boost3 2.0.0.0
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
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define BOOST3_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS )
59#define BOOST3_RETVAL uint8_t
60
61#define BOOST3_OK 0x00
62#define BOOST3_INIT_ERROR 0xFF
69#define BOOST3_ENABLE 0x01
70#define BOOST3_DISABLE 0x00 // End group macro
74// --------------------------------------------------------------- PUBLIC TYPES
83typedef struct
84{
85 // Output pins
86
87 digital_out_t en;
88
89} boost3_t;
90
94typedef struct
95{
96 // Additional gpio pins
97
98 pin_name_t en;
99
101 // End types group
103// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
104
110#ifdef __cplusplus
111extern "C"{
112#endif
113
123
133
142void boost3_dev_enable ( boost3_t *ctx, uint8_t state );
143
144
145#ifdef __cplusplus
146}
147#endif
148#endif // _BOOST3_H_
149 // End public_function group
152
153// ------------------------------------------------------------------------- END
#define BOOST3_RETVAL
Definition: boost3.h:59
BOOST3_RETVAL boost3_init(boost3_t *ctx, boost3_cfg_t *cfg)
Initialization function.
void boost3_cfg_setup(boost3_cfg_t *cfg)
Config Object Initialization function.
void boost3_dev_enable(boost3_t *ctx, uint8_t state)
Device Enable function.
Click configuration structure definition.
Definition: boost3.h:95
pin_name_t en
Definition: boost3.h:98
Click ctx object definition.
Definition: boost3.h:84
digital_out_t en
Definition: boost3.h:87