projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 95276127 | 1 | /*++\r |
| 2 | \r | |
| 3 | Copyright (c) 2006, Intel Corporation \r | |
| 4 | All rights reserved. This program and the accompanying materials \r | |
| 5 | are licensed and made available under the terms and conditions of the BSD License \r | |
| 6 | which accompanies this distribution. The full text of the license may be found at \r | |
| 7 | http://opensource.org/licenses/bsd-license.php \r | |
| 8 | \r | |
| 9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
| 10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
| 11 | \r | |
| 12 | Module Name:\r | |
| 13 | \r | |
| 14 | GraphicsConsole.h\r | |
| 15 | \r | |
| 16 | Abstract:\r | |
| 17 | \r | |
| 18 | \r | |
| 19 | Revision History\r | |
| 20 | \r | |
| 21 | --*/\r | |
| 22 | \r | |
| 23 | #ifndef _GRAPHICS_CONSOLE_H\r | |
| 24 | #define _GRAPHICS_CONSOLE_H\r | |
| 25 | \r | |
| 97a079ed | 26 | #include <PiDxe.h>\r |
| 8e5b17b2 | 27 | #include <Protocol/FrameworkHii.h>\r |
| 97a079ed A |
28 | #include <Protocol/SimpleTextOut.h>\r |
| 29 | #include <Protocol/GraphicsOutput.h>\r | |
| 30 | #include <Protocol/UgaDraw.h>\r | |
| 31 | #include <Protocol/DevicePath.h>\r | |
| 32 | #include <Library/DebugLib.h>\r | |
| 33 | #include <Library/UefiDriverEntryPoint.h>\r | |
| 34 | #include <Library/UefiLib.h>\r | |
| 8e5b17b2 | 35 | #include <Library/FrameworkHiiLib.h>\r |
| 97a079ed A |
36 | #include <Library/BaseMemoryLib.h>\r |
| 37 | #include <Library/MemoryAllocationLib.h>\r | |
| 38 | #include <Library/UefiBootServicesTableLib.h>\r | |
| 39 | \r | |
| 40 | \r | |
| 5bca971e | 41 | extern EFI_COMPONENT_NAME_PROTOCOL gGraphicsConsoleComponentName;\r |
| 42 | extern EFI_COMPONENT_NAME2_PROTOCOL gGraphicsConsoleComponentName2;\r | |
| 95276127 | 43 | \r |
| 44 | //\r | |
| 97a079ed | 45 | // EFI Component Name Functions\r |
| 95276127 | 46 | //\r |
| 5bca971e | 47 | /**\r |
| 48 | Retrieves a Unicode string that is the user readable name of the driver.\r | |
| 49 | \r | |
| 50 | This function retrieves the user readable name of a driver in the form of a\r | |
| 51 | Unicode string. If the driver specified by This has a user readable name in\r | |
| 52 | the language specified by Language, then a pointer to the driver name is\r | |
| 53 | returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r | |
| 54 | by This does not support the language specified by Language,\r | |
| 55 | then EFI_UNSUPPORTED is returned.\r | |
| 56 | \r | |
| 57 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
| 58 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
| 59 | \r | |
| 60 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
| 61 | array indicating the language. This is the\r | |
| 62 | language of the driver name that the caller is\r | |
| 63 | requesting, and it must match one of the\r | |
| 64 | languages specified in SupportedLanguages. The\r | |
| 65 | number of languages supported by a driver is up\r | |
| 66 | to the driver writer. Language is specified\r | |
| 67 | in RFC 3066 or ISO 639-2 language code format.\r | |
| 68 | \r | |
| 69 | @param DriverName[out] A pointer to the Unicode string to return.\r | |
| 70 | This Unicode string is the name of the\r | |
| 71 | driver specified by This in the language\r | |
| 72 | specified by Language.\r | |
| 73 | \r | |
| 74 | @retval EFI_SUCCESS The Unicode string for the Driver specified by\r | |
| 75 | This and the language specified by Language was\r | |
| 76 | returned in DriverName.\r | |
| 77 | \r | |
| 78 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
| 79 | \r | |
| 80 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
| 81 | \r | |
| 82 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
| 83 | the language specified by Language.\r | |
| 84 | \r | |
| 85 | **/\r | |
| 97a079ed A |
86 | EFI_STATUS\r |
| 87 | EFIAPI\r | |
| 88 | GraphicsConsoleComponentNameGetDriverName (\r | |
| 89 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
| 90 | IN CHAR8 *Language,\r | |
| 91 | OUT CHAR16 **DriverName\r | |
| 92 | );\r | |
| 93 | \r | |
| 5bca971e | 94 | \r |
| 95 | /**\r | |
| 96 | Retrieves a Unicode string that is the user readable name of the controller\r | |
| 97 | that is being managed by a driver.\r | |
| 98 | \r | |
| 99 | This function retrieves the user readable name of the controller specified by\r | |
| 100 | ControllerHandle and ChildHandle in the form of a Unicode string. If the\r | |
| 101 | driver specified by This has a user readable name in the language specified by\r | |
| 102 | Language, then a pointer to the controller name is returned in ControllerName,\r | |
| 103 | and EFI_SUCCESS is returned. If the driver specified by This is not currently\r | |
| 104 | managing the controller specified by ControllerHandle and ChildHandle,\r | |
| 105 | then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r | |
| 106 | support the language specified by Language, then EFI_UNSUPPORTED is returned.\r | |
| 107 | \r | |
| 108 | @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r | |
| 109 | EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
| 110 | \r | |
| 111 | @param ControllerHandle[in] The handle of a controller that the driver\r | |
| 112 | specified by This is managing. This handle\r | |
| 113 | specifies the controller whose name is to be\r | |
| 114 | returned.\r | |
| 115 | \r | |
| 116 | @param ChildHandle[in] The handle of the child controller to retrieve\r | |
| 117 | the name of. This is an optional parameter that\r | |
| 118 | may be NULL. It will be NULL for device\r | |
| 119 | drivers. It will also be NULL for a bus drivers\r | |
| 120 | that wish to retrieve the name of the bus\r | |
| 121 | controller. It will not be NULL for a bus\r | |
| 122 | driver that wishes to retrieve the name of a\r | |
| 123 | child controller.\r | |
| 124 | \r | |
| 125 | @param Language[in] A pointer to a Null-terminated ASCII string\r | |
| 126 | array indicating the language. This is the\r | |
| 127 | language of the driver name that the caller is\r | |
| 128 | requesting, and it must match one of the\r | |
| 129 | languages specified in SupportedLanguages. The\r | |
| 130 | number of languages supported by a driver is up\r | |
| 131 | to the driver writer. Language is specified in\r | |
| 132 | RFC 3066 or ISO 639-2 language code format.\r | |
| 133 | \r | |
| 134 | @param ControllerName[out] A pointer to the Unicode string to return.\r | |
| 135 | This Unicode string is the name of the\r | |
| 136 | controller specified by ControllerHandle and\r | |
| 137 | ChildHandle in the language specified by\r | |
| 138 | Language from the point of view of the driver\r | |
| 139 | specified by This.\r | |
| 140 | \r | |
| 141 | @retval EFI_SUCCESS The Unicode string for the user readable name in\r | |
| 142 | the language specified by Language for the\r | |
| 143 | driver specified by This was returned in\r | |
| 144 | DriverName.\r | |
| 145 | \r | |
| 146 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r | |
| 147 | \r | |
| 148 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
| 149 | EFI_HANDLE.\r | |
| 150 | \r | |
| 151 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
| 152 | \r | |
| 153 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
| 154 | \r | |
| 155 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
| 156 | managing the controller specified by\r | |
| 157 | ControllerHandle and ChildHandle.\r | |
| 158 | \r | |
| 159 | @retval EFI_UNSUPPORTED The driver specified by This does not support\r | |
| 160 | the language specified by Language.\r | |
| 161 | \r | |
| 162 | **/\r | |
| 97a079ed A |
163 | EFI_STATUS\r |
| 164 | EFIAPI\r | |
| 165 | GraphicsConsoleComponentNameGetControllerName (\r | |
| 166 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
| 167 | IN EFI_HANDLE ControllerHandle,\r | |
| 168 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
| 169 | IN CHAR8 *Language,\r | |
| 170 | OUT CHAR16 **ControllerName\r | |
| 171 | );\r | |
| 95276127 | 172 | \r |
| 5bca971e | 173 | \r |
| 95276127 | 174 | //\r |
| 175 | // Glyph database\r | |
| 176 | //\r | |
| 177 | #define GLYPH_WIDTH 8\r | |
| 178 | #define GLYPH_HEIGHT 19\r | |
| 179 | \r | |
| 180 | typedef union {\r | |
| 181 | EFI_NARROW_GLYPH NarrowGlyph;\r | |
| 182 | EFI_WIDE_GLYPH WideGlyph;\r | |
| 183 | } GLYPH_UNION;\r | |
| 184 | \r | |
| 5bca971e | 185 | extern EFI_NARROW_GLYPH UsStdNarrowGlyphData[];\r |
| 186 | extern EFI_WIDE_GLYPH UsStdWideGlyphData[];\r | |
| 95276127 | 187 | \r |
| 188 | //\r | |
| 189 | // Device Structure\r | |
| 190 | //\r | |
| 191 | #define GRAPHICS_CONSOLE_DEV_SIGNATURE EFI_SIGNATURE_32 ('g', 's', 't', 'o')\r | |
| 192 | \r | |
| 193 | typedef struct {\r | |
| 194 | UINTN Columns;\r | |
| 195 | UINTN Rows;\r | |
| 196 | INTN DeltaX;\r | |
| 197 | INTN DeltaY;\r | |
| 198 | UINT32 GopWidth;\r | |
| 199 | UINT32 GopHeight;\r | |
| 200 | UINT32 GopModeNumber;\r | |
| 201 | } GRAPHICS_CONSOLE_MODE_DATA;\r | |
| 202 | \r | |
| 203 | #define GRAPHICS_MAX_MODE 3\r | |
| 204 | \r | |
| 205 | typedef struct {\r | |
| 206 | UINTN Signature;\r | |
| 207 | EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r | |
| 208 | EFI_UGA_DRAW_PROTOCOL *UgaDraw;\r | |
| 209 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOutput;\r | |
| 210 | EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode;\r | |
| 211 | GRAPHICS_CONSOLE_MODE_DATA ModeData[GRAPHICS_MAX_MODE];\r | |
| 212 | EFI_GRAPHICS_OUTPUT_BLT_PIXEL *LineBuffer;\r | |
| 213 | EFI_HII_HANDLE HiiHandle;\r | |
| 214 | } GRAPHICS_CONSOLE_DEV;\r | |
| 215 | \r | |
| 216 | #define GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS(a) \\r | |
| 217 | CR (a, GRAPHICS_CONSOLE_DEV, SimpleTextOutput, GRAPHICS_CONSOLE_DEV_SIGNATURE)\r | |
| 218 | \r | |
| 219 | //\r | |
| 220 | // Global Variables\r | |
| 221 | //\r | |
| 5bca971e | 222 | extern EFI_DRIVER_BINDING_PROTOCOL gGraphicsConsoleDriverBinding;\r |
| 95276127 | 223 | \r |
| 224 | //\r | |
| 225 | // Prototypes\r | |
| 226 | //\r | |
| 227 | UINTN\r | |
| 228 | ReturnNarrowFontSize (\r | |
| 229 | VOID\r | |
| 230 | );\r | |
| 231 | \r | |
| 232 | UINTN\r | |
| 233 | ReturnWideFontSize (\r | |
| 234 | VOID\r | |
| 235 | );\r | |
| 236 | \r | |
| 237 | EFI_STATUS\r | |
| 238 | EFIAPI\r | |
| 239 | GraphicsConsoleConOutReset (\r | |
| 240 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
| 241 | IN BOOLEAN ExtendedVerification\r | |
| 242 | );\r | |
| 243 | \r | |
| 244 | EFI_STATUS\r | |
| 245 | EFIAPI\r | |
| 246 | GraphicsConsoleConOutOutputString (\r | |
| 247 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
| 248 | IN CHAR16 *WString\r | |
| 249 | );\r | |
| 250 | \r | |
| 251 | EFI_STATUS\r | |
| 252 | EFIAPI\r | |
| 253 | GraphicsConsoleConOutTestString (\r | |
| 254 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
| 255 | IN CHAR16 *WString\r | |
| 256 | );\r | |
| 257 | \r | |
| 258 | EFI_STATUS\r | |
| 259 | EFIAPI\r | |
| 260 | GraphicsConsoleConOutQueryMode (\r | |
| 261 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
| 262 | IN UINTN ModeNumber,\r | |
| 263 | OUT UINTN *Columns,\r | |
| 264 | OUT UINTN *Rows\r | |
| 265 | );\r | |
| 266 | \r | |
| 267 | EFI_STATUS\r | |
| 268 | EFIAPI\r | |
| 269 | GraphicsConsoleConOutSetMode (\r | |
| 270 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
| 271 | IN UINTN ModeNumber\r | |
| 272 | );\r | |
| 273 | \r | |
| 274 | EFI_STATUS\r | |
| 275 | EFIAPI\r | |
| 276 | GraphicsConsoleConOutSetAttribute (\r | |
| 277 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
| 278 | IN UINTN Attribute\r | |
| 279 | );\r | |
| 280 | \r | |
| 281 | EFI_STATUS\r | |
| 282 | EFIAPI\r | |
| 283 | GraphicsConsoleConOutClearScreen (\r | |
| 284 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r | |
| 285 | );\r | |
| 286 | \r | |
| 287 | EFI_STATUS\r | |
| 288 | EFIAPI\r | |
| 289 | GraphicsConsoleConOutSetCursorPosition (\r | |
| 290 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
| 291 | IN UINTN Column,\r | |
| 292 | IN UINTN Row\r | |
| 293 | );\r | |
| 294 | \r | |
| 295 | EFI_STATUS\r | |
| 296 | EFIAPI\r | |
| 297 | GraphicsConsoleConOutEnableCursor (\r | |
| 298 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r | |
| 299 | IN BOOLEAN Visible\r | |
| 300 | );\r | |
| 301 | \r | |
| 302 | EFI_STATUS\r | |
| 303 | EfiLocateHiiProtocol (\r | |
| 304 | VOID\r | |
| 305 | );\r | |
| 306 | \r | |
| 307 | EFI_STATUS\r | |
| 308 | EFIAPI\r | |
| 309 | GraphicsConsoleControllerDriverSupported (\r | |
| 310 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 311 | IN EFI_HANDLE Controller,\r | |
| 312 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
| 313 | );\r | |
| 314 | \r | |
| 315 | EFI_STATUS\r | |
| 316 | EFIAPI\r | |
| 317 | GraphicsConsoleControllerDriverStart (\r | |
| 318 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 319 | IN EFI_HANDLE Controller,\r | |
| 320 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
| 321 | );\r | |
| 322 | \r | |
| 323 | EFI_STATUS\r | |
| 324 | EFIAPI\r | |
| 325 | GraphicsConsoleControllerDriverStop (\r | |
| 326 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 327 | IN EFI_HANDLE Controller,\r | |
| 328 | IN UINTN NumberOfChildren,\r | |
| 329 | IN EFI_HANDLE *ChildHandleBuffer\r | |
| 330 | );\r | |
| 331 | \r | |
| 332 | #endif\r |