Merge pull request #448 from balena-io/update_orin_instructions

contracts/hw.device-type: Update instructions for Orin flasher types
balena-io · Dec 16, 2024 · 1cc20f9 · 1cc20f9
2 parents 474ab2d + ec076bf
commit 1cc20f9
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 20 deletions.
diff --git a/contracts/hw.device-type/jetson-agx-orin-devkit-64gb/contract.json b/contracts/hw.device-type/jetson-agx-orin-devkit-64gb/contract.json
@@ -28,12 +28,15 @@
     "is_private": false
   },
   "partials": {
+    "instructions": [
+        "For balenaOS versions v6.1.16 and newer, please ensure your device is running UEFI firmware version 36.3. Check and update the <a href=\"https://docs.balena.io/learn/develop/hardware/jetson-orin#provisioning-jetson-orin\">firmware version</a> before proceeding.",
+        "For balenaOS versions older than v6.1.16, please refer to the <a href=\"https://github.com/balena-os/jetson-flash?tab=readme-ov-file\">{{name}} legacy flashing</a> guide."
+    ],
     "bootDeviceExternal": [
-        "Put the device in <a href=\"https://github.com/balena-os/jetson-flash#recovery-mode\">force recovery</a> mode.",
-        "Connect the USB-C data port of the Devkit to the Host PC.",
-        "Boot the device from the inserted USB Key by following the <a href=\"https://github.com/balena-os/jetson-flash#agx-orin-devkit-64gb-flashing\">AGX Orin Devkit 64GB flashing steps</a>."
+        "Power on the {{name}}.",
+        "NOTE: Only If your device is already flashed with a balenaOS version older than v6.1.16, power it on and interrupt booting by pressing the 'Esc' key when prompted by the UEFI firmware. Enter the Boot Manager Menu of the UEFI firmware and select the attached USB key as boot media, to trigger the provisioning process."
     ],
     "flashIndicator": ["power LED is off"],
-    "bootDevice": ["Power up the {{name}}"]
+    "bootDevice": ["Power up the {{name}}. A progress bar will show up on the display while the UEFI firmware is updated. Please do not interrupt this process by turning off power or rebooting the device."]
   }
 }
diff --git a/contracts/hw.device-type/jetson-orin-nano-devkit-nvme/contract.json b/contracts/hw.device-type/jetson-orin-nano-devkit-nvme/contract.json
@@ -28,12 +28,14 @@
     "is_private": false
   },
   "partials": {
+    "instructions": [
+        "For balenaOS versions v6.1.16 and newer, please ensure your device is running UEFI firmware version 36.3. Check and update the <a href=\"https://docs.balena.io/learn/develop/hardware/jetson-orin#provisioning-jetson-orin\">firmware version</a> before proceeding.",
+        "For balenaOS versions older than v6.1.16, please refer to the <a href=\"https://github.com/balena-os/jetson-flash?tab=readme-ov-file\">{{name}} legacy flashing</a> guide."
+    ],
     "bootDeviceExternal": [
-        "Insert a NVME drive in the carrier board and put the device in <a href=\"https://github.com/balena-os/jetson-flash#recovery-mode\">force recovery</a> mode.",
-        "Connect the USB-C port of the carrier board to the Host PC.",
-        "RCM boot the balenaOS kernel following the <a href=\"https://github.com/balena-os/jetson-flash#orin-nano-flashing\">Orin Nano Flashing steps</a>."
+        "Insert a NVME drive in the Devkit and power up the {{name}}."
     ],
     "flashIndicator": ["power LED is off"],
-    "bootDevice": ["Remove recovery mode jumper and power up the {{name}}"]
+    "bootDevice": ["Power up the {{name}}. If you have a display or a debug UART cable connected to the device, a progress bar will show up while the UEFI firmware is updated. Please do not interrupt this process by turning off power or rebooting the device."]
   }
 }
diff --git a/contracts/hw.device-type/jetson-orin-nano-seeed-j3010/contract.json b/contracts/hw.device-type/jetson-orin-nano-seeed-j3010/contract.json
@@ -28,12 +28,14 @@
     "is_private": false
   },
   "partials": {
+    "instructions": [
+        "For balenaOS versions v6.1.16 and newer, please ensure your device is running UEFI firmware version 36.3. Check and update the <a href=\"https://docs.balena.io/learn/develop/hardware/jetson-orin#provisioning-jetson-orin\">firmware version</a> before proceeding.",
+        "For balenaOS versions older than v6.1.16, please refer to the <a href=\"https://github.com/balena-os/jetson-flash?tab=readme-ov-file\">{{name}} legacy flashing</a> guide."
+    ],
     "bootDeviceExternal": [
-        "Put the device in <a href=\"https://github.com/balena-os/jetson-flash#recovery-mode\">force recovery</a> mode.",
-        "Connect the USB-C port of the carrier board to the Host PC.",
-        "RCM boot the balenaOS kernel following the <a href=\"https://github.com/balena-os/jetson-flash#seeed-recomputer-j3010-flashing\">Seeed reComputer J3010 Flashing steps</a>."
+        "Insert a NVME drive in the Devkit and power up the {{name}}"
     ],
     "flashIndicator": ["power LED is off"],
-    "bootDevice": ["Remove recovery mode jumper and power up the {{name}}"]
+    "bootDevice": ["Power up the {{name}}. If you have a display or a debug UART cable connected to the device, a progress bar will show up while the UEFI firmware is updated. Please do not interrupt this process by turning off power or rebooting the device."]
   }
 }
diff --git a/contracts/hw.device-type/jetson-orin-nx-seeed-j4012/contract.json b/contracts/hw.device-type/jetson-orin-nx-seeed-j4012/contract.json
@@ -28,12 +28,14 @@
     "is_private": false
   },
   "partials": {
+    "instructions": [
+        "For balenaOS versions v6.1.16 and newer, please ensure your device is running UEFI firmware version 36.3. Check and update the <a href=\"https://docs.balena.io/learn/develop/hardware/jetson-orin#provisioning-jetson-orin\">firmware version</a> before proceeding.",
+        "For balenaOS versions older than v6.1.16, please refer to the <a href=\"https://github.com/balena-os/jetson-flash?tab=readme-ov-file\">{{name}} legacy flashing</a> guide."
+    ],
     "bootDeviceExternal": [
-        "Put the device in <a href=\"https://github.com/balena-os/jetson-flash#recovery-mode\">force recovery</a> mode.",
-        "Connect the USB-C port of the carrier board to the Host PC.",
-        "RCM boot the balenaOS kernel following the <a href=\"https://github.com/balena-os/jetson-flash#seeed-recomputer-j4012-flashing\">Seeed reComputer J4012 Flashing steps</a>."
+        "Insert a NVME drive in the Devkit and power up the {{name}}."
     ],
     "flashIndicator": ["power LED is off"],
-    "bootDevice": ["Remove recovery mode jumper and power up the {{name}}"]
+    "bootDevice": ["Power up the {{name}}. If you have a display or a debug UART cable connected to the device, a progress bar will show up while the UEFI firmware is updated. Please do not interrupt this process by turning off power or rebooting the device."]
   }
 }
diff --git a/contracts/hw.device-type/jetson-orin-nx-xavier-nx-devkit/contract.json b/contracts/hw.device-type/jetson-orin-nx-xavier-nx-devkit/contract.json
@@ -28,12 +28,14 @@
     "is_private": false
   },
   "partials": {
+      "instructions": [
+        "For balenaOS versions v6.1.16 and newer, please ensure your device is running UEFI firmware version 36.3. Check and update the <a href=\"https://docs.balena.io/learn/develop/hardware/jetson-orin#provisioning-jetson-orin\">firmware version</a> before proceeding.",
+        "For balenaOS versions older than v6.1.16, please refer to the <a href=\"https://github.com/balena-os/jetson-flash?tab=readme-ov-file\">{{name}} legacy flashing</a> guide."
+    ],
     "bootDeviceExternal": [
-        "Insert a NVME drive in the carrier board and put the device in <a href=\"https://github.com/balena-os/jetson-flash#recovery-mode\">force recovery</a> mode.",
-        "Connect the micro-USB port of the carrier board to the Host PC.",
-        "RCM boot the balenaOS kernel following the <a href=\"https://github.com/balena-os/jetson-flash#orin-nx-flashing\">Orin NX Flashing steps</a>."
+        "Insert a NVME drive in the Devkit and power up the {{name}}."
     ],
     "flashIndicator": ["power LED is off"],
-    "bootDevice": ["Remove recovery mode jumper and power up the {{name}}"]
+    "bootDevice": ["Power up the {{name}}. A progress bar will show up on the display while the UEFI firmware is updated. Please do not interrupt this process by turning off power or rebooting the device."]
   }
 }