]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/RedfishDiscover.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / Protocol / RedfishDiscover.h
index 8dbb70b0820ab875f4efa6bcb6071368a0c814d3..70b83eb4b4c6b350416028374fc5cb729535bf58 100644 (file)
     0x5db12509, 0x4550, 0x4347, { 0x96, 0xb3, 0x73, 0xc0, 0xff, 0x6e, 0x86, 0x9f } \\r
   }\r
 \r
-#define REDFISH_DISCOVER_TOKEN_SIGNATURE    SIGNATURE_32 ('R', 'F', 'T', 'S')\r
+#define REDFISH_DISCOVER_TOKEN_SIGNATURE  SIGNATURE_32 ('R', 'F', 'T', 'S')\r
 \r
 typedef UINT32 EFI_REDFISH_DISCOVER_FLAG;\r
-#define EFI_REDFISH_DISCOVER_HOST_INTERFACE 0x00000001 ///< Discover Redfish server reported in SMBIOS 42h.\r
-#define EFI_REDFISH_DISCOVER_SSDP           0x00000002 ///< Discover Redfish server using UPnP Http search method.\r
-#define EFI_REDFISH_DISCOVER_SSDP_UDP6      0x00000004 ///< Use UDP version 6.\r
-#define EFI_REDFISH_DISCOVER_KEEP_ALIVE     0x00000008 ///< Keep to send UPnP Search in the duration indicated in\r
-                                                       ///< EFI_REDFISH_DISCOVER_DURATION_MASK.\r
-#define EFI_REDFISH_DISCOVER_RENEW          0x00000010 ///< Set this bit to indicate this function to notify the caller\r
+#define EFI_REDFISH_DISCOVER_HOST_INTERFACE  0x00000001 ///< Discover Redfish server reported in SMBIOS 42h.\r
+#define EFI_REDFISH_DISCOVER_SSDP            0x00000002 ///< Discover Redfish server using UPnP Http search method.\r
+#define EFI_REDFISH_DISCOVER_SSDP_UDP6       0x00000004 ///< Use UDP version 6.\r
+#define EFI_REDFISH_DISCOVER_KEEP_ALIVE      0x00000008 ///< Keep to send UPnP Search in the duration indicated in\r
+                                                        ///< EFI_REDFISH_DISCOVER_DURATION_MASK.\r
+#define EFI_REDFISH_DISCOVER_RENEW  0x00000010         ///< Set this bit to indicate this function to notify the caller\r
                                                        ///< a list of all Redfish servers it found. Otherwise, this fucntion\r
                                                        ///< just notify the caller new found Redfish servers.\r
                                                        ///<\r
@@ -56,37 +56,37 @@ typedef struct {
 } EFI_REDFISH_DISCOVERED_INFORMATION;\r
 \r
 typedef struct {\r
-  EFI_STATUS Status;                                ///< Status of Redfish service discovery.\r
-  EFI_REDFISH_DISCOVERED_INFORMATION Information;   ///< Redfish service discovered.\r
+  EFI_STATUS                            Status;      ///< Status of Redfish service discovery.\r
+  EFI_REDFISH_DISCOVERED_INFORMATION    Information; ///< Redfish service discovered.\r
 } EFI_REDFISH_DISCOVERED_INSTANCE;\r
 \r
 typedef struct {\r
-  UINTN   NumberOfServiceFound;                      ///< Must be 0 when pass to Acquire ().\r
-  EFI_REDFISH_DISCOVERED_INSTANCE *RedfishInstances; ///< Must be NULL when pass to Acquire ().\r
+  UINTN                              NumberOfServiceFound; ///< Must be 0 when pass to Acquire ().\r
+  EFI_REDFISH_DISCOVERED_INSTANCE    *RedfishInstances;    ///< Must be NULL when pass to Acquire ().\r
 } EFI_REDFISH_DISCOVERED_LIST;\r
 \r
 typedef struct {\r
-    EFI_MAC_ADDRESS       MacAddress;             ///< MAC address of network interfase to discover Redfish service.\r
-    BOOLEAN               IsIpv6;                 ///< Indicates it's IP versino 6.\r
-    EFI_IP_ADDRESS        SubnetId;               ///< Subnet ID.\r
-    UINT8                 SubnetPrefixLength;     ///< Subnet prefix-length for IPv4 and IPv6.\r
-    UINT16                VlanId;                 ///< VLAN ID.\r
+  EFI_MAC_ADDRESS    MacAddress;                  ///< MAC address of network interfase to discover Redfish service.\r
+  BOOLEAN            IsIpv6;                      ///< Indicates it's IP versino 6.\r
+  EFI_IP_ADDRESS     SubnetId;                    ///< Subnet ID.\r
+  UINT8              SubnetPrefixLength;          ///< Subnet prefix-length for IPv4 and IPv6.\r
+  UINT16             VlanId;                      ///< VLAN ID.\r
 } EFI_REDFISH_DISCOVER_NETWORK_INTERFACE;\r
 \r
 typedef struct {\r
-  UINT32    Signature;            ///< Token signature.\r
-  EFI_REDFISH_DISCOVERED_LIST DiscoverList; ///< The memory of EFI_REDFISH_DISCOVERED_LIST is\r
-                                            ///< allocated by Acquire() and freed when caller invoke Release().\r
-  EFI_EVENT Event;                ///< The TPL_CALLBACK event to be notified when Redfish services\r
-                                  ///< are discovered or any errors occurred during discovery.\r
-  UINTN Timeout;                  ///< The timeout value declared in EFI_REDFISH_DISCOVERED_TOKEN\r
-                                  ///< determines the seconds to drop discover process.\r
-                                  ///< Basically, the nearby Redfish services must response in >=1\r
-                                  ///< and <= 5 seconds. The valid timeout value used to have\r
-                                  ///< asynchronous discovery is >= 1 and <= 5 seconds. Set the\r
-                                  ///< timeout to zero means to discover Redfish service synchronously.\r
-                                  ///< Event in token is created by caller to listen the Reefish services\r
-                                  ///< found by Acquire().\r
+  UINT32                         Signature;    ///< Token signature.\r
+  EFI_REDFISH_DISCOVERED_LIST    DiscoverList; ///< The memory of EFI_REDFISH_DISCOVERED_LIST is\r
+                                               ///< allocated by Acquire() and freed when caller invoke Release().\r
+  EFI_EVENT                      Event;        ///< The TPL_CALLBACK event to be notified when Redfish services\r
+                                               ///< are discovered or any errors occurred during discovery.\r
+  UINTN                          Timeout;      ///< The timeout value declared in EFI_REDFISH_DISCOVERED_TOKEN\r
+                                               ///< determines the seconds to drop discover process.\r
+                                               ///< Basically, the nearby Redfish services must response in >=1\r
+                                               ///< and <= 5 seconds. The valid timeout value used to have\r
+                                               ///< asynchronous discovery is >= 1 and <= 5 seconds. Set the\r
+                                               ///< timeout to zero means to discover Redfish service synchronously.\r
+                                               ///< Event in token is created by caller to listen the Reefish services\r
+                                               ///< found by Acquire().\r
 } EFI_REDFISH_DISCOVERED_TOKEN;\r
 \r
 /**\r
@@ -112,7 +112,7 @@ EFI_STATUS
   IN EFI_HANDLE                              ImageHandle,\r
   OUT UINTN                                  *NumberOfNetworkInterfaces,\r
   OUT EFI_REDFISH_DISCOVER_NETWORK_INTERFACE **NetworkInterfaces\r
-);\r
+  );\r
 \r
 /**\r
   This function acquires Redfish services by discovering static Redfish setting\r
@@ -146,7 +146,7 @@ EFI_STATUS
   IN EFI_REDFISH_DISCOVER_NETWORK_INTERFACE *TargetNetworkInterface OPTIONAL,\r
   IN EFI_REDFISH_DISCOVER_FLAG              Flags,\r
   IN EFI_REDFISH_DISCOVERED_TOKEN           *Token\r
-);\r
+  );\r
 \r
 /**\r
   This function aborts Redfish service discovery on the given network interface.\r
@@ -163,7 +163,7 @@ EFI_STATUS
 (EFIAPI *EFI_REDFISH_DISCOVER_ABORT_ACQUIRE)(\r
   IN EFI_REDFISH_DISCOVER_PROTOCOL          *This,\r
   IN EFI_REDFISH_DISCOVER_NETWORK_INTERFACE *TargetNetworkInterface OPTIONAL\r
-);\r
+  );\r
 \r
 /**\r
   This function releases Redfish services found by RedfishServiceAcquire().\r
@@ -180,14 +180,14 @@ EFI_STATUS
 (EFIAPI *EFI_REDFISH_DISCOVER_RELEASE_SERVICE)(\r
   IN EFI_REDFISH_DISCOVER_PROTOCOL   *This,\r
   IN EFI_REDFISH_DISCOVERED_LIST     *List\r
-);\r
+  );\r
 \r
 struct _EFI_REDFISH_DISCOVER_PROTOCOL {\r
-  EFI_REDFISH_DISCOVER_NETWORK_LIST    GetNetworkInterfaceList;\r
-  EFI_REDFISH_DISCOVER_ACQUIRE_SERVICE AcquireRedfishService;\r
-  EFI_REDFISH_DISCOVER_ABORT_ACQUIRE   AbortAcquireRedfishService;\r
-  EFI_REDFISH_DISCOVER_RELEASE_SERVICE ReleaseRedfishService;\r
+  EFI_REDFISH_DISCOVER_NETWORK_LIST       GetNetworkInterfaceList;\r
+  EFI_REDFISH_DISCOVER_ACQUIRE_SERVICE    AcquireRedfishService;\r
+  EFI_REDFISH_DISCOVER_ABORT_ACQUIRE      AbortAcquireRedfishService;\r
+  EFI_REDFISH_DISCOVER_RELEASE_SERVICE    ReleaseRedfishService;\r
 };\r
 \r
-extern EFI_GUID gEfiRedfishDiscoverProtocolGuid;\r
+extern EFI_GUID  gEfiRedfishDiscoverProtocolGuid;\r
 #endif\r