diff --git a/documentation/asciidoc/computers/compute-module/datasheet.adoc b/documentation/asciidoc/computers/compute-module/datasheet.adoc index 11d52ccb8..3f7ffbd75 100644 --- a/documentation/asciidoc/computers/compute-module/datasheet.adoc +++ b/documentation/asciidoc/computers/compute-module/datasheet.adoc @@ -20,7 +20,7 @@ To learn more about Compute Module 4 (CM4) and its corresponding IO Board, see t * https://datasheets.raspberrypi.com/cm4/cm4-datasheet.pdf[CM4 datasheet] -[.whitepaper, title="Configure the Compute Module 4", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003470-WP/Configuring-the-Compute-Module-4.pdf] +[.whitepaper, title="Configure the Compute Module 4", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003470-WP-Configuring-the-Compute-Module-4.pdf] **** The Compute Module 4 is available in a number of different hardware configurations. Some use cases disable certain features that aren't required. @@ -57,7 +57,7 @@ Raspberry Pi Compute Module 1 (CM1) and Compute Module 3 (CM3) are supported pro * https://datasheets.raspberrypi.com/cm/cm1-schematics.pdf[Schematics for CM1] * https://datasheets.raspberrypi.com/cm/cm3-schematics.pdf[Schematics for CM3] -[.whitepaper, title="Transition from Compute Module 1 or Compute Module 3 to Compute Module 4", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003469-WP/Transitioning-from-CM3-to-CM4.pdf] +[.whitepaper, title="Transition from Compute Module 1 or Compute Module 3 to Compute Module 4", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003469-WP-Transitioning-from-CM3-to-CM4.pdf] **** This white paper helps developers migrate from Compute Module 1 or Compute Module 3 to Compute Module 4. **** diff --git a/documentation/asciidoc/computers/config_txt/boot.adoc b/documentation/asciidoc/computers/config_txt/boot.adoc index 2eddd43c6..acdd553f1 100644 --- a/documentation/asciidoc/computers/config_txt/boot.adoc +++ b/documentation/asciidoc/computers/config_txt/boot.adoc @@ -54,6 +54,12 @@ The following Raspberry Pi models support this flag: Flagship models since Raspberry Pi 5, Compute Modules since CM5, and Keyboard models since Pi 500 _only_ support the 64-bit kernel. Models that only support a 64-bit kernel ignore this flag. +=== `armstub` + +`armstub` is the filename on the boot partition from which to load the Arm stub. The default Arm stub is stored in firmware and is selected automatically based on the Raspberry Pi model and various settings. + +The stub is a small piece of Arm code that is run before the kernel. Its job is to set up low-level hardware like the interrupt controller before passing control to the kernel. + === `ramfsfile` `ramfsfile` is the optional filename on the boot partition of a `ramfs` to load. @@ -173,6 +179,11 @@ By default, the PCIe x4 controller used by `RP1` is reset before starting the op Default: `1` +[[sha256]] +==== `sha256` + +If set to non-zero, enables the logging of SHA256 hashes for loaded files (the kernel, initramfs, Device Tree .dtb file, and overlays), as generated by the `sha256sum` utility. The logging output goes to the UART if enabled, and is also accessible via `sudo vclog --msg`. This option may be useful when debugging boot problems, but at the cost of potentially adding _many_ seconds to the boot time. Defaults to 0 on all platforms. + [[uart_2ndstage]] ==== `uart_2ndstage` @@ -287,9 +298,9 @@ Default: `1` === Secure Boot configuration properties -[.whitepaper, title="How to use Raspberry Pi Secure Boot", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003466-WP/Boot-Security-Howto.pdf] +[.whitepaper, title="How to use Raspberry Pi Secure Boot", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003466-WP-Boot-Security-Howto.pdf] **** -This whitepaper describes how to implement secure boot on devices based on Raspberry Pi 4. For an overview of our approach to implementing secure boot implementation, please see the https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-004651-WP/Raspberry-Pi-4-Boot-Security.pdf[Raspberry Pi 4 Boot Security] whitepaper. The secure boot system is intended for use with `buildroot`-based OS images; using it with Raspberry Pi OS is not recommended or supported. +This whitepaper describes how to implement secure boot on devices based on Raspberry Pi 4. For an overview of our approach to implementing secure boot implementation, please see the https://pip.raspberrypi.com/documents/RP-004651-WP-Raspberry-Pi-4-Boot-Security.pdf[Raspberry Pi 4 Boot Security] whitepaper. The secure boot system is intended for use with `buildroot`-based OS images; using it with Raspberry Pi OS is not recommended or supported. **** The following `config.txt` properties are used to program the `secure-boot` OTP settings. These changes are irreversible and can only be programmed via `RPIBOOT` when flashing the bootloader EEPROM image. This ensures that `secure-boot` cannot be set remotely or by accidentally inserting a stale SD card image. diff --git a/documentation/asciidoc/computers/config_txt/gpio.adoc b/documentation/asciidoc/computers/config_txt/gpio.adoc index 2508cbd06..39d9c64bd 100644 --- a/documentation/asciidoc/computers/config_txt/gpio.adoc +++ b/documentation/asciidoc/computers/config_txt/gpio.adoc @@ -40,3 +40,30 @@ GPIO changes made through this mechanism do not have any direct effect on the ke Note also that there is a delay of a few seconds between power being applied and the changes taking effect - longer if booting over the network or from a USB mass storage device. +=== `enable_jtag_gpio` + +Setting `enable_jtag_gpio=1` selects Alt4 mode for GPIO pins 22-27, and sets up some internal SoC connections, enabling the JTAG interface for the Arm CPU. It works on all models of Raspberry Pi. + +|=== +| Pin # | Function + +| GPIO22 +| `ARM_TRST` + +| GPIO23 +| `ARM_RTCK` + +| GPIO24 +| `ARM_TDO` + +| GPIO25 +| `ARM_TCK` + +| GPIO26 +| `ARM_TDI` + +| GPIO27 +| `ARM_TMS` +|=== + + diff --git a/documentation/asciidoc/computers/config_txt/overclocking.adoc b/documentation/asciidoc/computers/config_txt/overclocking.adoc index df0e58f5b..40768eee4 100644 --- a/documentation/asciidoc/computers/config_txt/overclocking.adoc +++ b/documentation/asciidoc/computers/config_txt/overclocking.adoc @@ -352,7 +352,7 @@ The GPU core, CPU, SDRAM and GPU each have their own PLLs and can have unrelated To view the Raspberry Pi's current frequency in KHz, type: `cat /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq`. Divide the result by 1000 to find the value in MHz. Note that this frequency is the kernel _requested_ frequency, and it is possible that any throttling (for example at high temperatures) may mean the CPU is actually running more slowly than reported. An instantaneous measurement of the actual ARM CPU frequency can be retrieved using the vcgencmd `vcgencmd measure_clock arm`. This is displayed in Hertz. === Monitoring core temperature -[.whitepaper, title="Cooling a Raspberry Pi device", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003608-WP/Cooling-a-Raspberry-Pi-device.pdf] +[.whitepaper, title="Cooling a Raspberry Pi device", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003608-WP-Cooling-a-Raspberry-Pi-device.pdf] **** This white paper goes through the reasons why your Raspberry Pi may get hot and why you might want to cool it back down, offering options on the cooling process. **** diff --git a/documentation/asciidoc/computers/config_txt/what_is_config_txt.adoc b/documentation/asciidoc/computers/config_txt/what_is_config_txt.adoc index e8fc1bf10..9f19a2368 100644 --- a/documentation/asciidoc/computers/config_txt/what_is_config_txt.adoc +++ b/documentation/asciidoc/computers/config_txt/what_is_config_txt.adoc @@ -14,6 +14,8 @@ Changes to `config.txt` only take effect after a reboot. You can view the curren NOTE: Not all config settings can be retrieved using `vcgencmd`. +Some legacy `config.txt` options are no longer officially supported. These are listed in xref:../computers/legacy_config_txt.adoc[Legacy config.txt options] and aren't included in this article. + === File format The `config.txt` file is read by the early-stage boot firmware, so it uses a very simple file format: **a single `property=value` statement on each line, where `value` is either an integer or a string**. Comments may be added, or existing config values may be commented out and disabled, by starting a line with the `#` character. diff --git a/documentation/asciidoc/computers/legacy_config_txt.adoc b/documentation/asciidoc/computers/legacy_config_txt.adoc index 0b020dad3..e16a75db3 100644 --- a/documentation/asciidoc/computers/legacy_config_txt.adoc +++ b/documentation/asciidoc/computers/legacy_config_txt.adoc @@ -2,8 +2,6 @@ include::legacy_config_txt/legacy.adoc[] include::legacy_config_txt/boot.adoc[] -include::legacy_config_txt/gpio.adoc[] - include::legacy_config_txt/overclocking.adoc[] include::legacy_config_txt/conditional.adoc[] diff --git a/documentation/asciidoc/computers/legacy_config_txt/boot.adoc b/documentation/asciidoc/computers/legacy_config_txt/boot.adoc index b7e735639..a570062de 100644 --- a/documentation/asciidoc/computers/legacy_config_txt/boot.adoc +++ b/documentation/asciidoc/computers/legacy_config_txt/boot.adoc @@ -29,12 +29,6 @@ WARNING: This setting is deprecated. Use `arm_64bit` instead to enable 64-bit ke Sets board-specific control bits. -=== `armstub` - -`armstub` is the filename on the boot partition from which to load the ARM stub. The default ARM stub is stored in firmware and is selected automatically based on the Raspberry Pi model and various settings. - -The stub is a small piece of ARM code that is run before the kernel. Its job is to set up low-level hardware like the interrupt controller before passing control to the kernel. - === `arm_peri_high` Set `arm_peri_high` to `1` to enable high peripheral mode on Raspberry Pi 4. It is set automatically if a suitable DTB is loaded. @@ -75,17 +69,6 @@ The `boot_delay_ms` command means wait for a given number of milliseconds in `st On the Raspberry Pi 4B, if this value is set to `0` then the interrupts will be routed to the Arm cores using the legacy interrupt controller, rather than via the GIC-400. The default value is `1`. -[[sha256]] -=== `sha256` - -If set to non-zero, enables the logging of SHA256 hashes for loaded files (the kernel, initramfs, Device Tree .dtb file, and overlays), as generated by the `sha256sum` utility. The logging output goes to the UART if enabled, and is also accessible via `sudo vclog --msg`. This option may be useful when debugging boot problems, but at the cost of potentially adding _many_ seconds to the boot time. Defaults to 0 on all platforms. - -=== `uart_2ndstage` - -Setting `uart_2ndstage=1` causes the second-stage loader (`bootcode.bin` on devices prior to the Raspberry Pi 4, or the boot code in the EEPROM for Raspberry Pi 4 devices) and the main firmware (`start*.elf`) to output diagnostic information to UART0. - -Be aware that output is likely to interfere with Bluetooth operation unless it is disabled (`dtoverlay=disable-bt`) or switched to the other UART (`dtoverlay=miniuart-bt`), and if the UART is accessed simultaneously to output from Linux, then data loss can occur leading to corrupted output. This feature should only be required when trying to diagnose an early boot loading problem. - [[upstream_kernel]] === `upstream_kernel` diff --git a/documentation/asciidoc/computers/legacy_config_txt/gpio.adoc b/documentation/asciidoc/computers/legacy_config_txt/gpio.adoc deleted file mode 100644 index b564be601..000000000 --- a/documentation/asciidoc/computers/legacy_config_txt/gpio.adoc +++ /dev/null @@ -1,28 +0,0 @@ -== Legacy GPIO control -(See also xref:config_txt.adoc#gpio-control[config.txt GPIO control].) - -=== `enable_jtag_gpio` - -Setting `enable_jtag_gpio=1` selects Alt4 mode for GPIO pins 22-27, and sets up some internal SoC connections, enabling the JTAG interface for the Arm CPU. It works on all models of Raspberry Pi. - -|=== -| Pin # | Function - -| GPIO22 -| ARM_TRST - -| GPIO23 -| ARM_RTCK - -| GPIO24 -| ARM_TDO - -| GPIO25 -| ARM_TCK - -| GPIO26 -| ARM_TDI - -| GPIO27 -| ARM_TMS -|=== diff --git a/documentation/asciidoc/computers/os/playing-audio-and-video.adoc b/documentation/asciidoc/computers/os/playing-audio-and-video.adoc index d6db63ed5..11cc62593 100644 --- a/documentation/asciidoc/computers/os/playing-audio-and-video.adoc +++ b/documentation/asciidoc/computers/os/playing-audio-and-video.adoc @@ -16,7 +16,7 @@ You can also launch VLC from the command line. For the examples below, we used a [source,console] ---- -$ wget --trust-server-names http://rptl.io/big-buck-bunny +$ wget --trust-server-names http://rpltd.co/big-buck-bunny ---- To play the clip in VLC from the command line, run the following command: @@ -62,7 +62,7 @@ For the examples below, we used a short audio clip. To download this clip from R [source,console] ---- -$ wget --trust-server-names http://rptl.io/startup-music +$ wget --trust-server-names http://rpltd.co/startup-music ---- To play the clip in VLC from the command line, run the following command: diff --git a/documentation/asciidoc/computers/os/rpi-os-introduction.adoc b/documentation/asciidoc/computers/os/rpi-os-introduction.adoc index f2ab3376e..10fb0d555 100644 --- a/documentation/asciidoc/computers/os/rpi-os-introduction.adoc +++ b/documentation/asciidoc/computers/os/rpi-os-introduction.adoc @@ -4,6 +4,17 @@ Raspberry Pi OS is a free, Debian-based operating system optimised for the Raspb Because Raspberry Pi OS is derived from Debian, it follows a staggered version of the https://wiki.debian.org/DebianReleases[Debian release cycle]. Releases happen roughly every 2 years. -The latest version of Raspberry Pi OS is based on https://www.raspberrypi.com/news/bookworm-the-new-version-of-raspberry-pi-os/[Debian Bookworm]. The previous version was based on https://www.raspberrypi.com/news/raspberry-pi-os-debian-bullseye/[Debian Bullseye]. +The latest version of Raspberry Pi OS is based on https://www.raspberrypi.com/news/trixie-the-new-version-of-raspberry-pi-os/[Debian Trixie]. The previous version was based on https://www.raspberrypi.com/news/bookworm-the-new-version-of-raspberry-pi-os/[Debian Bookworm]. -You can find images of Raspberry Pi OS at https://www.raspberrypi.com/software/operating-systems/[raspberrypi.com/software/operating-systems/] +== Get Raspberry Pi OS + +Raspberry Pi OS is available through the xref:../computers/getting-started.adoc#raspberry-pi-imager[Raspberry Pi Imager]. +You can also find images of Raspberry Pi OS at https://www.raspberrypi.com/software/operating-systems/[raspberrypi.com/software/operating-systems/]. + +We provide 64- and 32-bit versions of the OS in the following editions: + +* **Raspberry Pi OS with desktop.** This is the default version of Raspberry Pi OS shown in Raspberry Pi Imager. It includes applications such as the Chromium web browser, Firefox web browser, VLC media player, and the Thonny Python environment. +* **Raspberry Pi OS with desktop and recommended software.** This is listed as "Raspberry Pi OS Full" in Raspberry Pi Imager. It also includes the LibreOffice suite, KiCad, a programming environment for Scratch, and many other applications. +* **Raspberry Pi OS Lite.** This version doesn't include a graphical desktop experience. Use it for headless servers and similar use cases. We recommend this version for your Raspberry Pi 1, 2, and Zero computers. + +If you're already running a previous version of Raspberry Pi OS and want to instead use the latest major version, we recommend that you don't perform an in-place upgrade. Instead, start again with a new image. For more information, see <>. \ No newline at end of file diff --git a/documentation/asciidoc/computers/os/updating.adoc b/documentation/asciidoc/computers/os/updating.adoc index 6078bdde6..dfb7242f3 100644 --- a/documentation/asciidoc/computers/os/updating.adoc +++ b/documentation/asciidoc/computers/os/updating.adoc @@ -160,7 +160,7 @@ $ sudo rpi-update $ sudo reboot ---- -[.whitepaper, title="Updating Raspberry Pi firmware", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003476-WP/Updating-Pi-firmware.pdf] +[.whitepaper, title="Updating Raspberry Pi firmware", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003476-WP-Updating-Pi-firmware.pdf] **** This whitepaper documents how to update the VideoCore firmware in a Raspberry Pi OS image. **** @@ -175,14 +175,62 @@ $ sudo apt update $ sudo apt install --reinstall raspi-firmware ---- -[NOTE] -==== -If you still run Raspberry Pi OS Bullseye, you must instead reinstall `raspberrypi-kernel` using the following command: +=== Convert Raspberry Pi OS Lite into Raspberry Pi OS Desktop +You can add the packages that turn the Lite version into the Desktop version by using `apt`. + +. Install your preferred desktop windowing system. +* To install Wayland (recommended), run: ++ +[source,console] +---- +$ sudo apt install rpd-wayland-core +---- +* To install X, run: ++ +[source,console] +---- +$ sudo apt install rpd-x-core +---- +. Install the Raspberry Pi theme and Control Centre. ++ +[source,console] +---- +$ sudo apt install rpd-theme +$ sudo apt install rpd-preferences +---- +. Add the applications. ++ +[source,console] +---- +$ sudo apt install rpd-applications +$ sudo apt install rpd-utilities +$ sudo apt install rpd-developer +$ sudo apt install rpd-graphics +---- +. Add the extra features for your chosen windowing system, such as screenshot and remote desktop capabilities. +* For Wayland, run: ++ +[source,console] +---- +$ sudo apt install rpd-wayland-extras +---- +* For X, run: ++ +[source,console] +---- +$ sudo apt install rpd-x-extras +---- +. Restart your Raspberry Pi to enter the desktop environment. ++ [source,console] ---- -$ sudo apt install --reinstall libraspberrypi0 libraspberrypi-{bin,dev,doc} raspberrypi-{kernel,bootloader} +$ sudo reboot ---- -Reboot your Raspberry Pi with `sudo reboot` to put these changes into effect. -==== +You now have all the packages that comprise Raspberry Pi OS Desktop. If you want to return to the Lite version of Raspberry Pi OS, you can remove these packages. + +You can also install the recommended applications included in Raspberry Pi OS Full by going to your Raspberry Pi main menu and selecting **Preferences > Recommended Software**. + + + diff --git a/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc b/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc index a5d615ee3..7b0b3c396 100644 --- a/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc @@ -1,6 +1,6 @@ == Display Parallel Interface (DPI) -[.whitepaper, title="Using a DPI Display on the Raspberry Pi", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003471-WP/Using-a-DPI-display.pdf] +[.whitepaper, title="Using a DPI Display on the Raspberry Pi", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003471-WP-Using-a-DPI-display.pdf] **** Display Parallel Interface (DPI) displays can be connected to Raspberry Pi devices via the 40-pin general-purpose input/output (GPIO) connector as an alternative to using the dedicated Display Serial Interface (DSI) or High-Definition Multimedia Interface (HDMI) ports. **** diff --git a/documentation/asciidoc/computers/raspberry-pi/power-supplies.adoc b/documentation/asciidoc/computers/raspberry-pi/power-supplies.adoc index 424595941..68a2d011f 100644 --- a/documentation/asciidoc/computers/raspberry-pi/power-supplies.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/power-supplies.adoc @@ -140,9 +140,9 @@ The following table describes the amount of power (in amps) drawn by different R NOTE: These measurements used a standard Raspberry Pi OS image (current as of 26 Feb 2016, or June 2019 for the Raspberry Pi 4), at room temperature, with the Raspberry Pi connected to a HDMI monitor, USB keyboard, and USB mouse. The Raspberry Pi 3 Model B was connected to a wireless LAN access point, the Raspberry Pi 4 was connected to Ethernet. All these power measurements are approximate and do not take into account power consumption from additional USB devices; power consumption can easily exceed these measurements if multiple additional USB devices or a HAT are connected to the Raspberry Pi. -[.whitepaper, title="Extra PMIC features on Raspberry Pi 4 and Compute Module 4", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-004340-WP/Extra-PMIC-features-on-Raspberry-Pi-4-and-Compute-Module-4.pdf] +[.whitepaper, title="Extra PMIC features on Raspberry Pi 4, Raspbery Pi 5 and Compute Module 4", subtitle="", link=https://pip.raspberrypi.com/documents/RP-004340-WP-Extra-PMIC-features-on-Raspberry-Pi-4-and-Compute-Module-4.pdf] **** -A number of different PMIC devices have been used on both Raspberry Pi 4 and CM4. All the PMICs provide extra functionality alongside that of voltage supply. This document describes how to access these features in software. +A number of different PMIC devices have been used on Raspberry Pi 4, Raspberry Pi 5 and CM4. All the PMICs provide extra functionality alongside that of voltage supply. This document describes how to access these features in software. **** ==== Decrease Raspberry Pi 5 wattage when turned off @@ -166,7 +166,7 @@ If you see warnings, switch to a higher quality power supply and cable. Low qual Voltages can drop for a variety of reasons. You may have plugged in too many high-demand USB devices. The power supply could be inadequate. Or the power supply cable could use wires that are too thin. -[.whitepaper, title="Making a more resilient file system", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003610-WP/Making-a-more-resilient-file-system.pdf] +[.whitepaper, title="Making a more resilient file system", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003610-WP-Making-a-more-resilient-file-system.pdf] **** Raspberry Pi devices are frequently used as data storage and monitoring devices, often in places where sudden power-downs may occur. As with any computing device, power dropouts can cause storage corruption. diff --git a/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-industrial.adoc b/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-industrial.adoc index faf0f06f0..41e63c407 100644 --- a/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-industrial.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-industrial.adoc @@ -4,7 +4,7 @@ Raspberry Pi is often used as part of another product. This documentation descri === One-time programmable settings -[.whitepaper, title="Using the one-time programmable memory on Raspberry Pi single-board computers", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003611-WP/Using-the-One-time-programmable-memory-on-Raspberry-Pi-single-board-computers.pdf] +[.whitepaper, title="Using the one-time programmable memory on Raspberry Pi single-board computers", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003611-WP-Using-the-One-time-programmable-memory-on-Raspberry-Pi-single-board-computers.pdf] **** All Raspberry Pi single-board computers (SBCs) have an inbuilt area of one-time programmable (OTP) memory, which is actually part of the main system on a chip (SoC). As its name implies, OTP memory can be written to (i.e. a binary 0 can be changed to a 1) only once. Once a bit has been changed to 1, it can never be returned to 0. One way of looking at the OTP is to consider each bit as a fuse. Programming it involves deliberately blowing the fuse — an irreversible process, as you cannot get inside the chip to replace it! diff --git a/documentation/asciidoc/computers/software-sources.adoc b/documentation/asciidoc/computers/software-sources.adoc index 53fc53793..c29a3de0f 100644 --- a/documentation/asciidoc/computers/software-sources.adoc +++ b/documentation/asciidoc/computers/software-sources.adoc @@ -153,9 +153,12 @@ A tool to provision Raspberry Pi devices at manufacture, including secure boot a https://github.com/raspberrypi/usbboot:: A tool to boot a Raspberry Pi over USB for provisioning Compute Module and Raspberry Pi devices. +https://github.com/raspberrypi/rpi-sb-provisioner:: +A tool to mass provision Raspberry Pi devices (Raspberry Pi 5, Compute Module 4, and Compute Module 5 are supported). + === Feedback -http://github.com/raspberrypi/bookworm-feedback:: +http://github.com/raspberrypi/trixie-feedback:: A repo specifically reserved for bug-reporting for the current Raspberry Pi OS release. === Raspberry Pi Pico diff --git a/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc b/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc index 80e0f9fba..89219915a 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc @@ -10,7 +10,7 @@ The Raspberry Pi Debug Probe is a USB device that provides both a UART serial po * Works with https://openocd.org/[OpenOCD] and other tools supporting CMSIS-DAP * Open source, easily upgradeable firmware -NOTE: For more information on the Raspberry Pi three-pin debug connector see the https://rptl.io/debug-spec[specification]. +NOTE: For more information on the Raspberry Pi three-pin debug connector see the https://rpltd.co/debug-spec[specification]. This makes it easy to use a Raspberry Pi Pico on platforms such as Windows, macOS, and Linux that lack a GPIO header to connect directly to the Pico's serial UART or SWD port. @@ -32,7 +32,7 @@ Orange:: TX/SC (Output from Probe) Black:: GND Yellow:: RX/SD (Input to Probe or I/O) -While the cable with three-pin JST-SH connectors is intended to be used with the https://rptl.io/debug-spec[standard three-pin connector] which newer Raspberry Pi boards use for the SWD debug port and UART connectors. +While the cable with three-pin JST-SH connectors is intended to be used with the https://rpltd.co/debug-spec[standard three-pin connector] which newer Raspberry Pi boards use for the SWD debug port and UART connectors. The Debug Probe has five LEDs, a red LED to indicate power, and four more activity indicator LEDs diff --git a/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc b/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc index 8b242e97e..12c3b197e 100644 --- a/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc +++ b/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc @@ -46,5 +46,5 @@ https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf[Raspberry Pi https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-python-sdk.pdf[Raspberry Pi Pico Python SDK]:: A MicroPython environment for RP2040 microcontrollers -The API level Doxygen documentation for the Raspberry Pi Pico C/{cpp} SDK is also available https://rptl.io/pico-doxygen[as a micro-site]. +The API level Doxygen documentation for the Raspberry Pi Pico C/{cpp} SDK is also available https://rpltd.co/pico-doxygen[as a micro-site]. diff --git a/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc b/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc index f55dc79f2..d6fd01309 100644 --- a/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc +++ b/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc @@ -54,7 +54,7 @@ Key features: ** USB 1.1 controller and PHY, with host and device support ** 8 PIO state machines -[.whitepaper, title="Power switching RP2040 for low standby current applications", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-004339-WP/Power-switching-RP2040-for-low-standby-current-applications.pdf] +[.whitepaper, title="Power switching RP2040 for low standby current applications", subtitle="", link=https://pip.raspberrypi.com/documents/RP-004339-WP-Power-switching-RP2040-for-low-standby-current-applications.pdf] **** Even in deep sleep RP2040 draws a typical current of ~180μA, and sleep current is very dependent on PVT: process (current varies from chip to chip), voltage (current varies linearly with voltage), and temperature (current varies nonlinearly with temperature). diff --git a/documentation/asciidoc/services/bookshelf.adoc b/documentation/asciidoc/services/bookshelf.adoc new file mode 100644 index 000000000..2b6d45eea --- /dev/null +++ b/documentation/asciidoc/services/bookshelf.adoc @@ -0,0 +1,3 @@ +include::bookshelf/intro.adoc[] + +include::bookshelf/subscription.adoc[] \ No newline at end of file diff --git a/documentation/asciidoc/services/bookshelf/images/bookshelf-with-padlock.png b/documentation/asciidoc/services/bookshelf/images/bookshelf-with-padlock.png new file mode 100644 index 000000000..4070f60be Binary files /dev/null and b/documentation/asciidoc/services/bookshelf/images/bookshelf-with-padlock.png differ diff --git a/documentation/asciidoc/services/bookshelf/intro.adoc b/documentation/asciidoc/services/bookshelf/intro.adoc new file mode 100644 index 000000000..9cdda30f3 --- /dev/null +++ b/documentation/asciidoc/services/bookshelf/intro.adoc @@ -0,0 +1,11 @@ +[[bookshelf]] +== Introduction + +The Bookshelf application in Raspberry Pi OS provides access to books and magazines published by Raspberry Pi Press. Since Raspberry Pi OS Trixie, this also includes contributor-only titles. + +* Free titles are indicated by the cloud icon and can be downloaded by anyone. +* Contributor-only titles are indicated by the padlock symbol unless you're signed in with a xref:../services/id.adoc[Raspberry Pi ID] that's associated with a contribution or a subscription to the print magazine. Some contributor-only titles later become available to all. + +image::images/bookshelf-with-padlock.png[width="80%"] + +Bookshelf is included in the Raspberry Pi OS Desktop and Raspberry Pi OS Full images. diff --git a/documentation/asciidoc/services/bookshelf/subscription.adoc b/documentation/asciidoc/services/bookshelf/subscription.adoc new file mode 100644 index 000000000..a6b24a021 --- /dev/null +++ b/documentation/asciidoc/services/bookshelf/subscription.adoc @@ -0,0 +1,24 @@ +[[contribute]] +== Become a contributor (Raspberry Pi OS Trixie and later) + +Contributor-only titles are available to users who are signed in to Bookshelf with a xref:../services/id.adoc[Raspberry Pi ID] that's associated with one of the following things: + +* An email address that has a https://raspberrypipress.imbmsubscriptions.com/[subscription to our print magazine] +* A https://magazine.raspberrypi.com/bookshelf/link[monthly contribution] + +To set up a monthly contribution: + +. In Bookshelf, select **Contribute...** in the bottom left to open the contributor page on the Raspberry Pi website. +. If you don't have a Raspberry Pi ID already, you can create one now. If you have an existing Raspberry Pi ID, sign in with your username and password. +. Sign up for a monthly contribution. +. Select **Sign in to Bookshelf** to open Bookshelf and store your ID that identifies you as a contributor. + +The **Contribute...** button is no longer shown and all titles can now be downloaded. + +You can sign in with your Raspberry Pi ID and access available titles from any number of devices. If you move to a new Raspberry Pi or flash your SD with a different version of Raspberry Pi OS, sign in and download your favourite titles again. + +== Download titles + +Double-click on any of the available titles to download them as a PDF and open them in the default PDF reader. + +If you stop your monthly contribution, you keep any titles that you've already downloaded. These PDF files are stored in the **Bookshelf** folder of your home directory and remain accessible through Bookshelf. \ No newline at end of file diff --git a/documentation/asciidoc/services/connect/images/browser-sign-in.png b/documentation/asciidoc/services/connect/images/browser-sign-in.png index 03c6ad37a..81bbb213a 100644 Binary files a/documentation/asciidoc/services/connect/images/browser-sign-in.png and b/documentation/asciidoc/services/connect/images/browser-sign-in.png differ diff --git a/documentation/asciidoc/services/connect/images/configure-plugin.png b/documentation/asciidoc/services/connect/images/configure-plugin.png new file mode 100644 index 000000000..81f7f12c2 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/configure-plugin.png differ diff --git a/documentation/asciidoc/services/connect/images/disable-animate-icon.png b/documentation/asciidoc/services/connect/images/disable-animate-icon.png new file mode 100644 index 000000000..b329a2b00 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/disable-animate-icon.png differ diff --git a/documentation/asciidoc/services/connect/images/disallow-remote-shell.png b/documentation/asciidoc/services/connect/images/disallow-remote-shell.png index 35fb88725..dffe0f5ec 100644 Binary files a/documentation/asciidoc/services/connect/images/disallow-remote-shell.png and b/documentation/asciidoc/services/connect/images/disallow-remote-shell.png differ diff --git a/documentation/asciidoc/services/connect/images/disallow-screen-sharing.png b/documentation/asciidoc/services/connect/images/disallow-screen-sharing.png index 52d4d17aa..5deb8a2bf 100644 Binary files a/documentation/asciidoc/services/connect/images/disallow-screen-sharing.png and b/documentation/asciidoc/services/connect/images/disallow-screen-sharing.png differ diff --git a/documentation/asciidoc/services/connect/images/hero.png b/documentation/asciidoc/services/connect/images/hero.png index 0e7be5130..b1a0b9841 100644 Binary files a/documentation/asciidoc/services/connect/images/hero.png and b/documentation/asciidoc/services/connect/images/hero.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-notification.png b/documentation/asciidoc/services/connect/images/remote-shell-notification.png index 2bb47d88f..29d22a96d 100644 Binary files a/documentation/asciidoc/services/connect/images/remote-shell-notification.png and b/documentation/asciidoc/services/connect/images/remote-shell-notification.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-notification.png b/documentation/asciidoc/services/connect/images/screen-sharing-notification.png index 439d43748..54287856f 100644 Binary files a/documentation/asciidoc/services/connect/images/screen-sharing-notification.png and b/documentation/asciidoc/services/connect/images/screen-sharing-notification.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing.png b/documentation/asciidoc/services/connect/images/screen-sharing.png index 94fc1e871..18938febd 100644 Binary files a/documentation/asciidoc/services/connect/images/screen-sharing.png and b/documentation/asciidoc/services/connect/images/screen-sharing.png differ diff --git a/documentation/asciidoc/services/connect/images/sign-in.png b/documentation/asciidoc/services/connect/images/sign-in.png index 7b66320e9..8a3991925 100644 Binary files a/documentation/asciidoc/services/connect/images/sign-in.png and b/documentation/asciidoc/services/connect/images/sign-in.png differ diff --git a/documentation/asciidoc/services/connect/images/static-icon.png b/documentation/asciidoc/services/connect/images/static-icon.png new file mode 100644 index 000000000..336eb3bc2 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/static-icon.png differ diff --git a/documentation/asciidoc/services/connect/images/turn-on-connect.png b/documentation/asciidoc/services/connect/images/turn-on-connect.png index 96c749c79..142ad9e3f 100644 Binary files a/documentation/asciidoc/services/connect/images/turn-on-connect.png and b/documentation/asciidoc/services/connect/images/turn-on-connect.png differ diff --git a/documentation/asciidoc/services/connect/use.adoc b/documentation/asciidoc/services/connect/use.adoc index 9e331d585..a954a50f2 100644 --- a/documentation/asciidoc/services/connect/use.adoc +++ b/documentation/asciidoc/services/connect/use.adoc @@ -42,13 +42,13 @@ After authenticating, assign a name to your device. Choose a name that uniquely image::images/new-device.png[width="80%"] -You can now remotely connect to your device. The Connect icon in your menu bar will turn blue to indicate that your device is now signed in to the Connect service. You should receive an email notification indicating that a new device is linked to your Connect account. +You can now remotely connect to your device. The Connect icon in your menu bar turns blue to indicate that your device is signed in to the Connect service. You should receive an email notification indicating that a new device is linked to your Connect account. image::images/sign-in-email.png[width="70%"] WARNING: If you receive an email that says a device that you do not recognise has signed into Connect, change your Raspberry Pi ID password immediately. xref:connect.adoc#manage-devices[Remove the device from Connect] to permanently disassociate it from your account. Consider xref:id.adoc#enable-two-factor-authentication[enabling two-factor authentication] to keep your account secure. -Click the Connect icon in your menu bar to open the Connect menu. This menu allows you to turn Connect on and off, sign in and out, and allow or disallow remote access methods. +Open the Connect menu by selecting the Connect icon in your menu bar. This menu allows you to turn Connect on and off, sign in and out, and allow or disallow remote access methods. TIP: Connect signs communication with your device serial number. Moving your SD card between devices will sign you out of Connect. @@ -82,7 +82,7 @@ Once connected, a green dot appears next to the **Screen sharing** badge in the image::images/screen-sharing-in-progress.png[width="80%"] -The Connect icon in the system tray turns purple and displays a closed circle when a screen sharing session is in progress. A desktop notification will appear whenever a screen sharing session starts. +The Connect icon in the system tray rotates when a screen sharing session is in progress. A desktop notification appears whenever a screen sharing session starts. image::images/screen-sharing-notification.png[width="80%"] @@ -94,7 +94,7 @@ image::images/screen-sharing-ended.png[width="80%"] ==== Disallow screen sharing -To turn off screen sharing, click the Connect icon in the menu bar and unselect **Allow Screen Sharing**. Your device remains signed into Connect, but you won't be able to create a screen sharing session from the Connect dashboard. +To turn off screen sharing, select the Connect icon in the menu bar then deselect **Allow Screen Sharing**. Your device remains signed in to Connect, but you can't create a screen sharing session from the Connect dashboard. image::images/disallow-screen-sharing.png[width="80%"] @@ -111,8 +111,8 @@ image::images/screen-sharing-disabled.png[width="80%"] To re-enable screen sharing, do one of the following: -* click the Connect icon in the menu bar and select **Allow Screen Sharing** -* run the following command: +* Select the Connect icon in the menu bar and then choose **Allow Screen Sharing** +* Run the following command: + [source,console] ---- @@ -145,7 +145,7 @@ image::images/remote-shell-in-progress.png[width="80%"] TIP: Every remote shell connection creates a brand new connection, just like SSH. To persist background commands and configuration across multiple sessions, use `screen` or `tmux`. -The Connect icon in the menu bar turns purple and displays a closed circle when a remote shell session is in progress. A desktop notification will appear whenever a remote shell session starts. +The Connect icon in the menu bar rotates when a remote shell session is in progress. A desktop notification appears whenever a remote shell session starts. image::images/remote-shell-notification.png[width="80%"] @@ -159,7 +159,7 @@ image::images/remote-shell-ended.png[width="80%"] ==== Disallow remote shell access -To turn off remote shell access, click the Connect icon in the menu bar and unselect **Allow Remote Shell Access**. Your device remains signed into Connect, but you won't be able to create a remote shell session from the Connect dashboard. +To turn off remote shell access, select the Connect icon in the menu bar and then deselect **Allow Remote Shell Access**. Your device remains signed in to Connect, but you can't create a remote shell session from the Connect dashboard. image::images/disallow-remote-shell.png[width="80%"] @@ -176,8 +176,8 @@ image::images/remote-shell-disabled.png[width="80%"] To re-enable remote shell access, do one of the following: -* click the Connect system tray icon and select **Allow Remote Shell Access** -* run the following command: +* Select the Connect system tray icon and choose **Allow Remote Shell Access** +* Run the following command: + [source,console] ---- @@ -195,6 +195,20 @@ $ loginctl enable-linger TIP: We recommend enabling user-lingering on all headless Raspberry Pi OS Lite setups to prevent your device from becoming unreachable after a remote reboot. +== Disabling the animated icon + +To disable the animated icon when a screen sharing or remote shell session are in progress, right-click the Connect icon in the menu bar and select **Configure Plugin...**. + +image::images/configure-plugin.png[width="80%"] + +Select the **Animate Icon** toggle to switch to an alternate icon. + +image::images/disable-animate-icon.png[width="80%"] + +When a screen sharing or remote shell session is in progress, the Connect icon turns blue. + +image::images/static-icon.png[width="80%"] + == Manage devices The Connect dashboard lists all of the devices linked with your Connect account and shows you the various ways you can access them. @@ -228,7 +242,7 @@ Run the following command on your device to sign out of your Raspberry Pi ID, wh $ rpi-connect signout ---- -Alternatively, click the Connect icon in the menu bar and click "Sign Out". +Alternatively, select the Connect icon in the menu bar and choose "Sign Out". TIP: To fully remove a device from your Connect account, xref:connect.adoc#manage-devices[remove it from the Connect dashboard]. diff --git a/documentation/images/Bookshelf-SMALL.png b/documentation/images/Bookshelf-SMALL.png new file mode 100644 index 000000000..b8931da99 Binary files /dev/null and b/documentation/images/Bookshelf-SMALL.png differ diff --git a/documentation/images/full-sized/Bookshelf.png b/documentation/images/full-sized/Bookshelf.png new file mode 100644 index 000000000..b7f2192cd Binary files /dev/null and b/documentation/images/full-sized/Bookshelf.png differ diff --git a/documentation/index.json b/documentation/index.json index c08809794..8be16f78c 100644 --- a/documentation/index.json +++ b/documentation/index.json @@ -29,12 +29,6 @@ "image": "full-sized/The-config-txt-file.png", "subpath": "config_txt.adoc" }, - { - "title": "Legacy `config.txt` options", - "description": "Options which may be useful for OSes other than Raspberry Pi OS", - "image": "full-sized/Legacy-config-txt.png", - "subpath": "legacy_config_txt.adoc" - }, { "title": "The Linux kernel", "description": "How to configure and build a custom kernel for your Raspberry Pi", @@ -88,6 +82,12 @@ "description": "Open source software by Raspberry Pi", "image": "full-sized/software-sources.png", "subpath": "software-sources.adoc" + }, + { + "title": "Legacy `config.txt` options", + "description": "Options which might be useful for OSes other than Raspberry Pi OS", + "image": "full-sized/Legacy-config-txt.png", + "subpath": "legacy_config_txt.adoc" } ] }, @@ -263,6 +263,12 @@ "description": "Connect to your Raspberry Pi from your browser", "image": "full-sized/Connect-BIG.png", "subpath": "connect.adoc" + }, + { + "title": "Bookshelf", + "description": "Read titles published by Raspberry Pi Press", + "image": "full-sized/Bookshelf.png", + "subpath": "bookshelf.adoc" } ] },