charger16  2.0.0.0
charger16.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 CHARGER16_H
29 #define CHARGER16_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define CHARGER16_MAP_MIKROBUS( cfg, mikrobus ) \
59  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
60  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
61  // charger16_map // charger16
64 
69 typedef struct
70 {
71  digital_out_t en;
72  digital_out_t pwm;
74 } charger16_t;
75 
80 typedef struct
81 {
82  pin_name_t en;
83  pin_name_t pwm;
86 
91 typedef enum
92 {
94  CHARGER16_ERROR = -1
95 
97 
114 
130 
145 
159 
173 
174 #ifdef __cplusplus
175 }
176 #endif
177 #endif // CHARGER16_H
178  // charger16
180 
181 // ------------------------------------------------------------------------ END
CHARGER16_ERROR
@ CHARGER16_ERROR
Definition: charger16.h:94
charger16_disable_charging
err_t charger16_disable_charging(charger16_t *ctx)
Charger 16 disable charging function.
charger16_cfg_setup
void charger16_cfg_setup(charger16_cfg_t *cfg)
Charger 16 configuration object setup function.
charger16_cfg_t::en
pin_name_t en
Definition: charger16.h:82
CHARGER16_OK
@ CHARGER16_OK
Definition: charger16.h:93
charger16_default_cfg
err_t charger16_default_cfg(charger16_t *ctx)
Charger 16 default configuration function.
charger16_t
Charger 16 Click context object.
Definition: charger16.h:70
charger16_cfg_t::pwm
pin_name_t pwm
Definition: charger16.h:83
charger16_t::en
digital_out_t en
Definition: charger16.h:71
charger16_return_value_t
charger16_return_value_t
Charger 16 Click return value data.
Definition: charger16.h:92
charger16_enable_charging
err_t charger16_enable_charging(charger16_t *ctx)
Charger 16 enable charging function.
charger16_t::pwm
digital_out_t pwm
Definition: charger16.h:72
charger16_init
err_t charger16_init(charger16_t *ctx, charger16_cfg_t *cfg)
Charger 16 initialization function.
charger16_cfg_t
Charger 16 Click configuration object.
Definition: charger16.h:81