diff --git a/_sources/development/Developing.rst.txt b/_sources/development/Developing.rst.txt index 9711d4dd..617f17fd 100644 --- a/_sources/development/Developing.rst.txt +++ b/_sources/development/Developing.rst.txt @@ -17,7 +17,7 @@ Most modules read some platform configuration and then pass or fail based on the .. code-block:: python - ble = self.cs.control.get('BiosLockEnable') + ble = self.cs.control.get_list_by_name('BiosLockEnable').is_all_value(1) 3. React based on the status of the control: diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt index 3a5d2bdc..2e415b76 100644 --- a/_sources/index.rst.txt +++ b/_sources/index.rst.txt @@ -1,10 +1,10 @@ -.. CHIPSEC 1.13.16 documentation file, created by +.. CHIPSEC 2.0.0-rc4 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 1.13.16 -=============== +CHIPSEC 2.0.0-rc4 +================= CHIPSEC is a framework for analyzing platform level security of hardware, devices, system firmware, low-level protection mechanisms, and diff --git a/_sources/modules/chipsec.cfg.8086.adl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.adl.xml.rst.txt index 68f4ddf6..323ed551 100644 --- a/_sources/modules/chipsec.cfg.8086.adl.xml.rst.txt +++ b/_sources/modules/chipsec.cfg.8086.adl.xml.rst.txt @@ -5,7 +5,7 @@ Path: chipsec\\cfg\\8086\\adl.xml CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2021-2022, Intel Corporation +Copyright (c) 2023, Intel Corporation This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License diff --git a/_sources/modules/chipsec.cfg.8086.apl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.apl.xml.rst.txt deleted file mode 100644 index 02dd8d2e..00000000 --- a/_sources/modules/chipsec.cfg.8086.apl.xml.rst.txt +++ /dev/null @@ -1,9 +0,0 @@ -apl -======= - -Path: chipsec\\cfg\\8086\\apl.xml - - -XML configuration for Apollo Lake based SoCs -document id 334818/334819 - diff --git a/_sources/modules/chipsec.cfg.8086.avn.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.avn.xml.rst.txt deleted file mode 100644 index 77a37b9b..00000000 --- a/_sources/modules/chipsec.cfg.8086.avn.xml.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -avn -======= - -Path: chipsec\\cfg\\8086\\avn.xml - - -XML configuration for Avoton based platforms - -* Intel(R) Atom(TM) Processor C2000 Product Family for Microserver, September 2014 - http://www.intel.com/content/www/us/en/processors/atom/atom-c2000-microserver-datasheet.html - diff --git a/_sources/modules/chipsec.cfg.8086.bdw.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.bdw.xml.rst.txt deleted file mode 100644 index de53c4d4..00000000 --- a/_sources/modules/chipsec.cfg.8086.bdw.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -bdw -======= - -Path: chipsec\\cfg\\8086\\bdw.xml - - -XML configuration for Broadwell based platforms - diff --git a/_sources/modules/chipsec.cfg.8086.bdx.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.bdx.xml.rst.txt deleted file mode 100644 index 90402f95..00000000 --- a/_sources/modules/chipsec.cfg.8086.bdx.xml.rst.txt +++ /dev/null @@ -1,13 +0,0 @@ -bdx -======= - -Path: chipsec\\cfg\\8086\\bdx.xml - - -XML configuration file for Broadwell Server based platforms -Intel (c) Xeon Processor E5 v4 Product Family datasheet Vol. 2 -Intel (c) Xeon Processor E7 v4 Product Family datasheet Vol. 2 -Intel (c) C600 Series Chipset and Intel (c) X79 Express Chipset datasheet -Intel (c) C600 Series Chipset and Intel (c) X79 Express Chipset Specification Update -Intel (c) C610 Series Chipset and Intel (c) X99 Chipset Platform Controller Hub (PCH) datasheet - diff --git a/_sources/modules/chipsec.cfg.8086.byt.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.byt.xml.rst.txt deleted file mode 100644 index e57d29ec..00000000 --- a/_sources/modules/chipsec.cfg.8086.byt.xml.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -byt -======= - -Path: chipsec\\cfg\\8086\\byt.xml - - -XML configuration for Bay Trail based platforms - -* Intel(R) Atom(TM) Processor E3800 Product Family Datasheet, May 2016, Revision 4.0 - http://www.intel.com/content/www/us/en/embedded/products/bay-trail/atom-e3800-family-datasheet.html - diff --git a/_sources/modules/chipsec.cfg.8086.cfl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.cfl.xml.rst.txt deleted file mode 100644 index 29d7e9d5..00000000 --- a/_sources/modules/chipsec.cfg.8086.cfl.xml.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -cfl -======= - -Path: chipsec\\cfg\\8086\\cfl.xml - - -XML configuration file for Coffee Lake - -* 8th Generation Intel(R) Processor Family for S-Processor Platforms - https://www.intel.com/content/www/us/en/processors/core/core-technical-resources.html - diff --git a/_sources/modules/chipsec.cfg.8086.cht.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.cht.xml.rst.txt deleted file mode 100644 index 06aa9ebe..00000000 --- a/_sources/modules/chipsec.cfg.8086.cht.xml.rst.txt +++ /dev/null @@ -1,14 +0,0 @@ -cht -======= - -Path: chipsec\\cfg\\8086\\cht.xml - - -XML configuration for Cherry Trail and Braswell SoCs - -* Intel(R) Atom(TM) Processor Z8000 series datasheet - http://www.intel.com/content/www/us/en/processors/atom/atom-z8000-datasheet-vol-2.html - -* N-series Intel(R) Pentium(R) and Celeron(R) Processors Datasheet - http://www.intel.com/content/dam/www/public/us/en/documents/datasheets/pentium-celeron-n-series-datasheet-vol-2.pdf - diff --git a/_sources/modules/chipsec.cfg.8086.cml.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.cml.xml.rst.txt deleted file mode 100644 index 3d8b8be3..00000000 --- a/_sources/modules/chipsec.cfg.8086.cml.xml.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -cml -======= - -Path: chipsec\\cfg\\8086\\cml.xml - - XML configuration file for Comet Lake diff --git a/_sources/modules/chipsec.cfg.8086.common.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.common.xml.rst.txt deleted file mode 100644 index 4ab92728..00000000 --- a/_sources/modules/chipsec.cfg.8086.common.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -common -========== - -Path: chipsec\\cfg\\8086\\common.xml - - -Common (default) XML platform configuration file - diff --git a/_sources/modules/chipsec.cfg.8086.dnv.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.dnv.xml.rst.txt deleted file mode 100644 index 11d38718..00000000 --- a/_sources/modules/chipsec.cfg.8086.dnv.xml.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -dnv -======= - -Path: chipsec\\cfg\\8086\\dnv.xml - - -XML configuration file for Denverton - -* Intel Atom(R) Processor C3000 Product Family - https://www.intel.com/content/www/us/en/processors/atom/atom-technical-resources.html - 337018-002 - diff --git a/_sources/modules/chipsec.cfg.8086.ehl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.ehl.xml.rst.txt deleted file mode 100644 index e587fe41..00000000 --- a/_sources/modules/chipsec.cfg.8086.ehl.xml.rst.txt +++ /dev/null @@ -1,9 +0,0 @@ -ehl -======= - -Path: chipsec\\cfg\\8086\\ehl.xml - - -XML configuration file for Elkhart Lake -Document ID: 635255, 636112, 636722, 636723 - diff --git a/_sources/modules/chipsec.cfg.8086.glk.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.glk.xml.rst.txt deleted file mode 100644 index 04772a7d..00000000 --- a/_sources/modules/chipsec.cfg.8086.glk.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -glk -======= - -Path: chipsec\\cfg\\8086\\glk.xml - - XML configuration for GLK - Document ID: 336561-001 - diff --git a/_sources/modules/chipsec.cfg.8086.hsw.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.hsw.xml.rst.txt deleted file mode 100644 index 5a9a80db..00000000 --- a/_sources/modules/chipsec.cfg.8086.hsw.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -hsw -======= - -Path: chipsec\\cfg\\8086\\hsw.xml - - -XML configuration file for Haswell based platforms - diff --git a/_sources/modules/chipsec.cfg.8086.hsx.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.hsx.xml.rst.txt deleted file mode 100644 index 0632542a..00000000 --- a/_sources/modules/chipsec.cfg.8086.hsx.xml.rst.txt +++ /dev/null @@ -1,13 +0,0 @@ -hsx -======= - -Path: chipsec\\cfg\\8086\\hsx.xml - - -XML configuration file for Haswell Server based platforms -Intel (c) Xeon Processor E5-1600/2400/2600/4600 v3 Product Family datasheet Vol. 2 -Intel (c) Xeon Processor E7-8800/4800 v3 Product Family datasheet Vol. 2 -Intel (c) C600 Series Chipset and Intel (c) X79 Express Chipset datasheet -Intel (c) C600 Series Chipset and Intel (c) X79 Express Chipset Specification Update -Intel (c) C610 Series Chipset and Intel (c) X99 Chipset Platform Controller Hub (PCH) datasheet - diff --git a/_sources/modules/chipsec.cfg.8086.icl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.icl.xml.rst.txt deleted file mode 100644 index 2657dfc3..00000000 --- a/_sources/modules/chipsec.cfg.8086.icl.xml.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -icl -======= - -Path: chipsec\\cfg\\8086\\icl.xml - - XML configuration file for Ice Lake diff --git a/_sources/modules/chipsec.cfg.8086.icx.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.icx.xml.rst.txt deleted file mode 100644 index 90040c2d..00000000 --- a/_sources/modules/chipsec.cfg.8086.icx.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -icx -======= - -Path: chipsec\\cfg\\8086\\icx.xml - - -XML configuration file for Icelake/Lewisburg Server - diff --git a/_sources/modules/chipsec.cfg.8086.iommu.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.iommu.xml.rst.txt deleted file mode 100644 index 5fbbe833..00000000 --- a/_sources/modules/chipsec.cfg.8086.iommu.xml.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -iommu -========= - -Path: chipsec\\cfg\\8086\\iommu.xml - - -XML configuration file for Intel Virtualization Technology for Directed I/O (VT-d) - -* Section 10 of Intel Virtualization Technology for Directed I/O - http://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/vt-directed-io-spec.pdf - diff --git a/_sources/modules/chipsec.cfg.8086.ivb.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.ivb.xml.rst.txt deleted file mode 100644 index 2ec89186..00000000 --- a/_sources/modules/chipsec.cfg.8086.ivb.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -ivb -======= - -Path: chipsec\\cfg\\8086\\ivb.xml - - -XML configuration for IvyBridge based platforms - diff --git a/_sources/modules/chipsec.cfg.8086.ivt.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.ivt.xml.rst.txt deleted file mode 100644 index fdf4a476..00000000 --- a/_sources/modules/chipsec.cfg.8086.ivt.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -ivt -======= - -Path: chipsec\\cfg\\8086\\ivt.xml - - -XML configuration file for Ivytown (Ivy Bridge-E) based platforms - diff --git a/_sources/modules/chipsec.cfg.8086.jkt.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.jkt.xml.rst.txt deleted file mode 100644 index 397fe376..00000000 --- a/_sources/modules/chipsec.cfg.8086.jkt.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -jkt -======= - -Path: chipsec\\cfg\\8086\\jkt.xml - - -XML configuration file for Jaketown (Sandy Bridge-E) based platforms - diff --git a/_sources/modules/chipsec.cfg.8086.kbl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.kbl.xml.rst.txt index f6ae0a06..f9974f64 100644 --- a/_sources/modules/chipsec.cfg.8086.kbl.xml.rst.txt +++ b/_sources/modules/chipsec.cfg.8086.kbl.xml.rst.txt @@ -3,12 +3,4 @@ kbl Path: chipsec\\cfg\\8086\\kbl.xml - -XML configuration file for Kaby Lake based platforms - -http://www.intel.com/content/www/us/en/processors/core/core-technical-resources.html - -* 7th Generation Intel(R) Processor Families for U/Y-Platforms - -* 7th Generation Intel(R) Processor Families I/O for U/Y-Platforms - + XML configuration file for Ice Lake diff --git a/_sources/modules/chipsec.cfg.8086.kbl_orig.xmls.rst.txt b/_sources/modules/chipsec.cfg.8086.kbl_orig.xmls.rst.txt new file mode 100644 index 00000000..a159adb6 --- /dev/null +++ b/_sources/modules/chipsec.cfg.8086.kbl_orig.xmls.rst.txt @@ -0,0 +1,14 @@ +kbl_orig. +============= + +Path: chipsec\\cfg\\8086\\kbl_orig.xmls + + +XML configuration file for Kaby Lake based platforms + +http://www.intel.com/content/www/us/en/processors/core/core-technical-resources.html + +* 7th Generation Intel(R) Processor Families for U/Y-Platforms + +* 7th Generation Intel(R) Processor Families I/O for U/Y-Platforms + diff --git a/_sources/modules/chipsec.cfg.8086.mtl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.mtl.xml.rst.txt index 5aab24c9..022f1fe3 100644 --- a/_sources/modules/chipsec.cfg.8086.mtl.xml.rst.txt +++ b/_sources/modules/chipsec.cfg.8086.mtl.xml.rst.txt @@ -3,23 +3,4 @@ mtl Path: chipsec\\cfg\\8086\\mtl.xml - -CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2024, Intel Corporation - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; Version 2. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Contact information: -chipsec@intel.com - + XML configuration file for Ice Lake diff --git a/_sources/modules/chipsec.cfg.8086.pch_1xx.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_1xx.xml.rst.txt deleted file mode 100644 index 37ad1f95..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_1xx.xml.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -pch_1xx -=========== - -Path: chipsec\\cfg\\8086\\pch_1xx.xml - - -XML configuration file for 100 series PCH based platforms - -CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2020-2021, Intel Corporation - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; Version 2. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Contact information: -chipsec@intel.com - -* Intel(R) 100 Series Chipset Family Platform Controller Hub (PCH) - http://www.intel.com/content/www/us/en/processors/core/core-technical-resources.html - diff --git a/_sources/modules/chipsec.cfg.8086.pch_2xx.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_2xx.xml.rst.txt deleted file mode 100644 index 9469fdb6..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_2xx.xml.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -pch_2xx -=========== - -Path: chipsec\\cfg\\8086\\pch_2xx.xml - - -XML configuration file for 200 series PCH based platforms - -* Intel(R) 200 Series Chipset Family Platform Controller Hub (PCH) - http://www.intel.com/content/www/us/en/processors/core/core-technical-resources.html - diff --git a/_sources/modules/chipsec.cfg.8086.pch_3xx.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_3xx.xml.rst.txt deleted file mode 100644 index 2f580567..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_3xx.xml.rst.txt +++ /dev/null @@ -1,10 +0,0 @@ -pch_3xx -=========== - -Path: chipsec\\cfg\\8086\\pch_3xx.xml - - -XML configuration file for the 300 series PCH -https://www.intel.com/content/www/us/en/products/docs/chipsets/300-series-chipset-pch-datasheet-vol-2.html -337348-001 - diff --git a/_sources/modules/chipsec.cfg.8086.pch_3xxlp.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_3xxlp_orig.xmls.rst.txt similarity index 72% rename from _sources/modules/chipsec.cfg.8086.pch_3xxlp.xml.rst.txt rename to _sources/modules/chipsec.cfg.8086.pch_3xxlp_orig.xmls.rst.txt index 2f5b216f..194e64c7 100644 --- a/_sources/modules/chipsec.cfg.8086.pch_3xxlp.xml.rst.txt +++ b/_sources/modules/chipsec.cfg.8086.pch_3xxlp_orig.xmls.rst.txt @@ -1,7 +1,7 @@ -pch_3xxlp -============= +pch_3xxlp_orig. +=================== -Path: chipsec\\cfg\\8086\\pch_3xxlp.xml +Path: chipsec\\cfg\\8086\\pch_3xxlp_orig.xmls XML configuration file for the 300 series LP (U/Y) PCH diff --git a/_sources/modules/chipsec.cfg.8086.pch_3xxop.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_3xxop.xml.rst.txt deleted file mode 100644 index b19f0764..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_3xxop.xml.rst.txt +++ /dev/null @@ -1,10 +0,0 @@ -pch_3xxop -============= - -Path: chipsec\\cfg\\8086\\pch_3xxop.xml - - -XML configuration file for the 300 series On Package PCH -https://www.intel.com/content/www/us/en/products/docs/chipsets/300-series-chipset-on-package-pch-datasheet-vol-2.html -337868-002 - diff --git a/_sources/modules/chipsec.cfg.8086.pch_495.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_495.xml.rst.txt deleted file mode 100644 index dcab2e63..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_495.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -pch_495 -=========== - -Path: chipsec\\cfg\\8086\\pch_495.xml - - -XML configuration file for the 495 series PCH - diff --git a/_sources/modules/chipsec.cfg.8086.pch_4xx.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_4xx.xml.rst.txt deleted file mode 100644 index caf0f7e9..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_4xx.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -pch_4xx -=========== - -Path: chipsec\\cfg\\8086\\pch_4xx.xml - - - XML configuration file for 4XX pch - diff --git a/_sources/modules/chipsec.cfg.8086.pch_4xxh.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_4xxh.xml.rst.txt deleted file mode 100644 index 4f543111..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_4xxh.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -pch_4xxh -============ - -Path: chipsec\\cfg\\8086\\pch_4xxh.xml - - - XML configuration file 4xxH PCH 620855 - diff --git a/_sources/modules/chipsec.cfg.8086.pch_4xxlp.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_4xxlp.xml.rst.txt deleted file mode 100644 index a1a6f9cb..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_4xxlp.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -pch_4xxlp -============= - -Path: chipsec\\cfg\\8086\\pch_4xxlp.xml - - - XML configuration file for the 400 series LP (U/H) PCH - diff --git a/_sources/modules/chipsec.cfg.8086.pch_5xxh.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_5xxh.xml.rst.txt deleted file mode 100644 index 717ddc4b..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_5xxh.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -pch_5xxh -============ - -Path: chipsec\\cfg\\8086\\pch_5xxh.xml - - -XML configuration file for 5XXH series pch - diff --git a/_sources/modules/chipsec.cfg.8086.pch_5xxlp.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_5xxlp.xml.rst.txt index c85234dc..59b97302 100644 --- a/_sources/modules/chipsec.cfg.8086.pch_5xxlp.xml.rst.txt +++ b/_sources/modules/chipsec.cfg.8086.pch_5xxlp.xml.rst.txt @@ -4,5 +4,5 @@ pch_5xxlp Path: chipsec\\cfg\\8086\\pch_5xxlp.xml -XML configuration file for 5XXLP series pch +XML configuration file for 5XX series pch diff --git a/_sources/modules/chipsec.cfg.8086.pch_6xxP.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_6xxP.xml.rst.txt deleted file mode 100644 index c7f32e95..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_6xxP.xml.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -pch_6xxP -============ - -Path: chipsec\\cfg\\8086\\pch_6xxP.xml - - -CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2021-2022, Intel Corporation - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; Version 2. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Contact information: -chipsec@intel.com - diff --git a/_sources/modules/chipsec.cfg.8086.pch_6xxS.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_6xxS.xml.rst.txt deleted file mode 100644 index 7f1ed154..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_6xxS.xml.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -pch_6xxS -============ - -Path: chipsec\\cfg\\8086\\pch_6xxS.xml - - -CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2021-2022, Intel Corporation - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; Version 2. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Contact information: -chipsec@intel.com - diff --git a/_sources/modules/chipsec.cfg.8086.rkl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_6xxp.xml.rst.txt similarity index 92% rename from _sources/modules/chipsec.cfg.8086.rkl.xml.rst.txt rename to _sources/modules/chipsec.cfg.8086.pch_6xxp.xml.rst.txt index 07cb507f..3f1d524f 100644 --- a/_sources/modules/chipsec.cfg.8086.rkl.xml.rst.txt +++ b/_sources/modules/chipsec.cfg.8086.pch_6xxp.xml.rst.txt @@ -1,7 +1,7 @@ -rkl -======= +pch_6xxp +============ -Path: chipsec\\cfg\\8086\\rkl.xml +Path: chipsec\\cfg\\8086\\pch_6xxp.xml CHIPSEC: Platform Security Assessment Framework diff --git a/_sources/modules/chipsec.cfg.8086.pch_7x.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_7x.xml.rst.txt deleted file mode 100644 index 232268a6..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_7x.xml.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -pch_7x -========== - -Path: chipsec\\cfg\\8086\\pch_7x.xml - - -CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2022, Intel Corporation - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; Version 2. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Contact information: -chipsec@intel.com - diff --git a/_sources/modules/chipsec.cfg.8086.pch_8x.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_8x.xml.rst.txt deleted file mode 100644 index 5bf3f24b..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_8x.xml.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -pch_8x -========== - -Path: chipsec\\cfg\\8086\\pch_8x.xml - - -CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2022, Intel Corporation - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; Version 2. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Contact information: -chipsec@intel.com - diff --git a/_sources/modules/chipsec.cfg.8086.pch_c60x.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_c60x.xml.rst.txt deleted file mode 100644 index bd73b9d3..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_c60x.xml.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -pch_c60x -============ - -Path: chipsec\\cfg\\8086\\pch_c60x.xml - - -XML configuration file for C600 series PCH - Intel (c) C600 Series Chipset and Intel (c) X79 Express Chipset datasheet - Intel (c) C600 Series Chipset and Intel (c) X79 Express Chipset Specification Update - https://ark.intel.com/products/series/98463/Intel-C600-Series-Chipsets - diff --git a/_sources/modules/chipsec.cfg.8086.pch_c61x.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_c61x.xml.rst.txt deleted file mode 100644 index 3345f3b2..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_c61x.xml.rst.txt +++ /dev/null @@ -1,10 +0,0 @@ -pch_c61x -============ - -Path: chipsec\\cfg\\8086\\pch_c61x.xml - - -XML configuration file for C610 series PCH - Intel (c) C610 Series Chipset and Intel (c) X99 Chipset Platform Controller Hub (PCH) datasheet - https://ark.intel.com/products/series/98915/Intel-C610-Series-Chipsets - diff --git a/_sources/modules/chipsec.cfg.8086.pch_c620.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pch_c620.xml.rst.txt deleted file mode 100644 index 8d192626..00000000 --- a/_sources/modules/chipsec.cfg.8086.pch_c620.xml.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -pch_c620 -============ - -Path: chipsec\\cfg\\8086\\pch_c620.xml - - -XML configuration file for - -* Intel(R) C620 Series Chipset Family Platform Controller Hub - https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/c620-series-chipset-datasheet.pdf - diff --git a/_sources/modules/chipsec.cfg.8086.pmc_i440fx.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.pmc_i440fx.xml.rst.txt deleted file mode 100644 index bcab2341..00000000 --- a/_sources/modules/chipsec.cfg.8086.pmc_i440fx.xml.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -pmc_i440fx -============== - -Path: chipsec\\cfg\\8086\\pmc_i440fx.xml - - -XML configuration file for Intel 440FX PCI and Memory Controller (PMC). -It is used by QEMU "pc" machine, implemented in -https://github.com/qemu/qemu/blob/v7.0.0/hw/pci-host/i440fx.c - -A datasheet is available on https://wiki.qemu.org/File:29054901.pdf - diff --git a/_sources/modules/chipsec.cfg.8086.qrk.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.qrk.xml.rst.txt deleted file mode 100644 index db249f29..00000000 --- a/_sources/modules/chipsec.cfg.8086.qrk.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -qrk -======= - -Path: chipsec\\cfg\\8086\\qrk.xml - - -XML configuration for Quark based platforms - diff --git a/_sources/modules/chipsec.cfg.8086.rpl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.rpl.xml.rst.txt deleted file mode 100644 index 740602f6..00000000 --- a/_sources/modules/chipsec.cfg.8086.rpl.xml.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -rpl -======= - -Path: chipsec\\cfg\\8086\\rpl.xml - - -CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2022, Intel Corporation - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; Version 2. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Contact information: -chipsec@intel.com - diff --git a/_sources/modules/chipsec.cfg.8086.rst.txt b/_sources/modules/chipsec.cfg.8086.rst.txt index 743439f8..8cda8a4b 100644 --- a/_sources/modules/chipsec.cfg.8086.rst.txt +++ b/_sources/modules/chipsec.cfg.8086.rst.txt @@ -1,56 +1,10 @@ .. toctree:: - chipsec.cfg.8086.rkl.xml.rst - chipsec.cfg.8086.ivb.xml.rst - chipsec.cfg.8086.apl.xml.rst - chipsec.cfg.8086.whl.xml.rst - chipsec.cfg.8086.dnv.xml.rst - chipsec.cfg.8086.bdw.xml.rst - chipsec.cfg.8086.hsw.xml.rst - chipsec.cfg.8086.pch_c61x.xml.rst - chipsec.cfg.8086.skl.xml.rst - chipsec.cfg.8086.common.xml.rst - chipsec.cfg.8086.pch_8x.xml.rst - chipsec.cfg.8086.iommu.xml.rst - chipsec.cfg.8086.tpm12.xml.rst - chipsec.cfg.8086.pmc_i440fx.xml.rst - chipsec.cfg.8086.pch_2xx.xml.rst - chipsec.cfg.8086.tglh.xml.rst + chipsec.cfg.8086.kbl_orig.xmls.rst + chipsec.cfg.8086.mtl.xml.rst + chipsec.cfg.8086.pch_5xxlp.xml.rst + chipsec.cfg.8086.pch_3xxlp_orig.xmls.rst chipsec.cfg.8086.tglu.xml.rst + chipsec.cfg.8086.pch_6xxp.xml.rst chipsec.cfg.8086.kbl.xml.rst - chipsec.cfg.8086.pch_495.xml.rst - chipsec.cfg.8086.pch_6xxS.xml.rst - chipsec.cfg.8086.sfdp.xml.rst - chipsec.cfg.8086.bdx.xml.rst - chipsec.cfg.8086.hsx.xml.rst - chipsec.cfg.8086.glk.xml.rst - chipsec.cfg.8086.avn.xml.rst - chipsec.cfg.8086.byt.xml.rst - chipsec.cfg.8086.qrk.xml.rst - chipsec.cfg.8086.cht.xml.rst - chipsec.cfg.8086.cml.xml.rst - chipsec.cfg.8086.cfl.xml.rst - chipsec.cfg.8086.pch_7x.xml.rst - chipsec.cfg.8086.pch_5xxh.xml.rst - chipsec.cfg.8086.pch_4xxlp.xml.rst - chipsec.cfg.8086.pch_4xx.xml.rst chipsec.cfg.8086.adl.xml.rst - chipsec.cfg.8086.pch_1xx.xml.rst - chipsec.cfg.8086.snb.xml.rst - chipsec.cfg.8086.skx.xml.rst - chipsec.cfg.8086.pch_6xxP.xml.rst - chipsec.cfg.8086.txt.xml.rst - chipsec.cfg.8086.icx.xml.rst - chipsec.cfg.8086.mtl.xml.rst - chipsec.cfg.8086.rpl.xml.rst - chipsec.cfg.8086.ehl.xml.rst - chipsec.cfg.8086.pch_3xx.xml.rst - chipsec.cfg.8086.pch_3xxlp.xml.rst - chipsec.cfg.8086.jkt.xml.rst - chipsec.cfg.8086.pch_c60x.xml.rst - chipsec.cfg.8086.ivt.xml.rst - chipsec.cfg.8086.pch_5xxlp.xml.rst - chipsec.cfg.8086.icl.xml.rst - chipsec.cfg.8086.pch_3xxop.xml.rst - chipsec.cfg.8086.pch_c620.xml.rst - chipsec.cfg.8086.pch_4xxh.xml.rst diff --git a/_sources/modules/chipsec.cfg.8086.sfdp.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.sfdp.xml.rst.txt deleted file mode 100644 index 428e5b54..00000000 --- a/_sources/modules/chipsec.cfg.8086.sfdp.xml.rst.txt +++ /dev/null @@ -1,9 +0,0 @@ -sfdp -======== - -Path: chipsec\\cfg\\8086\\sfdp.xml - - -XML configuration for Serial Flash Discoverable Parameter feature -document: https://www.jedec.org/system/files/docs/JESD216D-01.pdf - diff --git a/_sources/modules/chipsec.cfg.8086.skl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.skl.xml.rst.txt deleted file mode 100644 index 0d0a3cbb..00000000 --- a/_sources/modules/chipsec.cfg.8086.skl.xml.rst.txt +++ /dev/null @@ -1,20 +0,0 @@ -skl -======= - -Path: chipsec\\cfg\\8086\\skl.xml - - -XML configuration file for Skylake based platforms - -http://www.intel.com/content/www/us/en/processors/core/core-technical-resources.html - -* 6th Generation Intel(R) Processor Datasheet for U/Y-Platforms - -* 6th Generation Intel(R) Processor I/O Datasheet for U/Y-Platforms - -* 6th Generation Intel(R) Processor Datasheet for S-Platforms - -* 6th Generation Intel(R) Processor Datasheet for H-Platforms - -* Intel(R) 100 Series Chipset Family Platform Controller Hub (PCH) - diff --git a/_sources/modules/chipsec.cfg.8086.skx.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.skx.xml.rst.txt deleted file mode 100644 index f01831ca..00000000 --- a/_sources/modules/chipsec.cfg.8086.skx.xml.rst.txt +++ /dev/null @@ -1,9 +0,0 @@ -skx -======= - -Path: chipsec\\cfg\\8086\\skx.xml - - -XML configuration file for Skylake/Purely Server -Intel (c) Xeon Processor Scalable Family datasheet Vol. 2 - diff --git a/_sources/modules/chipsec.cfg.8086.snb.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.snb.xml.rst.txt deleted file mode 100644 index 6a9f3120..00000000 --- a/_sources/modules/chipsec.cfg.8086.snb.xml.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -snb -======= - -Path: chipsec\\cfg\\8086\\snb.xml - - -XML configuration for Sandy Bridge based platforms - diff --git a/_sources/modules/chipsec.cfg.8086.tglh.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.tglh.xml.rst.txt deleted file mode 100644 index 2cdd18e9..00000000 --- a/_sources/modules/chipsec.cfg.8086.tglh.xml.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -tglh -======== - -Path: chipsec\\cfg\\8086\\tglh.xml - - -CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2022, Intel Corporation - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; Version 2. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Contact information: -chipsec@intel.com - diff --git a/_sources/modules/chipsec.cfg.8086.tpm12.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.tpm12.xml.rst.txt deleted file mode 100644 index 75bf04dd..00000000 --- a/_sources/modules/chipsec.cfg.8086.tpm12.xml.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -tpm12 -========= - -Path: chipsec\\cfg\\8086\\tpm12.xml - - -CHIPSEC: Platform Security Assessment Framework -Copyright (c) 2021, Intel Corporation - -This program is free software; you can redistribute it and/or -modify it under the terms of the GNU General Public License -as published by the Free Software Foundation; Version 2. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - -Contact information: -chipsec@intel.com - diff --git a/_sources/modules/chipsec.cfg.8086.txt.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.txt.xml.rst.txt deleted file mode 100644 index 2534899f..00000000 --- a/_sources/modules/chipsec.cfg.8086.txt.xml.rst.txt +++ /dev/null @@ -1,26 +0,0 @@ -txt -======= - -Path: chipsec\\cfg\\8086\\txt.xml - - -Configuration of Intel TXT register, following the guide: - - Intel® Trusted Execution Technology: Software Development Guide - Measured Launched Environment Developer's Guide - August 2016 - Revision 013 - -from https://web.archive.org/web/20170506220426/https://www.intel.com/content/www/us/en/software-developers/intel-txt-software-development-guide.html -(and https://usermanual.wiki/Document/inteltxtsoftwaredevelopmentguide.1721028921 ) - -Appendix B.1. (Intel® TXT Configuration Registers) details: - - These registers are mapped into two regions of memory, representing the public and private configuration spaces. - [...] - The private space registers are mapped to the address range starting at FED20000H. - The public space registers are mapped to the address range starting at FED30000H. - -As chipsec usually runs in environments where the private space is not available, -only the public space registers were described here. - diff --git a/_sources/modules/chipsec.cfg.8086.whl.xml.rst.txt b/_sources/modules/chipsec.cfg.8086.whl.xml.rst.txt deleted file mode 100644 index 64dba853..00000000 --- a/_sources/modules/chipsec.cfg.8086.whl.xml.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -whl -======= - -Path: chipsec\\cfg\\8086\\whl.xml - - -XML configuration file for Whiskey Lake - -8th Generation Intel(R) Processor Family for U-Processor Platforms: - - https://www.intel.com/content/www/us/en/processors/core/core-technical-resources.html - - https://www.intel.com/content/dam/www/public/us/en/documents/technical-specifications/300-series-chipset-on-package-pch-datasheet-vol-1.pdf - diff --git a/_sources/modules/chipsec.cfg.parsers.controls.rst.txt b/_sources/modules/chipsec.cfg.parsers.controls.rst.txt new file mode 100644 index 00000000..3239cb5c --- /dev/null +++ b/_sources/modules/chipsec.cfg.parsers.controls.rst.txt @@ -0,0 +1,7 @@ +chipsec.cfg.parsers.controls module +=================================== + +.. automodule:: chipsec.cfg.parsers.controls + + + diff --git a/_sources/modules/chipsec.cfg.parsers.core_parser_helper.rst.txt b/_sources/modules/chipsec.cfg.parsers.core_parser_helper.rst.txt new file mode 100644 index 00000000..e81a2288 --- /dev/null +++ b/_sources/modules/chipsec.cfg.parsers.core_parser_helper.rst.txt @@ -0,0 +1,7 @@ +chipsec.cfg.parsers.core\_parser\_helper module +=============================================== + +.. automodule:: chipsec.cfg.parsers.core_parser_helper + + + diff --git a/_sources/modules/chipsec.cfg.parsers.locks.rst.txt b/_sources/modules/chipsec.cfg.parsers.locks.rst.txt new file mode 100644 index 00000000..a11440b3 --- /dev/null +++ b/_sources/modules/chipsec.cfg.parsers.locks.rst.txt @@ -0,0 +1,7 @@ +chipsec.cfg.parsers.locks module +================================ + +.. automodule:: chipsec.cfg.parsers.locks + + + diff --git a/_sources/modules/chipsec.hal.acpi.rst.txt b/_sources/modules/chipsec.hal.acpi.rst.txt deleted file mode 100644 index ef9af18a..00000000 --- a/_sources/modules/chipsec.hal.acpi.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.acpi module -======================= - -.. automodule:: chipsec.hal.acpi - - - diff --git a/_sources/modules/chipsec.hal.acpi_tables.rst.txt b/_sources/modules/chipsec.hal.acpi_tables.rst.txt deleted file mode 100644 index d28ff783..00000000 --- a/_sources/modules/chipsec.hal.acpi_tables.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.acpi\_tables module -=============================== - -.. automodule:: chipsec.hal.acpi_tables - - - diff --git a/_sources/modules/chipsec.hal.cmos.rst.txt b/_sources/modules/chipsec.hal.cmos.rst.txt deleted file mode 100644 index 81853dea..00000000 --- a/_sources/modules/chipsec.hal.cmos.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.cmos module -======================= - -.. automodule:: chipsec.hal.cmos - - - diff --git a/_sources/modules/chipsec.hal.cpu.rst.txt b/_sources/modules/chipsec.hal.cpu.rst.txt deleted file mode 100644 index f358f82c..00000000 --- a/_sources/modules/chipsec.hal.cpu.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.cpu module -====================== - -.. automodule:: chipsec.hal.cpu - - - diff --git a/_sources/modules/chipsec.hal.cpuid.rst.txt b/_sources/modules/chipsec.hal.cpuid.rst.txt deleted file mode 100644 index aa02e29e..00000000 --- a/_sources/modules/chipsec.hal.cpuid.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.cpuid module -======================== - -.. automodule:: chipsec.hal.cpuid - - - diff --git a/_sources/modules/chipsec.hal.ec.rst.txt b/_sources/modules/chipsec.hal.ec.rst.txt deleted file mode 100644 index e52f7f55..00000000 --- a/_sources/modules/chipsec.hal.ec.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.ec module -===================== - -.. automodule:: chipsec.hal.ec - - - diff --git a/_sources/modules/chipsec.hal.hals.rst.txt b/_sources/modules/chipsec.hal.hals.rst.txt new file mode 100644 index 00000000..0113efd8 --- /dev/null +++ b/_sources/modules/chipsec.hal.hals.rst.txt @@ -0,0 +1,7 @@ +chipsec.hal.hals module +======================= + +.. automodule:: chipsec.hal.hals + + + diff --git a/_sources/modules/chipsec.hal.igd.rst.txt b/_sources/modules/chipsec.hal.igd.rst.txt deleted file mode 100644 index 94e1ad27..00000000 --- a/_sources/modules/chipsec.hal.igd.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.igd module -====================== - -.. automodule:: chipsec.hal.igd - - - diff --git a/_sources/modules/chipsec.hal.interrupts.rst.txt b/_sources/modules/chipsec.hal.interrupts.rst.txt deleted file mode 100644 index 2db95aae..00000000 --- a/_sources/modules/chipsec.hal.interrupts.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.interrupts module -============================= - -.. automodule:: chipsec.hal.interrupts - - - diff --git a/_sources/modules/chipsec.hal.io.rst.txt b/_sources/modules/chipsec.hal.io.rst.txt deleted file mode 100644 index f9adfd95..00000000 --- a/_sources/modules/chipsec.hal.io.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.io module -===================== - -.. automodule:: chipsec.hal.io - - - diff --git a/_sources/modules/chipsec.hal.iobar.rst.txt b/_sources/modules/chipsec.hal.iobar.rst.txt deleted file mode 100644 index 147dfb0b..00000000 --- a/_sources/modules/chipsec.hal.iobar.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.iobar module -======================== - -.. automodule:: chipsec.hal.iobar - - - diff --git a/_sources/modules/chipsec.hal.iommu.rst.txt b/_sources/modules/chipsec.hal.iommu.rst.txt deleted file mode 100644 index 6231370c..00000000 --- a/_sources/modules/chipsec.hal.iommu.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.iommu module -======================== - -.. automodule:: chipsec.hal.iommu - - - diff --git a/_sources/modules/chipsec.hal.locks.rst.txt b/_sources/modules/chipsec.hal.locks.rst.txt deleted file mode 100644 index 62ff8d3a..00000000 --- a/_sources/modules/chipsec.hal.locks.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.locks module -======================== - -.. automodule:: chipsec.hal.locks - - - diff --git a/_sources/modules/chipsec.hal.mmio.rst.txt b/_sources/modules/chipsec.hal.mmio.rst.txt deleted file mode 100644 index fa5bfdc3..00000000 --- a/_sources/modules/chipsec.hal.mmio.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.mmio module -======================= - -.. automodule:: chipsec.hal.mmio - - - diff --git a/_sources/modules/chipsec.hal.msgbus.rst.txt b/_sources/modules/chipsec.hal.msgbus.rst.txt deleted file mode 100644 index 0e1ff77a..00000000 --- a/_sources/modules/chipsec.hal.msgbus.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.msgbus module -========================= - -.. automodule:: chipsec.hal.msgbus - - - diff --git a/_sources/modules/chipsec.hal.msr.rst.txt b/_sources/modules/chipsec.hal.msr.rst.txt deleted file mode 100644 index 507e272e..00000000 --- a/_sources/modules/chipsec.hal.msr.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.msr module -====================== - -.. automodule:: chipsec.hal.msr - - - diff --git a/_sources/modules/chipsec.hal.paging.rst.txt b/_sources/modules/chipsec.hal.paging.rst.txt deleted file mode 100644 index 752b2201..00000000 --- a/_sources/modules/chipsec.hal.paging.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.paging module -========================= - -.. automodule:: chipsec.hal.paging - - - diff --git a/_sources/modules/chipsec.hal.pci.rst.txt b/_sources/modules/chipsec.hal.pci.rst.txt deleted file mode 100644 index 904ffd1a..00000000 --- a/_sources/modules/chipsec.hal.pci.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.pci module -====================== - -.. automodule:: chipsec.hal.pci - - - diff --git a/_sources/modules/chipsec.hal.pcidb.rst.txt b/_sources/modules/chipsec.hal.pcidb.rst.txt deleted file mode 100644 index 1572e35b..00000000 --- a/_sources/modules/chipsec.hal.pcidb.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.pcidb module -======================== - -.. automodule:: chipsec.hal.pcidb - - - diff --git a/_sources/modules/chipsec.hal.physmem.rst.txt b/_sources/modules/chipsec.hal.physmem.rst.txt deleted file mode 100644 index 22424b69..00000000 --- a/_sources/modules/chipsec.hal.physmem.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.physmem module -========================== - -.. automodule:: chipsec.hal.physmem - - - diff --git a/_sources/modules/chipsec.hal.psp.rst.txt b/_sources/modules/chipsec.hal.psp.rst.txt deleted file mode 100644 index e10298d7..00000000 --- a/_sources/modules/chipsec.hal.psp.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.psp module -====================== - -.. automodule:: chipsec.hal.psp - - - diff --git a/_sources/modules/chipsec.hal.rst.txt b/_sources/modules/chipsec.hal.rst.txt index 903f3efa..361bad40 100644 --- a/_sources/modules/chipsec.hal.rst.txt +++ b/_sources/modules/chipsec.hal.rst.txt @@ -4,46 +4,8 @@ chipsec.hal package .. toctree:: :maxdepth: 10 - chipsec.hal.acpi - chipsec.hal.acpi_tables - chipsec.hal.cmos - chipsec.hal.cpu - chipsec.hal.cpuid - chipsec.hal.ec chipsec.hal.hal_base - chipsec.hal.igd - chipsec.hal.interrupts - chipsec.hal.io - chipsec.hal.iobar - chipsec.hal.iommu - chipsec.hal.locks - chipsec.hal.mmio - chipsec.hal.msgbus - chipsec.hal.msr - chipsec.hal.paging - chipsec.hal.pci - chipsec.hal.pcidb - chipsec.hal.physmem - chipsec.hal.psp - chipsec.hal.smbios - chipsec.hal.smbus - chipsec.hal.spd - chipsec.hal.spi - chipsec.hal.spi_descriptor - chipsec.hal.spi_jedec_ids - chipsec.hal.spi_uefi - chipsec.hal.tpm - chipsec.hal.tpm_eventlog - chipsec.hal.tpm_interface - chipsec.hal.ucode - chipsec.hal.uefi - chipsec.hal.uefi_common - chipsec.hal.uefi_compression - chipsec.hal.uefi_fv - chipsec.hal.uefi_platform - chipsec.hal.uefi_search - chipsec.hal.virtmem - chipsec.hal.vmm + chipsec.hal.hals .. automodule:: chipsec.hal diff --git a/_sources/modules/chipsec.hal.smbios.rst.txt b/_sources/modules/chipsec.hal.smbios.rst.txt deleted file mode 100644 index 1554ccea..00000000 --- a/_sources/modules/chipsec.hal.smbios.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.smbios module -========================= - -.. automodule:: chipsec.hal.smbios - - - diff --git a/_sources/modules/chipsec.hal.smbus.rst.txt b/_sources/modules/chipsec.hal.smbus.rst.txt deleted file mode 100644 index 5f12770b..00000000 --- a/_sources/modules/chipsec.hal.smbus.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.smbus module -======================== - -.. automodule:: chipsec.hal.smbus - - - diff --git a/_sources/modules/chipsec.hal.spd.rst.txt b/_sources/modules/chipsec.hal.spd.rst.txt deleted file mode 100644 index 2f55544d..00000000 --- a/_sources/modules/chipsec.hal.spd.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.spd module -====================== - -.. automodule:: chipsec.hal.spd - - - diff --git a/_sources/modules/chipsec.hal.spi.rst.txt b/_sources/modules/chipsec.hal.spi.rst.txt deleted file mode 100644 index 6f29674c..00000000 --- a/_sources/modules/chipsec.hal.spi.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.spi module -====================== - -.. automodule:: chipsec.hal.spi - - - diff --git a/_sources/modules/chipsec.hal.spi_descriptor.rst.txt b/_sources/modules/chipsec.hal.spi_descriptor.rst.txt deleted file mode 100644 index 4734df19..00000000 --- a/_sources/modules/chipsec.hal.spi_descriptor.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.spi\_descriptor module -================================== - -.. automodule:: chipsec.hal.spi_descriptor - - - diff --git a/_sources/modules/chipsec.hal.spi_jedec_ids.rst.txt b/_sources/modules/chipsec.hal.spi_jedec_ids.rst.txt deleted file mode 100644 index 15144b3f..00000000 --- a/_sources/modules/chipsec.hal.spi_jedec_ids.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.spi\_jedec\_ids module -================================== - -.. automodule:: chipsec.hal.spi_jedec_ids - - - diff --git a/_sources/modules/chipsec.hal.spi_uefi.rst.txt b/_sources/modules/chipsec.hal.spi_uefi.rst.txt deleted file mode 100644 index ec5c851c..00000000 --- a/_sources/modules/chipsec.hal.spi_uefi.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.spi\_uefi module -============================ - -.. automodule:: chipsec.hal.spi_uefi - - - diff --git a/_sources/modules/chipsec.hal.tpm.rst.txt b/_sources/modules/chipsec.hal.tpm.rst.txt deleted file mode 100644 index 4abc1cb1..00000000 --- a/_sources/modules/chipsec.hal.tpm.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.tpm module -====================== - -.. automodule:: chipsec.hal.tpm - - - diff --git a/_sources/modules/chipsec.hal.tpm_eventlog.rst.txt b/_sources/modules/chipsec.hal.tpm_eventlog.rst.txt deleted file mode 100644 index 01d4039b..00000000 --- a/_sources/modules/chipsec.hal.tpm_eventlog.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.tpm\_eventlog module -================================ - -.. automodule:: chipsec.hal.tpm_eventlog - - - diff --git a/_sources/modules/chipsec.hal.tpm_interface.rst.txt b/_sources/modules/chipsec.hal.tpm_interface.rst.txt deleted file mode 100644 index c31d51b1..00000000 --- a/_sources/modules/chipsec.hal.tpm_interface.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.tpm\_interface module -================================= - -.. automodule:: chipsec.hal.tpm_interface - - - diff --git a/_sources/modules/chipsec.hal.ucode.rst.txt b/_sources/modules/chipsec.hal.ucode.rst.txt deleted file mode 100644 index 7258208d..00000000 --- a/_sources/modules/chipsec.hal.ucode.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.ucode module -======================== - -.. automodule:: chipsec.hal.ucode - - - diff --git a/_sources/modules/chipsec.hal.uefi.rst.txt b/_sources/modules/chipsec.hal.uefi.rst.txt deleted file mode 100644 index e11dfd4f..00000000 --- a/_sources/modules/chipsec.hal.uefi.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.uefi module -======================= - -.. automodule:: chipsec.hal.uefi - - - diff --git a/_sources/modules/chipsec.hal.uefi_common.rst.txt b/_sources/modules/chipsec.hal.uefi_common.rst.txt deleted file mode 100644 index fad89884..00000000 --- a/_sources/modules/chipsec.hal.uefi_common.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.uefi\_common module -=============================== - -.. automodule:: chipsec.hal.uefi_common - - - diff --git a/_sources/modules/chipsec.hal.uefi_compression.rst.txt b/_sources/modules/chipsec.hal.uefi_compression.rst.txt deleted file mode 100644 index a7565c64..00000000 --- a/_sources/modules/chipsec.hal.uefi_compression.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.uefi\_compression module -==================================== - -.. automodule:: chipsec.hal.uefi_compression - - - diff --git a/_sources/modules/chipsec.hal.uefi_fv.rst.txt b/_sources/modules/chipsec.hal.uefi_fv.rst.txt deleted file mode 100644 index b6ce1682..00000000 --- a/_sources/modules/chipsec.hal.uefi_fv.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.uefi\_fv module -=========================== - -.. automodule:: chipsec.hal.uefi_fv - - - diff --git a/_sources/modules/chipsec.hal.uefi_platform.rst.txt b/_sources/modules/chipsec.hal.uefi_platform.rst.txt deleted file mode 100644 index 39f01de2..00000000 --- a/_sources/modules/chipsec.hal.uefi_platform.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.uefi\_platform module -================================= - -.. automodule:: chipsec.hal.uefi_platform - - - diff --git a/_sources/modules/chipsec.hal.uefi_search.rst.txt b/_sources/modules/chipsec.hal.uefi_search.rst.txt deleted file mode 100644 index a91b4b10..00000000 --- a/_sources/modules/chipsec.hal.uefi_search.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.uefi\_search module -=============================== - -.. automodule:: chipsec.hal.uefi_search - - - diff --git a/_sources/modules/chipsec.hal.virtmem.rst.txt b/_sources/modules/chipsec.hal.virtmem.rst.txt deleted file mode 100644 index 4ec42f14..00000000 --- a/_sources/modules/chipsec.hal.virtmem.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.virtmem module -========================== - -.. automodule:: chipsec.hal.virtmem - - - diff --git a/_sources/modules/chipsec.hal.vmm.rst.txt b/_sources/modules/chipsec.hal.vmm.rst.txt deleted file mode 100644 index 22b2497c..00000000 --- a/_sources/modules/chipsec.hal.vmm.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.hal.vmm module -====================== - -.. automodule:: chipsec.hal.vmm - - - diff --git a/_sources/modules/chipsec.library.acpi_tables.rst.txt b/_sources/modules/chipsec.library.acpi_tables.rst.txt new file mode 100644 index 00000000..5407dac5 --- /dev/null +++ b/_sources/modules/chipsec.library.acpi_tables.rst.txt @@ -0,0 +1,7 @@ +chipsec.library.acpi\_tables module +=================================== + +.. automodule:: chipsec.library.acpi_tables + + + diff --git a/_sources/modules/chipsec.library.cpu.rst.txt b/_sources/modules/chipsec.library.cpu.rst.txt new file mode 100644 index 00000000..87d180d2 --- /dev/null +++ b/_sources/modules/chipsec.library.cpu.rst.txt @@ -0,0 +1,7 @@ +chipsec.library.cpu module +========================== + +.. automodule:: chipsec.library.cpu + + + diff --git a/_sources/modules/chipsec.library.display.rst.txt b/_sources/modules/chipsec.library.display.rst.txt new file mode 100644 index 00000000..0ba21785 --- /dev/null +++ b/_sources/modules/chipsec.library.display.rst.txt @@ -0,0 +1,7 @@ +chipsec.library.display module +============================== + +.. automodule:: chipsec.library.display + + + diff --git a/_sources/modules/chipsec.library.paging.rst.txt b/_sources/modules/chipsec.library.paging.rst.txt new file mode 100644 index 00000000..c812efc8 --- /dev/null +++ b/_sources/modules/chipsec.library.paging.rst.txt @@ -0,0 +1,7 @@ +chipsec.library.paging module +============================= + +.. automodule:: chipsec.library.paging + + + diff --git a/_sources/modules/chipsec.library.pci.rst.txt b/_sources/modules/chipsec.library.pci.rst.txt new file mode 100644 index 00000000..7eb42b8a --- /dev/null +++ b/_sources/modules/chipsec.library.pci.rst.txt @@ -0,0 +1,7 @@ +chipsec.library.pci module +========================== + +.. automodule:: chipsec.library.pci + + + diff --git a/_sources/modules/chipsec.library.pcidb.rst.txt b/_sources/modules/chipsec.library.pcidb.rst.txt new file mode 100644 index 00000000..f8ad25da --- /dev/null +++ b/_sources/modules/chipsec.library.pcidb.rst.txt @@ -0,0 +1,7 @@ +chipsec.library.pcidb module +============================ + +.. automodule:: chipsec.library.pcidb + + + diff --git a/_sources/modules/chipsec.library.spi_jedec_ids.rst.txt b/_sources/modules/chipsec.library.spi_jedec_ids.rst.txt new file mode 100644 index 00000000..abe8921d --- /dev/null +++ b/_sources/modules/chipsec.library.spi_jedec_ids.rst.txt @@ -0,0 +1,7 @@ +chipsec.library.spi\_jedec\_ids module +====================================== + +.. automodule:: chipsec.library.spi_jedec_ids + + + diff --git a/_sources/modules/chipsec.library.tpm12_commands.rst.txt b/_sources/modules/chipsec.library.tpm12_commands.rst.txt new file mode 100644 index 00000000..18c42155 --- /dev/null +++ b/_sources/modules/chipsec.library.tpm12_commands.rst.txt @@ -0,0 +1,7 @@ +chipsec.library.tpm12\_commands module +====================================== + +.. automodule:: chipsec.library.tpm12_commands + + + diff --git a/_sources/modules/chipsec.library.tpm_eventlog.rst.txt b/_sources/modules/chipsec.library.tpm_eventlog.rst.txt new file mode 100644 index 00000000..6ed7800d --- /dev/null +++ b/_sources/modules/chipsec.library.tpm_eventlog.rst.txt @@ -0,0 +1,7 @@ +chipsec.library.tpm\_eventlog module +==================================== + +.. automodule:: chipsec.library.tpm_eventlog + + + diff --git a/_sources/modules/chipsec.modules.hsw.rst.txt b/_sources/modules/chipsec.modules.hsw.rst.txt deleted file mode 100644 index 6b9e9193..00000000 --- a/_sources/modules/chipsec.modules.hsw.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.modules.hsw package -=========================== - -.. automodule:: chipsec.modules.hsw - - - diff --git a/_sources/modules/chipsec.modules.ivb.rst.txt b/_sources/modules/chipsec.modules.ivb.rst.txt deleted file mode 100644 index 6868af01..00000000 --- a/_sources/modules/chipsec.modules.ivb.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.modules.ivb package -=========================== - -.. automodule:: chipsec.modules.ivb - - - diff --git a/_sources/modules/chipsec.modules.rst.txt b/_sources/modules/chipsec.modules.rst.txt index 81b33b1a..722c0944 100644 --- a/_sources/modules/chipsec.modules.rst.txt +++ b/_sources/modules/chipsec.modules.rst.txt @@ -7,9 +7,6 @@ chipsec.modules package chipsec.modules.bdw chipsec.modules.byt chipsec.modules.common - chipsec.modules.hsw - chipsec.modules.ivb - chipsec.modules.snb chipsec.modules.tools .. automodule:: chipsec.modules diff --git a/_sources/modules/chipsec.modules.snb.rst.txt b/_sources/modules/chipsec.modules.snb.rst.txt deleted file mode 100644 index d5ad9240..00000000 --- a/_sources/modules/chipsec.modules.snb.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -chipsec.modules.snb package -=========================== - -.. automodule:: chipsec.modules.snb - - - diff --git a/_sources/modules/chipsec.utilcmd.hals_cmd.rst.txt b/_sources/modules/chipsec.utilcmd.hals_cmd.rst.txt new file mode 100644 index 00000000..5a16f5fc --- /dev/null +++ b/_sources/modules/chipsec.utilcmd.hals_cmd.rst.txt @@ -0,0 +1,7 @@ +chipsec.utilcmd.hals\_cmd module +================================ + +.. automodule:: chipsec.utilcmd.hals_cmd + + + diff --git a/_sources/modules/chipsec.utilcmd.mm_msgbus_cmd.rst.txt b/_sources/modules/chipsec.utilcmd.mm_msgbus_cmd.rst.txt new file mode 100644 index 00000000..fe8fad59 --- /dev/null +++ b/_sources/modules/chipsec.utilcmd.mm_msgbus_cmd.rst.txt @@ -0,0 +1,7 @@ +chipsec.utilcmd.mm\_msgbus\_cmd module +====================================== + +.. automodule:: chipsec.utilcmd.mm_msgbus_cmd + + + diff --git a/_sources/modules/chipsec.utilcmd.rst.txt b/_sources/modules/chipsec.utilcmd.rst.txt index 565bf35d..869582f3 100644 --- a/_sources/modules/chipsec.utilcmd.rst.txt +++ b/_sources/modules/chipsec.utilcmd.rst.txt @@ -13,12 +13,14 @@ chipsec.utilcmd package chipsec.utilcmd.deltas_cmd chipsec.utilcmd.desc_cmd chipsec.utilcmd.ec_cmd + chipsec.utilcmd.hals_cmd chipsec.utilcmd.igd_cmd chipsec.utilcmd.interrupts_cmd chipsec.utilcmd.io_cmd chipsec.utilcmd.iommu_cmd chipsec.utilcmd.lock_check_cmd chipsec.utilcmd.mem_cmd + chipsec.utilcmd.mm_msgbus_cmd chipsec.utilcmd.mmcfg_base_cmd chipsec.utilcmd.mmcfg_cmd chipsec.utilcmd.mmio_cmd diff --git a/_static/basic.css b/_static/basic.css index 11dc1139..e3db48a9 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -1,12 +1,5 @@ /* - * basic.css - * ~~~~~~~~~ - * * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ /* -- main layout ----------------------------------------------------------- */ @@ -115,15 +108,11 @@ img { /* -- search page ----------------------------------------------------------- */ ul.search { - margin: 10px 0 0 20px; - padding: 0; + margin-top: 10px; } ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; + padding: 5px 0; } ul.search li a { diff --git a/_static/classic.css b/_static/classic.css index fe226db0..76ea77ff 100644 --- a/_static/classic.css +++ b/_static/classic.css @@ -1,12 +1,5 @@ /* - * classic.css_t - * ~~~~~~~~~~~~~ - * * Sphinx stylesheet -- classic theme. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ @import url("basic.css"); diff --git a/_static/doctools.js b/_static/doctools.js index d06a71d7..0398ebb9 100644 --- a/_static/doctools.js +++ b/_static/doctools.js @@ -1,12 +1,5 @@ /* - * doctools.js - * ~~~~~~~~~~~ - * * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; diff --git a/_static/language_data.js b/_static/language_data.js index 250f5665..c7fe6c6f 100644 --- a/_static/language_data.js +++ b/_static/language_data.js @@ -1,19 +1,12 @@ /* - * language_data.js - * ~~~~~~~~~~~~~~~~ - * * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; -/* Non-minified version is copied as a separate JS file, is available */ +/* Non-minified version is copied as a separate JS file, if available */ /** * Porter Stemmer diff --git a/_static/pygments.css b/_static/pygments.css index 0d49244e..5f2b0a25 100644 --- a/_static/pygments.css +++ b/_static/pygments.css @@ -6,26 +6,26 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .hll { background-color: #ffffcc } .highlight { background: #eeffcc; } .highlight .c { color: #408090; font-style: italic } /* Comment */ -.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .err { border: 1px solid #F00 } /* Error */ .highlight .k { color: #007020; font-weight: bold } /* Keyword */ -.highlight .o { color: #666666 } /* Operator */ +.highlight .o { color: #666 } /* Operator */ .highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */ .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ .highlight .cp { color: #007020 } /* Comment.Preproc */ .highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */ .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.highlight .cs { color: #408090; background-color: #FFF0F0 } /* Comment.Special */ .highlight .gd { color: #A00000 } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gr { color: #F00 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #333333 } /* Generic.Output */ -.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .go { color: #333 } /* Generic.Output */ +.highlight .gp { color: #C65D09; font-weight: bold } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .gt { color: #04D } /* Generic.Traceback */ .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ @@ -33,43 +33,43 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #902000 } /* Keyword.Type */ .highlight .m { color: #208050 } /* Literal.Number */ -.highlight .s { color: #4070a0 } /* Literal.String */ -.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .s { color: #4070A0 } /* Literal.String */ +.highlight .na { color: #4070A0 } /* Name.Attribute */ .highlight .nb { color: #007020 } /* Name.Builtin */ -.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ -.highlight .no { color: #60add5 } /* Name.Constant */ -.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ -.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .nc { color: #0E84B5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60ADD5 } /* Name.Constant */ +.highlight .nd { color: #555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #D55537; font-weight: bold } /* Name.Entity */ .highlight .ne { color: #007020 } /* Name.Exception */ -.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nf { color: #06287E } /* Name.Function */ .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ -.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nn { color: #0E84B5; font-weight: bold } /* Name.Namespace */ .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .nv { color: #BB60D5 } /* Name.Variable */ .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .w { color: #BBB } /* Text.Whitespace */ .highlight .mb { color: #208050 } /* Literal.Number.Bin */ .highlight .mf { color: #208050 } /* Literal.Number.Float */ .highlight .mh { color: #208050 } /* Literal.Number.Hex */ .highlight .mi { color: #208050 } /* Literal.Number.Integer */ .highlight .mo { color: #208050 } /* Literal.Number.Oct */ -.highlight .sa { color: #4070a0 } /* Literal.String.Affix */ -.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ -.highlight .sc { color: #4070a0 } /* Literal.String.Char */ -.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ -.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ -.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ -.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ -.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ -.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sa { color: #4070A0 } /* Literal.String.Affix */ +.highlight .sb { color: #4070A0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070A0 } /* Literal.String.Char */ +.highlight .dl { color: #4070A0 } /* Literal.String.Delimiter */ +.highlight .sd { color: #4070A0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070A0 } /* Literal.String.Double */ +.highlight .se { color: #4070A0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070A0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70A0D0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #C65D09 } /* Literal.String.Other */ .highlight .sr { color: #235388 } /* Literal.String.Regex */ -.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .s1 { color: #4070A0 } /* Literal.String.Single */ .highlight .ss { color: #517918 } /* Literal.String.Symbol */ .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #06287e } /* Name.Function.Magic */ -.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ -.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ -.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ -.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ +.highlight .fm { color: #06287E } /* Name.Function.Magic */ +.highlight .vc { color: #BB60D5 } /* Name.Variable.Class */ +.highlight .vg { color: #BB60D5 } /* Name.Variable.Global */ +.highlight .vi { color: #BB60D5 } /* Name.Variable.Instance */ +.highlight .vm { color: #BB60D5 } /* Name.Variable.Magic */ .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js index 09d64585..2c774d17 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js @@ -1,12 +1,5 @@ /* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; @@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") { // and returns the new score. /* score: result => { - const [docname, title, anchor, descr, score, filename] = result + const [docname, title, anchor, descr, score, filename, kind] = result return score }, */ @@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") { }; } +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + const _removeChildren = (element) => { while (element && element.lastChild) element.removeChild(element.lastChild); }; @@ -62,12 +63,15 @@ const _displayItem = (item, searchTerms, highlightTerms) => { const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - const contentRoot = document.documentElement.dataset.content_root - ?? DOCUMENTATION_OPTIONS.URL_ROOT; + const contentRoot = document.documentElement.dataset.content_root; - const [docName, title, anchor, descr, score, _filename] = item; + const [docName, title, anchor, descr, score, _filename, kind] = item; let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); let requestUrl; let linkUrl; if (docBuilder === "dirhtml") { @@ -100,7 +104,7 @@ const _displayItem = (item, searchTerms, highlightTerms) => { .then((data) => { if (data) listItem.appendChild( - Search.makeSearchSummary(data, searchTerms) + Search.makeSearchSummary(data, searchTerms, anchor) ); // highlight search terms in the summary if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js @@ -116,9 +120,11 @@ const _finishSearch = (resultCount) => { "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." ); else - Search.status.innerText = _( - `Search finished, found ${resultCount} page(s) matching the search query.` - ); + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, + ).replace('${resultCount}', resultCount); }; const _displayNextItem = ( results, @@ -138,6 +144,22 @@ const _displayNextItem = ( // search finished, update title and status message else _finishSearch(resultCount); }; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; /** * Default splitQuery function. Can be overridden in ``sphinx.search`` with a @@ -161,13 +183,26 @@ const Search = { _queued_query: null, _pulse_status: -1, - htmlToText: (htmlString) => { + htmlToText: (htmlString, anchor) => { const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent !== undefined) return docContent.textContent; + if (docContent) return docContent.textContent; + console.warn( - "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." ); return ""; }, @@ -220,6 +255,7 @@ const Search = { searchSummary.classList.add("search-summary"); searchSummary.innerText = ""; const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); searchList.classList.add("search"); const out = document.getElementById("search-results"); @@ -240,16 +276,7 @@ const Search = { else Search.deferQuery(query); }, - /** - * execute search (requires search index to be loaded) - */ - query: (query) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - + _parseQuery: (query) => { // stem the search terms and add them to the correct list const stemmer = new Stemmer(); const searchTerms = new Set(); @@ -285,22 +312,40 @@ const Search = { // console.info("required: ", [...searchTerms]); // console.info("excluded: ", [...excludedTerms]); - // array of [docname, title, anchor, descr, score, filename] - let results = []; + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. + const normalResults = []; + const nonMainIndexResults = []; + _removeChildren(document.getElementById("search-progress")); - const queryLower = query.toLowerCase(); + const queryLower = query.toLowerCase().trim(); for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { for (const [file, id] of foundTitles) { - let score = Math.round(100 * queryLower.length / title.length) - results.push([ + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ docNames[file], titles[file] !== title ? `${titles[file]} > ${title}` : title, id !== null ? "#" + id : "", null, - score, + score + boost, filenames[file], + SearchResultKind.title, ]); } } @@ -309,46 +354,48 @@ const Search = { // search for explicit entries in index directives for (const [entry, foundEntries] of Object.entries(indexEntries)) { if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id] of foundEntries) { - let score = Math.round(100 * queryLower.length / entry.length) - results.push([ + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ docNames[file], titles[file], id ? "#" + id : "", null, score, filenames[file], - ]); + SearchResultKind.index, + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } } } } // lookup as object objectTerms.forEach((term) => - results.push(...Search.performObjectSearch(term, objectTerms)) + normalResults.push(...Search.performObjectSearch(term, objectTerms)) ); // lookup as search terms in fulltext - results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); // let the scorer override scores with a custom scoring function - if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); - - // now sort the results by score (in opposite order of appearance, since the - // display function below uses pop() to retrieve items) and then - // alphabetically - results.sort((a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; - }); + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; // remove duplicate search results // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept @@ -362,7 +409,12 @@ const Search = { return acc; }, []); - results = results.reverse(); + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); // for debugging //Search.lastresults = results.slice(); // a copy @@ -433,16 +485,14 @@ const Search = { descr, score, filenames[match[0]], + SearchResultKind.object, ]); }; - Object.keys(objects).forEach((prefix) => { - if (!(objects[prefix] instanceof Array)) { - objects[prefix] = Object.entries(objects[prefix]).map(([name, match]) => [...match, name]); - } + Object.keys(objects).forEach((prefix) => objects[prefix].forEach((array) => objectSearchCallback(prefix, array) - ); - }); + ) + ); return results; }, @@ -470,14 +520,18 @@ const Search = { // add support for partial matches if (word.length > 2) { const escapedWord = _escapeRegExp(word); - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord) && !terms[word]) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord) && !titleTerms[word]) - arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); - }); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } } // no match but word was a required one @@ -500,9 +554,8 @@ const Search = { // create the mapping files.forEach((file) => { - if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) - fileMap.get(file).push(word); - else fileMap.set(file, [word]); + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); }); }); @@ -543,6 +596,7 @@ const Search = { null, score, filenames[file], + SearchResultKind.text, ]); } return results; @@ -553,8 +607,8 @@ const Search = { * search summary for a given text. keywords is a list * of stemmed words. */ - makeSearchSummary: (htmlText, keywords) => { - const text = Search.htmlToText(htmlText); + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); if (text === "") return null; const textLower = text.toLowerCase(); diff --git a/_static/sidebar.js b/_static/sidebar.js index c5e2692c..ac7b39ee 100644 --- a/_static/sidebar.js +++ b/_static/sidebar.js @@ -1,7 +1,4 @@ /* - * sidebar.js - * ~~~~~~~~~~ - * * This script makes the Sphinx sidebar collapsible. * * .sphinxsidebar contains .sphinxsidebarwrapper. This script adds @@ -16,9 +13,6 @@ * Once the browser is closed the cookie is deleted and the position * reset to the default (expanded). * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ const initialiseSidebar = () => { diff --git a/contribution/code-style-python.html b/contribution/code-style-python.html index 87ea02c6..18f4d43d 100644 --- a/contribution/code-style-python.html +++ b/contribution/code-style-python.html @@ -6,11 +6,11 @@