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 
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 BOOST7_MAP_MIKROBUS( cfg, mikrobus ) \
73  cfg.stb1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
74  cfg.stb2 = MIKROBUS( mikrobus, MIKROBUS_PWM )
75  // boost7_map // boost7
78 
83 typedef struct
84 {
85  digital_out_t stb1;
86  digital_out_t stb2;
88 } boost7_t;
89 
94 typedef struct
95 {
96  pin_name_t stb1;
97  pin_name_t stb2;
99 } boost7_cfg_t;
100 
105 typedef enum
106 {
108  BOOST7_ERROR = -1
109 
111 
128 
142 err_t boost7_init ( boost7_t *ctx, boost7_cfg_t *cfg );
143 
153 
163 
173 
183 
184 #ifdef __cplusplus
185 }
186 #endif
187 #endif // BOOST7_H
188  // boost7
190 
191 // ------------------------------------------------------------------------ END
boost7_t::stb1
digital_out_t stb1
Definition: boost7.h:85
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:96
BOOST7_ERROR
@ BOOST7_ERROR
Definition: boost7.h:108
boost7_return_value_t
boost7_return_value_t
Boost 7 Click return value data.
Definition: boost7.h:106
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:95
boost7_t
Boost 7 Click context object.
Definition: boost7.h:84
boost7_cfg_t::stb2
pin_name_t stb2
Definition: boost7.h:97
BOOST7_OK
@ BOOST7_OK
Definition: boost7.h:107
boost7_t::stb2
digital_out_t stb2
Definition: boost7.h:86
boost7_enable_out1
void boost7_enable_out1(boost7_t *ctx)
Boost 7 enable out1 function.