1.1.1.4.21 DRV_PLC_PHY_SLEEP_IND_CALLBACK Typedef

C

typedef void ( *DRV_PLC_PHY_SLEEP_CALLBACK )( uintptr_t context );

Summary

Notifies when SLeep Mode is disabled and PLC driver is able to be used again.

Description

This data type defines the required function signature for the PLC driver sleep mode disable event handling callback function. A client must register a pointer using the callback register function whose function signature (parameter and return value types) match the types specified by this function pointer in order to receive transfer related event calls back from the driver.

Parameters

| context | Value identifying the context of the application that registered the event handling function |

Returns

None.

Example

void APP_MySleepDisableEventHandler( uintptr_t context )
{
    MY_APP_DATA_STRUCT* appData = (MY_APP_DATA_STRUCT*) context;

    // Do initial configuration of the application if needed
    
    appData.plc_sleep = false;
}

Remarks

The context parameter contains the a handle to the client context, provided at the time the event handling function was registered using the DRV_PLC_PHY_SleepDisableCallbackRegister function. This context handle value is passed back to the client as the context parameter. It can be any value necessary to identify the client context or instance (such as a pointer to the client's data) of the client that made the transfer add request.