diff options
Diffstat (limited to 'Acceleration/library/icp_telephony/tdm_infrastructure_message_handler/include/IxPiuMhSend_p.h')
| -rw-r--r-- | Acceleration/library/icp_telephony/tdm_infrastructure_message_handler/include/IxPiuMhSend_p.h | 185 |
1 files changed, 185 insertions, 0 deletions
diff --git a/Acceleration/library/icp_telephony/tdm_infrastructure_message_handler/include/IxPiuMhSend_p.h b/Acceleration/library/icp_telephony/tdm_infrastructure_message_handler/include/IxPiuMhSend_p.h new file mode 100644 index 0000000..d6a0352 --- /dev/null +++ b/Acceleration/library/icp_telephony/tdm_infrastructure_message_handler/include/IxPiuMhSend_p.h @@ -0,0 +1,185 @@ +/** + * @file IxPiuMhSend_p.h + * + * @author Intel Corporation + * @date 18 Jan 2002 + * + * @brief This file contains the private API for the Send module. + * + * + * @par + * This file is provided under a dual BSD/GPLv2 license. When using or + * redistributing this file, you may do so under either license. + * + * GPL LICENSE SUMMARY + * + * Copyright(c) 2007,2008,2009 Intel Corporation. All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of version 2 of the GNU General Public License as + * published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. + * The full GNU General Public License is included in this distribution + * in the file called LICENSE.GPL. + * + * Contact Information: + * Intel Corporation + * + * BSD LICENSE + * + * Copyright(c) 2007,2008,2009 Intel Corporation. All rights reserved. + * All rights reserved. + * + * 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 Intel Corporation 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. + * + * + * +*/ + +/** + * @defgroup IxPiuMhSend_p IxPiuMhSend_p + * + * @brief The private API for the Send module. + * + * @{ + */ + +#ifndef IXPIUMHSEND_P_H +#define IXPIUMHSEND_P_H + +#include "IxPiuMh.h" +#include "IxOsalTypes.h" + +/* + * #defines for function return types, etc. + */ + +/* + * Prototypes for interface functions. + */ + +/** + * @fn IX_STATUS ixPiuMhSendMessageSend ( + IxPiuMhPiuId piuId, + IxPiuMhMessage message, + UINT32 maxSendRetries) + * + * @brief This function writes a message to the specified PIU's inFIFO, + * and must be used when the message being sent does not solicit a response + * from the PIU. This function will return TIMEOUT status if PIU hang / halt. + * + * @param IxPiuMhPiuId piuId (in) - The ID of the PIU to send the message + * to. + * @param IxPiuMhMessage message (in) - The message to send. + * @param UINT32 maxSendRetries (in) - Max num. of retries to perform + * if the PIU's inFIFO is full. + * + * @return The function returns a status indicating success, failure or timeout. + */ + +IX_STATUS ixPiuMhSendMessageSend ( + IxPiuMhPiuId piuId, + IxPiuMhMessage message, + UINT32 maxSendRetries); + +/** + * @fn IX_STATUS ixPiuMhSendMessageWithResponseSend ( + IxPiuMhPiuId piuId, + IxPiuMhMessage message, + IxPiuMhMessageId solicitedMessageId, + IxPiuMhCallback solicitedCallback, + UINT32 maxSendRetries) + * + * @brief This function writes a message to the specified PIU's inFIFO, + * and must be used when the message being sent solicits a response from + * the PIU. The ID of the solicited response must be specified so that it + * can be recognised, and a callback provided to pass the response back to + * the client. This function will return TIMEOUT status if PIU hang / halt. + * + * @param IxPiuMhPiuId piuId (in) - The ID of the PIU to send the message + * to. + * @param IxPiuMhMessage message (in) - The message to send. + * @param IxPiuMhMessageId solicitedMessageId (in) - The ID of the + * solicited response. + * @param IxPiuMhCallback solicitedCallback (in) - The callback to pass the + * solicited response back to the client. + * @param UINT32 maxSendRetries (in) - Max num. of retries to perform + * if the PIU's inFIFO is full. + * + * @return The function returns a status indicating success, failure or timeout. + */ + +IX_STATUS ixPiuMhSendMessageWithResponseSend ( + IxPiuMhPiuId piuId, + IxPiuMhMessage message, + IxPiuMhMessageId solicitedMessageId, + IxPiuMhCallback solicitedCallback, + UINT32 maxSendRetries); + +/** + * @fn void ixPiuMhSendShow ( + IxPiuMhPiuId piuId) + * + * @brief This function will display the current state of the Send module. + * + * @param IxPiuMhPiuId piuId (in) - The ID of the PIU to display state + * information for. + * + * @return No return value. + */ + +void ixPiuMhSendShow ( + IxPiuMhPiuId piuId); + +/** + * @fn void ixPiuMhSendShowReset ( + IxPiuMhPiuId piuId) + * + * @brief This function will reset the current state of the Send module. + * + * @param IxPiuMhPiuId piuId (in) - The ID of the PIU to reset state + * information for. + * + * @return No return value. + */ + +void ixPiuMhSendShowReset ( + IxPiuMhPiuId piuId); + +#endif /* IXPIUMHSEND_P_H */ + +/** + * @} defgroup IxPiuMhSend_p + */ |