Statistics
| Branch: | Tag: | Revision:

amiro-lld / drivers / bq241xx / v1 / alld_bq241xx.h @ 9466e34d

History | View | Annotate | Download (4.15 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_bq241xx.h
21
 * @brief   Battery charger constants and driver structure.
22
 *
23
 * @addtogroup lld_charger
24
 * @{
25
 */
26

    
27
#ifndef AMIROLLD_BQ241XX_H
28
#define AMIROLLD_BQ241XX_H
29

    
30
#include <amiro-lld.h>
31

    
32
/******************************************************************************/
33
/* CONSTANTS                                                                  */
34
/******************************************************************************/
35

    
36
/**
37
 * @brief Active state of enabled gpio.
38
 */
39
#define BQ241xx_LLD_ENABLED_GPIO_ACTIVE_STATE         APAL_GPIO_ACTIVE_LOW
40

    
41
/**
42
 * @brief Active state of charge status gpio.
43
 */
44
#define BQ241xx_LLD_CHARGE_STATUS_GPIO_ACTIVE_STATE   APAL_GPIO_ACTIVE_HIGH
45

    
46
/******************************************************************************/
47
/* SETTINGS                                                                   */
48
/******************************************************************************/
49

    
50
/******************************************************************************/
51
/* CHECKS                                                                     */
52
/******************************************************************************/
53

    
54
/******************************************************************************/
55
/* DATA STRUCTURES AND TYPES                                                  */
56
/******************************************************************************/
57

    
58
/**
59
 * @brief The BQ241xx driver struct.
60
 */
61
typedef struct {
62
  const apalControlGpio_t* gpio_enabled;        /**< @brief GPIO to enable/disable the bq24103a */
63
  const apalControlGpio_t* gpio_charge_status;  /**< @brief GPIO showing the status of the bq24103a */
64
} BQ241xxDriver;
65

    
66
/**
67
 * @brief Enable enum.
68
 */
69
typedef enum {
70
  BQ241xx_LLD_ENABLED   = 0x01,         /**< @brief 'charging on' state */
71
  BQ241xx_LLD_DISABLED  = 0x00,         /**< @brief 'charging off' state */
72
} bq241xx_lld_enable_t;
73

    
74
/**
75
 * @brief Charge state enum.
76
 */
77
typedef enum {
78
  BQ241xx_LLD_CHARGING      = 0x01,     /**< @brief status indicating that the battery is being charged */
79
  BQ241xx_LLD_NOT_CHARGING  = 0x00,     /**< @brife status indicating that the battery is not being charged */
80
} bq241xx_lld_charge_state_t;
81

    
82
/******************************************************************************/
83
/* MACROS                                                                     */
84
/******************************************************************************/
85

    
86
/******************************************************************************/
87
/* EXTERN DECLARATIONS                                                        */
88
/******************************************************************************/
89

    
90
#ifdef __cplusplus
91
extern "C" {
92
#endif
93
  apalExitStatus_t bq241xx_lld_get_enabled(const BQ241xxDriver* const bq241xx, bq241xx_lld_enable_t* const enable);
94
  apalExitStatus_t bq241xx_lld_set_enabled(const BQ241xxDriver* const bq241xx, const bq241xx_lld_enable_t enable);
95
  apalExitStatus_t bq241xx_lld_get_charge_status(const BQ241xxDriver* const bq241xx, bq241xx_lld_charge_state_t* const charge);
96
#ifdef __cplusplus
97
}
98
#endif
99

    
100
/******************************************************************************/
101
/* INLINE FUNCTIONS                                                           */
102
/******************************************************************************/
103

    
104
#endif /* AMIROLLD_BQ241XX_H */
105

    
106
/** @} */
107