EdkModulePkg/Bus/Pci/IdeBus/Dxe/DriverConfiguration.c

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