IntelFrameworkPkg/Include/Protocol/CpuIo.h

   1 /** @file
   2   This code abstracts the CPU IO Protocol
   3
   4   Copyright (c) 2007, 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:  CpuIO.h
  14
  15   @par Revision Reference:
  16   CPU IO Protocol is defined in Framework of EFI CPU IO Protocol Spec
  17   Version 0.9
  18
  19 **/
  20
  21 #ifndef _CPUIO_H_
  22 #define _CPUIO_H_
  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 // *******************************************************
  33 // EFI_CPU_IO_PROTOCOL_WIDTH
  34 // *******************************************************
  35 //
  36 typedef enum {
  37   EfiCpuIoWidthUint8,
  38   EfiCpuIoWidthUint16,
  39   EfiCpuIoWidthUint32,
  40   EfiCpuIoWidthUint64,
  41   EfiCpuIoWidthFifoUint8,
  42   EfiCpuIoWidthFifoUint16,
  43   EfiCpuIoWidthFifoUint32,
  44   EfiCpuIoWidthFifoUint64,
  45   EfiCpuIoWidthFillUint8,
  46   EfiCpuIoWidthFillUint16,
  47   EfiCpuIoWidthFillUint32,
  48   EfiCpuIoWidthFillUint64,
  49   EfiCpuIoWidthMaximum
  50 } EFI_CPU_IO_PROTOCOL_WIDTH;
  51
  52 //
  53 // *******************************************************
  54 // EFI_CPU_IO_PROTOCOL_IO_MEM
  55 // *******************************************************
  56 //
  57 /**
  58   Enables a driver to access memory-mapped registers in the EFI system memory space.
  59   Or, Enables a driver to access registers in the EFI CPU I/O space.
  60
  61   @param  This                  A pointer to the EFI_CPU_IO_PROTOCOL instance.
  62   @param  Width                 Signifies the width of the I/O or Memory operation.
  63   @param  Address               The base address of the I/O or Memoryoperation.
  64   @param  Count                 The number of I/O or Memory operations to perform.
  65                                 The number of bytes moved is Width size * Count, starting at Address.
  66   @param  Buffer                For read operations, the destination buffer to store the results.
  67                                 For write operations, the source buffer from which to write data.
  68
  69   @retval EFI_SUCCESS           The data was read from or written to the EFI system.
  70   @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system.Or Buffer is NULL.
  71   @retval EFI_UNSUPPORTED       The Buffer is not aligned for the given Width.
  72                                 Or,The address range specified by Address, Width, and Count is not valid for this EFI system.
  73
  74 **/
  75 typedef
  76 EFI_STATUS
  77 (EFIAPI *EFI_CPU_IO_PROTOCOL_IO_MEM) (
  78   IN EFI_CPU_IO_PROTOCOL                *This,
  79   IN  EFI_CPU_IO_PROTOCOL_WIDTH         Width,
  80   IN  UINT64                            Address,
  81   IN  UINTN                             Count,
  82   IN  OUT VOID                          *Buffer
  83   );
  84
  85 //
  86 // *******************************************************
  87 // EFI_CPU_IO_PROTOCOL_ACCESS
  88 // *******************************************************
  89 //
  90 typedef struct {
  91   EFI_CPU_IO_PROTOCOL_IO_MEM  Read;
  92   EFI_CPU_IO_PROTOCOL_IO_MEM  Write;
  93 } EFI_CPU_IO_PROTOCOL_ACCESS;
  94
  95 //
  96 // *******************************************************
  97 // EFI_CPU_IO_PROTOCOL
  98 // *******************************************************
  99 //
 100 /**
 101   @par Protocol Description:
 102   Provides the basic memory and I/O interfaces that are used to abstract
 103   accesses to devices in a system.
 104
 105   @param Mem.Read
 106   Allows reads from memory-mapped I/O space.
 107
 108   @param Mem.Write
 109   Allows writes to memory-mapped I/O space.
 110
 111   @param Io.Read
 112   Allows reads from I/O space.
 113
 114   @param Io.Write
 115   Allows writes to I/O space.
 116
 117 **/
 118 struct _EFI_CPU_IO_PROTOCOL {
 119   EFI_CPU_IO_PROTOCOL_ACCESS  Mem;
 120   EFI_CPU_IO_PROTOCOL_ACCESS  Io;
 121 };
 122
 123 extern EFI_GUID gEfiCpuIoProtocolGuid;
 124
 125 #endif