Header file for GraphicsConsole driver.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
-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
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Protocol/HiiFont.h>\r
#include <Protocol/HiiDatabase.h>\r
\r
-\r
extern EFI_COMPONENT_NAME_PROTOCOL gGraphicsConsoleComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL gGraphicsConsoleComponentName2;\r
extern EFI_DRIVER_BINDING_PROTOCOL gGraphicsConsoleDriverBinding;\r
extern EFI_NARROW_GLYPH gUsStdNarrowGlyphData[];\r
\r
-extern UINT32 mNarrowFontSize;\r
+extern UINT32 mNarrowFontSize;\r
\r
typedef union {\r
- EFI_NARROW_GLYPH NarrowGlyph;\r
- EFI_WIDE_GLYPH WideGlyph;\r
+ EFI_NARROW_GLYPH NarrowGlyph;\r
+ EFI_WIDE_GLYPH WideGlyph;\r
} GLYPH_UNION;\r
\r
//\r
#define GRAPHICS_CONSOLE_DEV_SIGNATURE SIGNATURE_32 ('g', 's', 't', 'o')\r
\r
typedef struct {\r
- UINTN Columns;\r
- UINTN Rows;\r
- INTN DeltaX;\r
- INTN DeltaY;\r
- UINT32 GopWidth;\r
- UINT32 GopHeight;\r
- UINT32 GopModeNumber;\r
+ UINTN Columns;\r
+ UINTN Rows;\r
+ INTN DeltaX;\r
+ INTN DeltaY;\r
+ UINT32 GopWidth;\r
+ UINT32 GopHeight;\r
+ UINT32 GopModeNumber;\r
} GRAPHICS_CONSOLE_MODE_DATA;\r
\r
typedef struct {\r
- UINTN Signature;\r
- EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r
- EFI_UGA_DRAW_PROTOCOL *UgaDraw;\r
- EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOutput;\r
- EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode;\r
- GRAPHICS_CONSOLE_MODE_DATA *ModeData;\r
- EFI_GRAPHICS_OUTPUT_BLT_PIXEL *LineBuffer;\r
+ UINTN Signature;\r
+ EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r
+ EFI_UGA_DRAW_PROTOCOL *UgaDraw;\r
+ EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOutput;\r
+ EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode;\r
+ GRAPHICS_CONSOLE_MODE_DATA *ModeData;\r
+ EFI_GRAPHICS_OUTPUT_BLT_PIXEL *LineBuffer;\r
} GRAPHICS_CONSOLE_DEV;\r
\r
#define GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS(a) \\r
CR (a, GRAPHICS_CONSOLE_DEV, SimpleTextOutput, GRAPHICS_CONSOLE_DEV_SIGNATURE)\r
\r
-\r
//\r
// EFI Component Name Functions\r
//\r
+\r
/**\r
Retrieves a Unicode string that is the user readable name of the driver.\r
\r
OUT CHAR16 **DriverName\r
);\r
\r
-\r
/**\r
Retrieves a Unicode string that is the user readable name of the controller\r
that is being managed by a driver.\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleComponentNameGetControllerName (\r
- IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
- IN EFI_HANDLE ControllerHandle,\r
- IN EFI_HANDLE ChildHandle OPTIONAL,\r
- IN CHAR8 *Language,\r
- OUT CHAR16 **ControllerName\r
+ IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
+ IN EFI_HANDLE ControllerHandle,\r
+ IN EFI_HANDLE ChildHandle OPTIONAL,\r
+ IN CHAR8 *Language,\r
+ OUT CHAR16 **ControllerName\r
);\r
\r
-\r
/**\r
Reset the text output device hardware and optionally run diagnostics.\r
\r
Implements SIMPLE_TEXT_OUTPUT.Reset().\r
- If ExtendeVerification is TRUE, then perform dependent Graphics Console\r
+ If ExtendedVerification is TRUE, then perform dependent Graphics Console\r
device reset, and set display mode to mode 0.\r
If ExtendedVerification is FALSE, only set display mode to mode 0.\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleConOutReset (\r
- IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
- IN BOOLEAN ExtendedVerification\r
+ IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
+ IN BOOLEAN ExtendedVerification\r
);\r
\r
/**\r
supports\r
\r
Implements SIMPLE_TEXT_OUTPUT.QueryMode().\r
- It returnes information for an available text mode that the Graphics Console supports.\r
+ It returns information for an available text mode that the Graphics Console supports.\r
In this driver,we only support text mode 80x25, which is defined as mode 0.\r
\r
@param This Protocol instance pointer.\r
OUT UINTN *Rows\r
);\r
\r
-\r
/**\r
Sets the output device(s) to a specified mode.\r
\r
IN UINTN Row\r
);\r
\r
-\r
/**\r
Makes the cursor visible or invisible.\r
\r
/**\r
Test to see if Graphics Console could be supported on the Controller.\r
\r
- Graphics Console could be supported if Graphics Output Protocol or UGA Draw\r
+ Graphics Console could be supported if Graphics Output Protocol or UGADraw\r
Protocol exists on the Controller. (UGA Draw Protocol could be skipped\r
if PcdUgaConsumeSupport is set to FALSE.)\r
\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleControllerDriverSupported (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
);\r
\r
-\r
/**\r
Start this driver on Controller by opening Graphics Output protocol or\r
UGA Draw protocol, and installing Simple Text Out protocol on Controller.\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleControllerDriverStart (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
);\r
\r
/**\r
EFI_STATUS\r
EFIAPI\r
GraphicsConsoleControllerDriverStop (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN UINTN NumberOfChildren,\r
- IN EFI_HANDLE *ChildHandleBuffer\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN UINTN NumberOfChildren,\r
+ IN EFI_HANDLE *ChildHandleBuffer\r
);\r
\r
-\r
/**\r
Locate HII Database protocol and HII Font protocol.\r
\r
VOID\r
);\r
\r
-\r
/**\r
- Gets Graphics Console devcie's foreground color and background color.\r
+ Gets Graphics Console device's foreground color and background color.\r
\r
@param This Protocol instance pointer.\r
@param Foreground Returned text foreground color.\r
EFI_STATUS\r
CheckModeSupported (\r
EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput,\r
- IN UINT32 HorizontalResolution,\r
- IN UINT32 VerticalResolution,\r
- OUT UINT32 *CurrentModeNumber\r
+ IN UINT32 HorizontalResolution,\r
+ IN UINT32 VerticalResolution,\r
+ OUT UINT32 *CurrentModeNumber\r
);\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff