i2cisolator6  2.1.0.0
i2cisolator6.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 I2CISOLATOR6_H
29 #define I2CISOLATOR6_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_i2c_master.h"
37 
64 #define I2CISOLATOR6_DEVICE_ADDRESS 0x00
65  // i2cisolator6_set
67 
82 #define I2CISOLATOR6_MAP_MIKROBUS( cfg, mikrobus ) \
83  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
84  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
85  // i2cisolator6_map // i2cisolator6
88 
93 typedef struct
94 {
95  // Modules
96  i2c_master_t i2c;
98  // I2C slave address
99  uint8_t slave_address;
102 
107 typedef struct
108 {
109  pin_name_t scl;
110  pin_name_t sda;
112  uint32_t i2c_speed;
113  uint8_t i2c_address;
116 
121 typedef enum
122 {
124  I2CISOLATOR6_ERROR = -1
125 
127 
144 
159 
174 err_t i2cisolator6_write ( i2cisolator6_t *ctx, uint8_t *data_in, uint8_t len );
175 
191 err_t i2cisolator6_read ( i2cisolator6_t *ctx, uint8_t *data_out, uint8_t len );
192 
212 err_t i2cisolator6_write_then_read ( i2cisolator6_t *ctx, uint8_t *data_in, uint8_t len_write_data, uint8_t *data_out, uint8_t len_read_data );
213 
226 err_t i2cisolator6_set_slave_address ( i2cisolator6_t *ctx, uint8_t slave_address );
227 
228 #ifdef __cplusplus
229 }
230 #endif
231 #endif // I2CISOLATOR6_H
232  // i2cisolator6
234 
235 // ------------------------------------------------------------------------ END
i2cisolator6_t::slave_address
uint8_t slave_address
Definition: i2cisolator6.h:99
i2cisolator6_return_value_t
i2cisolator6_return_value_t
I2C Isolator 6 Click return value data.
Definition: i2cisolator6.h:122
i2cisolator6_read
err_t i2cisolator6_read(i2cisolator6_t *ctx, uint8_t *data_out, uint8_t len)
I2C Isolator 6 I2C reading function.
i2cisolator6_cfg_setup
void i2cisolator6_cfg_setup(i2cisolator6_cfg_t *cfg)
I2C Isolator 6 configuration object setup function.
i2cisolator6_init
err_t i2cisolator6_init(i2cisolator6_t *ctx, i2cisolator6_cfg_t *cfg)
I2C Isolator 6 initialization function.
i2cisolator6_set_slave_address
err_t i2cisolator6_set_slave_address(i2cisolator6_t *ctx, uint8_t slave_address)
I2C Isolator 6 set I2C Slave address function.
i2cisolator6_t
I2C Isolator 6 Click context object.
Definition: i2cisolator6.h:94
i2cisolator6_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2cisolator6.h:113
i2cisolator6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2cisolator6.h:112
i2cisolator6_cfg_t
I2C Isolator 6 Click configuration object.
Definition: i2cisolator6.h:108
i2cisolator6_write_then_read
err_t i2cisolator6_write_then_read(i2cisolator6_t *ctx, uint8_t *data_in, uint8_t len_write_data, uint8_t *data_out, uint8_t len_read_data)
I2C Isolator 6 I2C write then read function.
I2CISOLATOR6_OK
@ I2CISOLATOR6_OK
Definition: i2cisolator6.h:123
I2CISOLATOR6_ERROR
@ I2CISOLATOR6_ERROR
Definition: i2cisolator6.h:124
i2cisolator6_write
err_t i2cisolator6_write(i2cisolator6_t *ctx, uint8_t *data_in, uint8_t len)
I2C Isolator 6 I2C writing function.
i2cisolator6_cfg_t::sda
pin_name_t sda
Definition: i2cisolator6.h:110
i2cisolator6_t::i2c
i2c_master_t i2c
Definition: i2cisolator6.h:96
i2cisolator6_cfg_t::scl
pin_name_t scl
Definition: i2cisolator6.h:109