boost8  2.1.0.0
boost8.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef BOOST8_H
29 #define BOOST8_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
72 #define BOOST8_MAP_MIKROBUS( cfg, mikrobus ) \
73  cfg.en_p = MIKROBUS( mikrobus, MIKROBUS_RST ); \
74  cfg.en_n = MIKROBUS( mikrobus, MIKROBUS_PWM );
75  // boost8_map // boost8
78 
83 typedef struct
84 {
85  digital_out_t en_p;
86  digital_out_t en_n;
88 } boost8_t;
89 
94 typedef struct
95 {
96  pin_name_t en_p;
97  pin_name_t en_n;
99 } boost8_cfg_t;
100 
105 typedef enum
106 {
108  BOOST8_ERROR = -1
109 
111 
128 
142 err_t boost8_init ( boost8_t *ctx, boost8_cfg_t *cfg );
143 
155 
165 
175 
185 
195 
205 
215 
216 #ifdef __cplusplus
217 }
218 #endif
219 #endif // BOOST8_H
220  // boost8
222 
223 // ------------------------------------------------------------------------ END
boost8_t
Boost 8 Click context object.
Definition: boost8.h:84
boost8_t::en_p
digital_out_t en_p
Definition: boost8.h:85
BOOST8_ERROR
@ BOOST8_ERROR
Definition: boost8.h:108
boost8_disable_both_outputs
void boost8_disable_both_outputs(boost8_t *ctx)
Boost 8 disable both voltage outputs function.
boost8_cfg_t::en_p
pin_name_t en_p
Definition: boost8.h:96
boost8_disable_positive_voltage
void boost8_disable_positive_voltage(boost8_t *ctx)
Boost 8 disable positive voltage output function.
boost8_enable_negative_voltage
void boost8_enable_negative_voltage(boost8_t *ctx)
Boost 8 enable negative voltage output function.
boost8_default_cfg
void boost8_default_cfg(boost8_t *ctx)
Boost 8 default configuration function.
boost8_cfg_t
Boost 8 Click configuration object.
Definition: boost8.h:95
BOOST8_OK
@ BOOST8_OK
Definition: boost8.h:107
boost8_cfg_t::en_n
pin_name_t en_n
Definition: boost8.h:97
boost8_enable_positive_voltage
void boost8_enable_positive_voltage(boost8_t *ctx)
Boost 8 enable positive voltage output function.
boost8_disable_negative_voltage
void boost8_disable_negative_voltage(boost8_t *ctx)
Boost 8 disable negative voltage output function.
boost8_t::en_n
digital_out_t en_n
Definition: boost8.h:86
boost8_init
err_t boost8_init(boost8_t *ctx, boost8_cfg_t *cfg)
Boost 8 initialization function.
boost8_enable_both_outputs
void boost8_enable_both_outputs(boost8_t *ctx)
Boost 8 enable both voltage outputs function.
boost8_cfg_setup
void boost8_cfg_setup(boost8_cfg_t *cfg)
Boost 8 configuration object setup function.
boost8_return_value_t
boost8_return_value_t
Boost 8 Click return value data.
Definition: boost8.h:106