MdePkg/Include/Protocol/PciIo.h

   1 /** @file
   2   EFI PCI I/O Protocol
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __PCI_IO_H__
  16 #define __PCI_IO_H__
  17
  18 //
  19 // Global ID for the PCI I/O Protocol
  20 //
  21 #define EFI_PCI_IO_PROTOCOL_GUID \
  22   { \
  23     0x4cf5b200, 0x68b8, 0x4ca5, {0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a } \
  24   }
  25
  26 typedef struct _EFI_PCI_IO_PROTOCOL  EFI_PCI_IO_PROTOCOL;
  27
  28 //
  29 // Prototypes for the PCI I/O Protocol
  30 //
  31 typedef enum {
  32   EfiPciIoWidthUint8      = 0,
  33   EfiPciIoWidthUint16,
  34   EfiPciIoWidthUint32,
  35   EfiPciIoWidthUint64,
  36   EfiPciIoWidthFifoUint8,
  37   EfiPciIoWidthFifoUint16,
  38   EfiPciIoWidthFifoUint32,
  39   EfiPciIoWidthFifoUint64,
  40   EfiPciIoWidthFillUint8,
  41   EfiPciIoWidthFillUint16,
  42   EfiPciIoWidthFillUint32,
  43   EfiPciIoWidthFillUint64,
  44   EfiPciIoWidthMaximum
  45 } EFI_PCI_IO_PROTOCOL_WIDTH;
  46
  47 //
  48 // Complete PCI address generater
  49 //
  50 #define EFI_PCI_IO_PASS_THROUGH_BAR               0xff    // Special BAR that passes a memory or I/O cycle through unchanged
  51 #define EFI_PCI_IO_ATTRIBUTE_MASK                 0x077f  // All the following I/O and Memory cycles
  52 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO   0x0001  // I/O cycles 0x0000-0x00FF (10 bit decode)
  53 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO               0x0002  // I/O cycles 0x0100-0x03FF or greater (10 bit decode)
  54 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO       0x0004  // I/O cycles 0x3C6, 0x3C8, 0x3C9 (10 bit decode)
  55 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY           0x0008  // MEM cycles 0xA0000-0xBFFFF (24 bit decode)
  56 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO               0x0010  // I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (10 bit decode)
  57 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO       0x0020  // I/O cycles 0x1F0-0x1F7, 0x3F6, 0x3F7 (10 bit decode)
  58 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO     0x0040  // I/O cycles 0x170-0x177, 0x376, 0x377 (10 bit decode)
  59 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080  // Map a memory range so write are combined
  60 #define EFI_PCI_IO_ATTRIBUTE_IO                   0x0100  // Enable the I/O decode bit in the PCI Config Header
  61 #define EFI_PCI_IO_ATTRIBUTE_MEMORY               0x0200  // Enable the Memory decode bit in the PCI Config Header
  62 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER           0x0400  // Enable the DMA bit in the PCI Config Header
  63 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED        0x0800  // Map a memory range so all r/w accesses are cached
  64 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE       0x1000  // Disable a memory range
  65 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE      0x2000  // Clear for an add-in PCI Device
  66 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM         0x4000  // Clear for a physical PCI Option ROM accessed through ROM BAR
  67 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE   0x8000  // Clear for PCI controllers that can not genrate a DAC
  68 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16            0x10000 // I/O cycles 0x0100-0x03FF or greater (16 bit decode)
  69 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16    0x20000 // I/O cycles 0x3C6, 0x3C8, 0x3C9 (16 bit decode)
  70 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16            0x30000 // I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (16 bit decode)
  71
  72 #define EFI_PCI_DEVICE_ENABLE                     (EFI_PCI_IO_ATTRIBUTE_IO | EFI_PCI_IO_ATTRIBUTE_MEMORY | EFI_PCI_IO_ATTRIBUTE_BUS_MASTER)
  73 #define EFI_VGA_DEVICE_ENABLE                     (EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO | EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY | EFI_PCI_IO_ATTRIBUTE_VGA_IO | EFI_PCI_IO_ATTRIBUTE_IO)
  74
  75 //
  76 // *******************************************************
  77 // EFI_PCI_IO_PROTOCOL_OPERATION
  78 // *******************************************************
  79 //
  80 typedef enum {
  81   EfiPciIoOperationBusMasterRead,
  82   EfiPciIoOperationBusMasterWrite,
  83   EfiPciIoOperationBusMasterCommonBuffer,
  84   EfiPciIoOperationMaximum
  85 } EFI_PCI_IO_PROTOCOL_OPERATION;
  86
  87 //
  88 // *******************************************************
  89 // EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION
  90 // *******************************************************
  91 //
  92 typedef enum {
  93   EfiPciIoAttributeOperationGet,
  94   EfiPciIoAttributeOperationSet,
  95   EfiPciIoAttributeOperationEnable,
  96   EfiPciIoAttributeOperationDisable,
  97   EfiPciIoAttributeOperationSupported,
  98   EfiPciIoAttributeOperationMaximum
  99 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
 100
 101 /**
 102   Reads from the memory space of a PCI controller. Returns when either the polling exit criteria is
 103   satisfied or after a defined duration.
 104
 105   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 106   @param  Width                 Signifies the width of the memory or I/O operations.
 107   @param  BarIndex              The BAR index of the standard PCI Configuration header to use as the
 108                                 base address for the memory operation to perform.
 109   @param  Offset                The offset within the selected BAR to start the memory operation.
 110   @param  Mask                  Mask used for the polling criteria.
 111   @param  Value                 The comparison value used for the polling exit criteria.
 112   @param  Delay                 The number of 100 ns units to poll.
 113   @param  Result                Pointer to the last value read from the memory location.
 114
 115   @retval EFI_SUCCESS           The last data returned from the access matched the poll exit criteria.
 116   @retval EFI_UNSUPPORTED       BarIndex not valid for this PCI controller.
 117   @retval EFI_UNSUPPORTED       Offset is not valid for the BarIndex of this PCI controller.
 118   @retval EFI_TIMEOUT           Delay expired before a match occurred.
 119   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.
 120   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 121
 122 **/
 123 typedef
 124 EFI_STATUS
 125 (EFIAPI *EFI_PCI_IO_PROTOCOL_POLL_IO_MEM) (
 126   IN EFI_PCI_IO_PROTOCOL           *This,
 127   IN  EFI_PCI_IO_PROTOCOL_WIDTH    Width,
 128   IN  UINT8                        BarIndex,
 129   IN  UINT64                       Offset,
 130   IN  UINT64                       Mask,
 131   IN  UINT64                       Value,
 132   IN  UINT64                       Delay,
 133   OUT UINT64                       *Result
 134   );
 135
 136 /**
 137   Enable a PCI driver to access PCI controller registers in the PCI memory or I/O space.
 138
 139   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 140   @param  Width                 Signifies the width of the memory or I/O operations.
 141   @param  BarIndex              The BAR index of the standard PCI Configuration header to use as the
 142                                 base address for the memory or I/O operation to perform.
 143   @param  Offset                The offset within the selected BAR to start the memory or I/O operation.
 144   @param  Count                 The number of memory or I/O operations to perform.
 145   @param  Buffer                For read operations, the destination buffer to store the results. For write
 146                                 operations, the source buffer to write data from.
 147
 148   @retval EFI_SUCCESS           The data was read from or written to the PCI controller.
 149   @retval EFI_UNSUPPORTED       BarIndex not valid for this PCI controller.
 150   @retval EFI_UNSUPPORTED       The address range specified by Offset, Width, and Count is not
 151                                 valid for the PCI BAR specified by BarIndex.
 152   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.
 153   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 154
 155 **/
 156 typedef
 157 EFI_STATUS
 158 (EFIAPI *EFI_PCI_IO_PROTOCOL_IO_MEM) (
 159   IN EFI_PCI_IO_PROTOCOL              *This,
 160   IN     EFI_PCI_IO_PROTOCOL_WIDTH    Width,
 161   IN     UINT8                        BarIndex,
 162   IN     UINT64                       Offset,
 163   IN     UINTN                        Count,
 164   IN OUT VOID                         *Buffer
 165   );
 166
 167 typedef struct {
 168   EFI_PCI_IO_PROTOCOL_IO_MEM  Read;
 169   EFI_PCI_IO_PROTOCOL_IO_MEM  Write;
 170 } EFI_PCI_IO_PROTOCOL_ACCESS;
 171
 172 /**
 173   Enable a PCI driver to access PCI controller registers in PCI configuration space.
 174
 175   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 176   @param  Width                 Signifies the width of the memory operations.
 177   @param  Offset                The offset within the PCI configuration space for the PCI controller.
 178   @param  Count                 The number of PCI configuration operations to perform.
 179   @param  Buffer                For read operations, the destination buffer to store the results. For write
 180                                 operations, the source buffer to write data from.
 181
 182
 183   @retval EFI_SUCCESS           The data was read from or written to the PCI controller.
 184   @retval EFI_UNSUPPORTED       The address range specified by Offset, Width, and Count is not
 185                                 valid for the PCI configuration header of the PCI controller.
 186   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.
 187   @retval EFI_INVALID_PARAMETER Buffer is NULL or Width is invalid.
 188
 189 **/
 190 typedef
 191 EFI_STATUS
 192 (EFIAPI *EFI_PCI_IO_PROTOCOL_CONFIG) (
 193   IN EFI_PCI_IO_PROTOCOL              *This,
 194   IN     EFI_PCI_IO_PROTOCOL_WIDTH    Width,
 195   IN     UINT32                       Offset,
 196   IN     UINTN                        Count,
 197   IN OUT VOID                         *Buffer
 198   );
 199
 200 typedef struct {
 201   EFI_PCI_IO_PROTOCOL_CONFIG  Read;
 202   EFI_PCI_IO_PROTOCOL_CONFIG  Write;
 203 } EFI_PCI_IO_PROTOCOL_CONFIG_ACCESS;
 204
 205 /**
 206   Enables a PCI driver to copy one region of PCI memory space to another region of PCI
 207   memory space.
 208
 209   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 210   @param  Width                 Signifies the width of the memory operations.
 211   @param  DestBarIndex          The BAR index in the standard PCI Configuration header to use as the
 212                                 base address for the memory operation to perform.
 213   @param  DestOffset            The destination offset within the BAR specified by DestBarIndex to
 214                                 start the memory writes for the copy operation.
 215   @param  SrcBarIndex           The BAR index in the standard PCI Configuration header to use as the
 216                                 base address for the memory operation to perform.
 217   @param  SrcOffset             The source offset within the BAR specified by SrcBarIndex to start
 218                                 the memory reads for the copy operation.
 219   @param  Count                 The number of memory operations to perform. Bytes moved is Width
 220                                 size * Count, starting at DestOffset and SrcOffset.
 221
 222   @retval EFI_SUCCESS           The data was copied from one memory region to another memory region.
 223   @retval EFI_UNSUPPORTED       DestBarIndex not valid for this PCI controller.
 224   @retval EFI_UNSUPPORTED       SrcBarIndex not valid for this PCI controller.
 225   @retval EFI_UNSUPPORTED       The address range specified by DestOffset, Width, and Count
 226                                 is not valid for the PCI BAR specified by DestBarIndex.
 227   @retval EFI_UNSUPPORTED       The address range specified by SrcOffset, Width, and Count is
 228                                 not valid for the PCI BAR specified by SrcBarIndex.
 229   @retval EFI_INVALID_PARAMETER Width is invalid.
 230   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.
 231
 232 **/
 233 typedef
 234 EFI_STATUS
 235 (EFIAPI *EFI_PCI_IO_PROTOCOL_COPY_MEM) (
 236   IN EFI_PCI_IO_PROTOCOL              *This,
 237   IN     EFI_PCI_IO_PROTOCOL_WIDTH    Width,
 238   IN     UINT8                        DestBarIndex,
 239   IN     UINT64                       DestOffset,
 240   IN     UINT8                        SrcBarIndex,
 241   IN     UINT64                       SrcOffset,
 242   IN     UINTN                        Count
 243   );
 244
 245 /**
 246   Provides the PCI controller-Cspecific addresses needed to access system memory.
 247
 248   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 249   @param  Operation             Indicates if the bus master is going to read or write to system memory.
 250   @param  HostAddress           The system memory address to map to the PCI controller.
 251   @param  NumberOfBytes         On input the number of bytes to map. On output the number of bytes
 252                                 that were mapped.
 253   @param  DeviceAddress         The resulting map address for the bus master PCI controller to use to
 254                                 access the hosts HostAddress.
 255   @param  Mapping               A resulting value to pass to Unmap().
 256
 257   @retval EFI_SUCCESS           The range was mapped for the returned NumberOfBytes.
 258   @retval EFI_UNSUPPORTED       The HostAddress cannot be mapped as a common buffer.
 259   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 260   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.
 261   @retval EFI_DEVICE_ERROR      The system hardware could not map the requested address.
 262
 263 **/
 264 typedef
 265 EFI_STATUS
 266 (EFIAPI *EFI_PCI_IO_PROTOCOL_MAP) (
 267   IN EFI_PCI_IO_PROTOCOL                *This,
 268   IN     EFI_PCI_IO_PROTOCOL_OPERATION  Operation,
 269   IN     VOID                           *HostAddress,
 270   IN OUT UINTN                          *NumberOfBytes,
 271   OUT    EFI_PHYSICAL_ADDRESS           *DeviceAddress,
 272   OUT    VOID                           **Mapping
 273   );
 274
 275 /**
 276   Completes the Map() operation and releases any corresponding resources.
 277
 278   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 279   @param  Mapping               The mapping value returned from Map().
 280
 281   @retval EFI_SUCCESS           The range was unmapped.
 282   @retval EFI_DEVICE_ERROR      The data was not committed to the target system memory.
 283
 284 **/
 285 typedef
 286 EFI_STATUS
 287 (EFIAPI *EFI_PCI_IO_PROTOCOL_UNMAP) (
 288   IN EFI_PCI_IO_PROTOCOL           *This,
 289   IN  VOID                         *Mapping
 290   );
 291
 292 /**
 293   Allocates pages that are suitable for an EfiPciIoOperationBusMasterCommonBuffer
 294   mapping.
 295
 296   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 297   @param  Type                  This parameter is not used and must be ignored.
 298   @param  MemoryType            The type of memory to allocate, EfiBootServicesData or
 299                                 EfiRuntimeServicesData.
 300   @param  Pages                 The number of pages to allocate.
 301   @param  HostAddress           A pointer to store the base system memory address of the
 302                                 allocated range.
 303   @param  Attributes            The requested bit mask of attributes for the allocated range.
 304
 305   @retval EFI_SUCCESS           The requested memory pages were allocated.
 306   @retval EFI_UNSUPPORTED       Attributes is unsupported. The only legal attribute bits are
 307                                 MEMORY_WRITE_COMBINE and MEMORY_CACHED.
 308   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 309   @retval EFI_OUT_OF_RESOURCES  The memory pages could not be allocated.
 310
 311 **/
 312 typedef
 313 EFI_STATUS
 314 (EFIAPI *EFI_PCI_IO_PROTOCOL_ALLOCATE_BUFFER) (
 315   IN EFI_PCI_IO_PROTOCOL           *This,
 316   IN  EFI_ALLOCATE_TYPE            Type,
 317   IN  EFI_MEMORY_TYPE              MemoryType,
 318   IN  UINTN                        Pages,
 319   OUT VOID                         **HostAddress,
 320   IN  UINT64                       Attributes
 321   );
 322
 323 /**
 324   Frees memory that was allocated with AllocateBuffer().
 325
 326   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 327   @param  Pages                 The number of pages to free.
 328   @param  HostAddress           The base system memory address of the allocated range.
 329
 330   @retval EFI_SUCCESS           The requested memory pages were freed.
 331   @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages
 332                                 was not allocated with AllocateBuffer().
 333
 334 **/
 335 typedef
 336 EFI_STATUS
 337 (EFIAPI *EFI_PCI_IO_PROTOCOL_FREE_BUFFER) (
 338   IN EFI_PCI_IO_PROTOCOL           *This,
 339   IN  UINTN                        Pages,
 340   IN  VOID                         *HostAddress
 341   );
 342
 343 /**
 344   Flushes all PCI posted write transactions from a PCI host bridge to system memory.
 345
 346   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 347
 348   @retval EFI_SUCCESS           The PCI posted write transactions were flushed from the PCI host
 349                                 bridge to system memory.
 350   @retval EFI_DEVICE_ERROR      The PCI posted write transactions were not flushed from the PCI
 351                                 host bridge due to a hardware error.
 352
 353 **/
 354 typedef
 355 EFI_STATUS
 356 (EFIAPI *EFI_PCI_IO_PROTOCOL_FLUSH) (
 357   IN EFI_PCI_IO_PROTOCOL  *This
 358   );
 359
 360 /**
 361   Retrieves this PCI controller's current PCI bus number, device number, and function number.
 362
 363   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 364   @param  SegmentNumber         The PCI controller's current PCI segment number.
 365   @param  BusNumber             The PCI controller's current PCI bus number.
 366   @param  DeviceNumber          The PCI controller's current PCI device number.
 367   @param  FunctionNumber        The PCI controller's current PCI function number.
 368
 369   @retval EFI_SUCCESS           The PCI controller location was returned.
 370   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 371
 372 **/
 373 typedef
 374 EFI_STATUS
 375 (EFIAPI *EFI_PCI_IO_PROTOCOL_GET_LOCATION) (
 376   IN EFI_PCI_IO_PROTOCOL          *This,
 377   OUT UINTN                       *SegmentNumber,
 378   OUT UINTN                       *BusNumber,
 379   OUT UINTN                       *DeviceNumber,
 380   OUT UINTN                       *FunctionNumber
 381   );
 382
 383 /**
 384   Performs an operation on the attributes that this PCI controller supports. The operations include
 385   getting the set of supported attributes, retrieving the current attributes, setting the current
 386   attributes, enabling attributes, and disabling attributes.
 387
 388   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 389   @param  Operation             The operation to perform on the attributes for this PCI controller.
 390   @param  Attributes            The mask of attributes that are used for Set, Enable, and Disable
 391                                 operations.
 392   @param  Result                A pointer to the result mask of attributes that are returned for the Get
 393                                 and Supported operations.
 394
 395   @retval EFI_SUCCESS           The operation on the PCI controller's attributes was completed.
 396   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 397   @retval EFI_UNSUPPORTED       one or more of the bits set in
 398                                 Attributes are not supported by this PCI controller or one of
 399                                 its parent bridges when Operation is Set, Enable or Disable.
 400
 401 **/
 402 typedef
 403 EFI_STATUS
 404 (EFIAPI *EFI_PCI_IO_PROTOCOL_ATTRIBUTES) (
 405   IN EFI_PCI_IO_PROTOCOL                       *This,
 406   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation,
 407   IN  UINT64                                   Attributes,
 408   OUT UINT64                                   *Result OPTIONAL
 409   );
 410
 411 /**
 412   Gets the attributes that this PCI controller supports setting on a BAR using
 413   SetBarAttributes(), and retrieves the list of resource descriptors for a BAR.
 414
 415   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 416   @param  BarIndex              The BAR index of the standard PCI Configuration header to use as the
 417                                 base address for resource range. The legal range for this field is 0..5.
 418   @param  Supports              A pointer to the mask of attributes that this PCI controller supports
 419                                 setting for this BAR with SetBarAttributes().
 420   @param  Resources             A pointer to the ACPI 2.0 resource descriptors that describe the current
 421                                 configuration of this BAR of the PCI controller.
 422
 423   @retval EFI_SUCCESS           If Supports is not NULL, then the attributes that the PCI
 424                                 controller supports are returned in Supports. If Resources
 425                                 is not NULL, then the ACPI 2.0 resource descriptors that the PCI
 426                                 controller is currently using are returned in Resources.
 427   @retval EFI_INVALID_PARAMETER Both Supports and Attributes are NULL.
 428   @retval EFI_UNSUPPORTED       BarIndex not valid for this PCI controller.
 429   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to allocate
 430                                 Resources.
 431
 432 **/
 433 typedef
 434 EFI_STATUS
 435 (EFIAPI *EFI_PCI_IO_PROTOCOL_GET_BAR_ATTRIBUTES) (
 436   IN EFI_PCI_IO_PROTOCOL             *This,
 437   IN  UINT8                          BarIndex,
 438   OUT UINT64                         *Supports, OPTIONAL
 439   OUT VOID                           **Resources OPTIONAL
 440   );
 441
 442 /**
 443   Sets the attributes for a range of a BAR on a PCI controller.
 444
 445   @param  This                  A pointer to the EFI_PCI_IO_PROTOCOL instance.
 446   @param  Attributes            The mask of attributes to set for the resource range specified by
 447                                 BarIndex, Offset, and Length.
 448   @param  BarIndex              The BAR index of the standard PCI Configuration header to use as the
 449                                 base address for resource range. The legal range for this field is 0..5.
 450   @param  Offset                A pointer to the BAR relative base address of the resource range to be
 451                                 modified by the attributes specified by Attributes.
 452   @param  Length                A pointer to the length of the resource range to be modified by the
 453                                 attributes specified by Attributes.
 454
 455   @retval EFI_SUCCESS           The set of attributes specified by Attributes for the resource
 456                                 range specified by BarIndex, Offset, and Length were
 457                                 set on the PCI controller, and the actual resource range is returned
 458                                 in Offset and Length.
 459   @retval EFI_INVALID_PARAMETER Offset or Length is NULL.
 460   @retval EFI_UNSUPPORTED       BarIndex not valid for this PCI controller.
 461   @retval EFI_OUT_OF_RESOURCES  There are not enough resources to set the attributes on the
 462                                 resource range specified by BarIndex, Offset, and
 463                                 Length.
 464
 465 **/
 466 typedef
 467 EFI_STATUS
 468 (EFIAPI *EFI_PCI_IO_PROTOCOL_SET_BAR_ATTRIBUTES) (
 469   IN EFI_PCI_IO_PROTOCOL              *This,
 470   IN     UINT64                       Attributes,
 471   IN     UINT8                        BarIndex,
 472   IN OUT UINT64                       *Offset,
 473   IN OUT UINT64                       *Length
 474   );
 475
 476 //
 477 // Interface structure for the PCI I/O Protocol
 478 //
 479 struct _EFI_PCI_IO_PROTOCOL {
 480   EFI_PCI_IO_PROTOCOL_POLL_IO_MEM         PollMem;
 481   EFI_PCI_IO_PROTOCOL_POLL_IO_MEM         PollIo;
 482   EFI_PCI_IO_PROTOCOL_ACCESS              Mem;
 483   EFI_PCI_IO_PROTOCOL_ACCESS              Io;
 484   EFI_PCI_IO_PROTOCOL_CONFIG_ACCESS       Pci;
 485   EFI_PCI_IO_PROTOCOL_COPY_MEM            CopyMem;
 486   EFI_PCI_IO_PROTOCOL_MAP                 Map;
 487   EFI_PCI_IO_PROTOCOL_UNMAP               Unmap;
 488   EFI_PCI_IO_PROTOCOL_ALLOCATE_BUFFER     AllocateBuffer;
 489   EFI_PCI_IO_PROTOCOL_FREE_BUFFER         FreeBuffer;
 490   EFI_PCI_IO_PROTOCOL_FLUSH               Flush;
 491   EFI_PCI_IO_PROTOCOL_GET_LOCATION        GetLocation;
 492   EFI_PCI_IO_PROTOCOL_ATTRIBUTES          Attributes;
 493   EFI_PCI_IO_PROTOCOL_GET_BAR_ATTRIBUTES  GetBarAttributes;
 494   EFI_PCI_IO_PROTOCOL_SET_BAR_ATTRIBUTES  SetBarAttributes;
 495   UINT64                                  RomSize;
 496   VOID                                    *RomImage;
 497 };
 498
 499 extern EFI_GUID gEfiPciIoProtocolGuid;
 500
 501 #endif