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 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_pwm.h"
52 
73 #define VREG2_DEF_FREQ 5000
74  // vreg2_cfg
76 
91 #define VREG2_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
93  // vreg2_map // vreg2
96 
101 typedef struct
102 {
103  // Modules
104  pwm_t pwm;
106  // ctx variable
107  uint32_t pwm_freq;
109 } vreg2_t;
110 
115 typedef struct
116 {
117  // Communication gpio pins
118  pin_name_t pwm;
120  // Static variable
121  uint32_t dev_pwm_freq;
123 } vreg2_cfg_t;
124 
129 typedef enum
130 {
131  VREG2_OK = 0,
132  VREG2_ERROR = -1
133 
135 
152 
166 err_t vreg2_init ( vreg2_t *ctx, vreg2_cfg_t *cfg );
167 
180 err_t vreg2_default_cfg ( vreg2_t *ctx );
181 
193 err_t vreg2_set_duty_cycle ( vreg2_t *ctx, float duty_cycle );
194 
205 err_t vreg2_pwm_stop ( vreg2_t *ctx );
206 
217 err_t vreg2_pwm_start ( vreg2_t *ctx );
218 
219 #ifdef __cplusplus
220 }
221 #endif
222 #endif // VREG2_H
223  // vreg2
225 
226 // ------------------------------------------------------------------------ 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:130
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:118
VREG2_OK
@ VREG2_OK
Definition: vreg2.h:131
vreg2_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: vreg2.h:121
vreg2_t::pwm
pwm_t pwm
Definition: vreg2.h:104
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:107
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:132
vreg2_cfg_t
VREG 2 Click configuration object.
Definition: vreg2.h:116
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:102