boost6
2.0.0.0
cmake
boost6
lib_boost6
include
boost6.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 BOOST6_H
36
#define BOOST6_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 BOOST6_MAP_MIKROBUS( cfg, mikrobus ) \
66
cfg.rst= MIKROBUS( mikrobus, MIKROBUS_RST ); \
67
cfg.cs= MIKROBUS( mikrobus, MIKROBUS_CS ); \
68
cfg.pwm= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
69
75
#define BOOST6_RETVAL uint8_t
76
77
#define BOOST6_OK 0x00
78
#define BOOST6_INIT_ERROR 0xFF
79
85
#define BOOST6_DISABLE 0x00
86
#define BOOST6_ENABLE 0x01
87
// End group macro
90
// --------------------------------------------------------------- PUBLIC TYPES
99
typedef
struct
100
{
101
// Output pins
102
103
digital_out_t
rst
;
104
digital_out_t
cs
;
105
digital_out_t
pwm
;
106
107
}
boost6_t
;
108
112
typedef
struct
113
{
114
// Additional gpio pins
115
116
pin_name_t
rst
;
117
pin_name_t
cs
;
118
pin_name_t
pwm
;
119
120
}
boost6_cfg_t
;
121
// End types group
123
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
124
130
#ifdef __cplusplus
131
extern
"C"
{
132
#endif
133
142
void
boost6_cfg_setup
(
boost6_cfg_t
*cfg );
143
152
BOOST6_RETVAL
boost6_init
(
boost6_t
*ctx,
boost6_cfg_t
*cfg );
153
163
void
boost6_hw_reset
(
boost6_t
*ctx );
164
174
void
boost6_power_off
(
boost6_t
*ctx );
175
185
void
boost6_power_on
(
boost6_t
*ctx );
186
187
#ifdef __cplusplus
188
}
189
#endif
190
#endif // _BOOST6_H_
191
// End public_function group
194
195
// ------------------------------------------------------------------------- END
boost6_cfg_setup
void boost6_cfg_setup(boost6_cfg_t *cfg)
Config Object Initialization function.
boost6_t
Click ctx object definition.
Definition:
boost6.h:100
boost6_hw_reset
void boost6_hw_reset(boost6_t *ctx)
Hardware reset function.
boost6_cfg_t
Click configuration structure definition.
Definition:
boost6.h:113
BOOST6_RETVAL
#define BOOST6_RETVAL
Definition:
boost6.h:75
boost6_t::pwm
digital_out_t pwm
Definition:
boost6.h:105
boost6_t::cs
digital_out_t cs
Definition:
boost6.h:104
boost6_cfg_t::pwm
pin_name_t pwm
Definition:
boost6.h:118
boost6_cfg_t::cs
pin_name_t cs
Definition:
boost6.h:117
boost6_power_off
void boost6_power_off(boost6_t *ctx)
Power OFF function.
boost6_init
BOOST6_RETVAL boost6_init(boost6_t *ctx, boost6_cfg_t *cfg)
Initialization function.
boost6_power_on
void boost6_power_on(boost6_t *ctx)
Power ON function.
boost6_cfg_t::rst
pin_name_t rst
Definition:
boost6.h:116
boost6_t::rst
digital_out_t rst
Definition:
boost6.h:103
Generated by
1.8.20