[processor-sdk/pdk.git] / packages / ti / drv / sciclient / soc / sysfw / binaries / system-firmware-public-documentation / 2_tisci_msgs / security / extended_otp.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>Extended OTP TISCI 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="Derived KEK TISCI Description" href="dkek_management.html"/>
43 <link rel="prev" title="Runtime Debug TISCI Description" href="runtime_debug.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.00.02
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"><a class="reference internal" href="../index.html#resource-management-rm">Resource Management (RM)</a></li>
110 <li class="toctree-l2 current"><a class="reference internal" href="../index.html#secure-management">Secure Management</a><ul class="current">
111 <li class="toctree-l3"><a class="reference internal" href="sec_cert_format.html">Security X509 Certificate Documentation</a></li>
112 <li class="toctree-l3"><a class="reference internal" href="PROC_BOOT.html">Processor Boot Management TISCI Description</a></li>
113 <li class="toctree-l3"><a class="reference internal" href="firewall_api.html">Firewall TISCI Description</a></li>
114 <li class="toctree-l3"><a class="reference internal" href="sec_ap_data_transfer.html">Secure AP Command Interface</a></li>
115 <li class="toctree-l3"><a class="reference internal" href="runtime_debug.html">Runtime Debug TISCI Description</a></li>
116 <li class="toctree-l3 current"><a class="current reference internal" href="#">Extended OTP TISCI Description</a><ul>
117 <li class="toctree-l4"><a class="reference internal" href="#api-description">API Description</a></li>
118 </ul>
119 </li>
120 <li class="toctree-l3"><a class="reference internal" href="dkek_management.html">Derived KEK TISCI Description</a></li>
121 <li class="toctree-l3"><a class="reference internal" href="security_handover.html">Security Handover Message Description</a></li>
122 </ul>
123 </li>
124 </ul>
125 </li>
126 <li class="toctree-l1"><a class="reference internal" href="../../3_boardcfg/index.html">Chapter 3: Board Configuration</a></li>
127 <li class="toctree-l1"><a class="reference internal" href="../../4_trace/index.html">Chapter 4: Interpreting Trace Data</a></li>
128 <li class="toctree-l1"><a class="reference internal" href="../../5_soc_doc/index.html">Chapter 5: SoC Family Specific Documentation</a></li>
129 <li class="toctree-l1"><a class="reference internal" href="../../6_topic_user_guides/index.html">Chapter 6: Topic User Guides</a></li>
130 </ul>
134 </div>
135 </div>
136 </nav>
138 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
141 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
142 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
143 <a href="../../index.html">TISCI</a>
144 </nav>
148 <div class="wy-nav-content">
149 <div class="rst-content">
156 <div role="navigation" aria-label="breadcrumbs navigation">
157 <ul class="wy-breadcrumbs">
158 <li><a href="../../index.html">Docs</a> »</li>
160 <li><a href="../index.html">Chapter 2: TISCI Message Documentation</a> »</li>
162 <li>Extended OTP TISCI Description</li>
163 <li class="wy-breadcrumbs-aside">
167 </li>
168 </ul>
169 <hr/>
170 </div>
171 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
172 <div itemprop="articleBody">
174 <div class="section" id="extended-otp-tisci-description">
175 <h1>Extended OTP TISCI Description<a class="headerlink" href="#extended-otp-tisci-description" title="Permalink to this headline">¶</a></h1>
176 <p id="sec-api-ext-otp-tisci-dec">This chapter provides information on available TISCI messages for managing
177 the extended one time programmable (OTP) efuse array on K3 devices.</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>0x9022</td>
190 <td><a class="reference internal" href="#sec-api-ext-otp-read-otp-mmr"><span class="std std-ref">TISCI_MSG_READ_OTP_MMR</span></a></td>
191 </tr>
192 <tr class="row-odd"><td>0x9023</td>
193 <td><a class="reference internal" href="#write-otp-row"><span class="std std-ref">TISCI_MSG_WRITE_OTP_ROW</span></a></td>
194 </tr>
195 <tr class="row-even"><td>0x9024</td>
196 <td><a class="reference internal" href="#lock-otp-row"><span class="std std-ref">TISCI_MSG_LOCK_OTP_ROW</span></a></td>
197 </tr>
198 <tr class="row-odd"><td>0x9025</td>
199 <td><a class="reference internal" href="#soft-lock-otp-write-global"><span class="std std-ref">TISCI_MSG_SOFT_LOCK_OTP_WRITE_GLOBAL</span></a></td>
200 </tr>
201 <tr class="row-even"><td>0x9026</td>
202 <td><a class="reference internal" href="#get-otp-row-lock-status"><span class="std std-ref">TISCI_MSG_GET_OTP_ROW_LOCK_STATUS</span></a></td>
203 </tr>
204 </tbody>
205 </table>
206 <p>This document must be read alongside</p>
207 <ol class="arabic simple">
208 <li><a class="reference internal" href="../../6_topic_user_guides/extended_otp.html"><span class="doc">Using Extended OTP on HS devices</span></a> and</li>
209 <li><a class="reference internal" href="../../3_boardcfg/BOARDCFG_SEC.html"><span class="doc">Security Board Configuration</span></a>, specifically <a class="reference internal" href="../../3_boardcfg/BOARDCFG_SEC.html#pub-boardcfg-ext-otp-config"><span class="std std-ref">Extended OTP array configuration</span></a></li>
210 </ol>
211 <div class="section" id="api-description">
212 <h2>API Description<a class="headerlink" href="#api-description" title="Permalink to this headline">¶</a></h2>
213 <div class="section" id="tisci-msg-read-otp-mmr-read-otp-mmr">
214 <span id="sec-api-ext-otp-read-otp-mmr"></span><h3>TISCI_MSG_READ_OTP_MMR - Read OTP MMR<a class="headerlink" href="#tisci-msg-read-otp-mmr-read-otp-mmr" title="Permalink to this headline">¶</a></h3>
215 <div class="section" id="usage">
216 <h4>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h4>
217 <table border="1" class="docutils">
218 <colgroup>
219 <col width="75%" />
220 <col width="25%" />
221 </colgroup>
222 <tbody valign="top">
223 <tr class="row-odd"><td><strong>Message Type</strong></td>
224 <td>Secure</td>
225 </tr>
226 <tr class="row-even"><td><strong>Secure Queue Only?</strong></td>
227 <td>Yes</td>
228 </tr>
229 </tbody>
230 </table>
231 </div>
232 <div class="section" id="tisci-message-id">
233 <h4>TISCI Message ID<a class="headerlink" href="#tisci-message-id" title="Permalink to this headline">¶</a></h4>
234 <p><p><code class="docutils literal"><span class="pre">TISCI_MSG_READ_OTP_MMR</span>          <span class="pre">(0x9022U)</span></code></p>
235 <p>Message to read 32 bit OTP MMR by register number</p>
236 </p>
237 <p><p><strong>struct tisci_msg_read_otp_mmr_req</strong></p>
238 <p>Request message for reading OTP MMR</p>
239 <table border="1" class="docutils">
240 <colgroup>
241 <col width="14%" />
242 <col width="22%" />
243 <col width="64%" />
244 </colgroup>
245 <thead valign="bottom">
246 <tr class="row-odd"><th class="head">Parameter</th>
247 <th class="head">Type</th>
248 <th class="head">Description</th>
249 </tr>
250 </thead>
251 <tbody valign="top">
252 <tr class="row-even"><td>hdr</td>
253 <td>struct tisci_header</td>
254 <td>Common TI-SCI header</td>
255 </tr>
256 <tr class="row-odd"><td>mmr_idx</td>
257 <td>u8</td>
258 <td>Index of the 32-bit MMR to be read. Index starts from zero.</td>
259 </tr>
260 </tbody>
261 </table>
262 </p>
263 <p><p><strong>struct tisci_msg_read_otp_mmr_resp</strong></p>
264 <p>Respone message for reading OTP MMR</p>
265 <table border="1" class="docutils">
266 <colgroup>
267 <col width="19%" />
268 <col width="30%" />
269 <col width="51%" />
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>mmr_val</td>
283 <td>u32</td>
284 <td>Value of the requested 32-bit MMR</td>
285 </tr>
286 </tbody>
287 </table>
288 </p>
289 </div>
290 </div>
291 <div class="section" id="tisci-msg-write-otp-row-write-otp-row">
292 <span id="write-otp-row"></span><h3>TISCI_MSG_WRITE_OTP_ROW - Write OTP ROW<a class="headerlink" href="#tisci-msg-write-otp-row-write-otp-row" title="Permalink to this headline">¶</a></h3>
293 <div class="section" id="id1">
294 <h4>Usage<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
295 <table border="1" class="docutils">
296 <colgroup>
297 <col width="75%" />
298 <col width="25%" />
299 </colgroup>
300 <tbody valign="top">
301 <tr class="row-odd"><td><strong>Message Type</strong></td>
302 <td>Secure</td>
303 </tr>
304 <tr class="row-even"><td><strong>Secure Queue Only?</strong></td>
305 <td>Yes</td>
306 </tr>
307 </tbody>
308 </table>
309 </div>
310 <div class="section" id="id2">
311 <h4>TISCI Message ID<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
312 <p><p><code class="docutils literal"><span class="pre">TISCI_MSG_WRITE_OTP_ROW</span>          <span class="pre">(0x9023U)</span></code></p>
313 <p>Message to write to non-secure OTP Row</p>
314 </p>
315 <p><p><strong>struct tisci_msg_write_otp_row_req</strong></p>
316 <p>Request message for writing to an OTP row</p>
317 <table border="1" class="docutils">
318 <colgroup>
319 <col width="14%" />
320 <col width="22%" />
321 <col width="64%" />
322 </colgroup>
323 <thead valign="bottom">
324 <tr class="row-odd"><th class="head">Parameter</th>
325 <th class="head">Type</th>
326 <th class="head">Description</th>
327 </tr>
328 </thead>
329 <tbody valign="top">
330 <tr class="row-even"><td>hdr</td>
331 <td>struct tisci_header</td>
332 <td>Common TI-SCI header</td>
333 </tr>
334 <tr class="row-odd"><td>row_idx</td>
335 <td>u8</td>
336 <td>Index of the otp row to be written. Index starts from zero.</td>
337 </tr>
338 <tr class="row-even"><td>row_val</td>
339 <td>u32</td>
340 <td>value to be written to the otp row</td>
341 </tr>
342 <tr class="row-odd"><td>row_mask</td>
343 <td>u32</td>
344 <td>mask specifying the bits in row_val to be written</td>
345 </tr>
346 </tbody>
347 </table>
348 </p>
349 <p><p><strong>struct tisci_msg_write_otp_row_resp</strong></p>
350 <p>Respone message for writing to an OTP row</p>
351 <table border="1" class="docutils">
352 <colgroup>
353 <col width="14%" />
354 <col width="23%" />
355 <col width="63%" />
356 </colgroup>
357 <thead valign="bottom">
358 <tr class="row-odd"><th class="head">Parameter</th>
359 <th class="head">Type</th>
360 <th class="head">Description</th>
361 </tr>
362 </thead>
363 <tbody valign="top">
364 <tr class="row-even"><td>hdr</td>
365 <td>struct tisci_header</td>
366 <td>Common TI-SCI header</td>
367 </tr>
368 <tr class="row-odd"><td>row_val</td>
369 <td>u32</td>
370 <td>value read back from the row after the write operation.</td>
371 </tr>
372 </tbody>
373 </table>
374 </p>
375 </div>
376 </div>
377 <div class="section" id="tisci-msg-lock-otp-row-lock-otp-row">
378 <span id="lock-otp-row"></span><h3>TISCI_MSG_LOCK_OTP_ROW - Lock OTP ROW<a class="headerlink" href="#tisci-msg-lock-otp-row-lock-otp-row" title="Permalink to this headline">¶</a></h3>
379 <div class="section" id="id3">
380 <h4>Usage<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4>
381 <table border="1" class="docutils">
382 <colgroup>
383 <col width="75%" />
384 <col width="25%" />
385 </colgroup>
386 <tbody valign="top">
387 <tr class="row-odd"><td><strong>Message Type</strong></td>
388 <td>Secure</td>
389 </tr>
390 <tr class="row-even"><td><strong>Secure Queue Only?</strong></td>
391 <td>Yes</td>
392 </tr>
393 </tbody>
394 </table>
395 </div>
396 <div class="section" id="id4">
397 <h4>TISCI Message ID<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h4>
398 <p><p><code class="docutils literal"><span class="pre">TISCI_MSG_LOCK_OTP_ROW</span>          <span class="pre">(0x9024U)</span></code></p>
399 <p>Message to lock OTP Row</p>
400 </p>
401 <p><p><strong>struct tisci_msg_lock_otp_row_req</strong></p>
402 <p>Request message for hardware locking an OTP row</p>
403 <table border="1" class="docutils">
404 <colgroup>
405 <col width="11%" />
406 <col width="16%" />
407 <col width="73%" />
408 </colgroup>
409 <thead valign="bottom">
410 <tr class="row-odd"><th class="head">Parameter</th>
411 <th class="head">Type</th>
412 <th class="head">Description</th>
413 </tr>
414 </thead>
415 <tbody valign="top">
416 <tr class="row-even"><td>hdr</td>
417 <td>struct tisci_header</td>
418 <td>Common TI-SCI header</td>
419 </tr>
420 <tr class="row-odd"><td>row_idx</td>
421 <td>u8</td>
422 <td>Index of the otp row to be written. Index starts from zero.</td>
423 </tr>
424 <tr class="row-even"><td>hw_write_lock</td>
425 <td>u8</td>
426 <td>indicates if write lock has to be applied in HW on the current row. Set to 0x5A for write lock.</td>
427 </tr>
428 <tr class="row-odd"><td>hw_read_lock</td>
429 <td>u8</td>
430 <td>indicates if read lock has to be applied in HW on the current row. Set to 0x5A for read lock.</td>
431 </tr>
432 <tr class="row-even"><td>row_soft_lock</td>
433 <td>u8</td>
434 <td>indicates if soft lock has to be enabled on current row preventing writes. (ignored for now)</td>
435 </tr>
436 </tbody>
437 </table>
438 <p>In all cases 0x5A indicates true and 0xA5 indicates false. All other values are invalid.</p>
439 </p>
440 <p><p><strong>struct tisci_msg_lock_otp_row_resp</strong></p>
441 <p>Respone message for hardware lock OTP row</p>
442 <table border="1" class="docutils">
443 <colgroup>
444 <col width="23%" />
445 <col width="38%" />
446 <col width="39%" />
447 </colgroup>
448 <thead valign="bottom">
449 <tr class="row-odd"><th class="head">Parameter</th>
450 <th class="head">Type</th>
451 <th class="head">Description</th>
452 </tr>
453 </thead>
454 <tbody valign="top">
455 <tr class="row-even"><td>hdr</td>
456 <td>struct tisci_header</td>
457 <td>Common TI-SCI header</td>
458 </tr>
459 </tbody>
460 </table>
461 </p>
462 </div>
463 </div>
464 <div class="section" id="tisci-msg-soft-lock-otp-write-global-soft-lock-otp-write-globally">
465 <span id="soft-lock-otp-write-global"></span><h3>TISCI_MSG_SOFT_LOCK_OTP_WRITE_GLOBAL - Soft Lock OTP Write Globally<a class="headerlink" href="#tisci-msg-soft-lock-otp-write-global-soft-lock-otp-write-globally" title="Permalink to this headline">¶</a></h3>
466 <div class="section" id="id5">
467 <h4>Usage<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h4>
468 <table border="1" class="docutils">
469 <colgroup>
470 <col width="75%" />
471 <col width="25%" />
472 </colgroup>
473 <tbody valign="top">
474 <tr class="row-odd"><td><strong>Message Type</strong></td>
475 <td>Secure</td>
476 </tr>
477 <tr class="row-even"><td><strong>Secure Queue Only?</strong></td>
478 <td>Yes</td>
479 </tr>
480 </tbody>
481 </table>
482 </div>
483 <div class="section" id="id6">
484 <h4>TISCI Message ID<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h4>
485 <p><p><code class="docutils literal"><span class="pre">TISCI_MSG_SOFT_LOCK_OTP_WRITE_GLOBAL</span>          <span class="pre">(0x9025U)</span></code></p>
486 <p>Message to perform a global lock on OTP writes</p>
487 </p>
488 <p><p><strong>struct tisci_msg_soft_lock_otp_write_global_req</strong></p>
489 <p>Request message for performing a global soft write lock on OTP rows</p>
490 <table border="1" class="docutils">
491 <colgroup>
492 <col width="23%" />
493 <col width="38%" />
494 <col width="39%" />
495 </colgroup>
496 <thead valign="bottom">
497 <tr class="row-odd"><th class="head">Parameter</th>
498 <th class="head">Type</th>
499 <th class="head">Description</th>
500 </tr>
501 </thead>
502 <tbody valign="top">
503 <tr class="row-even"><td>hdr</td>
504 <td>struct tisci_header</td>
505 <td>Common TI-SCI header</td>
506 </tr>
507 </tbody>
508 </table>
509 </p>
510 <p><p><strong>struct tisci_msg_soft_lock_otp_write_global_resp</strong></p>
511 <p>Respone message for global soft write lock on OTP rows</p>
512 <table border="1" class="docutils">
513 <colgroup>
514 <col width="23%" />
515 <col width="38%" />
516 <col width="39%" />
517 </colgroup>
518 <thead valign="bottom">
519 <tr class="row-odd"><th class="head">Parameter</th>
520 <th class="head">Type</th>
521 <th class="head">Description</th>
522 </tr>
523 </thead>
524 <tbody valign="top">
525 <tr class="row-even"><td>hdr</td>
526 <td>struct tisci_header</td>
527 <td>Common TI-SCI header</td>
528 </tr>
529 </tbody>
530 </table>
531 </p>
532 </div>
533 </div>
534 <div class="section" id="tisci-msg-get-otp-row-lock-status-get-otp-row-lock-status">
535 <span id="get-otp-row-lock-status"></span><h3>TISCI_MSG_GET_OTP_ROW_LOCK_STATUS - Get OTP ROW Lock Status<a class="headerlink" href="#tisci-msg-get-otp-row-lock-status-get-otp-row-lock-status" title="Permalink to this headline">¶</a></h3>
536 <div class="section" id="id7">
537 <h4>Usage<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h4>
538 <table border="1" class="docutils">
539 <colgroup>
540 <col width="75%" />
541 <col width="25%" />
542 </colgroup>
543 <tbody valign="top">
544 <tr class="row-odd"><td><strong>Message Type</strong></td>
545 <td>Secure</td>
546 </tr>
547 <tr class="row-even"><td><strong>Secure Queue Only?</strong></td>
548 <td>Yes</td>
549 </tr>
550 </tbody>
551 </table>
552 </div>
553 <div class="section" id="id8">
554 <h4>TISCI Message ID<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h4>
555 <p><p><code class="docutils literal"><span class="pre">TISCI_MSG_GET_OTP_ROW_LOCK_STATUS</span>          <span class="pre">(0x9026U)</span></code></p>
556 <p>Message to get the lock status of a row</p>
557 </p>
558 <p><p><strong>struct tisci_msg_get_otp_row_lock_status_req</strong></p>
559 <p>Request message for querying lock status of an OTP row</p>
560 <table border="1" class="docutils">
561 <colgroup>
562 <col width="14%" />
563 <col width="22%" />
564 <col width="64%" />
565 </colgroup>
566 <thead valign="bottom">
567 <tr class="row-odd"><th class="head">Parameter</th>
568 <th class="head">Type</th>
569 <th class="head">Description</th>
570 </tr>
571 </thead>
572 <tbody valign="top">
573 <tr class="row-even"><td>hdr</td>
574 <td>struct tisci_header</td>
575 <td>Common TI-SCI header</td>
576 </tr>
577 <tr class="row-odd"><td>row_idx</td>
578 <td>u8</td>
579 <td>Index of the otp row to be queried. Index starts from zero.</td>
580 </tr>
581 </tbody>
582 </table>
583 </p>
584 <p><p><strong>struct tisci_msg_get_otp_row_lock_status_resp</strong></p>
585 <p>Respone message for Get OTP row lock status request</p>
586 <table border="1" class="docutils">
587 <colgroup>
588 <col width="16%" />
589 <col width="18%" />
590 <col width="66%" />
591 </colgroup>
592 <thead valign="bottom">
593 <tr class="row-odd"><th class="head">Parameter</th>
594 <th class="head">Type</th>
595 <th class="head">Description</th>
596 </tr>
597 </thead>
598 <tbody valign="top">
599 <tr class="row-even"><td>hdr</td>
600 <td>struct tisci_header</td>
601 <td>Common TI-SCI header</td>
602 </tr>
603 <tr class="row-odd"><td>global_soft_lock</td>
604 <td>u8</td>
605 <td>indicates if global soft lock has been enabled preventing writes.</td>
606 </tr>
607 <tr class="row-even"><td>hw_write_lock</td>
608 <td>u8</td>
609 <td>indicates if write lock has been applied in HW on the current row.</td>
610 </tr>
611 <tr class="row-odd"><td>hw_read_lock</td>
612 <td>u8</td>
613 <td>indicates if read lock has been applied in HW on the current row.</td>
614 </tr>
615 <tr class="row-even"><td>row_soft_lock</td>
616 <td>u8</td>
617 <td>indicates if soft lock has been enabled on current row preventing writes.</td>
618 </tr>
619 </tbody>
620 </table>
621 <p>In all cases 0x5A indicates true and 0xA5 indicates false. All other values are invalid.</p>
622 </p>
623 </div>
624 </div>
625 </div>
626 </div>
629 </div>
630 </div>
631 <footer>
633 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
635 <a href="dkek_management.html" class="btn btn-neutral float-right" title="Derived KEK TISCI Description" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
638 <a href="runtime_debug.html" class="btn btn-neutral" title="Runtime Debug TISCI Description" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
640 </div>
643 <hr/>
645 <div role="contentinfo">
646 <p>
647 <a href="http://www.ti.com/corp/docs/legal/copyright.shtml">© Copyright 2016-2020</a>, Texas Instruments Incorporated. All rights reserved. <br>
648 <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>
650 </p>
651 </div>
653 </footer>
655 </div>
656 </div>
658 </section>
660 </div>
666 <script type="text/javascript">
667 var DOCUMENTATION_OPTIONS = {
668 URL_ROOT:'../../',
669 VERSION:'20.00.02',
670 COLLAPSE_INDEX:false,
671 FILE_SUFFIX:'.html',
672 HAS_SOURCE: true
673 };
674 </script>
675 <script type="text/javascript" src="../../_static/jquery.js"></script>
676 <script type="text/javascript" src="../../_static/underscore.js"></script>
677 <script type="text/javascript" src="../../_static/doctools.js"></script>
678 <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
680 <script src="http://www.ti.com/assets/js/headerfooter/analytics.js" type="text/javascript" charset="utf-8"></script>
686 <script type="text/javascript" src="../../_static/js/theme.js"></script>
691 <script type="text/javascript">
692 jQuery(function () {
693 SphinxRtdTheme.StickyNav.enable();
694 });
696 var menuHeight = window.innerHeight;
698 var contentOffset = $(".wy-nav-content-wrap").offset();
699 var contentHeight = $(".wy-nav-content-wrap").height();
700 var contentBottom = contentOffset.top + contentHeight;
702 function setNavbarTop() {
703 var scrollTop = $(window).scrollTop();
704 var maxTop = scrollTop + menuHeight;
706 // If past the header
707 if (scrollTop > contentOffset.top && maxTop < contentBottom) {
708 stickyTop = scrollTop - contentOffset.top;
709 } else if (maxTop > contentBottom) {
710 stickyTop = scrollTop - contentOffset.top - (maxTop - contentBottom);
711 } else {
712 stickyTop = 0;
713 }
715 $(".wy-nav-side").css("top", stickyTop);
716 }
718 $(document).ready(function() {
719 setNavbarTop();
720 $(window).scroll(function () {
721 setNavbarTop();
722 });
724 $('body').on("mousewheel", function () {
725 // Remove default behavior
726 event.preventDefault();
727 // Scroll without smoothing
728 var wheelDelta = event.wheelDelta;
729 var currentScrollPosition = window.pageYOffset;
730 window.scrollTo(0, currentScrollPosition - wheelDelta);
731 });
732 });
733 </script>
736 </body>
737 </html>