IntelFrameworkPkg/Include/Protocol/PciPlatform.h

   1 /** @file
   2   This file declares PlatfromOpRom protocols which provides the interface between
   3   the PCI bus driver/PCI Host Bridge Resource Allocation driver and a platform-specific
   4   driver to describe the unique features of a platform. This
   5   protocol is optional.
   6
   7   Copyright (c) 2007, Intel Corporation
   8   All rights reserved. This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16   @par Revision Reference:
  17   This protocol is defined in PCI Platform Support Specification
  18   Version 0.9
  19
  20 **/
  21
  22 #ifndef _PCI_PLATFORM_H_
  23 #define _PCI_PLATFORM_H_
  24
  25 #include <PiDxe.h>
  26 #include <Protocol/PciHostBridgeResourceAllocation.h>
  27
  28 //
  29 // Protocol for GUID.
  30 //
  31
  32 #define EFI_PCI_PLATFORM_PROTOCOL_GUID \
  33 { 0x7d75280, 0x27d4, 0x4d69, {0x90, 0xd0, 0x56, 0x43, 0xe2, 0x38, 0xb3, 0x41} }
  34
  35 typedef struct _EFI_PCI_PLATFORM_PROTOCOL EFI_PCI_PLATFORM_PROTOCOL;
  36
  37 typedef    UINT32   EFI_PCI_PLATFORM_POLICY;
  38
  39
  40 #define     EFI_RESERVE_NONE_IO_ALIAS        0x0000
  41 #define     EFI_RESERVE_ISA_IO_ALIAS         0x0001
  42 #define     EFI_RESERVE_ISA_IO_NO_ALIAS      0x0002
  43 #define     EFI_RESERVE_VGA_IO_ALIAS         0x0004
  44 #define     EFI_RESERVE_VGA_IO_NO_ALIAS      0x0008
  45
  46
  47 typedef enum {
  48   ChipsetEntry,
  49   ChipsetExit,
  50   MaximumChipsetPhase
  51 } EFI_PCI_CHIPSET_EXECUTION_PHASE;
  52
  53
  54 /**
  55   The PlatformNotify() function can be used to notify the platform driver so that
  56   it can perform platform-specific actions. No specific actions are required.
  57   Eight notification points are defined at this time. More synchronization points
  58   may be added as required in the future. The PCI bus driver calls the platform driver
  59   twice for every Phase-once before the PCI Host Bridge Resource Allocation Protocol
  60   driver is notified, and once after the PCI Host Bridge Resource Allocation Protocol
  61   driver has been notified.
  62   This member function may not perform any error checking on the input parameters. It
  63   also does not return any error codes. If this member function detects any error condition,
  64   it needs to handle those errors on its own because there is no way to surface any
  65   errors to the caller.
  66
  67   @param  This                  Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
  68   @param  HostBridge            The handle of the host bridge controller.
  69   @param  Phase                 The phase of the PCI bus enumeration.
  70   @param  ChipsetPhase          Defines the execution phase of the PCI chipset driver.
  71
  72   @retval EFI_SUCCESS           The function completed successfully.
  73
  74 **/
  75 typedef
  76 EFI_STATUS
  77 (EFIAPI *EFI_PCI_PLATFORM_PHASE_NOTIFY)(
  78   IN EFI_PCI_PLATFORM_PROTOCOL                       *This,
  79   IN  EFI_HANDLE                                     HostBridge,
  80   IN  EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE  Phase,
  81   IN  EFI_PCI_CHIPSET_EXECUTION_PHASE                ChipsetPhase
  82 );
  83
  84
  85 /**
  86   The PlatformPrepController() function can be used to notify the platform driver so that
  87   it can perform platform-specific actions. No specific actions are required.
  88   Several notification points are defined at this time. More synchronization points may be
  89   added as required in the future. The PCI bus driver calls the platform driver twice for
  90   every PCI controller-once before the PCI Host Bridge Resource Allocation Protocol driver
  91   is notified, and once after the PCI Host Bridge Resource Allocation Protocol driver has
  92   been notified.
  93   This member function may not perform any error checking on the input parameters. It also
  94   does not return any error codes. If this member function detects any error condition, it
  95   needs to handle those errors on its own because there is no way to surface any errors to
  96   the caller.
  97
  98   @param  This                  Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
  99   @param  HostBridge            The associated PCI host bridge handle.
 100   @param  RootBridge            The associated PCI root bridge handle.
 101   @param  PciAddress            The address of the PCI device on the PCI bus.
 102   @param  Phase                 The phase of the PCI controller enumeration.
 103   @param  ChipsetPhase          Defines the execution phase of the PCI chipset driver.
 104
 105   @retval EFI_SUCCESS           The function completed successfully.
 106
 107 **/
 108 typedef
 109 EFI_STATUS
 110 (EFIAPI *EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER)(
 111   IN  EFI_PCI_PLATFORM_PROTOCOL                      *This,
 112   IN  EFI_HANDLE                                     HostBridge,
 113   IN  EFI_HANDLE                                     RootBridge,
 114   IN  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS    PciAddress,
 115   IN  EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE   Phase,
 116   IN  EFI_PCI_CHIPSET_EXECUTION_PHASE                ChipsetPhase
 117 );
 118
 119
 120 /**
 121   The GetPlatformPolicy() function retrieves the platform policy regarding PCI
 122   enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol
 123   driver can call this member function to retrieve the policy.
 124
 125   @param  This                  Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
 126   @param  PciPolicy             The platform policy with respect to VGA and ISA aliasing.
 127
 128   @retval EFI_SUCCESS           The function completed successfully.
 129   @retval EFI_INVALID_PARAMETER PciPolicy is NULL.
 130
 131 **/
 132 typedef
 133 EFI_STATUS
 134 (EFIAPI *EFI_PCI_PLATFORM_GET_PLATFORM_POLICY)(
 135   IN  EFI_PCI_PLATFORM_PROTOCOL           *This,
 136   OUT EFI_PCI_PLATFORM_POLICY             *PciPolicy
 137 );
 138
 139
 140 /**
 141   The GetPciRom() function gets the PCI device's option ROM from a platform-specific location.
 142   The option ROM will be loaded into memory. This member function is used to return an image
 143   that is packaged as a PCI 2.2 option ROM. The image may contain both legacy and EFI option
 144   ROMs. See the UEFI 2.0 Specification for details. This member function can be used to return
 145   option ROM images for embedded controllers. Option ROMs for embedded controllers are typically
 146   stored in platform-specific storage, and this member function can retrieve it from that storage
 147   and return it to the PCI bus driver. The PCI bus driver will call this member function before
 148   scanning the ROM that is attached to any controller, which allows a platform to specify a ROM
 149   image that is different from the ROM image on a PCI card.
 150
 151   @param  This                  Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
 152   @param  PciHandle             The handle of the PCI device.
 153   @param  RomImage              If the call succeeds, the pointer to the pointer to the option ROM image.
 154                                 Otherwise, this field is undefined. The memory for RomImage is allocated
 155                                 by EFI_PCI_PLATFORM_PROTOCOL.GetPciRom() using the EFI Boot Service AllocatePool().
 156                                 It is the caller's responsibility to free the memory using the EFI Boot Service
 157                                 FreePool(), when the caller is done with the option ROM.
 158   @param  RomSize               If the call succeeds, a pointer to the size of the option ROM size. Otherwise,
 159                                 this field is undefined.
 160
 161   @retval EFI_SUCCESS           The option ROM was available for this device and loaded into memory.
 162   @retval EFI_NOT_FOUND         No option ROM was available for this device.
 163   @retval EFI_OUT_OF_RESOURCES  No memory was available to load the option ROM.
 164   @retval EFI_DEVICE_ERROR      An error occurred in getting the option ROM.
 165
 166 **/
 167 typedef
 168 EFI_STATUS
 169 (EFIAPI *EFI_PCI_PLATFORM_GET_PCI_ROM)(
 170   IN   EFI_PCI_PLATFORM_PROTOCOL    *This,
 171   IN   EFI_HANDLE                   PciHandle,
 172   OUT  VOID                         **RomImage,
 173   OUT  UINTN                        *RomSize
 174 );
 175
 176 /**
 177   @par Protocol Description:
 178   This protocol provides the interface between the PCI bus driver/PCI Host
 179   Bridge Resource Allocation driver and a platform-specific driver to describe
 180   the unique features of a platform.
 181
 182   @param PlatformNotify
 183   The notification from the PCI bus enumerator to the platform that it is
 184   about to enter a certain phase during the enumeration process.
 185
 186   @param PlatformPrepController
 187   The notification from the PCI bus enumerator to the platform for each PCI
 188   controller at several predefined points during PCI controller initialization.
 189
 190   @param GetPlatformPolicy
 191   Retrieves the platform policy regarding enumeration.
 192
 193   @param GetPciRom
 194   Gets the PCI device's option ROM from a platform-specific location.
 195
 196 **/
 197 struct _EFI_PCI_PLATFORM_PROTOCOL {
 198   EFI_PCI_PLATFORM_PHASE_NOTIFY          PhaseNotify;
 199   EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER PlatformPrepController;
 200   EFI_PCI_PLATFORM_GET_PLATFORM_POLICY   GetPlatformPolicy;
 201   EFI_PCI_PLATFORM_GET_PCI_ROM           GetPciRom;
 202 };
 203
 204 extern EFI_GUID   gEfiPciPlatformProtocolGuid;
 205
 206 #endif