notify.h File Reference

#include <dsplink.h>

Include dependency graph for gpp/inc/notify.h:

Go to the source code of this file.

FnNotifyCbck
Signature of the callback function to be registered with the NOTIFY component. ============================================================================ Parameters: eventNo Event number associated with the callback being invoked. arg Fixed argument registered with the IPS component along with the callback function. info Run-time information provided to the upper layer by the NOTIFY component. This information is specific to the IPS being implemented. Returns: None. Precondition: None. Postcondition: None. See also: IPS_register () ============================================================================
typedef void(*	FnNotifyCbck )(IN Uint32 eventNo, IN Pvoid arg, IN Pvoid info)
DLLEXPORT DSP_STATUS	NOTIFY_register (IN ProcessorId dspId, IN Uint32 ipsId, IN Uint32 eventNo, IN FnNotifyCbck fnNotifyCbck, IN Pvoid cbckArg)
	This function registers a callback for a specific event with the NOTIFY component.
DLLEXPORT DSP_STATUS	NOTIFY_unregister (IN ProcessorId dspId, IN Uint32 ipsId, IN Uint32 eventNo, IN FnNotifyCbck fnNotifyCbck, IN Pvoid cbckArg)
	This function unregisters a callback for a specific event with the NOTIFY component.
DLLEXPORT DSP_STATUS	NOTIFY_notify (IN ProcessorId dspId, IN Uint32 ipsId, IN Uint32 eventno, IN Uint32 payload)
	This function sends a notification of an event to the DSP.

---

Typedef Documentation

typedef void(* FnNotifyCbck)(IN Uint32 eventNo, IN Pvoid arg, IN Pvoid info)

---

Function Documentation

DLLEXPORT DSP_STATUS NOTIFY_register	(	IN ProcessorId	dspId,
		IN Uint32	ipsId,
		IN Uint32	eventNo,
		IN FnNotifyCbck	fnNotifyCbck,
		IN Pvoid	cbckArg
	)

This function registers a callback for a specific event with the NOTIFY component.

============================================================================

Function:

NOTIFY_register

Parameters:

dspId	DSP Identifier.
ipsId	IPS Identifier.
eventNo	Event No to be registered.
fnNotifyCbck	Callback function to be registered for the specified event.
cbckArg	Optional argument to the callback function to be registered for the specified event. This argument shall be passed to each invocation of the callback function.

Returns:

DSP_SOK Operation successfully completed. DSP_EWRONGSTATE IPS not initialized. DSP_EINVALIDARG Invalid arguments. DSP_ENOTSUPPORTED IPS is not supported in DSP->GPP direction. DSP_RESOURCE Specified ips id, event number is reserved for LINK protocols like MSGQ, CHNL, RingIO etc. DSP_EFAIL General failure.

Precondition:

The fnNotifyCbck argument must be valid. The event must be supported by the IPS component. dspId must be valid. PROC_attach has been successful.

Postcondition:

On success, the event must be registered with the IPS component.

See also:

FnNotifyCbck, NOTIFY_unregister () ============================================================================

DLLEXPORT DSP_STATUS NOTIFY_unregister	(	IN ProcessorId	dspId,
		IN Uint32	ipsId,
		IN Uint32	eventNo,
		IN FnNotifyCbck	fnNotifyCbck,
		IN Pvoid	cbckArg
	)

This function unregisters a callback for a specific event with the NOTIFY component.

============================================================================

Function:

NOTIFY_unregister

Parameters:

dspId	DSP Identifier.
ipsId	IPS Identifier.
event	Event to be unregistered.
fnNotifyCbck	Callback function to be registered for the specified event.
cbckArg	Optional argument to the callback function registered for the the specified event.

Returns:

DSP_SOK Operation successfully completed. DSP_EWRONGSTATE IPS not initialized. DSP_EINVALIDARG Invalid arguments. DSP_ENOTSUPPORTED IPS is not supported in DSP->GPP direction. DSP_EFAIL General failure.

Precondition:

The event must be supported by the NOTIFY component. The event must have been registered with the NOTIFY component earlier. The fnNotifyCbck argument must be valid. All Notifications are complete.

Postcondition:

On success, the event must be unregistered from the IPS component

See also:

NOTIFY_register () ============================================================================

DLLEXPORT DSP_STATUS NOTIFY_notify	(	IN ProcessorId	dspId,
		IN Uint32	ipsId,
		IN Uint32	eventno,
		IN Uint32	payload
	)

This function sends a notification of an event to the DSP.

============================================================================

Function:

NOTIFY_notify

Parameters:

dspId	DSP Identifier.
ipsId	IPS Identifier.
eventno	Event to be notified to the DSP.
payload	Data to be sent with Event (Optional).

Returns:

DSP_SOK Operation successfully completed. DSP_EFAIL General failure. DSP_EWRONGSTATE IPS not initialized. DSP_ENOTSUPPORTED IPS is not supported in GPP->DSP direction. DSP_EINVALIDARG Invalid arguments.

Precondition:

The event must be supported by the NOTIFY component. The notification component must be initialized. NOTIFY_register has been successful.

Postcondition:

None.

See also:

None. ============================================================================