boost3
2.0.0.0
cmake
boost3
lib_boost3
include
boost3.h
Go to the documentation of this file.
1
/*
2
* MikroSDK - MikroE Software Development Kit
3
* Copyright© 2020 MikroElektronika d.o.o.
4
*
5
* Permission is hereby granted, free of charge, to any person
6
* obtaining a copy of this software and associated documentation
7
* files (the "Software"), to deal in the Software without restriction,
8
* including without limitation the rights to use, copy, modify, merge,
9
* publish, distribute, sublicense, and/or sell copies of the Software,
10
* and to permit persons to whom the Software is furnished to do so,
11
* subject to the following conditions:
12
*
13
* The above copyright notice and this permission notice shall be
14
* included in all copies or substantial portions of the Software.
15
*
16
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22
* OR OTHER DEALINGS IN THE SOFTWARE.
23
*/
24
33
// ----------------------------------------------------------------------------
34
35
#ifndef BOOST3_H
36
#define BOOST3_H
37
42
#ifdef PREINIT_SUPPORTED
43
#include "preinit.h"
44
#endif
45
46
#ifdef MikroCCoreVersion
47
#if MikroCCoreVersion >= 1
48
#include "delays.h"
49
#endif
50
#endif
51
52
#include "drv_digital_out.h"
53
#include "drv_digital_in.h"
54
55
// -------------------------------------------------------------- PUBLIC MACROS
65
#define BOOST3_MAP_MIKROBUS( cfg, mikrobus ) \
66
cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS )
67
73
#define BOOST3_RETVAL uint8_t
74
75
#define BOOST3_OK 0x00
76
#define BOOST3_INIT_ERROR 0xFF
77
83
#define BOOST3_ENABLE 0x01
84
#define BOOST3_DISABLE 0x00
85
// End group macro
88
// --------------------------------------------------------------- PUBLIC TYPES
97
typedef
struct
98
{
99
// Output pins
100
101
digital_out_t
en
;
102
103
}
boost3_t
;
104
108
typedef
struct
109
{
110
// Additional gpio pins
111
112
pin_name_t
en
;
113
114
}
boost3_cfg_t
;
115
// End types group
117
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
118
124
#ifdef __cplusplus
125
extern
"C"
{
126
#endif
127
136
void
boost3_cfg_setup
(
boost3_cfg_t
*cfg );
137
146
BOOST3_RETVAL
boost3_init
(
boost3_t
*ctx,
boost3_cfg_t
*cfg );
147
156
void
boost3_dev_enable
(
boost3_t
*ctx, uint8_t state );
157
158
159
#ifdef __cplusplus
160
}
161
#endif
162
#endif // _BOOST3_H_
163
// End public_function group
166
167
// ------------------------------------------------------------------------- END
BOOST3_RETVAL
#define BOOST3_RETVAL
Definition:
boost3.h:73
boost3_cfg_t::en
pin_name_t en
Definition:
boost3.h:112
boost3_t::en
digital_out_t en
Definition:
boost3.h:101
boost3_t
Click ctx object definition.
Definition:
boost3.h:98
boost3_cfg_t
Click configuration structure definition.
Definition:
boost3.h:109
boost3_dev_enable
void boost3_dev_enable(boost3_t *ctx, uint8_t state)
Device Enable function.
boost3_cfg_setup
void boost3_cfg_setup(boost3_cfg_t *cfg)
Config Object Initialization function.
boost3_init
BOOST3_RETVAL boost3_init(boost3_t *ctx, boost3_cfg_t *cfg)
Initialization function.
Generated by
1.8.20