buck10  2.0.0.0
buck10.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 BUCK10_H
29 #define BUCK10_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
68  #define BUCK10_DEVICE_ENABLE 0x01
69  #define BUCK10_DEVICE_DISABLE 0x00
70  // buck10_mode
72 
87 #define BUCK10_MAP_MIKROBUS( cfg, mikrobus ) \
88  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
89  // buck10_map // buck10
92 
97 typedef struct
98 {
99  // Output pins
100 
101  digital_out_t en;
102 
103 } buck10_t;
104 
109 typedef struct
110 {
111  // Additional gpio pins
112 
113  pin_name_t en;
114 
115 } buck10_cfg_t;
116 
121 typedef enum
122 {
124  BUCK10_ERROR = -1
125 
127 
144 
159 err_t buck10_init ( buck10_t *ctx, buck10_cfg_t *cfg );
160 
172 void buck10_set_device_mode ( buck10_t *ctx, uint8_t mode);
173 
174 #ifdef __cplusplus
175 }
176 #endif
177 #endif // BUCK10_H
178  // buck10
180 
181 // ------------------------------------------------------------------------ END
buck10_t::en
digital_out_t en
Definition: buck10.h:101
buck10_t
Buck 10 Click context object.
Definition: buck10.h:98
buck10_cfg_t::en
pin_name_t en
Definition: buck10.h:113
BUCK10_ERROR
@ BUCK10_ERROR
Definition: buck10.h:124
buck10_set_device_mode
void buck10_set_device_mode(buck10_t *ctx, uint8_t mode)
Function for enable or disable device.
buck10_cfg_t
Buck 10 Click configuration object.
Definition: buck10.h:110
buck10_cfg_setup
void buck10_cfg_setup(buck10_cfg_t *cfg)
Buck 10 configuration object setup function.
buck10_return_value_t
buck10_return_value_t
Buck 10 Click return value data.
Definition: buck10.h:122
BUCK10_OK
@ BUCK10_OK
Definition: buck10.h:123
buck10_init
err_t buck10_init(buck10_t *ctx, buck10_cfg_t *cfg)
Buck 10 initialization function.