Chipsec

__New or Updated Modules:__
* `tools.secureboot.te` - Updated to take input from python2/3
* `modules.common.spd_wd` - updated to work within python3
* `modules.tools.uefi.uefivar_fuzz` - updated to be python3 compliant
* `modules.common.memlock` - updated is_supported logic
* `modules.common.ia32cfg` - enabled per thread checking of settings

__New or Updated Functionality:__
* Added cs_input function to support input/raw_input differences between python2/3
* `fuzzing.primitives` - updated to be python3 compliant
* `hal.acpi` - fixed python3 compatibility issue
* Ability to query the existence of a register directly
* Uefi decode logic issue when calculating size of a file
* dump_buffer function - bug fixes
* Add ability to have registers reference memory type within configuration files
* Add ability to load custom_helpers

__Fixes:__
* `setup.py` build errors
* `linuxhelper` uefi variable compatibility with python3
* `linux/cores.c` - build error
* `common.xml` - updated register definitions
* header output is now consistent between chipsec_main and chipsec_util
* `chipsec_util` - extended use of argparse
* `chipset` - custom_chipset import

__Additional Information:__
* python2.7 is still supported
* Any modules under the `modules.tools` directory have not yet been fully validated to work with python3
* When filing an issue with python3 if possible also include the results of running the same command with python2

__New or Updated Modules:__
* `utilcmd.cpu_cmd` - Updated to utilize argparse
* `modules.common.spd_wd` - updated to work within python3

__New or Updated Functionality:__
* python3 is supported - merged in python3-rc branch
* PCI enumeration will be silent by default when the --debug flag is enabled
* c6xx supported platforms

__Fixes:__
* Exception handling when pci_enumeration fails
* Removed debug print from Windows helper IOCTL calls
* Use of is when comparing None type
* Division within modules compliant with python3
* Windows driver hypercall type
* Filehelper updated to work with python3

__Additional Information:__
* python2.7 is still supported
* Any modules under the `modules.tools` directory have not yet been fully validated to work with python3
* When filing an issue with python3 if possible also include the results of running the same command with python2

python3-rc2
Only for Experimental/Development support
Use official release for validation

__Python 3 Support__:
Updated to be equivalent to release 1.3.8.
All major functionality appears to be working within chipsec_main modules and chipsec_util commands
Next steps will be to validate all python3 functionality replicates python2 functionality

__Current Supported OS__:
Linux
Windows
MacOS

__Unsupported OS__:
UEFI Shell

__Python 2 compatability__:
There should be no impact to any prior functionality and all OS are still supported

__New or Updated Modules:__
* tools.uefi.s3script_modify - added better messaging when s3script is not found
* common.spd_wd - new module to check SPD Write Disable bit
* utilcmd.acpi_cmd - moved to arg_parse for options
* common.sgx_check - updated test logic to handle when enabled/disabled and only validate defined registers
* tools.cpu.sinkhole.py - updated failure/success messages
* utilcmd.decode_cmd - updated command output messages
* debug_enabled - removed hardcoded values from test into configuration files
* utilcmd.cmos_cmd - moved to arg_parse for options


__New or Updated Functionality:__
* Configuration files created
* whl
* skx
* pch_3xx
* Added Clone and Replay ability - register values can be saved to and replayed from json file
* Dynamic bus support added
* SMM returns register values after call
* SMM hal functionality for ACPI commbuffer support
* Added ability to reset the SMBus controller
* Updated Linux native IO read/write functionality
* Added Fuzzing primitives file from Sulley fuzz testing framework
* Updated setup.py
* Added ability to use build_ext for Windows
* Updated script to build compression tools for macOS, Linux, and Windows
* Updated UEFI Decompress functionality
* Added signed guid Certificate RSA2048/SHA256 support
* Add VSS2 NVRAM parsing
* Modified FV search logic
* Compression/Decompression algorithms imported from TianoCore/edk2 BaseTools
* Add ability to define devices by name within configuration files
* Updated Message handling for VSS AUTH Variables
* Add Revsiion ID reporting to chipset detection

__Fixes:__
* Add stack unwind to Windows driver
* chipsec_util argument passing to commands and return status from commands
* Ability to get number of threads from APIC table
* Handling unknown DIMM types
* Updates to configuration files:
* pch_1xx
* pch_2xx
* pch_c60x
* pch_c61x
* pch_c62x
* iommu
* ivt
* jkt
* pcidb
* skl
* kbl
* cfl
* bdx
* hsx
* Normalized logging:
* Hal modules use HAL
* Helper modules use DEBUG
* Modules and Commands use VERBOSE
* Added ability to select which each mode of logging individually
* Added UEFI table to ACPI tables
* Windows helper with DEBUG flag enabled


__Additional Information:__
* Users **must rebuild the driver** for Windows, Linux, and macOS due to fixes in the driver source

python3-rc1
Only for Experimental/Development support
Use official release for validation

__Python 3 Support__:
All major functionality appears to be working within chipsec_main modules and chipsec_util commands
Next steps will be to enable other operating system support

__Current Supported OS__:
Linux

__Unsupported OS__:
Windows
MacOS
UEFI Shell

__Python 2 compatability__:
There should be no impact to any prior functionality and all OS are still supported

__New or Updated Modules:__
* Updated output formatting in `common.memlock` module
* Updated `common.sgx_check` to be skipped when not supported by the platform
* Enabled modules on macOS
* `common.bios_smi`
* `common..ia32cfg`
* `common.smrr`
* `smm_dma`
* Updated `common.smm` to check earlier if the module should be run
* Updated handling of STIBP in `common.cpu.spectre_v2` module

__New or Updated Functionality:__
* Added macOS CI support
* Switched command line argument parsing module for `chipsec_main` and `chipsec_util`
* Updated `chipsec_util` to continue to load commands after a failed command load
* Updated detection of legacy BIOS functionality in Windows 7 and later
* Added support to allow command line arguments to be passed to all modules

__Fixes:__
* Fixed Windows physmem write errors
* Fixed UEFI Decode crash in CHIPSEC Util
* Fixed losing last UEFI variable when parsing VSS
* Fixed typo in C600 PCH description string
* Fixed LVSCC/UVSCC configuration data
* Fixed Linux driver build issues with kernel 4.1.12 and 4.14
* Fixed SPI JEDEC command on older PCH versions
* Fixed loading of some PCH configuration files
* Fixed Linux driver build support for legacy and UEFI modes
* Fixed 32bit CPUID support
* Fixed IOCTL numbering in Linux driver
* Fixed native MMIO reads in Linux with less than 4GB
* Fixed `register_has_field` exception when register has not fields defined
* Fixes for PyLint issues
* Fixed variable issues in UEFI Shell
* Fixed case where a register is un-defined multiple times by configuration files
* Fixed incorrect configuration support for FREG6
* Fixed passing of arguments with `-a` to modules after parser switch
* Fixed Linux driver build on kernel 5.0-rc6 as well as new build warnings
* Documentation updates

__Additional Information:__
* Users should rebuild the Windows driver due to fixes in the driver source

__New or Updated Modules:__
* Updated `memconfig` to only check registers that are defined by the platform
* Updated `common.bios_smi` to check controls not registers
* Added `me_mfg_mode` module
* Added support for LoJax detection
* Updated `common.spi_lock` test support
* Added `sgx_check` module and register definitions
* Updates to DCI support in `debugenabled` module


__New or Updated Functionality:__
* Added ability for is_supported to signal a module is not applicable
* Added 300 Series PCH support
* Added support for building Windows driver with VS2017
* Added fixed I/O bar support
* Updated XML and JSON log rewrite
* Updated logger to use python logging support
* Added JEDEC ID command
* Added DAL helper support
* Added 8th Generation Core Processor support
* Updated UEFI variable fuzzing code
* Added C600 and C610 configuration
* Added C620 PCH configuration
* Updated ACPI table parsing support
* Updated UEFI system table support
* Added Denverton (DNV) support
* Added result delta functionality
* Added ability to override PCH from detected version


__Fixes:__
* Updated `readme` content
* Fixed Atom register names to match common names
* Updated manual source for release
* Fixed HackingTeam rootkit link
* Fixed corner case when disabling logging mid test
* Fixed exception when logging some objects
* Fixed CFL SPI FREG field sizes
* Fixed UEFI decompress when `NextFileFw` is given an invalid file size
* Fixed 64-bit MMIO accesses in UEFI Shell
* Fixed Windows variable access support
* Fixed extra argument in Linux helper
* Fixed FV decompress buffer overflow
* Fixed P2SB hide functionality
* Fixed `is_efi` interface definition
* Fixed parsing of secure boot variables
* Fixed flash region support
* Fixed `FLMSTR` display
* Workaround `memlock` issue in UEFI shell with Atom
* Fixed get affinity messages
* Fixed VMM EPT util support
* Fixed PREFast issues
* Fixed exception in XML logging
* Fixed Linux build issue with `alid_mmap_phys_addr_range`
* Fixed code to always detect chipset
* Fixed Debian packaging support
* Removed RWE support due to issues accessing PCI resources

New or Updated Modules:
* `common.cpu.spectre_v2` - Checks for Spectre variant 2 mitigation.
* `debugenabled` - Verifies hardware debug features are disabled.
* `memlock` - Verifies that LT memory configuration is locked.

New or Updated Functionality:
* Added missing device IDs for BDW and KBL.
* Added `chipsec_util vmem` command for access virtual memory addresses.
* Added INFORMATION module result type.
* Added ability to define a fixed BAR values for hidden PCI devices.
* Added PCH detection and loading of PCH specific configuration files.
* Added 100 and 200 series PCH configuration files.
* Changed SKIPPED result into two result types (`NOT IMPLEMENTED` and `NOT APPLICABLE`)

Fixes:
* Fixed banner missing from log file.
* Added `mm_msgbus` to register type validation.
* Fixed decompression issues.
* Fixed processing of `pt` option in IOMMU command.
* Fixed error reporting in `debugenabled` module when warnings are reported.

NOTE: By default tests that were previously marked as skipped on platforms will now be recorded as Not Implemented in the results. In the future some tests will be updated to report Not Applicable when appropriate.