diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt index ba71ee8e..d6848acc 100644 --- a/_sources/index.rst.txt +++ b/_sources/index.rst.txt @@ -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 diff --git a/_sources/modules/chipsec.cfg.parsers.hob_parser.rst.txt b/_sources/modules/chipsec.cfg.parsers.hob_parser.rst.txt new file mode 100644 index 00000000..8f9fa2b0 --- /dev/null +++ b/_sources/modules/chipsec.cfg.parsers.hob_parser.rst.txt @@ -0,0 +1,7 @@ +chipsec.cfg.parsers.hob\_parser module +====================================== + +.. automodule:: chipsec.cfg.parsers.hob_parser + + + diff --git a/_sources/modules/chipsec.cfg.parsers.ip.hob.rst.txt b/_sources/modules/chipsec.cfg.parsers.ip.hob.rst.txt new file mode 100644 index 00000000..2538d75f --- /dev/null +++ b/_sources/modules/chipsec.cfg.parsers.ip.hob.rst.txt @@ -0,0 +1,7 @@ +chipsec.cfg.parsers.ip.hob module +================================= + +.. automodule:: chipsec.cfg.parsers.ip.hob + + + diff --git a/_sources/modules/chipsec.cfg.parsers.ip.rst.txt b/_sources/modules/chipsec.cfg.parsers.ip.rst.txt index ad78cd66..9b1faa1c 100644 --- a/_sources/modules/chipsec.cfg.parsers.ip.rst.txt +++ b/_sources/modules/chipsec.cfg.parsers.ip.rst.txt @@ -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 diff --git a/_sources/modules/chipsec.cfg.parsers.registers.hob.rst.txt b/_sources/modules/chipsec.cfg.parsers.registers.hob.rst.txt new file mode 100644 index 00000000..bb569c2e --- /dev/null +++ b/_sources/modules/chipsec.cfg.parsers.registers.hob.rst.txt @@ -0,0 +1,7 @@ +chipsec.cfg.parsers.registers.hob module +======================================== + +.. automodule:: chipsec.cfg.parsers.registers.hob + + + diff --git a/_sources/modules/chipsec.cfg.parsers.registers.rst.txt b/_sources/modules/chipsec.cfg.parsers.registers.rst.txt index fae24336..11f9173d 100644 --- a/_sources/modules/chipsec.cfg.parsers.registers.rst.txt +++ b/_sources/modules/chipsec.cfg.parsers.registers.rst.txt @@ -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 diff --git a/_sources/modules/chipsec.hal.common.hob.rst.txt b/_sources/modules/chipsec.hal.common.hob.rst.txt new file mode 100644 index 00000000..35db4d02 --- /dev/null +++ b/_sources/modules/chipsec.hal.common.hob.rst.txt @@ -0,0 +1,7 @@ +chipsec.hal.common.hob module +============================= + +.. automodule:: chipsec.hal.common.hob + + + diff --git a/_sources/modules/chipsec.hal.common.rst.txt b/_sources/modules/chipsec.hal.common.rst.txt index 9be63121..3af11c19 100644 --- a/_sources/modules/chipsec.hal.common.rst.txt +++ b/_sources/modules/chipsec.hal.common.rst.txt @@ -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 diff --git a/_sources/modules/chipsec.utilcmd.hob_cmd.rst.txt b/_sources/modules/chipsec.utilcmd.hob_cmd.rst.txt new file mode 100644 index 00000000..e44bd421 --- /dev/null +++ b/_sources/modules/chipsec.utilcmd.hob_cmd.rst.txt @@ -0,0 +1,7 @@ +chipsec.utilcmd.hob\_cmd module +=============================== + +.. automodule:: chipsec.utilcmd.hob_cmd + + + diff --git a/_sources/modules/chipsec.utilcmd.rst.txt b/_sources/modules/chipsec.utilcmd.rst.txt index 869582f3..3ed081ff 100644 --- a/_sources/modules/chipsec.utilcmd.rst.txt +++ b/_sources/modules/chipsec.utilcmd.rst.txt @@ -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 diff --git a/contribution/code-style-python.html b/contribution/code-style-python.html index a4a4906f..19668ca5 100644 --- a/contribution/code-style-python.html +++ b/contribution/code-style-python.html @@ -86,10 +86,10 @@

Python Coding Style Guide
'This is a preferred "string".'
-"Also an acceptable 'string'."
+
'This is a preferred "string".'
+"Also an acceptable 'string'."
 
-"Avoid making this \"string\"."
+"Avoid making this \"string\"."
@@ -110,7 +110,7 @@

Python Coding Style Guidefrom chipsec.module_common import BaseModule from chipsec.library.returncode import ModuleResult -# Bad - using '*' and importing sys after local imports +# Bad - using '*' and importing sys after local imports import * from chipsec.module_common import * import sys @@ -203,7 +203,7 @@

Python Coding Style Guide
"""String description docstring."""
+
"""String description docstring."""
@@ -617,7 +617,7 @@

Navigation

 diff --git a/contribution/sphinx.html b/contribution/sphinx.html index 353283ac..8321c9f2 100644 --- a/contribution/sphinx.html +++ b/contribution/sphinx.html @@ -157,7 +157,7 @@

Navigation

diff --git a/development/Architecture-Overview.html b/development/Architecture-Overview.html index 6c0e306c..006cd9c9 100644 --- a/development/Architecture-Overview.html +++ b/development/Architecture-Overview.html @@ -126,6 +126,7 @@

Commands
  • chipsec.utilcmd.desc_cmd module
  • chipsec.utilcmd.ec_cmd module
  • chipsec.utilcmd.hals_cmd module
    • +
  • chipsec.utilcmd.hob_cmd module
  • chipsec.utilcmd.igd_cmd module
  • chipsec.utilcmd.interrupts_cmd module
  • chipsec.utilcmd.io_cmd module
    • @@ -173,6 +174,7 @@

    HAL (Hardware Abstraction Layer)chipsec.hal.common.cmos module
  • chipsec.hal.common.cpuid module
  • chipsec.hal.common.ec module
    • +
  • chipsec.hal.common.hob module
  • chipsec.hal.common.interrupts module
  • chipsec.hal.common.io module
  • chipsec.hal.common.iobar module
    • @@ -368,7 +370,7 @@

    Navigation

    diff --git a/development/Configuration-Files.html b/development/Configuration-Files.html index 15682c64..25852b73 100644 --- a/development/Configuration-Files.html +++ b/development/Configuration-Files.html @@ -69,17 +69,17 @@

    Navigation

    Configuration File Example

    <mmio>
-<bar name="SPIBAR" bus="0" dev="0x1F" fun="5" reg="0x10" width="4" mask="0xFFFFF000" size="0x1000" desc="SPI Controller Register Range" offset="0x0"/>
+<bar name="SPIBAR" bus="0" dev="0x1F" fun="5" reg="0x10" width="4" mask="0xFFFFF000" size="0x1000" desc="SPI Controller Register Range" offset="0x0"/>
 </mmio>
 <registers>
-<register name="BC" type="pcicfg" bus="0" dev="0x1F" fun="5" offset="0xDC" size="4" desc="BIOS Control">
-<field name="BIOSWE" bit="0" size="1" desc="BIOS Write Enable" />
+<register name="BC" type="pcicfg" bus="0" dev="0x1F" fun="5" offset="0xDC" size="4" desc="BIOS Control">
+<field name="BIOSWE" bit="0" size="1" desc="BIOS Write Enable" />
 …
-<field name="BILD" bit="7" size="1" desc="BIOS Interface Lock Down"/>
+<field name="BILD" bit="7" size="1" desc="BIOS Interface Lock Down"/>
 </register>
 </registers>
 <controls>
-<control name="BiosInterfaceLockDown" register="BC" field="BILD" desc="BIOS Interface Lock-Down"/>
+<control name="BiosInterfaceLockDown" register="BC" field="BILD" desc="BIOS Interface Lock-Down"/>
 </controls>
    @@ -208,7 +208,7 @@

    Navigation

    diff --git a/development/Developing.html b/development/Developing.html index 9f874eb8..1568bb99 100644 --- a/development/Developing.html +++ b/development/Developing.html @@ -51,20 +51,20 @@

    Writing Your Own Modules

  • Define the control in the platform XML file (in chipsec/cfg):

    -
    <control name="BiosLockEnable"     register="BC"    field="BLE"    desc="BIOS Lock Enable"/>
+
    <control name="BiosLockEnable"     register="BC"    field="BLE"    desc="BIOS Lock Enable"/>

  • Get the current status of the control:

    -
    ble = self.cs.control.get_list_by_name('BiosLockEnable').is_all_value(1)
+
    ble = self.cs.control.get_list_by_name('BiosLockEnable').is_all_value(1)

  • React based on the status of the control:

    if ble:
-    self.logger.log_passed("BIOS Lock is set.")
+    self.logger.log_passed("BIOS Lock is set.")
 else:
-    self.logger.log_failed("BIOS Lock is not set.")
+    self.logger.log_failed("BIOS Lock is not set.")
    • @@ -193,7 +193,7 @@

    Navigation

     diff --git a/development/OS-Helpers-and-Drivers.html b/development/OS-Helpers-and-Drivers.html index c316803c..61e1cebf 100644 --- a/development/OS-Helpers-and-Drivers.html +++ b/development/OS-Helpers-and-Drivers.html @@ -67,7 +67,7 @@

    Exampledef __init__(self): super(NewHelper, self).__init__() - self.name = "NewHelper" + self.name = "NewHelper"

    @@ -192,7 +192,7 @@

    Navigation

     diff --git a/development/Platform-Detection.html b/development/Platform-Detection.html index 8e462607..0987c20b 100644 --- a/development/Platform-Detection.html +++ b/development/Platform-Detection.html @@ -164,7 +164,7 @@

    Navigation

    diff --git a/development/Sample-Module-Code.html b/development/Sample-Module-Code.html index 6ef97459..ea171c57 100644 --- a/development/Sample-Module-Code.html +++ b/development/Sample-Module-Code.html @@ -50,25 +50,25 @@

    Sample module code templatefrom chipsec.library.returncode import ModuleResult class ModuleClass(BaseModule): - """Class name aligns with file name, eg ModuleClass.py""" + """Class name aligns with file name, eg ModuleClass.py""" def __init__(self): BaseModule.__init__(self) def is_supported(self) -> bool: - """Module prerequisite checks""" + """Module prerequisite checks""" if some_module_requirement(): return True # Module is applicable self.res = ModuleResult.NOTAPPLICABLE return False # Module is not applicable def action(self) -> int: - """Module test logic and methods as needed""" - self.logger.log_passed('Module was successful!') + """Module test logic and methods as needed""" + self.logger.log_passed('Module was successful!') return ModuleResult.PASSED def run(self, module_argv) -> int: - """Primary module execution and result handling""" - self.logger.start_test('Module Description') + """Primary module execution and result handling""" + self.logger.start_test('Module Description') self.res = self.action() return self.res @@ -173,7 +173,7 @@

    Navigation

     diff --git a/development/Sample-Util-Command.html b/development/Sample-Util-Command.html index 3649651e..783ba326 100644 --- a/development/Sample-Util-Command.html +++ b/development/Sample-Util-Command.html @@ -54,16 +54,16 @@

    Util Commandfrom chipsec.command import BaseCommand, toLoad class CommandClass(BaseCommand): - """ + """ >>> chipsec_util command_display_name action - """ + """ def requirements(self) -> toLoad: return toLoad.All def parse_arguments(self): - parser = ArgumentParser(prog='chipsec_util command_display_name', usage=CommandClass.__doc__) + parser = ArgumentParser(prog='chipsec_util command_display_name', usage=CommandClass.__doc__) subparsers = parser.add_subparsers() - parser_entrypoint = subparsers.add_parser('action') + parser_entrypoint = subparsers.add_parser('action') parser_entrypoint.set_defaults(func=self.action) parser.parse_args(self.argv, namespace=self) @@ -73,7 +73,7 @@

    Util Commanddef run(self): self.func() -commands = {'command_display_name': CommandClass} +commands = {'command_display_name': CommandClass} @@ -176,7 +176,7 @@

    Navigation

     diff --git a/development/Vulnerabilities-and-CHIPSEC-Modules.html b/development/Vulnerabilities-and-CHIPSEC-Modules.html index 87212fac..6fcc50fa 100644 --- a/development/Vulnerabilities-and-CHIPSEC-Modules.html +++ b/development/Vulnerabilities-and-CHIPSEC-Modules.html @@ -653,7 +653,7 @@

    Navigation

    diff --git a/genindex.html b/genindex.html index 8abf2f28..9e28fa7c 100644 --- a/genindex.html +++ b/genindex.html @@ -58,6 +58,13 @@

    C

    +
  • + chipsec.cfg.parsers.hob_parser + +
  • @@ -79,6 +86,13 @@

    C

    • +
  • + chipsec.cfg.parsers.ip.hob + +
  • @@ -163,6 +177,13 @@

    C

    • +
  • + chipsec.cfg.parsers.registers.hob + +
  • @@ -317,6 +338,13 @@

    C

    • +
  • + chipsec.hal.common.hob + +
  • @@ -858,6 +886,8 @@

    C

  • module
    • + + - - diff --git a/index.html b/index.html index ddae0973..06aefb02 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ - CHIPSEC 2.0.7 — CHIPSEC documentation + CHIPSEC 2.0.8 — CHIPSEC documentation @@ -31,7 +31,7 @@

    Navigation

    next |
  • CHIPSEC documentation »
    • -
  • CHIPSEC 2.0.7
    • +
  • CHIPSEC 2.0.8
    • @@ -40,8 +40,8 @@

    Navigation

    -
    -

    CHIPSEC 2.0.7

    +
    +

    CHIPSEC 2.0.8

    CHIPSEC is a framework for analyzing platform level security of hardware, devices, system firmware, low-level protection mechanisms, and the configuration of various platform components.

    @@ -229,11 +229,11 @@

    Navigation

    next |
  • CHIPSEC documentation »
    • -
  • CHIPSEC 2.0.7
    • +
  • CHIPSEC 2.0.8
    • diff --git a/installation/InstallLinux.html b/installation/InstallLinux.html index cb48c6b1..65cac977 100644 --- a/installation/InstallLinux.html +++ b/installation/InstallLinux.html @@ -226,7 +226,7 @@

    Navigation

    diff --git a/installation/InstallWinDAL.html b/installation/InstallWinDAL.html index 08ed17ec..c84282b7 100644 --- a/installation/InstallWinDAL.html +++ b/installation/InstallWinDAL.html @@ -164,7 +164,7 @@

    Navigation

    diff --git a/installation/InstallWindows.html b/installation/InstallWindows.html index 2f33ef1c..28e88e76 100644 --- a/installation/InstallWindows.html +++ b/installation/InstallWindows.html @@ -424,7 +424,7 @@

    Navigation

    diff --git a/installation/USBwithUEFIShell.html b/installation/USBwithUEFIShell.html index 96e0c2e7..9aeacbd7 100644 --- a/installation/USBwithUEFIShell.html +++ b/installation/USBwithUEFIShell.html @@ -252,7 +252,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.adl.xml.html b/modules/chipsec.cfg.8086.adl.xml.html index 481195ad..610280a2 100644 --- a/modules/chipsec.cfg.8086.adl.xml.html +++ b/modules/chipsec.cfg.8086.adl.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.arl.xml.html b/modules/chipsec.cfg.8086.arl.xml.html index 3d308f93..9bbffd48 100644 --- a/modules/chipsec.cfg.8086.arl.xml.html +++ b/modules/chipsec.cfg.8086.arl.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.arlh.xml.html b/modules/chipsec.cfg.8086.arlh.xml.html index e71030f7..96f65688 100644 --- a/modules/chipsec.cfg.8086.arlh.xml.html +++ b/modules/chipsec.cfg.8086.arlh.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.html b/modules/chipsec.cfg.8086.html index 524f339b..c46ab9af 100644 --- a/modules/chipsec.cfg.8086.html +++ b/modules/chipsec.cfg.8086.html @@ -166,7 +166,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.kbl.xml.html b/modules/chipsec.cfg.8086.kbl.xml.html index 0c391f27..425764e5 100644 --- a/modules/chipsec.cfg.8086.kbl.xml.html +++ b/modules/chipsec.cfg.8086.kbl.xml.html @@ -154,7 +154,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.kbl_orig.xmls.html b/modules/chipsec.cfg.8086.kbl_orig.xmls.html index 3dcb00d8..6e479edf 100644 --- a/modules/chipsec.cfg.8086.kbl_orig.xmls.html +++ b/modules/chipsec.cfg.8086.kbl_orig.xmls.html @@ -157,7 +157,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.lnl.xml.html b/modules/chipsec.cfg.8086.lnl.xml.html index a21226f2..efceacab 100644 --- a/modules/chipsec.cfg.8086.lnl.xml.html +++ b/modules/chipsec.cfg.8086.lnl.xml.html @@ -154,7 +154,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.mtl.xml.html b/modules/chipsec.cfg.8086.mtl.xml.html index d93f207e..79beff90 100644 --- a/modules/chipsec.cfg.8086.mtl.xml.html +++ b/modules/chipsec.cfg.8086.mtl.xml.html @@ -154,7 +154,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.pch_3xxlp_orig.xmls.html b/modules/chipsec.cfg.8086.pch_3xxlp_orig.xmls.html index 6895e969..bd9330ba 100644 --- a/modules/chipsec.cfg.8086.pch_3xxlp_orig.xmls.html +++ b/modules/chipsec.cfg.8086.pch_3xxlp_orig.xmls.html @@ -154,7 +154,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.pch_5xxlp.xml.html b/modules/chipsec.cfg.8086.pch_5xxlp.xml.html index a92bf23e..020196b0 100644 --- a/modules/chipsec.cfg.8086.pch_5xxlp.xml.html +++ b/modules/chipsec.cfg.8086.pch_5xxlp.xml.html @@ -152,7 +152,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.pch_6xxp.xml.html b/modules/chipsec.cfg.8086.pch_6xxp.xml.html index 74e61ee7..fdfd6f9e 100644 --- a/modules/chipsec.cfg.8086.pch_6xxp.xml.html +++ b/modules/chipsec.cfg.8086.pch_6xxp.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.pch_7xx.xml.html b/modules/chipsec.cfg.8086.pch_7xx.xml.html index ccd67c7b..d9ff0ec1 100644 --- a/modules/chipsec.cfg.8086.pch_7xx.xml.html +++ b/modules/chipsec.cfg.8086.pch_7xx.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.pch_7xxOP.xml.html b/modules/chipsec.cfg.8086.pch_7xxOP.xml.html index 6d6e16d6..0463d3be 100644 --- a/modules/chipsec.cfg.8086.pch_7xxOP.xml.html +++ b/modules/chipsec.cfg.8086.pch_7xxOP.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.pch_8xx.xml.html b/modules/chipsec.cfg.8086.pch_8xx.xml.html index e9094f8e..4c8bd79f 100644 --- a/modules/chipsec.cfg.8086.pch_8xx.xml.html +++ b/modules/chipsec.cfg.8086.pch_8xx.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.pmc_i440fx.xml.html b/modules/chipsec.cfg.8086.pmc_i440fx.xml.html index 92a84001..a46fe927 100644 --- a/modules/chipsec.cfg.8086.pmc_i440fx.xml.html +++ b/modules/chipsec.cfg.8086.pmc_i440fx.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.q35.xml.html b/modules/chipsec.cfg.8086.q35.xml.html index 14bee443..39342174 100644 --- a/modules/chipsec.cfg.8086.q35.xml.html +++ b/modules/chipsec.cfg.8086.q35.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.rpl.xml.html b/modules/chipsec.cfg.8086.rpl.xml.html index 7cf28104..1e6d7978 100644 --- a/modules/chipsec.cfg.8086.rpl.xml.html +++ b/modules/chipsec.cfg.8086.rpl.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.8086.tglu.xml.html b/modules/chipsec.cfg.8086.tglu.xml.html index 1ffd5354..43098010 100644 --- a/modules/chipsec.cfg.8086.tglu.xml.html +++ b/modules/chipsec.cfg.8086.tglu.xml.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.controls.html b/modules/chipsec.cfg.parsers.controls.html index 2aad896e..316ed966 100644 --- a/modules/chipsec.cfg.parsers.controls.html +++ b/modules/chipsec.cfg.parsers.controls.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.core_parser_helper.html b/modules/chipsec.cfg.parsers.core_parser_helper.html index 73a586ad..abf68c1f 100644 --- a/modules/chipsec.cfg.parsers.core_parser_helper.html +++ b/modules/chipsec.cfg.parsers.core_parser_helper.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.hob_parser.html b/modules/chipsec.cfg.parsers.hob_parser.html new file mode 100644 index 00000000..cae0afb7 --- /dev/null +++ b/modules/chipsec.cfg.parsers.hob_parser.html @@ -0,0 +1,160 @@ + + + + + + + + chipsec.cfg.parsers.hob_parser module — CHIPSEC documentation + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    chipsec.cfg.parsers.hob_parser module

    +

    HOB definition parser - describes the payload of GUID extension HOBs in XML

    +

    A platform configuration file pulls in HOB definitions the same way it pulls in +other definitions, naming the IP node that will hold them:

    +
    +
    +
    <hob>

    <definition name=”HOB” config=”HOB.hob0.xml” />

    +
    +
    +

    </hob>

    +
    +

    The included file declares one <structure> element per known GUID extension HOB, +with a <field> element per member of the corresponding C structure, in declaration +order:

    +
    +
    +
    <hob>
    +
    <structure name=”PEI_PCD_DATABASE” guid=”EA296D92-0B69-423C-8C28-33B4E0A91268”>

    <field name=”Signature” type=”guid” desc=”PcdDataBaseGuid” /> +<field name=”BuildVersion” type=”uint32” /> +<field name=”Pad” type=”bytes” size=”6” />

    +
    +
    +

    </structure>

    +
    +
    +

    </hob>

    +
    +

    Layouts are packed (no implicit alignment padding), so any padding present in the +C structure must be declared explicitly as a field.

    +

    Definitions are stored by GUID in Cfg.HOB_DEFINITIONS and each one is exposed as a +register whose fields are the structure members (byte offsets converted to bit +positions), published into the platform hierarchy as VID.<definition name>.<structure name>.

    +
    + + +
    +
    +
    +
    + +
    +
    + + + + \ No newline at end of file diff --git a/modules/chipsec.cfg.parsers.iommu_parser.html b/modules/chipsec.cfg.parsers.iommu_parser.html index a53fa3bc..6a1bcf9c 100644 --- a/modules/chipsec.cfg.parsers.iommu_parser.html +++ b/modules/chipsec.cfg.parsers.iommu_parser.html @@ -124,7 +124,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.generic.html b/modules/chipsec.cfg.parsers.ip.generic.html index acc4ed04..2151d1f7 100644 --- a/modules/chipsec.cfg.parsers.ip.generic.html +++ b/modules/chipsec.cfg.parsers.ip.generic.html @@ -126,7 +126,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.hob.html b/modules/chipsec.cfg.parsers.ip.hob.html new file mode 100644 index 00000000..ce880c50 --- /dev/null +++ b/modules/chipsec.cfg.parsers.ip.hob.html @@ -0,0 +1,133 @@ + + + + + + + + chipsec.cfg.parsers.ip.hob module — CHIPSEC documentation + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    chipsec.cfg.parsers.ip.hob module

    +

    HOB (Hand-Off Block) configuration parser.

    +

    This module provides the HOBConfig class describing a <definition> entry of the +top-level <hob> section. The definition names the IP node that holds the HOB +structure declarations pulled in from its config file(s).

    +
    + + +
    +
    +
    +
    + +
    +
    + + + + \ No newline at end of file diff --git a/modules/chipsec.cfg.parsers.ip.html b/modules/chipsec.cfg.parsers.ip.html index ed90ae21..99818975 100644 --- a/modules/chipsec.cfg.parsers.ip.html +++ b/modules/chipsec.cfg.parsers.ip.html @@ -41,6 +41,7 @@

    chipsec.cfg.parsers.ip package diff --git a/modules/chipsec.cfg.parsers.ip.io.html b/modules/chipsec.cfg.parsers.ip.io.html index 0528f397..383d56dc 100644 --- a/modules/chipsec.cfg.parsers.ip.io.html +++ b/modules/chipsec.cfg.parsers.ip.io.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.iobar.html b/modules/chipsec.cfg.parsers.ip.iobar.html index 9130ccd4..d8895540 100644 --- a/modules/chipsec.cfg.parsers.ip.iobar.html +++ b/modules/chipsec.cfg.parsers.ip.iobar.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.memory.html b/modules/chipsec.cfg.parsers.ip.memory.html index 447a8c7e..b1116af4 100644 --- a/modules/chipsec.cfg.parsers.ip.memory.html +++ b/modules/chipsec.cfg.parsers.ip.memory.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.mm_msgbus.html b/modules/chipsec.cfg.parsers.ip.mm_msgbus.html index 72662526..86b39ce4 100644 --- a/modules/chipsec.cfg.parsers.ip.mm_msgbus.html +++ b/modules/chipsec.cfg.parsers.ip.mm_msgbus.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.mmio_bar.html b/modules/chipsec.cfg.parsers.ip.mmio_bar.html index d4615687..5e777f4d 100644 --- a/modules/chipsec.cfg.parsers.ip.mmio_bar.html +++ b/modules/chipsec.cfg.parsers.ip.mmio_bar.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.msgbus.html b/modules/chipsec.cfg.parsers.ip.msgbus.html index d0acc517..c2025820 100644 --- a/modules/chipsec.cfg.parsers.ip.msgbus.html +++ b/modules/chipsec.cfg.parsers.ip.msgbus.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.msr.html b/modules/chipsec.cfg.parsers.ip.msr.html index 1f76c2cb..fc5d9c47 100644 --- a/modules/chipsec.cfg.parsers.ip.msr.html +++ b/modules/chipsec.cfg.parsers.ip.msr.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.pci_device.html b/modules/chipsec.cfg.parsers.ip.pci_device.html index 671da27c..67440a59 100644 --- a/modules/chipsec.cfg.parsers.ip.pci_device.html +++ b/modules/chipsec.cfg.parsers.ip.pci_device.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.ip.platform.html b/modules/chipsec.cfg.parsers.ip.platform.html index 44855132..c250483d 100644 --- a/modules/chipsec.cfg.parsers.ip.platform.html +++ b/modules/chipsec.cfg.parsers.ip.platform.html @@ -126,7 +126,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.locks.html b/modules/chipsec.cfg.parsers.locks.html index 6488d81e..079b75d3 100644 --- a/modules/chipsec.cfg.parsers.locks.html +++ b/modules/chipsec.cfg.parsers.locks.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.controls.html b/modules/chipsec.cfg.parsers.registers.controls.html index be63a6a7..fe7bd0a3 100644 --- a/modules/chipsec.cfg.parsers.registers.controls.html +++ b/modules/chipsec.cfg.parsers.registers.controls.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.hob.html b/modules/chipsec.cfg.parsers.registers.hob.html new file mode 100644 index 00000000..356404dc --- /dev/null +++ b/modules/chipsec.cfg.parsers.registers.hob.html @@ -0,0 +1,145 @@ + + + + + + + + chipsec.cfg.parsers.registers.hob module — CHIPSEC documentation + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    chipsec.cfg.parsers.registers.hob module

    +

    Register view of a GUID extension HOB payload.

    +

    The payload is held as a single integer so that each structure member declared in +XML becomes a normal register field: its ‘bit’ is the member’s byte offset times +eight and its ‘size’ is the member’s width in bits. This makes the standard field +accessors (get_field / has_field / get_field_mask) work directly on HOB data.

    +
    +
    Two distinct byte orders are involved:
      +

    • The payload is packed into the integer little-endian so that the first byte of +the structure is the least significant one. That is what makes byte offset N +map to bit N*8; it is a container encoding, not an interpretation of the data.

      • +

    • Individual members are reinterpreted using sys.byteorder, because the HOB list +is read from the memory of the machine running CHIPSEC and is therefore stored +in that machine’s native order (matching the ‘=’ prefix used for sizing).

      • +
    +
    +
    +
    + + +
    +
    +
    +
    + +
    +
    + + + + \ No newline at end of file diff --git a/modules/chipsec.cfg.parsers.registers.html b/modules/chipsec.cfg.parsers.registers.html index a094befe..3f1e1056 100644 --- a/modules/chipsec.cfg.parsers.registers.html +++ b/modules/chipsec.cfg.parsers.registers.html @@ -41,6 +41,7 @@

    chipsec.cfg.parsers.registers package diff --git a/modules/chipsec.cfg.parsers.registers.io.html b/modules/chipsec.cfg.parsers.registers.io.html index bfef2cef..abe695f2 100644 --- a/modules/chipsec.cfg.parsers.registers.io.html +++ b/modules/chipsec.cfg.parsers.registers.io.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.iobar.html b/modules/chipsec.cfg.parsers.registers.iobar.html index d60b20d8..c9f8be30 100644 --- a/modules/chipsec.cfg.parsers.registers.iobar.html +++ b/modules/chipsec.cfg.parsers.registers.iobar.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.locks.html b/modules/chipsec.cfg.parsers.registers.locks.html index a88a1827..f23d2552 100644 --- a/modules/chipsec.cfg.parsers.registers.locks.html +++ b/modules/chipsec.cfg.parsers.registers.locks.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.memory.html b/modules/chipsec.cfg.parsers.registers.memory.html index 2ef74fd8..4128e9ec 100644 --- a/modules/chipsec.cfg.parsers.registers.memory.html +++ b/modules/chipsec.cfg.parsers.registers.memory.html @@ -125,7 +125,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.mm_msgbus.html b/modules/chipsec.cfg.parsers.registers.mm_msgbus.html index 56f9ae4f..a171c84a 100644 --- a/modules/chipsec.cfg.parsers.registers.mm_msgbus.html +++ b/modules/chipsec.cfg.parsers.registers.mm_msgbus.html @@ -126,7 +126,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.mmcfg.html b/modules/chipsec.cfg.parsers.registers.mmcfg.html index 02c8a889..eb4e4e9e 100644 --- a/modules/chipsec.cfg.parsers.registers.mmcfg.html +++ b/modules/chipsec.cfg.parsers.registers.mmcfg.html @@ -126,7 +126,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.mmio.html b/modules/chipsec.cfg.parsers.registers.mmio.html index 704ef78a..6974872e 100644 --- a/modules/chipsec.cfg.parsers.registers.mmio.html +++ b/modules/chipsec.cfg.parsers.registers.mmio.html @@ -126,7 +126,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.msgbus.html b/modules/chipsec.cfg.parsers.registers.msgbus.html index cebfc9a9..ea58f51c 100644 --- a/modules/chipsec.cfg.parsers.registers.msgbus.html +++ b/modules/chipsec.cfg.parsers.registers.msgbus.html @@ -126,7 +126,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.msr.html b/modules/chipsec.cfg.parsers.registers.msr.html index 869e49d5..6328a0d5 100644 --- a/modules/chipsec.cfg.parsers.registers.msr.html +++ b/modules/chipsec.cfg.parsers.registers.msr.html @@ -126,7 +126,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.pci.html b/modules/chipsec.cfg.parsers.registers.pci.html index 0e319cc8..10d6ce9a 100644 --- a/modules/chipsec.cfg.parsers.registers.pci.html +++ b/modules/chipsec.cfg.parsers.registers.pci.html @@ -124,7 +124,7 @@

    Navigation

    diff --git a/modules/chipsec.cfg.parsers.registers.simple.html b/modules/chipsec.cfg.parsers.registers.simple.html index e88f4b9d..93932021 100644 --- a/modules/chipsec.cfg.parsers.registers.simple.html +++ b/modules/chipsec.cfg.parsers.registers.simple.html @@ -126,7 +126,7 @@

    Navigation

    diff --git a/modules/chipsec.fuzzing.html b/modules/chipsec.fuzzing.html index 1927e465..c6964c50 100644 --- a/modules/chipsec.fuzzing.html +++ b/modules/chipsec.fuzzing.html @@ -153,7 +153,7 @@

    Navigation

    diff --git a/modules/chipsec.fuzzing.primitives.html b/modules/chipsec.fuzzing.primitives.html index 2900a5e2..a209bbd8 100644 --- a/modules/chipsec.fuzzing.primitives.html +++ b/modules/chipsec.fuzzing.primitives.html @@ -150,7 +150,7 @@

    Navigation

    diff --git a/modules/chipsec.hal.amd.cpu.html b/modules/chipsec.hal.amd.cpu.html index 71ed65a8..2f78c730 100644 --- a/modules/chipsec.hal.amd.cpu.html +++ b/modules/chipsec.hal.amd.cpu.html @@ -153,7 +153,7 @@

    Navigation

    diff --git a/modules/chipsec.hal.amd.html b/modules/chipsec.hal.amd.html index b1a732fb..4faf407a 100644 --- a/modules/chipsec.hal.amd.html +++ b/modules/chipsec.hal.amd.html @@ -156,7 +156,7 @@

    Navigation

    diff --git a/modules/chipsec.hal.amd.psp.html b/modules/chipsec.hal.amd.psp.html index 63f36db3..ae609734 100644 --- a/modules/chipsec.hal.amd.psp.html +++ b/modules/chipsec.hal.amd.psp.html @@ -152,7 +152,7 @@

    Navigation

    diff --git a/modules/chipsec.hal.common.acpi.html b/modules/chipsec.hal.common.acpi.html index baf52603..08f04fac 100644 --- a/modules/chipsec.hal.common.acpi.html +++ b/modules/chipsec.hal.common.acpi.html @@ -153,7 +153,7 @@

    Navigation

    diff --git a/modules/chipsec.hal.common.cmos.html b/modules/chipsec.hal.common.cmos.html index 9c321292..377ab43a 100644 --- a/modules/chipsec.hal.common.cmos.html +++ b/modules/chipsec.hal.common.cmos.html @@ -165,7 +165,7 @@

    Navigation

    diff --git a/modules/chipsec.hal.common.cpuid.html b/modules/chipsec.hal.common.cpuid.html index da2a7b9b..7b67ec4e 100644 --- a/modules/chipsec.hal.common.cpuid.html +++ b/modules/chipsec.hal.common.cpuid.html @@ -159,7 +159,7 @@

    Navigation

    diff --git a/modules/chipsec.hal.common.ec.html b/modules/chipsec.hal.common.ec.html index 44f4be2b..77b48c71 100644 --- a/modules/chipsec.hal.common.ec.html +++ b/modules/chipsec.hal.common.ec.html @@ -16,7 +16,7 @@ - +

    Next topic

    -

    chipsec.hal.common.interrupts module

    +

    chipsec.hal.common.hob module