From patchwork Tue Feb 24 18:03:05 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ard Biesheuvel X-Patchwork-Id: 44979 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f197.google.com (mail-lb0-f197.google.com [209.85.217.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id DEFC72029F for ; Tue, 24 Feb 2015 18:06:48 +0000 (UTC) Received: by lbdu10 with SMTP id u10sf18448757lbd.3 for ; Tue, 24 Feb 2015 10:06:47 -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:cc:subject:precedence:list-id:list-unsubscribe:list-post :list-help:list-subscribe:mime-version:content-type :content-transfer-encoding:sender:errors-to:x-original-sender :x-original-authentication-results:mailing-list:list-archive; bh=sZoTdaNRZhCeojWc3yEHDa6jjnGyv5+1kujZe/CysQY=; b=dFPrSHwKT7EluvDZNJj6dF0/4FGuHDVyGxOA3nsS3jMPElmNUgKOQOsP1QWw723XEv XLYyYOm5rSFXJBk29oJ6q96pwD9ikaIRFAUceYpVovg+9JQDsgRQ3Hd6NHomdGKZORtr CJ13mc4QW6GiJ8+dxrK/asnvEl1KY56N+DT2xgjHczCXi3g6QkJQ0jct6V3uufjDMzf6 X8oBR82pJeUegFfsNmCR3Jq6nu1Yvl43i0kXXkMyyKd4eO/z5uUW31iZecTYPBmlNTle L1msPiZKbpFhV6uWsbRYdFgTSUoaC87q6uTvQdM1nqMwg8yn9CRlM5Ugci2i+hkcNYhC Vogg== X-Gm-Message-State: ALoCoQkPjZ+CWiWGsf3xTa7OW77992FpajUvEoY390E+h/ZHt2aiqugGOFkcN9KA4TepSHKyWZO/ X-Received: by 10.112.130.70 with SMTP id oc6mr136096lbb.13.1424801207779; Tue, 24 Feb 2015 10:06:47 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.3.200 with SMTP id e8ls657144lae.65.gmail; Tue, 24 Feb 2015 10:06:47 -0800 (PST) X-Received: by 10.152.115.169 with SMTP id jp9mr15458581lab.121.1424801207509; Tue, 24 Feb 2015 10:06:47 -0800 (PST) Received: from mail-la0-f41.google.com (mail-la0-f41.google.com. [209.85.215.41]) by mx.google.com with ESMTPS id sm5si26560885lbb.39.2015.02.24.10.06.47 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 24 Feb 2015 10:06:47 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.41 as permitted sender) client-ip=209.85.215.41; Received: by labhv19 with SMTP id hv19so4884240lab.10 for ; Tue, 24 Feb 2015 10:06:47 -0800 (PST) X-Received: by 10.152.115.136 with SMTP id jo8mr11843995lab.32.1424801207355; Tue, 24 Feb 2015 10:06:47 -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 h5csp2079445lbj; Tue, 24 Feb 2015 10:06:46 -0800 (PST) X-Received: by 10.140.85.137 with SMTP id n9mr36621887qgd.17.1424801205346; Tue, 24 Feb 2015 10:06:45 -0800 (PST) Received: from lists.xen.org (lists.xen.org. [50.57.142.19]) by mx.google.com with ESMTPS id d1si6320173qam.88.2015.02.24.10.06.44 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 24 Feb 2015 10:06:45 -0800 (PST) Received-SPF: none (google.com: xen-devel-bounces@lists.xen.org does not designate permitted sender hosts) client-ip=50.57.142.19; Received: from localhost ([127.0.0.1] helo=lists.xen.org) by lists.xen.org with esmtp (Exim 4.72) (envelope-from ) id 1YQJra-0003Oo-St; Tue, 24 Feb 2015 18:05:42 +0000 Received: from mail6.bemta4.messagelabs.com ([85.158.143.247]) by lists.xen.org with esmtp (Exim 4.72) (envelope-from ) id 1YQJrY-0003Jk-Io for xen-devel@lists.xen.org; Tue, 24 Feb 2015 18:05:40 +0000 Received: from [85.158.143.35] by server-1.bemta-4.messagelabs.com id AE/EC-03004-37DBCE45; Tue, 24 Feb 2015 18:05:39 +0000 X-Env-Sender: ard.biesheuvel@linaro.org X-Msg-Ref: server-11.tower-21.messagelabs.com!1424801138!12843977!1 X-Originating-IP: [74.125.82.181] X-SpamReason: No, hits=0.5 required=7.0 tests=BODY_RANDOM_LONG, UPPERCASE_25_50 X-StarScan-Received: X-StarScan-Version: 6.13.4; banners=-,-,- X-VirusChecked: Checked Received: (qmail 18344 invoked from network); 24 Feb 2015 18:05:39 -0000 Received: from mail-we0-f181.google.com (HELO mail-we0-f181.google.com) (74.125.82.181) by server-11.tower-21.messagelabs.com with RC4-SHA encrypted SMTP; 24 Feb 2015 18:05:39 -0000 Received: by wesw62 with SMTP id w62so26796931wes.9 for ; Tue, 24 Feb 2015 10:05:38 -0800 (PST) X-Received: by 10.194.61.12 with SMTP id l12mr34679059wjr.139.1424801138763; Tue, 24 Feb 2015 10:05:38 -0800 (PST) Received: from ards-macbook-pro.lan (bl11-65-113.dsl.telepac.pt. [85.244.65.113]) by mx.google.com with ESMTPSA id w8sm12792521wja.4.2015.02.24.10.05.35 (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 24 Feb 2015 10:05:37 -0800 (PST) From: Ard Biesheuvel To: edk2-devel@lists.sourceforge.net, olivier.martin@arm.com, lersek@redhat.com, roy.franz@linaro.org, leif.lindholm@linaro.org, stefano.stabellini@eu.citrix.com, ian.campbell@citrix.com, anthony.perard@citrix.com, xen-devel@lists.xen.org, julien.grall@linaro.org, jordan.l.justen@intel.com, michael.d.kinney@intel.com Date: Tue, 24 Feb 2015 18:03:05 +0000 Message-Id: <1424800990-15777-25-git-send-email-ard.biesheuvel@linaro.org> X-Mailer: git-send-email 1.8.3.2 In-Reply-To: <1424800990-15777-1-git-send-email-ard.biesheuvel@linaro.org> References: <1424800990-15777-1-git-send-email-ard.biesheuvel@linaro.org> Cc: wei.liu2@citrix.com, Ard Biesheuvel Subject: [Xen-devel] [PATCH v5 24/29] Ovmf/Xen: add Xen PV console SerialPortLib driver X-BeenThere: xen-devel@lists.xen.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Sender: xen-devel-bounces@lists.xen.org Errors-To: xen-devel-bounces@lists.xen.org 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.215.41 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 List-Archive: 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 Acked-by: Laszlo Ersek 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