the platform about the ControllerHandle that is being started.\r
Information returned from Query may lead to the drivers Start()\r
function failing.\r
- If the UEFI driver is a bus driver and producing a ChildHandle\r
+ If the UEFI driver is a bus driver and producing a ChildHandle,\r
the driver must call Query after the child handle has been created\r
and an EFI_DEVICE_PATH_PROTOCOL has been placed on that handle,\r
but before any time consuming operation is performed. If information\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
+ 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
should not attempt to free ParameterTypeGuid.\r
\r
@param ParameterBlock The platform returns a pointer to the\r
- ParameterBlock structure which\r
+ ParameterBlock structure, which\r
contains details about the\r
configuration parameters specific to\r
the ParameterTypeGuid. This structure\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
+ allocated by the platform. The\r
platform is responsible for freeing\r
the ParameterBlock after Result is\r
called.\r
typedef enum {\r
///\r
/// The controller specified by ControllerHandle is still\r
- /// in a usable state, it's configuration has been updated\r
+ /// in a usable state, and its configuration has been updated\r
/// via parsing the ParameterBlock. If required by the\r
- /// parameter block and the module supports an NVRAM store\r
+ /// parameter block, and the module supports an NVRAM store,\r
/// the configuration information from PB was successfully\r
/// saved to the NVRAM. No actions are required before\r
/// this controller can be used again with the updated\r
\r
///\r
/// The driver has detected that the controller specified\r
- /// by ControllerHandle is not in a usable state, and it\r
+ /// by ControllerHandle is not in a usable state and \r
/// needs to be stopped. The calling agent can use the\r
/// DisconnectControservice to perform this operation, and\r
/// it should be performed as soon as possible. \r
/// be stopped and restarted before it can be used again.\r
/// The calling agent can use the DisconnectController()\r
/// and ConnectController() services to perform this\r
- /// operation. The restart operation can be delayed until\r
- /// all of the configuratiooptions have been set. \r
+ /// operation. The restart operation can be delayed until\r
+ /// all of the configuration options have been set. \r
///\r
EfiPlatformConfigurationActionRestartController = 2,\r
\r
ParameterBlock, and ParameterBlockSize. The UEFI driver may\r
update values in ParameterBlock based on rules defined by\r
ParameterTypeGuid. The platform is responsible for freeing\r
- ParameterBlock and the UEFI driver must not try to free it\r
+ ParameterBlock and the UEFI driver must not try to free it.\r
\r
@param This A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.\r
\r
\r
@param ParameterBlockSize The ParameterBlock size returned from Query.\r
\r
- @param Configuration ActionThe driver tells the platform what\r
+ @param ConfigurationAction The driver tells the platform what\r
action is required for ParameterBlock to\r
take effect.\r
\r
EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is platform\r
firmware and the consumer is the UEFI driver. Note: if future\r
versions of the DMTF SM CLP Specification require changes to the\r
- parameter block definition, newer ParameterTypeGuid will be\r
+ parameter block definition, a newer ParameterTypeGuid will be\r
used.\r
**/\r
typedef struct {\r
CHAR8 *CLPCommand; ///< A pointer to the DMTF SM CLP command line null-terminated string that the \r
- ///< driver is required to parse and process when this EFI_SUCCESS The platform \r
+ ///< driver is required to parse and process. EFI_SUCCESS The platform \r
///< return parameter information for ControllerHandle. EFI_NOT_FOUND Instance \r
///< was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid \r
- ///< EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. function is called. \r
+ ///< EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. Function is called. \r
///< See the DMTF SM CLP Specification 1.0 Final Standard for details on the \r
///< format and syntax of the CLP command line string. CLPCommand buffer\r
///< is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
projects / mirror_edk2.git / blobdiff