Embedded Application Programming Interface - picmg

4 EAPI Information Functions
4.1 EApiBoardGetStringA
4.1.1 Description:
Text information about the hardware platform.
4.1.2 Parameters
Id
uint32_t
EAPI_CALLTYPE
EApiBoardGetStringA(
__IN uint32_t Id , /* Name Id */
__OUT char *pBuffer , /* Destination pBuffer */
__INOUT uint32_t *pBufLen /* pBuffer Length */
);
FUNC_DEF 3: EApiBoardGetStringA
__IN Selects the Get String Sub function Id.
Id Description Example
EAPI_ID_BOARD_MANUFACTURER_STR Board Manufacturer Name PICMG
EAPI_ID_BOARD_NAME_STR Board Name SAMPLE API
EAPI_ID_BOARD_SERIAL_STR Serial Number Sample Serial
Number
EAPI_ID_BOARD_BIOS_REVISION_STR Board BIOS Revision PICMGR2.0
EAPI_ID_BOARD_PLATFORM_TYPE_STR
Platform ID See 'Platform
Specification' on page 22
COMExpress
pBuffer
__OUT Pointer to a buffer that receives the value's data. This parameter can be NULL if the data is
not required
pBufLen
____INOUT Pointer to a variable that specifies the size, in bytes, of the buffer pointed to by the
pBuffer parameter. When the function returns, this variable contains the size of the data copied to
pBuffer including the terminating null character.
If the buffer specified by pBuffer parameter is not large enough to hold the data, the function returns
the value EAPI_STATUS_MORE_DATA and stores the required buffer size, in bytes, into the variable
pointed to by pBufLen.
If pBuffer is NULL, and pBufLen is non-NULL, the function returns EAPI_STATUS_MORE_DATA,
and stores the size of the data, in bytes, in the variable pointed to by pBufLen. This lets an
application determine the best way to allocate a buffer for the value's data.
Find more details refer to the platform specific header files. The Platform ID is defined by the
specification and is “COMExpress” for COM Express.
PICMG® EAPI R1.0, August 8, 2010 page 21 of 83