module ti.sdo.ipc.Notify

Notification manager

C synopsis
Individual elements
XDCscript usage
Individual elements

This module has a common header that can be found in the ti.ipc package. Application code should include the common header file (not the RTSC-generated one):

#include <ti/ipc/Notify.h>

The RTSC module must be used in the application's RTSC configuration file (.cfg) if runtime APIs will be used in the application:

Notify = xdc.useModule('ti.sdo.ipc.Notify');

Documentation for all runtime APIs, instance configuration parameters, error codes macros and type definitions available to the application integrator can be found in the Doxygen documenation for the IPC product. However, the documentation presented on this page should be referred to for information specific to the RTSC module, such as module configuration, Errors, and Asserts. [ more ... ]

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

#include <ti/sdo/ipc/Notify.h>

Functions
Void	Notify_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(Notify_Params *params);
Functions common to all target instances
	Notify_handle// Convert this instance structure pointer into an instance handle, Notify_Handle_label// The label associated with this instance object, Notify_Handle_name// The name of this instance object, Notify_Object_count// The number of statically-created instance objects, Notify_Object_first// The handle of the first dynamically-created instance object, or NULL, Notify_Object_get// The handle of the i-th statically-created instance object (array == NULL), Notify_Object_heap// The heap used to allocate dynamically-created instance objects, Notify_Object_next// The handle of the next dynamically-created instance object, or NULL, Notify_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	Notify_Module_getMask// Returns the diagnostics mask for this module, Notify_Module_hasMask// Test whether this module has a diagnostics mask, Notify_Module_heap// The heap from which this module allocates memory, Notify_Module_id// Get this module's unique id, Notify_Module_setMask// Set the diagnostics mask for this module, Notify_Module_startupDone// Test if this module has completed startup
Defines
#define	Notify_MAXEVENTS// Maximum number of events supported by the Notify module (UInt)32
Typedefs
typedef Notify_Object *	Notify_Handle// Client reference to an instance object;
typedef struct	Notify_Object// Opaque internal representation of an instance object Notify_Object;
typedef struct	Notify_Params// Instance config-params structure ...
typedef struct	Notify_Struct// Opaque client structure large enough to hold an instance object Notify_Struct;
Constants
extern const Assert_Id	Notify_A_alreadyRegistered// Assert raised when trying to re-register for given line and processor;
extern const Assert_Id	Notify_A_internal// Assert raised when an internal error is encountered;
extern const Assert_Id	Notify_A_invArgument// Assert raised when an argument is invalid;
extern const Assert_Id	Notify_A_notRegistered// Assert raised when trying to use an unregistered Notify instance;
extern const Assert_Id	Notify_A_outOfOrderNesting// Assert raised when restore called with improper key;
extern const Assert_Id	Notify_A_reservedEvent// Assert raised when trying to improperly use a reserved event;
extern const UInt	Notify_numEvents// Number of events supported by Notify;
extern const UInt16	Notify_reservedEvents// Number of reserved event numbers;
extern const UInt32	Notify_sendEventPollCount// Poll for specified amount before sendEvent times out;

DETAILS

This module has a common header that can be found in the ti.ipc package. Application code should include the common header file (not the RTSC-generated one):

#include <ti/ipc/Notify.h>

The RTSC module must be used in the application's RTSC configuration file (.cfg) if runtime APIs will be used in the application:

Notify = xdc.useModule('ti.sdo.ipc.Notify');

The Notify module typically doesn't require much (if any) configuration at static time. However, it is possible to reduce the amount of shared memory used by the Notify subsystem by reducing the value of numEvents.

const Notify_MAXEVENTS