Cleaned up code repetitions of messaging and shared memory read/write.
[processor-sdk/performance-audio-sr.git] / pasdk / test_dsp / framework / aspMsg_master.h
index ca8f48dce497ffe4ab422fee87204c88c8db368f..a98902d7489e9be3b85ba48a9366e547caab2b2b 100644 (file)
@@ -48,6 +48,14 @@ All rights reserved.
 
 #define ASP_MSG_MASTER_DEF_NUMMSGS  ( 4 )
 
+/* Error messages for function AspMsgSend */
+#define ASP_MSG_NO_ERR                          (  0 )
+#define ASP_MSG_ERR_QUEUE_ALLOC                 ( -1 )
+#define ASP_MSG_ERR_QUEUE_PUT                   ( -2 )
+#define ASP_MSG_ERR_QUEUE_GET                   ( -3 )
+#define ASP_MSG_ERR_QUEUE_FREE                  ( -4 )
+#define ASP_MSG_ERR_ACKNOWLEDGE                 ( -5 )
+
 /* module structure */
 typedef struct AspMsgMaster_Module
 {
@@ -75,6 +83,16 @@ Int AspMsgMaster_init(
 
 extern AspMsgMaster_Handle hAspMsgMaster;
 
-
+/* ASP message sending function
+ * Description: This function can be used to send message from the master processor
+ *              to slave processor. It uses the global handle hAspMsgMaster for
+ *              message passing.
+ */
+Int                    // returned error message
+AspMsgSend(
+       UInt32 sndCmd,     // command that is sent from master to slave
+       UInt32 ackCmd,     // acknowledgement that comes back from slave to master
+       char *sndMsgBuf,   // message buffer for message sent to slave
+       char *ackMsgBuf);  // message buffer for acknowledgement from slave
 
 #endif /* _ASP_MSG_MASTER_H_ */