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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58  #define BUCK9_DEVICE_ENABLE 0x01
59  #define BUCK9_DEVICE_DISABLE 0x00
60  // buck9_mode
62 
77 #define BUCK9_MAP_MIKROBUS( cfg, mikrobus ) \
78  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
79  // buck9_map // buck9
82 
87 typedef struct
88 {
89  // Output pins
90 
91  digital_out_t en;
92 
93 } buck9_t;
94 
99 typedef struct
100 {
101  // Additional gpio pins
102 
103  pin_name_t en;
104 
105 } buck9_cfg_t;
106 
111 typedef enum
112 {
113  BUCK9_OK = 0,
114  BUCK9_ERROR = -1
115 
117 
133 void buck9_cfg_setup ( buck9_cfg_t *cfg );
134 
149 err_t buck9_init ( buck9_t *ctx, buck9_cfg_t *cfg );
150 
162 void buck9_set_device_mode ( buck9_t *ctx, uint8_t mode);
163 
164 #ifdef __cplusplus
165 }
166 #endif
167 #endif // BUCK9_H
168  // buck9
170 
171 // ------------------------------------------------------------------------ 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:110
BUCK9_ERROR
Definition: buck9.h:113
BUCK9_OK
Definition: buck9.h:112
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:86
buck9_set_device_mode
void buck9_set_device_mode(buck9_t *ctx, uint8_t mode)
Function for enable or disable device.
buck9_cfg_t
Buck 9 Click configuration object.
Definition: buck9.h:98