X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FPciPlatform.h;h=080952dc5711edaa538598e18ae491af3d1520be;hb=2997220ab70e1d40717c3de269e0a35f4b3600bb;hp=d1044b6209bc55094734efb5827c7b2e38aa0f3a;hpb=8411f1c002faf9a16c28a643a1c8a32de904a7d7;p=mirror_edk2.git diff --git a/IntelFrameworkPkg/Include/Protocol/PciPlatform.h b/IntelFrameworkPkg/Include/Protocol/PciPlatform.h index d1044b6209..080952dc57 100644 --- a/IntelFrameworkPkg/Include/Protocol/PciPlatform.h +++ b/IntelFrameworkPkg/Include/Protocol/PciPlatform.h @@ -4,7 +4,7 @@ driver to describe the unique features of a platform. This protocol is optional. - Copyright (c) 2007, Intel Corporation + Copyright (c) 2007 - 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 @@ -36,22 +36,45 @@ typedef struct _EFI_PCI_PLATFORM_PROTOCOL EFI_PCI_PLATFORM_PROTOCOL; typedef UINT32 EFI_PCI_PLATFORM_POLICY; - +// +// There are 4 legal combinations of following bit values: +// EFI_RESERVE_NONE_IO_ALIAS, +// EFI_RESERVE_ISA_IO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS, +// EFI_RESERVE_ISA_IO_NO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS, +// EFI_RESERVE_ISA_IO_NO_ALIAS | EFI_RESERVE_VGA_IO_NO_ALIAS +// #define EFI_RESERVE_NONE_IO_ALIAS 0x0000 #define EFI_RESERVE_ISA_IO_ALIAS 0x0001 #define EFI_RESERVE_ISA_IO_NO_ALIAS 0x0002 #define EFI_RESERVE_VGA_IO_ALIAS 0x0004 #define EFI_RESERVE_VGA_IO_NO_ALIAS 0x0008 - +/// +/// EFI_PCI_CHIPSET_EXECUTION_PHASE is used to call a platform protocol and execute +/// platform-specific code. +/// typedef enum { + /// + /// The phase that indicates the entry point to the PCI Bus Notify phase. This + /// platform hook is called before the PCI bus driver calls the + /// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL driver. + /// ChipsetEntry, + /// + /// The phase that indicates the exit point to the Chipset Notify phase before + /// returning to the PCI Bus Driver Notify phase. This platform hook is called after + /// the PCI bus driver calls the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL + /// driver. + /// ChipsetExit, MaximumChipsetPhase } EFI_PCI_CHIPSET_EXECUTION_PHASE; /** + The notification from the PCI bus enumerator to the platform that it is + about to enter a certain phase during the enumeration process. + The PlatformNotify() function can be used to notify the platform driver so that it can perform platform-specific actions. No specific actions are required. Eight notification points are defined at this time. More synchronization points @@ -74,16 +97,18 @@ typedef enum { **/ typedef EFI_STATUS -(EFIAPI *EFI_PCI_PLATFORM_PHASE_NOTIFY) ( - IN EFI_PCI_PLATFORM_PROTOCOL *This, +(EFIAPI *EFI_PCI_PLATFORM_PHASE_NOTIFY)( + IN EFI_PCI_PLATFORM_PROTOCOL *This, IN EFI_HANDLE HostBridge, IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase, IN EFI_PCI_CHIPSET_EXECUTION_PHASE ChipsetPhase -) -; +); /** + The notification from the PCI bus enumerator to the platform for each PCI + controller at several predefined points during PCI controller initialization. + The PlatformPrepController() function can be used to notify the platform driver so that it can perform platform-specific actions. No specific actions are required. Several notification points are defined at this time. More synchronization points may be @@ -108,18 +133,19 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER) ( +(EFIAPI *EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER)( IN EFI_PCI_PLATFORM_PROTOCOL *This, IN EFI_HANDLE HostBridge, IN EFI_HANDLE RootBridge, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress, IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase, IN EFI_PCI_CHIPSET_EXECUTION_PHASE ChipsetPhase -) -; +); /** + Retrieves the platform policy regarding enumeration. + The GetPlatformPolicy() function retrieves the platform policy regarding PCI enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol driver can call this member function to retrieve the policy. @@ -133,14 +159,15 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *EFI_PCI_PLATFORM_GET_PLATFORM_POLICY) ( +(EFIAPI *EFI_PCI_PLATFORM_GET_PLATFORM_POLICY)( IN EFI_PCI_PLATFORM_PROTOCOL *This, OUT EFI_PCI_PLATFORM_POLICY *PciPolicy -) -; +); /** + Gets the PCI device's option ROM from a platform-specific location. + The GetPciRom() function gets the PCI device's option ROM from a platform-specific location. The option ROM will be loaded into memory. This member function is used to return an image that is packaged as a PCI 2.2 option ROM. The image may contain both legacy and EFI option @@ -169,39 +196,36 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *EFI_PCI_PLATFORM_GET_PCI_ROM) ( +(EFIAPI *EFI_PCI_PLATFORM_GET_PCI_ROM)( IN EFI_PCI_PLATFORM_PROTOCOL *This, IN EFI_HANDLE PciHandle, OUT VOID **RomImage, OUT UINTN *RomSize -) -; - -/** - @par Protocol Description: - This protocol provides the interface between the PCI bus driver/PCI Host - Bridge Resource Allocation driver and a platform-specific driver to describe - the unique features of a platform. - - @param PlatformNotify - The notification from the PCI bus enumerator to the platform that it is - about to enter a certain phase during the enumeration process. - - @param PlatformPrepController - The notification from the PCI bus enumerator to the platform for each PCI - controller at several predefined points during PCI controller initialization. - - @param GetPlatformPolicy - Retrieves the platform policy regarding enumeration. +); - @param GetPciRom - Gets the PCI device's option ROM from a platform-specific location. - -**/ +/// +/// This protocol provides the interface between the PCI bus driver/PCI Host +/// Bridge Resource Allocation driver and a platform-specific driver to describe +/// the unique features of a platform. +/// struct _EFI_PCI_PLATFORM_PROTOCOL { - EFI_PCI_PLATFORM_PHASE_NOTIFY PhaseNotify; + /// + /// The notification from the PCI bus enumerator to the platform that it is about to + /// enter a certain phase during the enumeration process. + /// + EFI_PCI_PLATFORM_PHASE_NOTIFY PlatformNotify; + /// + /// The notification from the PCI bus enumerator to the platform for each PCI + /// controller at several predefined points during PCI controller initialization. + /// EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER PlatformPrepController; + /// + /// Retrieves the platform policy regarding enumeration. + /// EFI_PCI_PLATFORM_GET_PLATFORM_POLICY GetPlatformPolicy; + /// + /// Gets the PCI device’s option ROM from a platform-specific location. + /// EFI_PCI_PLATFORM_GET_PCI_ROM GetPciRom; };