notify.h File Reference

#include <dsplink.h>

Include dependency graph for dsp/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 NOTIFY 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 NOTIFY being implemented. Returns: None. Precondition: None. Postcondition: None. See also: NOTIFY_register () ============================================================================
typedef Void(*	FnNotifyCbck )(IN Uint32 eventNo, IN Ptr arg, IN Ptr info)
Int	NOTIFY_register (IN Uint32 procId, IN Uint32 ipsId, IN Uint32 eventNo, IN FnNotifyCbck fnNotifyCbck, IN Ptr cbckArg)
	This function registers a callback for a specific event with the NOTIFY component.
Int	NOTIFY_unregister (IN Uint32 procId, IN Uint32 ipsId, IN Uint32 eventNo, IN FnNotifyCbck fnNotifyCbck, IN Void *cbckArg)
	This function unregisters a callback for a specific event with the NOTIFY component.
Int	NOTIFY_notify (IN Uint32 procId, IN Uint32 ipsId, IN Uint32 eventNo, IN Uint32 payload)
	This function sends a notification of an event to the processor.

---

Typedef Documentation

typedef Void(* FnNotifyCbck)(IN Uint32 eventNo, IN Ptr arg, IN Ptr info)

---

Function Documentation

Int NOTIFY_register	(	IN Uint32	procId,
		IN Uint32	ipsId,
		IN Uint32	eventNo,
		IN FnNotifyCbck	fnNotifyCbck,
		IN Ptr	cbckArg
	)

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

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

Function:

NOTIFY_register

Parameters:

procId	Identifier of the processor from which the notifications shall be received.
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:

SYS_OK Operation successfully completed. SYS_EINVAL Invalid argument. SYS_EALLOC Memory allocation failure. SYS_EMODE IPS is not supported for GPP->DSP mode. SYS_EBUSY Specified ips id, event number is reserved for LINK protocols like MSGQ, CHNL, RingIO etc.

Precondition:

The NOTIFY component must be initialized before calling this function.

Postcondition:

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

See also:

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

Int NOTIFY_unregister	(	IN Uint32	procId,
		IN Uint32	ipsId,
		IN Uint32	eventNo,
		IN FnNotifyCbck	fnNotifyCbck,
		IN Void *	cbckArg
	)

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

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

Function:

NOTIFY_unregister

Parameters:

procId	Identifier of the processor from which the notifications shall no longer be received.
ipsId	IPS Identifier.
eventNo	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:

SYS_OK Operation successfully completed. SYS_ENOTFOUND Registered event not found. SYS_EMODE IPS is not supported for GPP->DSP mode.

Precondition:

The NOTIFY component must be initialized before calling this function. The fnNotifyCbck argument must be valid.

Postcondition:

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

See also:

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

Int NOTIFY_notify	(	IN Uint32	procId,
		IN Uint32	ipsId,
		IN Uint32	eventNo,
		IN Uint32	payload
	)

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

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

Function:

NOTIFY_notify

Parameters:

procId	Identifier of the processor to which the notification is to be sent.
ipsId	IPS Identifier.
eventNo	Event to be notified to the processor.
payload	Data to be sent with Event.

Returns:

SYS_OK Operation successfully completed. SYS_ENODEV Event is not registered on the remote processor. SYS_EINVAL Invalid argument. SYS_EMODE IPS is not supported for DSP->GPP mode.

Precondition:

The NOTIFY component must be initialized before calling this function. The event must be supported by the NOTIFY component.

Postcondition:

None.

See also:

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