boost7  2.1.0.0
boost7.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 BOOST7_H
29 #define BOOST7_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define BOOST7_MAP_MIKROBUS( cfg, mikrobus ) \
59  cfg.stb1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
60  cfg.stb2 = MIKROBUS( mikrobus, MIKROBUS_PWM )
61  // boost7_map // boost7
64 
69 typedef struct
70 {
71  digital_out_t stb1;
72  digital_out_t stb2;
74 } boost7_t;
75 
80 typedef struct
81 {
82  pin_name_t stb1;
83  pin_name_t stb2;
85 } boost7_cfg_t;
86 
91 typedef enum
92 {
93  BOOST7_OK = 0,
94  BOOST7_ERROR = -1
95 
97 
114 
128 err_t boost7_init ( boost7_t *ctx, boost7_cfg_t *cfg );
129 
139 
149 
159 
169 
170 #ifdef __cplusplus
171 }
172 #endif
173 #endif // BOOST7_H
174  // boost7
176 
177 // ------------------------------------------------------------------------ END
boost7_t::stb1
digital_out_t stb1
Definition: boost7.h:71
boost7_enable_out2
void boost7_enable_out2(boost7_t *ctx)
Boost 7 enable out2 function.
boost7_init
err_t boost7_init(boost7_t *ctx, boost7_cfg_t *cfg)
Boost 7 initialization function.
boost7_cfg_t::stb1
pin_name_t stb1
Definition: boost7.h:82
BOOST7_ERROR
@ BOOST7_ERROR
Definition: boost7.h:94
boost7_return_value_t
boost7_return_value_t
Boost 7 Click return value data.
Definition: boost7.h:92
boost7_disable_out1
void boost7_disable_out1(boost7_t *ctx)
Boost 7 disable out1 function.
boost7_cfg_setup
void boost7_cfg_setup(boost7_cfg_t *cfg)
Boost 7 configuration object setup function.
boost7_disable_out2
void boost7_disable_out2(boost7_t *ctx)
Boost 7 disable out2 function.
boost7_cfg_t
Boost 7 Click configuration object.
Definition: boost7.h:81
boost7_t
Boost 7 Click context object.
Definition: boost7.h:70
boost7_cfg_t::stb2
pin_name_t stb2
Definition: boost7.h:83
BOOST7_OK
@ BOOST7_OK
Definition: boost7.h:93
boost7_t::stb2
digital_out_t stb2
Definition: boost7.h:72
boost7_enable_out1
void boost7_enable_out1(boost7_t *ctx)
Boost 7 enable out1 function.