diff options
Diffstat (limited to 'IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h')
| -rw-r--r-- | IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h | 102 |
1 files changed, 55 insertions, 47 deletions
diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h index 60b7adcb85..2190aa369d 100644 --- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h +++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h @@ -1,50 +1,54 @@ /** @file
+ PCI Rom supporting funtions declaration for PCI Bus module.
-Copyright (c) 2006 - 2009, 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
-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.
+Copyright (c) 2006 - 2009, 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
+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 _EFI_PCI_OP_ROM_SUPPORT_H_
-#define _EFI_PCI_OP_ROM_SUPPORT_H_
+#ifndef _EFI_PCI_OPTION_ROM_SUPPORT_H_
+#define _EFI_PCI_OPTION_ROM_SUPPORT_H_
-#include <Protocol/LoadFile2.h>
/**
Initialize a PCI LoadFile2 instance.
-
+
@param PciIoDevice PCI IO Device.
**/
VOID
InitializePciLoadFile2 (
- PCI_IO_DEVICE *PciIoDevice
+ IN PCI_IO_DEVICE *PciIoDevice
);
/**
Causes the driver to load a specified file.
-
+
@param This Indicates a pointer to the calling context.
@param FilePath The device specific path of the file to load.
@param BootPolicy Should always be FALSE.
- @param BufferSize On input the size of Buffer in bytes. On output with a return
- code of EFI_SUCCESS, the amount of data transferred to Buffer.
- On output with a return code of EFI_BUFFER_TOO_SMALL,
- the size of Buffer required to retrieve the requested file.
- @param Buffer The memory buffer to transfer the file to. If Buffer is NULL,
+ @param BufferSize On input the size of Buffer in bytes. On output with a return
+ code of EFI_SUCCESS, the amount of data transferred to Buffer.
+ On output with a return code of EFI_BUFFER_TOO_SMALL,
+ the size of Buffer required to retrieve the requested file.
+ @param Buffer The memory buffer to transfer the file to. If Buffer is NULL,
then no the size of the requested file is returned in BufferSize.
- @retval EFI_SUCCESS The file was loaded.
+ @retval EFI_SUCCESS The file was loaded.
@retval EFI_UNSUPPORTED BootPolicy is TRUE.
+ @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or
+ BufferSize is NULL.
+ @retval EFI_NOT_FOUND Not found PCI Option Rom on PCI device.
+ @retval EFI_DEVICE_ERROR Failed to decompress PCI Option Rom image.
@retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to read the current directory entry.
BufferSize has been updated with the size needed to complete the request.
-
+
**/
EFI_STATUS
EFIAPI
@@ -57,30 +61,30 @@ LoadFile2 ( );
/**
-
Check if the RomImage contains EFI Images.
- @param RomImage The ROM address of Image for check.
+ @param RomImage The ROM address of Image for check.
@param RomSize Size of ROM for check.
@retval TRUE ROM contain EFI Image.
@retval FALSE ROM not contain EFI Image.
-
+
**/
BOOLEAN
ContainEfiImage (
IN VOID *RomImage,
IN UINT64 RomSize
- );
+ );
/**
Get Pci device's oprom infor bits.
-
- @param PciIoDevice Pci device instance
- @retval EFI_NOT_FOUND Pci device has not oprom
- @retval EFI_SUCCESS Pci device has oprom
+ @param PciIoDevice Pci device instance.
+
+ @retval EFI_NOT_FOUND Pci device has not Option Rom.
+ @retval EFI_SUCCESS Pci device has Option Rom.
+
**/
EFI_STATUS
GetOpRomInfo (
@@ -88,13 +92,14 @@ GetOpRomInfo ( );
/**
- Load option rom image for specified PCI device
-
- @param PciDevice Pci device instance
- @param RomBase Base address of oprom.
-
- @retval EFI_OUT_OF_RESOURCES not enough memory to hold image
- @retval EFI_SUCESS Success
+ Load Option Rom image for specified PCI device.
+
+ @param PciDevice Pci device instance.
+ @param RomBase Base address of Option Rom.
+
+ @retval EFI_OUT_OF_RESOURCES No enough memory to hold image.
+ @retval EFI_SUCESS Successfully loaded Option Rom.
+
**/
EFI_STATUS
LoadOpRomImage (
@@ -103,17 +108,16 @@ LoadOpRomImage ( );
/**
- enable/disable oprom decode
-
- @param PciDevice pci device instance
+ Enable/Disable Option Rom decode.
+
+ @param PciDevice Pci device instance.
@param RomBarIndex The BAR index of the standard PCI Configuration header to use as the
base address for resource range. The legal range for this field is 0..5.
- @param RomBar Base address of rom
+ @param RomBar Base address of Option Rom.
@param Enable Flag for enable/disable decode.
-
- @retval EFI_SUCCESS Success
+
**/
-EFI_STATUS
+VOID
RomDecode (
IN PCI_IO_DEVICE *PciDevice,
IN UINT8 RomBarIndex,
@@ -122,13 +126,17 @@ RomDecode ( );
/**
- Process the oprom image.
-
- @param PciDevice Pci device instance
+ Load and start the Option Rom image.
+
+ @param PciDevice Pci device instance.
+
+ @retval EFI_SUCCESS Successfully loaded and started PCI Option Rom image.
+ @retval EFI_NOT_FOUND Failed to process PCI Option Rom image.
+
**/
EFI_STATUS
ProcessOpRomImage (
- PCI_IO_DEVICE *PciDevice
+ IN PCI_IO_DEVICE *PciDevice
);
#endif
|