i2cisolator7  2.1.0.0
i2cisolator7.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 I2CISOLATOR7_H
29 #define I2CISOLATOR7_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
60 #define I2CISOLATOR7_DEVICE_ADDRESS 0x00
61  // i2cisolator7_set
63 
78 #define I2CISOLATOR7_MAP_MIKROBUS( cfg, mikrobus ) \
79  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
80  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
81  // i2cisolator7_map // i2cisolator7
84 
89 typedef struct
90 {
91  // Modules
92  i2c_master_t i2c;
94  // I2C slave address
95  uint8_t slave_address;
98 
103 typedef struct
104 {
105  pin_name_t scl;
106  pin_name_t sda;
108  uint32_t i2c_speed;
109  uint8_t i2c_address;
112 
117 typedef enum
118 {
120  I2CISOLATOR7_ERROR = -1
121 
123 
140 
155 
168 err_t i2cisolator7_set_slave_address ( i2cisolator7_t *ctx, uint8_t slave_address );
169 
183 err_t i2cisolator7_generic_write ( i2cisolator7_t *ctx, uint8_t *data_in, uint8_t len );
184 
198 err_t i2cisolator7_generic_read ( i2cisolator7_t *ctx, uint8_t *data_out, uint8_t len );
199 
219 err_t i2cisolator7_write_then_read ( i2cisolator7_t *ctx, uint8_t *data_in, uint8_t len_write_data,
220  uint8_t *data_out, uint8_t len_read_data );
221 
222 #ifdef __cplusplus
223 }
224 #endif
225 #endif // I2CISOLATOR7_H
226  // i2cisolator7
228 
229 // ------------------------------------------------------------------------ END
i2cisolator7_t::i2c
i2c_master_t i2c
Definition: i2cisolator7.h:92
i2cisolator7_generic_read
err_t i2cisolator7_generic_read(i2cisolator7_t *ctx, uint8_t *data_out, uint8_t len)
I2C Isolator 7 I2C reading function.
i2cisolator7_write_then_read
err_t i2cisolator7_write_then_read(i2cisolator7_t *ctx, uint8_t *data_in, uint8_t len_write_data, uint8_t *data_out, uint8_t len_read_data)
I2C Isolator 7 I2C write then read function.
i2cisolator7_cfg_t::sda
pin_name_t sda
Definition: i2cisolator7.h:106
i2cisolator7_t::slave_address
uint8_t slave_address
Definition: i2cisolator7.h:95
i2cisolator7_return_value_t
i2cisolator7_return_value_t
I2C Isolator 7 Click return value data.
Definition: i2cisolator7.h:118
i2cisolator7_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2cisolator7.h:109
i2cisolator7_set_slave_address
err_t i2cisolator7_set_slave_address(i2cisolator7_t *ctx, uint8_t slave_address)
I2C Isolator 7 set I2C Slave address function.
I2CISOLATOR7_OK
@ I2CISOLATOR7_OK
Definition: i2cisolator7.h:119
i2cisolator7_t
I2C Isolator 7 Click context object.
Definition: i2cisolator7.h:90
I2CISOLATOR7_ERROR
@ I2CISOLATOR7_ERROR
Definition: i2cisolator7.h:120
i2cisolator7_init
err_t i2cisolator7_init(i2cisolator7_t *ctx, i2cisolator7_cfg_t *cfg)
I2C Isolator 7 initialization function.
i2cisolator7_cfg_t
I2C Isolator 7 Click configuration object.
Definition: i2cisolator7.h:104
i2cisolator7_cfg_t::scl
pin_name_t scl
Definition: i2cisolator7.h:105
i2cisolator7_generic_write
err_t i2cisolator7_generic_write(i2cisolator7_t *ctx, uint8_t *data_in, uint8_t len)
I2C Isolator 7 I2C writing function.
i2cisolator7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2cisolator7.h:108
i2cisolator7_cfg_setup
void i2cisolator7_cfg_setup(i2cisolator7_cfg_t *cfg)
I2C Isolator 7 configuration object setup function.