From patchwork Fri Jan 13 13:39:21 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 641947 Delivered-To: patch@linaro.org Received: by 2002:a17:522:f3c4:b0:4b4:3859:abed with SMTP id in4csp225860pvb; Fri, 13 Jan 2023 06:13:47 -0800 (PST) X-Google-Smtp-Source: AMrXdXvzX2QBVHyur+nPXxo5O+8yHlAid+H4hBfX0RTS2RzLOzXpmDRPD+zyeWKDT0f9KFuArQOf X-Received: by 2002:a81:5503:0:b0:4dd:52f0:3609 with SMTP id j3-20020a815503000000b004dd52f03609mr2529906ywb.43.1673619227423; Fri, 13 Jan 2023 06:13:47 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1673619227; cv=none; d=google.com; s=arc-20160816; b=FVI+eu9/Mp91kYKsHqBkuQ1FvHKiIgEg1Niruq9Gt4xjavdfkckCGs4VQ1DojRkkFK 9u83a2/auIv5pr9W184uRVvZqtVy5hhv/KkYUhUiZiVMM2OwD+EghHDQQILe9NFYihQC zfDEIOm4PgPfJMSihwBhAQas1LFp1FyPg11ZsA9MNX7vR/DadMQ4asSeEFMNJrv68Pxn CDOuS6XhJAdCEYmvl/zhZazIwixTl0VD8FdALHVq92W/kI/sgkTyAFvmajEASkJSaFw2 ifRgaJqJ4qczL8jhvbdU6bW70aNqCt6EgjYKAJJxUS4oHSr1BTTna77Kegj1lnVCk3zl GV1A== 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:cc:to :from:dkim-signature; bh=ZkjvImv3urfubQ/CIur/IuzDRXVAlRae10Z3LaYvYZ8=; b=i2uGYKYoKDLQ71X7jYvdytBNJY9gmfOwYaFmPldtJkJkgJJxNI/PmRGDpJvpqdHfkT sgQVoNj2FepLiw1X8yuSBSblfuTfOVzcHnERAx3gkjwT89S/MSIHawERxCHepWTmxZ4m rIjyHigAtDavfM/lcdWPeBhfYZdzvvzhj++ZN2dXdyEdWZA4HdRmCujpt8A8eeE6nOIK jTqBBl7xw7uxPJLmDYMT+o6Wjp3h4CWT0nDkc7/P5vndfTAGGebarDI2uBmdOT3HbkMs h00b5JIUX/NE2OBfOXD++Qs91CNMow+zzyWVnY9o78ArXySxeTgBtja/bBvz9mk/QM0E jD+Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=KQ98xfT4; 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 ESMTP id j4-20020a05620a410400b006ff045dc7e6si13516921qko.29.2023.01.13.06.13.46 for ; Fri, 13 Jan 2023 06:13: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=KQ98xfT4; 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] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pGKHM-0007q8-Bk; Fri, 13 Jan 2023 08:39:32 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pGKHK-0007pR-7t for qemu-devel@nongnu.org; Fri, 13 Jan 2023 08:39:30 -0500 Received: from mail-wm1-x333.google.com ([2a00:1450:4864:20::333]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pGKHH-000530-BT for qemu-devel@nongnu.org; Fri, 13 Jan 2023 08:39:29 -0500 Received: by mail-wm1-x333.google.com with SMTP id j34-20020a05600c1c2200b003da1b054057so3082868wms.5 for ; Fri, 13 Jan 2023 05:39:26 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=ZkjvImv3urfubQ/CIur/IuzDRXVAlRae10Z3LaYvYZ8=; b=KQ98xfT4n3kDO82kAcafmt+RWC82neT/zuoienwDEIKc+hodyjnVHMesHlHXT+z4ts J8fGsmP/vYXoH/tfIKlAvS1Zl83xA4SPOmhN5voZaqYzEaX4GAHOkiML02CfPk7xOfLr BCHTihKYUFp2Eo8INa0P6eJd3p2CteOPOtlUO0vN2IEBdTiCZWcN3xySXW6qYmL6TUd1 gAYnXpWaZadpZ2HNbj60wj+5UMGvTzfCp04efohWd8ZSom/9+cHBJOZR/wwx12quaG9i mBNtYSGxiJ6vEuCbMCsDpcSflaztJA9XFOdzP4g9bQe27YdJh4c68b+zVFvrQC63sTs/ XFxg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=ZkjvImv3urfubQ/CIur/IuzDRXVAlRae10Z3LaYvYZ8=; b=q3ccmp5cH0g6h8VD8mXGpcBdFYqQgrq/EftFCmBx0Dzzb3cA/i1l3S69jcRVztQ7vX Y6Wrh+iBfztXPcIc0AdvoLJfGnxAOYT6gIL2AmZOMud1P+20W8ABGGgjGUcnpgJq4GQ8 LLpxdBr4zmUu+5Hm52nH9EM3J80WkR5yV0rXHJBodrWgtJtjpTkCGY6kWzn/ZaOYR4M0 v265LocJBu4lGAR8MmvuAYnr+52P6exeMUbzgDGV+gxL7AP8Z7kPgem92JDDyeIBf7p1 FCyp/bdRqS5HoRHwu7zwDofKkAwlrxeFLyEw3+VWiHzrWlXO5fG07Vbg/9bmsXh7rSyz VmCA== X-Gm-Message-State: AFqh2kpPTg/+ksax5ogkVAhBmQKgAoms5x7g2KFJGVHhOaFRKj5fQKWF eEqIE5Xlzhsr3pxk38ZPzQPwHw== X-Received: by 2002:a05:600c:4fc6:b0:3d3:4a47:52e9 with SMTP id o6-20020a05600c4fc600b003d34a4752e9mr57953781wmq.15.1673617166105; Fri, 13 Jan 2023 05:39:26 -0800 (PST) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id e18-20020a05600c4e5200b003d9876aa04asm29736196wmq.41.2023.01.13.05.39.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 13 Jan 2023 05:39:25 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 9BF251FFBA; Fri, 13 Jan 2023 13:39:23 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Alexandre Iooss , peter.maydell@linaro.org, Markus Armbruster , Mahmoud Mandour , =?utf-8?q?Alex_Benn=C3=A9e?= , Richard Henderson , John G Johnson , Elena Ufimtseva , Paolo Bonzini , Jagannathan Raman Subject: [PATCH 2/4] docs: add a new section to outline emulation support Date: Fri, 13 Jan 2023 13:39:21 +0000 Message-Id: <20230113133923.1642627-3-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230113133923.1642627-1-alex.bennee@linaro.org> References: <20230113133923.1642627-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::333; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x333.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 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-bounces+patch=linaro.org@nongnu.org This affects both system and user mode emulation so we should probably list it up front. Signed-off-by: Alex Bennée --- docs/about/emulation.rst | 103 ++++++++++++++++++++++++++++++++++ docs/about/index.rst | 1 + docs/devel/tcg-plugins.rst | 2 + docs/system/arm/emulation.rst | 2 + 4 files changed, 108 insertions(+) create mode 100644 docs/about/emulation.rst diff --git a/docs/about/emulation.rst b/docs/about/emulation.rst new file mode 100644 index 0000000000..d919175b5e --- /dev/null +++ b/docs/about/emulation.rst @@ -0,0 +1,103 @@ +Emulation +========= + +QEMU's Tiny Code Generator (TCG) gives it the ability to emulate a +number of CPU architectures on any supported platform. Both +:ref:`System Emulation` and :ref:`User Mode Emulation` are supported +depending on the guest architecture. + +.. list-table:: Supported Guest Architectures for Emulation + :widths: 30 10 10 50 + :header-rows: 1 + + * - Architecture (qemu name) + - System + - User-mode + - Notes + * - Alpha + - Yes + - Yes + - Legacy 64 bit RISC ISA developed by DEC + * - Arm (arm, aarch64) + - Yes + - Yes + - Wide range of features, see :ref:`Arm Emulation` for details + * - AVR + - Yes + - No + - 8 bit micro controller, often used in maker projects + * - Cris + - Yes + - Yes + - Embedded RISC chip developed by AXIS + * - Hexagon + - No + - Yes + - Family of DSPs by Qualcomm + * - PA-RISC (hppa) + - Yes + - Yes + - A legacy RISC system used in HPs old minicomputers + * - x86 (i386, x86_64) + - Yes + - Yes + - The ubiquitous desktop PC CPU architecture, 32 and 64 bit. + * - Loongarch + - Yes + - Yes + - A MIPs-like 64bit RISC architecture developed in China + * - m68k + - Yes + - Yes + - Motorola 68000 variants and ColdFire + * - Microblaze + - Yes + - Yes + - RISC based soft-core by Xilinx + * - MIPS (mips, mipsel, mips64, mips64el) + - Yes + - Yes + - Venerable RISC architecture originally out of Stanford University + * - Nios2 + - Yes + - Yes + - 32 bit embedded soft-core by Altera + * - OpenRISC + - Yes + - Yes + - Open source RISC architecture developed by the OpenRISC community + * - Power (ppc, ppc64) + - Yes + - Yes + - A general purpose RISC architecture now managed by IBM + * - RISC-V + - Yes + - Yes + - An open standard RISC ISA maintained by RISC-V International + * - RX + - Yes + - No + - A 32 bit micro controller developed by Renesas + * - s390x + - Yes + - Yes + - A 64 bit CPU found in IBM's System Z mainframes + * - sh4 + - Yes + - Yes + - A 32 bit RISC embedded CPU developed by Hitachi + * - SPARC (sparc, sparc64) + - Yes + - Yes + - A RISC ISA originally developed by Sun Microsystems + * - Tricore + - Yes + - No + - A 32 bit RISC/uController/DSP developed by Infineon + * - Xtensa + - Yes + - Yes + - A configurable 32 bit soft core now owned by Cadence + +A number of features are are only available when running under +emulation including :ref:`Record/Replay` and :ref:`TCG Plugins`. diff --git a/docs/about/index.rst b/docs/about/index.rst index bae1309cc6..b00b584b31 100644 --- a/docs/about/index.rst +++ b/docs/about/index.rst @@ -23,6 +23,7 @@ allows you to create, convert and modify disk images. :maxdepth: 2 build-platforms + emulation deprecated removed-features license diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index 9740a70406..81dcd43a61 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -3,6 +3,8 @@ Copyright (c) 2019, Linaro Limited Written by Emilio Cota and Alex Bennée +.. _TCG Plugins: + QEMU TCG Plugins ================ diff --git a/docs/system/arm/emulation.rst b/docs/system/arm/emulation.rst index b33d7c28dc..b87e064d9d 100644 --- a/docs/system/arm/emulation.rst +++ b/docs/system/arm/emulation.rst @@ -1,3 +1,5 @@ +.. _Arm Emulation: + A-profile CPU architecture support ==================================