leddriver19  2.1.0.0
leddriver19.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 LEDDRIVER19_H
29 #define LEDDRIVER19_H
30 
31 #ifdef __cplusplus
32 extern "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 LEDDRIVER19_REG_DEVICE_ID 0x00
60 #define LEDDRIVER19_REG_DEVICE_EN 0x01
61 #define LEDDRIVER19_REG_CH_EN_LOW 0x02
62 #define LEDDRIVER19_REG_CH_EN_HIGH 0x03
63 #define LEDDRIVER19_REG_CONFIG 0x04
64 #define LEDDRIVER19_REG_FAULT_MASK 0x05
65 #define LEDDRIVER19_REG_FAULT_INT 0x06
66 #define LEDDRIVER19_REG_OPEN_LED_LOW 0x07
67 #define LEDDRIVER19_REG_OPEN_LED_HIGH 0x08
68 #define LEDDRIVER19_REG_CUR_LED_CS0 0x09
69 #define LEDDRIVER19_REG_CUR_LED_CS1 0x0A
70 #define LEDDRIVER19_REG_CUR_LED_CS2 0x0B
71 #define LEDDRIVER19_REG_CUR_LED_CS3 0x0C
72 #define LEDDRIVER19_REG_CUR_LED_CS4 0x0D
73 #define LEDDRIVER19_REG_CUR_LED_CS5 0x0E
74 #define LEDDRIVER19_REG_CUR_LED_CS6 0x0F
75 #define LEDDRIVER19_REG_CUR_LED_CS7 0x10
76 #define LEDDRIVER19_REG_CUR_LED_CS8 0x11
77 #define LEDDRIVER19_REG_CUR_LED_CS9 0x12
78 #define LEDDRIVER19_REG_CUR_LED_CS10 0x13
79 #define LEDDRIVER19_REG_CUR_LED_CS11 0x14
80 #define LEDDRIVER19_REG_PATTERN_SEQ_REP 0x15
81 #define LEDDRIVER19_REG_PATTERN_0_DUR 0x16
82 #define LEDDRIVER19_REG_PATTERN_1_DUR 0x17
83 #define LEDDRIVER19_REG_PATTERN_2_DUR 0x18
84 #define LEDDRIVER19_REG_PATTERN_3_DUR 0x19
85 #define LEDDRIVER19_REG_PATTERN_4_DUR 0x1A
86 #define LEDDRIVER19_REG_PATTERN_5_DUR 0x1B
87 #define LEDDRIVER19_REG_PATTERN_6_DUR 0x1C
88 #define LEDDRIVER19_REG_PATTERN_7_DUR 0x1D
89 #define LEDDRIVER19_REG_PWMREG_OFFSET 0x1E
90 #define LEDDRIVER19_REG_CLOCK_CONFIG 0xE0
91 
92  // leddriver19_reg
94 
109 #define LEDDRIVER19_DEVICE_ID 0x12
110 
116 #define LEDDRIVER19_PIN_STATE_HIGH 0x01
117 #define LEDDRIVER19_PIN_STATE_LOW 0x00
118 
124 #define LEDDRIVER19_SW_RESET 0x80
125 #define LEDDRIVER19_ENABLE 0x01
126 
132 #define LEDDRIVER19_PATSEL_0 0x00
133 #define LEDDRIVER19_PATSEL_1 0x01
134 #define LEDDRIVER19_PATSEL_2 0x02
135 #define LEDDRIVER19_PATSEL_3 0x03
136 #define LEDDRIVER19_PATSEL_4 0x04
137 #define LEDDRIVER19_PATSEL_5 0x05
138 #define LEDDRIVER19_PATSEL_6 0x06
139 #define LEDDRIVER19_PATSEL_7 0x07
140 
146 #define LEDDRIVER19_CH_SEL_0 0x00
147 #define LEDDRIVER19_CH_SEL_1 0x01
148 #define LEDDRIVER19_CH_SEL_2 0x02
149 #define LEDDRIVER19_CH_SEL_3 0x03
150 #define LEDDRIVER19_CH_SEL_4 0x04
151 #define LEDDRIVER19_CH_SEL_5 0x05
152 #define LEDDRIVER19_CH_SEL_6 0x06
153 #define LEDDRIVER19_CH_SEL_7 0x07
154 #define LEDDRIVER19_CH_SEL_8 0x08
155 #define LEDDRIVER19_CH_SEL_9 0x09
156 #define LEDDRIVER19_CH_SEL_10 0x0A
157 #define LEDDRIVER19_CH_SEL_11 0x0B
158 
164 #define LEDDRIVER19_SHFT_EN 0x08
165 #define LEDDRIVER19_SHFT_DIS 0x00
166 #define LEDDRIVER19_GCTRL_EN 0x01
167 #define LEDDRIVER19_GCTRL_DIS 0x00
168 #define LEDDRIVER19_PATSR_RUNING 0x01
169 #define LEDDRIVER19_PATSR_DONE 0x00
170 #define LEDDRIVER19_PATS_EN 0x01
171 #define LEDDRIVER19_PATS_DIS 0x00
172 
178 #define LEDDRIVER19_OVTP_MASK 0x01
179 #define LEDDRIVER19_OPEN_MASK 0x02
180 #define LEDDRIVER19_PAT_MASK 0x04
181 #define LEDDRIVER19_SOF_MASK 0x08
182 
188 #define LEDDRIVER19_OVTP 0x01
189 #define LEDDRIVER19_OPEN 0x02
190 #define LEDDRIVER19_PAT 0x04
191 #define LEDDRIVER19_SOF 0x08
192 
198 #define LEDDRIVER19_PATTERN_SEL_OFFSET 0x18
199 
205 #define LEDDRIVER19_PWM_MASK 0x0FFFu
206 
212 #define LEDDRIVER19_CS0_OPEN 0x0001u
213 #define LEDDRIVER19_CS1_OPEN 0x0002u
214 #define LEDDRIVER19_CS2_OPEN 0x0004u
215 #define LEDDRIVER19_CS3_OPEN 0x0008u
216 #define LEDDRIVER19_CS4_OPEN 0x0010u
217 #define LEDDRIVER19_CS5_OPEN 0x0020u
218 #define LEDDRIVER19_CS6_OPEN 0x0040u
219 #define LEDDRIVER19_CS7_OPEN 0x0080u
220 #define LEDDRIVER19_CS8_OPEN 0x0100u
221 #define LEDDRIVER19_CS9_OPEN 0x0200u
222 #define LEDDRIVER19_CS10_OPEN 0x0400u
223 #define LEDDRIVER19_CS11_OPEN 0x0800u
224 
230 #define LEDDRIVER19_CS0_ENABLE 0x0001u
231 #define LEDDRIVER19_CS1_ENABLE 0x0002u
232 #define LEDDRIVER19_CS2_ENABLE 0x0004u
233 #define LEDDRIVER19_CS3_ENABLE 0x0008u
234 #define LEDDRIVER19_CS4_ENABLE 0x0010u
235 #define LEDDRIVER19_CS5_ENABLE 0x0020u
236 #define LEDDRIVER19_CS6_ENABLE 0x0040u
237 #define LEDDRIVER19_CS7_ENABLE 0x0080u
238 #define LEDDRIVER19_CS8_ENABLE 0x0100u
239 #define LEDDRIVER19_CS9_ENABLE 0x0200u
240 #define LEDDRIVER19_CS10_ENABLE 0x0400u
241 #define LEDDRIVER19_CS11_ENABLE 0x0800u
242 #define LEDDRIVER19_CS_ENABLE_ALL 0x0FFFu
243 
249 #define LEDDRIVER19_PWM_VAL_CONVERSION 40.95f
250 #define LEDDRIVER19_CURRENT_STEP_TO_MA 0.07843f
251 #define LEDDRIVER19_CURRENT_STEP_TO_HEX 12.75f
252 
258 #define LEDDRIVER19_DEVICE_ADDRESS_0 0x58
259 #define LEDDRIVER19_DEVICE_ADDRESS_1 0x59
260 #define LEDDRIVER19_DEVICE_ADDRESS_2 0x5A
261 #define LEDDRIVER19_DEVICE_ADDRESS_3 0x5B
262  // leddriver19_set
264 
279 #define LEDDRIVER19_MAP_MIKROBUS( cfg, mikrobus ) \
280  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
281  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
282  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
283  // leddriver19_map // leddriver19
286 
291 typedef struct
292 {
293  // Input pins
294  digital_in_t int_pin;
296  // Modules
297  i2c_master_t i2c;
299  // I2C slave address
300  uint8_t slave_address;
302 } leddriver19_t;
303 
308 typedef struct
309 {
310  pin_name_t scl;
311  pin_name_t sda;
313  pin_name_t int_pin;
315  uint32_t i2c_speed;
316  uint8_t i2c_address;
319 
324 typedef enum
325 {
327  LEDDRIVER19_ERROR = -1
328 
330 
347 
362 
376 
391 err_t leddriver19_generic_write ( leddriver19_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
392 
407 err_t leddriver19_generic_read ( leddriver19_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
408 
418 
432 err_t leddriver19_write_reg ( leddriver19_t *ctx, uint8_t reg, uint8_t data_in );
433 
447 err_t leddriver19_read_reg ( leddriver19_t *ctx, uint8_t reg, uint8_t *data_out );
448 
460 
472 err_t leddriver19_enable_channels ( leddriver19_t *ctx, uint16_t channels_en );
473 
485 err_t leddriver19_disable_channels ( leddriver19_t *ctx, uint16_t channels_dis );
486 
487 
501 err_t leddriver19_set_pattern_pwm ( leddriver19_t *ctx, uint8_t pattern_sel, uint8_t channel_sel,
502  float pwm_value );
503 
516 err_t leddriver19_get_ch_current ( leddriver19_t *ctx, uint8_t channel_sel, float *current_val );
517 
530 err_t leddriver19_set_ch_current ( leddriver19_t *ctx, uint8_t channel_sel, float current_val );
531 
543 err_t leddriver19_get_int_data ( leddriver19_t *ctx, uint8_t *int_data );
544 
556 err_t leddriver19_get_nc_led ( leddriver19_t *ctx, uint16_t *led_data );
557 
558 #ifdef __cplusplus
559 }
560 #endif
561 #endif // LEDDRIVER19_H
562  // leddriver19
564 
565 // ------------------------------------------------------------------------ END
leddriver19_cfg_setup
void leddriver19_cfg_setup(leddriver19_cfg_t *cfg)
LED Driver 19 configuration object setup function.
leddriver19_disable_channels
err_t leddriver19_disable_channels(leddriver19_t *ctx, uint16_t channels_dis)
LED Driver 19 disable channels function.
leddriver19_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: leddriver19.h:315
leddriver19_init
err_t leddriver19_init(leddriver19_t *ctx, leddriver19_cfg_t *cfg)
LED Driver 19 initialization function.
leddriver19_t
LED Driver 19 Click context object.
Definition: leddriver19.h:292
leddriver19_get_nc_led
err_t leddriver19_get_nc_led(leddriver19_t *ctx, uint16_t *led_data)
LED Driver 19 get LED open ( NC channels ) data function.
leddriver19_t::slave_address
uint8_t slave_address
Definition: leddriver19.h:300
leddriver19_t::int_pin
digital_in_t int_pin
Definition: leddriver19.h:294
LEDDRIVER19_ERROR
@ LEDDRIVER19_ERROR
Definition: leddriver19.h:327
leddriver19_cfg_t::scl
pin_name_t scl
Definition: leddriver19.h:310
leddriver19_default_cfg
err_t leddriver19_default_cfg(leddriver19_t *ctx)
LED Driver 19 default configuration function.
leddriver19_get_ch_current
err_t leddriver19_get_ch_current(leddriver19_t *ctx, uint8_t channel_sel, float *current_val)
LED Driver 19 get channel current value function.
leddriver19_get_int_data
err_t leddriver19_get_int_data(leddriver19_t *ctx, uint8_t *int_data)
LED Driver 19 get interrupt register data function.
leddriver19_cfg_t::i2c_address
uint8_t i2c_address
Definition: leddriver19.h:316
leddriver19_sw_reset
err_t leddriver19_sw_reset(leddriver19_t *ctx)
LED Driver 19 software reset function.
leddriver19_generic_read
err_t leddriver19_generic_read(leddriver19_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
LED Driver 19 I2C reading function.
leddriver19_generic_write
err_t leddriver19_generic_write(leddriver19_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
LED Driver 19 I2C writing function.
LEDDRIVER19_OK
@ LEDDRIVER19_OK
Definition: leddriver19.h:326
leddriver19_set_ch_current
err_t leddriver19_set_ch_current(leddriver19_t *ctx, uint8_t channel_sel, float current_val)
LED Driver 19 set channel current value function.
leddriver19_set_pattern_pwm
err_t leddriver19_set_pattern_pwm(leddriver19_t *ctx, uint8_t pattern_sel, uint8_t channel_sel, float pwm_value)
LED Driver 19 set pattern PWM value function.
leddriver19_read_reg
err_t leddriver19_read_reg(leddriver19_t *ctx, uint8_t reg, uint8_t *data_out)
LED Driver 19 I2C register reading function.
leddriver19_write_reg
err_t leddriver19_write_reg(leddriver19_t *ctx, uint8_t reg, uint8_t data_in)
LED Driver 19 I2C register writing function.
leddriver19_enable_channels
err_t leddriver19_enable_channels(leddriver19_t *ctx, uint16_t channels_en)
LED Driver 19 enables channels function.
leddriver19_cfg_t::sda
pin_name_t sda
Definition: leddriver19.h:311
leddriver19_t::i2c
i2c_master_t i2c
Definition: leddriver19.h:297
leddriver19_cfg_t
LED Driver 19 Click configuration object.
Definition: leddriver19.h:309
leddriver19_return_value_t
leddriver19_return_value_t
LED Driver 19 Click return value data.
Definition: leddriver19.h:325
leddriver19_cfg_t::int_pin
pin_name_t int_pin
Definition: leddriver19.h:313
leddriver19_get_int_pin
uint8_t leddriver19_get_int_pin(leddriver19_t *ctx)
LED Driver 19 get interrupt pin state function.