Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

msgqdefs.h File Reference

Defines data types and structures used by DSP/BIOS(tm) Link for MSGQ. More...

#include <gpptypes.h>
#include <errbase.h>

Include dependency graph for msgqdefs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  MSGQ_Attrs_tag
struct  PCPYMQT_Attrs_tag
struct  ZCPYMQT_Attrs_tag
struct  DCPYMQT_Attrs_tag
struct  MSGQ_LocateAttrs_tag
struct  MSGQ_LocateAsyncAttrs_tag
struct  MSGQ_MsgHeader_tag
struct  MSGQ_AsyncLocateMsg_tag
struct  MSGQ_AsyncErrorMsg_tag

MSGQ_Queue

This type is used for identifying a message queue across processors. ============================================================================

============================================================================

#define MSGQ_INVALIDMSGQ   (Uint16) 0xFFFFu
 This constant denotes an invalid message queue. ============================================================================.
#define MSGQ_INVALIDPROCID   (Uint16) 0xFFFFu
 This constant denotes an invalid processor ID. ============================================================================.
#define MSGQ_INTERNALIDSSTART   (Uint16) 0xFF00u
 This constant defines the start of internal MSGQ message ID range. ============================================================================.
#define MSGQ_ASYNCLOCATEMSGID   (Uint16) 0xFF00u
 This constant defines the asynchronous locate message ID. ============================================================================.
#define MSGQ_ASYNCERRORMSGID   (Uint16) 0xFF01u
 This constant defines the asynchronous error message ID. ============================================================================.
#define MSGQ_INTERNALIDSEND   (Uint16) 0xFF7fu
 This constant defines the end of internal MSGQ message ID range. ============================================================================.
#define MSGQ_MQTMSGIDSSTART   (Uint16) 0xFF80u
 This constant defines the start of transport message ID range. ============================================================================.
#define MSGQ_MQTMSGIDSEND   (Uint16) 0xFFFEu
 This constant defines the end of transport message ID range. ============================================================================.
#define MSGQ_INVALIDMSGID   (Uint16) 0xFFFFu
 This constant is used to denote no message ID value. ============================================================================.
#define MSGQ_MQTERROREXIT   (MSGQ_MqtError) -1l
 In an asynchronous error message, this value as the error type indicates that remote MQT has called exit. ============================================================================.
#define MSGQ_MQTFAILEDPUT   (MSGQ_MqtError) -2l
 In an asynchronous error message, this value as the error type indicates that the transport failed to send a message to the remote processor. ============================================================================.
#define MSG_HEADER_RESERVED_SIZE   2u
 This macro defines the size of the reserved field of message header. ============================================================================.
#define IS_VALID_MSGQ(msgq)   (msgq != MSGQ_INVALIDMSGQ)
 Is the MSGQ valid. ============================================================================.
typedef Uint32 MSGQ_Queue
 This constant denotes an invalid message queue. ============================================================================.

MQT_Interface

Forward declaration of MQT interface table. ============================================================================

============================================================================

#define MsgqMqtError   MSGQ_MqtError
#define MsgqId   MSGQ_Id
#define MsgqQueue   MSGQ_Queue
#define MsgqAttrs   MSGQ_Attrs
#define PcpyMqtAttrs   PCPYMQT_Attrs
#define ZcpyMqtAttrs   ZCPYMQT_Attrs
#define DcpyMqtAttrs   DCPYMQT_Attrs
#define MsgqLocateAttrs   MSGQ_LocateAttrs
#define MsgqLocateAsyncAttrs   MSGQ_LocateAsyncAttrs
#define MsgqMsgHeader   MSGQ_MsgHeader
#define MsgqAsyncLocateMsg   MSGQ_AsyncLocateMsg
#define MsgqAsyncErrorMsg   MSGQ_AsyncErrorMsg
#define MsgqMsg   MSGQ_Msg
#define MqtInterface   MQT_Interface
typedef MQT_Interface_tag MQT_Interface

MSGQ_MqtError

This type is used for identifying types of MQT async error messages. ============================================================================

============================================================================

typedef Int16 MSGQ_MqtError

MSGQ_Id

This type is used for identifying a message queue on a specific processor. ============================================================================

============================================================================

typedef Uint16 MSGQ_Id

MsgqPend

Defines the types for the pend function.

============================================================================

Parameters:
notifyHandle Pointer to the notification object for the message queue.
timeout Timeout Value.
Returns:
DSP_SOK Operation successfully completed. SYNC_E_FAIL General error from GPP-OS. DSP_ETIMEOUT Timeout occured while performing operation. DSP_EPOINTER Invalid pointer passed. ============================================================================


typedef DSP_STATUS(* MsgqPend )(Pvoid notifyHandle, Uint32 timeout)

MsgqPost

Defines the types for the post function.

============================================================================

Parameters:
notifyHandle Pointer to the notification object for the message queue.
Returns:
DSP_SOK Operation successfully completed. SYNC_E_FAIL General error from GPP-OS. DSP_EPOINTER Invalid pointer passed. DSP_EMEMORY Operation failed due to memory error. ============================================================================


typedef DSP_STATUS(* MsgqPost )(Pvoid notifyHandle)

MSGQ_Attrs

This structure defines the attributes required during opening of the MSGQ.

============================================================================

Parameters:
notifyHandle Pointer to the notification object for the message queue.
pend Function to be used to wait to receive a message.
post Function to be used to indicate arrival of a message. ============================================================================


typedef MSGQ_Attrs_tag MSGQ_Attrs

PCPYMQT_Attrs

This structure defines the attributes for initialization of the PCPY MQT.

============================================================================

Parameters:
poolId Pool ID used for allocating control messages. This pool is also used in case the ID within the message received from the DSP is invalid. ============================================================================


typedef PCPYMQT_Attrs_tag PCPYMQT_Attrs

ZCPYMQT_Attrs

This structure defines the attributes for initialization of the ZCPY MQT.

============================================================================

Parameters:
poolId Pool ID used for allocating control messages. ============================================================================


typedef ZCPYMQT_Attrs_tag ZCPYMQT_Attrs

DCPYMQT_Attrs

This structure defines the attributes for initialization of the DCPY MQT.

============================================================================

Parameters:
poolId Pool ID used for allocating control messages. ============================================================================


typedef DCPYMQT_Attrs_tag DCPYMQT_Attrs

MSGQ_LocateAttrs

This structure defines the attributes required during synchronous location of a MSGQ.

============================================================================

Parameters:
timeout Timeout value in milliseconds for the locate calls. ============================================================================


typedef MSGQ_LocateAttrs_tag MSGQ_LocateAttrs

MSGQ_LocateAsyncAttrs

This structure defines the attributes required during asynchronous location of a MSGQ.

============================================================================

Parameters:
poolId ID of the pool to be used for allocating async locate messages.
arg User-defined argument returned with an async locate message. ============================================================================


typedef MSGQ_LocateAsyncAttrs_tag MSGQ_LocateAsyncAttrs

MSGQ_MsgHeader

This structure defines the format of the message header that must be the first field of any message.

============================================================================

Parameters:
reserved Reserved for use by the MQT. The MQT typically uses them as a link for queuing the messages.
srcProcId Processor Id for the source message queue
poolId ID of the Pool used for allocating this message.
size Size of the message including the header.
dstId ID of the destination message queue.
srcId ID of the source message queue for reply.
msgId User-specified message ID. ============================================================================


typedef MSGQ_MsgHeader_tag MSGQ_MsgHeader

MSGQ_AsyncLocateMsg

This structure defines the asynchronous locate message format.

============================================================================

Parameters:
header Fixed message header required for all messages.
msgqQueue Reply message queue specified during MSGQ_locateAsync ().
arg User-defined argument specified as part of the MSGQ_LocateAsyncAttrs ============================================================================


typedef MSGQ_AsyncLocateMsg_tag MSGQ_AsyncLocateMsg

MSGQ_AsyncErrorMsg

This structure defines the asynchronous error message format.

============================================================================

Parameters:
header Fixed message header required for all messages.
errorType Type of error.
arg1 First argument dependent on the error type. MSGQ_MQTERROREXIT : Processor ID of the transport. MSGQ_MQTFAILEDPUT : Handle of the destination message queue on which the put failed.
arg2 Second argument dependent on the error type. MSGQ_MQTERROREXIT : Not used. MSGQ_MQTFAILEDPUT : Status of the MSGQ_put () call that failed. ============================================================================


typedef MSGQ_AsyncErrorMsg_tag MSGQ_AsyncErrorMsg

MSGQ_Msg

This is the type of any buffer used for messaging. ============================================================================

============================================================================

typedef MSGQ_MsgHeaderMSGQ_Msg

Defines

#define MSGQDEFS_H


Detailed Description

Defines data types and structures used by DSP/BIOS(tm) Link for MSGQ.

============================================================================

Path:
/db/swcoe_asp/DSPLINK_Build/dsplink_linux_1_65_00_03/dsplink/gpp/inc/usr/
Version:
1.65.00.03 ============================================================================
Copyright:
Copyright (C) 2002-2009, Texas Instruments Incorporated - http://www.ti.com/
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ============================================================================

Definition in file msgqdefs.h.


Define Documentation

#define DcpyMqtAttrs   DCPYMQT_Attrs
 

============================================================================

Deprecated:
The deprecated data structure DcpyMqtAttrs has been replaced with DCPYMQT_Attrs
============================================================================

Definition at line 482 of file msgqdefs.h.

#define IS_VALID_MSGQ msgq   )     (msgq != MSGQ_INVALIDMSGQ)
 

Is the MSGQ valid. ============================================================================.

============================================================================

Macro:
IS_VALID_MSGQ

Definition at line 189 of file msgqdefs.h.

#define MqtInterface   MQT_Interface
 

============================================================================

Deprecated:
The deprecated data structure MqtInterface has been replaced with MQT_Interface
============================================================================

Definition at line 538 of file msgqdefs.h.

#define MSG_HEADER_RESERVED_SIZE   2u
 

This macro defines the size of the reserved field of message header. ============================================================================.

============================================================================

Constant:
MSG_HEADER_RESERVED_SIZE

Definition at line 181 of file msgqdefs.h.

#define MSGQ_ASYNCERRORMSGID   (Uint16) 0xFF01u
 

This constant defines the asynchronous error message ID. ============================================================================.

============================================================================

Constant:
MSGQ_ASYNCERRORMSGID

Definition at line 122 of file msgqdefs.h.

#define MSGQ_ASYNCLOCATEMSGID   (Uint16) 0xFF00u
 

This constant defines the asynchronous locate message ID. ============================================================================.

============================================================================

Constant:
MSGQ_ASYNCLOCATEMSGID

Definition at line 114 of file msgqdefs.h.

#define MSGQ_INTERNALIDSEND   (Uint16) 0xFF7fu
 

This constant defines the end of internal MSGQ message ID range. ============================================================================.

============================================================================

Constant:
MSGQ_INTERNALIDSEND

Definition at line 130 of file msgqdefs.h.

#define MSGQ_INTERNALIDSSTART   (Uint16) 0xFF00u
 

This constant defines the start of internal MSGQ message ID range. ============================================================================.

============================================================================

Constant:
MSGQ_INTERNAL_ID_START

Definition at line 106 of file msgqdefs.h.

#define MSGQ_INVALIDMSGID   (Uint16) 0xFFFFu
 

This constant is used to denote no message ID value. ============================================================================.

============================================================================

Constant:
MSGQ_INVALIDMSGID

Definition at line 154 of file msgqdefs.h.

#define MSGQ_INVALIDMSGQ   (Uint16) 0xFFFFu
 

This constant denotes an invalid message queue. ============================================================================.

============================================================================

Constant:
MSGQ_INVALIDMSGQ

Definition at line 90 of file msgqdefs.h.

#define MSGQ_INVALIDPROCID   (Uint16) 0xFFFFu
 

This constant denotes an invalid processor ID. ============================================================================.

============================================================================

Constant:
MSGQ_INVALIDPROCID

Definition at line 98 of file msgqdefs.h.

#define MSGQ_MQTERROREXIT   (MSGQ_MqtError) -1l
 

In an asynchronous error message, this value as the error type indicates that remote MQT has called exit. ============================================================================.

============================================================================

Constant:
MSGQ_MQTERROREXIT

Definition at line 163 of file msgqdefs.h.

#define MSGQ_MQTFAILEDPUT   (MSGQ_MqtError) -2l
 

In an asynchronous error message, this value as the error type indicates that the transport failed to send a message to the remote processor. ============================================================================.

============================================================================

Constant:
MSGQ_MQTFAILEDPUT

Definition at line 173 of file msgqdefs.h.

#define MSGQ_MQTMSGIDSEND   (Uint16) 0xFFFEu
 

This constant defines the end of transport message ID range. ============================================================================.

============================================================================

Constant:
MSGQ_MQTMSGIDSEND

Definition at line 146 of file msgqdefs.h.

#define MSGQ_MQTMSGIDSSTART   (Uint16) 0xFF80u
 

This constant defines the start of transport message ID range. ============================================================================.

============================================================================

Constant:
MSGQ_MQTMSGIDSSTART

Definition at line 138 of file msgqdefs.h.

#define MsgqAsyncErrorMsg   MSGQ_AsyncErrorMsg
 

============================================================================

Deprecated:
The deprecated data structure MsgqAsyncErrorMsg has been replaced with MSGQ_AsyncErrorMsg
============================================================================

Definition at line 522 of file msgqdefs.h.

#define MsgqAsyncLocateMsg   MSGQ_AsyncLocateMsg
 

============================================================================

Deprecated:
The deprecated data structure MSGQ_AsyncLocateMsg has been replaced with MSGQ_AsyncLocateMsg
============================================================================

Definition at line 514 of file msgqdefs.h.

#define MsgqAttrs   MSGQ_Attrs
 

============================================================================

Deprecated:
The deprecated data structure MsgqAttrs has been replaced with MSGQ_Attrs
============================================================================

Definition at line 458 of file msgqdefs.h.

#define MSGQDEFS_H
 

Definition at line 45 of file msgqdefs.h.

#define MsgqId   MSGQ_Id
 

============================================================================

Deprecated:
The deprecated data structure MsgqId has been replaced with MSGQ_Id
============================================================================

Definition at line 442 of file msgqdefs.h.

#define MsgqLocateAsyncAttrs   MSGQ_LocateAsyncAttrs
 

============================================================================

Deprecated:
The deprecated data structure MSGQ_LocateAsyncAttrs has been replaced with MSGQ_LocateAsyncAttrs
============================================================================

Definition at line 498 of file msgqdefs.h.

#define MsgqLocateAttrs   MSGQ_LocateAttrs
 

============================================================================

Deprecated:
The deprecated data structure MSGQ_LocateAttrs has been replaced with MSGQ_LocateAttrs
============================================================================

Definition at line 490 of file msgqdefs.h.

#define MsgqMqtError   MSGQ_MqtError
 

============================================================================

Deprecated:
The deprecated data structure MsgqMqtError has been replaced with MSGQ_MqtError
============================================================================

Definition at line 434 of file msgqdefs.h.

#define MsgqMsg   MSGQ_Msg
 

============================================================================

Deprecated:
The deprecated data structure MsgqMsg has been replaced with MSGQ_Msg
============================================================================

Definition at line 530 of file msgqdefs.h.

#define MsgqMsgHeader   MSGQ_MsgHeader
 

============================================================================

Deprecated:
The deprecated data structure MsgqMsgHeader has been replaced with MSGQ_MsgHeader
============================================================================

Definition at line 506 of file msgqdefs.h.

#define MsgqQueue   MSGQ_Queue
 

============================================================================

Deprecated:
The deprecated data structure MsgqQueue has been replaced with MSGQ_Queue
============================================================================

Definition at line 450 of file msgqdefs.h.

#define PcpyMqtAttrs   PCPYMQT_Attrs
 

============================================================================

Deprecated:
The deprecated data structure PcpyMqtAttrs has been replaced with PCPYMQT_Attrs
============================================================================

Definition at line 466 of file msgqdefs.h.

#define ZcpyMqtAttrs   ZCPYMQT_Attrs
 

============================================================================

Deprecated:
The deprecated data structure ZcpyMqtAttrs has been replaced with ZCPYMQT_Attrs
============================================================================

Definition at line 474 of file msgqdefs.h.


Typedef Documentation

typedef struct DCPYMQT_Attrs_tag DCPYMQT_Attrs
 

typedef struct MQT_Interface_tag MQT_Interface
 

============================================================================

Deprecated:
The deprecated data structure MsgqMqtError has been replaced with MSGQ_MqtError
============================================================================

Definition at line 425 of file msgqdefs.h.

typedef struct MSGQ_AsyncErrorMsg_tag MSGQ_AsyncErrorMsg
 

typedef struct MSGQ_AsyncLocateMsg_tag MSGQ_AsyncLocateMsg
 

typedef struct MSGQ_Attrs_tag MSGQ_Attrs
 

typedef Uint16 MSGQ_Id
 

Definition at line 73 of file msgqdefs.h.

typedef struct MSGQ_LocateAsyncAttrs_tag MSGQ_LocateAsyncAttrs
 

typedef struct MSGQ_LocateAttrs_tag MSGQ_LocateAttrs
 

typedef Int16 MSGQ_MqtError
 

Definition at line 64 of file msgqdefs.h.

typedef MSGQ_MsgHeader* MSGQ_Msg
 

Definition at line 417 of file msgqdefs.h.

typedef struct MSGQ_MsgHeader_tag MSGQ_MsgHeader
 

typedef Uint32 MSGQ_Queue
 

This constant denotes an invalid message queue. ============================================================================.

============================================================================

Constant:
MSGQ_INVALIDMSGQ

Definition at line 81 of file msgqdefs.h.

typedef DSP_STATUS(* MsgqPend)(Pvoid notifyHandle, Uint32 timeout)
 

Definition at line 212 of file msgqdefs.h.

typedef DSP_STATUS(* MsgqPost)(Pvoid notifyHandle)
 

Definition at line 233 of file msgqdefs.h.

typedef struct PCPYMQT_Attrs_tag PCPYMQT_Attrs
 

typedef struct ZCPYMQT_Attrs_tag ZCPYMQT_Attrs
 


Generated on Fri Jul 16 14:34:08 2010 for DSP/BIOSLink by  doxygen 1.4.4