From 4130f7ca3ee4b4b314ab296a75419dce4fd2c984 Mon Sep 17 00:00:00 2001 From: Tim Gover Date: Mon, 25 Nov 2024 09:29:48 +0000 Subject: [PATCH 01/20] EEPROM config: Update POWER_OFF_ON_HALT defaults The default value for CM5 and PI500 is 1. --- .../asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index 36e984a833..2dbc47eb24 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -47,7 +47,7 @@ Default: `115200` If `1` then `sudo halt` will run in a lower power mode until either GPIO3 or GLOBAL_EN are shorted to ground. -This setting is not relevant on Raspberry Pi 5 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wakeup from `HALT` or `STANDBY`. +This setting is not relevant on Raspberry Pi 5, CM5 or Pi500 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wakeup from `HALT` or `STANDBY`. Default: `1` @@ -60,7 +60,7 @@ Raspberry Pi 400 has a dedicated power button which operates even if the process On Raspberry Pi 5 this places the PMIC in `STANDBY` mode where all outputs are switched off. There is no need to set `WAKE_ON_GPIO` and pressing the xref:raspberry-pi.adoc#power-button[dedicated power button] will boot the device. -Default: `0` +Default: `1` on CM5 and Pi500, otherwise `0` [[BOOT_ORDER]] ==== `BOOT_ORDER` From c007ae3375b6fb05124b1c6cb16fa4418e2af921 Mon Sep 17 00:00:00 2001 From: Tim Gover Date: Mon, 25 Nov 2024 09:35:41 +0000 Subject: [PATCH 02/20] eeprom config: Add documentation for NETWORK_INSTALL_AT_POWER_ON --- .../computers/raspberry-pi/eeprom-bootloader.adoc | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index 2dbc47eb24..b6fc541306 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -398,7 +398,14 @@ This setting is ignored and network install is disabled if `DISABLE_HDMI=1` is s In order to detect the keyboard, network install must initialise the USB controller and enumerate devices. This increases boot time by approximately 1 second so it may be advantageous to disable network install in some embedded applications. -Default: `1` on Raspberry Pi 4 and Raspberry Pi 400, and `0` on Compute Module 4. +Default: `1` on Raspberry Pi 4 and Raspberry Pi 400, and `0` on Compute Module 4, CM4S and CM5. + +[[NET_INSTALL_AT_POWER_ON]] +==== `NET_INSTALL_AT_POWER_ON` +If this property is set to `1` then the network install UI will briefly be displayed after a cold boot to make this feature more obvious to new users. +The default bootloader images set this value to `1` in the bootloader config. It can be disabled via the `Advanced Options` menu in `raspi-config` or by manually deleting the line via `sudo rpi-eeprom-config --edit` + +Default: `0` [[NET_INSTALL_KEYBOARD_WAIT]] ==== `NET_INSTALL_KEYBOARD_WAIT` From df051e62b1ce22433be3e286c4f2937329510440 Mon Sep 17 00:00:00 2001 From: Tim Gover Date: Mon, 25 Nov 2024 09:44:12 +0000 Subject: [PATCH 03/20] config.txt: Add documentation for enable_rp1_uart --- documentation/asciidoc/computers/config_txt/boot.adoc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/documentation/asciidoc/computers/config_txt/boot.adoc b/documentation/asciidoc/computers/config_txt/boot.adoc index 618683f8f8..86b3344d02 100644 --- a/documentation/asciidoc/computers/config_txt/boot.adoc +++ b/documentation/asciidoc/computers/config_txt/boot.adoc @@ -154,6 +154,14 @@ Not relevant on Raspberry Pi 5 because there is no `start.elf` file. Default: `0x0` +[[enable_rp1_uart]] +==== `enable_rp1_uart` + +If `enable_rp1_uart` is set to `1` then firmware initialises RP1 UART0 to 115200 bps and doesn't reset RP1 before starting the OS (`pciex4_reset=1`). +This makes it easier to get UART output on the 40-pin header in early boot-code e.g. bare-metal debug. + +Default: `0x0` + [[pciex4_reset]] ==== `pciex4_reset` From 53d7721fc46e0f6449d0b9297b2f1302afdb648c Mon Sep 17 00:00:00 2001 From: Tim Gover Date: Mon, 25 Nov 2024 09:50:26 +0000 Subject: [PATCH 04/20] rpi-eeprom-update: Indicate that this is supported on CM5 / Pi500 CM4/CM4-S are the special cases because the 2711 bootrom cannot load `recovery.bin` from EMMC on platforms where RSA boot signing is enabled by default. --- .../asciidoc/computers/raspberry-pi/boot-eeprom.adoc | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc index c9f40c79ea..f189658c88 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc @@ -1,6 +1,6 @@ == Raspberry Pi boot EEPROM -Raspberry Pi 5, Raspberry Pi 4, 400, Compute Module 4, and Compute Module 4S computers use an EEPROM to boot the system. All other models of Raspberry Pi computer use the `bootcode.bin` file located in the boot filesystem. +Raspberry Pi 5, Compute Module 5, Raspberry Pi 500, Raspberry Pi 4, Raspberry Pi 400, Compute Module 4, and Compute Module 4S computers use an EEPROM to boot the system. All other models of Raspberry Pi computer use the `bootcode.bin` file located in the boot filesystem. NOTE: You can find the scripts and pre-compiled binaries used to create `rpi-eeprom` in the https://github.com/raspberrypi/rpi-eeprom/[rpi-eeprom GitHub repository]. @@ -13,10 +13,13 @@ If an error occurs during boot, then an xref:configuration.adoc#led-warning-flas There are multiple ways to update the bootloader of your Raspberry Pi. -==== Raspberry Pi 5, Raspberry Pi 4 and Raspberry Pi 400 +==== Raspberry Pi 5, Compute Module 5, Raspberry Pi 500, Raspberry Pi 4 and Raspberry Pi 400 Raspberry Pi OS automatically updates the bootloader for important bug fixes. To manually update the bootloader or change the boot order, use xref:configuration.adoc#raspi-config[raspi-config]. +N.B. On Compute Module 4 and CM4S the bootrom is unable to load the `recovery.bin` file from EMMC and automatic bootloader updates are not enabled. +The recommended update mechanism is `rpiboot` or via `flashrom` - see `rpi-eeprom-update -h` for more information. + [[imager]] ==== Use Raspberry Pi Imager to update the bootloader From 4085a0713cb7ea1c6c2ab24652d5f8116d13b6c0 Mon Sep 17 00:00:00 2001 From: Tim Gover Date: Mon, 25 Nov 2024 09:54:26 +0000 Subject: [PATCH 05/20] initial-turbo: Add a note indicating that the default is changing to 60 seconds --- documentation/asciidoc/computers/config_txt/overclocking.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/documentation/asciidoc/computers/config_txt/overclocking.adoc b/documentation/asciidoc/computers/config_txt/overclocking.adoc index 395d4e686f..a8b7175c1d 100644 --- a/documentation/asciidoc/computers/config_txt/overclocking.adoc +++ b/documentation/asciidoc/computers/config_txt/overclocking.adoc @@ -61,6 +61,7 @@ WARNING: Setting any overclocking parameters to values other than those used by | initial_turbo | Enables https://forums.raspberrypi.com/viewtopic.php?f=29&t=6201&start=425#p180099[turbo mode from boot] for the given value in seconds, or until cpufreq sets a frequency. The maximum value is `60`. +| In newer versions of the firmware (rpi-update 2024/11) the default has been changed to `60` in order to reduce boot time. | arm_freq_min | Minimum value of `arm_freq` used for dynamic frequency clocking. Note that reducing this value below the default does not result in any significant power savings, and is not currently supported. From 4b5ecb589054c13ec4b3a3ecb3b27d88c31b6253 Mon Sep 17 00:00:00 2001 From: Tim Gover Date: Mon, 25 Nov 2024 09:59:05 +0000 Subject: [PATCH 06/20] overclocking: The SHIFT key override is going - remove this from overclocking docs --- .../asciidoc/computers/config_txt/overclocking.adoc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/documentation/asciidoc/computers/config_txt/overclocking.adoc b/documentation/asciidoc/computers/config_txt/overclocking.adoc index a8b7175c1d..65a9372c5f 100644 --- a/documentation/asciidoc/computers/config_txt/overclocking.adoc +++ b/documentation/asciidoc/computers/config_txt/overclocking.adoc @@ -60,8 +60,7 @@ WARNING: Setting any overclocking parameters to values other than those used by | Forces turbo mode frequencies even when the ARM cores are not busy. Enabling this may set the warranty bit if `over_voltage_*` is also set. | initial_turbo -| Enables https://forums.raspberrypi.com/viewtopic.php?f=29&t=6201&start=425#p180099[turbo mode from boot] for the given value in seconds, or until cpufreq sets a frequency. The maximum value is `60`. -| In newer versions of the firmware (rpi-update 2024/11) the default has been changed to `60` in order to reduce boot time. +| Enables https://forums.raspberrypi.com/viewtopic.php?f=29&t=6201&start=425#p180099[turbo mode from boot] for the given value in seconds, or until cpufreq sets a frequency. The maximum value is `60`. In newer versions of the firmware (rpi-update 2024/11) the default has been changed to `60` in order to reduce boot time. In addition, the Kernel CPU performance governor has been switched from `powersave` to `ondemand`. | arm_freq_min | Minimum value of `arm_freq` used for dynamic frequency clocking. Note that reducing this value below the default does not result in any significant power savings, and is not currently supported. @@ -382,4 +381,4 @@ $ vcgencmd pmic_read_adc EXT5V_V === Overclocking problems -Most overclocking issues show up immediately with a failure to boot. If this occurs, hold down the `shift` key during the next boot. This will temporarily disable all overclocking, allowing you to boot successfully and then edit your settings. +Most overclocking issues show up immediately with a failure to boot. If this occurs, remove any clock frequency overrides from `config.txt` then increasing the core-voltage via the `over_voltage_delta` parameter before re-applying over-clocking parameters. From 66d36088f24a5355e8d9513ff3be4055a2889bf9 Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 25 Nov 2024 13:33:34 +0000 Subject: [PATCH 07/20] Update documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc --- .../asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index b6fc541306..fcca8bb59b 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -60,7 +60,7 @@ Raspberry Pi 400 has a dedicated power button which operates even if the process On Raspberry Pi 5 this places the PMIC in `STANDBY` mode where all outputs are switched off. There is no need to set `WAKE_ON_GPIO` and pressing the xref:raspberry-pi.adoc#power-button[dedicated power button] will boot the device. -Default: `1` on CM5 and Pi500, otherwise `0` +Default: `1` on Compute Module 5 and Pi 500, otherwise `0` [[BOOT_ORDER]] ==== `BOOT_ORDER` From ff80aa7c7946885c3dc31601ec1cefe1214e155f Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 25 Nov 2024 13:34:49 +0000 Subject: [PATCH 08/20] Update documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc --- .../asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index fcca8bb59b..49dc4c1d20 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -398,7 +398,7 @@ This setting is ignored and network install is disabled if `DISABLE_HDMI=1` is s In order to detect the keyboard, network install must initialise the USB controller and enumerate devices. This increases boot time by approximately 1 second so it may be advantageous to disable network install in some embedded applications. -Default: `1` on Raspberry Pi 4 and Raspberry Pi 400, and `0` on Compute Module 4, CM4S and CM5. +Default: `1` on Raspberry Pi 4 and Raspberry Pi 400; `0` on Compute Module 4, Compute Module 4S, and Compute Module 5. [[NET_INSTALL_AT_POWER_ON]] ==== `NET_INSTALL_AT_POWER_ON` From 600f130e1f28aaed82bc7e4147f0b4083370be98 Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 25 Nov 2024 13:38:05 +0000 Subject: [PATCH 09/20] Update documentation/asciidoc/computers/config_txt/overclocking.adoc --- .../asciidoc/computers/config_txt/overclocking.adoc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/config_txt/overclocking.adoc b/documentation/asciidoc/computers/config_txt/overclocking.adoc index 65a9372c5f..41a9abde1d 100644 --- a/documentation/asciidoc/computers/config_txt/overclocking.adoc +++ b/documentation/asciidoc/computers/config_txt/overclocking.adoc @@ -60,7 +60,11 @@ WARNING: Setting any overclocking parameters to values other than those used by | Forces turbo mode frequencies even when the ARM cores are not busy. Enabling this may set the warranty bit if `over_voltage_*` is also set. | initial_turbo -| Enables https://forums.raspberrypi.com/viewtopic.php?f=29&t=6201&start=425#p180099[turbo mode from boot] for the given value in seconds, or until cpufreq sets a frequency. The maximum value is `60`. In newer versions of the firmware (rpi-update 2024/11) the default has been changed to `60` in order to reduce boot time. In addition, the Kernel CPU performance governor has been switched from `powersave` to `ondemand`. +| Enables https://forums.raspberrypi.com/viewtopic.php?f=29&t=6201&start=425#p180099[turbo mode from boot] for the given value in seconds, or until `cpufreq` sets a frequency. The maximum value is `60`. The November 2024 firmware update made the following changes: + +* changed the default to `60` to reduce boot time +* switched the kernel CPU performance governor from `powersave` to `ondemand` + | arm_freq_min | Minimum value of `arm_freq` used for dynamic frequency clocking. Note that reducing this value below the default does not result in any significant power savings, and is not currently supported. From 91ce7b8482881c6e65b561e50959fd458f32d376 Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 25 Nov 2024 13:41:26 +0000 Subject: [PATCH 10/20] Update documentation/asciidoc/computers/config_txt/overclocking.adoc --- .../asciidoc/computers/config_txt/overclocking.adoc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/config_txt/overclocking.adoc b/documentation/asciidoc/computers/config_txt/overclocking.adoc index 41a9abde1d..639198483d 100644 --- a/documentation/asciidoc/computers/config_txt/overclocking.adoc +++ b/documentation/asciidoc/computers/config_txt/overclocking.adoc @@ -385,4 +385,9 @@ $ vcgencmd pmic_read_adc EXT5V_V === Overclocking problems -Most overclocking issues show up immediately with a failure to boot. If this occurs, remove any clock frequency overrides from `config.txt` then increasing the core-voltage via the `over_voltage_delta` parameter before re-applying over-clocking parameters. +Most overclocking issues show up immediately, when the device fails to boot. If your device fails to boot due to an overclocking configuration change, use the following steps to return your device to a bootable state: + +. Remove any clock frequency overrides from `config.txt`. +. Increase the core voltage using `over_voltage_delta`. +. Re-apply overclocking parameters, taking care to avoid the previous known-bad overclocking parameters. + From 71898df37228201d0c8e20dca09cea97f129b5ca Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 25 Nov 2024 13:44:27 +0000 Subject: [PATCH 11/20] Update documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc --- .../asciidoc/computers/raspberry-pi/boot-eeprom.adoc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc index f189658c88..2de8564814 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc @@ -1,6 +1,12 @@ == Raspberry Pi boot EEPROM -Raspberry Pi 5, Compute Module 5, Raspberry Pi 500, Raspberry Pi 4, Raspberry Pi 400, Compute Module 4, and Compute Module 4S computers use an EEPROM to boot the system. All other models of Raspberry Pi computer use the `bootcode.bin` file located in the boot filesystem. +The following Raspberry Pi models use an EEPROM to boot the system: + +* Flagship models since Raspberry Pi 4 +* Compute Module models since Compute Module 4 (including Compute Module 4S) +* Keyboard models since Raspberry Pi 400 + +All other models of Raspberry Pi computer use the `bootcode.bin` file located in the boot filesystem. NOTE: You can find the scripts and pre-compiled binaries used to create `rpi-eeprom` in the https://github.com/raspberrypi/rpi-eeprom/[rpi-eeprom GitHub repository]. From 05e92201a2e5643dbdb2475fa00b9ba7bdd686ee Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 25 Nov 2024 13:45:42 +0000 Subject: [PATCH 12/20] Update documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc --- .../asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index 49dc4c1d20..ecadbf1b6a 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -47,7 +47,7 @@ Default: `115200` If `1` then `sudo halt` will run in a lower power mode until either GPIO3 or GLOBAL_EN are shorted to ground. -This setting is not relevant on Raspberry Pi 5, CM5 or Pi500 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wakeup from `HALT` or `STANDBY`. +This setting is not relevant on Raspberry Pi 5, Compute Module 5, or Raspberry Pi 500 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wake from `HALT` or `STANDBY`. Default: `1` From 8fb29644d22055ff552f785af393ae293f07b786 Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 25 Nov 2024 13:47:27 +0000 Subject: [PATCH 13/20] Update documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc --- .../asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index ecadbf1b6a..746f5f1803 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -60,7 +60,7 @@ Raspberry Pi 400 has a dedicated power button which operates even if the process On Raspberry Pi 5 this places the PMIC in `STANDBY` mode where all outputs are switched off. There is no need to set `WAKE_ON_GPIO` and pressing the xref:raspberry-pi.adoc#power-button[dedicated power button] will boot the device. -Default: `1` on Compute Module 5 and Pi 500, otherwise `0` +Default: `1` on Compute Modules since Compute Module 5 and Keyboard models since Raspberry Pi 500; otherwise `0` [[BOOT_ORDER]] ==== `BOOT_ORDER` From af1e36486e56f0e4d261decd66ca5a7e9c165c2a Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 25 Nov 2024 13:50:13 +0000 Subject: [PATCH 14/20] Update documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc --- .../computers/raspberry-pi/eeprom-bootloader.adoc | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index 746f5f1803..a6b413b948 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -402,8 +402,16 @@ Default: `1` on Raspberry Pi 4 and Raspberry Pi 400; `0` on Compute Module 4, Co [[NET_INSTALL_AT_POWER_ON]] ==== `NET_INSTALL_AT_POWER_ON` -If this property is set to `1` then the network install UI will briefly be displayed after a cold boot to make this feature more obvious to new users. -The default bootloader images set this value to `1` in the bootloader config. It can be disabled via the `Advanced Options` menu in `raspi-config` or by manually deleting the line via `sudo rpi-eeprom-config --edit` + +When set to `1`, displays the network install UI briefly after a cold boot to make this feature more obvious to new users. + +The default bootloader images set this value to `1` in the bootloader config. To disable the brief network install UI display, use the `Advanced Options` menu in `raspi-config` or manually delete this line in `rpi-eeprom-config`: + +[source,console] +---- +$ sudo rpi-eeprom-config --edit +---- + Default: `0` From 2b678065f172fb1582de953aab8299917079fc6a Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 25 Nov 2024 14:13:24 +0000 Subject: [PATCH 15/20] Apply suggestions from code review --- documentation/asciidoc/computers/config_txt/boot.adoc | 4 ++-- documentation/asciidoc/computers/config_txt/overclocking.adoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/asciidoc/computers/config_txt/boot.adoc b/documentation/asciidoc/computers/config_txt/boot.adoc index 86b3344d02..351984dcb0 100644 --- a/documentation/asciidoc/computers/config_txt/boot.adoc +++ b/documentation/asciidoc/computers/config_txt/boot.adoc @@ -157,8 +157,8 @@ Default: `0x0` [[enable_rp1_uart]] ==== `enable_rp1_uart` -If `enable_rp1_uart` is set to `1` then firmware initialises RP1 UART0 to 115200 bps and doesn't reset RP1 before starting the OS (`pciex4_reset=1`). -This makes it easier to get UART output on the 40-pin header in early boot-code e.g. bare-metal debug. +When set to `1`, firmware initialises RP1 UART0 to 115200bps and doesn't reset RP1 before starting the OS (separately configurable using `pciex4_reset=1`). +This makes it easier to get UART output on the 40-pin header in early boot-code, for instance during bare-metal debug. Default: `0x0` diff --git a/documentation/asciidoc/computers/config_txt/overclocking.adoc b/documentation/asciidoc/computers/config_txt/overclocking.adoc index 639198483d..bf25e35040 100644 --- a/documentation/asciidoc/computers/config_txt/overclocking.adoc +++ b/documentation/asciidoc/computers/config_txt/overclocking.adoc @@ -62,7 +62,7 @@ WARNING: Setting any overclocking parameters to values other than those used by | initial_turbo | Enables https://forums.raspberrypi.com/viewtopic.php?f=29&t=6201&start=425#p180099[turbo mode from boot] for the given value in seconds, or until `cpufreq` sets a frequency. The maximum value is `60`. The November 2024 firmware update made the following changes: -* changed the default to `60` to reduce boot time +* changed the default from `0` to `60` to reduce boot time * switched the kernel CPU performance governor from `powersave` to `ondemand` From d96c178e42795cc6ba1d0bab82b78b8929ae3775 Mon Sep 17 00:00:00 2001 From: nate contino Date: Tue, 26 Nov 2024 03:54:17 +0000 Subject: [PATCH 16/20] Update documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc --- .../asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index a6b413b948..eccae4767b 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -398,7 +398,7 @@ This setting is ignored and network install is disabled if `DISABLE_HDMI=1` is s In order to detect the keyboard, network install must initialise the USB controller and enumerate devices. This increases boot time by approximately 1 second so it may be advantageous to disable network install in some embedded applications. -Default: `1` on Raspberry Pi 4 and Raspberry Pi 400; `0` on Compute Module 4, Compute Module 4S, and Compute Module 5. +Default: `1` on Raspberry Pi 5, Raspberry Pi 4 and Raspberry Pi 400; `0` on Compute Module 4, Compute Module 4S, and Compute Module 5. [[NET_INSTALL_AT_POWER_ON]] ==== `NET_INSTALL_AT_POWER_ON` From a3a4b557aaddbfaf3b194b4032967b70eceb78a2 Mon Sep 17 00:00:00 2001 From: nate contino Date: Tue, 26 Nov 2024 03:58:32 +0000 Subject: [PATCH 17/20] Apply suggestions from code review --- documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc | 2 +- .../asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc index 2de8564814..b60f2f9848 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc @@ -23,7 +23,7 @@ There are multiple ways to update the bootloader of your Raspberry Pi. Raspberry Pi OS automatically updates the bootloader for important bug fixes. To manually update the bootloader or change the boot order, use xref:configuration.adoc#raspi-config[raspi-config]. -N.B. On Compute Module 4 and CM4S the bootrom is unable to load the `recovery.bin` file from EMMC and automatic bootloader updates are not enabled. +NOTE: Compute Module 4 and Compute Module 4S do not support automatic bootloader updates because the bootrom cannot load the `recovery.bin` file from eMMC. The recommended update mechanism is `rpiboot` or via `flashrom` - see `rpi-eeprom-update -h` for more information. [[imager]] diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index eccae4767b..8cf531f216 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -403,7 +403,7 @@ Default: `1` on Raspberry Pi 5, Raspberry Pi 4 and Raspberry Pi 400; `0` on Comp [[NET_INSTALL_AT_POWER_ON]] ==== `NET_INSTALL_AT_POWER_ON` -When set to `1`, displays the network install UI briefly after a cold boot to make this feature more obvious to new users. +When set to `1`, displays the network install UI briefly after a cold boot to make this feature more obvious to new users. Overrides `NET_INSTALL_ENABLED` if the settings conflict. The default bootloader images set this value to `1` in the bootloader config. To disable the brief network install UI display, use the `Advanced Options` menu in `raspi-config` or manually delete this line in `rpi-eeprom-config`: From 6ca9f97d9e4bf16e745043f5940d8e95baf7f194 Mon Sep 17 00:00:00 2001 From: nate contino Date: Tue, 26 Nov 2024 16:32:04 +0000 Subject: [PATCH 18/20] Update documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc --- .../asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index 8cf531f216..8dbe1aef8e 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -398,7 +398,7 @@ This setting is ignored and network install is disabled if `DISABLE_HDMI=1` is s In order to detect the keyboard, network install must initialise the USB controller and enumerate devices. This increases boot time by approximately 1 second so it may be advantageous to disable network install in some embedded applications. -Default: `1` on Raspberry Pi 5, Raspberry Pi 4 and Raspberry Pi 400; `0` on Compute Module 4, Compute Module 4S, and Compute Module 5. +Default: `1` on Raspberry Pi 5, Raspberry Pi 4, Raspberry Pi 500, and Raspberry Pi 400; `0` on Compute Module 4, Compute Module 4S, and Compute Module 5. [[NET_INSTALL_AT_POWER_ON]] ==== `NET_INSTALL_AT_POWER_ON` From 95603a7dd546c3f0e94b92ffaff5687c9b75e15d Mon Sep 17 00:00:00 2001 From: nate contino Date: Tue, 26 Nov 2024 17:08:27 +0000 Subject: [PATCH 19/20] Adopt consistent, terse, clear model references --- .../asciidoc/computers/raspberry-pi/boot-eeprom.adoc | 8 ++++---- .../computers/raspberry-pi/eeprom-bootloader.adoc | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc index b60f2f9848..b5e9941777 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc @@ -2,9 +2,9 @@ The following Raspberry Pi models use an EEPROM to boot the system: -* Flagship models since Raspberry Pi 4 -* Compute Module models since Compute Module 4 (including Compute Module 4S) -* Keyboard models since Raspberry Pi 400 +* Flagship models since 4 +* Compute Module models since 4 (including Compute Module 4S) +* Keyboard models since 400 All other models of Raspberry Pi computer use the `bootcode.bin` file located in the boot filesystem. @@ -19,7 +19,7 @@ If an error occurs during boot, then an xref:configuration.adoc#led-warning-flas There are multiple ways to update the bootloader of your Raspberry Pi. -==== Raspberry Pi 5, Compute Module 5, Raspberry Pi 500, Raspberry Pi 4 and Raspberry Pi 400 +==== Flagship models since 4; Compute Modules since 5; Keyboard models since 400 Raspberry Pi OS automatically updates the bootloader for important bug fixes. To manually update the bootloader or change the boot order, use xref:configuration.adoc#raspi-config[raspi-config]. diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index 8dbe1aef8e..ce6fcceaf5 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -47,7 +47,7 @@ Default: `115200` If `1` then `sudo halt` will run in a lower power mode until either GPIO3 or GLOBAL_EN are shorted to ground. -This setting is not relevant on Raspberry Pi 5, Compute Module 5, or Raspberry Pi 500 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wake from `HALT` or `STANDBY`. +This setting is not relevant on Flagship models since 5, Compute Modules since 5, and Keyboard models since 500 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wake from `HALT` or `STANDBY`. Default: `1` @@ -60,7 +60,7 @@ Raspberry Pi 400 has a dedicated power button which operates even if the process On Raspberry Pi 5 this places the PMIC in `STANDBY` mode where all outputs are switched off. There is no need to set `WAKE_ON_GPIO` and pressing the xref:raspberry-pi.adoc#power-button[dedicated power button] will boot the device. -Default: `1` on Compute Modules since Compute Module 5 and Keyboard models since Raspberry Pi 500; otherwise `0` +Default: `1` on Compute Modules since 5 and Keyboard models since 400; otherwise `0` [[BOOT_ORDER]] ==== `BOOT_ORDER` @@ -398,7 +398,7 @@ This setting is ignored and network install is disabled if `DISABLE_HDMI=1` is s In order to detect the keyboard, network install must initialise the USB controller and enumerate devices. This increases boot time by approximately 1 second so it may be advantageous to disable network install in some embedded applications. -Default: `1` on Raspberry Pi 5, Raspberry Pi 4, Raspberry Pi 500, and Raspberry Pi 400; `0` on Compute Module 4, Compute Module 4S, and Compute Module 5. +Default: `1` on Flagship models since 4 and Keyboard models since 400; `0` on Compute Modules since 4 (including Compute Module 4S). [[NET_INSTALL_AT_POWER_ON]] ==== `NET_INSTALL_AT_POWER_ON` From b19a43eda3c25041a40eae498326502c9482d9ed Mon Sep 17 00:00:00 2001 From: nate contino Date: Tue, 26 Nov 2024 17:33:16 +0000 Subject: [PATCH 20/20] Apply little birdie suggestions --- .../asciidoc/computers/raspberry-pi/boot-eeprom.adoc | 11 +++++------ .../computers/raspberry-pi/eeprom-bootloader.adoc | 6 +++--- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc index b5e9941777..cca4bf0e58 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc @@ -2,9 +2,9 @@ The following Raspberry Pi models use an EEPROM to boot the system: -* Flagship models since 4 -* Compute Module models since 4 (including Compute Module 4S) -* Keyboard models since 400 +* Flagship models since Raspberry Pi 4 +* Compute Module models since CM4 (including CM4S) +* Keyboard models since Pi 400 All other models of Raspberry Pi computer use the `bootcode.bin` file located in the boot filesystem. @@ -19,12 +19,11 @@ If an error occurs during boot, then an xref:configuration.adoc#led-warning-flas There are multiple ways to update the bootloader of your Raspberry Pi. -==== Flagship models since 4; Compute Modules since 5; Keyboard models since 400 +==== Flagship models since Raspberry Pi 4; Compute Modules since CM5; Keyboard models since Pi 400 Raspberry Pi OS automatically updates the bootloader for important bug fixes. To manually update the bootloader or change the boot order, use xref:configuration.adoc#raspi-config[raspi-config]. -NOTE: Compute Module 4 and Compute Module 4S do not support automatic bootloader updates because the bootrom cannot load the `recovery.bin` file from eMMC. -The recommended update mechanism is `rpiboot` or via `flashrom` - see `rpi-eeprom-update -h` for more information. +NOTE: Compute Module 4 and Compute Module 4S do not support automatic bootloader updates because the bootrom cannot load the `recovery.bin` file from eMMC. The recommended update mechanism is `rpiboot` or via `flashrom` - see `rpi-eeprom-update -h` for more information. [[imager]] ==== Use Raspberry Pi Imager to update the bootloader diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index ce6fcceaf5..682b43641a 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -47,7 +47,7 @@ Default: `115200` If `1` then `sudo halt` will run in a lower power mode until either GPIO3 or GLOBAL_EN are shorted to ground. -This setting is not relevant on Flagship models since 5, Compute Modules since 5, and Keyboard models since 500 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wake from `HALT` or `STANDBY`. +This setting is not relevant on Flagship models since Raspberry Pi 5, Compute Modules since CM5, and Keyboard models since Pi 500 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wake from `HALT` or `STANDBY`. Default: `1` @@ -60,7 +60,7 @@ Raspberry Pi 400 has a dedicated power button which operates even if the process On Raspberry Pi 5 this places the PMIC in `STANDBY` mode where all outputs are switched off. There is no need to set `WAKE_ON_GPIO` and pressing the xref:raspberry-pi.adoc#power-button[dedicated power button] will boot the device. -Default: `1` on Compute Modules since 5 and Keyboard models since 400; otherwise `0` +Default: `1` on Compute Modules since CM5 and Keyboard models since Pi 400; otherwise `0` [[BOOT_ORDER]] ==== `BOOT_ORDER` @@ -398,7 +398,7 @@ This setting is ignored and network install is disabled if `DISABLE_HDMI=1` is s In order to detect the keyboard, network install must initialise the USB controller and enumerate devices. This increases boot time by approximately 1 second so it may be advantageous to disable network install in some embedded applications. -Default: `1` on Flagship models since 4 and Keyboard models since 400; `0` on Compute Modules since 4 (including Compute Module 4S). +Default: `1` on Flagship models since Raspberry Pi 4 and Keyboard models since Pi 400; `0` on Compute Modules since CM4 (including CM4S). [[NET_INSTALL_AT_POWER_ON]] ==== `NET_INSTALL_AT_POWER_ON`