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 "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 
69 #define I2CMUX6_CHANNEL_DISABLE 0x00
70 #define I2CMUX6_CHANNEL_1 0x01
71 #define I2CMUX6_CHANNEL_2 0x02
72 #define I2CMUX6_CHANNEL_3 0x04
73 #define I2CMUX6_CHANNEL_4 0x08
74 #define I2CMUX6_CHANNEL_ALL 0x0F
75 
81 #define I2CMUX6_DEVICE_ADDRESS 0x00
82  // i2cmux6_set
84 
99 #define I2CMUX6_MAP_MIKROBUS( cfg, mikrobus ) \
100  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
101  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
102  cfg.en3 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
103  cfg.en1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
104  cfg.en2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
105  cfg.en4 = MIKROBUS( mikrobus, MIKROBUS_PWM );
106  // i2cmux6_map // i2cmux6
109 
114 typedef struct
115 {
116  // Output pins
117  digital_out_t en1;
118  digital_out_t en2;
119  digital_out_t en3;
120  digital_out_t en4;
122  // Modules
123  i2c_master_t i2c;
125  // I2C slave address
126  uint8_t slave_address;
128 } i2cmux6_t;
129 
134 typedef struct
135 {
136  pin_name_t scl;
137  pin_name_t sda;
139  pin_name_t en1;
140  pin_name_t en2;
141  pin_name_t en3;
142  pin_name_t en4;
144  uint32_t i2c_speed;
145  uint8_t i2c_address;
147 } i2cmux6_cfg_t;
148 
153 typedef enum
154 {
156  I2CMUX6_ERROR = -1
157 
159 
176 
190 err_t i2cmux6_init ( i2cmux6_t *ctx, i2cmux6_cfg_t *cfg );
191 
206 err_t i2cmux6_generic_write ( i2cmux6_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
207 
222 err_t i2cmux6_generic_read ( i2cmux6_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
223 
236 err_t i2cmux6_set_channel ( i2cmux6_t *ctx, uint8_t ch_sel, uint8_t ch_slave_addr );
237 
238 #ifdef __cplusplus
239 }
240 #endif
241 #endif // I2CMUX6_H
242  // i2cmux6
244 
245 // ------------------------------------------------------------------------ END
i2cmux6_cfg_t::en2
pin_name_t en2
Definition: i2cmux6.h:140
i2cmux6_cfg_t::scl
pin_name_t scl
Definition: i2cmux6.h:136
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:118
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:145
I2CMUX6_ERROR
@ I2CMUX6_ERROR
Definition: i2cmux6.h:156
I2CMUX6_OK
@ I2CMUX6_OK
Definition: i2cmux6.h:155
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:126
i2cmux6_t::en1
digital_out_t en1
Definition: i2cmux6.h:117
i2cmux6_t::en3
digital_out_t en3
Definition: i2cmux6.h:119
i2cmux6_t
I2C MUX 6 Click context object.
Definition: i2cmux6.h:115
i2cmux6_cfg_t::en4
pin_name_t en4
Definition: i2cmux6.h:142
i2cmux6_return_value_t
i2cmux6_return_value_t
I2C MUX 6 Click return value data.
Definition: i2cmux6.h:154
i2cmux6_cfg_t::en3
pin_name_t en3
Definition: i2cmux6.h:141
i2cmux6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2cmux6.h:144
i2cmux6_cfg_t::sda
pin_name_t sda
Definition: i2cmux6.h:137
i2cmux6_t::i2c
i2c_master_t i2c
Definition: i2cmux6.h:123
i2cmux6_cfg_t
I2C MUX 6 Click configuration object.
Definition: i2cmux6.h:135
i2cmux6_t::en4
digital_out_t en4
Definition: i2cmux6.h:120
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:139