Defines, Structures, Typedefs, Functions. More...
Files | |
| file | clCmApi.h |
| Header file of Chassis Manager Related APIs. | |
Macros | |
| #define | CL_CM_VERSION {(ClUint8T)'B', 0x1, 0x1} |
| Latest supported version of the Chassis Manager client service. | |
| #define | CL_ERR_CM_HPI_ERROR (CL_ERR_COMMON_MAX+1) |
| Generic HPI error. | |
| #define | CL_ERR_CM_HPI_INVALID_PHY_SLOT (CL_ERR_COMMON_MAX+2) |
| No such physical slot in the chassis or not FRU in physical slot. | |
| #define | clCmBladeOperationRequest(chassisId, physSlot, request) CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED) |
| Operates on the Blade or any platform hardware. More... | |
| #define | clCmFruOperationRequest(hMoId, request) CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED) |
| Operates on the FRU or any platform hardware. More... | |
| #define | clCmFruStateGet(hMoId, pState) CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED) |
| Returns the state of an FRU. More... | |
| #define | clCmVersionVerify(version) CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED) |
| This api can be used to verify the version supported by the CM. More... | |
Enumerations | |
| enum | ClCmFruOperationT { CL_CM_POWERON_REQUEST = 1 , CL_CM_POWEROFF_REQUEST , CL_CM_POWER_CYCLE_REQUEST , CL_CM_INSERT_REQUEST , CL_CM_EXTRACT_REQUEST , CL_CM_RESET_REQUEST , CL_CM_WARM_RESET_REQUEST , CL_CM_RESET_ASSERT_REQUEST , CL_CM_RESET_DEASSERT_REQUEST } |
| Possible FRU operations for the clCmFruOperationRequest() function. More... | |
Defines, Structures, Typedefs, Functions.
| #define clCmBladeOperationRequest | ( | chassisId, | |
| physSlot, | |||
| request | |||
| ) | CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED) |
Operates on the Blade or any platform hardware.
| chassisId | ChassisId of the blade |
| physSlot | Physical slot of the blade (per HPI terminology) |
| request | Operation requested on the hardware |
| CL_OK | The API executed successfully |
| CL_ERR_INVALID_PARAMETER | Request valus is invalid |
| CL_ERR_VERSION_MISMATCH | If client and server are version incompatible |
| CL_ERR_CM_HPI_ERROR | For any server side HPI errors |
| CL_ERR_TRY_AGAIN | If Chassis manager is busy and cannot service the request immediately |
DBG_PRINTS on the Chassis Manager console or Log file.| #define clCmFruOperationRequest | ( | hMoId, | |
| request | |||
| ) | CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED) |
Operates on the FRU or any platform hardware.
| hMoId | MoId of the FRU. |
| request | Operation requested on the hardware. |
| CL_OK | The API executed successfully |
| CL_ERR_INVALID_PARAMETER | The hMoId value is not a valid MO Id or the request value is invalid |
| CL_ERR_VERSION_MISMATCH | If client and server are version incompatible |
| CL_ERR_CM_HPI_ERROR | For any server side HPI errors |
| CL_ERR_TRY_AGAIN | If Chassis manager is busy and cannot service the request immediately |
DBG_PRINTS on the Chassis Manager console or Log file.extern ClRcT clCmFruOperationRequest (CL_IN ClCorMOIdPtrT hMoId, CL_OUT ClCmFruOperationT request);
| #define clCmFruStateGet | ( | hMoId, | |
| pState | |||
| ) | CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED) |
Returns the state of an FRU.
| hMoId | MoId of the FRU. |
| pState | (out) Pointer to store the state of the FRU. |
| CL_OK | The API executed successfully |
| CL_ERR_INVALID_PARAMETER | The hMoId value is not a valid MO Id |
| CL_ERR_NULL_POINTER | On passing a NULL pointer |
| CL_ERR_VERSION_MISMATCH | If client and server are version incompatible |
| CL_ERR_CM_HPI_ERROR | For any server side HPI errors |
| CL_ERR_TRY_AGAIN | If Chassis Manager is busy and cannot service the request immediately |
DBG_PRINTS on the Chassis Manager console or Log file.extern ClRcT clCmFruStateGet (CL_IN ClCorMOIdPtrT hMoId,CL_OUT SaHpiHsStateT *pState);
| #define clCmVersionVerify | ( | version | ) | CL_RC(CL_CID_CM,CL_ERR_NOT_SUPPORTED) |
This api can be used to verify the version supported by the CM.
| version | (IN/OUT) Version requested (IN) and the closest version supported by the service (OUT) |
| CL_OK | The API executed successfully. |
| CL_ERR_VERSION_MISMATCH | If exact request version is not supported. |
extern ClRcT clCmVersionVerify(CL_INOUT ClVersionT *version);
| enum ClCmFruOperationT |
Possible FRU operations for the clCmFruOperationRequest() function.