RedfishPkg/RedfishDebugLib: provide Redfish debug

[mirror_edk2.git] / RedfishPkg / RedfishRestExDxe / RedfishRestExInternal.h

diff --git a/RedfishPkg/RedfishRestExDxe/RedfishRestExInternal.h b/RedfishPkg/RedfishRestExDxe/RedfishRestExInternal.h
index a75985928ce2e765652ead14f16d50d811eaf8ec..bca679e2ccc43f571423dddd07ad29650a031d09 100644 (file)
--- a/RedfishPkg/RedfishRestExDxe/RedfishRestExInternal.h
+++ b/RedfishPkg/RedfishRestExDxe/RedfishRestExInternal.h
@@ -3,6 +3,7 @@
 \r
   Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
   (C) Copyright 2019-2020 Hewlett Packard Enterprise Development LP<BR>\r
+  Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.\r
 \r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
@@ -21,6 +22,7 @@
 #include <Library/HttpIoLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
 #include <Library/NetLib.h>\r
+#include <Library/RedfishDebugLib.h>\r
 #include <Library/UefiLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiDriverEntryPoint.h>\r
@@ -41,7 +43,7 @@
                                 REST service.\r
   @param[in]  HttpReceiveEfiStatus  This is the status return from HttpIoRecvResponse\r
 \r
-  @retval EFI_SUCCESS           The payload receive from Redfish service in sucessfully.\r
+  @retval EFI_SUCCESS           The payload receive from Redfish service in successfully.\r
   @retval EFI_NOT_READY         May need to resend the HTTP request.\r
   @retval EFI_DEVICE_ERROR      Something wrong and can't be resolved.\r
   @retval Others                Other errors as indicated.\r
@@ -49,8 +51,8 @@
 **/\r
 EFI_STATUS\r
 RedfishCheckHttpReceiveStatus (\r
-  IN RESTEX_INSTANCE *Instance,\r
-  IN EFI_STATUS HttpIoReceiveStatus\r
+  IN RESTEX_INSTANCE  *Instance,\r
+  IN EFI_STATUS       HttpIoReceiveStatus\r
   );\r
 \r
 /**\r
@@ -76,10 +78,10 @@ RedfishCheckHttpReceiveStatus (
 **/\r
 EFI_STATUS\r
 RedfishHttpAddExpectation (\r
-  IN EFI_REST_EX_PROTOCOL   *This,\r
-  IN EFI_HTTP_MESSAGE       *RequestMessage,\r
-  IN EFI_HTTP_HEADER        **PreservedRequestHeaders,\r
-  IN BOOLEAN                *ItsWrite\r
+  IN EFI_REST_EX_PROTOCOL  *This,\r
+  IN EFI_HTTP_MESSAGE      *RequestMessage,\r
+  IN EFI_HTTP_HEADER       **PreservedRequestHeaders,\r
+  IN BOOLEAN               *ItsWrite\r
   );\r
 \r
 /**\r
@@ -104,9 +106,9 @@ RedfishHttpAddExpectation (
 EFI_STATUS\r
 EFIAPI\r
 RedfishRestExSendReceive (\r
-  IN      EFI_REST_EX_PROTOCOL   *This,\r
-  IN      EFI_HTTP_MESSAGE       *RequestMessage,\r
-  OUT     EFI_HTTP_MESSAGE       *ResponseMessage\r
+  IN      EFI_REST_EX_PROTOCOL  *This,\r
+  IN      EFI_HTTP_MESSAGE      *RequestMessage,\r
+  OUT     EFI_HTTP_MESSAGE      *ResponseMessage\r
   );\r
 \r
 /**\r
@@ -134,8 +136,8 @@ RedfishRestExSendReceive (
 EFI_STATUS\r
 EFIAPI\r
 RedfishRestExGetServiceTime (\r
-  IN      EFI_REST_EX_PROTOCOL   *This,\r
-  OUT     EFI_TIME               *Time\r
+  IN      EFI_REST_EX_PROTOCOL  *This,\r
+  OUT     EFI_TIME              *Time\r
   );\r
 \r
 /**\r
@@ -205,8 +207,8 @@ RedfishRestExGetService (
 EFI_STATUS\r
 EFIAPI\r
 RedfishRestExGetModeData (\r
-  IN  EFI_REST_EX_PROTOCOL      *This,\r
-  OUT EFI_REST_EX_CONFIG_DATA   *RestExConfigData\r
+  IN  EFI_REST_EX_PROTOCOL     *This,\r
+  OUT EFI_REST_EX_CONFIG_DATA  *RestExConfigData\r
   );\r
 \r
 /**\r
@@ -243,8 +245,8 @@ RedfishRestExGetModeData (
 EFI_STATUS\r
 EFIAPI\r
 RedfishRestExConfigure (\r
-  IN  EFI_REST_EX_PROTOCOL    *This,\r
-  IN  EFI_REST_EX_CONFIG_DATA RestExConfigData\r
+  IN  EFI_REST_EX_PROTOCOL     *This,\r
+  IN  EFI_REST_EX_CONFIG_DATA  RestExConfigData\r
   );\r
 \r
 /**\r
@@ -281,10 +283,10 @@ RedfishRestExConfigure (
 EFI_STATUS\r
 EFIAPI\r
 RedfishRestExAyncSendReceive (\r
-  IN      EFI_REST_EX_PROTOCOL   *This,\r
-  IN      EFI_HTTP_MESSAGE       *RequestMessage OPTIONAL,\r
-  IN      EFI_REST_EX_TOKEN      *RestExToken,\r
-  IN      UINTN                  *TimeOutInMilliSeconds OPTIONAL\r
+  IN      EFI_REST_EX_PROTOCOL  *This,\r
+  IN      EFI_HTTP_MESSAGE      *RequestMessage OPTIONAL,\r
+  IN      EFI_REST_EX_TOKEN     *RestExToken,\r
+  IN      UINTN                 *TimeOutInMilliSeconds OPTIONAL\r
   );\r
 \r
 /**\r
@@ -316,10 +318,11 @@ RedfishRestExAyncSendReceive (
 EFI_STATUS\r
 EFIAPI\r
 RedfishRestExEventService (\r
-  IN      EFI_REST_EX_PROTOCOL   *This,\r
-  IN      EFI_HTTP_MESSAGE       *RequestMessage OPTIONAL,\r
-  IN      EFI_REST_EX_TOKEN      *RestExToken\r
+  IN      EFI_REST_EX_PROTOCOL  *This,\r
+  IN      EFI_HTTP_MESSAGE      *RequestMessage OPTIONAL,\r
+  IN      EFI_REST_EX_TOKEN     *RestExToken\r
   );\r
+\r
 /**\r
   Create a new TLS session becuase the previous on is closed.\r
   status.\r
@@ -333,8 +336,7 @@ RedfishRestExEventService (
 EFI_STATUS\r
 ResetHttpTslSession (\r
   IN   RESTEX_INSTANCE  *Instance\r
-);\r
-\r
+  );\r
 \r
 /**\r
   Callback function which provided by user to remove one node in NetDestroyLinkList process.\r
@@ -349,8 +351,8 @@ ResetHttpTslSession (
 EFI_STATUS\r
 EFIAPI\r
 RestExDestroyChildEntryInHandleBuffer (\r
-  IN LIST_ENTRY         *Entry,\r
-  IN VOID               *Context\r
+  IN LIST_ENTRY  *Entry,\r
+  IN VOID        *Context\r
   );\r
 \r
 /**\r
@@ -361,7 +363,7 @@ RestExDestroyChildEntryInHandleBuffer (
 **/\r
 VOID\r
 RestExDestroyInstance (\r
-  IN RESTEX_INSTANCE         *Instance\r
+  IN RESTEX_INSTANCE  *Instance\r
   );\r
 \r
 /**\r
@@ -376,11 +378,10 @@ RestExDestroyInstance (
 **/\r
 EFI_STATUS\r
 RestExCreateInstance (\r
-  IN  RESTEX_SERVICE         *Service,\r
-  OUT RESTEX_INSTANCE        **Instance\r
+  IN  RESTEX_SERVICE   *Service,\r
+  OUT RESTEX_INSTANCE  **Instance\r
   );\r
 \r
-\r
 /**\r
   Release all the resource used the RestEx service binding instance.\r
 \r
@@ -389,7 +390,7 @@ RestExCreateInstance (
 **/\r
 VOID\r
 RestExDestroyService (\r
-  IN RESTEX_SERVICE     *RestExSb\r
+  IN RESTEX_SERVICE  *RestExSb\r
   );\r
 \r
 /**\r
@@ -407,9 +408,9 @@ RestExDestroyService (
 **/\r
 EFI_STATUS\r
 RestExCreateService (\r
-  IN     EFI_HANDLE            Controller,\r
-  IN     EFI_HANDLE            Image,\r
-  OUT    RESTEX_SERVICE        **Service\r
+  IN     EFI_HANDLE      Controller,\r
+  IN     EFI_HANDLE      Image,\r
+  OUT    RESTEX_SERVICE  **Service\r
   );\r
 \r
 /**\r
@@ -608,4 +609,5 @@ RedfishRestExServiceBindingDestroyChild (
   IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
   IN EFI_HANDLE                    ChildHandle\r
   );\r
+\r
 #endif\r