               KBL Y RVP3 Type C board (with eSPI support) RELEASE NOTES

V02.04  03-10-2020
------------------
- Modify max CC & CV as per AML-WCOS platform.
-TI994 support and TI common interface ported.

V02.03  02-19-2020
------------------
- Fix system not booting with battery alone.

V02.02  02-14-2020
------------------
- AML-WCOS: Enable dual battery support.

V02.01  01-21-2020
------------------
- AML-WCOS: Disable ATX detect and update charger setting.

V02.00  12-04-2019
------------------
- Begining new major version 2.0 for AML WCOS program.
- AML-WCOS: Change HomeButton mapping from gpio162 to gpio056 for AML-WCOS

V01.36  06-11-2019
------------------
-- AML-Y: Fix: UCSI failure due to incorrect port capability for AR card. Implementation
		for the Get Partner Sink PDOs
			   
V01.35  01-17-2019
------------------
- AML-Y: Use STD_ADP_PRSNT instead of TYPEC_DCBRL_PRESENCE as this is TP in AML
- Fix:1606903284: Fixing UCSI issue for AMLY42. board Id iscorrection. TIPD Alert
	GPIO corrected.
- Fix: Corrected BoardId based Check for the TIPD resource selection.

V01.34  01-03-2019
------------------
- UCSI support for AML
- Back out changelist 609430: Disabling burstmode

V01.33  12-17-2018
------------------
- HSD-1606735891: AML Y RVP Voltage regulator LVM override implementation

V01.32  10-10-2018
------------------
- HSD 1606652866: Virtual battery hot keys using scan matrix keyboard is not working. 

V01.31  09-27-2018
------------------
- Revert CL#605470: BurstMode workaround as it has created CS regression.

V01.30  09-05-2018
------------------
- AML: Fix klockwork issues in Hwsmbus
- Fix HSD-1606028859: SUT is not waking from CS with Scan matrix keyboard
- Fix AML - 1606664305 ,1606664359: PECI reports failsafe temprature. 
- HSD 1606652928: AML-Y 7W/5W:Active trip point is not working in BSOD screen

V01.29  08-29-2018
------------------
- HSD-1605830140: Do not process burst mode command to avoid EC timeout errors in OS.

V01.28  08-06-2018
------------------
- HSD-1605930433: avoiding hardloop in PECI cmd & fif reset before starting PECI transaction.

V01.27  07-17-2018
------------------
- HSD-1605299274: Proper BATLOW_ assert/de-assert based on battery and charger.
- HSD-2007359429: PECI driver change and retry implementation

V01.26  07-11-2018
------------------
- HSD-1605289590:[EC][AMB/KBL-YR-RVP3 CRB Fab2]:CPU Fan keeps rotating  in S5 State with "State After G3" set to 'S5 state'
- Low battery condition check before generating wake from S3. CFL-S/H CL#555009
- HSD-1605480039: On SPT LP EC needs to wait for power button release and then start the timer for ESPI_RESET to Work around EC0A DeepSx hang issue

V01.25  06-20-2018
------------------
- Fixed klock work issues.
- RCR 1407291118: EC Team needs to implement WA for platforms supporting both MAFS and SAFs, slave (e.g.BMC) should ignore this bit when platform is operating in SAFS mode
- RCR 1407291030: [AML] [PO] EC FW - Need EC FW workaround in order to boot in SAF mode
- EC to configure SAF mode registers by default after G3 exit, unless in MAF mode. 

V01.24  06-12-2018
------------------
- HSD-1605302356: Pull 449961 from CNL: Fan speed read by DPTF does not correlate to actual fan speed
- HSD #1407224521: [KBL-YR] System fails to boot after Global Reset in MAF mode
- Interrupt based VW Ready bit set

V01.23  06-04-2018
------------------
- Added new error codes for board id read fail (0x0B) and EEPROM read fail (0x0D)  
- Use cached value for ATX detect to avoid runtime errors.

V01.22  05-25-2018
------------------
- toml and make file chagnes to support MEC1428
- Added support for PMC_GPIO

V01.21  05-05-2018
------------------
- This release onwards is for Amberlake Support.
- Added support for MAF
- Added TestEspi test interface for debugging OOB & periodic / random generation of wake events like OOB, VW, IRQ.
- RCR 1407018947.1: [AML] EC fw test feature for PM wake from SCI, OOB, IRQ
- Disabled Debug prints in couple of files.
- Added ESPI_RESET check & EC0A 
- Support to compile with new Microchip compiler version v1.40
- Updated TOML file to fit in EC image in shared flash @ 0x1000
- Disable MAF by default.
- Add SAF support and Detect MAF mode based on flash channel ready set by bootloader
  and configure gpio123 in MAF and gpio013 in SAF/G3 as PM_RSMRST_N.

V01.20  11-08-2017
------------------
Sending Gaid command for PPM reset causing HSD:1604455282 & 1604428355, hence reverted as WA

V01.19  09-13-2017
------------------
- Ported UCSI fixes from KBL-R which fixed RS3 HLK issues.

V01.18  07-03-2017
------------------
- Fix UCSI HLK issues related to unsupported cmd, altmode, audio/debug accessory.
- Enable Ufp only and dfp only mode in ucsi

V01.17  06-05-2017
------------------
- HSD-1604241743, Return current swith status for SMCHost command GetSwitchStatus(0x0A)
			   
V01.16  05-30-2017
------------------
- Ignore PECI temperature reading on bad FCS error, HSD-1305034660

V01.15 04-19-2017
----------------
- Update ACPICPUDTSHigB and ACPICPUDTSLowB with CPU temperature, HSD-1209894951

V01.14 1-06-2017
----------------			   
Fixed :[1604243199][kaby_lake.rvp3]KBL-EC:Some Function key(Fn) + F-series keys are not working on KBL-Y board through scan matrix keyboard.

V01.13 10-14-2016
----------------
Fixed : 1604185876: [kaby_lake.rvp3][KBL_BKC_WSTV_Type-C_CS ]Slide to shutdown screen is not appearing in Type- C board
			   
V01.12 10-04-2016
----------------
WA Provided : 1209037137: [KBL-Y][RVP3 Type C] High CPU utilization caused by 'System 
Interrupts' when CPU temperature above 50C

V01.11 07-13-2016
----------------
Fixed : [HSD-ES][client_platf][1604185860][kaby_lake.rvp3]KBL-Y: With "EC LP mode" and "EC-CS-Debug Light' options enabled in BIOS, CAPS_LOCK continues to be ON even after exiting CS
Fixed : [HSD-ES][client_platf][1208704002][kaby_lake.rvp3][KBL] GENx thermisters: When returning from S4/S5, EC/BIOS returns zero (voltage) which is not in the LPAT lookup table
WA Provided : [KBL PV] EC Timeout errors in event log
WA Provided : [KBL-Y][RS1-14376][WW28.3] Frequently system takes more time to boot into OS with Type-C enabled in BIOS.

V01.10 06-20-2016
----------------
Fixed : [HSD-ES][client_platf][1404771676][kaby_lake.rvp3][Type-C KBL-Y RVP3]  Device controller doesn't enter D3 upon disconnect  from host after DUT cold boot with cable connected to Type-C port 1
Fixed : [HSD-ES][client_platf][1604198721][kaby_lake.rvp3]KBL Y RVP3 Type C board Volume Down key Release SCI (0x81) is not getting generated

V01.09 05-06-2016
----------------
Fixed : [HSD-ES][client_platf][1208249475][kaby_lake.rvp3]Applying set charge rate command (37h) to offset 3Ah will cause the charge rate to oscillate charge and not charging
Fixed : [HSD-ES][client_platf][1604164288][kaby_lake.rvp3]KBL-Y: SUT remains in S5 state upon plugging in AC-brick, power button press is required to boot the SUT.
Fixed : [HSD-ES][client_platf][1207363523][kaby_lake.other][KB Lake] EC does not take over control of charger charge rate from DPTF when system enters Sx
Fixed : [HSD-ES][client_platf][1604168772][kaby_lake.rvp3][KBL_Y_Type-C FAB2 Board]System not resuming from Sx with 15W charger connected.
LPC support for KBL S

V01.08 04-27-2016
----------------
Added for RCR : [HSD-ES][client_platf][1404787877][][Type-C KBL-Y RVP3] Platform should not boot when connected to 15W adapter unless the charge crosses the threshold voltage for boot
Added for RCR : [HSD-ES][client_platf][1207541024][] Added "KBL EC Support for Pmax, PBSS and battery cycle count SCIs" as part of this RCR
Fixed : [HSD-ES][client_platf][1404761197][kaby_lake.rvp3][Type-C KBL-Y RVP3] Sometimes KBL-Y crashes with BugCheck 50 during Type-C dock hotplug/removal
Fixed : [HSD-ES][client_platf][1604103081][kaby_lake.rvp3]KBL-Y: Windows displays only battery icon in OS with ATX Power supply connected.
Fixed : [HSD-ES][client_platf][1404973333][kaby_lake.other]KSKBL_S_CRB platform Serial Port not working

V01.07 04-13-2016
----------------
Fixed : [HSD-ES][client_platf][1404743993][][Type-C KBL-Y RVP3] Dual Role bit not set in sink PD0
Fixed : [HSD-ES][client_platf][1604120054][]KBL BIOS:SUT hangs after wakes from CS In KBL_Y boards
Fixed : [HSD-ES][client_platf][1207551270][]KabyLake: Some sensors occasionally stop getting interrupts for temp threshold crossed events
Added for RCR : [HSD-ES][client_platf][1604123408][kaby_lake.rvp3]KBL Y RVP3 Fab2 EC changes

V01.06 03-24-2016
----------------
- KBL-S and KBL-Y merged code initial release

V01.05 02-18-2016
----------------
- Fixed : [HSD-ES][client_platf][1604117733][kaby_lake.rvp8]KBL-DT: Unable to launch PECI tool on KBL-S-DT board.
- FFU tool support.
- Fixed : [HSD-ES][client_platf][1207538944][kaby_lake.other][Power Boss] [MUST FIX - KBL Beta] Platform Power Source updates correctly in TPWR participant tab, but not in Power Boss Policy tab

V01.04 02-04-2016
----------------
- Fixed : [HSD-ES][client_platf][1604078166][kaby_lake.rvp3]KBL-EC: UCSI version is not reflected correctly in EDK shell on KBL-Y-board.
- Fixed : [HSD-ES][client_platf][1404709386][kaby_lake.rvp3][Type-C KBL-Y RVP3] XDCI controller doesn't wake upon connection of USB host to KBL-Y RVP3 platform Type-C port 1.
- Fixed : [HSD-ES][client_platf][1404702467][kaby_lake.rvp3][Type-C KBL-Y RVP3] Platform is not charging when connecting chargers that provide less than 60W.

V01.3 01-21-2016
----------------
- Fixed: DPTF changes from APL : moved the ACPIPSRC offset from [134/0x86] to offset [121/0x79] to maintain uniformity across all platforms
- Fixed: HSD 1604074897 - Battery pack current is not updated to 0 in the ACPI space once the battery is unplugged

V01.2 01-13-2016
----------------
- Type C workaround for Vbus Sense
- [HSD-ES][client_platf][1207494558][kaby_lake.other]KBL : Add Hot Key Support _Q52
- BIOS PMIC WA support ported from skl
- DPTF changes from APL : 1207096450  - [APL Alpha] SEN1 does not cause threshold crossed event if running in interrupt mode
- DPTF changes from APL : 1207107442  DPTF: need EC support for Power participant

V01.01 01-08-2016
----------------
HSD 1604071752 - Send "stop charging" command to uQNS when the charging is not happening
HSD 1604073771 - kaby_lake.rvp3]KBL RVP Y[triage] [Enabling] - UCSI applicantion hang is seen with driver version : 12.29.50.634

Known limitation : 5v, 12v type c charging not enabled, PECI stress tool not enabled, DPTF sensor tunining and offset correction.

V01.0 12-29-2015
----------------
- Base version with Type C and Fast charging support
(20V charging support only )
- Basic EC features supported

NOTES:
=====
Required Hardware:
	KBL Y RVP3 Board
	Dediprog to program KSC binary image.

Flash Programming:
	1) Power off the board completely and disconnect all the power sources.
	2) Connect the Dediprog SF600 to EC Programming header
	3) Open the Dediprog software and select the chip "W25Q128FV"
	4) Select the ksc binary image file
	5) Click on Batch to perform erase/program/verify (Make sure the programming starts from offset 0)
	6) After programming disconnect dediprog and apply the power.

Flash Programming Using Tools : Refer below links for firmware update using FFT tool.

FFT Tool Wiki  Please refer to the usage instructions and commands section in the wiki.
https://wiki.ith.intel.com/pages/viewpage.action?pageId=225319947

Tool download link: 
https://sharepoint.amr.ith.intel.com/sites/PCCGUtil/PCCG%20Utilities/Firmware%20Flash%20Tool%20(1.0.123).zip
