Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated boot partition mentions to use new path #3105

Merged
merged 1 commit into from
Sep 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions documentation/asciidoc/accessories/audio/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ image::images/gui.png[]

There are a number of third-party audio software applications available for Raspberry Pi that will support the plug-and-play feature of our audio boards. Often these are used headless. They can be controlled via a PC or Mac application, or by a web server installed on Raspberry Pi, with interaction through a webpage.

If you need to configure Raspberry Pi OS yourself, perhaps if you're running a headless system of your own and don't have the option of control via the GUI, you will need to make your Raspberry Pi audio board the primary audio device in Raspberry Pi OS, disabling the Raspberry Pi’s on-board audio device. This is done by editing the `/boot/config.txt` file. Using a Terminal session connected to your Raspberry Pi via SSH, run the following command to edit the file:
If you need to configure Raspberry Pi OS yourself, perhaps if you're running a headless system of your own and don't have the option of control via the GUI, you will need to make your Raspberry Pi audio board the primary audio device in Raspberry Pi OS, disabling the Raspberry Pi’s on-board audio device. This is done by editing the xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] file. Using a Terminal session connected to your Raspberry Pi via SSH, run the following command to edit the file:

----
$ sudo nano /boot/config.txt
$ sudo nano /boot/firmware/config.txt
----

Find the `dtparam=audio=on` line in the file and comment it out by placing a # symbol at the start of the line. Anything written after the # symbol in any given line will be disregarded by the program. Your ``/boot/config.txt`` file should now have the following entry:
Find the `dtparam=audio=on` line in the file and comment it out by placing a # symbol at the start of the line. Anything written after the # symbol in any given line will be disregarded by the program. Your `/boot/firmware/config.txt` file should now contain the following entry:

----
#dtparam=audio=on
Expand All @@ -24,7 +24,7 @@ Press CTRL+X, then Y and Enter to save, followed by a reboot of your Raspberry P
$ sudo reboot
----

Alternatively, the `/boot/config.txt` file can be edited directly onto the Raspberry Pi's microSD card, inserted into your usual computer. Using the default file manager, open the `boot` volume on the card and edit the `config.txt` file using an appropriate text editor, then save the file, eject the microSD card and reinsert it back into your Raspberry Pi.
Alternatively, the `/boot/firmware/config.txt` file can be edited directly onto the Raspberry Pi's microSD card, inserted into your usual computer. Using the default file manager, open the `/boot/firmware/` volume on the card and edit the `config.txt` file using an appropriate text editor, then save the file, eject the microSD card and reinsert it back into your Raspberry Pi.

=== Attaching the HAT

Expand Down
6 changes: 3 additions & 3 deletions documentation/asciidoc/accessories/display/display_intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To set screen orientation when in console mode, you will need to edit the kernel

[,bash]
----
sudo nano /boot/cmdline.txt
sudo nano /boot/firmware/cmdline.txt
----

To rotate by 90 degrees clockwise, add the following to the cmdline, making sure everything is on the same line, do not add any carriage returns. Possible rotation values are 0, 90, 180 and 270.
Expand All @@ -47,13 +47,13 @@ Legacy graphics mode is used by default on all Raspberry Pi models prior to the

NOTE: Legacy mode on the Raspberry Pi 4B has no 3D acceleration so it should only be used if you have a specific reason for needing it.

To flip the display, add the following line to the file `/boot/config.txt`:
To flip the display, add the following line to the xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] file:

`lcd_rotate=2`

This will vertically flip the LCD and the touch screen, compensating for the physical orientation of the display.

You can also rotate the display by adding the following to the `config.txt` file.
You can also rotate the display by adding the following to `config.txt`:

* `display_lcd_rotate=x`, where `x` can be one of the following:

Expand Down
2 changes: 1 addition & 1 deletion documentation/asciidoc/accessories/display/legacy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Using the jumper cables, connect SCL/SDA on the GPIO header to the horizontal pi

For the GPIO header pinout, see http://pinout.xyz/[this diagram].

DSI display autodetection is disabled by default on these boards. To enable detection, add the following line to `/boot/config.txt`:
DSI display autodetection is disabled by default on these boards. To enable detection, add the following line to the xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] file:

`ignore_lcd=0`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ cat /proc/cmdline | grep bcm2708_fb
[discrete]
=== My screen is upside-down!

Depending on your display stand, you might find that the LCD display defaults to being upside-down. You can fix this by rotating it with `/boot/config.txt`.
Depending on your display stand, you might find that the LCD display defaults to being upside-down. You can fix this by rotating it with the xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] file:

[,bash]
----
sudo nano /boot/config.txt
sudo nano /boot/firmware/config.txt
----

Then add:
Expand Down
4 changes: 2 additions & 2 deletions documentation/asciidoc/accessories/sense-hat/hardware.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ $ sudo cp RTIMULib.ini /etc

== Reading and writing EEPROM data

Enable I2C0 and I2C1 by adding the following line to `/boot/config.txt`:
Enable I2C0 and I2C1 by adding the following line to the xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] file:

----
dtparam=i2c_vc=on
Expand Down Expand Up @@ -131,7 +131,7 @@ Download EEPROM settings and build the `.eep` binary:
[,bash]
----
$ wget https://github.com/raspberrypi/rpi-sense/raw/master/eeprom/eeprom_settings.txt -O sense_eeprom.txt
./eepmake sense_eeprom.txt sense.eep /boot/overlays/rpi-sense-overlay.dtb
./eepmake sense_eeprom.txt sense.eep /boot/firmware/overlays/rpi-sense-overlay.dtb
----

Disable write protection:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ libcamera-hello

You should see a camera preview window for about 5 seconds.

NOTE: Raspberry Pi 3 and older devices running _Bullseye_ may not by default be using the correct display driver. Refer to the `/boot/config.txt` file and ensure that either `dtoverlay=vc4-fkms-v3d` or `dtoverlay=vc4-kms-v3d` is currently active. Please reboot if you needed to change this.
NOTE: Raspberry Pi 3 and older devices running _Bullseye_ may not by default be using the correct display driver. Refer to the xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] file and ensure that either `dtoverlay=vc4-fkms-v3d` or `dtoverlay=vc4-kms-v3d` is currently active. Please reboot if you needed to change this.

==== If you do need to alter the configuration

You may need to alter the camera configuration in your `/boot/config.txt` file if:
You may need to alter the camera configuration in your `/boot/firmware/config.txt` file if:

* You are using a 3rd party camera (the manufacturer's instructions should explain the changes you need to make).

Expand All @@ -28,7 +28,7 @@ You may need to alter the camera configuration in your `/boot/config.txt` file i
If you do need to add your own `dtoverlay`, the following are currently recognised.

|===
| Camera Module | In `/boot/config.txt`
| Camera Module | In `/boot/firmware/config.txt`

| V1 camera (OV5647)
| `dtoverlay=ov5647`
Expand Down
4 changes: 2 additions & 2 deletions documentation/asciidoc/computers/camera/libcamera_vid.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@ Using `libcamera-vid` to capture high framerate video (generally anything over 6
1. The https://en.wikipedia.org/wiki/Advanced_Video_Coding#Levels[H.264 target level] must be set to 4.2 with the `--level 4.2` argument.
2. Software colour denoise processing must be turned off with the `--denoise cdn_off` argument.
3. For rates over 100 fps, disabling the display window with the `-n` option would free up some additional CPU cycles to help avoid frame drops.
4. It is advisable to set `force_turbo=1` in `/boot/config.txt` to ensure the CPU clock does not get throttled during the video capture. See https://www.raspberrypi.com/documentation/computers/config_txt.html#force_turbo[here] for further details.
4. It is advisable to set `force_turbo=1` in xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] to ensure the CPU clock does not get throttled during the video capture. See xref:config_txt.adoc#force_turbo[the `force_turbo` documentation] for further details.
5. Adjust the ISP output resolution with `--width 1280 --height 720` or something even lower to achieve your framerate target.
6. On a Pi 4, you can overclock the GPU to improve performance by adding `gpu_freq=550` or higher in `/boot/config.txt`. See https://www.raspberrypi.com/documentation/computers/config_txt.html#overclocking[here] for further details.
6. On a Pi 4, you can overclock the GPU to improve performance by adding `gpu_freq=550` or higher in `/boot/firmware/config.txt`. See xref:config_txt.adoc#overclocking[the overclocking documentation] for further details.

An example command for 1280x720 120fps video encode would be:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Download https://datasheets.raspberrypi.com/cm/minimal-cm-dt-blob.dts[minimal-cm
Edit `minimal-cm-dt-blob.dts` and change the pin states of GPIO44 and 45 to be I2C1 with pull-ups:

----
sudo nano /boot/minimal-cm-dt-blob.dts
sudo nano /boot/firmware/minimal-cm-dt-blob.dts
----

Change lines:
Expand All @@ -201,18 +201,18 @@ NOTE: We could use this `dt-blob.dts` with no changes The Linux Device Tree will
Compile `dt-blob.bin`:

----
sudo dtc -I dts -O dtb -o /boot/dt-blob.bin /boot/minimal-cm-dt-blob.dts
sudo dtc -I dts -O dtb -o /boot/firmware/dt-blob.bin /boot/firmware/minimal-cm-dt-blob.dts
----

Grab https://datasheets.raspberrypi.com/cm/example1-overlay.dts[example1-overlay.dts] and put it in `/boot` then compile it:

----
sudo dtc -@ -I dts -O dtb -o /boot/overlays/example1.dtbo /boot/example1-overlay.dts
sudo dtc -@ -I dts -O dtb -o /boot/firmware/overlays/example1.dtbo /boot/firmware/example1-overlay.dts
----

NOTE: The '-@' in the `dtc` command line. This is necessary if you are compiling dts files with external references, as overlays tend to be.

Edit `/boot/config.txt` and add the line:
Edit xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] and add the line:

----
dtoverlay=example1
Expand All @@ -231,11 +231,11 @@ will return with the hardware clock time, and not an error.
[discrete]
=== Example 2 - Attaching an ENC28J60 SPI Ethernet Controller on BANK0

In this example we use one of the already available overlays in /boot/overlays to add an ENC28J60 SPI Ethernet controller to BANK0. The Ethernet controller is connected to SPI pins CE0, MISO, MOSI and SCLK (GPIO8-11 respectively), as well as GPIO25 for a falling edge interrupt, and of course GND and 3V3.
In this example we use one of the already available overlays in `/boot/firmware/overlays` to add an ENC28J60 SPI Ethernet controller to BANK0. The Ethernet controller is connected to SPI pins CE0, MISO, MOSI and SCLK (GPIO8-11 respectively), as well as GPIO25 for a falling edge interrupt, and of course GND and 3V3.

In this example we won't change `dt-blob.bin`, although of course you can if you wish. We should see that Linux Device Tree correctly sets up the pins.

Edit `/boot/config.txt` and add the line:
Edit `/boot/firmware/config.txt` and add the following line:

----
dtoverlay=enc28j60
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ image::images/CMIO-Cam-Adapter.jpg[Connecting the adapter board]
+
image::images/CMIO-Cam-GPIO.jpg[GPIO connection for a single camera]

. Power the Compute Module up and run `+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-cam1.bin -O /boot/dt-blob.bin+`
. Power the Compute Module up and run `+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-cam1.bin -O /boot/firmware/dt-blob.bin+`
. Finally, reboot for the dt-blob.bin file to be read.

To connect two cameras, follow the steps as for a single camera and then also:
Expand All @@ -46,7 +46,7 @@ To connect two cameras, follow the steps as for a single camera and then also:
. (CM1 and CM3 only) Connect the GPIO pins for the second camera.
image:images/CMIO-Cam-GPIO2.jpg[GPIO connection with additional camera]
. (CM4 only) Add jumpers to J6.
. Power up and run `+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-dualcam.bin -O /boot/dt-blob.bin+`
. Power up and run `+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-dualcam.bin -O /boot/firmware/dt-blob.bin+`
. Reboot for the dt-blob.bin file to be read.

NOTE: The default wiring uses GPIOs 2&3 to control the primary camera. These GPIOs can also be used for I2C, but doing so will result in a conflict, and the camera is unlikely to work.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Connecting to DISP1

. Power up the Compute Module and run:
+
`+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-disp1-only.bin -O /boot/dt-blob.bin+`
`+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-disp1-only.bin -O /boot/firmware/dt-blob.bin+`

. Reboot for the `dt-blob.bin` file to be read.

Expand All @@ -39,7 +39,7 @@ Connecting to DISP0

. Power up the Compute Module and run:
+
`+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-disp0-only.bin -O /boot/dt-blob.bin+`
`+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-disp0-only.bin -O /boot/firmware/dt-blob.bin+`

. Reboot for the `dt-blob.bin` file to be read.

Expand All @@ -63,7 +63,7 @@ image:images/CMIO-Cam-Disp-GPIO.jpg[GPIO connection for a single display and Cam

. Power up the Compute Module and run:
+
`+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-disp1-cam1.bin -O /boot/dt-blob.bin+`
`+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-disp1-cam1.bin -O /boot/firmware/dt-blob.bin+`

. Reboot for the `dt-blob.bin` file to be read.

Expand All @@ -83,7 +83,7 @@ image:images/CMIO-Cam-Disp-GPIO.jpg[GPIO connection for a single display and Cam
. (CM4 only) Add jumpers to J6.
. Power up the Compute Module and run:
+
`+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-disp1-cam2.bin -O /boot/dt-blob.bin+`
`+sudo wget https://datasheets.raspberrypi.com/cmio/dt-blob-disp1-cam2.bin -O /boot/firmware/dt-blob.bin+`

. Reboot for the `dt-blob.bin` file to be read.
+
Expand All @@ -94,9 +94,9 @@ image:images/CMIO-Cam-Disp-Example.jpg[Camera Preview on the 7 inch display]

There is no additional configuration required to enable the touchscreen. The touch interface should work out of the box once the screen is successfully detected.

If you wish to disable the touchscreen element and only use the display side, you can add the command `disable_touchscreen=1` to /boot/config.txt to do so.
If you wish to disable the touchscreen element and only use the display side, you can add the command `disable_touchscreen=1` to xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] to do so.

To make the firmware to ignore the display even if connected, then add `ignore_lcd=1` to /boot/config.txt.
To make the firmware to ignore the display even if connected, then add `ignore_lcd=1` to `/boot/firmware/config.txt`.

=== Firmware Configuration

Expand Down
4 changes: 2 additions & 2 deletions documentation/asciidoc/computers/config_txt/video.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Set to `1` to enable composite video output, or `0` to disable. On Raspberry Pi

On all models except Raspberry Pi 4, HDMI output needs to be disabled in order for composite output to be enabled. HDMI output is disabled when no HDMI display is connected / detected. Set `enable_tvout=0` to prevent composite being enabled when HDMI is disabled.

To enable composite output (on all models of Raspberry Pi) you also need to append `,composite` to the end of the `dtoverlay=vc4-kms-v3d` line in `/boot/config.txt`, e.g.
To enable composite output (on all models of Raspberry Pi) you also need to append `,composite` to the end of the `dtoverlay=vc4-kms-v3d` line in xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]:

----
dtoverlay=vc4-kms-v3d,composite
Expand All @@ -59,7 +59,7 @@ By default this will output composite NTSC video. To choose a different mode, yo
vc4.tv_norm=video_mode
----

to the single line in `/boot/cmdline.txt`, where `video_mode` is one of `NTSC`, `NTSC-J`, `NTSC-443`, `PAL`, `PAL-M`, `PAL-N`, `PAL60` or `SECAM`.
to the single line in `/boot/firmware/cmdline.txt`, where `video_mode` is one of `NTSC`, `NTSC-J`, `NTSC-443`, `PAL`, `PAL-M`, `PAL-N`, `PAL60` or `SECAM`.

=== LCD Displays and Touchscreens

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
== What is `config.txt`?

The Raspberry Pi uses a configuration file instead of the https://en.wikipedia.org/wiki/BIOS[BIOS] you would expect to find on a conventional PC. The system configuration parameters, which would traditionally be edited and stored using a BIOS, are stored instead in a text file named `config.txt`. This is read by the GPU before the ARM CPU and Linux are initialised. It must therefore be located on the first (boot) partition of your SD card, alongside `bootcode.bin` and `start.elf`. This file is normally accessible as `/boot/config.txt` from Linux, and must be edited as the `root` user. From Windows or OS X it is visible as a file in the only accessible part of the card. If you need to apply some of the config settings below, but you don't have a `config.txt` on your boot partition yet, simply create it as a new text file.
NOTE: Prior to _Bookworm_, Raspberry Pi OS stored the boot partition at `/boot/`. Since _Bookworm_, the boot partition is located at `/boot/firmware/`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd use "mounted" rather than "stored", but this probably isn't important enough to change.


The Raspberry Pi uses a configuration file instead of the https://en.wikipedia.org/wiki/BIOS[BIOS] you would expect to find on a conventional PC. The system configuration parameters, which would traditionally be edited and stored using a BIOS, are stored instead in an optional text file named `config.txt`. This is read by the GPU before the ARM CPU and Linux are initialised. It must therefore be located on the first (boot) partition of your SD card, alongside `bootcode.bin` and `start.elf`. This file is normally accessible as `/boot/firmware/config.txt` from Linux, and must be edited as the `root` user. From Windows or OS X it is visible as a file in the only accessible part of the card. If you need to apply some of the config settings below, but you don't have a `config.txt` on your boot partition yet, simply create it as a new text file.

Any changes will only take effect after you have rebooted your Raspberry Pi. After Linux has booted, you can view the current active settings using the following commands:

Expand Down
Loading
Loading