expand2  2.0.0.0
expand2.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 EXPAND2_H
36 #define EXPAND2_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 EXPAND2_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 EXPAND2_RETVAL uint8_t
79 
80 #define EXPAND2_OK 0x00
81 #define EXPAND2_INIT_ERROR 0xFF
82 
88 #define EXPAND2_I2C_MODULE_ADDRESS_0 0x20
89 #define EXPAND2_I2C_MODULE_ADDRESS_1 0x21
90 #define EXPAND2_I2C_MODULE_ADDRESS_2 0x22
91 #define EXPAND2_I2C_MODULE_ADDRESS_3 0x23
92 #define EXPAND2_I2C_MODULE_ADDRESS_4 0x24
93 #define EXPAND2_I2C_MODULE_ADDRESS_5 0x25
94 #define EXPAND2_I2C_MODULE_ADDRESS_6 0x26
95 #define EXPAND2_I2C_MODULE_ADDRESS_7 0x27
96 
102 #define EXPAND2_PORT_DIRECTION_OUTPUT 0x00
103 #define EXPAND2_PORT_DIRECTION_INPUT 0xFF
104 
110 #define EXPAND2_IODIRA_BANK1 0x00
111 #define EXPAND2_IPOLA_BANK1 0x01
112 #define EXPAND2_GPINTENA_BANK1 0x02
113 #define EXPAND2_DEFVALA_BANK1 0x03
114 #define EXPAND2_INTCONA_BANK1 0x04
115 #define EXPAND2_IOCON_BANK1 0x05
116 #define EXPAND2_GPPUA_BANK1 0x06
117 #define EXPAND2_INTFA_BANK1 0x07
118 #define EXPAND2_INTCAPA_BANK1 0x08
119 #define EXPAND2_GPIOA_BANK1 0x09
120 #define EXPAND2_OLATA_BANK1 0x0A
121 #define EXPAND2_IODIRB_BANK1 0x10
122 #define EXPAND2_IPOLB_BANK1 0x11
123 #define EXPAND2_GPINTENB_BANK1 0x12
124 #define EXPAND2_DEFVALB_BANK1 0x13
125 #define EXPAND2_INTCONB_BANK1 0x14
126 #define EXPAND2_IOCONO_BANK1 0x15
127 #define EXPAND2_GPPUB_BANK1 0x16
128 #define EXPAND2_INTFB_BANK1 0x17
129 #define EXPAND2_INTCAPB_BANK1 0x18
130 #define EXPAND2_GPIOB_BANK1 0x19
131 #define EXPAND2_OLATB_BANK1 0x1A
132 
138 #define EXPAND2_IODIRA_BANK0 0x00
139 #define EXPAND2_IODIRB_BANK0 0x01
140 #define EXPAND2_IPOLA_BANK0 0x02
141 #define EXPAND2_IPOLB_BANK0 0x03
142 #define EXPAND2_GPINTENA_BANK0 0x04
143 #define EXPAND2_GPINTENB_BANK0 0x05
144 #define EXPAND2_DEFVALA_BANK0 0x06
145 #define EXPAND2_DEFVALB_BANK0 0x07
146 #define EXPAND2_INTCONA_BANK0 0x08
147 #define EXPAND2_INTCONB_BANK0 0x09
148 #define EXPAND2_IOCON_BANK0 0x0A
149 #define EXPAND2_GPPUA_BANK0 0x0C
150 #define EXPAND2_GPPUB_BANK0 0x0D
151 #define EXPAND2_INTFA_BANK0 0x0E
152 #define EXPAND2_INTFB_BANK0 0x0F
153 #define EXPAND2_INTCAPA_BANK0 0x10
154 #define EXPAND2_INTCAPB_BANK0 0x11
155 #define EXPAND2_GPIOA_BANK0 0x12
156 #define EXPAND2_GPIOB_BANK0 0x13
157 #define EXPAND2_OLATA_BANK0 0x14
158 #define EXPAND2_OLATB_BANK0 0x15
159 
160 #define EXPAND2_HD1_PA0 0x01
161 #define EXPAND2_HD1_PA1 0x02
162 #define EXPAND2_HD1_PA2 0x04
163 #define EXPAND2_HD1_PA3 0x08
164 #define EXPAND2_HD1_PA4 0x10
165 #define EXPAND2_HD1_PA5 0x20
166 #define EXPAND2_HD1_PA6 0x40
167 #define EXPAND2_HD1_PA7 0x80
168 
169 #define EXPAND2_HD2_PB0 0x01
170 #define EXPAND2_HD2_PB1 0x02
171 #define EXPAND2_HD2_PB2 0x04
172 #define EXPAND2_HD2_PB3 0x08
173 #define EXPAND2_HD2_PB4 0x10
174 #define EXPAND2_HD2_PB5 0x20
175 #define EXPAND2_HD2_PB6 0x40
176 #define EXPAND2_HD2_PB7 0x80
177 
178 #define EXPAND2_HD_START_POSITION 0x01
179 
180 #define EXPAND2_INT_ERR 0xFF
181  // End group macro
183 // --------------------------------------------------------------- PUBLIC TYPES
192 typedef struct
193 {
194  // Output pins
195 
196  digital_out_t rst;
197 
198  // Input pins
199 
200  digital_in_t int_pin;
201 
202  // Modules
203 
204  i2c_master_t i2c;
205 
206  // ctx variable
207 
208  uint8_t slave_address;
209 
210 } expand2_t;
211 
215 typedef struct
216 {
217  // Communication gpio pins
218 
219  pin_name_t scl;
220  pin_name_t sda;
221 
222  // Additional gpio pins
223 
224  pin_name_t rst;
225  pin_name_t int_pin;
226 
227  // static variable
228 
229  uint32_t i2c_speed;
230  uint8_t i2c_address;
231 
232 } expand2_cfg_t;
233  // End types group
235 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
236 
242 #ifdef __cplusplus
243 extern "C"{
244 #endif
245 
255 
264 
273 
284 void expand2_generic_write ( expand2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
285 
297 void expand2_generic_read ( expand2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
298 
309 void expand2_set_bits ( expand2_t *ctx, uint8_t module_address, uint8_t reg_address, uint8_t bit_mask );
310 
321 void expand2_clear_bits ( expand2_t *ctx, uint8_t module_address, uint8_t reg_address, uint8_t bit_mask );
322 
333 void expand2_toggle_bits ( expand2_t *ctx, uint8_t module_address, uint8_t reg_address, uint8_t bit_mask );
334 
344 uint8_t expand2_read_port_a ( expand2_t *ctx, uint8_t module_address );
345 
355 uint8_t expand2_read_port_b ( expand2_t *ctx, uint8_t module_address );
356 
366 uint16_t expand2_read_both_ports ( expand2_t *ctx, uint8_t module_address );
367 
377 void expand2_write_port_a ( expand2_t *ctx, uint8_t module_address, uint8_t write_data );
378 
388 void expand2_clear_bit_port_a ( expand2_t *ctx, uint8_t moduleAddress, uint8_t bitMask );
389 
399 void expand2_set_bit_port_a ( expand2_t *ctx, uint8_t module_address, uint8_t bit_mask );
400 
410 void expand2_toggle_bit_port_a ( expand2_t *ctx, uint8_t module_address, uint8_t bit_mask );
411 
421 void expand2_write_port_b ( expand2_t *ctx, uint8_t module_address, uint8_t write_data );
422 
432 void expand2_clear_bit_port_b ( expand2_t *ctx, uint8_t module_address, uint8_t bit_mask );
433 
443 void expand2_setBitPortB( expand2_t *ctx, uint8_t module_address, uint8_t bit_mask );
444 
454 void expand2_toggle_bit_port_b ( expand2_t *ctx, uint8_t module_address, uint8_t bit_mask );
455 
465 void expand2_set_direction_port_a ( expand2_t *ctx, uint8_t module_address, uint8_t write_data );
466 
476 void expand2_set_input_dir_port_a ( expand2_t *ctx, uint8_t module_address, uint8_t bit_mask );
477 
487 void expand2_set_output_dir_port_a ( expand2_t *ctx, uint8_t module_address, uint8_t bit_mask );
488 
498 void expand2_set_direction_port_b ( expand2_t *ctx, uint8_t module_address, uint8_t write_data );
499 
509 void expand2_set_input_dir_port_b ( expand2_t *ctx, uint8_t module_address, uint8_t bit_mask );
510 
520 void expand2_set_output_dir_port_b ( expand2_t *ctx, uint8_t module_address, uint8_t bit_mask );
521 
531 void expand2_set_pull_ups_port_a ( expand2_t *ctx, uint8_t module_address, uint8_t write_data );
532 
542 void expand2_set_pull_ups_port_b ( expand2_t *ctx, uint8_t module_address, uint8_t write_data );
543 
553 void expand2_set_port_a ( expand2_t *ctx, uint8_t module_address, uint8_t position );
554 
564 void expand2_set_port_b ( expand2_t *ctx, uint8_t module_address, uint8_t position );
565 
578 
593 
594 #ifdef __cplusplus
595 }
596 #endif
597 #endif // _EXPAND2_H_
598  // End public_function group
601 
602 // ------------------------------------------------------------------------- END
expand2_set_direction_port_b
void expand2_set_direction_port_b(expand2_t *ctx, uint8_t module_address, uint8_t write_data)
Set expander PORTB direction function.
expand2_set_port_a
void expand2_set_port_a(expand2_t *ctx, uint8_t module_address, uint8_t position)
Active pin by position on PORTA function.
expand2_cfg_t
Click configuration structure definition.
Definition: expand2.h:216
expand2_set_bits
void expand2_set_bits(expand2_t *ctx, uint8_t module_address, uint8_t reg_address, uint8_t bit_mask)
Set register bits function.
expand2_t::slave_address
uint8_t slave_address
Definition: expand2.h:208
expand2_cfg_t::scl
pin_name_t scl
Definition: expand2.h:219
expand2_write_port_a
void expand2_write_port_a(expand2_t *ctx, uint8_t module_address, uint8_t write_data)
Write one byte of data to register for PORTA function.
expand2_t::rst
digital_out_t rst
Definition: expand2.h:196
expand2_set_bit_port_a
void expand2_set_bit_port_a(expand2_t *ctx, uint8_t module_address, uint8_t bit_mask)
Set bit to register for PORTA function.
expand2_cfg_t::int_pin
pin_name_t int_pin
Definition: expand2.h:225
expand2_read_port_b
uint8_t expand2_read_port_b(expand2_t *ctx, uint8_t module_address)
Read one byte of data from PORTB function.
expand2_clear_bit_port_b
void expand2_clear_bit_port_b(expand2_t *ctx, uint8_t module_address, uint8_t bit_mask)
Clear bit from register for PORTB function.
expand2_cfg_setup
void expand2_cfg_setup(expand2_cfg_t *cfg)
Config Object Initialization function.
expand2_write_port_b
void expand2_write_port_b(expand2_t *ctx, uint8_t module_address, uint8_t write_data)
Write one byte of data to register for PORTB function.
expand2_set_input_dir_port_b
void expand2_set_input_dir_port_b(expand2_t *ctx, uint8_t module_address, uint8_t bit_mask)
Set expander PORTB input direction function.
expand2_set_direction_port_a
void expand2_set_direction_port_a(expand2_t *ctx, uint8_t module_address, uint8_t write_data)
Set expander PORTA direction function.
expand2_t::int_pin
digital_in_t int_pin
Definition: expand2.h:200
expand2_toggle_bit_port_b
void expand2_toggle_bit_port_b(expand2_t *ctx, uint8_t module_address, uint8_t bit_mask)
Toggle bit to register for PORTB function.
expand2_t
Click ctx object definition.
Definition: expand2.h:193
expand2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: expand2.h:229
expand2_set_output_dir_port_b
void expand2_set_output_dir_port_b(expand2_t *ctx, uint8_t module_address, uint8_t bit_mask)
Set expander PORTB output direction function.
expand2_toggle_bit_port_a
void expand2_toggle_bit_port_a(expand2_t *ctx, uint8_t module_address, uint8_t bit_mask)
Toggle bit to register for PORTA function.
expand2_init
EXPAND2_RETVAL expand2_init(expand2_t *ctx, expand2_cfg_t *cfg)
Initialization function.
expand2_t::i2c
i2c_master_t i2c
Definition: expand2.h:204
expand2_set_pull_ups_port_b
void expand2_set_pull_ups_port_b(expand2_t *ctx, uint8_t module_address, uint8_t write_data)
Set pull-ups of the expander for PORTB pins function.
expand2_generic_write
void expand2_generic_write(expand2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
expand2_read_port_a
uint8_t expand2_read_port_a(expand2_t *ctx, uint8_t module_address)
Read one byte of data from PORTA function.
expand2_set_input_dir_port_a
void expand2_set_input_dir_port_a(expand2_t *ctx, uint8_t module_address, uint8_t bit_mask)
Set expander PORTA input direction function.
expand2_default_cfg
void expand2_default_cfg(expand2_t *ctx)
Click Default Configuration function.
expand2_clear_bit_port_a
void expand2_clear_bit_port_a(expand2_t *ctx, uint8_t moduleAddress, uint8_t bitMask)
Clear bit from register for PORTA function.
expand2_set_port_b
void expand2_set_port_b(expand2_t *ctx, uint8_t module_address, uint8_t position)
Active pin by position on PORTB function.
expand2_cfg_t::i2c_address
uint8_t i2c_address
Definition: expand2.h:230
EXPAND2_RETVAL
#define EXPAND2_RETVAL
Definition: expand2.h:78
expand2_toggle_bits
void expand2_toggle_bits(expand2_t *ctx, uint8_t module_address, uint8_t reg_address, uint8_t bit_mask)
Toggle register bits function.
expand2_set_pull_ups_port_a
void expand2_set_pull_ups_port_a(expand2_t *ctx, uint8_t module_address, uint8_t write_data)
Set pull-ups of the expander for PORTA pins function.
expand2_setBitPortB
void expand2_setBitPortB(expand2_t *ctx, uint8_t module_address, uint8_t bit_mask)
Set bit to register for PORTB function.
expand2_cfg_t::rst
pin_name_t rst
Definition: expand2.h:224
expand2_set_output_dir_port_a
void expand2_set_output_dir_port_a(expand2_t *ctx, uint8_t module_address, uint8_t bit_mask)
Set expander PORTA output direction function.
expand2_reset
void expand2_reset(expand2_t *ctx)
Reset function.
expand2_getInterrupt
uint8_t expand2_getInterrupt(expand2_t *ctx)
Get state of interrupt pin function.
expand2_clear_bits
void expand2_clear_bits(expand2_t *ctx, uint8_t module_address, uint8_t reg_address, uint8_t bit_mask)
Clear register bits function.
expand2_cfg_t::sda
pin_name_t sda
Definition: expand2.h:220
expand2_read_both_ports
uint16_t expand2_read_both_ports(expand2_t *ctx, uint8_t module_address)
Read two byte of data from PORTA & PORTB function.
expand2_generic_read
void expand2_generic_read(expand2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.