]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/XenBusDxe/XenStore.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / OvmfPkg / XenBusDxe / XenStore.h
index 9020411f6a11767426afe05fe2b00783166143df..b2ae8055243e363ea94a4be19ba45fc083cdd2f4 100644 (file)
@@ -9,23 +9,7 @@
   This file may be distributed separately from the Linux kernel, or\r
   incorporated into other software packages, subject to the following license:\r
 \r
-  Permission is hereby granted, free of charge, to any person obtaining a copy\r
-  of this source file (the "Software"), to deal in the Software without\r
-  restriction, including without limitation the rights to use, copy, modify,\r
-  merge, publish, distribute, sublicense, and/or sell copies of the Software,\r
-  and to permit persons to whom the Software is furnished to do so, subject to\r
-  the following conditions:\r
-\r
-  The above copyright notice and this permission notice shall be included in\r
-  all copies or substantial portions of the Software.\r
-\r
-  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
-  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
-  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
-  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
-  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\r
-  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\r
-  IN THE SOFTWARE.\r
+  SPDX-License-Identifier: MIT\r
 **/\r
 \r
 #ifndef _XEN_XENSTORE_XENSTOREVAR_H\r
@@ -54,11 +38,11 @@ typedef struct _XENSTORE_WATCH XENSTORE_WATCH;
 **/\r
 XENSTORE_STATUS\r
 XenStoreListDirectory (\r
-  IN  XENSTORE_TRANSACTION  Transaction,\r
-  IN  CONST CHAR8           *DirectoryPath,\r
-  IN  CONST CHAR8           *Node,\r
-  OUT UINT32                *DirectoryCountPtr,\r
-  OUT CONST CHAR8           ***DirectoryListPtr\r
+  IN  CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN  CONST CHAR8                 *DirectoryPath,\r
+  IN  CONST CHAR8                 *Node,\r
+  OUT UINT32                      *DirectoryCountPtr,\r
+  OUT CONST CHAR8                 ***DirectoryListPtr\r
   );\r
 \r
 /**\r
@@ -74,9 +58,9 @@ XenStoreListDirectory (
 **/\r
 BOOLEAN\r
 XenStorePathExists (\r
-  IN XENSTORE_TRANSACTION  Transaction,\r
-  IN CONST CHAR8 *Directory,\r
-  IN CONST CHAR8 *Node\r
+  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN CONST CHAR8                 *Directory,\r
+  IN CONST CHAR8                 *Node\r
   );\r
 \r
 /**\r
@@ -98,11 +82,11 @@ XenStorePathExists (
 **/\r
 XENSTORE_STATUS\r
 XenStoreRead (\r
-  IN  XENSTORE_TRANSACTION    Transaction,\r
-  IN  CONST CHAR8             *DirectoryPath,\r
-  IN  CONST CHAR8             *Node,\r
-  OUT UINT32                  *LenPtr OPTIONAL,\r
-  OUT VOID                    **Result\r
+  IN  CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN  CONST CHAR8                 *DirectoryPath,\r
+  IN  CONST CHAR8                 *Node,\r
+  OUT UINT32                      *LenPtr OPTIONAL,\r
+  OUT VOID                        **Result\r
   );\r
 \r
 /**\r
@@ -118,10 +102,10 @@ XenStoreRead (
 **/\r
 XENSTORE_STATUS\r
 XenStoreWrite (\r
-  IN XENSTORE_TRANSACTION  Transaction,\r
-  IN CONST CHAR8           *DirectoryPath,\r
-  IN CONST CHAR8           *Node,\r
-  IN CONST CHAR8           *Str\r
+  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN CONST CHAR8                 *DirectoryPath,\r
+  IN CONST CHAR8                 *Node,\r
+  IN CONST CHAR8                 *Str\r
   );\r
 \r
 /**\r
@@ -136,9 +120,9 @@ XenStoreWrite (
 **/\r
 XENSTORE_STATUS\r
 XenStoreRemove (\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
-  IN CONST CHAR8            *DirectoryPath,\r
-  IN CONST CHAR8            *Node\r
+  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN CONST CHAR8                 *DirectoryPath,\r
+  IN CONST CHAR8                 *Node\r
   );\r
 \r
 /**\r
@@ -170,8 +154,8 @@ XenStoreTransactionStart (
 **/\r
 XENSTORE_STATUS\r
 XenStoreTransactionEnd (\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
-  IN BOOLEAN                Abort\r
+  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN BOOLEAN                     Abort\r
   );\r
 \r
 /**\r
@@ -189,10 +173,10 @@ XenStoreTransactionEnd (
 XENSTORE_STATUS\r
 EFIAPI\r
 XenStoreSPrint (\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
-  IN CONST CHAR8            *DirectoryPath,\r
-  IN CONST CHAR8            *Node,\r
-  IN CONST CHAR8            *FormatString,\r
+  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN CONST CHAR8                 *DirectoryPath,\r
+  IN CONST CHAR8                 *Node,\r
+  IN CONST CHAR8                 *FormatString,\r
   ...\r
   );\r
 \r
@@ -209,12 +193,13 @@ XenStoreSPrint (
            indicating the type of write failure.\r
 **/\r
 XENSTORE_STATUS\r
+EFIAPI\r
 XenStoreVSPrint (\r
-  IN XENSTORE_TRANSACTION  Transaction,\r
-  IN CONST CHAR8           *DirectoryPath,\r
-  IN CONST CHAR8           *Node,\r
-  IN CONST CHAR8           *FormatString,\r
-  IN VA_LIST               Marker\r
+  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN CONST CHAR8                 *DirectoryPath,\r
+  IN CONST CHAR8                 *Node,\r
+  IN CONST CHAR8                 *FormatString,\r
+  IN VA_LIST                     Marker\r
   );\r
 \r
 /**\r
@@ -229,7 +214,7 @@ XenStoreVSPrint (
 \r
   @return  On success, XENSTORE_STATUS_SUCCESS. Otherwise an errno value\r
            indicating the type of write failure.  EEXIST errors from the\r
-           XenStore are supressed, allowing multiple, physically different,\r
+           XenStore are suppressed, allowing multiple, physically different,\r
            xenbus_watch objects, to watch the same path in the XenStore.\r
 **/\r
 XENSTORE_STATUS\r
@@ -247,7 +232,7 @@ XenStoreRegisterWatch (
 **/\r
 VOID\r
 XenStoreUnregisterWatch (\r
-  IN XENSTORE_WATCH *Watch\r
+  IN XENSTORE_WATCH  *Watch\r
   );\r
 \r
 /**\r
@@ -255,18 +240,17 @@ XenStoreUnregisterWatch (
   is the NUL string, the returned value contains the path string\r
   <DirectoryPath>.\r
 \r
-  @param DirectoryPath The NUL terminated directory prefix for new path.\r
+  @param DirectoryPath  The NUL terminated directory prefix for new path.\r
   @param Node           The NUL terminated basename for the new path.\r
 \r
   @return  A buffer containing the joined path.\r
  */\r
 CHAR8 *\r
 XenStoreJoin (\r
-  IN CONST CHAR8 *DirectoryPath,\r
-  IN CONST CHAR8 *Node\r
+  IN CONST CHAR8  *DirectoryPath,\r
+  IN CONST CHAR8  *Node\r
   );\r
 \r
-\r
 /**\r
   Initialize the XenStore states and rings.\r
 \r
@@ -276,7 +260,7 @@ XenStoreJoin (
 **/\r
 EFI_STATUS\r
 XenStoreInit (\r
-  XENBUS_DEVICE *Dev\r
+  XENBUS_DEVICE  *Dev\r
   );\r
 \r
 /**\r
@@ -286,10 +270,9 @@ XenStoreInit (
 **/\r
 VOID\r
 XenStoreDeinit (\r
-  IN XENBUS_DEVICE *Dev\r
+  IN XENBUS_DEVICE  *Dev\r
   );\r
 \r
-\r
 //\r
 // XENBUS protocol\r
 //\r
@@ -297,34 +280,34 @@ XenStoreDeinit (
 XENSTORE_STATUS\r
 EFIAPI\r
 XenBusWaitForWatch (\r
-  IN XENBUS_PROTOCOL *This,\r
-  IN VOID *Token\r
+  IN XENBUS_PROTOCOL  *This,\r
+  IN VOID             *Token\r
   );\r
 \r
 XENSTORE_STATUS\r
 EFIAPI\r
 XenBusXenStoreRead (\r
-  IN  XENBUS_PROTOCOL       *This,\r
-  IN  XENSTORE_TRANSACTION  Transaction,\r
-  IN  CONST CHAR8           *Node,\r
-  OUT VOID                  **Value\r
+  IN  XENBUS_PROTOCOL             *This,\r
+  IN  CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN  CONST CHAR8                 *Node,\r
+  OUT VOID                        **Value\r
   );\r
 \r
 XENSTORE_STATUS\r
 EFIAPI\r
 XenBusXenStoreBackendRead (\r
-  IN  XENBUS_PROTOCOL       *This,\r
-  IN  XENSTORE_TRANSACTION  Transaction,\r
-  IN  CONST CHAR8           *Node,\r
-  OUT VOID                  **Value\r
+  IN  XENBUS_PROTOCOL             *This,\r
+  IN  CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN  CONST CHAR8                 *Node,\r
+  OUT VOID                        **Value\r
   );\r
 \r
 XENSTORE_STATUS\r
 EFIAPI\r
 XenBusXenStoreRemove (\r
-  IN XENBUS_PROTOCOL        *This,\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
-  IN CONST CHAR8            *Node\r
+  IN XENBUS_PROTOCOL             *This,\r
+  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN CONST CHAR8                 *Node\r
   );\r
 \r
 XENSTORE_STATUS\r
@@ -337,36 +320,36 @@ XenBusXenStoreTransactionStart (
 XENSTORE_STATUS\r
 EFIAPI\r
 XenBusXenStoreTransactionEnd (\r
-  IN XENBUS_PROTOCOL        *This,\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
-  IN BOOLEAN                Abort\r
+  IN XENBUS_PROTOCOL             *This,\r
+  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN BOOLEAN                     Abort\r
   );\r
 \r
 XENSTORE_STATUS\r
 EFIAPI\r
 XenBusXenStoreSPrint (\r
-  IN XENBUS_PROTOCOL        *This,\r
-  IN XENSTORE_TRANSACTION   Transaction,\r
-  IN CONST CHAR8            *DirectoryPath,\r
-  IN CONST CHAR8            *Node,\r
-  IN CONST CHAR8            *FormatString,\r
+  IN XENBUS_PROTOCOL             *This,\r
+  IN CONST XENSTORE_TRANSACTION  *Transaction,\r
+  IN CONST CHAR8                 *DirectoryPath,\r
+  IN CONST CHAR8                 *Node,\r
+  IN CONST CHAR8                 *FormatString,\r
   ...\r
   );\r
 \r
 XENSTORE_STATUS\r
 EFIAPI\r
 XenBusRegisterWatch (\r
-  IN  XENBUS_PROTOCOL *This,\r
-  IN  CONST CHAR8     *Node,\r
-  OUT VOID            **Token\r
+  IN  XENBUS_PROTOCOL  *This,\r
+  IN  CONST CHAR8      *Node,\r
+  OUT VOID             **Token\r
   );\r
 \r
 XENSTORE_STATUS\r
 EFIAPI\r
 XenBusRegisterWatchBackend (\r
-  IN  XENBUS_PROTOCOL *This,\r
-  IN  CONST CHAR8     *Node,\r
-  OUT VOID            **Token\r
+  IN  XENBUS_PROTOCOL  *This,\r
+  IN  CONST CHAR8      *Node,\r
+  OUT VOID             **Token\r
   );\r
 \r
 VOID\r