charger18  2.0.0.0
charger18.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 CHARGER18_H
29 #define CHARGER18_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 CHARGER18_CONTROL_DISABLE 0
59 #define CHARGER18_CONTROL_ENABLE 1
60  // charger18_set
62 
77 #define CHARGER18_MAP_MIKROBUS( cfg, mikrobus ) \
78  cfg.bon = MIKROBUS( mikrobus, MIKROBUS_AN ); \
79  cfg.on = MIKROBUS( mikrobus, MIKROBUS_RST ); \
80  cfg.ien = MIKROBUS( mikrobus, MIKROBUS_CS ); \
81  cfg.ldo = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
82  cfg.sta = MIKROBUS( mikrobus, MIKROBUS_INT )
83  // charger18_map // charger18
86 
91 typedef struct
92 {
93  digital_out_t bon;
94  digital_out_t on;
95  digital_out_t ien;
96  digital_out_t ldo;
98  digital_in_t sta;
100 } charger18_t;
101 
106 typedef struct
107 {
108  pin_name_t bon;
109  pin_name_t on;
110  pin_name_t ien;
111  pin_name_t ldo;
112  pin_name_t sta;
115 
120 typedef enum
121 {
123  CHARGER18_ERROR = -1
124 
126 
143 
159 
171 void charger18_buck_control ( charger18_t *ctx, uint8_t state );
172 
184 void charger18_ldo_control ( charger18_t *ctx, uint8_t state );
185 
197 void charger18_suspend_control ( charger18_t *ctx, uint8_t state );
198 
210 void charger18_power_control ( charger18_t *ctx, uint8_t state );
211 
221 
222 #ifdef __cplusplus
223 }
224 #endif
225 #endif // CHARGER18_H
226  // charger18
228 
229 // ------------------------------------------------------------------------ END
charger18_buck_control
void charger18_buck_control(charger18_t *ctx, uint8_t state)
Charger 18 buck control function.
charger18_t::on
digital_out_t on
Definition: charger18.h:94
charger18_t::ien
digital_out_t ien
Definition: charger18.h:95
charger18_t::ldo
digital_out_t ldo
Definition: charger18.h:96
charger18_cfg_t::ien
pin_name_t ien
Definition: charger18.h:110
charger18_t::sta
digital_in_t sta
Definition: charger18.h:98
charger18_t::bon
digital_out_t bon
Definition: charger18.h:93
charger18_cfg_t::sta
pin_name_t sta
Definition: charger18.h:112
CHARGER18_ERROR
@ CHARGER18_ERROR
Definition: charger18.h:123
charger18_ldo_control
void charger18_ldo_control(charger18_t *ctx, uint8_t state)
Charger 18 ldo control function.
charger18_get_sta_pin
uint8_t charger18_get_sta_pin(charger18_t *ctx)
Charger 18 get STA pin function.
charger18_cfg_t::bon
pin_name_t bon
Definition: charger18.h:108
charger18_cfg_setup
void charger18_cfg_setup(charger18_cfg_t *cfg)
Charger 18 configuration object setup function.
charger18_cfg_t::ldo
pin_name_t ldo
Definition: charger18.h:111
charger18_t
Charger 18 Click context object.
Definition: charger18.h:92
charger18_suspend_control
void charger18_suspend_control(charger18_t *ctx, uint8_t state)
Charger 18 suspend control function.
charger18_power_control
void charger18_power_control(charger18_t *ctx, uint8_t state)
Charger 18 power control function.
charger18_init
err_t charger18_init(charger18_t *ctx, charger18_cfg_t *cfg)
Charger 18 initialization function.
charger18_cfg_t::on
pin_name_t on
Definition: charger18.h:109
charger18_cfg_t
Charger 18 Click configuration object.
Definition: charger18.h:107
CHARGER18_OK
@ CHARGER18_OK
Definition: charger18.h:122
charger18_return_value_t
charger18_return_value_t
Charger 18 Click return value data.
Definition: charger18.h:121