Code scrub for IdeBusDxe driver

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8636 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jchen20
2009-06-24 02:21:05 +00:00
parent 4e97801cfa
commit 630d580d53
10 changed files with 3109 additions and 4023 deletions

View File

@@ -1,4 +1,7 @@
/** @file
Implementation of UEFI Driver Configuration Protocol for IDE bus driver which
provides ability to set IDE bus controller specific options.
Copyright (c) 2006 - 2008, 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
@@ -31,11 +34,11 @@ EFI_DRIVER_CONFIGURATION_PROTOCOL gIDEBusDriverConfiguration = {
};
/**
TODO: Add function description
Interprete keyboard input.
@retval EFI_ABORTED TODO: Add description for return value.
@retval EFI_SUCCESS TODO: Add description for return value.
@retval EFI_NOT_FOUND TODO: Add description for return value.
@retval EFI_ABORTED Get an 'ESC' key inputed.
@retval EFI_SUCCESS Get an 'Y' or 'y' inputed.
@retval EFI_NOT_FOUND Get an 'N' or 'n' inputed..
**/
EFI_STATUS
@@ -80,46 +83,35 @@ GetResponse (
Allows the user to set controller specific options for a controller that a
driver is currently managing.
@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
instance.
@param ControllerHandle The handle of the controller to set options on.
@param ChildHandle The handle of the child controller to set options on.
This is an optional parameter that may be NULL.
It will be NULL for device drivers, and for a bus drivers
that wish to set options for the bus controller.
It will not be NULL for a bus driver that wishes to set
options for one of its child controllers.
@param Language A pointer to a three character ISO 639-2 language
identifier. This is the language of the user interface
that should be presented to the user, and it must match
one of the languages specified in SupportedLanguages.
The number of languages supported by a driver is up to
the driver writer.
@param ActionRequired A pointer to the action that the calling agent is
required to perform when this function returns.
See "Related Definitions" for a list of the actions that
the calling agent is required to perform prior to
accessing ControllerHandle again.
@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.
@param ControllerHandle The handle of the controller to set options on.
@param ChildHandle The handle of the child controller to set options on.
This is an optional parameter that may be NULL.
It will be NULL for device drivers, and for a bus drivers
that wish to set options for the bus controller.
It will not be NULL for a bus driver that wishes to set
options for one of its child controllers.
@param Language A pointer to a three character ISO 639-2 language identifier.
This is the language of the user interface that should be presented
to the user, and it must match one of the languages specified in
SupportedLanguages. The number of languages supported by a driver is up to
the driver writer.
@param ActionRequired A pointer to the action that the calling agent is required
to perform when this function returns.
@retval EFI_SUCCESS The driver specified by This successfully set the
configuration options for the controller specified
by ControllerHandle..
@retval EFI_SUCCESS The driver specified by This successfully set the configuration
options for the controller specified by ControllerHandle..
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a
valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ActionRequired is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
setting configuration options for the controller
specified by ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support the
language specified by Language.
@retval EFI_DEVICE_ERROR A device error occurred while attempt to set the
configuration options for the controller specified
by ControllerHandle and ChildHandle.
@retval EFI_OUT_RESOURCES There are not enough resources available to set the
configuration options for the controller specified
by ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support setting configuration options for
the controller specified by ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support the language specified by Language.
@retval EFI_DEVICE_ERROR A device error occurred while attempt to set the configuration options for the
controller specified by ControllerHandle and ChildHandle.
@retval EFI_OUT_RESOURCES There are not enough resources available to set the configuration options for the
controller specified by ControllerHandle and ChildHandle
**/
EFI_STATUS
EFIAPI
@@ -189,35 +181,25 @@ IDEBusDriverConfigurationSetOptions (
/**
Tests to see if a controller's current configuration options are valid.
@param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL
instance.
@param ControllerHandle The handle of the controller to test if it's current
configuration options are valid.
@param ChildHandle The handle of the child controller to test if it's
current
configuration options are valid. This is an optional
parameter that may be NULL. It will be NULL for device
drivers. It will also be NULL for a bus drivers that
wish to test the configuration options for the bus
controller. It will not be NULL for a bus driver that
wishes to test configuration options for one of
its child controllers.
@retval EFI_SUCCESS The controller specified by ControllerHandle and
ChildHandle that is being managed by the driver
specified by This has a valid set of configuration
options.
@param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.
@param ControllerHandle The handle of the controller to test if it's current configuration options
are valid.
@param ChildHandle The handle of the child controller to test if it's current configuration
options are valid. This is an optional parameter that may be NULL. It will
be NULL for device drivers. It will also be NULL for a bus drivers that
wish to test the configuration options for the bus controller. It will
not be NULL for a bus driver that wishes to test configuration options for
one of its child controllers.
@retval EFI_SUCCESS The controller specified by ControllerHandle and ChildHandle that is being
managed by the driver specified by This has a valid set of configuration
options.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
EFI_HANDLE.
@retval EFI_UNSUPPORTED The driver specified by This is not currently
managing the controller specified by
ControllerHandle and ChildHandle.
@retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and
ChildHandle that is being managed by the driver
specified by This has an invalid set of
configuration options.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
@retval EFI_UNSUPPORTED The driver specified by This is not currently managing the controller
specified by ControllerHandle and ChildHandle.
@retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and ChildHandle that is being
managed by the driver specified by This has an invalid set of configuration
options.
**/
EFI_STATUS
EFIAPI
@@ -249,51 +231,37 @@ IDEBusDriverConfigurationOptionsValid (
return EFI_SUCCESS;
}
/**
Forces a driver to set the default configuration options for a controller.
@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL
instance.
@param ControllerHandle The handle of the controller to force default
configuration options on.
@param ChildHandle The handle of the child controller to force default
configuration options on This is an optional parameter
that may be NULL. It will be NULL for device drivers.
It will also be NULL for a bus drivers that wish to
force default configuration options for the bus
controller. It will not be NULL for a bus driver that
wishes to force default configuration options for one
of its child controllers.
@param DefaultType The type of default configuration options to force on
the controller specified by ControllerHandle and
ChildHandle. See Table 9-1 for legal values.
A DefaultType of 0x00000000 must be supported
by this protocol.
@param ActionRequired A pointer to the action that the calling agent
is required to perform when this function returns.
@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.
@param ControllerHandle The handle of the controller to force default configuration options on.
@param ChildHandle The handle of the child controller to force default configuration
options on This is an optional parameter that may be NULL. It
will be NULL for device drivers. It will also be NULL for a bus
drivers that wish to force default configuration options for the bus
controller. It will not be NULL for a bus driver that wishes to force
default configuration options for one of its child controllers.
@param DefaultType The type of default configuration options to force on the controller
specified by ControllerHandle and ChildHandle.
@param ActionRequired A pointer to the action that the calling agent is required to perform
when this function returns.
@retval EFI_SUCCESS The driver specified by This successfully forced
the default configuration options on the
controller specified by ControllerHandle and
ChildHandle.
@retval EFI_SUCCESS The driver specified by This successfully forced the
default configuration options on the controller specified by
ControllerHandle and ChildHandle.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a
valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ActionRequired is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
forcing the default configuration options on
the controller specified by ControllerHandle
and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the configuration type specified by DefaultType.
@retval EFI_DEVICE_ERROR A device error occurred while attempt to force
the default configuration options on the controller
specified by ControllerHandle and ChildHandle.
@retval EFI_OUT_RESOURCES There are not enough resources available to force
the default configuration options on the controller
specified by ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support forcing the default
configuration options on the controller specified by ControllerHandle
and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support the configuration type
specified by DefaultType.
@retval EFI_DEVICE_ERROR A device error occurred while attempt to force the default configuration
options on the controller specified by ControllerHandle and ChildHandle.
@retval EFI_OUT_RESOURCES There are not enough resources available to force the default configuration
options on the controller specified by ControllerHandle and ChildHandle.
**/
EFI_STATUS
EFIAPI