charger26 2.1.0.0
charger26.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 CHARGER26_H
29#define CHARGER26_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37
53#define CHARGER26_PIN_STATE_HIGH 0x01
54#define CHARGER26_PIN_STATE_LOW 0x00
55
60#define CHARGER26_SELV_4V1_REG_POINT 0x00
61#define CHARGER26_SELV_4V2_REG_POINT 0x01
62
67#define CHARGER26_SELI_100_MA_MAX_REG 0x00
68#define CHARGER26_SELI_500_MA_MAX_REG 0x01
69
74#define CHARGER26_ENABLE_OUTPUT 0x01
75#define CHARGER26_DISABLE_OUTPUT 0x00
76
77 // charger26_set
79
94#define CHARGER26_MAP_MIKROBUS( cfg, mikrobus ) \
95 cfg.vsel = MIKROBUS( mikrobus, MIKROBUS_AN ); \
96 cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
97 cfg.isel = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
98 cfg.chg = MIKROBUS( mikrobus, MIKROBUS_INT )
99 // charger26_map // charger26
102
107typedef struct
108{
109 digital_out_t vsel;
110 digital_out_t en;
111 digital_out_t isel;
113 digital_in_t chg;
116
121typedef struct
122{
123 pin_name_t vsel;
124 pin_name_t en;
125 pin_name_t isel;
126 pin_name_t chg;
129
134typedef enum
135{
137 CHARGER26_ERROR = -1
138
140
157
172
184
195void charger26_set_vsel ( charger26_t *ctx, uint8_t vout_sel );
196
207void charger26_set_isel ( charger26_t *ctx, uint8_t iout_sel );
208
219void charger26_enable_output ( charger26_t *ctx, uint8_t output_state );
220
232
233#ifdef __cplusplus
234}
235#endif
236#endif // CHARGER26_H
237 // charger26
239
240// ------------------------------------------------------------------------ END
charger26_return_value_t
Charger 26 Click return value data.
Definition: charger26.h:135
@ CHARGER26_ERROR
Definition: charger26.h:137
@ CHARGER26_OK
Definition: charger26.h:136
void charger26_enable_output(charger26_t *ctx, uint8_t output_state)
Charger 26 enable charger output function.
uint8_t charger26_get_chg_state(charger26_t *ctx)
Charger 26 chg pin reading function.
void charger26_set_vsel(charger26_t *ctx, uint8_t vout_sel)
Charger 26 select charger voltage function.
err_t charger26_init(charger26_t *ctx, charger26_cfg_t *cfg)
Charger 26 initialization function.
void charger26_cfg_setup(charger26_cfg_t *cfg)
Charger 26 configuration object setup function.
void charger26_default_cfg(charger26_t *ctx)
Charger 26 default configuration function.
void charger26_set_isel(charger26_t *ctx, uint8_t iout_sel)
Charger 26 select charger current function.
Charger 26 Click configuration object.
Definition: charger26.h:122
pin_name_t vsel
Definition: charger26.h:123
pin_name_t en
Definition: charger26.h:124
pin_name_t isel
Definition: charger26.h:125
pin_name_t chg
Definition: charger26.h:126
Charger 26 Click context object.
Definition: charger26.h:108
digital_out_t vsel
Definition: charger26.h:109
digital_out_t isel
Definition: charger26.h:111
digital_in_t chg
Definition: charger26.h:113
digital_out_t en
Definition: charger26.h:110