All of lore.kernel.org
 help / color / mirror / Atom feed
From: Sean Anderson <sean.anderson@seco.com>
To: Tom Rini <trini@konsulko.com>
Cc: Liviu Dudau <liviu.dudau@foss.arm.com>,
	u-boot@lists.denx.de, Simon Glass <sjg@chromium.org>,
	Linus Walleij <linus.walleij@linaro.org>,
	Andre Przywara <andre.przywara@arm.com>,
	Sean Anderson <sean.anderson@seco.com>
Subject: [PATCH v2 01/28] doc: Convert semihosting readme to rST
Date: Thu, 10 Mar 2022 15:50:31 -0500	[thread overview]
Message-ID: <20220310205059.499269-2-sean.anderson@seco.com> (raw)
In-Reply-To: <20220310205059.499269-1-sean.anderson@seco.com>

This converts the semihosting readme to rST. I have tried to make only
cosmetic changes, but I did fix up the first link (which was broken).

Signed-off-by: Sean Anderson <sean.anderson@seco.com>
---

(no changes since v1)

 doc/usage/index.rst                           |  1 +
 .../semihosting.rst}                          | 35 +++++++++++--------
 2 files changed, 21 insertions(+), 15 deletions(-)
 rename doc/{README.semihosting => usage/semihosting.rst} (53%)

diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 964d761e13..569da2bdd1 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -11,6 +11,7 @@ Use U-Boot
    netconsole
    partitions
    cmdline
+   semihosting
 
 Shell commands
 --------------
diff --git a/doc/README.semihosting b/doc/usage/semihosting.rst
similarity index 53%
rename from doc/README.semihosting
rename to doc/usage/semihosting.rst
index f382d0131e..ed16e4d582 100644
--- a/doc/README.semihosting
+++ b/doc/usage/semihosting.rst
@@ -1,35 +1,40 @@
-SPDX-License-Identifier: GPL-2.0+
-/*
- * Copyright 2014 Broadcom Corporation.
- */
+.. SPDX-License-Identifier: GPL-2.0+
+.. Copyright 2014 Broadcom Corporation.
+
+Semihosting
+===========
 
 Semihosting is ARM's way of having a real or virtual target communicate
 with a host or host debugger for basic operations such as file I/O,
-console I/O, etc. Please see
-http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0471c/Bgbjjgij.html for more information.
+console I/O, etc. Please see `Arm's semihosting documentation
+<https://developer.arm.com/documentation/100863/latest/>`_ for more
+information.
 
 For developing on armv8 virtual fastmodel platforms, semihosting is a
 valuable tool since it allows access to image/configuration files before
 eMMC or other NV media are available.
 
 There are two main ARM virtual Fixed Virtual Platform (FVP) models,
-Versatile Express (VE) FVP and BASE FVP (See
-http://www.arm.com/products/tools/models/fast-models/foundation-model.php)
+`Versatile Express (VE) FVP and BASE FVP
+<http://www.arm.com/products/tools/models/fast-models/foundation-model.php>`_.
 The initial vexpress64 u-boot board created here runs on the VE virtual
 platform using the license-free Foundation_v8 simulator. Fortunately,
 the Foundation_v8 simulator also supports the BASE_FVP model which
 companies can purchase licenses for and contain much more functionality.
-So we can, in u-boot, run either model by either using the VE FVP (default),
-or turning on CONFIG_BASE_FVP for the more full featured model.
+So we can, in U-Boot, run either model by either using the VE FVP (default),
+or turning on ``CONFIG_BASE_FVP`` for the more full featured model.
 
-Rather than create a new armv8 board similar to armltd/vexpress64, add
-semihosting calls to the existing one, enabled with CONFIG_SEMIHOSTING
-and CONFIG_BASE_FVP both set. Also reuse the existing board config file
+Rather than create a new armv8 board similar to ``armltd/vexpress64``, add
+semihosting calls to the existing one, enabled with ``CONFIG_SEMIHOSTING``
+and ``CONFIG_BASE_FVP`` both set. Also reuse the existing board config file
 vexpress_aemv8.h but differentiate the two models by the presence or
-absence of CONFIG_BASE_FVP. This change is tested and works on both the
+absence of ``CONFIG_BASE_FVP``. This change is tested and works on both the
 Foundation and Base fastmodel simulators.
 
-The semihosting code adds a command:
+Loading files
+-------------
+
+The semihosting code adds a "hostfs"::
 
   smhload <image> <address> [env var]
 
-- 
2.25.1


  reply	other threads:[~2022-03-10 20:51 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-10 20:50 [PATCH v2 00/28] arm: semihosting: Cleanups and new features Sean Anderson
2022-03-10 20:50 ` Sean Anderson [this message]
2022-03-10 20:50 ` [PATCH v2 02/28] nxp: ls1046ardb: Convert README to rST Sean Anderson
2022-03-10 20:50 ` [PATCH v2 03/28] doc: ls1046ardb: Expand boot mode section Sean Anderson
2022-03-10 20:50 ` [PATCH v2 04/28] doc: ls1046ardb: Document debug uart Sean Anderson
2022-03-10 20:50 ` [PATCH v2 05/28] arm: smh: Add semihosting entry to MAINTAINERS Sean Anderson
2022-03-10 20:50 ` [PATCH v2 06/28] arm: smh: Export semihosting functions Sean Anderson
2022-03-10 20:50 ` [PATCH v2 07/28] arm: smh: Use numeric modes for smh_open Sean Anderson
2022-03-10 20:50 ` [PATCH v2 08/28] arm: smh: Return errno on error Sean Anderson
2022-03-10 20:50 ` [PATCH v2 09/28] arm: smh: Document functions in header Sean Anderson
2022-03-10 20:50 ` [PATCH v2 10/28] arm: smh: Add some file manipulation commands Sean Anderson
2022-03-10 20:50 ` [PATCH v2 11/28] spl: Add semihosting boot method Sean Anderson
2022-03-10 20:50 ` [PATCH v2 12/28] fs: Add semihosting filesystem Sean Anderson
2022-03-10 20:50 ` [PATCH v2 13/28] cmd: fdt: Use start/size for chosen instead of start/end Sean Anderson
2022-03-10 20:50 ` [PATCH v2 14/28] arm: smh: Remove smhload command Sean Anderson
2022-03-10 20:50 ` [PATCH v2 15/28] arm: smh: Add some functions for working with the host console Sean Anderson
2022-03-10 20:50 ` [PATCH v2 16/28] serial: Add semihosting driver Sean Anderson
2022-03-10 20:50 ` [PATCH v2 17/28] doc: smh: Update semihosting documentation Sean Anderson
2022-03-10 20:50 ` [PATCH v2 18/28] ls1046ardb: Add support for JTAG boot Sean Anderson
2022-03-10 20:50 ` [PATCH v2 19/28] arm64: Save esr in pt_regs Sean Anderson
2022-03-10 20:50 ` [PATCH v2 20/28] arm64: Save spsr " Sean Anderson
2022-03-10 21:01   ` Sean Anderson
2022-03-10 20:50 ` [PATCH v2 21/28] arm64: Import some ESR and SPSR defines from Linux Sean Anderson
2022-03-10 20:50 ` [PATCH v2 22/28] arm: smh: Add option to detect semihosting Sean Anderson
2022-03-10 20:50 ` [PATCH v2 23/28] arm: Catch non-emulated semihosting calls Sean Anderson
2022-03-10 20:50 ` [PATCH v2 24/28] serial: smh: Initialize serial only if semihosting is enabled Sean Anderson
2022-03-10 20:50 ` [PATCH v2 25/28] arm64: ls1046a: Support semihosting fallback Sean Anderson
2022-03-10 20:50 ` [PATCH v2 26/28] serial: dm: Add support for puts Sean Anderson
2022-03-11 15:40   ` Sean Anderson
2022-03-12  5:02   ` Simon Glass
2022-03-12  5:53     ` Sean Anderson
2022-03-12 17:58       ` Simon Glass
2022-03-10 20:50 ` [PATCH v2 27/28] serial: sandbox: Implement puts Sean Anderson
2022-03-10 20:50 ` [PATCH v2 28/28] serial: smh: Implement puts for DM Sean Anderson
2022-03-11 18:22 ` [PATCH v2 00/28] arm: semihosting: Cleanups and new features Andre Przywara
2022-03-11 19:20   ` Sean Anderson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220310205059.499269-2-sean.anderson@seco.com \
    --to=sean.anderson@seco.com \
    --cc=andre.przywara@arm.com \
    --cc=linus.walleij@linaro.org \
    --cc=liviu.dudau@foss.arm.com \
    --cc=sjg@chromium.org \
    --cc=trini@konsulko.com \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.