IxNpeMhSend_p.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  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
  20. * SPDX-License-Identifier: BSD-3-Clause
  21. * @par
  22. * -- End of Copyright Notice --
  23. */
  24. /**
  25. * @defgroup IxNpeMhSend_p IxNpeMhSend_p
  26. *
  27. * @brief The private API for the Send module.
  28. *
  29. * @{
  30. */
  31. #ifndef IXNPEMHSEND_P_H
  32. #define IXNPEMHSEND_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 IX_STATUS ixNpeMhSendMessageSend (
  43. IxNpeMhNpeId npeId,
  44. IxNpeMhMessage message,
  45. UINT32 maxSendRetries)
  46. *
  47. * @brief This function writes a message to the specified NPE's inFIFO,
  48. * and must be used when the message being sent does not solicit a response
  49. * from the NPE. This function will return TIMEOUT status if NPE hang / halt.
  50. *
  51. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to send the message
  52. * to.
  53. * @param IxNpeMhMessage message (in) - The message to send.
  54. * @param UINT32 maxSendRetries (in) - Max num. of retries to perform
  55. * if the NPE's inFIFO is full.
  56. *
  57. * @return The function returns a status indicating success, failure or timeout.
  58. */
  59. IX_STATUS ixNpeMhSendMessageSend (
  60. IxNpeMhNpeId npeId,
  61. IxNpeMhMessage message,
  62. UINT32 maxSendRetries);
  63. /**
  64. * @fn IX_STATUS ixNpeMhSendMessageWithResponseSend (
  65. IxNpeMhNpeId npeId,
  66. IxNpeMhMessage message,
  67. IxNpeMhMessageId solicitedMessageId,
  68. IxNpeMhCallback solicitedCallback,
  69. UINT32 maxSendRetries)
  70. *
  71. * @brief This function writes a message to the specified NPE's inFIFO,
  72. * and must be used when the message being sent solicits a response from
  73. * the NPE. The ID of the solicited response must be specified so that it
  74. * can be recognised, and a callback provided to pass the response back to
  75. * the client. This function will return TIMEOUT status if NPE hang / halt.
  76. *
  77. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to send the message
  78. * to.
  79. * @param IxNpeMhMessage message (in) - The message to send.
  80. * @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the
  81. * solicited response.
  82. * @param IxNpeMhCallback solicitedCallback (in) - The callback to pass the
  83. * solicited response back to the client.
  84. * @param UINT32 maxSendRetries (in) - Max num. of retries to perform
  85. * if the NPE's inFIFO is full.
  86. *
  87. * @return The function returns a status indicating success, failure or timeout.
  88. */
  89. IX_STATUS ixNpeMhSendMessageWithResponseSend (
  90. IxNpeMhNpeId npeId,
  91. IxNpeMhMessage message,
  92. IxNpeMhMessageId solicitedMessageId,
  93. IxNpeMhCallback solicitedCallback,
  94. UINT32 maxSendRetries);
  95. /**
  96. * @fn void ixNpeMhSendShow (
  97. IxNpeMhNpeId npeId)
  98. *
  99. * @brief This function will display the current state of the Send module.
  100. *
  101. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
  102. * information for.
  103. *
  104. * @return No return value.
  105. */
  106. void ixNpeMhSendShow (
  107. IxNpeMhNpeId npeId);
  108. /**
  109. * @fn void ixNpeMhSendShowReset (
  110. IxNpeMhNpeId npeId)
  111. *
  112. * @brief This function will reset the current state of the Send module.
  113. *
  114. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
  115. * information for.
  116. *
  117. * @return No return value.
  118. */
  119. void ixNpeMhSendShowReset (
  120. IxNpeMhNpeId npeId);
  121. #endif /* IXNPEMHSEND_P_H */
  122. /**
  123. * @} defgroup IxNpeMhSend_p
  124. */