packages/ti/drv/sciclient/soc/sysfw/binaries/system-firmware-public-documentation/2_tisci_msgs/pm/sysreset.html

   1
   2
   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">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>TISCI PM System Reset API Documentation &mdash; TISCI User Guide</title>
  12
  13
  14
  15
  16     <link rel="shortcut icon" href="../../_static/favicon.ico"/>
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29     <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
  30
  31
  32
  33     <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
  34
  35
  36
  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 IRQ TISCI Message Description" href="../rm/rm_irq.html"/>
  43         <link rel="prev" title="TISCI PM Clock API Documentation" href="clocks.html"/>
  44
  45
  46   <script src="../../_static/js/modernizr.min.js"></script>
  47
  48 </head>
  49
  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">
  64
  65
  66     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  67       <div class="wy-side-scroll">
  68         <div class="wy-side-nav-search">
  69
  70
  71
  72             <a href="../../index.html" class="icon icon-home"> TISCI
  73
  74
  75
  76           </a>
  77
  78
  79
  80
  81               <div class="version">
  82                 20.00.02
  83               </div>
  84
  85
  86
  87
  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>
  95
  96
  97         </div>
  98
  99         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 100
 101
 102
 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 current"><a class="reference internal" href="../index.html#power-management-pm">Power Management (PM)</a><ul class="current">
 109 <li class="toctree-l3"><a class="reference internal" href="devices.html">TISCI PM Device API Documentation</a></li>
 110 <li class="toctree-l3"><a class="reference internal" href="clocks.html">TISCI PM Clock API Documentation</a></li>
 111 <li class="toctree-l3 current"><a class="current reference internal" href="#">TISCI PM System Reset API Documentation</a><ul>
 112 <li class="toctree-l4"><a class="reference internal" href="#tisci-msg-sys-reset">TISCI_MSG_SYS_RESET</a></li>
 113 </ul>
 114 </li>
 115 </ul>
 116 </li>
 117 <li class="toctree-l2"><a class="reference internal" href="../index.html#resource-management-rm">Resource Management (RM)</a></li>
 118 <li class="toctree-l2"><a class="reference internal" href="../index.html#secure-management">Secure Management</a></li>
 119 </ul>
 120 </li>
 121 <li class="toctree-l1"><a class="reference internal" href="../../3_boardcfg/index.html">Chapter 3: Board Configuration</a></li>
 122 <li class="toctree-l1"><a class="reference internal" href="../../4_trace/index.html">Chapter 4: Interpreting Trace Data</a></li>
 123 <li class="toctree-l1"><a class="reference internal" href="../../5_soc_doc/index.html">Chapter 5: SoC Family Specific Documentation</a></li>
 124 <li class="toctree-l1"><a class="reference internal" href="../../6_topic_user_guides/index.html">Chapter 6: Topic User Guides</a></li>
 125 </ul>
 126
 127
 128
 129         </div>
 130       </div>
 131     </nav>
 132
 133     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 134
 135
 136       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 137         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 138         <a href="../../index.html">TISCI</a>
 139       </nav>
 140
 141
 142
 143       <div class="wy-nav-content">
 144         <div class="rst-content">
 145
 146
 147
 148
 149
 150
 151 <div role="navigation" aria-label="breadcrumbs navigation">
 152   <ul class="wy-breadcrumbs">
 153     <li><a href="../../index.html">Docs</a> &raquo;</li>
 154
 155           <li><a href="../index.html">Chapter 2: TISCI Message Documentation</a> &raquo;</li>
 156
 157     <li>TISCI PM System Reset API Documentation</li>
 158       <li class="wy-breadcrumbs-aside">
 159
 160
 161
 162       </li>
 163   </ul>
 164   <hr/>
 165 </div>
 166           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 167            <div itemprop="articleBody">
 168
 169   <div class="section" id="tisci-pm-system-reset-api-documentation">
 170 <h1>TISCI PM System Reset API Documentation<a class="headerlink" href="#tisci-pm-system-reset-api-documentation" title="Permalink to this headline">¶</a></h1>
 171 <p>This document describes the TISCI API for issuing warm reset to a domain.</p>
 172 <div class="section" id="tisci-msg-sys-reset">
 173 <span id="pm-sysreset-msg-sys-reset"></span><h2>TISCI_MSG_SYS_RESET<a class="headerlink" href="#tisci-msg-sys-reset" title="Permalink to this headline">¶</a></h2>
 174 <div class="section" id="objective">
 175 <h3>Objective<a class="headerlink" href="#objective" title="Permalink to this headline">¶</a></h3>
 176 <p>Request for a software warm reset of a domain.</p>
 177 </div>
 178 <div class="section" id="usage">
 179 <h3>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h3>
 180 <table border="1" class="docutils">
 181 <colgroup>
 182 <col width="75%" />
 183 <col width="25%" />
 184 </colgroup>
 185 <tbody valign="top">
 186 <tr class="row-odd"><td><strong>Message Type</strong></td>
 187 <td>Normal</td>
 188 </tr>
 189 <tr class="row-even"><td><strong>Secure Queue Only?</strong></td>
 190 <td>No</td>
 191 </tr>
 192 </tbody>
 193 </table>
 194 <p>User can use this API to issue software warm reset of a domain. The domain
 195 definition may vary from SoC to SoC. Depending on the SoC, certain domain
 196 reset could be defined to be equivalent to a system-wide reset. The reset
 197 brings the device or part of the device to a known state after events such
 198 as power-up, hardware request, or software request. The domain reset can
 199 be used for error handling and recovery.</p>
 200 <p>To maintain backward compatibility, when a user leaves the domain parameter
 201 empty, the API would process the message with the DOMGRP_COMPATIBILITY as
 202 the domain value.</p>
 203 <p>After calling the TISCI_MSG_SYS_RESET API, the chosen domain will be
 204 deinitialized. The user is responsible for reconfiguring the devices in the
 205 chosen domain by resending the board configuration for baseport, power
 206 management, resource management, and security management. If the chosen
 207 domain reset would lead to system-wide reset, then no additional board
 208 configuration calls are necessary.</p>
 209 </div>
 210 <div class="section" id="macros-used-in-this-document">
 211 <h3>Macros Used in this Document<a class="headerlink" href="#macros-used-in-this-document" title="Permalink to this headline">¶</a></h3>
 212 </div>
 213 <div class="section" id="tisci-message-id">
 214 <span id="pub-sysreset-tisci"></span><h3>TISCI Message ID<a class="headerlink" href="#tisci-message-id" title="Permalink to this headline">¶</a></h3>
 215 <p><code class="docutils literal"><span class="pre">TISCI_MSG_SYS_RESET</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">(0x0005U)</span></code></p>
 216 </div>
 217 <div class="section" id="message-data-structures">
 218 <h3>Message Data Structures<a class="headerlink" href="#message-data-structures" title="Permalink to this headline">¶</a></h3>
 219 <p><p><strong>struct tisci_msg_sys_reset_req</strong></p>
 220 <p>Request for TISCI_MSG_SYS_RESET.</p>
 221 <table border="1" class="docutils">
 222 <colgroup>
 223 <col width="15%" />
 224 <col width="24%" />
 225 <col width="60%" />
 226 </colgroup>
 227 <thead valign="bottom">
 228 <tr class="row-odd"><th class="head">Parameter</th>
 229 <th class="head">Type</th>
 230 <th class="head">Description</th>
 231 </tr>
 232 </thead>
 233 <tbody valign="top">
 234 <tr class="row-even"><td>hdr</td>
 235 <td>struct tisci_header</td>
 236 <td>TISCI header to provide ACK/NAK flags to the host.</td>
 237 </tr>
 238 <tr class="row-odd"><td>domain</td>
 239 <td>domgrp_t</td>
 240 <td>Domain to be reset.</td>
 241 </tr>
 242 </tbody>
 243 </table>
 244 </p>
 245 <p>To maintain backward compatibility, when a user does not pass the domain
 246 argument, it would perform the SoC’s default reset behavior.</p>
 247 <p><p><strong>struct tisci_msg_sys_reset_resp</strong></p>
 248 <p>Empty response for TISCI_MSG_SYS_RESET.</p>
 249 <table border="1" class="docutils">
 250 <colgroup>
 251 <col width="27%" />
 252 <col width="43%" />
 253 <col width="31%" />
 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>TISCI header.</td>
 265 </tr>
 266 </tbody>
 267 </table>
 268 <p>Although this message is essentially empty and contains only a header
 269  a full data structure is created for consistency in implementation.</p>
 270 </p>
 271 </div>
 272 </div>
 273 </div>
 274
 275
 276            </div>
 277           </div>
 278           <footer>
 279
 280     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 281
 282         <a href="../rm/rm_irq.html" class="btn btn-neutral float-right" title="Resource Management IRQ TISCI Message Description" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
 283
 284
 285         <a href="clocks.html" class="btn btn-neutral" title="TISCI PM Clock API Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 286
 287     </div>
 288
 289
 290   <hr/>
 291
 292   <div role="contentinfo">
 293     <p>
 294       <a href="http://www.ti.com/corp/docs/legal/copyright.shtml">&copy; Copyright 2016-2020</a>, Texas Instruments Incorporated. All rights reserved. <br>
 295       <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>
 296
 297     </p>
 298   </div>
 299
 300 </footer>
 301
 302         </div>
 303       </div>
 304
 305     </section>
 306
 307   </div>
 308
 309
 310
 311
 312
 313     <script type="text/javascript">
 314         var DOCUMENTATION_OPTIONS = {
 315             URL_ROOT:'../../',
 316             VERSION:'20.00.02',
 317             COLLAPSE_INDEX:false,
 318             FILE_SUFFIX:'.html',
 319             HAS_SOURCE:  true
 320         };
 321     </script>
 322       <script type="text/javascript" src="../../_static/jquery.js"></script>
 323       <script type="text/javascript" src="../../_static/underscore.js"></script>
 324       <script type="text/javascript" src="../../_static/doctools.js"></script>
 325       <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
 326
 327     <script src="http://www.ti.com/assets/js/headerfooter/analytics.js" type="text/javascript" charset="utf-8"></script>
 328
 329
 330
 331
 332
 333     <script type="text/javascript" src="../../_static/js/theme.js"></script>
 334
 335
 336
 337
 338   <script type="text/javascript">
 339       jQuery(function () {
 340           SphinxRtdTheme.StickyNav.enable();
 341         });
 342
 343       var menuHeight = window.innerHeight;
 344
 345       var contentOffset = $(".wy-nav-content-wrap").offset();
 346       var contentHeight = $(".wy-nav-content-wrap").height();
 347       var contentBottom = contentOffset.top + contentHeight;
 348
 349       function setNavbarTop() {
 350           var scrollTop = $(window).scrollTop();
 351           var maxTop = scrollTop + menuHeight;
 352
 353           // If past the header
 354           if (scrollTop > contentOffset.top && maxTop < contentBottom) {
 355             stickyTop = scrollTop - contentOffset.top;
 356           } else if (maxTop > contentBottom) {
 357             stickyTop = scrollTop - contentOffset.top - (maxTop - contentBottom);
 358           } else {
 359             stickyTop = 0;
 360           }
 361
 362           $(".wy-nav-side").css("top", stickyTop);
 363       }
 364
 365       $(document).ready(function() {
 366         setNavbarTop();
 367         $(window).scroll(function () {
 368           setNavbarTop();
 369         });
 370
 371         $('body').on("mousewheel", function () {
 372             // Remove default behavior
 373             event.preventDefault();
 374             // Scroll without smoothing
 375             var wheelDelta = event.wheelDelta;
 376             var currentScrollPosition = window.pageYOffset;
 377             window.scrollTo(0, currentScrollPosition - wheelDelta);
 378         });
 379       });
 380   </script>
 381
 382
 383 </body>
 384 </html>