| Wolfgang Denk | 4646d2a | 2006-05-30 15:56:48 +0200 | [diff] [blame] | 1 | /** |
| 2 | * @file IxNpeMhSend_p.h |
| 3 | * |
| 4 | * @author Intel Corporation |
| 5 | * @date 18 Jan 2002 |
| 6 | * |
| 7 | * @brief This file contains the private API for the Send module. |
| 8 | * |
| 9 | * |
| 10 | * @par |
| 11 | * IXP400 SW Release version 2.0 |
| 12 | * |
| 13 | * -- Copyright Notice -- |
| 14 | * |
| 15 | * @par |
| 16 | * Copyright 2001-2005, Intel Corporation. |
| 17 | * All rights reserved. |
| 18 | * |
| 19 | * @par |
| Wolfgang Denk | c57eadc | 2013-07-28 22:12:47 +0200 | [diff] [blame] | 20 | * SPDX-License-Identifier: BSD-3-Clause |
| Wolfgang Denk | 4646d2a | 2006-05-30 15:56:48 +0200 | [diff] [blame] | 21 | * @par |
| 22 | * -- End of Copyright Notice -- |
| 23 | */ |
| 24 | |
| 25 | /** |
| 26 | * @defgroup IxNpeMhSend_p IxNpeMhSend_p |
| 27 | * |
| 28 | * @brief The private API for the Send module. |
| 29 | * |
| 30 | * @{ |
| 31 | */ |
| 32 | |
| 33 | #ifndef IXNPEMHSEND_P_H |
| 34 | #define IXNPEMHSEND_P_H |
| 35 | |
| 36 | #include "IxNpeMh.h" |
| 37 | #include "IxOsalTypes.h" |
| 38 | |
| 39 | /* |
| 40 | * #defines for function return types, etc. |
| 41 | */ |
| 42 | |
| 43 | /* |
| 44 | * Prototypes for interface functions. |
| 45 | */ |
| 46 | |
| 47 | /** |
| 48 | * @fn IX_STATUS ixNpeMhSendMessageSend ( |
| 49 | IxNpeMhNpeId npeId, |
| 50 | IxNpeMhMessage message, |
| 51 | UINT32 maxSendRetries) |
| 52 | * |
| 53 | * @brief This function writes a message to the specified NPE's inFIFO, |
| 54 | * and must be used when the message being sent does not solicit a response |
| 55 | * from the NPE. This function will return TIMEOUT status if NPE hang / halt. |
| 56 | * |
| 57 | * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to send the message |
| 58 | * to. |
| 59 | * @param IxNpeMhMessage message (in) - The message to send. |
| 60 | * @param UINT32 maxSendRetries (in) - Max num. of retries to perform |
| 61 | * if the NPE's inFIFO is full. |
| 62 | * |
| 63 | * @return The function returns a status indicating success, failure or timeout. |
| 64 | */ |
| 65 | |
| 66 | IX_STATUS ixNpeMhSendMessageSend ( |
| 67 | IxNpeMhNpeId npeId, |
| 68 | IxNpeMhMessage message, |
| 69 | UINT32 maxSendRetries); |
| 70 | |
| 71 | /** |
| 72 | * @fn IX_STATUS ixNpeMhSendMessageWithResponseSend ( |
| 73 | IxNpeMhNpeId npeId, |
| 74 | IxNpeMhMessage message, |
| 75 | IxNpeMhMessageId solicitedMessageId, |
| 76 | IxNpeMhCallback solicitedCallback, |
| 77 | UINT32 maxSendRetries) |
| 78 | * |
| 79 | * @brief This function writes a message to the specified NPE's inFIFO, |
| 80 | * and must be used when the message being sent solicits a response from |
| 81 | * the NPE. The ID of the solicited response must be specified so that it |
| 82 | * can be recognised, and a callback provided to pass the response back to |
| 83 | * the client. This function will return TIMEOUT status if NPE hang / halt. |
| 84 | * |
| 85 | * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to send the message |
| 86 | * to. |
| 87 | * @param IxNpeMhMessage message (in) - The message to send. |
| 88 | * @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the |
| 89 | * solicited response. |
| 90 | * @param IxNpeMhCallback solicitedCallback (in) - The callback to pass the |
| 91 | * solicited response back to the client. |
| 92 | * @param UINT32 maxSendRetries (in) - Max num. of retries to perform |
| 93 | * if the NPE's inFIFO is full. |
| 94 | * |
| 95 | * @return The function returns a status indicating success, failure or timeout. |
| 96 | */ |
| 97 | |
| 98 | IX_STATUS ixNpeMhSendMessageWithResponseSend ( |
| 99 | IxNpeMhNpeId npeId, |
| 100 | IxNpeMhMessage message, |
| 101 | IxNpeMhMessageId solicitedMessageId, |
| 102 | IxNpeMhCallback solicitedCallback, |
| 103 | UINT32 maxSendRetries); |
| 104 | |
| 105 | /** |
| 106 | * @fn void ixNpeMhSendShow ( |
| 107 | IxNpeMhNpeId npeId) |
| 108 | * |
| 109 | * @brief This function will display the current state of the Send module. |
| 110 | * |
| 111 | * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state |
| 112 | * information for. |
| 113 | * |
| 114 | * @return No return value. |
| 115 | */ |
| 116 | |
| 117 | void ixNpeMhSendShow ( |
| 118 | IxNpeMhNpeId npeId); |
| 119 | |
| 120 | /** |
| 121 | * @fn void ixNpeMhSendShowReset ( |
| 122 | IxNpeMhNpeId npeId) |
| 123 | * |
| 124 | * @brief This function will reset the current state of the Send module. |
| 125 | * |
| 126 | * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state |
| 127 | * information for. |
| 128 | * |
| 129 | * @return No return value. |
| 130 | */ |
| 131 | |
| 132 | void ixNpeMhSendShowReset ( |
| 133 | IxNpeMhNpeId npeId); |
| 134 | |
| 135 | #endif /* IXNPEMHSEND_P_H */ |
| 136 | |
| 137 | /** |
| 138 | * @} defgroup IxNpeMhSend_p |
| 139 | */ |