]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/BdsDxe/FrontPage.h
Clean up to update the reference of the these macros:
[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / FrontPage.h
index 00d8c685a588e36be7ca682aeedd5d9b1009a2e6..d8e3bb49b82c1b0a6a2988470818875064dc1be4 100644 (file)
@@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _FRONT_PAGE_H\r
-#define _FRONT_PAGE_H\r
+#ifndef _FRONT_PAGE_H_\r
+#define _FRONT_PAGE_H_\r
 \r
 #include "DeviceMngr/DeviceManager.h"\r
 #include "BootMaint/BootMaint.h"\r
@@ -43,10 +43,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #define FRONT_PAGE_FORMSET_GUID \\r
   { \\r
-    0x9e0c30bc, 0x3f06, 0x4ba6, 0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe \\r
+    0x9e0c30bc, 0x3f06, 0x4ba6, {0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe} \\r
   }\r
 \r
-#define FRONT_PAGE_CALLBACK_DATA_SIGNATURE  EFI_SIGNATURE_32 ('F', 'P', 'C', 'B')\r
+#define FRONT_PAGE_CALLBACK_DATA_SIGNATURE  SIGNATURE_32 ('F', 'P', 'C', 'B')\r
 \r
 typedef struct {\r
   UINTN                           Signature;\r
@@ -84,6 +84,28 @@ extern EFI_HII_CONFIG_ROUTING_PROTOCOL *gHiiConfigRouting;
 extern UINTN    gCallbackKey;\r
 extern BOOLEAN  gConnectAllHappened;\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
 FakeExtractConfig (\r
@@ -93,6 +115,22 @@ FakeExtractConfig (
   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
 FakeRouteConfig (\r
@@ -101,6 +139,24 @@ FakeRouteConfig (
   OUT EFI_STRING                             *Progress\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 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_OUT_OF_RESOURCES  Not enough storage is available to hold the 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 callback.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 FrontPageCallback (\r
@@ -112,11 +168,32 @@ FrontPageCallback (
   OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest\r
   );\r
 \r
+/**\r
+  Initialize HII information for the FrontPage\r
+\r
+\r
+  @param InitializeHiiData    TRUE if HII elements need to be initialized.\r
+\r
+  @retval  EFI_SUCCESS        The operation is successful.\r
+  @retval  EFI_DEVICE_ERROR   If the dynamic opcode creation failed.\r
+\r
+**/\r
 EFI_STATUS\r
 InitializeFrontPage (\r
-  IN BOOLEAN    ReInitializeStrings\r
+  IN BOOLEAN    InitializeHiiData\r
   );\r
 \r
+/**\r
+  Acquire the string associated with the ProducerGuid and return it.\r
+\r
+\r
+  @param ProducerGuid    - The Guid to search the HII database for\r
+  @param Token           - The token value of the string to extract\r
+  @param String          - The string that is extracted\r
+\r
+  @retval  EFI_SUCCESS  The function returns EFI_SUCCESS always.\r
+\r
+**/\r
 EFI_STATUS\r
 GetProducerString (\r
   IN      EFI_GUID                  *ProducerGuid,\r
@@ -124,12 +201,35 @@ GetProducerString (
   OUT     CHAR16                    **String\r
   );\r
 \r
+/**\r
+  Compare two EFI_TIME data.\r
+\r
+\r
+  @param FirstTime       - A pointer to the first EFI_TIME data.\r
+  @param SecondTime      - A pointer to the second EFI_TIME data.\r
+\r
+  @retval  TRUE              The FirstTime is not later than the SecondTime.\r
+  @retval  FALSE             The FirstTime is later than the SecondTime.\r
+\r
+**/\r
 BOOLEAN\r
 TimeCompare (\r
   IN EFI_TIME               *FirstTime,\r
   IN EFI_TIME               *SecondTime\r
   );\r
 \r
+/**\r
+  This function is the main entry of the platform setup entry.\r
+  The function will present the main menu of the system setup,\r
+  this is the platform reference part and can be customize.\r
+\r
+\r
+  @param TimeoutDefault  - The fault time out value before the system\r
+                         continue to boot.\r
+  @param ConnectAllHappened - The indicater to check if the connect all have\r
+                         already happended.\r
+\r
+**/\r
 VOID\r
 PlatformBdsEnterFrontPage (\r
   IN UINT16                 TimeoutDefault,\r