expand15 2.1.0.0
expand15.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 EXPAND15_H
29#define EXPAND15_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59// TODO -- dodati makroe koji definisu adrese registara
60#define EXPAND15_REG_INPUT_PORT_0 0x00
61#define EXPAND15_REG_INPUT_PORT_1 0x01
62#define EXPAND15_REG_OUTPUT_PORT_0 0x02
63#define EXPAND15_REG_OUTPUT_PORT_1 0x03
64#define EXPAND15_REG_POLARITY_INVERSION_0 0x04
65#define EXPAND15_REG_POLARITY_INVERSION_1 0x05
66#define EXPAND15_REG_CONFIGURATION_0 0x06
67#define EXPAND15_REG_CONFIGURATION_1 0x07
68#define EXPAND15_REG_OUTPUT_DRV_STRENGHT_0_0 0x40
69#define EXPAND15_REG_OUTPUT_DRV_STRENGHT_0_1 0x41
70#define EXPAND15_REG_OUTPUT_DRV_STRENGHT_1_0 0x42
71#define EXPAND15_REG_OUTPUT_DRV_STRENGHT_1_1 0x43
72#define EXPAND15_REG_INPUT_LATCH_0 0x44
73#define EXPAND15_REG_INPUT_LATCH_1 0x45
74#define EXPAND15_REG_PULL_UP_DOWN_EN_0 0x46
75#define EXPAND15_REG_PULL_UP_DOWN_EN_1 0x47
76#define EXPAND15_REG_PULL_UP_DOWN_SELECT_0 0x48
77#define EXPAND15_REG_PULL_UP_DOWN_SELECT_1 0x49
78#define EXPAND15_REG_INTERRUPT_MASK_0 0x4A
79#define EXPAND15_REG_INTERRUPT_MASK_1 0x4B
80#define EXPAND15_REG_INTERRUPT_STATUS_0 0x4C
81#define EXPAND15_REG_INTERRUPT_STATUS_1 0x4D
82#define EXPAND15_REG_OUTPUT_PORT_CFG 0x4F
83
84 // expand15_reg
86
101// TODO -- dodati makroe koji definisu komande/vrednosti koje se upisuju u registre
102#define EXPAND15_PIN_00_MASK 0x01
103#define EXPAND15_PIN_01_MASK 0x02
104#define EXPAND15_PIN_02_MASK 0x04
105#define EXPAND15_PIN_03_MASK 0x08
106#define EXPAND15_PIN_04_MASK 0x10
107#define EXPAND15_PIN_05_MASK 0x20
108#define EXPAND15_PIN_06_MASK 0x40
109#define EXPAND15_PIN_07_MASK 0x80
110#define EXPAND15_PIN_10_MASK 0x01
111#define EXPAND15_PIN_11_MASK 0x02
112#define EXPAND15_PIN_12_MASK 0x04
113#define EXPAND15_PIN_13_MASK 0x08
114#define EXPAND15_PIN_14_MASK 0x10
115#define EXPAND15_PIN_15_MASK 0x20
116#define EXPAND15_PIN_16_MASK 0x40
117#define EXPAND15_PIN_17_MASK 0x80
118
119#define EXPAND15_PORT_0 0x00
120#define EXPAND15_PORT_1 0x01
121
122#define EXPAND15_OUTPUT_STRENGHT_FULL 0x03
123#define EXPAND15_OUTPUT_STRENGHT_3_QUARTERS 0x02
124#define EXPAND15_OUTPUT_STRENGHT_HALF 0x01
125#define EXPAND15_OUTPUT_STRENGHT_1_QUARTER 0x00
126
127#define EXPAND15_PORT_PUSH_PULL 0x00
128#define EXPAND15_PORT_OPEN_DRAIN 0x01
129
130#define EXPAND15_ALL_PINS_ON 0xFF
131#define EXPAND15_ALL_PINS_OFF 0x00
132
138#define EXPAND15_DEVICE_ADDRESS_GND 0x20
139#define EXPAND15_DEVICE_ADDRESS_VCC 0x21
140 // expand15_set
142
157#define EXPAND15_MAP_MIKROBUS( cfg, mikrobus ) \
158 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
159 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
160 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
161 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
162 // expand15_map // expand15
165
170typedef struct
171{
172 // Output pins
173 digital_out_t rst;
175 // Input pins
176 digital_in_t int_pin;
178 // Modules
179 i2c_master_t i2c;
181 // I2C slave address
184} expand15_t;
185
190typedef struct
191{
192 pin_name_t scl;
193 pin_name_t sda;
195 pin_name_t rst;
196 pin_name_t int_pin;
198 uint32_t i2c_speed;
199 uint8_t i2c_address;
202
207typedef enum
208{
210 EXPAND15_ERROR = -1
211
213
230
245
259
274err_t expand15_generic_write ( expand15_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
275
290err_t expand15_generic_read ( expand15_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
291
301
311
324err_t expand15_get_input_pins_state ( expand15_t *ctx, uint8_t port, uint8_t *pin_state );
325
338err_t expand15_get_output_pins_state ( expand15_t *ctx, uint8_t port, uint8_t *pin_state );
339
352err_t expand15_set_output_pins_state ( expand15_t *ctx, uint8_t port, uint8_t pin_state );
353
366err_t expand15_get_input_pins_polarity ( expand15_t *ctx, uint8_t port, uint8_t *pin_polarity );
367
380err_t expand15_set_input_pins_polarity ( expand15_t *ctx, uint8_t port, uint8_t pin_polarity );
381
394err_t expand15_get_pin_configuration ( expand15_t *ctx, uint8_t port, uint8_t *pin_config );
395
408err_t expand15_set_pins_as_input ( expand15_t *ctx, uint8_t port, uint8_t pin_config );
409
422err_t expand15_set_pins_as_output ( expand15_t *ctx, uint8_t port, uint8_t pin_config );
423
436err_t expand15_get_output_level ( expand15_t *ctx, uint8_t port, uint16_t *pin_output_level );
437
450err_t expand15_set_output_level ( expand15_t *ctx, uint8_t port, uint16_t pin_output_level );
451
465err_t expand15_set_output_pin_srenght( expand15_t *ctx, uint8_t port, uint8_t pin, uint8_t strenght );
466
479err_t expand15_set_enable_pull_up_down ( expand15_t *ctx, uint8_t port, uint8_t port_config );
480
493err_t expand15_get_enable_pull_up_down ( expand15_t *ctx, uint8_t port, uint8_t *port_config );
494
507err_t expand15_set_pull_up_down ( expand15_t *ctx, uint8_t port, uint8_t pin_config );
508
521err_t expand15_get_pull_up_down ( expand15_t *ctx, uint8_t port, uint8_t *pin_config );
522
535err_t expand15_set_interrupt_mask ( expand15_t *ctx, uint8_t port, uint8_t int_config );
536
549err_t expand15_get_interrupt_mask ( expand15_t *ctx, uint8_t port, uint8_t *int_config );
550
563err_t expand15_get_interrupt_status ( expand15_t *ctx, uint8_t port, uint8_t *int_status );
564
577err_t expand15_get_output_port_config ( expand15_t *ctx, uint8_t *port0_cfg, uint8_t *port1_cfg );
578
591err_t expand15_set_output_port_config ( expand15_t *ctx, uint8_t port0_cfg, uint8_t port1_cfg );
592
593#ifdef __cplusplus
594}
595#endif
596#endif // EXPAND15_H
597 // expand15
599
600// ------------------------------------------------------------------------ END
expand15_return_value_t
Expand 15 Click return value data.
Definition: expand15.h:208
@ EXPAND15_OK
Definition: expand15.h:209
@ EXPAND15_ERROR
Definition: expand15.h:210
err_t expand15_get_input_pins_polarity(expand15_t *ctx, uint8_t port, uint8_t *pin_polarity)
Expand 15 get input pin polarity function.
err_t expand15_set_output_port_config(expand15_t *ctx, uint8_t port0_cfg, uint8_t port1_cfg)
Expand 15 set output port configuration function.
err_t expand15_get_pull_up_down(expand15_t *ctx, uint8_t port, uint8_t *pin_config)
Expand 15 get pull up/down function.
err_t expand15_get_interrupt_status(expand15_t *ctx, uint8_t port, uint8_t *int_status)
Expand 15 get interrupt status function.
err_t expand15_default_cfg(expand15_t *ctx)
Expand 15 default configuration function.
err_t expand15_set_output_pins_state(expand15_t *ctx, uint8_t port, uint8_t pin_state)
Expand 15 set output pin state function.
err_t expand15_generic_read(expand15_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Expand 15 I2C reading function.
err_t expand15_generic_write(expand15_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Expand 15 I2C writing function.
err_t expand15_set_pull_up_down(expand15_t *ctx, uint8_t port, uint8_t pin_config)
Expand 15 set pull up/down function.
err_t expand15_get_input_pins_state(expand15_t *ctx, uint8_t port, uint8_t *pin_state)
Expand 15 get input pin state function.
err_t expand15_get_output_level(expand15_t *ctx, uint8_t port, uint16_t *pin_output_level)
Expand 15 get output level function.
err_t expand15_set_output_level(expand15_t *ctx, uint8_t port, uint16_t pin_output_level)
Expand 15 set output level function.
err_t expand15_get_pin_configuration(expand15_t *ctx, uint8_t port, uint8_t *pin_config)
Expand 15 get pin configuration function.
err_t expand15_get_output_port_config(expand15_t *ctx, uint8_t *port0_cfg, uint8_t *port1_cfg)
Expand 15 get output port configuration function.
uint8_t expand15_get_interrupt_pin_state(expand15_t *ctx)
Expand 15 get interrupt function.
err_t expand15_set_enable_pull_up_down(expand15_t *ctx, uint8_t port, uint8_t port_config)
Expand 15 set enable pull up/down function.
err_t expand15_set_output_pin_srenght(expand15_t *ctx, uint8_t port, uint8_t pin, uint8_t strenght)
Expand 15 set pin output strenght function.
err_t expand15_set_input_pins_polarity(expand15_t *ctx, uint8_t port, uint8_t pin_polarity)
Expand 15 set input pin polarity function.
err_t expand15_get_interrupt_mask(expand15_t *ctx, uint8_t port, uint8_t *int_config)
Expand 15 get interrupt mask function.
void expand15_cfg_setup(expand15_cfg_t *cfg)
Expand 15 configuration object setup function.
void expand15_hw_reset(expand15_t *ctx)
Expand 15 hardware reset function.
err_t expand15_set_pins_as_output(expand15_t *ctx, uint8_t port, uint8_t pin_config)
Expand 15 set pin as output function.
err_t expand15_set_interrupt_mask(expand15_t *ctx, uint8_t port, uint8_t int_config)
Expand 15 set interrupt mask function.
err_t expand15_get_enable_pull_up_down(expand15_t *ctx, uint8_t port, uint8_t *port_config)
Expand 15 get enable pull up/down function.
err_t expand15_set_pins_as_input(expand15_t *ctx, uint8_t port, uint8_t pin_config)
Expand 15 set pin as input function.
err_t expand15_init(expand15_t *ctx, expand15_cfg_t *cfg)
Expand 15 initialization function.
err_t expand15_get_output_pins_state(expand15_t *ctx, uint8_t port, uint8_t *pin_state)
Expand 15 get output pin state function.
Expand 15 Click configuration object.
Definition: expand15.h:191
uint32_t i2c_speed
Definition: expand15.h:198
pin_name_t scl
Definition: expand15.h:192
pin_name_t int_pin
Definition: expand15.h:196
pin_name_t sda
Definition: expand15.h:193
pin_name_t rst
Definition: expand15.h:195
uint8_t i2c_address
Definition: expand15.h:199
Expand 15 Click context object.
Definition: expand15.h:171
digital_in_t int_pin
Definition: expand15.h:176
i2c_master_t i2c
Definition: expand15.h:179
digital_out_t rst
Definition: expand15.h:173
uint8_t slave_address
Definition: expand15.h:182