[mirror_edk2.git] / SecurityPkg / VariableAuthenticated / SecureBootConfigDxe / SecureBootConfigImpl.h

/** @file\r
  The header file of HII Config Access protocol implementation of SecureBoot\r
  configuration module.\r
\r
Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r
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
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 __SECUREBOOT_CONFIG_IMPL_H__\r
#define __SECUREBOOT_CONFIG_IMPL_H__\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/HiiConfigRouting.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PrintLib.h>\r
\r
#include <Guid/MdeModuleHii.h>\r
#include <Guid/AuthenticatedVariableFormat.h>\r
\r
#include "SecureBootConfigNvData.h"\r
\r
//\r
// Tool generated IFR binary data and String package data\r
//\r
extern UINT8                        SecureBootConfigBin[];\r
extern UINT8                        SecureBootConfigDxeStrings[];\r
\r
///\r
/// HII specific Vendor Device Path definition.\r
///\r
typedef struct {\r
  VENDOR_DEVICE_PATH                VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL          End;\r
} HII_VENDOR_DEVICE_PATH;\r
\r
typedef struct {\r
  UINTN                             Signature;\r
\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL    ConfigAccess;\r
  EFI_HII_HANDLE                    HiiHandle;\r
  EFI_HANDLE                        DriverHandle;\r
\r
} SECUREBOOT_CONFIG_PRIVATE_DATA;\r
\r
extern SECUREBOOT_CONFIG_PRIVATE_DATA      mSecureBootConfigPrivateDateTemplate;\r
\r
#define SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE     SIGNATURE_32 ('S', 'E', 'C', 'B')\r
#define SECUREBOOT_CONFIG_PRIVATE_FROM_THIS(a)  CR (a, SECUREBOOT_CONFIG_PRIVATE_DATA, ConfigAccess, SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE)\r
\r
\r
/**\r
  This function publish the SecureBoot configuration Form.\r
\r
  @param[in, out]  PrivateData   Points to SecureBoot configuration private data.\r
\r
  @retval EFI_SUCCESS            HII Form is installed for this network device.\r
  @retval EFI_OUT_OF_RESOURCES   Not enough resource for HII Form installation.\r
  @retval Others                 Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
InstallSecureBootConfigForm (\r
  IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA  *PrivateData\r
  );\r
\r
/**\r
  This function removes SecureBoot configuration Form.\r
\r
  @param[in, out]  PrivateData   Points to SecureBoot configuration private data.\r
\r
**/\r
VOID\r
UninstallSecureBootConfigForm (\r
  IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA    *PrivateData\r
  );\r
\r
/**\r
  This function allows a caller to extract the current configuration for one\r
  or more named elements from the target driver.\r
\r
  @param[in]   This              Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param[in]   Request           A null-terminated Unicode string in\r
                                 <ConfigRequest> format.\r
  @param[out]  Progress          On return, points to a character in the Request\r
                                 string. Points to the string's null terminator if\r
                                 request was successful. Points to the most recent\r
                                 '&' before the first failing name/value pair (or\r
                                 the beginning of the string if the failure is in\r
                                 the first name/value pair) if the request was not\r
                                 successful.\r
  @param[out]  Results           A null-terminated Unicode string in\r
                                 <ConfigAltResp> format which has all values filled\r
                                 in for the names in the Request string. String to\r
                                 be allocated by the called function.\r
\r
  @retval EFI_SUCCESS            The Results is filled with the requested values.\r
  @retval EFI_OUT_OF_RESOURCES   Not enough memory to store the results.\r
  @retval EFI_INVALID_PARAMETER  Request is illegal syntax, or unknown name.\r
  @retval EFI_NOT_FOUND          Routing data doesn't match any storage in this\r
                                 driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SecureBootExtractConfig (\r
  IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL        *This,\r
  IN CONST EFI_STRING                            Request,\r
       OUT EFI_STRING                            *Progress,\r
       OUT EFI_STRING                            *Results\r
  );\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
  @param[in]  This               Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param[in]  Configuration      A null-terminated Unicode string in <ConfigResp>\r
                                 format.\r
  @param[out] Progress           A pointer to a string filled in with the offset of\r
                                 the most recent '&' before the first failing\r
                                 name/value pair (or the beginning of the string if\r
                                 the failure is in the first name/value pair) or\r
                                 the terminating NULL if all was successful.\r
\r
  @retval EFI_SUCCESS            The Results is processed successfully.\r
  @retval EFI_INVALID_PARAMETER  Configuration is NULL.\r
  @retval EFI_NOT_FOUND          Routing data doesn't match any storage in this\r
                                 driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SecureBootRouteConfig (\r
  IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL      *This,\r
  IN CONST EFI_STRING                          Configuration,\r
       OUT EFI_STRING                          *Progress\r
  );\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
  @param[in]  This               Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param[in]  Action             Specifies the type of action taken by the browser.\r
  @param[in]  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.\r
  @param[in]  Type               The type of value for the question.\r
  @param[in]  Value              A pointer to the data being sent to the original\r
                                 exporting driver.\r
  @param[out] 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
**/\r
EFI_STATUS\r
EFIAPI\r
SecureBootCallback (\r
  IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL      *This,\r
  IN     EFI_BROWSER_ACTION                    Action,\r
  IN     EFI_QUESTION_ID                       QuestionId,\r
  IN     UINT8                                 Type,\r
  IN     EFI_IFR_TYPE_VALUE                    *Value,\r
     OUT EFI_BROWSER_ACTION_REQUEST            *ActionRequest\r
  );\r
\r
#endif\r
Commit	Line	Data
beda2356	1	/** @file\r
	2	The header file of HII Config Access protocol implementation of SecureBoot\r
	3	configuration module.\r
	4	\r
	5	Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r
bc0c99b3	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
beda2356	9	http://opensource.org/licenses/bsd-license.php\r
beda2356	10	\r
bc0c99b3	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
beda2356	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef __SECUREBOOT_CONFIG_IMPL_H__\r
	17	#define __SECUREBOOT_CONFIG_IMPL_H__\r
	18	\r
	19	#include <Uefi.h>\r
	20	\r
	21	#include <Protocol/HiiConfigAccess.h>\r
	22	#include <Protocol/HiiConfigRouting.h>\r
	23	\r
	24	#include <Library/BaseLib.h>\r
	25	#include <Library/BaseMemoryLib.h>\r
	26	#include <Library/DebugLib.h>\r
	27	#include <Library/MemoryAllocationLib.h>\r
	28	#include <Library/UefiBootServicesTableLib.h>\r
	29	#include <Library/UefiRuntimeServicesTableLib.h>\r
	30	#include <Library/UefiHiiServicesLib.h>\r
	31	#include <Library/UefiLib.h>\r
	32	#include <Library/HiiLib.h>\r
	33	#include <Library/DevicePathLib.h>\r
bc0c99b3	34	#include <Library/PrintLib.h>\r
beda2356	35	\r
	36	#include <Guid/MdeModuleHii.h>\r
	37	#include <Guid/AuthenticatedVariableFormat.h>\r
	38	\r
	39	#include "SecureBootConfigNvData.h"\r
	40	\r
	41	//\r
	42	// Tool generated IFR binary data and String package data\r
	43	//\r
	44	extern UINT8 SecureBootConfigBin[];\r
	45	extern UINT8 SecureBootConfigDxeStrings[];\r
	46	\r
	47	///\r
	48	/// HII specific Vendor Device Path definition.\r
	49	///\r
	50	typedef struct {\r
	51	VENDOR_DEVICE_PATH VendorDevicePath;\r
	52	EFI_DEVICE_PATH_PROTOCOL End;\r
	53	} HII_VENDOR_DEVICE_PATH;\r
	54	\r
	55	typedef struct {\r
	56	UINTN Signature;\r
	57	\r
	58	EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess;\r
	59	EFI_HII_HANDLE HiiHandle;\r
	60	EFI_HANDLE DriverHandle;\r
	61	\r
	62	} SECUREBOOT_CONFIG_PRIVATE_DATA;\r
	63	\r
	64	extern SECUREBOOT_CONFIG_PRIVATE_DATA mSecureBootConfigPrivateDateTemplate;\r
	65	\r
	66	#define SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('S', 'E', 'C', 'B')\r
bc0c99b3	67	#define SECUREBOOT_CONFIG_PRIVATE_FROM_THIS(a) CR (a, SECUREBOOT_CONFIG_PRIVATE_DATA, ConfigAccess, SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE)\r
bc0c99b3	68	\r
beda2356	69	\r
	70	/**\r
	71	This function publish the SecureBoot configuration Form.\r
	72	\r
	73	@param[in, out] PrivateData Points to SecureBoot configuration private data.\r
	74	\r
	75	@retval EFI_SUCCESS HII Form is installed for this network device.\r
	76	@retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.\r
	77	@retval Others Other errors as indicated.\r
	78	\r
	79	**/\r
	80	EFI_STATUS\r
	81	InstallSecureBootConfigForm (\r
	82	IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData\r
	83	);\r
	84	\r
	85	/**\r
	86	This function removes SecureBoot configuration Form.\r
	87	\r
	88	@param[in, out] PrivateData Points to SecureBoot configuration private data.\r
	89	\r
	90	**/\r
beda2356	91	VOID\r
	92	UninstallSecureBootConfigForm (\r
	93	IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData\r
	94	);\r
	95	\r
	96	/**\r
	97	This function allows a caller to extract the current configuration for one\r
	98	or more named elements from the target driver.\r
	99	\r
	100	@param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
	101	@param[in] Request A null-terminated Unicode string in\r
	102	<ConfigRequest> format.\r
	103	@param[out] Progress On return, points to a character in the Request\r
	104	string. Points to the string's null terminator if\r
	105	request was successful. Points to the most recent\r
	106	'&' before the first failing name/value pair (or\r
	107	the beginning of the string if the failure is in\r
	108	the first name/value pair) if the request was not\r
	109	successful.\r
	110	@param[out] Results A null-terminated Unicode string in\r
	111	<ConfigAltResp> format which has all values filled\r
	112	in for the names in the Request string. String to\r
	113	be allocated by the called function.\r
	114	\r
	115	@retval EFI_SUCCESS The Results is filled with the requested values.\r
	116	@retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r
	117	@retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.\r
	118	@retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r
	119	driver.\r
	120	\r
	121	**/\r
	122	EFI_STATUS\r
	123	EFIAPI\r
	124	SecureBootExtractConfig (\r
	125	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
	126	IN CONST EFI_STRING Request,\r
	127	OUT EFI_STRING *Progress,\r
	128	OUT EFI_STRING *Results\r
	129	);\r
	130	\r
	131	/**\r
	132	This function processes the results of changes in configuration.\r
	133	\r
	134	@param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
	135	@param[in] Configuration A null-terminated Unicode string in <ConfigResp>\r
	136	format.\r
	137	@param[out] Progress A pointer to a string filled in with the offset of\r
	138	the most recent '&' before the first failing\r
	139	name/value pair (or the beginning of the string if\r
	140	the failure is in the first name/value pair) or\r
	141	the terminating NULL if all was successful.\r
	142	\r
	143	@retval EFI_SUCCESS The Results is processed successfully.\r
	144	@retval EFI_INVALID_PARAMETER Configuration is NULL.\r
	145	@retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r
	146	driver.\r
	147	\r
	148	**/\r
	149	EFI_STATUS\r
	150	EFIAPI\r
	151	SecureBootRouteConfig (\r
	152	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
	153	IN CONST EFI_STRING Configuration,\r
	154	OUT EFI_STRING *Progress\r
155	);\r
156	\r
157	/**\r
158	This function processes the results of changes in configuration.\r
159	\r
160	@param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
161	@param[in] Action Specifies the type of action taken by the browser.\r
162	@param[in] QuestionId A unique value which is sent to the original\r
163	exporting driver so that it can identify the type\r
164	of data to expect.\r
165	@param[in] Type The type of value for the question.\r
166	@param[in] Value A pointer to the data being sent to the original\r
167	exporting driver.\r
168	@param[out] ActionRequest On return, points to the action requested by the\r
169	callback function.\r
170	\r
171	@retval EFI_SUCCESS The callback successfully handled the action.\r
172	@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the\r
173	variable and its data.\r
174	@retval EFI_DEVICE_ERROR The variable could not be saved.\r
175	@retval EFI_UNSUPPORTED The specified Action is not supported by the\r
176	callback.\r
177	\r
178	**/\r
179	EFI_STATUS\r
180	EFIAPI\r
181	SecureBootCallback (\r
182	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
183	IN EFI_BROWSER_ACTION Action,\r
184	IN EFI_QUESTION_ID QuestionId,\r
185	IN UINT8 Type,\r
186	IN EFI_IFR_TYPE_VALUE *Value,\r
187	OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
188	);\r
189	\r
190	#endif\r