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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define BUCK3_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.en= MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.pgd= MIKROBUS( mikrobus, MIKROBUS_CS );
68 
74 #define BUCK3_RETVAL uint8_t
75 
76 #define BUCK3_OK 0x00
77 #define BUCK3_INIT_ERROR 0xFF
78 
84 #define BUCK3_MODE_ACTIVE 0x01
85 #define BUCK3_MODE_SLEEP 0x00
86  // End group macro
89 // --------------------------------------------------------------- PUBLIC TYPES
98 typedef struct
99 {
100  // Output pins
101 
102  digital_out_t en;
103 
104  // Input pins
105 
106  digital_in_t pgd;
107 
108 } buck3_t;
109 
113 typedef struct
114 {
115  // Additional gpio pins
116 
117  pin_name_t en;
118  pin_name_t pgd;
119 
120 } buck3_cfg_t;
121  // End types group
123 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
124 
130 #ifdef __cplusplus
131 extern "C"{
132 #endif
133 
143 
152 
165 
176 uint8_t buck3_get_power_good ( buck3_t *ctx );
177 
191 void buck3_set_device_state ( buck3_t *ctx, uint8_t state );
192 
193 
194 #ifdef __cplusplus
195 }
196 #endif
197 #endif // _BUCK3_H_
198  // End public_function group
201 
202 // ------------------------------------------------------------------------- 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:102
buck3_cfg_t::pgd
pin_name_t pgd
Definition: buck3.h:118
BUCK3_RETVAL
#define BUCK3_RETVAL
Definition: buck3.h:74
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:117
buck3_t::pgd
digital_in_t pgd
Definition: buck3.h:106
buck3_init
BUCK3_RETVAL buck3_init(buck3_t *ctx, buck3_cfg_t *cfg)
Initialization function.
buck3_t
Click ctx object definition.
Definition: buck3.h:99
buck3_cfg_t
Click configuration structure definition.
Definition: buck3.h:114