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