vreg2  2.0.0.0
vreg2.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef VREG2_H
29 #define VREG2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_pwm.h"
48 
69 #define VREG2_DEF_FREQ 5000
70  // vreg2_cfg
72 
87 #define VREG2_MAP_MIKROBUS( cfg, mikrobus ) \
88  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
89  // vreg2_map // vreg2
92 
97 typedef struct
98 {
99  // Modules
100  pwm_t pwm;
102  // ctx variable
103  uint32_t pwm_freq;
105 } vreg2_t;
106 
111 typedef struct
112 {
113  // Communication gpio pins
114  pin_name_t pwm;
116  // Static variable
117  uint32_t dev_pwm_freq;
119 } vreg2_cfg_t;
120 
125 typedef enum
126 {
127  VREG2_OK = 0,
128  VREG2_ERROR = -1
129 
131 
148 
162 err_t vreg2_init ( vreg2_t *ctx, vreg2_cfg_t *cfg );
163 
176 err_t vreg2_default_cfg ( vreg2_t *ctx );
177 
189 err_t vreg2_set_duty_cycle ( vreg2_t *ctx, float duty_cycle );
190 
201 err_t vreg2_pwm_stop ( vreg2_t *ctx );
202 
213 err_t vreg2_pwm_start ( vreg2_t *ctx );
214 
215 #ifdef __cplusplus
216 }
217 #endif
218 #endif // VREG2_H
219  // vreg2
221 
222 // ------------------------------------------------------------------------ END
vreg2_pwm_start
err_t vreg2_pwm_start(vreg2_t *ctx)
VREG 2 start PWM module.
vreg2_return_value_t
vreg2_return_value_t
VREG 2 Click return value data.
Definition: vreg2.h:126
vreg2_init
err_t vreg2_init(vreg2_t *ctx, vreg2_cfg_t *cfg)
VREG 2 initialization function.
vreg2_cfg_t::pwm
pin_name_t pwm
Definition: vreg2.h:114
VREG2_OK
@ VREG2_OK
Definition: vreg2.h:127
vreg2_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: vreg2.h:117
vreg2_t::pwm
pwm_t pwm
Definition: vreg2.h:100
vreg2_pwm_stop
err_t vreg2_pwm_stop(vreg2_t *ctx)
VREG 2 stop PWM module.
vreg2_t::pwm_freq
uint32_t pwm_freq
Definition: vreg2.h:103
vreg2_default_cfg
err_t vreg2_default_cfg(vreg2_t *ctx)
VREG 2 default configuration function.
vreg2_set_duty_cycle
err_t vreg2_set_duty_cycle(vreg2_t *ctx, float duty_cycle)
VREG 2 sets PWM duty cycle.
VREG2_ERROR
@ VREG2_ERROR
Definition: vreg2.h:128
vreg2_cfg_t
VREG 2 Click configuration object.
Definition: vreg2.h:112
vreg2_cfg_setup
void vreg2_cfg_setup(vreg2_cfg_t *cfg)
VREG 2 configuration object setup function.
vreg2_t
VREG 2 Click context object.
Definition: vreg2.h:98