Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
99ce481
Fix debuild instructions in software-sources.adoc
lurch Jun 26, 2025
6a0fdeb
Add links to firmware and rpi-eeprom repos
ghollingworth Jun 27, 2025
4fdb301
Fix CM5IO camera instructions
obugandi Jun 28, 2025
d656605
Add caveat about rotating the non-desktop environment
lurch Aug 19, 2025
1160e1c
Fix typo and add further clarification
lurch Aug 19, 2025
e004a8c
wording tweak
lurch Aug 20, 2025
e37a729
Add info about setting keyboard layout for new user
lurch Sep 1, 2025
301f34a
Update documentation/asciidoc/computers/configuration/users.adoc
lurch Sep 2, 2025
325064a
Wording tweak
lurch Sep 2, 2025
04f2bf3
Update documentation/asciidoc/computers/software-sources.adoc
lurch Sep 2, 2025
61d355a
Add note about checking Debug Probe firmware version
lurch Sep 3, 2025
0219e9b
Clarify Debug Probe bcdDevice version
lurch Sep 4, 2025
a59f1ec
Update getting-started.adoc
copeland3300 Sep 7, 2025
3c32015
Update documentation/asciidoc/microcontrollers/debug-probe/updating-f…
lurch Sep 9, 2025
f9f2acc
More significant rejig of updating DebugProbe firmware
lurch Sep 9, 2025
776ec97
conditional: Document the bootvar0 variable
popcornmix Sep 15, 2025
04cd833
Update intro.adoc
katshann-raspberry Sep 25, 2025
6db24ba
Update documentation/asciidoc/computers/keyboard-computers/intro.adoc
katshann-raspberry Sep 25, 2025
051c07e
Merge pull request #4191 from raspberrypi/katshann-raspberry-patch-1
katshann-raspberry Sep 25, 2025
b9d8be7
Update documentation/asciidoc/computers/configuration/users.adoc
lurch Sep 25, 2025
ca34841
Merge pull request #4174 from copeland3300/patch-1
katshann-raspberry Sep 25, 2025
154b899
Merge pull request #4171 from raspberrypi/lurch-patch-5
katshann-raspberry Sep 25, 2025
a98cfaa
Merge pull request #4169 from raspberrypi/lurch-patch-3
katshann-raspberry Sep 25, 2025
586d3e5
Merge pull request #4163 from raspberrypi/lurch-patch-2
katshann-raspberry Sep 25, 2025
12a5ee7
Merge pull request #4129 from raspberrypi/lurch-patch-4
katshann-raspberry Sep 25, 2025
a2f6355
Update documentation/asciidoc/computers/software-sources.adoc
katshann-raspberry Sep 25, 2025
8482f11
Merge pull request #4131 from obugandi/develop
katshann-raspberry Sep 25, 2025
1af18ff
Update documentation/asciidoc/computers/config_txt/conditional.adoc
katshann-raspberry Sep 25, 2025
bbc6922
Update documentation/asciidoc/computers/config_txt/conditional.adoc
katshann-raspberry Sep 25, 2025
807a83e
Update documentation/asciidoc/computers/raspberry-pi/eeprom-bootloade…
katshann-raspberry Sep 25, 2025
9c62106
Update documentation/asciidoc/computers/config_txt/conditional.adoc
katshann-raspberry Sep 25, 2025
a707d34
Merge pull request #4130 from ghollingworth/develop
katshann-raspberry Sep 25, 2025
fa0fe2c
Merge pull request #4183 from popcornmix/bootvar0
katshann-raspberry Sep 25, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions documentation/asciidoc/accessories/touch-display-2/about.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ To rotate the display without a desktop, edit the `/boot/firmware/cmdline.txt` f
video=DSI-1:720x1280@60,rotate=<rotation-value>
----

This `rotate=` setting only rotates the text-mode console; any applications that write directly to DRM (such as `cvlc` or the libcamera apps) won't be rotated, and will instead need to use their own rotation options (if available).

NOTE: You can't rotate the DSI display separately from the HDMI display with `cmdline.txt`. When you use DSI and HDMI simultaneously, they share the same rotation value.

== Customise touchscreen settings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ To connect a single camera to a Compute Module, complete the following steps:
+
image::images/CMIO-Cam-Adapter.jpg[alt="Connecting the adapter board", width="60%"]

. _(CM5 only)_: Fit two jumpers on J6 per the board's written instructions.
+
image::images/cm5io-j6-cam1.png[alt="Jumpers on J6 for CAM1", width="60%"]


. _(CM1, CM3, CM3+, and CM4S only)_: Connect the following GPIO pins with jumper cables:
* `0` to `CD1_SDA`
* `1` to `CD1_SCL`
Expand Down Expand Up @@ -107,7 +112,7 @@ image::images/CMIO-Cam-Adapter.jpg[alt="Connect the adapter board", width="60%"]
+
image:images/CMIO-Cam-GPIO2.jpg[alt="GPIO connection with additional camera", width="60%"]

. _(CM4 and CM5)_: Connect the J6 GPIO pins with two vertical-orientation jumpers.
. _(CM4)_: Connect the J6 GPIO pins with two vertical-orientation jumpers.
+
image:images/j6_vertical.jpg[alt="Connect the J6 GPIO pins in vertical orientation", width="60%"]

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions documentation/asciidoc/computers/config_txt/conditional.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,26 @@ sudo vcmailbox 0x0003008c 8 8 1 0
----
The value of the `boot_arg1` variable when the OS was started can be read via xref:configuration.adoc#part4[device-tree] at `/proc/device-tree/chosen/bootloader/arg1`

==== `bootvar0`
Raspberry Pi 5 and newer devices only.

The `bootvar0` variable is a 32-bit user-defined value that is set through `rpi-eeprom-config`, and then can be used as a conditional variable in `config.txt`.

For example, setting `bootvar0` to 42 via `rpi-eeprom-config`:
[source,ini]
----
BOOTVAR0=42
----

Using `bootvar0` conditionally in `config.txt`:
[source,ini]
----
[bootvar0=42]
arm_freq=1000
----

This allows a common image (that is, with the same `config.txt` file) to support different configurations based on the persistent `rpi-eeprom-config` settings.

==== `boot_count`
Raspberry Pi 5 and newer devices only.

Expand Down
7 changes: 7 additions & 0 deletions documentation/asciidoc/computers/configuration/users.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ $ sudo su - <username>

If the above command runs successfully, permissions were successfully configured for the user.

If you've changed your keyboard layout, you might find that the newly added user is using the "wrong" keyboard layout. To fix this, sign in as the new user and run:

[source,console]
----
$ sudo raspi-config nonint update_labwc_keyboard
----

=== Delete a user

To delete a user, run the following command, replacing the `<username>` placeholder with the username you would like to delete:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ For more information, see <<advanced, Advanced software settings>>.
[[replace-m2]]
=== Replace your M.2 SSD

You can expand storage capacity by replacing the M.2 SSD in your Raspberry Pi 500+. The Raspberry Pi 500+ supports SSDs that use the M.2 M key edge connector in the form factors 2230, 2242, 2260, and 2280.
You can expand storage capacity by replacing the M.2 SSD in your Raspberry Pi 500+. You can also use this slot to install a different PCIe peripheral. The Raspberry Pi 500+ supports devices that use the M.2 M key edge connector in the form factors 2230, 2242, 2260, and 2280.

To complete this procedure, you need a cross head screwdriver, a flat head screwdriver, and the provided plastic opening tool (spudger).

Expand Down Expand Up @@ -731,4 +731,4 @@ $ rpi-keyboard-config game

The game uses your keyboard backlighting as the "screen", and the lights flash in patterns to represent the bird and pipes. Your goal is to keep the bird from hitting pipes, similar to the original Flappy Bird. Press the space bar to fly over pipes (lit-up LEDs). Your "bird" continues to drop until you press the space bar. Your score is determined by the number of pipes you've successfully passed, which is indicated by the number of purple LEDs along the top of the keyboard.

To exit the game, press *Q* on your keyboard.
To exit the game, press *Q* on your keyboard.
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,13 @@ During the "partition walk" `autoboot.txt` files are not processed to avoid cycl

Default: `0`

[[BOOTVAR0]]
==== `BOOTVAR0`

Allows setting the conditional variable `bootvar0` used by `config.txt`. See xref:config_txt.adoc#bootvar0[bootvar0].

Default: `0`

[[PSU_MAX_CURRENT]]
==== `PSU_MAX_CURRENT`

Expand Down
18 changes: 17 additions & 1 deletion documentation/asciidoc/computers/software-sources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ At Raspberry Pi we're trying to open source as much of our code as possible to m

== Finding software sources in Raspberry Pi OS

When looking for software which is distributed with Raspberry Pi OS, there are often upstream software sources that we patch to create our downstream packages (those tagged with `pass:[+rpt]`). To view the source for those packages it is usually easier to fetch through apt. To do this, you first need to edit your apt lists to include the source packages. The following files should be edited to remove the leading `pass:[#]` from each line:
When looking for software which is distributed with Raspberry Pi OS, there are often upstream software sources that we patch to create our downstream packages (those tagged with `pass:[+rpt]`). To view the source for those packages it is usually easier to fetch through apt. To do this, you first need to edit your apt lists to include the source packages. The following files should be edited to remove the leading `pass:[#]` from each `deb-src` line:

* `+/etc/apt/sources.list+`
* `+/etc/apt/sources.list.d/raspi.list+`
Expand All @@ -21,11 +21,19 @@ Now you can fetch the package source, for example:
$ apt source labwc
----

Next, you need to install a helper package:

[source,console]
----
$ sudo apt install devscripts
----

Finally you can build the package using the standard Debian building process.

[source,console]
----
$ sudo apt build-dep labwc
$ cd labwc-0.8.4
$ debuild -uc -us
----

Expand All @@ -46,6 +54,14 @@ The following is a curated list of repositories which most people are interested
https://github.com/raspberrypi/linux::
This repository contains the source code for the downstream Linux kernel supported and working on all versions of Raspberry Pi from Pi 1 to Pi 5.

https://github.com/raspberrypi/firmware::
This repository contains the closed source firmware, although the following two links are useful:
* https://github.com/raspberrypi/firmware/commits/master/[Changelog for the firmware]
* https://github.com/raspberrypi/firmware/blob/master/boot/overlays/README[Device tree overlay README]

https://github.com/raspberrypi/rpi-eeprom::
Installation scripts and binaries for the Raspberry Pi 4 and Raspberry Pi 5 bootloader EEPROMs including the https://github.com/raspberrypi/rpi-eeprom/releases[releases] and https://github.com/raspberrypi/rpi-eeprom/blob/master/releases.md[release notes].

=== Libraries and applications

https://github.com/raspberrypi/utils::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Connect the following:
** Debug Probe `TX` connected to Pico H `RX` pin
** Debug Probe `GND` connected to Pico H `GND` pin
NOTE: If you have a non-H Pico or Pico W (without a JST-SH connector) you can still connect it to a Debug Probe. Solder a male connector to the `SWCLK`, `GND`, and `SWDIO` header pins on the board. Using the alternate 3-pin JST-SH connector to 0.1-inch header (female) cable included with the Debug Probe, connect to the Debug Probe "D" port. Connect `SWCLK`, `GND`, and `SWDIO` on the Pico or Pico W to the `SC`, `GND`, and `SD` pins on the Debug Probe, respectively.
NOTE: If you have a non-H Pico or Pico W (without a JST-SH connector) you can still connect it to a Debug Probe. Solder a male connector to the `SWCLK`, `GND`, and `SWDIO` header pins on the board. Using the alternate 3-pin JST-SH connector to 0.1-inch header (female) cable included with the Debug Probe, connect to the Debug Probe "D" port. Connect `SWCLK`, `GND`, and `SWDIO` on the Pico or Pico W to the `SC` (orange wire), `GND` (black wire), and `SD` (yellow wire) pins on the Debug Probe, respectively.

image:images/wiring.png[width="70%"]

Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,21 @@

Firmware for the Debug Probe is available as a UF2 file distributed by Raspberry Pi.

The latest version of the Debug Probe firmware is version 2.2. If you're running an older version, or if you have accidentally overwritten the firmware on your Debug Probe, you can find the latest release of the firmware in https://github.com/raspberrypi/debugprobe/releases/latest[the debugprobe GitHub repository].
The latest version of the Debug Probe firmware is version 2.2.3. If you're running an older version, or if you have accidentally overwritten the firmware on your Debug Probe, you can find the latest release of the firmware in https://github.com/raspberrypi/debugprobe/releases/latest[the debugprobe GitHub repository].

Download `debugprobe.uf2` from the latest release.
To check the firmware version of your Debug Probe, run:
[source, console]
----
$ lsusb -v -d 2e8a:000c | grep bcdDevice
----
This will report `bcdDevice 2.23` for Debug Probe firmware version 2.2.3.

Pinch to remove the top of the Debug Probe enclosure.
NOTE: The `Info : CMSIS-DAP: FW Version = 2.0.0` line reported by `openocd` only refers to the CMSIS-DAP protocol level (which is different to the Debug Probe firmware version).

Push and hold the BOOTSEL button as you plug the Debug Probe into your computer to mount a volume called "RPI-RP2".
To update the firmware version of your Debug Probe:

Copy `debugprobe.uf2` onto the "RPI-RP2" volume. The volume will dismount automatically after the file finishes copying onto the device.

Your Debug Probe will reboot and now runs an updated version of the Debug Probe firmware. It is now ready for debugging.
1. Download `debugprobe.uf2` from the latest release.
1. Pinch to remove the top of the Debug Probe enclosure.
1. Push and hold the BOOTSEL button as you plug the Debug Probe into your computer, to mount a volume called "RPI-RP2".
1. Copy `debugprobe.uf2` onto the "RPI-RP2" volume. The volume will dismount automatically after the file finishes copying onto the device.
1. Your Debug Probe will reboot and now runs an updated version of the Debug Probe firmware. It is now ready for debugging.