buck3  2.0.0.0
buck3.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 BUCK3_H
36 #define BUCK3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define BUCK3_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.en= MIKROBUS( mikrobus, MIKROBUS_RST ); \
53  cfg.pgd= MIKROBUS( mikrobus, MIKROBUS_CS );
54 
60 #define BUCK3_RETVAL uint8_t
61 
62 #define BUCK3_OK 0x00
63 #define BUCK3_INIT_ERROR 0xFF
64 
70 #define BUCK3_MODE_ACTIVE 0x01
71 #define BUCK3_MODE_SLEEP 0x00
72  // End group macro
75 // --------------------------------------------------------------- PUBLIC TYPES
84 typedef struct
85 {
86  // Output pins
87 
88  digital_out_t en;
89 
90  // Input pins
91 
92  digital_in_t pgd;
93 
94 } buck3_t;
95 
99 typedef struct
100 {
101  // Additional gpio pins
102 
103  pin_name_t en;
104  pin_name_t pgd;
105 
106 } buck3_cfg_t;
107  // End types group
109 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
110 
116 #ifdef __cplusplus
117 extern "C"{
118 #endif
119 
128 void buck3_cfg_setup ( buck3_cfg_t *cfg );
129 
138 
150 void buck3_default_cfg ( buck3_t *ctx );
151 
162 uint8_t buck3_get_power_good ( buck3_t *ctx );
163 
177 void buck3_set_device_state ( buck3_t *ctx, uint8_t state );
178 
179 
180 #ifdef __cplusplus
181 }
182 #endif
183 #endif // _BUCK3_H_
184  // End public_function group
187 
188 // ------------------------------------------------------------------------- END
buck3_set_device_state
void buck3_set_device_state(buck3_t *ctx, uint8_t state)
Function for setting chip mode.
buck3_cfg_setup
void buck3_cfg_setup(buck3_cfg_t *cfg)
Config Object Initialization function.
buck3_t::en
digital_out_t en
Definition: buck3.h:88
buck3_cfg_t::pgd
pin_name_t pgd
Definition: buck3.h:104
BUCK3_RETVAL
#define BUCK3_RETVAL
Definition: buck3.h:60
buck3_get_power_good
uint8_t buck3_get_power_good(buck3_t *ctx)
Function reads state of PGD pin.
buck3_default_cfg
void buck3_default_cfg(buck3_t *ctx)
Click Default Configuration function.
buck3_cfg_t::en
pin_name_t en
Definition: buck3.h:103
buck3_t::pgd
digital_in_t pgd
Definition: buck3.h:92
buck3_init
BUCK3_RETVAL buck3_init(buck3_t *ctx, buck3_cfg_t *cfg)
Initialization function.
buck3_t
Click ctx object definition.
Definition: buck3.h:84
buck3_cfg_t
Click configuration structure definition.
Definition: buck3.h:99