[mirror_edk2.git] / MdePkg / Include / Protocol / HiiConfigRouting.h

/** @file\r
  The file provides services to manage the movement of\r
  configuration data from drivers to configuration applications.\r
  It then serves as the single point to receive configuration\r
  information from configuration applications, routing the\r
  results to the appropriate drivers.\r
  \r
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php.                                          \r
    \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __HII_CONFIG_ROUTING_H__\r
#define __HII_CONFIG_ROUTING_H__\r
\r
#define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \\r
  { 0x587e72d7, 0xcc50, 0x4f79, { 0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f } }\r
\r
\r
typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;\r
\r
/**\r
   \r
  This function allows the caller to request the current\r
  configuration for one or more named elements from one or more\r
  drivers. The resulting string is in the standard HII\r
  configuration string format. If Successful, Results contains an\r
  equivalent string with "=" and the values associated with all\r
  names added in. The expected implementation is for each\r
  <ConfigRequest> substring in the Request to call the HII\r
  Configuration Routing Protocol ExtractProtocol function for the\r
  driver corresponding to the <ConfigHdr> at the start of the\r
  <ConfigRequest> substring. The request fails if no driver\r
  matches the <ConfigRequest> substring. Note: Alternative\r
  configuration strings may also be appended to the end of the\r
  current configuration string. If they are, they must appear\r
  after the current configuration. They must contain the same\r
  routing (GUID, NAME, PATH) as the current configuration string.\r
  They must have an additional description indicating the type of\r
  alternative configuration the string represents,\r
  "ALTCFG=<StringToken>". That <StringToken> (when converted from\r
  hexadecimal (encoded as text) to binary) is a reference to a string in the\r
  associated string pack. As an example, assume that the Request\r
  string is:\r
  GUID=...&NAME=00480050&PATH=...&Fred&George&Ron&Neville A result\r
  might be:\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
\r
  @param Request    A null-terminated string in <MultiConfigRequest> format.\r
\r
  @param Progress   On return, points to a character in the\r
                    Request string. Points to the string's null\r
                    terminator if the request was successful. Points\r
                    to 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) if the request was not\r
                    successful\r
\r
  @param Results    A null-terminated string in <MultiConfigAltResp> format\r
                    which has all values filled in for the names in the\r
                    Request string.\r
\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_RESOURCES    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
                                  would result in this type of\r
                                  error. The Progress parameter\r
                                  is set to NULL. \r
  \r
  @retval EFI_NOT_FOUND           Routing data doesn't match any\r
                                  known driver. Progress set to\r
                                  the "G" in "GUID" of the\r
                                  routing header that doesn't\r
                                  match. Note: There is no\r
                                  requirement that all routing\r
                                  data be validated before any\r
                                  configuration extraction.\r
\r
  @retval EFI_INVALID_PARAMETER   Illegal syntax. Progress set\r
                                  to the most recent & before the\r
                                  error, or the beginning of the\r
                                  string.\r
  @retval EFI_INVALID_PARAMETER   Unknown name.\r
\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_HII_EXTRACT_CONFIG)(\r
  IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
  IN CONST  EFI_STRING                      Request,\r
  OUT       EFI_STRING                      *Progress,\r
  OUT       EFI_STRING                      *Results\r
);\r
\r
/**\r
  This function allows the caller to request the current configuration \r
  for the entirety of the current HII database and returns the data in\r
  a null-terminated string.\r
\r
  This function allows the caller to request the current\r
  configuration for all of the current HII database. The results\r
  include both the current and alternate configurations as\r
  described in ExtractConfig() above. \r
  \r
  @param This     Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
  \r
  @param  Results Null-terminated Unicode string in\r
                  <MultiConfigAltResp> format which has all values\r
                  filled in for the entirety of the current HII \r
                  database. String to be allocated by the  called \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
  \r
  @retval EFI_OUT_OF_RESOURCES    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
                                  would result in this type of\r
                                  error.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_HII_EXPORT_CONFIG)(\r
  IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
  OUT       EFI_STRING                      *Results\r
);\r
\r
/**\r
   \r
  This function routes the results of processing forms to the\r
  appropriate targets. It scans for <ConfigHdr> within the string\r
  and passes the header and subsequent body to the driver whose\r
  location is described in the <ConfigHdr>. Many <ConfigHdr>s may\r
  appear as a single request. The expected implementation is to\r
  hand off the various <ConfigResp> substrings to the\r
  Configuration Access Protocol RouteConfig routine corresponding\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 instance.\r
\r
  @param Configuration  A null-terminated string in <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
\r
  @retval EFI_SUCCESS             The results have been distributed or are\r
                                  awaiting distribution.\r
  \r
  @retval EFI_OUT_OF_RESOURCES    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           The target for the specified routing data\r
                                  was not found.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_HII_ROUTE_CONFIG)(\r
  IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
  IN CONST  EFI_STRING                      Configuration,\r
  OUT       EFI_STRING                      *Progress\r
);\r
\r
\r
/**\r
   \r
  This function extracts the current configuration from a block of\r
  bytes. To do so, it requires that the ConfigRequest string\r
  consists of a list of <BlockName> formatted names. It uses the\r
  offset in the name to determine the index into the Block to\r
  start the extraction and the width of each name to determine the\r
  number of bytes to extract. These are mapped to a string\r
  using the equivalent of the C "%x" format (with optional leading\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 instance.\r
\r
  @param ConfigRequest  A null-terminated string in <ConfigRequest> format.\r
\r
  @param Block      An array of bytes defining the block's\r
                    configuration.\r
\r
  @param BlockSize  The length in bytes of Block.\r
\r
  @param Config     The filled-in configuration string. String\r
                    allocated by the function. Returned only if\r
                    call is successful. The null-terminated string \r
                    will be <ConfigResp> 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
\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_RESOURCES    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
                                  parameter would result in this\r
                                  type of error. Progress points\r
                                  to the first character of\r
                                  ConfigRequest.\r
\r
  @retval EFI_NOT_FOUND           The target for the specified routing data\r
                                  was not found. Progress points to the\r
                                  'G' in "GUID" of the errant routing\r
                                  data. \r
  @retval EFI_DEVICE_ERROR        The block is not large enough. Progress undefined.\r
\r
  @retval EFI_INVALID_PARAMETER   Encountered non <BlockName>\r
                                  formatted string. Block is\r
                                  left updated and Progress\r
                                  points at the '&' preceding\r
                                  the first non-<BlockName>.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_HII_BLOCK_TO_CONFIG)(\r
  IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
  IN CONST  EFI_STRING                      ConfigRequest,\r
  IN CONST  UINT8                           *Block,\r
  IN CONST  UINTN                           BlockSize,\r
  OUT       EFI_STRING                      *Config,\r
  OUT       EFI_STRING                      *Progress\r
);\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
  UEFI Variable. If present, the function skips GUID, NAME, and\r
  PATH in <ConfigResp>. It stops when it finds a non-<BlockConfig>\r
  name / value pair (after skipping the routing header) or when it\r
  reaches the end of the string.\r
  Example Assume an existing block containing: 00 01 02 03 04 05\r
  And the ConfigResp string is:\r
  OFFSET=4&WIDTH=1&VALUE=7&OFFSET=0&WIDTH=2&VALUE=AA55\r
  The results are\r
  55 AA 02 07 04 05\r
\r
  @param This           Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
\r
  @param ConfigResp     A null-terminated string in <ConfigResp> format.\r
\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
                        this parameter is null or if the\r
                        BlockLength parameter is (on input)\r
                        shorter than required by the\r
                        Configuration string, only the BlockSize\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 largest \r
                        index of the modified byte in the Block, or\r
                        the required buffer size if the Block is not\r
                        large enough.\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
  @retval EFI_DEVICE_ERROR       Block not large enough. Progress undefined.\r
  @retval EFI_NOT_FOUND          Target for the specified routing data was not found.\r
                                 Progress points to the "G" in "GUID" of the errant\r
                                 routing data.\r
  @retval EFI_BUFFER_TOO_SMALL   Block not large enough. Progress undefined. \r
                                 BlockSize is updated with the required buffer size.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_HII_CONFIG_TO_BLOCK)(\r
  IN CONST  EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
  IN CONST  EFI_STRING                      ConfigResp,\r
  IN OUT    UINT8                           *Block,\r
  IN OUT    UINTN                           *BlockSize,\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 ConfigResp        A null-terminated string in <ConfigAltResp> 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
                           The null-terminated string will be <ConfigResp> format.\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           The 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 EFI_HII_CONFIG_ROUTING_PROTOCOL    *This, \r
  IN  CONST EFI_STRING                         ConfigResp, \r
  IN  CONST EFI_GUID                           *Guid, \r
  IN  CONST EFI_STRING                         Name, \r
  IN  CONST EFI_DEVICE_PATH_PROTOCOL           *DevicePath,  \r
  IN  CONST UINT16                             *AltCfgId,\r
  OUT EFI_STRING                               *AltCfgResp \r
  );\r
\r
///\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
struct _EFI_HII_CONFIG_ROUTING_PROTOCOL {\r
  EFI_HII_EXTRACT_CONFIG  ExtractConfig;\r
  EFI_HII_EXPORT_CONFIG   ExportConfig;\r
  EFI_HII_ROUTE_CONFIG    RouteConfig;\r
  EFI_HII_BLOCK_TO_CONFIG BlockToConfig;\r
  EFI_HII_CONFIG_TO_BLOCK ConfigToBlock;\r
  EFI_HII_GET_ALT_CFG     GetAltConfig;\r
};\r
\r
extern EFI_GUID gEfiHiiConfigRoutingProtocolGuid;\r
\r
\r
#endif\r
\r
Commit	Line	Data
d1f95000	1	/** @file\r
	2	The file provides services to manage the movement of\r
	3	configuration data from drivers to configuration applications.\r
	4	It then serves as the single point to receive configuration\r
	5	information from configuration applications, routing the\r
	6	results to the appropriate drivers.\r
	7	\r
9df063a0	8	Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
af2dc6a7	9	This program and the accompanying materials are licensed and made available under \r
	10	the terms and conditions of the BSD License that accompanies this distribution. \r
	11	The full text of the license may be found at\r
	12	http://opensource.org/licenses/bsd-license.php. \r
	13	\r
	14	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	15	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
d1f95000	16	\r
d1f95000	17	**/\r
	18	\r
	19	#ifndef __HII_CONFIG_ROUTING_H__\r
	20	#define __HII_CONFIG_ROUTING_H__\r
	21	\r
	22	#define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \\r
	23	{ 0x587e72d7, 0xcc50, 0x4f79, { 0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f } }\r
	24	\r
	25	\r
	26	typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;\r
	27	\r
d1f95000	28	/**\r
	29	\r
	30	This function allows the caller to request the current\r
	31	configuration for one or more named elements from one or more\r
	32	drivers. The resulting string is in the standard HII\r
af2dc6a7	33	configuration string format. If Successful, Results contains an\r
d1f95000	34	equivalent string with "=" and the values associated with all\r
d1f95000	35	names added in. The expected implementation is for each\r
af2dc6a7	36	<ConfigRequest> substring in the Request to call the HII\r
d1f95000	37	Configuration Routing Protocol ExtractProtocol function for the\r
	38	driver corresponding to the <ConfigHdr> at the start of the\r
	39	<ConfigRequest> substring. The request fails if no driver\r
	40	matches the <ConfigRequest> substring. Note: Alternative\r
	41	configuration strings may also be appended to the end of the\r
	42	current configuration string. If they are, they must appear\r
	43	after the current configuration. They must contain the same\r
	44	routing (GUID, NAME, PATH) as the current configuration string.\r
	45	They must have an additional description indicating the type of\r
	46	alternative configuration the string represents,\r
	47	"ALTCFG=<StringToken>". That <StringToken> (when converted from\r
fbf926ad	48	hexadecimal (encoded as text) to binary) is a reference to a string in the\r
d1f95000	49	associated string pack. As an example, assume that the Request\r
	50	string is:\r
	51	GUID=...&NAME=00480050&PATH=...&Fred&George&Ron&Neville A result\r
	52	might be:\r
	53	GUID=...&NAME=00480050&PATH=...&Fred=16&George=16&Ron=12&Neville=11&\r
	54	GUID=...&NAME=00480050&PATH=...&ALTCFG=0037&Fred=12&Neville=7\r
	55	\r
4ca9b6c4 LG	56	@param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL\r
4ca9b6c4 LG	57	instance.\r
d1f95000	58	\r
a1e98f78	59	@param Request A null-terminated string in <MultiConfigRequest> format.\r
d1f95000	60	\r
	61	@param Progress On return, points to a character in the\r
	62	Request string. Points to the string's null\r
af2dc6a7	63	terminator if the request was successful. Points\r
d1f95000	64	to the most recent '&' before the first\r
	65	failing name / value pair (or the beginning\r
	66	of the string if the failure is in the first\r
	67	name / value pair) if the request was not\r
	68	successful\r
	69	\r
a1e98f78	70	@param Results A null-terminated string in <MultiConfigAltResp> format\r
29c18ab5	71	which has all values filled in for the names in the\r
a1e98f78	72	Request string.\r
d1f95000	73	\r
4ca9b6c4 LG	74	@retval EFI_SUCCESS The Results string is filled with the\r
	75	values corresponding to all requested\r
	76	names.\r
d1f95000	77	\r
e1f1fb16	78	@retval EFI_OUT_OF_RESOURCES Not enough memory to store the\r
4ca9b6c4 LG	79	parts of the results that must be\r
	80	stored awaiting possible future\r
	81	protocols.\r
d1f95000	82	\r
	83	@retval EFI_INVALID_PARAMETER For example, passing in a NULL\r
	84	for the Request parameter\r
	85	would result in this type of\r
	86	error. The Progress parameter\r
630b4187	87	is set to NULL. \r
	88	\r
	89	@retval EFI_NOT_FOUND Routing data doesn't match any\r
d1f95000	90	known driver. Progress set to\r
	91	the "G" in "GUID" of the\r
	92	routing header that doesn't\r
	93	match. Note: There is no\r
	94	requirement that all routing\r
	95	data be validated before any\r
	96	configuration extraction.\r
	97	\r
	98	@retval EFI_INVALID_PARAMETER Illegal syntax. Progress set\r
af2dc6a7	99	to the most recent & before the\r
af2dc6a7	100	error, or the beginning of the\r
d1f95000	101	string.\r
	102	@retval EFI_INVALID_PARAMETER Unknown name.\r
	103	\r
	104	\r
	105	**/\r
	106	typedef\r
	107	EFI_STATUS\r
c8c44377	108	(EFIAPI * EFI_HII_EXTRACT_CONFIG)(\r
d1f95000	109	IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
7d582d6b	110	IN CONST EFI_STRING Request,\r
d1f95000	111	OUT EFI_STRING *Progress,\r
	112	OUT EFI_STRING *Results\r
	113	);\r
	114	\r
	115	/**\r
fbf926ad	116	This function allows the caller to request the current configuration \r
	117	for the entirety of the current HII database and returns the data in\r
	118	a null-terminated string.\r
	119	\r
d1f95000	120	This function allows the caller to request the current\r
	121	configuration for all of the current HII database. The results\r
	122	include both the current and alternate configurations as\r
29c18ab5	123	described in ExtractConfig() above. \r
d1f95000	124	\r
4ca9b6c4	125	@param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
d1f95000	126	\r
5795218e ED	127	@param Results Null-terminated Unicode string in\r
	128	<MultiConfigAltResp> format which has all values\r
	129	filled in for the entirety of the current HII \r
	130	database. String to be allocated by the called \r
	131	function. De-allocation is up to the caller.\r
d1f95000	132	\r
4ca9b6c4 LG	133	@retval EFI_SUCCESS The Results string is filled with the\r
	134	values corresponding to all requested\r
	135	names.\r
d1f95000	136	\r
e1f1fb16	137	@retval EFI_OUT_OF_RESOURCES Not enough memory to store the\r
4ca9b6c4 LG	138	parts of the results that must be\r
	139	stored awaiting possible future\r
	140	protocols.\r
d1f95000	141	\r
	142	@retval EFI_INVALID_PARAMETERS For example, passing in a NULL\r
	143	for the Results parameter\r
	144	would result in this type of\r
	145	error.\r
	146	\r
	147	**/\r
	148	typedef\r
	149	EFI_STATUS\r
c8c44377	150	(EFIAPI * EFI_HII_EXPORT_CONFIG)(\r
d1f95000	151	IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
	152	OUT EFI_STRING *Results\r
	153	);\r
	154	\r
	155	/**\r
	156	\r
	157	This function routes the results of processing forms to the\r
	158	appropriate targets. It scans for <ConfigHdr> within the string\r
	159	and passes the header and subsequent body to the driver whose\r
	160	location is described in the <ConfigHdr>. Many <ConfigHdr>s may\r
	161	appear as a single request. The expected implementation is to\r
	162	hand off the various <ConfigResp> substrings to the\r
	163	Configuration Access Protocol RouteConfig routine corresponding\r
	164	to the driver whose routing information is defined by the\r
	165	<ConfigHdr> in turn.\r
	166	\r
4ca9b6c4	167	@param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
d1f95000	168	\r
fbf926ad	169	@param Configuration A null-terminated string in <MulltiConfigResp> format.\r
d1f95000	170	\r
4ca9b6c4 LG	171	@param Progress A pointer to a string filled in with the\r
	172	offset of the most recent '&' before the\r
	173	first failing name / value pair (or the\r
	174	beginning of the string if the failure is in\r
af2dc6a7	175	the first name / value pair), or the\r
4ca9b6c4	176	terminating NULL if all was successful.\r
d1f95000	177	\r
4ca9b6c4 LG	178	@retval EFI_SUCCESS The results have been distributed or are\r
4ca9b6c4 LG	179	awaiting distribution.\r
d1f95000	180	\r
e1f1fb16	181	@retval EFI_OUT_OF_RESOURCES Not enough memory to store the\r
4ca9b6c4 LG	182	parts of the results that must be\r
	183	stored awaiting possible future\r
	184	protocols.\r
d1f95000	185	\r
	186	@retval EFI_INVALID_PARAMETERS Passing in a NULL for the\r
	187	Results parameter would result\r
	188	in this type of error.\r
	189	\r
af2dc6a7	190	@retval EFI_NOT_FOUND The target for the specified routing data\r
af2dc6a7	191	was not found.\r
d1f95000	192	\r
	193	**/\r
	194	typedef\r
	195	EFI_STATUS\r
c8c44377	196	(EFIAPI * EFI_HII_ROUTE_CONFIG)(\r
d1f95000	197	IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
	198	IN CONST EFI_STRING Configuration,\r
	199	OUT EFI_STRING *Progress\r
	200	);\r
	201	\r
	202	\r
	203	/**\r
	204	\r
	205	This function extracts the current configuration from a block of\r
	206	bytes. To do so, it requires that the ConfigRequest string\r
	207	consists of a list of <BlockName> formatted names. It uses the\r
	208	offset in the name to determine the index into the Block to\r
	209	start the extraction and the width of each name to determine the\r
fbf926ad	210	number of bytes to extract. These are mapped to a string\r
d1f95000	211	using the equivalent of the C "%x" format (with optional leading\r
	212	spaces). The call fails if, for any (offset, width) pair in\r
	213	ConfigRequest, offset+value >= BlockSize.\r
	214	\r
4ca9b6c4	215	@param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
d1f95000	216	\r
fbf926ad	217	@param ConfigRequest A null-terminated string in <ConfigRequest> format.\r
d1f95000	218	\r
af2dc6a7	219	@param Block An array of bytes defining the block's\r
4ca9b6c4	220	configuration.\r
d1f95000	221	\r
af2dc6a7	222	@param BlockSize The length in bytes of Block.\r
d1f95000	223	\r
af2dc6a7	224	@param Config The filled-in configuration string. String\r
4ca9b6c4	225	allocated by the function. Returned only if\r
a1e98f78 LG	226	call is successful. The null-terminated string \r
a1e98f78 LG	227	will be <ConfigResp> format.\r
d1f95000	228	\r
	229	@param Progress A pointer to a string filled in with the\r
	230	offset of the most recent '&' before the\r
	231	first failing name / value pair (or the\r
	232	beginning of the string if the failure is in\r
af2dc6a7	233	the first name / value pair), or the\r
d1f95000	234	terminating NULL if all was successful.\r
d1f95000	235	\r
4ca9b6c4 LG	236	@retval EFI_SUCCESS The request succeeded. Progress points\r
	237	to the null terminator at the end of the\r
	238	ConfigRequest string.\r
	239	\r
e1f1fb16	240	@retval EFI_OUT_OF_RESOURCES Not enough memory to allocate\r
4ca9b6c4 LG	241	Config. Progress points to the\r
4ca9b6c4 LG	242	first character of ConfigRequest.\r
d1f95000	243	\r
	244	@retval EFI_INVALID_PARAMETERS Passing in a NULL for the\r
	245	ConfigRequest or Block\r
	246	parameter would result in this\r
	247	type of error. Progress points\r
	248	to the first character of\r
	249	ConfigRequest.\r
	250	\r
af2dc6a7	251	@retval EFI_NOT_FOUND The target for the specified routing data\r
4ca9b6c4 LG	252	was not found. Progress points to the\r
4ca9b6c4 LG	253	'G' in "GUID" of the errant routing\r
630b4187	254	data. \r
af2dc6a7	255	@retval EFI_DEVICE_ERROR The block is not large enough. Progress undefined.\r
d1f95000	256	\r
	257	@retval EFI_INVALID_PARAMETER Encountered non <BlockName>\r
	258	formatted string. Block is\r
	259	left updated and Progress\r
	260	points at the '&' preceding\r
	261	the first non-<BlockName>.\r
	262	\r
	263	**/\r
	264	typedef\r
	265	EFI_STATUS\r
c8c44377	266	(EFIAPI * EFI_HII_BLOCK_TO_CONFIG)(\r
d1f95000	267	IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
	268	IN CONST EFI_STRING ConfigRequest,\r
	269	IN CONST UINT8 *Block,\r
	270	IN CONST UINTN BlockSize,\r
7d582d6b	271	OUT EFI_STRING *Config,\r
d1f95000	272	OUT EFI_STRING *Progress\r
	273	);\r
	274	\r
	275	\r
	276	\r
	277	/**\r
d1f95000	278	This function maps a configuration containing a series of\r
	279	<BlockConfig> formatted name value pairs in ConfigResp into a\r
	280	Block so it may be stored in a linear mapped storage such as a\r
	281	UEFI Variable. If present, the function skips GUID, NAME, and\r
	282	PATH in <ConfigResp>. It stops when it finds a non-<BlockConfig>\r
	283	name / value pair (after skipping the routing header) or when it\r
	284	reaches the end of the string.\r
	285	Example Assume an existing block containing: 00 01 02 03 04 05\r
	286	And the ConfigResp string is:\r
	287	OFFSET=4&WIDTH=1&VALUE=7&OFFSET=0&WIDTH=2&VALUE=AA55\r
	288	The results are\r
	289	55 AA 02 07 04 05\r
	290	\r
4ca9b6c4	291	@param This Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
d1f95000	292	\r
fbf926ad	293	@param ConfigResp A null-terminated string in <ConfigResp> format.\r
d1f95000	294	\r
4ca9b6c4	295	@param Block A possibly null array of bytes\r
d1f95000	296	representing the current block. Only\r
	297	bytes referenced in the ConfigResp\r
	298	string in the block are modified. If\r
	299	this parameter is null or if the\r
	300	BlockLength parameter is (on input)\r
	301	shorter than required by the\r
	302	Configuration string, only the BlockSize\r
af2dc6a7	303	parameter is updated, and an appropriate\r
d1f95000	304	status (see below) is returned.\r
d1f95000	305	\r
4ca9b6c4 LG	306	@param BlockSize The length of the Block in units of UINT8.\r
4ca9b6c4 LG	307	On input, this is the size of the Block. On\r
5795218e ED	308	output, if successful, contains the largest \r
	309	index of the modified byte in the Block, or\r
	310	the required buffer size if the Block is not\r
	311	large enough.\r
4ca9b6c4 LG	312	\r
	313	@param Progress On return, points to an element of the\r
	314	ConfigResp string filled in with the offset\r
	315	of the most recent "&" before the first\r
	316	failing name / value pair (or the beginning\r
	317	of the string if the failure is in the first\r
af2dc6a7	318	name / value pair), or the terminating NULL\r
4ca9b6c4 LG	319	if all was successful.\r
	320	\r
	321	@retval EFI_SUCCESS The request succeeded. Progress points to the null\r
	322	terminator at the end of the ConfigResp string.\r
630b4187	323	@retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress\r
4ca9b6c4 LG	324	points to the first character of ConfigResp.\r
	325	@retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or\r
	326	Block parameter would result in this type of\r
	327	error. Progress points to the first character of\r
	328	ConfigResp.\r
	329	@retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted name /\r
	330	value pair. Block is left updated and\r
	331	Progress points at the '&' preceding the first\r
	332	non-<BlockName>.\r
6c4986de LG	333	@retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.\r
	334	@retval EFI_NOT_FOUND Target for the specified routing data was not found.\r
	335	Progress points to the "G" in "GUID" of the errant\r
	336	routing data.\r
5795218e ED	337	@retval EFI_BUFFER_TOO_SMALL Block not large enough. Progress undefined. \r
	338	BlockSize is updated with the required buffer size.\r
	339	\r
d1f95000	340	**/\r
	341	typedef\r
	342	EFI_STATUS\r
c8c44377	343	(EFIAPI * EFI_HII_CONFIG_TO_BLOCK)(\r
d1f95000	344	IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,\r
7d582d6b	345	IN CONST EFI_STRING ConfigResp,\r
7d582d6b	346	IN OUT UINT8 *Block,\r
d1f95000	347	IN OUT UINTN *BlockSize,\r
	348	OUT EFI_STRING *Progress\r
	349	);\r
	350	\r
4ca9b6c4 LG	351	/**\r
	352	This helper function is to be called by drivers to extract portions of \r
	353	a larger configuration string.\r
	354	\r
fbf926ad	355	@param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
a1e98f78	356	@param ConfigResp A null-terminated string in <ConfigAltResp> format.\r
4ca9b6c4 LG	357	@param Guid A pointer to the GUID value to search for in the \r
	358	routing portion of the ConfigResp string when retrieving \r
	359	the requested data. If Guid is NULL, then all GUID \r
	360	values will be searched for.\r
	361	@param Name A pointer to the NAME value to search for in the \r
	362	routing portion of the ConfigResp string when retrieving \r
	363	the requested data. If Name is NULL, then all Name \r
	364	values will be searched for. \r
	365	@param DevicePath A pointer to the PATH value to search for in the \r
	366	routing portion of the ConfigResp string when retrieving \r
	367	the requested data. If DevicePath is NULL, then all \r
	368	DevicePath values will be searched for. \r
	369	@param AltCfgId A pointer to the ALTCFG value to search for in the \r
	370	routing portion of the ConfigResp string when retrieving \r
	371	the requested data. If this parameter is NULL, \r
	372	then the current setting will be retrieved.\r
	373	@param AltCfgResp A pointer to a buffer which will be allocated by the \r
	374	function which contains the retrieved string as requested. \r
	375	This buffer is only allocated if the call was successful. \r
a1e98f78	376	The null-terminated string will be <ConfigResp> format.\r
4ca9b6c4 LG	377	\r
	378	@retval EFI_SUCCESS The request succeeded. The requested data was extracted \r
	379	and placed in the newly allocated AltCfgResp buffer.\r
	380	@retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp. \r
	381	@retval EFI_INVALID_PARAMETER Any parameter is invalid.\r
af2dc6a7	382	@retval EFI_NOT_FOUND The target for the specified routing data was not found.\r
4ca9b6c4	383	**/\r
7d582d6b	384	typedef\r
7d582d6b	385	EFI_STATUS \r
8b13229b	386	(EFIAPI * EFI_HII_GET_ALT_CFG)(\r
7d582d6b	387	IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This, \r
a1e98f78	388	IN CONST EFI_STRING ConfigResp, \r
7d582d6b	389	IN CONST EFI_GUID *Guid, \r
	390	IN CONST EFI_STRING Name, \r
	391	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, \r
	392	IN CONST UINT16 *AltCfgId,\r
	393	OUT EFI_STRING *AltCfgResp \r
ed66e1bc	394	);\r
7d582d6b	395	\r
44717a39	396	///\r
	397	/// This protocol defines the configuration routing interfaces\r
	398	/// between external applications and the HII. There may only be one\r
	399	/// instance of this protocol in the system.\r
	400	///\r
d1f95000	401	struct _EFI_HII_CONFIG_ROUTING_PROTOCOL {\r
c8c44377	402	EFI_HII_EXTRACT_CONFIG ExtractConfig;\r
	403	EFI_HII_EXPORT_CONFIG ExportConfig;\r
	404	EFI_HII_ROUTE_CONFIG RouteConfig;\r
	405	EFI_HII_BLOCK_TO_CONFIG BlockToConfig;\r
	406	EFI_HII_CONFIG_TO_BLOCK ConfigToBlock;\r
f754f721	407	EFI_HII_GET_ALT_CFG GetAltConfig;\r
d1f95000	408	};\r
	409	\r
	410	extern EFI_GUID gEfiHiiConfigRoutingProtocolGuid;\r
	411	\r
	412	\r
	413	#endif\r
	414	\r