MdePkg/Include/Ppi/PciCfg.h

   1 /** @file
   2   This file declares PciCfg PPI used to access PCI configuration space in PEI
   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   Module Name:  PciCfg.h
  14
  15   @par Revision Reference:
  16   This PPI is defined in PEI CIS
  17   Version 0.91.
  18
  19 **/
  20
  21 #ifndef __PEI_PCI_CFG_H__
  22 #define __PEI_PCI_CFG_H__
  23
  24 #define EFI_PEI_PCI_CFG_PPI_INSTALLED_GUID \
  25   { \
  26     0xe1f2eba0, 0xf7b9, 0x4a26, {0x86, 0x20, 0x13, 0x12, 0x21, 0x64, 0x2a, 0x90 } \
  27   }
  28
  29 typedef struct _EFI_PEI_PCI_CFG_PPI   EFI_PEI_PCI_CFG_PPI;
  30
  31 #define PEI_PCI_CFG_ADDRESS(bus, dev, func, reg)  ( \
  32       (UINT64) ((((UINTN) bus) << 24) + (((UINTN) dev) << 16) + (((UINTN) func) << 8) + ((UINTN) reg)) \
  33     ) & 0x00000000ffffffff
  34
  35 typedef enum {
  36   EfiPeiPciCfgWidthUint8   = 0,
  37   EfiPeiPciCfgWidthUint16  = 1,
  38   EfiPeiPciCfgWidthUint32  = 2,
  39   EfiPeiPciCfgWidthUint64  = 3,
  40   EfiPeiPciCfgWidthMaximum
  41 } EFI_PEI_PCI_CFG_PPI_WIDTH;
  42
  43 typedef struct {
  44   UINT8 Register;
  45   UINT8 Function;
  46   UINT8 Device;
  47   UINT8 Bus;
  48   UINT8 Reserved[4];
  49 } EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS;
  50
  51 /**
  52   PCI read and write operation.
  53
  54   @param  PeiServices An indirect pointer to the PEI Services Table
  55   published by the PEI Foundation.
  56
  57   @param  This Pointer to local data for the interface.
  58
  59   @param  Width The width of the access. Enumerated in bytes.
  60
  61   @param  Address The physical address of the access.
  62
  63   @param  Buffer A pointer to the buffer of data.
  64
  65   @retval EFI_SUCCESS The function completed successfully.
  66
  67   @retval EFI_NOT_YET_AVAILABLE The service has not been installed.
  68
  69 **/
  70 typedef
  71 EFI_STATUS
  72 (EFIAPI *EFI_PEI_PCI_CFG_PPI_IO) (
  73   IN EFI_PEI_SERVICES             **PeiServices,
  74   IN EFI_PEI_PCI_CFG_PPI          *This,
  75   IN EFI_PEI_PCI_CFG_PPI_WIDTH    Width,
  76   IN UINT64                       Address,
  77   IN OUT VOID                     *Buffer
  78   );
  79
  80 /**
  81   PCI read-modify-write operation.
  82
  83   @param  PeiServices An indirect pointer to the PEI Services Table
  84   published by the PEI Foundation.
  85
  86   @param  This Pointer to local data for the interface.
  87
  88   @param  Width The width of the access. Enumerated in bytes.
  89
  90   @param  Address The physical address of the access.
  91
  92   @param  SetBits Value of the bits to set.
  93
  94   @param  ClearBits Value of the bits to clear.
  95
  96   @retval EFI_SUCCESS  The function completed successfully.
  97
  98 **/
  99 typedef
 100 EFI_STATUS
 101 (EFIAPI *EFI_PEI_PCI_CFG_PPI_RW) (
 102   IN EFI_PEI_SERVICES             **PeiServices,
 103   IN EFI_PEI_PCI_CFG_PPI          *This,
 104   IN EFI_PEI_PCI_CFG_PPI_WIDTH    Width,
 105   IN UINT64                       Address,
 106   IN UINTN                        SetBits,
 107   IN UINTN                        ClearBits
 108   );
 109
 110 /**
 111   @par Ppi Description:
 112   The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI
 113   controllers behind a PCI root bridge controller.
 114
 115   @param Read
 116   PCI read services.  See the Read() function description.
 117
 118   @param Write
 119   PCI write services.  See the Write() function description.
 120
 121   @param Modify
 122 PCI read-modify-write services.  See the Modify() function description.
 123
 124 **/
 125 struct _EFI_PEI_PCI_CFG_PPI {
 126   EFI_PEI_PCI_CFG_PPI_IO  Read;
 127   EFI_PEI_PCI_CFG_PPI_IO  Write;
 128   EFI_PEI_PCI_CFG_PPI_RW  Modify;
 129 };
 130
 131 extern EFI_GUID gEfiPciCfgPpiInServiceTableGuid;
 132
 133 #endif