]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Bus/Isa/IsaFloppyDxe/ComponentName.c
Isa Floppy driver code scrub.
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / IsaFloppyDxe / ComponentName.c
index a02e3683d3f7c280bdcff62de632de65137bde90..624f725ab2bd0efca91388ed838273c3f92904b1 100644 (file)
@@ -1,6 +1,7 @@
-/**@file\r
+/** @file\r
+  UEFI Component Name(2) protocol implementation for Isa Floppy driver.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation.<BR>\r
+Copyright (c) 2006 - 2009, Intel Corporation. <BR>\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
@@ -53,10 +54,9 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIsaFloppyDriverNameTable
   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[in]  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[in]  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
@@ -64,23 +64,18 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIsaFloppyDriverNameTable
                                 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[out]  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
 \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
@@ -112,15 +107,13 @@ IsaFloppyComponentNameGetDriverName (
   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[in]  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[in]  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[in]  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
@@ -128,8 +121,7 @@ IsaFloppyComponentNameGetDriverName (
                                 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[in]  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
@@ -137,8 +129,7 @@ IsaFloppyComponentNameGetDriverName (
                                 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[out]  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
@@ -149,72 +140,55 @@ IsaFloppyComponentNameGetDriverName (
                                 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
 IsaFloppyComponentNameGetControllerName (\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
-  EFI_STATUS                            Status;\r
-  EFI_BLOCK_IO_PROTOCOL                 *BlkIo;\r
-  FDC_BLK_IO_DEV                        *FdcDev;\r
-  EFI_ISA_IO_PROTOCOL                   *IsaIoProtocol;\r
+  EFI_STATUS             Status;\r
+  EFI_BLOCK_IO_PROTOCOL  *BlkIo;\r
+  FDC_BLK_IO_DEV         *FdcDev;\r
 \r
+  if (Language == NULL || ControllerName == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
   //\r
   // This is a device driver, so ChildHandle must be NULL.\r
   //\r
   if (ChildHandle != NULL) {\r
     return EFI_UNSUPPORTED;\r
   }\r
+\r
   //\r
-  // Check Controller's handle\r
+  // Check if this driver is currently managing ControllerHandle\r
   //\r
-  Status = gBS->OpenProtocol (\r
-                  ControllerHandle,\r
-                  &gEfiIsaIoProtocolGuid,\r
-                  (VOID **) &IsaIoProtocol,\r
-                  gFdcControllerDriver.DriverBindingHandle,\r
-                  ControllerHandle,\r
-                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
-                  );\r
-  if (!EFI_ERROR (Status)) {\r
-    gBS->CloseProtocol (\r
-           ControllerHandle,\r
-           &gEfiIsaIoProtocolGuid,\r
-           gFdcControllerDriver.DriverBindingHandle,\r
-           ControllerHandle\r
-           );\r
-\r
-    return EFI_UNSUPPORTED;\r
+  Status = EfiTestManagedDevice (\r
+             ControllerHandle,\r
+             gFdcControllerDriver.DriverBindingHandle,\r
+             &gEfiIsaIoProtocolGuid\r
+             );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
   }\r
 \r
-  if (Status != EFI_ALREADY_STARTED) {\r
-    return EFI_UNSUPPORTED;\r
-  }\r
   //\r
-  // Get the Block I/O Protocol on Controller\r
+  // Get the device context\r
   //\r
   Status = gBS->OpenProtocol (\r
                   ControllerHandle,\r
@@ -227,9 +201,7 @@ IsaFloppyComponentNameGetControllerName (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
-  //\r
-  // Get the Floppy Disk Controller's Device structure\r
-  //\r
+\r
   FdcDev = FDD_BLK_IO_FROM_THIS (BlkIo);\r
 \r
   return LookupUnicodeString2 (\r
@@ -244,33 +216,34 @@ IsaFloppyComponentNameGetControllerName (
 /**\r
   Add the component name for the floppy device\r
 \r
-  @param  FdcDev                 - A pointer to the FDC_BLK_IO_DEV instance.\r
+  @param[in]  FdcDev  A pointer to the FDC_BLK_IO_DEV instance.\r
 \r
 **/\r
 VOID\r
 AddName (\r
-  IN  FDC_BLK_IO_DEV         *FdcDev\r
+  IN  FDC_BLK_IO_DEV  *FdcDev\r
   )\r
-\r
 {\r
-  CHAR16  FloppyDriveName[FLOPPY_DRIVE_NAME_ASCII_LEN + 1];\r
-\r
-  StrCpy (FloppyDriveName, FLOPPY_DRIVE_NAME);\r
-  FloppyDriveName[FLOPPY_DRIVE_NAME_ASCII_LEN - 1] = (CHAR16) (L'0' + FdcDev->Disk);\r
-  AddUnicodeString2 (\r
-    "eng",\r
-    gIsaFloppyComponentName.SupportedLanguages,\r
-    &FdcDev->ControllerNameTable,\r
-    FloppyDriveName,\r
-    TRUE\r
-    );\r
-  AddUnicodeString2 (\r
-    "en",\r
-    gIsaFloppyComponentName2.SupportedLanguages,\r
-    &FdcDev->ControllerNameTable,\r
-    FloppyDriveName,\r
-    FALSE\r
-    );\r
-\r
+  CHAR16  FloppyDriveName[FLOPPY_DRIVE_NAME_LEN + 1];\r
+\r
+  if (!(FeaturePcdGet(PcdComponentNameDisable) && FeaturePcdGet(PcdComponentName2Disable))) {\r
+    StrCpy (FloppyDriveName, FLOPPY_DRIVE_NAME);\r
+    FloppyDriveName[FLOPPY_DRIVE_NAME_LEN - 1] = (CHAR16) (L'0' + FdcDev->Disk);\r
+\r
+    AddUnicodeString2 (\r
+      "eng",\r
+      gIsaFloppyComponentName.SupportedLanguages,\r
+      &FdcDev->ControllerNameTable,\r
+      FloppyDriveName,\r
+      TRUE\r
+      );\r
+    AddUnicodeString2 (\r
+      "en",\r
+      gIsaFloppyComponentName2.SupportedLanguages,\r
+      &FdcDev->ControllerNameTable,\r
+      FloppyDriveName,\r
+      FALSE\r
+      );\r
+  }\r
 }\r
 \r