i2c1wire2  2.1.0.0
Data Structures | Macros | Enumerations | Functions
i2c1wire2.h File Reference

This file contains API for I2C 1-Wire 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  i2c1wire2_t
 I2C 1-Wire 2 Click context object. More...
 
struct  i2c1wire2_cfg_t
 I2C 1-Wire 2 Click configuration object. More...
 

Macros

#define I2C1WIRE2_REG_MASTER_CFG   0x00
 I2C 1-Wire 2 description register. More...
 
#define I2C1WIRE2_REG_STD_SPEED_TRSTL   0x01
 
#define I2C1WIRE2_REG_STD_SPEED_TMSI   0x02
 
#define I2C1WIRE2_REG_STD_SPEED_TMSP   0x03
 
#define I2C1WIRE2_REG_STD_SPEED_TRTH   0x04
 
#define I2C1WIRE2_REG_STD_SPEED_TW0L   0x05
 
#define I2C1WIRE2_REG_STD_SPEED_TW1L   0x06
 
#define I2C1WIRE2_REG_STD_SPEED_TMSR   0x07
 
#define I2C1WIRE2_REG_STD_SPEED_TREC   0x08
 
#define I2C1WIRE2_REG_OVER_SPEED_TRSTL   0x09
 
#define I2C1WIRE2_REG_OVER_SPEED_TMSI   0x0A
 
#define I2C1WIRE2_REG_OVER_SPEED_TMSP   0x0B
 
#define I2C1WIRE2_REG_OVER_SPEED_TRTH   0x0C
 
#define I2C1WIRE2_REG_OVER_SPEED_TW0L   0x0D
 
#define I2C1WIRE2_REG_OVER_SPEED_TW1L   0x0E
 
#define I2C1WIRE2_REG_OVER_SPEED_TMSR   0x0F
 
#define I2C1WIRE2_REG_OVER_SPEED_TREC   0x10
 
#define I2C1WIRE2_REG_PRUP_BUFF   0x11
 
#define I2C1WIRE2_REG_PDSLEW   0x12
 
#define I2C1WIRE2_CMD_WRITE_MEMORY   0x96
 I2C 1-Wire 2 commands. More...
 
#define I2C1WIRE2_CMD_READ_MEMORY   0x44
 
#define I2C1WIRE2_CMD_SET_PAGE_PROTECTION   0xC3
 
#define I2C1WIRE2_CMD_READ_STATUS   0xAA
 
#define I2C1WIRE2_CMD_READ_1WIRE_PORT_CFG   0x52
 
#define I2C1WIRE2_CMD_WRITE_1WIRE_PORT_CFG   0x99
 
#define I2C1WIRE2_CMD_MASTER_RESET   0x62
 
#define I2C1WIRE2_CMD_1WIRE_SCRIPT   0x88
 
#define I2C1WIRE2_CMD_1WIRE_BLOCK   0xAB
 
#define I2C1WIRE2_CMD_1WIRE_READ_BLOCK   0x50
 
#define I2C1WIRE2_CMD_1WIRE_WRITE_BLOCK   0x68
 
#define I2C1WIRE2_CMD_1WIRE_SEARCH   0x11
 
#define I2C1WIRE2_CMD_FULL_COMMAND_SEQUENCE   0x57
 
#define I2C1WIRE2_CMD_COMPUTE_CRC16   0xCC
 
#define I2C1WIRE2_CUSTOM_VAL   0x80
 I2C 1-Wire 2 description setting. More...
 
#define I2C1WIRE2_RWPU_EXT   0x00
 
#define I2C1WIRE2_RWPU_500   0x01
 
#define I2C1WIRE2_RWPU_1000   0x02
 
#define I2C1WIRE2_RWPU_333   0x03
 
#define I2C1WIRE2_VIAPO_LOW   0x00
 
#define I2C1WIRE2_VIAPO_MEDIUM   0x04
 
#define I2C1WIRE2_VIAPO_HIGH   0x08
 
#define I2C1WIRE2_VIAPO_OFF   0x0C
 
#define I2C1WIRE2_VTH_LOW   0x00
 
#define I2C1WIRE2_VTH_MEDIUM   0x01
 
#define I2C1WIRE2_VTH_HIGH   0x02
 
#define I2C1WIRE2_VTH_OFF   0x03
 
#define I2C1WIRE2_SEARCH_1WIRE_RESET   0x01
 I2C 1-Wire 2 search command setting. More...
 
#define I2C1WIRE2_SEARCH_IGNORE_PULSE   0x02
 
#define I2C1WIRE2_SEARCH_RESET   0x04
 
#define I2C1WIRE2_RESULT_BYTE_OK   0xAA
 I2C 1-Wire 2 Result byte setting. More...
 
#define I2C1WIRE2_RESULT_BYTE_ERROR   0x55
 
#define I2C1WIRE2_NO_PRESENCE_PULS   0x33
 
#define I2C1WIRE2_NO_DEVICE_DETECTED   0x00
 
#define I2C1WIRE2_RESULT_BYTE_ERROR_INVALID_PARAMS   0x77
 
#define I2C1WIRE2_RESULT_BYTE_ERROR_RESET_FAIL   0x22
 
#define I2C1WIRE2_DEVICE_ADDRESS   0x40
 I2C 1-Wire 2 device address setting. More...
 
#define I2C1WIRE2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  i2c1wire2_return_value_t { I2C1WIRE2_OK = 0, I2C1WIRE2_ERROR = -1 }
 I2C 1-Wire 2 Click return value data. More...
 

Functions

void i2c1wire2_cfg_setup (i2c1wire2_cfg_t *cfg)
 I2C 1-Wire 2 configuration object setup function. More...
 
err_t i2c1wire2_init (i2c1wire2_t *ctx, i2c1wire2_cfg_t *cfg)
 I2C 1-Wire 2 initialization function. More...
 
err_t i2c1wire2_default_cfg (i2c1wire2_t *ctx)
 I2C 1-Wire 2 default configuration function. More...
 
err_t i2c1wire2_generic_write (i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 I2C 1-Wire 2 I2C writing function. More...
 
err_t i2c1wire2_generic_read (i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 I2C 1-Wire 2 I2C reading function. More...
 
err_t i2c1wire2_master_reset (i2c1wire2_t *ctx)
 I2C 1-Wire 2 master reset function. More...
 
err_t i2c1wire2_read_port_cfg (i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_out)
 I2C 1-Wire 2 read port configuration function. More...
 
err_t i2c1wire2_write_port_cfg (i2c1wire2_t *ctx, uint8_t reg, uint8_t *data_in)
 I2C 1-Wire 2 write port configuration function. More...
 
err_t i2c1wire2_search (i2c1wire2_t *ctx, uint8_t *flag, uint8_t *rom_id, uint8_t *last_flag, uint8_t param_data, uint8_t command_code)
 I2C 1-Wire 2 search function. More...
 

Detailed Description

This file contains API for I2C 1-Wire 2 Click Driver.

Enumeration Type Documentation

◆ i2c1wire2_return_value_t

I2C 1-Wire 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
I2C1WIRE2_OK 
I2C1WIRE2_ERROR