IxNpeMhReceive_p.h 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. /**
  2. * @file IxNpeMhReceive_p.h
  3. *
  4. * @author Intel Corporation
  5. * @date 18 Jan 2002
  6. *
  7. * @brief This file contains the private API for the Receive 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
  20. * SPDX-License-Identifier: BSD-3-Clause
  21. * @par
  22. * -- End of Copyright Notice --
  23. */
  24. /**
  25. * @defgroup IxNpeMhReceive_p IxNpeMhReceive_p
  26. *
  27. * @brief The private API for the Receive module.
  28. *
  29. * @{
  30. */
  31. #ifndef IXNPEMHRECEIVE_P_H
  32. #define IXNPEMHRECEIVE_P_H
  33. #include "IxNpeMh.h"
  34. #include "IxOsalTypes.h"
  35. /*
  36. * #defines for function return types, etc.
  37. */
  38. /*
  39. * Prototypes for interface functions.
  40. */
  41. /**
  42. * @fn void ixNpeMhReceiveInitialize (void)
  43. *
  44. * @brief This function registers an internal ISR to handle the NPEs'
  45. * "outFIFO not empty" interrupts and receive messages from the NPEs when
  46. * they become available.
  47. *
  48. * @return No return value.
  49. */
  50. void ixNpeMhReceiveInitialize (void);
  51. /**
  52. * @fn IX_STATUS ixNpeMhReceiveMessagesReceive (
  53. IxNpeMhNpeId npeId)
  54. *
  55. * @brief This function reads messages from a particular NPE's outFIFO
  56. * until the outFIFO is empty, and for each message looks first for an
  57. * unsolicited callback, then a solicited callback, to pass the message
  58. * back to the client. If no callback can be found the message is
  59. * discarded and an error reported. This function will return TIMEOUT
  60. * status if NPE hang / halt.
  61. *
  62. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to receive
  63. * messages from.
  64. *
  65. * @return The function returns a status indicating success, failure or timeout.
  66. */
  67. IX_STATUS ixNpeMhReceiveMessagesReceive (
  68. IxNpeMhNpeId npeId);
  69. /**
  70. * @fn void ixNpeMhReceiveShow (
  71. IxNpeMhNpeId npeId)
  72. *
  73. * @brief This function will display the current state of the Receive
  74. * module.
  75. *
  76. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
  77. * information for.
  78. *
  79. * @return No return status.
  80. */
  81. void ixNpeMhReceiveShow (
  82. IxNpeMhNpeId npeId);
  83. /**
  84. * @fn void ixNpeMhReceiveShowReset (
  85. IxNpeMhNpeId npeId)
  86. *
  87. * @brief This function will reset the current state of the Receive
  88. * module.
  89. *
  90. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
  91. * information for.
  92. *
  93. * @return No return status.
  94. */
  95. void ixNpeMhReceiveShowReset (
  96. IxNpeMhNpeId npeId);
  97. #endif /* IXNPEMHRECEIVE_P_H */
  98. /**
  99. * @} defgroup IxNpeMhReceive_p
  100. */