IntelFrameworkModulePkg: Clean up source files
1. Do not use tab characters 2. No trailing white space in one line 3. All files must end with CRLF Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
/** @file
|
||||
Header file for IDE Bus Driver.
|
||||
|
||||
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
||||
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
|
||||
@@ -181,7 +181,7 @@ IDEBusDriverBindingStop (
|
||||
// EFI Driver Configuration Functions
|
||||
//
|
||||
/**
|
||||
Allows the user to set controller specific options for a controller that a
|
||||
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.
|
||||
@@ -192,26 +192,26 @@ IDEBusDriverBindingStop (
|
||||
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
|
||||
@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
|
||||
@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
|
||||
|
||||
@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 ActionRequired is NULL.
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support setting configuration options for
|
||||
@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
|
||||
@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
|
||||
@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
|
||||
@@ -228,20 +228,20 @@ 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
|
||||
@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
|
||||
@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
|
||||
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
|
||||
@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
|
||||
@@ -260,31 +260,31 @@ IDEBusDriverConfigurationOptionsValid (
|
||||
|
||||
@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
|
||||
@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
|
||||
@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
|
||||
@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 ActionRequired is NULL.
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support forcing the default
|
||||
@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
|
||||
@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
|
||||
@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
|
||||
@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
|
||||
@@ -308,24 +308,24 @@ IDEBusDriverConfigurationForceDefaults (
|
||||
@param ChildHandle The handle of the child controller to run diagnostics 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 run diagnostics on the bus controller.
|
||||
It will not be NULL for a bus driver that wishes to run
|
||||
bus drivers that wish to run diagnostics on the bus controller.
|
||||
It will not be NULL for a bus driver that wishes to run
|
||||
diagnostics on one of its child controllers.
|
||||
@param DiagnosticType Indicates type of diagnostics to perform on the controller
|
||||
specified by ControllerHandle and ChildHandle.
|
||||
@param Language A pointer to a three character ISO 639-2 language identifier.
|
||||
This is the language in which the optional error message should
|
||||
be returned in Buffer, and it must match one of the languages
|
||||
@param Language A pointer to a three character ISO 639-2 language identifier.
|
||||
This is the language in which the optional error message should
|
||||
be returned in Buffer, 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 ErrorType A GUID that defines the format of the data returned in Buffer.
|
||||
@param BufferSize The size, in bytes, of the data returned in Buffer.
|
||||
@param Buffer A buffer that contains a Null-terminated Unicode string
|
||||
plus some additional data whose format is defined by ErrorType.
|
||||
Buffer is allocated by this function with AllocatePool(), and
|
||||
plus some additional data whose format is defined by ErrorType.
|
||||
Buffer is allocated by this function with AllocatePool(), and
|
||||
it is the caller's responsibility to free it with a call to FreePool().
|
||||
|
||||
@retval EFI_SUCCESS The controller specified by ControllerHandle and ChildHandle passed
|
||||
@retval EFI_SUCCESS The controller specified by ControllerHandle and ChildHandle passed
|
||||
the diagnostic.
|
||||
@retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
|
||||
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
|
||||
@@ -333,18 +333,18 @@ IDEBusDriverConfigurationForceDefaults (
|
||||
@retval EFI_INVALID_PARAMETER ErrorType is NULL.
|
||||
@retval EFI_INVALID_PARAMETER BufferType is NULL.
|
||||
@retval EFI_INVALID_PARAMETER Buffer is NULL.
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support running
|
||||
diagnostics for the controller specified by ControllerHandle
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support running
|
||||
diagnostics for the controller specified by ControllerHandle
|
||||
and ChildHandle.
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support the
|
||||
type of diagnostic specified by DiagnosticType.
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support the language
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support the language
|
||||
specified by Language.
|
||||
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to complete the
|
||||
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to complete the
|
||||
diagnostics.
|
||||
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to return the
|
||||
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to return the
|
||||
status information in ErrorType, BufferSize,and Buffer.
|
||||
@retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and ChildHandle
|
||||
@retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and ChildHandle
|
||||
did not pass the diagnostic.
|
||||
**/
|
||||
EFI_STATUS
|
||||
@@ -427,7 +427,7 @@ IDEBlkIoWriteBlocks (
|
||||
/**
|
||||
Flushes all modified data to a physical block devices
|
||||
|
||||
@param This Indicates a pointer to the calling context which to sepcify a
|
||||
@param This Indicates a pointer to the calling context which to sepcify a
|
||||
sepcific block device
|
||||
|
||||
@retval EFI_SUCCESS Always return success.
|
||||
@@ -438,7 +438,7 @@ IDEBlkIoFlushBlocks (
|
||||
IN EFI_BLOCK_IO_PROTOCOL *This
|
||||
);
|
||||
/**
|
||||
This function is used by the IDE bus driver to get inquiry data.
|
||||
This function is used by the IDE bus driver to get inquiry data.
|
||||
Data format of Identify data is defined by the Interface GUID.
|
||||
|
||||
@param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
|
||||
@@ -446,9 +446,9 @@ IDEBlkIoFlushBlocks (
|
||||
@param InquiryDataSize Pointer to the value for the inquiry data size.
|
||||
|
||||
@retval EFI_SUCCESS The command was accepted without any errors.
|
||||
@retval EFI_NOT_FOUND Device does not support this data class
|
||||
@retval EFI_DEVICE_ERROR Error reading InquiryData from device
|
||||
@retval EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough
|
||||
@retval EFI_NOT_FOUND Device does not support this data class
|
||||
@retval EFI_DEVICE_ERROR Error reading InquiryData from device
|
||||
@retval EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
@@ -460,7 +460,7 @@ IDEDiskInfoInquiry (
|
||||
);
|
||||
|
||||
/**
|
||||
This function is used by the IDE bus driver to get identify data.
|
||||
This function is used by the IDE bus driver to get identify data.
|
||||
Data format of Identify data is defined by the Interface GUID.
|
||||
|
||||
@param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
|
||||
@@ -468,9 +468,9 @@ IDEDiskInfoInquiry (
|
||||
@param IdentifyDataSize Pointer to the value for the identify data size.
|
||||
|
||||
@retval EFI_SUCCESS The command was accepted without any errors.
|
||||
@retval EFI_NOT_FOUND Device does not support this data class
|
||||
@retval EFI_DEVICE_ERROR Error reading IdentifyData from device
|
||||
@retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough
|
||||
@retval EFI_NOT_FOUND Device does not support this data class
|
||||
@retval EFI_DEVICE_ERROR Error reading IdentifyData from device
|
||||
@retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
@@ -482,18 +482,18 @@ IDEDiskInfoIdentify (
|
||||
);
|
||||
|
||||
/**
|
||||
This function is used by the IDE bus driver to get sense data.
|
||||
This function is used by the IDE bus driver to get sense data.
|
||||
Data format of Sense data is defined by the Interface GUID.
|
||||
|
||||
@param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
|
||||
@param SenseData Pointer to the SenseData.
|
||||
@param SenseDataSize Size of SenseData in bytes.
|
||||
@param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
|
||||
@param SenseData Pointer to the SenseData.
|
||||
@param SenseDataSize Size of SenseData in bytes.
|
||||
@param SenseDataNumber Pointer to the value for the identify data size.
|
||||
|
||||
@retval EFI_SUCCESS The command was accepted without any errors.
|
||||
@retval EFI_NOT_FOUND Device does not support this data class
|
||||
@retval EFI_DEVICE_ERROR Error reading InquiryData from device
|
||||
@retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough
|
||||
@retval EFI_NOT_FOUND Device does not support this data class
|
||||
@retval EFI_DEVICE_ERROR Error reading InquiryData from device
|
||||
@retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
@@ -508,12 +508,12 @@ IDEDiskInfoSenseData (
|
||||
/**
|
||||
This function is used by the IDE bus driver to get controller information.
|
||||
|
||||
@param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
|
||||
@param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
|
||||
@param IdeChannel Pointer to the Ide Channel number. Primary or secondary.
|
||||
@param IdeDevice Pointer to the Ide Device number. Master or slave.
|
||||
|
||||
@retval EFI_SUCCESS IdeChannel and IdeDevice are valid
|
||||
@retval EFI_UNSUPPORTED This is not an IDE device
|
||||
@retval EFI_SUCCESS IdeChannel and IdeDevice are valid
|
||||
@retval EFI_UNSUPPORTED This is not an IDE device
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
@@ -524,7 +524,7 @@ IDEDiskInfoWhichIde (
|
||||
OUT UINT32 *IdeDevice
|
||||
);
|
||||
/**
|
||||
The is an event(generally the event is exitBootService event) call back function.
|
||||
The is an event(generally the event is exitBootService event) call back function.
|
||||
Clear pending IDE interrupt before OS loader/kernel take control of the IDE device.
|
||||
|
||||
@param Event Pointer to this event
|
||||
|
Reference in New Issue
Block a user