133 #ifndef ti_ipc_MessageQ__include
134 #define ti_ipc_MessageQ__include
138 #if defined (__cplusplus)
150 #define MessageQ_S_BUSY (2)
155 #define MessageQ_S_ALREADYSETUP (1)
160 #define MessageQ_S_SUCCESS (0)
165 #define MessageQ_E_FAIL (-1)
170 #define MessageQ_E_INVALIDARG (-2)
175 #define MessageQ_E_MEMORY (-3)
180 #define MessageQ_E_ALREADYEXISTS (-4)
185 #define MessageQ_E_NOTFOUND (-5)
190 #define MessageQ_E_TIMEOUT (-6)
195 #define MessageQ_E_INVALIDSTATE (-7)
200 #define MessageQ_E_OSFAILURE (-8)
205 #define MessageQ_E_RESOURCE (-9)
210 #define MessageQ_E_RESTART (-10)
215 #define MessageQ_E_INVALIDMSG (-11)
220 #define MessageQ_E_NOTOWNER (-12)
225 #define MessageQ_E_REMOTEACTIVE (-13)
230 #define MessageQ_E_INVALIDHEAPID (-14)
235 #define MessageQ_E_INVALIDPROCID (-15)
240 #define MessageQ_E_MAXREACHED (-16)
245 #define MessageQ_E_UNREGISTEREDHEAPID (-17)
250 #define MessageQ_E_CANNOTFREESTATICMSG (-18)
255 #define MessageQ_E_UNBLOCKED (-19)
265 #define MessageQ_FOREVER (~(0))
270 #define MessageQ_INVALIDMSGID (0xffff)
275 #define MessageQ_INVALIDMESSAGEQ (0xffff)
280 #define MessageQ_PRIORITYMASK (0x3)
292 #define MessageQ_PORTOFFSET (0x80)
319 #define MessageQ_getDstQueue(msg) \
320 (((MessageQ_Msg)(msg))->dstId == \
321 (MessageQ_QueueIndex)MessageQ_INVALIDMESSAGEQ) ? \
322 (MessageQ_QueueId)MessageQ_INVALIDMESSAGEQ : \
323 (((MessageQ_QueueId)((MessageQ_Msg)(msg))->dstProc << 16u) \
324 | (((MessageQ_Msg)(msg))->dstId))
341 #define MessageQ_getMsgId(msg) (((MessageQ_Msg) (msg))->msgId)
351 #define MessageQ_getMsgSize(msg) (((MessageQ_Msg) (msg))->msgSize)
360 #define MessageQ_getMsgPri(msg) \
361 ((((MessageQ_Msg) (msg))->flags & MessageQ_PRIORITYMASK))
373 #define MessageQ_getProcId(queueId) \
374 ((UInt16)((queueId) >> 16))
405 #define MessageQ_getQueueIndex(queueId) \
406 (((MessageQ_QueueIndex)((MessageQ_QueueId)0xFFFF & (queueId))) \
407 - MessageQ_PORTOFFSET)
426 #define MessageQ_getReplyQueue(msg) \
427 (MessageQ_QueueId)((((MessageQ_Msg) (msg))->replyProc << 16u) \
428 | ((MessageQ_Msg)(msg))->replyId)
438 #define MessageQ_getTransportId(msg) \
439 ((((MessageQ_Msg)(msg))->flags & (0x7 << 2)) >> 2)
453 #define MessageQ_setMsgId(msg, id) ((MessageQ_Msg) (msg))->msgId = (id)
461 #define MessageQ_setMsgPri(msg, priority) \
462 ((MessageQ_Msg)(msg))->flags = \
463 (((MessageQ_Msg)(msg))->flags & ~(MessageQ_PRIORITYMASK)) \
464 | ((priority) & MessageQ_PRIORITYMASK)
479 #define MessageQ_setTransportId(msg, tid) \
480 ((MessageQ_Msg)(msg))->flags = \
481 ((((MessageQ_Msg)(msg))->flags & ~(0x7 << 2)) | ((tid) << 2))
547 #define MessageQ_Params_VERSION_2 2
554 #define MessageQ_Params_VERSION MessageQ_Params_VERSION_2
633 #define MessageQ_ANY (Bits16)~(0)
656 #include <ti/ipc/interfaces/ITransport.h>
657 #include <ti/ipc/interfaces/IMessageQTransport.h>
659 #include <ti/sdo/ipc/interfaces/ITransport.h>
660 #include <ti/sdo/ipc/interfaces/IMessageQTransport.h>
664 UInt16 rprocId, UInt priority);
684 #ifndef MessageQ_internal
687 if (params != NULL) {
688 MessageQ_Params_init__S(params, MessageQ_Params_VERSION);
1051 Int
MessageQ_get(MessageQ_Handle handle, MessageQ_Msg *msg, UInt timeout);
1081 Int
MessageQ_put(MessageQ_QueueId queueId, MessageQ_Msg msg);
1155 #if defined (__cplusplus)
Int MessageQ_free(MessageQ_Msg msg)
Frees a message back to the heap.
Void(* MessageQ_PutHookFxn)(MessageQ_QueueId queueId, MessageQ_Msg msg)
Put hook function definition.
Definition: MessageQ.h:653
Int MessageQ_get(MessageQ_Handle handle, MessageQ_Msg *msg, UInt timeout)
Gets a message from the message queue.
Void MessageQ_setFreeHookFxn(MessageQ_FreeHookFxn freeHookFxn)
Sets MessageQ's free hook function.
MessageQ_Priority
Message priority.
Definition: MessageQ.h:620
Structure defining parameters for MessageQ_create().
Definition: MessageQ.h:506
Int MessageQ_delete(MessageQ_Handle *handlePtr)
Delete a created MessageQ instance.
MessageQ_Handle MessageQ_create2(String name, const MessageQ_Params2 *params)
Create a MessageQ instance using the type MessageQ_Params2.
Int MessageQ_open(String name, MessageQ_QueueId *queueId)
Open a message queue.
Void MessageQ_unregisterTransport(UInt16 rprocId, UInt priority)
Definition: MessageQ.h:624
Int MessageQ_registerHeap(Ptr heap, UInt16 heapId)
Register a heap with MessageQ.
Definition: MessageQ.h:622
Void * synchronizer
Definition: MessageQ.h:514
UInt32 MessageQ_getQueueId(MessageQ_Handle handle)
Returns the QueueId associated with the handle.
UInt16 MessageQ_QueueIndex
Local queue index.
Definition: MessageQ.h:496
MessageQ_MsgHeader * MessageQ_Msg
Typedef for ease of use.
Definition: MessageQ.h:615
Definition: MessageQ.h:621
Bool MessageQ_registerTransportId(UInt tid, ITransport_Handle inst)
Register a transport instance for the given ID.
Void(* MessageQ_FreeHookFxn)(Bits16 heapId, Bits16 msgId)
Free hook prototype.
Definition: MessageQ.h:641
struct MessageQ_Object * MessageQ_Handle
MessageQ_Handle type.
Definition: MessageQ.h:501
MessageQ_Msg MessageQ_alloc(UInt16 heapId, UInt32 size)
Allocates a message from the heap.
Int MessageQ_count(MessageQ_Handle handle)
Returns the number of messages in a message queue.
Void * synchronizer
Definition: MessageQ.h:567
Void MessageQ_setPutHookFxn(MessageQ_PutHookFxn putHookFxn)
Set the function hook for the MessageQ_put() method.
Void MessageQ_Params2_init(MessageQ_Params2 *params)
Initialize MessageQ_Params2.
Void MessageQ_unblock(MessageQ_Handle handle)
Unblocks a MessageQ.
UInt32 MessageQ_QueueId
A 32-bit value that uniquely identifies a message queue.
Definition: MessageQ.h:491
Int MessageQ_put(MessageQ_QueueId queueId, MessageQ_Msg msg)
Place a message onto a message queue.
MessageQ_QueueIndex queueIndex
Definition: MessageQ.h:576
Structure defining parameters for MessageQ_create2().
Definition: MessageQ.h:566
Void MessageQ_unregisterTransportId(UInt tid)
Unregister the transport instance for the given ID.
Int MessageQ_unregisterHeap(UInt16 heapId)
Unregister a heap with MessageQ.
MessageQ_QueueIndex queueIndex
Definition: MessageQ.h:523
Definition: MessageQ.h:623
Int MessageQ_close(MessageQ_QueueId *queueId)
Close the opened handle.
MessageQ_QueueId MessageQ_openQueueId(UInt16 queueIndex, UInt16 procId)
Opens a MessageQ given the queue index and remote processor ID.
Void MessageQ_setReplyQueue(MessageQ_Handle handle, MessageQ_Msg msg)
Embeds a source message queue into a message.
MessageQ_Handle MessageQ_create(String name, const MessageQ_Params *params)
Create a MessageQ instance.
Void MessageQ_staticMsgInit(MessageQ_Msg msg, UInt32 size)
Initializes a message not obtained from MessageQ_alloc()
Bool MessageQ_registerTransport(IMessageQTransport_Handle handle, UInt16 rprocId, UInt priority)
Void MessageQ_setMsgTrace(MessageQ_Msg msg, Bool traceFlag)
Sets the message tracing flag on a given message.