Embedded Application Programming Interface - picmg

#define EAPI_STATUS_WRITE_ERROR
EAPI_UINT32_C(0xFFFFFAFE)
/* Description
* The amount of available data exceeds the buffer size.
* Storage buffer overflow was prevented. Read count was larger then
* the defined buffer length.
* Read Count > Buffer Length
* Actions
* Either increase the buffer size or reduce the block length.
*/
#define EAPI_STATUS_MORE_DATA
EAPI_UINT32_C(0xFFFFF9FF)
/* Description
* Generic error message. No further error details are available.
* Actions
* none.
*/
#define EAPI_STATUS_ERROR
EAPI_UINT32_C(0xFFFFF0FF)
/* Description
* The operation was successful.
* Actions
* none.
*/
#define EAPI_STATUS_SUCCESS
#define EAPI_TEST_SUCCESS(x)
EAPI_UINT32_C(0)
(!(x))
/* Library */
/*
* EApiLibInitialize
*
* Condition | Return Values
* ---------------------------------------+------------------------------
* Library Already initialized | EAPI_STATUS_INITIALIZED
* Common Error | Common Error Code
* Else | EAPI_STATUS_SUCCESS
*/
EApiStatus_t
EAPI_CALLTYPE
EApiLibInitialize(void)
; /* Should be called before
* calling any other API
* function is called
*/
/*
* EApiLibUnInitialize
*
* Condition | Return Values
* ---------------------------------------+------------------------------
* Library Uninitialized | EAPI_STATUS_NOT_INITIALIZED
* Common Error | Common Error Code
* Else | EAPI_STATUS_SUCCESS
*/
EApiStatus_t
EAPI_CALLTYPE
EApiLibUnInitialize(void) ; /* Should be called before
* program exit
*/
/*
*
* Plug and Play Identifiers
*
*
*
*/
/*
* The following MACROS are for Creating OEM IDs
* OEM ID macros should be named
* EAPI_[PNPID]_ID_[TYPE]_[NAME]
* E.G.
* EAPI_PMG_ID_BOARD_CUSTOMERID
*/
#define EAPI_BYTE_SWAP_W(a) EAPI_UINT16_C(\
(((a)8)&0x00FF) \
PICMG® EAPI R1.0, August 8, 2010 page 58 of 83