IPC API  3.40.00.06
MmType.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012-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 
41 #ifndef ti_ipc_mm_MmType__include
42 #define ti_ipc_mm_MmType__include
43 
44 #include <ti/grcm/RcmServer.h>
45 
46 #if defined(__cplusplus)
47 extern "C" {
48 #endif
49 
53 #define MmType_MAX_NAMELEN (64)
54 
58 #define MmType_MAX_PARAMS (10)
59 
66 #define MmType_NumElem(x) (sizeof(x)/sizeof((x)[0]))
67 
74 typedef enum {
79 } MmType_Dir;
80 
84 typedef enum {
94 
99 
100 #define MmType_PtrType(type) ((type) | MmType_Param_PTR)
101 
105 typedef struct {
106  UInt32 direction;
107  UInt32 type;
108  UInt32 count;
110 
116 typedef struct {
117  Char name[MmType_MAX_NAMELEN];
118  UInt32 numParam;
120 } MmType_FxnSig;
121 
126 typedef struct {
127  UInt count;
130 
135 typedef struct {
136  SizeT size;
137  SizeT data;
138 } MmType_Param;
139 
140 
141 #if defined(__cplusplus)
142 }
143 #endif
144 #endif /* ti_ipc_mm_MmType__include */
UInt count
Definition: MmType.h:127
#define MmType_MAX_PARAMS
Maximum number of parameters.
Definition: MmType.h:58
Definition: MmType.h:87
Definition: MmType.h:93
Definition: MmType.h:89
MmType_Dir
Parameter Direction.
Definition: MmType.h:74
MmType_ParamType
Parameter Type.
Definition: MmType.h:84
Definition: MmType.h:75
UInt32 type
Definition: MmType.h:107
Definition: MmType.h:85
Definition: MmType.h:92
Function Signature.
Definition: MmType.h:116
Definition: MmType.h:90
Marshalled Parameter structure.
Definition: MmType.h:135
Remote Command Message Server Module. An RcmServer processes inbound messages received from an RcmCli...
Definition: MmType.h:78
SizeT data
Definition: MmType.h:137
Function Signature Table.
Definition: MmType.h:126
UInt32 direction
Definition: MmType.h:106
Definition: MmType.h:97
Definition: MmType.h:88
Definition: MmType.h:77
Parameter Signature.
Definition: MmType.h:105
SizeT size
Definition: MmType.h:136
Definition: MmType.h:76
Definition: MmType.h:91
MmType_FxnSig * table
Definition: MmType.h:128
Definition: MmType.h:86
Definition: MmType.h:95
#define MmType_MAX_NAMELEN
Maximum function name length.
Definition: MmType.h:53
UInt32 count
Definition: MmType.h:108
UInt32 numParam
Definition: MmType.h:118
Copyright 2015, Texas Instruments Incorporated