i2cmux3  2.0.0.0
i2cmux3.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 I2CMUX3_H
36 #define I2CMUX3_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define I2CMUX3_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
66 
72 #define I2CMUX3_RETVAL uint8_t
73 
74 #define I2CMUX3_OK 0x00
75 #define I2CMUX3_INIT_ERROR 0xFF
76 
82 #define I2CMUX3_DEV_ADR_0 0x70
83 #define I2CMUX3_DEV_ADR_1 0x71
84 #define I2CMUX3_DEV_ADR_2 0x72
85 #define I2CMUX3_DEV_ADR_3 0x73
86 #define I2CMUX3_DEV_ADR_4 0x74
87 #define I2CMUX3_DEV_ADR_5 0x75
88 #define I2CMUX3_DEV_ADR_6 0x76
89 #define I2CMUX3_DEV_ADR_7 0x77
90 
96 #define I2CMUX3_DIS_ALL_CH 0x00
97 #define I2CMUX3_SEL_CH_0 0x01
98 #define I2CMUX3_SEL_CH_1 0x02
99 #define I2CMUX3_SEL_CH_2 0x04
100 #define I2CMUX3_SEL_CH_3 0x08
101 #define I2CMUX3_SEL_CH_4 0x10
102 #define I2CMUX3_SEL_CH_5 0x20
103 #define I2CMUX3_SEL_CH_6 0x40
104 #define I2CMUX3_SEL_CH_7 0x80
105 
111 #define I2CMUX3_DEV_DIS 0x00
112 #define I2CMUX3_DEV_EN 0x01
113  // End group macro
116 // --------------------------------------------------------------- PUBLIC TYPES
125 typedef struct
126 {
127  // Output pins
128 
129  digital_out_t rst;
130 
131  // Modules
132 
133  i2c_master_t i2c;
134 
135  // ctx variable
136 
137  uint8_t slave_address;
138 
139 } i2cmux3_t;
140 
144 typedef struct
145 {
146  // Communication gpio pins
147 
148  pin_name_t scl;
149  pin_name_t sda;
150 
151  // Additional gpio pins
152 
153  pin_name_t rst;
154 
155  // static variable
156 
157  uint32_t i2c_speed;
158  uint8_t i2c_address;
159 
160 } i2cmux3_cfg_t;
161  // End types group
163 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
164 
170 #ifdef __cplusplus
171 extern "C"{
172 #endif
173 
183 
192 
203 void i2cmux3_generic_write ( i2cmux3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
204 
216 void i2cmux3_generic_read ( i2cmux3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
217 
226 void i2cmux3_write_ctl ( i2cmux3_t *ctx, uint8_t wr_data );
227 
237 uint8_t i2cmux3_read_ctl ( i2cmux3_t *ctx );
238 
249 void i2cmux3_ch_sel ( i2cmux3_t *ctx, uint8_t sel_ch );
250 
264 void i2cmux3_wr_slv ( i2cmux3_t *ctx, uint8_t slv_sel_adr, uint8_t reg, uint8_t *p_wr_data,
265  uint8_t n_bytes );
266 
280 void i2cmux3_rd_slv ( i2cmux3_t *ctx, uint8_t slv_sel_adr, uint8_t reg, uint8_t *p_rd_data,
281  uint8_t n_bytes );
282 
293 void i2cmux3_dev_enable ( i2cmux3_t *ctx, uint8_t stat );
294 
303 void i2cmux3_hw_rst ( i2cmux3_t *ctx );
304 
305 #ifdef __cplusplus
306 }
307 #endif
308 #endif // _I2CMUX3_H_
309  // End public_function group
312 
313 // ------------------------------------------------------------------------- END
i2cmux3_generic_write
void i2cmux3_generic_write(i2cmux3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
i2cmux3_init
I2CMUX3_RETVAL i2cmux3_init(i2cmux3_t *ctx, i2cmux3_cfg_t *cfg)
Initialization function.
i2cmux3_dev_enable
void i2cmux3_dev_enable(i2cmux3_t *ctx, uint8_t stat)
Device enable function.
i2cmux3_write_ctl
void i2cmux3_write_ctl(i2cmux3_t *ctx, uint8_t wr_data)
Write Control Register function.
i2cmux3_cfg_t::i2c_address
uint8_t i2c_address
Definition: i2cmux3.h:158
i2cmux3_t::rst
digital_out_t rst
Definition: i2cmux3.h:129
i2cmux3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: i2cmux3.h:157
i2cmux3_hw_rst
void i2cmux3_hw_rst(i2cmux3_t *ctx)
Hardware reset function.
i2cmux3_t::i2c
i2c_master_t i2c
Definition: i2cmux3.h:133
i2cmux3_wr_slv
void i2cmux3_wr_slv(i2cmux3_t *ctx, uint8_t slv_sel_adr, uint8_t reg, uint8_t *p_wr_data, uint8_t n_bytes)
Slave Device Write function.
I2CMUX3_RETVAL
#define I2CMUX3_RETVAL
Definition: i2cmux3.h:72
i2cmux3_generic_read
void i2cmux3_generic_read(i2cmux3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
i2cmux3_cfg_t::rst
pin_name_t rst
Definition: i2cmux3.h:153
i2cmux3_rd_slv
void i2cmux3_rd_slv(i2cmux3_t *ctx, uint8_t slv_sel_adr, uint8_t reg, uint8_t *p_rd_data, uint8_t n_bytes)
Slave Device Read function.
i2cmux3_cfg_t::scl
pin_name_t scl
Definition: i2cmux3.h:148
i2cmux3_t
Click ctx object definition.
Definition: i2cmux3.h:126
i2cmux3_cfg_setup
void i2cmux3_cfg_setup(i2cmux3_cfg_t *cfg)
Config Object Initialization function.
i2cmux3_read_ctl
uint8_t i2cmux3_read_ctl(i2cmux3_t *ctx)
Read Control Register function.
i2cmux3_cfg_t::sda
pin_name_t sda
Definition: i2cmux3.h:149
i2cmux3_ch_sel
void i2cmux3_ch_sel(i2cmux3_t *ctx, uint8_t sel_ch)
Select Channel function.
i2cmux3_cfg_t
Click configuration structure definition.
Definition: i2cmux3.h:145
i2cmux3_t::slave_address
uint8_t slave_address
Definition: i2cmux3.h:137