boost6  2.0.0.0
boost6.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 BOOST6_H
36 #define BOOST6_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 BOOST6_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.rst= MIKROBUS( mikrobus, MIKROBUS_RST ); \
63  cfg.cs= MIKROBUS( mikrobus, MIKROBUS_CS ); \
64  cfg.pwm= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
65 
71 #define BOOST6_RETVAL uint8_t
72 
73 #define BOOST6_OK 0x00
74 #define BOOST6_INIT_ERROR 0xFF
75 
81 #define BOOST6_DISABLE 0x00
82 #define BOOST6_ENABLE 0x01
83  // End group macro
86 // --------------------------------------------------------------- PUBLIC TYPES
95 typedef struct
96 {
97  // Output pins
98 
99  digital_out_t rst;
100  digital_out_t cs;
101  digital_out_t pwm;
102 
103 } boost6_t;
104 
108 typedef struct
109 {
110  // Additional gpio pins
111 
112  pin_name_t rst;
113  pin_name_t cs;
114  pin_name_t pwm;
115 
116 } boost6_cfg_t;
117  // End types group
119 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
120 
126 #ifdef __cplusplus
127 extern "C"{
128 #endif
129 
139 
149 
159 void boost6_hw_reset ( boost6_t *ctx );
160 
171 
181 void boost6_power_on ( boost6_t *ctx );
182 
183 #ifdef __cplusplus
184 }
185 #endif
186 #endif // _BOOST6_H_
187  // End public_function group
190 
191 // ------------------------------------------------------------------------- END
boost6_cfg_setup
void boost6_cfg_setup(boost6_cfg_t *cfg)
Config Object Initialization function.
boost6_t
Click ctx object definition.
Definition: boost6.h:96
boost6_hw_reset
void boost6_hw_reset(boost6_t *ctx)
Hardware reset function.
boost6_cfg_t
Click configuration structure definition.
Definition: boost6.h:109
BOOST6_RETVAL
#define BOOST6_RETVAL
Definition: boost6.h:71
boost6_t::pwm
digital_out_t pwm
Definition: boost6.h:101
boost6_t::cs
digital_out_t cs
Definition: boost6.h:100
boost6_cfg_t::pwm
pin_name_t pwm
Definition: boost6.h:114
boost6_cfg_t::cs
pin_name_t cs
Definition: boost6.h:113
boost6_power_off
void boost6_power_off(boost6_t *ctx)
Power OFF function.
boost6_init
BOOST6_RETVAL boost6_init(boost6_t *ctx, boost6_cfg_t *cfg)
Initialization function.
boost6_power_on
void boost6_power_on(boost6_t *ctx)
Power ON function.
boost6_cfg_t::rst
pin_name_t rst
Definition: boost6.h:112
boost6_t::rst
digital_out_t rst
Definition: boost6.h:99