boost2
2.0.0.0
cmake
boost2
lib_boost2
include
boost2.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 BOOST2_H
36
#define BOOST2_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 BOOST2_MAP_MIKROBUS( cfg, mikrobus ) \
66
cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
67
cfg.pg= MIKROBUS( mikrobus, MIKROBUS_INT )
68
74
#define BOOST2_RETVAL uint8_t
75
76
#define BOOST2_OK 0x00
77
#define BOOST2_INIT_ERROR 0xFF
78
// End group macro
81
// --------------------------------------------------------------- PUBLIC TYPES
90
typedef
struct
91
{
92
// Output pins
93
94
digital_out_t
en
;
95
96
// Input pins
97
98
digital_in_t
pg
;
99
100
}
boost2_t
;
101
105
typedef
struct
106
{
107
// Additional gpio pins
108
109
pin_name_t
en
;
110
111
pin_name_t
pg
;
112
113
}
boost2_cfg_t
;
114
// End types group
116
117
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
118
124
#ifdef __cplusplus
125
extern
"C"
{
126
#endif
127
136
void
boost2_cfg_setup
(
boost2_cfg_t
*cfg );
137
145
BOOST2_RETVAL
boost2_init
(
boost2_t
*ctx,
boost2_cfg_t
*cfg );
146
155
void
boost2_set_en_pin
(
boost2_t
*ctx, uint8_t new_state );
156
164
uint8_t
boost2_get_pg_pin
(
boost2_t
*ctx );
165
166
#ifdef __cplusplus
167
}
168
#endif
169
#endif // _BOOST2_H_
170
// End public_function group
173
174
// ------------------------------------------------------------------------- END
boost2_cfg_setup
void boost2_cfg_setup(boost2_cfg_t *cfg)
Config Object Initialization function.
boost2_t::en
digital_out_t en
Definition:
boost2.h:94
boost2_cfg_t::en
pin_name_t en
Definition:
boost2.h:109
boost2_cfg_t
Click configuration structure definition.
Definition:
boost2.h:106
boost2_set_en_pin
void boost2_set_en_pin(boost2_t *ctx, uint8_t new_state)
Set enable pin.
boost2_init
BOOST2_RETVAL boost2_init(boost2_t *ctx, boost2_cfg_t *cfg)
Initialization function.
boost2_t::pg
digital_in_t pg
Definition:
boost2.h:98
boost2_t
Click ctx object definition.
Definition:
boost2.h:91
boost2_get_pg_pin
uint8_t boost2_get_pg_pin(boost2_t *ctx)
Get PG pin state.
boost2_cfg_t::pg
pin_name_t pg
Definition:
boost2.h:111
BOOST2_RETVAL
#define BOOST2_RETVAL
Definition:
boost2.h:74
Generated by
1.8.20