From: Bin Meng <bmeng.cn@gmail.com>
Date: Thu, 18 Jul 2019 07:34:09 +0000 (-0700)
Subject: doc: board: Add Intel Edison board doc
X-Git-Tag: v2019.10-rc1~16^2~26
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=225b87c26d13af3c556d12e4837d5a3863d0ff84;p=platform%2Fkernel%2Fu-boot.git

doc: board: Add Intel Edison board doc

This extracts Intel Edison 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>
Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
---

diff --git a/doc/README.x86 b/doc/README.x86
index 5e85b57..28d6ae0 100644
--- a/doc/README.x86
+++ b/doc/README.x86
@@ -47,16 +47,6 @@ on other architectures, like below:
 $ make coreboot_defconfig
 $ make all
 
-Build Instructions for U-Boot as main bootloader
-------------------------------------------------
-
-Intel Edison instructions:
-
-Simple you can build U-Boot and obtain u-boot.bin
-
-$ make edison_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
@@ -346,33 +336,6 @@ are missing in the 64-bit world. One notable feature is the VGA console
 support which is currently missing, so that you must specify '-nographic'
 to get 64-bit U-Boot up and running.
 
-Updating U-Boot on Edison
--------------------------
-By default Intel Edison boards are shipped with preinstalled heavily
-patched U-Boot v2014.04. Though it supports DFU which we may be able to
-use.
-
-1. Prepare u-boot.bin as described in chapter above. You still need one
-more step (if and only if you have original U-Boot), i.e. run the
-following command:
-
-$ truncate -s %4096 u-boot.bin
-
-2. Run your board and interrupt booting to U-Boot console. In the console
-call:
-
- => run do_force_flash_os
-
-3. Wait for few seconds, it will prepare environment variable and runs
-DFU. Run DFU command from the host system:
-
-$ dfu-util -v -d 8087:0a99 --alt u-boot0 -D u-boot.bin
-
-4. Return to U-Boot console and following hint. i.e. push Ctrl+C, and
-reset the board:
-
- => reset
-
 CPU Microcode
 -------------
 Modern CPUs usually require a special bit stream called microcode [8] to be
diff --git a/doc/board/intel/edison.rst b/doc/board/intel/edison.rst
new file mode 100644
index 0000000..1aee2a1
--- /dev/null
+++ b/doc/board/intel/edison.rst
@@ -0,0 +1,41 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
+
+Edison
+======
+
+Build Instructions for U-Boot as main bootloader
+------------------------------------------------
+
+Simple you can build U-Boot and obtain u-boot.bin::
+
+   $ make edison_defconfig
+   $ make all
+
+Updating U-Boot on Edison
+-------------------------
+
+By default Intel Edison boards are shipped with preinstalled heavily
+patched U-Boot v2014.04. Though it supports DFU which we may be able to
+use.
+
+1. Prepare u-boot.bin as described in chapter above. You still need one
+   more step (if and only if you have original U-Boot), i.e. run the
+   following command::
+
+   $ truncate -s %4096 u-boot.bin
+
+2. Run your board and interrupt booting to U-Boot console. In the console
+   call::
+
+   => run do_force_flash_os
+
+3. Wait for few seconds, it will prepare environment variable and runs
+   DFU. Run DFU command from the host system::
+
+   $ dfu-util -v -d 8087:0a99 --alt u-boot0 -D u-boot.bin
+
+4. Return to U-Boot console and following hint. i.e. push Ctrl+C, and
+   reset the board::
+
+   => reset
diff --git a/doc/board/intel/index.rst b/doc/board/intel/index.rst
index 521e6e6..482e01b 100644
--- a/doc/board/intel/index.rst
+++ b/doc/board/intel/index.rst
@@ -10,4 +10,5 @@ Intel
    cherryhill
    cougarcanyon2
    crownbay
+   edison
    minnowmax