i2cmux2  2.0.0.0
i2cmux2.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 I2CMUX2_H
36 #define I2CMUX2_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define I2CMUX2_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
70  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
71  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
72 
78 #define I2CMUX2_OK 0
79 #define I2CMUX2_ERROR -1
80 
82 // Device address
83 #define I2CMUX2_I2C_SLAVE_ADDRESS_0 0x70
84 #define I2CMUX2_I2C_SLAVE_ADDRESS_1 0x71
85 #define I2CMUX2_I2C_SLAVE_ADDRESS_2 0x72
86 #define I2CMUX2_I2C_SLAVE_ADDRESS_3 0x73
87 #define I2CMUX2_I2C_SLAVE_ADDRESS_4 0x74
88 #define I2CMUX2_I2C_SLAVE_ADDRESS_5 0x75
89 #define I2CMUX2_I2C_SLAVE_ADDRESS_6 0x76
90 #define I2CMUX2_I2C_SLAVE_ADDRESS_7 0x77
91 
92 // Set channel
93 #define I2CMUX2_CMD_NO_CH 0x00
94 #define I2CMUX2_CMD_SET_CH_0 0x01
95 #define I2CMUX2_CMD_SET_CH_1 0x02
96 #define I2CMUX2_CMD_SET_CH_2 0x04
97 #define I2CMUX2_CMD_SET_CH_3 0x08
98 
99 // Interrupt bit mask
100 #define I2CMUX2_INT_BITS 0xF0
101 
102 // Interrupt of channel
103 #define I2CMUX2_INT_NO_CH 0x00
104 #define I2CMUX2_INT_CH_0 0x01
105 #define I2CMUX2_INT_CH_1 0x02
106 #define I2CMUX2_INT_CH_2 0x04
107 #define I2CMUX2_INT_CH_3 0x08
108 
109 // Interrupt pin state
110 #define I2CMUX2_INT_PIN_STATE_ACTIVE 0x00
111 #define I2CMUX2_INT_PIN_STATE_NOT_ACTIVE 0x01
112  // End group macro
114 // --------------------------------------------------------------- PUBLIC TYPES
123 typedef struct
124 {
125  // Output pins
126  digital_out_t rst;
127 
128  // Input pins
129  digital_in_t int_pin;
130 
131  // Modules
132  i2c_master_t i2c;
133 
134  // ctx variable
135  uint8_t slave_address;
136 
137 } i2cmux2_t;
138 
142 typedef struct
143 {
144  // Communication gpio pins
145  pin_name_t scl;
146  pin_name_t sda;
147 
148  // Additional gpio pins
149  pin_name_t rst;
150  pin_name_t int_pin;
151 
152  // static variable
153  uint32_t i2c_speed;
154  uint8_t i2c_address;
155 
156 } i2cmux2_cfg_t;
157  // End types group
159 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
160 
166 #ifdef __cplusplus
167 extern "C"{
168 #endif
169 
179 
188 err_t i2cmux2_init ( i2cmux2_t *ctx, i2cmux2_cfg_t *cfg );
189 
200 void i2cmux2_generic_write ( i2cmux2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
201 
213 void i2cmux2_generic_read ( i2cmux2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
214 
224 
234 void i2cmux2_write_cmd ( i2cmux2_t *ctx, uint8_t tx_data );
235 
247 uint8_t i2cmux2_read_cmd ( i2cmux2_t *ctx );
248 
259 void i2cmux2_set_channel ( i2cmux2_t *ctx, uint8_t channel, uint8_t ch_slave_address );
260 
277 
291 uint8_t i2cmux2_check_int ( i2cmux2_t *ctx );
292 
293 #ifdef __cplusplus
294 }
295 #endif
296 #endif // _I2CMUX2_H_
297  // End public_function group
300 
301 // ------------------------------------------------------------------------- END
i2cmux2_read_interrupt
uint8_t i2cmux2_read_interrupt(i2cmux2_t *ctx)
Read interrupt status function.
i2cmux2_generic_write
void i2cmux2_generic_write(i2cmux2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
i2cmux2_t::rst
digital_out_t rst
Definition: i2cmux2.h:126
i2cmux2_generic_read
void i2cmux2_generic_read(i2cmux2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
i2cmux2_t::i2c
i2c_master_t i2c
Definition: i2cmux2.h:132
i2cmux2_read_cmd
uint8_t i2cmux2_read_cmd(i2cmux2_t *ctx)
Read command function.
i2cmux2_cfg_t::int_pin
pin_name_t int_pin
Definition: i2cmux2.h:150
i2cmux2_set_channel
void i2cmux2_set_channel(i2cmux2_t *ctx, uint8_t channel, uint8_t ch_slave_address)
Set channel function.
i2cmux2_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2cmux2.h:154
i2cmux2_init
err_t i2cmux2_init(i2cmux2_t *ctx, i2cmux2_cfg_t *cfg)
Initialization function.
i2cmux2_t::int_pin
digital_in_t int_pin
Definition: i2cmux2.h:129
i2cmux2_cfg_t::sda
pin_name_t sda
Definition: i2cmux2.h:146
i2cmux2_cfg_t::rst
pin_name_t rst
Definition: i2cmux2.h:149
i2cmux2_cfg_setup
void i2cmux2_cfg_setup(i2cmux2_cfg_t *cfg)
Config Object Initialization function.
i2cmux2_t::slave_address
uint8_t slave_address
Definition: i2cmux2.h:135
i2cmux2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2cmux2.h:153
i2cmux2_write_cmd
void i2cmux2_write_cmd(i2cmux2_t *ctx, uint8_t tx_data)
Write command function.
i2cmux2_check_int
uint8_t i2cmux2_check_int(i2cmux2_t *ctx)
Check interrupt status function.
i2cmux2_cfg_t::scl
pin_name_t scl
Definition: i2cmux2.h:145
i2cmux2_hw_reset
void i2cmux2_hw_reset(i2cmux2_t *ctx)
Hardware reset function.
i2cmux2_t
Click ctx object definition.
Definition: i2cmux2.h:124
i2cmux2_cfg_t
Click configuration structure definition.
Definition: i2cmux2.h:143