amiro-lld / include / alld_bq24103a.h @ ef078306
History | View | Annotate | Download (4.277 KB)
| 1 | d6728c5b | Thomas Schöpping | /*
|
|---|---|---|---|
| 2 | AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
|
||
| 3 | f125ae07 | Thomas Schöpping | Copyright (C) 2016..2019 Thomas Schöpping et al.
|
| 4 | d6728c5b | Thomas Schöpping | |
| 5 | This program is free software: you can redistribute it and/or modify
|
||
| 6 | f0ca400f | Thomas Schöpping | it under the terms of the GNU Lesser General Public License as published by
|
| 7 | d6728c5b | Thomas Schöpping | 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 | f0ca400f | Thomas Schöpping | GNU Lesser General Public License for more details.
|
| 14 | d6728c5b | Thomas Schöpping | |
| 15 | f0ca400f | Thomas Schöpping | You should have received a copy of the GNU Lesser General Public License
|
| 16 | d6728c5b | Thomas Schöpping | along with this program. If not, see <http://www.gnu.org/licenses/>.
|
| 17 | */
|
||
| 18 | |||
| 19 | 5e2f673b | Marc Rothmann | /**
|
| 20 | * @file alld_bq24103a.h
|
||
| 21 | * @brief Battery charger constants and driver structure.
|
||
| 22 | *
|
||
| 23 | * @addtogroup lld_charger
|
||
| 24 | * @{
|
||
| 25 | */
|
||
| 26 | |||
| 27 | 8c47f14b | Thomas Schöpping | #ifndef AMIROLLD_BQ24103A_H
|
| 28 | #define AMIROLLD_BQ24103A_H
|
||
| 29 | d6728c5b | Thomas Schöpping | |
| 30 | #include <amiro-lld.h> |
||
| 31 | |||
| 32 | #if defined(AMIROLLD_CFG_USE_BQ24103A) || defined(__DOXYGEN__)
|
||
| 33 | |||
| 34 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
| 35 | /* CONSTANTS */
|
||
| 36 | /******************************************************************************/
|
||
| 37 | |||
| 38 | d6728c5b | Thomas Schöpping | /**
|
| 39 | * @brief Active state of enabled gpio.
|
||
| 40 | */
|
||
| 41 | #define BQ24103A_LLD_ENABLED_GPIO_ACTIVE_STATE APAL_GPIO_ACTIVE_LOW
|
||
| 42 | |||
| 43 | /**
|
||
| 44 | * @brief Active state of charge status gpio.
|
||
| 45 | */
|
||
| 46 | #define BQ24103A_LLD_CHARGE_STATUS_GPIO_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
||
| 47 | |||
| 48 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
| 49 | /* SETTINGS */
|
||
| 50 | /******************************************************************************/
|
||
| 51 | |||
| 52 | /******************************************************************************/
|
||
| 53 | /* CHECKS */
|
||
| 54 | /******************************************************************************/
|
||
| 55 | |||
| 56 | /******************************************************************************/
|
||
| 57 | /* DATA STRUCTURES AND TYPES */
|
||
| 58 | /******************************************************************************/
|
||
| 59 | |||
| 60 | d6728c5b | Thomas Schöpping | /**
|
| 61 | * @brief The BQ24103A driver struct.
|
||
| 62 | */
|
||
| 63 | typedef struct { |
||
| 64 | 11500ad8 | Thomas Schöpping | const apalControlGpio_t* gpio_enabled; /**< @brief GPIO to enable/disable the bq24103a */ |
| 65 | const apalControlGpio_t* gpio_charge_status; /**< @brief GPIO showing the status of the bq24103a */ |
||
| 66 | d6728c5b | Thomas Schöpping | } BQ24103ADriver; |
| 67 | |||
| 68 | /**
|
||
| 69 | * @brief Enable enum.
|
||
| 70 | */
|
||
| 71 | typedef enum { |
||
| 72 | BQ24103A_LLD_ENABLED = 0x01, /**< @brief 'charging on' state */ |
||
| 73 | BQ24103A_LLD_DISABLED = 0x00, /**< @brief 'charging off' state */ |
||
| 74 | } bq24103a_lld_enable_t; |
||
| 75 | |||
| 76 | /**
|
||
| 77 | * @brief Charge state enum.
|
||
| 78 | */
|
||
| 79 | typedef enum { |
||
| 80 | BQ24103A_LLD_CHARGING = 0x01, /**< @brief status indicating that the battery is being charged */ |
||
| 81 | BQ24103A_LLD_NOT_CHARGING = 0x00, /**< @brife status indicating that the battery is not being charged */ |
||
| 82 | } bq24103a_lld_charge_state_t; |
||
| 83 | |||
| 84 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
| 85 | /* MACROS */
|
||
| 86 | /******************************************************************************/
|
||
| 87 | |||
| 88 | /******************************************************************************/
|
||
| 89 | /* EXTERN DECLARATIONS */
|
||
| 90 | /******************************************************************************/
|
||
| 91 | d6728c5b | Thomas Schöpping | |
| 92 | #ifdef __cplusplus
|
||
| 93 | extern "C" { |
||
| 94 | #endif
|
||
| 95 | apalExitStatus_t bq24103a_lld_get_enabled(const BQ24103ADriver* const bq24103a, bq24103a_lld_enable_t* const enable); |
||
| 96 | apalExitStatus_t bq24103a_lld_set_enabled(const BQ24103ADriver* const bq24103a, const bq24103a_lld_enable_t enable); |
||
| 97 | apalExitStatus_t bq24103a_lld_get_charge_status(const BQ24103ADriver* const bq24103a, bq24103a_lld_charge_state_t* const charge); |
||
| 98 | #ifdef __cplusplus
|
||
| 99 | } |
||
| 100 | #endif
|
||
| 101 | |||
| 102 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
| 103 | /* INLINE FUNCTIONS */
|
||
| 104 | /******************************************************************************/
|
||
| 105 | |||
| 106 | d6728c5b | Thomas Schöpping | #endif /* defined(AMIROLLD_CFG_USE_BQ24103A) */ |
| 107 | |||
| 108 | 8c47f14b | Thomas Schöpping | #endif /* AMIROLLD_BQ24103A_H */ |
| 109 | |||
| 110 | 5e2f673b | Marc Rothmann | /** @} */
|