[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / interfaces / IGateMPSupport-src.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html><head><title>interface ti.sdo.ipc.interfaces.IGateMPSupport</title>
3 <meta name="googlebot" content="noindex,nofollow">
4 <link rel="stylesheet" type="text/css" href="../../../../src.css"/>
5 </head>
6 <body>
7 <pre class=src>
8 1 <span class="comment">/*
9 </span> 2 <span class="comment"> * Copyright (c) 2012-2013, Texas Instruments Incorporated
10 </span> 3 <span class="comment"> * All rights reserved.
11 </span> 4 <span class="comment"> *
12 </span> 5 <span class="comment"> * Redistribution and use in source and binary forms, with or without
13 </span> 6 <span class="comment"> * modification, are permitted provided that the following conditions
14 </span> 7 <span class="comment"> * are met:
15 </span> 8 <span class="comment"> *
16 </span> 9 <span class="comment"> * * Redistributions of source code must retain the above copyright
17 </span> 10 <span class="comment"> * notice, this list of conditions and the following disclaimer.
18 </span> 11 <span class="comment"> *
19 </span> 12 <span class="comment"> * * Redistributions in binary form must reproduce the above copyright
20 </span> 13 <span class="comment"> * notice, this list of conditions and the following disclaimer in the
21 </span> 14 <span class="comment"> * documentation and/or other materials provided with the distribution.
22 </span> 15 <span class="comment"> *
23 </span> 16 <span class="comment"> * * Neither the name of Texas Instruments Incorporated nor the names of
24 </span> 17 <span class="comment"> * its contributors may be used to endorse or promote products derived
25 </span> 18 <span class="comment"> * from this software without specific prior written permission.
26 </span> 19 <span class="comment"> *
27 </span> 20 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28 </span> 21 <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
29 </span> 22 <span class="comment"> * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 </span> 23 <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
31 </span> 24 <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 </span> 25 <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 </span> 26 <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
34 </span> 27 <span class="comment"> * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
35 </span> 28 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
36 </span> 29 <span class="comment"> * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
37 </span> 30 <span class="comment"> * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 </span> 31 <span class="comment"> */</span>
39 32 <span class="comment">/*
40 </span> 33 <span class="comment"> * ======== IGateMPSupport.xdc ========
41 </span> 34 <span class="comment"> *
42 </span> 35 <span class="comment"> */</span>
43 36
44 37 import xdc.runtime.IGateProvider;
45 38
46 39 <span class="xdoc">/*!
47 </span> 40 <span class="xdoc"> * ======== IGateMPSupport ========
48 </span> 41 <span class="xdoc"> */</span>
49 42 <span class=key>interface</span> IGateMPSupport <span class=key>inherits</span> IGateProvider
50 43 {
51 44 <span class="xdoc">/*!
52 </span> 45 <span class="xdoc"> * ======== getNumResources ========
53 </span> 46 <span class="xdoc"> * Returns the number of resources offered by the GateMP delegate
54 </span> 47 <span class="xdoc"> */</span>
55 48 <span class=key>metaonly</span> UInt getNumResources();
56 49
57 50 <span class="xdoc">/*!
58 </span> 51 <span class="xdoc"> * ======== getReservedMask ========
59 </span> 52 <span class="xdoc"> * <b>@_nodoc</b>
60 </span> 53 <span class="xdoc"> * Used by GateMP to query which HW resources are reserved
61 </span> 54 <span class="xdoc"> */</span>
62 55 @DirectCall
63 56 Bits32 *getReservedMask();
64 57
65 58 <span class="xdoc">/*!
66 </span> 59 <span class="xdoc"> * ======== sharedMemReq ========
67 </span> 60 <span class="xdoc"> * Amount of shared memory required for creation of each instance
68 </span> 61 <span class="xdoc"> *
69 </span> 62 <span class="xdoc"> * The value returned by this function may depend on the cache alignment
70 </span> 63 <span class="xdoc"> * requirements for the shared region from which memory will be used.
71 </span> 64 <span class="xdoc"> *
72 </span> 65 <span class="xdoc"> * <b>@param(params)</b> Pointer to the parameters that will be used in
73 </span> 66 <span class="xdoc"> * the create.
74 </span> 67 <span class="xdoc"> *
75 </span> 68 <span class="xdoc"> * <b>@a(returns)</b> Number of MAUs needed to create the instance.
76 </span> 69 <span class="xdoc"> */</span>
77 70 @DirectCall
78 71 SizeT sharedMemReq(<span class=key>const</span> Params *params);
79 72
80 73 <span class="xdoc">/*!
81 </span> 74 <span class="xdoc"> * ======== getRemoteStatus$view ========
82 </span> 75 <span class="xdoc"> * <b>@_nodoc</b>
83 </span> 76 <span class="xdoc"> * ROV helper function that returns the status of the remote gate
84 </span> 77 <span class="xdoc"> *
85 </span> 78 <span class="xdoc"> * <b>@b(returns)</b> Gate status
86 </span> 79 <span class="xdoc"> */</span>
87 80 <span class=key>metaonly</span> String getRemoteStatus$view(IGateProvider.Handle handle);
88 81
89 82 <span class=key>instance</span>:
90 83
91 84 <span class="xdoc">/*!
92 </span> 85 <span class="xdoc"> * Logical resource id
93 </span> 86 <span class="xdoc"> */</span>
94 87 <span class=key>config</span> UInt resourceId = 0;
95 88
96 89 <span class="xdoc">/*! <b>@_nodoc</b>
97 </span> 90 <span class="xdoc"> * ======== openFlag ========
98 </span> 91 <span class="xdoc"> */</span>
99 92 <span class=key>config</span> Bool openFlag = <span class=key>false</span>;
100 93
101 94 <span class="xdoc">/*!
102 </span> 95 <span class="xdoc"> * ======== regionId ========
103 </span> 96 <span class="xdoc"> * <b>@_nodoc</b>
104 </span> 97 <span class="xdoc"> * Shared Region Id
105 </span> 98 <span class="xdoc"> *
106 </span> 99 <span class="xdoc"> * The ID corresponding to the shared region in which this shared instance
107 </span> 100 <span class="xdoc"> * is to be placed.
108 </span> 101 <span class="xdoc"> */</span>
109 102 <span class=key>config</span> UInt16 regionId = 0;
110 103
111 104 <span class="xdoc">/*!
112 </span> 105 <span class="xdoc"> * ======== sharedAddr ========
113 </span> 106 <span class="xdoc"> * Physical address of the shared memory
114 </span> 107 <span class="xdoc"> *
115 </span> 108 <span class="xdoc"> * This parameter is only used by GateMP delegates that use shared memory
116 </span> 109 <span class="xdoc"> */</span>
117 110 <span class=key>config</span> Ptr sharedAddr = <span class=key>null</span>;
118 111
119 112 <span class="xdoc">/*!
120 </span> 113 <span class="xdoc"> * ======== create ========
121 </span> 114 <span class="xdoc"> * Create a remote gate instance.
122 </span> 115 <span class="xdoc"> *
123 </span> 116 <span class="xdoc"> * A Non-NULL gate for local protection must be passed to the create
124 </span> 117 <span class="xdoc"> * call. If no local protection is desired, a
125 </span> 118 <span class="xdoc"> * {<b>@link</b> xdc.runtime.GateNull} handle must be passed in.
126 </span> 119 <span class="xdoc"> *
127 </span> 120 <span class="xdoc"> * <b>@param(localGate)</b> Gate to use for local protection.
128 </span> 121 <span class="xdoc"> */</span>
129 122 create(IGateProvider.Handle localGate);
130 123 }
131 </pre>
132 </body></html>