From patchwork Tue Feb 3 19:20:07 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ard Biesheuvel X-Patchwork-Id: 44299 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f200.google.com (mail-lb0-f200.google.com [209.85.217.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id E12772034D for ; Tue, 3 Feb 2015 19:22:17 +0000 (UTC) Received: by mail-lb0-f200.google.com with SMTP id u10sf7827262lbd.3 for ; Tue, 03 Feb 2015 11:22:16 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:in-reply-to :references:subject:precedence:reply-to:list-id:list-unsubscribe :list-archive:list-post:list-help:list-subscribe:mime-version :content-type:content-transfer-encoding:errors-to:x-original-sender :x-original-authentication-results:mailing-list; bh=kaPGD+M3S7CM/I2iA+opKnclLX3T5Gw9TOQvz0iBUQY=; b=gzcThntAFC6C/fWV8+7cSfz8G7TCfSWtvHq+oSj/KK7BZ2PkKvJwgumF+8Ey5eQKHL +FwgmAAkEUoeOooO94Nni9ga2asG/VJsJBKkvSdI68MliDjm6MKmXjh6ZmfOq7d6Lh1S bzSRDBb3zyRs4RWaUUZVLTCWE3ckKGpfTwONUDtZlXilJMwOt2UTWpBTOtXjqsKXixdP 2MKphlCRUaO41yvEExNluFuHtSyRi5bYwPsNSQPpOmsY8yeunD+EK7gK/f6SR6LSxsm4 Q9BzuBdbqKiP1eubDhpGJPmv69aRBkeNdstyES0YfbsoenC3sr4ugl5cQ49TdHZDHYYE bhsw== X-Gm-Message-State: ALoCoQkJ0zWY3YdbmJZp/vfOnXLNExWqFp+Rb8lBfilkwGkVivGcWfsrXUoZgvOQgiR0xKIyuTah X-Received: by 10.112.64.171 with SMTP id p11mr3311390lbs.12.1422991336738; Tue, 03 Feb 2015 11:22:16 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.23.130 with SMTP id m2ls672954laf.87.gmail; Tue, 03 Feb 2015 11:22:16 -0800 (PST) X-Received: by 10.112.92.129 with SMTP id cm1mr26580119lbb.85.1422991336588; Tue, 03 Feb 2015 11:22:16 -0800 (PST) Received: from mail-lb0-f180.google.com (mail-lb0-f180.google.com. [209.85.217.180]) by mx.google.com with ESMTPS id ww5si20142050lbb.22.2015.02.03.11.22.16 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 03 Feb 2015 11:22:16 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.180 as permitted sender) client-ip=209.85.217.180; Received: by mail-lb0-f180.google.com with SMTP id b6so40446775lbj.11 for ; Tue, 03 Feb 2015 11:22:16 -0800 (PST) X-Received: by 10.112.181.41 with SMTP id dt9mr26226254lbc.56.1422991336489; Tue, 03 Feb 2015 11:22:16 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.35.133 with SMTP id h5csp34380lbj; Tue, 3 Feb 2015 11:22:15 -0800 (PST) X-Received: by 10.107.151.80 with SMTP id z77mr30459884iod.51.1422991334571; Tue, 03 Feb 2015 11:22:14 -0800 (PST) Received: from lists.sourceforge.net (lists.sourceforge.net. [216.34.181.88]) by mx.google.com with ESMTPS id cy19si10376392igc.10.2015.02.03.11.22.13 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 03 Feb 2015 11:22:14 -0800 (PST) Received-SPF: pass (google.com: domain of edk2-devel-bounces@lists.sourceforge.net designates 216.34.181.88 as permitted sender) client-ip=216.34.181.88; Received: from localhost ([127.0.0.1] helo=sfs-ml-2.v29.ch3.sourceforge.com) by sfs-ml-2.v29.ch3.sourceforge.com with esmtp (Exim 4.76) (envelope-from ) id 1YIj2z-0002VZ-U8; Tue, 03 Feb 2015 19:22:05 +0000 Received: from sog-mx-2.v43.ch3.sourceforge.com ([172.29.43.192] helo=mx.sourceforge.net) by sfs-ml-2.v29.ch3.sourceforge.com with esmtp (Exim 4.76) (envelope-from ) id 1YIj2z-0002VI-1E for edk2-devel@lists.sourceforge.net; Tue, 03 Feb 2015 19:22:05 +0000 Received-SPF: pass (sog-mx-2.v43.ch3.sourceforge.com: domain of linaro.org designates 209.85.212.182 as permitted sender) client-ip=209.85.212.182; envelope-from=ard.biesheuvel@linaro.org; helo=mail-wi0-f182.google.com; Received: from mail-wi0-f182.google.com ([209.85.212.182]) by sog-mx-2.v43.ch3.sourceforge.com with esmtps (TLSv1:RC4-SHA:128) (Exim 4.76) id 1YIj2t-0002GJ-9X for edk2-devel@lists.sourceforge.net; Tue, 03 Feb 2015 19:22:04 +0000 Received: by mail-wi0-f182.google.com with SMTP id n3so23965319wiv.3 for ; Tue, 03 Feb 2015 11:21:53 -0800 (PST) X-Received: by 10.180.189.52 with SMTP id gf20mr37033556wic.27.1422991313221; Tue, 03 Feb 2015 11:21:53 -0800 (PST) Received: from ards-macbook-pro.local (73.233.28.37.rev.vodafone.pt. [37.28.233.73]) by mx.google.com with ESMTPSA id eb7sm25860139wic.11.2015.02.03.11.21.49 (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 03 Feb 2015 11:21:52 -0800 (PST) From: Ard Biesheuvel To: edk2-devel@lists.sourceforge.net, lersek@redhat.com, olivier.martin@arm.com, roy.franz@linaro.org, leif.lindholm@linaro.org, stefano.stabellini@eu.citrix.com, ian.campbell@citrix.com, anthony.perard@citrix.com, christoffer.dall@linaro.org, xen-devel@lists.xen.org, ilias.biris@linaro.org, julien.grall@linaro.org Date: Tue, 3 Feb 2015 19:20:07 +0000 Message-Id: <1422991212-9257-23-git-send-email-ard.biesheuvel@linaro.org> X-Mailer: git-send-email 1.8.3.2 In-Reply-To: <1422991212-9257-1-git-send-email-ard.biesheuvel@linaro.org> References: <1422991212-9257-1-git-send-email-ard.biesheuvel@linaro.org> X-Spam-Score: -1.5 (-) X-Spam-Report: Spam Filtering performed by mx.sourceforge.net. See http://spamassassin.org/tag/ for more details. -1.5 SPF_CHECK_PASS SPF reports sender host as permitted sender for sender-domain -0.0 SPF_PASS SPF: sender matches SPF record -0.0 AWL AWL: Adjusted score from AWL reputation of From: address X-Headers-End: 1YIj2t-0002GJ-9X Subject: [edk2] [PATCH v3 22/27] Ovmf/Xen: add Xen PV console SerialPortLib driver X-BeenThere: edk2-devel@lists.sourceforge.net X-Mailman-Version: 2.1.9 Precedence: list Reply-To: edk2-devel@lists.sourceforge.net List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: edk2-devel-bounces@lists.sourceforge.net X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: ard.biesheuvel@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.180 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 This implements a SerialPortLib instance that wires up to the PV console ring used by domU guests. Also imports the required upstream Xen io/console.h header. Contributed-under: TianoCore Contribution Agreement 1.0 Reviewed-by: Stefano Stabellini Signed-off-by: Ard Biesheuvel --- OvmfPkg/Include/IndustryStandard/Xen/io/console.h | 51 +++++++ .../XenConsoleSerialPortLib.c | 156 +++++++++++++++++++++ .../XenConsoleSerialPortLib.inf | 35 +++++ 3 files changed, 242 insertions(+) create mode 100644 OvmfPkg/Include/IndustryStandard/Xen/io/console.h create mode 100644 OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c create mode 100644 OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.inf diff --git a/OvmfPkg/Include/IndustryStandard/Xen/io/console.h b/OvmfPkg/Include/IndustryStandard/Xen/io/console.h new file mode 100644 index 000000000000..f1caa9765bcf --- /dev/null +++ b/OvmfPkg/Include/IndustryStandard/Xen/io/console.h @@ -0,0 +1,51 @@ +/****************************************************************************** + * console.h + * + * Console I/O interface for Xen guest OSes. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + * + * Copyright (c) 2005, Keir Fraser + */ + +#ifndef __XEN_PUBLIC_IO_CONSOLE_H__ +#define __XEN_PUBLIC_IO_CONSOLE_H__ + +typedef UINT32 XENCONS_RING_IDX; + +#define MASK_XENCONS_IDX(idx, ring) ((idx) & (sizeof(ring)-1)) + +struct xencons_interface { + char in[1024]; + char out[2048]; + XENCONS_RING_IDX in_cons, in_prod; + XENCONS_RING_IDX out_cons, out_prod; +}; + +#endif /* __XEN_PUBLIC_IO_CONSOLE_H__ */ + +/* + * Local variables: + * mode: C + * c-file-style: "BSD" + * c-basic-offset: 4 + * tab-width: 4 + * indent-tabs-mode: nil + * End: + */ diff --git a/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c b/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c new file mode 100644 index 000000000000..98022354cf31 --- /dev/null +++ b/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c @@ -0,0 +1,156 @@ +/** @file + Xen console SerialPortLib instance + + Copyright (c) 2015, Linaro Ltd. All rights reserved.
+ + This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +**/ + +#include +#include + +#include +#include +#include + +#include +#include +#include + +// +// The code below expects these global variables to be mutable, even in the case +// that we have been incorporated into SEC or PEIM phase modules (which is +// allowed by our INF description). While this is a dangerous assumption to make +// in general, it is actually fine for the Xen domU (guest) environment that +// this module is intended for, as UEFI always executes from DRAM in that case. +// +STATIC evtchn_send_t mXenConsoleEventChain; +STATIC struct xencons_interface *mXenConsoleInterface; + +RETURN_STATUS +EFIAPI +SerialPortInitialize ( + VOID + ) +{ + if (!mXenConsoleInterface) { + mXenConsoleEventChain.port = (UINT32)XenHypercallHvmGetParam (HVM_PARAM_CONSOLE_EVTCHN); + mXenConsoleInterface = (struct xencons_interface *)(UINTN) + (XenHypercallHvmGetParam (HVM_PARAM_CONSOLE_PFN) << EFI_PAGE_SHIFT); + + // + // No point in ASSERT'ing here as we won't be seeing the output + // + } + return RETURN_SUCCESS; +} + +/** + Write data to serial device. + + @param Buffer Point of data buffer which need to be written. + @param NumberOfBytes Number of output bytes which are cached in Buffer. + + @retval 0 Write data failed. + @retval !0 Actual number of bytes written to serial device. + +**/ +UINTN +EFIAPI +SerialPortWrite ( + IN UINT8 *Buffer, + IN UINTN NumberOfBytes + ) +{ + XENCONS_RING_IDX Consumer, Producer; + UINTN Sent; + + if (!mXenConsoleInterface) { + return 0; + } + + Consumer = mXenConsoleInterface->out_cons; + Producer = mXenConsoleInterface->out_prod; + + MemoryFence (); + + Sent = 0; + while (Sent < NumberOfBytes && ((Producer - Consumer) < sizeof (mXenConsoleInterface->out))) + mXenConsoleInterface->out[MASK_XENCONS_IDX(Producer++, mXenConsoleInterface->out)] = Buffer[Sent++]; + + MemoryFence (); + + mXenConsoleInterface->out_prod = Producer; + + if (Sent > 0) { + XenHypercallEventChannelOp (EVTCHNOP_send, &mXenConsoleEventChain); + } + + return Sent; +} + +/** + Read data from serial device and save the data in buffer. + + @param Buffer Point of data buffer which need to be written. + @param NumberOfBytes Size of Buffer[]. + + @retval 0 Read data failed. + @retval !0 Actual number of bytes read from serial device. + +**/ +UINTN +EFIAPI +SerialPortRead ( + OUT UINT8 *Buffer, + IN UINTN NumberOfBytes +) +{ + XENCONS_RING_IDX Consumer, Producer; + UINTN Received; + + if (!mXenConsoleInterface) { + return 0; + } + + Consumer = mXenConsoleInterface->in_cons; + Producer = mXenConsoleInterface->in_prod; + + MemoryFence (); + + Received = 0; + while (Received < NumberOfBytes && Consumer < Producer) + Buffer[Received++] = mXenConsoleInterface->in[MASK_XENCONS_IDX(Consumer++, mXenConsoleInterface->in)]; + + MemoryFence (); + + mXenConsoleInterface->in_cons = Consumer; + + XenHypercallEventChannelOp (EVTCHNOP_send, &mXenConsoleEventChain); + + return Received; +} + +/** + Check to see if any data is available to be read from the debug device. + + @retval TRUE At least one byte of data is available to be read + @retval FALSE No data is available to be read + +**/ +BOOLEAN +EFIAPI +SerialPortPoll ( + VOID + ) +{ + return mXenConsoleInterface && + mXenConsoleInterface->in_cons != mXenConsoleInterface->in_prod; +} diff --git a/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.inf b/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.inf new file mode 100644 index 000000000000..8a7411558fa3 --- /dev/null +++ b/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.inf @@ -0,0 +1,35 @@ +#/** @file +# +# Component description file for XenConsoleSerialPortLib module +# +# Copyright (c) 2015, Linaro Ltd. All rights reserved.
+# +# This program and the accompanying materials +# are licensed and made available under the terms and conditions of the BSD License +# which accompanies this distribution. The full text of the license may be found at +# http://opensource.org/licenses/bsd-license.php +# +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +# +#**/ + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = XenConsoleSerialPortLib + FILE_GUID = 401406DD-BCAC-4B91-9F4E-72A7FEBE4762 + MODULE_TYPE = BASE + VERSION_STRING = 1.0 + LIBRARY_CLASS = SerialPortLib + CONSTRUCTOR = SerialPortInitialize + +[Sources.common] + XenConsoleSerialPortLib.c + +[LibraryClasses] + BaseLib + XenHypercallLib + +[Packages] + MdePkg/MdePkg.dec + OvmfPkg/OvmfPkg.dec