public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Bin Meng <bmeng.cn@gmail.com>
To: u-boot@lists.denx.de
Subject: [U-Boot] [PATCH 28/50] doc: board: Add coreboot board doc
Date: Thu, 18 Jul 2019 00:34:13 -0700	[thread overview]
Message-ID: <1563435275-22326-29-git-send-email-bmeng.cn@gmail.com> (raw)
In-Reply-To: <1563435275-22326-1-git-send-email-bmeng.cn@gmail.com>

This extracts coreboot board specific information from README.x86,
converts plain text documentation to reST format and adds it to
Sphinx TOC tree. No essential content change.

Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
---

 doc/README.x86                  | 37 ------------------------------------
 doc/board/coreboot/coreboot.rst | 42 +++++++++++++++++++++++++++++++++++++++++
 doc/board/coreboot/index.rst    |  9 +++++++++
 doc/board/index.rst             |  1 +
 4 files changed, 52 insertions(+), 37 deletions(-)
 create mode 100644 doc/board/coreboot/coreboot.rst
 create mode 100644 doc/board/coreboot/index.rst

diff --git a/doc/README.x86 b/doc/README.x86
index 2374be9..c987439 100644
--- a/doc/README.x86
+++ b/doc/README.x86
@@ -39,14 +39,6 @@ Linux kernel as part of a FIT image. It also supports a compressed zImage.
 U-Boot supports loading an x86 VxWorks kernel. Please check README.vxworks
 for more details.
 
-Build Instructions for U-Boot as coreboot payload
--------------------------------------------------
-Building U-Boot as a coreboot payload is just like building U-Boot for targets
-on other architectures, like below:
-
-$ make coreboot_defconfig
-$ make all
-
 Build Instructions for U-Boot as BIOS replacement (bare mode)
 -------------------------------------------------------------
 Building a ROM version of U-Boot (hereafter referred to as u-boot.rom) is a
@@ -82,35 +74,6 @@ Device Tree Control  --->
 	...
 	(qemu-x86_q35) Default Device Tree for DT control
 
-Test with coreboot
-------------------
-For testing U-Boot as the coreboot payload, there are things that need be paid
-attention to. coreboot supports loading an ELF executable and a 32-bit plain
-binary, as well as other supported payloads. With the default configuration,
-U-Boot is set up to use a separate Device Tree Blob (dtb). As of today, the
-generated u-boot-dtb.bin needs to be packaged by the cbfstool utility (a tool
-provided by coreboot) manually as coreboot's 'make menuconfig' does not provide
-this capability yet. The command is as follows:
-
-# in the coreboot root directory
-$ ./build/util/cbfstool/cbfstool build/coreboot.rom add-flat-binary \
-  -f u-boot-dtb.bin -n fallback/payload -c lzma -l 0x1110000 -e 0x1110000
-
-Make sure 0x1110000 matches CONFIG_SYS_TEXT_BASE, which is the symbol address
-of _x86boot_start (in arch/x86/cpu/start.S).
-
-If you want to use ELF as the coreboot payload, change U-Boot configuration to
-use CONFIG_OF_EMBED instead of CONFIG_OF_SEPARATE.
-
-To enable video you must enable these options in coreboot:
-
-   - Set framebuffer graphics resolution (1280x1024 32k-color (1:5:5))
-   - Keep VESA framebuffer
-
-At present it seems that for Minnowboard Max, coreboot does not pass through
-the video information correctly (it always says the resolution is 0x0). This
-works correctly for link though.
-
 Test with QEMU for bare mode
 ----------------------------
 QEMU is a fancy emulator that can enable us to test U-Boot without access to
diff --git a/doc/board/coreboot/coreboot.rst b/doc/board/coreboot/coreboot.rst
new file mode 100644
index 0000000..fd97422
--- /dev/null
+++ b/doc/board/coreboot/coreboot.rst
@@ -0,0 +1,42 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Bin Meng <bmeng.cn@gmail.com>
+
+Coreboot
+========
+
+Build Instructions for U-Boot as coreboot payload
+-------------------------------------------------
+Building U-Boot as a coreboot payload is just like building U-Boot for targets
+on other architectures, like below::
+
+   $ make coreboot_defconfig
+   $ make all
+
+Test with coreboot
+------------------
+For testing U-Boot as the coreboot payload, there are things that need be paid
+attention to. coreboot supports loading an ELF executable and a 32-bit plain
+binary, as well as other supported payloads. With the default configuration,
+U-Boot is set up to use a separate Device Tree Blob (dtb). As of today, the
+generated u-boot-dtb.bin needs to be packaged by the cbfstool utility (a tool
+provided by coreboot) manually as coreboot's 'make menuconfig' does not provide
+this capability yet. The command is as follows::
+
+   # in the coreboot root directory
+   $ ./build/util/cbfstool/cbfstool build/coreboot.rom add-flat-binary \
+     -f u-boot-dtb.bin -n fallback/payload -c lzma -l 0x1110000 -e 0x1110000
+
+Make sure 0x1110000 matches CONFIG_SYS_TEXT_BASE, which is the symbol address
+of _x86boot_start (in arch/x86/cpu/start.S).
+
+If you want to use ELF as the coreboot payload, change U-Boot configuration to
+use CONFIG_OF_EMBED instead of CONFIG_OF_SEPARATE.
+
+To enable video you must enable these options in coreboot:
+
+   - Set framebuffer graphics resolution (1280x1024 32k-color (1:5:5))
+   - Keep VESA framebuffer
+
+At present it seems that for Minnowboard Max, coreboot does not pass through
+the video information correctly (it always says the resolution is 0x0). This
+works correctly for link though.
diff --git a/doc/board/coreboot/index.rst b/doc/board/coreboot/index.rst
new file mode 100644
index 0000000..d148db9
--- /dev/null
+++ b/doc/board/coreboot/index.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Coreboot
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   coreboot
diff --git a/doc/board/index.rst b/doc/board/index.rst
index 59f745d..eb21a67 100644
--- a/doc/board/index.rst
+++ b/doc/board/index.rst
@@ -6,5 +6,6 @@ Board-specific doc
 .. toctree::
    :maxdepth: 2
 
+   coreboot/index
    google/index
    intel/index
-- 
2.7.4

  parent reply	other threads:[~2019-07-18  7:34 UTC|newest]

Thread overview: 66+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-07-18  7:33 [U-Boot] [PATCH 00/50] doc: Shape into useful HTML docs Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 01/50] doc: Move existing rst files into api sub-directory Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 02/50] doc: Add top-level description about U-Boot documentation Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 03/50] doc: Add driver-model to Sphinx TOC tree Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 04/50] doc: driver-model: Convert README.txt to reST Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 05/50] doc: driver-model: Convert MIGRATION.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 06/50] doc: driver-model: Convert fdt-fixup.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 07/50] doc: driver-model: Convert fs_firmware_loader.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 08/50] doc: driver-model: Convert i2c-howto.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 09/50] doc: driver-model: Convert livetree.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 10/50] doc: driver-model: Convert of-plat.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 11/50] doc: driver-model: Convert pci-info.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 12/50] doc: driver-model: Convert pmic-framework.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 13/50] doc: driver-model: Convert remoteproc-framework.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 14/50] doc: driver-model: Convert serial-howto.txt " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 15/50] doc: driver-model: Convert spi-howto.txt " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 16/50] doc: driver-model: Convert usb-info.txt " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 17/50] doc: Add architecture specific info to Sphinx TOC tree Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 18/50] doc: arch: Convert README.mips to reST Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 19/50] doc: Add board specific info to Sphinx TOC tree Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 20/50] doc: board: Add Intel Crown Bay board doc Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 21/50] doc: board: Add Intel Bay Trail based board docs Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 22/50] doc: board: Add Intel Cherry Hill board doc Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 23/50] doc: board: Add Intel Cougar Canyon 2 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 24/50] doc: board: Add Intel Edison " Bin Meng
2019-07-18 18:27   ` Andy Shevchenko
2019-07-18  7:34 ` [U-Boot] [PATCH 25/50] doc: board: Add Intel Galileo " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 26/50] doc: board: Add Google Chromebook Link " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 27/50] doc: board: Add Google Chromebook Samus " Bin Meng
2019-07-18  7:34 ` Bin Meng [this message]
2019-07-18  7:34 ` [U-Boot] [PATCH 29/50] doc: board: Add QEMU x86 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 30/50] doc: board: Convert README.qemu-arm to reST Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 31/50] doc: board: Convert README.qemu-riscv " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 32/50] doc: board: Convert README.qemu-mips " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 33/50] doc: board: Add AndesTech ax25-ae350 board doc Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 34/50] doc: board: Convert README.ag101p to reST Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 35/50] doc: board: Convert README.sifive-fu540 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 36/50] doc: board: Convert README.sh7752evb " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 37/50] doc: board: Convert README.sh7753evb " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 38/50] doc: board: Convert README.at91 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 39/50] doc: board: Convert README.b4860qds " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 40/50] doc: board: Convert README.zynq " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 41/50] doc: arch: Convert README.x86 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 42/50] doc: arch: Convert README.arm64 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 43/50] doc: arch: Convert README.NDS32 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 44/50] doc: arch: Convert README.nios2 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 45/50] doc: arch: Convert README.ARC " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 46/50] doc: arch: Convert README.m68k " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 47/50] doc: arch: Convert README.sh " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 48/50] doc: arch: Convert README.sandbox " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 49/50] doc: arch: Convert README.xtensa " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 50/50] doc: Remove README.blackfin Bin Meng
2019-07-23  6:20 ` [U-Boot] [PATCH 00/50] doc: Shape into useful HTML docs Bin Meng
2019-07-23 15:00   ` Wolfgang Denk
2019-07-23 15:29     ` Tom Rini
2019-07-24  4:59       ` Bin Meng
2019-07-24  4:53     ` Bin Meng
2019-07-24  7:08       ` Wolfgang Denk
2019-07-24  7:13         ` Bin Meng
2019-07-24 14:14 ` Tom Rini
2019-07-24 14:16   ` Bin Meng
2019-07-24 14:18     ` Tom Rini
2019-07-24 19:30       ` Heinrich Schuchardt
2019-07-24 20:05 ` Tom Rini
2019-07-25 18:31 ` Heinrich Schuchardt
2019-07-26  1:54   ` Bin Meng

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1563435275-22326-29-git-send-email-bmeng.cn@gmail.com \
    --to=bmeng.cn@gmail.com \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox