Add some function/header comments.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / VgaMiniPort.h

/**@file\r
  Vga Mini port binding for a VGA controller\r
\r
Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __VGA_MINI_PORT_H_\r
#define __VGA_MINI_PORT_H_\r
\r
#define EFI_VGA_MINI_PORT_PROTOCOL_GUID \\r
  { \\r
    0xc7735a2f, 0x88f5, 0x4882, {0xae, 0x63, 0xfa, 0xac, 0x8c, 0x8b, 0x86, 0xb3 } \\r
  }\r
\r
typedef struct _EFI_VGA_MINI_PORT_PROTOCOL  EFI_VGA_MINI_PORT_PROTOCOL;\r
\r
/**\r
  Sets the text display mode of a VGA controller\r
  \r
  @param This             Protocol instance pointer.\r
  @param Mode             Mode number.  0 - 80x25   1-80x50\r
\r
  @retval EFI_SUCCESS            The mode was set\r
  @retval EFI_DEVICE_ERROR       The device is not functioning properly.\r
  \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_VGA_MINI_PORT_SET_MODE) (\r
  IN EFI_VGA_MINI_PORT_PROTOCOL          * This,\r
  IN UINTN                               ModeNumber\r
  );\r
\r
struct _EFI_VGA_MINI_PORT_PROTOCOL {\r
  EFI_VGA_MINI_PORT_SET_MODE  SetMode;\r
\r
  UINT64                      VgaMemoryOffset;\r
  UINT64                      CrtcAddressRegisterOffset;\r
  UINT64                      CrtcDataRegisterOffset;\r
\r
  UINT8                       VgaMemoryBar;\r
  UINT8                       CrtcAddressRegisterBar;\r
  UINT8                       CrtcDataRegisterBar;\r
\r
  UINT8                       MaxMode;\r
};\r
\r
extern EFI_GUID gEfiVgaMiniPortProtocolGuid;\r
\r
#endif\r