[processor-sdk/pdk.git] / packages / ti / drv / sciclient / soc / sysfw / binaries / system-firmware-public-documentation / 2_tisci_msgs / rm / rm_proxy.html
3 <!DOCTYPE html>
4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6 <head>
7 <meta charset="utf-8">
9 <meta name="viewport" content="width=device-width, initial-scale=1.0">
11 <title>Resource Management Proxy TISCI Message Description — TISCI User Guide</title>
16 <link rel="shortcut icon" href="../../_static/favicon.ico"/>
29 <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
33 <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
37 <link rel="index" title="Index"
38 href="../../genindex.html"/>
39 <link rel="search" title="Search" href="../../search.html"/>
40 <link rel="top" title="TISCI User Guide" href="../../index.html"/>
41 <link rel="up" title="Chapter 2: TISCI Message Documentation" href="../index.html"/>
42 <link rel="next" title="Resource Management Ring Accelerator TISCI Message Description" href="rm_ra.html"/>
43 <link rel="prev" title="Resource Management IRQ TISCI Message Description" href="rm_irq.html"/>
46 <script src="../../_static/js/modernizr.min.js"></script>
48 </head>
50 <body class="wy-body-for-nav" role="document">
51 <header id="tiHeader">
52 <div class="top">
53 <ul>
54 <li id="top_logo">
55 <a href="http://www.ti.com">
56 <img src="../../_static/img/ti_logo.png"/>
57 </a>
58 </li>
59 </ul>
60 </div>
61 <div class="nav"></div>
62 </header>
63 <div class="wy-grid-for-nav">
66 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
67 <div class="wy-side-scroll">
68 <div class="wy-side-nav-search">
72 <a href="../../index.html" class="icon icon-home"> TISCI
76 </a>
81 <div class="version">
82 20.05.00
83 </div>
88 <div role="search">
89 <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
90 <input type="text" name="q" placeholder="Search docs" />
91 <input type="hidden" name="check_keywords" value="yes" />
92 <input type="hidden" name="area" value="default" />
93 </form>
94 </div>
97 </div>
99 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
103 <ul class="current">
104 <li class="toctree-l1"><a class="reference internal" href="../../1_intro/index.html">Chapter 1: Introduction</a></li>
105 <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Chapter 2: TISCI Message Documentation</a><ul class="current">
106 <li class="toctree-l2"><a class="reference internal" href="../general/TISCI_header.html">Texas Instruments System Controller Interface (TISCI)</a></li>
107 <li class="toctree-l2"><a class="reference internal" href="../index.html#general">General</a></li>
108 <li class="toctree-l2"><a class="reference internal" href="../index.html#power-management-pm">Power Management (PM)</a></li>
109 <li class="toctree-l2 current"><a class="reference internal" href="../index.html#resource-management-rm">Resource Management (RM)</a><ul class="current">
110 <li class="toctree-l3"><a class="reference internal" href="rm_irq.html">Resource Management IRQ TISCI Message Description</a></li>
111 <li class="toctree-l3 current"><a class="current reference internal" href="#">Resource Management Proxy TISCI Message Description</a><ul>
112 <li class="toctree-l4"><a class="reference internal" href="#introduction">Introduction</a></li>
113 <li class="toctree-l4"><a class="reference internal" href="#tisci-msg-rm-proxy-cfg-proxy-configuration">TISCI_MSG_RM_PROXY_CFG - Proxy Configuration</a></li>
114 </ul>
115 </li>
116 <li class="toctree-l3"><a class="reference internal" href="rm_ra.html">Resource Management Ring Accelerator TISCI Message Description</a></li>
117 <li class="toctree-l3"><a class="reference internal" href="rm_udmap.html">Resource Management UDMAP TISCI Message Description</a></li>
118 <li class="toctree-l3"><a class="reference internal" href="rm_psil.html">Resource Management PSI-L TISCI Message Description</a></li>
119 </ul>
120 </li>
121 <li class="toctree-l2"><a class="reference internal" href="../index.html#secure-management">Secure Management</a></li>
122 </ul>
123 </li>
124 <li class="toctree-l1"><a class="reference internal" href="../../3_boardcfg/index.html">Chapter 3: Board Configuration</a></li>
125 <li class="toctree-l1"><a class="reference internal" href="../../4_trace/index.html">Chapter 4: Interpreting Trace Data</a></li>
126 <li class="toctree-l1"><a class="reference internal" href="../../5_soc_doc/index.html">Chapter 5: SoC Family Specific Documentation</a></li>
127 <li class="toctree-l1"><a class="reference internal" href="../../6_topic_user_guides/index.html">Chapter 6: Topic User Guides</a></li>
128 </ul>
132 </div>
133 </div>
134 </nav>
136 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
139 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
140 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
141 <a href="../../index.html">TISCI</a>
142 </nav>
146 <div class="wy-nav-content">
147 <div class="rst-content">
154 <div role="navigation" aria-label="breadcrumbs navigation">
155 <ul class="wy-breadcrumbs">
156 <li><a href="../../index.html">Docs</a> »</li>
158 <li><a href="../index.html">Chapter 2: TISCI Message Documentation</a> »</li>
160 <li>Resource Management Proxy TISCI Message Description</li>
161 <li class="wy-breadcrumbs-aside">
165 </li>
166 </ul>
167 <hr/>
168 </div>
169 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
170 <div itemprop="articleBody">
172 <div class="section" id="resource-management-proxy-tisci-message-description">
173 <h1>Resource Management Proxy TISCI Message Description<a class="headerlink" href="#resource-management-proxy-tisci-message-description" title="Permalink to this headline">¶</a></h1>
174 <div class="section" id="introduction">
175 <h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
176 <p>This chapter provides information on usage of the RM Proxy management
177 TISCI message API parameters.</p>
178 <table border="1" class="docutils">
179 <colgroup>
180 <col width="19%" />
181 <col width="81%" />
182 </colgroup>
183 <thead valign="bottom">
184 <tr class="row-odd"><th class="head">TISCI Message ID</th>
185 <th class="head">Message Name</th>
186 </tr>
187 </thead>
188 <tbody valign="top">
189 <tr class="row-even"><td>0x1300</td>
190 <td><a class="reference internal" href="#pub-rm-public-proxy-cfg"><span class="std std-ref">TISCI_MSG_RM_PROXY_CFG</span></a></td>
191 </tr>
192 <tr class="row-odd"><td>N/A</td>
193 <td><a class="reference internal" href="#pub-rm-public-proxy-cfg-response"><span class="std std-ref">TISCI_MSG_RM_PROXY_CFG Response</span></a></td>
194 </tr>
195 </tbody>
196 </table>
197 <div class="section" id="proxy-valid-parameters-field-usage">
198 <span id="pub-rm-public-proxy-valid-params"></span><h3>Proxy Valid Parameters Field Usage<a class="headerlink" href="#proxy-valid-parameters-field-usage" title="Permalink to this headline">¶</a></h3>
199 <p>Some proxy TISCI message APIs make use of a valid_params bit field. Bits within
200 the valid_params field define whether or not individual TISCI message
201 parameters are valid. When a bit corresponding to a parameter is set (to 1)
202 the parameter is considered valid and will be programmed into its
203 corresponding register field, assuming validation of the parameter passes.
204 When a valid_params bit is not set, i.e. a value of 0, the corresponding
205 register field is read and used within the validation process of the request.
206 The register field for a parameter is not programmed if the corresponding
207 valid_params bit is not set.</p>
208 </div>
209 </div>
210 <div class="section" id="tisci-msg-rm-proxy-cfg-proxy-configuration">
211 <h2>TISCI_MSG_RM_PROXY_CFG - Proxy Configuration<a class="headerlink" href="#tisci-msg-rm-proxy-cfg-proxy-configuration" title="Permalink to this headline">¶</a></h2>
212 <div class="section" id="proxy-configuration-request">
213 <span id="pub-rm-public-proxy-cfg"></span><h3>Proxy Configuration Request<a class="headerlink" href="#proxy-configuration-request" title="Permalink to this headline">¶</a></h3>
214 <p>The <strong>proxy_cfg</strong> TISCI message API is used to configure the channelized
215 firewalls of a Navigator Subsystem proxy. The proxy index must be assigned to
216 the host defined in the TISCI header via the RM board configuration resource
217 assignment range list. The channelized firewalls covering the proxy error
218 events are configured to only give DMSC write access. The proxy target data
219 control region channelized firewalls are configured to give the assigned host
220 read and write access.</p>
221 <div class="section" id="usage">
222 <h4>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h4>
223 <table border="1" class="docutils">
224 <colgroup>
225 <col width="75%" />
226 <col width="25%" />
227 </colgroup>
228 <tbody valign="top">
229 <tr class="row-odd"><td><strong>Message Type</strong></td>
230 <td>Normal</td>
231 </tr>
232 <tr class="row-even"><td><strong>Secure Queue Only?</strong></td>
233 <td>No</td>
234 </tr>
235 </tbody>
236 </table>
237 </div>
238 <div class="section" id="tisci-message-id">
239 <h4>TISCI Message ID<a class="headerlink" href="#tisci-message-id" title="Permalink to this headline">¶</a></h4>
240 <p><p><code class="docutils literal notranslate"><span class="pre">TISCI_MSG_RM_PROXY_CFG</span>          <span class="pre">(0x1300U)</span></code></p>
241 <p>RM TISCI message to setup a Navigator Subsystem proxy for
242 configuration</p>
243 </p>
244 </div>
245 <div class="section" id="proxy-configuration-message-parameters">
246 <h4>Proxy Configuration Message Parameters<a class="headerlink" href="#proxy-configuration-message-parameters" title="Permalink to this headline">¶</a></h4>
247 <p><p><strong>struct tisci_msg_rm_proxy_cfg_req</strong></p>
248 <p>Configures a Navigator Subsystem proxy</p>
249 <table border="1" class="docutils">
250 <colgroup>
251 <col width="7%" />
252 <col width="11%" />
253 <col width="82%" />
254 </colgroup>
255 <thead valign="bottom">
256 <tr class="row-odd"><th class="head">Parameter</th>
257 <th class="head">Type</th>
258 <th class="head">Description</th>
259 </tr>
260 </thead>
261 <tbody valign="top">
262 <tr class="row-even"><td>hdr</td>
263 <td>struct tisci_header</td>
264 <td>Standard TISCI header</td>
265 </tr>
266 <tr class="row-odd"><td>valid_params</td>
267 <td>u32</td>
268 <td>Bitfield defining validity of proxy configuration parameters. This field is unused at the moment but exists if expansion of the API is needed in the future.</td>
269 </tr>
270 <tr class="row-even"><td>nav_id</td>
271 <td>u16</td>
272 <td>SoC device ID of Navigator Subsystem where proxy is located</td>
273 </tr>
274 <tr class="row-odd"><td>index</td>
275 <td>u16</td>
276 <td>Proxy index.</td>
277 </tr>
278 </tbody>
279 </table>
280 <p>Configures the channelized firewalls of a Navigator Subsystem
281 proxy. The firewalls are configured to all the header host access to the
282 backing RAM and target data configuration registers. The proxy index must
283 be assigned to the host defined in the TISCI header via the RM board
284 configuration resource assignment range list.</p>
285 </p>
286 </div>
287 </div>
288 <div class="section" id="proxy-configuration-response">
289 <span id="pub-rm-public-proxy-cfg-response"></span><h3>Proxy Configuration Response<a class="headerlink" href="#proxy-configuration-response" title="Permalink to this headline">¶</a></h3>
290 <p>The <strong>proxy_cfg_response</strong> message returns the result status of the
291 processed <strong>proxy_cfg</strong> message.</p>
292 <div class="section" id="proxy-configuration-response-message-parameters">
293 <h4>Proxy Configuration Response Message Parameters<a class="headerlink" href="#proxy-configuration-response-message-parameters" title="Permalink to this headline">¶</a></h4>
294 <p><p><strong>struct tisci_msg_rm_proxy_cfg_resp</strong></p>
295 <p>Response to configuring a proxy.</p>
296 <table border="1" class="docutils">
297 <colgroup>
298 <col width="23%" />
299 <col width="37%" />
300 <col width="40%" />
301 </colgroup>
302 <thead valign="bottom">
303 <tr class="row-odd"><th class="head">Parameter</th>
304 <th class="head">Type</th>
305 <th class="head">Description</th>
306 </tr>
307 </thead>
308 <tbody valign="top">
309 <tr class="row-even"><td>hdr</td>
310 <td>struct tisci_header</td>
311 <td>Standard TISCI header</td>
312 </tr>
313 </tbody>
314 </table>
315 </p>
316 </div>
317 </div>
318 </div>
319 </div>
322 </div>
323 </div>
324 <footer>
326 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
328 <a href="rm_ra.html" class="btn btn-neutral float-right" title="Resource Management Ring Accelerator TISCI Message Description" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
331 <a href="rm_irq.html" class="btn btn-neutral" title="Resource Management IRQ TISCI Message Description" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
333 </div>
336 <hr/>
338 <div role="contentinfo">
339 <p>
340 <a href="http://www.ti.com/corp/docs/legal/copyright.shtml">© Copyright 2016-2020</a>, Texas Instruments Incorporated. All rights reserved. <br>
341 <a href="http://www.ti.com/corp/docs/legal/trademark/trademrk.htm">Trademarks</a> | <a href="http://www.ti.com/corp/docs/legal/privacy.shtml">Privacy policy</a> | <a href="http://www.ti.com/corp/docs/legal/termsofuse.shtml">Terms of use</a> | <a href="http://www.ti.com/lsds/ti/legal/termsofsale.page">Terms of sale</a>
343 </p>
344 </div>
346 </footer>
348 </div>
349 </div>
351 </section>
353 </div>
359 <script type="text/javascript">
360 var DOCUMENTATION_OPTIONS = {
361 URL_ROOT:'../../',
362 VERSION:'20.05.00',
363 COLLAPSE_INDEX:false,
364 FILE_SUFFIX:'.html',
365 HAS_SOURCE: true
366 };
367 </script>
368 <script type="text/javascript" src="../../_static/jquery.js"></script>
369 <script type="text/javascript" src="../../_static/underscore.js"></script>
370 <script type="text/javascript" src="../../_static/doctools.js"></script>
371 <script type="text/javascript" src="../../_static/language_data.js"></script>
373 <script src="http://www.ti.com/assets/js/headerfooter/analytics.js" type="text/javascript" charset="utf-8"></script>
379 <script type="text/javascript" src="../../_static/js/theme.js"></script>
384 <script type="text/javascript">
385 jQuery(function () {
386 SphinxRtdTheme.StickyNav.enable();
387 });
389 var menuHeight = window.innerHeight;
391 var contentOffset = $(".wy-nav-content-wrap").offset();
392 var contentHeight = $(".wy-nav-content-wrap").height();
393 var contentBottom = contentOffset.top + contentHeight;
395 function setNavbarTop() {
396 var scrollTop = $(window).scrollTop();
397 var maxTop = scrollTop + menuHeight;
399 // If past the header
400 if (scrollTop > contentOffset.top && maxTop < contentBottom) {
401 stickyTop = scrollTop - contentOffset.top;
402 } else if (maxTop > contentBottom) {
403 stickyTop = scrollTop - contentOffset.top - (maxTop - contentBottom);
404 } else {
405 stickyTop = 0;
406 }
408 $(".wy-nav-side").css("top", stickyTop);
409 }
411 $(document).ready(function() {
412 setNavbarTop();
413 $(window).scroll(function () {
414 setNavbarTop();
415 });
417 $('body').on("mousewheel", function () {
418 // Remove default behavior
419 event.preventDefault();
420 // Scroll without smoothing
421 var wheelDelta = event.wheelDelta;
422 var currentScrollPosition = window.pageYOffset;
423 window.scrollTo(0, currentScrollPosition - wheelDelta);
424 });
425 });
426 </script>
429 </body>
430 </html>