boost3  2.0.0.0
boost3.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 BOOST3_H
36 #define BOOST3_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define BOOST3_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS )
63 
69 #define BOOST3_RETVAL uint8_t
70 
71 #define BOOST3_OK 0x00
72 #define BOOST3_INIT_ERROR 0xFF
73 
79 #define BOOST3_ENABLE 0x01
80 #define BOOST3_DISABLE 0x00
81  // End group macro
84 // --------------------------------------------------------------- PUBLIC TYPES
93 typedef struct
94 {
95  // Output pins
96 
97  digital_out_t en;
98 
99 } boost3_t;
100 
104 typedef struct
105 {
106  // Additional gpio pins
107 
108  pin_name_t en;
109 
110 } boost3_cfg_t;
111  // End types group
113 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
114 
120 #ifdef __cplusplus
121 extern "C"{
122 #endif
123 
133 
143 
152 void boost3_dev_enable ( boost3_t *ctx, uint8_t state );
153 
154 
155 #ifdef __cplusplus
156 }
157 #endif
158 #endif // _BOOST3_H_
159  // End public_function group
162 
163 // ------------------------------------------------------------------------- END
BOOST3_RETVAL
#define BOOST3_RETVAL
Definition: boost3.h:69
boost3_cfg_t::en
pin_name_t en
Definition: boost3.h:108
boost3_t::en
digital_out_t en
Definition: boost3.h:97
boost3_t
Click ctx object definition.
Definition: boost3.h:94
boost3_cfg_t
Click configuration structure definition.
Definition: boost3.h:105
boost3_dev_enable
void boost3_dev_enable(boost3_t *ctx, uint8_t state)
Device Enable function.
boost3_cfg_setup
void boost3_cfg_setup(boost3_cfg_t *cfg)
Config Object Initialization function.
boost3_init
BOOST3_RETVAL boost3_init(boost3_t *ctx, boost3_cfg_t *cfg)
Initialization function.