RedfishClientPkg: Redfish task service support by nicklela · Pull Request #98 · tianocore/edk2-redfish-client

nicklela · 2024-10-24T07:29:37Z

Description

Introduce driver and library to support Redfish task service.

How This Was Tested

Build pass on RedfishClientPkg.

ghbaccount · 2024-11-02T00:41:11Z

+  while (!IsNull (&Private->RegisteredList, Node)) {
+    Entry =  REDFISH_TASK_REGISTERED_ENTRY_FROM_LIST (Node);
+
+    if ((StrCmp (Entry->ListenUri, Uri) == 0) && (Entry->Context == Context)) {


Wouldn't it be better to check Context value at first?

ghbaccount · 2024-11-02T00:43:16Z

+    JsonValueFree (TaskCollection);
+  }
+
+  return Status;


@nicklela, there is a compilation warning:

RedfishClientPkg/RedfishTaskServiceDxe/RedfishTaskServiceDxe.c:496:10: error: 'Status' may be used uninitialized in this function [-Werror=maybe-uninitialized]
return Status;
^~~~~~
cc1: all warnings being treated as errors.

nicklela · 2025-01-22T23:50:54Z

I need more time to create flow diagram and explain how Redfish task works. So I convert this pull request to draft for now.

achhetry · 2026-04-24T06:46:33Z

@nicklela Can we move this draft for review?

Please review the attached files for Redfish Task Service flow.

Redfish_Client_Driver_Stack_Task_Service_Flow_Chart_with_markings

Redfish_Client_Driver_Stack_Task_Service_Flow_Chart

redfish-feature-driver-call-flow_with_markings

///
/// Definition of _EDKII_REDFISH_TASK_PROTOCOL.
///
struct _EDKII_REDFISH_TASK_PROTOCOL {
UINT32 Version;
REDFISH_TASK_REGISTER Register;
REDFISH_TASK_UNREGISTER Unregister;
REDFISH_TASK_REPORT_MESSAGE ReportMessage;
REDFISH_TASK_GET_PAYLOAD GetPayload;
REDFISH_TASK_FREE_PAYLOAD FreePayload;
};
The RedfishTaskServiceDxe registers with RedfishFeatureCoreDxe for the management of TaskService URI. RedfishFeatureCoreDxe
invokes registered callback for the task service management during Edk2RedfishFeatureDriverStartupEvent[11].
RedfishTaskService's callback invokes RedfishTaskServiceDispatcher to fetch the TaskCollection from the BMC.

The dispatcher will iterate through all the tasks available in the collection and will try to identify the associated
callback registered by the Redfish client feature driver. Later, once the associated callback is invoked the feature driver
requests the task payload through the RedfishTaskProtocol and performs the action required. Once completed or failed,
TaskStatus and TaskState is communicated back to the RedfishTaskServiceDxe which will eventually notify the BMC.

TaskService.md

achhetry · 2026-05-15T09:42:15Z

Hi @nicklela , @changab , @igorkulchytskyy - Are we good with the Redfish TaskService flow, Can we merge this change?

nicklela · 2026-05-15T12:52:09Z

Hi @nicklela , @changab , @igorkulchytskyy - Are we good with the Redfish TaskService flow, Can we merge this change?

I remember last time Igor had question about the design. @igorkulchytskyy if you have chance, could you check the flow diagram that @achhetry update above?

igorkulchytskyy

Looks good for me now. Thank you

achhetry · 2026-05-19T07:53:21Z

Hi @nicklela , This branch has conflicts, can you please help to resolve

changab · 2026-06-18T14:00:15Z

@nicklela, just a reminder for this PR.

Introduce new library to handle Redfish message. This library associate Redfish message to corresponding Redfish URI. When Redfish resource is ready for provisioning, driver can get all Redfish messages associated with this Redfish URI and add them into provision data. Signed-off-by: Nickle Wang <nicklew@nvidia.com>

…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 <nicklew@nvidia.com>

Add new library to read Redfish protocol feature attribute. Redfish feature driver calls this library to get protocol feature support on BMC. Signed-off-by: Nickle Wang <nicklew@nvidia.com>

… task Introduce new driver to handle Redfish task service. This driver reads Redfish task service and dispatch task to registered Redfish driver. When Redfish driver is done with his job, this driver helps to return task result back to BMC. Signed-off-by: Nickle Wang <nicklew@nvidia.com>

Add special handing for Redfish task service because task needs to be called before Redfish feature driver. The request from Redfish task may change the BIOS configuration so it has to be handled first. Signed-off-by: Nickle Wang <nicklew@nvidia.com>

Enable Redfish task support by adding RedfishTaskDxe driver, Redfish message library and Redfish task library to RedfishClientPkg. Signed-off-by: Nickle Wang <nicklew@nvidia.com>

Add Redfish Task service driver and its design diagram to Readme file. Signed-off-by: Nickle Wang <nicklew@nvidia.com> Co-authored-by: Aman Chhetry <achhetry@qti.qualcomm.com>

Do not run patch checks to svg image files Signed-off-by: Nickle Wang <nicklew@nvidia.com>

nicklela · 2026-06-23T14:20:55Z

@nicklela, just a reminder for this PR.

Hi @changab @achhetry I have rebased this pull request to the top of tree.

@achhetry I add your diagram and description of task service in #98 (comment) to Readme.md file. Thanks for your great help!

Please help me to review this pull request and see if I missed anything, thanks!

vishalo · 2026-06-23T16:01:23Z

+
+**/
+
+#ifndef REDFISH_MESSAGE_LIB_H_


Is this repo keeping #ifndef or moving to #pragma once ?

vishalo · 2026-06-23T16:02:20Z

+  DESTRUCTOR                     = RedfishMessageDestructor
+
+#
+#  VALID_ARCHITECTURES           = IA32 X64 EBC


vishalo · 2026-06-23T16:08:07Z

  gEfiRedfishClientPkgTokenSpaceGuid.PcdRedfishCoreExecuteOnce|TRUE|BOOLEAN|0x10000007
+  # This is used to disable Redfish HTTP query by using "$expand" parameter even when
+  # Redfish service supports this query parameter.
+  gEfiRedfishClientPkgTokenSpaceGuid.PcdHttpExpandQueryDisabled|FALSE|BOOLEAN|0x2000000A


Is there some reason to change to 0x2* instead of incrementing previous one ?

nicklela self-assigned this Oct 24, 2024

nicklela requested review from changab and igorkulchytskyy as code owners October 24, 2024 07:29

nicklela force-pushed the redfish-task-support branch 4 times, most recently from 62a3d74 to 5881f20 Compare October 24, 2024 13:25

ghbaccount reviewed Nov 2, 2024

View reviewed changes

nicklela marked this pull request as draft January 22, 2025 23:49

nicklela marked this pull request as ready for review April 25, 2026 15:54

igorkulchytskyy approved these changes May 15, 2026

View reviewed changes

nicklela added 5 commits June 23, 2026 20:40

RedfishClientPkg/RedfishProtocolFeaturesLib: lib to get protocol feature

f9c45b9

Add new library to read Redfish protocol feature attribute. Redfish feature driver calls this library to get protocol feature support on BMC. Signed-off-by: Nickle Wang <nicklew@nvidia.com>

nicklela force-pushed the redfish-task-support branch 3 times, most recently from 30bf20a to e234d82 Compare June 23, 2026 14:09

nicklela and others added 3 commits June 23, 2026 22:12

RedfishClientPkg: add Redfish task service support

00fa31a

Enable Redfish task support by adding RedfishTaskDxe driver, Redfish message library and Redfish task library to RedfishClientPkg. Signed-off-by: Nickle Wang <nicklew@nvidia.com>

RedfishClientPkg: add Redfish Task design to Readme.md

e7d92b5

Add Redfish Task service driver and its design diagram to Readme file. Signed-off-by: Nickle Wang <nicklew@nvidia.com> Co-authored-by: Aman Chhetry <achhetry@qti.qualcomm.com>

RedfishClientPkg/workflows: skip svg image file

52cdf91

Do not run patch checks to svg image files Signed-off-by: Nickle Wang <nicklew@nvidia.com>

nicklela force-pushed the redfish-task-support branch from e234d82 to 52cdf91 Compare June 23, 2026 14:13

vishalo reviewed Jun 23, 2026

View reviewed changes

Uh oh!

Conversation

nicklela commented Oct 24, 2024

Description

How This Was Tested

Uh oh!

ghbaccount Nov 2, 2024

Choose a reason for hiding this comment

Uh oh!

ghbaccount Nov 2, 2024

Choose a reason for hiding this comment

Uh oh!

nicklela commented Jan 22, 2025

Uh oh!

achhetry commented Apr 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

achhetry commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicklela commented May 15, 2026

Uh oh!

igorkulchytskyy left a comment

Choose a reason for hiding this comment

Uh oh!

achhetry commented May 19, 2026

Uh oh!

changab commented Jun 18, 2026

Uh oh!

nicklela commented Jun 23, 2026

Uh oh!

vishalo Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

vishalo Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

vishalo Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

achhetry commented Apr 24, 2026 •

edited

Loading

achhetry commented May 15, 2026 •

edited

Loading