leddriver10  2.0.0.0
leddriver10.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 LEDDRIVER10_H
29 #define LEDDRIVER10_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_spi_master.h"
38 #include "drv_pwm.h"
39 
60 // TODO -- dodati makroe koji definisu adrese registara
61  // leddriver10_reg
63 
78 #define LEDDRIVER10_ENABLE_ALL_CH 0xFFFF
79 #define LEDDRIVER10_DISABLE_ALL_CH 0x0000
80 #define LEDDRIVER10_ENABLE_CH_0 0x0001
81 #define LEDDRIVER10_ENABLE_CH_1 0x0002
82 #define LEDDRIVER10_ENABLE_CH_2 0x0004
83 #define LEDDRIVER10_ENABLE_CH_3 0x0008
84 #define LEDDRIVER10_ENABLE_CH_4 0x0010
85 #define LEDDRIVER10_ENABLE_CH_5 0x0020
86 #define LEDDRIVER10_ENABLE_CH_6 0x0040
87 #define LEDDRIVER10_ENABLE_CH_7 0x0080
88 #define LEDDRIVER10_ENABLE_CH_8 0x0100
89 #define LEDDRIVER10_ENABLE_CH_9 0x0200
90 #define LEDDRIVER10_ENABLE_CH_10 0x0400
91 #define LEDDRIVER10_ENABLE_CH_11 0x0800
92 #define LEDDRIVER10_ENABLE_CH_12 0x1000
93 #define LEDDRIVER10_ENABLE_CH_13 0x2000
94 #define LEDDRIVER10_ENABLE_CH_14 0x4000
95 #define LEDDRIVER10_ENABLE_CH_15 0x8000
96 
101 #define LEDDRIVER10_DEF_FREQ 10000
102  // leddriver10_set
104 
119 #define LEDDRIVER10_MAP_MIKROBUS( cfg, mikrobus ) \
120  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
121  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
122  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
123  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
124  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
125  // leddriver10_map // leddriver10
128 
133 typedef struct
134 {
135  // Modules
136  spi_master_t spi;
137  pwm_t pwm;
139  pin_name_t chip_select;
140  uint32_t pwm_freq;
142 } leddriver10_t;
143 
148 typedef struct
149 {
150  // Communication gpio pins
151  pin_name_t miso;
152  pin_name_t mosi;
153  pin_name_t sck;
154  pin_name_t cs;
155  pin_name_t pwm;
157  // Static variable
158  uint32_t spi_speed;
159  spi_master_mode_t spi_mode;
160  spi_master_chip_select_polarity_t cs_polarity;
161  uint32_t dev_pwm_freq;
164 
169 typedef enum
170 {
172  LEDDRIVER10_ERROR = -1
173 
175 
192 
208 
221 err_t leddriver10_set_channels ( leddriver10_t *ctx, uint16_t ch_mask );
222 
235 err_t leddriver10_read_channels ( leddriver10_t *ctx, uint16_t *ch_mask );
236 
249 err_t leddriver10_set_duty_cycle ( leddriver10_t *ctx, float duty_cycle );
250 
263 
276 
277 #ifdef __cplusplus
278 }
279 #endif
280 #endif // LEDDRIVER10_H
281  // leddriver10
283 
284 // ------------------------------------------------------------------------ END
leddriver10_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: leddriver10.h:160
leddriver10_cfg_t::spi_speed
uint32_t spi_speed
Definition: leddriver10.h:158
leddriver10_cfg_setup
void leddriver10_cfg_setup(leddriver10_cfg_t *cfg)
LED Driver 10 configuration object setup function.
leddriver10_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: leddriver10.h:161
leddriver10_cfg_t::cs
pin_name_t cs
Definition: leddriver10.h:154
leddriver10_cfg_t::miso
pin_name_t miso
Definition: leddriver10.h:151
leddriver10_t
LED Driver 10 Click context object.
Definition: leddriver10.h:134
leddriver10_set_channels
err_t leddriver10_set_channels(leddriver10_t *ctx, uint16_t ch_mask)
LED Driver 10 set channels function.
leddriver10_return_value_t
leddriver10_return_value_t
LED Driver 10 Click return value data.
Definition: leddriver10.h:170
leddriver10_init
err_t leddriver10_init(leddriver10_t *ctx, leddriver10_cfg_t *cfg)
LED Driver 10 initialization function.
leddriver10_t::pwm_freq
uint32_t pwm_freq
Definition: leddriver10.h:140
leddriver10_read_channels
err_t leddriver10_read_channels(leddriver10_t *ctx, uint16_t *ch_mask)
LED Driver 10 read channels function.
leddriver10_t::chip_select
pin_name_t chip_select
Definition: leddriver10.h:139
leddriver10_t::spi
spi_master_t spi
Definition: leddriver10.h:136
LEDDRIVER10_OK
@ LEDDRIVER10_OK
Definition: leddriver10.h:171
leddriver10_pwm_stop
err_t leddriver10_pwm_stop(leddriver10_t *ctx)
LED Driver 10 stop PWM module.
leddriver10_cfg_t::sck
pin_name_t sck
Definition: leddriver10.h:153
LEDDRIVER10_ERROR
@ LEDDRIVER10_ERROR
Definition: leddriver10.h:172
leddriver10_pwm_start
err_t leddriver10_pwm_start(leddriver10_t *ctx)
LED Driver 10 start PWM module.
leddriver10_cfg_t::pwm
pin_name_t pwm
Definition: leddriver10.h:155
leddriver10_cfg_t
LED Driver 10 Click configuration object.
Definition: leddriver10.h:149
leddriver10_set_duty_cycle
err_t leddriver10_set_duty_cycle(leddriver10_t *ctx, float duty_cycle)
LED Driver 10 sets PWM duty cycle.
leddriver10_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: leddriver10.h:159
leddriver10_t::pwm
pwm_t pwm
Definition: leddriver10.h:137
leddriver10_cfg_t::mosi
pin_name_t mosi
Definition: leddriver10.h:152