expand9 2.0.0.0
expand9.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 EXPAND9_H
29#define EXPAND9_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#define EXPAND9_REG_INPUT_DISABLE_B 0x00
60#define EXPAND9_REG_INPUT_DISABLE_A 0x01
61#define EXPAND9_REG_LONG_SLEW_B 0x02
62#define EXPAND9_REG_LONG_SLEW_A 0x03
63#define EXPAND9_REG_LOW_DRIVE_B 0x04
64#define EXPAND9_REG_LOW_DRIVE_A 0x05
65#define EXPAND9_REG_PULL_UP_B 0x06
66#define EXPAND9_REG_PULL_UP_A 0x07
67#define EXPAND9_REG_PULL_DOWN_B 0x08
68#define EXPAND9_REG_PULL_DOWN_A 0x09
69#define EXPAND9_REG_OPEN_DRAIN_B 0x0A
70#define EXPAND9_REG_OPEN_DRAIN_A 0x0B
71#define EXPAND9_REG_POLARITY_B 0x0C
72#define EXPAND9_REG_POLARITY_A 0x0D
73#define EXPAND9_REG_DIR_B 0x0E
74#define EXPAND9_REG_DIR_A 0x0F
75#define EXPAND9_REG_DATA_B 0x10
76#define EXPAND9_REG_DATA_A 0x11
77#define EXPAND9_REG_INTERRUPT_MASK_B 0x12
78#define EXPAND9_REG_INTERRUPT_MASK_A 0x13
79#define EXPAND9_REG_SENSE_HIGH_B 0x14
80#define EXPAND9_REG_SENSE_LOW_B 0x15
81#define EXPAND9_REG_SENSE_HIGH_A 0x16
82#define EXPAND9_REG_SENSE_LOW_A 0x17
83#define EXPAND9_REG_INTERRUPT_SOURCE_B 0x18
84#define EXPAND9_REG_INTERRUPT_SOURCE_A 0x19
85#define EXPAND9_REG_EVENT_STATUS_B 0x1A
86#define EXPAND9_REG_EVENT_STATUS_A 0x1B
87#define EXPAND9_REG_LEVEL_SHIFTER_1 0x1C
88#define EXPAND9_REG_LEVEL_SHIFTER_2 0x1D
89#define EXPAND9_REG_CLOCK 0x1E
90#define EXPAND9_REG_MISC 0x1F
91#define EXPAND9_REG_LED_DRIVER_ENABLE_B 0x20
92#define EXPAND9_REG_LED_DRIVER_ENABLE_A 0x21
93#define EXPAND9_REG_DEBOUNCE_CONFIG 0x22
94#define EXPAND9_REG_DEBOUNCE_ENABLE_B 0x23
95#define EXPAND9_REG_DEBOUNCE_ENABLE_A 0x24
96#define EXPAND9_REG_KEY_CONFIG_1 0x25
97#define EXPAND9_REG_KEY_CONFIG_2 0x26
98#define EXPAND9_REG_KEY_DATA_1 0x27
99#define EXPAND9_REG_KEY_DATA_2 0x28
100#define EXPAND9_REG_T_ON_0 0x29
101#define EXPAND9_REG_I_ON_0 0x2A
102#define EXPAND9_REG_OFF_0 0x2B
103#define EXPAND9_REG_T_ON_1 0x2C
104#define EXPAND9_REG_I_ON_1 0x2D
105#define EXPAND9_REG_OFF_1 0x2E
106#define EXPAND9_REG_T_ON_2 0x2F
107#define EXPAND9_REG_I_ON_2 0x30
108#define EXPAND9_REG_OFF_2 0x31
109#define EXPAND9_REG_T_ON_3 0x32
110#define EXPAND9_REG_I_ON_3 0x33
111#define EXPAND9_REG_OFF_3 0x34
112#define EXPAND9_REG_T_ON_4 0x35
113#define EXPAND9_REG_I_ON_4 0x36
114#define EXPAND9_REG_OFF_4 0x37
115#define EXPAND9_REG_T_RISE_4 0x38
116#define EXPAND9_REG_T_FALL_4 0x39
117#define EXPAND9_REG_T_ON_5 0x3A
118#define EXPAND9_REG_I_ON_5 0x3B
119#define EXPAND9_REG_OFF_5 0x3C
120#define EXPAND9_REG_T_RISE_5 0x3D
121#define EXPAND9_REG_T_FALL_5 0x3E
122#define EXPAND9_REG_T_ON_6 0x3F
123#define EXPAND9_REG_I_ON_6 0x40
124#define EXPAND9_REG_OFF_6 0x41
125#define EXPAND9_REG_T_RISE_6 0x42
126#define EXPAND9_REG_T_FALL_6 0x43
127#define EXPAND9_REG_T_ON_7 0x44
128#define EXPAND9_REG_I_ON_7 0x45
129#define EXPAND9_REG_OFF_7 0x46
130#define EXPAND9_REG_T_RISE_7 0x47
131#define EXPAND9_REG_T_FALL_7 0x48
132#define EXPAND9_REG_T_ON_8 0x49
133#define EXPAND9_REG_I_ON_8 0x4A
134#define EXPAND9_REG_OFF_8 0x4B
135#define EXPAND9_REG_T_ON_9 0x4C
136#define EXPAND9_REG_I_ON_9 0x4D
137#define EXPAND9_REG_OFF_9 0x4E
138#define EXPAND9_REG_T_ON_10 0x4F
139#define EXPAND9_REG_I_ON_10 0x50
140#define EXPAND9_REG_OFF_10 0x51
141#define EXPAND9_REG_T_ON_11 0x52
142#define EXPAND9_REG_I_ON_11 0x53
143#define EXPAND9_REG_OFF_11 0x54
144#define EXPAND9_REG_T_ON_12 0x55
145#define EXPAND9_REG_I_ON_12 0x56
146#define EXPAND9_REG_OFF_12 0x57
147#define EXPAND9_REG_T_RISE_12 0x58
148#define EXPAND9_REG_T_FALL_12 0x59
149#define EXPAND9_REG_T_ON_13 0x5A
150#define EXPAND9_REG_I_ON_13 0x5B
151#define EXPAND9_REG_OFF_13 0x5C
152#define EXPAND9_REG_T_RISE_13 0x5D
153#define EXPAND9_REG_T_FALL_13 0x5E
154#define EXPAND9_REG_T_ON_14 0x5F
155#define EXPAND9_REG_I_ON_14 0x60
156#define EXPAND9_REG_OFF_14 0x61
157#define EXPAND9_REG_T_RISE_14 0x62
158#define EXPAND9_REG_T_FALL_14 0x63
159#define EXPAND9_REG_T_ON_15 0x64
160#define EXPAND9_REG_I_ON_15 0x65
161#define EXPAND9_REG_OFF_15 0x66
162#define EXPAND9_REG_T_RISE_15 0x67
163#define EXPAND9_REG_T_FALL_15 0x68
164#define EXPAND9_REG_HIGH_INPUT_B 0x69
165#define EXPAND9_REG_HIGH_INPUT_A 0x6A
166#define EXPAND9_REG_RESET 0x7D
167#define EXPAND9_REG_TEST_1 0x7E
168#define EXPAND9_REG_TEST_2 0x7F
169 // expand9_reg
171
186#define EXPAND9_CHANGE 0x01
187#define EXPAND9_FALLING 0x02
188#define EXPAND9_RISING 0x03
189#define EXPAND9_FREQ_DIV_1 0x01
190#define EXPAND9_FREQ_DIV_2 0x02
191#define EXPAND9_FREQ_DIV_3 0x03
192#define EXPAND9_FREQ_DIV_4 0x04
193#define EXPAND9_FREQ_DIV_5 0x05
194#define EXPAND9_FREQ_DIV_6 0x06
195#define EXPAND9_FREQ_DIV_7 0x07
196#define EXPAND9_LED_MODE_LINEAR 0x00
197#define EXPAND9_LED_MODE_LOGARITHMIC 0x01
198
204#define EXPAND9_SET_DEV_ADDR_GND 0x3E
205#define EXPAND9_SET_DEV_ADDR_VCC 0x70
206 // expand9_set
208
223#define EXPAND9_MAP_MIKROBUS( cfg, mikrobus ) \
224 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
225 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
226 cfg.add = MIKROBUS( mikrobus, MIKROBUS_AN ); \
227 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
228 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
229 // expand9_map // expand9
232
237typedef struct
238{
239 // Output pins
240 digital_out_t add;
241 digital_out_t rst;
244 // Input pins
245 digital_in_t int_pin;
247 // Modules
248 i2c_master_t i2c;
250 // I2C slave address
253} expand9_t;
254
259typedef struct
260{
261 pin_name_t scl;
262 pin_name_t sda;
264 pin_name_t add;
265 pin_name_t rst;
266 pin_name_t int_pin;
268 uint32_t i2c_speed;
269 uint8_t i2c_address;
272
277typedef enum
278{
280 EXPAND9_ERROR = -1
281
283
288typedef enum
289{
292
294
299typedef enum
300{
302 CH_OUTPUT_ON = 1
303
305
322
338
353
369err_t expand9_set_slave_address ( expand9_t *ctx, uint8_t slave_addr );
370
386err_t expand9_generic_write ( expand9_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
387
403err_t expand9_generic_read ( expand9_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
404
419
434err_t expand9_set_ch_direction ( expand9_t *ctx, uint8_t ch_pos, expand9_direction_value_t direction );
435
450
465
481err_t expand9_set_ch_output_state ( expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t ch_state );
482
498err_t expand9_get_ch_output_state ( expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t *ch_state );
499
518err_t expand9_write_ch ( expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t ch_state );
519
535err_t expand9_read_ch ( expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t *ch_state );
536
557err_t expand9_led_driver_config ( expand9_t *ctx, uint8_t ch_pos, uint8_t freq_div, uint8_t lin_log );
558
575err_t expand9_set_intensity ( expand9_t *ctx, uint8_t ch_pos, uint8_t intensity );
576
591err_t expand9_sync ( expand9_t *ctx );
592
617err_t expand9_debounce_config ( expand9_t *ctx, uint8_t config_val );
618
638err_t expand9_enable_ch_interrupt ( expand9_t *ctx, uint8_t ch_pos, uint8_t rise_fall );
639
655
671err_t expand9_check_ch_interrupt ( expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t *int_state );
672
687
688#ifdef __cplusplus
689}
690#endif
691#endif // EXPAND9_H
692 // expand9
694
695// ------------------------------------------------------------------------ END
expand9_direction_value_t
Expand 9 Click direction value data.
Definition: expand9.h:289
@ DIRECTION_INPUT
Definition: expand9.h:290
@ DIRECTION_OUTPUT
Definition: expand9.h:291
expand9_return_value_t
Expand 9 Click return value data.
Definition: expand9.h:278
@ EXPAND9_OK
Definition: expand9.h:279
@ EXPAND9_ERROR
Definition: expand9.h:280
expand9_ch_state_value_t
Expand 9 Click channel state value data.
Definition: expand9.h:300
@ CH_OUTPUT_OFF
Definition: expand9.h:301
@ CH_OUTPUT_ON
Definition: expand9.h:302
uint8_t expand9_check_interrupt_pin(expand9_t *ctx)
Expand 9 check interrupt pin function.
err_t expand9_generic_read(expand9_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Expand 9 I2C reading function.
err_t expand9_set_slave_address(expand9_t *ctx, uint8_t slave_addr)
Expand 9 set I2C Slave address function.
err_t expand9_set_ch_output_state(expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t ch_state)
Expand 9 set channel output state function.
err_t expand9_set_intensity(expand9_t *ctx, uint8_t ch_pos, uint8_t intensity)
Expand 9 set intensity function.
err_t expand9_default_cfg(expand9_t *ctx)
Expand 9 default configuration function.
err_t expand9_set_all_ch_input(expand9_t *ctx)
Expand 9 set all channel input function.
err_t expand9_write_ch(expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t ch_state)
Expand 9 write channel function.
err_t expand9_led_driver_config(expand9_t *ctx, uint8_t ch_pos, uint8_t freq_div, uint8_t lin_log)
Expand 9 LED driver configuration function.
err_t expand9_read_ch(expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t *ch_state)
Expand 9 read channel function.
void expand9_cfg_setup(expand9_cfg_t *cfg)
Expand 9 configuration object setup function.
err_t expand9_soft_reset(expand9_t *ctx)
Expand 9 software reset function.
err_t expand9_enable_ch_interrupt(expand9_t *ctx, uint8_t ch_pos, uint8_t rise_fall)
Expand 9 enable channel interrupt function.
err_t expand9_debounce_config(expand9_t *ctx, uint8_t config_val)
Expand 9 sync function.
err_t expand9_clear_interrupt(expand9_t *ctx)
Expand 9 clear all interrupt function.
err_t expand9_sync(expand9_t *ctx)
Expand 9 sync function.
err_t expand9_set_ch_direction(expand9_t *ctx, uint8_t ch_pos, expand9_direction_value_t direction)
Expand 9 set channel direction function.
err_t expand9_generic_write(expand9_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Expand 9 I2C writing function.
err_t expand9_set_all_ch_output(expand9_t *ctx)
Expand 9 set all channel output function.
err_t expand9_get_ch_output_state(expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t *ch_state)
Expand 9 get channel output state function.
err_t expand9_init(expand9_t *ctx, expand9_cfg_t *cfg)
Expand 9 initialization function.
err_t expand9_check_ch_interrupt(expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t *int_state)
Expand 9 check channel interrupt function.
Expand 9 Click configuration object.
Definition: expand9.h:260
uint32_t i2c_speed
Definition: expand9.h:268
pin_name_t add
Definition: expand9.h:264
pin_name_t scl
Definition: expand9.h:261
pin_name_t int_pin
Definition: expand9.h:266
pin_name_t sda
Definition: expand9.h:262
pin_name_t rst
Definition: expand9.h:265
uint8_t i2c_address
Definition: expand9.h:269
Expand 9 Click context object.
Definition: expand9.h:238
digital_out_t add
Definition: expand9.h:240
digital_in_t int_pin
Definition: expand9.h:245
i2c_master_t i2c
Definition: expand9.h:248
digital_out_t rst
Definition: expand9.h:241
uint8_t slave_address
Definition: expand9.h:251