[mirror_edk2.git] / MdeModulePkg / Library / BootManagerLib / BootManager.h

/** @file\r
  The boot manager reference implement\r
\r
  Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>\r
  This software and associated documentation (if any) is furnished\r
  under a license and may only be used or copied in accordance\r
  with the terms of the license. Except as permitted by such\r
  license, no part of this software or documentation may be\r
  reproduced, stored in a retrieval system, or transmitted in any\r
  form or by any means without the express written consent of\r
  Intel Corporation.\r
\r
**/\r
\r
#ifndef _EFI_BOOT_MANAGER_H_\r
#define _EFI_BOOT_MANAGER_H_\r
\r
#include <Guid/MdeModuleHii.h>\r
#include <Guid/GlobalVariable.h>\r
\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/DevicePathToText.h>\r
\r
#include <Library/PrintLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/UefiBootManagerLib.h>\r
\r
#pragma pack(1)\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
#pragma pack()\r
\r
//\r
// These are defined as the same with vfr file\r
//\r
#define BOOT_MANAGER_FORMSET_GUID \\r
  { \\r
  0x847bc3fe, 0xb974, 0x446d, {0x94, 0x49, 0x5a, 0xd5, 0x41, 0x2e, 0x99, 0x3b} \\r
  }\r
\r
#define BOOT_MANAGER_FORM_ID     0x1000\r
\r
#define LABEL_BOOT_OPTION        0x00\r
#define LABEL_BOOT_OPTION_END    0x01\r
\r
//\r
// Variable created with this flag will be "Efi:...."\r
//\r
#define VAR_FLAG  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE\r
\r
//\r
// These are the VFR compiler generated data representing our VFR data.\r
//\r
extern UINT8 BootManagerVfrBin[];\r
\r
#define BOOT_MANAGER_CALLBACK_DATA_SIGNATURE  SIGNATURE_32 ('B', 'M', 'C', 'B')\r
\r
typedef struct {\r
  UINTN                           Signature;\r
\r
  //\r
  // HII relative handles\r
  //\r
  EFI_HII_HANDLE                  HiiHandle;\r
  EFI_HANDLE                      DriverHandle;\r
\r
  //\r
  // Produced protocols\r
  //\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;\r
} BOOT_MANAGER_CALLBACK_DATA;\r
\r
/**\r
  This call back function is registered with Boot Manager formset.\r
  When user selects a boot option, this call back function will\r
  be triggered. The boot option is saved for later processing.\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 exporting driver\r
                         so that it can identify the type of data to expect.\r
  @param Type            The type of value for the question.\r
  @param Value           A pointer to the data being sent to the original exporting driver.\r
  @param ActionRequest   On return, points to the action requested by the callback function.\r
\r
  @retval  EFI_SUCCESS           The callback successfully handled the action.\r
  @retval  EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootManagerCallback (\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
/**\r
  This function allows a caller to extract the current configuration for one\r
  or more named elements from the target driver.\r
\r
\r
  @param This            - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Request         - A null-terminated Unicode string in <ConfigRequest> format.\r
  @param Progress        - On return, points to a character in the Request string.\r
                         Points to the string's null terminator if request was successful.\r
                         Points to the most recent '&' before the first failing name/value\r
                         pair (or the beginning of the string if the failure is in the\r
                         first name/value pair) if the request was not successful.\r
  @param Results         - A null-terminated Unicode string in <ConfigAltResp> format which\r
                         has all values 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 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 NULL, illegal syntax, or unknown name.\r
  @retval  EFI_NOT_FOUND          Routing data doesn't match any storage in this driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootManagerExtractConfig (\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
\r
  @param This            - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Configuration   - A null-terminated Unicode string in <ConfigResp> format.\r
  @param Progress        - A pointer to a string filled in with the offset of the most\r
                         recent '&' before the first failing name/value pair (or the\r
                         beginning of the string if the failure is in the first\r
                         name/value pair) or 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 driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootManagerRouteConfig (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,\r
  IN  CONST EFI_STRING                       Configuration,\r
  OUT EFI_STRING                             *Progress\r
  );\r
\r
#endif\r
Commit	Line	Data
3a2dc0f5 DB	1	/** @file\r
	2	The boot manager reference implement\r
	3	\r
	4	Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>\r
	5	This software and associated documentation (if any) is furnished\r
	6	under a license and may only be used or copied in accordance\r
	7	with the terms of the license. Except as permitted by such\r
	8	license, no part of this software or documentation may be\r
	9	reproduced, stored in a retrieval system, or transmitted in any\r
	10	form or by any means without the express written consent of\r
	11	Intel Corporation.\r
	12	\r
	13	**/\r
	14	\r
	15	#ifndef _EFI_BOOT_MANAGER_H_\r
	16	#define _EFI_BOOT_MANAGER_H_\r
	17	\r
	18	#include <Guid/MdeModuleHii.h>\r
	19	#include <Guid/GlobalVariable.h>\r
	20	\r
	21	#include <Protocol/HiiConfigAccess.h>\r
	22	#include <Protocol/DevicePathToText.h>\r
	23	\r
	24	#include <Library/PrintLib.h>\r
	25	#include <Library/DebugLib.h>\r
	26	#include <Library/BaseMemoryLib.h>\r
	27	#include <Library/UefiBootServicesTableLib.h>\r
	28	#include <Library/UefiLib.h>\r
	29	#include <Library/MemoryAllocationLib.h>\r
	30	#include <Library/UefiRuntimeServicesTableLib.h>\r
	31	#include <Library/HiiLib.h>\r
	32	#include <Library/DevicePathLib.h>\r
	33	#include <Library/UefiBootManagerLib.h>\r
	34	\r
	35	#pragma pack(1)\r
	36	\r
	37	///\r
	38	/// HII specific Vendor Device Path definition.\r
	39	///\r
	40	typedef struct {\r
	41	VENDOR_DEVICE_PATH VendorDevicePath;\r
	42	EFI_DEVICE_PATH_PROTOCOL End;\r
	43	} HII_VENDOR_DEVICE_PATH;\r
	44	#pragma pack()\r
	45	\r
	46	//\r
	47	// These are defined as the same with vfr file\r
	48	//\r
	49	#define BOOT_MANAGER_FORMSET_GUID \\r
	50	{ \\r
	51	0x847bc3fe, 0xb974, 0x446d, {0x94, 0x49, 0x5a, 0xd5, 0x41, 0x2e, 0x99, 0x3b} \\r
	52	}\r
	53	\r
	54	#define BOOT_MANAGER_FORM_ID 0x1000\r
	55	\r
	56	#define LABEL_BOOT_OPTION 0x00\r
	57	#define LABEL_BOOT_OPTION_END 0x01\r
	58	\r
	59	//\r
	60	// Variable created with this flag will be "Efi:...."\r
	61	//\r
	62	#define VAR_FLAG EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS \| EFI_VARIABLE_NON_VOLATILE\r
	63	\r
	64	//\r
65	// These are the VFR compiler generated data representing our VFR data.\r
66	//\r
67	extern UINT8 BootManagerVfrBin[];\r
68	\r
69	#define BOOT_MANAGER_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('B', 'M', 'C', 'B')\r
70	\r
71	typedef struct {\r
72	UINTN Signature;\r
73	\r
74	//\r
75	// HII relative handles\r
76	//\r
77	EFI_HII_HANDLE HiiHandle;\r
78	EFI_HANDLE DriverHandle;\r
79	\r
80	//\r
81	// Produced protocols\r
82	//\r
83	EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess;\r
84	} BOOT_MANAGER_CALLBACK_DATA;\r
85	\r
86	/**\r
87	This call back function is registered with Boot Manager formset.\r
88	When user selects a boot option, this call back function will\r
89	be triggered. The boot option is saved for later processing.\r
90	\r
91	\r
92	@param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
93	@param Action Specifies the type of action taken by the browser.\r
94	@param QuestionId A unique value which is sent to the original exporting driver\r
95	so that it can identify the type of data to expect.\r
96	@param Type The type of value for the question.\r
97	@param Value A pointer to the data being sent to the original exporting driver.\r
98	@param ActionRequest On return, points to the action requested by the callback function.\r
99	\r
100	@retval EFI_SUCCESS The callback successfully handled the action.\r
101	@retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.\r
102	\r
103	**/\r
104	EFI_STATUS\r
105	EFIAPI\r
106	BootManagerCallback (\r
107	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
108	IN EFI_BROWSER_ACTION Action,\r
109	IN EFI_QUESTION_ID QuestionId,\r
110	IN UINT8 Type,\r
111	IN EFI_IFR_TYPE_VALUE *Value,\r
112	OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
113	);\r
114	\r
115	/**\r
116	This function allows a caller to extract the current configuration for one\r
117	or more named elements from the target driver.\r
118	\r
119	\r
120	@param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
121	@param Request - A null-terminated Unicode string in <ConfigRequest> format.\r
122	@param Progress - On return, points to a character in the Request string.\r
123	Points to the string's null terminator if request was successful.\r
124	Points to the most recent '&' before the first failing name/value\r
125	pair (or the beginning of the string if the failure is in the\r
126	first name/value pair) if the request was not successful.\r
127	@param Results - A null-terminated Unicode string in <ConfigAltResp> format which\r
128	has all values filled in for the names in the Request string.\r
129	String to be allocated by the called function.\r
130	\r
131	@retval EFI_SUCCESS The Results is filled with the requested values.\r
132	@retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r
133	@retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r
134	@retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
135	\r
136	**/\r
137	EFI_STATUS\r
138	EFIAPI\r
139	BootManagerExtractConfig (\r
140	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
141	IN CONST EFI_STRING Request,\r
142	OUT EFI_STRING *Progress,\r
143	OUT EFI_STRING *Results\r
144	);\r
145	\r
146	/**\r
147	This function processes the results of changes in configuration.\r
148	\r
149	\r
150	@param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
151	@param Configuration - A null-terminated Unicode string in <ConfigResp> format.\r
152	@param Progress - A pointer to a string filled in with the offset of the most\r
153	recent '&' before the first failing name/value pair (or the\r
154	beginning of the string if the failure is in the first\r
155	name/value pair) or the terminating NULL if all was successful.\r
156	\r
157	@retval EFI_SUCCESS The Results is processed successfully.\r
158	@retval EFI_INVALID_PARAMETER Configuration is NULL.\r
159	@retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
160	\r
161	**/\r
162	EFI_STATUS\r
163	EFIAPI\r
164	BootManagerRouteConfig (\r
165	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
166	IN CONST EFI_STRING Configuration,\r
167	OUT EFI_STRING *Progress\r
168	);\r
169	\r
170	#endif\r