From patchwork Tue Feb 24 18:03:08 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ard Biesheuvel X-Patchwork-Id: 44983 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f199.google.com (mail-wi0-f199.google.com [209.85.212.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 96EC22029F for ; Tue, 24 Feb 2015 18:07:00 +0000 (UTC) Received: by mail-wi0-f199.google.com with SMTP id bs8sf16315381wib.2 for ; Tue, 24 Feb 2015 10:06:59 -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=UpGpbMf7sraQSisjQyJA2axgENoiivHIF1RCRxhqfs8=; b=IWBhsyANzNYkYeIKV5+ndXoca59qI3g1AyT0x7dYG9KskICCczn92pZNNKCmy0YAB7 yI2mXcNLnJkiQ2arQb69otBkMVfrL3ogpc05sNIKAI94zZl5Pp0KFH+Nxn0lRIffqC4Q ER/RQSlo6xQuBOpU5zuk1IEaFHC+QnHXgXlwEQlBU/DwPuLCRhaFxMNBkwxETGjcW3ch rX2jOtfdvA+yfZXsdP/7HWRjoj9PFU4nbQQpF0VRrXtq6BRZvUIOwhLDRSeOQvxoH4uz cD6YHRIJfxAmbXgwxGZNYhFy6tsDAMI1k8vLdBu+IovPdOtHkpTvhlEf6pdjznmzqXz0 DNTA== X-Gm-Message-State: ALoCoQle048T6g4kRsQ86AkKFe1hx+zYQf2ntoUUADDndMOgZVpL+0zP9CASiTrNmrx57d7PdOEM X-Received: by 10.112.131.106 with SMTP id ol10mr2375657lbb.20.1424801219867; Tue, 24 Feb 2015 10:06:59 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.120.65 with SMTP id la1ls652543lab.77.gmail; Tue, 24 Feb 2015 10:06:59 -0800 (PST) X-Received: by 10.112.223.7 with SMTP id qq7mr15445943lbc.81.1424801219709; Tue, 24 Feb 2015 10:06:59 -0800 (PST) Received: from mail-la0-f45.google.com (mail-la0-f45.google.com. [209.85.215.45]) by mx.google.com with ESMTPS id po1si28973005lbb.87.2015.02.24.10.06.59 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 24 Feb 2015 10:06:59 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.45 as permitted sender) client-ip=209.85.215.45; Received: by labgd6 with SMTP id gd6so4907932lab.8 for ; Tue, 24 Feb 2015 10:06:59 -0800 (PST) X-Received: by 10.152.116.18 with SMTP id js18mr15488790lab.106.1424801219591; Tue, 24 Feb 2015 10:06:59 -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 h5csp2079590lbj; Tue, 24 Feb 2015 10:06:58 -0800 (PST) X-Received: by 10.53.8.38 with SMTP id dh6mr17099370vdd.89.1424801215185; Tue, 24 Feb 2015 10:06:55 -0800 (PST) Received: from lists.xen.org (lists.xen.org. [50.57.142.19]) by mx.google.com with ESMTPS id p2si19120011vdw.88.2015.02.24.10.06.54 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 24 Feb 2015 10:06:55 -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 1YQJrk-0003iC-GS; Tue, 24 Feb 2015 18:05:52 +0000 Received: from mail6.bemta14.messagelabs.com ([193.109.254.103]) by lists.xen.org with esmtp (Exim 4.72) (envelope-from ) id 1YQJri-0003cX-4p for xen-devel@lists.xen.org; Tue, 24 Feb 2015 18:05:50 +0000 Received: from [193.109.254.147] by server-14.bemta-14.messagelabs.com id 2C/C6-02753-D7DBCE45; Tue, 24 Feb 2015 18:05:49 +0000 X-Env-Sender: ard.biesheuvel@linaro.org X-Msg-Ref: server-12.tower-27.messagelabs.com!1424801148!12584614!1 X-Originating-IP: [209.85.212.177] X-SpamReason: No, hits=0.0 required=7.0 tests=UPPERCASE_25_50 X-StarScan-Received: X-StarScan-Version: 6.13.4; banners=-,-,- X-VirusChecked: Checked Received: (qmail 22299 invoked from network); 24 Feb 2015 18:05:48 -0000 Received: from mail-wi0-f177.google.com (HELO mail-wi0-f177.google.com) (209.85.212.177) by server-12.tower-27.messagelabs.com with RC4-SHA encrypted SMTP; 24 Feb 2015 18:05:48 -0000 Received: by mail-wi0-f177.google.com with SMTP id bs8so27195072wib.4 for ; Tue, 24 Feb 2015 10:05:48 -0800 (PST) X-Received: by 10.194.61.12 with SMTP id l12mr34680298wjr.139.1424801147963; Tue, 24 Feb 2015 10:05:47 -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.44 (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 24 Feb 2015 10:05:46 -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:08 +0000 Message-Id: <1424800990-15777-28-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 27/29] ArmVirtualizationPkg: add XenIoMmioLib 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.45 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 adds a XenIoMmioLib declaration and implementation that can be invoked to install the XENIO_PROTOCOL and a corresponding grant table address on a EFI handle. Contributed-under: TianoCore Contribution Agreement 1.0 Reviewed-by: Laszlo Ersek Signed-off-by: Ard Biesheuvel --- OvmfPkg/Include/Library/XenIoMmioLib.h | 64 ++++++++++ OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.c | 166 ++++++++++++++++++++++++++ OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.inf | 39 ++++++ OvmfPkg/OvmfPkg.dec | 4 + 4 files changed, 273 insertions(+) create mode 100644 OvmfPkg/Include/Library/XenIoMmioLib.h create mode 100644 OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.c create mode 100644 OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.inf diff --git a/OvmfPkg/Include/Library/XenIoMmioLib.h b/OvmfPkg/Include/Library/XenIoMmioLib.h new file mode 100644 index 000000000000..3986c72c574e --- /dev/null +++ b/OvmfPkg/Include/Library/XenIoMmioLib.h @@ -0,0 +1,64 @@ +/** @file +* Manage XenBus device path and I/O handles +* +* 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. +* +**/ + +#ifndef _XENIO_MMIO_DEVICE_LIB_H_ +#define _XENIO_MMIO_DEVICE_LIB_H_ + +/** + + Install the XENBUS_ROOT_DEVICE_PATH and XENIO_PROTOCOL protocols on + the handle pointed to by @Handle, or on a new handle if it points to + NULL + + @param Handle Pointer to the handle to install the protocols + on, may point to a NULL handle. + + @param GrantTableAddress The address of the Xen grant table + + @retval EFI_SUCCESS Protocols were installed successfully + + @retval EFI_OUT_OF_RESOURCES The function failed to allocate memory required + by the XenIo MMIO and device path protocols + + @return Status code returned by the boot service + InstallMultipleProtocolInterfaces () + +**/ +EFI_STATUS +XenIoMmioInstall ( + IN OUT EFI_HANDLE *Handle, + IN EFI_PHYSICAL_ADDRESS GrantTableAddress + ); + + +/** + + Uninstall the XENBUS_ROOT_DEVICE_PATH and XENIO_PROTOCOL protocols + + @param Handle Handle onto which the protocols have been installed + earlier by XenIoMmioInstall () + + @retval EFI_SUCCESS Protocols were uninstalled successfully + + @return Status code returned by the boot service + UninstallMultipleProtocolInterfaces () + +**/ +EFI_STATUS +XenIoMmioUninstall ( + IN EFI_HANDLE Handle + ); + +#endif diff --git a/OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.c b/OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.c new file mode 100644 index 000000000000..c710e85865c3 --- /dev/null +++ b/OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.c @@ -0,0 +1,166 @@ +/** @file +* Manage XenBus device path and I/O handles +* +* 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 + +#include +#include + +#pragma pack (1) +typedef struct { + VENDOR_DEVICE_PATH Vendor; + EFI_PHYSICAL_ADDRESS GrantTableAddress; + EFI_DEVICE_PATH_PROTOCOL End; +} XENBUS_ROOT_DEVICE_PATH; +#pragma pack () + +STATIC CONST XENBUS_ROOT_DEVICE_PATH mXenBusRootDevicePathTemplate = { + { + { + HARDWARE_DEVICE_PATH, + HW_VENDOR_DP, + { sizeof (VENDOR_DEVICE_PATH) + sizeof (EFI_PHYSICAL_ADDRESS), 0 } + }, + XENBUS_ROOT_DEVICE_GUID, + }, + 0, + { + END_DEVICE_PATH_TYPE, + END_ENTIRE_DEVICE_PATH_SUBTYPE, + { sizeof (EFI_DEVICE_PATH_PROTOCOL), 0 } + } +}; + +/** + + Install the XENBUS_ROOT_DEVICE_PATH and XENIO_PROTOCOL protocols on + the handle pointed to by @Handle, or on a new handle if it points to + NULL + + @param Handle Pointer to the handle to install the protocols + on, may point to a NULL handle. + + @param GrantTableAddress The address of the Xen grant table + + @retval EFI_SUCCESS Protocols were installed successfully + + @retval EFI_OUT_OF_RESOURCES The function failed to allocate memory required + by the XenIo MMIO and device path protocols + + @return Status code returned by the boot service + InstallMultipleProtocolInterfaces () + +**/ +EFI_STATUS +XenIoMmioInstall ( + IN OUT EFI_HANDLE *Handle, + IN EFI_PHYSICAL_ADDRESS GrantTableAddress + ) +{ + EFI_STATUS Status; + XENIO_PROTOCOL *XenIo; + XENBUS_ROOT_DEVICE_PATH *XenBusDevicePath; + EFI_HANDLE OutHandle; + + ASSERT (Handle != NULL); + + OutHandle = *Handle; + + XenIo = AllocateZeroPool (sizeof *XenIo); + if (!XenIo) { + return EFI_OUT_OF_RESOURCES; + } + XenIo->GrantTableAddress = GrantTableAddress; + + XenBusDevicePath = AllocateCopyPool (sizeof *XenBusDevicePath, + &mXenBusRootDevicePathTemplate); + if (!XenBusDevicePath) { + DEBUG ((EFI_D_ERROR, "%a: Out of memory\n", __FUNCTION__)); + Status = EFI_OUT_OF_RESOURCES; + goto FreeXenIo; + } + XenBusDevicePath->GrantTableAddress = GrantTableAddress; + + Status = gBS->InstallMultipleProtocolInterfaces (&OutHandle, + &gEfiDevicePathProtocolGuid, XenBusDevicePath, + &gXenIoProtocolGuid, XenIo, + NULL); + if (!EFI_ERROR (Status)) { + *Handle = OutHandle; + return EFI_SUCCESS; + } + + DEBUG ((EFI_D_ERROR, "%a: Failed to install the EFI_DEVICE_PATH and " + "XENIO_PROTOCOL protocols on handle %p (Status == %r)\n", + __FUNCTION__, OutHandle, Status)); + + FreePool (XenBusDevicePath); + +FreeXenIo: + FreePool (XenIo); + return Status; +} + +/** + + Uninstall the XENBUS_ROOT_DEVICE_PATH and XENIO_PROTOCOL protocols + + @param Handle Handle onto which the protocols have been installed + earlier by XenIoMmioInstall () + + @retval EFI_SUCCESS Protocols were uninstalled successfully + + @return Status code returned by the boot service + UninstallMultipleProtocolInterfaces () + +**/ +EFI_STATUS +XenIoMmioUninstall ( + IN EFI_HANDLE Handle + ) +{ + EFI_STATUS Status; + VOID *XenIo; + VOID *XenBusDevicePath; + + XenBusDevicePath = NULL; + gBS->OpenProtocol (Handle, &gEfiDevicePathProtocolGuid, &XenBusDevicePath, + NULL, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); + + XenIo = NULL; + gBS->OpenProtocol (Handle, &gXenIoProtocolGuid, &XenIo, + NULL, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); + + Status = gBS->UninstallMultipleProtocolInterfaces (Handle, + &gEfiDevicePathProtocolGuid, XenBusDevicePath, + &gXenIoProtocolGuid, XenIo, + NULL); + + if (EFI_ERROR (Status)) { + return Status; + } + + FreePool (XenBusDevicePath); + FreePool (XenIo); + + return EFI_SUCCESS; +} diff --git a/OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.inf b/OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.inf new file mode 100644 index 000000000000..16cc4530355e --- /dev/null +++ b/OvmfPkg/Library/XenIoMmioLib/XenIoMmioLib.inf @@ -0,0 +1,39 @@ +## @file +# Manage XenBus device path and I/O handles +# +# 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 = XenIoMmioLib + FILE_GUID = de9bdc19-8434-47bb-be3c-7f28f2101fd0 + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + LIBRARY_CLASS = XenIoMmioLib + +[Sources] + XenIoMmioLib.c + +[Packages] + MdePkg/MdePkg.dec + OvmfPkg/OvmfPkg.dec + +[LibraryClasses] + BaseMemoryLib + +[Guids] + gXenBusRootDeviceGuid + +[Protocols] + gEfiDevicePathProtocolGuid + gXenIoProtocolGuid diff --git a/OvmfPkg/OvmfPkg.dec b/OvmfPkg/OvmfPkg.dec index d61600225919..4cb70dc98e79 100644 --- a/OvmfPkg/OvmfPkg.dec +++ b/OvmfPkg/OvmfPkg.dec @@ -48,6 +48,10 @@ # XenHypercallLib|Include/Library/XenHypercallLib.h + ## @libraryclass Manage XenBus device path and I/O handles + # + XenIoMmioLib|Include/Library/XenIoMmioLib.h + [Guids] gUefiOvmfPkgTokenSpaceGuid = {0x93bb96af, 0xb9f2, 0x4eb8, {0x94, 0x62, 0xe0, 0xba, 0x74, 0x56, 0x42, 0x36}} gEfiXenInfoGuid = {0xd3b46f3b, 0xd441, 0x1244, {0x9a, 0x12, 0x0, 0x12, 0x27, 0x3f, 0xc1, 0x4d}}