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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define BUCK8_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.rst= MIKROBUS( mikrobus, MIKROBUS_RST ); \
63  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
64  cfg.syn= MIKROBUS( mikrobus, MIKROBUS_PWM );
65 
71 #define BUCK8_RETVAL uint8_t
72 
73 #define BUCK8_OK 0x00
74 #define BUCK8_INIT_ERROR 0xFF
75 
81 #define BUCK8_MODE_ACTIVE 0x01
82 #define BUCK8_MODE_SLEEP 0x00
83  // End group macro
86 // --------------------------------------------------------------- PUBLIC TYPES
95 typedef struct
96 {
97  // Output pins
98 
99  digital_out_t rst;
100  digital_in_t en;
101  digital_out_t syn;
102 
103 } buck8_t;
104 
108 typedef struct
109 {
110  // Additional gpio pins
111 
112  pin_name_t rst;
113  pin_name_t en;
114  pin_name_t syn;
115 
116 } buck8_cfg_t;
117  // End types group
119 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
120 
126 #ifdef __cplusplus
127 extern "C"{
128 #endif
129 
139 
148 
161 
173 void buck8_set_power_mode ( buck8_t *ctx, uint8_t mode );
174 
186 uint8_t buck8_get_state ( buck8_t *ctx );
187 
188 
189 #ifdef __cplusplus
190 }
191 #endif
192 #endif // _BUCK8_H_
193  // End public_function group
196 
197 // ------------------------------------------------------------------------- END
buck8_cfg_t::syn
pin_name_t syn
Definition: buck8.h:114
buck8_set_power_mode
void buck8_set_power_mode(buck8_t *ctx, uint8_t mode)
Function settings mode.
buck8_t::en
digital_in_t en
Definition: buck8.h:100
buck8_get_state
uint8_t buck8_get_state(buck8_t *ctx)
Function reads state of pin.
buck8_cfg_t::rst
pin_name_t rst
Definition: buck8.h:112
buck8_cfg_t::en
pin_name_t en
Definition: buck8.h:113
buck8_t::rst
digital_out_t rst
Definition: buck8.h:99
buck8_init
BUCK8_RETVAL buck8_init(buck8_t *ctx, buck8_cfg_t *cfg)
Initialization function.
BUCK8_RETVAL
#define BUCK8_RETVAL
Definition: buck8.h:71
buck8_t
Click ctx object definition.
Definition: buck8.h:96
buck8_cfg_setup
void buck8_cfg_setup(buck8_cfg_t *cfg)
Config Object Initialization function.
buck8_default_cfg
void buck8_default_cfg(buck8_t *ctx)
Click Default Configuration function.
buck8_cfg_t
Click configuration structure definition.
Definition: buck8.h:109
buck8_t::syn
digital_out_t syn
Definition: buck8.h:101