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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_pwm.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define LEDDRIVER5_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
54  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS );
55 
62 #define LEDDRIVER5_RETVAL uint8_t
63 
64 #define LEDDRIVER5_OK 0x00
65 #define LEDDRIVER5_INIT_ERROR 0xFF
66 
72 #define LEDDRIVER5_DEF_FREQ 5000
73  // End group macro
76 // --------------------------------------------------------------- PUBLIC TYPES
85 typedef struct
86 {
87 
88  // Output pins
89 
90  digital_out_t en;
91 
92  // Modules
93 
94  pwm_t pwm;
95 
96  // ctx variable
97 
98  uint32_t pwm_freq;
99 
100 } leddriver5_t;
101 
105 typedef struct
106 {
107  // Communication gpio pins
108 
109  pin_name_t pwm;
110 
111  // Additional gpio pins
112 
113  pin_name_t en;
114 
115  // static variable
116 
117  uint32_t dev_pwm_freq;
118 
120  // End types group
122 
123 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
124 
130 #ifdef __cplusplus
131 extern "C"{
132 #endif
133 
143 
152 
161 
171 void leddriver5_set_duty_cycle ( leddriver5_t *ctx, float duty_cycle );
172 
180 void leddriver5_pwm_stop ( leddriver5_t *ctx );
181 
189 void leddriver5_pwm_start ( leddriver5_t *ctx );
190 
191 #ifdef __cplusplus
192 }
193 #endif
194 #endif // _LEDDRIVER5_H_
195  // End public_function group
198 
199 // ------------------------------------------------------------------------- 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:98
leddriver5_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: leddriver5.h:117
leddriver5_t::pwm
pwm_t pwm
Definition: leddriver5.h:94
LEDDRIVER5_RETVAL
#define LEDDRIVER5_RETVAL
Definition: leddriver5.h:62
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:109
leddriver5_t
Click ctx object definition.
Definition: leddriver5.h:85
leddriver5_cfg_t
Click configuration structure definition.
Definition: leddriver5.h:105
leddriver5_t::en
digital_out_t en
Definition: leddriver5.h:90
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:113
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.