pasdk/test_dsp/framework/aspMsg_master.h

   1
   2 /*
   3 Copyright (c) 2016, Texas Instruments Incorporated - http://www.ti.com/
   4 All rights reserved.
   5
   6 * Redistribution and use in source and binary forms, with or without
   7 * modification, are permitted provided that the following conditions
   8 * are met:
   9 *
  10 * Redistributions of source code must retain the above copyright
  11 * notice, this list of conditions and the following disclaimer.
  12 *
  13 * Redistributions in binary form must reproduce the above copyright
  14 * notice, this list of conditions and the following disclaimer in the
  15 * documentation and/or other materials provided with the
  16 * distribution.
  17 *
  18 * Neither the name of Texas Instruments Incorporated nor the names of
  19 * its contributors may be used to endorse or promote products derived
  20 * from this software without specific prior written permission.
  21 *
  22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33 *
  34 */
  35
  36 #ifndef _ASP_MSG_MASTER_H_
  37 #define _ASP_MSG_MASTER_H_
  38
  39 #include <xdc/std.h>
  40 #include <ti/sysbios/heaps/HeapBuf.h>
  41 #include <ti/ipc/MessageQ.h>
  42
  43 #define ASP_MSG_MASTER_SOK                      (  0 )
  44 #define ASP_MSG_MASTER_HEAPBUF_CREATE_FAIL      ( -1 )
  45 #define ASP_MSG_MASTER_MSGQ_REGHEAP_FAIL        ( -2 )
  46 #define ASP_MSG_MASTER_MASTER_MSGQ_CREATE_FAIL  ( -3 )
  47 #define ASP_MSG_MASTER_SLAVE_MSGQ_OPEN_FAIL     ( -4 )
  48
  49 #define ASP_MSG_MASTER_DEF_NUMMSGS  ( 4 )
  50
  51 /* module structure */
  52 typedef struct AspMsgMaster_Module
  53 {
  54     UInt16              masterProcId;       // master processor id
  55     UInt16              slaveProcId;        // slave processor id
  56     MessageQ_Handle     masterQue;          // created locally
  57     MessageQ_QueueId    slaveQue;           // opened remotely
  58     UInt16              heapId;             // MessageQ heapId
  59     HeapBuf_Handle      heap;               // message heap
  60     Int                 msgSize;            // aligned size of message
  61     Int                 poolSize;           // size of message pool
  62     Ptr                 store;              // memory store for message pool
  63     UInt32              messageId;          // MS bit: reply bit, LS 31 bits: message id
  64 } AspMsgMaster_Module;
  65
  66 /* module handle */
  67 typedef AspMsgMaster_Module *   AspMsgMaster_Handle;
  68
  69 /* Initialize ASP master messaging */
  70 Int AspMsgMaster_init(
  71     AspMsgMaster_Handle hAspMsgMaster,
  72     UInt16 remoteProcId,
  73     UInt16 numMsgs
  74 );
  75
  76 extern AspMsgMaster_Handle hAspMsgMaster;
  77
  78
  79
  80 #endif /* _ASP_MSG_MASTER_H_ */