i2cextend2  2.0.0.0
i2cextend2.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2021 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 I2CEXTEND2_H
29 #define I2CEXTEND2_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 
74 #define C6DOFIMU11_REG_WHO_AM_I 0x00
75 #define C6DOFIMU11_REG_CNTL2 0x3A
76 #define C6DOFIMU11_REG_INC3 0x2C
77 #define C6DOFIMU11_REG_ACCEL_XOUT_L 0x0A
78 #define C6DOFIMU11_REG_ACCEL_YOUT_L 0x0C
79 #define C6DOFIMU11_REG_ACCEL_ZOUT_L 0x0E
80 #define C6DOFIMU11_REG_MAG_XOUT_L 0x10
81 #define C6DOFIMU11_REG_MAG_YOUT_L 0x12
82 #define C6DOFIMU11_REG_MAG_ZOUT_L 0x14
83  // i2cextend2_reg
85 
100 #define I2CEXTEND2_EXTEND_DISABLE 0x00
101 #define I2CEXTEND2_EXTEND_ENABLE 0x01
102 
107 #define I2CEXTEND_PIN_STATE_LOW 0x00
108 #define I2CEXTEND_PIN_STATE_HIGH 0x01
109 
114 #define C6DOFIMU11_CNTL2_TEMP_EN_STANDBY_MODE 0x00
115 #define C6DOFIMU11_CNTL2_MAG_EN_STANDBY_MODE 0x00
116 #define C6DOFIMU11_CNTL2_ACCEL_EN_STANDBY_MODE 0x00
117 #define C6DOFIMU11_INC3_IEL2_FIFO_TRIG 0x20
118 #define C6DOFIMU11_INC3_IEL1_FIFO_TRIG 0x02
119 #define C6DOFIMU11_CNTL2_ACCEL_EN_OPERATING_MODE 0x01
120 #define C6DOFIMU11_CNTL2_GSEL_8G 0x00
121 #define C6DOFIMU11_CNTL2_RES_MAX2 0x0C
122 #define C6DOFIMU11_CNTL2_MAG_EN_OPERATING_MODE 0x02
123 #define C6DOFIMU11_WHO_AM_I_WIA_ID 0x2D
124 
130 #define C6DOFIMU11_I2C_SLAVE_ADDRESS_GND 0x0E
131 #define C6DOFIMU11_I2C_SLAVE_ADDRESS_VCC 0x0F
132  // i2cextend2_set
134 
149 #define I2CEXTEND2_MAP_MIKROBUS( cfg, mikrobus ) \
150  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
151  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
152  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS )
153  // i2cextend2_map // i2cextend2
156 
161 typedef struct
162 {
163  // Output pins
164  digital_out_t en;
166  // Modules
167  i2c_master_t i2c;
169  // I2C slave address
170  uint8_t slave_address;
172 } i2cextend2_t;
173 
178 typedef struct
179 {
180  pin_name_t scl;
181  pin_name_t sda;
183  pin_name_t en;
185  uint32_t i2c_speed;
186  uint8_t i2c_address;
189 
194 typedef enum
195 {
197  I2CEXTEND2_ERROR = -1
198 
200 
217 
232 
244 void i2cextend2_rmt_write ( i2cextend2_t *ctx, uint8_t reg, uint8_t tx_data );
245 
256 uint8_t i2cextend2_rmt_read ( i2cextend2_t *ctx, uint8_t reg );
257 
270 void i2cextend2_rmt_multi_write ( i2cextend2_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes );
271 
284 void i2cextend2_rmt_multi_read ( i2cextend2_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes );
285 
298 void i2cextend2_enable ( i2cextend2_t *ctx, uint8_t en_extend );
299 
300 #ifdef __cplusplus
301 }
302 #endif
303 #endif // I2CEXTEND2_H
304  // i2cextend2
306 
307 // ------------------------------------------------------------------------ END
i2cextend2_return_value_t
i2cextend2_return_value_t
I2C Extend 2 Click return value data.
Definition: i2cextend2.h:195
i2cextend2_t::slave_address
uint8_t slave_address
Definition: i2cextend2.h:170
i2cextend2_rmt_multi_read
void i2cextend2_rmt_multi_read(i2cextend2_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes)
Generic multi read data in Remote Mode function.
i2cextend2_rmt_write
void i2cextend2_rmt_write(i2cextend2_t *ctx, uint8_t reg, uint8_t tx_data)
Generic write data in Remote Mode function.
i2cextend2_enable
void i2cextend2_enable(i2cextend2_t *ctx, uint8_t en_extend)
Enable extend function.
i2cextend2_rmt_multi_write
void i2cextend2_rmt_multi_write(i2cextend2_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes)
Generic multi write data in Remote Mode function.
i2cextend2_cfg_t::sda
pin_name_t sda
Definition: i2cextend2.h:181
i2cextend2_init
err_t i2cextend2_init(i2cextend2_t *ctx, i2cextend2_cfg_t *cfg)
I2C Extend 2 initialization function.
i2cextend2_cfg_t::en
pin_name_t en
Definition: i2cextend2.h:183
i2cextend2_cfg_setup
void i2cextend2_cfg_setup(i2cextend2_cfg_t *cfg)
I2C Extend 2 configuration object setup function.
i2cextend2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2cextend2.h:185
i2cextend2_t::en
digital_out_t en
Definition: i2cextend2.h:164
I2CEXTEND2_ERROR
@ I2CEXTEND2_ERROR
Definition: i2cextend2.h:197
i2cextend2_cfg_t
I2C Extend 2 Click configuration object.
Definition: i2cextend2.h:179
i2cextend2_t
I2C Extend 2 Click context object.
Definition: i2cextend2.h:162
i2cextend2_t::i2c
i2c_master_t i2c
Definition: i2cextend2.h:167
i2cextend2_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2cextend2.h:186
I2CEXTEND2_OK
@ I2CEXTEND2_OK
Definition: i2cextend2.h:196
i2cextend2_cfg_t::scl
pin_name_t scl
Definition: i2cextend2.h:180
i2cextend2_rmt_read
uint8_t i2cextend2_rmt_read(i2cextend2_t *ctx, uint8_t reg)
Generic read data in Remote Mode function.