amiro-lld / include / alld_at24c01bn-sh-b.h @ f125ae07
History | View | Annotate | Download (3.187 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_at24c01bn-sh-b.h
|
| 21 |
* @brief EEPROM macros and structures.
|
| 22 |
*
|
| 23 |
* @addtogroup lld_eeprom
|
| 24 |
* @{
|
| 25 |
*/
|
| 26 |
|
| 27 |
#ifndef _AMIROLLD_AT24C01BN_H_
|
| 28 |
#define _AMIROLLD_AT24C01BN_H_
|
| 29 |
|
| 30 |
#include <amiro-lld.h> |
| 31 |
|
| 32 |
#if defined(AMIROLLD_CFG_USE_AT24C01BN) || defined(__DOXYGEN__)
|
| 33 |
|
| 34 |
/**
|
| 35 |
* @brief Memory size of the EEPROM in bits.
|
| 36 |
*/
|
| 37 |
#define AT24C01BN_LLD_SIZE_BITS 1024 |
| 38 |
|
| 39 |
/**
|
| 40 |
* @brief Memory size of the EEPROM in bytes
|
| 41 |
*/
|
| 42 |
#define AT24C01BN_LLD_SIZE_BYTES 128 |
| 43 |
|
| 44 |
|
| 45 |
/**
|
| 46 |
* @brief Size of a page in bytes
|
| 47 |
*/
|
| 48 |
#define AT24C01BN_LLD_PAGE_SIZE_BYTES 8 |
| 49 |
|
| 50 |
/**
|
| 51 |
* @brief Time in microseconds a write operation takes to complete (I2C will not respond).
|
| 52 |
* @note The system should wait slightly longer.
|
| 53 |
*/
|
| 54 |
#define AT24C01BN_LLD_WRITECYCLETIME_US 5000 |
| 55 |
|
| 56 |
/**
|
| 57 |
* @brief Maximum I2C frequency.
|
| 58 |
*/
|
| 59 |
#define AT24C01BN_LLD_I2C_MAXFREQUENCY 400000 |
| 60 |
|
| 61 |
/**
|
| 62 |
* @brief Maximum I2C frequency at 5V.
|
| 63 |
*/
|
| 64 |
#define AT24C01BN_LLD_I2C_MAXFREQUENCY_5V 1000000 |
| 65 |
|
| 66 |
/**
|
| 67 |
* @brief The AT24C01BN driver struct
|
| 68 |
*/
|
| 69 |
typedef struct { |
| 70 |
apalI2CDriver_t* i2cd; /**< @brief The I2C Driver */
|
| 71 |
apalI2Caddr_t addr; /**< @brief The address of the AT24C01B for I2C communication, which is defined by the wiring of the A0, A1, A2 pins */
|
| 72 |
} AT24C01BNDriver; |
| 73 |
|
| 74 |
/**
|
| 75 |
* @brief Bitmasks for the I2C address, including the wiring of the A0, A1, A2 pins.
|
| 76 |
*/
|
| 77 |
enum {
|
| 78 |
AT24C01BN_LLD_I2C_ADDR_FIXED = 0x0050u,
|
| 79 |
AT24C01BN_LLD_I2C_ADDR_A0 = 0x0001u,
|
| 80 |
AT24C01BN_LLD_I2C_ADDR_A1 = 0x0002u,
|
| 81 |
AT24C01BN_LLD_I2C_ADDR_A2 = 0x0004u,
|
| 82 |
}; |
| 83 |
|
| 84 |
#ifdef __cplusplus
|
| 85 |
extern "C" { |
| 86 |
#endif
|
| 87 |
apalExitStatus_t at24c01bn_lld_poll_ack(const AT24C01BNDriver* const at24c01bn, const apalTime_t timeout); |
| 88 |
apalExitStatus_t at24c01bn_lld_read_current_address(const AT24C01BNDriver* const at24c01bn, uint8_t* const data, const uint8_t num, const apalTime_t timeout); |
| 89 |
apalExitStatus_t at24c01bn_lld_read(const AT24C01BNDriver* const at24c01bn, const uint8_t addr, uint8_t* const data, const uint8_t num, const apalTime_t timeout); |
| 90 |
apalExitStatus_t at24c01bn_lld_write_byte(const AT24C01BNDriver* const at24c01bn, const uint8_t addr, const uint8_t data, const apalTime_t timeout); |
| 91 |
apalExitStatus_t at24c01bn_lld_write_page(const AT24C01BNDriver* const at24c01bn, const uint8_t addr, const uint8_t* const data, const uint8_t num, const apalTime_t timeout); |
| 92 |
#ifdef __cplusplus
|
| 93 |
} |
| 94 |
#endif
|
| 95 |
|
| 96 |
#endif /* defined(AMIROLLD_CFG_USE_AT24C01BN) */ |
| 97 |
|
| 98 |
#endif /* _AMIROLLD_AT24C01BN_H_ */ |
| 99 |
|
| 100 |
/** @} */
|