buck2 2.0.0.0
buck2.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 BUCK2_H
36#define BUCK2_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define BUCK2_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.voset0 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
53 cfg.voset1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
54 cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
55 cfg.fq= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
56 cfg.pg= MIKROBUS( mikrobus, MIKROBUS_INT );
63#define BUCK2_RETVAL uint8_t
64
65#define BUCK2_OK 0x00
66#define BUCK2_INIT_ERROR 0xFF
73#define BUCK2_MODE_ACTIVE 0x01
74#define BUCK2_MODE_SLEEP 0x00
81#define BUCK2_VOSET_LOW 0x00
82#define BUCK2_VOSET_HIGH 0x01
89#define BUCK2_FREQ_790KHz 0x01
90#define BUCK2_FREQ_565KHz 0x00
97#define BUCK2_SET_VOLTAGE_3300mV 0
98#define BUCK2_SET_VOLTAGE_2500mV 1
99#define BUCK2_SET_VOLTAGE_1800mV 2
100#define BUCK2_SET_VOLTAGE_1500mV 3
107#define BUCK2_VOSET_CH_0 0
108#define BUCK2_VOSET_CH_1 1 // End group macro
112// --------------------------------------------------------------- PUBLIC TYPES
121typedef struct
122{
123 // Output pins
124
125 digital_out_t voset0;
126 digital_out_t voset1;
127 digital_out_t en;
128 digital_out_t fq;
129
130 // Input pins
131
132 digital_in_t pg;
133
134} buck2_t;
135
139typedef struct
140{
141 // Additional gpio pins
142
143 pin_name_t voset0;
144 pin_name_t voset1;
145 pin_name_t en;
146 pin_name_t fq;
147 pin_name_t pg;
148
150 // End types group
152
153// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
154
160#ifdef __cplusplus
161extern "C"{
162#endif
163
173
182
198
206void buck2_set_voset ( buck2_t *ctx, uint8_t channel, uint8_t state );
207
220void busk2_set_frequency ( buck2_t *ctx, uint8_t freq );
221
234void buck2_set_power_mode ( buck2_t *ctx, uint8_t mode );
235
242
254
269void buck2_set_output_voltage ( buck2_t *ctx , uint8_t voltage );
270
271#ifdef __cplusplus
272}
273#endif
274#endif // _BUCK2_H_
275 // End public_function group
278
279// ------------------------------------------------------------------------- END
#define BUCK2_RETVAL
Definition: buck2.h:63
void buck2_default_cfg(buck2_t *ctx)
Click Default Configuration function.
void back2_device_reset(buck2_t *ctx)
Function for reset chip.
void buck2_cfg_setup(buck2_cfg_t *cfg)
Config Object Initialization function.
BUCK2_RETVAL buck2_init(buck2_t *ctx, buck2_cfg_t *cfg)
Initialization function.
void buck2_set_power_mode(buck2_t *ctx, uint8_t mode)
Function settings chip mode.
void buck2_set_output_voltage(buck2_t *ctx, uint8_t voltage)
Function settings output voltage.
void buck2_set_voset(buck2_t *ctx, uint8_t channel, uint8_t state)
Function settings VOSET pin state.
uint8_t buck2_get_power_good(buck2_t *ctx)
Function reads state PG pin.
void busk2_set_frequency(buck2_t *ctx, uint8_t freq)
Function settings Frequency.
Click configuration structure definition.
Definition: buck2.h:140
pin_name_t fq
Definition: buck2.h:146
pin_name_t voset0
Definition: buck2.h:143
pin_name_t voset1
Definition: buck2.h:144
pin_name_t en
Definition: buck2.h:145
pin_name_t pg
Definition: buck2.h:147
Click ctx object definition.
Definition: buck2.h:122
digital_out_t voset0
Definition: buck2.h:125
digital_out_t fq
Definition: buck2.h:128
digital_out_t voset1
Definition: buck2.h:126
digital_out_t en
Definition: buck2.h:127
digital_in_t pg
Definition: buck2.h:132