expand  2.0.0.0
expand.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 EXPAND_H
36 #define EXPAND_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define EXPAND_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
56  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
57  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
58  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
60  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
61 
67 #define EXPAND_RETVAL uint8_t
68 
69 #define EXPAND_OK 0x00
70 #define EXPAND_INIT_ERROR 0xFF
71 
77 #define EXPAND_SPI_DEVICE_OPCODE 0x40
78 #define EXPAND_OPCODE_WRITE 0xFE
79 #define EXPAND_OPCODE_READ 0x01
80 
86 #define EXPAND_SPI_MODULE_POSITION_0 0x00
87 #define EXPAND_SPI_MODULE_POSITION_1 0x02
88 #define EXPAND_SPI_MODULE_POSITION_2 0x04
89 #define EXPAND_SPI_MODULE_POSITION_3 0x06
90 #define EXPAND_SPI_MODULE_POSITION_4 0x08
91 #define EXPAND_SPI_MODULE_POSITION_5 0x0A
92 #define EXPAND_SPI_MODULE_POSITION_6 0x0C
93 #define EXPAND_SPI_MODULE_POSITION_7 0x0E
94 
100 #define EXPAND_PORT_DIRECTION_OUTPUT 0x00
101 #define EXPAND_PORT_DIRECTION_INPUT 0xFF
102 
108 #define EXPAND_IODIRA_BANK1 0x00
109 #define EXPAND_IPOLA_BANK1 0x01
110 #define EXPAND_GPINTENA_BANK1 0x02
111 #define EXPAND_DEFVALA_BANK1 0x03
112 #define EXPAND_INTCONA_BANK1 0x04
113 #define EXPAND_IOCON_BANK1 0x05
114 #define EXPAND_GPPUA_BANK1 0x06
115 #define EXPAND_INTFA_BANK1 0x07
116 #define EXPAND_INTCAPA_BANK1 0x08
117 #define EXPAND_GPIOA_BANK1 0x09
118 #define EXPAND_OLATA_BANK1 0x0A
119 #define EXPAND_IODIRB_BANK1 0x10
120 #define EXPAND_IPOLB_BANK1 0x11
121 #define EXPAND_GPINTENB_BANK1 0x12
122 #define EXPAND_DEFVALB_BANK1 0x13
123 #define EXPAND_INTCONB_BANK1 0x14
124 #define EXPAND_IOCONO_BANK1 0x15
125 #define EXPAND_GPPUB_BANK1 0x16
126 #define EXPAND_INTFB_BANK1 0x17
127 #define EXPAND_INTCAPB_BANK1 0x18
128 #define EXPAND_GPIOB_BANK1 0x19
129 #define EXPAND_OLATB_BANK1 0x1A
130 
137 #define EXPAND_IODIRA_BANK0 0x00
138 #define EXPAND_IODIRB_BANK0 0x01
139 #define EXPAND_IPOLA_BANK0 0x02
140 #define EXPAND_IPOLB_BANK0 0x03
141 #define EXPAND_GPINTENA_BANK0 0x04
142 #define EXPAND_GPINTENB_BANK0 0x05
143 #define EXPAND_DEFVALA_BANK0 0x06
144 #define EXPAND_DEFVALB_BANK0 0x07
145 #define EXPAND_INTCONA_BANK0 0x08
146 #define EXPAND_INTCONB_BANK0 0x09
147 #define EXPAND_IOCON_BANK0 0x0A
148 #define EXPAND_GPPUA_BANK0 0x0C
149 #define EXPAND_GPPUB_BANK0 0x0D
150 #define EXPAND_INTFA_BANK0 0x0E
151 #define EXPAND_INTFB_BANK0 0x0F
152 #define EXPAND_INTCAPA_BANK0 0x10
153 #define EXPAND_INTCAPB_BANK0 0x11
154 #define EXPAND_GPIOA_BANK0 0x12
155 #define EXPAND_GPIOB_BANK0 0x13
156 #define EXPAND_OLATA_BANK0 0x14
157 #define EXPAND_OLATB_BANK0 0x15
158 
164 #define EXPAND_IOCON_BYTE_MODE 0x20
165 #define EXPAND_IOCON_HAEN 0x08
166 
167 #define EXPAND_CN4_PA0 0x01
168 #define EXPAND_CN4_PA1 0x02
169 #define EXPAND_CN4_PA2 0x04
170 #define EXPAND_CN4_PA3 0x08
171 #define EXPAND_CN4_PA4 0x10
172 #define EXPAND_CN4_PA5 0x20
173 #define EXPAND_CN4_PA6 0x40
174 #define EXPAND_CN4_PA7 0x80
175 
176 #define EXPAND_CN5_PB0 0x01
177 #define EXPAND_CN5_PB1 0x02
178 #define EXPAND_CN5_PB2 0x04
179 #define EXPAND_CN5_PB3 0x08
180 #define EXPAND_CN5_PB4 0x10
181 #define EXPAND_CN5_PB5 0x20
182 #define EXPAND_CN5_PB6 0x40
183 #define EXPAND_CN5_PB7 0x80
184 
185 #define EXPAND_CN_START_POSITION 0x01
186 
187 #define EXPAND_INT_ERR 0xFF
188  // End group macro
191 // --------------------------------------------------------------- PUBLIC TYPES
200 typedef struct
201 {
202  // Output pins
203 
204  digital_out_t cs;
205  digital_out_t rst;
206 
207  // Input pins
208 
209  digital_in_t int_pin;
210 
211  // Modules
212 
213  spi_master_t spi;
214  pin_name_t chip_select;
215 
216 } expand_t;
217 
221 typedef struct
222 {
223  // Communication gpio pins
224 
225  pin_name_t miso;
226  pin_name_t mosi;
227  pin_name_t sck;
228  pin_name_t cs;
229 
230  // Additional gpio pins
231 
232  pin_name_t rst;
233  pin_name_t int_pin;
234 
235  // static variable
236 
237  uint32_t spi_speed;
238  spi_master_mode_t spi_mode;
239  spi_master_chip_select_polarity_t cs_polarity;
240 
241 } expand_cfg_t;
242  // End types group
244 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
245 
250 #ifdef __cplusplus
251 extern "C"{
252 #endif
253 
262 void expand_cfg_setup ( expand_cfg_t *cfg );
263 
272 
282 uint8_t expand_read_byte ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr );
293 void expand_write_byte ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t write_data );
294 
303 void expand_default_configuration ( expand_t *ctx, uint8_t mod_cmd );
304 
315 void expand_set_bits ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t bit_mask );
316 
327 void expand_clear_bits ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t bit_mask );
328 
339 void expand_toggle_bits ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t bit_mask );
340 
351 uint8_t expand_read_port_a ( expand_t *ctx, uint8_t mod_cmd );
352 
363 uint8_t expand_read_port_b ( expand_t *ctx, uint8_t mod_cmd );
364 
375 uint16_t expand_read_both_porta ( expand_t *ctx, uint8_t mod_cmd );
376 
386 void expand_write_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
387 
397 void expand_clear_bit_port_a( uint8_t mod_cmd, uint8_t bit_mask );
398 
408 void expand_set_bit_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
409 
419 void expand_toggle_bit_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
420 
431 void expand_write_port_b( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
432 
442 void expand_clear_bit_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
443 
453 void expand_set_bit_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
454 
464 void expand_toggle_bit_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
465 
476 void expand_set_direction_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
477 
488 void expand_set_input_dir_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
489 
500 void expand_set_output_dir_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
501 
512 void expand_set_direction_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
513 
524 void expand_set_input_dir_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
525 
536 void expand_set_output_dir_port_b( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
537 
549 void expand_set_pull_ups_port_a( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
550 
562 void expand_set_pull_ups_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
563 
572 void expand_set_potr_a( expand_t *ctx, uint8_t position );
573 
582 void expand_set_potr_b ( expand_t *ctx, uint8_t position );
583 
596 void expand_reset ( expand_t *ctx );
597 
608 uint8_t expand_get_interrupt( expand_t *ctx );
609 
610 #ifdef __cplusplus
611 }
612 #endif
613 #endif // _EXPAND_H_
614  // End public_function group
617 
618 // ------------------------------------------------------------------------- END
expand_t
Click ctx object definition.
Definition: expand.h:200
expand_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: expand.h:239
expand_read_byte
uint8_t expand_read_byte(expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr)
Generic read one bayt from register function.
expand_write_byte
void expand_write_byte(expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t write_data)
Generic write one bayt to register function.
expand_t::cs
digital_out_t cs
Definition: expand.h:204
expand_cfg_setup
void expand_cfg_setup(expand_cfg_t *cfg)
Config Object Initialization function.
expand_write_port_a
void expand_write_port_a(expand_t *ctx, uint8_t mod_cmd, uint8_t write_data)
Write one byte of data to register for PORTA function.
expand_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: expand.h:238
expand_cfg_t::rst
pin_name_t rst
Definition: expand.h:232
expand_cfg_t::int_pin
pin_name_t int_pin
Definition: expand.h:233
expand_set_input_dir_port_a
void expand_set_input_dir_port_a(expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask)
Set expander PORTA input direction function.
expand_cfg_t::cs
pin_name_t cs
Definition: expand.h:228
expand_set_pull_ups_port_b
void expand_set_pull_ups_port_b(expand_t *ctx, uint8_t mod_cmd, uint8_t write_data)
Set pull-ups of the expander for PORTB pins function.
expand_clear_bit_port_b
void expand_clear_bit_port_b(expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask)
Clear bit from register for PORTB function.
expand_read_port_b
uint8_t expand_read_port_b(expand_t *ctx, uint8_t mod_cmd)
Read one byte of data from PORTB function.
expand_set_bit_port_a
void expand_set_bit_port_a(expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask)
Set bit to register for PORTA function.
expand_clear_bits
void expand_clear_bits(expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t bit_mask)
Clear register bits function.
expand_write_port_b
void expand_write_port_b(expand_t *ctx, uint8_t mod_cmd, uint8_t write_data)
Write one byte of data to register for PORTB function.
expand_read_both_porta
uint16_t expand_read_both_porta(expand_t *ctx, uint8_t mod_cmd)
Read two byte of data from PORTA & PORTB function.
expand_toggle_bit_port_b
void expand_toggle_bit_port_b(expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask)
Toggle bit to register for PORTB function.
expand_get_interrupt
uint8_t expand_get_interrupt(expand_t *ctx)
Get state of interrupt pin function.
expand_toggle_bits
void expand_toggle_bits(expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t bit_mask)
Toggle register bits function.
expand_init
EXPAND_RETVAL expand_init(expand_t *ctx, expand_cfg_t *cfg)
Initialization function.
expand_default_configuration
void expand_default_configuration(expand_t *ctx, uint8_t mod_cmd)
Generic write one bayt to register function.
expand_set_output_dir_port_a
void expand_set_output_dir_port_a(expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask)
Set expander PORTA output direction function.
expand_t::chip_select
pin_name_t chip_select
Definition: expand.h:214
expand_set_direction_port_a
void expand_set_direction_port_a(expand_t *ctx, uint8_t mod_cmd, uint8_t write_data)
Set expander PORTA direction function.
expand_cfg_t::mosi
pin_name_t mosi
Definition: expand.h:226
expand_set_output_dir_port_b
void expand_set_output_dir_port_b(expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask)
Set expander PORTB output direction function.
expand_cfg_t::miso
pin_name_t miso
Definition: expand.h:225
expand_set_pull_ups_port_a
void expand_set_pull_ups_port_a(expand_t *ctx, uint8_t mod_cmd, uint8_t write_data)
Set pull-ups of the expander for PORTA pins function.
expand_reset
void expand_reset(expand_t *ctx)
Reset function.
expand_set_bits
void expand_set_bits(expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t bit_mask)
Set register bits function.
expand_t::spi
spi_master_t spi
Definition: expand.h:213
expand_cfg_t
Click configuration structure definition.
Definition: expand.h:221
expand_set_potr_a
void expand_set_potr_a(expand_t *ctx, uint8_t position)
Active pin by position on PORTA function.
expand_t::rst
digital_out_t rst
Definition: expand.h:205
expand_cfg_t::spi_speed
uint32_t spi_speed
Definition: expand.h:237
expand_cfg_t::sck
pin_name_t sck
Definition: expand.h:227
expand_toggle_bit_port_a
void expand_toggle_bit_port_a(expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask)
Toggle bit to register for PORTA function.
expand_set_bit_port_b
void expand_set_bit_port_b(expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask)
Set bit to register for PORTB function.
expand_clear_bit_port_a
void expand_clear_bit_port_a(uint8_t mod_cmd, uint8_t bit_mask)
Clear bit from register for PORTA function.
expand_read_port_a
uint8_t expand_read_port_a(expand_t *ctx, uint8_t mod_cmd)
Read one byte of data from PORTA function.
expand_set_input_dir_port_b
void expand_set_input_dir_port_b(expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask)
Set expander PORTB input direction function.
expand_set_potr_b
void expand_set_potr_b(expand_t *ctx, uint8_t position)
Active pin by position on PORTB function.
EXPAND_RETVAL
#define EXPAND_RETVAL
Definition: expand.h:67
expand_set_direction_port_b
void expand_set_direction_port_b(expand_t *ctx, uint8_t mod_cmd, uint8_t write_data)
Set expander PORTB direction function.
expand_t::int_pin
digital_in_t int_pin
Definition: expand.h:209