X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FUgaIo.h;h=b6884219180cfaeecfae22b005661c7b2c2508c6;hp=50fb3d569a0a9d13c7d00585997000dcac999016;hb=344d057a2b539cf34420e2afad2351b45c65178e;hpb=258cce138272fc013a723040691b37294e473a37 diff --git a/MdePkg/Include/Protocol/UgaIo.h b/MdePkg/Include/Protocol/UgaIo.h index 50fb3d569a..b688421918 100644 --- a/MdePkg/Include/Protocol/UgaIo.h +++ b/MdePkg/Include/Protocol/UgaIo.h @@ -3,8 +3,8 @@ Abstraction of a very simple graphics device. - Copyright (c) 2006 - 2008, Intel Corporation - All rights reserved. This program and the accompanying materials + Copyright (c) 2006 - 2008, 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 @@ -30,8 +30,7 @@ typedef enum { UgaDtOutputController, UgaDtOutputPort, UgaDtOther -} -UGA_DEVICE_TYPE, *PUGA_DEVICE_TYPE; +} UGA_DEVICE_TYPE, *PUGA_DEVICE_TYPE; typedef UINT32 UGA_DEVICE_ID, *PUGA_DEVICE_ID; @@ -40,8 +39,7 @@ typedef struct { UGA_DEVICE_ID deviceId; UINT32 ui32DeviceContextSize; UINT32 ui32SharedContextSize; -} -UGA_DEVICE_DATA, *PUGA_DEVICE_DATA; +} UGA_DEVICE_DATA, *PUGA_DEVICE_DATA; typedef struct _UGA_DEVICE { VOID *pvDeviceContext; @@ -51,8 +49,7 @@ typedef struct _UGA_DEVICE { VOID *pvBusIoServices; VOID *pvStdIoServices; UGA_DEVICE_DATA deviceData; -} -UGA_DEVICE, *PUGA_DEVICE; +} UGA_DEVICE, *PUGA_DEVICE; typedef enum { UgaIoGetVersion = 1, @@ -78,8 +75,7 @@ typedef enum { UgaIoGetDevicePropertySize, UgaIoGetDeviceProperty, UgaIoBtPrivateInterface -} -UGA_IO_REQUEST_CODE, *PUGA_IO_REQUEST_CODE; +} UGA_IO_REQUEST_CODE, *PUGA_IO_REQUEST_CODE; typedef struct { IN UGA_IO_REQUEST_CODE ioRequestCode; @@ -91,17 +87,17 @@ typedef struct { } UGA_IO_REQUEST, *PUGA_IO_REQUEST; -/** - Dynamically allocate storage for a child UGA_DEVICE . - - @param[in] This The EFI_UGA_IO_PROTOCOL instance. - @param[in] ParentDevice ParentDevice specifies a pointer to the parent device of Device. +/** + Dynamically allocate storage for a child UGA_DEVICE. + + @param[in] This The EFI_UGA_IO_PROTOCOL instance. + @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. + 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. - + 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. @@ -119,14 +115,14 @@ EFI_STATUS ); -/** - Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice() . - +/** + 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. + 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(). @@ -162,10 +158,9 @@ typedef UGA_STATUS IN OUT PUGA_IO_REQUEST pIoRequest ); -/** - @par Protocol Description: - Provides a basic abstraction to send I/O requests to the graphics device and any of its children. -**/ +/// +/// Provides a basic abstraction to send I/O requests to the graphics device and any of its children. +/// struct _EFI_UGA_IO_PROTOCOL { EFI_UGA_IO_PROTOCOL_CREATE_DEVICE CreateDevice; EFI_UGA_IO_PROTOCOL_DELETE_DEVICE DeleteDevice;