leddriver8  2.0.0.0
leddriver8.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 LEDDRIVER8_H
36 #define LEDDRIVER8_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
63 #define LEDDRIVER8_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
70 
76 #define LEDDRIVER8_RETVAL uint8_t
77 
78 #define LEDDRIVER8_OK 0x00
79 #define LEDDRIVER8_INIT_ERROR 0xFF
80 
86 #define LEDDRIVER8_REG_MODE_1 0x00
87 #define LEDDRIVER8_REG_MODE_2 0x01
88 #define LEDDRIVER8_REG_OUT_ERROR_FLAG_0 0x02
89 #define LEDDRIVER8_REG_OUT_ERROR_FLAG_1 0x03
90 #define LEDDRIVER8_REG_OUT_ERROR_FLAG_2 0x04
91 #define LEDDRIVER8_REG_OUT_ERROR_FLAG_3 0x05
92 #define LEDDRIVER8_REG_OUT_ERROR_FLAG_4 0x06
93 #define LEDDRIVER8_REG_OUT_ERROR_FLAG_5 0x07
94 #define LEDDRIVER8_REG_LED_OUTPUT_0 0x08
95 #define LEDDRIVER8_REG_LED_OUTPUT_1 0x09
96 #define LEDDRIVER8_REG_LED_OUTPUT_2 0x0A
97 #define LEDDRIVER8_REG_LED_OUTPUT_3 0x0B
98 #define LEDDRIVER8_REG_LED_OUTPUT_4 0x0C
99 #define LEDDRIVER8_REG_LED_OUTPUT_5 0x0D
100 #define LEDDRIVER8_REG_GRP_PWM 0x0E
101 #define LEDDRIVER8_REG_GRP_FREQ 0x0F
102 #define LEDDRIVER8_REG_BRIGHTNESS_LED_0 0x10
103 #define LEDDRIVER8_REG_BRIGHTNESS_LED_1 0x11
104 #define LEDDRIVER8_REG_BRIGHTNESS_LED_2 0x12
105 #define LEDDRIVER8_REG_BRIGHTNESS_LED_3 0x13
106 #define LEDDRIVER8_REG_BRIGHTNESS_LED_4 0x14
107 #define LEDDRIVER8_REG_BRIGHTNESS_LED_5 0x15
108 #define LEDDRIVER8_REG_BRIGHTNESS_LED_6 0x16
109 #define LEDDRIVER8_REG_BRIGHTNESS_LED_7 0x17
110 #define LEDDRIVER8_REG_BRIGHTNESS_LED_8 0x18
111 #define LEDDRIVER8_REG_BRIGHTNESS_LED_9 0x19
112 #define LEDDRIVER8_REG_BRIGHTNESS_LED_10 0x1A
113 #define LEDDRIVER8_REG_BRIGHTNESS_LED_11 0x1B
114 #define LEDDRIVER8_REG_BRIGHTNESS_LED_12 0x1C
115 #define LEDDRIVER8_REG_BRIGHTNESS_LED_13 0x1D
116 #define LEDDRIVER8_REG_BRIGHTNESS_LED_14 0x1E
117 #define LEDDRIVER8_REG_BRIGHTNESS_LED_15 0x1F
118 #define LEDDRIVER8_REG_BRIGHTNESS_LED_16 0x20
119 #define LEDDRIVER8_REG_BRIGHTNESS_LED_17 0x21
120 #define LEDDRIVER8_REG_BRIGHTNESS_LED_18 0x22
121 #define LEDDRIVER8_REG_BRIGHTNESS_LED_19 0x23
122 #define LEDDRIVER8_REG_BRIGHTNESS_LED_20 0x24
123 #define LEDDRIVER8_REG_BRIGHTNESS_LED_21 0x25
124 #define LEDDRIVER8_REG_BRIGHTNESS_LED_22 0x26
125 #define LEDDRIVER8_REG_BRIGHTNESS_LED_23 0x27
126 #define LEDDRIVER8_REG_IREF_0 0x28
127 #define LEDDRIVER8_REG_IREF_1 0x29
128 #define LEDDRIVER8_REG_IREF_2 0x2A
129 #define LEDDRIVER8_REG_IREF_3 0x2B
130 #define LEDDRIVER8_REG_IREF_4 0x2C
131 #define LEDDRIVER8_REG_IREF_5 0x2D
132 #define LEDDRIVER8_REG_IREF_6 0x2E
133 #define LEDDRIVER8_REG_IREF_7 0x2F
134 #define LEDDRIVER8_REG_IREF_8 0x30
135 #define LEDDRIVER8_REG_IREF_9 0x31
136 #define LEDDRIVER8_REG_IREF_10 0x32
137 #define LEDDRIVER8_REG_IREF_11 0x33
138 #define LEDDRIVER8_REG_IREF_12 0x34
139 #define LEDDRIVER8_REG_IREF_13 0x35
140 #define LEDDRIVER8_REG_IREF_14 0x36
141 #define LEDDRIVER8_REG_IREF_15 0x37
142 #define LEDDRIVER8_REG_IREF_16 0x38
143 #define LEDDRIVER8_REG_IREF_17 0x39
144 #define LEDDRIVER8_REG_IREF_18 0x3A
145 #define LEDDRIVER8_REG_IREF_19 0x3B
146 #define LEDDRIVER8_REG_IREF_20 0x3C
147 #define LEDDRIVER8_REG_IREF_21 0x3D
148 #define LEDDRIVER8_REG_IREF_22 0x3E
149 #define LEDDRIVER8_REG_IREF_23 0x3F
150 #define LEDDRIVER8_REG_RAMP_RATE_GRP0 0x40
151 #define LEDDRIVER8_REG_STEP_TIME_GRP0 0x41
152 #define LEDDRIVER8_REG_HOLD_CNTL_GRP0 0x42
153 #define LEDDRIVER8_REG_IREF_GRP0 0x43
154 #define LEDDRIVER8_REG_RAMP_RATE_GRP1 0x44
155 #define LEDDRIVER8_REG_STEP_TIME_GRP1 0x45
156 #define LEDDRIVER8_REG_HOLD_CNTL_GRP1 0x46
157 #define LEDDRIVER8_REG_IREF_GRP1 0x47
158 #define LEDDRIVER8_REG_RAMP_RATE_GRP2 0x48
159 #define LEDDRIVER8_REG_STEP_TIME_GRP2 0x49
160 #define LEDDRIVER8_REG_HOLD_CNTL_GRP2 0x4A
161 #define LEDDRIVER8_REG_IREF_GRP2 0x4B
162 #define LEDDRIVER8_REG_RAMP_RATE_GRP3 0x4C
163 #define LEDDRIVER8_REG_STEP_TIME_GRP3 0x4D
164 #define LEDDRIVER8_REG_HOLD_CNTL_GRP3 0x4E
165 #define LEDDRIVER8_REG_IREF_GRP3 0x4F
166 #define LEDDRIVER8_REG_RAMP_RATE_GRP4 0x50
167 #define LEDDRIVER8_REG_STEP_TIME_GRP4 0x51
168 #define LEDDRIVER8_REG_HOLD_CNTL_GRP4 0x52
169 #define LEDDRIVER8_REG_IREF_GRP4 0x53
170 #define LEDDRIVER8_REG_RAMP_RATE_GRP5 0x54
171 #define LEDDRIVER8_REG_STEP_TIME_GRP5 0x55
172 #define LEDDRIVER8_REG_HOLD_CNTL_GRP5 0x56
173 #define LEDDRIVER8_REG_IREF_GRP5 0x57
174 #define LEDDRIVER8_REG_GRAD_MODE_SEL0 0x58
175 #define LEDDRIVER8_REG_GRAD_MODE_SEL1 0x59
176 #define LEDDRIVER8_REG_GRAD_MODE_SEL2 0x5A
177 #define LEDDRIVER8_REG_GRAD_GRP_SEL0 0x5B
178 #define LEDDRIVER8_REG_GRAD_GRP_SEL1 0x5C
179 #define LEDDRIVER8_REG_GRAD_GRP_SEL2 0x5D
180 #define LEDDRIVER8_REG_GRAD_GRP_SEL3 0x5E
181 #define LEDDRIVER8_REG_GRAD_GRP_SEL4 0x5F
182 #define LEDDRIVER8_REG_GRAD_GRP_SEL5 0x60
183 #define LEDDRIVER8_REG_GRAD_GRP_SEL6 0x61
184 #define LEDDRIVER8_REG_GRAD_GRP_SEL7 0x62
185 #define LEDDRIVER8_REG_GRAD_GRP_SEL8 0x63
186 #define LEDDRIVER8_REG_GRAD_GRP_SEL9 0x64
187 #define LEDDRIVER8_REG_GRAD_GRP_SEL10 0x65
188 #define LEDDRIVER8_REG_GRAD_GRP_SEL11 0x66
189 #define LEDDRIVER8_REG_GRAD_CTRL_0 0x67
190 #define LEDDRIVER8_REG_GRAD_CTRL_1 0x68
191 #define LEDDRIVER8_REG_OFFSET 0x69
192 #define LEDDRIVER8_REG_PWM_ALL 0x6A
193 #define LEDDRIVER8_REG_IREF_ALL 0x6B
194 
200 #define LEDDRIVER8_MODE1_NORMAL_MODE 0x00
201 #define LEDDRIVER8_MODE1_SLEEP_MODE 0x10
202 
208 #define LEDDRIVER8_MODE2_DMBLNK_DIMMING 0x00
209 #define LEDDRIVER8_MODE2_DMBLNK_BLINKING 0x20
210 #define LEDDRIVER8_MODE2_CLRERR_NO 0x00
211 #define LEDDRIVER8_MODE2_CLRERR_ALL 0x10
212 #define LEDDRIVER8_MODE2_AUTO_SWITCH_OFF_DIS 0x08
213 #define LEDDRIVER8_MODE2_EXP_ENABLE 0x04
214 #define LEDDRIVER8_MODE2_EXP_DISABLE 0x00
215 
221 #define LEDDRIVER8_LED_DRIVER_0_23 0x00
222 #define LEDDRIVER8_LED_DRIVER_FULL 0x01
223 #define LEDDRIVER8_LED_DRIVER_PWMX 0x02
224 #define LEDDRIVER8_LED_DRIVER_GRPPWM 0x03
225 
226 #define LEDDRIVER8_BRIGHTNESS_ALL_LED 0x30
227 #define LEDDRIVER8_OUTPUT_GAIN_ALL_LED 0x40
228 #define LEDDRIVER8_FULL_OUTPUT_CURRENT_GAIN 0xFF
229 
230 #define LEDDRIVER8_ENABLE_LED_OUTPUTS 0x00
231 #define LEDDRIVER8_DISABLE_LED_OUTPUTS 0x01
232 
233 #define LEDDRIVER8_MAX_BRIGHTNESS 0xFF
234 #define LEDDRIVER8_MIN_BRIGHTNESS 0x00
235 
241 #define LEDDRIVER8_LED_0 0x00
242 #define LEDDRIVER8_LED_1 0x01
243 #define LEDDRIVER8_LED_2 0x02
244 #define LEDDRIVER8_LED_3 0x03
245 #define LEDDRIVER8_LED_4 0x04
246 #define LEDDRIVER8_LED_5 0x05
247 #define LEDDRIVER8_LED_6 0x06
248 #define LEDDRIVER8_LED_7 0x07
249 #define LEDDRIVER8_LED_8 0x08
250 #define LEDDRIVER8_LED_9 0x09
251 #define LEDDRIVER8_LED_10 0x0A
252 #define LEDDRIVER8_LED_11 0x0B
253 #define LEDDRIVER8_LED_12 0x0C
254 #define LEDDRIVER8_LED_13 0x0D
255 #define LEDDRIVER8_LED_14 0x0E
256 #define LEDDRIVER8_LED_15 0x0F
257 #define LEDDRIVER8_LED_16 0x10
258 #define LEDDRIVER8_LED_17 0x11
259 #define LEDDRIVER8_LED_18 0x12
260 #define LEDDRIVER8_LED_19 0x13
261 #define LEDDRIVER8_LED_20 0x14
262 #define LEDDRIVER8_LED_21 0x15
263 #define LEDDRIVER8_LED_22 0x16
264 #define LEDDRIVER8_LED_23 0x17
265  // End group macro
268 // --------------------------------------------------------------- PUBLIC TYPES
277 typedef struct
278 {
279  digital_out_t cs;
280  // Output pins
281 
282  digital_out_t rst;
283  digital_out_t pwm;
284 
285  // Modules
286 
287  spi_master_t spi;
288  pin_name_t chip_select;
289 
290 } leddriver8_t;
291 
295 typedef struct
296 {
297  // Communication gpio pins
298 
299  pin_name_t miso;
300  pin_name_t mosi;
301  pin_name_t sck;
302  pin_name_t cs;
303 
304  // Additional gpio pins
305 
306  pin_name_t rst;
307  pin_name_t pwm;
308 
309  // static variable
310 
311  uint32_t spi_speed;
312  spi_master_mode_t spi_mode;
313  spi_master_chip_select_polarity_t cs_polarity;
314 
316  // End types group
318 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
319 
324 #ifdef __cplusplus
325 extern "C"{
326 #endif
327 
337 
346 
354 void leddriver8_write_data ( leddriver8_t *ctx, uint8_t reg, uint8_t data_byte );
355 
363 uint8_t leddriver8_read_data ( leddriver8_t *ctx, uint8_t reg );
364 
371 void leddriver8_output_enable_pin( leddriver8_t *ctx, uint8_t state );
372 
380 
392 void leddriver8_set_brightness ( leddriver8_t *ctx, uint8_t num_led, uint8_t value );
393 
405 void leddriver8_set_output_gain ( leddriver8_t *ctx, uint8_t num_led, uint8_t value );
406 
414 void leddriver8_set_mode_register( leddriver8_t *ctx, uint8_t mode_1, uint8_t mode_2 );
415 
416 #ifdef __cplusplus
417 }
418 #endif
419 #endif // _LEDDRIVER8_H_
420  // End public_function group
423 
424 // ------------------------------------------------------------------------- END
leddriver8_cfg_t::mosi
pin_name_t mosi
Definition: leddriver8.h:300
leddriver8_cfg_t::spi_speed
uint32_t spi_speed
Definition: leddriver8.h:311
leddriver8_cfg_t::cs
pin_name_t cs
Definition: leddriver8.h:302
leddriver8_init
LEDDRIVER8_RETVAL leddriver8_init(leddriver8_t *ctx, leddriver8_cfg_t *cfg)
Initialization function.
leddriver8_t::cs
digital_out_t cs
Definition: leddriver8.h:279
leddriver8_read_data
uint8_t leddriver8_read_data(leddriver8_t *ctx, uint8_t reg)
Functions for read byte from register.
leddriver8_cfg_setup
void leddriver8_cfg_setup(leddriver8_cfg_t *cfg)
Config Object Initialization function.
leddriver8_t::pwm
digital_out_t pwm
Definition: leddriver8.h:283
leddriver8_set_output_gain
void leddriver8_set_output_gain(leddriver8_t *ctx, uint8_t num_led, uint8_t value)
Function for set output gain.
leddriver8_cfg_t::sck
pin_name_t sck
Definition: leddriver8.h:301
leddriver8_reset
void leddriver8_reset(leddriver8_t *ctx)
Device reset function.
leddriver8_cfg_t
Click configuration structure definition.
Definition: leddriver8.h:296
leddriver8_set_brightness
void leddriver8_set_brightness(leddriver8_t *ctx, uint8_t num_led, uint8_t value)
Function for set Brightness.
leddriver8_set_mode_register
void leddriver8_set_mode_register(leddriver8_t *ctx, uint8_t mode_1, uint8_t mode_2)
Function for set mode registers.
leddriver8_t
Click ctx object definition.
Definition: leddriver8.h:278
leddriver8_write_data
void leddriver8_write_data(leddriver8_t *ctx, uint8_t reg, uint8_t data_byte)
Functions for write one byte in the register.
leddriver8_t::chip_select
pin_name_t chip_select
Definition: leddriver8.h:288
leddriver8_cfg_t::rst
pin_name_t rst
Definition: leddriver8.h:306
leddriver8_cfg_t::miso
pin_name_t miso
Definition: leddriver8.h:299
leddriver8_t::spi
spi_master_t spi
Definition: leddriver8.h:287
leddriver8_cfg_t::pwm
pin_name_t pwm
Definition: leddriver8.h:307
leddriver8_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: leddriver8.h:312
leddriver8_t::rst
digital_out_t rst
Definition: leddriver8.h:282
leddriver8_output_enable_pin
void leddriver8_output_enable_pin(leddriver8_t *ctx, uint8_t state)
Functions for enable led output.
LEDDRIVER8_RETVAL
#define LEDDRIVER8_RETVAL
Definition: leddriver8.h:76
leddriver8_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: leddriver8.h:313