The file provides the protocol to retrieve configuration\r
information for a device that a UEFI driver is about to start.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation\r
+ Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. 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
ParameterBlock has been processed via a Query and corresponding\r
Response call it must not be returned again via a Query call.\r
\r
- @param This A pointer to the\r
- EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL\r
- instance.\r
+ @param This A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.\r
\r
- @param ControllerHandle The handle the platform will return\r
- configuration information about.\r
+ @param ControllerHandle The handle the platform will return\r
+ configuration information about.\r
\r
- @param ChildHandle The handle of the child controller to\r
- return information on. This is an optional\r
- parameter that may be NULL. It will be\r
- NULL for device drivers, and for bus\r
- drivers that attempt to get options for\r
- the bus controller. It will not be NULL\r
- for a bus driver that attempts to get\r
- options for one of its child controllers.\r
+ @param ChildHandle The handle of the child controller to\r
+ return information on. This is an optional\r
+ parameter that may be NULL. It will be\r
+ NULL for device drivers, and for bus\r
+ drivers that attempt to get options for\r
+ the bus controller. It will not be NULL\r
+ for a bus driver that attempts to get\r
+ options for one of its child controllers.\r
\r
\r
- @param Instance Pointer to the Instance value. On output the\r
- instance associated with the parameter data\r
- return. On input zero means return the first\r
- query data or pass in a valid instance\r
- number returned from a previous call to\r
- Query.\r
-\r
- @param ParameterTypeGuid An EFI_GUID that defines the\r
- contents of ParameterBlock. UEFI\r
- drivers must use the\r
- ParameterTypeGuid to determine how\r
- to parser the ParameterBlock.\r
-\r
- @param ParameterBlock The platform returns a pointer to the\r
- ParameterBlock structure which\r
- contains details about the\r
- configuration parameters specific to\r
- the ParameterTypeGuid. This structure\r
- is defined based on the protocol and\r
- may be different for different\r
- protocols. UEFI driver decodes this\r
- structure and its contents based on\r
- ProtocolGuid. ParameterBlock is\r
- allocated by the platform and the\r
- platform is responsible for freeing\r
- the ParameterBlock after Result is\r
- called.\r
+ @param Instance Pointer to the Instance value. On output the\r
+ instance associated with the parameter data\r
+ return. On input zero means return the first\r
+ query data or pass in a valid instance\r
+ number returned from a previous call to\r
+ Query.\r
+\r
+ @param ParameterTypeGuid An EFI_GUID that defines the\r
+ contents of ParameterBlock. UEFI\r
+ drivers must use the\r
+ ParameterTypeGuid to determine how\r
+ to parser the ParameterBlock.\r
+\r
+ @param ParameterBlock The platform returns a pointer to the\r
+ ParameterBlock structure which\r
+ contains details about the\r
+ configuration parameters specific to\r
+ the ParameterTypeGuid. This structure\r
+ is defined based on the protocol and\r
+ may be different for different\r
+ protocols. UEFI driver decodes this\r
+ structure and its contents based on\r
+ ProtocolGuid. ParameterBlock is\r
+ allocated by the platform and the\r
+ platform is responsible for freeing\r
+ the ParameterBlock after Result is\r
+ called.\r
\r
@param ParameterBlockSize The platform returns the size of\r
the ParameterBlock in bytes.\r
\r
\r
- @retval EFI_SUCCESS The platform return parameter\r
- information for ControllerHandle.\r
+ @retval EFI_SUCCESS The platform return parameter\r
+ information for ControllerHandle.\r
\r
- @retval EFI_NOT_FOUND No more unread Instance exists.\r
+ @retval EFI_NOT_FOUND No more unread Instance exists.\r
\r
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid\r
EFI_HANDLE.\r
\r
@retval EFI_INVALID_PARAMETER Instance is NULL.\r
\r
- @retval EFI_DEVICE_ERROR A device error occurred while\r
- attempting to return parameter block\r
- information for the controller\r
- specified by ControllerHandle and\r
- ChildHandle.\r
+ @retval EFI_DEVICE_ERROR A device error occurred while\r
+ attempting to return parameter block\r
+ information for the controller\r
+ specified by ControllerHandle and\r
+ ChildHandle.\r
\r
- @retval EFI_OUT_RESOURCES There are not enough resources\r
- available to set the configuration\r
- options for the controller specified\r
- by ControllerHandle and ChildHandle.\r
+ @retval EFI_OUT_RESOURCES There are not enough resources\r
+ available to set the configuration\r
+ options for the controller specified\r
+ by ControllerHandle and ChildHandle.\r
\r
\r
**/\r
ParameterTypeGuid. The platform is responsible for freeing\r
ParameterBlock and the UEFI driver must not try to free it\r
\r
- @param This A pointer to the\r
- EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL\r
- instance.\r
+ @param This A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.\r
\r
- @param ControllerHandle The handle the driver is returning\r
- configuration information about.\r
+ @param ControllerHandle The handle the driver is returning\r
+ configuration information about.\r
\r
- @param ChildHandle The handle of the child controller to\r
- return information on. This is an optional\r
- parameter that may be NULL. It will be\r
- NULL for device drivers, and for bus\r
- drivers that attempt to get options for\r
- the bus controller. It will not be NULL\r
- for a bus driver that attempts to get\r
- options for one of its child controllers.\r
- Instance Instance data returned from\r
- Query().\r
+ @param ChildHandle The handle of the child controller to\r
+ return information on. This is an optional\r
+ parameter that may be NULL. It will be\r
+ NULL for device drivers, and for bus\r
+ drivers that attempt to get options for\r
+ the bus controller. It will not be NULL\r
+ for a bus driver that attempts to get\r
+ options for one of its child controllers.\r
+ Instance Instance data returned from\r
+ Query().\r
\r
- @param ParameterTypeGuid ParameterTypeGuid returned from\r
- Query.\r
+ @param ParameterTypeGuid ParameterTypeGuid returned from Query.\r
\r
- @param ParameterBlock ParameterBlock returned from Query.\r
+ @param ParameterBlock ParameterBlock returned from Query.\r
\r
- @param ParameterBlockSize The ParameterBlock size returned\r
- from Query.\r
+ @param ParameterBlockSize The ParameterBlock size returned from Query.\r
\r
- @param Configuration ActionThe driver tells the platform what\r
- action is required for ParameterBlock to\r
- take effect.\r
- \r
+ @param Configuration ActionThe driver tells the platform what\r
+ action is required for ParameterBlock to\r
+ take effect.\r
\r
- @retval EFI_SUCCESS The platform return parameter information\r
- for ControllerHandle.\r
\r
- @retval EFI_NOT_FOUND Instance was not found.\r
+ @retval EFI_SUCCESS The platform return parameter information\r
+ for ControllerHandle.\r
\r
- @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid\r
- EFI_HANDLE.\r
+ @retval EFI_NOT_FOUND Instance was not found.\r
\r
+ @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+ \r
@retval EFI_INVALID_PARAMETER Instance is zero.\r
\r
**/\r
\r
\r
/**\r
+ @par Protocol Description:\r
The EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is used by the\r
UEFI driver to query the platform for configuration information.\r
The UEFI driver calls Query() multiple times to get\r
understand the data returned via Query() and thus no action was\r
taken.\r
\r
- @param Query Called by the UEFI Driver Start() function to\r
- get configuration information from the\r
- platform.\r
+ @param Query Called by the UEFI Driver Start() function to\r
+ get configuration information from the\r
+ platform.\r
\r
@param Response Called by the UEFI Driver Start() function\r
to let the platform know how UEFI driver\r
parameter block definition, newer ParameterTypeGuid will be\r
used.\r
\r
- @param CLPCommand A pointer to the DMTF SM CLP command line\r
- null-terminated string that the driver is\r
- required to parse and process when this\r
- EFI_SUCCESS The platform return parameter\r
- information for ControllerHandle.\r
- EFI_NOT_FOUND Instance was not found.\r
- EFI_INVALID_PARAMETER ControllerHandle is\r
- not a valid EFI_HANDLE.\r
- EFI_INVALID_PARAMETER Instance is zero.\r
- function is called. See the DMTF SM CLP\r
- Specification 1.0 Final Standard for\r
- details on the format and syntax of the\r
- CLP command line string. CLPCommand buffer\r
- is allocated by the producer of the\r
- EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
-\r
- @param CLPCommandLength The length of the CLP Command in\r
- bytes.\r
+ @param CLPCommand A pointer to the DMTF SM CLP command line\r
+ null-terminated string that the driver is\r
+ required to parse and process when this\r
+ EFI_SUCCESS The platform return parameter\r
+ information for ControllerHandle.\r
+ EFI_NOT_FOUND Instance was not found.\r
+ EFI_INVALID_PARAMETER ControllerHandle is\r
+ not a valid EFI_HANDLE.\r
+ EFI_INVALID_PARAMETER Instance is zero.\r
+ function is called. See the DMTF SM CLP\r
+ Specification 1.0 Final Standard for\r
+ details on the format and syntax of the\r
+ CLP command line string. CLPCommand buffer\r
+ is allocated by the producer of the\r
+ EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
+\r
+ @param CLPCommandLength The length of the CLP Command in bytes.\r
\r
@param CLPReturnString A pointer to the CLP return status\r
string that the driver is required to\r
projects / mirror_edk2.git / blobdiff