boost2 2.0.0.0
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
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 )
60#define BOOST2_RETVAL uint8_t
61
62#define BOOST2_OK 0x00
63#define BOOST2_INIT_ERROR 0xFF // End group macro
67// --------------------------------------------------------------- PUBLIC TYPES
76typedef 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
91typedef struct
92{
93 // Additional gpio pins
94
95 pin_name_t en;
96
97 pin_name_t pg;
98
100 // End types group
102
103// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
104
110#ifdef __cplusplus
111extern "C"{
112#endif
113
123
132
141void boost2_set_en_pin ( boost2_t *ctx, uint8_t new_state );
142
151
152#ifdef __cplusplus
153}
154#endif
155#endif // _BOOST2_H_
156 // End public_function group
159
160// ------------------------------------------------------------------------- END
#define BOOST2_RETVAL
Definition: boost2.h:60
BOOST2_RETVAL boost2_init(boost2_t *ctx, boost2_cfg_t *cfg)
Initialization function.
void boost2_cfg_setup(boost2_cfg_t *cfg)
Config Object Initialization function.
void boost2_set_en_pin(boost2_t *ctx, uint8_t new_state)
Set enable pin.
uint8_t boost2_get_pg_pin(boost2_t *ctx)
Get PG pin state.
Click configuration structure definition.
Definition: boost2.h:92
pin_name_t en
Definition: boost2.h:95
pin_name_t pg
Definition: boost2.h:97
Click ctx object definition.
Definition: boost2.h:77
digital_out_t en
Definition: boost2.h:80
digital_in_t pg
Definition: boost2.h:84