2 UGA IO protocol from the EFI 1.1 specification.
4 Abstraction of a very simple graphics device.
6 Copyright (c) 2006 - 2007, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 #define EFI_UGA_IO_PROTOCOL_GUID \
21 { 0x61a4d49e, 0x6f68, 0x4f1b, { 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 } }
23 typedef struct _EFI_UGA_IO_PROTOCOL EFI_UGA_IO_PROTOCOL
;
25 typedef UINT32 UGA_STATUS
;
29 UgaDtGraphicsController
,
30 UgaDtOutputController
,
34 UGA_DEVICE_TYPE
, *PUGA_DEVICE_TYPE
;
36 typedef UINT32 UGA_DEVICE_ID
, *PUGA_DEVICE_ID
;
39 UGA_DEVICE_TYPE deviceType
;
40 UGA_DEVICE_ID deviceId
;
41 UINT32 ui32DeviceContextSize
;
42 UINT32 ui32SharedContextSize
;
44 UGA_DEVICE_DATA
, *PUGA_DEVICE_DATA
;
46 typedef struct _UGA_DEVICE
{
47 VOID
*pvDeviceContext
;
48 VOID
*pvSharedContext
;
49 VOID
*pvRunTimeContext
;
50 struct _UGA_DEVICE
*pParentDevice
;
51 VOID
*pvBusIoServices
;
52 VOID
*pvStdIoServices
;
53 UGA_DEVICE_DATA deviceData
;
55 UGA_DEVICE
, *PUGA_DEVICE
;
57 #ifndef UGA_IO_REQUEST_CODE
59 // Prevent conflicts with UGA typedefs.
71 UgaIoGetMemoryConfiguration
,
75 UgaIoDeviceChannelOpen
,
76 UgaIoDeviceChannelClose
,
77 UgaIoDeviceChannelRead
,
78 UgaIoDeviceChannelWrite
,
79 UgaIoGetPersistentDataSize
,
80 UgaIoGetPersistentData
,
81 UgaIoSetPersistentData
,
82 UgaIoGetDevicePropertySize
,
83 UgaIoGetDeviceProperty
,
84 UgaIoBtPrivateInterface
86 UGA_IO_REQUEST_CODE
, *PUGA_IO_REQUEST_CODE
;
91 IN UGA_IO_REQUEST_CODE ioRequestCode
;
93 IN UINT64 ui64InBufferSize
;
94 OUT VOID
*pvOutBuffer
;
95 IN UINT64 ui64OutBufferSize
;
96 OUT UINT64 ui64BytesReturned
;
98 UGA_IO_REQUEST
, *PUGA_IO_REQUEST
;
102 (EFIAPI
*EFI_UGA_IO_PROTOCOL_CREATE_DEVICE
) (
103 IN EFI_UGA_IO_PROTOCOL
* This
,
104 IN UGA_DEVICE
* ParentDevice
,
105 IN UGA_DEVICE_DATA
* DeviceData
,
106 IN VOID
*RunTimeContext
,
107 OUT UGA_DEVICE
**Device
114 Dynamically allocate storage for a child UGA_DEVICE .
118 This - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is
119 defined in Section 10.7.
121 ParentDevice - ParentDevice specifies a pointer to the parent device of Device.
123 DeviceData - A pointer to UGA_DEVICE_DATA returned from a call to DispatchService()
124 with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice.
126 RuntimeContext - Context to associate with Device.
128 Device - The Device returns a dynamically allocated child UGA_DEVICE object
129 for ParentDevice. The caller is responsible for deleting Device.
133 EFI_SUCCESS - Device was returned.
135 EFI_INVALID_PARAMETER - One of the arguments was not valid.
137 EFI_DEVICE_ERROR - The device had an error and could not complete the request.
142 (EFIAPI
*EFI_UGA_IO_PROTOCOL_DELETE_DEVICE
) (
143 IN EFI_UGA_IO_PROTOCOL
* This
,
144 IN UGA_DEVICE
* Device
151 Delete a dynamically allocated child UGA_DEVICE object that was allocated via
156 This - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is defined
159 Device - The Device points to a UGA_DEVICE object that was dynamically
160 allocated via a CreateDevice() call.
164 EFI_SUCCESS - Device was deleted.
166 EFI_INVALID_PARAMETER - The Device was not allocated via CreateDevice()
169 typedef UGA_STATUS (EFIAPI
*PUGA_FW_SERVICE_DISPATCH
) (IN PUGA_DEVICE pDevice
, IN OUT PUGA_IO_REQUEST pIoRequest
);
175 This is the main UGA service dispatch routine for all UGA_IO_REQUEST s.
179 pDevice - pDevice specifies a pointer to a device object associated with a
180 device enumerated by a pIoRequest->ioRequestCode of type
181 UgaIoGetChildDevice. The root device for the EFI_UGA_IO_PROTOCOL
182 is represented by pDevice being set to NULL.
184 pIoRequest - pIoRequest points to a caller allocated buffer that contains data
185 defined by pIoRequest->ioRequestCode. See Related Definitions for
186 a definition of UGA_IO_REQUEST_CODE s and their associated data
191 Varies depending on pIoRequest.
194 struct _EFI_UGA_IO_PROTOCOL
{
195 EFI_UGA_IO_PROTOCOL_CREATE_DEVICE CreateDevice
;
196 EFI_UGA_IO_PROTOCOL_DELETE_DEVICE DeleteDevice
;
197 PUGA_FW_SERVICE_DISPATCH DispatchService
;
200 extern EFI_GUID gEfiUgaIoProtocolGuid
;
203 // Data structure that is stored in the EFI Configuration Table with the
204 // EFI_UGA_IO_PROTOCOL_GUID. The option ROMs listed in this table may have
210 UINT32 SizeOfEntries
;
211 UINT32 NumberOfEntries
;
212 } EFI_DRIVER_OS_HANDOFF_HEADER
;
215 EfiUgaDriverFromPciRom
,
216 EfiUgaDriverFromSystem
,
218 } EFI_DRIVER_HANOFF_ENUM
;
221 EFI_DRIVER_HANOFF_ENUM Type
;
222 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
225 } EFI_DRIVER_OS_HANDOFF
;