aboutsummaryrefslogtreecommitdiff
path: root/qemu-options.hx
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2020-02-28 15:36:09 +0000
committerPeter Maydell <peter.maydell@linaro.org>2020-03-06 10:05:12 +0000
commit44d79a6bd74b1e98394f456957f3c919c44cf4aa (patch)
tree762f97e9f0f89314fe0f2bf017961be8326f4149 /qemu-options.hx
parent705f48cc221fea128abdcc334606931e971229e4 (diff)
docs: Roll semihosting option information into qemu-options.hx
Currently the per-target documentation for those targets that implement semihosting includes a bit of text that goes into both the manual and the manpage about options specific to the target. This text is redundant with the earlier generic option description of the semihosting option produced from qemu-options.hx. To avoid having to create a lot of stub include files to include into the rST generated qemu.1 manpage, roll target-specific bits of information into the qemu-options.hx text, so the user doesn't have to look in two places for this information. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Tested-by: Alex Bennée <alex.bennee@linaro.org> Message-id: 20200228153619.9906-24-peter.maydell@linaro.org
Diffstat (limited to 'qemu-options.hx')
-rw-r--r--qemu-options.hx18
1 files changed, 18 insertions, 0 deletions
diff --git a/qemu-options.hx b/qemu-options.hx
index 5a4ac8e239..753bfce411 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -4116,6 +4116,12 @@ STEXI
@item -semihosting
@findex -semihosting
Enable semihosting mode (ARM, M68K, Xtensa, MIPS, Nios II only).
+
+Note that this allows guest direct access to the host filesystem, so
+should only be used with a trusted guest OS.
+
+See the -semihosting-config option documentation for further information
+about the facilities this enables.
ETEXI
DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config,
"-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]\n" \
@@ -4126,6 +4132,18 @@ STEXI
@item -semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]
@findex -semihosting-config
Enable and configure semihosting (ARM, M68K, Xtensa, MIPS, Nios II only).
+
+Note that this allows guest direct access to the host filesystem, so
+should only be used with a trusted guest OS.
+
+On Arm this implements the standard semihosting API, version 2.0.
+
+On M68K this implements the "ColdFire GDB" interface used by libgloss.
+
+Xtensa semihosting provides basic file IO calls, such as
+open/read/write/seek/select. Tensilica baremetal libc for ISS and
+linux platform "sim" use this interface.
+
@table @option
@item target=@code{native|gdb|auto}
Defines where the semihosting calls will be addressed, to QEMU (@code{native})