buck8 2.0.0.0
buck8.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 BUCK8_H
36#define BUCK8_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define BUCK8_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.rst= MIKROBUS( mikrobus, MIKROBUS_RST ); \
53 cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
54 cfg.syn= MIKROBUS( mikrobus, MIKROBUS_PWM );
61#define BUCK8_RETVAL uint8_t
62
63#define BUCK8_OK 0x00
64#define BUCK8_INIT_ERROR 0xFF
71#define BUCK8_MODE_ACTIVE 0x01
72#define BUCK8_MODE_SLEEP 0x00 // End group macro
76// --------------------------------------------------------------- PUBLIC TYPES
85typedef struct
86{
87 // Output pins
88
89 digital_out_t rst;
90 digital_in_t en;
91 digital_out_t syn;
92
93} buck8_t;
94
98typedef struct
99{
100 // Additional gpio pins
101
102 pin_name_t rst;
103 pin_name_t en;
104 pin_name_t syn;
105
107 // End types group
109// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
110
116#ifdef __cplusplus
117extern "C"{
118#endif
119
129
138
151
163void buck8_set_power_mode ( buck8_t *ctx, uint8_t mode );
164
176uint8_t buck8_get_state ( buck8_t *ctx );
177
178
179#ifdef __cplusplus
180}
181#endif
182#endif // _BUCK8_H_
183 // End public_function group
186
187// ------------------------------------------------------------------------- END
#define BUCK8_RETVAL
Definition: buck8.h:61
BUCK8_RETVAL buck8_init(buck8_t *ctx, buck8_cfg_t *cfg)
Initialization function.
void buck8_set_power_mode(buck8_t *ctx, uint8_t mode)
Function settings mode.
void buck8_default_cfg(buck8_t *ctx)
Click Default Configuration function.
void buck8_cfg_setup(buck8_cfg_t *cfg)
Config Object Initialization function.
uint8_t buck8_get_state(buck8_t *ctx)
Function reads state of pin.
Click configuration structure definition.
Definition: buck8.h:99
pin_name_t en
Definition: buck8.h:103
pin_name_t rst
Definition: buck8.h:102
pin_name_t syn
Definition: buck8.h:104
Click ctx object definition.
Definition: buck8.h:86
digital_out_t syn
Definition: buck8.h:91
digital_in_t en
Definition: buck8.h:90
digital_out_t rst
Definition: buck8.h:89