soc/intel/ptl: Update ME specification version to 21
[coreboot.git] / Documentation / mainboard / pcengines / apu2.md
blobcaa26cc3e58c29eb6c790c3a19988a2eb585c4c8
1 # PC Engines APU2
3 This page describes how to run coreboot on PC Engines APU2 platform.
5 ## Technology
7 ```{eval-rst}
8 +------------+---------------------------------------------------------------+
9 | CPU        | AMD G series GX-412TC                                         |
10 +------------+---------------------------------------------------------------+
11 | CPU core   | 1 GHz quad Puma core with 64 bit support                      |
12 |            | 32K data + 32K instruction cache per core, shared 2MB L2 cache|
13 +------------+---------------------------------------------------------------+
14 | DRAM       | 2 or 4 GB DDR3-1333 DRAM                                      |
15 +------------+---------------------------------------------------------------+
16 | Boot       | From SD card, USB, mSATA SSD, SATA                            |
17 +------------+---------------------------------------------------------------+
18 | Power      | 6 to 12W of 12V power                                         |
19 +------------+---------------------------------------------------------------+
20 | Firmware   | coreboot with support for iPXE and USB boot                   |
21 +------------+---------------------------------------------------------------+
22 ```
24 ## Required proprietary blobs
26 To build working coreboot image some blobs are needed.
28 ```{eval-rst}
29 +-----------------+---------------------------------+---------------------+
30 | Binary file     | Apply                           | Required / Optional |
31 +=================+=================================+=====================+
32 | amdfw.rom*      | AMD Platform Security Processor | Required            |
33 +-----------------+---------------------------------+---------------------+
34 | AGESA.bin       | AGESA Platform Initialization   | Required            |
35 +-----------------+---------------------------------+---------------------+
36 | xhci.bin        | AMD XHCI controller             | Optional            |
37 +-----------------+---------------------------------+---------------------+
38 ```
39 (\*) - package containing all required blobs for PSP. Directory, in which all
40 blobs are listed and available is: *3rdparty/southbridge/amd/avalon/PSP*
42 ## Flashing coreboot
44 ```{eval-rst}
45 +---------------------+--------------------------+
46 | Type                | Value                    |
47 +=====================+==========================+
48 | Socketed flash      | no                       |
49 +---------------------+--------------------------+
50 | Model               | W25Q64                   |
51 +---------------------+--------------------------+
52 | Size                | 8 MiB                    |
53 +---------------------+--------------------------+
54 | Package             | SOIC-8                   |
55 +---------------------+--------------------------+
56 | Write protection    | jumper on WP# pin*       |
57 +---------------------+--------------------------+
58 | Dual BIOS feature   | no                       |
59 +---------------------+--------------------------+
60 | Internal flashing   | yes                      |
61 +---------------------+--------------------------+
62 ```
63 (\*) - It is used in normal SPI mode, but can be dangerous when using Quad SPI
64 Flash. Then, pull-down resistors should be considered rather than jumper.
66 ### Internal programming
68 The SPI flash can be accessed using [flashrom].
70     flashrom -p internal -w coreboot.rom
72 ### External programming
74 **IMPORTANT**: When programming SPI flash, first you need to enter apu2 in S5
75 (Soft-off) power state. S5 state can be forced by shorting power button pin on
76 J2 header.
78 The external access to flash chip is available through standard SOP-8 clip or
79 SOP-8 header next to the flash chip on the board. Notice that not all boards
80 have a header soldered down originally. Hence, there could be an empty slot with
81 8 eyelets, so you can solder down a header on your own. The SPI flash chip and
82 SPI header are marked in the picture below. Also there is SPI header and SPI
83 flash pin layout included. Depend on using header or clip there are important
84 rules:
85 - using header J6 - don't connect 1,7,8 pins
86 - using clip U23 - don't connect 3,7,8 pins
88 Also signatures at the schematic can be ambiguous:
89 - J6 SPIDI = U23 SO = MISO
90 - J6 SPIDO = U23 SI = MOSI
92 There is no restrictions as to the programmer device. It is only recommended to
93 flash firmware without supplying power. External programming can be performed,
94 for example using OrangePi and Armbian. You can exploit linux_spi driver which
95 provides communication with SPI devices. Example command to program SPI flash
96 with OrangePi using linux_spi:
98     flashrom -f -w coreboot.rom -p linux_spi:dev=/dev/spidev1.0,spispeed=16000
100 **apu2 platform with marked in SPI header and SPI flash chip**
102 ![][apu2_flash]
104 **SPI header pin layout**
106 ![][spi_header]
108 ## Schematics
110 PC Engines APU2 [platform schematics](https://pcengines.ch/schema/apu2d.pdf)
111 are available for free on PC Engines official site. Both configurations
112 (2GB/4GB) have the same PCB and schematic.
114 [apu2_flash]: apu2.jpg
115 [spi_header]: apu2_spi.jpg
116 [flashrom]: https://flashrom.org/Flashrom