i2cisolator2  2.0.0.0
i2cisolator2.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef I2CISOLATOR2_H
36 #define I2CISOLATOR2_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define I2CISOLATOR2_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.pdis = MIKROBUS( mikrobus, MIKROBUS_PWM )
66 
72 #define I2CISOLATOR2_OK 0
73 #define I2CISOLATOR2_ERROR -1
74 
80 #define I2CISOLATOR2_POWER_ENABLE 0
81 #define I2CISOLATOR2_POWER_DISABLE 1
82  // End group macro
86 // --------------------------------------------------------------- PUBLIC TYPES
95 typedef struct
96 {
97  // Output pins
98  digital_out_t pdis;
99 
100  // Modules
101  i2c_master_t i2c;
102 
103  // ctx variable
104  uint8_t slave_address;
105 
107 
111 typedef struct
112 {
113  // Communication gpio pins
114  pin_name_t scl;
115  pin_name_t sda;
116 
117  // Additional gpio pins
118  pin_name_t pdis;
119 
120  // static variable
121  uint32_t i2c_speed;
122  uint8_t i2c_address;
123 
125  // End types group
127 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
128 
134 #ifdef __cplusplus
135 extern "C"{
136 #endif
137 
147 
160 
169 void i2cisolator2_enable_power ( i2cisolator2_t *ctx, uint8_t state );
170 
183 err_t i2cisolator2_write ( i2cisolator2_t *ctx, uint8_t *data_in, uint16_t len );
184 
197 err_t i2cisolator2_read ( i2cisolator2_t *ctx, uint8_t *data_out, uint16_t len );
198 
214 err_t i2cisolator2_write_then_read ( i2cisolator2_t *ctx, uint8_t *data_in, uint16_t in_len,
215  uint8_t *data_out, uint16_t out_len );
216 
228 err_t i2cisolator2_set_slave_address ( i2cisolator2_t *ctx, uint8_t slave_addr );
229 
230 #ifdef __cplusplus
231 }
232 #endif
233 #endif // _I2CISOLATOR2_H_
234  // End public_function group
237 
238 // ------------------------------------------------------------------------- END
i2cisolator2_t
Click ctx object definition.
Definition: i2cisolator2.h:96
i2cisolator2_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2cisolator2.h:122
i2cisolator2_write
err_t i2cisolator2_write(i2cisolator2_t *ctx, uint8_t *data_in, uint16_t len)
Generic write function.
i2cisolator2_read
err_t i2cisolator2_read(i2cisolator2_t *ctx, uint8_t *data_out, uint16_t len)
Generic read function.
i2cisolator2_enable_power
void i2cisolator2_enable_power(i2cisolator2_t *ctx, uint8_t state)
This function sets PDIS pin state.
i2cisolator2_cfg_setup
void i2cisolator2_cfg_setup(i2cisolator2_cfg_t *cfg)
Config Object Initialization function.
i2cisolator2_t::slave_address
uint8_t slave_address
Definition: i2cisolator2.h:104
i2cisolator2_init
err_t i2cisolator2_init(i2cisolator2_t *ctx, i2cisolator2_cfg_t *cfg)
Initialization function.
i2cisolator2_cfg_t::scl
pin_name_t scl
Definition: i2cisolator2.h:114
i2cisolator2_write_then_read
err_t i2cisolator2_write_then_read(i2cisolator2_t *ctx, uint8_t *data_in, uint16_t in_len, uint8_t *data_out, uint16_t out_len)
Generic write then read function.
i2cisolator2_set_slave_address
err_t i2cisolator2_set_slave_address(i2cisolator2_t *ctx, uint8_t slave_addr)
Set slave address function.
i2cisolator2_cfg_t::sda
pin_name_t sda
Definition: i2cisolator2.h:115
i2cisolator2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2cisolator2.h:121
i2cisolator2_cfg_t::pdis
pin_name_t pdis
Definition: i2cisolator2.h:118
i2cisolator2_t::i2c
i2c_master_t i2c
Definition: i2cisolator2.h:101
i2cisolator2_t::pdis
digital_out_t pdis
Definition: i2cisolator2.h:98
i2cisolator2_cfg_t
Click configuration structure definition.
Definition: i2cisolator2.h:112