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