Merge pull request #426 from timg236/default-2022-04-26

2022-04-27 - Promote pieeprom-2022-04-26 to the DEFAULT release

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,63 +0,0 @@
----
-name: Bug report
-about: Create a bug report for the bootloader EEPROM or rpi-eeprom-update scripts. Please use the Raspberry Pi General Discussion forum for general questions about the bootloader.
-
----
-
-This repository tracks bugs for the Raspberry Pi 4 bootloader EEPROM and Linux update scripts.
-
-* If you suspect a hardware problem then please read the [Boot Problems](https://www.raspberrypi.org/forums/viewtopic.php?p=437084) post first before contacting the reseller.
-* Support questions or should be posted on the Raspberry Pi [General Discussion](https://www.raspberrypi.org/forums/viewforum.php?f=63) forum
-
-**Mandatory information**
-* Raspberry Pi model
-* Board revision (`cat /proc/cpuinfo | grep Revision`)
-* Operating system version
-* Details of any hardware attached e.g. links to USB 
-* Photo of the HDMI diagnostics screen, UART trace.
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-
-**Expected behaviour**
-A clear and concise description of what you expected to happen.
-
-**Bootloader version and configuration**
-Please include the bootloader version and config.
-```bash
-vcgencmd bootloader_version
-vcgencmd bootloader_config
-```
-
-**SD card boot (please complete the following information):**  
- - SD card type
- - Partition information (`sudo fdisk -l`) if you are able to obtain this from another computer
-
-**USB boot (please complete the following information):**  
-Verify that the the USB device works correctly when hot-plugged under Linux and attach the output of 'lsusb -vvv'.
-
-**Network boot (please complete the following information):**  
-Network boot bug normally requires one or more of the following log types. [PiServer](https://github.com/raspberrypi/piserver) is the officially supported network boot server.
-
- - DHCP server configuration files e.g. `dnsmasq.conf`
- - Wireshark binary packet capture
- - UART logs with `uart_2ndstage=1` set in `config.txt`
-
-**NVMe boot (please complete the following information):**
-
-```bash
-sudo apt-get install nvme-cli
-sudo nvme list
-sudo nvme id-ctrl -H /dev/nvme0
-sudo nvme list-ns /dev/nvme0
-sudo nvme id-ns -H /dev/nvme0 --namespace-id=1
-```
-
-**Additional context**
-Add any other context about the problem here. 
-
-The [Bootloader configuration](https://www.raspberrypi.org/documentation/computers/raspberry-pi.html#raspberry-pi-4-bootloader-configuration) page describes how to enable UART or NETCONSOLE logs. For complex USB boot issues NETCONSOLE logs are recommended.
-

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,123 @@
+name: "Bug report"
+description: Create a report to help us fix your issue
+body:
+- type: markdown
+  attributes:
+    value: |
+      **Is this the right place for my bug report?**
+      
+      * This repository contains the Raspberry Pi 4, Pi400 and CM4 bootloader EEPROM images and installation scripts.      
+      * Please report boot issues for the earlier models at the GPU firmware repo [github.com/raspberrypi/firmware](https://github.com/raspberrypi/firmware).
+      * Please report USB issues which occur after the OS has started at the Linux repo [github.com/raspberrypi/linux/](https://github.com/raspberrypi/linux/).
+      * If you simply have a question, then [the Raspberry Pi forums](https://www.raspberrypi.org/forums) are the best place to ask it. 
+         * The ["Is your Pi not booting?"](https://forums.raspberrypi.com/viewtopic.php?f=28&t=58151) post has lots of useful advice.
+
+- type: textarea
+  id: description
+  attributes:
+    label: Describe the bug
+    description: |
+      Add a clear and concise description of what you think the bug is. 
+      
+      * Attach a photo of the bootloader [diagnostics](https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#boot-diagnostics-on-the-raspberry-pi-4).
+      * If the system is failing to boot then please check if the green activity LED is displaying an [error pattern](https://www.raspberrypi.com/documentation/computers/configuration.html#led-warning-flash-codes).
+  validations:
+    required: true
+
+- type: textarea
+  id: reproduce
+  attributes:
+    label: Steps to reproduce the behaviour
+    description: |
+      List the steps required to reproduce the issue.
+  validations:
+    required: true
+- type: dropdown
+  id: model
+  attributes:
+    label: Device (s)
+    description: On which device you are facing the bug?
+    multiple: true
+    options:
+      - Raspberry Pi 4 Mod. B
+      - Raspberry Pi 400
+      - Raspberry Pi CM4
+      - Raspberry Pi CM4 Lite
+      - Other
+  validations:
+    required: true
+    
+- type: textarea
+  id: config
+  attributes:
+    label: Bootloader configuration.
+    description: |      
+      Copy and paste the results of `vcgencmd bootloader_config` or describe the failing configuration.
+      
+      * `rpi-eeprom-update` saves a backup of the previous bootloader configuration to `/var/lib/raspberrypi/bootloader/backup` before it schedules the update.
+      * `rpi-eeprom-config pieeprom.upd` can be used to read the contents of an EEPROM image.
+  validations:
+    required: true
+
+- type: textarea
+  id: system
+  attributes:
+    label: System
+    description: |
+      Copy and paste the results of the `raspinfo` command in to this section.
+      Alternatively, copy and paste a pastebin link, or add answers to the following questions:
+      * Which OS and version (`cat /etc/rpi-issue`)?
+      * Which bootloader version (`vcgencmd bootloader_version`)?
+      * Which firmware version (`vcgencmd version`)?
+      * Which kernel version (`uname -a`)?
+  validations:
+    required: false
+    
+- type: textarea
+  id: Logs
+  attributes:
+    label: Bootloader logs
+    description: |
+       If the problem can't be diagnosed from the bootloader HDMI diagnostics screen then we'll normally need to see more detailed logs to diagnose the problem. The bootloader and GPU firmware can be configured to enable log output to the UART pins `14` and `15` on the [40-pin GPIO header](https://www.raspberrypi.com/documentation/computers/os.html#gpio-and-the-40-pin-header)
+         * To enable UART logging from the bootloader specify [BOOT_UART=1](https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#BOOT_UART) in the EEPROM config
+         * To enable UART logging from the `start.elf` GPU firmware stage add [uart_2ndstage=1](https://www.raspberrypi.com/documentation/computers/config_txt.html#uart_2ndstage) to `config.txt`.
+         * If you are familiar with using Wireshark then it's also possible to use [NETCONSOLE](https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#NETCONSOLE) write logs to UDP packets.
+       Please paste the bootloader logs here.          
+  validations:
+    required: false
+    
+- type: textarea
+  id: USB
+  attributes:
+    label: USB boot
+    description: |
+       Before using USB as the boot device it's advisble to verify that the USB device is [compatible](https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#hardware-compatibility) and works reliably from Linux. 
+       Please specify the make and model of the USB device plus any HUBs or USB/SATA adapters. Please also capture the output of the following command from Linux `lsusb -vvv` and paste the results here.
+  validations:
+    required: false    
+
+- type: textarea
+  id: NVMe
+  attributes:
+    label: NVMe boot
+    description: |
+       Before using NVMe as the boot device it's advisble to verify that the NVMe storage is working reliably when mounted from Linux. Please specify the make and model and also  capture the following information from a working system when reporting NVMe issues.
+       * `sudo apt-get install nvme-cli`
+       * `sudo nvme list`
+       * `sudo nvme id-ctrl -H /dev/nvme0`
+       * `sudo nvme list-ns /dev/nvme0`
+       * `sudo nvme id-ns -H /dev/nvme0 --namespace-id=1`   
+  validations:
+    required: false
+    
+- type: textarea
+  id: tftp
+  attributes:
+    label: Network (TFTP boot)
+    description: |      
+      Please provide the following information if possible:- 
+      * DHCP server configuration files e.g. `dnsmasq.conf`
+      * Wireshark binary packet capture      
+  validations:
+    required: false
+    

.github/ISSUE_TEMPLATE/config.yml

@@ -1,2 +1,9 @@
 blank_issues_enabled: false
 
+contact_links:
+  - name: "⛔ Question"
+    url: https://www.raspberrypi.org/forums
+    about: "Please do not use GitHub for asking questions. If you simply have a question, then the Raspberry Pi forums are the best place to ask it. Thanks in advance for helping us keep the issue tracker clean!"
+  - name: "⛔ Problems with Raspberry Pi Imager / network-install"
+    url: https://github.com/raspberrypi/rpi-imager
+    about: "If the problem with network install occurs after the Raspberry Pi Imager UI has started then please report it at https://github.com/raspberrypi/rpi-imager/issues. Otherwise, raise the bug report here."

LICENSE

@@ -64,4 +64,32 @@ License: custom
  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
- DAMAGE. 
+ DAMAGE.
+
+License: uIP
+ Copyright (c) 2006, Swedish Institute of Computer Science.
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ 1. Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+ 3. Neither the name of the Institute nor the names of its contributors
+    may be used to endorse or promote products derived from this software
+    without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
+ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ SUCH DAMAGE.

firmware/release-notes.md

@@ -1,7 +1,90 @@
 # Raspberry Pi4 bootloader EEPROM release notes
 
-USB MSD boot also requires the firmware from Raspberry Pi OS 2020-08-20 or newer.
-https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#raspberry-pi-4-bootloader-configuration
+## 2022-04-27 - Promote pieeprom-2022-04-26 to the DEFAULT release
+   * Enable Network Install in the default bootloader release.
+   * This release is signed with the secure-boot key and supports
+     the new HTTP boot-order for downloading signed boot images for
+     automated provisioning systems.
+
+## 2022-04-22 - Add pieeprom-2022-04-26 release - STABLE/BETA
+   * Release pieeprom-2022-04-22 signed with the secure-boot key so that
+     network install can be used on secure-boot devices.
+
+## 2022-04-22 - Add pieeprom-2022-04-22 release - BETA
+   * Fix netboot reboot failure on Pi 4B R1.1 if OS enables IDDQ power saving
+     https://github.com/raspberrypi/rpi-eeprom/issues/417
+   * Fix incorrect error code (configuration error) on EEPROM update failure.
+   * Enable more verbose errors for EEPROM update failures.
+
+## 2022-03-10 - Promote the 2022-03-10 beta release to LATEST/STABLE
+   * Includes new net install feature, enabled by default for Pi 4 and Pi 400
+   * New net install download screen may appear on boot if a boot location can't
+     be found or if boot is slow. Alternative press and hold shift on boot to
+     start net install.
+   * New HTTP boot order.
+   * Bootloader diagnosis screen is now 720p if supported by your monitor.
+   * Self update mode is now enabled during SD/EMMC boot.
+   * The PARTITION number can now be specified as an EEPROM property.
+   * Allow smaller MSD discovery timeouts to be specified.
+   * Some tweaks and fixes to IPV6 netboot.
+   * Increase the max ramdisk size to 128MB
+   * Increase timeout of early SD/EMMC commands to 100ms
+
+## 2022-03-10 - HTTP_PATH fix - BETA
+   * Fix the defective HTTP_PATH eeprom configuration
+
+## 2022-02-28 - More net Install changes - BETA
+   Net install changes.
+   * Net install is initiated on boot if shift is pressed.
+   * New HTTP boot order (7) and configuration parameters,
+     HTTP_HOST, HTTP_PATH, HTTP_PORT to set url
+
+   Other interesting changes.
+   * Increase the max ramdisk size to 128MB
+   * Increase timeout of early SD/EMMC commands to 100ms
+
+## 2022-02-16 - Net Install fixes - BETA
+   Net install changes.
+   * Got rid of confirmation step that required you to press <Space> to
+     initiate net install. Now just long press <Shift>
+   * Updated the screen text to make it more obvious the device is still
+     trying boot when the net install is showing.
+   * Fixed a DHCP net install bug which caused us to lose the
+     gateway address.
+   * Fixed a bug with the uIP timers which could cause net install to
+     always fail.
+   * Implemented resume and retry on download failure.
+
+   Other interesting changes.
+   * Allow smaller MSD discovery timeouts to be specified.
+   * Some tweaks and fixes to IPV6 netboot.
+
+## 2022-02-08 - Fix secure-boot boot failure - STABLE
+   * Fix boot failure regression on boards which had the OTP secure boot bits set.
+
+## 2022-02-04 - Network Install - BETA
+   * New network install feature for the bootloader. To disable network install
+     (e.g. in an industrial product) set NET_INSTALL_ENABLED=0 in the EEPROM
+     config or HDMI_DISABLE=1.
+   * Self update mode is now enabled during SD/EMMC boot. This enables
+     rpi-eeprom-update to be used on a CM4 / CM4-lite because recovery.bin
+     is not required. For industrial products we recommend disabling
+     self-update after initial setup by setting ENABLE_SELF_UPDATE=0 in
+     the EEPROM config.
+   * The PARTITION number can now be specified as an EEPROM property. This
+     might be used to boot maintenance software if a button connected to
+     a GPIO is pressed. The partition number specified via the reboot
+     command or autoboot.txt are a higher precedence than the EEPROM
+     property.
+
+## 2022-01-25 - Promote pieeprom-2022-01-25 to the DEFAULT release
+Interesting changes since the last default release
+   * Support and bug fixes for all Compute Module variants.
+   * NVMe interoperability fixes
+   * FAT/GPT fixes and file-system performance improvements.
+   * Add secure-boot support for industrial applications
+     See https://github.com/raspberrypi/usbboot/blob/master/secure-boot-recovery/README.md
+   * Added ramdisk / boot.img - for RPIBOOT and secure-boot.
 
 ## 2022-01-25 - Create new release from 2022-01-20 - LATEST/STABLE
    * Rebuild 2022-01-20 for new stable release

imager/make-imager-release

@@ -4,4 +4,4 @@ set -e
 
 script_dir=$(cd "$(dirname "$0")" && pwd)
 
-${script_dir}/make-release critical 2021-04-29 000138a1 "${script_dir}" release rpi-boot-eeprom-recovery
+${script_dir}/make-release critical 2022-01-25 000138a1 "${script_dir}" release rpi-boot-eeprom-recovery

imager/make-release

@@ -38,7 +38,7 @@ gen_release() {
       "${script_dir}/../rpi-eeprom-config" \
          --config "${config}" --out pieeprom.bin \
          "${firmware_dir}/pieeprom-${pieeprom_version}.bin" || die "Failed to create updated EEPROM config with \"${config}\""
-      sha256sum pieeprom.bin | awk '{print $1}' > pieeprom.sig
+      ${script_dir}/../rpi-eeprom-digest -i pieeprom.bin -o pieeprom.sig
       echo "Creating ${out}"
       zip "${out}" *
       cleanup