From patchwork Wed Sep 27 06:13:09 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bhupinder Thakur X-Patchwork-Id: 114331 Delivered-To: patch@linaro.org Received: by 10.140.106.117 with SMTP id d108csp4665345qgf; Tue, 26 Sep 2017 23:16:57 -0700 (PDT) X-Received: by 10.107.169.226 with SMTP id f95mr464385ioj.38.1506493017551; Tue, 26 Sep 2017 23:16:57 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1506493017; cv=none; d=google.com; s=arc-20160816; b=lJI4q8b53W31QGaO5EHkygOG+TOmFsOzP2sq2LPuqzlDmrOPXwRv+/TCaXbrbD9xtp C1Ft7n5ox+hplHQNW2bCP92HVv+JYPrCCdHHy78FaZfXe0itKCohS49jNpAEtt6UcJ5Z SJdNdOMTgNKo+iuTgN5belVtPc86uhZi/9MgI2PfmOfqpVMf7DSeBFAF/I82XN2tRs3Q X7h49YOo+8MV2T/qNSCAuGuh8Hd7GqzMoL5K1zXo3SOSkUH9CRMec79TXgfVfdRcPmQp VSGhqR+4pRcq6cqqzE0E2+r3qHzew1tbN2yUVHVQySFHU0l09Vnc2s2vOpieZ1RGjB6U gc4Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:mime-version :list-subscribe:list-help:list-post:list-unsubscribe:list-id :precedence:subject:cc:message-id:date:to:from:dkim-signature :arc-authentication-results; bh=HvvFPpd/+Lzj6WRNQaQv+1bhvnsy9kr8jgN3YupgRqU=; b=QzeEefzSI/vF6jXGdjmhsq6RF7lwhWQ6FOrKYRt2hqKfubyCvRoSeZqWpgExrzZPMU J1UHMrzbFwvGxuWXMQyH9tNsST3fF11vjyCS0fT0d8XfrrntpmXe2NISCvWjAbLHwBrj pEpXsf4P7t7CBdGHnUl2vNYxLQWQEu37Wj4p4j/5gQbuBhFCFtE8WuiNV2Pm7iZ7Qv2g 2edY7fEXdEpiGATitzf2s1PvhxcCsLVenRBZi01xZ3xVFrhOoK8ftkJtqtVtYLCkdsnD oEeoW9gW1sJYk7rTgi/EqhDTiRvaJ8kUz1hfMZ25PykWhWfR+pLqhZ0A16axaU870Nwc MVpg== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=aH4kGWre; spf=neutral (google.com: 192.237.175.120 is neither permitted nor denied by best guess record for domain of xen-devel-bounces@lists.xen.org) smtp.mailfrom=xen-devel-bounces@lists.xen.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.xenproject.org (lists.xenproject.org. [192.237.175.120]) by mx.google.com with ESMTPS id o8si3770303itf.71.2017.09.26.23.16.57 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 26 Sep 2017 23:16:57 -0700 (PDT) Received-SPF: neutral (google.com: 192.237.175.120 is neither permitted nor denied by best guess record for domain of xen-devel-bounces@lists.xen.org) client-ip=192.237.175.120; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=aH4kGWre; spf=neutral (google.com: 192.237.175.120 is neither permitted nor denied by best guess record for domain of xen-devel-bounces@lists.xen.org) smtp.mailfrom=xen-devel-bounces@lists.xen.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dx5bM-0002Oo-Fj; Wed, 27 Sep 2017 06:13:44 +0000 Received: from mail6.bemta6.messagelabs.com ([193.109.254.103]) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dx5bL-0002Oi-Bo for xen-devel@lists.xenproject.org; Wed, 27 Sep 2017 06:13:43 +0000 Received: from [85.158.143.35] by server-2.bemta-6.messagelabs.com id 01/82-10804-6914BC95; Wed, 27 Sep 2017 06:13:42 +0000 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFtrBIsWRWlGSWpSXmKPExsXiVRtspDvV8XS kwbFJKhbft0xmcmD0OPzhCksAYxRrZl5SfkUCa8bMsztYCjp9K27+Wc/YwNhq08XIySEkMINR Ytkv8y5GLg4WgXZmifPrzzGBOBIC71gkdj1YywRSJSGQJ/Gu5yQ7hJ0mMb/xOyOEXSax9OYnR ohJWhJHT81mBWkWEljBJHFz1iSWLkYODjYBE4lZHRIgNSICShL3Vk0GW8AsMJFZYsGP42BDhQ XsJO5Mmwc2iEVAVeLkl+1gcV4Bb4nupslQi+Ukbp7rZJ7AyL+AkWEVo0ZxalFZapGukaleUlF mekZJbmJmjq6hgZlebmpxcWJ6ak5iUrFecn7uJkZgCDEAwQ7GVQsCDzFKcjApifLW/D8VKcSX lJ9SmZFYnBFfVJqTWnyIUYaDQ0mCN87hdKSQYFFqempFWmYOMJhh0hIcPEoivFEgad7igsTc4 sx0iNQpxkCOY5su/2Hi+DHpCpD80nsDSO7bcwtIdty8CyQ3gckN3x/8YRJiycvPS5US560CGS QAMiijNA9uDSxCLzHKSgnzMgIdLsRTkFqUm1mCKv+KUZyDUUmYNxlkCk9mXgncNa+ADmUCOrR 36gmQQ0sSEVJSDYxTDiplSBhuFuW/fCrmYm1Cmpj+Mvf9bEd3sUw886kiMstUuXb1ji0Gt14e W/O2pPnYlR9JrHGppabTklXe1MfK+DX56Fl0O/P9LXLtCu95qLRBOV6JNSbF4bqJaVo79zbmS xciT0YqlyZZyVT/LtZUfjPdZAnzOevI5DWRKdozUqRk2q8lKLEUZyQaajEXFScCAJaaUdPLAg AA X-Env-Sender: bhupinder.thakur@linaro.org X-Msg-Ref: server-6.tower-21.messagelabs.com!1506492820!61730286!1 X-Originating-IP: [74.125.83.50] X-SpamReason: No, hits=1.3 required=7.0 tests=BODY_RANDOM_LONG,USERPASS X-StarScan-Received: X-StarScan-Version: 9.4.45; banners=-,-,- X-VirusChecked: Checked Received: (qmail 22882 invoked from network); 27 Sep 2017 06:13:41 -0000 Received: from mail-pg0-f50.google.com (HELO mail-pg0-f50.google.com) (74.125.83.50) by server-6.tower-21.messagelabs.com with AES128-GCM-SHA256 encrypted SMTP; 27 Sep 2017 06:13:41 -0000 Received: by mail-pg0-f50.google.com with SMTP id k193so7220041pgc.8 for ; Tue, 26 Sep 2017 23:13:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=FesRZHJXUs2hUBBJ681jzdblGghMg9XPtH6FnY2CGWs=; b=aH4kGWreAORIyA3GyzCjOxWRlHVso2SNf1vwbl9UiZL7olcC18K3eqL4Q0Hpczwtbu cv7Y1IwleuQy7YqLwse33w1IcJPIZrpYk18+t50MRnTa31sr7tkYp0NKbYUfcmZGmxal gAL337geqecUSquEvAXzq6KsHONnbgn6k0Kfc= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=FesRZHJXUs2hUBBJ681jzdblGghMg9XPtH6FnY2CGWs=; b=kg/HnciHSqvj1zVojGgQ13KiH6zpF4Ud9m+QBFYA9qF20NpFT1HANV9Tw+RYQoiZuj laKFmC6y11m1mubyzmjDw9zAYZf7tGLlvy3bmA/lVHC3YHRV6IfpwFRtli/Ea8JRMGif z/swP1f2Xaobo0o5F/Ha3KV1I2MYkWzHBHmhCAxmnc0++49Xvxy3yUE9ibG7lEZ7QrXF XSyQ1kLamLOTcyYVCOkF7lP1WURB8OCH7jOAXUviHrBA1z55KxsJ5zKCQpgfkbW/Oel+ d4XoiB+IaLun9OUoTnAv++TJbRpvP01H4gr7UnVq+TxOsVQ7PtdYobdgEAlkGzCz648Z XOqQ== X-Gm-Message-State: AHPjjUjCj3jw0c5Oxi79MkhX6lFOWQ1Lpj3AbQwplGCNNdpnlnDuSNGE re/iXY729lqp66S6aC9bW5t9Iz+nahc= X-Google-Smtp-Source: AOwi7QAFuBtaslldKErg7D4Fxld1J0IyHv7GXbTPyd/d2g9zJHLlkfDoEYGKUALAa/butewTKxCoAw== X-Received: by 10.98.13.151 with SMTP id 23mr345146pfn.39.1506492819486; Tue, 26 Sep 2017 23:13:39 -0700 (PDT) Received: from blr-ubuntu-linaro.wlan.qualcomm.com (h3.248.139.40.ip.windstream.net. [40.139.248.3]) by smtp.gmail.com with ESMTPSA id s187sm18013485pgb.82.2017.09.26.23.13.37 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 26 Sep 2017 23:13:38 -0700 (PDT) From: Bhupinder Thakur To: xen-devel@lists.xenproject.org Date: Wed, 27 Sep 2017 11:43:09 +0530 Message-Id: <1506492816-25954-1-git-send-email-bhupinder.thakur@linaro.org> X-Mailer: git-send-email 2.7.4 Cc: Stefano Stabellini , Wei Liu , George Dunlap , Andrew Cooper , Ian Jackson , Tim Deegan , Julien Grall , Jan Beulich , Andre Przywara Subject: [Xen-devel] [PATCH 00/27 v11] SBSA UART emulation support in Xen X-BeenThere: xen-devel@lists.xen.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: xen-devel-bounces@lists.xen.org Sender: "Xen-devel" SBSA UART emulation for guests in Xen ====================================== Linaro has published VM System specification for ARM Processors, which provides a set of guidelines for both guest OS and hypervisor implementations, such that building OS images according to these guidelines guarantees that those images can also run on hypervisors compliant with this specification. One of the spec requirements is that the hypervisor must provide an emulated SBSA UART as a serial console which meets the minimum requirements in SBSA UART as defined in appendix B of the following ARM Server Base Architecture Document: https://static.docs.arm.com/den0029/a/Server_Base_System_Architecture_v3_1_ARM_DEN_0029A.pdf. This feature allows the Xen guests to use SBSA compliant UART as as a console. Note that SBSA UART is a subset of full featured ARM pl011 UART and supports only a subset of registers as mentioned below. It does not support rx/tx DMA. Currently, Xen supports paravirtualized (aka PV console) and an emulated serial consoles. This feature will expose an emulated SBSA UART console to the guest, which a user can access using xenconsole. The device tree passed to the guest VM will contain the SBSA UART MMIO address range and an irq for receiving rx/tx interrupts. The device tree format is specified in Documentation/devicetree/bindings/serial/arm_sbsa_uart.txt. The Xen hypervisor will expose two types of interfaces to the backend and domU. The interface exposed to domU will be an emulated SBSA UART by emulating the access to the following registers by the guest. - Data register (DR) - RW - Raw interrupt status register (RIS) - RO - Masked interrupt status register (MIS)- RO - Interrupt Mask (IMSC) - RW - Interrupt Clear (ICR) - WO It will also inject the interrupts to the guest in the following conditions: - incoming data in the rx buffer for the guest - there is space in the tx buffer for the guest to write more data The interface exposed to the backend will be the same PV console interface, which minimizes the changes required in xenconsole to support a new SBSA UART console. This interface has rx and tx ring buffers and an event channel for sending/receiving events from the backend. So essentially Xen handles the data on behalf of domU and the backend. Any data written by domU is captured by Xen and written to the TX (OUT) ring buffer and an event is raised to the backend to read the TX ring buffer. Similarly on reciving an event from xenconsole, Xen injects an interrupt to guest to indicate there is data available in the RX (IN) ring buffer. The SBSA UART state is completely captured in the set of registers mentioned above and this state is updated everytime there is an event from the backend or there is register read/write access from domU. For example, if domU has masked the rx interrupt in the IMSC register, then Xen will not inject an interrupt to guest and will just update the RIS register. Once the interrupt is unmasked by guest, the interrupt will be delivered to the guest. Changes summary: Xen Hypervisor =============== 1. Add emulation code to emulate read/write access to SBSA UART registers and interrupts: - It emulates DR read/write by reading and writing from/to the IN and OUT ring buffers and raising an event to dom0 when there is data in the OUT ring buffer and injecting an interrupt to the guest when there is data in the IN ring buffer. - Other registers are related to interrupt management and essentially control when interrupts are delivered to the guest. 2. Add a new domctl API to initialize SBSA UART emulation in Xen. 3. Enable SBSA UART emulation for a domain based on a libxl option passed during domain creation. Toolstack ========== 1. Add a new option "vuart" in the domU configuration file to enable/disable vuart. 2. Create a SBSA UART DT node in the guest device tree. It uses a fixed SPI IRQ number and MMIO address range for SBSA UART. 3. Call vuart init DOMCTL API to enable SBSA UART emulation. 5. Add a new vuart xenstore node, which contains: - ring-ref - event channel - buffer limit - type Xenconsoled ============ 1. Split the domain structure to support multiple consoles. 2. Modify different APIs such as buffer_append() etc. to operate on the console structure. 3. Add support for handling multiple consoles. 4. Add support for vuart console: The vpl011 changes available at the following repo: url: https://git@git.linaro.org:/people/bhupinder.thakur/xen.git branch: vpl011_v11 There are some TBD items which need to be looked at in the future: 1. Currently UEFI firmware logs the output to hvc console only. How can UEFI firmware be made aware of pl011 console and how it can use it as a console instead of hvc. There was a discussion on this and it was decided that SBSA UART should be used as a debug port by the UEFI firmware so that all debug output is redirected to this port. 2. Linux seems to have hvc console as the default console i.e. if no console is specified then it uses hvc as the console. How can an option be provided in Linux to select either hvc or pl011 as the default console. It was suggeted to use the SPCR in ACPI and the stdout-path option in the device tree to specify the default console. However, currently hvc console is not describable in the ACPI/device tree. This support will have to be added to allow the user to specify the default console. 3. ACPI support for pl011 device. CC: Andrew Cooper CC: George Dunlap CC: Ian Jackson CC: Jan Beulich CC: Konrad Rzeszutek Wilk CC: Stefano Stabellini CC: Tim Deegan CC: Wei Liu CC: Julien Grall CC: Andre Przywara Bhupinder Thakur (27): xen/arm: vpl011: Define common ring buffer helper functions in console.h xen/arm: vpl011: Add SBSA UART emulation in Xen xen/arm: vpl011: Allocate a new GFN in the toolstack for vuart xen/arm: vpl011: Add support for vuart in libxl xen/arm: vpl011: Rearrange xen header includes in alphabetical order in domctl.c xen/arm: vpl011: Add a new domctl API to initialize vpl011 xen/arm: vpl011: Add a new vuart node in the xenstore xen/arm: vpl011: Modify xenconsole to define and use a new console structure xen/arm: vpl011: Rename the console structure field conspath to xspath xen/arm: vpl011: Modify xenconsole functions to take console structure as input xen/arm: vpl011: Add a new console_init function in xenconsole xen/arm: vpl011: Add a new buffer_available function in xenconsole xen/arm: vpl011: Add a new maybe_add_console_evtchn_fd function in xenconsole xen/arm: vpl011: Add a new maybe_add_console_tty_fd function in xenconsole xen/arm: vpl011: Add a new console_evtchn_unmask function in xenconsole xen/arm: vpl011: Add a new handle_console_ring function in xenconsole xen/arm: vpl011: Add a new handle_console_tty function in xenconsole xen/arm: vpl011: Add a new console_cleanup function in xenconsole xen/arm: vpl011: Add a new console_open_log function in xenconsole xen/arm: vpl011: Add a new console_close_evtchn function in xenconsole xen/arm: vpl011: Add support for multiple consoles in xenconsole xen/arm: vpl011: Add support for vuart console in xenconsole xen/arm: vpl011: Add a new vuart console type to xenconsole client xen/arm: vpl011: Add a pl011 uart DT node in the guest device tree xen/arm: vpl011: Update documentation for vuart console support xen/arm: vpl011: Fix the slow early console SBSA UART output xen/arm: vpl011: Correct the logic for asserting/de-asserting SBSA UART TX interrupt docs/man/xl.cfg.pod.5.in | 12 + docs/misc/console.txt | 44 ++- tools/console/Makefile | 3 +- tools/console/client/main.c | 13 +- tools/console/daemon/io.c | 661 +++++++++++++++++++++++------------ tools/libxc/include/xc_dom.h | 2 + tools/libxc/include/xenctrl.h | 20 ++ tools/libxc/xc_dom_arm.c | 5 +- tools/libxc/xc_dom_boot.c | 2 + tools/libxc/xc_domain.c | 27 ++ tools/libxl/libxl.h | 7 + tools/libxl/libxl_arch.h | 7 + tools/libxl/libxl_arm.c | 89 +++++ tools/libxl/libxl_console.c | 47 +++ tools/libxl/libxl_create.c | 9 +- tools/libxl/libxl_device.c | 9 +- tools/libxl/libxl_dom.c | 5 + tools/libxl/libxl_internal.h | 6 + tools/libxl/libxl_types.idl | 7 + tools/libxl/libxl_types_internal.idl | 1 + tools/libxl/libxl_x86.c | 8 + tools/xl/xl_cmdtable.c | 2 +- tools/xl/xl_console.c | 5 +- tools/xl/xl_parse.c | 8 + xen/arch/arm/Kconfig | 7 + xen/arch/arm/Makefile | 1 + xen/arch/arm/domain.c | 6 + xen/arch/arm/domctl.c | 58 ++- xen/arch/arm/vpl011.c | 496 ++++++++++++++++++++++++++ xen/include/Makefile | 1 + xen/include/asm-arm/domain.h | 6 + xen/include/asm-arm/pl011-uart.h | 2 + xen/include/asm-arm/vpl011.h | 74 ++++ xen/include/public/arch-arm.h | 6 + xen/include/public/domctl.h | 24 ++ xen/include/public/io/console.h | 6 + 36 files changed, 1445 insertions(+), 241 deletions(-) create mode 100644 xen/arch/arm/vpl011.c create mode 100644 xen/include/asm-arm/vpl011.h