Embedded Application Programming Interface - picmg

*
* EApiStorageCap
*
* Condition | Return Values
* ---------------------------------------------+------------------------------
* Library Uninitialized | EAPI_STATUS_NOT_INITIALIZED
* ((pStorageSize==NULL)&&(pBlockLength==NULL)) | EAPI_STATUS_INVALID_PARAMETER
* Unsupported Id | EAPI_STATUS_UNSUPPORTED
* Common Error | Common Error Code
* Else | EAPI_STATUS_SUCCESS
*/
EApiStatus_t
EAPI_CALLTYPE
EApiStorageCap(
__IN EApiId_t Id , /* Storage Area Id */
__OUT uint32_t *pStorageSize , /* Total */
__OUT uint32_t *pBlockLength /* Write Block Length
* & Alignment
*/
);
/*
* EApiStorageAreaRead
*
* Condition | Return Values
* ---------------------------------------+------------------------------
* Library Uninitialized | EAPI_STATUS_NOT_INITIALIZED
* pBuffer==NULL | EAPI_STATUS_INVALID_PARAMETER
* ByteCnt==0 | EAPI_STATUS_INVALID_PARAMETER
* BufLen==0 | EAPI_STATUS_INVALID_PARAMETER
* unknown Id | EAPI_STATUS_UNSUPPORTED
* Offset+ByteCnt>pStorageSize | EAPI_STATUS_INVALID_BLOCK_LENGTH
* Read Error | EAPI_STATUS_READ_ERROR
* ByteCnt>BufLen | EAPI_STATUS_MORE_DATA
* Common Error | Common Error Code
* Else | EAPI_STATUS_SUCCESS
*/
EApiStatus_t
EAPI_CALLTYPE
EApiStorageAreaRead(
__IN EApiId_t Id , /* Storage Area Id */
__IN uint32_t Offset , /* Byte Offset */
__OUT void *pBuffer , /* Pointer to Data pBuffer */
__IN uint32_t BufLen , /* Data pBuffer Size in
* bytes
*/
__IN uint32_t ByteCnt /* Number of bytes to read */
);
/*
* EApiStorageAreaWrite
*
* Condition | Return Values
* ---------------------------------------+------------------------------
* Library Uninitialized | EAPI_STATUS_NOT_INITIALIZED
* pBuffer==NULL | EAPI_STATUS_INVALID_PARAMETER
* ByteCnt==0 | EAPI_STATUS_INVALID_PARAMETER
* unknown Id | EAPI_STATUS_UNSUPPORTED
* Offset%pBlockLength | EAPI_STATUS_INVALID_BLOCK_ALIGNMENT
* ByteCnt%pBlockLength | EAPI_STATUS_INVALID_BLOCK_ALIGNMENT
* Offset+ByteCnt>pStorageSize | EAPI_STATUS_INVALID_BLOCK_LENGTH
* Write Error | EAPI_STATUS_WRITE_ERROR
* Common Error | Common Error Code
* Else | EAPI_STATUS_SUCCESS
*/
EApiStatus_t
EAPI_CALLTYPE
EApiStorageAreaWrite(
__IN EApiId_t Id , /* Storage Area Id */
__IN uint32_t Offset , /* Byte Offset */
__IN void *pBuffer , /* Pointer to Data pBuffer */
__IN uint32_t ByteCnt /* Number of bytes to write */
);
/*
*
* I 2 C
*
PICMG® EAPI R1.0, August 8, 2010 page 62 of 83