packages/ti/drv/sciclient/soc/sysfw/binaries/system-firmware-public-documentation/2_tisci_msgs/security/runtime_debug.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>Runtime Debug TISCI Description &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="Extended OTP TISCI Description" href="extended_otp.html"/>
  43         <link rel="prev" title="Secure AP Command Interface" href="sec_ap_data_transfer.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
  82
  83
  84 <div role="search">
  85   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
  86     <input type="text" name="q" placeholder="Search docs" />
  87     <input type="hidden" name="check_keywords" value="yes" />
  88     <input type="hidden" name="area" value="default" />
  89   </form>
  90 </div>
  91
  92
  93         </div>
  94
  95         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  96
  97
  98
  99                 <ul class="current">
 100 <li class="toctree-l1"><a class="reference internal" href="../../1_intro/index.html">Chapter 1: Introduction</a></li>
 101 <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Chapter 2: TISCI Message Documentation</a><ul class="current">
 102 <li class="toctree-l2"><a class="reference internal" href="../general/TISCI_header.html">Texas Instruments System Controller Interface (TISCI)</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="../index.html#general">General</a></li>
 104 <li class="toctree-l2"><a class="reference internal" href="../index.html#power-management-pm">Power Management (PM)</a></li>
 105 <li class="toctree-l2"><a class="reference internal" href="../index.html#resource-management-rm">Resource Management (RM)</a></li>
 106 <li class="toctree-l2 current"><a class="reference internal" href="../index.html#secure-management">Secure Management</a><ul class="current">
 107 <li class="toctree-l3"><a class="reference internal" href="sec_cert_format.html">Security X509 Certificate Documentation</a></li>
 108 <li class="toctree-l3"><a class="reference internal" href="PROC_BOOT.html">Processor Boot Management TISCI Description</a></li>
 109 <li class="toctree-l3"><a class="reference internal" href="firewall_api.html">Firewall TISCI Description</a></li>
 110 <li class="toctree-l3"><a class="reference internal" href="sec_ap_data_transfer.html">Secure AP Command Interface</a></li>
 111 <li class="toctree-l3 current"><a class="current reference internal" href="#">Runtime Debug TISCI 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="#api-description">API Description</a></li>
 114 </ul>
 115 </li>
 116 <li class="toctree-l3"><a class="reference internal" href="extended_otp.html">Extended OTP TISCI Description</a></li>
 117 <li class="toctree-l3"><a class="reference internal" href="dkek_management.html">Derived KEK TISCI Description</a></li>
 118 <li class="toctree-l3"><a class="reference internal" href="security_handover.html">Security Handover Message Description</a></li>
 119 <li class="toctree-l3"><a class="reference internal" href="keywriter.html">OTP Keywriter TISCI Description</a></li>
 120 </ul>
 121 </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>
 129
 130
 131
 132         </div>
 133       </div>
 134     </nav>
 135
 136     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 137
 138
 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>
 143
 144
 145
 146       <div class="wy-nav-content">
 147         <div class="rst-content">
 148
 149
 150
 151
 152
 153
 154 <div role="navigation" aria-label="breadcrumbs navigation">
 155   <ul class="wy-breadcrumbs">
 156     <li><a href="../../index.html">Docs</a> &raquo;</li>
 157
 158           <li><a href="../index.html">Chapter 2: TISCI Message Documentation</a> &raquo;</li>
 159
 160     <li>Runtime Debug TISCI Description</li>
 161       <li class="wy-breadcrumbs-aside">
 162
 163
 164
 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">
 171
 172   <div class="section" id="runtime-debug-tisci-description">
 173 <h1>Runtime Debug TISCI Description<a class="headerlink" href="#runtime-debug-tisci-description" title="Permalink to this headline">¶</a></h1>
 174 <p id="sec-api-runtime-debug-tisci-desc">This chapter provides information on available TISCI messages
 175 for configuring runtime debug.</p>
 176 <table border="1" class="docutils">
 177 <colgroup>
 178 <col width="26%" />
 179 <col width="74%" />
 180 </colgroup>
 181 <thead valign="bottom">
 182 <tr class="row-odd"><th class="head">TISCI Message ID</th>
 183 <th class="head">Message Name</th>
 184 </tr>
 185 </thead>
 186 <tbody valign="top">
 187 <tr class="row-even"><td>0x900C</td>
 188 <td><a class="reference internal" href="#open-debug-fwls"><span class="std std-ref">TISCI_MSG_OPEN_DEBUG_FWLS</span></a></td>
 189 </tr>
 190 <tr class="row-odd"><td>0x9021</td>
 191 <td><a class="reference internal" href="#get-soc-uid"><span class="std std-ref">TISCI_MSG_GET_SOC_UID</span></a></td>
 192 </tr>
 193 </tbody>
 194 </table>
 195 <div class="section" id="introduction">
 196 <span id="sec-api-runtime-debug-intro"></span><h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
 197 <div class="admonition note">
 198 <p class="first admonition-title">Note</p>
 199 <p class="last">This document is applicable to HS devices only.</p>
 200 </div>
 201 <div class="admonition note">
 202 <p class="first admonition-title">Note</p>
 203 <p class="last">Opening the JTAG port through the Secure AP command interface is the primary
 204 method of unlocking JTAG on K3 devices. This method is documented in
 205 <a class="reference internal" href="sec_ap_data_transfer.html"><span class="doc">Secure AP Command Interface</span></a>. For debug flexbility, System Firmware also supports
 206 unlocking JTAG on target via a TISCI message documented in this chapter.</p>
 207 </div>
 208 </div>
 209 <div class="section" id="api-description">
 210 <h2>API Description<a class="headerlink" href="#api-description" title="Permalink to this headline">¶</a></h2>
 211 <div class="section" id="tisci-msg-get-soc-uid-get-soc-uid">
 212 <span id="get-soc-uid"></span><h3>TISCI_MSG_GET_SOC_UID - Get SOC UID<a class="headerlink" href="#tisci-msg-get-soc-uid-get-soc-uid" title="Permalink to this headline">¶</a></h3>
 213 <p><strong>Usage</strong>:</p>
 214 <table border="1" class="docutils">
 215 <colgroup>
 216 <col width="75%" />
 217 <col width="25%" />
 218 </colgroup>
 219 <tbody valign="top">
 220 <tr class="row-odd"><td><strong>Message Type</strong></td>
 221 <td>Normal</td>
 222 </tr>
 223 <tr class="row-even"><td><strong>Secure Queue Only?</strong></td>
 224 <td>No</td>
 225 </tr>
 226 </tbody>
 227 </table>
 228 <p>Unlocking the JTAG port requires a X509 certificate signed with the active root
 229 of trust asymmetric key. The X509 certificate must contain the Unique identifier
 230 for the SOC (SOC UID). This enables debug certificates to be tied to specific
 231 devices. SOC UID is calculated on the device by the BOOT ROM and must be
 232 extracted from the device. This TISCI message is used to obtain the SOC UID to
 233 populate in the debug unlock certificate. For more information, see
 234 <a class="reference internal" href="sec_cert_format.html#sysfw-debug-ext"><span class="std std-ref">System Firmware Debug Extension</span></a>.</p>
 235 <div class="section" id="tisci-message-id">
 236 <h4>TISCI Message ID<a class="headerlink" href="#tisci-message-id" title="Permalink to this headline">¶</a></h4>
 237 <p><p><code class="docutils literal"><span class="pre">TISCI_MSG_GET_SOC_UID</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">(0x9021U)</span></code></p>
 238 <p>Message to get SOC UID</p>
 239 </p>
 240 <p><p><strong>struct tisci_msg_get_soc_uid_req</strong></p>
 241 <p>Request to provide the SOC UID via TISCI_MSG_GET_SOC_UID</p>
 242 <table border="1" class="docutils">
 243 <colgroup>
 244 <col width="23%" />
 245 <col width="38%" />
 246 <col width="39%" />
 247 </colgroup>
 248 <thead valign="bottom">
 249 <tr class="row-odd"><th class="head">Parameter</th>
 250 <th class="head">Type</th>
 251 <th class="head">Description</th>
 252 </tr>
 253 </thead>
 254 <tbody valign="top">
 255 <tr class="row-even"><td>hdr</td>
 256 <td>struct tisci_header</td>
 257 <td>Common TI-SCI header</td>
 258 </tr>
 259 </tbody>
 260 </table>
 261 </p>
 262 <p><code class="docutils literal"><span class="pre">UID_LEN_WORDS</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">(8U)</span></code></p>
 263 <p><p><strong>struct tisci_msg_get_soc_uid_resp</strong></p>
 264 <p>Response to the TISCI_MSG_GET_SOC_UID message</p>
 265 <table border="1" class="docutils">
 266 <colgroup>
 267 <col width="22%" />
 268 <col width="35%" />
 269 <col width="43%" />
 270 </colgroup>
 271 <thead valign="bottom">
 272 <tr class="row-odd"><th class="head">Parameter</th>
 273 <th class="head">Type</th>
 274 <th class="head">Description</th>
 275 </tr>
 276 </thead>
 277 <tbody valign="top">
 278 <tr class="row-even"><td>hdr</td>
 279 <td>struct tisci_header</td>
 280 <td>Common TI-SCI header</td>
 281 </tr>
 282 <tr class="row-odd"><td>soc_uid</td>
 283 <td>u32</td>
 284 <td>8 words with the SOC UID</td>
 285 </tr>
 286 </tbody>
 287 </table>
 288 </p>
 289 </div>
 290 </div>
 291 <div class="section" id="tisci-msg-open-debug-fwls-open-debug-firewalls">
 292 <span id="open-debug-fwls"></span><h3>TISCI_MSG_OPEN_DEBUG_FWLS - Open Debug Firewalls<a class="headerlink" href="#tisci-msg-open-debug-fwls-open-debug-firewalls" title="Permalink to this headline">¶</a></h3>
 293 <p><strong>Usage</strong>:</p>
 294 <table border="1" class="docutils">
 295 <colgroup>
 296 <col width="75%" />
 297 <col width="25%" />
 298 </colgroup>
 299 <tbody valign="top">
 300 <tr class="row-odd"><td><strong>Message Type</strong></td>
 301 <td>Normal</td>
 302 </tr>
 303 <tr class="row-even"><td><strong>Secure Queue Only?</strong></td>
 304 <td>Yes</td>
 305 </tr>
 306 </tbody>
 307 </table>
 308 <p>Unlocking the JTAG port requires a X509 certificate signed with the active root
 309 of trust asymmetric key. This API is used to provide the signed certificate to
 310 System Firmware for proceessing and JTAG unlock.</p>
 311 <p>The X509 certificate format is described in <a class="reference internal" href="sec_cert_format.html"><span class="doc">Security X509 Certificate Documentation</span></a>. The fields of
 312 the certificate should be filled as specified in the
 313 <a class="reference internal" href="sec_cert_format.html#sysfw-debug-ext"><span class="std std-ref">System Firmware Debug Extension</span></a>. The X509 debug extension is mandatory.
 314 The other X509 extensions are not processed by System Firmware while performing JTAG
 315 unlock.</p>
 316 <div class="section" id="id1">
 317 <h4>TISCI Message ID<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
 318 <p><p><code class="docutils literal"><span class="pre">TISCI_MSG_OPEN_DEBUG_FWLS</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">(0x900CU)</span></code></p>
 319 <p>Message to open debug firewalls using a certificate</p>
 320 </p>
 321 <p><p><strong>struct tisci_msg_open_debug_fwls_req</strong></p>
 322 <p>Request to provide the SOC UID via TISCI_MSG_OPEN_DEBUG_FWLS</p>
 323 <table border="1" class="docutils">
 324 <colgroup>
 325 <col width="19%" />
 326 <col width="24%" />
 327 <col width="57%" />
 328 </colgroup>
 329 <thead valign="bottom">
 330 <tr class="row-odd"><th class="head">Parameter</th>
 331 <th class="head">Type</th>
 332 <th class="head">Description</th>
 333 </tr>
 334 </thead>
 335 <tbody valign="top">
 336 <tr class="row-even"><td>hdr</td>
 337 <td>struct tisci_header</td>
 338 <td>Common TI-SCI header</td>
 339 </tr>
 340 <tr class="row-odd"><td>debug_cert_addr</td>
 341 <td>u64</td>
 342 <td>Physical address of the debug unlock certificate</td>
 343 </tr>
 344 </tbody>
 345 </table>
 346 </p>
 347 <p><p><strong>struct tisci_msg_open_debug_fwls_resp</strong></p>
 348 <p>Response to the TISCI_MSG_OPEN_DEBUG_FWLS message</p>
 349 <table border="1" class="docutils">
 350 <colgroup>
 351 <col width="23%" />
 352 <col width="38%" />
 353 <col width="39%" />
 354 </colgroup>
 355 <thead valign="bottom">
 356 <tr class="row-odd"><th class="head">Parameter</th>
 357 <th class="head">Type</th>
 358 <th class="head">Description</th>
 359 </tr>
 360 </thead>
 361 <tbody valign="top">
 362 <tr class="row-even"><td>hdr</td>
 363 <td>struct tisci_header</td>
 364 <td>Common TI-SCI header</td>
 365 </tr>
 366 </tbody>
 367 </table>
 368 </p>
 369 </div>
 370 </div>
 371 </div>
 372 </div>
 373
 374
 375            </div>
 376           </div>
 377           <footer>
 378
 379     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 380
 381         <a href="extended_otp.html" class="btn btn-neutral float-right" title="Extended OTP TISCI Description" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
 382
 383
 384         <a href="sec_ap_data_transfer.html" class="btn btn-neutral" title="Secure AP Command Interface" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 385
 386     </div>
 387
 388
 389   <hr/>
 390
 391   <div role="contentinfo">
 392     <p>
 393       <a href="http://www.ti.com/corp/docs/legal/copyright.shtml">&copy; Copyright 2016-2020</a>, Texas Instruments Incorporated. All rights reserved. <br>
 394       <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>
 395
 396     </p>
 397   </div>
 398
 399 </footer>
 400
 401         </div>
 402       </div>
 403
 404     </section>
 405
 406   </div>
 407
 408
 409
 410
 411
 412     <script type="text/javascript">
 413         var DOCUMENTATION_OPTIONS = {
 414             URL_ROOT:'../../',
 415             VERSION:'',
 416             COLLAPSE_INDEX:false,
 417             FILE_SUFFIX:'.html',
 418             HAS_SOURCE:  true
 419         };
 420     </script>
 421       <script type="text/javascript" src="../../_static/jquery.js"></script>
 422       <script type="text/javascript" src="../../_static/underscore.js"></script>
 423       <script type="text/javascript" src="../../_static/doctools.js"></script>
 424       <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
 425
 426     <script src="http://www.ti.com/assets/js/headerfooter/analytics.js" type="text/javascript" charset="utf-8"></script>
 427
 428
 429
 430
 431
 432     <script type="text/javascript" src="../../_static/js/theme.js"></script>
 433
 434
 435
 436
 437   <script type="text/javascript">
 438       jQuery(function () {
 439           SphinxRtdTheme.StickyNav.enable();
 440         });
 441
 442       var menuHeight = window.innerHeight;
 443
 444       var contentOffset = $(".wy-nav-content-wrap").offset();
 445       var contentHeight = $(".wy-nav-content-wrap").height();
 446       var contentBottom = contentOffset.top + contentHeight;
 447
 448       function setNavbarTop() {
 449           var scrollTop = $(window).scrollTop();
 450           var maxTop = scrollTop + menuHeight;
 451
 452           // If past the header
 453           if (scrollTop > contentOffset.top && maxTop < contentBottom) {
 454             stickyTop = scrollTop - contentOffset.top;
 455           } else if (maxTop > contentBottom) {
 456             stickyTop = scrollTop - contentOffset.top - (maxTop - contentBottom);
 457           } else {
 458             stickyTop = 0;
 459           }
 460
 461           $(".wy-nav-side").css("top", stickyTop);
 462       }
 463
 464       $(document).ready(function() {
 465         setNavbarTop();
 466         $(window).scroll(function () {
 467           setNavbarTop();
 468         });
 469
 470         $('body').on("mousewheel", function () {
 471             // Remove default behavior
 472             event.preventDefault();
 473             // Scroll without smoothing
 474             var wheelDelta = event.wheelDelta;
 475             var currentScrollPosition = window.pageYOffset;
 476             window.scrollTo(0, currentScrollPosition - wheelDelta);
 477         });
 478       });
 479   </script>
 480
 481
 482 </body>
 483 </html>