From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-x22b.google.com (mail-wm0-x22b.google.com [IPv6:2a00:1450:400c:c09::22b]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 488C581CE2 for ; Tue, 1 Nov 2016 14:57:07 -0700 (PDT) Received: by mail-wm0-x22b.google.com with SMTP id a197so103948473wmd.0 for ; Tue, 01 Nov 2016 14:57:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=pS3ikaHEdMLG6C53bRVlwyW5a7OSSafudyTtGPDlgPc=; b=Xpd/oSzBMjIMLPlV9ZI2YqalaoOZy2t9yaN66zBcuo4rHn0q0BSp0I3j10csGOIgb0 RqEVs5IlcaEHCs5bUKbbqJHXHa9Xo/ugz3DPJienNKj/lz1yUaamZvLeHfvVuCX23eqr yhyGTMMmTxFBb2h24zQmwRqiIsue2rm2OocME= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=pS3ikaHEdMLG6C53bRVlwyW5a7OSSafudyTtGPDlgPc=; b=Plmao3PiZ6nOxL8RMaWs7IjnskRx+KARJQXuukTEjP80upbRf+wIeWC+qfp+eXWrQR u4DJC7jOiqxQwBQY0AQcEJQRrtzLiusdsiMjS2YvFKFPywkpkjjbSfyeZzNX7v9sjb/4 7Y0KKuBCNT5ypMGygDIaFSVJsCT1O8+AhD8FZieZQFa8JBUyyn6IVj27K+oZ+SEiJNXs or5iT8lidZX0/L4mvyx64bZ+pomcQp9AaOM5PD+7fRpvsJ/pouVfw0H9buVyCN2Oj3tW dsYYjhE2MCtSSb+r+zNK8b9E6nyCqs6n7+jrmaDnW3WKJpM5S5ixzvdAPkwy32jnE4+s bqhg== X-Gm-Message-State: ABUngvc0IwffkDpNs8VGUm2JV7qVuN6Kq7PmNvcRkRjopgCeY/1ftBsPNx2OVbRzWuia18VU X-Received: by 10.194.170.8 with SMTP id ai8mr256098wjc.118.1478037427186; Tue, 01 Nov 2016 14:57:07 -0700 (PDT) Received: from bivouac.eciton.net (bivouac.eciton.net. [2a00:1098:0:86:1000:23:0:2]) by smtp.gmail.com with ESMTPSA id 194sm32514468wmj.20.2016.11.01.14.57.06 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 01 Nov 2016 14:57:06 -0700 (PDT) Date: Tue, 1 Nov 2016 21:57:04 +0000 From: Leif Lindholm To: Ard Biesheuvel Cc: edk2-devel@lists.01.org Message-ID: <20161101215704.GN1161@bivouac.eciton.net> References: <1477937590-10361-1-git-send-email-ard.biesheuvel@linaro.org> <1477937590-10361-3-git-send-email-ard.biesheuvel@linaro.org> MIME-Version: 1.0 In-Reply-To: <1477937590-10361-3-git-send-email-ard.biesheuvel@linaro.org> User-Agent: Mutt/1.5.23 (2014-03-12) Subject: Re: [PATCH 2/5] EmbeddedPkg: introduce platform PCI I/O registration library X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 01 Nov 2016 21:57:07 -0000 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Mon, Oct 31, 2016 at 06:13:07PM +0000, Ard Biesheuvel wrote: > This introduces the PlatformPciIoDeviceRegistrationLib library class and > a default implementation to help platforms expose platform devices that > may be driven by a PCI driver. > > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Ard Biesheuvel > --- > EmbeddedPkg/EmbeddedPkg.dec | 1 + > EmbeddedPkg/EmbeddedPkg.dsc | 2 + > EmbeddedPkg/Include/Library/PlatformPciIoDeviceRegistrationLib.h | 46 ++++++++ > EmbeddedPkg/Library/PlatformPciIoDeviceRegistrationLib/PlatformPciIoDeviceRegistrationLib.c | 115 ++++++++++++++++++++ > EmbeddedPkg/Library/PlatformPciIoDeviceRegistrationLib/PlatformPciIoDeviceRegistrationLib.inf | 34 ++++++ > 5 files changed, 198 insertions(+) > > diff --git a/EmbeddedPkg/EmbeddedPkg.dec b/EmbeddedPkg/EmbeddedPkg.dec > index 84a6f4d01077..226036858880 100644 > --- a/EmbeddedPkg/EmbeddedPkg.dec > +++ b/EmbeddedPkg/EmbeddedPkg.dec > @@ -44,6 +44,7 @@ [LibraryClasses.common] > EblNetworkLib|Include/Library/EblNetworkLib.h > GdbSerialLib|Include/Library/GdbSerialLib.h > DebugAgentTimerLib|Include/Library/DebugAgentTimerLib.h > + PlatformPciIoDeviceRegistrationLib|Include/Library/PlatformPciIoDeviceRegistrationLib.h > > > [Guids.common] > diff --git a/EmbeddedPkg/EmbeddedPkg.dsc b/EmbeddedPkg/EmbeddedPkg.dsc > index eb7af800f0b2..d47c836379c9 100644 > --- a/EmbeddedPkg/EmbeddedPkg.dsc > +++ b/EmbeddedPkg/EmbeddedPkg.dsc > @@ -290,5 +290,7 @@ [Components.common] > EmbeddedPkg/Library/PrePiHobLib/PrePiHobLib.inf > EmbeddedPkg/Library/PrePiMemoryAllocationLib/PrePiMemoryAllocationLib.inf > > + EmbeddedPkg/Library/PlatformPciIoDeviceRegistrationLib/PlatformPciIoDeviceRegistrationLib.inf > + > [Components.IA32, Components.X64, Components.IPF, Components.ARM] > EmbeddedPkg/GdbStub/GdbStub.inf > diff --git a/EmbeddedPkg/Include/Library/PlatformPciIoDeviceRegistrationLib.h b/EmbeddedPkg/Include/Library/PlatformPciIoDeviceRegistrationLib.h > new file mode 100644 > index 000000000000..07f163abc701 > --- /dev/null > +++ b/EmbeddedPkg/Include/Library/PlatformPciIoDeviceRegistrationLib.h > @@ -0,0 +1,46 @@ > +/** @file > + Copyright (c) 2016, 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 __PLATFORM_PCI_IO_DEVICE_REGISTRATION_LIB_H__ > +#define __PLATFORM_PCI_IO_DEVICE_REGISTRATION_LIB_H__ > + > +#include > + > +/** > + Register a platform device for PCI I/O protocol emulation > + > + @param[in] BaseAddress The MMIO base address of the platform device > + @param[in] DeviceType The type of platform device > + @param[in] DmaType Whether the device is DMA coherent > + @param[in] InitFunc Initialization routine to be invoked when the > + device is enabled > + @param[in,out] Handle The handle onto which to install the platform > + PCI I/O protocol has been installed. > + If Handle is NULL or *Handle is NULL, a new > + handle will be allocated. > + > + @retval EFI_SUCCESS The registration succeeded. > + @retval other The registration failed. > + > +**/ > +EFI_STATUS > +EFIAPI > +PlatformPciIoRegisterDevice ( > + IN EFI_PHYSICAL_ADDRESS BaseAddress, > + IN PLATFORM_PCI_IO_DEVICE_TYPE DeviceType, > + IN PLATFORM_PCI_IO_DMA_TYPE DmaType, > + IN PLATFORM_PCI_IO_INIT InitFunc, > + IN OUT EFI_HANDLE *Handle OPTIONAL > + ); > + > +#endif > diff --git a/EmbeddedPkg/Library/PlatformPciIoDeviceRegistrationLib/PlatformPciIoDeviceRegistrationLib.c b/EmbeddedPkg/Library/PlatformPciIoDeviceRegistrationLib/PlatformPciIoDeviceRegistrationLib.c > new file mode 100644 > index 000000000000..1ce5abb137df > --- /dev/null > +++ b/EmbeddedPkg/Library/PlatformPciIoDeviceRegistrationLib/PlatformPciIoDeviceRegistrationLib.c > @@ -0,0 +1,115 @@ > +/** @file > + Copyright (c) 2016, 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 > + > +#pragma pack (1) > +typedef struct { > + VENDOR_DEVICE_PATH Vendor; > + UINT64 BaseAddress; > + EFI_DEVICE_PATH_PROTOCOL End; > +} PLATFORM_PCI_IO_DEVICE_PATH; > + > +#pragma pack () > + > +/** > + Register a platform device for PCI I/O protocol emulation > + > + @param[in] BaseAddress The MMIO base address of the platform device > + @param[in] DeviceType The type of platform device > + @param[in] DmaType Whether the device is DMA coherent > + @param[in] InitFunc Initialization routine to be invoked when the > + device is enabled > + @param[in,out] Handle The handle onto which to install the platform > + PCI I/O protocol has been installed. > + If Handle is NULL or *Handle is NULL, a new > + handle will be allocated. > + > + @retval EFI_SUCCESS The registration succeeded. > + @retval other The registration failed. > + > +**/ > +EFI_STATUS > +EFIAPI > +PlatformPciIoRegisterDevice ( > + IN EFI_PHYSICAL_ADDRESS BaseAddress, > + IN PLATFORM_PCI_IO_DEVICE_TYPE DeviceType, > + IN PLATFORM_PCI_IO_DMA_TYPE DmaType, > + IN PLATFORM_PCI_IO_INIT InitFunc, > + IN OUT EFI_HANDLE *Handle > + ) > +{ > + PLATFORM_PCI_IO *Device; > + PLATFORM_PCI_IO_DEVICE_PATH *DevicePath; > + EFI_HANDLE LocalHandle; > + EFI_STATUS Status; > + > + if (DeviceType >= PlatformPciIoDeviceMax || DmaType >= PlatformPciIoDmaMax) { > + return EFI_INVALID_PARAMETER; > + } > + > + if (Handle == NULL) { > + Handle = &LocalHandle; > + LocalHandle = NULL; > + } > + > + Device = (PLATFORM_PCI_IO *)AllocateZeroPool (sizeof *Device); > + if (Device == NULL) { > + return EFI_OUT_OF_RESOURCES; > + } > + > + Device->BaseAddress = BaseAddress; > + Device->DeviceType = DeviceType; > + Device->DmaType = DmaType; > + Device->Initialize = InitFunc; > + > + DevicePath = (PLATFORM_PCI_IO_DEVICE_PATH *)CreateDeviceNode ( > + HARDWARE_DEVICE_PATH, > + HW_VENDOR_DP, > + sizeof (*DevicePath)); > + if (DevicePath == NULL) { > + Status = EFI_OUT_OF_RESOURCES; > + goto FreeDevice; > + } > + > + CopyGuid (&DevicePath->Vendor.Guid, &gPlatformPciIoProtocolGuid); > + DevicePath->BaseAddress = BaseAddress; > + > + SetDevicePathNodeLength (&DevicePath->Vendor, > + sizeof (*DevicePath) - sizeof (DevicePath->End)); > + SetDevicePathEndNode (&DevicePath->End); > + > + Status = gBS->InstallMultipleProtocolInterfaces (Handle, > + &gPlatformPciIoProtocolGuid, Device, > + &gEfiDevicePathProtocolGuid, DevicePath); > + if (EFI_ERROR (Status)) { > + goto FreeDevicePath; > + } > + return EFI_SUCCESS; > + > +FreeDevicePath: > + FreePool (DevicePath); > + > +FreeDevice: > + FreePool (Device); > + > + return Status; > +} > diff --git a/EmbeddedPkg/Library/PlatformPciIoDeviceRegistrationLib/PlatformPciIoDeviceRegistrationLib.inf b/EmbeddedPkg/Library/PlatformPciIoDeviceRegistrationLib/PlatformPciIoDeviceRegistrationLib.inf > new file mode 100644 > index 000000000000..282db3ab59ab > --- /dev/null > +++ b/EmbeddedPkg/Library/PlatformPciIoDeviceRegistrationLib/PlatformPciIoDeviceRegistrationLib.inf > @@ -0,0 +1,34 @@ > +# @file > +# Copyright (c) 2016, 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 = 0x00010017 Not 0019? > + BASE_NAME = PlatformPciIoDeviceRegistrationLib > + FILE_GUID = 8802ae41-8184-49cb-8aec-62627cd7ceb4 > + MODULE_TYPE = DXE_DRIVER > + VERSION_STRING = 1.0 > + LIBRARY_CLASS = PlatformPciIoDeviceRegistrationLib > + > +[Sources] > + PlatformPciIoDeviceRegistrationLib.c > + > +[Packages] > + MdePkg/MdePkg.dec > + EmbeddedPkg/EmbeddedPkg.dec > + > +[LibraryClasses] > + DebugLib > + DevicePathLib > + UefiBootServicesTableLib > + > +[Protocols] > + gPlatformPciIoProtocolGuid > -- > 2.7.4 >