charger13  2.0.0.0
charger13.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 CHARGER13_H
36 #define CHARGER13_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 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define CHARGER13_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.en= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
67  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
68 
74 #define CHARGER13_RETVAL uint8_t
75 
76 #define CHARGER13_OK 0x00
77 #define CHARGER13_INIT_ERROR 0xFF
78  // End group macro
81 // --------------------------------------------------------------- PUBLIC TYPES
90 typedef struct
91 {
92  // Output pins
93 
94  digital_out_t en;
95 
96  // Input pins
97 
98  digital_in_t int_pin;
99 
100 } charger13_t;
101 
105 typedef struct
106 {
107  // Additional gpio pins
108 
109  pin_name_t en;
110  pin_name_t int_pin;
111 
113  // End types group
115 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
116 
122 #ifdef __cplusplus
123 extern "C"{
124 #endif
125 
135 
144 
155 
166 
175 uint8_t charger13_check ( charger13_t *ctx );
176 
177 #ifdef __cplusplus
178 }
179 #endif
180 #endif // _CHARGER13_H_
181  // End public_function group
184 
185 // ------------------------------------------------------------------------- END
charger13_t::en
digital_out_t en
Definition: charger13.h:94
charger13_t
Click ctx object definition.
Definition: charger13.h:91
CHARGER13_RETVAL
#define CHARGER13_RETVAL
Definition: charger13.h:74
charger13_cfg_setup
void charger13_cfg_setup(charger13_cfg_t *cfg)
Config Object Initialization function.
charger13_check
uint8_t charger13_check(charger13_t *ctx)
Check battery charging function.
charger13_init
CHARGER13_RETVAL charger13_init(charger13_t *ctx, charger13_cfg_t *cfg)
Initialization function.
charger13_cfg_t::int_pin
pin_name_t int_pin
Definition: charger13.h:110
charger13_disable
void charger13_disable(charger13_t *ctx)
Disabled charging function.
charger13_t::int_pin
digital_in_t int_pin
Definition: charger13.h:98
charger13_cfg_t
Click configuration structure definition.
Definition: charger13.h:106
charger13_cfg_t::en
pin_name_t en
Definition: charger13.h:109
charger13_enable
void charger13_enable(charger13_t *ctx)
Enabled charging function.