module ti.sdo.ipc.family.ti81xx.NotifyDriverMbx
index URL

A TI81xx hardware mailbox based driver for the Notify Module

This is a ti.sdo.ipc.Notify driver that uses hardware mailboxes to transmit notifications to remote processors. [ more ... ]
C synopsis target-domain sourced in ti/sdo/ipc/family/ti81xx/NotifyDriverMbx.xdc
#include <ti/sdo/ipc/family/ti81xx/NotifyDriverMbx.h>
Functions
Void
NotifyDriverMbx_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(NotifyDriverMbx_Params *params);
Functions common to all INotifyDriver modules
Void 
NotifyDriverMbx_disable// Disable a NotifyDriver instance(NotifyDriverMbx_Handle handle);
Void 
NotifyDriverMbx_disableEvent// Disable an event(NotifyDriverMbx_Handle handle, UInt32 eventId);
Void 
NotifyDriverMbx_enable// Enable a NotifyDriver instance(NotifyDriverMbx_Handle handle);
Void 
NotifyDriverMbx_enableEvent// Enable an event(NotifyDriverMbx_Handle handle, UInt32 eventId);
Void 
NotifyDriverMbx_registerEvent// Register a callback to an event(NotifyDriverMbx_Handle handle, UInt32 eventId);
Int 
NotifyDriverMbx_sendEvent// Send a signal to an event(NotifyDriverMbx_Handle handle, UInt32 eventId, UInt32 payload, Bool waitClear);
Void 
NotifyDriverMbx_unregisterEvent// Remove an event listener from an event(NotifyDriverMbx_Handle handle, UInt32 eventId);
Functions common to all target instances
NotifyDriverMbx_handle// Convert this instance structure pointer into an instance handle, NotifyDriverMbx_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, NotifyDriverMbx_Handle_label// The label associated with this instance object, NotifyDriverMbx_Handle_name// The name of this instance object, NotifyDriverMbx_Handle_upCast// unconditionally move one level up the inheritance hierarchy, NotifyDriverMbx_Object_count// The number of statically-created instance objects, NotifyDriverMbx_Object_first// The handle of the first dynamically-created instance object, or NULL, NotifyDriverMbx_Object_get// The handle of the i-th statically-created instance object (array == NULL), NotifyDriverMbx_Object_heap// The heap used to allocate dynamically-created instance objects, NotifyDriverMbx_Object_next// The handle of the next dynamically-created instance object, or NULL, NotifyDriverMbx_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
NotifyDriverMbx_Module_getMask// Returns the diagnostics mask for this module, NotifyDriverMbx_Module_hasMask// Test whether this module has a diagnostics mask, NotifyDriverMbx_Module_heap// The heap from which this module allocates memory, NotifyDriverMbx_Module_id// Get this module's unique id, NotifyDriverMbx_Module_setMask// Set the diagnostics mask for this module, NotifyDriverMbx_Module_startupDone// Test if this module has completed startup
Typedefs
typedef NotifyDriverMbx_Object *
NotifyDriverMbx_Handle// Client reference to an instance object;
typedef struct
NotifyDriverMbx_Object// Opaque internal representation of an instance object NotifyDriverMbx_Object;
typedef struct
NotifyDriverMbx_Params// Instance config-params structure ...
typedef struct
NotifyDriverMbx_Struct// Opaque client structure large enough to hold an instance object NotifyDriverMbx_Struct;
Constants
extern const Assert_Id 
NotifyDriverMbx_A_notSupported// Assert raised when trying to use Notify_[enable/disable]Event with NotifyDriverMbx;
extern const UInt 
NotifyDriverMbx_intVectorId// Interrupt vector ID to be used by the driver;
extern const UInt32 
NotifyDriverMbx_mailboxBaseAddr// Base address for the Mailbox subsystem;
 
DETAILS
This is a ti.sdo.ipc.Notify driver that uses hardware mailboxes to transmit notifications to remote processors.
Unlike the Notify drivers available in the ti.sdo.ipc.notifyDrivers package, this driver is not generic and will only work with the TI81xx family of devices.
The driver uses no shared memory since the event IDs and payloads that comprise notifications are transmitted via the hardware mailbox FIFO. The FIFO can hold up to 4 mailbox messages. The number of notification that can be stored in the FIFO depends on the sizes of the payloads being sent via Notify_sendEvent. If the payload is less than 0x7FFFFFF, then a single message will be sent per notification. Otherwise, if the payload is greater than or equal to 0x7FFFFFF, two mailbox messages are needed to send the notification.
The behavior of Notify_sendEvent when the FIFO is full depends on the value of the 'waitClear' argument to the function. If 'waitClear' is TRUE, then Notify_sendEvent will spin waiting for enough room in the FIFO for the notification before actually sending it. If 'waitClear' is FALSE, then Notify_sendEvent will return Notify_E_FAIL if there isn't enough room in the FIFO to store the notification.
The Notify_[enable/disable]Event APIs are not supported by this driver.
 
config NotifyDriverMbx_A_notSupported  // module-wide
index URL

Assert raised when trying to use Notify_[enable/disable]Event with NotifyDriverMbx

C synopsis target-domain
extern const Assert_Id NotifyDriverMbx_A_notSupported;
 
 
config NotifyDriverMbx_intVectorId  // module-wide
index URL

Interrupt vector ID to be used by the driver

C synopsis target-domain
extern const UInt NotifyDriverMbx_intVectorId;
 
DETAILS
This parameter is only used by the DSP core
 
config NotifyDriverMbx_mailboxBaseAddr  // module-wide
index URL

Base address for the Mailbox subsystem

C synopsis target-domain
extern const UInt32 NotifyDriverMbx_mailboxBaseAddr;
 
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId NotifyDriverMbx_Module_id();
// Get this module's unique id
 
Bool NotifyDriverMbx_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle NotifyDriverMbx_Module_heap();
// The heap from which this module allocates memory
 
Bool NotifyDriverMbx_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 NotifyDriverMbx_Module_getMask();
// Returns the diagnostics mask for this module
 
Void NotifyDriverMbx_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types
index URL

C synopsis target-domain
typedef struct NotifyDriverMbx_Object NotifyDriverMbx_Object;
// Opaque internal representation of an instance object
 
typedef NotifyDriverMbx_Object *NotifyDriverMbx_Handle;
// Client reference to an instance object
 
typedef struct NotifyDriverMbx_Struct NotifyDriverMbx_Struct;
// Opaque client structure large enough to hold an instance object
 
NotifyDriverMbx_Handle NotifyDriverMbx_handle(NotifyDriverMbx_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
NotifyDriverMbx_Struct *NotifyDriverMbx_struct(NotifyDriverMbx_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters
index URL

C synopsis target-domain
typedef struct NotifyDriverMbx_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    UInt16 remoteProcId;
    // The MultiProc ID corresponding to the remote processor
} NotifyDriverMbx_Params;
 
Void NotifyDriverMbx_Params_init(NotifyDriverMbx_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config NotifyDriverMbx_remoteProcId  // instance
index URL

The MultiProc ID corresponding to the remote processor

C synopsis target-domain
struct NotifyDriverMbx_Params {
      ...
    UInt16 remoteProcId;
 
 
NotifyDriverMbx_disable()  // instance
index URL

Disable a NotifyDriver instance

C synopsis target-domain
Void NotifyDriverMbx_disable(NotifyDriverMbx_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created NotifyDriverMbx instance object
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.
 
NotifyDriverMbx_disableEvent()  // instance
index URL

Disable an event

C synopsis target-domain
Void NotifyDriverMbx_disableEvent(NotifyDriverMbx_Handle handle, UInt32 eventId);
 
ARGUMENTS
handle — handle of a previously-created NotifyDriverMbx instance object
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.
 
NotifyDriverMbx_enable()  // instance
index URL

Enable a NotifyDriver instance

C synopsis target-domain
Void NotifyDriverMbx_enable(NotifyDriverMbx_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created NotifyDriverMbx instance object
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.
 
NotifyDriverMbx_enableEvent()  // instance
index URL

Enable an event

C synopsis target-domain
Void NotifyDriverMbx_enableEvent(NotifyDriverMbx_Handle handle, UInt32 eventId);
 
ARGUMENTS
handle — handle of a previously-created NotifyDriverMbx instance object
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.
 
NotifyDriverMbx_registerEvent()  // instance
index URL

Register a callback to an event

C synopsis target-domain
Void NotifyDriverMbx_registerEvent(NotifyDriverMbx_Handle handle, UInt32 eventId);
 
ARGUMENTS
handle — handle of a previously-created NotifyDriverMbx instance object
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.
 
NotifyDriverMbx_sendEvent()  // instance
index URL

Send a signal to an event

C synopsis target-domain
Int NotifyDriverMbx_sendEvent(NotifyDriverMbx_Handle handle, UInt32 eventId, UInt32 payload, Bool waitClear);
 
ARGUMENTS
handle — handle of a previously-created NotifyDriverMbx instance object
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.
 
NotifyDriverMbx_unregisterEvent()  // instance
index URL

Remove an event listener from an event

C synopsis target-domain
Void NotifyDriverMbx_unregisterEvent(NotifyDriverMbx_Handle handle, UInt32 eventId);
 
ARGUMENTS
handle — handle of a previously-created NotifyDriverMbx instance object
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.
Instance Convertors
index URL

C synopsis target-domain
INotifyDriver_Handle NotifyDriverMbx_Handle_upCast(NotifyDriverMbx_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
NotifyDriverMbx_Handle NotifyDriverMbx_Handle_downCast(INotifyDriver_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins
index URL

C synopsis target-domain
Int NotifyDriverMbx_Object_count();
// The number of statically-created instance objects
 
NotifyDriverMbx_Handle NotifyDriverMbx_Object_get(NotifyDriverMbx_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
NotifyDriverMbx_Handle NotifyDriverMbx_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
NotifyDriverMbx_Handle NotifyDriverMbx_Object_next(NotifyDriverMbx_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle NotifyDriverMbx_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *NotifyDriverMbx_Handle_label(NotifyDriverMbx_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String NotifyDriverMbx_Handle_name(NotifyDriverMbx_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/sdo/ipc/family/ti81xx/NotifyDriverMbx.xdc
var NotifyDriverMbx = xdc.useModule('ti.sdo.ipc.family.ti81xx.NotifyDriverMbx');
module-wide config parameters
    NotifyDriverMbx.A_notSupported// Assert raised when trying to use Notify_[enable/disable]Event with NotifyDriverMbx = Assert.Desc {
        msg: "A_notSupported: [enable/disable]Event not supported by NotifyDriverMbx"
    };
    NotifyDriverMbx.intVectorId// Interrupt vector ID to be used by the driver = UInt ~1u;
    NotifyDriverMbx.mailboxBaseAddr// Base address for the Mailbox subsystem = UInt32 0x480C8000;
 
    NotifyDriverMbx.common$// Common module configuration parameters = Types.Common$ undefined;
    NotifyDriverMbx.rovViewInfo//  = ViewInfo.Instance ViewInfo.create;
per-instance config parameters
    var params = new NotifyDriverMbx.Params// Instance config-params object;
        params.remoteProcId// The MultiProc ID corresponding to the remote processor = UInt16 MultiProc.INVALIDID;
 
 
config NotifyDriverMbx.A_notSupported  // module-wide
index URL

Assert raised when trying to use Notify_[enable/disable]Event with NotifyDriverMbx

XDCscript usage meta-domain
NotifyDriverMbx.A_notSupported = Assert.Desc {
    msg: "A_notSupported: [enable/disable]Event not supported by NotifyDriverMbx"
};
 
C SYNOPSIS
NotifyDriverMbx_A_notSupported
 
config NotifyDriverMbx.intVectorId  // module-wide
index URL

Interrupt vector ID to be used by the driver

XDCscript usage meta-domain
NotifyDriverMbx.intVectorId = UInt ~1u;
 
DETAILS
This parameter is only used by the DSP core
C SYNOPSIS
NotifyDriverMbx_intVectorId
 
config NotifyDriverMbx.mailboxBaseAddr  // module-wide
index URL

Base address for the Mailbox subsystem

XDCscript usage meta-domain
NotifyDriverMbx.mailboxBaseAddr = UInt32 0x480C8000;
 
C SYNOPSIS
NotifyDriverMbx_mailboxBaseAddr
 
metaonly config NotifyDriverMbx.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
NotifyDriverMbx.common$ = Types.Common$ undefined;
 
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.
 
metaonly config NotifyDriverMbx.rovViewInfo  // module-wide
index URL
XDCscript usage meta-domain
NotifyDriverMbx.rovViewInfo = ViewInfo.Instance ViewInfo.create;
 
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new NotifyDriverMbx.Params;
// Instance config-params object
    params.remoteProcId = UInt16 MultiProc.INVALIDID;
    // The MultiProc ID corresponding to the remote processor
 
config NotifyDriverMbx.remoteProcId  // instance
index URL

The MultiProc ID corresponding to the remote processor

XDCscript usage meta-domain
var params = new NotifyDriverMbx.Params;
  ...
params.remoteProcId = UInt16 MultiProc.INVALIDID;
 
C SYNOPSIS
null
generated on Sat, 11 Feb 2012 00:37:57 GMT