interface ti.sdo.ipc.interfaces.INotifyDriver
index URL

Notify driver interface

Interface implemented by all drivers for the notify module. Modules that implement this interface expect the eventId arguments to be valid.
XDCspec summary sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
interface INotifyDriver {  ...
// inherits xdc.runtime.IModule
instance:  ...
XDCspec declarations sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
package ti.sdo.ipc.interfaces;
 
interface INotifyDriver {
module-wide config parameters
    metaonly config Types.Common$ common$// Common module configuration parameters;
 
 
instance:
per-instance functions
    Void disable// Disable a NotifyDriver instance();
    Void disableEvent// Disable an event(UInt32 eventId);
    Void enable// Enable a NotifyDriver instance();
    Void enableEvent// Enable an event(UInt32 eventId);
    Void registerEvent// Register a callback to an event(UInt32 eventId);
    Int sendEvent// Send a signal to an event(UInt32 eventId, UInt32 payload, Bool waitClear);
    Void unregisterEvent// Remove an event listener from an event(UInt32 eventId);
}
 
metaonly config INotifyDriver.common$  // module-wide
index URL

Common module configuration parameters

XDCspec declarations sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
metaonly config Types.Common$ common$;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
 
INotifyDriver.disable()  // instance
index URL

Disable a NotifyDriver instance

XDCspec declarations sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
Void disable();
 
DETAILS
Disables the ability of a Notify driver to receive events for a given processor. This interface function is called by the Notify_disable function. Refer to its documentation for more details.
 
INotifyDriver.disableEvent()  // instance
index URL

Disable an event

XDCspec declarations sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
Void disableEvent(UInt32 eventId);
 
ARGUMENTS
eventId — Number of event to disable
DETAILS
This interface function is called by the Notify_disableEvent function. Refer to its documentation for more details.
The Notify module does validation of the eventId. The Notify module enters calls this function within the Notify module gate.
 
INotifyDriver.enable()  // instance
index URL

Enable a NotifyDriver instance

XDCspec declarations sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
Void enable();
 
DETAILS
Enables the ability of a Notify driver to receive events for a given processor. This interface function is called by the Notify_restore function. Refer to its documentation for more details.
 
INotifyDriver.enableEvent()  // instance
index URL

Enable an event

XDCspec declarations sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
Void enableEvent(UInt32 eventId);
 
ARGUMENTS
eventId — Number of event to enable
DETAILS
This interface function is called by the Notify_disableEvent function. Refer to its documentation for more details.
The Notify module does validation of the eventId. The Notify module enters calls this function within the Notify module gate.
 
INotifyDriver.registerEvent()  // instance
index URL

Register a callback to an event

XDCspec declarations sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
Void registerEvent(UInt32 eventId);
 
ARGUMENTS
eventId — Number of event that is being registered
DETAILS
This driver function is called by the Notify_registerEvent function within the Notify module gate. Refer to its documentation for more details.
 
INotifyDriver.sendEvent()  // instance
index URL

Send a signal to an event

XDCspec declarations sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
Int sendEvent(UInt32 eventId, UInt32 payload, Bool waitClear);
 
ARGUMENTS
eventId — Number of event to signal
payload — Payload (optional) to pass to callback function
waitClear — If TRUE, have the NotifyDriver wait for acknowledgement back from the destination processor.
RETURNS
Notify status
DETAILS
This interface function is called by the Notify_sendEvent function. Notify_sendEvent does not provide any context protection for INotifyDriver_sendEvent, so appropriate measures must be taken within the driver itself.
 
INotifyDriver.unregisterEvent()  // instance
index URL

Remove an event listener from an event

XDCspec declarations sourced in ti/sdo/ipc/interfaces/INotifyDriver.xdc
Void unregisterEvent(UInt32 eventId);
 
ARGUMENTS
eventId — Number of event that is being unregistered
DETAILS
This driver function is called by the Notify_unregisterEvent function within the Notify module gate. Refer to it for more details.
generated on Sat, 11 Feb 2012 00:38:03 GMT