MsgAPI.h 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. /*****************************************************************
  2. *****************************************************************
  3. *** **
  4. *** (C)Copyright 2005-2006, American Megatrends Inc. **
  5. *** **
  6. *** All Rights Reserved. **
  7. *** **
  8. *** 6145-F, Northbelt Parkway, Norcross, **
  9. *** **
  10. *** Georgia - 30071, USA. Phone-(770)-246-8600. **
  11. *** **
  12. *****************************************************************
  13. *****************************************************************
  14. ******************************************************************
  15. *
  16. * MsgApi.h
  17. * Messaging API.
  18. *
  19. * Author: Govind Kothandapani <govindk@ami.com>
  20. ******************************************************************/
  21. #ifndef MSGAPI_H
  22. #define MSGAPI_H
  23. #include "Types.h"
  24. #include "Message.h"
  25. /*-----------------------------------------------------------------
  26. * @fn API_PostMsg
  27. * @brief Post a message to the destination task.
  28. * @param pMsgPkt - Pointer to the message to be posted.
  29. * @param Queue - Queue to post this message to.
  30. * @return 0 if success, -1 if failed.
  31. *-----------------------------------------------------------------*/
  32. extern int API_PostMsg(MsgPkt_T* pMsgPkt, HQueue_T Queue,int BMCInst);
  33. /*---------------------------------------------------------------------------
  34. * @fn GetMsg
  35. * @brief Gets the message posted to this task.
  36. * @param pMsgPkt - Pointer to the buffer to hold the message packet.
  37. * @param Queue - Queue to fetch the message from.
  38. * @param NumMs - Number of milli-seconds to wait.
  39. * WAIT_NONE - If the function has to return immediately.
  40. * WAIT_INFINITE - If the function has to wait infinitely.
  41. * @return 0 if success, -1 if failed.
  42. *--------------------------------------------------------------------------*/
  43. extern int API_GetMsg(MsgPkt_T* pMsgPkt, HQueue_T Queue, INT16S NumMs,int BMCInst);
  44. #endif /* MSGAPI_H */