Minor code cleanups.

Author: dgarske

.github/workflows/make-test-swtpm.yml

@@ -68,7 +68,7 @@ jobs:
             wolftpm_config: --enable-st33
           # STMicro ST33KTPM2
           - name: st33ktpm2 firmware
-            wolftpm_config: --enable-st33 --enable-firmware --enable-st
+            wolftpm_config: --enable-st33 --enable-firmware
           # Microchip
           - name: microchip
             wolftpm_config: --enable-microchip

.gitignore

@@ -84,6 +84,7 @@ examples/boot/secret_seal
 examples/boot/secret_unseal
 examples/firmware/ifx_fw_extract
 examples/firmware/ifx_fw_update
+examples/firmware/st33_fw_update
 examples/endorsement/get_ek_certs
 examples/endorsement/verify_ek_cert
 
@@ -151,6 +152,10 @@ UpgradeLog.htm
 *.VC.db
 *.filters
 
+# macOS files
+._.DS_Store
+.DS_Store
+
 # Backup and old files
 /**/*.bak
 /**/*.old
@@ -170,3 +175,11 @@ UpgradeLog.htm
 # we won't track the actual working sdkconfig files
 /IDE/Espressif/**/sdkconfig
 /IDE/Espressif/**/sdkconfig.old
+
+# Firmware files
+examples/firmware/*.fi
+examples/firmware/*.BIN
+examples/firmware/*.DATA
+examples/firmware/*.MANIFEST
+examples/firmware/*.MANIFESTHASH
+

examples/firmware/README.md

@@ -153,7 +153,7 @@ Note: LMS format requirements:
 # Run without arguments to display the current firmware information
 ./st33_fw_update
 ST33 Firmware Update Tool
-TPM2: Caps 0x30000415, Did 0x0003, Vid 0x104a, Rid 0x 1 
+TPM2: Caps 0x30000415, Did 0x0003, Vid 0x104a, Rid 0x 1
 TPM2_Startup pass
 Mfg STM (2), Vendor ST33KTPM2X, Fw 9.257 (0x0)
 Firmware version details: Major=9, Minor=257, Vendor=0x0
@@ -165,7 +165,7 @@ Firmware update: Non-LMS format required
 ST33 Firmware Update Tool
 	Firmware File: TPM_ST33KTPM2X_00090200_V1.fi
 	Format: Non-LMS (V1)
-TPM2: Caps 0x30000415, Did 0x0003, Vid 0x104a, Rid 0x 1 
+TPM2: Caps 0x30000415, Did 0x0003, Vid 0x104a, Rid 0x 1
 TPM2_Startup pass
 Mfg STM (2), Vendor ST33KTPM2X, Fw 9.257 (0x0)
 Firmware version details: Major=9, Minor=257, Vendor=0x0
@@ -184,7 +184,7 @@ Please reset or power cycle the TPM.
 ST33 Firmware Update Tool
 	Firmware File: ST33KTPM2X_FAC_00090200_V2.fi
 	Format: LMS (V2)
-TPM2: Caps 0x30000415, Did 0x0003, Vid 0x104a, Rid 0x 3 
+TPM2: Caps 0x30000415, Did 0x0003, Vid 0x104a, Rid 0x 3
 TPM2_Startup pass
 Mfg STM (2), Vendor ST33KTPM2X, Fw 9.512 (0x0)
 Firmware version details: Major=9, Minor=512, Vendor=0x0
@@ -201,7 +201,7 @@ Please reset or power cycle the TPM.
 # Cancel an ongoing firmware update
 ./st33_fw_update --abandon
 ST33 Firmware Update Tool
-TPM2: Caps 0x30000415, Did 0x0003, Vid 0x104a, Rid 0x 1 
+TPM2: Caps 0x30000415, Did 0x0003, Vid 0x104a, Rid 0x 1
 TPM2_Startup pass
 Mfg STM (2), Vendor ST33KTPM2X, Fw 9.257 (0x0)
 Firmware version details: Major=9, Minor=257, Vendor=0x0
@@ -211,27 +211,4 @@ Firmware Update Abandon:
 Success: Please reset or power cycle TPM
 ```
 
-**Note**: Firmware files cannot be made public and must be obtained separately from STMicroelectronics. Reference implementation code is available in the `examples-private` repository.
-
-### Testing Firmware Updates
-
-The `test_st33_firmware.sh` script can be used to test firmware update functionality:
-
-```sh
-# Basic functionality tests (no firmware files needed)
-./examples/firmware/test_st33_firmware.sh
-
-# Test non-LMS firmware update only
-NON_LMS_FW_FILE=/path/to/nonlms.fi ./examples/firmware/test_st33_firmware.sh --no-lms
-
-# Test LMS firmware update only
-LMS_FW_FILE=/path/to/lms.fi ./examples/firmware/test_st33_firmware.sh --lms
-
-# Test both (backward compatible, runs both if both files are provided)
-LMS_FW_FILE=/path/to/lms.fi NON_LMS_FW_FILE=/path/to/nonlms.fi ./examples/firmware/test_st33_firmware.sh
-
-# Show help
-./examples/firmware/test_st33_firmware.sh --help
-```
-
-**Note**: Use `--lms` or `--no-lms` flags to test a specific update path. When neither flag is specified, the script will attempt to run both tests if both firmware files are provided (backward compatible behavior).
+**Note**: Firmware files cannot be made public and must be obtained separately from STMicroelectronics.

examples/firmware/include.am

@@ -8,28 +8,31 @@ EXTRA_DIST += examples/firmware/Makefile
 EXTRA_DIST += examples/firmware/ifx_fw_extract.c
 
 if BUILD_EXAMPLES
-if BUILD_INFINEON
 if BUILD_FIRMWARE
+
+if BUILD_INFINEON
 noinst_PROGRAMS += examples/firmware/ifx_fw_update
 noinst_HEADERS  += examples/firmware/ifx_fw_update.h
 examples_firmware_ifx_fw_update_SOURCES      = examples/firmware/ifx_fw_update.c \
                                                examples/tpm_test_keys.c
 examples_firmware_ifx_fw_update_LDADD        = src/libwolftpm.la $(LIB_STATIC_ADD)
 examples_firmware_ifx_fw_update_DEPENDENCIES = src/libwolftpm.la
 endif
-endif
+
 if BUILD_ST33
-if BUILD_FIRMWARE
 noinst_PROGRAMS += examples/firmware/st33_fw_update
 examples_firmware_st33_fw_update_SOURCES     = examples/firmware/st33_fw_update.c \
                                                examples/tpm_test_keys.c
 examples_firmware_st33_fw_update_LDADD       = src/libwolftpm.la $(LIB_STATIC_ADD)
 examples_firmware_st33_fw_update_DEPENDENCIES = src/libwolftpm.la
+
 endif
 endif
 endif
 
 example_firmwaredir = $(exampledir)/firmware
-dist_example_firmware_DATA = examples/firmware/ifx_fw_update.c
+dist_example_firmware_DATA = examples/firmware/ifx_fw_update.c \
+                             examples/firmware/st33_fw_update.c
 
-DISTCLEANFILES+= examples/firmware/.libs/ifx_fw_update
+DISTCLEANFILES+= examples/firmware/.libs/ifx_fw_update \
+                 examples/firmware/.libs/st33_fw_update

examples/firmware/st33_fw_update.c

@@ -138,6 +138,9 @@ static int TPM2_ST33_SendFirmwareData(fw_info_t* fwinfo)
     return rc;
 }
 
+/* Callback function for firmware data access
+ * Returns the actual number of bytes copied (may be less than requested at end of buffer)
+ * Returns BUFFER_E on error (offset out of bounds) */
 static int TPM2_ST33_FwData_Cb(uint8_t* data, uint32_t data_req_sz,
     uint32_t offset, void* cb_ctx)
 {
@@ -257,9 +260,9 @@ int TPM2_ST33_Firmware_Update(void* userCtx, int argc, char *argv[])
             rc, TPM2_GetRCString(rc));
         goto exit;
     }
-    
+
     TPM2_ST33_PrintInfo(&caps);
-    
+
     /* Verify this is an ST33 TPM */
     if (caps.mfg != TPM_MFG_STM) {
         printf("Error: This tool is for STMicroelectronics ST33 TPMs only!\n");