Statistics
| Branch: | Tag: | Revision:

amiro-lld / drivers / P9221R / v1 / alld_P9221R.h @ d55455fa

History | View | Annotate | Download (4.56 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_P9221R.h
21
 * @brief   qi charger macros and structures.
22
 *
23
 * @{
24
 */
25

    
26
#ifndef AMIROLLD_P9221R_H
27
#define AMIROLLD_P9221R_H
28

    
29
#include <amiro-lld.h>
30

    
31
/******************************************************************************/
32
/* CONSTANTS                                                                  */
33
/******************************************************************************/
34

    
35
/**
36
 * @brief Maximum I2C frequency.
37
 */
38
#define P9221R_LLD_I2C_MAXFREQUENCY   400000
39

    
40
/******************************************************************************/
41
/* SETTINGS                                                                   */
42
/******************************************************************************/
43

    
44
/******************************************************************************/
45
/* CHECKS                                                                     */
46
/******************************************************************************/
47

    
48
/******************************************************************************/
49
/* DATA STRUCTURES AND TYPES                                                  */
50
/******************************************************************************/
51

    
52
/**
53
 * @brief I2C address masks.
54
 */
55
enum {
56
  P9221R_LLD_I2C_ADDR_FIXED   = 0x0061u,
57
};
58

    
59
/**
60
 * @brief Registers.
61
 */
62
typedef enum {
63
  P9221R_LLD_REGISTER_PARTNUMBER                = 0x0000,
64
  P9221R_LLD_REGISTER_INTERRUPTENABLE           = 0x0038,
65
  // Writeable Registers
66
  P9221R_LLD_REGISTER_BATTERY_STATUS_SENT       = 0x003A,
67
  P9221R_LLD_REGISTER_END_POWER_TRANSFER        = 0x003B,
68
  // Read-Only Registers
69
  P9221R_LLD_REGISTER_OUTPUT_VOLTAGE_LSB        = 0x003C,
70
  P9221R_LLD_REGISTER_OUTPUT_VOLTAGE_MSB        = 0x003D,
71
  P9221R_LLD_REGISTER_IOUT_CURRENT_LSB          = 0x0044,
72
  P9221R_LLD_REGISTER_IOUT_CURRENT_MSB          = 0x0045,
73
  P9221R_LLD_REGISTER_OPERATING_FREQUENCY_MSB   = 0x0048,
74
  P9221R_LLD_REGISTER_OPERATING_FREQUENCY_LSB   = 0x0049,
75
  P9221R_LLD_REGISTER_ALIGNMENT_X               = 0x004B,
76
  P9221R_LLD_REGISTER_ALIGNMENT_Y               = 0x004C,
77
} p9221r_lld_register_t;
78

    
79

    
80
typedef struct {
81
  apalI2CDriver_t* i2cd;
82
  apalI2Caddr_t addr;
83
  uint16_t current_lsb_uA;
84
  //P9221R_lld_cfg_t *config;
85
} P9221RDriver;
86

    
87

    
88
/******************************************************************************/
89
/* MACROS                                                                     */
90
/******************************************************************************/
91

    
92
/******************************************************************************/
93
/* EXTERN DECLARATIONS                                                        */
94
/******************************************************************************/
95

    
96
#ifdef __cplusplus
97
extern "C" {
98
#endif
99
  apalExitStatus_t p9221r_lld_read_register(const P9221RDriver* const p9221r, const p9221r_lld_register_t addr, uint8_t* const data, const uint8_t num, const apalTime_t timeout);
100
  apalExitStatus_t p9221r_lld_write_register(const P9221RDriver* const p9221r, const p9221r_lld_register_t addr, const uint16_t* const data, const uint8_t num, const apalTime_t timeout);
101
  apalExitStatus_t p9221r_lld_read_alignment(const P9221RDriver* const p9221r, int8_t* const alignment, const apalTime_t timeout);
102
  apalExitStatus_t p9221r_lld_read_voltage(const P9221RDriver* const p9221r, float* const voltage, const apalTime_t timeout);
103
  apalExitStatus_t p9221r_lld_read_current(const P9221RDriver* const p9221r, float* const current, const apalTime_t timeout);
104

    
105
#ifdef __cplusplus
106
}
107
#endif
108

    
109
/******************************************************************************/
110
/* INLINE FUNCTIONS                                                           */
111
/******************************************************************************/
112

    
113
#endif /* AMIROLLD_P9221R_H */
114

    
115
/** @} */
116