EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Functions | Variables

ShellPkg/Library/UefiShellDriver1CommandsLib/DrvCfg.c File Reference

#include "UefiShellDriver1CommandsLib.h"
#include <Protocol/HiiConfigAccess.h>
#include <Protocol/HiiDatabase.h>

Go to the source code of this file.

Functions

EFI_STATUS EFIAPI FindHiiHandleViaDevPath (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevPath1, OUT EFI_HII_HANDLE *HiiHandle, IN EFI_HII_DATABASE_PROTOCOL *HiiDb)
EFI_STATUS EFIAPI ConvertHandleToHiiHandle (IN CONST EFI_HANDLE Handle, OUT EFI_HII_HANDLE *HiiHandle, IN EFI_HII_DATABASE_PROTOCOL *HiiDb)
SHELL_STATUS EFIAPI ConfigToFile (IN CONST EFI_HANDLE Handle, IN CONST CHAR16 *FileName)
SHELL_STATUS EFIAPI ConfigFromFile (IN EFI_HANDLE Handle, IN CONST CHAR16 *FileName)
EFI_STATUS EFIAPI ShellCmdDriverConfigurationProcessActionRequired (EFI_HANDLE DriverImageHandle, EFI_HANDLE ControllerHandle, EFI_HANDLE ChildHandle, EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED ActionRequired)
SHELL_STATUS EFIAPI PreHiiDrvCfg (IN CONST CHAR8 *Language, IN BOOLEAN ForceDefaults, IN UINT32 DefaultType, IN BOOLEAN AllChildren, IN BOOLEAN ValidateOptions, IN BOOLEAN SetOptions, IN EFI_HANDLE DriverImageHandle, IN EFI_HANDLE DeviceHandle, IN EFI_HANDLE ChildHandle)
SHELL_STATUS EFIAPI PrintConfigInfoOnAll (IN CONST BOOLEAN ChildrenToo, IN CONST CHAR8 *Language, IN CONST BOOLEAN UseHii)
SHELL_STATUS EFIAPI ShellCommandRunDrvCfg (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables

STATIC CONST EFI_GUIDCfgGuidList [] = {&gEfiDriverConfigurationProtocolGuid, &gEfiDriverConfiguration2ProtocolGuid, NULL}
STATIC CONST SHELL_PARAM_ITEM ParamListHii []
STATIC CONST SHELL_PARAM_ITEM ParamListPreHii []

Detailed Description

Main file for DrvCfg shell Driver1 function.

Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file DrvCfg.c.


Function Documentation

SHELL_STATUS EFIAPI ConfigFromFile ( IN EFI_HANDLE  Handle,
IN CONST CHAR16 FileName 
)

Function to read in HII configuration information from a file.

Parameters:
[in]HandleThe handle to get info for.
[in]FileNameThe filename to read the info from.

Definition at line 261 of file DrvCfg.c.

SHELL_STATUS EFIAPI ConfigToFile ( IN CONST EFI_HANDLE  Handle,
IN CONST CHAR16 FileName 
)

Function to print out all HII configuration information to a file.

Parameters:
[in]HandleThe handle to get info on. NULL to do all handles.
[in]FileNameThe filename to rwite the info to.

Definition at line 155 of file DrvCfg.c.

EFI_STATUS EFIAPI ConvertHandleToHiiHandle ( IN CONST EFI_HANDLE  Handle,
OUT EFI_HII_HANDLE HiiHandle,
IN EFI_HII_DATABASE_PROTOCOL HiiDb 
)

Convert a EFI_HANDLE to a EFI_HII_HANDLE.

Parameters:
[in]HandleThe EFI_HANDLE to convert.
[out]HiiHandleThe EFI_HII_HANDLE after the converstion.
[in]HiiDbThe Hii database protocol
Return values:
EFI_SUCCESSThe operation was successful.

Definition at line 120 of file DrvCfg.c.

EFI_STATUS EFIAPI FindHiiHandleViaDevPath ( IN CONST EFI_DEVICE_PATH_PROTOCOL DevPath1,
OUT EFI_HII_HANDLE HiiHandle,
IN EFI_HII_DATABASE_PROTOCOL HiiDb 
)

Find the EFI_HII_HANDLE by device path.

Parameters:
[in]DevPath1The Device Path to match.
[out]HiiHandleThe EFI_HII_HANDLE after the converstion.
[in]HiiDbThe Hii database protocol
Return values:
EFI_SUCCESSThe operation was successful.
EFI_NOT_FOUNDThere was no EFI_HII_HANDLE found for that deviec path.

Definition at line 33 of file DrvCfg.c.

SHELL_STATUS EFIAPI PreHiiDrvCfg ( IN CONST CHAR8 Language,
IN BOOLEAN  ForceDefaults,
IN UINT32  DefaultType,
IN BOOLEAN  AllChildren,
IN BOOLEAN  ValidateOptions,
IN BOOLEAN  SetOptions,
IN EFI_HANDLE  DriverImageHandle,
IN EFI_HANDLE  DeviceHandle,
IN EFI_HANDLE  ChildHandle 
)

Do the configuration in an environment without HII.

Parameters:
[in]LanguageThe language code.
[in]ForceDefaultsTRUE to force defaults, FALSE otherwise.
[in]DefaultTypeIf ForceDefaults is TRUE, specifies the default type.
[in]AllChildrenTRUE to configure all children, FALSE otherwise.
[in]ValidateOptionsTRUE to validate existing options, FALSE otherwise.
[in]SetOptionsTRUE to set options, FALSE otherwise.
[in]DriverImageHandleThe handle for the driver to configure.
[in]DeviceHandleThe handle of the device being managed by the Driver specified.
[in]ChildHandleThe handle of a child device of the specified device.
Return values:
SHELL_NOT_FOUNDA specified handle could not be found.
SHELL_INVALID_PARAMETERA parameter has a invalid value.

Definition at line 541 of file DrvCfg.c.

SHELL_STATUS EFIAPI PrintConfigInfoOnAll ( IN CONST BOOLEAN  ChildrenToo,
IN CONST CHAR8 Language,
IN CONST BOOLEAN  UseHii 
)

Function to print out configuration information on all configurable handles.

Parameters:
[in]ChildrenTooTRUE to tewst for children.
[in]LanguageASCII string for language code.
[in]UseHiiTRUE to check for Hii and DPC, FALSE for DCP only.
Return values:
SHELL_SUCCESSThe operation was successful.

Definition at line 1048 of file DrvCfg.c.

EFI_STATUS EFIAPI ShellCmdDriverConfigurationProcessActionRequired ( EFI_HANDLE  DriverImageHandle,
EFI_HANDLE  ControllerHandle,
EFI_HANDLE  ChildHandle,
EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED  ActionRequired 
)

Present a requested action to the user.

Parameters:
[in]DriverImageHandleThe handle for the driver to configure.
[in]ControllerHandleThe handle of the device being managed by the Driver specified.
[in]ChildHandleThe handle of a child device of the specified device.
[in]ActionRequiredThe required HII action.
Return values:
SHELL_INVALID_PARAMETERA parameter has a invalid value.

Definition at line 472 of file DrvCfg.c.

SHELL_STATUS EFIAPI ShellCommandRunDrvCfg ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function for 'drvcfg' command.

Parameters:
[in]ImageHandleHandle to the Image (NULL if Internal).
[in]SystemTablePointer to the System Table (NULL if Internal).

Definition at line 1130 of file DrvCfg.c.


Variable Documentation

Definition at line 19 of file DrvCfg.c.

Initial value:
 {
  {L"-s", TypeFlag},
  {L"-l", TypeValue},
  {L"-f", TypeValue},
  {L"-o", TypeValue},
  {L"-i", TypeValue},
  {NULL, TypeMax}
  }

Definition at line 1105 of file DrvCfg.c.

Initial value:
 {
  {L"-c", TypeFlag},
  {L"-s", TypeFlag},
  {L"-v", TypeFlag},
  {L"-l", TypeValue},
  {L"-f", TypeValue},
  {NULL, TypeMax}
  }

Definition at line 1113 of file DrvCfg.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines