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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define BUCKBOOST3_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
53  cfg.uv= MIKROBUS( mikrobus, MIKROBUS_INT );
54 
60 #define BUCKBOOST3_RETVAL uint8_t
61 
62 #define BUCKBOOST3_OK 0x00
63 #define BUCKBOOST3_INIT_ERROR 0xFF
64 
70 #define BUCKBOOST3_DEVICE_ENABLE 0x01
71 #define BUCKBOOST3_DEVICE_DISABLE 0x00
72  // End group macro
75 // --------------------------------------------------------------- PUBLIC TYPES
84 typedef struct
85 {
86  // Output pins
87 
88  digital_out_t en;
89 
90  // Input pins
91 
92  digital_in_t uv;
93 
94 } buckboost3_t;
95 
99 typedef struct
100 {
101  // Additional gpio pins
102 
103  pin_name_t en;
104 
105  pin_name_t uv;
106 
108  // End types group
110 
111 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
112 
118 #ifdef __cplusplus
119 extern "C"{
120 #endif
121 
131 
140 
149 
158 void buckboost3_enable ( buckboost3_t *ctx, uint8_t state );
159 
170 
171 #ifdef __cplusplus
172 }
173 #endif
174 #endif // _BUCKBOOST3_H_
175  // End public_function group
178 
179 // ------------------------------------------------------------------------- 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:84
buckboost3_cfg_t::en
pin_name_t en
Definition: buckboost3.h:103
buckboost3_cfg_t::uv
pin_name_t uv
Definition: buckboost3.h:105
BUCKBOOST3_RETVAL
#define BUCKBOOST3_RETVAL
Definition: buckboost3.h:60
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_default_cfg
void buckboost3_default_cfg(buckboost3_t *ctx)
Click Default Configuration function.
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:88
buckboost3_cfg_t
Click configuration structure definition.
Definition: buckboost3.h:99
buckboost3_t::uv
digital_in_t uv
Definition: buckboost3.h:92