2 * @file IxNpeMhSend_p.h
4 * @author Intel Corporation
7 * @brief This file contains the private API for the Send module.
11 * IXP400 SW Release version 2.0
13 * -- Copyright Notice --
16 * Copyright 2001-2005, Intel Corporation.
17 * All rights reserved.
20 * SPDX-License-Identifier: BSD-3-Clause
22 * -- End of Copyright Notice --
26 * @defgroup IxNpeMhSend_p IxNpeMhSend_p
28 * @brief The private API for the Send module.
33 #ifndef IXNPEMHSEND_P_H
34 #define IXNPEMHSEND_P_H
37 #include "IxOsalTypes.h"
40 * #defines for function return types, etc.
44 * Prototypes for interface functions.
48 * @fn IX_STATUS ixNpeMhSendMessageSend (
50 IxNpeMhMessage message,
51 UINT32 maxSendRetries)
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.
57 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to send the message
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.
63 * @return The function returns a status indicating success, failure or timeout.
66 IX_STATUS ixNpeMhSendMessageSend (
68 IxNpeMhMessage message,
69 UINT32 maxSendRetries);
72 * @fn IX_STATUS ixNpeMhSendMessageWithResponseSend (
74 IxNpeMhMessage message,
75 IxNpeMhMessageId solicitedMessageId,
76 IxNpeMhCallback solicitedCallback,
77 UINT32 maxSendRetries)
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.
85 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to send the message
87 * @param IxNpeMhMessage message (in) - The message to send.
88 * @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the
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.
95 * @return The function returns a status indicating success, failure or timeout.
98 IX_STATUS ixNpeMhSendMessageWithResponseSend (
100 IxNpeMhMessage message,
101 IxNpeMhMessageId solicitedMessageId,
102 IxNpeMhCallback solicitedCallback,
103 UINT32 maxSendRetries);
106 * @fn void ixNpeMhSendShow (
109 * @brief This function will display the current state of the Send module.
111 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
114 * @return No return value.
117 void ixNpeMhSendShow (
121 * @fn void ixNpeMhSendShowReset (
124 * @brief This function will reset the current state of the Send module.
126 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
129 * @return No return value.
132 void ixNpeMhSendShowReset (
135 #endif /* IXNPEMHSEND_P_H */
138 * @} defgroup IxNpeMhSend_p