Files
chipsec-chipsec/docs/sphinx/Configuration-Files.rst
T
Sae86 d52ea51fd7 Sphinx update
Modified:
        docs/create_manual.cmd - Add html command and options to build either html or pdf, or both
        docs/sphinx/_templates/scover.tmpl - Update date automatically
        docs/sphinx/_templates/sstylesheet.style - remove references to templates that will no longer be used, add format styles
        docs/sphinx/conf.py - Add several changes for documentation creation. HTML: main doc, copyright year, version and release numbers, html theme options. PDF: increased toc depth
        docs/sphinx/index.rst - Update from Home wiki page
        docs/sphinx/removeStrRst.py - change how titles are shown and more information shown for modules and add a function to update version in scover

Deleted:
        docs/sphinx/_templates/cover.pdf - no longer used
        docs/sphinx/_templates/layout.html - no longer used
        docs/sphinx/_templates/page.pdf - no longer used
        docs/sphinx/_templates/theme.conf - added in conf.py
        docs/sphinx/_images/chipsec.jpg - replaced by architecture.png
        Replaced by imported wiki files:
	    docs/sphinx/compandstruct.rst
	    docs/sphinx/dalinstall.rst
	    docs/sphinx/description.rst
            docs/sphinx/installation.rst
            docs/sphinx/linuxinstall.rst
            docs/sphinx/mod.rst
            docs/sphinx/options.py
            docs/sphinx/options.rst
            docs/sphinx/osxinstall.rst
            docs/sphinx/uefinstall.rst
            docs/sphinx/usage.rst
            docs/sphinx/winstall.rst

Added
        docs/create_manual.sh - Add script version for linux
the following is a list of files imported from the wiki:
        docs/sphinx/Architecture-Overview.rst
        docs/sphinx/Configuration-Files.rst
        docs/sphinx/Developing.rst
        docs/sphinx/Install in DAL Win.rst
        docs/sphinx/Install in Linux.rst
        docs/sphinx/Install in MacOS.rst
        docs/sphinx/Install in Windows.rst
        docs/sphinx/Interpreting-Results.rst
        docs/sphinx/OS-Helpers-and-Drivers.rst
        docs/sphinx/Platform-Detection.rst
        docs/sphinx/Running-Chipsec.rst
        docs/sphinx/USB with UEFI Shell.rst
        docs/sphinx/Using-CHIPSEC-with-Kali-Linux.rst
        docs/sphinx/Vulnerabilities-and-CHIPSEC-Modules.rst
        docs/sphinx/_images/architecture.png

Signed-off-by: Sae86 <sae.batllori@intel.com>
2021-03-31 18:40:27 -07:00

34 lines
1001 B
ReStructuredText

.. _Configuration-Files:
Configuration Files
===================
Broken into common and platform specific configuration files
Used to define controls, registers and bit fields
Common files always loaded first so the platform files can override
values
Correct platform configuration files loaded based off of platform
detection
Configuraiton 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"/>
</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" />
<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"/>
</controls>