IPC API  3.40.00.06
GateMPAppCommon.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013, 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  */
32 
33 /*
34  * ======== GateMPAppCommon.h ========
35  *
36  */
37 
38 #ifndef GateMPAppCommon__include
39 #define GateMPAppCommon__include
40 #if defined (__cplusplus)
41 extern "C" {
42 #endif
43 
44 
45 /*
46  * ======== Application Configuration ========
47  */
48 
49 /* notify commands 00 - FF */
50 #define GATEMPAPP_CMD_MASK 0xFF000000
51 
52 /* used by host and remote device to synchronize states with each other*/
53 #define GATEMPAPP_CMD_SPTR_ADDR 0x10000000
54 #define GATEMPAPP_CMD_SPTR_ADDR_ACK 0x12000000
55 #define GATEMPAPP_CMD_SHUTDOWN_ACK 0x20000000
56 #define GATEMPAPP_CMD_SHUTDOWN 0x21000000
57 #define GATEMPAPP_CMD_SYNC 0x30000000
58 
59 /* GateMP instance created on host */
60 #define GATEMP_HOST_NAME "GATE_MP1"
61 /* GateMP instance created on slave */
62 #define GATEMP_SLAVE_NAME "GATE_MP2"
63 
64 /* queue error message*/
65 #define GATEMPAPP_E_FAILURE 0xF0000000
66 #define GATEMPAPP_E_UNEXPECTEDMSG 0xF2000000
67 
68 /* Number of times to lock/unlock */
69 #define LOOP_ITR 300
70 
71 typedef struct {
73  UInt32 cmd;
74  UInt32 payload;
76 
77 #define GateMPApp_MsgHeapId 0
78 #define GateMPApp_HostMsgQueName "HOST:MsgQ:01"
79 #define GateMPApp_SlaveMsgQueName "SLAVE:MsgQ:01"
80 
81 #if defined (__cplusplus)
82 }
83 #endif /* defined (__cplusplus) */
84 #endif /* GateMPAppCommon__include */
Definition: GateMPAppCommon.h:71
MessageQ_MsgHeader reserved
Definition: GateMPAppCommon.h:72
Required first field in every message.
Definition: MessageQ.h:601
UInt32 cmd
Definition: GateMPAppCommon.h:73
UInt32 payload
Definition: GateMPAppCommon.h:74
Copyright 2015, Texas Instruments Incorporated