4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI HII results processing protocol invokes this type of protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when it needs to forward results to a driver's configuration handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This protocol is published by drivers providing and requesting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data from HII. It may only be invoked by HII.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x330d4706, 0xf2a0, 0x4e4f, { 0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_HII_CONFIG_ACCESS_PROTOCOL EFI_HII_CONFIG_ACCESS_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING 0x1001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function allows the caller to request the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration for one or more named elements. The resulting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string is in <ConfigAltResp> format. Any and all alternative
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration strings shall also be appended to the end of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current configuration string. If they are, they must appear
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after the current configuration. They must contain the same
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync routing (GUID, NAME, PATH) as the current configuration string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync They must have an additional description indicating the type of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync alternative configuration the string represents,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "ALTCFG=<StringToken>". That <StringToken> (when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync converted from Hex UNICODE to binary) is a reference to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string in the associated string pack.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Request A null-terminated Unicode string in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <ConfigRequest> format. Note that this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync includes the routing information as well as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the configurable name / value pairs. It is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync invalid for this string to be in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <MultiConfigRequest> format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If a NULL is passed in for the Request field,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all of the settings being abstracted by this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be returned in the Results field. In addition,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if a ConfigHdr is passed in with no request elements,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all of the settings being abstracted for that particular
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ConfigHdr reference will be returned in the Results Field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Progress On return, points to a character in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Request string. Points to the string's null
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync terminator if request was successful. Points
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the most recent "&" before the first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync failing name / value pair (or the beginning
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the string if the failure is in the first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync name / value pair) if the request was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Results A null-terminated Unicode string in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <MultiConfigAltResp> format which has all values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filled in for the names in the Request string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync String to be allocated by the called function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The Results string is filled with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync values corresponding to all requested
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parts of the results that must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stored awaiting possible future
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Routing data doesn't match any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync known driver. Progress set to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync first character in the routing header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: There is no requirement that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver validate the routing data. It
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must skip the <ConfigHdr> in order to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync process the names.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to most recent "&" before the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync error or the beginning of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Unknown name. Progress points
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the & before the name in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function applies changes in a driver's configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Input is a Configuration, which has the routing data for this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver followed by name / value configuration pairs. The driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must apply those pairs to its configurable storage. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver's configuration is stored in a linear block of data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the driver's name / value pairs are in <BlockConfig>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync format, it may use the ConfigToBlock helper function (above) to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync simplify the job.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Configuration A null-terminated Unicode string in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <ConfigString> format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Progress A pointer to a string filled in with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync offset of the most recent '&' before the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync first failing name / value pair (or the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync beginn ing of the string if the failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is in the first name / value pair) or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the terminating NULL if all was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The results have been distributed or are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync awaiting distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parts of the results that must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stored awaiting possible future
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETERS Passing in a NULL for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Results parameter would result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in this type of error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Target for the specified routing data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was not found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called to provide results data to the driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This data consists of a unique key that is used to identify
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which data is either being passed back or being asked for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Action Specifies the type of action taken by the browser.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param QuestionId A unique value which is sent to the original
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exporting driver so that it can identify the type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of data to expect. The format of the data tends to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync vary based on the opcode that generated the callback.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Type The type of value for the question.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value A pointer to the data being sent to the original
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exporting driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ActionRequest On return, points to the action requested by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync callback function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The callback successfully handled the action.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable and its data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The variable could not be saved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The specified Action is not supported by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This protocol provides a callable interface between the HII and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// drivers. Only drivers which provide IFR data to HII are required
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// to publish this protocol.