boost6
2.0.0.0
clicks
boost6
lib
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
38
#include "drv_digital_out.h"
39
#include "drv_digital_in.h"
40
41
// -------------------------------------------------------------- PUBLIC MACROS
51
#define BOOST6_MAP_MIKROBUS( cfg, mikrobus ) \
52
cfg.rst= MIKROBUS( mikrobus, MIKROBUS_RST ); \
53
cfg.cs= MIKROBUS( mikrobus, MIKROBUS_CS ); \
54
cfg.pwm= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
55
61
#define BOOST6_RETVAL uint8_t
62
63
#define BOOST6_OK 0x00
64
#define BOOST6_INIT_ERROR 0xFF
65
71
#define BOOST6_DISABLE 0x00
72
#define BOOST6_ENABLE 0x01
73
// End group macro
76
// --------------------------------------------------------------- PUBLIC TYPES
85
typedef
struct
86
{
87
// Output pins
88
89
digital_out_t
rst
;
90
digital_out_t
cs
;
91
digital_out_t
pwm
;
92
93
}
boost6_t
;
94
98
typedef
struct
99
{
100
// Additional gpio pins
101
102
pin_name_t
rst
;
103
pin_name_t
cs
;
104
pin_name_t
pwm
;
105
106
}
boost6_cfg_t
;
107
// End types group
109
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
110
116
#ifdef __cplusplus
117
extern
"C"
{
118
#endif
119
128
void
boost6_cfg_setup
(
boost6_cfg_t
*cfg );
129
138
BOOST6_RETVAL
boost6_init
(
boost6_t
*ctx,
boost6_cfg_t
*cfg );
139
149
void
boost6_hw_reset
(
boost6_t
*ctx );
150
160
void
boost6_power_off
(
boost6_t
*ctx );
161
171
void
boost6_power_on
(
boost6_t
*ctx );
172
173
#ifdef __cplusplus
174
}
175
#endif
176
#endif // _BOOST6_H_
177
// End public_function group
180
181
// ------------------------------------------------------------------------- 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:86
boost6_hw_reset
void boost6_hw_reset(boost6_t *ctx)
Hardware reset function.
boost6_cfg_t
Click configuration structure definition.
Definition:
boost6.h:99
BOOST6_RETVAL
#define BOOST6_RETVAL
Definition:
boost6.h:61
boost6_t::pwm
digital_out_t pwm
Definition:
boost6.h:91
boost6_t::cs
digital_out_t cs
Definition:
boost6.h:90
boost6_cfg_t::pwm
pin_name_t pwm
Definition:
boost6.h:104
boost6_cfg_t::cs
pin_name_t cs
Definition:
boost6.h:103
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:102
boost6_t::rst
digital_out_t rst
Definition:
boost6.h:89
Generated by
1.8.20