i2cisolator4  2.0.0.0
i2cisolator4.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 I2CISOLATOR4_H
29 #define I2CISOLATOR4_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
77 #define I2CISOLATOR4_SET_DEV_ADDR 0x00
78  // i2cisolator4_set
80 
95 #define I2CISOLATOR4_MAP_MIKROBUS( cfg, mikrobus ) \
96  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
97  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
98  // i2cisolator4_map // i2cisolator4
101 
106 typedef struct
107 {
108  // Modules
109 
110  i2c_master_t i2c;
112  // I2C slave address
113 
114  uint8_t slave_address;
117 
122 typedef struct
123 {
124  pin_name_t scl;
125  pin_name_t sda;
128  uint32_t i2c_speed;
129  uint8_t i2c_address;
132 
137 typedef enum
138 {
140  I2CISOLATOR4_ERROR = -1
141 
143 
162 
180 
198 err_t i2cisolator4_generic_write ( i2cisolator4_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
199 
217 err_t i2cisolator4_generic_read ( i2cisolator4_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
218 
234 err_t i2cisolator4_set_slave_address ( i2cisolator4_t *ctx, uint8_t address );
235 
236 #ifdef __cplusplus
237 }
238 #endif
239 #endif // I2CISOLATOR4_H
240  // i2cisolator4
242 
243 // ------------------------------------------------------------------------ END
i2cisolator4_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2cisolator4.h:129
i2cisolator4_t::slave_address
uint8_t slave_address
Definition: i2cisolator4.h:114
i2cisolator4_t
I2C Isolator 4 Click context object.
Definition: i2cisolator4.h:107
i2cisolator4_cfg_t::scl
pin_name_t scl
Definition: i2cisolator4.h:124
i2cisolator4_init
err_t i2cisolator4_init(i2cisolator4_t *ctx, i2cisolator4_cfg_t *cfg)
I2C Isolator 4 initialization function.
i2cisolator4_set_slave_address
err_t i2cisolator4_set_slave_address(i2cisolator4_t *ctx, uint8_t address)
I2C Isolator 4 set I2C Slave address function.
i2cisolator4_return_value_t
i2cisolator4_return_value_t
I2C Isolator 4 Click return value data.
Definition: i2cisolator4.h:138
i2cisolator4_generic_read
err_t i2cisolator4_generic_read(i2cisolator4_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
I2C Isolator 4 I2C reading function.
i2cisolator4_cfg_t::sda
pin_name_t sda
Definition: i2cisolator4.h:125
i2cisolator4_cfg_t
I2C Isolator 4 Click configuration object.
Definition: i2cisolator4.h:123
i2cisolator4_cfg_setup
void i2cisolator4_cfg_setup(i2cisolator4_cfg_t *cfg)
I2C Isolator 4 configuration object setup function.
i2cisolator4_t::i2c
i2c_master_t i2c
Definition: i2cisolator4.h:110
i2cisolator4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2cisolator4.h:128
I2CISOLATOR4_ERROR
@ I2CISOLATOR4_ERROR
Definition: i2cisolator4.h:140
I2CISOLATOR4_OK
@ I2CISOLATOR4_OK
Definition: i2cisolator4.h:139
i2cisolator4_generic_write
err_t i2cisolator4_generic_write(i2cisolator4_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
I2C Isolator 4 I2C writing function.