[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / ipc / remoteproc / Resource-src.html
diff --git a/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/ipc/remoteproc/Resource-src.html b/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/ipc/remoteproc/Resource-src.html
+++ /dev/null
@@ -1,186 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><title>module ti.ipc.remoteproc.Resource</title>
-<meta name="googlebot" content="noindex,nofollow">
-<link rel="stylesheet" type="text/css" href="../../../src.css"/>
-</head>
-<body>
-<pre class=src>
- 1 <span class="comment">/*
-</span> 2 <span class="comment"> * Copyright (c) 2011-2013, Texas Instruments Incorporated
-</span> 3 <span class="comment"> * All rights reserved.
-</span> 4 <span class="comment"> *
-</span> 5 <span class="comment"> * Redistribution and use in source and binary forms, with or without
-</span> 6 <span class="comment"> * modification, are permitted provided that the following conditions
-</span> 7 <span class="comment"> * are met:
-</span> 8 <span class="comment"> *
-</span> 9 <span class="comment"> * * Redistributions of source code must retain the above copyright
-</span> 10 <span class="comment"> * notice, this list of conditions and the following disclaimer.
-</span> 11 <span class="comment"> *
-</span> 12 <span class="comment"> * * Redistributions in binary form must reproduce the above copyright
-</span> 13 <span class="comment"> * notice, this list of conditions and the following disclaimer in the
-</span> 14 <span class="comment"> * documentation and/or other materials provided with the distribution.
-</span> 15 <span class="comment"> *
-</span> 16 <span class="comment"> * * Neither the name of Texas Instruments Incorporated nor the names of
-</span> 17 <span class="comment"> * its contributors may be used to endorse or promote products derived
-</span> 18 <span class="comment"> * from this software without specific prior written permission.
-</span> 19 <span class="comment"> *
-</span> 20 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-</span> 21 <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-</span> 22 <span class="comment"> * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-</span> 23 <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
-</span> 24 <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-</span> 25 <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-</span> 26 <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
-</span> 27 <span class="comment"> * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-</span> 28 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-</span> 29 <span class="comment"> * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
-</span> 30 <span class="comment"> * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-</span> 31 <span class="comment"> */</span>
- 32
- 33 <span class="comment">/*
-</span> 34 <span class="comment"> * ======== Resource.xdc ========
-</span> 35 <span class="comment"> */</span>
- 36
- 37 <span class="xdoc">/*!
-</span> 38 <span class="xdoc"> * ======== Resource ========
-</span> 39 <span class="xdoc"> * Resource Module
-</span> 40 <span class="xdoc"> */</span>
- 41
- 42 @Template(<span class="string">"./Resource.xdt"</span>)
- 43 @ModuleStartup
- 44 <span class=key>module</span> Resource {
- 45
- 46 <span class="xdoc">/*!
-</span> 47 <span class="xdoc"> * <b>@def</b> Resource_loadAddr
-</span> 48 <span class="xdoc"> * <b>@brief</b> Default load address for the Resource table
-</span> 49 <span class="xdoc"> */</span>
- 50 <span class=key>metaonly</span> <span class=key>config</span> UInt loadAddr = 0x3000;
- 51
- 52 <span class="xdoc">/*!
-</span> 53 <span class="xdoc"> * <b>@def</b> Resource_loadSegment
-</span> 54 <span class="xdoc"> * <b>@brief</b> If loadSegment is defined, loadAddr is overridden with the base
-</span> 55 <span class="xdoc"> * address of the loadSegment
-</span> 56 <span class="xdoc"> */</span>
- 57 <span class=key>metaonly</span> <span class=key>config</span> String loadSegment;
- 58
- 59 <span class="xdoc">/*!
-</span> 60 <span class="xdoc"> * <b>@def</b> Resource_traceOnly
-</span> 61 <span class="xdoc"> * <b>@brief</b> Set traceOnly to true in order to get an image with trace
-</span> 62 <span class="xdoc"> * resources only, and without VRINGs.
-</span> 63 <span class="xdoc"> * Implemented only for the Keystone II (TCI6638) platform.
-</span> 64 <span class="xdoc"> */</span>
- 65 <span class=key>metaonly</span> <span class=key>config</span> Bool traceOnly = <span class=key>false</span>;
- 66
- 67 <span class="xdoc">/*!
-</span> 68 <span class="xdoc"> * Flag to indicate the user will provide a custom resource table
-</span> 69 <span class="xdoc"> *
-</span> 70 <span class="xdoc"> * If false (the default), a default resource table will be
-</span> 71 <span class="xdoc"> * created during configuration.
-</span> 72 <span class="xdoc"> *
-</span> 73 <span class="xdoc"> * If true, the user must supply their own resource table.
-</span> 74 <span class="xdoc"> * Fundamentally, this amounts to providing a well-formed
-</span> 75 <span class="xdoc"> * resource_table structure named 'ti_ipc_remoteproc_ResourceTable'.
-</span> 76 <span class="xdoc"> */</span>
- 77 <span class=key>metaonly</span> <span class=key>config</span> Bool customTable = <span class=key>false</span>;
- 78
- 79 <span class="xdoc">/*!
-</span> 80 <span class="xdoc"> * <b>@def</b> Resource_S_SUCCESS
-</span> 81 <span class="xdoc"> * <b>@brief</b> Operation is successful.
-</span> 82 <span class="xdoc"> */</span>
- 83 <span class=key>const</span> Int S_SUCCESS = 0;
- 84
- 85 <span class="xdoc">/*!
-</span> 86 <span class="xdoc"> * <b>@def</b> Resource_E_NOTFOUND
-</span> 87 <span class="xdoc"> * <b>@brief</b> Element was not found in table
-</span> 88 <span class="xdoc"> */</span>
- 89 <span class=key>const</span> Int E_NOTFOUND = -1;
- 90
- 91 <span class="xdoc">/*!
-</span> 92 <span class="xdoc"> * <b>@def</b> Resource_RscTable
-</span> 93 <span class="xdoc"> *
-</span> 94 <span class="xdoc"> * <b>@brief</b> An open-ended type-length-value based resource table
-</span> 95 <span class="xdoc"> */</span>
- 96 <span class=key>struct</span> RscTable {
- 97 UInt32 ver;
- 98 UInt32 num;
- 99 UInt32 reserved[2];
- 100 UInt32 offset[1];
- 101 };
- 102
- 103 <span class="xdoc">/*!
-</span> 104 <span class="xdoc"> * <b>@def</b> Resource_MemEntry
-</span> 105 <span class="xdoc"> *
-</span> 106 <span class="xdoc"> * <b>@brief</b> A Resource Table memory type record
-</span> 107 <span class="xdoc"> */</span>
- 108 <span class=key>struct</span> MemEntry {
- 109 UInt32 type;
- 110 UInt32 da; <span class="comment">/* Device Virtual Address */</span>
- 111 UInt32 pa; <span class="comment">/* Physical Address */</span>
- 112 UInt32 len;
- 113 UInt32 flags;
- 114 UInt32 reserved;
- 115 Char name[32];
- 116 };
- 117
- 118 <span class="xdoc">/*!
-</span> 119 <span class="xdoc"> * <b>@brief</b> Virtual to Physical address translation function
-</span> 120 <span class="xdoc"> *
-</span> 121 <span class="xdoc"> * <b>@sa</b> Resource_physToVirt
-</span> 122 <span class="xdoc"> */</span>
- 123 @DirectCall
- 124 Int virtToPhys(UInt32 da, UInt32 *pa);
- 125
- 126 <span class="xdoc">/*!
-</span> 127 <span class="xdoc"> * <b>@brief</b> Physical to Virtual address translation function
-</span> 128 <span class="xdoc"> *
-</span> 129 <span class="xdoc"> * <b>@sa</b> Resource_virtToPhys
-</span> 130 <span class="xdoc"> */</span>
- 131 @DirectCall
- 132 Int physToVirt(UInt32 pa, UInt32 *da);
- 133
- 134 <span class="xdoc">/*!
-</span> 135 <span class="xdoc"> * <b>@brief</b> Get the Trace Buffer address from resource table.
-</span> 136 <span class="xdoc"> *
-</span> 137 <span class="xdoc"> * <b>@return</b> Pointer to trace buffer, or NULL if not found.
-</span> 138 <span class="xdoc"> */</span>
- 139 @DirectCall
- 140 Ptr getTraceBufPtr();
- 141
- 142 <span class="xdoc">/*!
-</span> 143 <span class="xdoc"> * <b>@brief</b> Get the status field of the VDEV, given the fw_rsc_vdev id.
-</span> 144 <span class="xdoc"> *
-</span> 145 <span class="xdoc"> * <b>@return</b> status value which is set by Virtio device on HLOS.
-</span> 146 <span class="xdoc"> */</span>
- 147 @DirectCall
- 148 Char getVdevStatus(UInt32 id);
- 149
- 150 <span class="xdoc">/*!
-</span> 151 <span class="xdoc"> * <b>@brief</b> Get the nth (vqId) vring address from the VDEV struct.
-</span> 152 <span class="xdoc"> *
-</span> 153 <span class="xdoc"> * <b>@return</b> NULL if no VDEV found, or vqId is not found.
-</span> 154 <span class="xdoc"> */</span>
- 155 @DirectCall
- 156 Ptr getVringDA(UInt32 vqId);
- 157
- 158 <span class=key>internal</span>: <span class="comment">/* not for client use */</span>
- 159
- 160 <span class="xdoc">/*!
-</span> 161 <span class="xdoc"> * <b>@brief</b> Use resource and resourceLen so table could be properly
-</span> 162 <span class="xdoc"> * allocated
-</span> 163 <span class="xdoc"> *
-</span> 164 <span class="xdoc"> */</span>
- 165 Void init();
- 166
- 167 <span class="xdoc">/*!
-</span> 168 <span class="xdoc"> * <b>@brief</b> Return the i-th entry in the resource table if the entry
-</span> 169 <span class="xdoc"> * is of type CARVEOUT or DEVMEM, or NULL otherwise.
-</span> 170 <span class="xdoc"> *
-</span> 171 <span class="xdoc"> */</span>
- 172 MemEntry *getMemEntry(UInt index);
- 173
- 174 <span class=key>struct</span> Module_State {
- 175 RscTable *pTable; <span class="comment">/* Resource Resource Table pointer */</span>
- 176 };
- 177 }
-</pre>
-</body></html>