/** @file\r
Header file for IDE Bus Driver.\r
\r
- Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
// EFI Driver Configuration Functions\r
//\r
/**\r
- Allows the user to set controller specific options for a controller that a \r
+ Allows the user to set controller specific options for a controller that a\r
driver is currently managing.\r
\r
@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.\r
that wish to set options for the bus controller.\r
It will not be NULL for a bus driver that wishes to set\r
options for one of its child controllers.\r
- @param Language A pointer to a three character ISO 639-2 language identifier. \r
- This is the language of the user interface that should be presented \r
- to the user, and it must match one of the languages specified in \r
+ @param Language A pointer to a three character ISO 639-2 language identifier.\r
+ This is the language of the user interface that should be presented\r
+ to the user, and it must match one of the languages specified in\r
SupportedLanguages. The number of languages supported by a driver is up to\r
the driver writer.\r
- @param ActionRequired A pointer to the action that the calling agent is required \r
+ @param ActionRequired A pointer to the action that the calling agent is required\r
to perform when this function returns.\r
- \r
\r
- @retval EFI_SUCCESS The driver specified by This successfully set the configuration \r
+\r
+ @retval EFI_SUCCESS The driver specified by This successfully set the configuration\r
options for the controller specified by ControllerHandle..\r
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
@retval EFI_INVALID_PARAMETER ActionRequired is NULL.\r
- @retval EFI_UNSUPPORTED The driver specified by This does not support setting configuration options for \r
+ @retval EFI_UNSUPPORTED The driver specified by This does not support setting configuration options for\r
the controller specified by ControllerHandle and ChildHandle.\r
@retval EFI_UNSUPPORTED The driver specified by This does not support the language specified by Language.\r
- @retval EFI_DEVICE_ERROR A device error occurred while attempt to set the configuration options for the \r
+ @retval EFI_DEVICE_ERROR A device error occurred while attempt to set the configuration options for the\r
controller specified by ControllerHandle and ChildHandle.\r
- @retval EFI_OUT_RESOURCES There are not enough resources available to set the configuration options for the \r
+ @retval EFI_OUT_RESOURCES There are not enough resources available to set the configuration options for the\r
controller specified by ControllerHandle and ChildHandle\r
**/\r
EFI_STATUS\r
Tests to see if a controller's current configuration options are valid.\r
\r
@param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
- @param ControllerHandle The handle of the controller to test if it's current configuration options \r
+ @param ControllerHandle The handle of the controller to test if it's current configuration options\r
are valid.\r
- @param ChildHandle The handle of the child controller to test if it's current configuration \r
- options are valid. This is an optional parameter that may be NULL. It will \r
+ @param ChildHandle The handle of the child controller to test if it's current configuration\r
+ options are valid. This is an optional parameter that may be NULL. It will\r
be NULL for device drivers. It will also be NULL for a bus drivers that\r
- wish to test the configuration options for the bus controller. It will \r
- not be NULL for a bus driver that wishes to test configuration options for \r
+ wish to test the configuration options for the bus controller. It will\r
+ not be NULL for a bus driver that wishes to test configuration options for\r
one of its child controllers.\r
@retval EFI_SUCCESS The controller specified by ControllerHandle and ChildHandle that is being\r
managed by the driver specified by This has a valid set of configuration\r
options.\r
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
- @retval EFI_UNSUPPORTED The driver specified by This is not currently managing the controller \r
+ @retval EFI_UNSUPPORTED The driver specified by This is not currently managing the controller\r
specified by ControllerHandle and ChildHandle.\r
@retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and ChildHandle that is being\r
managed by the driver specified by This has an invalid set of configuration\r
\r
@param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.\r
@param ControllerHandle The handle of the controller to force default configuration options on.\r
- @param ChildHandle The handle of the child controller to force default configuration \r
- options on This is an optional parameter that may be NULL. It \r
- will be NULL for device drivers. It will also be NULL for a bus \r
+ @param ChildHandle The handle of the child controller to force default configuration\r
+ options on This is an optional parameter that may be NULL. It\r
+ will be NULL for device drivers. It will also be NULL for a bus\r
drivers that wish to force default configuration options for the bus\r
controller. It will not be NULL for a bus driver that wishes to force\r
default configuration options for one of its child controllers.\r
- @param DefaultType The type of default configuration options to force on the controller \r
- specified by ControllerHandle and ChildHandle. \r
- @param ActionRequired A pointer to the action that the calling agent is required to perform \r
+ @param DefaultType The type of default configuration options to force on the controller\r
+ specified by ControllerHandle and ChildHandle.\r
+ @param ActionRequired A pointer to the action that the calling agent is required to perform\r
when this function returns.\r
\r
- @retval EFI_SUCCESS The driver specified by This successfully forced the \r
- default configuration options on the controller specified by \r
+ @retval EFI_SUCCESS The driver specified by This successfully forced the\r
+ default configuration options on the controller specified by\r
ControllerHandle and ChildHandle.\r
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
@retval EFI_INVALID_PARAMETER ActionRequired is NULL.\r
- @retval EFI_UNSUPPORTED The driver specified by This does not support forcing the default \r
+ @retval EFI_UNSUPPORTED The driver specified by This does not support forcing the default\r
configuration options on the controller specified by ControllerHandle\r
and ChildHandle.\r
- @retval EFI_UNSUPPORTED The driver specified by This does not support the configuration type \r
+ @retval EFI_UNSUPPORTED The driver specified by This does not support the configuration type\r
specified by DefaultType.\r
- @retval EFI_DEVICE_ERROR A device error occurred while attempt to force the default configuration \r
+ @retval EFI_DEVICE_ERROR A device error occurred while attempt to force the default configuration\r
options on the controller specified by ControllerHandle and ChildHandle.\r
- @retval EFI_OUT_RESOURCES There are not enough resources available to force the default configuration \r
+ @retval EFI_OUT_RESOURCES There are not enough resources available to force the default configuration\r
options on the controller specified by ControllerHandle and ChildHandle.\r
**/\r
EFI_STATUS\r
@param ChildHandle The handle of the child controller to run diagnostics on\r
This is an optional parameter that may be NULL. It will\r
be NULL for device drivers. It will also be NULL for a\r
- bus drivers that wish to run diagnostics on the bus controller. \r
- It will not be NULL for a bus driver that wishes to run \r
+ bus drivers that wish to run diagnostics on the bus controller.\r
+ It will not be NULL for a bus driver that wishes to run\r
diagnostics on one of its child controllers.\r
@param DiagnosticType Indicates type of diagnostics to perform on the controller\r
specified by ControllerHandle and ChildHandle.\r
- @param Language A pointer to a three character ISO 639-2 language identifier. \r
- This is the language in which the optional error message should \r
- be returned in Buffer, and it must match one of the languages \r
+ @param Language A pointer to a three character ISO 639-2 language identifier.\r
+ This is the language in which the optional error message should\r
+ be returned in Buffer, and it must match one of the languages\r
specified in SupportedLanguages. The number of languages supported by\r
a driver is up to the driver writer.\r
@param ErrorType A GUID that defines the format of the data returned in Buffer.\r
@param BufferSize The size, in bytes, of the data returned in Buffer.\r
@param Buffer A buffer that contains a Null-terminated Unicode string\r
- plus some additional data whose format is defined by ErrorType. \r
- Buffer is allocated by this function with AllocatePool(), and \r
+ plus some additional data whose format is defined by ErrorType.\r
+ Buffer is allocated by this function with AllocatePool(), and\r
it is the caller's responsibility to free it with a call to FreePool().\r
\r
- @retval EFI_SUCCESS The controller specified by ControllerHandle and ChildHandle passed \r
+ @retval EFI_SUCCESS The controller specified by ControllerHandle and ChildHandle passed\r
the diagnostic.\r
@retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
@retval EFI_INVALID_PARAMETER ErrorType is NULL.\r
@retval EFI_INVALID_PARAMETER BufferType is NULL.\r
@retval EFI_INVALID_PARAMETER Buffer is NULL.\r
- @retval EFI_UNSUPPORTED The driver specified by This does not support running \r
- diagnostics for the controller specified by ControllerHandle \r
+ @retval EFI_UNSUPPORTED The driver specified by This does not support running\r
+ diagnostics for the controller specified by ControllerHandle\r
and ChildHandle.\r
@retval EFI_UNSUPPORTED The driver specified by This does not support the\r
type of diagnostic specified by DiagnosticType.\r
- @retval EFI_UNSUPPORTED The driver specified by This does not support the language \r
+ @retval EFI_UNSUPPORTED The driver specified by This does not support the language\r
specified by Language.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to complete the \r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to complete the\r
diagnostics.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to return the \r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to return the\r
status information in ErrorType, BufferSize,and Buffer.\r
- @retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and ChildHandle \r
+ @retval EFI_DEVICE_ERROR The controller specified by ControllerHandle and ChildHandle\r
did not pass the diagnostic.\r
**/\r
EFI_STATUS\r
/**\r
Flushes all modified data to a physical block devices\r
\r
- @param This Indicates a pointer to the calling context which to sepcify a \r
+ @param This Indicates a pointer to the calling context which to sepcify a\r
sepcific block device\r
\r
@retval EFI_SUCCESS Always return success.\r
IN EFI_BLOCK_IO_PROTOCOL *This\r
);\r
/**\r
- This function is used by the IDE bus driver to get inquiry data. \r
+ This function is used by the IDE bus driver to get inquiry data.\r
Data format of Identify data is defined by the Interface GUID.\r
\r
@param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
@param InquiryDataSize Pointer to the value for the inquiry data size.\r
\r
@retval EFI_SUCCESS The command was accepted without any errors.\r
- @retval EFI_NOT_FOUND Device does not support this data class \r
- @retval EFI_DEVICE_ERROR Error reading InquiryData from device \r
- @retval EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough \r
+ @retval EFI_NOT_FOUND Device does not support this data class\r
+ @retval EFI_DEVICE_ERROR Error reading InquiryData from device\r
+ @retval EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough\r
\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- This function is used by the IDE bus driver to get identify data. \r
+ This function is used by the IDE bus driver to get identify data.\r
Data format of Identify data is defined by the Interface GUID.\r
\r
@param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
@param IdentifyDataSize Pointer to the value for the identify data size.\r
\r
@retval EFI_SUCCESS The command was accepted without any errors.\r
- @retval EFI_NOT_FOUND Device does not support this data class \r
- @retval EFI_DEVICE_ERROR Error reading IdentifyData from device \r
- @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough \r
+ @retval EFI_NOT_FOUND Device does not support this data class\r
+ @retval EFI_DEVICE_ERROR Error reading IdentifyData from device\r
+ @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough\r
\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- This function is used by the IDE bus driver to get sense data. \r
+ This function is used by the IDE bus driver to get sense data.\r
Data format of Sense data is defined by the Interface GUID.\r
\r
- @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
- @param SenseData Pointer to the SenseData. \r
- @param SenseDataSize Size of SenseData in bytes. \r
+ @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
+ @param SenseData Pointer to the SenseData.\r
+ @param SenseDataSize Size of SenseData in bytes.\r
@param SenseDataNumber Pointer to the value for the identify data size.\r
\r
@retval EFI_SUCCESS The command was accepted without any errors.\r
- @retval EFI_NOT_FOUND Device does not support this data class \r
- @retval EFI_DEVICE_ERROR Error reading InquiryData from device \r
- @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough \r
+ @retval EFI_NOT_FOUND Device does not support this data class\r
+ @retval EFI_DEVICE_ERROR Error reading InquiryData from device\r
+ @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough\r
\r
**/\r
EFI_STATUS\r
/**\r
This function is used by the IDE bus driver to get controller information.\r
\r
- @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
+ @param This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
@param IdeChannel Pointer to the Ide Channel number. Primary or secondary.\r
@param IdeDevice Pointer to the Ide Device number. Master or slave.\r
\r
- @retval EFI_SUCCESS IdeChannel and IdeDevice are valid \r
- @retval EFI_UNSUPPORTED This is not an IDE device \r
+ @retval EFI_SUCCESS IdeChannel and IdeDevice are valid\r
+ @retval EFI_UNSUPPORTED This is not an IDE device\r
\r
**/\r
EFI_STATUS\r
OUT UINT32 *IdeDevice\r
);\r
/**\r
- The is an event(generally the event is exitBootService event) call back function. \r
+ The is an event(generally the event is exitBootService event) call back function.\r
Clear pending IDE interrupt before OS loader/kernel take control of the IDE device.\r
\r
@param Event Pointer to this event\r
projects / mirror_edk2.git / blobdiff