From 7612907337e135f080fed96ee78a346c3b9e6a04 Mon Sep 17 00:00:00 2001
From: Tim Gover <tim.gover@raspberrypi.com>
Date: Sat, 17 Oct 2020 13:32:57 +0100
Subject: [PATCH] Add the timestamp of the update to the pieeprom.sig file.

Add the timestamp to pieeprom.sig for use with a future bootloader
update.

This is not relevant for the VL805 firmware because it is not
configurable.
---
 rpi-eeprom-config |  3 +++
 rpi-eeprom-update | 21 ++++++++++++++++++---
 2 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/rpi-eeprom-config b/rpi-eeprom-config
index ea2ca48..21a9ed2 100755
--- a/rpi-eeprom-config
+++ b/rpi-eeprom-config
@@ -22,6 +22,9 @@ MAX_BOOTCONF_SIZE = 2024
 # The number, order and size of the sections depends on the bootloader version
 # but the following mask can be used to test for section headers and skip
 # unknown data.
+#
+# The last 4KB of the EEPROM image is reserved for internal use by the
+# bootloader and may be overwritten during the update process.
 MAGIC = 0x55aaf00f
 MAGIC_MASK = 0xfffff00f
 FILE_MAGIC = 0x55aaf11f # id for modifiable file, currently only bootconf.txt
diff --git a/rpi-eeprom-update b/rpi-eeprom-update
index 9012b5b..90eb12d 100755
--- a/rpi-eeprom-update
+++ b/rpi-eeprom-update
@@ -151,9 +151,15 @@ applyRecoveryUpdate()
 
    # A '.sig' file is created so that recovery.bin can check that the
    # EEPROM image has not been created (e.g. SD card corruption).
-   # The .sig file format is currently just a SHA256 in ASCII hex. In future,
-   # if an actual public key signature is required then that plus any other
-   # data would be appended after the SHA256 signature.
+   # Format of the .sig file.
+   # --
+   # SHA256\n
+   # ts: UPDATE-TIMESTAMP\n
+   # --
+   # SHA256 is a 64 character hex string
+   # UPDATE-TIMESTAMP is an unsigned decimal.
+   #
+   # The 'filename' output from sha256 MUST be omitted.
    if [ -n "${BOOTLOADER_UPDATE_IMAGE}" ]; then
         [ -f "${BOOTLOADER_UPDATE_IMAGE}" ] || die "${BOOTLOADER_UPDATE_IMAGE} not found"
 
@@ -167,6 +173,15 @@ applyRecoveryUpdate()
         sha256sum "${TMP_EEPROM_IMAGE}" | awk '{print $1}' > "${BOOTFS}/pieeprom.sig" \
                 || die "Failed to create ${BOOTFS}/pieeprom.sig"
 
+        # Appends the update creation timestamp on a newline in pieeprom.sig
+        # During an self-update mode the bootloader examines the update timestamp
+        # and # will only update itself if it is newer than than the current update
+        # timestamp.
+        #
+        # The update-timestamp is indendent of the bootloader version and
+        # and does not have to be timestamp.
+        echo "ts: $(date -u +%s)" >> "${BOOTFS}/pieeprom.sig"
+
         cp -f "${TMP_EEPROM_IMAGE}" "${BOOTFS}/pieeprom.upd" \
                 || die "Failed to copy ${TMP_EEPROM_IMAGE} to ${BOOTFS}"