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 
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_pwm.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define PWMDRIVER_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
64 
70 #define PWMDRIVER_RETVAL uint8_t
71 
72 #define PWMDRIVER_OK 0x00
73 #define PWMDRIVER_INIT_ERROR 0xFF
74 
80 #define PWMDRIVER_DEF_FREQ 20000
81  // End group macro
84 // --------------------------------------------------------------- PUBLIC TYPES
93 typedef struct
94 {
95 
96  // Modules
97 
98  pwm_t pwm;
99 
100  // ctx variable
101 
102  uint16_t pwm_period;
103  uint32_t pwm_freq;
104 
105 } pwmdriver_t;
106 
110 typedef struct
111 {
112  // Communication gpio pins
113 
114  pin_name_t pwm;
115 
116 
117  // static variable
118 
119  uint32_t dev_pwm_freq;
120 
122  // End types group
124 
125 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
126 
132 #ifdef __cplusplus
133 extern "C"{
134 #endif
135 
145 
155 
164 
174 void pwmdriver_set_duty_cycle ( pwmdriver_t *ctx, float duty_cycle );
175 
184 
193 
194 #ifdef __cplusplus
195 }
196 #endif
197 #endif // _PWMDRIVER_H_
198  // End public_function group
201 
202 // ------------------------------------------------------------------------- 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:102
pwmdriver_cfg_setup
void pwmdriver_cfg_setup(pwmdriver_cfg_t *cfg)
Config Object Initialization function.
pwmdriver_t::pwm
pwm_t pwm
Definition: pwmdriver.h:98
pwmdriver_t
Click ctx object definition.
Definition: pwmdriver.h:94
PWMDRIVER_RETVAL
#define PWMDRIVER_RETVAL
Definition: pwmdriver.h:70
pwmdriver_cfg_t
Click configuration structure definition.
Definition: pwmdriver.h:111
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:114
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:119
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:103