buck9  2.0.0.0
buck9.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef BUCK9_H
29 #define BUCK9_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
72  #define BUCK9_DEVICE_ENABLE 0x01
73  #define BUCK9_DEVICE_DISABLE 0x00
74  // buck9_mode
76 
91 #define BUCK9_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
93  // buck9_map // buck9
96 
101 typedef struct
102 {
103  // Output pins
104 
105  digital_out_t en;
106 
107 } buck9_t;
108 
113 typedef struct
114 {
115  // Additional gpio pins
116 
117  pin_name_t en;
118 
119 } buck9_cfg_t;
120 
125 typedef enum
126 {
127  BUCK9_OK = 0,
128  BUCK9_ERROR = -1
129 
131 
148 
163 err_t buck9_init ( buck9_t *ctx, buck9_cfg_t *cfg );
164 
176 void buck9_set_device_mode ( buck9_t *ctx, uint8_t mode);
177 
178 #ifdef __cplusplus
179 }
180 #endif
181 #endif // BUCK9_H
182  // buck9
184 
185 // ------------------------------------------------------------------------ END
buck9_init
err_t buck9_init(buck9_t *ctx, buck9_cfg_t *cfg)
Buck 9 initialization function.
buck9_return_value_t
buck9_return_value_t
Buck 9 Click return value data.
Definition: buck9.h:126
BUCK9_ERROR
@ BUCK9_ERROR
Definition: buck9.h:128
buck9_t::en
digital_out_t en
Definition: buck9.h:105
BUCK9_OK
@ BUCK9_OK
Definition: buck9.h:127
buck9_cfg_setup
void buck9_cfg_setup(buck9_cfg_t *cfg)
Buck 9 configuration object setup function.
buck9_t
Buck 9 Click context object.
Definition: buck9.h:102
buck9_set_device_mode
void buck9_set_device_mode(buck9_t *ctx, uint8_t mode)
Function for enable or disable device.
buck9_cfg_t::en
pin_name_t en
Definition: buck9.h:117
buck9_cfg_t
Buck 9 Click configuration object.
Definition: buck9.h:114