/*
Copyright (c) 2016, Texas Instruments Incorporated - http://www.ti.com/
All rights reserved.

* Redistribution and use in source and binary forms, with or without 
* modification, are permitted provided that the following conditions
* are met:
*
* Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution.
*
* Neither the name of Texas Instruments Incorporated nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/

#ifndef _ASP_MSG_MASTER_H_
#define _ASP_MSG_MASTER_H_

#include <xdc/std.h>
#include <ti/sysbios/heaps/HeapBuf.h>
#include <ti/ipc/MessageQ.h>

#define ASP_MSG_MASTER_SOK                      (  0 )
#define ASP_MSG_MASTER_HEAPBUF_CREATE_FAIL      ( -1 )
#define ASP_MSG_MASTER_MSGQ_REGHEAP_FAIL        ( -2 )
#define ASP_MSG_MASTER_MASTER_MSGQ_CREATE_FAIL  ( -3 )
#define ASP_MSG_MASTER_SLAVE_MSGQ_OPEN_FAIL     ( -4 )

#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
{
    UInt16              masterProcId;       // master processor id
    UInt16              slaveProcId;        // slave processor id
    MessageQ_Handle     masterQue;          // created locally
    MessageQ_QueueId    slaveQue;           // opened remotely
    UInt16              heapId;             // MessageQ heapId
    HeapBuf_Handle      heap;               // message heap
    Int                 msgSize;            // aligned size of message
    Int                 poolSize;           // size of message pool
    Ptr                 store;              // memory store for message pool
    UInt32              messageId;          // MS bit: reply bit, LS 31 bits: message id
} AspMsgMaster_Module;

/* module handle */
typedef AspMsgMaster_Module *   AspMsgMaster_Handle;

/* Initialize ASP master messaging */
Int AspMsgMaster_init(
    AspMsgMaster_Handle hAspMsgMaster, 
    UInt16 remoteProcId, 
    UInt16 numMsgs
);

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_ */