i2cisolator5 2.1.0.0
i2cisolator5.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 I2CISOLATOR5_H
29#define I2CISOLATOR5_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 I2CISOLATOR5_PIN_STATE_HIGH 0x01
60#define I2CISOLATOR5_PIN_STATE_LOW 0x00
61
67#define I2CISOLATOR5_DEVICE_ADDRESS 0x00
68 // i2cisolator5_set
70
85#define I2CISOLATOR5_MAP_MIKROBUS( cfg, mikrobus ) \
86 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
87 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
88 cfg.otb = MIKROBUS( mikrobus, MIKROBUS_RST ); \
89 cfg.ota = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
90 cfg.ina = MIKROBUS( mikrobus, MIKROBUS_INT )
91 // i2cisolator5_map // i2cisolator5
94
99typedef struct
100{
101 // Output pins
102 digital_out_t otb;
103 digital_out_t ota;
105 // Input pins
106 digital_in_t ina;
108 // Modules
109 i2c_master_t i2c;
111 // I2C slave address
115
120typedef struct
121{
122 pin_name_t scl;
123 pin_name_t sda;
125 pin_name_t otb;
126 pin_name_t ota;
127 pin_name_t ina;
129 uint32_t i2c_speed;
130 uint8_t i2c_address;
133
138typedef enum
139{
142
144
161
176
190
205err_t i2cisolator5_generic_write ( i2cisolator5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
206
221err_t i2cisolator5_generic_read ( i2cisolator5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
222
235err_t i2cisolator5_set_slave_address ( i2cisolator5_t *ctx, uint8_t address );
236
246void i2cisolator5_set_outa_state ( i2cisolator5_t *ctx, uint8_t outa_state );
247
257void i2cisolator5_set_outb_state ( i2cisolator5_t *ctx, uint8_t outb_state );
258
268
269#ifdef __cplusplus
270}
271#endif
272#endif // I2CISOLATOR5_H
273 // i2cisolator5
275
276// ------------------------------------------------------------------------ END
err_t i2cisolator5_generic_read(i2cisolator5_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
I2C Isolator 5 I2C reading function.
err_t i2cisolator5_init(i2cisolator5_t *ctx, i2cisolator5_cfg_t *cfg)
I2C Isolator 5 initialization function.
uint8_t i2cisolator5_get_ina_state(i2cisolator5_t *ctx)
I2C Isolator 5 get input A state function.
void i2cisolator5_cfg_setup(i2cisolator5_cfg_t *cfg)
I2C Isolator 5 configuration object setup function.
void i2cisolator5_set_outb_state(i2cisolator5_t *ctx, uint8_t outb_state)
I2C Isolator 5 set output B state function.
void i2cisolator5_set_outa_state(i2cisolator5_t *ctx, uint8_t outa_state)
I2C Isolator 5 set output A state function.
err_t i2cisolator5_default_cfg(i2cisolator5_t *ctx)
I2C Isolator 5 default configuration function.
err_t i2cisolator5_generic_write(i2cisolator5_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
I2C Isolator 5 I2C writing function.
err_t i2cisolator5_set_slave_address(i2cisolator5_t *ctx, uint8_t address)
I2C Isolator 5 set I2C Slave address function.
i2cisolator5_return_value_t
I2C Isolator 5 Click return value data.
Definition: i2cisolator5.h:139
@ I2CISOLATOR5_ERROR
Definition: i2cisolator5.h:141
@ I2CISOLATOR5_OK
Definition: i2cisolator5.h:140
I2C Isolator 5 Click configuration object.
Definition: i2cisolator5.h:121
uint32_t i2c_speed
Definition: i2cisolator5.h:129
pin_name_t otb
Definition: i2cisolator5.h:125
pin_name_t ina
Definition: i2cisolator5.h:127
pin_name_t ota
Definition: i2cisolator5.h:126
pin_name_t scl
Definition: i2cisolator5.h:122
pin_name_t sda
Definition: i2cisolator5.h:123
uint8_t i2c_address
Definition: i2cisolator5.h:130
I2C Isolator 5 Click context object.
Definition: i2cisolator5.h:100
digital_out_t otb
Definition: i2cisolator5.h:102
digital_out_t ota
Definition: i2cisolator5.h:103
i2c_master_t i2c
Definition: i2cisolator5.h:109
uint8_t slave_address
Definition: i2cisolator5.h:112
digital_in_t ina
Definition: i2cisolator5.h:106