leddriver5  2.0.0.0
leddriver5.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 LEDDRIVER5_H
36 #define LEDDRIVER5_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_pwm.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define LEDDRIVER5_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
68  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS );
69 
76 #define LEDDRIVER5_RETVAL uint8_t
77 
78 #define LEDDRIVER5_OK 0x00
79 #define LEDDRIVER5_INIT_ERROR 0xFF
80 
86 #define LEDDRIVER5_DEF_FREQ 5000
87  // End group macro
90 // --------------------------------------------------------------- PUBLIC TYPES
99 typedef struct
100 {
101 
102  // Output pins
103 
104  digital_out_t en;
105 
106  // Modules
107 
108  pwm_t pwm;
109 
110  // ctx variable
111 
112  uint32_t pwm_freq;
113 
114 } leddriver5_t;
115 
119 typedef struct
120 {
121  // Communication gpio pins
122 
123  pin_name_t pwm;
124 
125  // Additional gpio pins
126 
127  pin_name_t en;
128 
129  // static variable
130 
131  uint32_t dev_pwm_freq;
132 
134  // End types group
136 
137 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
138 
144 #ifdef __cplusplus
145 extern "C"{
146 #endif
147 
157 
166 
175 
185 void leddriver5_set_duty_cycle ( leddriver5_t *ctx, float duty_cycle );
186 
195 
204 
205 #ifdef __cplusplus
206 }
207 #endif
208 #endif // _LEDDRIVER5_H_
209  // End public_function group
212 
213 // ------------------------------------------------------------------------- END
leddriver5_set_duty_cycle
void leddriver5_set_duty_cycle(leddriver5_t *ctx, float duty_cycle)
Generic sets PWM duty cycle.
leddriver5_t::pwm_freq
uint32_t pwm_freq
Definition: leddriver5.h:112
leddriver5_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: leddriver5.h:131
leddriver5_t::pwm
pwm_t pwm
Definition: leddriver5.h:108
LEDDRIVER5_RETVAL
#define LEDDRIVER5_RETVAL
Definition: leddriver5.h:76
leddriver5_default_cfg
void leddriver5_default_cfg(leddriver5_t *ctx)
Click Default Configuration function.
leddriver5_cfg_t::pwm
pin_name_t pwm
Definition: leddriver5.h:123
leddriver5_t
Click ctx object definition.
Definition: leddriver5.h:100
leddriver5_cfg_t
Click configuration structure definition.
Definition: leddriver5.h:120
leddriver5_t::en
digital_out_t en
Definition: leddriver5.h:104
leddriver5_pwm_start
void leddriver5_pwm_start(leddriver5_t *ctx)
Start PWM module.
leddriver5_pwm_stop
void leddriver5_pwm_stop(leddriver5_t *ctx)
Stop PWM module.
leddriver5_cfg_t::en
pin_name_t en
Definition: leddriver5.h:127
leddriver5_cfg_setup
void leddriver5_cfg_setup(leddriver5_cfg_t *cfg)
Config Object Initialization function.
leddriver5_init
LEDDRIVER5_RETVAL leddriver5_init(leddriver5_t *ctx, leddriver5_cfg_t *cfg)
Initialization function.