X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FUgaIo.h;h=02654051afea36893669b9eb47909df0448ec2e7;hb=e26ac2b535a0b117c45212775b86c6410d5b5615;hp=b1e7d44575ac5140cf67e8de0e3f3cdb32c5d0e3;hpb=d1f950002362305fcd4c30f108ef7b76679f5843;p=mirror_edk2.git diff --git a/MdePkg/Include/Protocol/UgaIo.h b/MdePkg/Include/Protocol/UgaIo.h index b1e7d44575..02654051af 100644 --- a/MdePkg/Include/Protocol/UgaIo.h +++ b/MdePkg/Include/Protocol/UgaIo.h @@ -1,34 +1,24 @@ - -/*++ - -Copyright (c) 2006, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - -Module Name: - - UgaIo.h - -Abstract: - +/** @file UGA IO protocol from the EFI 1.1 specification. Abstraction of a very simple graphics device. + + Copyright (c) 2006 - 2007, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. ---*/ +**/ #ifndef __UGA_IO_H__ #define __UGA_IO_H__ #define EFI_UGA_IO_PROTOCOL_GUID \ - { \ - 0x61a4d49e, 0x6f68, 0x4f1b, { 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 } \ - } + { 0x61a4d49e, 0x6f68, 0x4f1b, { 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 } } typedef struct _EFI_UGA_IO_PROTOCOL EFI_UGA_IO_PROTOCOL; @@ -104,49 +94,51 @@ typedef struct { OUT VOID *pvOutBuffer; IN UINT64 ui64OutBufferSize; OUT UINT64 ui64BytesReturned; -} -UGA_IO_REQUEST, *PUGA_IO_REQUEST; - +} UGA_IO_REQUEST, *PUGA_IO_REQUEST; + + +/** + Dynamically allocate storage for a child UGA_DEVICE . + + @param[in] This The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is + defined in Section 10.7. + @param[in] ParentDevice ParentDevice specifies a pointer to the parent device of Device. + @param[in] DeviceData A pointer to UGA_DEVICE_DATA returned from a call to DispatchService() + with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice. + @param[in] RunTimeContext Context to associate with Device. + @param[out] Device The Device returns a dynamically allocated child UGA_DEVICE object + for ParentDevice. The caller is responsible for deleting Device. + + + @retval EFI_SUCCESS Device was returned. + @retval EFI_INVALID_PARAMETER One of the arguments was not valid. + @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. + +**/ typedef EFI_STATUS (EFIAPI *EFI_UGA_IO_PROTOCOL_CREATE_DEVICE) ( - IN EFI_UGA_IO_PROTOCOL * This, - IN UGA_DEVICE * ParentDevice, - IN UGA_DEVICE_DATA * DeviceData, + IN EFI_UGA_IO_PROTOCOL *This, + IN UGA_DEVICE *ParentDevice, + IN UGA_DEVICE_DATA *DeviceData, IN VOID *RunTimeContext, OUT UGA_DEVICE **Device ); -/*++ - - Routine Description: - - Dynamically allocate storage for a child UGA_DEVICE . - - Arguments: - - This - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is - defined in Section 10.7. - - ParentDevice - ParentDevice specifies a pointer to the parent device of Device. - - DeviceData - A pointer to UGA_DEVICE_DATA returned from a call to DispatchService() - with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice. - RuntimeContext - Context to associate with Device. +/** + Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice() . + + @param[in] This The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is + defined in Section 10.7. + @param[in] Device The Device points to a UGA_DEVICE object that was dynamically + allocated via a CreateDevice() call. + + + @retval EFI_SUCCESS Device was returned. + @retval EFI_INVALID_PARAMETER The Device was not allocated via CreateDevice(). - Device - The Device returns a dynamically allocated child UGA_DEVICE object - for ParentDevice. The caller is responsible for deleting Device. - - Returns: - - EFI_SUCCESS - Device was returned. - - EFI_INVALID_PARAMETER - One of the arguments was not valid. - - EFI_DEVICE_ERROR - The device had an error and could not complete the request. - ---*/ +**/ typedef EFI_STATUS (EFIAPI *EFI_UGA_IO_PROTOCOL_DELETE_DEVICE) ( @@ -154,31 +146,10 @@ EFI_STATUS IN UGA_DEVICE * Device ); -/*++ - - Routine Description: - - Delete a dynamically allocated child UGA_DEVICE object that was allocated via - CreateDevice() . - - Arguments: - - This - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is defined - in Section 10.7. - - Device - The Device points to a UGA_DEVICE object that was dynamically - allocated via a CreateDevice() call. - - Returns: - - EFI_SUCCESS - Device was deleted. - - EFI_INVALID_PARAMETER - The Device was not allocated via CreateDevice() ---*/ typedef UGA_STATUS (EFIAPI *PUGA_FW_SERVICE_DISPATCH) (IN PUGA_DEVICE pDevice, IN OUT PUGA_IO_REQUEST pIoRequest); -/*++ +/** Routine Description: @@ -200,7 +171,7 @@ typedef UGA_STATUS (EFIAPI *PUGA_FW_SERVICE_DISPATCH) (IN PUGA_DEVICE pDevice, I Varies depending on pIoRequest. ---*/ +**/ struct _EFI_UGA_IO_PROTOCOL { EFI_UGA_IO_PROTOCOL_CREATE_DEVICE CreateDevice; EFI_UGA_IO_PROTOCOL_DELETE_DEVICE DeleteDevice;