buckboost3  2.0.0.0
buckboost3.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 BUCKBOOST3_H
36 #define BUCKBOOST3_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 BUCKBOOST3_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
67  cfg.uv= MIKROBUS( mikrobus, MIKROBUS_INT );
68 
74 #define BUCKBOOST3_RETVAL uint8_t
75 
76 #define BUCKBOOST3_OK 0x00
77 #define BUCKBOOST3_INIT_ERROR 0xFF
78 
84 #define BUCKBOOST3_DEVICE_ENABLE 0x01
85 #define BUCKBOOST3_DEVICE_DISABLE 0x00
86  // End group macro
89 // --------------------------------------------------------------- PUBLIC TYPES
98 typedef struct
99 {
100  // Output pins
101 
102  digital_out_t en;
103 
104  // Input pins
105 
106  digital_in_t uv;
107 
108 } buckboost3_t;
109 
113 typedef struct
114 {
115  // Additional gpio pins
116 
117  pin_name_t en;
118 
119  pin_name_t uv;
120 
122  // End types group
124 
125 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
126 
132 #ifdef __cplusplus
133 extern "C"{
134 #endif
135 
145 
154 
163 void buckboost3_enable ( buckboost3_t *ctx, uint8_t state );
164 
175 
176 #ifdef __cplusplus
177 }
178 #endif
179 #endif // _BUCKBOOST3_H_
180  // End public_function group
183 
184 // ------------------------------------------------------------------------- END
buckboost3_init
BUCKBOOST3_RETVAL buckboost3_init(buckboost3_t *ctx, buckboost3_cfg_t *cfg)
Initialization function.
buckboost3_t
Click ctx object definition.
Definition: buckboost3.h:99
buckboost3_cfg_t::en
pin_name_t en
Definition: buckboost3.h:117
buckboost3_cfg_t::uv
pin_name_t uv
Definition: buckboost3.h:119
BUCKBOOST3_RETVAL
#define BUCKBOOST3_RETVAL
Definition: buckboost3.h:74
buckboost3_enable
void buckboost3_enable(buckboost3_t *ctx, uint8_t state)
Function for enable/disable device.
buckboost3_get_interrupt_state
uint8_t buckboost3_get_interrupt_state(buckboost3_t *ctx)
Function for get Intterupt pin state.
buckboost3_cfg_setup
void buckboost3_cfg_setup(buckboost3_cfg_t *cfg)
Config Object Initialization function.
buckboost3_t::en
digital_out_t en
Definition: buckboost3.h:102
buckboost3_cfg_t
Click configuration structure definition.
Definition: buckboost3.h:114
buckboost3_t::uv
digital_in_t uv
Definition: buckboost3.h:106