From patchwork Fri Mar 6 11:09:49 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 184273 Delivered-To: patch@linaro.org Received: by 2002:a92:1f12:0:0:0:0:0 with SMTP id i18csp7303087ile; Fri, 6 Mar 2020 03:20:48 -0800 (PST) X-Google-Smtp-Source: ADFU+vut71JGjSuDIY9dxJEU/7Bn9nQ1VNblSc7u9u4LJLZ8Iv1cKLQMyx2B5+I4CoDbM3uqy/OO X-Received: by 2002:ac8:108d:: with SMTP id a13mr2541515qtj.230.1583493647981; Fri, 06 Mar 2020 03:20:47 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1583493647; cv=none; d=google.com; s=arc-20160816; b=DqEaSuizAmvYKnkEaa8r2eH825wyfdNrTsKCVEn3SJyB2U4lIYApJx7+GrlfISAtFU Kl1vwIugY7rZ7MACbU0X8+dAIOGQbuVqBQUYiAsRrDzvWq0GduWhyhdAYwkxCe/wZ2Xs SCSmkHIjpdIH9/lLkOxns/p5Oeslb2fBTOLD1nndbaU/Ef/vzIVrbmdDQGdvf6nT1uyP CCIDLRXXL5viF+5UzY23hImH8Jus7u7DYecYQ3QEyAy1FLpvaiDmrUDFNuA4Dlw5Pncr jkZp+9Apn0JnA0j3yU740P5/FYlx/EIIKyKDXcGVMWtxGwOgCuXjKkYSfXSDiCX2uwVX N4YQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=16OwmzPRHLOaxlQLblRm3xfkd1LYqopUI1wfjaSJuJQ=; b=D3D7DURoEvDf72DwJlwQTmaOphhg9niuYa437gkNm34aYen2dSgBo+BLx7cnYMtxqL IGGkoENXb3junB0RnK6iUsKum5bk623id1u9Wl+2+k+tnA/DbZ4WACVDmnXoUmiRdCmM iUx9n6NxbRHywx+4g4n0Cbyod5YiPA3K+JatVUv+rYX8Vsi+E2MZBLFDazMoEuxbAcno Z3PtX55Ke7iDMpgSVRyAU1XuU85KcchOGuOECHsgnO+zi3K3GyuvRIeSq1jbysiEq1Cy xgTvy6AzVn8ErQnciDvU6MTNRHg4YDfPW+ctg8NnnSdFUuADUuPL1I7XKoyjPBPEKzpw eQOg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="u2TyY/nk"; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id i25si399536qte.308.2020.03.06.03.20.47 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 06 Mar 2020 03:20:47 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="u2TyY/nk"; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:35044 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jAB27-0006As-DT for patch@linaro.org; Fri, 06 Mar 2020 06:20:47 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:39808) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jAAsN-0004Ai-IH for qemu-devel@nongnu.org; Fri, 06 Mar 2020 06:10:45 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jAAsH-0005dJ-Ib for qemu-devel@nongnu.org; Fri, 06 Mar 2020 06:10:43 -0500 Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]:35574) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1jAAsH-0005b4-A4 for qemu-devel@nongnu.org; Fri, 06 Mar 2020 06:10:37 -0500 Received: by mail-wm1-x32f.google.com with SMTP id m3so1937265wmi.0 for ; Fri, 06 Mar 2020 03:10:37 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=16OwmzPRHLOaxlQLblRm3xfkd1LYqopUI1wfjaSJuJQ=; b=u2TyY/nk6+4UCEeQz0F5Is2HumTW/di9pbGGxl9iv7RW+tB9sq0JkxHPNAdZNN+TFo UyPLbTYehIOI6X6TKIXYQjm6at//ECjenKJQjQ9vr4xxkzgn7q121TKkmPLwpJlYPdFD f/RrNLRk+r11CNtDn5HGTS9TVQFMkoP/V9d7E71MxkU2XVWYFV1sJlFrAg6lpKK2yJ2I VOtJSH+rDI65jl+9Z09YCNee/aowdVERuDHRgJ3HwQN0NASsEys/vMZb/hHFI5MGvDcS OjgJigRkS62b8ha7dMzOHP3jKjhn9JbH5kLB/vbYeMQxhRUdZKHidWH0DKfRY2HSz0xX eC7w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=16OwmzPRHLOaxlQLblRm3xfkd1LYqopUI1wfjaSJuJQ=; b=M68mS+6xHu/fjHDoYN12OunvS6Zfa4HOO81+nT7wvDNcX9MDwNxU7qE2MXQdJ7Eodf eIynjn/DN0Ao+K6Tz1rVUbF9Z74QB/tgUALr8Gdpb5vOP1pyDBUWuRxTQbGgKqZDfKkO bXeRy+nu8Jp7OXhh3irVnzgRpNncjhhJsnHL8Oj18xJaBVUzzL9HgqG5gk9YFcsUY1N/ ald5Zp0ywi9k8nd0jmiwrHVTnHEeLHtKmbZiqZQn/hXC5G+V7dtxkMHutJ29qOJ+4sHx 9d1iSAxwiII6PKkYipfBYVkQZzxZWGFU1uAymsGMv1Vv6mARCwyxHurYNawZOetsChUZ lcCw== X-Gm-Message-State: ANhLgQ3Xd6i6VEz//phvRO1TtTj5YDMnaVvg9KpU4kQu409w6GjkcoOb LsFYwBBDZyN70NHyyYS/iz5gzd3hUSnOJw== X-Received: by 2002:a1c:a5c2:: with SMTP id o185mr3377392wme.173.1583493035855; Fri, 06 Mar 2020 03:10:35 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y10sm12553029wma.26.2020.03.06.03.10.34 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Mar 2020 03:10:35 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 23/33] docs: Roll semihosting option information into qemu-options.hx Date: Fri, 6 Mar 2020 11:09:49 +0000 Message-Id: <20200306110959.29461-24-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200306110959.29461-1-peter.maydell@linaro.org> References: <20200306110959.29461-1-peter.maydell@linaro.org> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::32f X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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 Reviewed-by: Alex Bennée Tested-by: Alex Bennée Message-id: 20200228153619.9906-24-peter.maydell@linaro.org --- docs/system/target-arm.rst | 10 ---------- docs/system/target-arm.texi | 18 ------------------ docs/system/target-m68k.rst | 11 ----------- docs/system/target-m68k.texi | 19 ------------------- docs/system/target-xtensa.rst | 12 ------------ docs/system/target-xtensa.texi | 20 -------------------- qemu-options.hx | 18 ++++++++++++++++++ 7 files changed, 18 insertions(+), 90 deletions(-) -- 2.20.1 diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst index 0490be55871..d2a3b44ce88 100644 --- a/docs/system/target-arm.rst +++ b/docs/system/target-arm.rst @@ -215,13 +215,3 @@ emulation includes the following elements: A Linux 2.6 test image is available on the QEMU web site. More information is available in the QEMU mailing-list archive. - -The following options are specific to the ARM emulation: - -``-semihosting`` - Enable semihosting syscall emulation. - - On ARM this implements the \"Angel\" interface. - - Note that this allows guest direct access to the host filesystem, so - should only be used with trusted guest OS. diff --git a/docs/system/target-arm.texi b/docs/system/target-arm.texi index c56b5f6ebfe..eb80dd35f0b 100644 --- a/docs/system/target-arm.texi +++ b/docs/system/target-arm.texi @@ -243,21 +243,3 @@ Three on-chip UARTs A Linux 2.6 test image is available on the QEMU web site. More information is available in the QEMU mailing-list archive. -@c man begin OPTIONS - -The following options are specific to the ARM emulation: - -@table @option - -@item -semihosting -Enable semihosting syscall emulation. - -On ARM this implements the "Angel" interface. - -Note that this allows guest direct access to the host filesystem, -so should only be used with trusted guest OS. - -@end table - -@c man end - diff --git a/docs/system/target-m68k.rst b/docs/system/target-m68k.rst index 50b7dd9d639..d28d3b92e5e 100644 --- a/docs/system/target-m68k.rst +++ b/docs/system/target-m68k.rst @@ -19,14 +19,3 @@ The AN5206 emulation includes the following devices: - MCF5206 ColdFire V2 Microprocessor. - Two on-chip UARTs. - -The following options are specific to the ColdFire emulation: - -``-semihosting`` - Enable semihosting syscall emulation. - - On M68K this implements the \"ColdFire GDB\" interface used by - libgloss. - - Note that this allows guest direct access to the host filesystem, so - should only be used with trusted guest OS. diff --git a/docs/system/target-m68k.texi b/docs/system/target-m68k.texi index a77b19ea0f1..dcce7bc8c56 100644 --- a/docs/system/target-m68k.texi +++ b/docs/system/target-m68k.texi @@ -23,22 +23,3 @@ MCF5206 ColdFire V2 Microprocessor. @item Two on-chip UARTs. @end itemize - -@c man begin OPTIONS - -The following options are specific to the ColdFire emulation: - -@table @option - -@item -semihosting -Enable semihosting syscall emulation. - -On M68K this implements the "ColdFire GDB" interface used by libgloss. - -Note that this allows guest direct access to the host filesystem, -so should only be used with trusted guest OS. - -@end table - -@c man end - diff --git a/docs/system/target-xtensa.rst b/docs/system/target-xtensa.rst index 43cab8dc4da..8d703ad769e 100644 --- a/docs/system/target-xtensa.rst +++ b/docs/system/target-xtensa.rst @@ -25,15 +25,3 @@ The Avnet LX60/LX110/LX200 emulation supports: - 16550 UART - OpenCores 10/100 Mbps Ethernet MAC - -The following options are specific to the Xtensa emulation: - -``-semihosting`` - Enable semihosting syscall emulation. - - 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. - - Note that this allows guest direct access to the host filesystem, so - should only be used with trusted guest OS. diff --git a/docs/system/target-xtensa.texi b/docs/system/target-xtensa.texi index 40327de6fa7..1e6c04dccd6 100644 --- a/docs/system/target-xtensa.texi +++ b/docs/system/target-xtensa.texi @@ -33,23 +33,3 @@ A range of Xtensa CPUs, default is the DC232B @item OpenCores 10/100 Mbps Ethernet MAC @end itemize - -@c man begin OPTIONS - -The following options are specific to the Xtensa emulation: - -@table @option - -@item -semihosting -Enable semihosting syscall emulation. - -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. - -Note that this allows guest direct access to the host filesystem, -so should only be used with trusted guest OS. - -@end table - -@c man end - diff --git a/qemu-options.hx b/qemu-options.hx index 5a4ac8e2396..753bfce411d 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})