IntelFrameworkPkg/Include/Protocol/CpuIo.h

   1 /** @file
   2   This code abstracts the CPU IO Protocol which installed by some platform or chipset-specific
   3   PEIM that abstracts the processor-visible I/O operations.
   4
   5   Copyright (c) 2007 - 2009, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14   @par Revision Reference:
  15   CPU IO Protocol is defined in Framework of EFI CPU IO Protocol Spec
  16   Version 0.9
  17
  18 **/
  19
  20 #ifndef _CPUIO_H_
  21 #define _CPUIO_H_
  22
  23
  24 #define EFI_CPU_IO_PROTOCOL_GUID \
  25   { \
  26     0xB0732526, 0x38C8, 0x4b40, {0x88, 0x77, 0x61, 0xC7, 0xB0, 0x6A, 0xAC, 0x45 } \
  27   }
  28
  29 typedef struct _EFI_CPU_IO_PROTOCOL EFI_CPU_IO_PROTOCOL;
  30
  31 ///
  32 /// Enumeration that defines the width of the I/O operation.
  33 ///
  34 typedef enum {
  35   EfiCpuIoWidthUint8,
  36   EfiCpuIoWidthUint16,
  37   EfiCpuIoWidthUint32,
  38   EfiCpuIoWidthUint64,
  39   EfiCpuIoWidthFifoUint8,
  40   EfiCpuIoWidthFifoUint16,
  41   EfiCpuIoWidthFifoUint32,
  42   EfiCpuIoWidthFifoUint64,
  43   EfiCpuIoWidthFillUint8,
  44   EfiCpuIoWidthFillUint16,
  45   EfiCpuIoWidthFillUint32,
  46   EfiCpuIoWidthFillUint64,
  47   EfiCpuIoWidthMaximum
  48 } EFI_CPU_IO_PROTOCOL_WIDTH;
  49
  50 /**
  51   Enables a driver to access memory-mapped registers in the EFI system memory space.
  52   Or, enables a driver to access registers in the EFI CPU I/O space.
  53
  54   @param[in]       This         A pointer to the EFI_CPU_IO_PROTOCOL instance.
  55   @param[in]       Width        Signifies the width of the I/O or Memory operation.
  56   @param[in]       Address      The base address of the I/O or Memory operation.
  57   @param[in]       Count        The number of I/O or Memory operations to perform.
  58                                 The number of bytes moved is Width size * Count, starting at Address.
  59   @param[in, out]  Buffer       For read operations, the destination buffer to store the results.
  60                                 For write operations, the source buffer from which to write data.
  61
  62   @retval EFI_SUCCESS           The data was read from or written to the EFI system.
  63   @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system. Or Buffer is NULL.
  64   @retval EFI_UNSUPPORTED       The Buffer is not aligned for the given Width.
  65                                 Or,The address range specified by Address, Width, and Count is not valid for this EFI system.
  66
  67 **/
  68 typedef
  69 EFI_STATUS
  70 (EFIAPI *EFI_CPU_IO_PROTOCOL_IO_MEM)(
  71   IN     EFI_CPU_IO_PROTOCOL               *This,
  72   IN     EFI_CPU_IO_PROTOCOL_WIDTH         Width,
  73   IN     UINT64                            Address,
  74   IN     UINTN                             Count,
  75   IN OUT VOID                              *Buffer
  76   );
  77
  78 ///
  79 /// Service for read and write accesses.
  80 ///
  81 typedef struct {
  82   ///
  83   /// This service provides the various modalities of memory and I/O read.
  84   ///
  85   EFI_CPU_IO_PROTOCOL_IO_MEM  Read;
  86   ///
  87   /// This service provides the various modalities of memory and I/O write.
  88   ///
  89   EFI_CPU_IO_PROTOCOL_IO_MEM  Write;
  90 } EFI_CPU_IO_PROTOCOL_ACCESS;
  91
  92 ///
  93 /// Provides the basic memory and I/O interfaces that are used to abstract
  94 /// accesses to devices in a system.
  95 ///
  96 struct _EFI_CPU_IO_PROTOCOL {
  97   ///
  98   /// Enables a driver to access memory-mapped registers in the EFI system memory space.
  99   ///
 100   EFI_CPU_IO_PROTOCOL_ACCESS  Mem;
 101   ///
 102   /// Enables a driver to access registers in the EFI CPU I/O space.
 103   ///
 104   EFI_CPU_IO_PROTOCOL_ACCESS  Io;
 105 };
 106
 107 extern EFI_GUID gEfiCpuIoProtocolGuid;
 108
 109 #endif