buckboost2  2.0.0.0
buckboost2.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 BUCKBOOST2_H
36 #define BUCKBOOST2_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 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define BUCKBOOST2_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.an= MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.en= MIKROBUS( mikrobus, MIKROBUS_RST ); \
68  cfg.mod= MIKROBUS( mikrobus, MIKROBUS_PWM )
69 
75 #define BUCKBOOST2_RETVAL uint8_t
76 
77 #define BUCKBOOST2_OK 0x00
78 #define BUCKBOOST2_INIT_ERROR 0xFF
79 
85 #define BUCKBOOST2_WITH_IMPROVEMENT 0x01
86 #define BUCKBOOST2_WITHOUT_IMPROVEMENT 0x00
87  // End group macro
90 // --------------------------------------------------------------- PUBLIC TYPES
99 typedef struct
100 {
101  // Output pins
102 
103  digital_out_t en;
104  digital_out_t mod;
105 
106  // Input pins
107 
108  digital_in_t an;
109 
110 } buckboost2_t;
111 
115 typedef struct
116 {
117  // Additional gpio pins
118 
119  pin_name_t an;
120  pin_name_t en;
121  pin_name_t mod;
122 
124  // End types group
126 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
127 
133 #ifdef __cplusplus
134 extern "C"{
135 #endif
136 
146 
156 
165 
174 
188 void buckboost2_set_mode ( buckboost2_t *ctx , uint8_t mode );
189 
190 #ifdef __cplusplus
191 }
192 #endif
193 #endif // _BUCKBOOST2_H_
194  // End public_function group
197 
198 // ------------------------------------------------------------------------- END
buckboost2_cfg_t::mod
pin_name_t mod
Definition: buckboost2.h:121
buckboost2_cfg_t::an
pin_name_t an
Definition: buckboost2.h:119
buckboost2_cfg_setup
void buckboost2_cfg_setup(buckboost2_cfg_t *cfg)
Config Object Initialization function.
buckboost2_t::mod
digital_out_t mod
Definition: buckboost2.h:104
buckboost2_power_on
void buckboost2_power_on(buckboost2_t *ctx)
Power on function.
buckboost2_init
BUCKBOOST2_RETVAL buckboost2_init(buckboost2_t *ctx, buckboost2_cfg_t *cfg)
Initialization function.
buckboost2_set_mode
void buckboost2_set_mode(buckboost2_t *ctx, uint8_t mode)
Mode setting functon.
buckboost2_t::an
digital_in_t an
Definition: buckboost2.h:108
buckboost2_cfg_t::en
pin_name_t en
Definition: buckboost2.h:120
BUCKBOOST2_RETVAL
#define BUCKBOOST2_RETVAL
Definition: buckboost2.h:75
buckboost2_cfg_t
Click configuration structure definition.
Definition: buckboost2.h:116
buckboost2_t
Click ctx object definition.
Definition: buckboost2.h:100
buckboost2_power_off
void buckboost2_power_off(buckboost2_t *ctx)
Power off function.
buckboost2_t::en
digital_out_t en
Definition: buckboost2.h:103