boost2  2.0.0.0
boost2.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 BOOST2_H
36 #define BOOST2_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 BOOST2_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
63  cfg.pg= MIKROBUS( mikrobus, MIKROBUS_INT )
64 
70 #define BOOST2_RETVAL uint8_t
71 
72 #define BOOST2_OK 0x00
73 #define BOOST2_INIT_ERROR 0xFF
74  // End group macro
77 // --------------------------------------------------------------- PUBLIC TYPES
86 typedef struct
87 {
88  // Output pins
89 
90  digital_out_t en;
91 
92  // Input pins
93 
94  digital_in_t pg;
95 
96 } boost2_t;
97 
101 typedef struct
102 {
103  // Additional gpio pins
104 
105  pin_name_t en;
106 
107  pin_name_t pg;
108 
109 } boost2_cfg_t;
110  // End types group
112 
113 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
114 
120 #ifdef __cplusplus
121 extern "C"{
122 #endif
123 
133 
142 
151 void boost2_set_en_pin ( boost2_t *ctx, uint8_t new_state );
152 
160 uint8_t boost2_get_pg_pin ( boost2_t *ctx );
161 
162 #ifdef __cplusplus
163 }
164 #endif
165 #endif // _BOOST2_H_
166  // End public_function group
169 
170 // ------------------------------------------------------------------------- END
boost2_cfg_setup
void boost2_cfg_setup(boost2_cfg_t *cfg)
Config Object Initialization function.
boost2_t::en
digital_out_t en
Definition: boost2.h:90
boost2_cfg_t::en
pin_name_t en
Definition: boost2.h:105
boost2_cfg_t
Click configuration structure definition.
Definition: boost2.h:102
boost2_set_en_pin
void boost2_set_en_pin(boost2_t *ctx, uint8_t new_state)
Set enable pin.
boost2_init
BOOST2_RETVAL boost2_init(boost2_t *ctx, boost2_cfg_t *cfg)
Initialization function.
boost2_t::pg
digital_in_t pg
Definition: boost2.h:94
boost2_t
Click ctx object definition.
Definition: boost2.h:87
boost2_get_pg_pin
uint8_t boost2_get_pg_pin(boost2_t *ctx)
Get PG pin state.
boost2_cfg_t::pg
pin_name_t pg
Definition: boost2.h:107
BOOST2_RETVAL
#define BOOST2_RETVAL
Definition: boost2.h:70