Explode the Pi 5 documentation all over the place #3522
Conversation
aallan
added
pi5 5️⃣
| The other three pins on the Touch Display are used to connect the display to an original Raspberry Pi 1 Model A or B. Refer to our documentation on xref:display.adoc#legacy-support[legacy support] for more information. | ||
|
|
||
| NOTE: To identify an original Raspberry Pi, check the GPIO header connector. Only the original model has a 26-pin GPIO header connector; subsequent models have 40 pins. | ||
|
|
||
|
|
There was a problem hiding this comment.
Is this newline serving a purpose, or is it just some cruft that's found it's way in?
There was a problem hiding this comment.
Cruft probably. It should affect the rendered output.
| @@ -353,7 +353,7 @@ Hitting the temperature limit is not harmful to the SoC, but it will cause the C | |||
|
|
|||
| When the core temperature is between 80°C and 85°C, the ARM cores will be throttled back. If the temperature exceeds 85°C, the ARM cores and the GPU will be throttled back. | |||
|
|
|||
| For the Raspberry Pi 3 Model B+, the PCB technology has been changed to provide better heat dissipation and increased thermal mass. In addition, a soft temperature limit has been introduced, with the goal of maximising the time for which a device can "sprint" before reaching the hard limit at 85°C. When the soft limit is reached, the clock speed is reduced from 1.4GHz to 1.2GHz, and the operating voltage is reduced slightly. This reduces the rate of temperature increase: we trade a short period at 1.4GHz for a longer period at 1.2GHz. By default, the soft limit is 60°C. This can be changed via the `temp_soft_limit` setting in config.txt. | |||
| For the Raspberry Pi 3 Model B+, the PCB technology has been changed to provide better heat dissipation and increased thermal mass. In addition, a soft temperature limit has been introduced, with the goal of maximising the time for which a device can "sprint" before reaching the hard limit at 85°C. When the soft limit is reached, the clock speed is reduced from 1.4GHz to 1.2GHz, and the operating voltage is reduced slightly. This reduces the rate of temperature increase: we trade a short period at 1.4GHz for a longer period at 1.2GHz. By default, the soft limit is 60°C. This can be changed via the `temp_soft_limit` setting in `config.txt`. | |||
There was a problem hiding this comment.
I was surprised to see this in here, after the commit message referred to Pi5, but the change is certainly an improvement.
There was a problem hiding this comment.
If you look, the change here was Nate added quote marks around the config.txt file to make the filename monopaced. The text was already there. Shouldn't really have been in this PR!
There was a problem hiding this comment.
Yes - that's why I was surprised!
|
|
||
| At boot the fan is turned on, and the tachometer input is checked to see if the fan is spinning. If it is, then the `cooling_fan` device tree overlay is enabled. This overlay is in `bcm2712-rpi-5-b.dtb` by default, but with `status=disabled`. | ||
|
|
||
| The official fan is a Coolcox https://www.coolcox.com/products/pdf/CC3007.pdf[CC3007H05S] part. |
There was a problem hiding this comment.
Official fan in which configuration - case, Active Cooler, or both?
There was a problem hiding this comment.
Good point. Fixed.
| By default the PCIe connector is not enabled. To enable it, add the following line to `/boot/firmware/config.txt`: | ||
|
|
||
| [source] | ||
| ---- | ||
| dtparam=pciex1 | ||
| ---- | ||
|
|
||
| Reboot with `sudo reboot` for the configuration changes to take effect. | ||
|
|
||
| NOTE: You can also use the alias `nvme`. |
There was a problem hiding this comment.
Are we certain this is required? I've not had to do this on any recent firmware or Pi OS combo.
There was a problem hiding this comment.
@nathan-contino Can you confirm this is still necessary with the latest firmware?
There was a problem hiding this comment.
Unfortunately I don't have hardware to test this on. But if Tom says it isn't necessary for him, I believe it. I'll remove this bit.
There was a problem hiding this comment.
So I think the difference is whether we are using the PCIe as the boot disk or not. If we are booting from an NVMe drive then this isn't needed. You just need to make sure you have the boot order correct, and a recent firmware.
If you're booting from an SD Card you'll need this, so that PCIe is activated and you can use it as a drive. Alternatively, you'll need it if you're using PCIe for something that isn't NVMe.
There was a problem hiding this comment.
That's a negative, @aallan. Booting from the SDcard on a Pi5b, I'm testing 'secure' NVMe drives via our M2 HAT+, and have not needed to use this directive to format and generally punish the candidate drives.
There was a problem hiding this comment.
Ah. If you're using our hardware, then that's a HAT+. The HAT+ configures things for you. If you're not on our hardware you can't guarantee it's a HAT+. So what this section really needs is rewriting from that perspective. I think there's a NOTE block in there somewhere about this, but it needs to be cleaned up and all that put inline.
|
|
||
| When you plug your Raspberry Pi into power for the first time, it will automatically turn on and boot into the operating system without having to push the button. | ||
|
|
||
| If you run Raspberry Pi Desktop, you can initiate a clean shutdown by briefly pressing the power button. A menu will appear asking whether you want to shutdown, reboot, or logout. |
There was a problem hiding this comment.
Strictly speaking, you get a window rather than a menu. Not sure it's worth a change, though.
| Very high-current devices, or devices which can draw a surge current such as certain modems and USB hard disks, will still require an external powered USB hub. The power requirements of the Raspberry Pi increase as you make use of the various interfaces on the Raspberry Pi. The GPIO pins can draw 50mA safely (note that that means 50mA distributed across all the pins: an individual GPIO pin can only safely draw 16mA), the HDMI port uses 50mA, the Camera Module requires 250mA, and keyboards and mice can take as little as 100mA or as much as 1000mA! Check the power rating of the devices you plan to connect to the Raspberry Pi and purchase a power supply accordingly. If you're not sure, we would advise you to buy a powered USB hub. | ||
|
|
||
| This is the typical amount of power (in amps) drawn by different Raspberry Pi models during standard processes: | ||
| The following table describes the amount of power (in amps) drawn by different Raspberry Pi models during various workloads: | ||
|
|
||
| |=== | ||
| | | | Raspberry Pi 1B+ | Raspberry Pi 2B | Raspberry Pi 3B | Raspberry Pi Zero | Raspberry Pi 4B |
There was a problem hiding this comment.
Did we also characterise Raspberry Pi 5 B, or do we not intend to / intend to later?
There was a problem hiding this comment.
I don't believe that this work has been done yet? Or at least I haven't seen numbers. @nathan-contino Can you follow up with the relevant folks and find out whether we have this data?
There was a problem hiding this comment.
Who should I ping about this? Not sure who did this testing in the first place. I can do some of the testing myself for the 5, but it might be a good idea to re-run these tests with the latest Raspberry Pi OS for each device.
| === Power supply warnings | ||
|
|
||
| On all models of Raspberry Pi since the Raspberry Pi B+ (2014) except the Zero range, there is low-voltage detection circuitry that will detect if the supply voltage drops below 4.63V (±5%). This will result in an entry being added to the kernel log. | ||
|
|
||
| If you are seeing warnings, you should improve the power supply and/or cable, as low power can cause problems with corruption of SD cards, or erratic behaviour of the Raspberry Pi itself. | ||
| If you see warnings, switch to a better power supply and cable. Low power can corrupt storage or cause unpredictable behaviour within the Raspberry Pi. |
There was a problem hiding this comment.
I realise this is just the rework of the existing text - but I'm sort of uncomfortable with using 'better' and 'low' here - presumably we actually mean 'higher quality' and 'lower quality', and that comes through clearly enough, but it just reads a little too blunt.
There was a problem hiding this comment.
Agreed. I think this need... softening. @nathan-contino Can you take another pass here?
There was a problem hiding this comment.
Updated and softened.
|
Should be good to go, except for those benchmarks. |
|
|
||
| [source] | ||
| [source,perl] |
There was a problem hiding this comment.
Why is this tagged as perl?
There was a problem hiding this comment.
This syntax doesn't have a reasonable highlighting equivalent in our toolbox, so I just chose something that renders equal signs a different color so it's slightly easier to read large blocks of text with equal signs in between. Perl was a slightly arbitrary choice, but I tested bash and a couple of others and the square bracket [] syntax seems to mess up the highlighting. Perl, as we know, tolerates just about any string of characters without breaking, so I went with that 😄
| @@ -52,16 +35,29 @@ $ sudo rpi-eeprom-config --edit | |||
|
|
|||
| Replace the `BOOT_ORDER` line with the following line: | |||
|
|
|||
| [source] | |||
| [source,perl] | |||
|
YOLO! |
On the main Pi site, I found a link to this page on our Pi 5 product page (reachable with just one Pi 5 click from the home page). Ctrl+F for "Raspberry Pi 5 documentation".
But it might be a good idea to add a redirect from
https://www.raspberrypi.com/documentation/computers/raspberry-pi-5.htmltohttps://www.raspberrypi.com/documentation/computers/raspberry-pi.htmlbecause I'm sure there are other places that link here and we'd rather not introduce a lot of 404s.