Chipsec

__New or Updated Modules/UtilCmds:__
* `tools.cpu.sinkhole` - Minor improvements to sinkhole.py
* `tools.uefi.scan_blocked` - Fix to exit if no FW image is found
* `utilcmd.acpi_cmd` - Prompt the user to specify only existing ACPI tables, delete unused import
* `utilcmd.desc_cmd` - Fix log message typos
* `utilcmd.tpm_cmd` - Fix TPM locality memory mapping bug caused by argparse changes

__New or Updated Configurations:__
* `8086/dnv` - Change SPIBAR mask (Issue 927)
* `8086/pch_5xxxh` - Update config files for pch5xxh and pch5xxlp
* `8086/pch_5xxxlp` - Update config files for pch5xxh and pch5xxlp

__Removed Modules:__
* None

__Additional Changes:__
* `README.md` - Update 01.org mailing list link
* `common.wsmt` - Introduce a new module to check for the presence and configuration of the WSMT table
* `chipset` - Add write_register() return
* `docs/create_manual.cmd` - Script enhancements
* `docs/create_manual.sh` - Script enhancements
* `docs/sphinx/Contact.rst` - Update Windows Installation and other improvements
* `docs/sphinx/Download.rst` - Update Windows Installation and other improvements
* `docs/sphinx/Install in Windows.rst` - Update Windows Installation and other improvements
* `docs/sphinx/_images/GHRepo.png` - Update Windows Installation and other improvements
* `docs/sphinx/_images/LR.png` - Update Windows Installation and other improvements
* `docs/sphinx/_images/chipsec_favicon.jpg` - Update Windows Installation and other improvements
* `docs/sphinx/conf.py` - Update Windows Installation and other improvements
* `docs/sphinx/index.rst` - Update Windows Installation and other improvements
* `drivers/linux/chipsec_km.c` - Drop _GNU_SOURCE define, simplify and fix symbol resolving for kernels >= 5.10, sprint_symbol() based fallback for symbol resolving, always ensure required symbols are non-null, use appropriate error code on module init errors, fix ioctl() error codes, fix memory leak in IOCTL_GET_EFIVAR ioctl, simplify my_xlate_dev_mem_ptr() slightly, make my_[un]xlate_dev_mem_ptr() static and fix getting physical address of GDT
* `drivers/win7/driver.c` - Fix issue with mmio r/w
* `drivers/win7/include/chipsec.h` - Fix issue with mmio r/w
* `hal.acpi_tables` - Better parsing of the WSMT
* `hal.acpi` - oshelper.get_ACPI_table already takes care of checking if we're in native API mode, better parsing of the WSMT
* `hal.uefi_common` - Fix bug when formatting VendorGuid, Rename VendorGuid -> VendorGuidData
* `helper.rwe.rwehelper` - Trace error message when GetSystemFirmwareTable fails, fix conversion of table identifiers from strings to integers
* `helper.win.win32helper` - Fix issue with mmio r/w
* `helper.win.win32helper` - Trace error message when GetSystemFirmwareTable fails, fix conversion of table identifiers from strings to integers
* `windows_requirements.txt` - Add windows_requirements.txt, Add setuptools to windows_requirements.txt

__Additional Notes:__
* :arrow_right: __For Windows users, please rebuild your windows driver as updates have been made.__ ⬅️
* __For Windows, Linux and MacOS: Python2 support has been deprecated as of June 2020. Please use Python3.__
* Any modules under the `modules.tools` directory have not yet been fully validated to work with Python3.

__New Module Details:__

Module Name | Supported Platforms | Flags
:---: | :---: | :---:
common.wsmt | */Windows | None

__New or Updated Modules/UtilCmds:__
* `tools.smm.rouge_smm_bar` - Update rouge_mmio_bar to work with python3
* `tools.uefi.scan_blocked` - Fix to exit if no FW image is found

__New or Updated Configurations:__
* `8086/cml` - Add additional SKU DIDs
* `8086/pch_c620` - Add fixed address attribute to SBREGBAR
* `8086/tglu` - Add WOPCM field

__Removed Modules:__
* None

__Additional Changes:__
* `.github/workflows/tests.yml` - Configure GitHub Actions to test some features
* `AUTHORS` - Update AUTHORS file
* `chipset` - Add register type checks (msr/pci)
* `drivers/linux/Makefile` - Simplify the Makefile used by Linux kernel module
* `drivers/linux/amd64/cpu.asm` - Fix Linux swsmi assembly
* `drivers/linux/chipsec_km.c` - Simplify parsing /proc/kallsyms in Linux kernel module
* `hal.mmio` - Fix MMCFG accesses not DWORD aligned
* `hal.msgbus` - Fix issue when trying to access SB on some platforms
* `helper.win.win32helper` - Fix strings when passed as byte array
* `logger` - Fix logger when logfile and ALWAYS_FLUSH
* `tests.hardware.test_generic` - Fix test to work with GitHub Actions

__Additional Notes:__
* __For Windows users, please rebuild your windows driver as updates have been made.__
* __For Windows, Linux and MacOS: Python2 support has been deprecated as of June 2020. Please use Python3.__
* Any modules under the `modules.tools` directory have not yet been fully validated to work with Python3.

__New Module Details:__

Module Name | Supported Platforms | Flags
:---: | :---: | :---:

__New or Updated Modules/UtilCmds:__
* `common.sgx_check` - Update missed formatting changes
* `common.uefi.access_uefispec` - Get rid of call to ord(), delete unreferenced lists, print error message only if ro_concern is not empty, try to modify other variables as well and fix status code check for set_EFI_variable
* `module_common` - Update BaseModule methods
* `modules.tools.uefi.uefivar_fuzz` - Add bytes support to uefivar_fuzz.py
* `tools.smm.smm_ptr` - Fix smm_ptr.py sig bytearray
* `utilcmd.interrupts_cmd` - Fix payload reading for smi_smmc
* `utilcmd.mmio_cmd` - General Flake8 formatting cleanup and add partial MMIO region dump
* `utilcmd.pci_cmd` - Remove underscores that are no longer needed

__New or Updated Configurations:__
* `8086/common` - Switch to MEI1 device definition
* `8086/pch_4xx` - PCH 4xx series updates
* `8086/pch_4xxh` - PCH 4xx series updates
* `8086/pch_4xxlp` - PCH 4xx series updates

__Removed Modules:__
* None

__Additional Changes:__
* `.travis.yaml` - Change xenial to newer distros
* `chipsec.chipset` - Update functions to display register in verbose mode, update for issue 761 and add changes to enable consistancy checking
* `chipsec.defines` - Improve winhelper.py py3 str handling
* `chipsec.hal.iobar` - Add changes to enable consistancy checking
* `chipsec.hal.mmio` - Add changes to enable consistancy checking
* `chipsec.hal.spi_uefi` - Update spi_uefi.py to handle the corrupted GUID
* `chipsec.hal.spi` - Fix hal.spi bytearray verbose print
* `chipsec.hal.tpm_eventlog` - Remove stray backslash from the URL for TCG EFI Platform Specification
* `chipsec.helper.linux.linuxhelper` - Change tostring to tobytes, add one additional status_dict and other minor improvements
* `chipsec.helper.win.win32helper` - Improve winhelper.py py3 str handling
* `chipsec.logger` - Update to prefer WConio2 over the original WConio
* `tests.software.cs` - Update to always close the temporary log file when a test fails
* `tests.software.test_tpm_eventlog` - Generate 12-byte fake TPM event in EFIFirmwareBlob test
* `tests.software.util` - Update to always close the temporary log file when a test fails

__Additional Notes:__
* __For Windows users, please rebuild your windows driver as updates have been made.__
* __For Windows, Linux and MacOS: Python2 support has been deprecated as of June 2020. Please use Python3.__
* Any modules under the `modules.tools` directory have not yet been fully validated to work with Python3.

__New Module Details:__

Module Name | Supported Platforms | Flags
:---: | :---: | :---:

__New or Updated Modules/UtilCmds:__
* None


__New or Updated Configurations:__
* `8086/pch_5xxh` - Fix missing type attribute


__Removed Modules:__
* None


__Additional Changes:__
* `chipsec.chipset` - Update exception logic from cs exception changes

__Additional Notes:__
* __For Windows users, please rebuild your windows driver as updates have been made.__
* __For Windows, Linux and MacOS: Python2 support has been deprecated as of June 2020. Please use Python3.__
* Any modules under the `modules.tools` directory have not yet been fully validated to work with Python3.

__New Module Details:__


Module Name | Supported Platforms | Flags
:---: | :---: | :---:

__New or Updated Modules/UtilCmds:__
* `common.memlock` - Add display of register when in verbose mode
* `common.smm_code_chk` - Capture self.res and fix encoding issue
* `common.spi_access` - Add messaging for SPI checks
* `common.spi_desc` - Add messaging for SPI checks
* `utilcmd.config_cmd` - Add util config util command
* `utilcmd.interrupts_cmd` - Update interrupts_cmd.py CLI to argparse and add smmc port option and print textual representation of the status returned by send_smmc_SMI
* `utilcmd.io_cmd` - Fix parameter processing in I/O command
* `utilcmd.pci_cmd` - Update pci_cmd.py CLI to argparse


__New or Updated Configurations:__
* `8086/apl` - Updated the product xml files to match the datasheets
* `8086/cht` - Updated the product xml files to match the datasheets
* `8086/cml` - Add CML configuration
* `8086/glk` - Updated the product xml files to match the datasheets
* `8086/pch_4xx` - Add pch4xx config file
* `8086/pch_4xxh` - Add pch4xxh config file
* `8086/pch_5xxh` - Add pch5xxh config file
* `8086/pch_5xxlp` - Add pch5xxlp config file
* `8086/rkl` - Add RKL configuration
* `8086/skx` - Add CPUID range to include detection_value for CPX
* `8086/tglu` - Add TGLU configuration


__Removed Modules:__
* None


__Additional Changes:__
* `README.md` - Add release convention section
* `chipsec.chipset` - Add execeptions within cs.read_register, specify detection_value ranges and check if the VID is present in the chipset dictionary
* `chipsec/modules/tools/uefi/blockedlist.json` - Add MosaicRegressor UEFI RK to blockedlist
* `chipsec_tools/log_parser/requirements.txt` - Update log_parser requirements.txt and add lxml version update
* `drivers/linux/Makefile` - Support overriding Linux source path
* `drivers/linux/dkms.conf` - Update chipsec version in dkms.conf and override KSRC instead of KERNELDIR in dkms.conf
* `drivers/win7/chipsec_hlpr.vcxproj` - Fix copy error when building driver with a space in the path
* `drivers/win7/driver.c` - Change macro used for writing to MMIO
* `drivers/win7/include/chipsec.h` - Add IOCTL code
* `hal.interrupts` - Add port options to send_smmc_SMI() and dump the communication buffer before and after triggering the SMI
* `hal.uefi_common` - Dump boot script entries using dump_buffer_bytes and add textual representation of the status returned by send_smmc_SMI
* `hal.uefi_platform` - Fix wrong header length for EDK-type boot script
* `helper.linux.linuxhelper` - Fix mmio access granularity in native mode and error message when the Linux kernel module fails to load
* `helper.win.win32helper` - Use new IOCTL for MMIO writes
* `Sphinx` - Updates for manual
* `tests.software.mock_helper` - Fix mock_helper for cs_exceptions
* `travis.yml` - Update travis.yml for macos


__Additional Notes:__
* __For Windows users, please rebuild your windows driver as updates have been made.__
* __For Windows, Linux and MacOS: Python2 support has been deprecated as of June 2020. Please use Python3.__
* Any modules under the `modules.tools` directory have not yet been fully validated to work with Python3.

__New Module Details:__


Module Name | Supported Platforms | Flags
:---: | :---: | :---:

__New or Updated Modules/UtilCmds:__
* `common.debugenabled` - Change helper calls to HAL calls
* `common.smm_code_chk` - Introduce a new module that checks that SMM_Code_Chk_En is configured properly
* `common.spi_fdopss` - Update spi_fdopss check for FDOPSS
* `tools.smm.smm_ptr` - Fix minor typos in smm_ptr.py
* `tools.vmm.xen.hypercall` - Change helper calls to HAL calls

__New or Updated Configurations:__
* `8086/apl` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/bdw` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/cfl` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/cml` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/dnv` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/edx` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/glk` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/hsw` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/hsx` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/icl` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/kbl` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/skl` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/skx` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `8086/whl` - Add the definition for MSR_SMM_FEATURE_CONTROL
* `template` - Add lock and lockedby to configuration

__Removed Modules:__
* None

__Additional Changes:__
* `chipsec.chipset` - Add lock and lockedby to configuration
* `drivers.linux.Makefile` - Fix Makefile to work with DKMS
* `drivers.linux.chipsec_km.c` - Fix driver for Linux kernel 5.10+. Remove old syscalls get_fs/set_fs.
* `drivers.linux.chipsec_km.c` - Fix two memory leak bugs
* `drivers.linux.chipsec_km.c` - Use CONFIG_EFI instead of user defined HAS_EFI (1036)

__Additional Notes:__
* __For Windows users, please rebuild your windows driver as updates have been made.__
* __For Windows, Linux and MacOS: Python2 support has been deprecated as of June 2020. Please use Python3.__
* Any modules under the `modules.tools` directory have not yet been fully validated to work with Python3.

__New Module Details:__
* `common.smm_code_chk` - Introduce a new module that checks that SMM_Code_Chk_En is configured properly

Module Name | Supported Platforms | Flags
:---: | :---: | :---:
common.smm_code_chk | APL BDW CFL CML DNV EDX GLK HSW HSX ICL KBL SKL SKX WHL | None