/** @file\r
\r
- The file provides services to forward results to PCOL-based\r
- handler if EFI HII results processing protocol invokes this\r
- protocol.\r
+ The EFI HII results processing protocol invokes this type of protocol \r
+ when it needs to forward results to a driver's configuration handler. \r
+ This protocol is published by drivers providing and requesting \r
+ configuration data from HII. It may only be invoked by HII.\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
converted from Hex UNICODE to binary) is a reference to a\r
string in the associated string pack.\r
\r
- @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+ @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
\r
- @param Request A null-terminated Unicode string in\r
- <ConfigRequest> format. Note that this\r
- includes the routing information as well as\r
- the configurable name / value pairs. It is\r
- invalid for this string to be in\r
- <MultiConfigRequest> format.\r
+ @param Request A null-terminated Unicode string in\r
+ <ConfigRequest> format. Note that this\r
+ includes the routing information as well as\r
+ the configurable name / value pairs. It is\r
+ invalid for this string to be in\r
+ <MultiConfigRequest> format.\r
\r
@param Progress On return, points to a character in the\r
Request string. Points to the string's null\r
name / value pair) if the request was not\r
successful\r
\r
- @param Results A null-terminated Unicode string in\r
- <ConfigAltResp> format which has all values\r
- filled in for the names in the Request string.\r
- String to be allocated by the called function.\r
+ @param Results A null-terminated Unicode string in\r
+ <ConfigAltResp> format which has all values\r
+ filled in for the names in the Request string.\r
+ String to be allocated by the called function.\r
\r
- @retval EFI_SUCCESS The Results string is filled with the\r
- values corresponding to all requested\r
- names.\r
+ @retval EFI_SUCCESS The Results string is filled with the\r
+ values corresponding to all requested\r
+ names.\r
\r
- @retval EFI_OUT_OF_MEMORY Not enough memory to store the\r
- parts of the results that must be\r
- stored awaiting possible future\r
- protocols.\r
+ @retval EFI_OUT_OF_MEMORY Not enough memory to store the\r
+ parts of the results that must be\r
+ stored awaiting possible future\r
+ protocols.\r
\r
@retval EFI_INVALID_PARAMETER For example, passing in a NULL\r
for the Request parameter\r
Progress parameter would be\r
set to NULL. \r
\r
- @retval EFI_NOT_FOUND Routing data doesn't match any\r
- known driver. Progress set to the\r
- first character in the routing header.\r
- Note: There is no requirement that the\r
- driver validate the routing data. It\r
- must skip the <ConfigHdr> in order to\r
- process the names.\r
+ @retval EFI_NOT_FOUND Routing data doesn't match any\r
+ known driver. Progress set to the\r
+ first character in the routing header.\r
+ Note: There is no requirement that the\r
+ driver validate the routing data. It\r
+ must skip the <ConfigHdr> in order to\r
+ process the names.\r
\r
@retval EFI_INVALID_PARAMETER Illegal syntax. Progress set\r
to most recent & before the\r
format, it may use the ConfigToBlock helper function (above) to\r
simplify the job.\r
\r
- @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+ @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
\r
@param Configuration A null-terminated Unicode string in\r
- <ConfigString> format. Progress a\r
- pointer to a string filled in with the\r
+ <ConfigString> format. \r
+ \r
+ @param Progress A pointer to a string filled in with the\r
offset of the most recent '&' before the\r
first failing name / value pair (or the\r
beginn ing of the string if the failure\r
the terminating NULL if all was\r
successful.\r
\r
- @retval EFI_SUCCESS The results have been distributed or are\r
- awaiting distribution.\r
+ @retval EFI_SUCCESS The results have been distributed or are\r
+ awaiting distribution.\r
\r
- @retval EFI_OUT_OF_MEMORY Not enough memory to store the\r
- parts of the results that must be\r
- stored awaiting possible future\r
- protocols.\r
+ @retval EFI_OUT_OF_MEMORY Not enough memory to store the\r
+ parts of the results that must be\r
+ stored awaiting possible future\r
+ protocols.\r
\r
@retval EFI_INVALID_PARAMETERS Passing in a NULL for the\r
Results parameter would result\r
in this type of error.\r
\r
- @retval EFI_NOT_FOUND Target for the specified routing data\r
- was not found\r
+ @retval EFI_NOT_FOUND Target for the specified routing data\r
+ was not found\r
\r
**/\r
typedef\r
This data consists of a unique key that is used to identify\r
which data is either being passed back or being asked for.\r
\r
- @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
-\r
- @param KeyValue A unique value which is sent to the original\r
- exporting driver so that it can identify the\r
- type of data to expect. The format of the\r
- data tends to vary based on the opcode that\r
- generated the callback.\r
-\r
- @param Data A pointer to the data being sent to the original\r
- exporting driver. The format of the data should\r
- be the same as that of the question invoking the\r
- callback and will be known to the recipient.\r
-\r
- @retval EFI_SUCCESS The firmware has successfully stored the\r
- variable and its data as defined by the\r
- Attributes.\r
-\r
- @retval EFI_INVALID_PARAMETER An invalid combination of\r
- Attributes bits was supplied,\r
- or the DataSize exceeds the\r
- maximum allowed.\r
-\r
- @retval EFI_OUT_OF_RESOURCES Not enough storage is available\r
- to hold the variable and its\r
- data.\r
-\r
- @retval EFI_DEVICE_ERROR The variable could not be saved due\r
- to a hardware failure.\r
-\r
-\r
+ @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+ @param Action Specifies the type of action taken by the browser.\r
+ @param QuestionId A unique value which is sent to the original\r
+ exporting driver so that it can identify the type\r
+ of data to expect. The format of the data tends to \r
+ vary based on the opcode that enerated the callback.\r
+ @param Type The type of value for the question.\r
+ @param Value A pointer to the data being sent to the original\r
+ exporting driver.\r
+ @param ActionRequest On return, points to the action requested by the\r
+ callback function.\r
+\r
+ @retval EFI_SUCCESS The callback successfully handled the action.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the\r
+ variable and its data.\r
+ @retval EFI_DEVICE_ERROR The variable could not be saved.\r
+ @retval EFI_UNSUPPORTED The specified Action is not supported by the\r
+ callback.\r
**/\r
typedef\r
EFI_STATUS\r
)\r
;\r
/**\r
- \r
+ @par Protocol Description: \r
This protocol provides a callable interface between the HII and\r
drivers. Only drivers which provide IFR data to HII are required\r
to publish this protocol.\r
analogous to the similarly named\r
function in the HII Routing Protocol.\r
\r
- @param RouteConfig This function breaks apart the UNICODE\r
- results strings and returns configuration\r
- information as specified by the request.\r
+ @param RouteConfig This function breaks apart the UNICODE\r
+ results strings and returns configuration\r
+ information as specified by the request.\r
\r
- @param Callback This function is called from the\r
- configuration browser to communicate certain\r
- activities that were initiated by a user.\r
-\r
+ @param Callback This function is called from the\r
+ configuration browser to communicate certain\r
+ activities that were initiated by a user.\r
\r
**/\r
struct _EFI_HII_CONFIG_ACCESS_PROTOCOL {\r
projects / mirror_edk2.git / blobdiff