Documentation: Fix wrong link to commit message guidelines
[coreboot2.git] / Documentation / mainboard / hp / elitebook_820_g2.md
blob6fafbe1758ce2d58fb1544c50e093aecffed8e4c
1 # HP EliteBook 820 G2
3 This page is about the notebook [HP EliteBook 820 G2].
5 ## Release status
7 HP EliteBook 820 G2 was released in 2015 and is now end of life.
8 It can be bought from a secondhand market like Taobao or eBay.
10 ## Required proprietary blobs
12 The following blobs are required to operate the hardware:
14 1. EC firmware
15 2. Intel ME firmware
16 3. Broadwell mrc.bin and refcode.elf
18 HP EliteBook 820 G2 uses SMSC MEC1324 as its embedded controller.
19 The EC firmware is stored in the flash chip, but we don't need to touch it
20 or use it in the coreboot build process.
22 Intel ME firmware is in the flash chip. It is not needed when building coreboot.
24 The Broadwell memory reference code binary and reference code blob is needed
25 when building coreboot. Read the document [Blobs used in Intel Broadwell boards]
26 on how to get these blobs.
28 ## Programming
30 Before flashing, remove the battery and the hard drive cover according to the
31 [Maintenance and Service Guide] of this laptop.
33 HP EliteBook 820 G2 has two flash chips, a 16MiB system flash, and a 2MiB
34 private flash. To install coreboot, we need to program both flash chips.
35 Read [HP Sure Start] for detailed information.
37 ![HP EliteBook 820 G2 flash chip](elitebook_820_g2_flash.jpg)
39 To access the system flash, we need to connect the AC adapter to the machine,
40 then clip on the flash chip with an SOIC-8 clip. An [STM32-based flash programmer]
41 made with an STM32 development board is tested to work.
43 To access the private flash chip, we can use a ch341a based flash programmer and
44 flash the chip with the AC adapter disconnected.
46 To flash coreboot on a board running OME firmware, create a backup for both flash
47 chips, then do the following:
49 1. Erase the private flash to disable the IFD protection
50 2. Modify the IFD to shrink the BIOS region, so that we can put the firmware outside
51    the protected flash region
53 To erase the private flash chip, attach it with the flash programmer via the SOIC-8 clip,
54 then run:
56     flashrom -p <programmer> --erase
58 To modify the IFD, write the following flash layout to a file:
60     00000000:00000fff fd
61     00001000:00002fff gbe
62     00003000:005fffff me
63     00600000:00bfffff bios
64     00eb5000:00ffffff pd
66 Suppose the above layout file is ``layout.txt`` and the origin content of the system flash
67 is in ``factory-sys.rom``, run:
69     ifdtool -n layout.txt factory-sys.rom
71 Then a flash image with a new IFD will be in ``factory-sys.rom.new``.
73 Flash the IFD of the system flash:
75     flashrom -p <programmer> --ifd -i fd -w factory-sys.rom.new
77 Then flash the coreboot image:
79     # first extend the 12M coreboot.rom to 16M
80     fallocate -l 16M build/coreboot.rom
81     flashrom -p <programmer> --ifd -i bios -w build/coreboot.rom
83 After coreboot is installed, the coreboot firmware can be updated with internal flashing:
85     flashrom -p internal --ifd -i bios --noverify-all -w build/coreboot.rom
87 ## Debugging
89 The board can be debugged with EHCI debug. The EHCI debug port is the USB port on the left.
91 ## Test status
93 ### Untested
95 - NFC module
96 - Fingerprint reader
97 - Smart Card reader
99 ### Working
101 - mainboards with i3-5010U, i5-5300U CPU, 16G+8G DDR3L memory
102 - SATA and M.2 SATA disk
103 - PCIe SSD
104 - Webcam
105 - Touch screen
106 - Audio output from speaker and headphone jack
107 - Intel GbE (needs a modified refcode documented in [Blobs used in Intel Broadwell boards])
108 - WLAN
109 - WWAN
110 - SD card reader
111 - Internal LCD, DisplayPort and VGA video outputs
112 - Dock
113 - USB
114 - Keyboard and touchpad
115 - EC ACPI
116 - S3 resume
117 - TPM
118 - Arch Linux with Linux 5.11.16
119 - Broadwell MRC version 2.6.0 Build 0 and refcode from Purism Librem 13 v1
120 - Graphics initialization with libgfxinit
121 - Payload: SeaBIOS 1.16.2
122 - EC firmware: KBC Revision 96.54 from OEM firmware version 01.05
123 - Internal flashing under coreboot
125 ## Technology
127 ```{eval-rst}
128 +------------------+-----------------------------+
129 | SoC              | Intel Broadwell             |
130 +------------------+-----------------------------+
131 | EC               | SMSC MEC1324                |
132 +------------------+-----------------------------+
133 | Coprocessor      | Intel Management Engine     |
134 +------------------+-----------------------------+
137 [HP EliteBook 820 G2]: https://support.hp.com/us-en/product/HP-EliteBook-820-G2-Notebook-PC/7343192/
138 [Blobs used in Intel Broadwell boards]: ../../soc/intel/broadwell/blobs.md
139 [Maintenance and Service Guide]: http://h10032.www1.hp.com/ctg/Manual/c04775894.pdf
140 [STM32-based flash programmer]: https://github.com/dword1511/stm32-vserprog
141 [HP Sure Start]: hp_sure_start.md