Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. CHIPSEC 2.0.7 documentation file, created by
.. CHIPSEC 2.0.8 documentation file, created by
sphinx-quickstart on Wed Mar 25 13:24:44 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

CHIPSEC 2.0.7
CHIPSEC 2.0.8
=============

CHIPSEC is a framework for analyzing platform level security of
Expand Down
7 changes: 7 additions & 0 deletions _sources/modules/chipsec.cfg.parsers.hob_parser.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
chipsec.cfg.parsers.hob\_parser module
======================================

.. automodule:: chipsec.cfg.parsers.hob_parser



7 changes: 7 additions & 0 deletions _sources/modules/chipsec.cfg.parsers.ip.hob.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
chipsec.cfg.parsers.ip.hob module
=================================

.. automodule:: chipsec.cfg.parsers.ip.hob



1 change: 1 addition & 0 deletions _sources/modules/chipsec.cfg.parsers.ip.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ chipsec.cfg.parsers.ip package
:maxdepth: 10

chipsec.cfg.parsers.ip.generic
chipsec.cfg.parsers.ip.hob
chipsec.cfg.parsers.ip.io
chipsec.cfg.parsers.ip.iobar
chipsec.cfg.parsers.ip.memory
Expand Down
7 changes: 7 additions & 0 deletions _sources/modules/chipsec.cfg.parsers.registers.hob.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
chipsec.cfg.parsers.registers.hob module
========================================

.. automodule:: chipsec.cfg.parsers.registers.hob



1 change: 1 addition & 0 deletions _sources/modules/chipsec.cfg.parsers.registers.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ chipsec.cfg.parsers.registers package
:maxdepth: 10

chipsec.cfg.parsers.registers.controls
chipsec.cfg.parsers.registers.hob
chipsec.cfg.parsers.registers.io
chipsec.cfg.parsers.registers.iobar
chipsec.cfg.parsers.registers.locks
Expand Down
7 changes: 7 additions & 0 deletions _sources/modules/chipsec.hal.common.hob.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
chipsec.hal.common.hob module
=============================

.. automodule:: chipsec.hal.common.hob



1 change: 1 addition & 0 deletions _sources/modules/chipsec.hal.common.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ chipsec.hal.common package
chipsec.hal.common.cmos
chipsec.hal.common.cpuid
chipsec.hal.common.ec
chipsec.hal.common.hob
chipsec.hal.common.interrupts
chipsec.hal.common.io
chipsec.hal.common.iobar
Expand Down
7 changes: 7 additions & 0 deletions _sources/modules/chipsec.utilcmd.hob_cmd.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
chipsec.utilcmd.hob\_cmd module
===============================

.. automodule:: chipsec.utilcmd.hob_cmd



1 change: 1 addition & 0 deletions _sources/modules/chipsec.utilcmd.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ chipsec.utilcmd package
chipsec.utilcmd.desc_cmd
chipsec.utilcmd.ec_cmd
chipsec.utilcmd.hals_cmd
chipsec.utilcmd.hob_cmd
chipsec.utilcmd.igd_cmd
chipsec.utilcmd.interrupts_cmd
chipsec.utilcmd.io_cmd
Expand Down
12 changes: 6 additions & 6 deletions contribution/code-style-python.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ <h1>Python Coding Style Guide<a class="headerlink" href="#python-coding-style-gu
<blockquote>
<div><p>Single quotes are encouraged but can vary with use case.</p>
<p>Avoid using backslashes ‘\’ in strings.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="s1">&#39;This is a preferred &quot;string&quot;.&#39;</span>
<span class="s2">&quot;Also an acceptable &#39;string&#39;.&quot;</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="s1">'This is a preferred "string".'</span>
<span class="s2">"Also an acceptable 'string'."</span>

<span class="s2">&quot;Avoid making this </span><span class="se">\&quot;</span><span class="s2">string</span><span class="se">\&quot;</span><span class="s2">.&quot;</span>
<span class="s2">"Avoid making this </span><span class="se">\"</span><span class="s2">string</span><span class="se">\"</span><span class="s2">."</span>
</pre></div>
</div>
</div></blockquote>
Expand All @@ -110,7 +110,7 @@ <h1>Python Coding Style Guide<a class="headerlink" href="#python-coding-style-gu
<span class="kn">from</span><span class="w"> </span><span class="nn">chipsec.module_common</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseModule</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">chipsec.library.returncode</span><span class="w"> </span><span class="kn">import</span> <span class="n">ModuleResult</span>

<span class="c1"># Bad - using &#39;*&#39; and importing sys after local imports</span>
<span class="c1"># Bad - using '*' and importing sys after local imports</span>
<span class="kn">import</span><span class="w"> </span><span class="o">*</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">chipsec.module_common</span><span class="w"> </span><span class="kn">import</span> <span class="o">*</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
Expand Down Expand Up @@ -203,7 +203,7 @@ <h1>Python Coding Style Guide<a class="headerlink" href="#python-coding-style-gu
<li><p>Docstrings</p>
<blockquote>
<div><p>Use three double-quotes for all docstrings.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="sd">&quot;&quot;&quot;String description docstring.&quot;&quot;&quot;</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="sd">"""String description docstring."""</span>
</pre></div>
</div>
</div></blockquote>
Expand Down Expand Up @@ -617,7 +617,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
Last updated on Jul 30, 2026.
Last updated on Aug 27, 2026.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion contribution/sphinx.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
Last updated on Jul 30, 2026.
Last updated on Aug 27, 2026.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
Expand Down
4 changes: 3 additions & 1 deletion development/Architecture-Overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ <h2>Commands<a class="headerlink" href="#commands" title="Link to this heading">
<li class="toctree-l2"><a class="reference internal" href="../modules/chipsec.utilcmd.desc_cmd.html">chipsec.utilcmd.desc_cmd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../modules/chipsec.utilcmd.ec_cmd.html">chipsec.utilcmd.ec_cmd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../modules/chipsec.utilcmd.hals_cmd.html">chipsec.utilcmd.hals_cmd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../modules/chipsec.utilcmd.hob_cmd.html">chipsec.utilcmd.hob_cmd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../modules/chipsec.utilcmd.igd_cmd.html">chipsec.utilcmd.igd_cmd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../modules/chipsec.utilcmd.interrupts_cmd.html">chipsec.utilcmd.interrupts_cmd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../modules/chipsec.utilcmd.io_cmd.html">chipsec.utilcmd.io_cmd module</a></li>
Expand Down Expand Up @@ -173,6 +174,7 @@ <h2>HAL (Hardware Abstraction Layer)<a class="headerlink" href="#hal-hardware-ab
<li class="toctree-l3"><a class="reference internal" href="../modules/chipsec.hal.common.cmos.html">chipsec.hal.common.cmos module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../modules/chipsec.hal.common.cpuid.html">chipsec.hal.common.cpuid module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../modules/chipsec.hal.common.ec.html">chipsec.hal.common.ec module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../modules/chipsec.hal.common.hob.html">chipsec.hal.common.hob module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../modules/chipsec.hal.common.interrupts.html">chipsec.hal.common.interrupts module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../modules/chipsec.hal.common.io.html">chipsec.hal.common.io module</a></li>
<li class="toctree-l3"><a class="reference internal" href="../modules/chipsec.hal.common.iobar.html">chipsec.hal.common.iobar module</a></li>
Expand Down Expand Up @@ -368,7 +370,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
Last updated on Jul 30, 2026.
Last updated on Aug 27, 2026.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
Expand Down
12 changes: 6 additions & 6 deletions development/Configuration-Files.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,17 @@ <h3>Navigation</h3>
<section id="configuration-file-example">
<h2>Configuration File Example<a class="headerlink" href="#configuration-file-example" title="Link to this heading">¶</a></h2>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;mmio&gt;</span>
<span class="nt">&lt;bar</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;SPIBAR&quot;</span><span class="w"> </span><span class="na">bus=</span><span class="s">&quot;0&quot;</span><span class="w"> </span><span class="na">dev=</span><span class="s">&quot;0x1F&quot;</span><span class="w"> </span><span class="na">fun=</span><span class="s">&quot;5&quot;</span><span class="w"> </span><span class="na">reg=</span><span class="s">&quot;0x10&quot;</span><span class="w"> </span><span class="na">width=</span><span class="s">&quot;4&quot;</span><span class="w"> </span><span class="na">mask=</span><span class="s">&quot;0xFFFFF000&quot;</span><span class="w"> </span><span class="na">size=</span><span class="s">&quot;0x1000&quot;</span><span class="w"> </span><span class="na">desc=</span><span class="s">&quot;SPI Controller Register Range&quot;</span><span class="w"> </span><span class="na">offset=</span><span class="s">&quot;0x0&quot;</span><span class="nt">/&gt;</span>
<span class="nt">&lt;bar</span><span class="w"> </span><span class="na">name=</span><span class="s">"SPIBAR"</span><span class="w"> </span><span class="na">bus=</span><span class="s">"0"</span><span class="w"> </span><span class="na">dev=</span><span class="s">"0x1F"</span><span class="w"> </span><span class="na">fun=</span><span class="s">"5"</span><span class="w"> </span><span class="na">reg=</span><span class="s">"0x10"</span><span class="w"> </span><span class="na">width=</span><span class="s">"4"</span><span class="w"> </span><span class="na">mask=</span><span class="s">"0xFFFFF000"</span><span class="w"> </span><span class="na">size=</span><span class="s">"0x1000"</span><span class="w"> </span><span class="na">desc=</span><span class="s">"SPI Controller Register Range"</span><span class="w"> </span><span class="na">offset=</span><span class="s">"0x0"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/mmio&gt;</span>
<span class="nt">&lt;registers&gt;</span>
<span class="nt">&lt;register</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;BC&quot;</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;pcicfg&quot;</span><span class="w"> </span><span class="na">bus=</span><span class="s">&quot;0&quot;</span><span class="w"> </span><span class="na">dev=</span><span class="s">&quot;0x1F&quot;</span><span class="w"> </span><span class="na">fun=</span><span class="s">&quot;5&quot;</span><span class="w"> </span><span class="na">offset=</span><span class="s">&quot;0xDC&quot;</span><span class="w"> </span><span class="na">size=</span><span class="s">&quot;4&quot;</span><span class="w"> </span><span class="na">desc=</span><span class="s">&quot;BIOS Control&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;field</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;BIOSWE&quot;</span><span class="w"> </span><span class="na">bit=</span><span class="s">&quot;0&quot;</span><span class="w"> </span><span class="na">size=</span><span class="s">&quot;1&quot;</span><span class="w"> </span><span class="na">desc=</span><span class="s">&quot;BIOS Write Enable&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
<span class="nt">&lt;register</span><span class="w"> </span><span class="na">name=</span><span class="s">"BC"</span><span class="w"> </span><span class="na">type=</span><span class="s">"pcicfg"</span><span class="w"> </span><span class="na">bus=</span><span class="s">"0"</span><span class="w"> </span><span class="na">dev=</span><span class="s">"0x1F"</span><span class="w"> </span><span class="na">fun=</span><span class="s">"5"</span><span class="w"> </span><span class="na">offset=</span><span class="s">"0xDC"</span><span class="w"> </span><span class="na">size=</span><span class="s">"4"</span><span class="w"> </span><span class="na">desc=</span><span class="s">"BIOS Control"</span><span class="nt">&gt;</span>
<span class="nt">&lt;field</span><span class="w"> </span><span class="na">name=</span><span class="s">"BIOSWE"</span><span class="w"> </span><span class="na">bit=</span><span class="s">"0"</span><span class="w"> </span><span class="na">size=</span><span class="s">"1"</span><span class="w"> </span><span class="na">desc=</span><span class="s">"BIOS Write Enable"</span><span class="w"> </span><span class="nt">/&gt;</span>
<span class="nt">&lt;field</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;BILD&quot;</span><span class="w"> </span><span class="na">bit=</span><span class="s">&quot;7&quot;</span><span class="w"> </span><span class="na">size=</span><span class="s">&quot;1&quot;</span><span class="w"> </span><span class="na">desc=</span><span class="s">&quot;BIOS Interface Lock Down&quot;</span><span class="nt">/&gt;</span>
<span class="nt">&lt;field</span><span class="w"> </span><span class="na">name=</span><span class="s">"BILD"</span><span class="w"> </span><span class="na">bit=</span><span class="s">"7"</span><span class="w"> </span><span class="na">size=</span><span class="s">"1"</span><span class="w"> </span><span class="na">desc=</span><span class="s">"BIOS Interface Lock Down"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/register&gt;</span>
<span class="nt">&lt;/registers&gt;</span>
<span class="nt">&lt;controls&gt;</span>
<span class="nt">&lt;control</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;BiosInterfaceLockDown&quot;</span><span class="w"> </span><span class="na">register=</span><span class="s">&quot;BC&quot;</span><span class="w"> </span><span class="na">field=</span><span class="s">&quot;BILD&quot;</span><span class="w"> </span><span class="na">desc=</span><span class="s">&quot;BIOS Interface Lock-Down&quot;</span><span class="nt">/&gt;</span>
<span class="nt">&lt;control</span><span class="w"> </span><span class="na">name=</span><span class="s">"BiosInterfaceLockDown"</span><span class="w"> </span><span class="na">register=</span><span class="s">"BC"</span><span class="w"> </span><span class="na">field=</span><span class="s">"BILD"</span><span class="w"> </span><span class="na">desc=</span><span class="s">"BIOS Interface Lock-Down"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/controls&gt;</span>
</pre></div>
</div>
Expand Down Expand Up @@ -208,7 +208,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
Last updated on Jul 30, 2026.
Last updated on Aug 27, 2026.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
Expand Down
10 changes: 5 additions & 5 deletions development/Developing.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,20 @@ <h1>Writing Your Own Modules<a class="headerlink" href="#writing-your-own-module
<p>Most modules read some platform configuration and then pass or fail based on the result. For example:</p>
<ol class="arabic">
<li><p>Define the control in the platform XML file (in <code class="docutils literal notranslate"><span class="pre">chipsec/cfg</span></code>):</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;control</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;BiosLockEnable&quot;</span><span class="w"> </span><span class="na">register=</span><span class="s">&quot;BC&quot;</span><span class="w"> </span><span class="na">field=</span><span class="s">&quot;BLE&quot;</span><span class="w"> </span><span class="na">desc=</span><span class="s">&quot;BIOS Lock Enable&quot;</span><span class="nt">/&gt;</span>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;control</span><span class="w"> </span><span class="na">name=</span><span class="s">"BiosLockEnable"</span><span class="w"> </span><span class="na">register=</span><span class="s">"BC"</span><span class="w"> </span><span class="na">field=</span><span class="s">"BLE"</span><span class="w"> </span><span class="na">desc=</span><span class="s">"BIOS Lock Enable"</span><span class="nt">/&gt;</span>
</pre></div>
</div>
</li>
<li><p>Get the current status of the control:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">ble</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cs</span><span class="o">.</span><span class="n">control</span><span class="o">.</span><span class="n">get_list_by_name</span><span class="p">(</span><span class="s1">&#39;BiosLockEnable&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_all_value</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">ble</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cs</span><span class="o">.</span><span class="n">control</span><span class="o">.</span><span class="n">get_list_by_name</span><span class="p">(</span><span class="s1">'BiosLockEnable'</span><span class="p">)</span><span class="o">.</span><span class="n">is_all_value</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p>React based on the status of the control:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="n">ble</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">log_passed</span><span class="p">(</span><span class="s2">&quot;BIOS Lock is set.&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">log_passed</span><span class="p">(</span><span class="s2">"BIOS Lock is set."</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">log_failed</span><span class="p">(</span><span class="s2">&quot;BIOS Lock is not set.&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">log_failed</span><span class="p">(</span><span class="s2">"BIOS Lock is not set."</span><span class="p">)</span>
</pre></div>
</div>
</li>
Expand Down Expand Up @@ -193,7 +193,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
Last updated on Jul 30, 2026.
Last updated on Aug 27, 2026.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions development/OS-Helpers-and-Drivers.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ <h3>Example<a class="headerlink" href="#example" title="Link to this heading">¶

<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">NewHelper</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;NewHelper&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s2">"NewHelper"</span>
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -192,7 +192,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
Last updated on Jul 30, 2026.
Last updated on Aug 27, 2026.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion development/Platform-Detection.html
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
Last updated on Jul 30, 2026.
Last updated on Aug 27, 2026.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
Expand Down
Loading