Skip to content

Minor copy-edits #2675

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 28, 2022
Merged

Minor copy-edits #2675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions documentation/asciidoc/computers/config_txt/video.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1691,25 +1691,25 @@ Use `framebuffer_depth` to specify the console framebuffer depth in bits per pix
| framebuffer_depth | result | notes

| 8
| 8bit framebuffer
| 8-bit framebuffer
| Default RGB palette makes screen unreadable

| 16
| 16bit framebuffer
| 16-bit framebuffer
|

| 24
| 24bit framebuffer
| 24-bit framebuffer
| May result in a corrupted display

| 32
| 32bit framebuffer
| 32-bit framebuffer
| May need to be used in conjunction with `framebuffer_ignore_alpha=1`
|===

==== `framebuffer_ignore_alpha`

Set `framebuffer_ignore_alpha` to `1` to disable the alpha channel. Can help with the display of a 32bit `framebuffer_depth`.
Set `framebuffer_ignore_alpha` to `1` to disable the alpha channel. Can help with the display of a 32-bit `framebuffer_depth`.

==== `framebuffer_priority`

Expand Down
2 changes: 1 addition & 1 deletion documentation/asciidoc/computers/configuration/boot_folder.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The boot folder will contain various xref:linux_kernel.adoc#kernel[kernel] image
| kernel8.img
| BCM2837, BCM2711
| Pi Zero 2 W, Pi 2, Pi 3, Pi 4, Pi 400
| Beta xref:config_txt.adoc#boot-options[64 bit kernel]. Raspberry Pi 2 with BCM2836 does not support 64-bit.
| xref:config_txt.adoc#boot-options[64-bit kernel]. Raspberry Pi 2 with BCM2836 does not support 64-bit kernels.
|===

NOTE: The architecture reported by `lscpu` is `armv7l` for systems running a 32-bit kernel (i.e. everything except `kernel8.img`), and `aarch64` for systems running a 64-bit kernel. The `l` in the `armv7l` case refers to the architecture being little-endian, not `LPAE` as is indicated by the `l` in the `kernel7l.img` filename.
Expand Down
4 changes: 2 additions & 2 deletions documentation/asciidoc/computers/configuration/device-tree.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ The UTC build time for the EEPROM bootloader.

`capabilities` - 32-bit integer

This bit field, which describes the features supported by the current bootloader. This may be used to check whether a feature (e.g. USB boot) is supported before enabling it in the bootloader EEPROM config.
This bit-field describes the features supported by the current bootloader. This may be used to check whether a feature (e.g. USB boot) is supported before enabling it in the bootloader EEPROM config.
Copy link

Choose a reason for hiding this comment

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

Might be worth adding this to the word list in the style guide.


|===
| Bit | Feature
Expand Down Expand Up @@ -878,7 +878,7 @@ The UTC update timestamp set by `rpi-eeprom-update`.

`signed_boot` - 32-bit integer

If secure-boot is enabled then this bit field will be non-zero. The individual bits indicate the current secure-boot configuration.
If secure-boot is enabled then this bit-field will be non-zero. The individual bits indicate the current secure-boot configuration.

|===
| Bit | Description
Expand Down
4 changes: 2 additions & 2 deletions documentation/asciidoc/computers/os/graphics-utilities.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Displays the enabled and detected state of the Raspberry Pi camera: `1` means ye

==== get_throttled

Returns the throttled state of the system. This is a bit pattern - a bit being set indicates the following meanings:
Returns the throttled state of the system. This is a bit-pattern - a bit being set indicates the following meanings:

[cols="^,,"]
|===
Expand Down Expand Up @@ -211,7 +211,7 @@ Displays the current voltages used by the specific block.

==== otp_dump

Displays the content of the OTP (one-time programmable) memory inside the SoC. These are 32 bit values, indexed from 8 to 64. See the xref:raspberry-pi.adoc#otp-register-and-bit-definitions[OTP bits page] for more details.
Displays the content of the OTP (one-time programmable) memory inside the SoC. These are 32-bit values, indexed from 8 to 64. See the xref:raspberry-pi.adoc#otp-register-and-bit-definitions[OTP bits page] for more details.

[[getconfig]]
==== get_config [configuration item|int|str]
Expand Down
2 changes: 1 addition & 1 deletion documentation/asciidoc/computers/raspberry-pi/otp-bits.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This is available via device-tree in `/proc/device-tree/chosen/rpi-boardrev-ext`
46 -- WVC1 decode key +
47-54 -- SHA256 of RSA public key for secure-boot +
55 -- secure-boot flags (reserved for use by the bootloader) +
56-63 -- 256bit device specific private key +
56-63 -- 256-bit device-specific private key +
64-65 -- MAC address; if set, system will use this in preference to the automatically generated address based on the serial number +
66 -- advanced boot register (not BCM2711)

Expand Down
4 changes: 2 additions & 2 deletions documentation/asciidoc/computers/raspberry-pi/raspberry-pi-industrial.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ which will return something like:
0x00000020 0x80000000 0x00010004 0x00000008 0x800000008 0xnnnnnnnn 0x00000000 0x00000000
----

The above uses the https://github.com/raspberrypi/firmware/wiki/Mailbox-property-interface[mailbox property interface] `GET_BOARD_SERIAL` with a request size of 8 bytes and response size of 8 bytes (sending two integers for the request 0, 0). The response to this will be two integers (0x00000020 and 0x80000000) followed by the tag code, the request length, the response length (with the 31st bit set to indicate that it is a response) then the 64 bit serial number (where the MS 32bits are always 0).
The above uses the https://github.com/raspberrypi/firmware/wiki/Mailbox-property-interface[mailbox property interface] `GET_BOARD_SERIAL` with a request size of 8 bytes and response size of 8 bytes (sending two integers for the request 0, 0). The response to this will be two integers (0x00000020 and 0x80000000) followed by the tag code, the request length, the response length (with the 31st bit set to indicate that it is a response) then the 64-bit serial number (where the MS 32 bits are always 0).

=== Write and Read Customer OTP Values

Expand Down Expand Up @@ -98,7 +98,7 @@ vcmailbox 0x00038021 8 8 0xffffffff 0xaffebabe
This operation is unlikely to be useful for the vast majority of users, and is irreversible.

=== Device specific private key
Eight rows of OTP (256bits) are available for use as a device-specific private key. This is intended to support file-system encryption.
Eight rows of OTP (256 bits) are available for use as a device-specific private key. This is intended to support file-system encryption.

These rows can be programmed and read using similar `vcmailbox` commands to those used for managing customer OTP rows. If
secure-boot / file-system encryption is not required then the device private key rows can be used to store general purpose information.
Expand Down