amiro-lld / include / alld_bq24103a.h @ f125ae07
History | View | Annotate | Download (2.61 KB)
1 |
/*
|
---|---|
2 |
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
|
3 |
Copyright (C) 2016..2019 Thomas Schöpping et al.
|
4 |
|
5 |
This program is free software: you can redistribute it and/or modify
|
6 |
it under the terms of the GNU Lesser General Public License as published by
|
7 |
the Free Software Foundation, either version 3 of the License, or
|
8 |
(at your option) any later version.
|
9 |
|
10 |
This program is distributed in the hope that it will be useful,
|
11 |
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
12 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
13 |
GNU Lesser General Public License for more details.
|
14 |
|
15 |
You should have received a copy of the GNU Lesser General Public License
|
16 |
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
17 |
*/
|
18 |
|
19 |
/**
|
20 |
* @file alld_bq24103a.h
|
21 |
* @brief Battery charger constants and driver structure.
|
22 |
*
|
23 |
* @addtogroup lld_charger
|
24 |
* @{
|
25 |
*/
|
26 |
|
27 |
#ifndef _AMIROLLD_BQ24103A_H_
|
28 |
#define _AMIROLLD_BQ24103A_H_
|
29 |
|
30 |
#include <amiro-lld.h> |
31 |
|
32 |
#if defined(AMIROLLD_CFG_USE_BQ24103A) || defined(__DOXYGEN__)
|
33 |
|
34 |
/**
|
35 |
* @brief Active state of enabled gpio.
|
36 |
*/
|
37 |
#define BQ24103A_LLD_ENABLED_GPIO_ACTIVE_STATE APAL_GPIO_ACTIVE_LOW
|
38 |
|
39 |
/**
|
40 |
* @brief Active state of charge status gpio.
|
41 |
*/
|
42 |
#define BQ24103A_LLD_CHARGE_STATUS_GPIO_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
43 |
|
44 |
/**
|
45 |
* @brief The BQ24103A driver struct.
|
46 |
*/
|
47 |
typedef struct { |
48 |
const apalControlGpio_t* gpio_enabled; /**< @brief GPIO to enable/disable the bq24103a */ |
49 |
const apalControlGpio_t* gpio_charge_status; /**< @brief GPIO showing the status of the bq24103a */ |
50 |
} BQ24103ADriver; |
51 |
|
52 |
/**
|
53 |
* @brief Enable enum.
|
54 |
*/
|
55 |
typedef enum { |
56 |
BQ24103A_LLD_ENABLED = 0x01, /**< @brief 'charging on' state */ |
57 |
BQ24103A_LLD_DISABLED = 0x00, /**< @brief 'charging off' state */ |
58 |
} bq24103a_lld_enable_t; |
59 |
|
60 |
/**
|
61 |
* @brief Charge state enum.
|
62 |
*/
|
63 |
typedef enum { |
64 |
BQ24103A_LLD_CHARGING = 0x01, /**< @brief status indicating that the battery is being charged */ |
65 |
BQ24103A_LLD_NOT_CHARGING = 0x00, /**< @brife status indicating that the battery is not being charged */ |
66 |
} bq24103a_lld_charge_state_t; |
67 |
|
68 |
|
69 |
#ifdef __cplusplus
|
70 |
extern "C" { |
71 |
#endif
|
72 |
apalExitStatus_t bq24103a_lld_get_enabled(const BQ24103ADriver* const bq24103a, bq24103a_lld_enable_t* const enable); |
73 |
apalExitStatus_t bq24103a_lld_set_enabled(const BQ24103ADriver* const bq24103a, const bq24103a_lld_enable_t enable); |
74 |
apalExitStatus_t bq24103a_lld_get_charge_status(const BQ24103ADriver* const bq24103a, bq24103a_lld_charge_state_t* const charge); |
75 |
#ifdef __cplusplus
|
76 |
} |
77 |
#endif
|
78 |
|
79 |
#endif /* defined(AMIROLLD_CFG_USE_BQ24103A) */ |
80 |
|
81 |
/** @} */
|
82 |
#endif /* _AMIROLLD_BQ24103A_H_ */ |