buck13  2.0.0.0
buck13.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 BUCK13_H
36 #define BUCK13_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 #include "drv_spi_master.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
68 #define BUCK13_MAP_MIKROBUS( cfg, mikrobus ) \
69  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
70  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
71  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
72  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
73  cfg.en = MIKROBUS( mikrobus, MIKROBUS_AN );
74 
80 #define BUCK13_RETVAL uint8_t
81 
82 #define BUCK13_OK 0x00
83 #define BUCK13_INIT_ERROR 0xFF
84 
90 #define BUCK13_ENABLE 1
91 #define BUCK13_DISABLE 0
92  // End group macro
94 // --------------------------------------------------------------- PUBLIC TYPES
103 typedef struct
104 {
105  // Output pins
106 
107  digital_out_t en;
108  digital_out_t cs;
109 
110  // Modules
111 
112  spi_master_t spi;
113  pin_name_t chip_select;
114 
115 } buck13_t;
116 
120 typedef struct
121 {
122  // Communication gpio pins
123 
124  pin_name_t miso;
125  pin_name_t mosi;
126  pin_name_t sck;
127  pin_name_t cs;
128 
129  // Additional gpio pins
130 
131  pin_name_t en;
132 
133  // static variable
134 
135  uint32_t spi_speed;
136  spi_master_mode_t spi_mode;
137  spi_master_chip_select_polarity_t cs_polarity;
138 
139 } buck13_cfg_t;
140  // End types group
142 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
143 
148 #ifdef __cplusplus
149 extern "C"{
150 #endif
151 
161 
171 
185 
198 (
199  buck13_t *ctx,
200  uint8_t *wr_buf,
201  uint16_t wr_len,
202  uint8_t *rd_buf,
203  uint16_t rd_len
204 );
205 
214 void buck13_enable ( buck13_t *ctx, uint8_t pwr_state );
215 
224 uint16_t buck13_get_adc( buck13_t *ctx );
225 
234 uint16_t buck13_get_voltage( buck13_t *ctx );
235 
236 #ifdef __cplusplus
237 }
238 #endif
239 #endif // _BUCK13_H_
240  // End public_function group
243 
244 // ------------------------------------------------------------------------- END
buck13_get_adc
uint16_t buck13_get_adc(buck13_t *ctx)
Get ADC function.
buck13_init
BUCK13_RETVAL buck13_init(buck13_t *ctx, buck13_cfg_t *cfg)
Initialization function.
buck13_t
Click ctx object definition.
Definition: buck13.h:104
buck13_t::cs
digital_out_t cs
Definition: buck13.h:108
buck13_t::chip_select
pin_name_t chip_select
Definition: buck13.h:113
buck13_cfg_t::sck
pin_name_t sck
Definition: buck13.h:126
buck13_cfg_t::cs
pin_name_t cs
Definition: buck13.h:127
buck13_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: buck13.h:137
buck13_cfg_t
Click configuration structure definition.
Definition: buck13.h:121
buck13_generic_transfer
void buck13_generic_transfer(buck13_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
buck13_cfg_t::spi_speed
uint32_t spi_speed
Definition: buck13.h:135
buck13_cfg_t::en
pin_name_t en
Definition: buck13.h:131
BUCK13_RETVAL
#define BUCK13_RETVAL
Definition: buck13.h:80
buck13_t::spi
spi_master_t spi
Definition: buck13.h:112
buck13_t::en
digital_out_t en
Definition: buck13.h:107
buck13_enable
void buck13_enable(buck13_t *ctx, uint8_t pwr_state)
Enable Buck13 function.
buck13_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: buck13.h:136
buck13_default_cfg
void buck13_default_cfg(buck13_t *ctx)
Click Default Configuration function.
buck13_cfg_setup
void buck13_cfg_setup(buck13_cfg_t *cfg)
Config Object Initialization function.
buck13_get_voltage
uint16_t buck13_get_voltage(buck13_t *ctx)
Get voltage function.
buck13_cfg_t::mosi
pin_name_t mosi
Definition: buck13.h:125
buck13_cfg_t::miso
pin_name_t miso
Definition: buck13.h:124