mikroSDK Reference Manual
drv_pwm.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2023 MikroElektronika d.o.o.
4 ** Contact: https://www.mikroe.com/contact
5 **
6 ** This file is part of the mikroSDK package
7 **
8 ** Commercial License Usage
9 **
10 ** Licensees holding valid commercial NECTO compilers AI licenses may use this
11 ** file in accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The MikroElektronika Company.
14 ** For licensing terms and conditions see
15 ** https://www.mikroe.com/legal/software-license-agreement.
16 ** For further information use the contact form at
17 ** https://www.mikroe.com/contact.
18 **
19 **
20 ** GNU Lesser General Public License Usage
21 **
22 ** Alternatively, this file may be used for
23 ** non-commercial projects under the terms of the GNU Lesser
24 ** General Public License version 3 as published by the Free Software
25 ** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
26 **
27 ** The above copyright notice and this permission notice shall be
28 ** included in all copies or substantial portions of the Software.
29 **
30 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
31 ** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
32 ** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
33 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
34 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
35 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
36 ** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
37 **
38 ****************************************************************************/
44 #ifndef _DRV_PWM_H_
45 #define _DRV_PWM_H_
46 
47 #ifdef __cplusplus
48 extern "C"{
49 #endif
50 
51 #include "drv_name.h"
52 #include "hal_pwm.h"
53 
57 typedef enum
58 {
59  PWM_SUCCESS = 0,
60  PWM_ERROR = (-1)
61 } pwm_err_t;
62 
83 typedef struct
84 {
85  pin_name_t pin;
86  uint32_t freq_hz;
87 } pwm_config_t;
88 
89 
96 typedef struct
97 {
98  handle_t handle;
99  pwm_config_t config;
100 } pwm_t;
101 
144 void pwm_configure_default( pwm_config_t *config );
145 
190 err_t pwm_open( pwm_t *obj, pwm_config_t *config );
191 
225 err_t pwm_set_freq( pwm_t *obj, uint32_t freq_hz );
226 
251 err_t pwm_start( pwm_t *obj );
252 
287 err_t pwm_set_duty( pwm_t *obj, float duty_ratio );
288 
314 err_t pwm_stop( pwm_t *obj );
315 
338 err_t pwm_close( pwm_t *obj );
339  // drvpwmgroup // drvgroup // pergroup
343 
344 #ifdef __cplusplus
345 }
346 #endif
347 
348 #endif // _DRV_PWM_H_
349 // ------------------------------------------------------------------------- END
drv_name.h
Pin and port name type definitions.
pwm_err_t
pwm_err_t
Definition: drv_pwm.h:56
PWM_ERROR
Definition: drv_pwm.h:59
PWM_SUCCESS
Definition: drv_pwm.h:58
pwm_open
err_t pwm_open(pwm_t *obj, pwm_config_t *config)
Open the PWM driver object on selected pin.
pwm_configure_default
void pwm_configure_default(pwm_config_t *config)
Configure PWM config structure.
hal_pwm.h
This file contains all the functions prototypes for the PWM library.
pwm_config_t
PWM driver config structure, consisted of the following fields:
Definition: drv_pwm.h:82
pwm_set_duty
err_t pwm_set_duty(pwm_t *obj, float duty_ratio)
Set PWM duty cycle in percentages.
pwm_set_freq
err_t pwm_set_freq(pwm_t *obj, uint32_t freq_hz)
Set PWM frequency in Hertz.
pwm_close
err_t pwm_close(pwm_t *obj)
Close PWM driver context object.
pin_name_t
hal_pin_name_t pin_name_t
Definition: drv_name.h:73
err_t
int32_t err_t
Definition: hal_target.h:63
pwm_start
err_t pwm_start(pwm_t *obj)
Enable counter and start PWM module.
pwm_t
PWM driver context structure.
Definition: drv_pwm.h:95
pwm_stop
err_t pwm_stop(pwm_t *obj)
Stop PWM module.