boost2
2.0.0.0
lib
include
boost2.h
Go to the documentation of this file.
1
/*
2
* MikroSDK - MikroE Software Development Kit
3
* Copyright (c) 2019, MikroElektronika - www.mikroe.com
4
* All rights reserved.
5
*
6
* Permission is hereby granted, free of charge, to any person obtaining a copy
7
* of this software and associated documentation files (the "Software"), to deal
8
* in the Software without restriction, including without limitation the rights
9
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
* copies of the Software, and to permit persons to whom the Software is
11
* furnished to do so, subject to the following conditions:
12
*
13
* The above copyright notice and this permission notice shall be included in
14
* all copies or substantial portions of the Software.
15
*
16
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
* SOFTWARE.
23
*/
24
33
// ----------------------------------------------------------------------------
34
35
#ifndef BOOST2_H
36
#define BOOST2_H
37
38
#include "drv_digital_out.h"
39
#include "drv_digital_in.h"
40
41
// -------------------------------------------------------------- PUBLIC MACROS
51
#define BOOST2_MAP_MIKROBUS( cfg, mikrobus ) \
52
cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
53
cfg.pg= MIKROBUS( mikrobus, MIKROBUS_INT )
54
60
#define BOOST2_RETVAL uint8_t
61
62
#define BOOST2_OK 0x00
63
#define BOOST2_INIT_ERROR 0xFF
64
// End group macro
67
// --------------------------------------------------------------- PUBLIC TYPES
76
typedef
struct
77
{
78
// Output pins
79
80
digital_out_t
en
;
81
82
// Input pins
83
84
digital_in_t
pg
;
85
86
}
boost2_t
;
87
91
typedef
struct
92
{
93
// Additional gpio pins
94
95
pin_name_t
en
;
96
97
pin_name_t
pg
;
98
99
}
boost2_cfg_t
;
100
// End types group
102
103
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
104
110
#ifdef __cplusplus
111
extern
"C"
{
112
#endif
113
122
void
boost2_cfg_setup
(
boost2_cfg_t
*cfg );
123
131
BOOST2_RETVAL
boost2_init
(
boost2_t
*ctx,
boost2_cfg_t
*cfg );
132
141
void
boost2_set_en_pin
(
boost2_t
*ctx, uint8_t new_state );
142
150
uint8_t
boost2_get_pg_pin
(
boost2_t
*ctx );
151
152
#ifdef __cplusplus
153
}
154
#endif
155
#endif // _BOOST2_H_
156
// End public_function group
159
160
// ------------------------------------------------------------------------- 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:80
boost2_cfg_t::en
pin_name_t en
Definition:
boost2.h:95
boost2_cfg_t
Click configuration structure definition.
Definition:
boost2.h:91
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:84
boost2_t
Click ctx object definition.
Definition:
boost2.h:76
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:97
BOOST2_RETVAL
#define BOOST2_RETVAL
Definition:
boost2.h:60
Generated by
1.8.16