#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
\r
-\r
#define MIN_ALIGNMENT_SIZE 4\r
#define ALIGN_SIZE(a) ((a % MIN_ALIGNMENT_SIZE) ? MIN_ALIGNMENT_SIZE - (a % MIN_ALIGNMENT_SIZE) : 0)\r
\r
\r
-#define EFI_CALLBACK_INFO_SIGNATURE EFI_SIGNATURE_32 ('C', 'l', 'b', 'k')\r
+#define EFI_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('C', 'l', 'b', 'k')\r
#define EFI_CALLBACK_INFO_FROM_THIS(a) CR (a, EFI_CALLBACK_INFO, ConfigAccess, EFI_CALLBACK_INFO_SIGNATURE)\r
#define MAX_CHOICE_NUM 0x100\r
#define UPDATE_DATA_SIZE 0x1000\r
//\r
#define PLAT_OVER_MNGR_GUID \\r
{ \\r
- 0x8614567d, 0x35be, 0x4415, 0x8d, 0x88, 0xbd, 0x7d, 0xc, 0x9c, 0x70, 0xc0 \\r
+ 0x8614567d, 0x35be, 0x4415, {0x8d, 0x88, 0xbd, 0x7d, 0xc, 0x9c, 0x70, 0xc0} \\r
}\r
\r
typedef struct {\r
EFI_STRING_ID DescriptionToken;\r
} CFG_PROTOCOL_INVOKER_CHOICE;\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 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
PlatOverMngrExtractConfig (\r
- IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\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 This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+ @param Configuration A null-terminated Unicode string in <ConfigRequest> 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
PlatOverMngrRouteConfig (\r
OUT EFI_STRING *Progress\r
);\r
\r
+/**\r
+ This is the function that is called to provide results data to the driver. This data\r
+ consists of a unique key which is used to identify what data is either being passed back\r
+ or being asked for.\r
+\r
+ @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+ @param Action A null-terminated Unicode string in <ConfigRequest> format.\r
+ @param KeyValue A unique Goto OpCode callback value which record user's selection.\r
+ 0x100 <= KeyValue <0x500 : user select a controller item in the first page;\r
+ KeyValue == 0x1234 : user select 'Refresh' in first page, or user select 'Go to Previous Menu' in second page\r
+ KeyValue == 0x1235 : user select 'Pci device filter' in first page\r
+ KeyValue == 0x1500 : user select 'order ... priority' item in second page\r
+ KeyValue == 0x1800 : user select 'commint changes' in third page\r
+ KeyValue == 0x2000 : user select 'Go to Previous Menu' in third page\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 Always returned.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PlatOverMngrCallback (\r
OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
);\r
\r
+/**\r
+ Get the image name\r
+\r
+ @param Image Image to search.\r
+\r
+ @retval !NULL Pointer into the image name if the image name is found,\r
+ @retval NULL Pointer to NULL if the image name is not found.\r
+\r
+**/\r
CHAR16 *\r
GetImageName (\r
- IN EFI_LOADED_IMAGE_PROTOCOL *Image\r
+ IN EFI_LOADED_IMAGE_PROTOCOL *Image\r
);\r
\r
-CHAR16 *\r
-DevicePathToStr (\r
- EFI_DEVICE_PATH_PROTOCOL *DevPath\r
- );\r
+/**\r
+ Get the description string by device path.\r
+\r
+ @param DevPath The input device path.\r
\r
+ @retval !NULL The description string retured.\r
+ @retval NULL The description string cannot be found.\r
\r
-EFI_DEVICE_PATH_PROTOCOL *\r
-UnpackDevicePath (\r
- IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
+**/\r
+CHAR16 *\r
+DevicePathToStr (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
);\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff