module ti.sdo.ipc.family.da830.NotifySetup

index URL

Manages setup of the default Notify driver handles

C synopsis
Individual elements
XDCscript usage
Individual elements

Creates the default notify drivers for each pair of processors.

C synopsis target-domain sourced in ti/sdo/ipc/family/da830/NotifySetup.xdc

#include <ti/sdo/ipc/family/da830/NotifySetup.h>

Functions common to all INotifySetup modules
Int	NotifySetup_attach// Function that will be called in Notify_attach(UInt16 remoteProcId, Ptr sharedAddr);
UInt16	NotifySetup_numIntLines// Returns number of interrupt lines to the processor(UInt16 remoteProcId);
SizeT	NotifySetup_sharedMemReq// Shared Memory Required for a single notification line(UInt16 remoteProcId, Ptr sharedAddr);
Functions common to all target modules
	NotifySetup_Module_getMask// Returns the diagnostics mask for this module, NotifySetup_Module_hasMask// Test whether this module has a diagnostics mask, NotifySetup_Module_heap// The heap from which this module allocates memory, NotifySetup_Module_id// Get this module's unique id, NotifySetup_Module_setMask// Set the diagnostics mask for this module, NotifySetup_Module_startupDone// Test if this module has completed startup
Typedefs
typedef enum	NotifySetup_ARM_INT// Possible incoming interrupt IDs for ARM ...
typedef enum	NotifySetup_DSP_INT// Possible incoming interrupt IDs for DSP ...
Constants
extern const UInt	NotifySetup_armRecvIntId0// Incoming interrupt ID for line #0 line on ARM;
extern const UInt	NotifySetup_armRecvIntId1// Incoming interrupt ID for line #1 line on ARM;
extern const UInt	NotifySetup_dspIntVectId0// Vector ID to use on DSP for line #0;
extern const UInt	NotifySetup_dspIntVectId1// Vector ID to use on DSP for line #1;
extern const UInt	NotifySetup_dspRecvIntId0// Incoming interrupt ID for line #0 line on DSP;
extern const UInt	NotifySetup_dspRecvIntId1// Incoming interrupt ID for line #1 line on DSP;
extern const Bool	NotifySetup_useSecondLine// Enable the second interrupt line;

enum NotifySetup_ARM_INT

index URL

Possible incoming interrupt IDs for ARM

C synopsis target-domain

typedef enum NotifySetup_ARM_INT {

NotifySetup_ARM_INT0,

NotifySetup_ARM_INT1

} NotifySetup_ARM_INT;

enum NotifySetup_DSP_INT

index URL

Possible incoming interrupt IDs for DSP

C synopsis target-domain

typedef enum NotifySetup_DSP_INT {

NotifySetup_DSP_INT0,

NotifySetup_DSP_INT1

} NotifySetup_DSP_INT;

config NotifySetup_armRecvIntId0 // module-wide

index URL

Incoming interrupt ID for line #0 line on ARM

C synopsis target-domain

extern const UInt NotifySetup_armRecvIntId0;

DETAILS

See ARM_INT for possible values.

config NotifySetup_armRecvIntId1 // module-wide

index URL

Incoming interrupt ID for line #1 line on ARM

C synopsis target-domain

extern const UInt NotifySetup_armRecvIntId1;

DETAILS

See ARM_INT for possible values.

config NotifySetup_dspIntVectId0 // module-wide

index URL

Vector ID to use on DSP for line #0

C synopsis target-domain

extern const UInt NotifySetup_dspIntVectId0;

config NotifySetup_dspIntVectId1 // module-wide

index URL

Vector ID to use on DSP for line #1

C synopsis target-domain

extern const UInt NotifySetup_dspIntVectId1;

config NotifySetup_dspRecvIntId0 // module-wide

index URL

Incoming interrupt ID for line #0 line on DSP

C synopsis target-domain

extern const UInt NotifySetup_dspRecvIntId0;

DETAILS

See DSP_INT for possible values.

config NotifySetup_dspRecvIntId1 // module-wide

index URL

Incoming interrupt ID for line #1 line on DSP

C synopsis target-domain

extern const UInt NotifySetup_dspRecvIntId1;

DETAILS

See DSP_INT for possible values.

config NotifySetup_useSecondLine // module-wide

index URL

Enable the second interrupt line

C synopsis target-domain

extern const Bool NotifySetup_useSecondLine;

NotifySetup_attach() // module-wide

index URL

Function that will be called in Notify_attach

C synopsis target-domain

Int NotifySetup_attach(UInt16 remoteProcId, Ptr sharedAddr);

NotifySetup_numIntLines() // module-wide

index URL

Returns number of interrupt lines to the processor

C synopsis target-domain

UInt16 NotifySetup_numIntLines(UInt16 remoteProcId);

NotifySetup_sharedMemReq() // module-wide

index URL

Shared Memory Required for a single notification line

C synopsis target-domain

SizeT NotifySetup_sharedMemReq(UInt16 remoteProcId, Ptr sharedAddr);

Module-Wide Built-Ins

index URL

C synopsis target-domain

Types_ModuleId NotifySetup_Module_id();

// Get this module's unique id

Bool NotifySetup_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle NotifySetup_Module_heap();

// The heap from which this module allocates memory

Bool NotifySetup_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 NotifySetup_Module_getMask();

// Returns the diagnostics mask for this module

Void NotifySetup_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

XDCscript usage meta-domain sourced in ti/sdo/ipc/family/da830/NotifySetup.xdc

var NotifySetup = xdc.useModule('ti.sdo.ipc.family.da830.NotifySetup');

module-wide constants & types

values of type NotifySetup.ARM_INT// Possible incoming interrupt IDs for ARM

const NotifySetup.ARM_INT0;

const NotifySetup.ARM_INT1;

values of type NotifySetup.DSP_INT// Possible incoming interrupt IDs for DSP

const NotifySetup.DSP_INT0;

const NotifySetup.DSP_INT1;

module-wide config parameters

NotifySetup.armRecvIntId0// Incoming interrupt ID for line #0 line on ARM = UInt NotifySetup.ARM_INT0;

NotifySetup.armRecvIntId1// Incoming interrupt ID for line #1 line on ARM = UInt NotifySetup.ARM_INT1;

NotifySetup.dspIntVectId0// Vector ID to use on DSP for line #0 = UInt 5;

NotifySetup.dspIntVectId1// Vector ID to use on DSP for line #1 = UInt 6;

NotifySetup.dspRecvIntId0// Incoming interrupt ID for line #0 line on DSP = UInt NotifySetup.DSP_INT0;

NotifySetup.dspRecvIntId1// Incoming interrupt ID for line #1 line on DSP = UInt NotifySetup.DSP_INT1;

NotifySetup.useSecondLine// Enable the second interrupt line = Bool false;

NotifySetup.common$// Common module configuration parameters = Types.Common$ undefined;

enum NotifySetup.ARM_INT

index URL

Possible incoming interrupt IDs for ARM

XDCscript usage meta-domain

values of type NotifySetup.ARM_INT

const NotifySetup.ARM_INT0;

const NotifySetup.ARM_INT1;

C SYNOPSIS

NotifySetup_ARM_INT

enum NotifySetup.DSP_INT

index URL

Possible incoming interrupt IDs for DSP

XDCscript usage meta-domain

values of type NotifySetup.DSP_INT

const NotifySetup.DSP_INT0;

const NotifySetup.DSP_INT1;

C SYNOPSIS

NotifySetup_DSP_INT

config NotifySetup.armRecvIntId0 // module-wide

index URL

Incoming interrupt ID for line #0 line on ARM

XDCscript usage meta-domain

NotifySetup.armRecvIntId0 = UInt NotifySetup.ARM_INT0;

DETAILS

See ARM_INT for possible values.

C SYNOPSIS

NotifySetup_armRecvIntId0

config NotifySetup.armRecvIntId1 // module-wide

index URL

Incoming interrupt ID for line #1 line on ARM

XDCscript usage meta-domain

NotifySetup.armRecvIntId1 = UInt NotifySetup.ARM_INT1;

DETAILS

See ARM_INT for possible values.

C SYNOPSIS

NotifySetup_armRecvIntId1

config NotifySetup.dspIntVectId0 // module-wide

index URL

Vector ID to use on DSP for line #0

XDCscript usage meta-domain

NotifySetup.dspIntVectId0 = UInt 5;

C SYNOPSIS

NotifySetup_dspIntVectId0

config NotifySetup.dspIntVectId1 // module-wide

index URL

Vector ID to use on DSP for line #1

XDCscript usage meta-domain

NotifySetup.dspIntVectId1 = UInt 6;

C SYNOPSIS

NotifySetup_dspIntVectId1

config NotifySetup.dspRecvIntId0 // module-wide

index URL

Incoming interrupt ID for line #0 line on DSP

XDCscript usage meta-domain

NotifySetup.dspRecvIntId0 = UInt NotifySetup.DSP_INT0;

DETAILS

See DSP_INT for possible values.

C SYNOPSIS

NotifySetup_dspRecvIntId0

config NotifySetup.dspRecvIntId1 // module-wide

index URL

Incoming interrupt ID for line #1 line on DSP

XDCscript usage meta-domain

NotifySetup.dspRecvIntId1 = UInt NotifySetup.DSP_INT1;

DETAILS

See DSP_INT for possible values.

C SYNOPSIS

NotifySetup_dspRecvIntId1

config NotifySetup.useSecondLine // module-wide

index URL

Enable the second interrupt line

XDCscript usage meta-domain

NotifySetup.useSecondLine = Bool false;

C SYNOPSIS

NotifySetup_useSecondLine

metaonly config NotifySetup.common$ // module-wide

index URL

Common module configuration parameters

XDCscript usage meta-domain

NotifySetup.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.

generated on Sat, 11 Feb 2012 00:37:49 GMT