Code scrub for VgaMiniPortDxe.
authorxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 19 Jun 2009 08:26:33 +0000 (08:26 +0000)
committerxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 19 Jun 2009 08:26:33 +0000 (08:26 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8608 6f19259b-4bc3-4df7-8a09-765794883524

IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/ComponentName.c
IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.c
IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.h
IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPortDxe.inf

index 36f3fd138c6e5612c98ffc305b26c832707f1191..c5d3cdd4cd62b766e4b984ee2957cda6f4946744 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
-  Implementation of EFI_COMPONENT_NAME_PROTOCOL for VgaminiPort driver.\r
+  Implements EFI Component Name Protocol for VGA Mini Port Driver.\r
   \r
-Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved\r
+Copyright (c) 2006 - 2009 Intel Corporation. All rights reserved\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
@@ -14,135 +14,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "VgaMiniPort.h"\r
 \r
-//\r
-// EFI Component Name Functions\r
-//\r
-/**\r
-  Retrieves a Unicode string that is the user readable name of the driver.\r
-\r
-  This function retrieves the user readable name of a driver in the form of a\r
-  Unicode string. If the driver specified by This has a user readable name in\r
-  the language specified by Language, then a pointer to the driver name is\r
-  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
-  by This does not support the language specified by Language,\r
-  then EFI_UNSUPPORTED is returned.\r
-\r
-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
-                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
-\r
-  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
-                                array indicating the language. This is the\r
-                                language of the driver name that the caller is\r
-                                requesting, and it must match one of the\r
-                                languages specified in SupportedLanguages. The\r
-                                number of languages supported by a driver is up\r
-                                to the driver writer. Language is specified\r
-                                in RFC 4646 or ISO 639-2 language code format.\r
-\r
-  @param  DriverName[out]       A pointer to the Unicode string to return.\r
-                                This Unicode string is the name of the\r
-                                driver specified by This in the language\r
-                                specified by Language.\r
-\r
-  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
-                                This and the language specified by Language was\r
-                                returned in DriverName.\r
-\r
-  @retval EFI_INVALID_PARAMETER Language is NULL.\r
-\r
-  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
-\r
-  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
-                                the language specified by Language.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-PciVgaMiniPortComponentNameGetDriverName (\r
-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
-  IN  CHAR8                        *Language,\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
-\r
-  This function retrieves the user readable name of the controller specified by\r
-  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
-  driver specified by This has a user readable name in the language specified by\r
-  Language, then a pointer to the controller name is returned in ControllerName,\r
-  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
-  managing the controller specified by ControllerHandle and ChildHandle,\r
-  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
-  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
-\r
-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
-                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
-\r
-  @param  ControllerHandle[in]  The handle of a controller that the driver\r
-                                specified by This is managing.  This handle\r
-                                specifies the controller whose name is to be\r
-                                returned.\r
-\r
-  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
-                                the name of.  This is an optional parameter that\r
-                                may be NULL.  It will be NULL for device\r
-                                drivers.  It will also be NULL for a bus drivers\r
-                                that wish to retrieve the name of the bus\r
-                                controller.  It will not be NULL for a bus\r
-                                driver that wishes to retrieve the name of a\r
-                                child controller.\r
-\r
-  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
-                                array indicating the language.  This is the\r
-                                language of the driver name that the caller is\r
-                                requesting, and it must match one of the\r
-                                languages specified in SupportedLanguages. The\r
-                                number of languages supported by a driver is up\r
-                                to the driver writer. Language is specified in\r
-                                RFC 4646 or ISO 639-2 language code format.\r
-\r
-  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
-                                This Unicode string is the name of the\r
-                                controller specified by ControllerHandle and\r
-                                ChildHandle in the language specified by\r
-                                Language from the point of view of the driver\r
-                                specified by This.\r
-\r
-  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
-                                the language specified by Language for the\r
-                                driver specified by This was returned in\r
-                                DriverName.\r
-\r
-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
-\r
-  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
-                                EFI_HANDLE.\r
-\r
-  @retval EFI_INVALID_PARAMETER Language is NULL.\r
-\r
-  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
-\r
-  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
-                                managing the controller specified by\r
-                                ControllerHandle and ChildHandle.\r
-\r
-  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
-                                the language specified by Language.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-PciVgaMiniPortComponentNameGetControllerName (\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
 // EFI Component Name Protocol\r
@@ -184,10 +55,9 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mPciVgaMiniPortDriverName
   by This does not support the language specified by Language,\r
   then EFI_UNSUPPORTED is returned.\r
 \r
-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+  @param  This                  A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                 EFI_COMPONENT_NAME_PROTOCOL instance.\r
-\r
-  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
+  @param  Language              A pointer to a Null-terminated ASCII string\r
                                 array indicating the language. This is the\r
                                 language of the driver name that the caller is\r
                                 requesting, and it must match one of the\r
@@ -195,8 +65,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mPciVgaMiniPortDriverName
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified\r
                                 in RFC 4646 or ISO 639-2 language code format.\r
-\r
-  @param  DriverName[out]       A pointer to the Unicode string to return.\r
+  @param  DriverName            A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
                                 driver specified by This in the language\r
                                 specified by Language.\r
@@ -204,11 +73,8 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mPciVgaMiniPortDriverName
   @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
                                 This and the language specified by Language was\r
                                 returned in DriverName.\r
-\r
   @retval EFI_INVALID_PARAMETER Language is NULL.\r
-\r
   @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
-\r
   @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                 the language specified by Language.\r
 \r
@@ -243,15 +109,13 @@ PciVgaMiniPortComponentNameGetDriverName (
   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
   support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
 \r
-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+  @param  This                  A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                 EFI_COMPONENT_NAME_PROTOCOL instance.\r
-\r
-  @param  ControllerHandle[in]  The handle of a controller that the driver\r
+  @param  ControllerHandle      The handle of a controller that the driver\r
                                 specified by This is managing.  This handle\r
                                 specifies the controller whose name is to be\r
                                 returned.\r
-\r
-  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
+  @param  ChildHandle           The handle of the child controller to retrieve\r
                                 the name of.  This is an optional parameter that\r
                                 may be NULL.  It will be NULL for device\r
                                 drivers.  It will also be NULL for a bus drivers\r
@@ -259,8 +123,7 @@ PciVgaMiniPortComponentNameGetDriverName (
                                 controller.  It will not be NULL for a bus\r
                                 driver that wishes to retrieve the name of a\r
                                 child controller.\r
-\r
-  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
+  @param  Language              A pointer to a Null-terminated ASCII string\r
                                 array indicating the language.  This is the\r
                                 language of the driver name that the caller is\r
                                 requesting, and it must match one of the\r
@@ -268,8 +131,7 @@ PciVgaMiniPortComponentNameGetDriverName (
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified in\r
                                 RFC 4646 or ISO 639-2 language code format.\r
-\r
-  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
+  @param  ControllerName        A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
                                 controller specified by ControllerHandle and\r
                                 ChildHandle in the language specified by\r
@@ -280,20 +142,14 @@ PciVgaMiniPortComponentNameGetDriverName (
                                 the language specified by Language for the\r
                                 driver specified by This was returned in\r
                                 DriverName.\r
-\r
   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
-\r
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                 EFI_HANDLE.\r
-\r
   @retval EFI_INVALID_PARAMETER Language is NULL.\r
-\r
   @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
-\r
   @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                 managing the controller specified by\r
                                 ControllerHandle and ChildHandle.\r
-\r
   @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                 the language specified by Language.\r
 \r
index b0963a45f8134e53a45d2c52cfdae6c797ffed41..ef39d2a7eedacb53539c415636ef98945c19d578 100644 (file)
@@ -1,6 +1,7 @@
 /** @file\r
+  Implements EFI Driver Binding Protocol and VGA Mini Port Protocol for VGA Mini Port Driver.\r
 \r
-Copyright (c) 2006 Intel Corporation. All rights reserved\r
+Copyright (c) 2006 - 2009 Intel Corporation. All rights reserved\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
@@ -34,12 +35,16 @@ EFI_DRIVER_BINDING_PROTOCOL gPciVgaMiniPortDriverBinding = {
 };\r
 \r
 /**\r
-  Driver entry point for VgaMiniPort driver.\r
-  \r
-  @param ImageHandle  Driver image handle.\r
-  @param SystemTable  Point to EFI_SYSTEM_TABLE.\r
-  \r
-  @retval Status of install driver binding protocol.\r
+  Entrypoint of VGA Mini Port Driver.\r
+\r
+  This function is the entrypoint of UVGA Mini Port Driver. It installs Driver Binding\r
+  Protocols together with Component Name Protocols.\r
+\r
+  @param  ImageHandle       The firmware allocated handle for the EFI image.\r
+  @param  SystemTable       A pointer to the EFI System Table.\r
+\r
+  @retval EFI_SUCCESS       The entry point is executed successfully.\r
+\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -48,21 +53,24 @@ PciVgaMiniPortDriverEntryPoint (
   IN EFI_SYSTEM_TABLE   *SystemTable\r
   )\r
 {\r
-  return EfiLibInstallDriverBindingComponentName2 (\r
-           ImageHandle,\r
-           SystemTable,\r
-           &gPciVgaMiniPortDriverBinding,\r
-           ImageHandle,\r
-           &gPciVgaMiniPortComponentName,\r
-           &gPciVgaMiniPortComponentName2\r
-           );\r
+  EFI_STATUS              Status;\r
+\r
+  Status = EfiLibInstallDriverBindingComponentName2 (\r
+             ImageHandle,\r
+             SystemTable,\r
+             &gPciVgaMiniPortDriverBinding,\r
+             ImageHandle,\r
+             &gPciVgaMiniPortComponentName,\r
+             &gPciVgaMiniPortComponentName2\r
+             );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  return EFI_SUCCESS;\r
 }\r
 \r
 \r
 /**\r
-  Supported.\r
-\r
-  (Standard DriverBinding Protocol Supported() function)\r
+  Check whether VGA Mini Port driver supports this device.\r
 \r
   @param  This                   The driver binding protocol.\r
   @param  Controller             The controller handle to check.\r
@@ -124,20 +132,21 @@ PciVgaMiniPortDriverBindingSupported (
 \r
 Done:\r
   gBS->CloseProtocol (\r
-        Controller,\r
-        &gEfiPciIoProtocolGuid,\r
-        This->DriverBindingHandle,\r
-        Controller\r
-        );\r
+         Controller,\r
+         &gEfiPciIoProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         Controller\r
+         );\r
 \r
   return Status;\r
 }\r
 \r
 \r
 /**\r
-  Install VGA Mini Port Protocol onto VGA device handles\r
+  Starts the VGA device with this driver.\r
 \r
-  (Standard DriverBinding Protocol Start() function)\r
+  This function consumes PCI I/O Protocol, and installs VGA Mini Port Protocol\r
+  onto the VGA device handle.\r
 \r
   @param  This                   The driver binding instance.\r
   @param  Controller             The controller to check.\r
@@ -179,16 +188,8 @@ PciVgaMiniPortDriverBindingStart (
   //\r
   // Allocate the private device structure\r
   //\r
-  Status = gBS->AllocatePool (\r
-                  EfiBootServicesData,\r
-                  sizeof (PCI_VGA_MINI_PORT_DEV),\r
-                  (VOID **) &PciVgaMiniPortPrivate\r
-                  );\r
-  if (EFI_ERROR (Status)) {\r
-    goto Done;\r
-  }\r
-\r
-  ZeroMem (PciVgaMiniPortPrivate, sizeof (PCI_VGA_MINI_PORT_DEV));\r
+  PciVgaMiniPortPrivate = AllocateZeroPool (sizeof (PCI_VGA_MINI_PORT_DEV));\r
+  ASSERT (PciVgaMiniPortPrivate != NULL);\r
 \r
   //\r
   // Initialize the private device structure\r
@@ -207,7 +208,7 @@ PciVgaMiniPortDriverBindingStart (
   PciVgaMiniPortPrivate->VgaMiniPort.MaxMode = 1;\r
 \r
   //\r
-  // Install Vga Mini Port Protocol\r
+  // Install VGA Mini Port Protocol\r
   //\r
   Status = gBS->InstallMultipleProtocolInterfaces (\r
                   &Controller,\r
@@ -218,13 +219,13 @@ PciVgaMiniPortDriverBindingStart (
 Done:\r
   if (EFI_ERROR (Status)) {\r
     gBS->CloseProtocol (\r
-          Controller,\r
-          &gEfiPciIoProtocolGuid,\r
-          This->DriverBindingHandle,\r
-          Controller\r
-          );\r
+           Controller,\r
+           &gEfiPciIoProtocolGuid,\r
+           This->DriverBindingHandle,\r
+           Controller\r
+           );\r
     if (PciVgaMiniPortPrivate != NULL) {\r
-      gBS->FreePool (PciVgaMiniPortPrivate);\r
+      FreePool (PciVgaMiniPortPrivate);\r
     }\r
   }\r
 \r
@@ -233,9 +234,10 @@ Done:
 \r
 \r
 /**\r
-  Stop.\r
+  Stop the VGA device with this driver.\r
 \r
-  (Standard DriverBinding Protocol Stop() function)\r
+  This function uninstalls VGA Mini Port Protocol from the VGA device handle,\r
+  and closes PCI I/O Protocol.\r
 \r
   @param  This                   The driver binding protocol.\r
   @param  Controller             The controller to release.\r
@@ -284,13 +286,13 @@ PciVgaMiniPortDriverBindingStop (
   }\r
 \r
   gBS->CloseProtocol (\r
-        Controller,\r
-        &gEfiPciIoProtocolGuid,\r
-        This->DriverBindingHandle,\r
-        Controller\r
-        );\r
+         Controller,\r
+         &gEfiPciIoProtocolGuid,\r
+         This->DriverBindingHandle,\r
+         Controller\r
+         );\r
 \r
-  gBS->FreePool (PciVgaMiniPortPrivate);\r
+  FreePool (PciVgaMiniPortPrivate);\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -299,14 +301,19 @@ PciVgaMiniPortDriverBindingStop (
 //\r
 \r
 /**\r
-  Thunk function of EFI_VGA_MINI_PORT_SET_MODE.\r
-\r
-  @param  This             Point to instance of EFI_VGA_MINI_PORT_PROTOCOL.\r
-  @param  ModeNumber       Mode number.\r
+  Sets the text display mode of a VGA controller.\r
 \r
-  @retval EFI_UNSUPPORTED  Invalid mode number.\r
-  @retval EFI_SUCCESS      Success.\r
+  This function implements EFI_VGA_MINI_PORT_PROTOCOL.SetMode().\r
+  If ModeNumber exceeds the valid range, then EFI_UNSUPPORTED is returned.\r
+  Otherwise, EFI_SUCCESS is directly returned without real operation.\r
+  \r
+  @param This                 Protocol instance pointer.\r
+  @param ModeNumber           Mode number.  0 - 80x25   1-80x50\r
 \r
+  @retval EFI_SUCCESS         The mode was set\r
+  @retval EFI_UNSUPPORTED     ModeNumber is not supported.\r
+  @retval EFI_DEVICE_ERROR    The device is not functioning properly.\r
+  \r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
index ef5b8a4c9c6dbc5993d8390a97908d2a05241049..34174173fa306791feedb7162adab12ca84043a4 100644 (file)
@@ -1,6 +1,7 @@
 /** @file\r
+  Internal include file for VGA Mini Port Driver.\r
 \r
-Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved\r
+Copyright (c) 2006 - 2009 Intel Corporation. All rights reserved\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
@@ -34,6 +35,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/UefiDriverEntryPoint.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
 \r
 #include <IndustryStandard/Pci22.h>\r
 \r
@@ -62,9 +64,7 @@ typedef struct {
 // Driver Binding Protocol functions\r
 //\r
 /**\r
-  Supported.\r
-\r
-  (Standard DriverBinding Protocol Supported() function)\r
+  Check whether VGA Mini Port driver supports this device.\r
 \r
   @param  This                   The driver binding protocol.\r
   @param  Controller             The controller handle to check.\r
@@ -83,9 +83,10 @@ PciVgaMiniPortDriverBindingSupported (
   );\r
 \r
 /**\r
-  Install VGA Mini Port Protocol onto VGA device handles\r
+  Starts the VGA device with this driver.\r
 \r
-  (Standard DriverBinding Protocol Start() function)\r
+  This function consumes PCI I/O Protocol, and installs VGA Mini Port Protocol\r
+  onto the VGA device handle.\r
 \r
   @param  This                   The driver binding instance.\r
   @param  Controller             The controller to check.\r
@@ -105,9 +106,10 @@ PciVgaMiniPortDriverBindingStart (
   );\r
 \r
 /**\r
-  Stop.\r
+  Stop the VGA device with this driver.\r
 \r
-  (Standard DriverBinding Protocol Stop() function)\r
+  This function uninstalls VGA Mini Port Protocol from the VGA device handle,\r
+  and closes PCI I/O Protocol.\r
 \r
   @param  This                   The driver binding protocol.\r
   @param  Controller             The controller to release.\r
@@ -129,17 +131,135 @@ PciVgaMiniPortDriverBindingStop (
   );\r
 \r
 //\r
-// VGA Mini Port Protocol functions\r
+// EFI Component Name Functions\r
 //\r
 /**\r
-  Thunk function of EFI_VGA_MINI_PORT_SET_MODE.\r
+  Retrieves a Unicode string that is the user readable name of the driver.\r
+\r
+  This function retrieves the user readable name of a driver in the form of a\r
+  Unicode string. If the driver specified by This has a user readable name in\r
+  the language specified by Language, then a pointer to the driver name is\r
+  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
+  by This does not support the language specified by Language,\r
+  then EFI_UNSUPPORTED is returned.\r
+\r
+  @param  This                  A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
+  @param  Language              A pointer to a Null-terminated ASCII string\r
+                                array indicating the language. This is the\r
+                                language of the driver name that the caller is\r
+                                requesting, and it must match one of the\r
+                                languages specified in SupportedLanguages. The\r
+                                number of languages supported by a driver is up\r
+                                to the driver writer. Language is specified\r
+                                in RFC 4646 or ISO 639-2 language code format.\r
+  @param  DriverName            A pointer to the Unicode string to return.\r
+                                This Unicode string is the name of the\r
+                                driver specified by This in the language\r
+                                specified by Language.\r
+\r
+  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
+                                This and the language specified by Language was\r
+                                returned in DriverName.\r
+  @retval EFI_INVALID_PARAMETER Language is NULL.\r
+  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
+                                the language specified by Language.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PciVgaMiniPortComponentNameGetDriverName (\r
+  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
+  IN  CHAR8                        *Language,\r
+  OUT CHAR16                       **DriverName\r
+  );\r
 \r
-  @param  This             Point to instance of EFI_VGA_MINI_PORT_PROTOCOL.\r
-  @param  ModeNumber       Mode number.\r
+/**\r
+  Retrieves a Unicode string that is the user readable name of the controller\r
+  that is being managed by a driver.\r
+\r
+  This function retrieves the user readable name of the controller specified by\r
+  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
+  driver specified by This has a user readable name in the language specified by\r
+  Language, then a pointer to the controller name is returned in ControllerName,\r
+  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
+  managing the controller specified by ControllerHandle and ChildHandle,\r
+  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
+  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
+\r
+  @param  This                  A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
+  @param  ControllerHandle      The handle of a controller that the driver\r
+                                specified by This is managing.  This handle\r
+                                specifies the controller whose name is to be\r
+                                returned.\r
+  @param  ChildHandle           The handle of the child controller to retrieve\r
+                                the name of.  This is an optional parameter that\r
+                                may be NULL.  It will be NULL for device\r
+                                drivers.  It will also be NULL for a bus drivers\r
+                                that wish to retrieve the name of the bus\r
+                                controller.  It will not be NULL for a bus\r
+                                driver that wishes to retrieve the name of a\r
+                                child controller.\r
+  @param  Language              A pointer to a Null-terminated ASCII string\r
+                                array indicating the language.  This is the\r
+                                language of the driver name that the caller is\r
+                                requesting, and it must match one of the\r
+                                languages specified in SupportedLanguages. The\r
+                                number of languages supported by a driver is up\r
+                                to the driver writer. Language is specified in\r
+                                RFC 4646 or ISO 639-2 language code format.\r
+  @param  ControllerName        A pointer to the Unicode string to return.\r
+                                This Unicode string is the name of the\r
+                                controller specified by ControllerHandle and\r
+                                ChildHandle in the language specified by\r
+                                Language from the point of view of the driver\r
+                                specified by This.\r
+\r
+  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
+                                the language specified by Language for the\r
+                                driver specified by This was returned in\r
+                                DriverName.\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
+                                EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER Language is NULL.\r
+  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
+  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
+                                managing the controller specified by\r
+                                ControllerHandle and ChildHandle.\r
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
+                                the language specified by Language.\r
 \r
-  @retval EFI_UNSUPPORTED  Invalid mode number.\r
-  @retval EFI_SUCCESS      Success.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PciVgaMiniPortComponentNameGetControllerName (\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
+// VGA Mini Port Protocol functions\r
+//\r
+/**\r
+  Sets the text display mode of a VGA controller.\r
+\r
+  This function implements EFI_VGA_MINI_PORT_PROTOCOL.SetMode().\r
+  If ModeNumber exceeds the valid range, then EFI_UNSUPPORTED is returned.\r
+  Otherwise, EFI_SUCCESS is directly returned without real operation.\r
+  \r
+  @param This                 Protocol instance pointer.\r
+  @param ModeNumber           Mode number.  0 - 80x25   1-80x50\r
+\r
+  @retval EFI_SUCCESS         The mode was set\r
+  @retval EFI_UNSUPPORTED     ModeNumber is not supported.\r
+  @retval EFI_DEVICE_ERROR    The device is not functioning properly.\r
+  \r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
index b9ca57e6be8b7fe7aa451ff9e7565681f77bb2b4..994b6cd01bd068526057c2d976df9ba39e4f74ca 100644 (file)
@@ -1,8 +1,5 @@
 #/** @file\r
-# Component name for module VgaMiniPort\r
-#\r
-# FIX ME!\r
-# Copyright (c) 2006 - 2009, Intel Corporation.\r
+# VGA Mini Port Driver that manages VGA device and produces VGA Mini Port Protocol.\r
 #\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
@@ -21,7 +18,6 @@
   FILE_GUID                      = 15C5E761-58D8-461a-9173-CAB020916264\r
   MODULE_TYPE                    = UEFI_DRIVER\r
   VERSION_STRING                 = 1.0\r
-  EFI_SPECIFICATION_VERSION      = 0x00020000\r
   ENTRY_POINT                    = PciVgaMiniPortDriverEntryPoint\r
 \r
 #\r
   VgaMiniPort.c\r
   VgaMiniPort.h\r
 \r
-\r
 [Packages]\r
   MdePkg/MdePkg.dec\r
-  MdeModulePkg/MdeModulePkg.dec\r
-  IntelFrameworkPkg/IntelFrameworkPkg.dec\r
   IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec\r
 \r
-\r
 [LibraryClasses]\r
   UefiLib\r
+  DebugLib\r
   UefiBootServicesTableLib\r
   UefiDriverEntryPoint\r
   BaseMemoryLib\r
-\r
+  MemoryAllocationLib\r
 \r
 [Protocols]\r
-  gEfiPciIoProtocolGuid                         # PROTOCOL ALWAYS_CONSUMED\r
-  gEfiComponentName2ProtocolGuid\r
-  gEfiVgaMiniPortProtocolGuid\r
+  gEfiPciIoProtocolGuid                         ## TO_START\r
+  gEfiVgaMiniPortProtocolGuid                   ## BY_START\r
 \r
 \r