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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37
58#define BOOST8_MAP_MIKROBUS( cfg, mikrobus ) \
59 cfg.en_p = MIKROBUS( mikrobus, MIKROBUS_RST ); \
60 cfg.en_n = MIKROBUS( mikrobus, MIKROBUS_PWM );
61 // boost8_map // boost8
64
69typedef struct
70{
71 digital_out_t en_p;
72 digital_out_t en_n;
74} boost8_t;
75
80typedef struct
81{
82 pin_name_t en_p;
83 pin_name_t en_n;
86
91typedef enum
92{
94 BOOST8_ERROR = -1
95
97
114
128err_t boost8_init ( boost8_t *ctx, boost8_cfg_t *cfg );
129
141
151
161
171
181
191
201
202#ifdef __cplusplus
203}
204#endif
205#endif // BOOST8_H
206 // boost8
208
209// ------------------------------------------------------------------------ END
boost8_return_value_t
Boost 8 Click return value data.
Definition: boost8.h:92
@ BOOST8_OK
Definition: boost8.h:93
@ BOOST8_ERROR
Definition: boost8.h:94
void boost8_cfg_setup(boost8_cfg_t *cfg)
Boost 8 configuration object setup function.
void boost8_disable_positive_voltage(boost8_t *ctx)
Boost 8 disable positive voltage output function.
void boost8_enable_negative_voltage(boost8_t *ctx)
Boost 8 enable negative voltage output function.
void boost8_disable_both_outputs(boost8_t *ctx)
Boost 8 disable both voltage outputs function.
void boost8_disable_negative_voltage(boost8_t *ctx)
Boost 8 disable negative voltage output function.
void boost8_default_cfg(boost8_t *ctx)
Boost 8 default configuration function.
void boost8_enable_both_outputs(boost8_t *ctx)
Boost 8 enable both voltage outputs function.
err_t boost8_init(boost8_t *ctx, boost8_cfg_t *cfg)
Boost 8 initialization function.
void boost8_enable_positive_voltage(boost8_t *ctx)
Boost 8 enable positive voltage output function.
Boost 8 Click configuration object.
Definition: boost8.h:81
pin_name_t en_n
Definition: boost8.h:83
pin_name_t en_p
Definition: boost8.h:82
Boost 8 Click context object.
Definition: boost8.h:70
digital_out_t en_p
Definition: boost8.h:71
digital_out_t en_n
Definition: boost8.h:72