[U-Boot,24/50] doc: board: Add Intel Edison board doc
diff mbox series

Message ID 1563435275-22326-25-git-send-email-bmeng.cn@gmail.com
State Accepted
Commit 225b87c26d13af3c556d12e4837d5a3863d0ff84
Delegated to: Tom Rini
Headers show
Series
  • doc: Shape into useful HTML docs
Related show

Commit Message

Bin Meng July 18, 2019, 7:34 a.m. UTC
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>
---

 doc/README.x86             | 37 -------------------------------------
 doc/board/intel/edison.rst | 41 +++++++++++++++++++++++++++++++++++++++++
 doc/board/intel/index.rst  |  1 +
 3 files changed, 42 insertions(+), 37 deletions(-)
 create mode 100644 doc/board/intel/edison.rst

Comments

Andy Shevchenko July 18, 2019, 6:27 p.m. UTC | #1
On Thu, Jul 18, 2019 at 11:00 AM Bin Meng <bmeng.cn@gmail.com> wrote:
>
> 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.
>

Thanks!
Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>

> Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
> ---
>
>  doc/README.x86             | 37 -------------------------------------
>  doc/board/intel/edison.rst | 41 +++++++++++++++++++++++++++++++++++++++++
>  doc/board/intel/index.rst  |  1 +
>  3 files changed, 42 insertions(+), 37 deletions(-)
>  create mode 100644 doc/board/intel/edison.rst
>
> 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
> --
> 2.7.4
>
> _______________________________________________
> U-Boot mailing list
> U-Boot@lists.denx.de
> https://lists.denx.de/listinfo/u-boot

Patch
diff mbox series

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