module ti.sdo.ipc.notifyDrivers.NotifyDriverShm

A shared memory driver for the Notify Module

C synopsis
Individual elements
Configuration settings
Individual elements

This is a ti.sdo.ipc.Notify driver that utilizes shared memory and inter-processor hardware interrupts for notification between cores. This driver supports caching and currently expects a cache line size of 128 Bytes. Event priorities are supported and correspond to event numbers used to register the events. [ more ... ]

C synopsis target-domain sourced in ti/sdo/ipc/notifyDrivers/NotifyDriverShm.xdc

#include <ti/sdo/ipc/notifyDrivers/NotifyDriverShm.h>

Functions
Void	NotifyDriverShm_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(NotifyDriverShm_Params *params);
SizeT	NotifyDriverShm_sharedMemReq// Amount of shared memory required for creation of each instance(NotifyDriverShm_Params *params);
Functions common to all INotifyDriver modules
Void	NotifyDriverShm_disable// Disable a NotifyDriver instance(NotifyDriverShm_Handle handle);
Void	NotifyDriverShm_disableEvent// Disable an event(NotifyDriverShm_Handle handle, UInt32 eventId);
Void	NotifyDriverShm_enable// Enable a NotifyDriver instance(NotifyDriverShm_Handle handle);
Void	NotifyDriverShm_enableEvent// Enable an event(NotifyDriverShm_Handle handle, UInt32 eventId);
Void	NotifyDriverShm_registerEvent// Register a callback to an event(NotifyDriverShm_Handle handle, UInt32 eventId);
Int	NotifyDriverShm_sendEvent// Send a signal to an event(NotifyDriverShm_Handle handle, UInt32 eventId, UInt32 payload, Bool waitClear);
Void	NotifyDriverShm_unregisterEvent// Remove an event listener from an event(NotifyDriverShm_Handle handle, UInt32 eventId);
Functions common to all target instances
	NotifyDriverShm_handle// Convert this instance structure pointer into an instance handle, NotifyDriverShm_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, NotifyDriverShm_Handle_label// The label associated with this instance object, NotifyDriverShm_Handle_name// The name of this instance object, NotifyDriverShm_Handle_upCast// unconditionally move one level up the inheritance hierarchy, NotifyDriverShm_Object_count// The number of statically-created instance objects, NotifyDriverShm_Object_first// The handle of the first dynamically-created instance object, or NULL, NotifyDriverShm_Object_get// The handle of the i-th statically-created instance object (array == NULL), NotifyDriverShm_Object_heap// The heap used to allocate dynamically-created instance objects, NotifyDriverShm_Object_next// The handle of the next dynamically-created instance object, or NULL, NotifyDriverShm_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	NotifyDriverShm_Module_getMask// Returns the diagnostics mask for this module, NotifyDriverShm_Module_hasMask// Test whether this module has a diagnostics mask, NotifyDriverShm_Module_heap// The heap from which this module allocates memory, NotifyDriverShm_Module_id// Get this module's unique id, NotifyDriverShm_Module_setMask// Set the diagnostics mask for this module, NotifyDriverShm_Module_startupDone// Test if this module has completed startup
Typedefs
typedef NotifyDriverShm_Object *	NotifyDriverShm_Handle// Client reference to an instance object;
typedef struct	NotifyDriverShm_Object// Opaque internal representation of an instance object NotifyDriverShm_Object;
typedef struct	NotifyDriverShm_Params// Instance config-params structure ...
typedef struct	NotifyDriverShm_Struct// Opaque client structure large enough to hold an instance object NotifyDriverShm_Struct;

DETAILS

This driver is designed to work with a variety of devices, each with distinct interrupt mechanisms. Therefore, this module needs to be plugged with an appropriate module that implements the IInterrupt interface for a given device.

The driver utilizes shared memory in the manner indicated by the following diagram.

  NOTE: Processors '0' and '1' correspond to the processors with lower and
        higher MultiProc ids, respectively

 sharedAddr -> --------------------------- bytes
               |  recvInitStatus (0)     | 4  -\
               |  sendInitStatus (0)     | 4   |= sizeof(ProcCtrl)
               |  eventRegMask (0)       | 4   |
               |  eventEnableMask (0)    | 4  -/
               |  [PADDING] (if needed)  |
               |-------------------------|
               |  recvInitStatus (1)     | 4
               |  sendInitStatus (1)     | 4
               |  eventRegMask (1)       | 4
               |  eventEnableMask (1)    | 4
               |  [PADDING] (if needed)  |
               |-------------------------|
               |  eventEntry_0 (0)       | 12 -> sizeof(EventEntry)
               |  [PADDING] (if needed)  |
               |-------------------------|
               |  eventEntry_1 (0)       | 12
               |  [PADDING] (if needed)  |
               |-------------------------|
                       ... ...
               |-------------------------|
               |  eventEntry_N (0)       | 12
               |  [PADDING] (if needed)  |
               |-------------------------|
               |  eventEntry_0 (1)       | 12
               |  [PADDING] (if needed)  |
               |-------------------------|
               |  eventEntry_1 (1)       | 12
               |  [PADDING] (if needed)  |
               |-------------------------|
                       ... ...
               |-------------------------|
               |  eventEntry_N (1)       | 12
               |  [PADDING] (if needed)  |
               |-------------------------|


  Legend:
  (0), (1) : Memory that belongs to the proc with lower and higher
             MultiProc.id, respectively
   |----|  : Cache line boundary
   N       : Notify_numEvents - 1

NotifyDriverShm_sharedMemReq() // module-wide