summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBin Meng <bmeng.cn@gmail.com>2019-07-18 00:34:03 -0700
committerTom Rini <trini@konsulko.com>2019-07-24 10:07:24 -0400
commit5f2c16dab20281f427c1138f33cefeb2e9785b7e (patch)
treeeca824d7d9a206285e425f31a3416d82e1cf61fe
parentd838138657f91c814132d66ae25430891b772fd6 (diff)
doc: arch: Convert README.mips to reST
Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
-rw-r--r--doc/arch/index.rst2
-rw-r--r--doc/arch/mips.rst (renamed from doc/README.mips)28
2 files changed, 12 insertions, 18 deletions
diff --git a/doc/arch/index.rst b/doc/arch/index.rst
index a03ee6b752..1aeb7a1327 100644
--- a/doc/arch/index.rst
+++ b/doc/arch/index.rst
@@ -5,3 +5,5 @@ Architecture-specific doc
.. toctree::
:maxdepth: 2
+
+ mips
diff --git a/doc/README.mips b/doc/arch/mips.rst
index b28f6285cc..b8166087dd 100644
--- a/doc/README.mips
+++ b/doc/arch/mips.rst
@@ -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