X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FBus%2FPci%2FPciBusDxe%2FPciHotPlugSupport.h;h=e8f7f678931c204f999e3f71704689a3e81f819f;hp=a285d94c93ca4827b8e519469e3e2f01a59958e2;hb=fcdfcdbfc2e5dc6a96ce550a1f46edb4007f35a9;hpb=1f6785c4b77d04bca9ce6205c63bd76264ec7789 diff --git a/MdeModulePkg/Bus/Pci/PciBusDxe/PciHotPlugSupport.h b/MdeModulePkg/Bus/Pci/PciBusDxe/PciHotPlugSupport.h index a285d94c93..e8f7f67893 100644 --- a/MdeModulePkg/Bus/Pci/PciBusDxe/PciHotPlugSupport.h +++ b/MdeModulePkg/Bus/Pci/PciBusDxe/PciHotPlugSupport.h @@ -1,7 +1,7 @@ /** @file PCI Hot Plug support functions declaration for PCI Bus module. -Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2019, Intel Corporation. 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 @@ -31,7 +31,7 @@ typedef struct { } ROOT_HPC_DATA; // -// Reference of some global variabes +// Reference of some global variables // extern EFI_PCI_HOT_PLUG_INIT_PROTOCOL *gPciHotPlugInit; extern EFI_HPC_LOCATION *gPciRootHpcPool; @@ -52,7 +52,7 @@ PciHPCInitialized ( ); /** - Compare two device pathes to check if they are exactly same. + Compare two device paths to check if they are exactly same. @param DevicePath1 A pointer to the first device path data structure. @param DevicePath2 A pointer to the second device path data structure. @@ -75,7 +75,7 @@ EfiCompareDevicePath ( private data structure. @retval EFI_SUCCESS They are same. - @retval EFI_UNSUPPORTED No PCI Hot Plug controler on the platform. + @retval EFI_UNSUPPORTED No PCI Hot Plug controller on the platform. @retval EFI_OUT_OF_RESOURCES No memory to constructor root hot plug private data structure. @@ -104,7 +104,7 @@ IsPciHotPlugBus ( @param HpbDevicePath A pointer to device path data structure to be tested. @param HpIndex If HpIndex is not NULL, return the index of root hot - plug in global array when TRUE is retuned. + plug in global array when TRUE is returned. @retval TRUE The device path is for root pci hot plug bus. @retval FALSE The device path is not for root pci hot plug bus. @@ -121,7 +121,7 @@ IsRootPciHotPlugBus ( @param HpcDevicePath A pointer to device path data structure to be tested. @param HpIndex If HpIndex is not NULL, return the index of root hot - plug in global array when TRUE is retuned. + plug in global array when TRUE is returned. @retval TRUE The device path is for root pci hot plug controller. @retval FALSE The device path is not for root pci hot plug controller. @@ -137,9 +137,9 @@ IsRootPciHotPlugController ( Creating event object for PCI Hot Plug controller. @param HpIndex Index of hot plug device in global array. - @param Event The retuned event that invoke this function. + @param Event The returned event that invoke this function. - @return Status of create event invoken. + @return Status of create event. **/ EFI_STATUS @@ -188,7 +188,7 @@ IsSHPC ( @param[in] PciIoDevice The device being checked. - @retval TRUE PciIoDevice is a PCIe port that accepts a hotplugged device. + @retval TRUE PciIoDevice is a PCIe port that accepts a hot-plugged device. @retval FALSE Otherwise. **/