Skip to contentSkip to conversation

doc: Shape into useful HTML docs

PATCH New Bin Meng 5 participants 66 messages Jul 18, 2019 – Jul 26, 2019

Subsystems (4)
lore
Share & tools
lore

Bin Meng

author
#0 lore raw

cover doc: Shape into useful HTML docs

At present there is Sphinx doc build system in U-Boot, however the contents are very limited, e.g.: only a few API descriptions like EFI, are included.

This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree.

With this series, now we have the following major chapters in our U-Boot HTML doc:

- Driver Model
- U-Boot API documentation
- Architecture-specific doc
- Board-specific doc

Board specific documents are put in a vendor subdirectory, just like what we have in <src_tree>/board. All x86 & RISC-V board docs are converted to reST. A few other board docs are converted too.

Tested by generating the HTML docs, 0 build warnings.

This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Bin Meng (50):
doc: Move existing rst files into api sub-directory
doc: Add top-level description about U-Boot documentation
doc: Add driver-model to Sphinx TOC tree
doc: driver-model: Convert README.txt to reST
doc: driver-model: Convert MIGRATION.txt to reST
doc: driver-model: Convert fdt-fixup.txt to reST
doc: driver-model: Convert fs_firmware_loader.txt to reST
doc: driver-model: Convert i2c-howto.txt to reST
doc: driver-model: Convert livetree.txt to reST
doc: driver-model: Convert of-plat.txt to reST
doc: driver-model: Convert pci-info.txt to reST
doc: driver-model: Convert pmic-framework.txt to reST
doc: driver-model: Convert remoteproc-framework.txt to reST
doc: driver-model: Convert serial-howto.txt to reST
doc: driver-model: Convert spi-howto.txt to reST
doc: driver-model: Convert usb-info.txt to reST
doc: Add architecture specific info to Sphinx TOC tree
doc: arch: Convert README.mips to reST
doc: Add board specific info to Sphinx TOC tree
doc: board: Add Intel Crown Bay board doc
doc: board: Add Intel Bay Trail based board docs
doc: board: Add Intel Cherry Hill board doc
doc: board: Add Intel Cougar Canyon 2 board doc
doc: board: Add Intel Edison board doc
doc: board: Add Intel Galileo board doc
doc: board: Add Google Chromebook Link board doc
doc: board: Add Google Chromebook Samus board doc
doc: board: Add coreboot board doc
doc: board: Add QEMU x86 board doc
doc: board: Convert README.qemu-arm to reST
doc: board: Convert README.qemu-riscv to reST
doc: board: Convert README.qemu-mips to reST
doc: board: Add AndesTech ax25-ae350 board doc
doc: board: Convert README.ag101p to reST
doc: board: Convert README.sifive-fu540 to reST
doc: board: Convert README.sh7752evb to reST
doc: board: Convert README.sh7753evb to reST
doc: board: Convert README.at91 to reST
doc: board: Convert README.b4860qds to reST
doc: board: Convert README.zynq to reST
doc: arch: Convert README.x86 to reST
doc: arch: Convert README.arm64 to reST
doc: arch: Convert README.NDS32 to reST
doc: arch: Convert README.nios2 to reST
doc: arch: Convert README.ARC to reST
doc: arch: Convert README.m68k to reST
doc: arch: Convert README.sh to reST
doc: arch: Convert README.sandbox to reST
doc: arch: Convert README.xtensa to reST
doc: Remove README.blackfin

 doc/README.AX25                                    |  46 --
 doc/README.N1213                                   |  55 --
 doc/README.NDS32                                   |  41 --
 doc/README.ae350                                   | 275 --------
 doc/README.at91                                    | 174 -----
 doc/README.b4860qds                                | 366 ----------
 doc/README.blackfin                                |  46 --
 doc/README.m68k                                    | 150 ----
 doc/README.qemu-mips                               | 195 ------
 doc/README.sh                                      |  97 ---
 doc/README.sh7752evb                               |  67 --
 doc/README.sh7753evb                               |  67 --
 doc/README.sifive-fu540                            | 303 --------
 doc/{ => api}/efi.rst                              |   0
 doc/api/index.rst                                  |  11 +
 doc/{ => api}/linker_lists.rst                     |   0
 doc/{ => api}/serial.rst                           |   0
 doc/{README.ARC => arch/arc.rst}                   |   5 +
 doc/{README.arm64 => arch/arm64.rst}               |  25 +-
 doc/arch/index.rst                                 |  18 +
 doc/arch/m68k.rst                                  | 170 +++++
 doc/{README.mips => arch/mips.rst}                 |  28 +-
 doc/arch/nds32.rst                                 | 101 +++
 doc/{README.nios2 => arch/nios2.rst}               |  86 ++-
 .../sandbox/README.sandbox => doc/arch/sandbox.rst | 251 +++----
 doc/arch/sh.rst                                    | 106 +++
 doc/{README.x86 => arch/x86.rst}                   | 766 ++++-----------------
 doc/{README.xtensa => arch/xtensa.rst}             |  24 +-
 .../AndesTech/adp-ag101p.rst}                      |  26 +-
 doc/board/AndesTech/ax25-ae350.rst                 | 329 +++++++++
 doc/board/atmel/at91ek.rst                         | 192 ++++++
 doc/board/coreboot/coreboot.rst                    |  42 ++
 doc/board/coreboot/index.rst                       |   9 +
 doc/board/emulation/index.rst                      |  12 +
 .../emulation/qemu-arm.rst}                        |  44 +-
 doc/board/emulation/qemu-mips.rst                  | 234 +++++++
 .../emulation/qemu-riscv.rst}                      |  21 +-
 doc/board/emulation/qemu-x86.rst                   | 101 +++
 doc/board/freescale/b4860qds.rst                   | 453 ++++++++++++
 doc/board/google/chromebook_link.rst               |  34 +
 doc/board/google/chromebook_samus.rst              | 101 +++
 doc/board/google/index.rst                         |  10 +
 doc/board/index.rst                                |  18 +
 doc/board/intel/bayleybay.rst                      |  29 +
 doc/board/intel/cherryhill.rst                     |  30 +
 doc/board/intel/cougarcanyon2.rst                  |  24 +
 doc/board/intel/crownbay.rst                       |  43 ++
 doc/board/intel/edison.rst                         |  41 ++
 doc/board/intel/galileo.rst                        |  22 +
 doc/board/intel/index.rst                          |  15 +
 doc/board/intel/minnowmax.rst                      |  70 ++
 doc/board/renesas/sh7752evb.rst                    |  79 +++
 doc/board/renesas/sh7753evb.rst                    |  79 +++
 doc/board/sifive/fu540.rst                         | 321 +++++++++
 doc/{README.zynq => board/xilinx/zynq.rst}         |  82 ++-
 doc/driver-model/{README.txt => design.rst}        | 589 ++++++++--------
 doc/driver-model/{fdt-fixup.txt => fdt-fixup.rst}  |  56 +-
 doc/driver-model/fs_firmware_loader.rst            | 154 +++++
 doc/driver-model/fs_firmware_loader.txt            | 148 ----
 doc/driver-model/{i2c-howto.txt => i2c-howto.rst}  |  36 +-
 doc/driver-model/index.rst                         |  21 +
 doc/driver-model/{livetree.txt => livetree.rst}    |  94 +--
 doc/driver-model/{MIGRATION.txt => migration.rst}  |  44 +-
 doc/driver-model/{of-plat.txt => of-plat.rst}      | 193 +++---
 doc/driver-model/{pci-info.txt => pci-info.rst}    |  21 +-
 .../{pmic-framework.txt => pmic-framework.rst}     | 131 ++--
 ...proc-framework.txt => remoteproc-framework.rst} | 181 ++---
 .../{serial-howto.txt => serial-howto.rst}         |  12 +-
 doc/driver-model/spi-howto.rst                     | 692 +++++++++++++++++++
 doc/driver-model/spi-howto.txt                     | 623 -----------------
 doc/driver-model/{usb-info.txt => usb-info.rst}    | 184 ++---
 doc/index.rst                                      |  69 +-
 72 files changed, 4903 insertions(+), 4279 deletions(-)
 delete mode 100644 doc/README.AX25
 delete mode 100644 doc/README.N1213
 delete mode 100644 doc/README.NDS32
 delete mode 100644 doc/README.ae350
 delete mode 100644 doc/README.at91
 delete mode 100644 doc/README.b4860qds
 delete mode 100644 doc/README.blackfin
 delete mode 100644 doc/README.m68k
 delete mode 100644 doc/README.qemu-mips
 delete mode 100644 doc/README.sh
 delete mode 100644 doc/README.sh7752evb
 delete mode 100644 doc/README.sh7753evb
 delete mode 100644 doc/README.sifive-fu540
 rename doc/{ => api}/efi.rst (100%)
 create mode 100644 doc/api/index.rst
 rename doc/{ => api}/linker_lists.rst (100%)
 rename doc/{ => api}/serial.rst (100%)
 rename doc/{README.ARC => arch/arc.rst} (96%)
 rename doc/{README.arm64 => arch/arm64.rst} (83%)
 create mode 100644 doc/arch/index.rst
 create mode 100644 doc/arch/m68k.rst
 rename doc/{README.mips => arch/mips.rst} (74%)
 create mode 100644 doc/arch/nds32.rst
 rename doc/{README.nios2 => arch/nios2.rst} (51%)
 rename board/sandbox/README.sandbox => doc/arch/sandbox.rst (76%)
 create mode 100644 doc/arch/sh.rst
 rename doc/{README.x86 => arch/x86.rst} (51%)
 rename doc/{README.xtensa => arch/xtensa.rst} (90%)
 rename doc/{README.ag101p => board/AndesTech/adp-ag101p.rst} (83%)
 create mode 100644 doc/board/AndesTech/ax25-ae350.rst
 create mode 100644 doc/board/atmel/at91ek.rst
 create mode 100644 doc/board/coreboot/coreboot.rst
 create mode 100644 doc/board/coreboot/index.rst
 create mode 100644 doc/board/emulation/index.rst
 rename doc/{README.qemu-arm => board/emulation/qemu-arm.rst} (80%)
 create mode 100644 doc/board/emulation/qemu-mips.rst
 rename doc/{README.qemu-riscv => board/emulation/qemu-riscv.rst} (82%)
 create mode 100644 doc/board/emulation/qemu-x86.rst
 create mode 100644 doc/board/freescale/b4860qds.rst
 create mode 100644 doc/board/google/chromebook_link.rst
 create mode 100644 doc/board/google/chromebook_samus.rst
 create mode 100644 doc/board/google/index.rst
 create mode 100644 doc/board/index.rst
 create mode 100644 doc/board/intel/bayleybay.rst
 create mode 100644 doc/board/intel/cherryhill.rst
 create mode 100644 doc/board/intel/cougarcanyon2.rst
 create mode 100644 doc/board/intel/crownbay.rst
 create mode 100644 doc/board/intel/edison.rst
 create mode 100644 doc/board/intel/galileo.rst
 create mode 100644 doc/board/intel/index.rst
 create mode 100644 doc/board/intel/minnowmax.rst
 create mode 100644 doc/board/renesas/sh7752evb.rst
 create mode 100644 doc/board/renesas/sh7753evb.rst
 create mode 100644 doc/board/sifive/fu540.rst
 rename doc/{README.zynq => board/xilinx/zynq.rst} (53%)
 rename doc/driver-model/{README.txt => design.rst} (64%)
 rename doc/driver-model/{fdt-fixup.txt => fdt-fixup.rst} (89%)
 create mode 100644 doc/driver-model/fs_firmware_loader.rst
 delete mode 100644 doc/driver-model/fs_firmware_loader.txt
 rename doc/driver-model/{i2c-howto.txt => i2c-howto.rst} (82%)
 create mode 100644 doc/driver-model/index.rst
 rename doc/driver-model/{livetree.txt => livetree.rst} (77%)
 rename doc/driver-model/{MIGRATION.txt => migration.rst} (84%)
 rename doc/driver-model/{of-plat.txt => of-plat.rst} (65%)
 rename doc/driver-model/{pci-info.txt => pci-info.rst} (95%)
 rename doc/driver-model/{pmic-framework.txt => pmic-framework.rst} (51%)
 rename doc/driver-model/{remoteproc-framework.txt => remoteproc-framework.rst} (50%)
 rename doc/driver-model/{serial-howto.txt => serial-howto.rst} (92%)
 create mode 100644 doc/driver-model/spi-howto.rst
 delete mode 100644 doc/driver-model/spi-howto.txt
 rename doc/driver-model/{usb-info.txt => usb-info.rst} (77%)
Signature · 1 line
2.7.4
author
#1 lore raw

PATCH 1/50 doc: Move existing rst files into api sub-directory

Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory.

---

 doc/{ => api}/efi.rst          |  0
 doc/api/index.rst              | 11 +++++++++++
 doc/{ => api}/linker_lists.rst |  0
 doc/{ => api}/serial.rst       |  0
 doc/index.rst                  | 14 +++++++++++---
 5 files changed, 22 insertions(+), 3 deletions(-)
 rename doc/{ => api}/efi.rst (100%)
 create mode 100644 doc/api/index.rst
 rename doc/{ => api}/linker_lists.rst (100%)
 rename doc/{ => api}/serial.rst (100%)
doc/api/efi.rst renamed from doc/efi.rst +0 -0
similarity index 100%
rename from doc/efi.rst
rename to doc/api/efi.rst
doc/api/index.rst new file +11 -0
new file mode 100644
index 0000000..d484c06
@@ -0,0 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+U-Boot API documentation
+========================
+
+.. toctree::
+   :maxdepth: 2
+
+   efi
+   linker_lists
+   serial
doc/api/linker_lists.rst renamed from doc/linker_lists.rst +0 -0
similarity index 100%
rename from doc/linker_lists.rst
rename to doc/api/linker_lists.rst
doc/api/serial.rst renamed from doc/serial.rst +0 -0
similarity index 100%
rename from doc/serial.rst
rename to doc/api/serial.rst
doc/index.rst +11 -3
index 0353c10..1946d09 100644
@@ -4,8 +4,16 @@
 U-Boot Developer Manual
 #######################
 
+U-Boot API documentation
+------------------------
+
+These books get into the details of how specific U-Boot subsystems work
+from the point of view of a U-Boot developer.  Much of the information here
+is taken directly from the U-Boot source, with supplemental material added
+as needed (or at least as we managed to add it - probably *not* all that is
+needed).
+
 .. toctree::
+   :maxdepth: 2
 
-   efi
-   linker_lists
-   serial
+   api/index
Signature · 1 line
2.7.4
author
#2 lore raw

PATCH 2/50 doc: Add top-level description about U-Boot documentation

In reply to Bin Meng

This updates the index.rst to add top-level description about U-Boot documentation. Words are taken from Linux kernel docs and modified for U-Boot.

---

 doc/index.rst | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)
doc/index.rst +19 -3
index 1946d09..3500e68 100644
@@ -1,8 +1,19 @@
 .. SPDX-License-Identifier: GPL-2.0+
 
-#######################
-U-Boot Developer Manual
-#######################
+.. _u-boot_doc:
+
+The U-Boot Documentation
+========================
+
+This is the top level of the U-Boot's documentation tree.  U-Boot
+documentation, like the U-Boot itself, is very much a work in progress;
+that is especially true as we work to integrate our many scattered
+documents into a coherent whole.  Please note that improvements to the
+documentation are welcome; join the U-Boot list at http://lists.denx.de
+if you want to help out.
+
+.. toctree::
+   :maxdepth: 2
 
 U-Boot API documentation
 ------------------------
@@ -17,3 +28,8 @@ needed).
    :maxdepth: 2
 
    api/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
Signature · 1 line
2.7.4
author
#3 lore raw

PATCH 3/50 doc: Add driver-model to Sphinx TOC tree

In reply to Bin Meng

Add index.rst for driver model. More docs will be added later.

---

 doc/driver-model/index.rst |  7 +++++++
 doc/index.rst              | 11 +++++++++++
 2 files changed, 18 insertions(+)
 create mode 100644 doc/driver-model/index.rst
doc/driver-model/index.rst new file +7 -0
new file mode 100644
index 0000000..0f74619
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Driver Model
+============
+
+.. toctree::
+   :maxdepth: 2
doc/index.rst +11 -0
index 3500e68..bc2f06a 100644
@@ -15,6 +15,17 @@ if you want to help out.
 .. toctree::
    :maxdepth: 2
 
+Driver-Model documentation
+--------------------------
+The following holds information on the U-Boot device driver framework:
+driver-model, including the design details of itself and several driver
+subsystems.
+
+.. toctree::
+   :maxdepth: 2
+
+   driver-model/index
+
 U-Boot API documentation
 ------------------------
 
Signature · 1 line
2.7.4
author
#4 lore raw

PATCH 4/50 doc: driver-model: Convert README.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/{README.txt => design.rst} | 589 +++++++++++++++-------------
 doc/driver-model/index.rst                  |   2 +
 2 files changed, 309 insertions(+), 282 deletions(-)
 rename doc/driver-model/{README.txt => design.rst} (64%)
doc/driver-model/design.rst renamed from doc/driver-model/README.txt +307 -282
similarity index 64%
rename from doc/driver-model/README.txt
rename to doc/driver-model/design.rst
index 532a771..8fd28c0 100644
@@ -1,40 +1,46 @@
-Driver Model
-============
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Simon Glass <[email protected]>
+
+Design Details
+==============
 
 This README contains high-level information about driver model, a unified
 way of declaring and accessing drivers in U-Boot. The original work was done
 by:
 
-   Marek Vasut <[email protected]>
-   Pavel Herrmann <[email protected]>
-   Viktor Křivák <[email protected]>
-   Tomas Hlavacek <[email protected]>
+   * Marek Vasut <[email protected]>
+   * Pavel Herrmann <[email protected]>
+   * Viktor Křivák <[email protected]>
+   * Tomas Hlavacek <[email protected]>
 
 This has been both simplified and extended into the current implementation
 by:
 
-   Simon Glass <[email protected]>
+   * Simon Glass <[email protected]>
 
 
 Terminology
 -----------
 
-Uclass - a group of devices which operate in the same way. A uclass provides
-	a way of accessing individual devices within the group, but always
-	using the same interface. For example a GPIO uclass provides
-	operations for get/set value. An I2C uclass may have 10 I2C ports,
-	4 with one driver, and 6 with another.
+Uclass
+  a group of devices which operate in the same way. A uclass provides
+  a way of accessing individual devices within the group, but always
+  using the same interface. For example a GPIO uclass provides
+  operations for get/set value. An I2C uclass may have 10 I2C ports,
+  4 with one driver, and 6 with another.
 
-Driver - some code which talks to a peripheral and presents a higher-level
-	interface to it.
+Driver
+  some code which talks to a peripheral and presents a higher-level
+  interface to it.
 
-Device - an instance of a driver, tied to a particular port or peripheral.
+Device
+  an instance of a driver, tied to a particular port or peripheral.
 
 
 How to try it
 -------------
 
-Build U-Boot sandbox and run it:
+Build U-Boot sandbox and run it::
 
    make sandbox_defconfig
    make
@@ -56,31 +62,31 @@ provide good code coverage of them. It does have multiple drivers, it
 handles parameter data and platdata (data which tells the driver how
 to operate on a particular platform) and it uses private driver data.
 
-To try it, see the example session below:
-
-=>demo hello 1
-Hello '@' from 07981110: red 4
-=>demo status 2
-Status: 0
-=>demo hello 2
-g
-r@
-e@@
-e@@@
-n@@@@
-g@@@@@
-=>demo status 2
-Status: 21
-=>demo hello 4 ^
-  y^^^
- e^^^^^
-l^^^^^^^
-l^^^^^^^
- o^^^^^
-  w^^^
-=>demo status 4
-Status: 36
-=>
+To try it, see the example session below::
+
+   =>demo hello 1
+   Hello '@' from 07981110: red 4
+   =>demo status 2
+   Status: 0
+   =>demo hello 2
+   g
+   r@
+   e@@
+   e@@@
+   n@@@@
+   g@@@@@
+   =>demo status 2
+   Status: 21
+   =>demo hello 4 ^
+     y^^^
+    e^^^^^
+   l^^^^^^^
+   l^^^^^^^
+    o^^^^^
+     w^^^
+   =>demo status 4
+   Status: 36
+   =>
 
 
 Running the tests
@@ -88,139 +94,139 @@ Running the tests
 
 The intent with driver model is that the core portion has 100% test coverage
 in sandbox, and every uclass has its own test. As a move towards this, tests
-are provided in test/dm. To run them, try:
+are provided in test/dm. To run them, try::
 
    ./test/py/test.py --bd sandbox --build -k ut_dm -v
 
-You should see something like this:
-
-(venv)$ ./test/py/test.py --bd sandbox --build -k ut_dm -v
-+make O=/root/u-boot/build-sandbox -s sandbox_defconfig
-+make O=/root/u-boot/build-sandbox -s -j8
-============================= test session starts ==============================
-platform linux2 -- Python 2.7.5, pytest-2.9.0, py-1.4.31, pluggy-0.3.1 -- /root/u-boot/venv/bin/python
-cachedir: .cache
-rootdir: /root/u-boot, inifile:
-collected 199 items
-
-test/py/tests/test_ut.py::test_ut_dm_init PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_adc_bind] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_adc_multi_channel_conversion] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_adc_multi_channel_shot] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_adc_single_channel_conversion] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_adc_single_channel_shot] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_adc_supply] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_adc_wrong_channel_selection] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_autobind] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_autobind_uclass_pdata_alloc] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_autobind_uclass_pdata_valid] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_autoprobe] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_child_post_bind] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_child_post_bind_uclass] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_child_pre_probe_uclass] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_children] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_children_funcs] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_children_iterators] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_data] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_data_uclass] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_ops] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_platdata] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_platdata_uclass] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_children] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_clk_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_clk_periph] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_device_get_uclass_id] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_eth] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_eth_act] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_eth_alias] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_eth_prime] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_eth_rotate] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_fdt] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_fdt_offset] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_fdt_pre_reloc] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_fdt_uclass_seq] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_gpio] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_gpio_anon] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_gpio_copy] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_gpio_leak] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_gpio_phandles] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_gpio_requestf] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_i2c_bytewise] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_i2c_find] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_i2c_offset] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_i2c_offset_len] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_i2c_probe_empty] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_i2c_read_write] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_i2c_speed] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_leak] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_led_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_led_gpio] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_led_label] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_lifecycle] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_mmc_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_net_retry] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_operations] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_ordering] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_pci_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_pci_busnum] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_pci_swapcase] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_platdata] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_power_pmic_get] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_power_pmic_io] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_autoset] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_autoset_list] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_get] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_set_get_current] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_set_get_enable] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_set_get_mode] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_set_get_voltage] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_pre_reloc] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_ram_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_regmap_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_regmap_syscon] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_remoteproc_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_remove] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_reset_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_reset_walk] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_rtc_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_rtc_dual] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_rtc_reset] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_rtc_set_get] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_spi_find] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_spi_flash] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_spi_xfer] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_syscon_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_syscon_by_driver_data] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_timer_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_uclass] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_uclass_before_ready] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_uclass_devices_find] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_uclass_devices_find_by_name] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_uclass_devices_get] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_uclass_devices_get_by_name] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_usb_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_usb_flash] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_usb_keyb] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_usb_multi] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_usb_remove] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_usb_tree] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_usb_tree_remove] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_usb_tree_reorder] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_base] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_bmp] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_bmp_comp] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_chars] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_context] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_rotation1] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_rotation2] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_rotation3] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_text] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_truetype] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_truetype_bs] PASSED
-test/py/tests/test_ut.py::test_ut[ut_dm_video_truetype_scroll] PASSED
-
-======================= 84 tests deselected by '-kut_dm' =======================
-================== 115 passed, 84 deselected in 3.77 seconds ===================
+You should see something like this::
+
+   (venv)$ ./test/py/test.py --bd sandbox --build -k ut_dm -v
+   +make O=/root/u-boot/build-sandbox -s sandbox_defconfig
+   +make O=/root/u-boot/build-sandbox -s -j8
+   ============================= test session starts ==============================
+   platform linux2 -- Python 2.7.5, pytest-2.9.0, py-1.4.31, pluggy-0.3.1 -- /root/u-boot/venv/bin/python
+   cachedir: .cache
+   rootdir: /root/u-boot, inifile:
+   collected 199 items
+
+   test/py/tests/test_ut.py::test_ut_dm_init PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_adc_bind] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_adc_multi_channel_conversion] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_adc_multi_channel_shot] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_adc_single_channel_conversion] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_adc_single_channel_shot] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_adc_supply] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_adc_wrong_channel_selection] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_autobind] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_autobind_uclass_pdata_alloc] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_autobind_uclass_pdata_valid] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_autoprobe] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_child_post_bind] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_child_post_bind_uclass] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_child_pre_probe_uclass] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_children] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_children_funcs] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_children_iterators] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_data] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_data_uclass] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_ops] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_platdata] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_bus_parent_platdata_uclass] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_children] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_clk_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_clk_periph] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_device_get_uclass_id] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_eth] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_eth_act] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_eth_alias] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_eth_prime] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_eth_rotate] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_fdt] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_fdt_offset] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_fdt_pre_reloc] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_fdt_uclass_seq] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_gpio] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_gpio_anon] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_gpio_copy] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_gpio_leak] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_gpio_phandles] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_gpio_requestf] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_i2c_bytewise] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_i2c_find] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_i2c_offset] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_i2c_offset_len] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_i2c_probe_empty] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_i2c_read_write] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_i2c_speed] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_leak] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_led_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_led_gpio] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_led_label] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_lifecycle] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_mmc_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_net_retry] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_operations] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_ordering] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_pci_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_pci_busnum] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_pci_swapcase] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_platdata] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_power_pmic_get] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_power_pmic_io] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_autoset] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_autoset_list] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_get] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_set_get_current] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_set_get_enable] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_set_get_mode] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_power_regulator_set_get_voltage] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_pre_reloc] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_ram_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_regmap_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_regmap_syscon] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_remoteproc_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_remove] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_reset_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_reset_walk] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_rtc_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_rtc_dual] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_rtc_reset] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_rtc_set_get] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_spi_find] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_spi_flash] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_spi_xfer] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_syscon_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_syscon_by_driver_data] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_timer_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_uclass] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_uclass_before_ready] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_uclass_devices_find] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_uclass_devices_find_by_name] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_uclass_devices_get] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_uclass_devices_get_by_name] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_usb_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_usb_flash] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_usb_keyb] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_usb_multi] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_usb_remove] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_usb_tree] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_usb_tree_remove] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_usb_tree_reorder] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_base] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_bmp] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_bmp_comp] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_chars] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_context] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_rotation1] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_rotation2] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_rotation3] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_text] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_truetype] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_truetype_bs] PASSED
+   test/py/tests/test_ut.py::test_ut[ut_dm_video_truetype_scroll] PASSED
+
+   ======================= 84 tests deselected by '-kut_dm' =======================
+   ================== 115 passed, 84 deselected in 3.77 seconds ===================
 
 What is going on?
 -----------------
@@ -228,6 +234,8 @@ What is going on?
 Let's start at the top. The demo command is in common/cmd_demo.c. It does
 the usual command processing and then:
 
+.. code-block:: c
+
 	struct udevice *demo_dev;
 
 	ret = uclass_get_device(UCLASS_DEMO, devnum, &demo_dev);
@@ -245,6 +253,8 @@ The device is automatically activated ready for use by uclass_get_device().
 
 Now that we have the device we can do things like:
 
+.. code-block:: c
+
 	return demo_hello(demo_dev, ch);
 
 This function is in the demo uclass. It takes care of calling the 'hello'
@@ -253,28 +263,32 @@ this particular device may use one or other of them.
 
 The code for demo_hello() is in drivers/demo/demo-uclass.c:
 
-int demo_hello(struct udevice *dev, int ch)
-{
-	const struct demo_ops *ops = device_get_ops(dev);
+.. code-block:: c
 
-	if (!ops->hello)
-		return -ENOSYS;
+	int demo_hello(struct udevice *dev, int ch)
+	{
+		const struct demo_ops *ops = device_get_ops(dev);
 
-	return ops->hello(dev, ch);
-}
+		if (!ops->hello)
+			return -ENOSYS;
+
+		return ops->hello(dev, ch);
+	}
 
 As you can see it just calls the relevant driver method. One of these is
 in drivers/demo/demo-simple.c:
 
-static int simple_hello(struct udevice *dev, int ch)
-{
-	const struct dm_demo_pdata *pdata = dev_get_platdata(dev);
+.. code-block:: c
+
+	static int simple_hello(struct udevice *dev, int ch)
+	{
+		const struct dm_demo_pdata *pdata = dev_get_platdata(dev);
 
-	printf("Hello from %08x: %s %d\n", map_to_sysmem(dev),
-	       pdata->colour, pdata->sides);
+		printf("Hello from %08x: %s %d\n", map_to_sysmem(dev),
+		       pdata->colour, pdata->sides);
 
-	return 0;
-}
+		return 0;
+	}
 
 
 So that is a trip from top (command execution) to bottom (driver action)
@@ -287,17 +301,19 @@ Declaring Drivers
 A driver declaration looks something like this (see
 drivers/demo/demo-shape.c):
 
-static const struct demo_ops shape_ops = {
-	.hello = shape_hello,
-	.status = shape_status,
-};
+.. code-block:: c
 
-U_BOOT_DRIVER(demo_shape_drv) = {
-	.name	= "demo_shape_drv",
-	.id	= UCLASS_DEMO,
-	.ops	= &shape_ops,
-	.priv_data_size = sizeof(struct shape_data),
-};
+	static const struct demo_ops shape_ops = {
+		.hello = shape_hello,
+		.status = shape_status,
+	};
+
+	U_BOOT_DRIVER(demo_shape_drv) = {
+		.name	= "demo_shape_drv",
+		.id	= UCLASS_DEMO,
+		.ops	= &shape_ops,
+		.priv_data_size = sizeof(struct shape_data),
+	};
 
 
 This driver has two methods (hello and status) and requires a bit of
@@ -315,11 +331,11 @@ so driver model can find the drivers that are available.
 The methods a device can provide are documented in the device.h header.
 Briefly, they are:
 
-    bind - make the driver model aware of a device (bind it to its driver)
-    unbind - make the driver model forget the device
-    ofdata_to_platdata - convert device tree data to platdata - see later
-    probe - make a device ready for use
-    remove - remove a device so it cannot be used until probed again
+   * bind - make the driver model aware of a device (bind it to its driver)
+   * unbind - make the driver model forget the device
+   * ofdata_to_platdata - convert device tree data to platdata - see later
+   * probe - make a device ready for use
+   * remove - remove a device so it cannot be used until probed again
 
 The sequence to get a device to work is bind, ofdata_to_platdata (if using
 device tree) and probe.
@@ -328,14 +344,14 @@ device tree) and probe.
 Platform Data
 -------------
 
-*** Note: platform data is the old way of doing things. It is
-*** basically a C structure which is passed to drivers to tell them about
-*** platform-specific settings like the address of its registers, bus
-*** speed, etc. Device tree is now the preferred way of handling this.
-*** Unless you have a good reason not to use device tree (the main one
-*** being you need serial support in SPL and don't have enough SRAM for
-*** the cut-down device tree and libfdt libraries) you should stay away
-*** from platform data.
+Note: platform data is the old way of doing things. It is
+basically a C structure which is passed to drivers to tell them about
+platform-specific settings like the address of its registers, bus
+speed, etc. Device tree is now the preferred way of handling this.
+Unless you have a good reason not to use device tree (the main one
+being you need serial support in SPL and don't have enough SRAM for
+the cut-down device tree and libfdt libraries) you should stay away
+from platform data.
 
 Platform data is like Linux platform data, if you are familiar with that.
 It provides the board-specific information to start up a device.
@@ -366,9 +382,9 @@ Examples of platform data include:
 
    - The base address of the IP block's register space
    - Configuration options, like:
-         - the SPI polarity and maximum speed for a SPI controller
-         - the I2C speed to use for an I2C device
-         - the number of GPIOs available in a GPIO device
+      - the SPI polarity and maximum speed for a SPI controller
+      - the I2C speed to use for an I2C device
+      - the number of GPIOs available in a GPIO device
 
 Where does the platform data come from? It is either held in a structure
 which is compiled into U-Boot, or it can be parsed from the Device Tree
@@ -384,10 +400,13 @@ Drivers can access their data via dev->info->platdata. Here is
 the declaration for the platform data, which would normally appear
 in the board file.
 
+.. code-block:: c
+
 	static const struct dm_demo_cdata red_square = {
 		.colour = "red",
 		.sides = 4.
 	};
+
 	static const struct driver_info info[] = {
 		{
 			.name = "demo_shape_drv",
@@ -409,6 +428,8 @@ necessary.
 With device tree we replace the above code with the following device tree
 fragment:
 
+.. code-block:: c
+
 	red-square {
 		compatible = "demo-shape";
 		colour = "red";
@@ -425,6 +446,8 @@ the board first!).
 
 The easiest way to make this work it to add a few members to the driver:
 
+.. code-block:: c
+
 	.platdata_auto_alloc_size = sizeof(struct dm_test_pdata),
 	.ofdata_to_platdata = testfdt_ofdata_to_platdata,
 
@@ -464,9 +487,11 @@ Declaring Uclasses
 
 The demo uclass is declared like this:
 
-U_BOOT_CLASS(demo) = {
-	.id		= UCLASS_DEMO,
-};
+.. code-block:: c
+
+	U_BOOT_CLASS(demo) = {
+		.id		= UCLASS_DEMO,
+	};
 
 It is also possible to specify special methods for probe, etc. The uclass
 numbering comes from include/dm/uclass.h. To add a new uclass, add to the
@@ -496,9 +521,11 @@ device will be automatically allocated the next available sequence number.
 To specify the sequence number in the device tree an alias is typically
 used. Make sure that the uclass has the DM_UC_FLAG_SEQ_ALIAS flag set.
 
-aliases {
-	serial2 = "/serial at 22230000";
-};
+.. code-block:: none
+
+	aliases {
+		serial2 = "/serial at 22230000";
+	};
 
 This indicates that in the uclass called "serial", the named node
 ("/serial at 22230000") will be given sequence number 2. Any command or driver
@@ -506,13 +533,15 @@ which requests serial device 2 will obtain this device.
 
 More commonly you can use node references, which expand to the full path:
 
-aliases {
-	serial2 = &serial_2;
-};
-...
-serial_2: serial at 22230000 {
-...
-};
+.. code-block:: none
+
+	aliases {
+		serial2 = &serial_2;
+	};
+	...
+	serial_2: serial at 22230000 {
+	...
+	};
 
 The alias resolves to the same string in this case, but this version is
 easier to read.
@@ -547,7 +576,7 @@ children are bound and probed.
 
 Here an explanation of how a bus fits with a uclass may be useful. Consider
 a USB bus with several devices attached to it, each from a different (made
-up) uclass:
+up) uclass::
 
    xhci_usb (UCLASS_USB)
       eth (UCLASS_ETHERNET)
@@ -579,7 +608,7 @@ Note that the information that controls this behaviour is in the bus's
 driver, not the child's. In fact it is possible that child has no knowledge
 that it is connected to a bus. The same child device may even be used on two
 different bus types. As an example. the 'flash' device shown above may also
-be connected on a SATA bus or standalone with no bus:
+be connected on a SATA bus or standalone with no bus::
 
    xhci_usb (UCLASS_USB)
       flash (UCLASS_FLASH_STORAGE)  - parent data/methods defined by USB bus
@@ -613,20 +642,21 @@ methods mentioned here are optional - e.g. if there is no probe() method for
 a device then it will not be called. A simple device may have very few
 methods actually defined.
 
-1. Bind stage
+Bind stage
+^^^^^^^^^^
 
 U-Boot discovers devices using one of these two methods:
 
-   - Scan the U_BOOT_DEVICE() definitions. U-Boot looks up the name specified
-by each, to find the appropriate U_BOOT_DRIVER() definition. In this case,
-there is no path by which driver_data may be provided, but the U_BOOT_DEVICE()
-may provide platdata.
+- Scan the U_BOOT_DEVICE() definitions. U-Boot looks up the name specified
+  by each, to find the appropriate U_BOOT_DRIVER() definition. In this case,
+  there is no path by which driver_data may be provided, but the U_BOOT_DEVICE()
+  may provide platdata.
 
-   - Scan through the device tree definitions. U-Boot looks at top-level
-nodes in the the device tree. It looks at the compatible string in each node
-and uses the of_match table of the U_BOOT_DRIVER() structure to find the
-right driver for each node. In this case, the of_match table may provide a
-driver_data value, but platdata cannot be provided until later.
+- Scan through the device tree definitions. U-Boot looks at top-level
+  nodes in the the device tree. It looks at the compatible string in each node
+  and uses the of_match table of the U_BOOT_DRIVER() structure to find the
+  right driver for each node. In this case, the of_match table may provide a
+  driver_data value, but platdata cannot be provided until later.
 
 For each device that is discovered, U-Boot then calls device_bind() to create a
 new device, initializes various core fields of the device object such as name,
@@ -653,45 +683,46 @@ probe/remove which is independent of bind/unbind. This is partly because in
 U-Boot it may be expensive to probe devices and we don't want to do it until
 they are needed, or perhaps until after relocation.
 
-2. Activation/probe
+Activation/probe
+^^^^^^^^^^^^^^^^
 
 When a device needs to be used, U-Boot activates it, by following these
 steps (see device_probe()):
 
-   a. If priv_auto_alloc_size is non-zero, then the device-private space
+   1. If priv_auto_alloc_size is non-zero, then the device-private space
    is allocated for the device and zeroed. It will be accessible as
    dev->priv. The driver can put anything it likes in there, but should use
    it for run-time information, not platform data (which should be static
    and known before the device is probed).
 
-   b. If platdata_auto_alloc_size is non-zero, then the platform data space
+   2. If platdata_auto_alloc_size is non-zero, then the platform data space
    is allocated. This is only useful for device tree operation, since
    otherwise you would have to specific the platform data in the
    U_BOOT_DEVICE() declaration. The space is allocated for the device and
    zeroed. It will be accessible as dev->platdata.
 
-   c. If the device's uclass specifies a non-zero per_device_auto_alloc_size,
+   3. If the device's uclass specifies a non-zero per_device_auto_alloc_size,
    then this space is allocated and zeroed also. It is allocated for and
    stored in the device, but it is uclass data. owned by the uclass driver.
    It is possible for the device to access it.
 
-   d. If the device's immediate parent specifies a per_child_auto_alloc_size
+   4. If the device's immediate parent specifies a per_child_auto_alloc_size
    then this space is allocated. This is intended for use by the parent
    device to keep track of things related to the child. For example a USB
    flash stick attached to a USB host controller would likely use this
    space. The controller can hold information about the USB state of each
    of its children.
 
-   e. All parent devices are probed. It is not possible to activate a device
+   5. All parent devices are probed. It is not possible to activate a device
    unless its predecessors (all the way up to the root device) are activated.
    This means (for example) that an I2C driver will require that its bus
    be activated.
 
-   f. The device's sequence number is assigned, either the requested one
+   6. The device's sequence number is assigned, either the requested one
    (assuming no conflicts) or the next available one if there is a conflict
    or nothing particular is requested.
 
-   g. If the driver provides an ofdata_to_platdata() method, then this is
+   7. If the driver provides an ofdata_to_platdata() method, then this is
    called to convert the device tree data into platform data. This should
    do various calls like fdtdec_get_int(gd->fdt_blob, dev_of_offset(dev), ...)
    to access the node and store the resulting information into dev->platdata.
@@ -707,7 +738,7 @@ steps (see device_probe()):
    data, one day it is possible that U-Boot will cache platform data for
    devices which are regularly de/activated).
 
-   h. The device's probe() method is called. This should do anything that
+   8. The device's probe() method is called. This should do anything that
    is required by the device to get it going. This could include checking
    that the hardware is actually present, setting up clocks for the
    hardware and setting up hardware registers to initial values. The code
@@ -722,40 +753,42 @@ steps (see device_probe()):
    allocate the priv space here yourself. The same applies also to
    platdata_auto_alloc_size. Remember to free them in the remove() method.
 
-   i. The device is marked 'activated'
+   9. The device is marked 'activated'
 
-   j. The uclass's post_probe() method is called, if one exists. This may
+   10. The uclass's post_probe() method is called, if one exists. This may
    cause the uclass to do some housekeeping to record the device as
    activated and 'known' by the uclass.
 
-3. Running stage
+Running stage
+^^^^^^^^^^^^^
 
 The device is now activated and can be used. From now until it is removed
 all of the above structures are accessible. The device appears in the
 uclass's list of devices (so if the device is in UCLASS_GPIO it will appear
 as a device in the GPIO uclass). This is the 'running' state of the device.
 
-4. Removal stage
+Removal stage
+^^^^^^^^^^^^^
 
 When the device is no-longer required, you can call device_remove() to
 remove it. This performs the probe steps in reverse:
 
-   a. The uclass's pre_remove() method is called, if one exists. This may
+   1. The uclass's pre_remove() method is called, if one exists. This may
    cause the uclass to do some housekeeping to record the device as
    deactivated and no-longer 'known' by the uclass.
 
-   b. All the device's children are removed. It is not permitted to have
+   2. All the device's children are removed. It is not permitted to have
    an active child device with a non-active parent. This means that
    device_remove() is called for all the children recursively at this point.
 
-   c. The device's remove() method is called. At this stage nothing has been
+   3. The device's remove() method is called. At this stage nothing has been
    deallocated so platform data, private data and the uclass data will all
    still be present. This is where the hardware can be shut down. It is
    intended that the device be completely inactive at this point, For U-Boot
    to be sure that no hardware is running, it should be enough to remove
    all devices.
 
-   d. The device memory is freed (platform data, private data, uclass data,
+   4. The device memory is freed (platform data, private data, uclass data,
    parent data).
 
    Note: Because the platform data for a U_BOOT_DEVICE() is defined with a
@@ -764,25 +797,26 @@ remove it. This performs the probe steps in reverse:
    be dynamically allocated, and thus needs to be deallocated during the
    remove() method, either:
 
-      1. if the platdata_auto_alloc_size is non-zero, the deallocation
-      happens automatically within the driver model core; or
+      - if the platdata_auto_alloc_size is non-zero, the deallocation
+        happens automatically within the driver model core; or
 
-      2. when platdata_auto_alloc_size is 0, both the allocation (in probe()
-      or preferably ofdata_to_platdata()) and the deallocation in remove()
-      are the responsibility of the driver author.
+      - when platdata_auto_alloc_size is 0, both the allocation (in probe()
+        or preferably ofdata_to_platdata()) and the deallocation in remove()
+        are the responsibility of the driver author.
 
-   e. The device sequence number is set to -1, meaning that it no longer
+   5. The device sequence number is set to -1, meaning that it no longer
    has an allocated sequence. If the device is later reactivated and that
    sequence number is still free, it may well receive the name sequence
    number again. But from this point, the sequence number previously used
    by this device will no longer exist (think of SPI bus 2 being removed
    and bus 2 is no longer available for use).
 
-   f. The device is marked inactive. Note that it is still bound, so the
+   6. The device is marked inactive. Note that it is still bound, so the
    device structure itself is not freed at this point. Should the device be
    activated again, then the cycle starts again at step 2 above.
 
-5. Unbind stage
+Unbind stage
+^^^^^^^^^^^^
 
 The device is unbound. This is the step that actually destroys the device.
 If a parent has children these will be destroyed first. After this point
@@ -805,24 +839,24 @@ For the record, this implementation uses a very similar approach to the
 original patches, but makes at least the following changes:
 
 - Tried to aggressively remove boilerplate, so that for most drivers there
-is little or no 'driver model' code to write.
+  is little or no 'driver model' code to write.
 - Moved some data from code into data structure - e.g. store a pointer to
-the driver operations structure in the driver, rather than passing it
-to the driver bind function.
+  the driver operations structure in the driver, rather than passing it
+  to the driver bind function.
 - Rename some structures to make them more similar to Linux (struct udevice
-instead of struct instance, struct platdata, etc.)
+  instead of struct instance, struct platdata, etc.)
 - Change the name 'core' to 'uclass', meaning U-Boot class. It seems that
-this concept relates to a class of drivers (or a subsystem). We shouldn't
-use 'class' since it is a C++ reserved word, so U-Boot class (uclass) seems
-better than 'core'.
+  this concept relates to a class of drivers (or a subsystem). We shouldn't
+  use 'class' since it is a C++ reserved word, so U-Boot class (uclass) seems
+  better than 'core'.
 - Remove 'struct driver_instance' and just use a single 'struct udevice'.
-This removes a level of indirection that doesn't seem necessary.
+  This removes a level of indirection that doesn't seem necessary.
 - Built in device tree support, to avoid the need for platdata
 - Removed the concept of driver relocation, and just make it possible for
-the new driver (created after relocation) to access the old driver data.
-I feel that relocation is a very special case and will only apply to a few
-drivers, many of which can/will just re-init anyway. So the overhead of
-dealing with this might not be worth it.
+  the new driver (created after relocation) to access the old driver data.
+  I feel that relocation is a very special case and will only apply to a few
+  drivers, many of which can/will just re-init anyway. So the overhead of
+  dealing with this might not be worth it.
 - Implemented a GPIO system, trying to keep it simple
 
 
@@ -903,12 +937,3 @@ change this to dynamic numbering, but then we would require some sort of
 lookup service, perhaps searching by name. This is slightly less efficient
 so has been left out for now. One small advantage of dynamic numbering might
 be fewer merge conflicts in uclass-id.h.
-
-
-Simon Glass
-sjg at chromium.org
-April 2013
-Updated 7-May-13
-Updated 14-Jun-13
-Updated 18-Oct-13
-Updated 5-Nov-13
doc/driver-model/index.rst +2 -0
index 0f74619..96fbd72 100644
@@ -5,3 +5,5 @@ Driver Model
 
 .. toctree::
    :maxdepth: 2
+
+   design
Signature · 1 line
2.7.4
author
#5 lore raw

PATCH 5/50 doc: driver-model: Convert MIGRATION.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/index.rst                        |  1 +
 doc/driver-model/{MIGRATION.txt => migration.rst} | 44 +++++++++++------------
 2 files changed, 22 insertions(+), 23 deletions(-)
 rename doc/driver-model/{MIGRATION.txt => migration.rst} (84%)
doc/driver-model/index.rst +1 -0
index 96fbd72..663aa5d 100644
@@ -7,3 +7,4 @@ Driver Model
    :maxdepth: 2
 
    design
+   migration
doc/driver-model/migration.rst renamed from doc/driver-model/MIGRATION.txt +21 -23

95 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#6 lore raw

PATCH 6/50 doc: driver-model: Convert fdt-fixup.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/{fdt-fixup.txt => fdt-fixup.rst} | 56 +++++++++++------------
 doc/driver-model/index.rst                        |  1 +
 2 files changed, 29 insertions(+), 28 deletions(-)
 rename doc/driver-model/{fdt-fixup.txt => fdt-fixup.rst} (89%)
doc/driver-model/fdt-fixup.rst renamed from doc/driver-model/fdt-fixup.txt +28 -28
similarity index 89%
rename from doc/driver-model/fdt-fixup.txt
rename to doc/driver-model/fdt-fixup.rst
index 70344bd..974c090 100644
@@ -1,15 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. 2017-01-06, Mario Six <[email protected]>
+
 Pre-relocation device tree manipulation
 =======================================
 
-Contents:
-
-1. Purpose
-2. Implementation
-3. Example
-4. Work to be done
-
-1. Purpose
-----------
+Purpose
+-------
 
 In certain markets, it is beneficial for manufacturers of embedded devices to
 offer certain ranges of products, where the functionality of the devices within
@@ -61,14 +57,16 @@ we have the pre-relocation driver model at our disposal at this stage, which
 means that we can query the hardware for the existence and variety of the
 components easily.
 
-2. Implementation
------------------
+Implementation
+--------------
 
 To take advantage of the pre-relocation device tree manipulation mechanism,
 boards have to implement the function board_fix_fdt, which has the following
 signature:
 
-int board_fix_fdt (void *rw_fdt_blob)
+.. code-block:: c
+
+   int board_fix_fdt (void *rw_fdt_blob)
 
 The passed-in void pointer is a writeable pointer to the device tree, which can
 be used to manipulate the device tree using e.g. functions from
@@ -79,10 +77,10 @@ unrecoverably halt the boot process, as with any function from init_sequence_f
 (in common/board_f.c).
 
 Furthermore, the Kconfig option OF_BOARD_FIXUP has to be set for the function
-to be called:
+to be called::
 
-Device Tree Control
--> [*] Board-specific manipulation of Device Tree
+   Device Tree Control
+   -> [*] Board-specific manipulation of Device Tree
 
 +----------------------------------------------------------+
 | WARNING: The actual manipulation of the device tree has  |
@@ -97,23 +95,27 @@ Device Tree Control
 Hence, the recommended layout of the board_fixup_fdt call-back function is the
 following:
 
-int board_fix_fdt(void *rw_fdt_blob)
-{
-	/* Collect information about device's hardware and store them in e.g.
-	   local variables */
+.. code-block:: c
+
+	int board_fix_fdt(void *rw_fdt_blob)
+	{
+		/*
+		 * Collect information about device's hardware and store
+		 * them in e.g. local variables
+		 */
 
-	/* Do device tree manipulation using the values previously collected */
+		/* Do device tree manipulation using the values previously collected */
 
-	/* Return 0 on successful manipulation and non-zero otherwise */
-}
+		/* Return 0 on successful manipulation and non-zero otherwise */
+	}
 
 If this convention is kept, both an "additive" approach, meaning that nodes for
 detected components are added to the device tree, as well as a "subtractive"
 approach, meaning that nodes for absent components are removed from the tree,
 as well as a combination of both approaches should work.
 
-3. Example
-----------
+Example
+-------
 
 The controlcenterdc board (board/gdsys/a38x/controlcenterdc.c) features a
 board_fix_fdt function, in which six GPIO expanders (which might be present or
@@ -123,10 +125,8 @@ subsequently deactivated in the device tree if they are not present.
 Note that the dm_i2c_simple_probe function does not use the device tree, hence
 it is safe to call it after the tree has already been manipulated.
 
-4. Work to be done
-------------------
+Work to be done
+---------------
 
 * The application of device tree overlay should be possible in board_fixup_fdt,
   but has not been tested at this stage.
-
-2017-01-06, Mario Six <[email protected]>
doc/driver-model/index.rst +1 -0
index 663aa5d..71ad062 100644
@@ -7,4 +7,5 @@ Driver Model
    :maxdepth: 2
 
    design
+   fdt-fixup
    migration
Signature · 1 line
2.7.4
author
#7 lore raw

PATCH 7/50 doc: driver-model: Convert fs_firmware_loader.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/fs_firmware_loader.rst | 154 ++++++++++++++++++++++++++++++++
 doc/driver-model/fs_firmware_loader.txt | 148 ------------------------------
 doc/driver-model/index.rst              |   1 +
 3 files changed, 155 insertions(+), 148 deletions(-)
 create mode 100644 doc/driver-model/fs_firmware_loader.rst
 delete mode 100644 doc/driver-model/fs_firmware_loader.txt
doc/driver-model/fs_firmware_loader.rst new file +154 -0
new file mode 100644
index 0000000..a44708c
@@ -0,0 +1,154 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. Copyright (C) 2018-2019 Intel Corporation <www.intel.com>
+
+File System Firmware Loader
+===========================
+
+This is file system firmware loader for U-Boot framework, which has very close
+to some Linux Firmware API. For the details of Linux Firmware API, you can refer
+to https://01.org/linuxgraphics/gfx-docs/drm/driver-api/firmware/index.html.
+
+File system firmware loader can be used to load whatever(firmware, image,
+and binary) from the storage device in file system format into target location
+such as memory, then consumer driver such as FPGA driver can program FPGA image
+from the target location into FPGA.
+
+To enable firmware loader, CONFIG_FS_LOADER need to be set at
+<board_name>_defconfig such as "CONFIG_FS_LOADER=y".
+
+Firmware Loader API core features
+---------------------------------
+
+Firmware storage device described in device tree source
+-------------------------------------------------------
+For passing data like storage device phandle and partition where the
+firmware loading from to the firmware loader driver, those data could be
+defined in fs-loader node as shown in below:
+
+Example for block device::
+
+	fs_loader0: fs-loader {
+		u-boot,dm-pre-reloc;
+		compatible = "u-boot,fs-loader";
+		phandlepart = <&mmc 1>;
+	};
+
+<&mmc 1> means block storage device pointer and its partition.
+
+Above example is a description for block storage, but for UBI storage
+device, it can be described in FDT as shown in below:
+
+Example for ubi::
+
+	fs_loader1: fs-loader {
+		u-boot,dm-pre-reloc;
+		compatible = "u-boot,fs-loader";
+		mtdpart = "UBI",
+		ubivol = "ubi0";
+	};
+
+Then, firmware-loader property can be added with any device node, which
+driver would use the firmware loader for loading.
+
+The value of the firmware-loader property should be set with phandle
+of the fs-loader node. For example::
+
+	firmware-loader = <&fs_loader0>;
+
+If there are majority of devices using the same fs-loader node, then
+firmware-loader property can be added under /chosen node instead of
+adding to each of device node.
+
+For example::
+
+	/{
+		chosen {
+			firmware-loader = <&fs_loader0>;
+		};
+	};
+
+In each respective driver of devices using firmware loader, the firmware
+loaded instance	should be created by DT phandle.
+
+For example of getting DT phandle from /chosen and creating instance:
+
+.. code-block:: c
+
+	chosen_node = ofnode_path("/chosen");
+	if (!ofnode_valid(chosen_node)) {
+		debug("/chosen node was not found.\n");
+		return -ENOENT;
+	}
+
+	phandle_p = ofnode_get_property(chosen_node, "firmware-loader", &size);
+	if (!phandle_p) {
+		debug("firmware-loader property was not found.\n");
+		return -ENOENT;
+	}
+
+	phandle = fdt32_to_cpu(*phandle_p);
+	ret = uclass_get_device_by_phandle_id(UCLASS_FS_FIRMWARE_LOADER,
+					     phandle, &dev);
+	if (ret)
+		return ret;
+
+Firmware loader driver is also designed to support U-boot environment
+variables, so all these data from FDT can be overwritten
+through the U-boot environment variable during run time.
+
+For examples:
+
+storage_interface:
+  Storage interface, it can be "mmc", "usb", "sata" or "ubi".
+fw_dev_part:
+  Block device number and its partition, it can be "0:1".
+fw_ubi_mtdpart:
+  UBI device mtd partition, it can be "UBI".
+fw_ubi_volume:
+  UBI volume, it can be "ubi0".
+
+When above environment variables are set, environment values would be
+used instead of data from FDT.
+The benefit of this design allows user to change storage attribute data
+at run time through U-boot console and saving the setting as default
+environment values in the storage for the next power cycle, so no
+compilation is required for both driver and FDT.
+
+File system firmware Loader API
+-------------------------------
+
+.. code-block:: c
+
+	int request_firmware_into_buf(struct udevice *dev,
+				      const char *name,
+				      void *buf, size_t size, u32 offset)
+
+Load firmware into a previously allocated buffer
+
+Parameters:
+
+* struct udevice \*dev: An instance of a driver
+* const char \*name: name of firmware file
+* void \*buf: address of buffer to load firmware into
+* size_t size: size of buffer
+* u32 offset: offset of a file for start reading into buffer
+
+Returns:
+	size of total read
+	-ve when error
+
+Description:
+	The firmware is loaded directly into the buffer pointed to by buf
+
+Example of calling request_firmware_into_buf API after creating firmware loader
+instance:
+
+.. code-block:: c
+
+	ret = uclass_get_device_by_phandle_id(UCLASS_FS_FIRMWARE_LOADER,
+					     phandle, &dev);
+	if (ret)
+		return ret;
+
+	request_firmware_into_buf(dev, filename, buffer_location, buffer_size,
+				 offset_ofreading);
doc/driver-model/fs_firmware_loader.txt deleted +0 -148

148 lines not on this page · raw message

doc/driver-model/index.rst +1 -0
index 71ad062..6b8f181 100644
@@ -8,4 +8,5 @@ Driver Model
 
    design
    fdt-fixup
+   fs_firmware_loader
    migration
Signature · 1 line
2.7.4
author
#8 lore raw

PATCH 8/50 doc: driver-model: Convert i2c-howto.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/{i2c-howto.txt => i2c-howto.rst} | 36 ++++++++++++-----------
 doc/driver-model/index.rst                        |  1 +
 2 files changed, 20 insertions(+), 17 deletions(-)
 rename doc/driver-model/{i2c-howto.txt => i2c-howto.rst} (82%)
doc/driver-model/i2c-howto.rst renamed from doc/driver-model/i2c-howto.txt +19 -17
similarity index 82%
rename from doc/driver-model/i2c-howto.txt
rename to doc/driver-model/i2c-howto.rst
index 8ba2f6e..938b707 100644
@@ -1,21 +1,23 @@
-How to port a serial driver to driver model
-===========================================
+.. SPDX-License-Identifier: GPL-2.0+
+
+How to port an I2C driver to driver model
+=========================================
 
 Over half of the I2C drivers have been converted as at November 2016. These
 ones remain:
 
-   adi_i2c
-   davinci_i2c
-   fti2c010
-   ihs_i2c
-   kona_i2c
-   lpc32xx_i2c
-   pca9564_i2c
-   ppc4xx_i2c
-   rcar_i2c
-   sh_i2c
-   soft_i2c
-   zynq_i2c
+   * adi_i2c
+   * davinci_i2c
+   * fti2c010
+   * ihs_i2c
+   * kona_i2c
+   * lpc32xx_i2c
+   * pca9564_i2c
+   * ppc4xx_i2c
+   * rcar_i2c
+   * sh_i2c
+   * soft_i2c
+   * zynq_i2c
 
 The deadline for this work is the end of June 2017. If no one steps
 forward to convert these, at some point there may come a patch to remove them!
@@ -27,14 +29,14 @@ model. Please feel free to update this file with your ideas and suggestions.
 - Define CONFIG_DM_I2C for your board, vendor or architecture
 - If the board does not already use driver model, you need CONFIG_DM also
 - Your board should then build, but will not work fully since there will be
-    no I2C driver
+  no I2C driver
 - Add the U_BOOT_DRIVER piece at the end (e.g. copy tegra_i2c.c for example)
 - Add a private struct for the driver data - avoid using static variables
 - Implement each of the driver methods, perhaps by calling your old methods
 - You may need to adjust the function parameters so that the old and new
-    implementations can share most of the existing code
+  implementations can share most of the existing code
 - If you convert all existing users of the driver, remove the pre-driver-model
-    code
+  code
 
 In terms of patches a conversion series typically has these patches:
 - clean up / prepare the driver for conversion
doc/driver-model/index.rst +1 -0
index 6b8f181..ce857a3 100644
@@ -9,4 +9,5 @@ Driver Model
    design
    fdt-fixup
    fs_firmware_loader
+   i2c-howto
    migration
Signature · 1 line
2.7.4
author
#9 lore raw

PATCH 9/50 doc: driver-model: Convert livetree.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/index.rst                      |  1 +
 doc/driver-model/{livetree.txt => livetree.rst} | 94 ++++++++++++++-----------
 2 files changed, 55 insertions(+), 40 deletions(-)
 rename doc/driver-model/{livetree.txt => livetree.rst} (77%)
doc/driver-model/index.rst +1 -0
index ce857a3..ff9b183 100644
@@ -10,4 +10,5 @@ Driver Model
    fdt-fixup
    fs_firmware_loader
    i2c-howto
+   livetree
    migration
doc/driver-model/livetree.rst renamed from doc/driver-model/livetree.txt +54 -40

186 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#10 lore raw

PATCH 10/50 doc: driver-model: Convert of-plat.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/index.rst                    |   1 +
 doc/driver-model/{of-plat.txt => of-plat.rst} | 193 ++++++++++++++------------
 2 files changed, 106 insertions(+), 88 deletions(-)
 rename doc/driver-model/{of-plat.txt => of-plat.rst} (65%)
doc/driver-model/index.rst +1 -0
index ff9b183..d1c19a4 100644
@@ -12,3 +12,4 @@ Driver Model
    i2c-howto
    livetree
    migration
+   of-plat
doc/driver-model/of-plat.rst renamed from doc/driver-model/of-plat.txt +105 -88

253 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#11 lore raw

PATCH 11/50 doc: driver-model: Convert pci-info.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/index.rst                      |  1 +
 doc/driver-model/{pci-info.txt => pci-info.rst} | 21 ++++++++++++---------
 2 files changed, 13 insertions(+), 9 deletions(-)
 rename doc/driver-model/{pci-info.txt => pci-info.rst} (95%)
doc/driver-model/index.rst +1 -0
index d1c19a4..a83c648 100644
@@ -13,3 +13,4 @@ Driver Model
    livetree
    migration
    of-plat
+   pci-info
doc/driver-model/pci-info.rst renamed from doc/driver-model/pci-info.txt +12 -9
similarity index 95%
rename from doc/driver-model/pci-info.txt
rename to doc/driver-model/pci-info.rst
index 14364c5..d93ab8b 100644
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
 PCI with Driver Model
 =====================
 
@@ -7,8 +9,7 @@ How busses are scanned
 Any config read will end up at pci_read_config(). This uses
 uclass_get_device_by_seq() to get the PCI bus for a particular bus number.
 Bus number 0 will need to be requested first, and the alias in the device
-tree file will point to the correct device:
-
+tree file will point to the correct device::
 
 	aliases {
 		pci0 = &pci;
@@ -45,7 +46,7 @@ present, matching on it takes precedence over PCI IDs and PCI classes.
 Note we must describe PCI devices with the same bus hierarchy as the
 hardware, otherwise driver model cannot detect the correct parent/children
 relationship during PCI bus enumeration thus PCI devices won't be bound to
-their drivers accordingly. A working example like below:
+their drivers accordingly. A working example like below::
 
 	pci {
 		#address-cells = <3>;
@@ -113,7 +114,7 @@ Sandbox
 
 With sandbox we need a device emulator for each device on the bus since there
 is no real PCI bus. This works by looking in the device tree node for a
-driver. For example:
+driver. For example::
 
 
 	pci at 1f,0 {
@@ -129,11 +130,11 @@ Note that the first cell in the 'reg' value is the bus/device/function. See
 PCI_BDF() for the encoding (it is also specified in the IEEE Std 1275-1994
 PCI bus binding document, v2.1)
 
-When this bus is scanned we will end up with something like this:
+When this bus is scanned we will end up with something like this::
 
-`- * pci-controller @ 05c660c8, 0
- `-   pci at 1f,0 @ 05c661c8, 63488
-  `-   emul at 1f,0 @ 05c662c8
+   `- * pci-controller @ 05c660c8, 0
+    `-   pci at 1f,0 @ 05c661c8, 63488
+     `-   emul at 1f,0 @ 05c662c8
 
 When accesses go to the pci at 1f,0 device they are forwarded to its child, the
 emulator.
@@ -144,6 +145,8 @@ eliminating the need to provide any device tree node under the host controller
 node. It is required a "sandbox,dev-info" property must be provided in the
 host controller node for this functionality to work.
 
+.. code-block:: none
+
 	pci1: pci-controller1 {
 		compatible = "sandbox,pci";
 		...
@@ -156,7 +159,7 @@ Each dynamic PCI device is encoded as 4 cells a group. The first and second
 cells are PCI device number and function number respectively. The third and
 fourth cells are PCI vendor ID and device ID respectively.
 
-When this bus is scanned we will end up with something like this:
+When this bus is scanned we will end up with something like this::
 
  pci        [ + ]   pci_sandbo  |-- pci-controller1
  pci_emul   [   ]   sandbox_sw  |   |-- sandbox_swap_case_emul
Signature · 1 line
2.7.4
author
#12 lore raw

PATCH 12/50 doc: driver-model: Convert pmic-framework.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/index.rst                         |   1 +
 .../{pmic-framework.txt => pmic-framework.rst}     | 131 +++++++++++----------
 2 files changed, 68 insertions(+), 64 deletions(-)
 rename doc/driver-model/{pmic-framework.txt => pmic-framework.rst} (51%)
doc/driver-model/index.rst +1 -0
index a83c648..fd33215 100644
@@ -14,3 +14,4 @@ Driver Model
    migration
    of-plat
    pci-info
+   pmic-framework
doc/driver-model/pmic-framework.rst renamed from doc/driver-model/pmic-framework.txt +67 -64

176 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#13 lore raw

PATCH 13/50 doc: driver-model: Convert remoteproc-framework.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/index.rst                         |   1 +
 ...proc-framework.txt => remoteproc-framework.rst} | 181 +++++++++++----------
 2 files changed, 92 insertions(+), 90 deletions(-)
 rename doc/driver-model/{remoteproc-framework.txt => remoteproc-framework.rst} (50%)
doc/driver-model/index.rst +1 -0
index fd33215..c6353dc 100644
@@ -15,3 +15,4 @@ Driver Model
    of-plat
    pci-info
    pmic-framework
+   remoteproc-framework
doc/driver-model/remoteproc-framework.rst renamed from doc/driver-model/remoteproc-framework.txt +91 -90

230 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#14 lore raw

PATCH 14/50 doc: driver-model: Convert serial-howto.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/index.rst                              |  1 +
 doc/driver-model/{serial-howto.txt => serial-howto.rst} | 12 +++++++-----
 2 files changed, 8 insertions(+), 5 deletions(-)
 rename doc/driver-model/{serial-howto.txt => serial-howto.rst} (92%)
doc/driver-model/index.rst +1 -0
index c6353dc..82f4393 100644
@@ -16,3 +16,4 @@ Driver Model
    pci-info
    pmic-framework
    remoteproc-framework
+   serial-howto
doc/driver-model/serial-howto.rst renamed from doc/driver-model/serial-howto.txt +7 -5
similarity index 92%
rename from doc/driver-model/serial-howto.txt
rename to doc/driver-model/serial-howto.rst
index a0df9a7..1469131 100644
@@ -1,11 +1,13 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
 How to port a serial driver to driver model
 ===========================================
 
 Almost all of the serial drivers have been converted as at January 2016. These
 ones remain:
 
-   serial_bfin.c
-   serial_pxa.c
+   * serial_bfin.c
+   * serial_pxa.c
 
 The deadline for this work was the end of January 2016. If no one steps
 forward to convert these, at some point there may come a patch to remove them!
@@ -17,14 +19,14 @@ model. Please feel free to update this file with your ideas and suggestions.
 - Define CONFIG_DM_SERIAL for your board, vendor or architecture
 - If the board does not already use driver model, you need CONFIG_DM also
 - Your board should then build, but will not boot since there will be no serial
-    driver
+  driver
 - Add the U_BOOT_DRIVER piece at the end (e.g. copy serial_s5p.c for example)
 - Add a private struct for the driver data - avoid using static variables
 - Implement each of the driver methods, perhaps by calling your old methods
 - You may need to adjust the function parameters so that the old and new
-    implementations can share most of the existing code
+  implementations can share most of the existing code
 - If you convert all existing users of the driver, remove the pre-driver-model
-    code
+  code
 
 In terms of patches a conversion series typically has these patches:
 - clean up / prepare the driver for conversion
Signature · 1 line
2.7.4
author
#15 lore raw

PATCH 15/50 doc: driver-model: Convert spi-howto.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/index.rst     |   1 +
 doc/driver-model/spi-howto.rst | 692 +++++++++++++++++++++++++++++++++++++++++
 doc/driver-model/spi-howto.txt | 623 -------------------------------------
 3 files changed, 693 insertions(+), 623 deletions(-)
 create mode 100644 doc/driver-model/spi-howto.rst
 delete mode 100644 doc/driver-model/spi-howto.txt
doc/driver-model/index.rst +1 -0
index 82f4393..64151bd 100644
@@ -17,3 +17,4 @@ Driver Model
    pmic-framework
    remoteproc-framework
    serial-howto
+   spi-howto
doc/driver-model/spi-howto.rst new file +692 -0

692 lines not on this page · raw message

doc/driver-model/spi-howto.txt deleted +0 -623

623 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#16 lore raw

PATCH 16/50 doc: driver-model: Convert usb-info.txt to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/driver-model/index.rst                      |   1 +
 doc/driver-model/{usb-info.txt => usb-info.rst} | 184 ++++++++++++------------
 2 files changed, 97 insertions(+), 88 deletions(-)
 rename doc/driver-model/{usb-info.txt => usb-info.rst} (77%)
doc/driver-model/index.rst +1 -0
index 64151bd..ea32c36 100644
@@ -18,3 +18,4 @@ Driver Model
    remoteproc-framework
    serial-howto
    spi-howto
+   usb-info
doc/driver-model/usb-info.rst renamed from doc/driver-model/usb-info.txt +96 -88

290 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#17 lore raw

PATCH 17/50 doc: Add architecture specific info to Sphinx TOC tree

In reply to Bin Meng

Add index.rst for architecture specific info. More docs will be added later.

---

 doc/arch/index.rst |  7 +++++++
 doc/index.rst      | 11 +++++++++++
 2 files changed, 18 insertions(+)
 create mode 100644 doc/arch/index.rst
doc/arch/index.rst new file +7 -0
new file mode 100644
index 0000000..a03ee6b
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Architecture-specific doc
+=========================
+
+.. toctree::
+   :maxdepth: 2
doc/index.rst +11 -0
index bc2f06a..6d42d94 100644
@@ -40,6 +40,17 @@ needed).
 
    api/index
 
+Architecture-specific doc
+-------------------------
+
+These books provide programming details about architecture-specific
+implementation.
+
+.. toctree::
+   :maxdepth: 2
+
+   arch/index
+
 Indices and tables
 ==================
 
Signature · 1 line
2.7.4
author
#18 lore raw

PATCH 18/50 doc: arch: Convert README.mips to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/arch/index.rst                 |  2 ++
 doc/{README.mips => arch/mips.rst} | 28 ++++++++++------------------
 2 files changed, 12 insertions(+), 18 deletions(-)
 rename doc/{README.mips => arch/mips.rst} (74%)
doc/arch/index.rst +2 -0
index a03ee6b..1aeb7a1 100644
@@ -5,3 +5,5 @@ Architecture-specific doc
 
 .. toctree::
    :maxdepth: 2
+
+   mips
doc/arch/mips.rst renamed from doc/README.mips +10 -18
similarity index 74%
rename from doc/README.mips
rename to doc/arch/mips.rst
index b28f628..b816608 100644
@@ -1,17 +1,16 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+MIPS
+====
 
 Notes for the MIPS architecture port of U-Boot
 
 Toolchains
 ----------
 
-  http://www.denx.de/wiki/DULG/ELDK
-  ELDK < DULG < DENX
-
-  http://www.emdebian.org/crosstools.html
-  Embedded Debian -- Cross-development toolchains
-
-  http://buildroot.uclibc.org/
-  Buildroot
+  * `ELDK < DULG < DENX <http://www.denx.de/wiki/DULG/ELDK>`_
+  * `Embedded Debian -- Cross-development toolchains <http://www.emdebian.org/crosstools.html>`_
+  * `Buildroot <http://buildroot.uclibc.org/>`_
 
 Known Issues
 ------------
@@ -24,9 +23,9 @@ Known Issues
     re-initializes the cache. The more common uImage 'bootm' command does
     not suffer this problem.
 
-    [workaround] To avoid this cache incoherency,
-    1) insert flush_cache(all) before calling dcache_disable(), or
-    2) fix dcache_disable() to do both flushing and disabling cache.
+    [workaround] To avoid this cache incoherency:
+       - insert flush_cache(all) before calling dcache_disable(), or
+       - fix dcache_disable() to do both flushing and disabling cache.
 
   * Note that Linux users need to kill dcache_disable() in do_bootelf_exec()
     or override do_bootelf_exec() not to disable I-/D-caches, because most
@@ -36,19 +35,12 @@ TODOs
 -----
 
   * Probe CPU types, I-/D-cache and TLB size etc. automatically
-
   * Secondary cache support missing
-
   * Initialize TLB entries redardless of their use
-
   * R2000/R3000 class parts are not supported
-
   * Limited testing across different MIPS variants
-
   * Due to cache initialization issues, the DRAM on board must be
     initialized in board specific assembler language before the cache init
     code is run -- that is, initialize the DRAM in lowlevel_init().
-
   * centralize/share more CPU code of MIPS32, MIPS64 and XBurst
-
   * support Qemu Malta
Signature · 1 line
2.7.4
author
#19 lore raw

PATCH 19/50 doc: Add board specific info to Sphinx TOC tree

In reply to Bin Meng

Add index.rst for board. More docs will be added later.

---

 doc/board/index.rst |  7 +++++++
 doc/index.rst       | 11 +++++++++++
 2 files changed, 18 insertions(+)
 create mode 100644 doc/board/index.rst
doc/board/index.rst new file +7 -0
new file mode 100644
index 0000000..b47f672
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Board-specific doc
+==================
+
+.. toctree::
+   :maxdepth: 2
doc/index.rst +11 -0
index 6d42d94..9ae2e16 100644
@@ -51,6 +51,17 @@ implementation.
 
    arch/index
 
+Board-specific doc
+------------------
+
+These books provide details about board-specific information. They are
+organized in a vendor subdirectory.
+
+.. toctree::
+   :maxdepth: 2
+
+   board/index
+
 Indices and tables
 ==================
 
Signature · 1 line
2.7.4
author
#20 lore raw

PATCH 20/50 doc: board: Add Intel Crown Bay board doc

In reply to Bin Meng

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

---

 doc/README.x86               | 37 -------------------------------------
 doc/board/index.rst          |  2 ++
 doc/board/intel/crownbay.rst | 43 +++++++++++++++++++++++++++++++++++++++++++
 doc/board/intel/index.rst    |  9 +++++++++
 4 files changed, 54 insertions(+), 37 deletions(-)
 create mode 100644 doc/board/intel/crownbay.rst
 create mode 100644 doc/board/intel/index.rst
doc/README.x86 +0 -37
index 8e0a3f3..8077ff3 100644
@@ -203,43 +203,6 @@ Flash map for samus / broadwell:
 
 ---
 
-Intel Crown Bay specific instructions for bare mode:
-
-U-Boot support of Intel Crown Bay board [4] relies on a binary blob called
-Firmware Support Package [5] to perform all the necessary initialization steps
-as documented in the BIOS Writer Guide, including initialization of the CPU,
-memory controller, chipset and certain bus interfaces.
-
-Download the Intel FSP for Atom E6xx series and Platform Controller Hub EG20T,
-install it on your host and locate the FSP binary blob. Note this platform
-also requires a Chipset Micro Code (CMC) state machine binary to be present in
-the SPI flash where u-boot.rom resides, and this CMC binary blob can be found
-in this FSP package too.
-
-* ./FSP/QUEENSBAY_FSP_GOLD_001_20-DECEMBER-2013.fd
-* ./Microcode/C0_22211.BIN
-
-Rename the first one to fsp.bin and second one to cmc.bin and put them in the
-board directory.
-
-Note the FSP release version 001 has a bug which could cause random endless
-loop during the FspInit call. This bug was published by Intel although Intel
-did not describe any details. We need manually apply the patch to the FSP
-binary using any hex editor (eg: bvi). Go to the offset 0x1fcd8 of the FSP
-binary, change the following five bytes values from orginally E8 42 FF FF FF
-to B8 00 80 0B 00.
-
-As for the video ROM, you need manually extract it from the Intel provided
-BIOS for Crown Bay here [6], using the AMI MMTool [7]. Check PCI option ROM
-ID 8086:4108, extract and save it as vga.bin in the board directory.
-
-Now you can build U-Boot and obtain u-boot.rom
-
-$ make crownbay_defconfig
-$ make all
-
----
-
 Intel Cougar Canyon 2 specific instructions for bare mode:
 
 This uses Intel FSP for 3rd generation Intel Core and Intel Celeron processors
doc/board/index.rst +2 -0
index b47f672..99b5d2f 100644
@@ -5,3 +5,5 @@ Board-specific doc
 
 .. toctree::
    :maxdepth: 2
+
+   intel/index
doc/board/intel/crownbay.rst new file +43 -0

43 lines not on this page · raw message

doc/board/intel/index.rst new file +9 -0
new file mode 100644
index 0000000..93b8ba2
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Intel
+=====
+
+.. toctree::
+   :maxdepth: 2
+
+   crownbay
Signature · 1 line
2.7.4
author
#21 lore raw

PATCH 21/50 doc: board: Add Intel Bay Trail based board docs

In reply to Bin Meng

This extracts Intel Bay Trail based board specific information from README.x86, converts plain text documentation to reST format and adds them to Sphinx TOC tree. No essential content change.

---

 doc/README.x86                | 75 -------------------------------------------
 doc/board/intel/bayleybay.rst | 29 +++++++++++++++++
 doc/board/intel/index.rst     |  2 ++
 doc/board/intel/minnowmax.rst | 70 ++++++++++++++++++++++++++++++++++++++++
 4 files changed, 101 insertions(+), 75 deletions(-)
 create mode 100644 doc/board/intel/bayleybay.rst
 create mode 100644 doc/board/intel/minnowmax.rst
doc/README.x86 +0 -75
index 8077ff3..b4f0f7c 100644
@@ -226,81 +226,6 @@ to the last 2MB of the 8MB chip, address range [600000, 7FFFFF].
 
 ---
 
-Intel Bay Trail based board instructions for bare mode:
-
-This uses as FSP as with Crown Bay, except it is for the Atom E3800 series.
-Two boards that use this configuration are Bayley Bay and Minnowboard MAX.
-Download this and get the .fd file (BAYTRAIL_FSP_GOLD_003_16-SEP-2014.fd at
-the time of writing). Put it in the corresponding board directory and rename
-it to fsp.bin.
-
-Obtain the VGA RAM (Vga.dat at the time of writing) and put it into the same
-board directory as vga.bin.
-
-You still need two more binary blobs. For Bayley Bay, they can be extracted
-from the sample SPI image provided in the FSP (SPI.bin at the time of writing).
-
-   $ ./tools/ifdtool -x BayleyBay/SPI.bin
-   $ cp flashregion_0_flashdescriptor.bin board/intel/bayleybay/descriptor.bin
-   $ cp flashregion_2_intel_me.bin board/intel/bayleybay/me.bin
-
-For Minnowboard MAX, we can reuse the same ME firmware above, but for flash
-descriptor, we need get that somewhere else, as the one above does not seem to
-work, probably because it is not designed for the Minnowboard MAX. Now download
-the original firmware image for this board from:
-
-http://firmware.intel.com/sites/default/files/2014-WW42.4-MinnowBoardMax.73-64-bit.bin_Release.zip
-
-Unzip it:
-
-   $ unzip 2014-WW42.4-MinnowBoardMax.73-64-bit.bin_Release.zip
-
-Use ifdtool in the U-Boot tools directory to extract the images from that
-file, for example:
-
-   $ ./tools/ifdtool -x MNW2MAX1.X64.0073.R02.1409160934.bin
-
-This will provide the descriptor file - copy this into the correct place:
-
-   $ cp flashregion_0_flashdescriptor.bin board/intel/minnowmax/descriptor.bin
-
-Now you can build U-Boot and obtain u-boot.rom
-Note: below are examples/information for Minnowboard MAX.
-
-$ make minnowmax_defconfig
-$ make all
-
-Checksums are as follows (but note that newer versions will invalidate this):
-
-$ md5sum -b board/intel/minnowmax/*.bin
-ffda9a3b94df5b74323afb328d51e6b4  board/intel/minnowmax/descriptor.bin
-69f65b9a580246291d20d08cbef9d7c5  board/intel/minnowmax/fsp.bin
-894a97d371544ec21de9c3e8e1716c4b  board/intel/minnowmax/me.bin
-a2588537da387da592a27219d56e9962  board/intel/minnowmax/vga.bin
-
-The ROM image is broken up into these parts:
-
-Offset   Description         Controlling config
-------------------------------------------------------------
-000000   descriptor.bin      Hard-coded to 0 in ifdtool
-001000   me.bin              Set by the descriptor
-500000   <spare>
-6ef000   Environment         CONFIG_ENV_OFFSET
-6f0000   MRC cache           CONFIG_ENABLE_MRC_CACHE
-700000   u-boot-dtb.bin      CONFIG_SYS_TEXT_BASE
-7b0000   vga.bin             CONFIG_VGA_BIOS_ADDR
-7c0000   fsp.bin             CONFIG_FSP_ADDR
-7f8000   <spare>             (depends on size of fsp.bin)
-7ff800   U-Boot 16-bit boot  CONFIG_SYS_X86_START16
-
-Overall ROM image size is controlled by CONFIG_ROM_SIZE.
-
-Note that the debug version of the FSP is bigger in size. If this version
-is used, CONFIG_FSP_ADDR needs to be configured to 0xfffb0000 instead of
-the default value 0xfffc0000.
-
----
-
 Intel Cherry Hill specific instructions for bare mode:
 
 This uses Intel FSP for Braswell platform. Download it from Intel FSP website,
doc/board/intel/bayleybay.rst new file +29 -0
new file mode 100644
index 0000000..db97f64
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Bin Meng <[email protected]>
+
+Bayley Bay CRB
+==============
+
+This uses as FSP as with Crown Bay, except it is for the Atom E3800 series.
+Download this and get the .fd file (BAYTRAIL_FSP_GOLD_003_16-SEP-2014.fd at
+the time of writing). Put it in the corresponding board directory and rename
+it to fsp.bin.
+
+Obtain the VGA RAM (Vga.dat at the time of writing) and put it into the same
+board directory as vga.bin.
+
+You still need two more binary blobs. For Bayley Bay, they can be extracted
+from the sample SPI image provided in the FSP (SPI.bin at the time of writing)::
+
+   $ ./tools/ifdtool -x BayleyBay/SPI.bin
+   $ cp flashregion_0_flashdescriptor.bin board/intel/bayleybay/descriptor.bin
+   $ cp flashregion_2_intel_me.bin board/intel/bayleybay/me.bin
+
+Now you can build U-Boot and obtain u-boot.rom::
+
+   $ make bayleybay_defconfig
+   $ make all
+
+Note that the debug version of the FSP is bigger in size. If this version
+is used, CONFIG_FSP_ADDR needs to be configured to 0xfffb0000 instead of
+the default value 0xfffc0000.
doc/board/intel/index.rst +2 -0
index 93b8ba2..af24760 100644
@@ -6,4 +6,6 @@ Intel
 .. toctree::
    :maxdepth: 2
 
+   bayleybay
    crownbay
+   minnowmax
doc/board/intel/minnowmax.rst new file +70 -0

70 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#22 lore raw

PATCH 22/50 doc: board: Add Intel Cherry Hill board doc

In reply to Bin Meng

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

---

 doc/README.x86                 | 29 -----------------------------
 doc/board/intel/cherryhill.rst | 30 ++++++++++++++++++++++++++++++
 doc/board/intel/index.rst      |  1 +
 3 files changed, 31 insertions(+), 29 deletions(-)
 create mode 100644 doc/board/intel/cherryhill.rst
doc/README.x86 +0 -29
index b4f0f7c..8e549c3 100644
@@ -226,35 +226,6 @@ to the last 2MB of the 8MB chip, address range [600000, 7FFFFF].
 
 ---
 
-Intel Cherry Hill specific instructions for bare mode:
-
-This uses Intel FSP for Braswell platform. Download it from Intel FSP website,
-put the .fd file to the board directory and rename it to fsp.bin.
-
-Extract descriptor.bin and me.bin from the original BIOS on the board using
-ifdtool and put them to the board directory as well.
-
-Note the FSP package for Braswell does not ship a traditional legacy VGA BIOS
-image for the integrated graphics device. Instead a new binary called Video
-BIOS Table (VBT) is shipped. Put it to the board directory and rename it to
-vbt.bin if you want graphics support in U-Boot.
-
-Now you can build U-Boot and obtain u-boot.rom
-
-$ make cherryhill_defconfig
-$ make all
-
-An important note for programming u-boot.rom to the on-board SPI flash is that
-you need make sure the SPI flash's 'quad enable' bit in its status register
-matches the settings in the descriptor.bin, otherwise the board won't boot.
-
-For the on-board SPI flash MX25U6435F, this can be done by writing 0x40 to the
-status register by DediProg in: Config > Modify Status Register > Write Status
-Register(s) > Register1 Value(Hex). This is is a one-time change. Once set, it
-persists in SPI flash part regardless of the u-boot.rom image burned.
-
----
-
 Intel Galileo instructions for bare mode:
 
 Only one binary blob is needed for Remote Management Unit (RMU) within Intel
doc/board/intel/cherryhill.rst new file +30 -0
new file mode 100644
index 0000000..151f061
@@ -0,0 +1,30 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Bin Meng <[email protected]>
+
+Cherry Hill CRB
+===============
+
+This uses Intel FSP for Braswell platform. Download it from Intel FSP website,
+put the .fd file to the board directory and rename it to fsp.bin.
+
+Extract descriptor.bin and me.bin from the original BIOS on the board using
+ifdtool and put them to the board directory as well.
+
+Note the FSP package for Braswell does not ship a traditional legacy VGA BIOS
+image for the integrated graphics device. Instead a new binary called Video
+BIOS Table (VBT) is shipped. Put it to the board directory and rename it to
+vbt.bin if you want graphics support in U-Boot.
+
+Now you can build U-Boot and obtain u-boot.rom::
+
+   $ make cherryhill_defconfig
+   $ make all
+
+An important note for programming u-boot.rom to the on-board SPI flash is that
+you need make sure the SPI flash's 'quad enable' bit in its status register
+matches the settings in the descriptor.bin, otherwise the board won't boot.
+
+For the on-board SPI flash MX25U6435F, this can be done by writing 0x40 to the
+status register by DediProg in: Config > Modify Status Register > Write Status
+Register(s) > Register1 Value(Hex). This is is a one-time change. Once set, it
+persists in SPI flash part regardless of the u-boot.rom image burned.
doc/board/intel/index.rst +1 -0
index af24760..d30debb 100644
@@ -7,5 +7,6 @@ Intel
    :maxdepth: 2
 
    bayleybay
+   cherryhill
    crownbay
    minnowmax
Signature · 1 line
2.7.4
author
#23 lore raw

PATCH 23/50 doc: board: Add Intel Cougar Canyon 2 board doc

In reply to Bin Meng

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

---

 doc/README.x86                    | 23 -----------------------
 doc/board/intel/cougarcanyon2.rst | 24 ++++++++++++++++++++++++
 doc/board/intel/index.rst         |  1 +
 3 files changed, 25 insertions(+), 23 deletions(-)
 create mode 100644 doc/board/intel/cougarcanyon2.rst
doc/README.x86 +0 -23
index 8e549c3..5e85b57 100644
@@ -203,29 +203,6 @@ Flash map for samus / broadwell:
 
 ---
 
-Intel Cougar Canyon 2 specific instructions for bare mode:
-
-This uses Intel FSP for 3rd generation Intel Core and Intel Celeron processors
-with mobile Intel HM76 and QM77 chipsets platform. Download it from Intel FSP
-website and put the .fd file (CHIEFRIVER_FSP_GOLD_001_09-OCTOBER-2013.fd at the
-time of writing) in the board directory and rename it to fsp.bin.
-
-Now build U-Boot and obtain u-boot.rom
-
-$ make cougarcanyon2_defconfig
-$ make all
-
-The board has two 8MB SPI flashes mounted, which are called SPI-0 and SPI-1 in
-the board manual. The SPI-0 flash should have flash descriptor plus ME firmware
-and SPI-1 flash is used to store U-Boot. For convenience, the complete 8MB SPI-0
-flash image is included in the FSP package (named Rom00_8M_MB_PPT.bin). Program
-this image to the SPI-0 flash according to the board manual just once and we are
-all set. For programming U-Boot we just need to program SPI-1 flash. Since the
-default u-boot.rom image for this board is set to 2MB, it should be programmed
-to the last 2MB of the 8MB chip, address range [600000, 7FFFFF].
-
----
-
 Intel Galileo instructions for bare mode:
 
 Only one binary blob is needed for Remote Management Unit (RMU) within Intel
doc/board/intel/cougarcanyon2.rst new file +24 -0
new file mode 100644
index 0000000..5e3e7a1
@@ -0,0 +1,24 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Bin Meng <[email protected]>
+
+Cougar Canyon 2 CRB
+===================
+
+This uses Intel FSP for 3rd generation Intel Core and Intel Celeron processors
+with mobile Intel HM76 and QM77 chipsets platform. Download it from Intel FSP
+website and put the .fd file (CHIEFRIVER_FSP_GOLD_001_09-OCTOBER-2013.fd at the
+time of writing) in the board directory and rename it to fsp.bin.
+
+Now build U-Boot and obtain u-boot.rom::
+
+   $ make cougarcanyon2_defconfig
+   $ make all
+
+The board has two 8MB SPI flashes mounted, which are called SPI-0 and SPI-1 in
+the board manual. The SPI-0 flash should have flash descriptor plus ME firmware
+and SPI-1 flash is used to store U-Boot. For convenience, the complete 8MB SPI-0
+flash image is included in the FSP package (named Rom00_8M_MB_PPT.bin). Program
+this image to the SPI-0 flash according to the board manual just once and we are
+all set. For programming U-Boot we just need to program SPI-1 flash. Since the
+default u-boot.rom image for this board is set to 2MB, it should be programmed
+to the last 2MB of the 8MB chip, address range [600000, 7FFFFF].
doc/board/intel/index.rst +1 -0
index d30debb..521e6e6 100644
@@ -8,5 +8,6 @@ Intel
 
    bayleybay
    cherryhill
+   cougarcanyon2
    crownbay
    minnowmax
Signature · 1 line
2.7.4
author
#24 lore raw

PATCH 24/50 doc: board: Add Intel Edison board doc

In reply to Bin Meng

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.

---

 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
doc/README.x86 +0 -37
index 5e85b57..28d6ae0 100644
@@ -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
doc/board/intel/edison.rst new file +41 -0

41 lines not on this page · raw message

doc/board/intel/index.rst +1 -0
index 521e6e6..482e01b 100644
@@ -10,4 +10,5 @@ Intel
    cherryhill
    cougarcanyon2
    crownbay
+   edison
    minnowmax
Signature · 1 line
2.7.4
#25 lore raw

PATCH 24/50 doc: board: Add Intel Edison board doc

Quoted 5 lines · Bin Meng

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!

Quoted 128 lines

---

 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
doc/README.x86 +0 -37
index 5e85b57..28d6ae0 100644
@@ -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
doc/board/intel/edison.rst new file +41 -0
new file mode 100644
index 0000000..1aee2a1
@@ -0,0 +1,41 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Andy Shevchenko <[email protected]>
+
+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
doc/board/intel/index.rst +1 -1
index 521e6e6..482e01b 100644
@@ -10,4 +10,5 @@ Intel
    cherryhill
    cougarcanyon2
    crownbay
+   edison
    minnowmax
--

2.7.4

_______________________________________________
U-Boot mailing list
U-Boot at lists.denx.de
https://lists.denx.de/listinfo/u-boot

Signature · 2 lines
With Best Regards,
Andy Shevchenko
author
#26 lore raw

PATCH 25/50 doc: board: Add Intel Galileo board doc

In reply to Bin Meng

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

---

 doc/README.x86              | 21 ---------------------
 doc/board/intel/galileo.rst | 22 ++++++++++++++++++++++
 doc/board/intel/index.rst   |  1 +
 3 files changed, 23 insertions(+), 21 deletions(-)
 create mode 100644 doc/board/intel/galileo.rst
doc/README.x86 +0 -21
index 28d6ae0..e72f840 100644
@@ -193,27 +193,6 @@ Flash map for samus / broadwell:
 
 ---
 
-Intel Galileo instructions for bare mode:
-
-Only one binary blob is needed for Remote Management Unit (RMU) within Intel
-Quark SoC. Not like FSP, U-Boot does not call into the binary. The binary is
-needed by the Quark SoC itself.
-
-You can get the binary blob from Quark Board Support Package from Intel website:
-
-* ./QuarkSocPkg/QuarkNorthCluster/Binary/QuarkMicrocode/RMU.bin
-
-Rename the file and put it to the board directory by:
-
-   $ cp RMU.bin board/intel/galileo/rmu.bin
-
-Now you can build U-Boot and obtain u-boot.rom
-
-$ make galileo_defconfig
-$ make all
-
----
-
 QEMU x86 target instructions for bare mode:
 
 To build u-boot.rom for QEMU x86 targets, just simply run
doc/board/intel/galileo.rst new file +22 -0
new file mode 100644
index 0000000..f51a06b
@@ -0,0 +1,22 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Bin Meng <[email protected]>
+
+Galileo
+=======
+
+Only one binary blob is needed for Remote Management Unit (RMU) within Intel
+Quark SoC. Not like FSP, U-Boot does not call into the binary. The binary is
+needed by the Quark SoC itself.
+
+You can get the binary blob from Quark Board Support Package from Intel website:
+
+   * ./QuarkSocPkg/QuarkNorthCluster/Binary/QuarkMicrocode/RMU.bin
+
+Rename the file and put it to the board directory by::
+
+   $ cp RMU.bin board/intel/galileo/rmu.bin
+
+Now you can build U-Boot and obtain u-boot.rom::
+
+   $ make galileo_defconfig
+   $ make all
doc/board/intel/index.rst +1 -0
index 482e01b..f416801 100644
@@ -11,4 +11,5 @@ Intel
    cougarcanyon2
    crownbay
    edison
+   galileo
    minnowmax
Signature · 1 line
2.7.4
author
#27 lore raw

PATCH 26/50 doc: board: Add Google Chromebook Link board doc

In reply to Bin Meng

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

---

 doc/README.x86                       | 31 -------------------------------
 doc/board/google/chromebook_link.rst | 34 ++++++++++++++++++++++++++++++++++
 doc/board/google/index.rst           |  9 +++++++++
 doc/board/index.rst                  |  1 +
 4 files changed, 44 insertions(+), 31 deletions(-)
 create mode 100644 doc/board/google/chromebook_link.rst
 create mode 100644 doc/board/google/index.rst
doc/README.x86 +0 -31
index e72f840..a8ad956 100644
@@ -65,37 +65,6 @@ Both tell the Makefile to build u-boot.rom as a target.
 
 ---
 
-Chromebook Link specific instructions for bare mode:
-
-First, you need the following binary blobs:
-
-* descriptor.bin - Intel flash descriptor
-* me.bin - Intel Management Engine
-* mrc.bin - Memory Reference Code, which sets up SDRAM
-* video ROM - sets up the display
-
-You can get these binary blobs by:
-
-$ git clone http://review.coreboot.org/p/blobs.git
-$ cd blobs
-
-Find the following files:
-
-* ./mainboard/google/link/descriptor.bin
-* ./mainboard/google/link/me.bin
-* ./northbridge/intel/sandybridge/systemagent-r6.bin
-
-The 3rd one should be renamed to mrc.bin.
-As for the video ROM, you can get it here [3] and rename it to vga.bin.
-Make sure all these binary blobs are put in the board directory.
-
-Now you can build U-Boot and obtain u-boot.rom:
-
-$ make chromebook_link_defconfig
-$ make all
-
----
-
 Chromebook Samus (2015 Pixel) instructions for bare mode:
 
 First, you need the following binary blobs:
doc/board/google/chromebook_link.rst new file +34 -0
new file mode 100644
index 0000000..1608030
@@ -0,0 +1,34 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. sectionauthor:: Simon Glass <[email protected]>
+
+Chromebook Link
+===============
+
+First, you need the following binary blobs:
+
+   * descriptor.bin - Intel flash descriptor
+   * me.bin - Intel Management Engine
+   * mrc.bin - Memory Reference Code, which sets up SDRAM
+   * video ROM - sets up the display
+
+You can get these binary blobs by::
+
+   $ git clone http://review.coreboot.org/p/blobs.git
+   $ cd blobs
+
+Find the following files:
+
+   * ./mainboard/google/link/descriptor.bin
+   * ./mainboard/google/link/me.bin
+   * ./northbridge/intel/sandybridge/systemagent-r6.bin
+
+The 3rd one should be renamed to mrc.bin.
+As for the video ROM, you can get it `here`_ and rename it to vga.bin.
+Make sure all these binary blobs are put in the board directory.
+
+Now you can build U-Boot and obtain u-boot.rom::
+
+   $ make chromebook_link_defconfig
+   $ make all
+
+.. _here: http://www.coreboot.org/~stepan/pci8086,0166.rom
doc/board/google/index.rst new file +9 -0
new file mode 100644
index 0000000..93833c5
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Google
+======
+
+.. toctree::
+   :maxdepth: 2
+
+   chromebook_link
doc/board/index.rst +1 -0
index 99b5d2f..59f745d 100644
@@ -6,4 +6,5 @@ Board-specific doc
 .. toctree::
    :maxdepth: 2
 
+   google/index
    intel/index
Signature · 1 line
2.7.4
author
#28 lore raw

PATCH 27/50 doc: board: Add Google Chromebook Samus board doc

In reply to Bin Meng

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

---

 doc/README.x86                        |  97 --------------------------------
 doc/board/google/chromebook_samus.rst | 101 ++++++++++++++++++++++++++++++++++
 doc/board/google/index.rst            |   1 +
 3 files changed, 102 insertions(+), 97 deletions(-)
 create mode 100644 doc/board/google/chromebook_samus.rst
doc/README.x86 +0 -97
index a8ad956..2374be9 100644
@@ -65,103 +65,6 @@ Both tell the Makefile to build u-boot.rom as a target.
 
 ---
 
-Chromebook Samus (2015 Pixel) instructions for bare mode:
-
-First, you need the following binary blobs:
-
-* descriptor.bin - Intel flash descriptor
-* me.bin - Intel Management Engine
-* mrc.bin - Memory Reference Code, which sets up SDRAM
-* refcode.elf - Additional Reference code
-* vga.bin - video ROM, which sets up the display
-
-If you have a samus you can obtain them from your flash, for example, in
-developer mode on the Chromebook (use Ctrl-Alt-F2 to obtain a terminal and
-log in as 'root'):
-
-   cd /tmp
-   flashrom -w samus.bin
-   scp samus.bin username at ip_address:/path/to/somewhere
-
-If not see the coreboot tree [4] where you can use:
-
-   bash crosfirmware.sh samus
-
-to get the image. There is also an 'extract_blobs.sh' scripts that you can use
-on the 'coreboot-Google_Samus.*' file to short-circuit some of the below.
-
-Then 'ifdtool -x samus.bin' on your development machine will produce:
-
-   flashregion_0_flashdescriptor.bin
-   flashregion_1_bios.bin
-   flashregion_2_intel_me.bin
-
-Rename flashregion_0_flashdescriptor.bin to descriptor.bin
-Rename flashregion_2_intel_me.bin to me.bin
-You can ignore flashregion_1_bios.bin - it is not used.
-
-To get the rest, use 'cbfstool samus.bin print':
-
-samus.bin: 8192 kB, bootblocksize 2864, romsize 8388608, offset 0x700000
-alignment: 64 bytes, architecture: x86
-
-Name                           Offset     Type         Size
-cmos_layout.bin                0x700000   cmos_layout  1164
-pci8086,0406.rom               0x7004c0   optionrom    65536
-spd.bin                        0x710500   (unknown)    4096
-cpu_microcode_blob.bin         0x711540   microcode    70720
-fallback/romstage              0x722a00   stage        54210
-fallback/ramstage              0x72fe00   stage        96382
-config                         0x7476c0   raw          6075
-fallback/vboot                 0x748ec0   stage        15980
-fallback/refcode               0x74cd80   stage        75578
-fallback/payload               0x75f500   payload      62878
-u-boot.dtb                     0x76eb00   (unknown)    5318
-(empty)                        0x770000   null         196504
-mrc.bin                        0x79ffc0   (unknown)    222876
-(empty)                        0x7d66c0   null         167320
-
-You can extract what you need:
-
-   cbfstool samus.bin extract -n pci8086,0406.rom -f vga.bin
-   cbfstool samus.bin extract -n fallback/refcode -f refcode.rmod
-   cbfstool samus.bin extract -n mrc.bin -f mrc.bin
-   cbfstool samus.bin extract -n fallback/refcode -f refcode.bin -U
-
-Note that the -U flag is only supported by the latest cbfstool. It unpacks
-and decompresses the stage to produce a coreboot rmodule. This is a simple
-representation of an ELF file. You need the patch "Support decoding a stage
-with compression".
-
-Put all 5 files into board/google/chromebook_samus.
-
-Now you can build U-Boot and obtain u-boot.rom:
-
-$ make chromebook_link_defconfig
-$ make all
-
-If you are using em100, then this command will flash write -Boot:
-
-   em100 -s -d filename.rom -c W25Q64CV -r
-
-Flash map for samus / broadwell:
-
-   fffff800	SYS_X86_START16
-   ffff0000	RESET_SEG_START
-   fffd8000	TPL_TEXT_BASE
-   fffa0000	X86_MRC_ADDR
-   fff90000	VGA_BIOS_ADDR
-   ffed0000	SYS_TEXT_BASE
-   ffea0000	X86_REFCODE_ADDR
-   ffe70000	SPL_TEXT_BASE
-   ffbf8000	CONFIG_ENV_OFFSET (environemnt offset)
-   ffbe0000	rw-mrc-cache (Memory-reference-code cache)
-   ffa00000	<spare>
-   ff801000	intel-me (address set by descriptor.bin)
-   ff800000	intel-descriptor
-
----
-
 QEMU x86 target instructions for bare mode:
 
 To build u-boot.rom for QEMU x86 targets, just simply run
doc/board/google/chromebook_samus.rst new file +101 -0

101 lines not on this page · raw message

doc/board/google/index.rst +1 -0
index 93833c5..7f557fe 100644
@@ -7,3 +7,4 @@ Google
    :maxdepth: 2
 
    chromebook_link
+   chromebook_samus
Signature · 1 line
2.7.4
author
#29 lore raw

PATCH 28/50 doc: board: Add coreboot board doc

In reply to Bin Meng

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.

---

 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
doc/README.x86 +0 -37
index 2374be9..c987439 100644
@@ -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
doc/board/coreboot/coreboot.rst new file +42 -0

42 lines not on this page · raw message

doc/board/coreboot/index.rst new file +9 -0
new file mode 100644
index 0000000..d148db9
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Coreboot
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   coreboot
doc/board/index.rst +1 -0
index 59f745d..eb21a67 100644
@@ -6,5 +6,6 @@ Board-specific doc
 .. toctree::
    :maxdepth: 2
 
+   coreboot/index
    google/index
    intel/index
Signature · 1 line
2.7.4
author
#30 lore raw

PATCH 29/50 doc: board: Add QEMU x86 board doc

In reply to Bin Meng

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

---

 doc/README.x86                   |  93 -----------------------------------
 doc/board/emulation/index.rst    |   9 ++++
 doc/board/emulation/qemu-x86.rst | 101 +++++++++++++++++++++++++++++++++++++++
 doc/board/index.rst              |   1 +
 4 files changed, 111 insertions(+), 93 deletions(-)
 create mode 100644 doc/board/emulation/index.rst
 create mode 100644 doc/board/emulation/qemu-x86.rst
doc/README.x86 +0 -93
index c987439..8cee320 100644
@@ -57,99 +57,6 @@ Both tell the Makefile to build u-boot.rom as a target.
 
 ---
 
-QEMU x86 target instructions for bare mode:
-
-To build u-boot.rom for QEMU x86 targets, just simply run
-
-$ make qemu-x86_defconfig (for 32-bit)
-or
-$ make qemu-x86_64_defconfig (for 64-bit)
-$ make all
-
-Note this default configuration will build a U-Boot for the QEMU x86 i440FX
-board. To build a U-Boot against QEMU x86 Q35 board, you can change the build
-configuration during the 'make menuconfig' process like below:
-
-Device Tree Control  --->
-	...
-	(qemu-x86_q35) Default Device Tree for DT control
-
-Test with QEMU for bare mode
-----------------------------
-QEMU is a fancy emulator that can enable us to test U-Boot without access to
-a real x86 board. Please make sure your QEMU version is 2.3.0 or above test
-U-Boot. To launch QEMU with u-boot.rom, call QEMU as follows:
-
-$ qemu-system-i386 -nographic -bios path/to/u-boot.rom
-
-This will instantiate an emulated x86 board with i440FX and PIIX chipset. QEMU
-also supports emulating an x86 board with Q35 and ICH9 based chipset, which is
-also supported by U-Boot. To instantiate such a machine, call QEMU with:
-
-$ qemu-system-i386 -nographic -bios path/to/u-boot.rom -M q35
-
-Note by default QEMU instantiated boards only have 128 MiB system memory. But
-it is enough to have U-Boot boot and function correctly. You can increase the
-system memory by pass '-m' parameter to QEMU if you want more memory:
-
-$ qemu-system-i386 -nographic -bios path/to/u-boot.rom -m 1024
-
-This creates a board with 1 GiB system memory. Currently U-Boot for QEMU only
-supports 3 GiB maximum system memory and reserves the last 1 GiB address space
-for PCI device memory-mapped I/O and other stuff, so the maximum value of '-m'
-would be 3072.
-
-QEMU emulates a graphic card which U-Boot supports. Removing '-nographic' will
-show QEMU's VGA console window. Note this will disable QEMU's serial output.
-If you want to check both consoles, use '-serial stdio'.
-
-Multicore is also supported by QEMU via '-smp n' where n is the number of cores
-to instantiate. Note, the maximum supported CPU number in QEMU is 255.
-
-The fw_cfg interface in QEMU also provides information about kernel data,
-initrd, command-line arguments and more. U-Boot supports directly accessing
-these informtion from fw_cfg interface, which saves the time of loading them
-from hard disk or network again, through emulated devices. To use it , simply
-providing them in QEMU command line:
-
-$ qemu-system-i386 -nographic -bios path/to/u-boot.rom -m 1024 -kernel /path/to/bzImage
-    -append 'root=/dev/ram console=ttyS0' -initrd /path/to/initrd -smp 8
-
-Note: -initrd and -smp are both optional
-
-Then start QEMU, in U-Boot command line use the following U-Boot command to
-setup kernel:
-
- => qfw
-qfw - QEMU firmware interface
-
-Usage:
-qfw <command>
-    - list                             : print firmware(s) currently loaded
-    - cpus                             : print online cpu number
-    - load <kernel addr> <initrd addr> : load kernel and initrd (if any) and setup for zboot
-
-=> qfw load
-loading kernel to address 01000000 size 5d9d30 initrd 04000000 size 1b1ab50
-
-Here the kernel (bzImage) is loaded to 01000000 and initrd is to 04000000. Then,
-'zboot' can be used to boot the kernel:
-
-=> zboot 01000000 - 04000000 1b1ab50
-
-To run 64-bit U-Boot, qemu-system-x86_64 should be used instead, e.g.:
-$ qemu-system-x86_64 -nographic -bios path/to/u-boot.rom
-
-A specific CPU can be specified via the '-cpu' parameter but please make
-sure the specified CPU supports 64-bit like '-cpu core2duo'. Conversely
-'-cpu pentium' won't work for obvious reasons that the processor only
-supports 32-bit.
-
-Note 64-bit support is very preliminary at this point. Lots of features
-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.
-
 CPU Microcode
 -------------
 Modern CPUs usually require a special bit stream called microcode [8] to be
doc/board/emulation/index.rst new file +9 -0
new file mode 100644
index 0000000..6d533f3
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Emulation
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   qemu-x86
doc/board/emulation/qemu-x86.rst new file +101 -0

101 lines not on this page · raw message

doc/board/index.rst +1 -0
index eb21a67..6d2356f 100644
@@ -7,5 +7,6 @@ Board-specific doc
    :maxdepth: 2
 
    coreboot/index
+   emulation/index
    google/index
    intel/index
Signature · 1 line
2.7.4
author
#31 lore raw

PATCH 30/50 doc: board: Convert README.qemu-arm to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/board/emulation/index.rst                      |  1 +
 .../emulation/qemu-arm.rst}                        | 44 ++++++++++++++--------
 2 files changed, 30 insertions(+), 15 deletions(-)
 rename doc/{README.qemu-arm => board/emulation/qemu-arm.rst} (80%)
doc/board/emulation/index.rst +1 -0
index 6d533f3..a2b1a60 100644
@@ -6,4 +6,5 @@ Emulation
 .. toctree::
    :maxdepth: 2
 
+   qemu-arm
    qemu-x86
doc/board/emulation/qemu-arm.rst renamed from doc/README.qemu-arm +29 -15

80 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#32 lore raw

PATCH 31/50 doc: board: Convert README.qemu-riscv to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/board/emulation/index.rst                       |  1 +
 .../emulation/qemu-riscv.rst}                       | 21 ++++++++++++---------
 2 files changed, 13 insertions(+), 9 deletions(-)
 rename doc/{README.qemu-riscv => board/emulation/qemu-riscv.rst} (82%)
doc/board/emulation/index.rst +1 -0
index a2b1a60..7537179 100644
@@ -7,4 +7,5 @@ Emulation
    :maxdepth: 2
 
    qemu-arm
+   qemu-riscv
    qemu-x86
doc/board/emulation/qemu-riscv.rst renamed from doc/README.qemu-riscv +12 -9
similarity index 82%
rename from doc/README.qemu-riscv
rename to doc/board/emulation/qemu-riscv.rst
index e2e4804..2148334 100644
@@ -1,9 +1,8 @@
-# SPDX-License-Identifier: GPL-2.0+
-#
-# Copyright (C) 2018, Bin Meng <[email protected]>
+.. SPDX-License-Identifier: GPL-2.0+
+.. Copyright (C) 2018, Bin Meng <[email protected]>
 
-U-Boot on QEMU's 'virt' machine on RISC-V
-=========================================
+QEMU RISC-V
+===========
 
 QEMU for RISC-V supports a special 'virt' machine designed for emulation and
 virtualization purposes. This document describes how to run U-Boot under it.
@@ -19,11 +18,13 @@ Building U-Boot
 ---------------
 Set the CROSS_COMPILE environment variable as usual, and run:
 
-- For 32-bit RISC-V:
+- For 32-bit RISC-V::
+
     make qemu-riscv32_defconfig
     make
 
-- For 64-bit RISC-V:
+- For 64-bit RISC-V::
+
     make qemu-riscv64_defconfig
     make
 
@@ -31,10 +32,12 @@ Running U-Boot
 --------------
 The minimal QEMU command line to get U-Boot up and running is:
 
-- For 32-bit RISC-V:
+- For 32-bit RISC-V::
+
     qemu-system-riscv32 -nographic -machine virt -kernel u-boot
 
-- For 64-bit RISC-V:
+- For 64-bit RISC-V::
+
     qemu-system-riscv64 -nographic -machine virt -kernel u-boot
 
 The commands above create targets with 128MiB memory by default.
Signature · 1 line
2.7.4
author
#33 lore raw

PATCH 32/50 doc: board: Convert README.qemu-mips to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/README.qemu-mips              | 195 -------------------------------
 doc/board/emulation/index.rst     |   1 +
 doc/board/emulation/qemu-mips.rst | 234 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 235 insertions(+), 195 deletions(-)
 delete mode 100644 doc/README.qemu-mips
 create mode 100644 doc/board/emulation/qemu-mips.rst
doc/README.qemu-mips deleted +0 -195
deleted file mode 100644
index 3940fac..0000000
@@ -1,195 +0,0 @@
-By Vlad Lungu vlad.lungu at windriver.com 2007-Oct-01
-----------------------------------------
-Qemu is a full system emulator. See
-
-http://www.nongnu.org/qemu/
-
-Limitations & comments
-----------------------
-Supports the "-M mips" configuration of qemu: serial,NE2000,IDE.
-Supports little and big endian as well as 32 bit and 64 bit.
-Derived from au1x00 with a lot of things cut out.
-
-Supports emulated flash (patch Jean-Christophe PLAGNIOL-VILLARD) with
-recent qemu versions. When using emulated flash, launch with
--pflash <filename> and erase mips_bios.bin.
-
-
-Notes for the Qemu MIPS port
-----------------------------
-
-I) Example usage:
-
-Using u-boot.bin as ROM (replaces Qemu monitor):
-
-32 bit, big endian:
-# make qemu_mips
-# qemu-system-mips -M mips -bios u-boot.bin -nographic
-
-32 bit, little endian:
-# make qemu_mipsel
-# qemu-system-mipsel -M mips -bios u-boot.bin -nographic
-
-64 bit, big endian:
-# make qemu_mips64
-# qemu-system-mips64 -cpu MIPS64R2-generic -M mips -bios u-boot.bin -nographic
-
-64 bit, little endian:
-# make qemu_mips64el
-# qemu-system-mips64el -cpu MIPS64R2-generic -M mips -bios u-boot.bin -nographic
-
-or using u-boot.bin from emulated flash:
-
-if you use a qemu version after commit 4224
-
-create image:
-# dd of=flash bs=1k count=4k if=/dev/zero
-# dd of=flash bs=1k conv=notrunc if=u-boot.bin
-start it (see above):
-# qemu-system-mips[64][el] [-cpu MIPS64R2-generic] -M mips -pflash flash -nographic
-
-2) Download kernel + initrd
-
-On ftp://ftp.denx.de/pub/contrib/Jean-Christophe_Plagniol-Villard/qemu_mips/
-you can downland
-
-#config to build the kernel
-qemu_mips_defconfig
-#patch to fix mips interrupt init on 2.6.24.y kernel
-qemu_mips_kernel.patch
-initrd.gz
-vmlinux
-vmlinux.bin
-System.map
-
-4) Generate uImage
-
-# tools/mkimage -A mips -O linux -T kernel -C gzip -a 0x80010000 -e 0x80245650 -n "Linux 2.6.24.y" -d vmlinux.bin.gz uImage
-
-5) Copy uImage to Flash
-# dd if=uImage bs=1k conv=notrunc seek=224 of=flash
-
-6) Generate Ide Disk
-
-# dd of=ide bs=1k cout=100k if=/dev/zero
-
-# sfdisk -C 261 -d ide
-# partition table of ide
-unit: sectors
-
-     ide1 : start=       63, size=    32067, Id=83
-     ide2 : start=    32130, size=    32130, Id=83
-     ide3 : start=    64260, size=  4128705, Id=83
-     ide4 : start=        0, size=        0, Id= 0
-
-7) Copy to ide
-
-# dd if=uImage bs=512 conv=notrunc seek=63 of=ide
-
-8) Generate ext2 on part 2 on Copy uImage and initrd.gz
-
-# Attached as loop device ide offset = 32130 * 512
-# losetup -o 16450560 -f ide
-# Format as ext2 ( arg2 : nb blocks)
-# mke2fs /dev/loop0 16065
-# losetup -d /dev/loop0
-# Mount and copy uImage and initrd.gz to it
-# mount -o loop,offset=16450560 -t ext2 ide /mnt
-# mkdir /mnt/boot
-# cp {initrd.gz,uImage} /mnt/boot/
-# Umount it
-# umount /mnt
-
-9) Set Environment
-
-setenv rd_start 0x80800000
-setenv rd_size 2663940
-setenv kernel BFC38000
-setenv oad_addr 80500000
-setenv load_addr2 80F00000
-setenv kernel_flash BFC38000
-setenv load_addr_hello 80200000
-setenv bootargs 'root=/dev/ram0 init=/bin/sh'
-setenv load_rd_ext2 'ide res; ext2load ide 0:2 ${rd_start} /boot/initrd.gz'
-setenv load_rd_tftp 'tftp ${rd_start} /initrd.gz'
-setenv load_kernel_hda 'ide res; diskboot ${load_addr} 0:2'
-setenv load_kernel_ext2 'ide res; ext2load ide 0:2 ${load_addr} /boot/uImage'
-setenv load_kernel_tftp 'tftp ${load_addr} /qemu_mips/uImage'
-setenv boot_ext2_ext2 'run load_rd_ext2; run load_kernel_ext2; run addmisc; bootm ${load_addr}'
-setenv boot_ext2_flash 'run load_rd_ext2; run addmisc; bootm ${kernel_flash}'
-setenv boot_ext2_hda 'run load_rd_ext2; run load_kernel_hda; run addmisc; bootm ${load_addr}'
-setenv boot_ext2_tftp 'run load_rd_ext2; run load_kernel_tftp; run addmisc; bootm ${load_addr}'
-setenv boot_tftp_hda 'run load_rd_tftp; run load_kernel_hda; run addmisc; bootm ${load_addr}'
-setenv boot_tftp_ext2 'run load_rd_tftp; run load_kernel_ext2; run addmisc; bootm ${load_addr}'
-setenv boot_tftp_flash 'run load_rd_tftp; run addmisc; bootm ${kernel_flash}'
-setenv boot_tftp_tftp 'run load_rd_tftp; run load_kernel_tftp; run addmisc; bootm ${load_addr}'
-setenv load_hello_tftp 'tftp ${load_addr_hello} /examples/hello_world.bin'
-setenv go_tftp 'run load_hello_tftp; go ${load_addr_hello}'
-setenv addmisc 'setenv bootargs ${bootargs} console=ttyS0,${baudrate} rd_start=${rd_start} rd_size=${rd_size} ethaddr=${ethaddr}'
-setenv bootcmd 'run boot_tftp_flash'
-
-10) Now you can boot from flash, ide, ide+ext2 and tfp
-
-# qemu-system-mips -M mips -pflash flash -monitor null -nographic -net nic -net user -tftp `pwd` -hda ide
-
-II) How to debug U-Boot
-
-In order to debug U-Boot you need to start qemu with gdb server support (-s)
-and waiting the connection to start the CPU (-S)
-
-# qemu-system-mips -S -s -M mips -pflash flash -monitor null -nographic -net nic -net user -tftp `pwd` -hda ide
-
-in an other console you start gdb
-
-1) Debugging of U-Boot Before Relocation
-
-Before relocation, the addresses in the ELF file can be used without any problems
-by connecting to the gdb server localhost:1234
-
-# mipsel-unknown-linux-gnu-gdb u-boot
-GNU gdb 6.6
-Copyright (C) 2006 Free Software Foundation, Inc.
-GDB is free software, covered by the GNU General Public License, and you are
-welcome to change it and/or distribute copies of it under certain conditions.
-Type "show copying" to see the conditions.
-There is absolutely no warranty for GDB.  Type "show warranty" for details.
-This GDB was configured as "--host=i486-linux-gnu --target=mipsel-unknown-linux-gnu"...
-(gdb)  target remote localhost:1234
-Remote debugging using localhost:1234
-_start () at start.S:64
-64		RVECENT(reset,0)	/* U-Boot entry point */
-Current language:  auto; currently asm
-(gdb)  b board.c:289
-Breakpoint 1 at 0xbfc00cc8: file board.c, line 289.
-(gdb) c
-Continuing.
-
-Breakpoint 1, board_init_f (bootflag=<value optimized out>) at board.c:290
-290		relocate_code (addr_sp, id, addr);
-Current language:  auto; currently c
-(gdb) p/x addr
-$1 = 0x87fa0000
-
-2) Debugging of U-Boot After Relocation
-
-For debugging U-Boot after relocation we need to know the address to which
-U-Boot relocates itself to 0x87fa0000 by default.
-And replace the symbol table to this offset.
-
-(gdb) symbol-file
-Discard symbol table from `/private/u-boot-arm/u-boot'? (y or n) y
-Error in re-setting breakpoint 1:
-No symbol table is loaded.  Use the "file" command.
-No symbol file now.
-(gdb) add-symbol-file u-boot 0x87fa0000
-add symbol table from file "u-boot" at
-	.text_addr = 0x87fa0000
-(y or n) y
-Reading symbols from /private/u-boot-arm/u-boot...done.
-Breakpoint 1 at 0x87fa0cc8: file board.c, line 289.
-(gdb) c
-Continuing.
-
-Program received signal SIGINT, Interrupt.
-0xffffffff87fa0de4 in udelay (usec=<value optimized out>) at time.c:78
-78		while ((tmo - read_c0_count()) < 0x7fffffff)
doc/board/emulation/index.rst +1 -0
index 7537179..1adefee 100644
@@ -7,5 +7,6 @@ Emulation
    :maxdepth: 2
 
    qemu-arm
+   qemu-mips
    qemu-riscv
    qemu-x86
doc/board/emulation/qemu-mips.rst new file +234 -0

234 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#34 lore raw

PATCH 33/50 doc: board: Add AndesTech ax25-ae350 board doc

In reply to Bin Meng

This converts README.AX25 and README.ae350 plain text documentation to reST format, merges them into one ax25-ae350 doc, and adds it to Sphinx TOC tree. No essential content change.

---

 doc/README.AX25                    |  46 ------
 doc/README.ae350                   | 275 -------------------------------
 doc/board/AndesTech/ax25-ae350.rst | 329 +++++++++++++++++++++++++++++++++++++
 doc/board/index.rst                |   1 +
 4 files changed, 330 insertions(+), 321 deletions(-)
 delete mode 100644 doc/README.AX25
 delete mode 100644 doc/README.ae350
 create mode 100644 doc/board/AndesTech/ax25-ae350.rst
doc/README.AX25 deleted +0 -46
deleted file mode 100644
index 7a607dd..0000000
@@ -1,46 +0,0 @@
-AX25 is Andes CPU IP to adopt RISC-V architecture.
-
-Features
-========
-
-CPU Core
- - 5-stage in-order execution pipeline
- - Hardware Multiplier
-	 - radix-2/radix-4/radix-16/radix-256/fast
- - Hardware Divider
- - Optional branch prediction
- - Machine mode and optional user mode
- - Optional performance monitoring
-
-ISA
- - RV64I base integer instructions
- - RVC for 16-bit compressed instructions
- - RVM for multiplication and division instructions
-
-Memory subsystem
- - I & D local memory
-   - Size: 4KB to 16MB
- - Memory subsyetem soft-error protection
-   - Protection scheme: parity-checking or error-checking-and-correction (ECC)
-   - Automatic hardware error correction
-
-Bus
- - Interface Protocol
-   - Synchronous AHB (32-bit/64-bit data-width), or
-   - Synchronous AXI4 (64-bit data-width)
-
-Power management
- - Wait for interrupt (WFI) mode
-
-Debug
- - Configurable number of breakpoints: 2/4/8
- - External Debug Module
-   - AHB slave port
- - External JTAG debug transport module
-
-Platform Level Interrupt Controller (PLIC)
- - AHB slave port
- - Configurable number of interrupts: 1-1023
- - Configurable number of interrupt priorities: 3/7/15/63/127/255
- - Configurable number of targets:  1-16
- - Preempted interrupt priority stack
doc/README.ae350 deleted +0 -275

275 lines not on this page · raw message

doc/board/AndesTech/ax25-ae350.rst new file +329 -0

329 lines not on this page · raw message

doc/board/index.rst +1 -0
index 6d2356f..1cf0bc6 100644
@@ -6,6 +6,7 @@ Board-specific doc
 .. toctree::
    :maxdepth: 2
 
+   AndesTech/index
    coreboot/index
    emulation/index
    google/index
Signature · 1 line
2.7.4
author
#35 lore raw

PATCH 34/50 doc: board: Convert README.ag101p to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 .../AndesTech/adp-ag101p.rst}                      | 26 +++++++++++++---------
 1 file changed, 15 insertions(+), 11 deletions(-)
 rename doc/{README.ag101p => board/AndesTech/adp-ag101p.rst} (83%)
doc/board/AndesTech/adp-ag101p.rst renamed from doc/README.ag101p +15 -11
similarity index 83%
rename from doc/README.ag101p
rename to doc/board/AndesTech/adp-ag101p.rst
index 8fc0ac5..879eba0 100644
@@ -1,18 +1,21 @@
-Andes Technology SoC AG101P
-===========================
+.. SPDX-License-Identifier: GPL-2.0+
+
+ADP-AG101P
+==========
+
+ADP-AG101P is the SoC with AG101 hardcore CPU.
+
+AG101P SoC
+----------
 
 AG101P is the mainline SoC produced by Andes Technology using N1213 CPU core
 with FPU and DDR contoller support.
 AG101P has integrated both AHB and APB bus and many periphals for application
 and product development.
 
-ADP-AG101P
-=========
-
-ADP-AG101P is the SoC with AG101 hardcore CPU.
 
 Configurations
-==============
+--------------
 
 CONFIG_MEM_REMAP:
 	Doing memory remap is essential for preparing some non-OS or RTOS
@@ -24,13 +27,14 @@ CONFIG_SKIP_LOWLEVEL_INIT:
 	in "include/configs/adp-ag101p.h".
 
 Build and boot steps
-====================
+--------------------
+
+Build:
 
-build:
 1. Prepare the toolchains and make sure the $PATH to toolchains is correct.
 2. Use `make adp-ag101p_defconfig` in u-boot root to build the image.
 
-Burn u-boot to SPI ROM:
-====================
+Burn U-Boot to SPI ROM
+----------------------
 
 This section will be added later.
Signature · 1 line
2.7.4
author
#36 lore raw

PATCH 35/50 doc: board: Convert README.sifive-fu540 to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/README.sifive-fu540    | 303 ------------------------------------------
 doc/board/index.rst        |   1 +
 doc/board/sifive/fu540.rst | 321 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 322 insertions(+), 303 deletions(-)
 delete mode 100644 doc/README.sifive-fu540
 create mode 100644 doc/board/sifive/fu540.rst
doc/README.sifive-fu540 deleted +0 -303
deleted file mode 100644
index fd9f2a8..0000000
@@ -1,303 +0,0 @@
-FU540-C000 RISC-V SoC
-=====================
-The FU540-C000 is the world’s first 4+1 64-bit RISC‑V SoC from SiFive.
-
-The HiFive Unleashed development platform is based on FU540-C000 and capable
-of running Linux.
-
-Mainline support
-================
-The support for following drivers are already enabled:
-1. SiFive UART Driver.
-2. SiFive PRCI Driver for clock.
-3. Cadence MACB ethernet driver for networking support.
-
-TODO:
-1. SPI driver is still missing. So MMC card can't be used in U-Boot as of now.
-2. U-Boot expects the serial console device entry to be present under /chosen
-   DT node. Example:
-   chosen {
-        stdout-path = "/soc/serial at 10010000:115200";
-   };
-
-   Without a serial console U-Boot will panic.
-
-Building
-========
-1. Add the RISC-V toolchain to your PATH.
-2. Setup ARCH & cross compilation enviornment variable.
-   a. export ARCH=riscv
-   b. export CROSS_COMPILE=<riscv64 toolchain prefix>
-3. make sifive_fu540_defconfig
-4. make
-
-Flashing
-========
-The current U-Boot port is supported in S-mode only and loaded from DRAM.
-
-A prior stage (M-mode) firmware/bootloader (e.g OpenSBI or BBL) is required to
-load the u-boot.bin into memory and provide runtime services. The u-boot.bin
-can be given as a payload to the prior stage (M-mode) firmware/bootloader.
-
-The description of steps required to build the firmware is beyond the scope of
-this document. Please refer OpenSBI or BBL documenation.
-(Note: OpenSBI git repo is at https://github.com/riscv/opensbi.git)
-(Note: BBL git repo is at https://github.com/riscv/riscv-pk.git)
-
-Once the prior stage firmware/bootloader binary is generated, it should be
-copied to the first partition of the sdcard.
-
-sudo dd if=<prior_stage_firmware_binary> of=/dev/disk2s1 bs=1024
-
-Booting
-=======
-Once you plugin the sdcard and power up, you should see the U-Boot prompt.
-
-Sample boot log from HiFive Unleashed board
-===========================================
-U-Boot 2019.01-00019-gc7953536-dirty (Jan 22 2019 - 11:05:40 -0800)
-
-CPU:   rv64imafdc
-Model: sifive,hifive-unleashed-a00
-DRAM:  8 GiB
-In:    serial at 10010000
-Out:   serial at 10010000
-Err:   serial at 10010000
-Net:
-Warning: ethernet at 10090000 (eth0) using random MAC address - b6:75:4d:48:50:94
-eth0: ethernet at 10090000
-Hit any key to stop autoboot:  0
-=> version
-U-Boot 2019.01-00019-gc7953536-dirty (Jan 22 2019 - 11:05:40 -0800)
-
-riscv64-linux-gcc.br_real (Buildroot 2018.11-rc2-00003-ga0787e9) 8.2.0
-GNU ld (GNU Binutils) 2.31.1
-=>
-===============================================================================
-
-Now you can configure your networking, tftp server and use tftp boot method to
-load uImage.
-
-==========================================================================
-=> setenv ethaddr 70:B3:D5:92:F0:C2
-=> setenv ipaddr 10.196.157.189
-=> setenv serverip 10.11.143.218
-=> setenv gatewayip 10.196.156.1
-=> setenv netmask 255.255.252.0
-=> bdinfo
-boot_params = 0x0000000000000000
-DRAM bank   = 0x0000000000000000
--> start    = 0x0000000080000000
--> size     = 0x0000000200000000
-relocaddr   = 0x00000000fff90000
-reloc off   = 0x000000007fd90000
-ethaddr     = 70:B3:D5:92:F0:C2
-IP addr     = 10.196.157.189
-baudrate    = 115200 bps
-=> tftpboot uImage
-ethernet at 10090000: PHY present at 0
-ethernet at 10090000: Starting autonegotiation...
-ethernet at 10090000: Autonegotiation complete
-ethernet at 10090000: link up, 1000Mbps full-duplex (lpa: 0x3800)
-Using ethernet at 10090000 device
-TFTP from server 10.11.143.218; our IP address is 10.196.157.189; sending through gateway 10.196.156.1
-Filename 'uImage'.
-Load address: 0x80200000
-Loading: #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         #################################################################
-         ##########################################################
-         2.5 MiB/s
-done
-Bytes transferred = 14939132 (e3f3fc hex)
-=> bootm 0x80200000 - 0x82200000
-## Booting kernel from Legacy Image at 80200000 ...
-   Image Name:   Linux
-   Image Type:   RISC-V Linux Kernel Image (uncompressed)
-   Data Size:    14939068 Bytes = 14.2 MiB
-   Load Address: 80200000
-   Entry Point:  80200000
-   Verifying Checksum ... OK
-## Flattened Device Tree blob at 82200000
-   Booting using the fdt blob at 0x82200000
-   Loading Kernel Image ... OK
-   Using Device Tree in place at 0000000082200000, end 0000000082205c69
-
-Starting kernel ...
-
-[    0.000000] OF: fdt: Ignoring memory range 0x80000000 - 0x80200000
-[    0.000000] Linux version 5.0.0-rc1-00020-g4b51f736 (atish at jedi-01) (gcc version 7.2.0 (GCC)) #262 SMP Mon Jan 21 17:39:27 PST 2019
-[    0.000000] initrd not found or empty - disabling initrd
-[    0.000000] Zone ranges:
-[    0.000000]   DMA32    [mem 0x0000000080200000-0x00000000ffffffff]
-[    0.000000]   Normal   [mem 0x0000000100000000-0x000027ffffffffff]
-[    0.000000] Movable zone start for each node
-[    0.000000] Early memory node ranges
-[    0.000000]   node   0: [mem 0x0000000080200000-0x000000027fffffff]
-[    0.000000] Initmem setup node 0 [mem 0x0000000080200000-0x000000027fffffff]
-[    0.000000] software IO TLB: mapped [mem 0xfbfff000-0xfffff000] (64MB)
-[    0.000000] CPU with hartid=0 has a non-okay status of "masked"
-[    0.000000] CPU with hartid=0 has a non-okay status of "masked"
-[    0.000000] elf_hwcap is 0x112d
-[    0.000000] percpu: Embedded 15 pages/cpu @(____ptrval____) s29720 r0 d31720 u61440
-[    0.000000] Built 1 zonelists, mobility grouping on.  Total pages: 2067975
-[    0.000000] Kernel command line: earlyprintk
-[    0.000000] Dentry cache hash table entries: 1048576 (order: 11, 8388608 bytes)
-[    0.000000] Inode-cache hash table entries: 524288 (order: 10, 4194304 bytes)
-[    0.000000] Sorting __ex_table...
-[    0.000000] Memory: 8178760K/8386560K available (3309K kernel code, 248K rwdata, 872K rodata, 9381K init, 763K bss, 207800K reserved, 0K cma-reserved)
-[    0.000000] SLUB: HWalign=64, Order=0-3, MinObjects=0, CPUs=4, Nodes=1
-[    0.000000] rcu: Hierarchical RCU implementation.
-[    0.000000] rcu:     RCU event tracing is enabled.
-[    0.000000] rcu:     RCU restricting CPUs from NR_CPUS=8 to nr_cpu_ids=4.
-[    0.000000] rcu: RCU calculated value of scheduler-enlistment delay is 10 jiffies.
-[    0.000000] rcu: Adjusting geometry for rcu_fanout_leaf=16, nr_cpu_ids=4
-[    0.000000] NR_IRQS: 0, nr_irqs: 0, preallocated irqs: 0
-[    0.000000] plic: mapped 53 interrupts to 4 (out of 9) handlers.
-[    0.000000] riscv_timer_init_dt: Registering clocksource cpuid [0] hartid [1]
-[    0.000000] clocksource: riscv_clocksource: mask: 0xffffffffffffffff max_cycles: 0x1d854df40, max_idle_ns: 3526361616960 ns
-[    0.000008] sched_clock: 64 bits at 1000kHz, resolution 1000ns, wraps every 2199023255500ns
-[    0.000221] Console: colour dummy device 80x25
-[    0.000902] printk: console [tty0] enabled
-[    0.000963] Calibrating delay loop (skipped), value calculated using timer frequency.. 2.00 BogoMIPS (lpj=10000)
-[    0.001034] pid_max: default: 32768 minimum: 301
-[    0.001541] Mount-cache hash table entries: 16384 (order: 5, 131072 bytes)
-[    0.001912] Mountpoint-cache hash table entries: 16384 (order: 5, 131072 bytes)
-[    0.003542] rcu: Hierarchical SRCU implementation.
-[    0.004347] smp: Bringing up secondary CPUs ...
-[    1.040259] CPU1: failed to come online
-[    2.080483] CPU2: failed to come online
-[    3.120699] CPU3: failed to come online
-[    3.120765] smp: Brought up 1 node, 1 CPU
-[    3.121923] devtmpfs: initialized
-[    3.124649] clocksource: jiffies: mask: 0xffffffff max_cycles: 0xffffffff, max_idle_ns: 19112604462750000 ns
-[    3.124727] futex hash table entries: 1024 (order: 4, 65536 bytes)
-[    3.125346] random: get_random_u32 called from bucket_table_alloc+0x72/0x172 with crng_init=0
-[    3.125578] NET: Registered protocol family 16
-[    3.126400] sifive-u54-prci 10000000.prci: Registered U54 core clocks
-[    3.126649] sifive-gemgxl-mgmt 100a0000.cadence-gemgxl-mgmt: Registered clock switch 'cadence-gemgxl-mgmt'
-[    3.135572] vgaarb: loaded
-[    3.135858] SCSI subsystem initialized
-[    3.136193] usbcore: registered new interface driver usbfs
-[    3.136266] usbcore: registered new interface driver hub
-[    3.136348] usbcore: registered new device driver usb
-[    3.136446] pps_core: LinuxPPS API ver. 1 registered
-[    3.136484] pps_core: Software ver. 5.3.6 - Copyright 2005-2007 Rodolfo Giometti <[email protected]>
-[    3.136575] PTP clock support registered
-[    3.137256] clocksource: Switched to clocksource riscv_clocksource
-[    3.142711] NET: Registered protocol family 2
-[    3.143322] tcp_listen_portaddr_hash hash table entries: 4096 (order: 4, 65536 bytes)
-[    3.143634] TCP established hash table entries: 65536 (order: 7, 524288 bytes)
-[    3.145799] TCP bind hash table entries: 65536 (order: 8, 1048576 bytes)
-[    3.149121] TCP: Hash tables configured (established 65536 bind 65536)
-[    3.149591] UDP hash table entries: 4096 (order: 5, 131072 bytes)
-[    3.150094] UDP-Lite hash table entries: 4096 (order: 5, 131072 bytes)
-[    3.150781] NET: Registered protocol family 1
-[    3.230693] workingset: timestamp_bits=62 max_order=21 bucket_order=0
-[    3.241224] io scheduler mq-deadline registered
-[    3.241269] io scheduler kyber registered
-[    3.242143] sifive_gpio 10060000.gpio: SiFive GPIO chip registered 16 GPIOs
-[    3.242357] pwm-sifivem 10020000.pwm: Unable to find controller clock
-[    3.242439] pwm-sifivem 10021000.pwm: Unable to find controller clock
-[    3.243228] xilinx-pcie 2000000000.pci: PCIe Link is DOWN
-[    3.243289] xilinx-pcie 2000000000.pci: host bridge /soc/pci at 2000000000 ranges:
-[    3.243360] xilinx-pcie 2000000000.pci:   No bus range found for /soc/pci at 2000000000, using [bus 00-ff]
-[    3.243447] xilinx-pcie 2000000000.pci:   MEM 0x40000000..0x5fffffff -> 0x40000000
-[    3.243591] xilinx-pcie 2000000000.pci: PCI host bridge to bus 0000:00
-[    3.243636] pci_bus 0000:00: root bus resource [bus 00-ff]
-[    3.243676] pci_bus 0000:00: root bus resource [mem 0x40000000-0x5fffffff]
-[    3.276547] Serial: 8250/16550 driver, 4 ports, IRQ sharing disabled
-[    3.277689] 10010000.serial: ttySIF0 at MMIO 0x10010000 (irq = 39, base_baud = 0) is a SiFive UART v0
-[    3.786963] printk: console [ttySIF0] enabled
-[    3.791504] 10011000.serial: ttySIF1 at MMIO 0x10011000 (irq = 40, base_baud = 0) is a SiFive UART v0
-[    3.801251] sifive_spi 10040000.spi: mapped; irq=41, cs=1
-[    3.806362] m25p80 spi0.0: unrecognized JEDEC id bytes: 9d, 70, 19
-[    3.812084] m25p80: probe of spi0.0 failed with error -2
-[    3.817453] sifive_spi 10041000.spi: mapped; irq=42, cs=4
-[    3.823027] sifive_spi 10050000.spi: mapped; irq=43, cs=1
-[    3.828604] libphy: Fixed MDIO Bus: probed
-[    3.832623] macb: GEM doesn't support hardware ptp.
-[    3.837196] libphy: MACB_mii_bus: probed
-[    4.041156] Microsemi VSC8541 SyncE 10090000.ethernet-ffffffff:00: attached PHY driver [Microsemi VSC8541 SyncE] (mii_bus:phy_addr=10090000.ethernet-ffffffff:00, irq=POLL)
-[    4.055779] macb 10090000.ethernet eth0: Cadence GEM rev 0x10070109 at 0x10090000 irq 12 (70:b3:d5:92:f0:c2)
-[    4.065780] ehci_hcd: USB 2.0 'Enhanced' Host Controller (EHCI) Driver
-[    4.072033] ehci-pci: EHCI PCI platform driver
-[    4.076521] usbcore: registered new interface driver usb-storage
-[    4.082843] softdog: initialized. soft_noboot=0 soft_margin=60 sec soft_panic=0 (nowayout=0)
-[    4.127465] mmc_spi spi2.0: SD/MMC host mmc0, no DMA, no WP, no poweroff
-[    4.133645] usbcore: registered new interface driver usbhid
-[    4.138980] usbhid: USB HID core driver
-[    4.143017] NET: Registered protocol family 17
-[    4.147885] pwm-sifivem 10020000.pwm: SiFive PWM chip registered 4 PWMs
-[    4.153945] pwm-sifivem 10021000.pwm: SiFive PWM chip registered 4 PWMs
-[    4.186407] Freeing unused kernel memory: 9380K
-[    4.190224] This architecture does not have kernel memory protection.
-[    4.196609] Run /init as init process
-Starting logging: OK
-Starting mdev...
-[    4.303785] mmc0: host does not support reading read-only switch, assuming write-enable
-[    4.311109] mmc0: new SDHC card on SPI
-[    4.317103] mmcblk0: mmc0:0000 SS08G 7.40 GiB
-[    4.386471]  mmcblk0: p1 p2
-sort: /sys/devices/platform/Fixed: No such file or directory
-modprobe: can't change directory to '/lib/modules': No such file or directory
-Initializing random[    4.759075] random: dd: uninitialized urandom read (512 bytes read)
- number generator... done.
-Starting network...
-udhcpc (v1.24.2) started
-Sending discover...
-Sending discover...
-[    7.927510] macb 10090000.ethernet eth0: link up (1000/Full)
-Sending discover...
-Sending select for 10.196.157.190...
-Lease of 10.196.157.190 obtained, lease time 499743
-deleting routers
-adding dns 10.86.1.1
-adding dns 10.86.2.1
-/etc/init.d/S50dropbear
-Starting dropbear sshd: [   12.772393] random: dropbear: uninitialized urandom read (32 bytes read)
-OK
-
-Welcome to Buildroot
-buildroot login:
doc/board/index.rst +1 -0
index 1cf0bc6..f9aa5c9 100644
@@ -11,3 +11,4 @@ Board-specific doc
    emulation/index
    google/index
    intel/index
+   sifive/index
doc/board/sifive/fu540.rst new file +321 -0

321 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#37 lore raw

PATCH 36/50 doc: board: Convert README.sh7752evb to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/README.sh7752evb            | 67 ----------------------------------
 doc/board/index.rst             |  1 +
 doc/board/renesas/sh7752evb.rst | 79 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 80 insertions(+), 67 deletions(-)
 delete mode 100644 doc/README.sh7752evb
 create mode 100644 doc/board/renesas/sh7752evb.rst
doc/README.sh7752evb deleted +0 -67
deleted file mode 100644
index c1fb54c..0000000
@@ -1,67 +0,0 @@
-========================================
-Renesas R0P7752C00000RZ board
-========================================
-
-This board specification:
-=========================
-
-The R0P7752C00000RZ(board config name:sh7752evb) has the following device:
-
- - SH7752 (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 sh7752evb_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
doc/board/index.rst +1 -0
index f9aa5c9..339a2a1 100644
@@ -11,4 +11,5 @@ Board-specific doc
    emulation/index
    google/index
    intel/index
+   renesas/index
    sifive/index
doc/board/renesas/sh7752evb.rst new file +79 -0

79 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#38 lore raw

PATCH 37/50 doc: board: Convert README.sh7753evb to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 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
doc/README.sh7753evb deleted +0 -67
deleted file mode 100644
index 5fe178c..0000000
@@ -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
doc/board/renesas/sh7753evb.rst new file +79 -0

79 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#39 lore raw

PATCH 38/50 doc: board: Convert README.at91 to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/README.at91            | 174 ----------------------------------------
 doc/board/atmel/at91ek.rst | 192 +++++++++++++++++++++++++++++++++++++++++++++
 doc/board/index.rst        |   1 +
 3 files changed, 193 insertions(+), 174 deletions(-)
 delete mode 100644 doc/README.at91
 create mode 100644 doc/board/atmel/at91ek.rst
doc/README.at91 deleted +0 -174
deleted file mode 100644
index 39dd563..0000000
@@ -1,174 +0,0 @@
-Atmel AT91 Evaluation kits
-
-Index
-  - I. Board mapping & boot media
-  - II. NAND partition table
-  - III. watchdog support
-
-I. Board mapping & boot media
-------------------------------------------------------------------------------
-AT91SAM9260EK, AT91SAM9G20EK & AT91SAM9XEEK
-------------------------------------------------------------------------------
-
-Memory map
-	0x20000000 - 23FFFFFF	SDRAM (64 MB)
-	0xC0000000 - Cxxxxxxx	Atmel Dataflash card (J13)
-	0xD0000000 - D07FFFFF	Soldered Atmel Dataflash (AT45DB642)
-
-Environment variables
-
-	U-Boot environment variables can be stored at different places:
-		- Dataflash on SPI chip select 1 (default)
-		- Dataflash on SPI chip select 0 (dataflash card)
-		- Nand flash.
-
-	You can choose your storage location at config step (here for at91sam9260ek) :
-		make at91sam9260ek_nandflash_config	- use nand flash
-		make at91sam9260ek_dataflash_cs0_config	- use data flash (spi cs0)
-		make at91sam9260ek_dataflash_cs1_config	- use data flash (spi cs1)
-
-
-------------------------------------------------------------------------------
-AT91SAM9261EK, AT91SAM9G10EK
-------------------------------------------------------------------------------
-
-Memory map
-	0x20000000 - 23FFFFFF	SDRAM (64 MB)
-	0xC0000000 - C07FFFFF	Soldered Atmel Dataflash (AT45DB642)
-	0xD0000000 - Dxxxxxxx	Atmel Dataflash card (J22)
-
-Environment variables
-
-	U-Boot environment variables can be stored at different places:
-		- Dataflash on SPI chip select 0 (default)
-		- Dataflash on SPI chip select 3 (dataflash card)
-		- Nand flash.
-
-	You can choose your storage location at config step (here for at91sam9260ek) :
-		make at91sam9261ek_nandflash_config	- use nand flash
-		make at91sam9261ek_dataflash_cs0_config	- use data flash (spi cs0)
-		make at91sam9261ek_dataflash_cs3_config	- use data flash (spi cs3)
-
-
-------------------------------------------------------------------------------
-AT91SAM9263EK
-------------------------------------------------------------------------------
-
-Memory map
-	0x20000000 - 23FFFFFF	SDRAM (64 MB)
-	0xC0000000 - Cxxxxxxx	Atmel Dataflash card (J9)
-
-Environment variables
-
-	U-Boot environment variables can be stored at different places:
-		- Dataflash on SPI chip select 0 (dataflash card)
-		- Nand flash.
-		- Nor flash (not populate by default)
-
-	You can choose your storage location at config step (here for at91sam9260ek) :
-		make at91sam9263ek_nandflash_config	- use nand flash
-		make at91sam9263ek_dataflash_cs0_config	- use data flash (spi cs0)
-		make at91sam9263ek_norflash_config	- use nor flash
-
-	You can choose to boot directly from U-Boot at config step
-		make at91sam9263ek_norflash_boot_config	- boot from nor flash
-
-
-------------------------------------------------------------------------------
-AT91SAM9M10G45EK
-------------------------------------------------------------------------------
-
-Memory map
-	0x70000000 - 77FFFFFF	SDRAM (128 MB)
-
-Environment variables
-
-	U-Boot environment variables can be stored at different places:
-		- Nand flash.
-
-	You can choose your storage location at config step (here for at91sam9m10g45ek) :
-		make at91sam9m10g45ek_nandflash_config		- use nand flash
-
-
-------------------------------------------------------------------------------
-AT91SAM9RLEK
-------------------------------------------------------------------------------
-
-Memory map
-	0x20000000 - 23FFFFFF	SDRAM (64 MB)
-	0xC0000000 - C07FFFFF   Soldered Atmel Dataflash (AT45DB642)
-
-Environment variables
-
-	U-Boot environment variables can be stored at different places:
-		- Dataflash on SPI chip select 0
-		- Nand flash.
-
-	You can choose your storage location at config step (here for at91sam9rlek) :
-		make at91sam9rlek_nandflash_config	- use nand flash
-
-
-------------------------------------------------------------------------------
-AT91SAM9N12EK, AT91SAM9X5EK
-------------------------------------------------------------------------------
-
-Memory map
-	0x20000000 - 27FFFFFF	SDRAM (128 MB)
-
-Environment variables
-
-	U-Boot environment variables can be stored at different places:
-		- Nand flash.
-		- SD/MMC card
-		- Serialflash/Dataflash on SPI chip select 0
-
-	You can choose your storage location at config step (here for at91sam9x5ek) :
-		make at91sam9x5ek_dataflash_config	- use data flash
-		make at91sam9x5ek_mmc_config		- use sd/mmc card
-		make at91sam9x5ek_nandflash_config	- use nand flash
-		make at91sam9x5ek_spiflash_config	- use serial flash
-
-
-------------------------------------------------------------------------------
-SAMA5D3XEK
-------------------------------------------------------------------------------
-
-Memory map
-	0x20000000 - 3FFFFFFF	SDRAM (512 MB)
-
-Environment variables
-
-	U-Boot environment variables can be stored at different places:
-		- Nand flash.
-		- SD/MMC card
-		- Serialflash on SPI chip select 0
-
-	You can choose your storage location at config step (here for sama5d3xek) :
-		make sama5d3xek_mmc_config		- use SD/MMC card
-		make sama5d3xek_nandflash_config	- use nand flash
-		make sama5d3xek_serialflash_config	- use serial flash
-
-
-II. NAND partition table
-
-	All the board support boot from NAND flash will use the following NAND
-	partition table
-
-		0x00000000 - 0x0003FFFF	bootstrap	(256 KiB)
-		0x00040000 - 0x000BFFFF u-boot		(512 KiB)
-		0x000C0000 - 0x000FFFFF env		(256 KiB)
-		0x00100000 - 0x0013FFFF env_redundant	(256 KiB)
-		0x00140000 - 0x0017FFFF spare		(256 KiB)
-		0x00180000 - 0x001FFFFF dtb		(512 KiB)
-		0x00200000 - 0x007FFFFF kernel		(6 MiB)
-		0x00800000 - 0xxxxxxxxx rootfs		(All left)
-
-III. Watchdog support
-
-	For security reasons, the at91 watchdog is running at boot time and,
-	if deactivated, cannot be used anymore.
-	If you want to use the watchdog, you will need to keep it running in
-	your code (make sure not to disable it in AT91Bootstrap for instance).
-
-	In the U-Boot configuration, the AT91 watchdog support is enabled using
-	the CONFIG_WDT and CONFIG_WDT_AT91 options.
doc/board/atmel/at91ek.rst new file +192 -0

192 lines not on this page · raw message

doc/board/index.rst +1 -0
index 339a2a1..b2f83b6 100644
@@ -7,6 +7,7 @@ Board-specific doc
    :maxdepth: 2
 
    AndesTech/index
+   atmel/index
    coreboot/index
    emulation/index
    google/index
Signature · 1 line
2.7.4
author
#40 lore raw

PATCH 39/50 doc: board: Convert README.b4860qds to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/README.b4860qds              | 366 -------------------------------
 doc/board/freescale/b4860qds.rst | 453 +++++++++++++++++++++++++++++++++++++++
 doc/board/index.rst              |   1 +
 3 files changed, 454 insertions(+), 366 deletions(-)
 delete mode 100644 doc/README.b4860qds
 create mode 100644 doc/board/freescale/b4860qds.rst
doc/README.b4860qds deleted +0 -366
deleted file mode 100644
index 889c8a9..0000000
@@ -1,366 +0,0 @@
-Overview
---------
-The B4860QDS is a Freescale reference board that hosts the B4860 SoC (and variants).
-
-B4860 Overview
--------------
-The B4860 QorIQ Qonverge device is a Freescale high-end, multicore SoC based on
-StarCore and Power Architecture® cores. It targets the broadband wireless
-infrastructure and builds upon the proven success of the existing multicore
-DSPs and Power CPUs. It is designed to bolster the rapidly changing and
-expanding wireless markets, such as 3GLTE (FDD and TDD), LTE-Advanced, and UMTS.
-
-The B4860 is a highly-integrated StarCore and Power Architecture processor that
-contains:
-. Six fully-programmable StarCore SC3900 FVP subsystems, divided into three
-clusters-each core runs up to 1.2 GHz, with an architecture highly optimized for
-wireless base station applications
-. Four dual-thread e6500 Power Architecture processors organized in one cluster-each
-core runs up to 1.8 GHz
-. Two DDR3/3L controllers for high-speed, industry-standard memory interface each
-runs at up to 1866.67 MHz
-. MAPLE-B3 hardware acceleration-for forward error correction schemes including
-Turbo or Viterbi decoding, Turbo encoding and rate matching, MIMO MMSE
-equalization scheme, matrix operations, CRC insertion and check, DFT/iDFT and
-FFT/iFFT calculations, PUSCH/PDSCH acceleration, and UMTS chip rate
-acceleration
-. CoreNet fabric that fully supports coherency using MESI protocol between the
-  e6500 cores, SC3900 FVP cores, memories and external interfaces.
-  CoreNet fabric interconnect runs at 667 MHz and supports coherent and
-  non-coherent out of order transactions with prioritization and bandwidth
-  allocation amongst CoreNet endpoints.
-. Data Path Acceleration Architecture, which includes the following:
-. Frame Manager (FMan), which supports in-line packet parsing and general
-  classification to enable policing and QoS-based packet distribution
-. Queue Manager (QMan) and Buffer Manager (BMan), which allow offloading
-  of queue management, task management, load distribution, flow ordering, buffer
-  management, and allocation tasks from the cores
-. Security engine (SEC 5.3)-crypto-acceleration for protocols such as IPsec,
-  SSL, and 802.16
-. RapidIO manager (RMAN) - Support SRIO types 8, 9, 10, and 11 (inbound and
-  outbound). Supports types 5, 6 (outbound only)
-. Large internal cache memory with snooping and stashing capabilities for
-  bandwidth saving and high utilization of processor elements. The 9856-Kbyte
-  internal memory space includes the following:
-. 32 Kbyte L1 ICache per e6500/SC3900 core
-. 32 Kbyte L1 DCache per e6500/SC3900 core
-. 2048 Kbyte unified L2 cache for each SC3900 FVP cluster
-. 2048 Kbyte unified L2 cache for the e6500 cluster
-. Two 512 Kbyte shared L3 CoreNet platform caches (CPC)
-. Sixteen 10-GHz SerDes lanes serving:
-. Two Serial RapidIO interfaces.
-	- Each supports up to 4 lanes and a total of up to 8 lanes
-. Up to 8-lanes Common Public Radio Interface (CPRI) controller for glue-less
-  antenna connection
-. Two 10-Gbit Ethernet controllers (10GEC)
-. Six 1G/2.5-Gbit Ethernet controllers for network communications
-. PCI Express controller
-. Debug (Aurora)
-. Two OCeaN DMAs
-. Various system peripherals
-. 182 32-bit timers
-
-B4860QDS Overview
-------------------
-- DDRC1: Ten separate DDR3 parts of 16-bit to support 72-bit (ECC) at 1866MT/s, ECC, 4 GB
-  of memory in two ranks of 2 GB.
-- DDRC2: Five separate DDR3 parts of 16-bit to support 72-bit (ECC) at 1866MT/s, ECC, 2 GB
-  of memory. Single rank.
-- SerDes 1 multiplexing: Two Vitesse (transmit and receive path) cross-point 16x16 switch
-  VSC3316
-- SerDes 2 multiplexing: Two Vitesse (transmit and receive path) cross-point 8x8 switch VSC3308
-- USB 2.0 ULPI PHY USB3315 by SMSC supports USB port in host mode.
-  B4860 UART port is available over USB-to-UART translator USB2SER or over RS232 flat cable.
-- A Vitesse dual SGMII phy VSC8662 links the B4860 SGMII lines to 2xRJ-45 copper connectors
-  for Stand-alone mode and to the 1000Base-X over AMC MicroTCA connector ports 0 and 2 for
-  AMC mode.
-- The B4860 configuration may be loaded from nine bits coded reset configuration reset source. The
-  RCW source is set by appropriate DIP-switches:
-- 16-bit NOR Flash / PROMJet
-- QIXIS 8-bit NOR Flash Emulator
-- 8-bit NAND Flash
-- 24-bit SPI Flash
-- Long address I2C EEPROM
-- Available debug interfaces are:
-	- On-board eCWTAP controller with ETH and USB I/F
-	- JTAG/COP 16-pin header for any external TAP controller
-	- External JTAG source over AMC to support B2B configuration
-	- 70-pin Aurora debug connector
-- QIXIS (FPGA) logic:
-	- 2 KB internal memory space including
-- IDT840NT4 clock synthesizer provides B4860 essential clocks : SYSCLK, DDRCLK1,2 and
-  RTCCLK.
-- Two 8T49N222A SerDes ref clock devices support two SerDes port clock frequency - total four
-  refclk, including CPRI clock scheme.
-
-B4420 Personality
---------------------
-
-B4420 Personality
---------------------
-B4420 is a reduced personality of B4860 with less core/clusters(both SC3900 and e6500), less DDR
-controllers, less serdes lanes, less SGMII interfaces and reduced target frequencies.
-
-Key differences between B4860 and B4420
-----------------------------------------
-
-B4420 has:
-1. Less e6500 cores: 1 cluster with 2 e6500 cores
-2. Less SC3900 cores/clusters: 1 cluster with 2 SC3900 cores per cluster.
-3. Single DDRC
-4. 2X 4 lane serdes
-5. 3 SGMII interfaces
-6. no sRIO
-7. no 10G
-
-B4860QDS Default Settings
--------------------------
-
-Switch Settings
-----------------
-
-SW1	OFF [0]	OFF [0]	OFF [0]	OFF [0]	OFF [0]	OFF [0]	OFF [0]	OFF [0]
-SW2	ON	ON	ON	ON	ON	ON	OFF	OFF
-SW3	OFF	OFF	OFF	ON	OFF	OFF	ON	OFF
-SW5	OFF	OFF	OFF	OFF	OFF	OFF	ON	ON
-
-Note: PCIe slots modes: All the PCIe devices work as Root Complex.
-Note: Boot location: NOR flash.
-
-SysClk/Core(e6500)/CCB/DDR/FMan/DDRCLK/StarCore/CPRI-Maple/eTVPE-Maple/ULB-Maple
-66MHz/1.6GHz/667MHz/1.6GHz data rate/667MHz/133MHz/1200MHz/500MHz/800MHz/667MHz
-
-a) NAND boot
-	SW1 [1.1] = 0
-	SW2 [1.1] = 1
-	SW3 [1:4] = 0001
-b) NOR boot
-	SW1 [1.1] = 1
-	SW2 [1.1] = 0
-	SW3 [1:4] = 1000.
-
-B4420QDS Default Settings
--------------------------
-
-Switch Settings
-----------------
-SW1	OFF[0]	OFF [0]	OFF [0]	OFF [0]	OFF [0]	OFF [0]	OFF [0]	OFF [0]
-SW2	ON	OFF	ON	OFF	ON	ON	OFF	OFF
-SW3	OFF	OFF	OFF	ON	OFF	OFF	ON	OFF
-SW5	OFF	OFF	OFF	OFF	OFF	OFF	ON	ON
-
-Note: PCIe slots modes: All the PCIe devices work as Root Complex.
-Note: Boot location: NOR flash.
-
-SysClk/Core(e6500)/CCB/DDR/FMan/DDRCLK/StarCore/CPRI-Maple/eTVPE-Maple/ULB-Maple
-66MHz/1.6GHz/667MHz/1.6GHz data rate/667MHz/133MHz/1200MHz/500MHz/800MHz/667MHz
-
-a) NAND boot
-	SW1 [1.1] = 0
-	SW2 [1.1] = 1
-	SW3 [1:4] = 0001
-b) NOR boot
-	SW1 [1.1] = 1
-	SW2 [1.1] = 0
-	SW3 [1:4] = 1000.
-
-Memory map on B4860QDS
-----------------------
-The addresses in brackets are physical addresses.
-
-Start Address	End Address	Description	Size
-0xF_FFDF_1000 	0xF_FFFF_FFFF	Free		2 MB
-0xF_FFDF_0000 	0xF_FFDF_0FFF	IFC - FPGA 	4 KB
-0xF_FF81_0000 	0xF_FFDE_FFFF	Free		5 MB
-0xF_FF80_0000	0xF_FF80_FFFF	IFC NAND Flash	64 KB
-0xF_FF00_0000	0xF_FF7F_FFFF	Free		8 MB
-0xF_FE00_0000 	0xF_FEFF_FFFF	CCSRBAR		16 MB
-0xF_F801_0000 	0xF_FDFF_FFFF	Free		95 MB
-0xF_F800_0000	0xF_F800_FFFF	PCIe I/O Space 	64 KB
-0xF_F600_0000 	0xF_F7FF_FFFF	QMAN s/w portal	32 MB
-0xF_F400_0000 	0xF_F5FF_FFFF	BMAN s/w portal	32 MB
-0xF_F000_0000 	0xF_F3FF_FFFF	Free		64 MB
-0xF_E800_0000 	0xF_EFFF_FFFF	IFC  NOR Flash 	128 MB
-0xF_E000_0000	0xF_E7FF_FFFF	Promjet		128 MB
-0xF_A0C0_0000 	0xF_DFFF_FFFF	Free		1012 MB
-0xF_A000_0000 	0xF_A0BF_FFFF	MAPLE0/1/2	12 MB
-0xF_0040_0000 	0xF_9FFF_FFFF	Free		12 GB
-0xF_0000_0000 	0xF_01FF_FFFF	DCSR		32 MB
-0xC_4000_0000 	0xE_FFFF_FFFF	Free		11 GB
-0xC_3000_0000 	0xC_3FFF_FFFF	sRIO-2 I/O 	256 MB
-0xC_2000_0000 	0xC_2FFF_FFFF	sRIO-1 I/O  	256 MB
-0xC_0000_0000	0xC_1FFF_FFFF	PCIe Mem Space 	512 MB
-0x1_0000_0000 	0xB_FFFF_FFFF	Free		44 GB
-0x0_8000_0000 	0x0_FFFF_FFFF	DDRC1		2 GB
-0x0_0000_0000 	0x0_7FFF_FFFF	DDRC2	  	2 GB
-
-Memory map on B4420QDS
-----------------------
-The addresses in brackets are physical addresses.
-
-Start Address	End Address	Description	Size
-0xF_FFDF_1000 	0xF_FFFF_FFFF	Free		2 MB
-0xF_FFDF_0000 	0xF_FFDF_0FFF	IFC - FPGA 	4 KB
-0xF_FF81_0000 	0xF_FFDE_FFFF	Free		5 MB
-0xF_FF80_0000	0xF_FF80_FFFF	IFC NAND Flash	64 KB
-0xF_FF00_0000	0xF_FF7F_FFFF	Free		8 MB
-0xF_FE00_0000 	0xF_FEFF_FFFF	CCSRBAR		16 MB
-0xF_F801_0000 	0xF_FDFF_FFFF	Free		95 MB
-0xF_F800_0000	0xF_F800_FFFF	PCIe I/O Space 	64 KB
-0xF_F600_0000 	0xF_F7FF_FFFF	QMAN s/w portal	32 MB
-0xF_F400_0000 	0xF_F5FF_FFFF	BMAN s/w portal	32 MB
-0xF_F000_0000 	0xF_F3FF_FFFF	Free		64 MB
-0xF_E800_0000 	0xF_EFFF_FFFF	IFC  NOR Flash 	128 MB
-0xF_E000_0000	0xF_E7FF_FFFF	Promjet		128 MB
-0xF_A0C0_0000 	0xF_DFFF_FFFF	Free		1012 MB
-0xF_A000_0000 	0xF_A0BF_FFFF	MAPLE0/1/2	12 MB
-0xF_0040_0000 	0xF_9FFF_FFFF	Free		12 GB
-0xF_0000_0000 	0xF_01FF_FFFF	DCSR		32 MB
-0xC_4000_0000 	0xE_FFFF_FFFF	Free		11 GB
-0xC_3000_0000 	0xC_3FFF_FFFF	sRIO-2 I/O 	256 MB
-0xC_2000_0000 	0xC_2FFF_FFFF	sRIO-1 I/O  	256 MB
-0xC_0000_0000	0xC_1FFF_FFFF	PCIe Mem Space 	512 MB
-0x1_0000_0000 	0xB_FFFF_FFFF	Free		44 GB
-0x0_0000_0000 	0x0_FFFF_FFFF	DDRC1		4 GB
-
-
-NOR Flash memory Map on B4860 and B4420QDS
-------------------------------------------
- Start		 End		Definition			Size
-0xEFF40000	0xEFFFFFFF	U-Boot (current bank)		768KB
-0xEFF20000	0xEFF3FFFF	U-Boot env (current bank)	128KB
-0xEFF00000	0xEFF1FFFF	FMAN Ucode (current bank)	128KB
-0xEF300000	0xEFEFFFFF	rootfs (alternate bank)		12MB
-0xEE800000	0xEE8FFFFF	device tree (alternate bank)	1MB
-0xEE020000	0xEE6FFFFF	Linux.uImage (alternate bank)	6MB+896KB
-0xEE000000	0xEE01FFFF	RCW (alternate bank)		128KB
-0xEDF40000	0xEDFFFFFF	U-Boot (alternate bank)		768KB
-0xEDF20000	0xEDF3FFFF	U-Boot env (alternate bank)	128KB
-0xEDF00000	0xEDF1FFFF	FMAN ucode (alternate bank)	128KB
-0xED300000	0xEDEFFFFF	rootfs (current bank)		12MB
-0xEC800000	0xEC8FFFFF	device tree (current bank)	1MB
-0xEC020000	0xEC6FFFFF	Linux.uImage (current bank)	6MB+896KB
-0xEC000000	0xEC01FFFF	RCW (current bank)		128KB
-
-Various Software configurations/environment variables/commands
---------------------------------------------------------------
-The below commands apply to both B4860QDS and B4420QDS.
-
-1. U-Boot environment variable hwconfig
-   The default hwconfig is:
-	hwconfig=fsl_ddr:ctlr_intlv=null,bank_intlv=cs0_cs1;usb1:
-					dr_mode=host,phy_type=ulpi
-   Note: For USB gadget set "dr_mode=peripheral"
-
-2. FMAN Ucode versions
-   fsl_fman_ucode_B4860_106_3_6.bin
-
-3. Switching to alternate bank
-   Commands for switching to alternate bank.
-
-	1. To change from vbank0 to vbank2
-		=> qixis_reset altbank (it will boot using vbank2)
-
-	2.To change from vbank2 to vbank0
-		=> qixis reset (it will boot using vbank0)
-
-4. To change personality of board
-   For changing personality from B4860 to B4420
-	1)Boot from vbank0
-	2)Flash vbank2 with b4420 rcw and U-Boot
-	3)Give following commands to uboot prompt
-	   => mw.b ffdf0040 0x30;
-	   => mw.b ffdf0010 0x00;
-	   => mw.b ffdf0062 0x02;
-	   => mw.b ffdf0050 0x02;
-	   => mw.b ffdf0010 0x30;
-	   => reset
-
-   Note: Power off cycle will lead to default switch settings.
-   Note: 0xffdf0000 is the address of the QIXIS FPGA.
-
-5. Switching between NOR and NAND boot(RCW src changed from NOR <-> NAND)
-
-   To change from NOR to NAND boot give following command on uboot prompt
-	=> mw.b ffdf0040 0x30
-	=> mw.b ffdf0010 0x00
-	=> mw.b 0xffdf0050 0x08
-	=> mw.b 0xffdf0060 0x82
-	=> mw.b ffdf0061 0x00
-	=> mw.b ffdf0010 0x30
-	=> reset
-
-   To change from NAND to NOR boot give following command on uboot prompt:
-	=> mw.b ffdf0040 0x30
-	=> mw.b ffdf0010 0x00
-	=> mw.b 0xffdf0050 0x00(for vbank0) or (mw.b 0xffdf0050 0x02 for vbank2)
-	=> mw.b 0xffdf0060 0x12
-	=> mw.b ffdf0061 0x01
-	=> mw.b ffdf0010 0x30
-	=> reset
-
-   Note: Power off cycle will lead to default switch settings.
-   Note: 0xffdf0000 is the address of the QIXIS FPGA.
-
-6.  Ethernet interfaces for B4860QDS
-   Serdes protocosl tested:
-   0x2a, 0x8d (serdes1, serdes2) [DEFAULT]
-   0x2a, 0xb2 (serdes1, serdes2)
-
-   When using [DEFAULT] RCW, which including 2 * 1G SGMII on board and 2 * 1G
-   SGMII on SGMII riser card.
-   Under U-Boot these network interfaces are recognized as:
-   FM1 at DTSEC3, FM1 at DTSEC4, FM1 at DTSEC5 and FM1 at DTSEC6.
-
-   On Linux the interfaces are renamed as:
-	. eth2 -> fm1-gb2
-	. eth3 -> fm1-gb3
-	. eth4 -> fm1-gb4
-	. eth5 -> fm1-gb5
-
-7. RCW and Ethernet interfaces for B4420QDS
-   Serdes protocosl tested:
-   0x18, 0x9e (serdes1, serdes2)
-
-   Under U-Boot these network interfaces are recognized as:
-   FM1 at DTSEC3, FM1 at DTSEC4 and  e1000#0.
-
-   On Linux the interfaces are renamed as:
-	. eth2 -> fm1-gb2
-	. eth3 -> fm1-gb3
-
-NAND boot with 2 Stage boot loader
-----------------------------------
-PBL initialise the internal SRAM and copy SPL(160KB) in SRAM.
-SPL further initialise DDR using SPD and environment variables and copy
-U-Boot(768 KB) from flash to DDR.
-Finally SPL transer control to U-Boot for futher booting.
-
-SPL has following features:
- - Executes within 256K
- - No relocation required
-
- Run time view of SPL framework during  boot :-
- -----------------------------------------------
- Area        | Address                         |
------------------------------------------------
- Secure boot | 0xFFFC0000 (32KB)               |
- headers     |                                 |
- -----------------------------------------------
- GD, BD      | 0xFFFC8000 (4KB)                |
- -----------------------------------------------
- ENV         | 0xFFFC9000 (8KB)                |
- -----------------------------------------------
- HEAP        | 0xFFFCB000 (30KB)               |
- -----------------------------------------------
- STACK       | 0xFFFD8000 (22KB)               |
- -----------------------------------------------
- U-Boot SPL  | 0xFFFD8000 (160KB)              |
- -----------------------------------------------
-
-NAND Flash memory Map on B4860 and B4420QDS
-------------------------------------------
- Start		 End		Definition			Size
-0x000000	0x0FFFFF	U-Boot                          1MB
-0x140000	0x15FFFF	U-Boot env                      128KB
-0x1A0000	0x1BFFFF	FMAN Ucode                      128KB
doc/board/freescale/b4860qds.rst new file +453 -0

453 lines not on this page · raw message

doc/board/index.rst +1 -0
index b2f83b6..a7e94cf 100644
@@ -10,6 +10,7 @@ Board-specific doc
    atmel/index
    coreboot/index
    emulation/index
+   freescale/index
    google/index
    intel/index
    renesas/index
Signature · 1 line
2.7.4
author
#41 lore raw

PATCH 40/50 doc: board: Convert README.zynq to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/board/index.rst                        |  1 +
 doc/{README.zynq => board/xilinx/zynq.rst} | 82 +++++++++++++++++-------------
 2 files changed, 48 insertions(+), 35 deletions(-)
 rename doc/{README.zynq => board/xilinx/zynq.rst} (53%)
doc/board/index.rst +1 -0
index a7e94cf..00e72f5 100644
@@ -15,3 +15,4 @@ Board-specific doc
    intel/index
    renesas/index
    sifive/index
+   xilinx/index
doc/board/xilinx/zynq.rst renamed from doc/README.zynq +47 -35

120 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#42 lore raw

PATCH 41/50 doc: arch: Convert README.x86 to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/arch/index.rst               |   1 +
 doc/{README.x86 => arch/x86.rst} | 286 ++++++++++++++++++++-------------------
 2 files changed, 147 insertions(+), 140 deletions(-)
 rename doc/{README.x86 => arch/x86.rst} (81%)
doc/arch/index.rst +1 -0
index 1aeb7a1..f24b4a3 100644
@@ -7,3 +7,4 @@ Architecture-specific doc
    :maxdepth: 2
 
    mips
+   x86
doc/arch/x86.rst renamed from doc/README.x86 +146 -140

551 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#43 lore raw

PATCH 42/50 doc: arch: Convert README.arm64 to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/{README.arm64 => arch/arm64.rst} | 25 ++++++++++++++-----------
 doc/arch/index.rst                   |  1 +
 2 files changed, 15 insertions(+), 11 deletions(-)
 rename doc/{README.arm64 => arch/arm64.rst} (83%)
doc/arch/arm64.rst renamed from doc/README.arm64 +14 -11
similarity index 83%
rename from doc/README.arm64
rename to doc/arch/arm64.rst
index b0bba0f..80498f6 100644
@@ -1,14 +1,17 @@
-U-Boot for arm64
+.. SPDX-License-Identifier: GPL-2.0+
+
+ARM64
+=====
 
 Summary
-=======
+-------
 The initial arm64 U-Boot port was developed before hardware was available,
 so the first supported platforms were the Foundation and Fast Model for ARMv8.
 These days U-Boot runs on a variety of 64-bit capable ARM hardware, from
 embedded development boards to servers.
 
 Notes
-=====
+-----
 
 1. U-Boot can run at any exception level it is entered in, it is
    recommened to enter it in EL3 if U-Boot takes some responsibilities of a
@@ -46,11 +49,11 @@ Notes
 
 
 Contributors
-============
-   Tom Rini            <[email protected]>
-   Scott Wood          <[email protected]>
-   York Sun            <[email protected]>
-   Simon Glass         <[email protected]>
-   Sharma Bhupesh      <[email protected]>
-   Rob Herring         <[email protected]>
-   Sergey Temerkhanov  <[email protected]>
+------------
+   * Tom Rini            <[email protected]>
+   * Scott Wood          <[email protected]>
+   * York Sun            <[email protected]>
+   * Simon Glass         <[email protected]>
+   * Sharma Bhupesh      <[email protected]>
+   * Rob Herring         <[email protected]>
+   * Sergey Temerkhanov  <[email protected]>
doc/arch/index.rst +1 -0
index f24b4a3..360b5d9 100644
@@ -6,5 +6,6 @@ Architecture-specific doc
 .. toctree::
    :maxdepth: 2
 
+   arm64
    mips
    x86
Signature · 1 line
2.7.4
author
#44 lore raw

PATCH 43/50 doc: arch: Convert README.NDS32 to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

This also merges README.N1213 contents into the new nds32.rst file.

---

 doc/README.N1213   |  55 -----------------------------
 doc/README.NDS32   |  41 ----------------------
 doc/arch/index.rst |   1 +
 doc/arch/nds32.rst | 101 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 102 insertions(+), 96 deletions(-)
 delete mode 100644 doc/README.N1213
 delete mode 100644 doc/README.NDS32
 create mode 100644 doc/arch/nds32.rst
doc/README.N1213 deleted +0 -55
deleted file mode 100644
index e107166..0000000
@@ -1,55 +0,0 @@
-N1213 is a configurable hard/soft core of NDS32's N12 CPU family.
-
-Features
-========
-
-CPU Core
- - 16-/32-bit mixable instruction format.
- - 32 general-purpose 32-bit registers.
- - 8-stage pipeline.
- - Dynamic branch prediction.
- - 32/64/128/256 BTB.
- - Return address stack (RAS).
- - Vector interrupts for internal/external.
-   interrupt controller with 6 hardware interrupt signals.
- - 3 HW-level nested interruptions.
- - User and super-user mode support.
- - Memory-mapped I/O.
- - Address space up to 4GB.
-
-Memory Management Unit
- - TLB
-   - 4/8-entry fully associative iTLB/dTLB.
-   - 32/64/128-entry 4-way set-associati.ve main TLB.
-   - TLB locking support
- - Optional hardware page table walker.
- - Two groups of page size support.
-  - 4KB & 1MB.
-  - 8KB & 1MB.
-
-Memory Subsystem
- - I & D cache.
-   - Virtually indexed and physically tagged.
-   - Cache size: 8KB/16KB/32KB/64KB.
-   - Cache line size: 16B/32B.
-   - Set associativity: 2-way, 4-way or direct-mapped.
-   - Cache locking support.
- - I & D local memory (LM).
-   - Size: 4KB to 1MB.
-   - Bank numbers: 1 or 2.
-   - Optional 1D/2D DMA engine.
-   - Internal or external to CPU core.
-
-Bus Interface
- - Synchronous/Asynchronous AHB bus: 0, 1 or 2 ports.
- - Synchronous High speed memory port.
-   (HSMP): 0, 1 or 2 ports.
-
-Debug
- - JTAG debug interface.
- - Embedded debug module (EDM).
- - Optional embedded program tracer interface.
-
-Miscellaneous
- - Programmable data endian control.
- - Performance monitoring mechanism.
doc/README.NDS32 deleted +0 -41

41 lines not on this page · raw message

doc/arch/index.rst +1 -0
index 360b5d9..7f10df0 100644
@@ -8,4 +8,5 @@ Architecture-specific doc
 
    arm64
    mips
+   nds32
    x86
doc/arch/nds32.rst new file +101 -0

101 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#45 lore raw

PATCH 44/50 doc: arch: Convert README.nios2 to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/arch/index.rst                   |  1 +
 doc/{README.nios2 => arch/nios2.rst} | 86 +++++++++++++++++++++---------------
 2 files changed, 52 insertions(+), 35 deletions(-)
 rename doc/{README.nios2 => arch/nios2.rst} (51%)
doc/arch/index.rst +1 -0
index 7f10df0..000f5de 100644
@@ -9,4 +9,5 @@ Architecture-specific doc
    arm64
    mips
    nds32
+   nios2
    x86
doc/arch/nios2.rst renamed from doc/README.nios2 +51 -35

143 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#46 lore raw

PATCH 45/50 doc: arch: Convert README.ARC to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/{README.ARC => arch/arc.rst} | 5 +++++
 doc/arch/index.rst               | 1 +
 2 files changed, 6 insertions(+)
 rename doc/{README.ARC => arch/arc.rst} (96%)
doc/arch/arc.rst renamed from doc/README.ARC +5 -0
similarity index 96%
rename from doc/README.ARC
rename to doc/arch/arc.rst
index 5f414fb..f8e04a3 100644
@@ -1,3 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+ARC
+===
+
 Synopsys' DesignWare(r) ARC(r) Processors are a family of 32-bit CPUs
 that SoC designers can optimize for a wide range of uses, from deeply embedded
 to high-performance host applications.
doc/arch/index.rst +1 -0
index 000f5de..93fbb7e 100644
@@ -6,6 +6,7 @@ Architecture-specific doc
 .. toctree::
    :maxdepth: 2
 
+   arc
    arm64
    mips
    nds32
Signature · 1 line
2.7.4
author
#47 lore raw

PATCH 46/50 doc: arch: Convert README.m68k to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/README.m68k    | 150 ----------------------------------------------
 doc/arch/index.rst |   1 +
 doc/arch/m68k.rst  | 170 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 171 insertions(+), 150 deletions(-)
 delete mode 100644 doc/README.m68k
 create mode 100644 doc/arch/m68k.rst
doc/README.m68k deleted +0 -150
deleted file mode 100644
index f867ca1..0000000
@@ -1,150 +0,0 @@
-
-U-Boot for Motorola (or Freescale/NXP) ColdFire processors
-
-===============================================================================
-History
-
-November 02, 2017	Angelo Dureghello <[email protected]>
-August   08, 2005	Jens Scharsig <[email protected]>
-			MCF5282 implementation without preloader
-January  12, 2004	<[email protected]>
-===============================================================================
-
-
-This file contains status information for the port of U-Boot to the
-Motorola ColdFire series of CPUs.
-
-
-1. Overview
-
-The ColdFire instruction set is "assembly source" compatible but an evolution
-of the original 68000 instruction set. Some not much used instructions has
-been removed. The instructions are only 16, 32, or 48 bits long, a
-simplification compared to the 68000 series.
-
-Bernhard Kuhn ported U-Boot 0.4.0 to the Motorola ColdFire architecture.
-The patches of Bernhard support the MCF5272 and MCF5282. A great disadvantage
-of these patches was that they needed a pre-bootloader to start U-Boot.
-Because of this, a new port was created which no longer needs a first stage
-booter.
-
-Thanks mainly to Freescale but also to several other contributors, U-Boot now
-supports nearly the entire range of ColdFire processors and their related
-development boards.
-
-
-2. Supported CPU families
-
-Please "make menuconfig" with ARCH=m68k, or check arch/m68k/cpu to see the
-currently supported processor and families.
-
-
-3. Supported boards
-
-U-Boot supports actually more than 40 ColdFire based boards.
-Board configuration can be done trough include/configs/<boardname>.h but the
-current recommended method is to use the new and more friendly approach as
-the "make menuconfig" way, very similar to the Linux way.
-
-To know details as memory map, build targets, default setup, etc, of a
-specific board please check:
-
-include/configs/<boardname>.h
-and/or
-configs/<boardname>_defconfig
-
-It is possible to build all ColdFire boards in a single command-line command,
-from u-boot root directory, as:
-
-./tools/buildman/buildman m68k
-
-
-3.1. Build U-Boot for a specific board
-
-A bash script similar to the one below may be used:
-
-#!/bin/bash
-
-export CROSS_COMPILE=/opt/toolchains/m68k/gcc-4.9.0-nolibc/bin/m68k-linux-
-
-board=M5475DFE
-
-make distclean
-make ARCH=m68k ${board}_defconfig
-make ARCH=m68k KBUILD_VERBOSE=1
-
-
-4. Adopted toolchains
-
-Please check:
-https://www.denx.de/wiki/U-Boot/ColdFireNotes
-
-
-5. ColdFire specific configuration options/settings
-
-
-5.1. Configuration to use a pre-loader
-
-If U-Boot should be loaded to RAM and started by a pre-loader
-CONFIG_MONITOR_IS_IN_RAM must be defined. If it is defined the
-initial vector table and basic processor initialization will not
-be compiled in. The start address of U-Boot must be adjusted in
-the boards config header file (CONFIG_SYS_MONITOR_BASE) and Makefile
-(CONFIG_SYS_TEXT_BASE) to the load address.
-
-
-5.2 ColdFire CPU specific options/settings
-
-To specify a CPU model, some defines shoudl be used, i.e.:
-
-CONFIG_MCF52x2	-- defined for all MCF52x2 CPUs
-CONFIG_M5272	-- defined for all Motorola MCF5272 CPUs
-
-Other options, generally set inside include/configs/<boardname>.h, they may
-apply to one or more cpu for the ColdFire family:
-
-CONFIG_SYS_MBAR	-- defines the base address of the MCF5272 configuration
-		   registers
-CONFIG_SYS_ENET_BD_BASE
-		-- defines the base address of the FEC buffer descriptors
-CONFIG_SYS_SCR	-- defines the contents of the System Configuration Register
-CONFIG_SYS_SPR	-- defines the contents of the System Protection Register
-CONFIG_SYS_MFD	-- defines the PLL Multiplication Factor Divider
-		   (see table 9-4 of MCF user manual)
-CONFIG_SYS_RFD	-- defines the PLL Reduce Frequency Devider
-		   (see table 9-4 of MCF user manual)
-CONFIG_SYS_CSx_BASE
-		-- defines the base address of chip select x
-CONFIG_SYS_CSx_SIZE
-		-- defines the memory size (address range) of chip select x
-CONFIG_SYS_CSx_WIDTH
-		-- defines the bus with of chip select x
-CONFIG_SYS_CSx_MASK
-		-- defines the mask for the related chip select x
-CONFIG_SYS_CSx_RO
-		-- if set to 0 chip select x is read/write else chip select
-		   is read only
-CONFIG_SYS_CSx_WS
-		-- defines the number of wait states  of chip select x
-CONFIG_SYS_CACHE_ICACR
-CONFIG_SYS_CACHE_DCACR
-CONFIG_SYS_CACHE_ACRX
-		-- cache-related registers config
-CONFIG_SYS_SDRAM_BASE
-CONFIG_SYS_SDRAM_SIZE
-CONFIG_SYS_SDRAM_BASEX
-CONFIG_SYS_SDRAM_CFG1
-CONFIG_SYS_SDRAM_CFG2
-CONFIG_SYS_SDRAM_CTRL
-CONFIG_SYS_SDRAM_MODE
-CONFIG_SYS_SDRAM_EMOD
-		-- SDRAM config for SDRAM controller-specific registers, please
-		   see arch/m68k/cpu/<specific_cpu>/start.S files to see how
-		   these options are used.
-CONFIG_MCFUART
-		-- defines enabling of ColdFire UART driver
-CONFIG_SYS_UART_PORT
-		-- defines the UART port to be used (only a single UART can be
-		   actually enabled)
-CONFIG_SYS_SBFHDR_SIZE
-		-- size of the prepended SBF header, if any
doc/arch/index.rst +1 -0
index 93fbb7e..ee90ec1 100644
@@ -8,6 +8,7 @@ Architecture-specific doc
 
    arc
    arm64
+   m68k
    mips
    nds32
    nios2
doc/arch/m68k.rst new file +170 -0

170 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#48 lore raw

PATCH 47/50 doc: arch: Convert README.sh to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/README.sh      |  97 ------------------------------------------------
 doc/arch/index.rst |   1 +
 doc/arch/sh.rst    | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 107 insertions(+), 97 deletions(-)
 delete mode 100644 doc/README.sh
 create mode 100644 doc/arch/sh.rst
doc/README.sh deleted +0 -97
deleted file mode 100644
index 766a8c8..0000000
@@ -1,97 +0,0 @@
-
-U-Boot for Renesas SuperH
-	Last update 01/18/2008 by Nobuhiro Iwamatsu
-
-================================================================================
-0. What's this?
-	This file contains status information for the port of U-Boot to the
-	Renesas SuperH series of CPUs.
-
-================================================================================
-1. Overview
-	SuperH has an original boot loader. However, source code is dirty, and
-	maintenance is not done.
-	To improve sharing and the maintenance of the code, Nobuhiro Iwamatsu
-	started the porting to u-boot in 2007.
-
-================================================================================
-2. Supported CPUs
-
-	2.1. Renesas SH7750/SH7750R
-		This CPU has the SH4 core.
-
-	2.2. Renesas SH7722
-		This CPU has the SH4AL-DSP core.
-
-	2.3. Renesas SH7780
-		This CPU has the SH4A core.
-
-================================================================================
-3. Supported Boards
-
-	3.1. Hitachi UL MS7750SE01/MS7750RSE01
-		Board specific code is in board/ms7750se
-		To use this board, type "make ms7750se_config".
-		Support devices are :
-			- SCIF
-			- SDRAM
-			- NOR Flash
-			- Marubun PCMCIA
-
-	3.2. Hitachi UL MS7722SE01
-		Board specific code is in board/ms7722se
-		To use this board, type "make ms7722se_config".
-		Support devices are :
-			- SCIF
-			- SDRAM
-			- NOR Flash
-			- Marubun PCMCIA
-			- SMC91x ethernet
-
-	3.2. Hitachi UL MS7720ERP01
-		Board specific code is in board/ms7720se
-		To use this board, type "make ms7720se_config".
-		Support devices are :
-			- SCIF
-			- SDRAM
-			- NOR Flash
-			- Marubun PCMCIA
-
-	3.3. Renesas R7780MP
-		Board specific code is in board/r7780mp
-		To use this board, type "make r7780mp_config".
-		Support devices are :
-			- SCIF
-			- DDR-SDRAM
-			- NOR Flash
-			- Compact Flash
-			- ASIX ethernet
-			- SH7780 PCI bridge
-			- RTL8110 ethernet
-
-	** README **
-		In SuperH, S-record and binary of made u-boot work on the memory.
-		When u-boot is written in the flash, it is necessary to change the
-		address by using 'objcopy'.
-		ex) shX-linux-objcopy -Ibinary -Osrec u-boot.bin u-boot.flash.srec
-
-================================================================================
-4. Compiler
-	You can use the following of u-boot to compile.
-		- SuperH Linux Open site
-			http://www.superh-linux.org/
-		- KPIT GNU tools
-			http://www.kpitgnutools.com/
-
-================================================================================
-5. Future
-	I plan to support the following CPUs and boards.
-		5.1. CPUs
-			- SH7751R(SH4)
-
-		5.2. Boards
-			- Many boards ;-)
-
-================================================================================
-Copyright (c) 2007,2008
-    Nobuhiro Iwamatsu <[email protected]>
doc/arch/index.rst +1 -0
index ee90ec1..d24662e 100644
@@ -12,4 +12,5 @@ Architecture-specific doc
    mips
    nds32
    nios2
+   sh
    x86
doc/arch/sh.rst new file +106 -0

106 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#49 lore raw

PATCH 48/50 doc: arch: Convert README.sandbox to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/arch/index.rst                                 |   1 +
 .../sandbox/README.sandbox => doc/arch/sandbox.rst | 251 +++++++++++----------
 2 files changed, 131 insertions(+), 121 deletions(-)
 rename board/sandbox/README.sandbox => doc/arch/sandbox.rst (76%)
doc/arch/index.rst +1 -0
index d24662e..2980b77 100644
@@ -12,5 +12,6 @@ Architecture-specific doc
    mips
    nds32
    nios2
+   sandbox
    sh
    x86
doc/arch/sandbox.rst renamed from board/sandbox/README.sandbox +130 -121

389 lines not on this page · raw message

Signature · 1 line
2.7.4
author
#50 lore raw

PATCH 49/50 doc: arch: Convert README.xtensa to reST

In reply to Bin Meng

Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change.

---

 doc/arch/index.rst                     |  1 +
 doc/{README.xtensa => arch/xtensa.rst} | 24 +++++++++++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)
 rename doc/{README.xtensa => arch/xtensa.rst} (90%)
doc/arch/index.rst +1 -0
index 2980b77..369d8ee 100644
@@ -15,3 +15,4 @@ Architecture-specific doc
    sandbox
    sh
    x86
+   xtensa
doc/arch/xtensa.rst renamed from doc/README.xtensa +13 -11
similarity index 90%
rename from doc/README.xtensa
rename to doc/arch/xtensa.rst
index 4068582..176410d 100644
@@ -1,5 +1,7 @@
-U-Boot for the Xtensa Architecture
-==================================
+.. SPDX-License-Identifier: GPL-2.0+
+
+Xtensa
+======
 
 Xtensa Architecture and Diamond Cores
 -------------------------------------
@@ -35,15 +37,16 @@ directory. The name of that directory starts with 'arch-' followed by
 the name for the processor configuration, for example, arch-dc233c for
 the Diamond DC233 processor.
 
-    core.h	Definitions for the core itself.
+core.h:
+  Definitions for the core itself.
 
 The following files are part of the overlay but not used by U-Boot.
 
-    tie.h	Co-processors and custom extensions defined
-		in the Tensilica Instruction Extension (TIE)
-		language.
-    tie-asm.h	Assembly macros to access custom-defined registers
-		and states.
+tie.h:
+  Co-processors and custom extensions defined in the Tensilica Instruction
+  Extension (TIE) language.
+tie-asm.h:
+  Assembly macros to access custom-defined registers and states.
 
 
 Global Data Pointer, Exported Function Stubs, and the ABI
@@ -92,6 +95,5 @@ U-Boot for Xtensa provides a special memory exception handler that
 reports such access attempts and resets the board.
 
 
-------------------------------------------------------------------------------
-Chris Zankel
-Ross Morley
+.. Chris Zankel
+.. Ross Morley
Signature · 1 line
2.7.4
author
#51 lore raw

PATCH 50/50 doc: Remove README.blackfin

In reply to Bin Meng

U-Boot no longer supports blackfin architecture. Remove the doc.

---

 doc/README.blackfin | 46 ----------------------------------------------
 1 file changed, 46 deletions(-)
 delete mode 100644 doc/README.blackfin
doc/README.blackfin deleted +0 -46
deleted file mode 100644
index a837d90..0000000
@@ -1,46 +0,0 @@
-Notes for the Blackfin architecture port of Das U-Boot
-
- =========
- ! ABOUT !
- =========
-
-<marketing blurb>
-Blackfin Processors embody a new breed of 16/32-bit embedded processor, ideally
-suited for products where a convergence of capabilities are necessary -
-multi-format audio, video, voice and image processing; multi-mode baseband and
-packet processing; control processing; and real-time security.  The Blackfin's
-unique combination of software flexibility and scalability has gained it
-widespread adoption in convergent applications.
-</marketing blurb>
-
-The Blackfin processor is wholly developed by Analog Devices Inc.
-
- ===========
- ! SUPPORT !
- ===========
-
-All open source code for the Blackfin processors are being handled via our
-collaborative website:
-http://blackfin.uclinux.org/
-
-In particular, bug reports, feature requests, help etc... for Das U-Boot are
-handled in the Das U-Boot sub project:
-http://blackfin.uclinux.org/gf/project/u-boot
-
-This website is backed both by an open source community as well as a dedicated
-team from Analog Devices Inc.
-
- =============
- ! TOOLCHAIN !
- =============
-
-To compile the Blackfin aspects, you'll need the GNU toolchain configured for
-the Blackfin processor.  You can obtain such a cross-compiler here:
-http://blackfin.uclinux.org/gf/project/toolchain
-
- =================
- ! DOCUMENTATION !
- =================
-
-For Blackfin specific documentation, you can visit our dedicated doc wiki:
-http://docs.blackfin.uclinux.org/doku.php?id=bootloaders:u-boot
Signature · 1 line
2.7.4
author
#52 lore raw

cover doc: Shape into useful HTML docs

In reply to Bin Meng

Hi Tom,

Quoted 21 lines · Bin Meng

At present there is Sphinx doc build system in U-Boot, however the contents are very limited, e.g.: only a few API descriptions like EFI, are included.

This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree.

With this series, now we have the following major chapters in our U-Boot HTML doc:

- Driver Model
- U-Boot API documentation
- Architecture-specific doc
- Board-specific doc

Board specific documents are put in a vendor subdirectory, just like what we have in <src_tree>/board. All x86 & RISC-V board docs are converted to reST. A few other board docs are converted too.

Quoted 8 lines

Tested by generating the HTML docs, 0 build warnings.

This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Ping?

Regards,
Bin

#53 lore raw

cover doc: Shape into useful HTML docs

Dear Bin,

Quoted 7 lines · In message <CAEUhbmVBz0z+Dh_q1hJKDOuoiJ1ZJ025hiLrYFUwDbp0UrxD1g@mail.gmail.com>…
Quoted 5 lines

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Ping?

Yes, this is possible. Where can I find the HTML files? And where would you want to put them? And what is the planned update strategy?

I mean, plain HTML documents are a bit lame, as they refer to a specific version of U-Boot only. What if I want to see the docs for a version of half a year ago?

What exactly are your plans?

Best regards,

Wolfgang Denk

Signature · 4 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
To be a winner, all you need to give is all you have.
#54 lore raw

cover doc: Shape into useful HTML docs

Quoted 11 lines · Wolfgang Denk

Dear Bin,

Quoted 7 lines · In message <CAEUhbmVBz0z+Dh_q1hJKDOuoiJ1ZJ025hiLrYFUwDbp0UrxD1g@mail.gmail.com>…
Quoted 5 lines

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Ping?

Quoted 7 lines

Yes, this is possible. Where can I find the HTML files? And where would you want to put them? And what is the planned update strategy?

I mean, plain HTML documents are a bit lame, as they refer to a specific version of U-Boot only. What if I want to see the docs for a version of half a year ago?

Thinking out loud, how about .../<VERSION>/ and we re-generate the docs for each full release?

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190723/1cb8793d/attachment.sig>
author
#55 lore raw

cover doc: Shape into useful HTML docs

Hi Tom,

Quoted 17 lines · Tom Rini
Quoted 15 lines · Wolfgang Denk

Dear Bin,

Quoted 7 lines · In message <CAEUhbmVBz0z+Dh_q1hJKDOuoiJ1ZJ025hiLrYFUwDbp0UrxD1g@mail.gmail.com>…
Quoted 5 lines

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Ping?

Yes, this is possible. Where can I find the HTML files? And where would you want to put them? And what is the planned update strategy?

Quoted 6 lines
Quoted 3 lines

I mean, plain HTML documents are a bit lame, as they refer to a specific version of U-Boot only. What if I want to see the docs for a version of half a year ago?

Thinking out loud, how about .../<VERSION>/ and we re-generate the docs for each full release?

If I understand correctly, you were proposing exact the same thing as I thought, so something like:

http://denx.de/u-boot/doc/html/v2018.07/
http://denx.de/u-boot/doc/html/v2019.10-rc1/
http://denx.de/u-boot/doc/html/latest/

Anyway these are doc update strategy and has nothing to do with the patch series itself. If no issues, could you please apply them? I am afraid the longer time it sits in the patch queue, the possibility of merge conflicts happen.

Regards,
Bin

author
#56 lore raw

cover doc: Shape into useful HTML docs

In reply to Wolfgang Denk

Hi Wolfgang,

Quoted 5 lines · Wolfgang Denk

Dear Bin,

Quoted 1 line · In message <CAEUhbmVBz0z+Dh_q1hJKDOuoiJ1ZJ025hiLrYFUwDbp0UrxD1g@mail.gmail.com>…
Quoted 8 lines
Quoted 6 lines
Quoted 4 lines

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Ping?

Yes, this is possible. Where can I find the HTML files? And where

The HTML files can be generated from the U-Boot source tree by "make htmldocs".

Quoted 2 lines

would you want to put them? And what is the planned update strategy?

If possible, can we have denx.de or gitlab.denx.de host the generated HTML docs?

Quoted 6 lines

I mean, plain HTML documents are a bit lame, as they refer to a specific version of U-Boot only. What if I want to see the docs for a version of half a year ago?

What exactly are your plans?

For versioned HTML, let's take a look at how Linux kernel does:
https://www.kernel.org/doc/html/

I think we can imitate Linux by having released doc archive (generated for each release), latest doc which is nightly built that always points to latest htmldocs in the tree. Maybe we can have additional -rc release doc for current release (eg: v2019.10-rc1), and these -rc htmldocs will get cleaned up when the official release is out. Thoughts?

Regards,
Bin

#57 lore raw

cover doc: Shape into useful HTML docs

Dear Bin,

Quoted 7 lines · In message <CAEUhbmXhLPkyiBaMxUgjZ_dyJna_ws63WspGQuzNCtGmjqAZwQ@mail.gmail.com>…

The HTML files can be generated from the U-Boot source tree by "make htmldocs".

Quoted 2 lines

would you want to put them? And what is the planned update strategy?

If possible, can we have denx.de or gitlab.denx.de host the generated HTML docs?

I had hoped for a bit more specific ideas. Where _exactly_ would you want to see them?

Speaking for myself, I would search for them under
http://www.denx.de/wiki/U-Boot/Documentation

?

Quoted 2 lines

For versioned HTML, let's take a look at how Linux kernel does:
https://www.kernel.org/doc/html/

OK, we can copy that.

Best regards,

Wolfgang Denk

Signature · 4 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Bus error -- please leave by the rear door.
author
#58 lore raw

cover doc: Shape into useful HTML docs

Hi Wolfgang,

Quoted 12 lines · Wolfgang Denk

Dear Bin,

Quoted 7 lines · In message <CAEUhbmXhLPkyiBaMxUgjZ_dyJna_ws63WspGQuzNCtGmjqAZwQ@mail.gmail.com>…

The HTML files can be generated from the U-Boot source tree by "make htmldocs".

Quoted 2 lines

would you want to put them? And what is the planned update strategy?

If possible, can we have denx.de or gitlab.denx.de host the generated HTML docs?

Quoted 7 lines

I had hoped for a bit more specific ideas. Where _exactly_ would you want to see them?

Speaking for myself, I would search for them under
http://www.denx.de/wiki/U-Boot/Documentation

?

Sorry if I was not clear enough. Since I am not entirely sure about the denx.de website layout I only say some rough ideas. The new Sphinx htmldoc will have an index.html that can be hooked into a URL.

Quoted 5 lines
Quoted 3 lines

For versioned HTML, let's take a look at how Linux kernel does:
https://www.kernel.org/doc/html/

OK, we can copy that.

I assume you already got my idea :)

Regards,
Bin

#59 lore raw

cover doc: Shape into useful HTML docs

In reply to Bin Meng
Quoted 20 lines · Bin Meng

At present there is Sphinx doc build system in U-Boot, however the contents are very limited, e.g.: only a few API descriptions like EFI, are included.

This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree.

With this series, now we have the following major chapters in our U-Boot HTML doc:

- Driver Model
- U-Boot API documentation
- Architecture-specific doc
- Board-specific doc

Board specific documents are put in a vendor subdirectory, just like what we have in <src_tree>/board. All x86 & RISC-V board docs are converted to reST. A few other board docs are converted too.

Quoted 7 lines

Tested by generating the HTML docs, 0 build warnings.

This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

As a follow-up, please update .gitlab-ci.yml at least to include a run of "make htmldocs". If we need to update the Dockerfile to include new utils we can do that too, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190724/f95de78a/attachment.sig>
author
#60 lore raw

cover doc: Shape into useful HTML docs

Hi Tom,

Quoted 27 lines · Tom Rini
Quoted 24 lines · Bin Meng

At present there is Sphinx doc build system in U-Boot, however the contents are very limited, e.g.: only a few API descriptions like EFI, are included.

This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree.

With this series, now we have the following major chapters in our U-Boot HTML doc:

- Driver Model
- U-Boot API documentation
- Architecture-specific doc
- Board-specific doc

Board specific documents are put in a vendor subdirectory, just like what we have in <src_tree>/board. All x86 & RISC-V board docs are converted to reST. A few other board docs are converted too.

Tested by generating the HTML docs, 0 build warnings.

This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.

Quoted 7 lines
Quoted 3 lines

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

As a follow-up, please update .gitlab-ci.yml at least to include a run of "make htmldocs". If we need to update the Dockerfile to include new utils we can do that too, thanks!

Yes, but I will need some time to study GitLab's .gitlab-ci.yml :)

Could that be done later?

Regards,
Bin

#61 lore raw

cover doc: Shape into useful HTML docs

Quoted 34 lines · Bin Meng

Hi Tom,

Quoted 31 lines · Tom Rini
Quoted 27 lines · Bin Meng

At present there is Sphinx doc build system in U-Boot, however the contents are very limited, e.g.: only a few API descriptions like EFI, are included.

This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree.

With this series, now we have the following major chapters in our U-Boot HTML doc:

- Driver Model
- U-Boot API documentation
- Architecture-specific doc
- Board-specific doc

Board specific documents are put in a vendor subdirectory, just like what we have in <src_tree>/board. All x86 & RISC-V board docs are converted to reST. A few other board docs are converted too.

Tested by generating the HTML docs, 0 build warnings.

This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Quoted 7 lines
Quoted 3 lines

As a follow-up, please update .gitlab-ci.yml at least to include a run of "make htmldocs". If we need to update the Dockerfile to include new utils we can do that too, thanks!

Yes, but I will need some time to study GitLab's .gitlab-ci.yml :)

Could that be done later?

Yes, to be clear, I asked for a follow-up as I have this otherwise merged locally but can't test it since make htmldocs blows up about a lack of required tools that I don't see documented. Once my current pipeline finishes (of other changes) I'll push this.

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190724/54c57faf/attachment.sig>
#62 lore raw

cover doc: Shape into useful HTML docs

Quoted 39 lines · Tom Rini
Quoted 38 lines · Bin Meng

Hi Tom,

Quoted 34 lines · Tom Rini
Quoted 20 lines · Bin Meng

At present there is Sphinx doc build system in U-Boot, however the contents are very limited, e.g.: only a few API descriptions like EFI, are included.

This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree.

With this series, now we have the following major chapters in our U-Boot HTML doc:

- Driver Model
- U-Boot API documentation
- Architecture-specific doc
- Board-specific doc

Board specific documents are put in a vendor subdirectory, just like what we have in <src_tree>/board. All x86 & RISC-V board docs are converted to reST. A few other board docs are converted too.

Quoted 7 lines

Tested by generating the HTML docs, 0 build warnings.

This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

As a follow-up, please update .gitlab-ci.yml at least to include a run of "make htmldocs". If we need to update the Dockerfile to include new utils we can do that too, thanks!

Quoted 9 lines
Quoted 3 lines

Yes, but I will need some time to study GitLab's .gitlab-ci.yml :)

Could that be done later?

Yes, to be clear, I asked for a follow-up as I have this otherwise merged locally but can't test it since make htmldocs blows up about a lack of required tools that I don't see documented. Once my current pipeline finishes (of other changes) I'll push this.

Hello Tom,

the necessary packages for Ubuntu Bionic to run 'make htmldocs' are:

build-essential sphinx-doc python3-sphinx

A warning occurs requesting packages graphviz and imagemagick.

Graphviz is currently not installable via apt-get but as we currently have no graphics in our documentation you can simply ignore the warnings.

Cf.
https://www.katrinasiegfried.com/single-post/2018/10/24/Installing-GraphViz-on-Linux-Ubuntu-1804LTS

The ReadTheDocs theme can be installed via

git clone https://github.com/readthedocs/sphinx_rtd_theme
cd sphinx_rtd_theme/
sudo apt-get install python3-setuptools
python3 setup.py install

This theme is not really needed but the output looks much nicer.

The generated documentation is available under doc/output/.

Best regards

Heinrich

#63 lore raw

cover doc: Shape into useful HTML docs

In reply to Bin Meng
Quoted 72 lines · Bin Meng

At present there is Sphinx doc build system in U-Boot, however the contents are very limited, e.g.: only a few API descriptions like EFI, are included.

This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree.

With this series, now we have the following major chapters in our U-Boot HTML doc:

- Driver Model
- U-Boot API documentation
- Architecture-specific doc
- Board-specific doc

Board specific documents are put in a vendor subdirectory, just like what we have in <src_tree>/board. All x86 & RISC-V board docs are converted to reST. A few other board docs are converted too.

Tested by generating the HTML docs, 0 build warnings.

This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Bin Meng (50):
doc: Move existing rst files into api sub-directory
doc: Add top-level description about U-Boot documentation
doc: Add driver-model to Sphinx TOC tree
doc: driver-model: Convert README.txt to reST
doc: driver-model: Convert MIGRATION.txt to reST
doc: driver-model: Convert fdt-fixup.txt to reST
doc: driver-model: Convert fs_firmware_loader.txt to reST
doc: driver-model: Convert i2c-howto.txt to reST
doc: driver-model: Convert livetree.txt to reST
doc: driver-model: Convert of-plat.txt to reST
doc: driver-model: Convert pci-info.txt to reST
doc: driver-model: Convert pmic-framework.txt to reST
doc: driver-model: Convert remoteproc-framework.txt to reST
doc: driver-model: Convert serial-howto.txt to reST
doc: driver-model: Convert spi-howto.txt to reST
doc: driver-model: Convert usb-info.txt to reST
doc: Add architecture specific info to Sphinx TOC tree
doc: arch: Convert README.mips to reST
doc: Add board specific info to Sphinx TOC tree
doc: board: Add Intel Crown Bay board doc
doc: board: Add Intel Bay Trail based board docs
doc: board: Add Intel Cherry Hill board doc
doc: board: Add Intel Cougar Canyon 2 board doc
doc: board: Add Intel Edison board doc
doc: board: Add Intel Galileo board doc
doc: board: Add Google Chromebook Link board doc
doc: board: Add Google Chromebook Samus board doc
doc: board: Add coreboot board doc
doc: board: Add QEMU x86 board doc
doc: board: Convert README.qemu-arm to reST
doc: board: Convert README.qemu-riscv to reST
doc: board: Convert README.qemu-mips to reST
doc: board: Add AndesTech ax25-ae350 board doc
doc: board: Convert README.ag101p to reST
doc: board: Convert README.sifive-fu540 to reST
doc: board: Convert README.sh7752evb to reST
doc: board: Convert README.sh7753evb to reST
doc: board: Convert README.at91 to reST
doc: board: Convert README.b4860qds to reST
doc: board: Convert README.zynq to reST
doc: arch: Convert README.x86 to reST
doc: arch: Convert README.arm64 to reST

Quoted 8 lines

doc: arch: Convert README.NDS32 to reST
doc: arch: Convert README.nios2 to reST
doc: arch: Convert README.ARC to reST
doc: arch: Convert README.m68k to reST
doc: arch: Convert README.sh to reST
doc: arch: Convert README.sandbox to reST
doc: arch: Convert README.xtensa to reST
doc: Remove README.blackfin

For the series, applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190724/9c4c28f4/attachment.sig>
#64 lore raw

cover doc: Shape into useful HTML docs

In reply to Bin Meng
Quoted 217 lines · Bin Meng

At present there is Sphinx doc build system in U-Boot, however the contents are very limited, e.g.: only a few API descriptions like EFI, are included.

This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree.

With this series, now we have the following major chapters in our U-Boot HTML doc:

- Driver Model
- U-Boot API documentation
- Architecture-specific doc
- Board-specific doc

Board specific documents are put in a vendor subdirectory, just like what we have in <src_tree>/board. All x86 & RISC-V board docs are converted to reST. A few other board docs are converted too.

Tested by generating the HTML docs, 0 build warnings.

This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Bin Meng (50):
doc: Move existing rst files into api sub-directory
doc: Add top-level description about U-Boot documentation
doc: Add driver-model to Sphinx TOC tree
doc: driver-model: Convert README.txt to reST
doc: driver-model: Convert MIGRATION.txt to reST
doc: driver-model: Convert fdt-fixup.txt to reST
doc: driver-model: Convert fs_firmware_loader.txt to reST
doc: driver-model: Convert i2c-howto.txt to reST
doc: driver-model: Convert livetree.txt to reST
doc: driver-model: Convert of-plat.txt to reST
doc: driver-model: Convert pci-info.txt to reST
doc: driver-model: Convert pmic-framework.txt to reST
doc: driver-model: Convert remoteproc-framework.txt to reST
doc: driver-model: Convert serial-howto.txt to reST
doc: driver-model: Convert spi-howto.txt to reST
doc: driver-model: Convert usb-info.txt to reST
doc: Add architecture specific info to Sphinx TOC tree
doc: arch: Convert README.mips to reST
doc: Add board specific info to Sphinx TOC tree
doc: board: Add Intel Crown Bay board doc
doc: board: Add Intel Bay Trail based board docs
doc: board: Add Intel Cherry Hill board doc
doc: board: Add Intel Cougar Canyon 2 board doc
doc: board: Add Intel Edison board doc
doc: board: Add Intel Galileo board doc
doc: board: Add Google Chromebook Link board doc
doc: board: Add Google Chromebook Samus board doc
doc: board: Add coreboot board doc
doc: board: Add QEMU x86 board doc
doc: board: Convert README.qemu-arm to reST
doc: board: Convert README.qemu-riscv to reST
doc: board: Convert README.qemu-mips to reST
doc: board: Add AndesTech ax25-ae350 board doc
doc: board: Convert README.ag101p to reST
doc: board: Convert README.sifive-fu540 to reST
doc: board: Convert README.sh7752evb to reST
doc: board: Convert README.sh7753evb to reST
doc: board: Convert README.at91 to reST
doc: board: Convert README.b4860qds to reST
doc: board: Convert README.zynq to reST
doc: arch: Convert README.x86 to reST
doc: arch: Convert README.arm64 to reST
doc: arch: Convert README.NDS32 to reST
doc: arch: Convert README.nios2 to reST
doc: arch: Convert README.ARC to reST
doc: arch: Convert README.m68k to reST
doc: arch: Convert README.sh to reST
doc: arch: Convert README.sandbox to reST
doc: arch: Convert README.xtensa to reST
doc: Remove README.blackfin

  doc/README.AX25                                    |  46 --
  doc/README.N1213                                   |  55 --
  doc/README.NDS32                                   |  41 --
  doc/README.ae350                                   | 275 --------
  doc/README.at91                                    | 174 -----
  doc/README.b4860qds                                | 366 ----------
  doc/README.blackfin                                |  46 --
  doc/README.m68k                                    | 150 ----
  doc/README.qemu-mips                               | 195 ------
  doc/README.sh                                      |  97 ---
  doc/README.sh7752evb                               |  67 --
  doc/README.sh7753evb                               |  67 --
  doc/README.sifive-fu540                            | 303 --------
  doc/{ => api}/efi.rst                              |   0
  doc/api/index.rst                                  |  11 +
  doc/{ => api}/linker_lists.rst                     |   0
  doc/{ => api}/serial.rst                           |   0
  doc/{README.ARC => arch/arc.rst}                   |   5 +
  doc/{README.arm64 => arch/arm64.rst}               |  25 +-
  doc/arch/index.rst                                 |  18 +
  doc/arch/m68k.rst                                  | 170 +++++
  doc/{README.mips => arch/mips.rst}                 |  28 +-
  doc/arch/nds32.rst                                 | 101 +++
  doc/{README.nios2 => arch/nios2.rst}               |  86 ++-
  .../sandbox/README.sandbox => doc/arch/sandbox.rst | 251 +++----
  doc/arch/sh.rst                                    | 106 +++
  doc/{README.x86 => arch/x86.rst}                   | 766 ++++-----------------
  doc/{README.xtensa => arch/xtensa.rst}             |  24 +-
  .../AndesTech/adp-ag101p.rst}                      |  26 +-
  doc/board/AndesTech/ax25-ae350.rst                 | 329 +++++++++
  doc/board/atmel/at91ek.rst                         | 192 ++++++
  doc/board/coreboot/coreboot.rst                    |  42 ++
  doc/board/coreboot/index.rst                       |   9 +
  doc/board/emulation/index.rst                      |  12 +
  .../emulation/qemu-arm.rst}                        |  44 +-
  doc/board/emulation/qemu-mips.rst                  | 234 +++++++
  .../emulation/qemu-riscv.rst}                      |  21 +-
  doc/board/emulation/qemu-x86.rst                   | 101 +++
  doc/board/freescale/b4860qds.rst                   | 453 ++++++++++++
  doc/board/google/chromebook_link.rst               |  34 +
  doc/board/google/chromebook_samus.rst              | 101 +++
  doc/board/google/index.rst                         |  10 +
  doc/board/index.rst                                |  18 +
  doc/board/intel/bayleybay.rst                      |  29 +
  doc/board/intel/cherryhill.rst                     |  30 +
  doc/board/intel/cougarcanyon2.rst                  |  24 +
  doc/board/intel/crownbay.rst                       |  43 ++
  doc/board/intel/edison.rst                         |  41 ++
  doc/board/intel/galileo.rst                        |  22 +
  doc/board/intel/index.rst                          |  15 +
  doc/board/intel/minnowmax.rst                      |  70 ++
  doc/board/renesas/sh7752evb.rst                    |  79 +++
  doc/board/renesas/sh7753evb.rst                    |  79 +++
  doc/board/sifive/fu540.rst                         | 321 +++++++++
  doc/{README.zynq => board/xilinx/zynq.rst}         |  82 ++-
  doc/driver-model/{README.txt => design.rst}        | 589 ++++++++--------
  doc/driver-model/{fdt-fixup.txt => fdt-fixup.rst}  |  56 +-
  doc/driver-model/fs_firmware_loader.rst            | 154 +++++
  doc/driver-model/fs_firmware_loader.txt            | 148 ----
  doc/driver-model/{i2c-howto.txt => i2c-howto.rst}  |  36 +-
  doc/driver-model/index.rst                         |  21 +
  doc/driver-model/{livetree.txt => livetree.rst}    |  94 +--
  doc/driver-model/{MIGRATION.txt => migration.rst}  |  44 +-
  doc/driver-model/{of-plat.txt => of-plat.rst}      | 193 +++---
  doc/driver-model/{pci-info.txt => pci-info.rst}    |  21 +-
  .../{pmic-framework.txt => pmic-framework.rst}     | 131 ++--
  ...proc-framework.txt => remoteproc-framework.rst} | 181 ++---
  .../{serial-howto.txt => serial-howto.rst}         |  12 +-
  doc/driver-model/spi-howto.rst                     | 692 +++++++++++++++++++
  doc/driver-model/spi-howto.txt                     | 623 -----------------
  doc/driver-model/{usb-info.txt => usb-info.rst}    | 184 ++---
  doc/index.rst                                      |  69 +-
  72 files changed, 4903 insertions(+), 4279 deletions(-)

delete mode 100644 doc/README.AX25
delete mode 100644 doc/README.N1213
delete mode 100644 doc/README.NDS32
delete mode 100644 doc/README.ae350
delete mode 100644 doc/README.at91
delete mode 100644 doc/README.b4860qds
delete mode 100644 doc/README.blackfin
delete mode 100644 doc/README.m68k
delete mode 100644 doc/README.qemu-mips
delete mode 100644 doc/README.sh
delete mode 100644 doc/README.sh7752evb
delete mode 100644 doc/README.sh7753evb
delete mode 100644 doc/README.sifive-fu540
rename doc/{ => api}/efi.rst (100%)
create mode 100644 doc/api/index.rst
rename doc/{ => api}/linker_lists.rst (100%)
rename doc/{ => api}/serial.rst (100%)
rename doc/{README.ARC => arch/arc.rst} (96%)
rename doc/{README.arm64 => arch/arm64.rst} (83%)
create mode 100644 doc/arch/index.rst
create mode 100644 doc/arch/m68k.rst
rename doc/{README.mips => arch/mips.rst} (74%)
create mode 100644 doc/arch/nds32.rst
rename doc/{README.nios2 => arch/nios2.rst} (51%)
rename board/sandbox/README.sandbox => doc/arch/sandbox.rst (76%) create mode 100644 doc/arch/sh.rst
rename doc/{README.x86 => arch/x86.rst} (51%)
rename doc/{README.xtensa => arch/xtensa.rst} (90%)
rename doc/{README.ag101p => board/AndesTech/adp-ag101p.rst} (83%) create mode 100644 doc/board/AndesTech/ax25-ae350.rst create mode 100644 doc/board/atmel/at91ek.rst
create mode 100644 doc/board/coreboot/coreboot.rst
create mode 100644 doc/board/coreboot/index.rst
create mode 100644 doc/board/emulation/index.rst
rename doc/{README.qemu-arm => board/emulation/qemu-arm.rst} (80%) create mode 100644 doc/board/emulation/qemu-mips.rst rename doc/{README.qemu-riscv => board/emulation/qemu-riscv.rst} (82%) create mode 100644 doc/board/emulation/qemu-x86.rst
create mode 100644 doc/board/freescale/b4860qds.rst
create mode 100644 doc/board/google/chromebook_link.rst create mode 100644 doc/board/google/chromebook_samus.rst create mode 100644 doc/board/google/index.rst
create mode 100644 doc/board/index.rst
create mode 100644 doc/board/intel/bayleybay.rst
create mode 100644 doc/board/intel/cherryhill.rst
create mode 100644 doc/board/intel/cougarcanyon2.rst create mode 100644 doc/board/intel/crownbay.rst
create mode 100644 doc/board/intel/edison.rst
create mode 100644 doc/board/intel/galileo.rst
create mode 100644 doc/board/intel/index.rst
create mode 100644 doc/board/intel/minnowmax.rst
create mode 100644 doc/board/renesas/sh7752evb.rst
create mode 100644 doc/board/renesas/sh7753evb.rst
create mode 100644 doc/board/sifive/fu540.rst
rename doc/{README.zynq => board/xilinx/zynq.rst} (53%) rename doc/driver-model/{README.txt => design.rst} (64%) rename doc/driver-model/{fdt-fixup.txt => fdt-fixup.rst} (89%) create mode 100644 doc/driver-model/fs_firmware_loader.rst delete mode 100644 doc/driver-model/fs_firmware_loader.txt rename doc/driver-model/{i2c-howto.txt => i2c-howto.rst} (82%) create mode 100644 doc/driver-model/index.rst
rename doc/driver-model/{livetree.txt => livetree.rst} (77%) rename doc/driver-model/{MIGRATION.txt => migration.rst} (84%)

Quoted 9 lines

rename doc/driver-model/{of-plat.txt => of-plat.rst} (65%)
rename doc/driver-model/{pci-info.txt => pci-info.rst} (95%)
rename doc/driver-model/{pmic-framework.txt => pmic-framework.rst} (51%) rename doc/driver-model/{remoteproc-framework.txt => remoteproc-framework.rst} (50%) rename doc/driver-model/{serial-howto.txt => serial-howto.rst} (92%) create mode 100644 doc/driver-model/spi-howto.rst
delete mode 100644 doc/driver-model/spi-howto.txt
rename doc/driver-model/{usb-info.txt => usb-info.rst} (77%)

Hello Bin,

current origin/master make htmldocs gives me the following warnings:

reading sources... [100%] board/index

./cmd/efidebug.c:733: WARNING: Unexpected indentation. /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/AndesTech/index' /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/atmel/index'
/doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/freescale/index' /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/renesas/index' /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/sifive/index' /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/xilinx/index'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /doc/board/AndesTech/adp-ag101p.rst: WARNING:
document isn't included in any toctree /doc/board/AndesTech/ax25-ae350.rst: WARNING: document isn't included in any toctree
/doc/board/atmel/at91ek.rst: WARNING: document isn't included in any toctree /doc/board/freescale/b4860qds.rst: WARNING: document isn't included in any toctree
/doc/board/renesas/sh7752evb.rst: WARNING: document isn't included in any toctree
/doc/board/renesas/sh7753evb.rst: WARNING: document isn't included in any toctree
/doc/board/sifive/fu540.rst: WARNING: document isn't included in any toctree /doc/board/xilinx/zynq.rst: WARNING: document isn't included in any toctree done

The efidebug.c one I will care about. Will you have a look at the others, please?

Best regards

Heinrich

author
#65 lore raw

cover doc: Shape into useful HTML docs

Hi Heinrich,

Quoted 265 lines · Heinrich Schuchardt
Quoted 217 lines · Bin Meng

At present there is Sphinx doc build system in U-Boot, however the contents are very limited, e.g.: only a few API descriptions like EFI, are included.

This series proposes an initial Sphinx doc layout for future extension, by converting some of the plain text documentation to reStructuredText format and add it to Sphinx TOC tree.

With this series, now we have the following major chapters in our U-Boot HTML doc:

- Driver Model
- U-Boot API documentation
- Architecture-specific doc
- Board-specific doc

Board specific documents are put in a vendor subdirectory, just like what we have in <src_tree>/board. All x86 & RISC-V board docs are converted to reST. A few other board docs are converted too.

Tested by generating the HTML docs, 0 build warnings.

This patch is rebased on https://patchwork.ozlabs.org/patch/1131726/.

@Wolfgang, is it possible to host the Sphinx HTML docs on denx.de?

This series is available at u-boot-x86/doc for testing.

Bin Meng (50):
doc: Move existing rst files into api sub-directory
doc: Add top-level description about U-Boot documentation
doc: Add driver-model to Sphinx TOC tree
doc: driver-model: Convert README.txt to reST
doc: driver-model: Convert MIGRATION.txt to reST
doc: driver-model: Convert fdt-fixup.txt to reST
doc: driver-model: Convert fs_firmware_loader.txt to reST
doc: driver-model: Convert i2c-howto.txt to reST
doc: driver-model: Convert livetree.txt to reST
doc: driver-model: Convert of-plat.txt to reST
doc: driver-model: Convert pci-info.txt to reST
doc: driver-model: Convert pmic-framework.txt to reST
doc: driver-model: Convert remoteproc-framework.txt to reST
doc: driver-model: Convert serial-howto.txt to reST
doc: driver-model: Convert spi-howto.txt to reST
doc: driver-model: Convert usb-info.txt to reST
doc: Add architecture specific info to Sphinx TOC tree
doc: arch: Convert README.mips to reST
doc: Add board specific info to Sphinx TOC tree
doc: board: Add Intel Crown Bay board doc
doc: board: Add Intel Bay Trail based board docs
doc: board: Add Intel Cherry Hill board doc
doc: board: Add Intel Cougar Canyon 2 board doc
doc: board: Add Intel Edison board doc
doc: board: Add Intel Galileo board doc
doc: board: Add Google Chromebook Link board doc
doc: board: Add Google Chromebook Samus board doc
doc: board: Add coreboot board doc
doc: board: Add QEMU x86 board doc
doc: board: Convert README.qemu-arm to reST
doc: board: Convert README.qemu-riscv to reST
doc: board: Convert README.qemu-mips to reST
doc: board: Add AndesTech ax25-ae350 board doc
doc: board: Convert README.ag101p to reST
doc: board: Convert README.sifive-fu540 to reST
doc: board: Convert README.sh7752evb to reST
doc: board: Convert README.sh7753evb to reST
doc: board: Convert README.at91 to reST
doc: board: Convert README.b4860qds to reST
doc: board: Convert README.zynq to reST
doc: arch: Convert README.x86 to reST
doc: arch: Convert README.arm64 to reST
doc: arch: Convert README.NDS32 to reST
doc: arch: Convert README.nios2 to reST
doc: arch: Convert README.ARC to reST
doc: arch: Convert README.m68k to reST
doc: arch: Convert README.sh to reST
doc: arch: Convert README.sandbox to reST
doc: arch: Convert README.xtensa to reST
doc: Remove README.blackfin

  doc/README.AX25                                    |  46 --
  doc/README.N1213                                   |  55 --
  doc/README.NDS32                                   |  41 --
  doc/README.ae350                                   | 275 --------
  doc/README.at91                                    | 174 -----
  doc/README.b4860qds                                | 366 ----------
  doc/README.blackfin                                |  46 --
  doc/README.m68k                                    | 150 ----
  doc/README.qemu-mips                               | 195 ------
  doc/README.sh                                      |  97 ---
  doc/README.sh7752evb                               |  67 --
  doc/README.sh7753evb                               |  67 --
  doc/README.sifive-fu540                            | 303 --------
  doc/{ => api}/efi.rst                              |   0
  doc/api/index.rst                                  |  11 +
  doc/{ => api}/linker_lists.rst                     |   0
  doc/{ => api}/serial.rst                           |   0
  doc/{README.ARC => arch/arc.rst}                   |   5 +
  doc/{README.arm64 => arch/arm64.rst}               |  25 +-
  doc/arch/index.rst                                 |  18 +
  doc/arch/m68k.rst                                  | 170 +++++
  doc/{README.mips => arch/mips.rst}                 |  28 +-
  doc/arch/nds32.rst                                 | 101 +++
  doc/{README.nios2 => arch/nios2.rst}               |  86 ++-
  .../sandbox/README.sandbox => doc/arch/sandbox.rst | 251 +++----
  doc/arch/sh.rst                                    | 106 +++
  doc/{README.x86 => arch/x86.rst}                   | 766 ++++-----------------
  doc/{README.xtensa => arch/xtensa.rst}             |  24 +-
  .../AndesTech/adp-ag101p.rst}                      |  26 +-
  doc/board/AndesTech/ax25-ae350.rst                 | 329 +++++++++
  doc/board/atmel/at91ek.rst                         | 192 ++++++
  doc/board/coreboot/coreboot.rst                    |  42 ++
  doc/board/coreboot/index.rst                       |   9 +
  doc/board/emulation/index.rst                      |  12 +
  .../emulation/qemu-arm.rst}                        |  44 +-
  doc/board/emulation/qemu-mips.rst                  | 234 +++++++
  .../emulation/qemu-riscv.rst}                      |  21 +-
  doc/board/emulation/qemu-x86.rst                   | 101 +++
  doc/board/freescale/b4860qds.rst                   | 453 ++++++++++++
  doc/board/google/chromebook_link.rst               |  34 +
  doc/board/google/chromebook_samus.rst              | 101 +++
  doc/board/google/index.rst                         |  10 +
  doc/board/index.rst                                |  18 +
  doc/board/intel/bayleybay.rst                      |  29 +
  doc/board/intel/cherryhill.rst                     |  30 +
  doc/board/intel/cougarcanyon2.rst                  |  24 +
  doc/board/intel/crownbay.rst                       |  43 ++
  doc/board/intel/edison.rst                         |  41 ++
  doc/board/intel/galileo.rst                        |  22 +
  doc/board/intel/index.rst                          |  15 +
  doc/board/intel/minnowmax.rst                      |  70 ++
  doc/board/renesas/sh7752evb.rst                    |  79 +++
  doc/board/renesas/sh7753evb.rst                    |  79 +++
  doc/board/sifive/fu540.rst                         | 321 +++++++++
  doc/{README.zynq => board/xilinx/zynq.rst}         |  82 ++-
  doc/driver-model/{README.txt => design.rst}        | 589 ++++++++--------
  doc/driver-model/{fdt-fixup.txt => fdt-fixup.rst}  |  56 +-
  doc/driver-model/fs_firmware_loader.rst            | 154 +++++
  doc/driver-model/fs_firmware_loader.txt            | 148 ----
  doc/driver-model/{i2c-howto.txt => i2c-howto.rst}  |  36 +-
  doc/driver-model/index.rst                         |  21 +
  doc/driver-model/{livetree.txt => livetree.rst}    |  94 +--
  doc/driver-model/{MIGRATION.txt => migration.rst}  |  44 +-
  doc/driver-model/{of-plat.txt => of-plat.rst}      | 193 +++---
  doc/driver-model/{pci-info.txt => pci-info.rst}    |  21 +-
  .../{pmic-framework.txt => pmic-framework.rst}     | 131 ++--
  ...proc-framework.txt => remoteproc-framework.rst} | 181 ++---
  .../{serial-howto.txt => serial-howto.rst}         |  12 +-
  doc/driver-model/spi-howto.rst                     | 692 +++++++++++++++++++
  doc/driver-model/spi-howto.txt                     | 623 -----------------
  doc/driver-model/{usb-info.txt => usb-info.rst}    | 184 ++---
  doc/index.rst                                      |  69 +-
  72 files changed, 4903 insertions(+), 4279 deletions(-)

delete mode 100644 doc/README.AX25
delete mode 100644 doc/README.N1213
delete mode 100644 doc/README.NDS32
delete mode 100644 doc/README.ae350
delete mode 100644 doc/README.at91
delete mode 100644 doc/README.b4860qds
delete mode 100644 doc/README.blackfin
delete mode 100644 doc/README.m68k
delete mode 100644 doc/README.qemu-mips
delete mode 100644 doc/README.sh
delete mode 100644 doc/README.sh7752evb
delete mode 100644 doc/README.sh7753evb
delete mode 100644 doc/README.sifive-fu540
rename doc/{ => api}/efi.rst (100%)
create mode 100644 doc/api/index.rst
rename doc/{ => api}/linker_lists.rst (100%)
rename doc/{ => api}/serial.rst (100%)
rename doc/{README.ARC => arch/arc.rst} (96%)
rename doc/{README.arm64 => arch/arm64.rst} (83%)
create mode 100644 doc/arch/index.rst
create mode 100644 doc/arch/m68k.rst
rename doc/{README.mips => arch/mips.rst} (74%)
create mode 100644 doc/arch/nds32.rst
rename doc/{README.nios2 => arch/nios2.rst} (51%)
rename board/sandbox/README.sandbox => doc/arch/sandbox.rst (76%) create mode 100644 doc/arch/sh.rst
rename doc/{README.x86 => arch/x86.rst} (51%)
rename doc/{README.xtensa => arch/xtensa.rst} (90%)
rename doc/{README.ag101p => board/AndesTech/adp-ag101p.rst} (83%) create mode 100644 doc/board/AndesTech/ax25-ae350.rst create mode 100644 doc/board/atmel/at91ek.rst
create mode 100644 doc/board/coreboot/coreboot.rst
create mode 100644 doc/board/coreboot/index.rst
create mode 100644 doc/board/emulation/index.rst
rename doc/{README.qemu-arm => board/emulation/qemu-arm.rst} (80%) create mode 100644 doc/board/emulation/qemu-mips.rst rename doc/{README.qemu-riscv => board/emulation/qemu-riscv.rst} (82%) create mode 100644 doc/board/emulation/qemu-x86.rst
create mode 100644 doc/board/freescale/b4860qds.rst
create mode 100644 doc/board/google/chromebook_link.rst create mode 100644 doc/board/google/chromebook_samus.rst create mode 100644 doc/board/google/index.rst
create mode 100644 doc/board/index.rst
create mode 100644 doc/board/intel/bayleybay.rst
create mode 100644 doc/board/intel/cherryhill.rst
create mode 100644 doc/board/intel/cougarcanyon2.rst create mode 100644 doc/board/intel/crownbay.rst
create mode 100644 doc/board/intel/edison.rst
create mode 100644 doc/board/intel/galileo.rst
create mode 100644 doc/board/intel/index.rst
create mode 100644 doc/board/intel/minnowmax.rst
create mode 100644 doc/board/renesas/sh7752evb.rst
create mode 100644 doc/board/renesas/sh7753evb.rst
create mode 100644 doc/board/sifive/fu540.rst
rename doc/{README.zynq => board/xilinx/zynq.rst} (53%) rename doc/driver-model/{README.txt => design.rst} (64%) rename doc/driver-model/{fdt-fixup.txt => fdt-fixup.rst} (89%) create mode 100644 doc/driver-model/fs_firmware_loader.rst delete mode 100644 doc/driver-model/fs_firmware_loader.txt rename doc/driver-model/{i2c-howto.txt => i2c-howto.rst} (82%) create mode 100644 doc/driver-model/index.rst
rename doc/driver-model/{livetree.txt => livetree.rst} (77%) rename doc/driver-model/{MIGRATION.txt => migration.rst} (84%)

Quoted 9 lines

rename doc/driver-model/{of-plat.txt => of-plat.rst} (65%)
rename doc/driver-model/{pci-info.txt => pci-info.rst} (95%)
rename doc/driver-model/{pmic-framework.txt => pmic-framework.rst} (51%) rename doc/driver-model/{remoteproc-framework.txt => remoteproc-framework.rst} (50%) rename doc/driver-model/{serial-howto.txt => serial-howto.rst} (92%) create mode 100644 doc/driver-model/spi-howto.rst
delete mode 100644 doc/driver-model/spi-howto.txt
rename doc/driver-model/{usb-info.txt => usb-info.rst} (77%)

Hello Bin,

current origin/master make htmldocs gives me the following warnings:

reading sources... [100%] board/index

./cmd/efidebug.c:733: WARNING: Unexpected indentation. /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/AndesTech/index' /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/atmel/index'
/doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/freescale/index' /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/renesas/index' /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/sifive/index' /doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/xilinx/index'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /doc/board/AndesTech/adp-ag101p.rst: WARNING:
document isn't included in any toctree /doc/board/AndesTech/ax25-ae350.rst: WARNING: document isn't included in any toctree
/doc/board/atmel/at91ek.rst: WARNING: document isn't included in any toctree /doc/board/freescale/b4860qds.rst: WARNING: document isn't included in any toctree
/doc/board/renesas/sh7752evb.rst: WARNING: document isn't included in any toctree
/doc/board/renesas/sh7753evb.rst: WARNING: document isn't included in any toctree
/doc/board/sifive/fu540.rst: WARNING: document isn't included in any toctree /doc/board/xilinx/zynq.rst: WARNING: document isn't included in any toctree done

Quoted 2 lines

The efidebug.c one I will care about. Will you have a look at the others, please?

Thanks for reporting. It looks that I missed adding these index to 'git stage' area before committing. That's why it escaped during my local testing.

Regards,
Bin