33c22b9cf2a621a8fd79bcf24c70d8067fae3ea0
[processor-sdk/big-data-ipc-examples.git] / host_bios / simple_buffer_example / shared / AppCommon.h
1 /*
2  * Copyright (c) 2017, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
33 /*
34  *  ======== AppCommon.h ========
35  *
36  */
38 #ifndef AppCommon__include
39 #define AppCommon__include
40 #if defined (__cplusplus)
41 extern "C" {
42 #endif
43 #include "bigdataxlat.h"
45 /*
46  *  ======== Application Configuration ========
47  */
49 /* notify commands 00 - FF */
50 #define App_CMD_MASK                   0xFF000000
51 #define App_CMD_NOP                    0x00000000
52 #define App_CMD_SHARED_REGION_INIT     0x00000001
53 #define App_CMD_BIGDATA                0x00000002
54 #define App_CMD_SHUTDOWN               0x02000000
56 typedef struct {
57     UInt64              base;
58     UInt64              size;
59 } SharedRegionInitCfg;
61 typedef struct {
62     MessageQ_MsgHeader  reserved;
63     UInt32              cmd;
64     Int32               id;
65     UInt16              regionId;
66     union {
67         SharedRegionInitCfg sharedRegionInitCfg;
68         bigDataSharedDesc_t bigDataSharedDesc;
69     } u;
70 } App_Msg;
72 #define App_MsgHeapId           0
73 #define App_HostMsgQueName      "HOST:MsgQ:01"
74 #define App_SlaveMsgQueName     "%s:MsgQ:01"  /* %s is each slave's Proc Name */
76 #define BIGDATA_SIZE 16384
78 #define BIGDATA_ALIGN 1
80 #if defined (__cplusplus)
81 }
82 #endif /* defined (__cplusplus) */
83 #endif /* AppCommon__include */