Redfish JSON C Structure Convertor v1.3

 - Fix unused variable build error under GCC.
 - Link child JSON object to the parent CS.
 - Generate edk2 FDF file.
 - Update copyright.

Author: changab

AUTHORS.md

@@ -4,4 +4,6 @@
 
 
 # Other Key Contributions:
+* Abner Chang - Advanced Micro Devices, Inc.
+
 

CHANGELOG.md

@@ -1,6 +1,11 @@
 
 # Change Log
 
+## [1.3] - 2024-1-8
+  - Fix unused variable build error under GCC.
+  - Link child JSON object to the parent CS.
+  - Generate edk2 FDF file.
+
 ## [1.2] - 2021-8-17
 - Fixe the issue when turn nested JSON object into nested C structure.
 - Fix the duplicated function name issue.

GenCRelatedFile.py

@@ -2,7 +2,7 @@
 # Redfish JSON resource to C structure converter source code generator.
 #
 # Copyright Notice:
-# Copyright 2021-2022 DMTF. All rights reserved.
+# Copyright 2021-2024 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Tacklebox/blob/main/LICENSE.md
 #
 import os
@@ -818,18 +818,31 @@ def GenCStructureJSonStructureCode (self, ResourceType, SchemaVersion, Structure
 
         CodeStr = self.GenCStructToJsonCCodeForStructure (ResourceType, SchemaVersion, StructnameShort, NestedStructName, PrecedentKey, CStructPointer + "->" + key, False)
         if "RedfishCS_status CS_To_JSON_" + PrecedentKey in self.CStructureToJsonStructureExistFunc:
-            # Funciton already exist.
+            # Function already exist.
             return
         self.CStructureToJsonStructureExistFunc.append ("RedfishCS_status CS_To_JSON_" + PrecedentKey)
 
         self.CStructureToJsonStructureFuncions += "static RedfishCS_status CS_To_JSON_" + PrecedentKey  + "(json_t *CsJson, char *Key, " + StructureMemberDataType + " *CSPtr)\n"
         self.CStructureToJsonStructureFuncions += "{\n"
+        
+        if CodeStr != "":
+            self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "json_t *CsParentJson;\n\n"
+        
         self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "if (CSPtr == NULL) {\n"
         self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE * 2 + "return RedfishCS_status_success;\n"
-        self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "}\n"
+        self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "}\n\n"
+        
+        if CodeStr != "":
+            self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "CsParentJson = CsJson;\n"
+        self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "CsJson = json_object();\n"
+        self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "if (CsJson == NULL) {\n"
+        self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE * 2 + "return RedfishCS_status_unsupported;\n"
+        self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "}\n\n"
 
         if CodeStr != "":
             self.CStructureToJsonStructureFuncions += CodeStr
+            self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "// Set to parent JSON object.\n"
+            self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "if (json_object_set_new (CsParentJson, Key, CsJson) == -1) {goto Error;}\n\n"
         else:
             self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "// Check if this is RedfishCS_Type_CS_EmptyProp.\n"
             self.CStructureToJsonStructureFuncions += C_SRC_TAB_SPACE + "CsEmptyPropLinkToJson(CsJson, Key, &CSPtr->Prop);\n"

GenEdk2Files.py

@@ -2,7 +2,7 @@
 # Redfish JSON resource to C structure converter source code generator.
 #
 # Copyright Notice:
-# Copyright 2021-2022 DMTF. All rights reserved.
+# Copyright 2021-2024 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Tacklebox/blob/main/LICENSE.md
 #
 import os
@@ -109,7 +109,8 @@ def __init__ (self, RedfishCSInstance, SchemaFileInstance, RedfishCSStructList,
         self.Edk2RedfishIntpTempDxeInf = ""
         self.Edk2RedfishIntpTempInclude = ""
         self.Edk2RedfishIntpComponentDsc = ""        
-        self.Edk2RedfishIntpLibDsc = ""          
+        self.Edk2RedfishIntpLibDsc = ""
+        self.Edk2RedfishIntpFdf = ""          
         self.Edk2RedfishintpKeywordsDict = {}
         self.Edk2CStructureName = ""
 
@@ -292,6 +293,7 @@ def GenEdk2RedfishIntpFile(self):
 
         self.Edk2RedfishIntpComponentDsc = "RedfishSchemaCsInterpreter_Component.dsc"
         self.Edk2RedfishIntpLibDsc = "RedfishSchemaCsInterpreter_Lib.dsc"
+        self.Edk2RedfishIntpFdf = "RedfishSchemaCsInterpreter_Component.fdf"
 
         self.Edk2RedfishIntpTempDxeC = self.Edk2RedfishIntpTempFilesDir + os.path.normpath("/RedfishCsDxe.temp")
         self.Edk2RedfishIntpTempDxeInf = self.Edk2RedfishIntpTempFilesDir + os.path.normpath("/RedfishCsInf.temp")
@@ -356,28 +358,50 @@ def GenEdk2RedfishIntpFile(self):
         if not os.path.exists (self.Edk2RedfishIntpOutputDir + os.path.normpath("/" + self.Edk2RedfishIntpLibDsc)):            
             fo = open(self.Edk2RedfishIntpOutputDir + os.path.normpath("/" + self.Edk2RedfishIntpLibDsc),"w")
             fo.close()
-
+        if not os.path.exists (self.Edk2RedfishIntpOutputDir + os.path.normpath("/" + self.Edk2RedfishIntpFdf)):
+            fo = open(self.Edk2RedfishIntpOutputDir + os.path.normpath("/" + self.Edk2RedfishIntpFdf),"w")
+            fo.close()
+           
+        #
+        # edk2 driver DSC
+        #
         fo = open(self.Edk2RedfishIntpOutputDir + os.path.normpath("/" + self.Edk2RedfishIntpComponentDsc),"a")
         if SchemaVersion == "":
-            fo.write("!if $(REDFISH_" + RedfishCs.ResourceType.upper() + ") OR $(REDFISH_CLIENT_ALL_AUTOGENED)\n")
+            fo.write("!if ($(REDFISH_" + RedfishCs.ResourceType.upper() + ") == TRUE) OR ($(REDFISH_CLIENT_ALL_AUTOGENED) == TRUE)\n")
             fo.write("  " + self.Edk2RedfishJsonCsPackagePath + "RedfishClientPkg/Converter/" + RedfishCs.ResourceType + "/" + RedfishCsSchemaDxe_INF_File + "\n")
             fo.write("!endif\n")
         else:
-            fo.write("!if $(REDFISH_" + RedfishCs.ResourceType.upper() + "_" + SchemaVersion.upper() + ") OR $(REDFISH_CLIENT_ALL_AUTOGENED)\n")
+            fo.write("!if ($(REDFISH_" + RedfishCs.ResourceType.upper() + "_" + SchemaVersion.upper() + ") == TRUE) OR ($(REDFISH_CLIENT_ALL_AUTOGENED) == TRUE)\n")
             fo.write("  " + self.Edk2RedfishJsonCsPackagePath + "RedfishClientPkg/Converter/" + RedfishCs.ResourceType + "/" + SchemaVersion + "/" + RedfishCsSchemaDxe_INF_File + "\n")
-            fo.write("!endif\n")            
+            fo.write("!endif\n")
         fo.close()
 
+        #
+        # edk2 library DSC
+        #
         fo = open(self.Edk2RedfishIntpOutputDir + os.path.normpath("/" + self.Edk2RedfishIntpLibDsc),"a")
         if SchemaVersion == "":
-            fo.write("!if $(REDFISH_" + RedfishCs.ResourceType.upper() + ") OR $(REDFISH_CLIENT_ALL_AUTOGENED)\n")
+            fo.write("!if ($(REDFISH_" + RedfishCs.ResourceType.upper() + ") == TRUE) OR ($(REDFISH_CLIENT_ALL_AUTOGENED) == TRUE)\n")
             fo.write("  " + self.LibClass + "|" + self.Edk2RedfishJsonCsPackagePath + "RedfishClientPkg/ConverterLib" + Edk2BindingDir + "/" + RedfishCs.ResourceType + "/Lib.inf" + "\n")
             fo.write("!endif\n")            
         else:
-            fo.write("!if $(REDFISH_" + RedfishCs.ResourceType.upper() + "_" + SchemaVersion.upper() + ") OR $(REDFISH_CLIENT_ALL_AUTOGENED)\n")
+            fo.write("!if ($(REDFISH_" + RedfishCs.ResourceType.upper() + "_" + SchemaVersion.upper() + ") == TRUE) OR ($(REDFISH_CLIENT_ALL_AUTOGENED) == TRUE)\n")
             fo.write("  " + self.LibClass + "|" + self.Edk2RedfishJsonCsPackagePath + "RedfishClientPkg/ConverterLib" + Edk2BindingDir + "/" + RedfishCs.ResourceType + "/" + SchemaVersion + "/Lib.inf" + "\n")
-            fo.write("!endif\n")            
-        fo.close()        
+            fo.write("!endif\n")
+        fo.close()
+        #
+        # edk2 driver FDF
+        #        
+        fo = open(self.Edk2RedfishIntpOutputDir + os.path.normpath("/" + self.Edk2RedfishIntpFdf),"a")
+        if SchemaVersion == "":
+            fo.write("!if ($(REDFISH_" + RedfishCs.ResourceType.upper() + ") == TRUE) OR ($(REDFISH_CLIENT_ALL_AUTOGENED) == TRUE)\n")
+            fo.write("  INF  " + self.Edk2RedfishJsonCsPackagePath + "RedfishClientPkg/Converter/" + RedfishCs.ResourceType + "/" + RedfishCsSchemaDxe_INF_File + "\n")
+            fo.write("!endif\n")
+        else:
+            fo.write("!if ($(REDFISH_" + RedfishCs.ResourceType.upper() + "_" + SchemaVersion.upper() + ") == TRUE) OR ($(REDFISH_CLIENT_ALL_AUTOGENED) == TRUE)\n")
+            fo.write("  INF  " + self.Edk2RedfishJsonCsPackagePath + "RedfishClientPkg/Converter/" + RedfishCs.ResourceType + "/" + SchemaVersion + "/" + RedfishCsSchemaDxe_INF_File + "\n")
+            fo.write("!endif\n")
+        fo.close()
 
         fo = open(os.path.normpath(RedfishCsInterpreter_Source_Schema_dir + "/" + RedfishCsSchemaDxe_C_File),"w")
         Edk2RedfishIntpTempDxeCLines = self.Replacekeyworkds(Edk2RedfishIntpTempDxeCLines)

GenRedfishSchemaCS.py

@@ -2,7 +2,7 @@
 # Redfish JSON resource to C structure converter source code generator.
 #
 # Copyright Notice:
-# Copyright 2021 DMTF. All rights reserved.
+# Copyright 2021-2024 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Tacklebox/blob/main/LICENSE.md
 #
 import os
@@ -816,7 +816,7 @@ def PrintHelpMessageExit (str):
 #JsonFileIo.close()
 # Test Redfish property
 
-print ("\n\nDMTF Redfish Schema to C Structure Generator Copyrights 2018-2024 v1.2_schema2020.4")
+print ("\n\nDMTF Redfish Schema to C Structure Generator Copyrights 2018-2024 v1.3_schema2021.4")
 
 if "-logfile" in sys.argv:
     ToolLogInformation = ToolLogger.ToolLog (TOOL_LOG_TO_FILE, "RedfishCs.log")

LICENSE.md

@@ -6,7 +6,7 @@ other rights are granted by DMTF. This software might be subject to other rights
 
 ### Copyrights.
 
-Copyright (c) 2021-2022, Contributing Member(s) of Distributed Management Task Force,
+Copyright (c) 2021-2024, Contributing Member(s) of Distributed Management Task Force,
 Inc.. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,