RedfishClientPkg/RedfishTaskLib: add library to update Redfish task s…

…tate

Introduce new library of updating Redfish task state to BMC. The interface
between host and BMC for updating Redfish task state is not defined in
industrial specification. Since this depends on platform BMC
implementation, this library is created for platform owner to handle this
part.

Signed-off-by: Nickle Wang <[email protected]>

RedfishClientPkg/Include/Library/RedfishTaskLib.h

@@ -0,0 +1,40 @@
+/** @file
+  This file defines the Redfish task library interface.
+
+  Copyright (c) 2023-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef REDFISH_TASK_LIB_H_
+#define REDFISH_TASK_LIB_H_
+
+#include <Uefi.h>
+#include <RedfishServiceData.h>
+#include <Protocol/EdkIIRedfishTaskProtocol.h>
+
+/**
+
+  This function update task result to BMC task service. There is
+  no standard way defined in Redfish specification that allows
+  BIOS to update task state and status. Platform implement
+  this function to update task result to BMC by following
+  BMC defined interface.
+
+  @param[in]  RedfishService  Instance to Redfish service.
+  @param[in]  TaskUri         The URI of task to update result.
+  @param[in]  TaskResult      The task state and task status to update.
+
+  @retval     EFI_SUCCESS         Task state and status is updated to BMC.
+  @retval     Others              Errors occur.
+
+**/
+EFI_STATUS
+RedfishTaskUpdate (
+  IN REDFISH_SERVICE      RedfishService,
+  IN EFI_STRING           TaskUri,
+  IN REDFISH_TASK_RESULT  TaskResult
+  );
+
+#endif

RedfishClientPkg/Library/RedfishTaskLibNull/RedfishTaskLibNull.c

@@ -0,0 +1,38 @@
+/** @file
+  Redfish task library NULL implementation.
+
+  Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#include <Library/RedfishTaskLib.h>
+#include <Library/DebugLib.h>
+
+/**
+
+  This function update task result to BMC task service. There is
+  no standard way defined in Redfish specification that allows
+  BIOS to update task state and status. Platform implement
+  this function to update task result to BMC by following
+  BMC defined interface.
+
+  @param[in]  RedfishService  Instance to Redfish service.
+  @param[in]  TaskUri         The URI of task to update result.
+  @param[in]  TaskResult      The task state and task status to update.
+
+  @retval     EFI_SUCCESS         Task state and status is updated to BMC.
+  @retval     Others              Errors occur.
+
+**/
+EFI_STATUS
+RedfishTaskUpdate (
+  IN REDFISH_SERVICE      RedfishService,
+  IN EFI_STRING           TaskUri,
+  IN REDFISH_TASK_RESULT  TaskResult
+  )
+{
+  DEBUG ((DEBUG_WARN, "%a: update task state and status is unsupported\n", __func__));
+  return EFI_UNSUPPORTED;
+}

RedfishClientPkg/Library/RedfishTaskLibNull/RedfishTaskLibNull.inf

@@ -0,0 +1,34 @@
+## @file
+#
+#  Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+#
+#  SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+##
+
+[Defines]
+  INF_VERSION                    = 0x00010006
+  BASE_NAME                      = RedfishTaskLibNull
+  FILE_GUID                      = 7A78D9A3-B823-4423-9F02-8ECF42033F4D
+  MODULE_TYPE                    = DXE_DRIVER
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = RedfishTaskLib| DXE_DRIVER UEFI_DRIVER
+
+#
+#  VALID_ARCHITECTURES           = IA32 X64 EBC
+#
+
+[Sources]
+  RedfishTaskLibNull.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+  MdeModulePkg/MdeModulePkg.dec
+  RedfishPkg/RedfishPkg.dec
+  RedfishClientPkg/RedfishClientPkg.dec
+
+[LibraryClasses]
+  DebugLib
+
+[Depex]
+  TRUE

RedfishClientPkg/RedfishClientPkg.dec

@@ -28,6 +28,7 @@
   RedfishEventLib|Include/Library/RedfishEventLib.h
   RedfishVersionLib|Include/Library/RedfishVersionLib.h
   RedfishMessageLib|Include/Library/RedfishMessageLib.h
+  RedfishTaskLib|Include/Library/RedfishTaskLib.h
 
 [Protocols]
   ## Include/Protocol/EdkIIRedfishFeature.h