#include <dsplink.h>
#include <archdefs.h>
#include <mpcsdefs.h>
Go to the source code of this file.
Data Structures | |||||||||||||||||||||||||||||||||||||||||||
struct | RingIO_Attrs_tag | ||||||||||||||||||||||||||||||||||||||||||
struct | RingIO_Client_tag | ||||||||||||||||||||||||||||||||||||||||||
struct | RingIO_ControlStruct_tag | ||||||||||||||||||||||||||||||||||||||||||
struct | RingIO_Entry_tag | ||||||||||||||||||||||||||||||||||||||||||
struct | RingIO_Ctrl_tag | ||||||||||||||||||||||||||||||||||||||||||
Defines | |||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_INVALID_ATTR (Uint16) 0xFFFFl | ||||||||||||||||||||||||||||||||||||||||||
This constant denotes an invalid attribute type. This should not be used for any valid attribute. ============================================================================. | |||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_DATABUF_CACHEUSE 0x1u | ||||||||||||||||||||||||||||||||||||||||||
These constants denote the flags provided while opening the RingIO. ============================================================================. | |||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_ATTRBUF_CACHEUSE 0x2u | ||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_CONTROL_CACHEUSE 0x4u | ||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_NEED_EXACT_SIZE 0x8u | ||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_NAME_MAX_LEN 32u | ||||||||||||||||||||||||||||||||||||||||||
Maximum length of RingIO strings. ============================================================================. | |||||||||||||||||||||||||||||||||||||||||||
Typedefs | |||||||||||||||||||||||||||||||||||||||||||
RingIO_Handle | |||||||||||||||||||||||||||||||||||||||||||
This type is used for the handle to the RingIO Client structure. ============================================================================ ============================================================================ | |||||||||||||||||||||||||||||||||||||||||||
typedef void * | RingIO_Handle | ||||||||||||||||||||||||||||||||||||||||||
RingIO_ControlHandle | |||||||||||||||||||||||||||||||||||||||||||
This type is used for the handle to the Shared Control structure. ============================================================================ ============================================================================ | |||||||||||||||||||||||||||||||||||||||||||
typedef struct RingIO_ControlStruct_tag * | RingIO_ControlHandle | ||||||||||||||||||||||||||||||||||||||||||
RingIO_BufPtr | |||||||||||||||||||||||||||||||||||||||||||
This type is used for the Buffer Pointer Type. ============================================================================ ============================================================================ | |||||||||||||||||||||||||||||||||||||||||||
typedef void * | RingIO_BufPtr | ||||||||||||||||||||||||||||||||||||||||||
RingIO_NotifyParam | |||||||||||||||||||||||||||||||||||||||||||
This type is used for the Notification Parameter. ============================================================================ ============================================================================ | |||||||||||||||||||||||||||||||||||||||||||
typedef void * | RingIO_NotifyParam | ||||||||||||||||||||||||||||||||||||||||||
RingIO_NotifyMsg | |||||||||||||||||||||||||||||||||||||||||||
This type is used for the Notification Message. ============================================================================ ============================================================================ | |||||||||||||||||||||||||||||||||||||||||||
typedef Uint16 | RingIO_NotifyMsg | ||||||||||||||||||||||||||||||||||||||||||
RingIO_NotifyFunc | |||||||||||||||||||||||||||||||||||||||||||
Signature of function used as the Notification function. ============================================================================
| |||||||||||||||||||||||||||||||||||||||||||
typedef void(* | RingIO_NotifyFunc )(RingIO_Handle handle, RingIO_NotifyParam param, RingIO_NotifyMsg msg) | ||||||||||||||||||||||||||||||||||||||||||
RingIO_Attrs | |||||||||||||||||||||||||||||||||||||||||||
This structure defines the RingIO Creation Parameters. ============================================================================
| |||||||||||||||||||||||||||||||||||||||||||
typedef struct RingIO_Attrs_tag | RingIO_Attrs | ||||||||||||||||||||||||||||||||||||||||||
RingIO_ControlStruct | |||||||||||||||||||||||||||||||||||||||||||
This structure defines the RingIO Control Structure. This structure is stored in shared memory and is accessible by all clients. The control structure supports a single reader and a single writer for the ring buffer. ============================================================================
| |||||||||||||||||||||||||||||||||||||||||||
typedef struct RingIO_ControlStruct_tag | RingIO_ControlStruct | ||||||||||||||||||||||||||||||||||||||||||
RingIO_Client | |||||||||||||||||||||||||||||||||||||||||||
This structure defines the RingIO Shared memory client structure. The RingIO Reader or Writer state information is stored in this structure ============================================================================
| |||||||||||||||||||||||||||||||||||||||||||
typedef struct RingIO_Client_tag | RingIO_Client | ||||||||||||||||||||||||||||||||||||||||||
RingIO_Entry | |||||||||||||||||||||||||||||||||||||||||||
Entry structure for the RingIO data transport ============================================================================
| |||||||||||||||||||||||||||||||||||||||||||
typedef struct RingIO_Entry_tag | RingIO_Entry | ||||||||||||||||||||||||||||||||||||||||||
Enumerations | |||||||||||||||||||||||||||||||||||||||||||
RingIO_OpenMode | |||||||||||||||||||||||||||||||||||||||||||
Enumeration of RingIO open modes. ============================================================================
| |||||||||||||||||||||||||||||||||||||||||||
enum | RingIO_OpenMode { RINGIO_MODE_READ = 0, RINGIO_MODE_WRITE, RINGIO_MODE_READ = 0u, RINGIO_MODE_WRITE } | ||||||||||||||||||||||||||||||||||||||||||
RingIO_TransportType | |||||||||||||||||||||||||||||||||||||||||||
Enumeration of RingIO transport types. ============================================================================
| |||||||||||||||||||||||||||||||||||||||||||
enum | RingIO_TransportType { RINGIO_TRANSPORT_DSP_DSP = 1, RINGIO_TRANSPORT_GPP_DSP, RINGIO_TRANSPORT_DSP_DSP = 1u, RINGIO_TRANSPORT_GPP_DSP } | ||||||||||||||||||||||||||||||||||||||||||
RingIO_NotifyType | |||||||||||||||||||||||||||||||||||||||||||
Enumeration of RingIO notification types. ============================================================================
============================================================================ | |||||||||||||||||||||||||||||||||||||||||||
enum | RingIO_NotifyType { RINGIO_NOTIFICATION_NONE = 0, RINGIO_NOTIFICATION_ALWAYS, RINGIO_NOTIFICATION_ONCE, RINGIO_NOTIFICATION_HDWRFIFO_ALWAYS, RINGIO_NOTIFICATION_HDWRFIFO_ONCE, RINGIO_NOTIFICATION_NONE = 0u, RINGIO_NOTIFICATION_ALWAYS, RINGIO_NOTIFICATION_ONCE, RINGIO_NOTIFICATION_HDWRFIFO_ALWAYS, RINGIO_NOTIFICATION_HDWRFIFO_ONCE } | ||||||||||||||||||||||||||||||||||||||||||
RingIO_Ctrl | |||||||||||||||||||||||||||||||||||||||||||
This structure defines the control structure required by the RINGIO component. It contains information about all RINGIO objects shared between the GPP and a specific DSP. ============================================================================
| |||||||||||||||||||||||||||||||||||||||||||
#define | RingIOEntry RingIO_Entry | ||||||||||||||||||||||||||||||||||||||||||
#define | RingIORegion RingIO_Ctrl | ||||||||||||||||||||||||||||||||||||||||||
#define | RingIO_SendNotify RingIO_sendNotify | ||||||||||||||||||||||||||||||||||||||||||
typedef struct RingIO_Ctrl_tag | RingIO_Ctrl |
#define RINGIO_INVALID_ATTR (Uint16) 0xFFFFl |
This constant denotes an invalid attribute type. This should not be used for any valid attribute. ============================================================================.
============================================================================
#define RINGIO_DATABUF_CACHEUSE 0x1u |
These constants denote the flags provided while opening the RingIO. ============================================================================.
============================================================================
#define RINGIO_ATTRBUF_CACHEUSE 0x2u |
#define RINGIO_CONTROL_CACHEUSE 0x4u |
#define RINGIO_NEED_EXACT_SIZE 0x8u |
#define RINGIO_NAME_MAX_LEN 32u |
Maximum length of RingIO strings. ============================================================================.
============================================================================
#define RingIOEntry RingIO_Entry |
============================================================================
============================================================================
#define RingIORegion RingIO_Ctrl |
============================================================================
============================================================================
#define RingIO_SendNotify RingIO_sendNotify |
============================================================================
============================================================================
typedef void* RingIO_Handle |
typedef struct RingIO_ControlStruct_tag* RingIO_ControlHandle |
typedef void* RingIO_BufPtr |
typedef void* RingIO_NotifyParam |
typedef Uint16 RingIO_NotifyMsg |
typedef void(* RingIO_NotifyFunc)(RingIO_Handle handle, RingIO_NotifyParam param, RingIO_NotifyMsg msg) |
typedef struct RingIO_Attrs_tag RingIO_Attrs |
typedef struct RingIO_ControlStruct_tag RingIO_ControlStruct |
typedef struct RingIO_Client_tag RingIO_Client |
typedef struct RingIO_Entry_tag RingIO_Entry |
typedef struct RingIO_Ctrl_tag RingIO_Ctrl |
enum RingIO_OpenMode |
enum RingIO_TransportType |
enum RingIO_NotifyType |