IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/DriverConfiguration.c

   1 /** @file
   2   Copyright (c) 2006 - 2008, Intel Corporation
   3   All rights reserved. This program and the accompanying materials
   4   are licensed and made available under the terms and conditions of the BSD License
   5   which accompanies this distribution.  The full text of the license may be found at
   6   http://opensource.org/licenses/bsd-license.php
   7
   8   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   9   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  10
  11 **/
  12
  13
  14 #include "IdeBus.h"
  15
  16 CHAR16 *OptionString[4] = {
  17   L"Enable Primary Master    (Y/N)? -->",
  18   L"Enable Primary Slave     (Y/N)? -->",
  19   L"Enable Secondary Master  (Y/N)? -->",
  20   L"Enable Secondary Slave   (Y/N)? -->"
  21 };
  22
  23 //
  24 // EFI Driver Configuration Protocol
  25 //
  26 EFI_DRIVER_CONFIGURATION_PROTOCOL gIDEBusDriverConfiguration = {
  27   IDEBusDriverConfigurationSetOptions,
  28   IDEBusDriverConfigurationOptionsValid,
  29   IDEBusDriverConfigurationForceDefaults,
  30   "eng"
  31 };
  32
  33 /**
  34   TODO: Add function description
  35
  36   @retval  EFI_ABORTED TODO: Add description for return value.
  37   @retval  EFI_SUCCESS TODO: Add description for return value.
  38   @retval  EFI_NOT_FOUND TODO: Add description for return value.
  39
  40 **/
  41 EFI_STATUS
  42 GetResponse (
  43   VOID
  44   )
  45 {
  46   EFI_STATUS    Status;
  47   EFI_INPUT_KEY Key;
  48
  49   while (TRUE) {
  50     Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
  51     if (!EFI_ERROR (Status)) {
  52       if (Key.ScanCode == SCAN_ESC) {
  53         return EFI_ABORTED;
  54       }
  55
  56       switch (Key.UnicodeChar) {
  57
  58       //
  59       // fall through
  60       //
  61       case L'y':
  62       case L'Y':
  63         gST->ConOut->OutputString (gST->ConOut, L"Y\n");
  64         return EFI_SUCCESS;
  65
  66       //
  67       // fall through
  68       //
  69       case L'n':
  70       case L'N':
  71         gST->ConOut->OutputString (gST->ConOut, L"N\n");
  72         return EFI_NOT_FOUND;
  73       }
  74
  75     }
  76   }
  77 }
  78
  79 /**
  80   Allows the user to set controller specific options for a controller that a
  81   driver is currently managing.
  82
  83   @param  This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
  84   instance.
  85   @param  ControllerHandle The handle of the controller to set options on.
  86   @param  ChildHandle The handle of the child controller to set options on.
  87   This is an optional parameter that may be NULL.
  88   It will be NULL for device drivers, and for a bus drivers
  89   that wish to set options for the bus controller.
  90   It will not be NULL for a bus driver that wishes to set
  91   options for one of its child controllers.
  92   @param  Language A pointer to a three character ISO 639-2 language
  93   identifier. This is the language of the user interface
  94   that should be presented to the user, and it must match
  95   one of the languages specified in SupportedLanguages.
  96   The number of languages supported by a driver is up to
  97   the driver writer.
  98   @param  ActionRequired A pointer to the action that the calling agent is
  99   required to perform when this function returns.
 100   See "Related Definitions" for a list of the actions that
 101   the calling agent is required to perform prior to
 102   accessing ControllerHandle again.
 103
 104   @retval  EFI_SUCCESS The driver specified by This successfully set the
 105   configuration options for the controller specified
 106   by ControllerHandle..
 107   @retval  EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 108   @retval  EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a
 109   valid EFI_HANDLE.
 110   @retval  EFI_INVALID_PARAMETER ActionRequired is NULL.
 111   @retval  EFI_UNSUPPORTED The driver specified by This does not support
 112   setting configuration options for the controller
 113   specified by ControllerHandle and ChildHandle.
 114   @retval  EFI_UNSUPPORTED The driver specified by This does not support the
 115   language specified by Language.
 116   @retval  EFI_DEVICE_ERROR A device error occurred while attempt to set the
 117   configuration options for the controller specified
 118   by ControllerHandle and ChildHandle.
 119   @retval  EFI_OUT_RESOURCES There are not enough resources available to set the
 120   configuration options for the controller specified
 121   by ControllerHandle and ChildHandle.
 122
 123 **/
 124 EFI_STATUS
 125 EFIAPI
 126 IDEBusDriverConfigurationSetOptions (
 127   IN  EFI_DRIVER_CONFIGURATION_PROTOCOL                      *This,
 128   IN  EFI_HANDLE                                             ControllerHandle,
 129   IN  EFI_HANDLE                                             ChildHandle  OPTIONAL,
 130   IN  CHAR8                                                  *Language,
 131   OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED               *ActionRequired
 132   )
 133 {
 134   EFI_STATUS  Status;
 135   UINT8       Value;
 136   UINT8       NewValue;
 137   UINTN       DataSize;
 138   UINTN       Index;
 139
 140   if (ChildHandle != NULL) {
 141     return EFI_UNSUPPORTED;
 142   }
 143
 144   *ActionRequired = EfiDriverConfigurationActionNone;
 145
 146   DataSize        = sizeof (Value);
 147   Status = gRT->GetVariable (
 148                   L"Configuration",
 149                   &gEfiCallerIdGuid,
 150                   NULL,
 151                   &DataSize,
 152                   &Value
 153                   );
 154
 155   gST->ConOut->OutputString (gST->ConOut, L"IDE Bus Driver Configuration\n");
 156   gST->ConOut->OutputString (gST->ConOut, L"===============================\n");
 157
 158   NewValue = 0;
 159   for (Index = 0; Index < 4; Index++) {
 160     gST->ConOut->OutputString (gST->ConOut, OptionString[Index]);
 161
 162     Status = GetResponse ();
 163     if (Status == EFI_ABORTED) {
 164       return EFI_SUCCESS;
 165     }
 166
 167     if (!EFI_ERROR (Status)) {
 168       NewValue = (UINT8) (NewValue | (1 << Index));
 169     }
 170   }
 171
 172   if (EFI_ERROR (Status) || (NewValue != Value)) {
 173     gRT->SetVariable (
 174           L"Configuration",
 175           &gEfiCallerIdGuid,
 176           EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
 177           sizeof (NewValue),
 178           &NewValue
 179           );
 180
 181     *ActionRequired = EfiDriverConfigurationActionRestartController;
 182   } else {
 183     *ActionRequired = EfiDriverConfigurationActionNone;
 184   }
 185
 186   return EFI_SUCCESS;
 187 }
 188
 189 /**
 190   Tests to see if a controller's current configuration options are valid.
 191
 192   @param  This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL
 193   instance.
 194   @param  ControllerHandle The handle of the controller to test if it's current
 195   configuration options are valid.
 196   @param  ChildHandle The handle of the child controller to test if it's
 197   current
 198   configuration options are valid.  This is an optional
 199   parameter that may be NULL.  It will be NULL for device
 200   drivers.  It will also be NULL for a bus drivers that
 201   wish to test the configuration options for the bus
 202   controller. It will not be NULL for a bus driver that
 203   wishes to test configuration options for one of
 204   its child controllers.
 205
 206   @retval  EFI_SUCCESS The controller specified by ControllerHandle and
 207   ChildHandle that is being managed by the driver
 208   specified by This has a valid set of  configuration
 209   options.
 210   @retval  EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 211   @retval  EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 212   EFI_HANDLE.
 213   @retval  EFI_UNSUPPORTED The driver specified by This is not currently
 214   managing the controller specified by
 215   ControllerHandle and ChildHandle.
 216   @retval  EFI_DEVICE_ERROR The controller specified by ControllerHandle and
 217   ChildHandle that is being managed by the driver
 218   specified by This has an invalid set of
 219   configuration options.
 220
 221 **/
 222 EFI_STATUS
 223 EFIAPI
 224 IDEBusDriverConfigurationOptionsValid (
 225   IN  EFI_DRIVER_CONFIGURATION_PROTOCOL               *This,
 226   IN  EFI_HANDLE                                      ControllerHandle,
 227   IN  EFI_HANDLE                                      ChildHandle  OPTIONAL
 228   )
 229 {
 230   EFI_STATUS  Status;
 231   UINT8       Value;
 232   UINTN       DataSize;
 233
 234   if (ChildHandle != NULL) {
 235     return EFI_UNSUPPORTED;
 236   }
 237
 238   DataSize = sizeof (Value);
 239   Status = gRT->GetVariable (
 240                   L"Configuration",
 241                   &gEfiCallerIdGuid,
 242                   NULL,
 243                   &DataSize,
 244                   &Value
 245                   );
 246   if (EFI_ERROR (Status) || Value > 0x0f) {
 247     return EFI_DEVICE_ERROR;
 248   }
 249
 250   return EFI_SUCCESS;
 251 }
 252
 253 /**
 254   Forces a driver to set the default configuration options for a controller.
 255
 256   @param  This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
 257   instance.
 258   @param  ControllerHandle The handle of the controller to force default
 259   configuration options on.
 260   @param  ChildHandle The handle of the child controller to force default
 261   configuration options on  This is an optional parameter
 262   that may be NULL.  It will be NULL for device drivers.
 263   It will also be NULL for a bus drivers that wish to
 264   force default configuration options for the bus
 265   controller.  It will not be NULL for a bus driver that
 266   wishes to force default configuration options for one
 267   of its child controllers.
 268   @param  DefaultType The type of default configuration options to force on
 269   the controller specified by ControllerHandle and
 270   ChildHandle.  See Table 9-1 for legal values.
 271   A DefaultType of 0x00000000 must be supported
 272   by this protocol.
 273   @param  ActionRequired A pointer to the action that the calling agent
 274   is required to perform when this function returns.
 275
 276   @retval  EFI_SUCCESS The driver specified by This successfully forced
 277   the default configuration options on the
 278   controller specified by ControllerHandle and
 279   ChildHandle.
 280   @retval  EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 281   @retval  EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a
 282   valid EFI_HANDLE.
 283   @retval  EFI_INVALID_PARAMETER ActionRequired is NULL.
 284   @retval  EFI_UNSUPPORTED The driver specified by This does not support
 285   forcing the default configuration options on
 286   the controller specified by ControllerHandle
 287   and ChildHandle.
 288   @retval  EFI_UNSUPPORTED The driver specified by This does not support
 289   the configuration type specified by DefaultType.
 290   @retval  EFI_DEVICE_ERROR A device error occurred while attempt to force
 291   the default configuration options on the controller
 292   specified by  ControllerHandle and ChildHandle.
 293   @retval  EFI_OUT_RESOURCES There are not enough resources available to force
 294   the default configuration options on the controller
 295   specified by ControllerHandle and ChildHandle.
 296
 297 **/
 298 EFI_STATUS
 299 EFIAPI
 300 IDEBusDriverConfigurationForceDefaults (
 301   IN  EFI_DRIVER_CONFIGURATION_PROTOCOL                      *This,
 302   IN  EFI_HANDLE                                             ControllerHandle,
 303   IN  EFI_HANDLE                                             ChildHandle  OPTIONAL,
 304   IN  UINT32                                                 DefaultType,
 305   OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED               *ActionRequired
 306   )
 307 {
 308   UINT8 Value;
 309
 310   if (ChildHandle != NULL) {
 311     return EFI_UNSUPPORTED;
 312   }
 313
 314   Value = 0x0f;
 315   gRT->SetVariable (
 316         L"Configuration",
 317         &gEfiCallerIdGuid,
 318         EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
 319         sizeof (Value),
 320         &Value
 321         );
 322   *ActionRequired = EfiDriverConfigurationActionRestartController;
 323   return EFI_SUCCESS;
 324 }