mirror of https://github.com/acidanthera/audk.git
221 lines
8.2 KiB
C
221 lines
8.2 KiB
C
/*++
|
|
|
|
Copyright (c) 2004 - 2006, 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
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
Module Name:
|
|
|
|
PciRootBridgeIo.h
|
|
|
|
Abstract:
|
|
|
|
PCI Root Bridge I/O protocol as defined in the EFI 1.1 specification.
|
|
|
|
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
|
|
defferent types of bus mastering DMA
|
|
|
|
--*/
|
|
|
|
#ifndef _PCI_ROOT_BRIDGE_IO_H_
|
|
#define _PCI_ROOT_BRIDGE_IO_H_
|
|
|
|
#define EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID \
|
|
{ \
|
|
0x2f707ebb, 0x4a1a, 0x11d4, {0x9a, 0x38, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} \
|
|
}
|
|
|
|
EFI_FORWARD_DECLARATION (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL);
|
|
|
|
typedef enum {
|
|
EfiPciWidthUint8,
|
|
EfiPciWidthUint16,
|
|
EfiPciWidthUint32,
|
|
EfiPciWidthUint64,
|
|
EfiPciWidthFifoUint8,
|
|
EfiPciWidthFifoUint16,
|
|
EfiPciWidthFifoUint32,
|
|
EfiPciWidthFifoUint64,
|
|
EfiPciWidthFillUint8,
|
|
EfiPciWidthFillUint16,
|
|
EfiPciWidthFillUint32,
|
|
EfiPciWidthFillUint64,
|
|
EfiPciWidthMaximum
|
|
} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH;
|
|
|
|
typedef enum {
|
|
EfiPciOperationBusMasterRead,
|
|
EfiPciOperationBusMasterWrite,
|
|
EfiPciOperationBusMasterCommonBuffer,
|
|
EfiPciOperationBusMasterRead64,
|
|
EfiPciOperationBusMasterWrite64,
|
|
EfiPciOperationBusMasterCommonBuffer64,
|
|
EfiPciOperationMaximum
|
|
} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_OPERATION;
|
|
|
|
#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_MEMORY_CACHED 0x0800
|
|
#define EFI_PCI_ATTRIBUTE_MEMORY_DISABLE 0x1000
|
|
#define EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
|
|
//
|
|
// The following definition is added in EFI1.1 spec update and UEFI2.0 spec.
|
|
//
|
|
#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_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)
|
|
|
|
#define EFI_PCI_ADDRESS(bus, dev, func, reg) \
|
|
((UINT64) ((((UINTN) bus) << 24) + (((UINTN) dev) << 16) + (((UINTN) func) << 8) + ((UINTN) reg)))
|
|
|
|
typedef struct {
|
|
UINT8 Register;
|
|
UINT8 Function;
|
|
UINT8 Device;
|
|
UINT8 Bus;
|
|
UINT32 ExtendedRegister;
|
|
} EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS;
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM) (
|
|
IN 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
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_IO_MEM) (
|
|
IN 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_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_ROOT_BRIDGE_IO_PROTOCOL_COPY_MEM) (
|
|
IN 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
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_MAP) (
|
|
IN 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
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_UNMAP) (
|
|
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL * This,
|
|
IN VOID *Mapping
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_ALLOCATE_BUFFER) (
|
|
IN 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
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FREE_BUFFER) (
|
|
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL * This,
|
|
IN UINTN Pages,
|
|
IN VOID *HostAddress
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_FLUSH) (
|
|
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL * This
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES) (
|
|
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL * This,
|
|
OUT UINT64 *Supports,
|
|
OUT UINT64 *Attributes
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES) (
|
|
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL * This,
|
|
IN UINT64 Attributes,
|
|
IN OUT UINT64 *ResourceBase,
|
|
IN OUT UINT64 *ResourceLength
|
|
);
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION) (
|
|
IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL * This,
|
|
OUT VOID **Resources
|
|
);
|
|
|
|
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;
|
|
};
|
|
|
|
extern EFI_GUID gEfiPciRootBridgeIoProtocolGuid;
|
|
|
|
#endif
|