[U-Boot,37/50] doc: board: Convert README.sh7753evb to reST
diff mbox series

Message ID 1563435275-22326-38-git-send-email-bmeng.cn@gmail.com
State Accepted
Commit d958ce3e25741509b2cfbc7defa5b028c71c836c
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
Convert plain text documentation to reStructuredText format and add
it to Sphinx TOC tree. No essential content change.

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

 doc/README.sh7753evb            | 67 ----------------------------------
 doc/board/renesas/sh7753evb.rst | 79 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 79 insertions(+), 67 deletions(-)
 delete mode 100644 doc/README.sh7753evb
 create mode 100644 doc/board/renesas/sh7753evb.rst

Patch
diff mbox series

diff --git a/doc/README.sh7753evb b/doc/README.sh7753evb
deleted file mode 100644
index 5fe178c..0000000
--- a/doc/README.sh7753evb
+++ /dev/null
@@ -1,67 +0,0 @@ 
-========================================
-Renesas SH7753 EVB board
-========================================
-
-This board specification:
-=========================
-
-The SH7753 EVB (board config name:sh7753evb) has the following device:
-
- - SH7753 (SH-4A)
- - DDR3-SDRAM 512MB
- - SPI ROM 8MB
- - Gigabit Ethernet controllers
- - eMMC 4GB
-
-
-Configuration for This board:
-=============================
-
-You can select the configuration as follows:
-
- - make sh7753evb_config
-
-
-This board specific command:
-============================
-
-This board has the following its specific command:
-
- - write_mac
-
-
-1. write_mac
-
-You can write MAC address to SPI ROM.
-
- Usage 1) Write MAC address
-
-   write_mac [GETHERC ch0] [GETHERC ch1]
-
-	For example)
-	 => write_mac 74:90:50:00:33:9e 74:90:50:00:33:9f
-		*) We have to input the command as a single line
-		   (without carriage return)
-		*) We have to reset after input the command.
-
- Usage 2) Show current data
-
-   write_mac
-
-	For example)
-		=> write_mac
-		GETHERC ch0 = 74:90:50:00:33:9e
-		GETHERC ch1 = 74:90:50:00:33:9f
-
-
-Update SPI ROM:
-============================
-
-1. Copy u-boot image to RAM area.
-2. Probe SPI device.
-   => sf probe 0
-   SF: Detected MX25L6405D with page size 64KiB, total 8 MiB
-3. Erase SPI ROM.
-   => sf erase 0 80000
-4. Write u-boot image to SPI ROM.
-   => sf write 0x48000000 0 80000
diff --git a/doc/board/renesas/sh7753evb.rst b/doc/board/renesas/sh7753evb.rst
new file mode 100644
index 0000000..c62a824
--- /dev/null
+++ b/doc/board/renesas/sh7753evb.rst
@@ -0,0 +1,79 @@ 
+.. SPDX-License-Identifier: GPL-2.0+
+
+SH7753 EVB board
+================
+
+This board specification
+------------------------
+
+The SH7753 EVB (board config name:sh7753evb) has the following device:
+
+ - SH7753 (SH-4A)
+ - DDR3-SDRAM 512MB
+ - SPI ROM 8MB
+ - Gigabit Ethernet controllers
+ - eMMC 4GB
+
+
+Configuration for This board
+----------------------------
+
+You can select the configuration as follows:
+
+ - make sh7753evb_config
+
+
+This board specific command
+---------------------------
+
+This board has the following its specific command:
+
+write_mac:
+  You can write MAC address to SPI ROM.
+
+Usage 1: Write MAC address
+
+.. code-block:: none
+
+   write_mac [GETHERC ch0] [GETHERC ch1]
+
+   For example:
+   => write_mac 74:90:50:00:33:9e 74:90:50:00:33:9f
+
+* We have to input the command as a single line (without carriage return)
+* We have to reset after input the command.
+
+Usage 2: Show current data
+
+.. code-block:: none
+
+   write_mac
+
+   For example:
+   => write_mac
+      GETHERC ch0 = 74:90:50:00:33:9e
+      GETHERC ch1 = 74:90:50:00:33:9f
+
+
+Update SPI ROM
+--------------
+
+1. Copy u-boot image to RAM area.
+2. Probe SPI device.
+
+.. code-block:: none
+
+   => sf probe 0
+   SF: Detected MX25L6405D with page size 64KiB, total 8 MiB
+
+3. Erase SPI ROM.
+
+.. code-block:: none
+
+   => sf erase 0 80000
+
+4. Write u-boot image to SPI ROM.
+
+.. code-block:: none
+
+   => sf write 0x48000000 0 80000