i2cmux6  2.0.0.0
i2cmux6.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 I2CMUX6_H
29 #define I2CMUX6_H
30 
31 #ifdef __cplusplus
32 extern "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 I2CMUX6_CHANNEL_DISABLE 0x00
60 #define I2CMUX6_CHANNEL_1 0x01
61 #define I2CMUX6_CHANNEL_2 0x02
62 #define I2CMUX6_CHANNEL_3 0x04
63 #define I2CMUX6_CHANNEL_4 0x08
64 #define I2CMUX6_CHANNEL_ALL 0x0F
65 
71 #define I2CMUX6_DEVICE_ADDRESS 0x00
72  // i2cmux6_set
74 
89 #define I2CMUX6_MAP_MIKROBUS( cfg, mikrobus ) \
90  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
91  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
92  cfg.en3 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
93  cfg.en1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
94  cfg.en2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
95  cfg.en4 = MIKROBUS( mikrobus, MIKROBUS_PWM );
96  // i2cmux6_map // i2cmux6
99 
104 typedef struct
105 {
106  // Output pins
107  digital_out_t en1;
108  digital_out_t en2;
109  digital_out_t en3;
110  digital_out_t en4;
112  // Modules
113  i2c_master_t i2c;
115  // I2C slave address
116  uint8_t slave_address;
118 } i2cmux6_t;
119 
124 typedef struct
125 {
126  pin_name_t scl;
127  pin_name_t sda;
129  pin_name_t en1;
130  pin_name_t en2;
131  pin_name_t en3;
132  pin_name_t en4;
134  uint32_t i2c_speed;
135  uint8_t i2c_address;
137 } i2cmux6_cfg_t;
138 
143 typedef enum
144 {
146  I2CMUX6_ERROR = -1
147 
149 
166 
180 err_t i2cmux6_init ( i2cmux6_t *ctx, i2cmux6_cfg_t *cfg );
181 
196 err_t i2cmux6_generic_write ( i2cmux6_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
197 
212 err_t i2cmux6_generic_read ( i2cmux6_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
213 
226 err_t i2cmux6_set_channel ( i2cmux6_t *ctx, uint8_t ch_sel, uint8_t ch_slave_addr );
227 
228 #ifdef __cplusplus
229 }
230 #endif
231 #endif // I2CMUX6_H
232  // i2cmux6
234 
235 // ------------------------------------------------------------------------ END
i2cmux6_cfg_t::en2
pin_name_t en2
Definition: i2cmux6.h:130
i2cmux6_cfg_t::scl
pin_name_t scl
Definition: i2cmux6.h:126
i2cmux6_set_channel
err_t i2cmux6_set_channel(i2cmux6_t *ctx, uint8_t ch_sel, uint8_t ch_slave_addr)
I2C MUX 6 set channel function.
i2cmux6_t::en2
digital_out_t en2
Definition: i2cmux6.h:108
i2cmux6_init
err_t i2cmux6_init(i2cmux6_t *ctx, i2cmux6_cfg_t *cfg)
I2C MUX 6 initialization function.
i2cmux6_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2cmux6.h:135
I2CMUX6_ERROR
@ I2CMUX6_ERROR
Definition: i2cmux6.h:146
I2CMUX6_OK
@ I2CMUX6_OK
Definition: i2cmux6.h:145
i2cmux6_generic_write
err_t i2cmux6_generic_write(i2cmux6_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
I2C MUX 6 I2C writing function.
i2cmux6_t::slave_address
uint8_t slave_address
Definition: i2cmux6.h:116
i2cmux6_t::en1
digital_out_t en1
Definition: i2cmux6.h:107
i2cmux6_t::en3
digital_out_t en3
Definition: i2cmux6.h:109
i2cmux6_t
I2C MUX 6 Click context object.
Definition: i2cmux6.h:105
i2cmux6_cfg_t::en4
pin_name_t en4
Definition: i2cmux6.h:132
i2cmux6_return_value_t
i2cmux6_return_value_t
I2C MUX 6 Click return value data.
Definition: i2cmux6.h:144
i2cmux6_cfg_t::en3
pin_name_t en3
Definition: i2cmux6.h:131
i2cmux6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2cmux6.h:134
i2cmux6_cfg_t::sda
pin_name_t sda
Definition: i2cmux6.h:127
i2cmux6_t::i2c
i2c_master_t i2c
Definition: i2cmux6.h:113
i2cmux6_cfg_t
I2C MUX 6 Click configuration object.
Definition: i2cmux6.h:125
i2cmux6_t::en4
digital_out_t en4
Definition: i2cmux6.h:110
i2cmux6_cfg_setup
void i2cmux6_cfg_setup(i2cmux6_cfg_t *cfg)
I2C MUX 6 configuration object setup function.
i2cmux6_generic_read
err_t i2cmux6_generic_read(i2cmux6_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
I2C MUX 6 I2C reading function.
i2cmux6_cfg_t::en1
pin_name_t en1
Definition: i2cmux6.h:129