]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/FormCallback.h
Add in OFFSET_OF macro as defined in MDE Library spec
[mirror_edk2.git] / MdePkg / Include / Protocol / FormCallback.h
index 7a1c5398b834d4b1dbba90c42aca4d2f21723f47..8845864be31acd5569f4e86179f7e68b4ed88cf6 100644 (file)
@@ -88,31 +88,22 @@ typedef struct {
 /**\r
   Returns the value of a variable. \r
 \r
-  @param  This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
-  \r
-  @param  VariableName A NULL-terminated Unicode string that is the \r
-  name of the vendor¡¯s variable. \r
-  \r
-  @param  VendorGuid A unique identifier for the vendor.\r
-  \r
-  @param  Attributes If not NULL, a pointer to the memory location to \r
-  return the attribute's bit-mask for the variable. \r
-  \r
-  @param  DataSize The size in bytes of the Buffer. A size of zero causes \r
-  the variable to be deleted.\r
-  \r
-  @param  Buffer The buffer to return the contents of the variable.\r
-\r
-  @retval EFI_SUCCESS  The function completed successfully.\r
-  \r
-  @retval EFI_NOT_FOUND  The variable was not found.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the result. \r
-  DataSize has been updated with the size needed to complete the request.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  One of the parameters has an invalid value.\r
-  \r
-  @retval EFI_DEVICE_ERROR  The variable could not be saved due to a hardware failure. \r
+  @param  This                  A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
+  @param  VariableName          A NULL-terminated Unicode string that is the\r
+                                name of the vendor's variable.\r
+  @param  VendorGuid            A unique identifier for the vendor.\r
+  @param  Attributes            If not NULL, a pointer to the memory location to\r
+                                return the attribute's bit-mask for the variable.\r
+  @param  DataSize              The size in bytes of the Buffer. A size of zero causes\r
+                                the variable to be deleted.\r
+  @param  Buffer                The buffer to return the contents of the variable.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_FOUND         The variable was not found.\r
+  @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the result.\r
+                                DataSize has been updated with the size needed to complete the request.\r
+  @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
+  @retval EFI_DEVICE_ERROR      The variable could not be saved due to a hardware failure.\r
 \r
 **/\r
 typedef\r
@@ -129,35 +120,26 @@ EFI_STATUS
 /**\r
   Sets the value of a variable. \r
 \r
-  @param  This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
-  \r
-  @param  VariableName A NULL-terminated Unicode string that is the \r
-  name of the vendor's variable. Each VariableName is unique for each VendorGuid.\r
-  \r
-  @param  VendorGuid A unique identifier for the vendor.\r
-  \r
-  @param  Attributes Attributes bit-mask to set for the variable. \r
-  \r
-  @param  DataSize The size in bytes of the Buffer. A size of zero causes \r
-  the variable to be deleted.\r
-  \r
-  @param  Buffer The buffer containing the contents of the variable.\r
-  \r
-  @param  ResetRequired Returns a value from the driver that abstracts \r
-  this information and will enable a system to know if a system reset \r
-  is required to achieve the configuration changes being enabled through \r
-  this function.\r
-\r
-  @retval EFI_SUCCESS  The firmware has successfully stored the variable and \r
-  its data as defined by the Attributes.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold \r
-  the variable and its data.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  An invalid combination of Attributes bits \r
-  was supplied, or the DataSize exceeds the maximum allowed.\r
-  \r
-  @retval EFI_DEVICE_ERROR  The variable could not be saved due to a hardware failure. \r
+  @param  This                  A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
+  @param  VariableName          A NULL-terminated Unicode string that is the\r
+                                name of the vendor's variable. Each VariableName is unique for each VendorGuid.\r
+  @param  VendorGuid            A unique identifier for the vendor.\r
+  @param  Attributes            Attributes bit-mask to set for the variable.\r
+  @param  DataSize              The size in bytes of the Buffer. A size of zero causes\r
+                                the variable to be deleted.\r
+  @param  Buffer                The buffer containing the contents of the variable.\r
+  @param  ResetRequired         Returns a value from the driver that abstracts\r
+                                this information and will enable a system to know if a system reset\r
+                                is required to achieve the configuration changes being enabled through\r
+                                this function.\r
+\r
+  @retval EFI_SUCCESS           The firmware has successfully stored the variable and\r
+                                its data as defined by the Attributes.\r
+  @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold\r
+                                the variable and its data.\r
+  @retval EFI_INVALID_PARAMETER An invalid combination of Attributes bits\r
+                                was supplied, or the DataSize exceeds the maximum allowed.\r
+  @retval EFI_DEVICE_ERROR      The variable could not be saved due to a hardware failure.\r
 \r
 **/\r
 typedef\r
@@ -175,16 +157,13 @@ EFI_STATUS
 /**\r
   This function is called to provide results data to the driver. \r
 \r
-  @param  This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
-  \r
-  @param  KeyValue A unique value which is sent to the original exporting \r
-  driver so that it can identify the type of data to expect. The format of \r
-  the data tends to vary based on the opcode that generated the callback. \r
-  \r
-  @param  Data A pointer to the data being sent to the original exporting driver. \r
-  \r
-  @param  Packet A pointer to a packet of information which a driver passes \r
-  back to the browser.\r
+  @param  This                  A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
+  @param  KeyValue              A unique value which is sent to the original exporting\r
+                                driver so that it can identify the type of data to expect. The format of\r
+                                the data tends to vary based on the opcode that generated the callback.\r
+  @param  Data                  A pointer to the data being sent to the original exporting driver.\r
+  @param  Packet                A pointer to a packet of information which a driver passes\r
+                                back to the browser.\r
 \r
   @return Status Code\r
 \r