pwmdriver  2.0.0.0
pwmdriver.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 PWMDRIVER_H
36 #define PWMDRIVER_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 PWMDRIVER_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
68 
74 #define PWMDRIVER_RETVAL uint8_t
75 
76 #define PWMDRIVER_OK 0x00
77 #define PWMDRIVER_INIT_ERROR 0xFF
78 
84 #define PWMDRIVER_DEF_FREQ 20000
85  // End group macro
88 // --------------------------------------------------------------- PUBLIC TYPES
97 typedef struct
98 {
99 
100  // Modules
101 
102  pwm_t pwm;
103 
104  // ctx variable
105 
106  uint16_t pwm_period;
107  uint32_t pwm_freq;
108 
109 } pwmdriver_t;
110 
114 typedef struct
115 {
116  // Communication gpio pins
117 
118  pin_name_t pwm;
119 
120 
121  // static variable
122 
123  uint32_t dev_pwm_freq;
124 
126  // End types group
128 
129 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
130 
136 #ifdef __cplusplus
137 extern "C"{
138 #endif
139 
149 
159 
168 
178 void pwmdriver_set_duty_cycle ( pwmdriver_t *ctx, float duty_cycle );
179 
188 
197 
198 #ifdef __cplusplus
199 }
200 #endif
201 #endif // _PWMDRIVER_H_
202  // End public_function group
205 
206 // ------------------------------------------------------------------------- END
pwmdriver_pwm_start
void pwmdriver_pwm_start(pwmdriver_t *ctx)
Start PWM module.
pwmdriver_t::pwm_period
uint16_t pwm_period
Definition: pwmdriver.h:106
pwmdriver_cfg_setup
void pwmdriver_cfg_setup(pwmdriver_cfg_t *cfg)
Config Object Initialization function.
pwmdriver_t::pwm
pwm_t pwm
Definition: pwmdriver.h:102
pwmdriver_t
Click ctx object definition.
Definition: pwmdriver.h:98
PWMDRIVER_RETVAL
#define PWMDRIVER_RETVAL
Definition: pwmdriver.h:74
pwmdriver_cfg_t
Click configuration structure definition.
Definition: pwmdriver.h:115
pwmdriver_default_cfg
void pwmdriver_default_cfg(pwmdriver_t *ctx)
Click Default Configuration function.
pwmdriver_cfg_t::pwm
pin_name_t pwm
Definition: pwmdriver.h:118
pwmdriver_init
PWMDRIVER_RETVAL pwmdriver_init(pwmdriver_t *ctx, pwmdriver_cfg_t *cfg)
Initialization function.
pwmdriver_pwm_stop
void pwmdriver_pwm_stop(pwmdriver_t *ctx)
Stop PWM module.
pwmdriver_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: pwmdriver.h:123
pwmdriver_set_duty_cycle
void pwmdriver_set_duty_cycle(pwmdriver_t *ctx, float duty_cycle)
Generic sets PWM duty cycle.
pwmdriver_t::pwm_freq
uint32_t pwm_freq
Definition: pwmdriver.h:107