amiro-lld / include / P9221R / v1 / alld_P9221R_v1.h @ 6ef38c23
History | View | Annotate | Download (3.954 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 |
/******************************************************************************/
|
| 33 |
/* CONSTANTS */
|
| 34 |
/******************************************************************************/
|
| 35 |
|
| 36 |
/******************************************************************************/
|
| 37 |
/* SETTINGS */
|
| 38 |
/******************************************************************************/
|
| 39 |
|
| 40 |
/******************************************************************************/
|
| 41 |
/* CHECKS */
|
| 42 |
/******************************************************************************/
|
| 43 |
|
| 44 |
/******************************************************************************/
|
| 45 |
/* DATA STRUCTURES AND TYPES */
|
| 46 |
/******************************************************************************/
|
| 47 |
/**
|
| 48 |
* @brief Registers.
|
| 49 |
*/
|
| 50 |
typedef enum { |
| 51 |
// Writeable Registers
|
| 52 |
P9221R_LLD_REGISTER_BATTERY_STATUS_SENT = 0x3A,
|
| 53 |
P9221R_LLD_REGISTER_END_POWER_TRANSFER = 0x3B,
|
| 54 |
// Read-Only Registers
|
| 55 |
P9221R_LLD_REGISTER_OUTPUT_VOLTAGE_LSB = 0x3C,
|
| 56 |
P9221R_LLD_REGISTER_OUTPUT_VOLTAGE_MSB = 0x3D,
|
| 57 |
P9221R_LLD_REGISTER_IOUT_CURRENT_LSB = 0x44,
|
| 58 |
P9221R_LLD_REGISTER_IOUT_CURRENT_MSB = 0x45,
|
| 59 |
P9221R_LLD_REGISTER_OPERATING_FREQUENCY_MSB = 0x48,
|
| 60 |
P9221R_LLD_REGISTER_OPERATING_FREQUENCY_LSB = 0x49,
|
| 61 |
P9221R_LLD_REGISTER_ALIGNMENT_X = 0x4B,
|
| 62 |
P9221R_LLD_REGISTER_ALIGNMENT_Y = 0x4C,
|
| 63 |
} p9221r_lld_register_t; |
| 64 |
|
| 65 |
/**
|
| 66 |
* @brief I2C address masks.
|
| 67 |
*/
|
| 68 |
enum {
|
| 69 |
P9221R_LLD_I2C_ADDR_FIXED = 0x0061u,
|
| 70 |
}; |
| 71 |
|
| 72 |
typedef struct { |
| 73 |
apalI2CDriver_t* i2cd; |
| 74 |
apalI2Caddr_t addr; |
| 75 |
uint16_t current_lsb_uA; |
| 76 |
P9221R_lld_cfg_t *config; |
| 77 |
} P9221RDriver; |
| 78 |
|
| 79 |
|
| 80 |
/******************************************************************************/
|
| 81 |
/* MACROS */
|
| 82 |
/******************************************************************************/
|
| 83 |
|
| 84 |
/******************************************************************************/
|
| 85 |
/* EXTERN DECLARATIONS */
|
| 86 |
/******************************************************************************/
|
| 87 |
|
| 88 |
#ifdef __cplusplus
|
| 89 |
extern "C" { |
| 90 |
#endif
|
| 91 |
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); |
| 92 |
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); |
| 93 |
#ifdef __cplusplus
|
| 94 |
} |
| 95 |
#endif
|
| 96 |
|
| 97 |
/******************************************************************************/
|
| 98 |
/* INLINE FUNCTIONS */
|
| 99 |
/******************************************************************************/
|
| 100 |
|