00001 /** ============================================================================ 00002 * @file msgq.h 00003 * 00004 * @path $(DSPLINK)/gpp/inc/usr/ 00005 * 00006 * @brief Defines the interfaces and data structures for the API sub-component 00007 * MSGQ. 00008 * 00009 * @ver 1.65.00.03 00010 * ============================================================================ 00011 * @copyright Copyright (C) 2002-2009, Texas Instruments Incorporated - 00012 * http://www.ti.com/ 00013 * 00014 * Redistribution and use in source and binary forms, with or without 00015 * modification, are permitted provided that the following conditions 00016 * are met: 00017 * 00018 * * Redistributions of source code must retain the above copyright 00019 * notice, this list of conditions and the following disclaimer. 00020 * 00021 * * Redistributions in binary form must reproduce the above copyright 00022 * notice, this list of conditions and the following disclaimer in the 00023 * documentation and/or other materials provided with the distribution. 00024 * 00025 * * Neither the name of Texas Instruments Incorporated nor the names of 00026 * its contributors may be used to endorse or promote products derived 00027 * from this software without specific prior written permission. 00028 * 00029 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00030 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 00031 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00032 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 00033 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00034 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 00035 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 00036 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 00037 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 00038 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 00039 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00040 * ============================================================================ 00041 */ 00042 00043 00044 #if !defined (MSGQ_H) 00045 #define MSGQ_H 00046 00047 00048 /* ----------------------------------- DSP/BIOS Link */ 00049 #include <dsplink.h> 00050 #include <msgqdefs.h> 00051 00052 /* ----------------------------------- Profiling */ 00053 #if defined (DDSP_PROFILE) 00054 #include <profile.h> 00055 #endif /* #if defined (DDSP_PROFILE) */ 00056 00057 00058 #if defined (__cplusplus) 00059 extern "C" { 00060 #endif /* defined (__cplusplus) */ 00061 00062 00063 /** ============================================================================ 00064 * @macro MSGQ_getMsgId 00065 * 00066 * @brief This macro returns the message ID of the specified message. 00067 * ============================================================================ 00068 */ 00069 #define MSGQ_getMsgId(msg) (((MSGQ_Msg) (msg))->msgId) 00070 00071 /** ============================================================================ 00072 * @macro MSGQ_getMsgSize 00073 * 00074 * @brief This macro returns the size of the specified message. 00075 * ============================================================================ 00076 */ 00077 #define MSGQ_getMsgSize(msg) (((MSGQ_Msg) (msg))->size) 00078 00079 /** ============================================================================ 00080 * @macro MSGQ_setMsgId 00081 * 00082 * @brief This macro sets the message ID in the specified message. 00083 * ============================================================================ 00084 */ 00085 #define MSGQ_setMsgId(msg, id) ((MSGQ_Msg) (msg))->msgId = id 00086 00087 /** ============================================================================ 00088 * @macro MSGQ_getDstQueue 00089 * 00090 * @brief This macro returns the MSGQ_Queue handle of the destination message 00091 * queue for the specified message. 00092 * ============================================================================ 00093 */ 00094 #define MSGQ_getDstQueue(msg) ((Uint32) ID_GPP << 16u) | ((MSGQ_Msg) (msg))->dstId 00095 00096 /** ============================================================================ 00097 * @macro MSGQ_setSrcQueue 00098 * 00099 * @brief This macro sets the source message queue in the specified message. 00100 * ============================================================================ 00101 */ 00102 #define MSGQ_setSrcQueue(msg, msgq) ((MSGQ_Msg) (msg))->srcId = (MSGQ_Id) msgq ; \ 00103 ((MSGQ_Msg) (msg))->srcProcId = (Uint16) \ 00104 (msgq >> 16u) 00105 00106 /** ============================================================================ 00107 * @macro MSGQ_isLocalQueue 00108 * 00109 * @brief This macro checks whether the specified queue is a local queue. 00110 * ============================================================================ 00111 */ 00112 #define MSGQ_isLocalQueue(msgq) ((msgq >> 16u) == ID_GPP) 00113 00114 00115 /** ============================================================================ 00116 * @func MSGQ_transportOpen 00117 * 00118 * @brief This function initializes the transport associated with the 00119 * specified processor. The transport corresponding to the processor ID 00120 * specified in the call should be configured in the CFG. This function 00121 * should be called only once as part of system initialization after 00122 * the client has called PROC_Attach the first time. Subsequent 00123 * tasks / threads should not call this function again as it would 00124 * result in unpredictable behavior. 00125 * 00126 * @param procId 00127 * ID of the Processor for which the transport is to be opened. 00128 * @param attrs 00129 * Attributes for initialization of the transport. 00130 * The structure of the expected attributes is specific to a 00131 * transport. 00132 * 00133 * @return DSP_SOK 00134 * Operation successfully completed. 00135 * DSP_SALREADYOPENED 00136 * The MSGQ transport for the specified processor has already been 00137 * opened. 00138 * DSP_EATTACHED 00139 * This process has not attached to the specified processor. 00140 * DSP_EMEMORY 00141 * Operation failed due to memory error. 00142 * DSP_EINVALIDARG 00143 * Invalid Parameter passed. 00144 * DSP_EACCESSDENIED 00145 * Access to the DSP is denied. 00146 * DSP_EFAIL 00147 * General failure. 00148 * 00149 * @pre attrs must be valid. 00150 * procId must be valid. 00151 * PROC_attach has been successful. 00152 * 00153 * @post None 00154 * 00155 * @see MSGQ_transportClose 00156 * ============================================================================ 00157 */ 00158 EXPORT_API 00159 DSP_STATUS 00160 MSGQ_transportOpen (IN ProcessorId procId, IN Pvoid attrs) ; 00161 00162 00163 /** ============================================================================ 00164 * @func MSGQ_transportClose 00165 * 00166 * @brief This function finalizes the transport associated with the 00167 * specified processor. 00168 * 00169 * @param procId 00170 * ID of the Processor for which the transport is to be closed. 00171 * 00172 * @return DSP_SOK 00173 * Operation successfully completed. 00174 * DSP_SCLOSED 00175 * The final process has closed the MSGQ transport. 00176 * DSP_EATTACHED 00177 * This process has not attached to the specified processor. 00178 * DSP_EMEMORY 00179 * Operation failed due to memory error. 00180 * DSP_EINVALIDARG 00181 * Invalid Parameter passed. 00182 * DSP_EOPENED 00183 * The MSGQ transport was not opened. 00184 * DSP_EACCESSDENIED 00185 * The MSGQ transport was not opened in this process. 00186 * DSP_EFAIL 00187 * General failure. 00188 * 00189 * @pre procId must be valid. 00190 * All MSGQ operations should be complete. 00191 * 00192 * @post None 00193 * 00194 * @see MSGQ_transportOpen 00195 * ============================================================================ 00196 */ 00197 EXPORT_API 00198 DSP_STATUS 00199 MSGQ_transportClose (IN ProcessorId procId) ; 00200 00201 00202 /** ============================================================================ 00203 * @func MSGQ_open 00204 * 00205 * @brief This function opens the message queue to be used for receiving 00206 * messages, identified through the specified message queue name. 00207 * 00208 * @param queueName 00209 * Name of the message queue to be opened. 00210 * @param msgqQueue 00211 * Location to store the handle to the message queue. 00212 * @param attrs 00213 * Optional attributes for creation of the MSGQ. 00214 * 00215 * @return DSP_SOK 00216 * Operation successfully completed. 00217 * DSP_EINVALIDARG 00218 * Invalid argument. 00219 * DSP_ENOTFOUND 00220 * Attempt to open more than number of message queues configured. 00221 * DSP_EMEMORY 00222 * Operation failed due to memory error. 00223 * DSP_EFAIL 00224 * General failure. 00225 * 00226 * @pre queueName must be valid. 00227 * msgqQueue must be a valid pointer. 00228 * PROC_attach has been successful. 00229 * 00230 * @post None 00231 * 00232 * @see MSGQ_Queue, MSGQ_Attrs, MSGQ_close (), MSGQ_locate () 00233 * ============================================================================ 00234 */ 00235 EXPORT_API 00236 DSP_STATUS 00237 MSGQ_open (IN Pstr queueName, 00238 OUT MSGQ_Queue * msgqQueue, 00239 IN MSGQ_Attrs * attrs) ; 00240 00241 00242 /** ============================================================================ 00243 * @func MSGQ_close 00244 * 00245 * @brief This function closes the message queue identified by the specified 00246 * MSGQ handle 00247 * 00248 * @param msgqQueue 00249 * Handle to the message queue to be closed. 00250 * 00251 * @return DSP_SOK 00252 * Operation successfully completed. 00253 * DSP_EINVALIDARG 00254 * Invalid argument. 00255 * DSP_EMEMORY 00256 * Operation failed due to memory error. 00257 * DSP_EFAIL 00258 * General failure. 00259 * 00260 * @pre msgqQueue must be valid. 00261 * All MSGQ operations are complete. 00262 * 00263 * @post None 00264 * 00265 * @see MSGQ_Queue, MSGQ_open () 00266 * ============================================================================ 00267 */ 00268 EXPORT_API 00269 DSP_STATUS 00270 MSGQ_close (IN MSGQ_Queue msgqQueue) ; 00271 00272 00273 /** ============================================================================ 00274 * @func MSGQ_locate 00275 * 00276 * @brief This function synchronously locates the message queue identified by 00277 * the specified MSGQ name and returns a handle to the located message 00278 * queue. 00279 * 00280 * @param queueName 00281 * Name of the message queue to be located. 00282 * @param msgqQueue 00283 * Location to store the handle to the located message queue. 00284 * @param attrs 00285 * Optional attributes for location of the MSGQ. 00286 * 00287 * @return DSP_SOK 00288 * Operation successfully completed. 00289 * DSP_EINVALIDARG 00290 * Invalid argument. 00291 * DSP_ENOTFOUND 00292 * The specified message queue could not be located. 00293 * DSP_ETIMEOUT 00294 * Timeout occurred while locating the message. 00295 * DSP_ENOTCOMPLETE 00296 * Operation not complete when WAIT_NONE was specified as timeout. 00297 * DSP_EMEMORY 00298 * Operation failed due to memory error. 00299 * DSP_EFAIL 00300 * General failure. 00301 * 00302 * @pre queueName must be valid. 00303 * msgqQueue must be a valid pointer. 00304 * Corresponding MSGQ has been opened successfully. 00305 * 00306 * @post None 00307 * 00308 * @see MSGQ_Queue, MSGQ_LocateAttrs, MSGQ_put (), MSGQ_release () 00309 * ============================================================================ 00310 */ 00311 EXPORT_API 00312 DSP_STATUS 00313 MSGQ_locate (IN Pstr queueName, 00314 OUT MSGQ_Queue * msgqQueue, 00315 IN MSGQ_LocateAttrs * attrs) ; 00316 00317 00318 /** ============================================================================ 00319 * @func MSGQ_locateAsync 00320 * 00321 * @brief This function asynchronously locates the message queue identified by 00322 * the specified MSGQ name. An attempt is made to asynchronously 00323 * locate the message queue. If found, an MSGQ_AsyncLocateMsg message is 00324 * sent to the specified reply message queue. 00325 * 00326 * @param queueName 00327 * Name of the message queue to be located. 00328 * @param replyQueue 00329 * Message queue to be used to receive the response message for 00330 * asynchronous location. 00331 * @param attrs 00332 * Attributes for asynchronous location of the MSGQ. 00333 * 00334 * @return DSP_SOK 00335 * Operation successfully completed. 00336 * DSP_EINVALIDARG 00337 * Invalid argument. 00338 * DSP_EMEMORY 00339 * Operation failed due to memory error. 00340 * DSP_EFAIL 00341 * General failure. 00342 * 00343 * @pre queueName must be valid. 00344 * replyQueue must be valid. 00345 * attrs must be valid. 00346 * Corresponding MSGQ has been opened successfully. 00347 * 00348 * @post None 00349 * 00350 * @see MSGQ_Queue, MSGQ_LocateAsyncAttrs, MSGQ_put (), MSGQ_release () 00351 * ============================================================================ 00352 */ 00353 EXPORT_API 00354 DSP_STATUS 00355 MSGQ_locateAsync (IN Pstr queueName, 00356 IN MSGQ_Queue replyQueue, 00357 IN MSGQ_LocateAsyncAttrs * attrs) ; 00358 00359 00360 /** ============================================================================ 00361 * @func MSGQ_release 00362 * 00363 * @brief This function releases the message queue identified by the MSGQ 00364 * handle that was located earlier. 00365 * 00366 * @param msgqQueue 00367 * Handle to the message queue to be released. 00368 * 00369 * @return DSP_SOK 00370 * Operation successfully completed. 00371 * DSP_EINVALIDARG 00372 * Invalid argument. 00373 * DSP_ENOTFOUND 00374 * The message queue has not been previously located. 00375 * DSP_EMEMORY 00376 * Operation failed due to memory error. 00377 * DSP_EFAIL 00378 * General failure. 00379 * 00380 * @pre msgqQueue must be valid. 00381 * MSGQ_locate has been successful. 00382 * All MSGQ operations pertaining to that MSGQ are complete. 00383 * 00384 * @post None 00385 * 00386 * @see MSGQ_Queue, MSGQ_locate () 00387 * ============================================================================ 00388 */ 00389 EXPORT_API 00390 DSP_STATUS 00391 MSGQ_release (IN MSGQ_Queue msgqQueue) ; 00392 00393 00394 /** ============================================================================ 00395 * @func MSGQ_alloc 00396 * 00397 * @brief This function allocates a message, and returns the pointer to the 00398 * user. 00399 * 00400 * @param poolId 00401 * ID of the Pool to be used for allocating this message. 00402 * @param size 00403 * Size of the message to be allocated. 00404 * @param msg 00405 * Location to receive the allocated message. 00406 * 00407 * @return DSP_SOK 00408 * Operation successfully completed. 00409 * DSP_EINVALIDARG 00410 * Invalid argument. 00411 * DSP_EMEMORY 00412 * Operation failed due to memory error. 00413 * DSP_EFAIL 00414 * General failure. 00415 * 00416 * @pre msg must be a valid pointer. 00417 * size must be greater than size of MSGQ_MsgHeader. 00418 * POOL has been configured according to application specification. 00419 * 00420 * @post None 00421 * 00422 * @see MSGQ_MsgHeader, MSGQ_put () 00423 * ============================================================================ 00424 */ 00425 EXPORT_API 00426 DSP_STATUS 00427 MSGQ_alloc (IN PoolId poolId, IN Uint16 size, OUT MSGQ_Msg * msg) ; 00428 00429 00430 /** ============================================================================ 00431 * @func MSGQ_free 00432 * 00433 * @brief This function frees a message. 00434 * 00435 * @param msg 00436 * Pointer to the message to be freed. 00437 * 00438 * @return DSP_SOK 00439 * Operation successfully completed. 00440 * DSP_EINVALIDARG 00441 * Invalid argument. 00442 * DSP_EMEMORY 00443 * Operation failed due to memory error. 00444 * DSP_EFAIL 00445 * General failure. 00446 * 00447 * @pre msg must be valid. 00448 * MSGQ_alloc must be successful. 00449 * 00450 * @post None 00451 * 00452 * @see MSGQ_MsgHeader, MSGQ_get () 00453 * ============================================================================ 00454 */ 00455 EXPORT_API 00456 DSP_STATUS 00457 MSGQ_free (IN MSGQ_Msg msg) ; 00458 00459 00460 /** ============================================================================ 00461 * @func MSGQ_put 00462 * 00463 * @brief This function sends a message to the specified MSGQ. 00464 * 00465 * @param msgqQueue 00466 * Handle to the destination MSGQ. 00467 * @param msg 00468 * Pointer to the message to be sent to the destination MSGQ. 00469 * 00470 * @return DSP_SOK 00471 * Operation successfully completed. 00472 * DSP_EINVALIDARG 00473 * Invalid argument. 00474 * DSP_EFAIL 00475 * General failure. 00476 * 00477 * @pre msgqQueue must be valid. 00478 * msg must be valid. 00479 * 00480 * @post None 00481 * 00482 * @see MSGQ_Queue, MSGQ_MsgHeader, MSGQ_get () 00483 * ============================================================================ 00484 */ 00485 EXPORT_API 00486 DSP_STATUS 00487 MSGQ_put (IN MSGQ_Queue msgqQueue, IN MSGQ_Msg msg) ; 00488 00489 00490 /** ============================================================================ 00491 * @func MSGQ_get 00492 * 00493 * @brief This function receives a message on the specified MSGQ. 00494 * 00495 * @param msgqQueue 00496 * Handle to the MSGQ on which the message is to be received. 00497 * @param timeout 00498 * Timeout value to wait for the message (in milliseconds). 00499 * @param msg 00500 * Location to receive the message. 00501 * 00502 * @return DSP_SOK 00503 * Operation successfully completed. 00504 * DSP_EINVALIDARG 00505 * Invalid Parameter passed. 00506 * DSP_ETIMEOUT 00507 * Timeout occurred while receiving the message. 00508 * DSP_ENOTCOMPLETE 00509 * Operation not complete when WAIT_NONE was specified as timeout. 00510 * DSP_EMEMORY 00511 * Operation failed due to memory error. 00512 * DSP_EFAIL 00513 * General failure. 00514 * 00515 * @pre msgQueue must be valid. 00516 * msgqQueue must be a local queue. 00517 * msg must be a valid pointer. 00518 * 00519 * @post None 00520 * 00521 * @see MSGQ_Queue, MSGQ_MsgHeader, MSGQ_put () 00522 * ============================================================================ 00523 */ 00524 EXPORT_API 00525 DSP_STATUS 00526 MSGQ_get (IN MSGQ_Queue msgqQueue, IN Uint32 timeout, OUT MSGQ_Msg * msg) ; 00527 00528 00529 /** ============================================================================ 00530 * @func MSGQ_getSrcQueue 00531 * 00532 * @brief This function returns a handle to the source message queue of a 00533 * message to be used for replying to the message. 00534 * 00535 * @param msg 00536 * Message, whose source MSGQ handle is to be returned. 00537 * @param msgqQueue 00538 * Location to retrieve the handle to the source MSGQ. 00539 * 00540 * @return DSP_SOK 00541 * Operation successfully completed. 00542 * DSP_EINVALIDARG 00543 * Invalid Parameter passed. 00544 * DSP_ENOTFOUND 00545 * Source information has not been provided by the sender. 00546 * DSP_EFAIL 00547 * General failure. 00548 * 00549 * @pre msg must be valid. 00550 * msgqQueue must be a valid pointer. 00551 * 00552 * @post None 00553 * 00554 * @see MSGQ_Queue, MSGQ_MsgHeader 00555 * ============================================================================ 00556 */ 00557 EXPORT_API 00558 DSP_STATUS 00559 MSGQ_getSrcQueue (IN MSGQ_Msg msg, OUT MSGQ_Queue * msgqQueue) ; 00560 00561 00562 /** ============================================================================ 00563 * @func MSGQ_count 00564 * 00565 * @brief This API returns the count of the number of messages in a local 00566 * message queue. 00567 * 00568 * @param msgqQueue 00569 * Handle to the MSGQ for which the count is to be retrieved. 00570 * @param count 00571 * Location to receive the message count. 00572 * 00573 * @return DSP_SOK 00574 * Operation successfully completed. 00575 * DSP_EINVALIDARG 00576 * Invalid argument 00577 * DSP_EFAIL 00578 * General failure. 00579 * 00580 * @pre msgqQueue must be valid. 00581 * msgqQueue must be a local queue. 00582 * count must be a valid pointer. 00583 * 00584 * @post None 00585 * 00586 * @see MSGQ_Queue 00587 * ============================================================================ 00588 */ 00589 EXPORT_API 00590 DSP_STATUS 00591 MSGQ_count (IN MSGQ_Queue msgqQueue, OUT Uint16 * count) ; 00592 00593 00594 /** ============================================================================ 00595 * @func MSGQ_setErrorHandler 00596 * 00597 * @brief This API allows the user to designate a MSGQ as an error-handler 00598 * MSGQ to receive asynchronous error messages from the transports. 00599 * 00600 * @param errorQueue 00601 * Handle to the message queue to receive the error messages. 00602 * @param poolId 00603 * ID indicating the pool to be used for allocating the error 00604 * messages. 00605 * 00606 * @return DSP_SOK 00607 * Operation successfully completed. 00608 * DSP_EINVALIDARG 00609 * Invalid argument 00610 * DSP_EFAIL 00611 * General failure. 00612 * 00613 * @pre MSGQ_open has been successful. 00614 * 00615 * @post None 00616 * 00617 * @see MSGQ_AsyncErrorMsg 00618 * ============================================================================ 00619 */ 00620 EXPORT_API 00621 DSP_STATUS 00622 MSGQ_setErrorHandler (IN MSGQ_Queue errorQueue, IN PoolId poolId) ; 00623 00624 00625 #if defined (DDSP_PROFILE) 00626 /** ============================================================================ 00627 * @func MSGQ_instrument 00628 * 00629 * @brief This function gets the instrumentation information related to the 00630 * specified message queue. 00631 * 00632 * @param msgqQueue 00633 * Handle to the message queue. 00634 * @param retVal 00635 * Location to retrieve the instrumentation information. 00636 * 00637 * @return DSP_SOK 00638 * Operation successfully completed. 00639 * DSP_EINVALIDARG 00640 * Invalid argument. 00641 * DSP_EFAIL 00642 * General failure. 00643 * 00644 * @pre msgqQueue must be valid. 00645 * retVal must be a valid pointer. 00646 * Profiling has been selected in the configuration. 00647 * 00648 * @post None 00649 * 00650 * @see MSGQ_Instrument 00651 * ============================================================================ 00652 */ 00653 EXPORT_API 00654 DSP_STATUS 00655 MSGQ_instrument (IN MSGQ_Queue msgqQueue, OUT MSGQ_Instrument * retVal) ; 00656 #endif /* defined (DDSP_PROFILE) */ 00657 00658 00659 #if defined (DDSP_DEBUG) 00660 /** ============================================================================ 00661 * @func MSGQ_debug 00662 * 00663 * @brief This function prints the current status of the MSGQ subcomponent. 00664 * 00665 * @param msgqQueue 00666 * Handle to the message queue. 00667 * 00668 * @return None 00669 * 00670 * @pre msgqQueue must be valid. 00671 * 00672 * @post None 00673 * 00674 * @see None 00675 * ============================================================================ 00676 */ 00677 EXPORT_API 00678 Void 00679 MSGQ_debug (IN MSGQ_Queue msgqQueue) ; 00680 #endif /* defined (DDSP_DEBUG) */ 00681 00682 00683 /** ============================================================================ 00684 * @deprecated The deprecated API MSGQ_GetMsgId has been replaced 00685 * with MSGQ_getMsgId. 00686 * This has been done to follow DSP/BIOS codinf guidelines and 00687 * have a uniform naming convention for the API's on both GPP 00688 * as well as DSP. 00689 * 00690 * ============================================================================ 00691 */ 00692 #define MSGQ_GetMsgId MSGQ_getMsgId 00693 00694 /** ============================================================================ 00695 * @deprecated The deprecated API MSGQ_GetMsgSize has been replaced 00696 * with MSGQ_getMsgSize. 00697 * This has been done to follow DSP/BIOS codinf guidelines and 00698 * have a uniform naming convention for the API's on both GPP 00699 * as well as DSP. 00700 * 00701 * ============================================================================ 00702 */ 00703 #define MSGQ_GetMsgSize MSGQ_getMsgSize 00704 00705 /** ============================================================================ 00706 * @deprecated The deprecated API MSGQ_SetMsgId has been replaced 00707 * with MSGQ_setMsgId. 00708 * This has been done to follow DSP/BIOS codinf guidelines and 00709 * have a uniform naming convention for the API's on both GPP 00710 * as well as DSP. 00711 * 00712 * ============================================================================ 00713 */ 00714 #define MSGQ_SetMsgId MSGQ_setMsgId 00715 00716 /** ============================================================================ 00717 * @deprecated The deprecated API MSGQ_GetDstQueue has been replaced 00718 * with MSGQ_getDstQueue. 00719 * This has been done to follow DSP/BIOS codinf guidelines and 00720 * have a uniform naming convention for the API's on both GPP 00721 * as well as DSP. 00722 * 00723 * ============================================================================ 00724 */ 00725 #define MSGQ_GetDstQueue MSGQ_getDstQueue 00726 00727 /** ============================================================================ 00728 * @deprecated The deprecated API MSGQ_SetSrcQueue has been replaced 00729 * with MSGQ_setSrcQueue. 00730 * This has been done to follow DSP/BIOS codinf guidelines and 00731 * have a uniform naming convention for the API's on both GPP 00732 * as well as DSP. 00733 * 00734 * ============================================================================ 00735 */ 00736 #define MSGQ_SetSrcQueue MSGQ_setSrcQueue 00737 00738 /** ============================================================================ 00739 * @deprecated The deprecated API MSGQ_IsLocalQueue has been replaced 00740 * with MSGQ_isLocalQueue. 00741 * This has been done to follow DSP/BIOS codinf guidelines and 00742 * have a uniform naming convention for the API's on both GPP 00743 * as well as DSP. 00744 * 00745 * ============================================================================ 00746 */ 00747 #define MSGQ_IsLocalQueue MSGQ_isLocalQueue 00748 00749 /** ============================================================================ 00750 * @deprecated The deprecated API MSGQ_TransportOpen has been replaced 00751 * with MSGQ_transportOpen. 00752 * This has been done to follow DSP/BIOS codinf guidelines and 00753 * have a uniform naming convention for the API's on both GPP 00754 * as well as DSP. 00755 * 00756 * ============================================================================ 00757 */ 00758 #define MSGQ_TransportOpen MSGQ_transportOpen 00759 00760 /** ============================================================================ 00761 * @deprecated The deprecated API MSGQ_TransportClose has been replaced 00762 * with MSGQ_transportClose. 00763 * This has been done to follow DSP/BIOS codinf guidelines and 00764 * have a uniform naming convention for the API's on both GPP 00765 * as well as DSP. 00766 * 00767 * ============================================================================ 00768 */ 00769 #define MSGQ_TransportClose MSGQ_transportClose 00770 00771 /** ============================================================================ 00772 * @deprecated The deprecated API MSGQ_Open has been replaced 00773 * with MSGQ_open. 00774 * This has been done to follow DSP/BIOS codinf guidelines and 00775 * have a uniform naming convention for the API's on both GPP 00776 * as well as DSP. 00777 * 00778 * ============================================================================ 00779 */ 00780 #define MSGQ_Open MSGQ_open 00781 00782 /** ============================================================================ 00783 * @deprecated The deprecated API MSGQ_Close has been replaced 00784 * with MSGQ_close. 00785 * This has been done to follow DSP/BIOS codinf guidelines and 00786 * have a uniform naming convention for the API's on both GPP 00787 * as well as DSP. 00788 * 00789 * ============================================================================ 00790 */ 00791 #define MSGQ_Close MSGQ_close 00792 00793 /** ============================================================================ 00794 * @deprecated The deprecated API MSGQ_Locate has been replaced 00795 * with MSGQ_locate. 00796 * This has been done to follow DSP/BIOS codinf guidelines and 00797 * have a uniform naming convention for the API's on both GPP 00798 * as well as DSP. 00799 * 00800 * ============================================================================ 00801 */ 00802 #define MSGQ_Locate MSGQ_locate 00803 00804 /** ============================================================================ 00805 * @deprecated The deprecated API MSGQ_LocateAsync has been replaced 00806 * with MSGQ_locateAsync. 00807 * This has been done to follow DSP/BIOS codinf guidelines and 00808 * have a uniform naming convention for the API's on both GPP 00809 * as well as DSP. 00810 * 00811 * ============================================================================ 00812 */ 00813 #define MSGQ_LocateAsync MSGQ_locateAsync 00814 00815 /** ============================================================================ 00816 * @deprecated The deprecated API MSGQ_Release has been replaced 00817 * with MSGQ_release. 00818 * This has been done to follow DSP/BIOS codinf guidelines and 00819 * have a uniform naming convention for the API's on both GPP 00820 * as well as DSP. 00821 * 00822 * ============================================================================ 00823 */ 00824 #define MSGQ_Release MSGQ_release 00825 00826 /** ============================================================================ 00827 * @deprecated The deprecated API MSGQ_Alloc has been replaced 00828 * with MSGQ_alloc. 00829 * This has been done to follow DSP/BIOS codinf guidelines and 00830 * have a uniform naming convention for the API's on both GPP 00831 * as well as DSP. 00832 * 00833 * ============================================================================ 00834 */ 00835 #define MSGQ_Alloc MSGQ_alloc 00836 00837 /** ============================================================================ 00838 * @deprecated The deprecated API MSGQ_Free has been replaced 00839 * with MSGQ_free. 00840 * This has been done to follow DSP/BIOS codinf guidelines and 00841 * have a uniform naming convention for the API's on both GPP 00842 * as well as DSP. 00843 * 00844 * ============================================================================ 00845 */ 00846 #define MSGQ_Free MSGQ_free 00847 00848 /** ============================================================================ 00849 * @deprecated The deprecated API MSGQ_Put has been replaced 00850 * with MSGQ_put. 00851 * This has been done to follow DSP/BIOS codinf guidelines and 00852 * have a uniform naming convention for the API's on both GPP 00853 * as well as DSP. 00854 * 00855 * ============================================================================ 00856 */ 00857 #define MSGQ_Put MSGQ_put 00858 00859 /** ============================================================================ 00860 * @deprecated The deprecated API MSGQ_Get has been replaced 00861 * with MSGQ_get. 00862 * This has been done to follow DSP/BIOS codinf guidelines and 00863 * have a uniform naming convention for the API's on both GPP 00864 * as well as DSP. 00865 * 00866 * ============================================================================ 00867 */ 00868 #define MSGQ_Get MSGQ_get 00869 00870 /** ============================================================================ 00871 * @deprecated The deprecated API MSGQ_GetSrcQueue has been replaced 00872 * with MSGQ_getSrcQueue. 00873 * This has been done to follow DSP/BIOS codinf guidelines and 00874 * have a uniform naming convention for the API's on both GPP 00875 * as well as DSP. 00876 * 00877 * ============================================================================ 00878 */ 00879 #define MSGQ_GetSrcQueue MSGQ_getSrcQueue 00880 00881 /** ============================================================================ 00882 * @deprecated The deprecated API MSGQ_Count has been replaced 00883 * with MSGQ_count. 00884 * This has been done to follow DSP/BIOS codinf guidelines and 00885 * have a uniform naming convention for the API's on both GPP 00886 * as well as DSP. 00887 * 00888 * ============================================================================ 00889 */ 00890 #define MSGQ_Count MSGQ_count 00891 00892 /** ============================================================================ 00893 * @deprecated The deprecated API MSGQ_SetErrorHandler has been replaced 00894 * with MSGQ_setErrorHandler. 00895 * This has been done to follow DSP/BIOS codinf guidelines and 00896 * have a uniform naming convention for the API's on both GPP 00897 * as well as DSP. 00898 * 00899 * ============================================================================ 00900 */ 00901 #define MSGQ_SetErrorHandler MSGQ_setErrorHandler 00902 00903 #if defined (DDSP_DEBUG) 00904 /** ============================================================================ 00905 * @deprecated The deprecated API MSGQ_Debug has been replaced 00906 * with MSGQ_debug. 00907 * This has been done to follow DSP/BIOS codinf guidelines and 00908 * have a uniform naming convention for the API's on both GPP 00909 * as well as DSP. 00910 * 00911 * ============================================================================ 00912 */ 00913 #define MSGQ_Debug MSGQ_debug 00914 #endif /* defined (DDSP_DEBUG) */ 00915 00916 00917 #if defined (__cplusplus) 00918 } 00919 #endif /* defined (__cplusplus) */ 00920 00921 00922 #endif /* !defined (MSGQ_H) */