i2cisolator3 2.0.0.0
i2cisolator3.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef I2CISOLATOR3_H
29#define I2CISOLATOR3_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59#define I2CISOLATOR3_THERMO20_CMD_RESET 0x1E
60#define I2CISOLATOR3_THERMO20_CMD_CONVERSION 0x46
61#define I2CISOLATOR3_THERMO20_CMD_READ_ADC 0x00
62
63#define I2CISOLATOR3_READ_WRITE_LEN_ERROR 0x00
64#define I2CISOLATOR3_READ_WRITE_LEN_MIN 0x01
70#define I2CISOLATOR3_SET_DEV_ADDR 0x40
71 // i2cisolator3_set
73
88#define I2CISOLATOR3_MAP_MIKROBUS( cfg, mikrobus ) \
89 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
90 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
91 // i2cisolator3_map // i2cisolator3
94
99typedef struct
100{
101 // Modules
102 i2c_master_t i2c;
104 // I2C slave address
108
113typedef struct
114{
115 pin_name_t scl;
116 pin_name_t sda;
118 uint32_t i2c_speed;
119 uint8_t i2c_address;
122
127typedef enum
128{
131
133
150
166
182err_t i2cisolator3_generic_write ( i2cisolator3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
183
199err_t i2cisolator3_generic_read ( i2cisolator3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
200
211void i2cisolator3_send_cmd ( i2cisolator3_t *ctx, uint8_t command );
212
224void i2cisolator3_write_byte ( i2cisolator3_t *ctx, uint8_t reg, uint8_t tx_data );
225
236uint8_t i2cisolator3_read_byte ( i2cisolator3_t *ctx, uint8_t reg );
237
251err_t i2cisolator3_burst_write ( i2cisolator3_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes );
252
266err_t i2cisolator3_burst_read ( i2cisolator3_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes );
267
282err_t i2cisolator3_adv_write ( i2cisolator3_t *ctx, uint8_t *p_reg, uint8_t n_reg_bytes, uint8_t *p_tx_data, uint8_t n_tx_data_bytes );
283
298err_t i2cisolator3_adv_read ( i2cisolator3_t *ctx, uint8_t *p_reg, uint8_t n_reg_bytes, uint8_t *p_rx_data, uint8_t n_rx_data_bytes );
299
300#ifdef __cplusplus
301}
302#endif
303#endif // I2CISOLATOR3_H
304 // i2cisolator3
306
307// ------------------------------------------------------------------------ END
void i2cisolator3_send_cmd(i2cisolator3_t *ctx, uint8_t command)
I2C Isolator 3 send command function.
err_t i2cisolator3_adv_read(i2cisolator3_t *ctx, uint8_t *p_reg, uint8_t n_reg_bytes, uint8_t *p_rx_data, uint8_t n_rx_data_bytes)
I2C Isolator 3 advanced read function.
void i2cisolator3_write_byte(i2cisolator3_t *ctx, uint8_t reg, uint8_t tx_data)
I2C Isolator 3 write the byte of data function.
err_t i2cisolator3_adv_write(i2cisolator3_t *ctx, uint8_t *p_reg, uint8_t n_reg_bytes, uint8_t *p_tx_data, uint8_t n_tx_data_bytes)
I2C Isolator 3 advanced write function.
uint8_t i2cisolator3_read_byte(i2cisolator3_t *ctx, uint8_t reg)
I2C Isolator 3 read the byte of data function.
err_t i2cisolator3_init(i2cisolator3_t *ctx, i2cisolator3_cfg_t *cfg)
I2C Isolator 3 initialization function.
err_t i2cisolator3_generic_write(i2cisolator3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
I2C Isolator 3 I2C writing function.
void i2cisolator3_cfg_setup(i2cisolator3_cfg_t *cfg)
I2C Isolator 3 configuration object setup function.
err_t i2cisolator3_generic_read(i2cisolator3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
I2C Isolator 3 I2C reading function.
err_t i2cisolator3_burst_read(i2cisolator3_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes)
I2C Isolator 3 burst read function.
err_t i2cisolator3_burst_write(i2cisolator3_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes)
I2C Isolator 3 burst write function.
i2cisolator3_return_value_t
I2C Isolator 3 Click return value data.
Definition: i2cisolator3.h:128
@ I2CISOLATOR3_OK
Definition: i2cisolator3.h:129
@ I2CISOLATOR3_ERROR
Definition: i2cisolator3.h:130
I2C Isolator 3 Click configuration object.
Definition: i2cisolator3.h:114
uint32_t i2c_speed
Definition: i2cisolator3.h:118
pin_name_t scl
Definition: i2cisolator3.h:115
pin_name_t sda
Definition: i2cisolator3.h:116
uint8_t i2c_address
Definition: i2cisolator3.h:119
I2C Isolator 3 Click context object.
Definition: i2cisolator3.h:100
i2c_master_t i2c
Definition: i2cisolator3.h:102
uint8_t slave_address
Definition: i2cisolator3.h:105