information from configuration applications, routing the\r
results to the appropriate drivers.\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
GUID=...&NAME=00480050&PATH=...&Fred=16&George=16&Ron=12&Neville=11&\r
GUID=...&NAME=00480050&PATH=...&ALTCFG=0037&Fred=12&Neville=7\r
\r
- @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
- instance.\r
+ @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
+ instance.\r
\r
- @param Request A null-terminated Unicode string in\r
- <MultiConfigRequest> format.\r
+ @param Request A null-terminated Unicode string 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
Request string. String to be allocated by\r
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
the configuration using the corresponding drivers??\r
EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig() interfaces below.\r
\r
- @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
- instance.\r
+ @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
\r
@param Results A null-terminated Unicode string in\r
<MultiConfigAltResp> format which has all\r
string. String to be allocated by this\r
function. De-allocation is up to the caller.\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_PARAMETERS For example, passing in a NULL\r
for the Results parameter\r
to the driver whose routing information is defined by the\r
<ConfigHdr> in turn.\r
\r
- @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
- instance.\r
+ @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
\r
@param Configuration A null-terminated Unicode string in\r
<MulltiConfigResp> 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
- beginning of the string if the failure is in\r
- the first name / value pair) or the\r
- terminating NULL if all was successful.\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
+ beginning of the string if the failure is in\r
+ the first name / value pair) or the\r
+ terminating NULL if all was 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
spaces). The call fails if, for any (offset, width) pair in\r
ConfigRequest, offset+value >= BlockSize.\r
\r
- @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
- instance.\r
+ @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
\r
@param ConfigRequest A null-terminated Unicode string in\r
<ConfigRequest> format.\r
\r
- @param Block Array of bytes defining the block's\r
- configuration.\r
+ @param Block Array of bytes defining the block's\r
+ configuration.\r
\r
@param BlockSize Length in bytes of Block.\r
\r
- @param Config Filled-in configuration string. String\r
- allocated by the function. Returned only if\r
- call is successful.\r
+ @param Config Filled-in configuration string. String\r
+ allocated by the function. Returned only if\r
+ call is successful.\r
\r
@param Progress A pointer to a string filled in with the\r
offset of the most recent '&' before the\r
the first name / value pair) or the\r
terminating NULL if all was successful.\r
\r
- @retval EFI_SUCCESS The request succeeded. Progress points\r
- to the null terminator at the end of the\r
- ConfigRequest string.\r
- @retval EFI_OUT_OF_MEMORY Not enough memory to allocate\r
- Config. Progress points to the\r
- first character of ConfigRequest.\r
+ @retval EFI_SUCCESS The request succeeded. Progress points\r
+ to the null terminator at the end of the\r
+ ConfigRequest string.\r
+\r
+ @retval EFI_OUT_OF_MEMORY Not enough memory to allocate\r
+ Config. Progress points to the\r
+ first character of ConfigRequest.\r
\r
@retval EFI_INVALID_PARAMETERS Passing in a NULL for the\r
ConfigRequest or Block\r
to the first character of\r
ConfigRequest.\r
\r
- @retval EFI_NOT_FOUND Target for the specified routing data\r
- was not found. Progress points to the\r
- 'G' in "GUID" of the errant routing\r
- data. EFI_DEVICE_ERROR Block not large\r
- enough. Progress undefined.\r
+ @retval EFI_NOT_FOUND Target for the specified routing data\r
+ was not found. Progress points to the\r
+ 'G' in "GUID" of the errant routing\r
+ data. EFI_DEVICE_ERROR Block not large\r
+ enough. Progress undefined.\r
\r
@retval EFI_INVALID_PARAMETER Encountered non <BlockName>\r
formatted string. Block is\r
\r
\r
/**\r
- \r
This function maps a configuration containing a series of\r
<BlockConfig> formatted name value pairs in ConfigResp into a\r
Block so it may be stored in a linear mapped storage such as a\r
The results are\r
55 AA 02 07 04 05\r
\r
- @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
- instance.\r
+ @param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
\r
- @param ConfigResp A null-terminated Unicode string in\r
- <ConfigResp> format.\r
+ @param ConfigResp A null-terminated Unicode string in\r
+ <ConfigResp> format.\r
\r
- @param CurrentBlock A possibly null array of bytes\r
+ @param Block A possibly null array of bytes\r
representing the current block. Only\r
bytes referenced in the ConfigResp\r
string in the block are modified. If\r
parameter is updated and an appropriate\r
status (see below) is returned.\r
\r
- @param BlockSize The length of the Block in units of UINT8.\r
- On input, this is the size of the Block. On\r
- output, if successful, contains the index of\r
- the last modified byte in the Block.\r
-\r
- @param Progress On return, points to an element of the\r
- ConfigResp string filled in with the offset\r
- of the most recent "&" before the first\r
- failing name / value pair (or the beginning\r
- of the string if the failure is in the first\r
- name / value pair) or the terminating NULL\r
- if all was successful.\r
+ @param BlockSize The length of the Block in units of UINT8.\r
+ On input, this is the size of the Block. On\r
+ output, if successful, contains the index of\r
+ the last modified byte in the Block.\r
+\r
+ @param Progress On return, points to an element of the\r
+ ConfigResp string filled in with the offset\r
+ of the most recent "&" before the first\r
+ failing name / value pair (or the beginning\r
+ of the string if the failure is in the first\r
+ name / value pair) or the terminating NULL\r
+ if all was successful.\r
+\r
+ @retval EFI_SUCCESS The request succeeded. Progress points to the null\r
+ terminator at the end of the ConfigResp string.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress\r
+ points to the first character of ConfigResp.\r
+ @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or\r
+ Block parameter would result in this type of\r
+ error. Progress points to the first character of\r
+ ConfigResp.\r
+ @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted name /\r
+ value pair. Block is left updated and\r
+ Progress points at the '&' preceding the first\r
+ non-<BlockName>.\r
\r
**/\r
typedef\r
OUT EFI_STRING *Progress\r
);\r
\r
+/**\r
+ This helper function is to be called by drivers to extract portions of \r
+ a larger configuration string.\r
+ \r
+ @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. \r
+ @param Configuration A null-terminated Unicode string in <MultiConfigAltResp> format.\r
+ @param Guid A pointer to the GUID value to search for in the \r
+ routing portion of the ConfigResp string when retrieving \r
+ the requested data. If Guid is NULL, then all GUID \r
+ values will be searched for.\r
+ @param Name A pointer to the NAME value to search for in the \r
+ routing portion of the ConfigResp string when retrieving \r
+ the requested data. If Name is NULL, then all Name \r
+ values will be searched for. \r
+ @param DevicePath A pointer to the PATH value to search for in the \r
+ routing portion of the ConfigResp string when retrieving \r
+ the requested data. If DevicePath is NULL, then all \r
+ DevicePath values will be searched for. \r
+ @param AltCfgId A pointer to the ALTCFG value to search for in the \r
+ routing portion of the ConfigResp string when retrieving \r
+ the requested data. If this parameter is NULL, \r
+ then the current setting will be retrieved.\r
+ @param AltCfgResp A pointer to a buffer which will be allocated by the \r
+ function which contains the retrieved string as requested. \r
+ This buffer is only allocated if the call was successful. \r
+ \r
+ @retval EFI_SUCCESS The request succeeded. The requested data was extracted \r
+ and placed in the newly allocated AltCfgResp buffer.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp. \r
+ @retval EFI_INVALID_PARAMETER Any parameter is invalid.\r
+ @retval EFI_NOT_FOUND Target for the specified routing data was not found.\r
+**/\r
typedef\r
EFI_STATUS \r
(EFIAPI * EFI_HII_GET_ALT_CFG)(\r
IN CONST UINT16 *AltCfgId,\r
OUT EFI_STRING *AltCfgResp \r
)\r
-/*++\r
-\r
- Routine Description:\r
- This helper function is to be called by drivers to extract portions of \r
- a larger configuration string.\r
- \r
- Arguments: \r
- This - A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance. \r
- Configuration - A null-terminated Unicode string in <MultiConfigAltResp> format.\r
- Guid - A pointer to the GUID value to search for in the \r
- routing portion of the ConfigResp string when retrieving \r
- the requested data. If Guid is NULL, then all GUID \r
- values will be searched for.\r
- Name - A pointer to the NAME value to search for in the \r
- routing portion of the ConfigResp string when retrieving \r
- the requested data. If Name is NULL, then all Name \r
- values will be searched for. \r
- DevicePath - A pointer to the PATH value to search for in the \r
- routing portion of the ConfigResp string when retrieving \r
- the requested data. If DevicePath is NULL, then all \r
- DevicePath values will be searched for. \r
- AltCfgId - A pointer to the ALTCFG value to search for in the \r
- routing portion of the ConfigResp string when retrieving \r
- the requested data. If this parameter is NULL, \r
- then the current setting will be retrieved.\r
- AltCfgResp - A pointer to a buffer which will be allocated by the \r
- function which contains the retrieved string as requested. \r
- This buffer is only allocated if the call was successful. \r
- \r
- Returns: \r
- EFI_SUCCESS - The request succeeded. The requested data was extracted \r
- and placed in the newly allocated AltCfgResp buffer.\r
- EFI_OUT_OF_RESOURCES - Not enough memory to allocate AltCfgResp. \r
- EFI_INVALID_PARAMETER - Any parameter is invalid.\r
- EFI_NOT_FOUND - Target for the specified routing data was not found.\r
- \r
---*/ \r
;\r
\r
-\r
/**\r
- \r
+ @par Protocol Description: \r
This protocol defines the configuration routing interfaces\r
between external applications and the HII. There may only be one\r
instance of this protocol in the system.\r
+ \r
+ @param ExtractConfig\r
+ This function allows a caller to extract the current configuration for \r
+ one or more named elements from one or more drivers.\r
+\r
+ @param ExportConfig\r
+ This function allows the caller to request the current configuration for \r
+ the entirety of the current HII database and returns the data \r
+ in a null-terminated Unicode string.\r
+\r
+ @param RouteConfig\r
+ This function processes the results of processing forms and routes it \r
+ to the appropriate handlers or storage.\r
+\r
+ @param BlockToConfig\r
+ This helper function is to be called by drivers to map configuration data \r
+ stored in byte array ("block") formats such as UEFI Variables into current \r
+ configuration strings.\r
+\r
+ @param ConfigToBlock\r
+ This helper function is to be called by drivers to map configuration strings \r
+ to configurations stored in byte array ("block") formats such as UEFI Variables.\r
+\r
+ @param GetAltConfig\r
+ This helper function is to be called by drivers to extract portions of a larger configuration string.\r
\r
**/\r
struct _EFI_HII_CONFIG_ROUTING_PROTOCOL {\r
projects / mirror_edk2.git / blobdiff