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 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
68 #define BOOST8_MAP_MIKROBUS( cfg, mikrobus ) \
69  cfg.en_p = MIKROBUS( mikrobus, MIKROBUS_RST ); \
70  cfg.en_n = MIKROBUS( mikrobus, MIKROBUS_PWM );
71  // boost8_map // boost8
74 
79 typedef struct
80 {
81  digital_out_t en_p;
82  digital_out_t en_n;
84 } boost8_t;
85 
90 typedef struct
91 {
92  pin_name_t en_p;
93  pin_name_t en_n;
95 } boost8_cfg_t;
96 
101 typedef enum
102 {
104  BOOST8_ERROR = -1
105 
107 
124 
138 err_t boost8_init ( boost8_t *ctx, boost8_cfg_t *cfg );
139 
151 
161 
171 
181 
191 
201 
211 
212 #ifdef __cplusplus
213 }
214 #endif
215 #endif // BOOST8_H
216  // boost8
218 
219 // ------------------------------------------------------------------------ END
boost8_t
Boost 8 Click context object.
Definition: boost8.h:80
boost8_t::en_p
digital_out_t en_p
Definition: boost8.h:81
BOOST8_ERROR
@ BOOST8_ERROR
Definition: boost8.h:104
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:92
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:91
BOOST8_OK
@ BOOST8_OK
Definition: boost8.h:103
boost8_cfg_t::en_n
pin_name_t en_n
Definition: boost8.h:93
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:82
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:102