Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / P9221R / v1 / alld_P9221R_v1.h @ 2344a771

History | View | Annotate | Download (4.149 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_v1.h
21
 * @brief   Power Monitor macros and structures.
22
 *
23
 * @addtogroup lld_power
24
 * @{
25
 */
26

    
27
#ifndef AMIROLLD_P9221R_V1_H
28
#define AMIROLLD_P9221R_V1_H
29

    
30
#include <amiro-lld.h>
31

    
32
#if (defined(AMIROLLD_CFG_P9221R) && (AMIROLLD_CFG_P9221R == 1)) || defined(__DOXYGEN__)
33

    
34
/******************************************************************************/
35
/* CONSTANTS                                                                  */
36
/******************************************************************************/
37

    
38
/******************************************************************************/
39
/* SETTINGS                                                                   */
40
/******************************************************************************/
41

    
42
/******************************************************************************/
43
/* CHECKS                                                                     */
44
/******************************************************************************/
45

    
46
/******************************************************************************/
47
/* DATA STRUCTURES AND TYPES                                                  */
48
/******************************************************************************/
49

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

    
57
/**
58
 * @brief Registers.
59
 */
60
typedef enum {
61
  // Writeable Registers
62
  P9221R_LLD_REGISTER_BATTERY_STATUS_SENT       = 0x3A,
63
  P9221R_LLD_REGISTER_END_POWER_TRANSFER        = 0x3B,
64
  // Read-Only Registers
65
  P9221R_LLD_REGISTER_OUTPUT_VOLTAGE_LSB        = 0x3C,
66
  P9221R_LLD_REGISTER_OUTPUT_VOLTAGE_MSB        = 0x3D,
67
  P9221R_LLD_REGISTER_IOUT_CURRENT_LSB          = 0x44,
68
  P9221R_LLD_REGISTER_IOUT_CURRENT_MSB          = 0x45,
69
  P9221R_LLD_REGISTER_OPERATING_FREQUENCY_MSB   = 0x48,
70
  P9221R_LLD_REGISTER_OPERATING_FREQUENCY_LSB   = 0x49,
71
  P9221R_LLD_REGISTER_ALIGNMENT_X               = 0x4B,
72
  P9221R_LLD_REGISTER_ALIGNMENT_Y               = 0x4C,
73
} p9221r_lld_register_t;
74

    
75

    
76
typedef struct {
77
  apalI2CDriver_t* i2cd;
78
  apalI2Caddr_t addr;
79
  uint16_t current_lsb_uA;
80
  //P9221R_lld_cfg_t *config;
81
}P9221RDriver;
82

    
83

    
84
/******************************************************************************/
85
/* MACROS                                                                     */
86
/******************************************************************************/
87

    
88
/******************************************************************************/
89
/* EXTERN DECLARATIONS                                                        */
90
/******************************************************************************/
91

    
92
#ifdef __cplusplus
93
extern "C" {
94
#endif
95
  apalExitStatus_t p9221r_lld_read_register(const P9221RDriver* const p9221r, const p9221r_lld_register_t addr, uint16_t* const data, const uint8_t num, const apalTime_t timeout);
96
  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);
97
#ifdef __cplusplus
98
}
99
#endif
100

    
101
/******************************************************************************/
102
/* INLINE FUNCTIONS                                                           */
103
/******************************************************************************/
104

    
105
#endif /* defined(AMIROLLD_CFG_P9221R) && (AMIROLLD_CFG_P9221R == 1) */
106

    
107
#endif /* AMIROLLD_P9221R_V1_H */