charger13  2.0.0.0
charger13.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef CHARGER13_H
36 #define CHARGER13_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define CHARGER13_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.en= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
53  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
54 
60 #define CHARGER13_RETVAL uint8_t
61 
62 #define CHARGER13_OK 0x00
63 #define CHARGER13_INIT_ERROR 0xFF
64  // End group macro
67 // --------------------------------------------------------------- PUBLIC TYPES
76 typedef struct
77 {
78  // Output pins
79 
80  digital_out_t en;
81 
82  // Input pins
83 
84  digital_in_t int_pin;
85 
86 } charger13_t;
87 
91 typedef struct
92 {
93  // Additional gpio pins
94 
95  pin_name_t en;
96  pin_name_t int_pin;
97 
99  // End types group
101 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
102 
108 #ifdef __cplusplus
109 extern "C"{
110 #endif
111 
121 
130 
140 void charger13_enable ( charger13_t *ctx );
141 
151 void charger13_disable ( charger13_t *ctx );
152 
161 uint8_t charger13_check ( charger13_t *ctx );
162 
163 #ifdef __cplusplus
164 }
165 #endif
166 #endif // _CHARGER13_H_
167  // End public_function group
170 
171 // ------------------------------------------------------------------------- END
charger13_t::en
digital_out_t en
Definition: charger13.h:80
charger13_t
Click ctx object definition.
Definition: charger13.h:76
CHARGER13_RETVAL
#define CHARGER13_RETVAL
Definition: charger13.h:60
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:96
charger13_disable
void charger13_disable(charger13_t *ctx)
Disabled charging function.
charger13_t::int_pin
digital_in_t int_pin
Definition: charger13.h:84
charger13_cfg_t
Click configuration structure definition.
Definition: charger13.h:91
charger13_cfg_t::en
pin_name_t en
Definition: charger13.h:95
charger13_enable
void charger13_enable(charger13_t *ctx)
Enabled charging function.