Add support for PCI Root Bridge I/O protocol.

PCI Root Bridge I/O protocol is used by PCI Bus Driver to perform
PCI Memory, PCI I/O, and PCI Configuration cycles on a
PCI Root Bridge. It also provides services to perform different
types of bus mastering DMA.

V2 - Scratch that - there already exists an efipciio.h with most
of these definitions. Let me remove this patch and propose a new
one that will amend what's already there.
OK, here's a better version that adds the required definition in
efipciio.h. Note that EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL and
EFI_PCI_IO_PROTOCOL are two different protocols.

V3 - Pete, There are now two defines of EFI_PCI_ADDRESS.
Please repost with your define removed.
Nigel, Sorry about that. Here's v3.

Signed-off-by: Pete Batard <pete@akeo.ie>
Signed-off-by: Nigel Croxon <nigel.croxon@hpe.com>

2 files changed, 201 insertions, 28 deletions

diff --git a/inc/efilib.h b/inc/efilib.h
index 5812ec4..9cecf1d 100644
--- a/inc/efilib.h
+++ b/inc/efilib.h
@@ -96,6 +96,7 @@ extern EFI_GUID gEFiUiInterfaceProtocolGuid;
 extern EFI_GUID InternalShellProtocol;
 extern EFI_GUID gEfiPciIoProtocolGuid;
 #define PciIoProtocol gEfiPciIoProtocolGuid
+extern EFI_GUID gEfiPciRootBridgeIoProtocolGuid;
 extern EFI_GUID gEfiDriverBindingProtocolGuid;
 #define DriverBindingProtocol gEfiDriverBindingProtocolGuid
 extern EFI_GUID gEfiComponentNameProtocolGuid;
diff --git a/inc/efipciio.h b/inc/efipciio.h
index 6366ffd..e885387 100644
--- a/inc/efipciio.h
+++ b/inc/efipciio.h
@@ -4,7 +4,11 @@
 #define EFI_PCI_IO_PROTOCOL_GUID \
     { 0x4cf5b200, 0x68b8, 0x4ca5, {0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a} }
 
+#define EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID \
+    { 0x2f707ebb, 0x4a1a, 0x11d4, {0x9a, 0x38, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
+
 INTERFACE_DECL(_EFI_PCI_IO_PROTOCOL);
+INTERFACE_DECL(_EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL);
 
 typedef enum {
     EfiPciIoWidthUint8,
@@ -20,7 +24,7 @@ typedef enum {
     EfiPciIoWidthFillUint32,
     EfiPciIoWidthFillUint64,
     EfiPciIoWidthMaximum
-} EFI_PCI_IO_PROTOCOL_WIDTH;
+} EFI_PCI_IO_PROTOCOL_WIDTH, EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH;
 
 #define EFI_PCI_IO_PASS_THROUGH_BAR 0xff
 
@@ -35,7 +39,19 @@ EFI_STATUS
   IN UINT64                       Value,
   IN UINT64                       Delay,
   OUT UINT64                      *Result
-  );
+);
+
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *This,
+  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH    Width,
+  IN UINT64                                   Address,
+  IN UINT64                                   Mask,
+  IN UINT64                                   Value,
+  IN UINT64                                   Delay,
+  OUT UINT64                                  *Result
+);
 
 typedef
 EFI_STATUS
@@ -48,11 +64,26 @@ EFI_STATUS
   IN OUT VOID                     *Buffer
 );
 
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *This,
+  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH    Width,
+  IN UINT64                                   Address,
+  IN UINTN                                    Count,
+  IN OUT VOID                                 *Buffer
+);
+
 typedef struct {
   EFI_PCI_IO_PROTOCOL_IO_MEM    Read;
   EFI_PCI_IO_PROTOCOL_IO_MEM    Write;
 } EFI_PCI_IO_PROTOCOL_ACCESS;
 
+typedef struct {
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM  Read;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM  Write;
+} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS;
+
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PCI_IO_PROTOCOL_CONFIG) (
@@ -63,6 +94,13 @@ EFI_STATUS
   IN OUT VOID                     *Buffer
 );
 
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *This,
+  OUT VOID                                      **Resources
+);
+
 typedef struct {
   EFI_PCI_IO_PROTOCOL_CONFIG Read;
   EFI_PCI_IO_PROTOCOL_CONFIG Write;
@@ -78,7 +116,17 @@ EFI_STATUS
   IN UINT8                        SrcBarIndex,
   IN UINT64                       SrcOffset,
   IN UINTN                        Count
-  );
+);
+
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_COPY_MEM) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *This,
+  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH    Width,
+  IN UINT64                                   DestAddress,
+  IN UINT64                                   SrcAddress,
+  IN UINTN                                    Count
+);
 
 typedef enum {
     EfiPciIoOperationBusMasterRead,
@@ -87,6 +135,16 @@ typedef enum {
     EfiPciIoOperationMaximum
 } EFI_PCI_IO_PROTOCOL_OPERATION;
 
+typedef enum {
+  EfiPciOperationBusMasterRead,
+  EfiPciOperationBusMasterWrite,
+  EfiPciOperationBusMasterCommonBuffer,
+  EfiPciOperationBusMasterRead64,
+  EfiPciOperationBusMasterWrite64,
+  EfiPciOperationBusMasterCommonBuffer64,
+  EfiPciOperationMaximum
+} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION;
+
 typedef
 EFI_STATUS
 (EFIAPI *EFI_PCI_IO_PROTOCOL_MAP) (
@@ -96,7 +154,18 @@ EFI_STATUS
   IN OUT UINTN                     *NumberOfBytes,
   OUT EFI_PHYSICAL_ADDRESS         *DeviceAddress,
   OUT VOID                         **Mapping
-  );
+);
+
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_MAP) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *This,
+  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION  Operation,
+  IN VOID                                       *HostAddress,
+  IN OUT UINTN                                  *NumberOfBytes,
+  OUT EFI_PHYSICAL_ADDRESS                      *DeviceAddress,
+  OUT VOID                                      **Mapping
+);
 
 typedef
 EFI_STATUS
@@ -107,6 +176,13 @@ EFI_STATUS
 
 typedef
 EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_UNMAP) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *This,
+  IN VOID                                       *Mapping
+);
+
+typedef
+EFI_STATUS
 (EFIAPI *EFI_PCI_IO_PROTOCOL_ALLOCATE_BUFFER) (
   IN struct _EFI_PCI_IO_PROTOCOL  *This,
   IN EFI_ALLOCATE_TYPE            Type,
@@ -114,7 +190,18 @@ EFI_STATUS
   IN UINTN                        Pages,
   OUT VOID                        **HostAddress,
   IN UINT64                       Attributes
-  );
+);
+
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ALLOCATE_BUFFER) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *This,
+  IN EFI_ALLOCATE_TYPE                          Type,
+  IN EFI_MEMORY_TYPE                            MemoryType,
+  IN UINTN                                      Pages,
+  IN OUT VOID                                   **HostAddress,
+  IN UINT64                                     Attributes
+);
 
 typedef
 EFI_STATUS
@@ -126,9 +213,23 @@ EFI_STATUS
 
 typedef
 EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FREE_BUFFER) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *This,
+  IN UINTN                                      Pages,
+  IN VOID                                       *HostAddress
+);
+
+typedef
+EFI_STATUS
 (EFIAPI *EFI_PCI_IO_PROTOCOL_FLUSH) (
   IN struct _EFI_PCI_IO_PROTOCOL  *This
-  );
+);
+
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FLUSH) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *This
+);
 
 typedef
 EFI_STATUS
@@ -138,26 +239,61 @@ EFI_STATUS
   OUT UINTN                       *BusNumber,
   OUT UINTN                       *DeviceNumber,
   OUT UINTN                       *FunctionNumber
-  );
+);
+
+#define EFI_PCI_ATTRIBUTE_ISA_MOTHERBOARD_IO      0x0001
+#define EFI_PCI_ATTRIBUTE_ISA_IO                  0x0002
+#define EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO          0x0004
+#define EFI_PCI_ATTRIBUTE_VGA_MEMORY              0x0008
+#define EFI_PCI_ATTRIBUTE_VGA_IO                  0x0010
+#define EFI_PCI_ATTRIBUTE_IDE_PRIMARY_IO          0x0020
+#define EFI_PCI_ATTRIBUTE_IDE_SECONDARY_IO        0x0040
+#define EFI_PCI_ATTRIBUTE_MEMORY_WRITE_COMBINE    0x0080
+#define EFI_PCI_ATTRIBUTE_IO                      0x0100
+#define EFI_PCI_ATTRIBUTE_MEMORY                  0x0200
+#define EFI_PCI_ATTRIBUTE_BUS_MASTER              0x0400
+#define EFI_PCI_ATTRIBUTE_MEMORY_CACHED           0x0800
+#define EFI_PCI_ATTRIBUTE_MEMORY_DISABLE          0x1000
+#define EFI_PCI_ATTRIBUTE_EMBEDDED_DEVICE         0x2000
+#define EFI_PCI_ATTRIBUTE_EMBEDDED_ROM            0x4000
+#define EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE      0x8000
+#define EFI_PCI_ATTRIBUTE_ISA_IO_16               0x10000
+#define EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO_16       0x20000
+#define EFI_PCI_ATTRIBUTE_VGA_IO_16               0x40000
+
+#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO   EFI_PCI_ATTRIBUTE_ISA_MOTHERBOARD_IO
+#define EFI_PCI_IO_ATTRIBUTE_ISA_IO               EFI_PCI_ATTRIBUTE_ISA_IO
+#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO       EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO
+#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY           EFI_PCI_ATTRIBUTE_VGA_MEMORY
+#define EFI_PCI_IO_ATTRIBUTE_VGA_IO               EFI_PCI_ATTRIBUTE_VGA_IO
+#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO       EFI_PCI_ATTRIBUTE_IDE_PRIMARY_IO
+#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO     EFI_PCI_ATTRIBUTE_IDE_SECONDARY_IO
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE EFI_PCI_ATTRIBUTE_MEMORY_WRITE_COMBINE
+#define EFI_PCI_IO_ATTRIBUTE_IO                   EFI_PCI_ATTRIBUTE_IO
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY               EFI_PCI_ATTRIBUTE_MEMORY
+#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER           EFI_PCI_ATTRIBUTE_BUS_MASTER
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED        EFI_PCI_ATTRIBUTE_MEMORY_CACHED
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE       EFI_PCI_ATTRIBUTE_MEMORY_DISABLE
+#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE      EFI_PCI_ATTRIBUTE_EMBEDDED_DEVICE
+#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM         EFI_PCI_ATTRIBUTE_EMBEDDED_ROM
+#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE   EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE
+#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16            EFI_PCI_ATTRIBUTE_ISA_IO_16
+#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16    EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO_16
+#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16            EFI_PCI_ATTRIBUTE_VGA_IO_16
 
-#define EFI_PCI_IO_ATTRIBUTE_ISA_IO               0x0002
-#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO       0x0004
-#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY           0x0008
-#define EFI_PCI_IO_ATTRIBUTE_VGA_IO               0x0010
-#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO       0x0020
-#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO     0x0040
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
-#define EFI_PCI_IO_ATTRIBUTE_IO                   0x0100
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY               0x0200
-#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER           0x0400
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED        0x0800
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE       0x1000
-#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE      0x2000
-#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM         0x4000
-#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE   0x8000
-#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16            0x10000
-#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16    0x20000
-#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16            0x40000
+#define EFI_PCI_ATTRIBUTE_VALID_FOR_ALLOCATE_BUFFER \
+    (EFI_PCI_ATTRIBUTE_MEMORY_WRITE_COMBINE | EFI_PCI_ATTRIBUTE_MEMORY_CACHED | EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE)
+
+#define EFI_PCI_ATTRIBUTE_INVALID_FOR_ALLOCATE_BUFFER \
+    (~EFI_PCI_ATTRIBUTE_VALID_FOR_ALLOCATE_BUFFER)
+
+typedef struct {
+    UINT8 Register;
+    UINT8 Function;
+    UINT8 Device;
+    UINT8 Bus;
+    UINT32 ExtendedRegister;
+} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS;
 
 typedef enum {
     EfiPciIoAttributeOperationGet,
@@ -175,7 +311,7 @@ EFI_STATUS
   IN EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION Operation,
   IN UINT64                                  Attributes,
   OUT UINT64                                 *Result OPTIONAL
-  );
+);
 
 typedef
 EFI_STATUS
@@ -184,7 +320,15 @@ EFI_STATUS
   IN UINT8                        BarIndex,
   OUT UINT64                      *Supports   OPTIONAL,
   OUT VOID                        **Resources OPTIONAL
-  );
+);
+
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *This,
+  OUT UINT64                                    *Supports,
+  OUT UINT64                                    *Attributes
+);
 
 typedef
 EFI_STATUS
@@ -194,7 +338,16 @@ EFI_STATUS
   IN UINT8                        BarIndex,
   IN OUT UINT64                   *Offset,
   IN OUT UINT64                   *Length
-  );
+);
+
+typedef
+EFI_STATUS
+(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES) (
+  IN struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *This,
+  IN UINT64                                     Attributes,
+  IN OUT UINT64                                 *ResourceBase,
+  IN OUT UINT64                                 *ResourceLength
+);
 
 typedef struct _EFI_PCI_IO_PROTOCOL {
   EFI_PCI_IO_PROTOCOL_POLL_IO_MEM        PollMem;
@@ -224,4 +377,23 @@ typedef struct _EFI_PCI_IO_PROTOCOL {
 typedef struct _EFI_PCI_IO_PROTOCOL _EFI_PCI_IO;
 typedef EFI_PCI_IO_PROTOCOL EFI_PCI_IO;
 
+typedef struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL {
+  EFI_HANDLE                                      ParentHandle;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM     PollMem;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM     PollIo;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS          Mem;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS          Io;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ACCESS          Pci;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_COPY_MEM        CopyMem;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_MAP             Map;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_UNMAP           Unmap;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ALLOCATE_BUFFER AllocateBuffer;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FREE_BUFFER     FreeBuffer;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FLUSH           Flush;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES  GetAttributes;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES  SetAttributes;
+  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION   Configuration;
+  UINT32                                          SegmentNumber;
+} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL;
+
 #endif /* _EFI_PCI_IO_H */