Added support for git information in GET_INFO

This is disabled by default and must be enabled by passing
ENABLE_GIT_VERSION_INFO=1 to make.
When enabled, it requires git and python to be installed.
By default, make expects both a "git" and a "python" binary to be
present in the PATH. If this is not the case, the locations and names of
these binaries can instead be supplied by setting the GIT and PYTHON
variables accordingly.

Author: trinamic-LH

.gitignore

@@ -1,6 +1,7 @@
 /_build*/
 deploy_*.sh
 *~
+GitInfo.h
 
 # Created by https://www.toptal.com/developers/gitignore/api/visualstudio,c,linux,windows,macos,eclipse
 # Edit at https://www.toptal.com/developers/gitignore?templates=visualstudio,c,linux,windows,macos,eclipse

Makefile

@@ -285,11 +285,46 @@ else ifeq ($(DEVICE),LandungsbrueckeV3)
     endif
     _LDFLAGS += -specs=nosys.specs
 else
-    ifeq (,$(filter clean,$(MAKECMDGOALS)))
-        $(error You need to set the DEVICE parameter to "Landungsbruecke", "LandungsbrueckeSmall" or "LandungsbrueckeV3". When calling make directly, do this by adding DEVICE=Landungsbruecke, DEVICE=LandungsbrueckeV3 or DEVICE=LandungsbrueckeSmall to the commandline)
-    endif
+    ifneq (,$(filter clean,$(MAKECMDGOALS)))
+    else ifneq (,$(filter codegen,$(MAKECMDGOALS)))
+    else
+        $(error You need to set the DEVICE parameter to "Landungsbruecke", "LandungsbrueckeSmall" or "LandungsbrueckeV3". When calling make directly, do this by adding DEVICE=Landungsbruecke, DEVICE=LandungsbrueckeV3 or DEVICE=LandungsbrueckeSmall to the commandline)
+    endif
 endif
 
+### Git info for build image ###################################################
+# Output file location
+GIT_INFO_FILE := ./GitInfo.h
+
+# Command & script definitions
+GIT ?= git
+PYTHON ?= python
+GIT_INFO_TOOL ?= tools/generators/generate_git_info.py
+GIT_INFO_GENERATOR_CMD := $(PYTHON) $(GIT_INFO_TOOL)
+
+# Git info retrieval - off by default
+ENABLE_GIT_VERSION_INFO ?= 0
+ifneq ($(ENABLE_GIT_VERSION_INFO),0)
+GIT_HASH           := $(shell $(GIT) rev-parse --revs-only --short=7 HEAD)
+GIT_DIRTY_FLAG     := $(shell $(GIT) diff --quiet && echo "0" || echo "1")
+$(info Building git commit $(GIT_HASH)$(if $(filter $(GIT_DIRTY_FLAG),1),-dirty))
+
+# Git info file generation
+$(GIT_INFO_FILE): force
+	$(GIT_INFO_GENERATOR_CMD) $(GIT_HASH) $(GIT_DIRTY_FLAG) --output $(GIT_INFO_FILE)
+
+else
+# Git info file generation - Copy the placeholder file
+GIT_PLACEHOLDER_FILE := tools/generators/blank_git_info.h
+$(GIT_INFO_FILE): force
+	$(info Copying placeholder git info file: $(GIT_PLACEHOLDER_FILE) -> $(GIT_INFO_FILE))
+	cp $(GIT_PLACEHOLDER_FILE) $(GIT_INFO_FILE)
+endif
+
+
+# Add the file to the list of autogenerated files
+AUTOGENERATED_FILES += $(GIT_INFO_FILE)
+
 # System and hardware abstraction layer
 SRC             += $(TMC_HAL_SRC)/tmc/SysTick.c
 SRC             += $(TMC_HAL_SRC)/tmc/IOs.c
@@ -553,13 +588,15 @@ DEPFILES   = $(addprefix $(DEP_DIR)/, $(addsuffix .o.d, $(ALLSRCBASE)))
 
 ### Make targets ###
 # Default target. Build everything
-all: begin gccversion build size end
+all: codegen begin gccversion build size end
 
 # Target: clean project.
 clean: begin clean_list end
 
+# Target: Generate autogenerated files
+codegen: $(AUTOGENERATED_FILES)
 # Helper targets: This makes selecting all output types easier (see build target below)
-elf: $(DEVICE_DIR)/$(TARGET).elf
+elf: $(DEVICE_DIR)/$(TARGET).elf codegen
 lss: $(DEVICE_DIR)/$(TARGET).lss
 sym: $(DEVICE_DIR)/$(TARGET).sym
 hex: $(DEVICE_DIR)/$(TARGET).hex
@@ -712,4 +749,4 @@ force:
 
 # Listing of phony targets.
 .PHONY : all begin end size gccversion \
-build elf hex bin lss sym clean clean_list program tmclfwupload
+build codegen elf hex bin lss sym clean clean_list program tmclfwupload

tmc/TMCL.c

@@ -8,6 +8,9 @@
 
 
 #include "TMCL.h"
+
+#include "GitInfo.h"
+
 #include "BoardAssignment.h"
 #include "hal/derivative.h"
 #include "IdDetection.h"
@@ -972,6 +975,17 @@ static void handleGetInfo(void)
         ActualReply.Value.UInt32 = 12;
         break;
 
+    case 30: // Git info
+        if (GIT_VERSION_INFO == 0xFFFFFFFF)
+        {
+            // Illegal GIT_VERSION_INFO value -> Git info is disabled
+            ActualReply.Status = REPLY_INVALID_TYPE;
+            break;
+        }
+
+        ActualReply.Value.Int32 = GIT_VERSION_INFO;
+        break;
+
     case 200: // DeviceSpecificArea: Patch version
         ActualReply.Value.UInt32 = VERSION_PATCH;
         break;

tools/generators/blank_git_info.h

@@ -0,0 +1,26 @@
+/*******************************************************************************
+* Copyright © 2025 Analog Devices Inc. All Rights Reserved. This software is
+* proprietary & confidential to Analog Devices, Inc. and its licensors.
+*******************************************************************************/
+/*
+ * This is an empty placeholder file. It is copied by make if git version
+ * information is disabled.
+ *
+ * To enable git version information in the build, you must:
+ * - Have git installed and available - Either:
+ *     - Have "git" in your PATH for the Makefile to call
+ *     - Set the $GIT environment variable for the Makefile to use instead of "git"
+ * - Have python 3 installed and available - either:
+ *     - Have "python" in your PATH for the Makefile to call
+ *     - Set the $PYTHON environment variable for the Makefile to use instead of "python"
+ * - Pass ENABLE_GIT_VERSION_INFO=1 to make
+ */
+
+#ifndef GIT_INFO_H_
+#define GIT_INFO_H_
+
+// This value is invalid - it is used by C code to identify that
+// no git information is available.
+#define GIT_VERSION_INFO 0xFFFFFFFF
+
+#endif /* GIT_INFO_H_ */

tools/generators/generate_git_info.py

@@ -0,0 +1,83 @@
+################################################################################
+# Copyright © 2025 Analog Devices Inc. All Rights Reserved. This software is
+# proprietary & confidential to Analog Devices, Inc. and its licensors.
+################################################################################
+"""
+This script generates a C header containing git information.
+
+This header then is used by the C firmware build to make the git version control
+information available in the resulting binary.
+
+To enable git version information in the build, you must:
+- Have git installed and available - Either:
+    - Have "git" in your PATH for the Makefile to call
+    - Set the $GIT environment variable for the Makefile to use instead of "git"
+- Have python 3 installed and available - either:
+    - Have "python" in your PATH for the Makefile to call
+    - Set the $PYTHON environment variable for the Makefile to use instead of "python"
+- Pass ENABLE_GIT_VERSION_INFO=1 to make
+"""
+import argparse
+from datetime import datetime
+import sys
+
+header_file_template = """
+/*******************************************************************************
+* Copyright © $CURRENT_YEAR Analog Devices Inc. All Rights Reserved. This software is
+* proprietary & confidential to Analog Devices, Inc. and its licensors.
+*******************************************************************************/
+/*
+ * This code was generated, do not edit this file manually!
+ */
+
+#ifndef GIT_INFO_H_
+#define GIT_INFO_H_
+
+#define GIT_HASH         $GIT_HASH
+#define GIT_DIRTY_FLAG   $GIT_DIRTY_FLAG
+#define GIT_VERSION_INFO ((GIT_HASH & 0x0FFFFFFF) | (GIT_DIRTY_FLAG << 28))
+
+#endif /* GIT_INFO_H_ */
+"""
+
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Generate a header file with git hash and dirty flag defined")
+
+    parser.add_argument("git_hash", type=lambda x: int(x, 16))
+    parser.add_argument("git_dirty", type=int)
+    parser.add_argument("--output", default="src/GitInfo.h")
+
+    args = parser.parse_args()
+
+    # Sanity check inputs
+    if not (type(args.git_hash) == int and 0 <= args.git_hash <= 0x0FFF_FFFF):
+        print("Error: Git hash is not a seven digit hex number")
+        sys.exit(1)
+    if not (type(args.git_dirty) == int and args.git_dirty in [0, 1]):
+        print("Error: Git dirty flag is neither 0 nor 1")
+        sys.exit(1)
+
+    # Output generation
+    output_text = header_file_template.lstrip()
+    output_text = output_text.replace("$CURRENT_YEAR",   datetime.now().strftime("%Y"))
+    output_text = output_text.replace("$GIT_HASH",       f"0x{args.git_hash:08X}")
+    output_text = output_text.replace("$GIT_DIRTY_FLAG", f"{args.git_dirty}")
+
+    # Check whether the generated result matches the existing result
+    try:
+        with open(args.output, "rt", encoding="utf-8") as f:
+            if f.read() == output_text:
+                print(f"Skipping generation of {args.output} file - no changes")
+                sys.exit(0)
+    except OSError:
+        pass
+
+    with open(args.output, "wt", encoding="utf-8") as f:
+        print(f"Generating {args.output}")
+        f.write(output_text)
+
+if __name__ == "__main__":
+    main()