User manual

NXP Semiconductors
UM10663
NXP Reader Library User Manual
UM10663
All information provided in this document is subject to legal disclaimers.
© NXP B.V. 2013. All rights reserved.
User Manual
COMPANY PUBLIC
Rev. 1.2 — 24 July 2013
257412
16 of 47
phStatus_t phhalHw_Rc663_Cmd_ReadE2(
phhalHw_Rc663_DataParams_t * pDataParams, [In]
uint16_t wAddress, [In]
uint16_t wNumBytes, [In]
uint8_t * pData ); [Out]
*pDataParams: pointer to the HAL layer data parameter structure.
wAddress: 2 byte address; Range is 0x0000 - 0x1FFF.
wNumBytes: number of data bytes to read. If
wAddress+wNumBytes > EEPROM_SIZE , then
function aborts before any read operation, although some addresses might be valid.
*pData: pointer to requested data. This value must not be NULL, else no data will be
returned.
returnValues:
PH_ERR_INVALID_PARAMETER - wNumBytes greater than 256 or greater than actual size of
FIFO invalid address
- bDataLen out of range 0 – 128
PH_ERR_READ_WRITE_ERROR - error occurred during writing data into EEPROM
PH_ERR_SUCCESS - operation successful.
Other: depending on implementation and underlaying component.
2.1.12 LoadReg command - phhalHw_Rc663_Cmd_LoadReg()
Reads a defined number of bytes from the EEPROM and copies the value into the
register set, beginning at the given register address. Function includes a software
protection from attempt to access invalid address. Verification is done before even the
first read command execution. All the register and EEPROM addresses intended to be
read/written must be in valid range, otherwise no load register operation is performed,
although some of EEPROM or register addresses might be valid.
phStatus_t phhalHw_Rc663_Cmd_LoadReg(
phhalHw_Rc663_DataParams_t * pDataParams, [In]
uint16_t wEEAddress, [In]
uint8_t bRegAddress, [In]
uint8_t bNumBytes ); [In]
*pDataParams: pointer to the HAL layer data parameter structure.
wEEAddress: 2 byte address within the section 2 of EEPROM: from 192 to 6143.
bRegAddress: register address in range of 0 – 128.
bNumBytes: number of bytes to copy.
returnValues:
PH_ERR_INVALID_PARAMETER – attempt to access EEPROM address out of section 2 or
register address out of 0 – 128.
PH_ERR_READ_WRITE_ERROR – error occurred during writing data into EEPROM
PH_ERR_SUCCESS - operation successful.
Other: depending on implementation and underlaying component.