1.5.3.2 PAL_RF_Status Function

C

PAL_RF_STATUS PAL_RF_Status(SYS_MODULE_OBJ object);

Summary

Returns status of the specific instance of the RF PAL module.

Description

This function returns the status of the specific RF PAL module instance.

Precondition

The PAL_RF_Initialize function should have been called before calling this function.

Parameters

ParamDescription
objectRF PAL object handle, returned from PAL_RF_Initialize.

Returns

  • PAL_RF_STATUS_READY: Indicates that the module is initialized and is ready to accept new requests from the client.

  • PAL_RF_STATUS_BUSY: Indicates that the module is busy with a previous initialization request from the client.

  • PAL_RF_STATUS_ERROR: Indicates that the module is in an error state. Any value lower than SYS_STATUS_ERROR is also an error state.

  • PAL_RF_STATUS_UNINITIALIZED: Indicates that the module is not initialized.

Example

// "object" returned from PAL_RF_Initialize

PAL_RF_STATUS palRfStatus;

palRfStatus = PAL_RF_Status (object);
if (palRfStatus == PAL_RF_STATUS_READY)
{
    // RF PAL is initialized and is ready to accept client requests.
}

Remarks

The upper layer must ensure that PAL_RF_Status returns PAL_RF_STATUS_READY before performing PAL RF operations.