Add ReallocatePool(), ReallocateRuntimePool(), and ReallocateReservedPool() to BaseMe...

[mirror_edk2.git] / MdePkg / Include / Protocol / DeviceIo.h

/** @file\r
  Device IO protocol as defined in the EFI 1.10 specification.\r
\r
  Device IO is used to abstract hardware access to devices. It includes\r
  memory mapped IO, IO, PCI Config space, and DMA.\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __DEVICE_IO_H__\r
#define __DEVICE_IO_H__\r
\r
#define EFI_DEVICE_IO_PROTOCOL_GUID \\r
  { \\r
    0xaf6ac311, 0x84c3, 0x11d2, {0x8e, 0x3c, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
  }\r
\r
typedef struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL;\r
\r
///\r
/// Protocol GUID name defined in EFI1.1.\r
/// \r
#define DEVICE_IO_PROTOCOL  EFI_DEVICE_IO_PROTOCOL_GUID\r
\r
///\r
/// Protocol defined in EFI1.1.\r
/// \r
typedef EFI_DEVICE_IO_PROTOCOL  EFI_DEVICE_IO_INTERFACE;\r
\r
typedef enum {\r
  IO_UINT8  = 0,\r
  IO_UINT16 = 1,\r
  IO_UINT32 = 2,\r
  IO_UINT64 = 3,\r
  //\r
  // Below enumerations are added in "EFI 1.10 Specification update - 001", which\r
  // is downloadable from http://download.intel.com/technology/efi/docs/EFI_1-10_Update.zip\r
  //\r
  MMIO_COPY_UINT8  = 4,\r
  MMIO_COPY_UINT16 = 5,\r
  MMIO_COPY_UINT32 = 6,\r
  MMIO_COPY_UINT64 = 7\r
} EFI_IO_WIDTH;\r
\r
/**                                                                 \r
  Enables a driver to access device registers in the appropriate memory or I/O space.\r
    \r
  @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
  @param  Width                 Signifies the width of the I/O operations.                                                                   \r
  @param  Address               The base address of the I/O operations. \r
  @param  Count                 The number of I/O operations to perform.\r
  @param  Buffer                For read operations, the destination buffer to store the results. For write\r
                                operations, the source buffer to write data from. If\r
                                Width is MMIO_COPY_UINT8, MMIO_COPY_UINT16,\r
                                MMIO_COPY_UINT32, or MMIO_COPY_UINT64, then\r
                                Buffer is interpreted as a base address of an I/O operation such as Address. \r
\r
  @retval EFI_SUCCESS           The data was read from or written to the device.\r
  @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.      \r
  @retval EFI_INVALID_PARAMETER Width is invalid.\r
                                   \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DEVICE_IO)(\r
  IN EFI_DEVICE_IO_PROTOCOL         *This,\r
  IN EFI_IO_WIDTH                   Width,\r
  IN UINT64                         Address,\r
  IN UINTN                          Count,\r
  IN OUT VOID                       *Buffer\r
  );\r
\r
typedef struct {\r
  EFI_DEVICE_IO Read;\r
  EFI_DEVICE_IO Write;\r
} EFI_IO_ACCESS;\r
\r
/**                                                                 \r
  Provides an EFI Device Path for a PCI device with the given PCI configuration space address.\r
    \r
  @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
  @param  PciAddress            The PCI configuration space address of the device whose Device Path\r
                                is going to be returned.  \r
  @param  PciDevicePath         A pointer to the pointer for the EFI Device Path for PciAddress.\r
                                Memory for the Device Path is allocated from the pool.          \r
\r
  @retval EFI_SUCCESS           The PciDevicePath returns a pointer to a valid EFI Device Path.\r
  @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.      \r
  @retval EFI_UNSUPPORTED       The PciAddress does not map to a valid EFI Device Path.\r
                                   \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PCI_DEVICE_PATH)(\r
  IN EFI_DEVICE_IO_PROTOCOL           *This,\r
  IN UINT64                           PciAddress,\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL     **PciDevicePath\r
  );\r
\r
typedef enum {\r
  ///\r
  /// A read operation from system memory by a bus master.\r
  ///\r
  EfiBusMasterRead,\r
\r
  ///\r
  /// A write operation to system memory by a bus master.\r
  ///\r
  EfiBusMasterWrite,\r
  \r
  ///\r
  /// Provides both read and write access to system memory\r
  /// by both the processor and a bus master. The buffer is\r