#include <mpcs.h>
Include dependency graph for dsp/inc/ringiodefs.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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | GET_ENTRY_ID(client) ((client)->virtControlHandle->entryId) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gets the entry id of the RingIO ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | GET_LOCK_POOL_ID(entryId) (RingIO_ctrlPtr->entry [entryId].lockPoolId) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gets the pool id from which the MPCS lock object structure has been allocated. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | GET_CTRL_POOL_ID(entryId) (RingIO_ctrlPtr->entry [entryId].ctrlPoolId) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gets the pool id from which the RingIO control structure has been validated. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | GET_DATA_POOL_ID(entryId) (RingIO_ctrlPtr->entry [entryId].dataPoolId) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gets the pool id from which the RingIO data buffer has been allocated. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | GET_ATTR_POOL_ID(entryId) (RingIO_ctrlPtr->entry [entryId].attrPoolId) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gets the pool id from which the RingIO attr buffer has been allocated. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | IS_WRITER(client) ((client)->openMode == RINGIO_MODE_WRITE) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Check if client is a writer. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | IS_READER(client) ((client)->openMode == RINGIO_MODE_READ) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Check if client is a reader. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | GET_CUR_ATTR_END(control) ((control)->curAttrBufEnd + 1) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Current attr buffer end. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | GET_CUR_DATA_END(control) ((control)->curBufEnd + 1) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Current data buffer end. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | ADJUST_MODULO(start, size, bufSize) (((start) + (size)) % bufSize) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Modulo operation ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | SIZEOF_ATTR(size) (sizeof (RingIO_Attr) + (size)) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Size of RingIO attributes ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typedef RingIO_Ctrl_tag | RingIO_Ctrl | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gets the entry id of the RingIO ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RingIO_Handle | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This type is used for the handle to the RingIO Client structure. ============================================================================
============================================================================ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typedef Ptr | RingIO_Handle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RingIO_ControlHandle | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This type is used for the handle to the Shared Control structure. ============================================================================
============================================================================ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typedef RingIO_ControlStruct_tag * | RingIO_ControlHandle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RingIO_BufPtr | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This type is used for the Buffer Pointer Type. ============================================================================
============================================================================ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typedef Ptr | RingIO_BufPtr | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RingIO_NotifyParam | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This type is used for the Notification Parameter. ============================================================================
============================================================================ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typedef Ptr | 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 RingIO_Attrs_tag | RingIO_Attrs | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RingIO_ControlStruct | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Forward declaration of RingIO_ControlStruct. ============================================================================
============================================================================ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typedef 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 RingIO_Client_tag | RingIO_Client | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RingIO_Entry | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Entry structure for the RingIO data transport ============================================================================
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typedef RingIO_Entry_tag | RingIO_Entry | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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_OpenMode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration of RingIO open modes. ============================================================================
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enum | RingIO_OpenMode { RINGIO_MODE_READ = 0, RINGIO_MODE_WRITE } | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RingIO_TransportType | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumeration of RingIO transport types. ============================================================================
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enum | RingIO_TransportType { RINGIO_TRANSPORT_DSP_DSP = 1, RINGIO_TRANSPORT_GPP_DSP } | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Defines | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIODEFS_H | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_SUCCESS (SYS_OK) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_BASE (SYS_EUSER) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_SPENDINGATTRIBUTE (RINGIO_BASE + 0x1) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_EFAILURE (RINGIO_BASE + 0x2) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_EBUFWRAP (RINGIO_BASE + 0x3) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_EBUFEMPTY (RINGIO_BASE + 0x4) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_EBUFFULL (RINGIO_BASE + 0x5) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_EPENDINGDATA (RINGIO_BASE + 0x6) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_EVARIABLEATTRIBUTE (RINGIO_BASE + 0x7) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_EALREADYEXISTS (RINGIO_BASE + 0x8) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_ENOTCONTIGUOUSDATA (RINGIO_BASE + 0x9) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_EWRONGSTATE (RINGIO_BASE + 0xA) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_NAME_MAX_LEN DSP_MAX_STRLEN | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Maximum length of RingIO strings. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_INVALID_ATTR (Uint16) 0xFFFF | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_DATABUF_CACHEUSE 0x1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
These constants denote the flags provided while opening the RingIO. ============================================================================. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_ATTRBUF_CACHEUSE 0x2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_CONTROL_CACHEUSE 0x4 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#define | RINGIO_NEED_EXACT_SIZE 0x8 |
|
Modulo operation ============================================================================. ============================================================================
Definition at line 625 of file dsp/inc/ringiodefs.h. |
|
Gets the pool id from which the RingIO attr buffer has been allocated. ============================================================================. ============================================================================
Definition at line 585 of file dsp/inc/ringiodefs.h. |
|
Gets the pool id from which the RingIO control structure has been validated. ============================================================================. ============================================================================
Definition at line 567 of file dsp/inc/ringiodefs.h. |
|
Get Current attr buffer end. ============================================================================. ============================================================================
Definition at line 609 of file dsp/inc/ringiodefs.h. |
|
Get Current data buffer end. ============================================================================. ============================================================================
Definition at line 617 of file dsp/inc/ringiodefs.h. |
|
Gets the pool id from which the RingIO data buffer has been allocated. ============================================================================. ============================================================================
Definition at line 576 of file dsp/inc/ringiodefs.h. |
|
Gets the entry id of the RingIO ============================================================================. ============================================================================
Definition at line 549 of file dsp/inc/ringiodefs.h. |
|
Gets the pool id from which the MPCS lock object structure has been allocated. ============================================================================. ============================================================================
Definition at line 558 of file dsp/inc/ringiodefs.h. |
|
Check if client is a reader. ============================================================================. ============================================================================
Definition at line 601 of file dsp/inc/ringiodefs.h. |
|
Check if client is a writer. ============================================================================. ============================================================================
Definition at line 593 of file dsp/inc/ringiodefs.h. |
|
Definition at line 123 of file dsp/inc/ringiodefs.h. |
|
Definition at line 58 of file dsp/inc/ringiodefs.h. |
|
Definition at line 124 of file dsp/inc/ringiodefs.h. |
|
These constants denote the flags provided while opening the RingIO. ============================================================================. ============================================================================
Definition at line 122 of file dsp/inc/ringiodefs.h. |
|
Definition at line 88 of file dsp/inc/ringiodefs.h. |
|
Definition at line 74 of file dsp/inc/ringiodefs.h. |
|
Definition at line 77 of file dsp/inc/ringiodefs.h. |
|
Definition at line 71 of file dsp/inc/ringiodefs.h. |
|
Definition at line 67 of file dsp/inc/ringiodefs.h. |
|
Definition at line 93 of file dsp/inc/ringiodefs.h. |
|
Definition at line 81 of file dsp/inc/ringiodefs.h. |
|
Definition at line 85 of file dsp/inc/ringiodefs.h. |
|
Definition at line 96 of file dsp/inc/ringiodefs.h. |
|
Definition at line 113 of file dsp/inc/ringiodefs.h. |
|
Maximum length of RingIO strings. ============================================================================. ============================================================================
Definition at line 104 of file dsp/inc/ringiodefs.h. |
|
Definition at line 125 of file dsp/inc/ringiodefs.h. |
|
Definition at line 64 of file dsp/inc/ringiodefs.h. |
|
Definition at line 57 of file dsp/inc/ringiodefs.h. |
|
Definition at line 44 of file dsp/inc/ringiodefs.h. |
|
Size of RingIO attributes ============================================================================. ============================================================================
Definition at line 633 of file dsp/inc/ringiodefs.h. |
|
|
|
Definition at line 214 of file dsp/inc/ringiodefs.h. |
|
|
|
Definition at line 206 of file dsp/inc/ringiodefs.h. |
|
Definition at line 293 of file dsp/inc/ringiodefs.h. |
|
Gets the entry id of the RingIO ============================================================================. ============================================================================
|
|
|
|
Definition at line 198 of file dsp/inc/ringiodefs.h. |
|
Definition at line 247 of file dsp/inc/ringiodefs.h. |
|
Definition at line 230 of file dsp/inc/ringiodefs.h. |
|
Definition at line 222 of file dsp/inc/ringiodefs.h. |
|
Definition at line 151 of file dsp/inc/ringiodefs.h. 00151 { 00152 RINGIO_NOTIFICATION_NONE = 0, 00153 RINGIO_NOTIFICATION_ALWAYS, 00154 RINGIO_NOTIFICATION_ONCE, 00155 RINGIO_NOTIFICATION_HDWRFIFO_ALWAYS, 00156 RINGIO_NOTIFICATION_HDWRFIFO_ONCE 00157 } RingIO_NotifyType ;
|
|
Definition at line 170 of file dsp/inc/ringiodefs.h. 00170 { 00171 RINGIO_MODE_READ = 0, 00172 RINGIO_MODE_WRITE 00173 } RingIO_OpenMode ;
|
|
Definition at line 186 of file dsp/inc/ringiodefs.h. 00186 { 00187 RINGIO_TRANSPORT_DSP_DSP = 1, 00188 RINGIO_TRANSPORT_GPP_DSP 00189 } RingIO_TransportType ;
|