SysLink.h File Reference

---

Detailed Description

This module contains common definitions, types, structures and functions used by SysLink.

Go to the source code of this file.

Data Structures
struct	SysLink_MemEntry_tag
	Structure for memEntry. More...
struct	SysLink_MemEntry_Block_tag
	Structure for memEntry block for one core. More...
struct	SysLink_MemoryMap_tag
	Structure for memEntry block for one core. More...
Defines
#define	IPC_BUFFER_ALIGN(x, y)   (UInt32)((UInt32)((x + y - 1) / y) * y)
#define	SYSLINK_MAX_MEMENTRIES   10
	Signifies maximum number of mem entries for each core for one platform.
#define	SYSLINK_MAX_NAMELENGTH   32
	Max name length.
#define	SysLink_MASTERKNLVIRT   (SysLink_MapMask)(1 << 0)
	Kernel Virtual address on master processor.
#define	SysLink_MASTERUSRVIRT   (SysLink_MapMask)(1 << 1)
	User Virtual address on master processor.
#define	SysLink_SLAVEVIRT   (SysLink_MapMask)(1 << 2)
	Virtual address on slave processor.
Typedefs
typedef UInt32	SysLink_MapMask
typedef enum SysLink_NotifyType_tag	SysLink_NotifyType
	Enumeration of Client notifyMgr notification types.
typedef struct SysLink_MemEntry_tag	SysLink_MemEntry
	Structure for memEntry.
typedef struct SysLink_MemEntry_Block_tag	SysLink_MemEntry_Block
	Structure for memEntry block for one core.
typedef struct SysLink_MemoryMap_tag	SysLink_MemoryMap
	Structure for memEntry block for one core.
Enumerations
enum	SysLink_NotifyType_tag {   SysLink_NOTIFICATION_NONE = 0,   SysLink_NOTIFICATION_ALWAYS = 1,   SysLink_NOTIFICATION_ONCE = 2,   SysLink_NOTIFICATION_HDWRFIFO_ALWAYS = 3,   SysLink_NOTIFICATION_HDWRFIFO_ONCE = 4 }
	Enumeration of Client notifyMgr notification types. More...
Functions
Void	SysLink_setup (Void)
	Function to initialize SysLink.
Void	SysLink_destroy (Void)
	Function to finalize SysLink.
Variables
String	SysLink_params

---

Define Documentation

#define IPC_BUFFER_ALIGN	(		x,
			y
	)		(UInt32)((UInt32)((x + y - 1) / y) * y)

============================================================================ IPC_BUFFER_ALIGN

Macro to align a number. x: The number to be aligned y: The value that the number should be aligned to. ============================================================================

#define SYSLINK_MAX_MEMENTRIES   10

Signifies maximum number of mem entries for each core for one platform.

#define SYSLINK_MAX_NAMELENGTH   32

Max name length.

#define SysLink_MASTERKNLVIRT   (SysLink_MapMask)(1 << 0)

Kernel Virtual address on master processor.

#define SysLink_MASTERUSRVIRT   (SysLink_MapMask)(1 << 1)

User Virtual address on master processor.

#define SysLink_SLAVEVIRT   (SysLink_MapMask)(1 << 2)

Virtual address on slave processor.

---

Typedef Documentation

typedef UInt32 SysLink_MapMask

typedef enum SysLink_NotifyType_tag SysLink_NotifyType

Enumeration of Client notifyMgr notification types.

typedef struct SysLink_MemEntry_tag SysLink_MemEntry

Structure for memEntry.

typedef struct SysLink_MemEntry_Block_tag SysLink_MemEntry_Block

Structure for memEntry block for one core.

typedef struct SysLink_MemoryMap_tag SysLink_MemoryMap

Structure for memEntry block for one core.

---

Enumeration Type Documentation

enum SysLink_NotifyType_tag

Enumeration of Client notifyMgr notification types.

Enumerator:

SysLink_NOTIFICATION_NONE	No notification required
SysLink_NOTIFICATION_ALWAYS	Notify whenever the other client sends data/frees up space.
SysLink_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.
SysLink_NOTIFICATION_HDWRFIFO_ALWAYS	Notify whenever the other side sends data/frees up space. This notification is never disabled.
SysLink_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.

---

Function Documentation

Void SysLink_setup

(

Void

)

Function to initialize SysLink.

This function must be called in every user process before making calls to any other SysLink APIs.

See also:

SysLink_destroy()

Void SysLink_destroy

(

Void

)

Function to finalize SysLink.

This function must be called in every user process at the end after all usage of SysLink in that process is complete.

See also:

SysLink_setup()

---

Variable Documentation

String SysLink_params