module ti.syslink.ipc.rtos.interfaces.SysLink

Common values shared by IPC modules

This module contains values, errors and asserts that are used by several IPC modules.
C synopsis target-domain sourced in ti/syslink/ipc/rtos/interfaces/SysLink.xdc
#include <ti/syslink/ipc/rtos/interfaces/SysLink.h>
Functions common to all target modules
Typedefs
typedef enum
Constants
extern const Assert_Id 
extern const Assert_Id 
extern const Assert_Id 
extern const Assert_Id 
extern const Assert_Id 
extern const Int 
extern const Error_Id 
extern const Error_Id 
 
 
enum SysLink_NotifyType

Enumeration of Client notifyMgr notification types.

C synopsis target-domain
typedef enum SysLink_NotifyType {
    SysLink_NOTIFICATION_NONE,
    SysLink_NOTIFICATION_ALWAYS,
    SysLink_NOTIFICATION_ONCE,
    SysLink_NOTIFICATION_HDWRFIFO_ALWAYS,
    SysLink_NOTIFICATION_HDWRFIFO_ONCE
} SysLink_NotifyType;
 
VALUES
NOTIFICATION_NONE — No notification required.
NOTIFICATION_ALWAYS — Notify whenever the other client sends data/frees up space.
NOTIFICATION_ONCE — Notify when the other side sends data/frees up buffer. Once the notification is done, the notification is disabled until it is enabled again.
NOTIFICATION_HDWRFIFO_ALWAYS — Notify whenever the other side sends data/frees up space. This notification is never disabled.
NOTIFICATION_HDWRFIFO_ONCE — Notify when the other side sends data/frees up buffer. Once the notification is done, the notification is disabled until it is enabled again. The notification is enabled once the watermark is crossed and does not require buffer to get full/empty..
 
config SysLink_A_addrNotCacheAligned  // module-wide

Error raised when an address is not cache-aligned

C synopsis target-domain
extern const Assert_Id SysLink_A_addrNotCacheAligned;
 
 
config SysLink_A_invSemNum  // module-wide

Assert raised by GateSpinLock delegate when provided semNum is invalid

C synopsis target-domain
extern const Assert_Id SysLink_A_invSemNum;
 
 
config SysLink_A_invSize  // module-wide

Assert raised when sharedAddrSize is too small

C synopsis target-domain
extern const Assert_Id SysLink_A_invSize;
 
 
config SysLink_A_invSpinLockNum  // module-wide

Assert raised by GateSpinLock delegate when provided lockNum is invalid

C synopsis target-domain
extern const Assert_Id SysLink_A_invSpinLockNum;
 
 
config SysLink_A_nullArgument  // module-wide

Assert raised when a required argument is null

C synopsis target-domain
extern const Assert_Id SysLink_A_nullArgument;
 
 
config SysLink_E_listMPNotCreated  // module-wide

Error raised in ti.sdo.ipc.ListMP.open when the ListMP has not been created yet

C synopsis target-domain
extern const Error_Id SysLink_E_listMPNotCreated;
 
 
config SysLink_E_versionMismatch  // module-wide

Error raised in an open call because there is a version mismatch between the opener and the creator

C synopsis target-domain
extern const Error_Id SysLink_E_versionMismatch;
 
 
config SysLink_cacheSize  // module-wide

Worse-case cache size

C synopsis target-domain
extern const Int SysLink_cacheSize;
 
DETAILS
This is used by the IPC modules to determine the cache size. When IPC modules place things in shared memory, this value is used to make sure items are on a cache boundary and are a multiple of the size.
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId SysLink_Module_id();
// Get this module's unique id
 
Bool SysLink_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle SysLink_Module_heap();
// The heap from which this module allocates memory
 
Bool SysLink_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 SysLink_Module_getMask();
// Returns the diagnostics mask for this module
 
Void SysLink_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/syslink/ipc/rtos/interfaces/SysLink.xdc
var SysLink = xdc.useModule('ti.syslink.ipc.rtos.interfaces.SysLink');
module-wide constants & types
        const SysLink.NOTIFICATION_NONE;
        const SysLink.NOTIFICATION_ALWAYS;
        const SysLink.NOTIFICATION_ONCE;
        const SysLink.NOTIFICATION_HDWRFIFO_ALWAYS;
        const SysLink.NOTIFICATION_HDWRFIFO_ONCE;
module-wide config parameters
        msg: "A_addrNotCacheAligned: Address is not cache aligned"
    };
        msg: "A_invSemNum: Invalid hardware semaphore number"
    };
        msg: "A_invSize: Invalid sharedAddrSize"
    };
        msg: "A_invSemNum: Invalid hardware spinlock number"
    };
        msg: "A_nullArgument: Required argument is null"
    };
        msg: "E_listMPNotCreated: ListMP not created"
    };
        msg: "E_versionMismatch: IPC Module version mismatch: creator: %d, opener: %d"
    };
 
 
 
enum SysLink.NotifyType

Enumeration of Client notifyMgr notification types.

XDCscript usage meta-domain
values of type SysLink.NotifyType
    const SysLink.NOTIFICATION_NONE;
    const SysLink.NOTIFICATION_ALWAYS;
    const SysLink.NOTIFICATION_ONCE;
    const SysLink.NOTIFICATION_HDWRFIFO_ALWAYS;
    const SysLink.NOTIFICATION_HDWRFIFO_ONCE;
 
VALUES
NOTIFICATION_NONE — No notification required.
NOTIFICATION_ALWAYS — Notify whenever the other client sends data/frees up space.
NOTIFICATION_ONCE — Notify when the other side sends data/frees up buffer. Once the notification is done, the notification is disabled until it is enabled again.
NOTIFICATION_HDWRFIFO_ALWAYS — Notify whenever the other side sends data/frees up space. This notification is never disabled.
NOTIFICATION_HDWRFIFO_ONCE — Notify when the other side sends data/frees up buffer. Once the notification is done, the notification is disabled until it is enabled again. The notification is enabled once the watermark is crossed and does not require buffer to get full/empty..
C SYNOPSIS
 
config SysLink.A_addrNotCacheAligned  // module-wide

Error raised when an address is not cache-aligned

XDCscript usage meta-domain
SysLink.A_addrNotCacheAligned = Assert.Desc {
    msg: "A_addrNotCacheAligned: Address is not cache aligned"
};
 
C SYNOPSIS
 
config SysLink.A_invSemNum  // module-wide

Assert raised by GateSpinLock delegate when provided semNum is invalid

XDCscript usage meta-domain
SysLink.A_invSemNum = Assert.Desc {
    msg: "A_invSemNum: Invalid hardware semaphore number"
};
 
C SYNOPSIS
 
config SysLink.A_invSize  // module-wide

Assert raised when sharedAddrSize is too small

XDCscript usage meta-domain
SysLink.A_invSize = Assert.Desc {
    msg: "A_invSize: Invalid sharedAddrSize"
};
 
C SYNOPSIS
 
config SysLink.A_invSpinLockNum  // module-wide

Assert raised by GateSpinLock delegate when provided lockNum is invalid

XDCscript usage meta-domain
SysLink.A_invSpinLockNum = Assert.Desc {
    msg: "A_invSemNum: Invalid hardware spinlock number"
};
 
C SYNOPSIS
 
config SysLink.A_nullArgument  // module-wide

Assert raised when a required argument is null

XDCscript usage meta-domain
SysLink.A_nullArgument = Assert.Desc {
    msg: "A_nullArgument: Required argument is null"
};
 
C SYNOPSIS
 
config SysLink.E_listMPNotCreated  // module-wide

Error raised in ti.sdo.ipc.ListMP.open when the ListMP has not been created yet

XDCscript usage meta-domain
SysLink.E_listMPNotCreated = Error.Desc {
    msg: "E_listMPNotCreated: ListMP not created"
};
 
C SYNOPSIS
 
config SysLink.E_versionMismatch  // module-wide

Error raised in an open call because there is a version mismatch between the opener and the creator

XDCscript usage meta-domain
SysLink.E_versionMismatch = Error.Desc {
    msg: "E_versionMismatch: IPC Module version mismatch: creator: %d, opener: %d"
};
 
C SYNOPSIS
 
config SysLink.cacheSize  // module-wide

Worse-case cache size

XDCscript usage meta-domain
SysLink.cacheSize = Int 128;
 
DETAILS
This is used by the IPC modules to determine the cache size. When IPC modules place things in shared memory, this value is used to make sure items are on a cache boundary and are a multiple of the size.
C SYNOPSIS
 
metaonly config SysLink.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
SysLink.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 Tue, 26 Jul 2011 23:22:40 GMT