1.1.2.4.11 DRV_G3_MACRT_RxParamsIndCallbackRegister Function

C

void DRV_G3_MACRT_RxParamsIndCallbackRegister (
    const DRV_HANDLE handle,
    const DRV_G3_MACRT_RX_PARAMS_IND_CALLBACK callback
);

Summary

Allows a client to set a G3 MAC RT reception parameters event handling function for the driver to call back when a packet reception has finished.

Description

This function allows a client to register a G3 MAC RT Rx parameters indication event handling function for the driver to call back when a new data message is received.

This callback has to be set to get the reception parameters related to a received frame, otherwise such information will be unknown. The callback once set, persists until the client closes the driver or sets another callback (which could be a NULL pointer to indicate no callback).

Precondition

DRV_G3_MACRT_Open must have been called to obtain a valid opened device handle.

Parameters

ParamDescription
handleA valid instance handle, returned from the driver's open routine
callbackPointer to the callback function

Returns

None.

Example

void APP_PLC_Params_Ind_callback(MAC_RT_RX_PARAMETERS_OBJ *pParameters)
{
    // Rx Parameters handling here.
}

// myAppObj is an application specific state data object.
MY_APP_OBJ myAppObj;

// Client registers a RxParams indication callback with driver. This is done once
// 'myHandle', returned from DRV_G3_MACRT_Open previously called
DRV_G3_MACRT_RxParamsIndCallbackRegister( myAppObj.myHandle, APP_PLC_Params_Ind_callback );

Remarks

None.