2 * @file IxNpeMhReceive_p.h
4 * @author Intel Corporation
7 * @brief This file contains the private API for the Receive 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 IxNpeMhReceive_p IxNpeMhReceive_p
28 * @brief The private API for the Receive module.
33 #ifndef IXNPEMHRECEIVE_P_H
34 #define IXNPEMHRECEIVE_P_H
37 #include "IxOsalTypes.h"
40 * #defines for function return types, etc.
44 * Prototypes for interface functions.
48 * @fn void ixNpeMhReceiveInitialize (void)
50 * @brief This function registers an internal ISR to handle the NPEs'
51 * "outFIFO not empty" interrupts and receive messages from the NPEs when
52 * they become available.
54 * @return No return value.
57 void ixNpeMhReceiveInitialize (void);
60 * @fn IX_STATUS ixNpeMhReceiveMessagesReceive (
63 * @brief This function reads messages from a particular NPE's outFIFO
64 * until the outFIFO is empty, and for each message looks first for an
65 * unsolicited callback, then a solicited callback, to pass the message
66 * back to the client. If no callback can be found the message is
67 * discarded and an error reported. This function will return TIMEOUT
68 * status if NPE hang / halt.
70 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to receive
73 * @return The function returns a status indicating success, failure or timeout.
76 IX_STATUS ixNpeMhReceiveMessagesReceive (
80 * @fn void ixNpeMhReceiveShow (
83 * @brief This function will display the current state of the Receive
86 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
89 * @return No return status.
92 void ixNpeMhReceiveShow (
96 * @fn void ixNpeMhReceiveShowReset (
99 * @brief This function will reset the current state of the Receive
102 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
105 * @return No return status.
108 void ixNpeMhReceiveShowReset (
111 #endif /* IXNPEMHRECEIVE_P_H */
114 * @} defgroup IxNpeMhReceive_p