diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f2874dadc..06b83605e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,39 +10,34 @@ jobs: build: runs-on: ubuntu-latest steps: - - name: Log current branches and repositories - run: | - echo "Current ref: $GITHUB_REF" - echo "Base ref: $GITHUB_BASE_REF" - echo "Head ref: $GITHUB_HEAD_REF" - echo "Repository: $GITHUB_REPOSITORY" - echo "Head repository: ${{ github.event.pull_request.head.repo.full_name }}" - name: Only allow pull requests based on master from the develop branch of the current repository if: ${{ github.base_ref == 'master' && !(github.head_ref == 'develop' && github.event.pull_request.head.repo.full_name == github.repository) }} run: | echo "Pull requests based on master can only come from the develop branch of this repository" echo "Please check your base branch as it should be develop by default" exit 1 - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@v5 + - uses: actions/setup-python@v6 with: python-version: 3.9 - name: Install Python dependencies uses: py-actions/py-dependency-install@v4 + - name: Install Python libs + run: pip3 install -r ./requirements.txt - uses: ruby/setup-ruby@v1 with: ruby-version: 3.2 bundler-cache: true - - uses: seanmiddleditch/gha-setup-ninja@v4 + - uses: seanmiddleditch/gha-setup-ninja@v6 with: version: 1.10.2 - name: Install arm-none-eabi-gcc GNU Arm Embedded Toolchain - uses: carlosperate/arm-none-eabi-gcc-action@v1.8.1 + uses: carlosperate/arm-none-eabi-gcc-action@v1.10.1 - name: Install Doxygen run: | - wget https://www.doxygen.nl/files/doxygen-1.9.6.linux.bin.tar.gz - tar xf doxygen-1.9.6.linux.bin.tar.gz -C "$HOME" - echo "$HOME/doxygen-1.9.6/bin" >> $GITHUB_PATH + wget https://www.doxygen.nl/files/doxygen-1.10.0.linux.bin.tar.gz + tar xf doxygen-1.10.0.linux.bin.tar.gz -C "$HOME" + echo "$HOME/doxygen-1.10.0/bin" >> $GITHUB_PATH - name: Build Doxygen documentation run: make build_doxygen_adoc - name: Build documentation diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 9ffb99cfc..8614b20a0 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -13,7 +13,7 @@ jobs: pull-requests: write steps: - - uses: actions/stale@v9 + - uses: actions/stale@v10 with: repo-token: ${{ secrets.GITHUB_TOKEN }} stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.' diff --git a/.gitignore b/.gitignore index 2984493b5..3e3542a21 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,7 @@ build build-pico-sdk-docs documentation/html documentation/asciidoc/pico-sdk +venv +.venv +.env +.vscode diff --git a/.gitmodules b/.gitmodules index 60c9ade06..9f315972e 100644 --- a/.gitmodules +++ b/.gitmodules @@ -6,3 +6,8 @@ path = lib/pico-examples url = https://github.com/raspberrypi/pico-examples.git branch = master + +[submodule "doxygentoasciidoc"] + path = lib/doxygentoasciidoc + url = https://github.com/raspberrypi/doxygentoasciidoc.git + branch = main diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 794ca9beb..37fef6b8e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,37 +1,163 @@ -# Contributing to Raspberry Pi Documentation +# Contributing to the Raspberry Pi Documentation -The Raspberry Pi Documentation website is built from Asciidoc source using Asciidoctor and a Jekyll and Python toolchain. The website is automatically deployed to the raspberrypi.com site — pushed to production — using GitHub Actions when a push to the `master` branch occurs. +The Raspberry Pi Documentation website is built from Asciidoc source using: -Full instructions for building and running the documentation website locally can be found in the top-level [README.md](README.md) file. +* [Asciidoctor](https://asciidoctor.org/) +* [Jekyll](https://jekyllrb.com/) +* [jekyll-asciidoc](https://github.com/asciidoctor/jekyll-asciidoc) +* Python -## How to Contribute +The website automatically deploys to [www.raspberrypi.com/documentation](https://www.raspberrypi.com/documentation) using GitHub Actions when new commits appear in the `master` branch. -In order to contribute new or updated documentation, you must first create a GitHub account and fork the original repository to your own account. You can make changes, save them in your forked repository, then [make a pull request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) against this repository. The pull request will appear [in the repository](https://github.com/raspberrypi/documentation/pulls) where it can be assessed by the maintainers, copy-edited, and if appropriate, merged with the official repository. +## Contribute -Unless you are opening a pull request which will only make small corrections, for instance, to correct a typo, you are more likely to get traction for your changes if you [open an issue](https://github.com/raspberrypi/documentation/issues) first to discuss the proposed changes. Issues and Pull Requests older than 60 days will [automatically be marked as stale](https://github.com/actions/stale) and then closed 7 days later if there still hasn't been any further activity. +To contribute or update documentation: -**NOTE:** The default [branch](https://github.com/raspberrypi/documentation/branches) of the repository is the `develop` branch, and this should be the branch you get by default when you initially checkout the repository. You should target any pull requests against the `develop` branch, pull requests against the `master` branch will automatically fail checks and not be accepted. +1. Create a fork of this repository on your GitHub account. -**NOTE:** Issues and Pull Requests older than 60 days will [automatically be marked as stale](https://github.com/actions/stale) and then closed 7 days later if there still hasn't been any further activity. +1. Make changes in your fork. Start from the default `develop` branch. -Before starting to write your contribution to the documentation, you should take a look at the [style guide](https://github.com/raspberrypi/style-guide/blob/master/style-guide.md). +1. Read our [style guide](https://github.com/raspberrypi/style-guide/blob/master/style-guide.md) to ensure that your changes are consistent with the rest of our documentation. Since Raspberry Pi is a British company, be sure to include all of your extra `u`s and transfigure those `z`s (pronounced 'zeds') into `s`s! -**IMPORTANT**: Because the documentation makes use of the Asciidoc `include` statement, the `xref:` statements inside the documentation do not link back to the correct pages on Github, as Github does not support Asciidoc include functionality (see [#2005](https://github.com/raspberrypi/documentation/issues/2005)). However, these links work correctly when the HTML documentation is built and deployed. Please do not submit Pull Requests fixing link destinations unless you're sure that the link is broken [on the documentation site](https://www.raspberrypi.com/documentation/) itself. +1. [Open a pull request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) against this repository. -## Type of Content +1. The maintainers will assess and copy-edit the PR. This can take anywhere from a few minutes to a few days, depending on the size of your PR, the time of year, and the availability of the maintainers. -We welcome contributions from the community, ranging from correcting small typos all the way through to adding entirely new sections to the documentation. However, going forward we're going to be fairly targeted about what sorts of content we add to the documentation. We are looking to keep the repository, and the documentation, focused on Raspberry Pi-specific things, rather than having generic Linux or computing content. +1. After making any requested improvements to your PR, the maintainers will accept the PR and merge your changes into `develop`. -We are therefore deprecating the more generic documentation around using the Linux operating system, ahead of removing these sections entirely at some point in the future as part of a larger update to the documentation site. This move is happening as we feel these sort of more general topics are, ten years on from when the documentation was initially written, now much better covered elsewhere on the web. +1. When the maintainers next release the documentation by merging `develop` into `master`, your changes will go public on the production documentation site. -As such, we're not accepting PRs against these sections unless they're correcting errors. +Alternatively, [open an issue](https://github.com/raspberrypi/documentation/issues) to discuss proposed changes. -**NOTE:** We are willing to consider toolchain-related contributions, but changes to the toolchain may have knock-on effects in other places, so it is possible that apparently benign pull requests that make toolchain changes could be refused for fairly opaque reasons. +## Build -## Third-Party Services +### Install dependencies -In general, we will not accept content that is specific to an individual third-party service or product. We will also not embed, or add links, to YouTube videos showing tutorials on how to configure your Raspberry Pi. +To build the Raspberry Pi documentation locally, you'll need Ruby, Python, and the Ninja build system. -## Licensing +#### Linux + +Use `apt` to install the dependencies: + +```console +$ sudo apt install -y ruby ruby-dev python3 python3-pip make ninja-build +``` + +Then, append the following lines to your `~/.bashrc` file (or equivalent shell configuration): + +```bash +export GEM_HOME="$(ruby -e 'puts Gem.user_dir')" +export PATH="$PATH:$GEM_HOME/bin" +``` + +Close and re-launch your terminal window to use the new dependencies and configuration. + +#### macOS + +If you don't already have it, we recommend installing the [Homebrew](https://brew.sh/) package manager: + +```console +$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" +``` + +Next, use Homebrew to install Ruby: + +```console +$ brew install ruby +``` + +After installing Ruby, follow the instructions provided by Homebrew to make your new Ruby version easily accessible from the command line. + +Then, use Homebrew to install the most recent version of Python: + +```console +$ brew install python +``` + +Then, install the [Ninja build system](https://formulae.brew.sh/formula/ninja#default): + +```console +$ brew install ninja +``` + +### Set up environment + +Use the `gem` package manager to install the [Ruby bundler](https://bundler.io/), which this repository uses to manage Ruby dependencies: + +```console +$ gem install bundler +``` + +And then install the required Ruby gems: + +```console +$ bundle install +``` + +Configure a Python virtual environment for this project: + +```console +$ python -m venv .env +``` + +Activate the virtual environment: + +```console +$ source .env/bin/activate +``` + +> [!TIP] +> When you're using a virtual environment, you should see a `(.env)` prefix at the start of your terminal prompt. At any time, run the `deactivate` command to exit the virtual environment. + +In the virtual environment, install the required Python modules: + +```console +$ pip3 install -r requirements.txt +``` + +### Build HTML + +> [!IMPORTANT] +> If you configured a Python virtual environment as recommended in the previous step, **always** run `source .env/bin/activate` before building. You must activate the virtual environment to access to all of the Python dependencies installed in that virtual environment. + +To build the documentation and start a local server to preview the built site, run the following command: + +```console +$ make serve_html +``` + +You can access the virtual server at [http://127.0.0.1:4000/documentation/](http://127.0.0.1:4000/documentation/). + +> [!TIP] +> To delete and rebuild the documentation site, run `make clean`, then re-run the build command. You'll need to do this every time you add or remove an Asciidoc, image, or video file. + + +### Build the Pico C SDK Doxygen documentation + +The Raspberry Pi documentation site includes a section of generated Asciidoc that we build from the [Doxygen Pico SDK documentation](https://github.com/raspberrypi/pico-sdk). + +We use the tooling in this repository and [doxygentoasciidoc](https://github.com/raspberrypi/doxygentoasciidoc) to generate that documentation section. By default, local documentation builds don't include this section because it takes a bit longer to build (tens of seconds) than the rest of the site. + +Building the Pico C SDK Doxygen documentation requires the following additional package dependencies: + +```console +$ sudo apt install -y cmake gcc-arm-none-eabi doxygen graphviz +``` + +Then, initialise the Git submodules used in the Pico C SDK section build: + +```console +$ git submodule update --init +``` + +Run the following command to build the Pico C SDK section Asciidoc files from the Doxygen source: + +```console +$ make build_doxygen_adoc +``` + +The next time you build the documentation site, you'll see the Pico C SDK section in your local preview. + +> [!TIP] +> To delete and rebuild the generated files, run `make clean_doxygen_xml`, then re-run the build command. -The documentation is under a [Creative Commons Attribution-Sharealike](https://creativecommons.org/licenses/by-sa/4.0/) (CC BY-SA 4.0) licence. By contributing content to this repository, you are agreeing to place your contributions under this licence. diff --git a/Gemfile b/Gemfile index 7a50b47b0..bb73401e4 100644 --- a/Gemfile +++ b/Gemfile @@ -8,10 +8,10 @@ source "https://rubygems.org" # # This will help ensure the proper Jekyll version is running. # Happy Jekylling! -gem "jekyll", "~> 4.3.3" +gem "jekyll", "~> 4.4.1" # This is the default theme for new Jekyll sites. You may change this to anything you like. -gem "minima", "~> 2.0" +gem "minima", "~> 2.5" # If you want to use GitHub Pages, remove the "gem "jekyll"" above and # uncomment the line below. To upgrade, run `bundle update github-pages`. @@ -21,6 +21,8 @@ gem "minima", "~> 2.0" group :jekyll_plugins do gem "jekyll-feed", "~> 0.17" gem 'jekyll-asciidoc' + gem 'asciidoctor' + gem 'asciidoctor-tabs', ">= 1.0.0.beta.6" end # Windows does not include zoneinfo files, so bundle the tzinfo-data gem @@ -31,10 +33,10 @@ install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do end # Performance-booster for watching directories on Windows -gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform? +gem "wdm", "~> 0.2.0", :install_if => Gem.win_platform? -gem "nokogiri", "~> 1.16" +gem "nokogiri", "~> 1.18" # So we can add custom element templates gem 'slim', '~> 5.2.1' -gem 'thread_safe', '~> 0.3.5' \ No newline at end of file +gem 'thread_safe', '~> 0.3.5' diff --git a/Gemfile.lock b/Gemfile.lock index cf036ed3a..1160aec3b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,32 +1,42 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.8.6) - public_suffix (>= 2.0.2, < 6.0) - asciidoctor (2.0.20) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + asciidoctor (2.0.23) + asciidoctor-tabs (1.0.0.beta.6) + asciidoctor (>= 2.0.0, < 3.0.0) + base64 (0.2.0) + bigdecimal (3.1.9) colorator (1.1.0) - concurrent-ruby (1.2.3) + concurrent-ruby (1.3.5) + csv (3.3.2) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) eventmachine (1.2.7) - ffi (1.16.3) + ffi (1.17.1) forwardable-extended (2.6.0) - google-protobuf (3.25.1) + google-protobuf (4.29.3) + bigdecimal + rake (>= 13) http_parser.rb (0.8.0) - i18n (1.14.1) + i18n (1.14.7) concurrent-ruby (~> 1.0) - jekyll (4.3.3) + jekyll (4.4.1) addressable (~> 2.4) + base64 (~> 0.2) colorator (~> 1.0) + csv (~> 3.0) em-websocket (~> 0.5) i18n (~> 1.0) jekyll-sass-converter (>= 2.0, < 4.0) jekyll-watch (~> 2.0) + json (~> 2.6) kramdown (~> 2.3, >= 2.3.1) kramdown-parser-gfm (~> 1.0) liquid (~> 4.0) - mercenary (>= 0.3.6, < 0.5) + mercenary (~> 0.3, >= 0.3.6) pathutil (~> 0.9) rouge (>= 3.0, < 5.0) safe_yaml (~> 1.0) @@ -37,43 +47,44 @@ GEM jekyll (>= 3.0.0) jekyll-feed (0.17.0) jekyll (>= 3.7, < 5.0) - jekyll-sass-converter (3.0.0) - sass-embedded (~> 1.54) - jekyll-seo-tag (2.7.1) + jekyll-sass-converter (3.1.0) + sass-embedded (~> 1.75) + jekyll-seo-tag (2.8.0) jekyll (>= 3.8, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - kramdown (2.4.0) - rexml + json (2.9.1) + kramdown (2.5.1) + rexml (>= 3.3.9) kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) - listen (3.8.0) + listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.4.0) - mini_portile2 (2.8.5) - minima (2.5.1) + mini_portile2 (2.8.9) + minima (2.5.2) jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) - nokogiri (1.16.2) + nokogiri (1.18.10) mini_portile2 (~> 2.8.2) racc (~> 1.4) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (5.0.4) - racc (1.7.3) - rake (13.1.0) + public_suffix (6.0.1) + racc (1.8.1) + rake (13.2.1) rb-fsevent (0.11.2) - rb-inotify (0.10.1) + rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.2.6) - rouge (4.2.0) + rexml (3.4.0) + rouge (4.5.1) safe_yaml (1.0.5) - sass-embedded (1.69.6) - google-protobuf (~> 3.25) - rake (>= 13.0.0) + sass-embedded (1.83.4) + google-protobuf (~> 4.29) + rake (>= 13) slim (5.2.1) temple (~> 0.10.0) tilt (>= 2.1.0) @@ -84,26 +95,28 @@ GEM tilt (2.3.0) tzinfo (2.0.6) concurrent-ruby (~> 1.0) - tzinfo-data (1.2024.1) + tzinfo-data (1.2025.2) tzinfo (>= 1.0.0) - unicode-display_width (2.5.0) - wdm (0.1.1) - webrick (1.8.1) + unicode-display_width (2.6.0) + wdm (0.2.0) + webrick (1.9.1) PLATFORMS ruby DEPENDENCIES - jekyll (~> 4.3.3) + asciidoctor + asciidoctor-tabs (>= 1.0.0.beta.6) + jekyll (~> 4.4.1) jekyll-asciidoc jekyll-feed (~> 0.17) - minima (~> 2.0) - nokogiri (~> 1.16) + minima (~> 2.5) + nokogiri (~> 1.18) slim (~> 5.2.1) thread_safe (~> 0.3.5) tzinfo (~> 2.0) tzinfo-data - wdm (~> 0.1.0) + wdm (~> 0.2.0) BUNDLED WITH 2.3.22 diff --git a/LICENSE.md b/LICENSE.md index 3cb65d491..4b2db9cd3 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -4,7 +4,7 @@ The Raspberry Pi documentation is licensed under a [Creative Commons Attribution # Creative Commons Attribution-ShareAlike 4.0 International -Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. +Creative Commons Corporation ("Creative Commons") is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an "as-is" basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. ### Using Creative Commons Public Licenses @@ -12,7 +12,7 @@ Creative Commons public licenses provide a standard set of terms and conditions * __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors). -* __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees). +* __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor's permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees). ## Creative Commons Attribution-ShareAlike 4.0 International Public License @@ -66,7 +66,7 @@ a. ___License grant.___ A. __Offer from the Licensor – Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. - B. __Additional offer from the Licensor – Adapted Material.__ Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply. + B. __Additional offer from the Licensor – Adapted Material.__ Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter's License You apply. C. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. @@ -112,7 +112,7 @@ b. ___ShareAlike.___ In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. -1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License. +1. The Adapter's License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License. 2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. @@ -170,6 +170,6 @@ c. No term or condition of this Public License will be waived and no failure to d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. -> Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” The text of the Creative Commons public licenses is dedicated to the public domain under the [CC0 Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/legalcode). Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. +> Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the "Licensor." The text of the Creative Commons public licenses is dedicated to the public domain under the [CC0 Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/legalcode). Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark "Creative Commons" or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. > > Creative Commons may be contacted at creativecommons.org. \ No newline at end of file diff --git a/Makefile b/Makefile index 2341a582c..711219f45 100644 --- a/Makefile +++ b/Makefile @@ -16,9 +16,10 @@ AUTO_NINJABUILD = $(BUILD_DIR)/autogenerated.ninja PICO_SDK_DIR = lib/pico-sdk PICO_EXAMPLES_DIR = lib/pico-examples +DOXYGEN_TO_ASCIIDOC_DIR = lib/doxygentoasciidoc ALL_SUBMODULE_CMAKELISTS = $(PICO_SDK_DIR)/CMakeLists.txt $(PICO_EXAMPLES_DIR)/CMakeLists.txt DOXYGEN_PICO_SDK_BUILD_DIR = build-pico-sdk-docs -DOXYGEN_HTML_DIR = $(DOXYGEN_PICO_SDK_BUILD_DIR)/docs/doxygen/html +DOXYGEN_XML_DIR = $(DOXYGEN_PICO_SDK_BUILD_DIR)/combined/docs/doxygen/xml # The pico-sdk here needs to match up with the "from_json" entry in index.json ASCIIDOC_DOXYGEN_DIR = $(ASCIIDOC_DIR)/pico-sdk @@ -26,7 +27,7 @@ JEKYLL_CMD = bundle exec jekyll .DEFAULT_GOAL := html -.PHONY: clean run_ninja clean_ninja html serve_html clean_html build_doxygen_html clean_doxygen_html build_doxygen_adoc clean_doxygen_adoc fetch_submodules clean_submodules clean_everything +.PHONY: clean run_ninja clean_ninja html serve_html clean_html build_doxygen_xml clean_doxygen_xml build_doxygen_adoc clean_doxygen_adoc fetch_submodules clean_submodules clean_everything $(BUILD_DIR): @mkdir -p $@ @@ -50,33 +51,43 @@ $(PICO_SDK_DIR)/CMakeLists.txt $(PICO_SDK_DIR)/docs/index.h: | $(PICO_SDK_DIR) $(PICO_EXAMPLES_DIR)/CMakeLists.txt: | $(PICO_SDK_DIR)/CMakeLists.txt $(PICO_EXAMPLES_DIR) git submodule update --init $(PICO_EXAMPLES_DIR) -fetch_submodules: $(ALL_SUBMODULE_CMAKELISTS) +# Initialise doxygentoasciidoc submodule +$(DOXYGEN_TO_ASCIIDOC_DIR)/__main__.py: + git submodule update --init $(DOXYGEN_TO_ASCIIDOC_DIR) + +fetch_submodules: $(ALL_SUBMODULE_CMAKELISTS) $(DOXYGEN_TO_ASCIIDOC_DIR)/__main__.py # Get rid of the submodules clean_submodules: git submodule deinit --all -# Create the pico-sdk Doxygen HTML files -$(DOXYGEN_HTML_DIR): | $(ALL_SUBMODULE_CMAKELISTS) $(DOXYGEN_PICO_SDK_BUILD_DIR) - cmake -S $(PICO_SDK_DIR) -B $(DOXYGEN_PICO_SDK_BUILD_DIR) -DPICO_EXAMPLES_PATH=../$(PICO_EXAMPLES_DIR) - $(MAKE) -C $(DOXYGEN_PICO_SDK_BUILD_DIR) docs - test -d "$@" +# Create the pico-sdk Doxygen XML files +$(DOXYGEN_XML_DIR) $(DOXYGEN_XML_DIR)/index.xml: | $(ALL_SUBMODULE_CMAKELISTS) $(DOXYGEN_PICO_SDK_BUILD_DIR) + cmake -S $(PICO_SDK_DIR) -B $(DOXYGEN_PICO_SDK_BUILD_DIR)/combined -D PICO_EXAMPLES_PATH=../../$(PICO_EXAMPLES_DIR) -D PICO_NO_PICOTOOL=1 -D PICO_PLATFORM=combined-docs + cmake -S $(PICO_SDK_DIR) -B $(DOXYGEN_PICO_SDK_BUILD_DIR)/PICO_RP2040 -D PICO_EXAMPLES_PATH=../../$(PICO_EXAMPLES_DIR) -D PICO_NO_PICOTOOL=1 -D PICO_PLATFORM=rp2040 + cmake -S $(PICO_SDK_DIR) -B $(DOXYGEN_PICO_SDK_BUILD_DIR)/PICO_RP2350 -D PICO_EXAMPLES_PATH=../../$(PICO_EXAMPLES_DIR) -D PICO_NO_PICOTOOL=1 -D PICO_PLATFORM=rp2350 + $(MAKE) -C $(DOXYGEN_PICO_SDK_BUILD_DIR)/combined docs + $(MAKE) -C $(DOXYGEN_PICO_SDK_BUILD_DIR)/PICO_RP2040 docs + $(MAKE) -C $(DOXYGEN_PICO_SDK_BUILD_DIR)/PICO_RP2350 docs + python3 $(SCRIPTS_DIR)/postprocess_doxygen_xml.py $(DOXYGEN_PICO_SDK_BUILD_DIR) -$(DOXYGEN_PICO_SDK_BUILD_DIR)/docs/Doxyfile: | $(DOXYGEN_HTML_DIR) +$(DOXYGEN_PICO_SDK_BUILD_DIR)/combined/docs/Doxyfile: | $(DOXYGEN_XML_DIR) -build_doxygen_html: | $(DOXYGEN_HTML_DIR) +build_doxygen_xml: | $(DOXYGEN_XML_DIR) # Clean all the Doxygen HTML files -clean_doxygen_html: +clean_doxygen_xml: rm -rf $(DOXYGEN_PICO_SDK_BUILD_DIR) -# Create the Doxygen asciidoc files -# Also need to move index.adoc to a different name, because it conflicts with the autogenerated index.adoc -$(ASCIIDOC_DOXYGEN_DIR)/picosdk_index.json $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc: $(SCRIPTS_DIR)/transform_doxygen_html.py $(PICO_SDK_DIR)/docs/index.h $(DOXYGEN_PICO_SDK_BUILD_DIR)/docs/Doxyfile | $(DOXYGEN_HTML_DIR) $(ASCIIDOC_DOXYGEN_DIR) +# create the sdk adoc and the json file +$(ASCIIDOC_DOXYGEN_DIR)/picosdk_index.json $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc: $(ASCIIDOC_DOXYGEN_DIR) $(DOXYGEN_XML_DIR)/index.xml $(DOXYGEN_TO_ASCIIDOC_DIR)/__main__.py $(DOXYGEN_TO_ASCIIDOC_DIR)/cli.py $(DOXYGEN_TO_ASCIIDOC_DIR)/nodes.py $(DOXYGEN_TO_ASCIIDOC_DIR)/helpers.py | $(BUILD_DIR) $(DOXYGEN_TO_ASCIIDOC_DIR)/requirements.txt $(MAKE) clean_ninja - $< $(DOXYGEN_HTML_DIR) $(ASCIIDOC_DOXYGEN_DIR) $(PICO_SDK_DIR)/docs/index.h $(ASCIIDOC_DOXYGEN_DIR)/picosdk_index.json - cp $(DOXYGEN_HTML_DIR)/*.png $(ASCIIDOC_DOXYGEN_DIR) - mv $(ASCIIDOC_DOXYGEN_DIR)/index.adoc $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc + pip3 install -r $(DOXYGEN_TO_ASCIIDOC_DIR)/requirements.txt + PYTHONPATH=$(DOXYGEN_TO_ASCIIDOC_DIR)/.. python3 -m doxygentoasciidoc -o $(ASCIIDOC_DOXYGEN_DIR)/all_groups.adoc $(DOXYGEN_XML_DIR)/index.xml + PYTHONPATH=$(DOXYGEN_TO_ASCIIDOC_DIR)/.. python3 -m doxygentoasciidoc -c -o $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc $(DOXYGEN_XML_DIR)/indexpage.xml + PYTHONPATH=$(DOXYGEN_TO_ASCIIDOC_DIR)/.. python3 -m doxygentoasciidoc -c -o $(ASCIIDOC_DOXYGEN_DIR)/examples_page.adoc $(DOXYGEN_XML_DIR)/examples_page.xml + python3 $(SCRIPTS_DIR)/postprocess_doxygen_adoc.py $(ASCIIDOC_DOXYGEN_DIR) + -cp $(DOXYGEN_XML_DIR)/*.png $(ASCIIDOC_DOXYGEN_DIR) 2>/dev/null || true build_doxygen_adoc: $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc @@ -85,7 +96,7 @@ clean_doxygen_adoc: if [ -d $(ASCIIDOC_DOXYGEN_DIR) ]; then $(MAKE) clean_ninja; fi rm -rf $(ASCIIDOC_DOXYGEN_DIR) -clean_everything: clean_submodules clean_doxygen_html clean +clean_everything: clean_submodules clean_doxygen_xml clean # AUTO_NINJABUILD contains all the parts of the ninjabuild where the rules themselves depend on other files $(AUTO_NINJABUILD): $(SCRIPTS_DIR)/create_auto_ninjabuild.py $(DOCUMENTATION_INDEX) $(SITE_CONFIG) | $(BUILD_DIR) @@ -107,7 +118,7 @@ html: run_ninja # Build the html output files and additionally run a small webserver for local previews serve_html: run_ninja - $(JEKYLL_CMD) serve + $(JEKYLL_CMD) serve --watch # Delete all the files created by the 'html' target clean_html: diff --git a/README.md b/README.md index 74cda7db8..69df3a28f 100644 --- a/README.md +++ b/README.md @@ -1,175 +1,22 @@ -# Welcome to the Raspberry Pi Documentation +
+ + + + Raspberry Pi: computers and microcontrollers + -This repository contains the Asciidoc source and the toolchain to build the [Raspberry Pi Documentation](https://www.raspberrypi.com/documentation/). For details of how to contribute to the documentation see the [CONTRIBUTING.md](CONTRIBUTING.md) file. +[Website][Raspberry Pi] | [Getting started] | [Documentation] | [Contribute] +
-**NOTE:** This repository has undergone some recent changes. See our [blog post](https://www.raspberrypi.com/blog/bring-on-the-documentation/) for more details. +This repository contains the source and tools used to build the [Raspberry Pi Documentation](https://www.raspberrypi.com/documentation/). -## Building the Documentation - -Instructions on how to checkout the `documentation` repo, and then install the toolchain needed to convert from Asciidoc to HTML and build the documentation site. - -### Checking out the Repository - -Install `git` if you don't already have it, and check out the `documentation` repo as follows, -``` -$ git clone https://github.com/raspberrypi/documentation.git -$ cd documentation -``` - -### Installing the Toolchain - -#### On Linux - -This works on both regular Debian or Ubuntu Linux — and has been tested in a minimal Docker container — and also under Raspberry Pi OS if you are working from a Raspberry Pi. - -You can install the necessary dependencies on Linux as follows, - -``` -$ sudo apt install -y ruby ruby-dev python3 python3-pip make ninja-build -``` - -then add these lines to the bottom of your `$HOME/.bashrc`, -``` -export GEM_HOME="$(ruby -e 'puts Gem.user_dir')" -export PATH="$PATH:$GEM_HOME/bin" -``` - -and close and relaunch your Terminal window to have these new variables activated. Finally, run -``` -$ gem install bundler -``` -to install the latest version of the Ruby `bundle` command. - -#### On macOS - -If you don't already have it, install the [Homebrew](https://brew.sh/) package manager: - -``` -$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" -``` - -Next, install Ruby: - -``` -$ brew install ruby -``` - -And install the [Ruby bundler](https://bundler.io/): - -``` -$ gem install bundler -``` - -##### Set up Homebrew Version of Ruby - -Because macOS provides its own version of Ruby, Homebrew doesn't automatically set up symlinks to access the version you just installed with the `ruby` command. But after a successful install, Homebrew outputs the commands you'll need to run to set up the symlink yourself. If you use the default macOS `zsh` shell on Apple Silicon, you can set up the symlink with the following command: - -``` -$ echo 'export PATH="/opt/homebrew/opt/ruby/bin:$PATH"' >> ~/.zshrc -``` - -If you run macOS on an Intel-based Mac, replace `opt/homebrew` with `usr/local` in the above command. - -If you run a shell other than the default, check which config file to modify for the command. For instance, `bash` uses `~/.bashrc` or `~/.bash_profile`. - -Once you've made the changes to your shell configuration, open a new terminal instance and run the following command: - -``` -$ ruby --version -``` - -You should see output similar to the following: - -``` -ruby 3.2.2 (2023-03-30 revision e51014f9c0) [arm64-darwin22] -``` - -As long as you see a Ruby version greater than or equal to 3.2.2, you've succeeded. - -##### Install Homebrew Dependencies - -Next, use Homebrew to install the other dependencies. -Start with the latest version of Python: - -``` -$ brew install python@3 -``` - -Then install the [Ninja build system](https://formulae.brew.sh/formula/ninja#default): - -``` -$ brew install ninja -``` - -Then install the [Gumbo HTML5 parser](https://formulae.brew.sh/formula/gumbo-parser#default): - -``` -$ brew install gumbo-parser -``` - -And finally, install the [YAML module for Python 3](https://formulae.brew.sh/formula/pyyaml#default): - -``` -$ pip3 install pyyaml -``` - -Now you've installed all of the dependencies you'll need from Homebrew. - -### Install Scripting Dependencies - -After installing the toolchain, install the required Ruby gems and Python modules. Make sure you're in the top-level directory of this repository (the one containing `Gemfile.lock` and `requirements.txt`), and run the following command to install the Ruby gems (this may take several minutes): - -``` -$ bundle install -``` - -Then, run the following command to install the remaining required Python modules: - -``` -$ pip3 install --user -r requirements.txt -``` - -### Building the Documentation Site - -After you've installed both the toolchain and scripting dependencies, you can build the documentation with the following command: - -``` -$ make -``` - -This automatically uses [Ninja build](https://ninja-build.org/) to convert the source files in `documentation/asciidoc/` to a suitable intermediate structure in `build/jekyll/` and then uses [Jekyll AsciiDoc](https://github.com/asciidoctor/jekyll-asciidoc) to convert the files in `build/jekyll/` to the final output HTML files in `documentation/html/`. - -You can also start a local server to view the built site: - -``` -$ make serve_html -``` - -As the local server launches, the local URL will be printed in the terminal -- open this URL in a browser to see the locally-built site. - -You can also use `make` to delete the `build/` and `documentation/html/` directories: - -``` -$ make clean -``` - -### Building with Doxygen - -If you want to build the Pico C SDK Doxygen documentation alongside the main documentation site you can do so with, - -``` -$ make build_doxygen_adoc -$ make -``` - -and clean up afterwards by using, - -``` -$ make clean_everything -``` - -which will revert the repository to a pristine state. +[Raspberry Pi]: https://www.raspberrypi.com/ +[Getting Started]: https://www.raspberrypi.com/documentation/computers/getting-started.html +[Documentation]: https://www.raspberrypi.com/documentation/ +[Contribute]: CONTRIBUTING.md ## Licence -The Raspberry Pi [documentation](./documentation/) is [licensed](https://github.com/raspberrypi/documentation/blob/develop/LICENSE.md) under a Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA). While the toolchain source code — which is everything outside of the top-level `documentation/` subdirectory — is Copyright © 2021 Raspberry Pi Ltd and licensed under the [BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause) licence. +The Raspberry Pi documentation is [licensed](https://github.com/raspberrypi/documentation/blob/develop/LICENSE.md) under a Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA). Documentation tools (everything outside of the `documentation/` subdirectory) are licensed under the [BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause) licence. diff --git a/_config.yml b/_config.yml index acfa472d3..4d740515b 100644 --- a/_config.yml +++ b/_config.yml @@ -17,14 +17,16 @@ title: Raspberry Pi Documentation description: >- # this means to ignore newlines until "baseurl:" Raspberry Pi Documentation. baseurl: "/documentation" # the subpath of your site, e.g. /blog -url: "" # the base hostname & protocol for your site, e.g. http://example.com +url: "https://www.raspberrypi.com/documentation" # the base hostname & protocol for your site, e.g. http://example.com githuburl: "https://github.com/raspberrypi/documentation/" +mainsite: https://raspberrypi.com/ githubbranch: master githubbranch_edit: develop # Build settings theme: minima plugins: + - asciidoctor-tabs - jekyll-asciidoc - jekyll-feed diff --git a/documentation/asciidoc/accessories/ai-camera.adoc b/documentation/asciidoc/accessories/ai-camera.adoc new file mode 100644 index 000000000..55d35cba5 --- /dev/null +++ b/documentation/asciidoc/accessories/ai-camera.adoc @@ -0,0 +1,7 @@ +include::ai-camera/about.adoc[] + +include::ai-camera/getting-started.adoc[] + +include::ai-camera/details.adoc[] + +include::ai-camera/model-conversion.adoc[] diff --git a/documentation/asciidoc/accessories/ai-camera/about.adoc b/documentation/asciidoc/accessories/ai-camera/about.adoc new file mode 100644 index 000000000..927fcf19a --- /dev/null +++ b/documentation/asciidoc/accessories/ai-camera/about.adoc @@ -0,0 +1,9 @@ +[[ai-camera]] +== About + +The Raspberry Pi AI Camera uses the Sony IMX500 imaging sensor to provide low-latency, high-performance AI capabilities to any camera application. Tight integration with xref:../computers/camera_software.adoc[Raspberry Pi's camera software stack] allows users to deploy their own neural network models with minimal effort. + +image::images/ai-camera.png[The Raspberry Pi AI Camera] + +This section demonstrates how to run either a pre-packaged or custom neural network model on the camera. Additionally, this section includes the steps required to interpret inference data generated by neural networks running on the IMX500 in https://github.com/raspberrypi/rpicam-apps[`rpicam-apps`] and https://github.com/raspberrypi/picamera2[Picamera2]. + diff --git a/documentation/asciidoc/accessories/ai-camera/details.adoc b/documentation/asciidoc/accessories/ai-camera/details.adoc new file mode 100644 index 000000000..e640f289c --- /dev/null +++ b/documentation/asciidoc/accessories/ai-camera/details.adoc @@ -0,0 +1,262 @@ + +== Under the hood + +=== Overview + +The Raspberry Pi AI Camera works differently from traditional AI-based camera image processing systems, as shown in the diagram below: + +image::images/imx500-comparison.svg[Traditional versus IMX500 AI camera systems] + +The left side demonstrates the architecture of a traditional AI camera system. In such a system, the camera delivers images to the Raspberry Pi. The Raspberry Pi processes the images and then performs AI inference. Traditional systems may use external AI accelerators (as shown) or rely exclusively on the CPU. + +The right side demonstrates the architecture of a system that uses IMX500. The camera module contains a small Image Signal Processor (ISP) which turns the raw camera image data into an **input tensor**. The camera module sends this tensor directly into the AI accelerator within the camera, which produces **output tensors** that contain the inferencing results. The AI accelerator sends these tensors to the Raspberry Pi. There is no need for an external accelerator, nor for the Raspberry Pi to run neural network software on the CPU. + +To fully understand this system, familiarise yourself with the following concepts: + +Input Tensor:: The part of the sensor image passed to the AI engine for inferencing. Produced by a small on-board ISP which also crops and scales the camera image to the dimensions expected by the neural network that has been loaded. The input tensor is not normally made available to applications, though it is possible to access it for debugging purposes. + +Region of Interest (ROI):: Specifies exactly which part of the sensor image is cropped out before being rescaled to the size demanded by the neural network. Can be queried and set by an application. The units used are always pixels in the full resolution sensor output. The default ROI setting uses the full image received from the sensor, cropping no data. + +Output Tensors:: The results of inferencing performed by the neural network. The precise number and shape of the outputs depend on the neural network. Application code must understand how to handle the tensors. + +=== System architecture + +The diagram below shows the various camera software components (in green) used during our imaging/inference use case with the Raspberry Pi AI Camera module hardware (in red): + +image::images/imx500-block-diagram.svg[IMX500 block diagram] + +At startup, the IMX500 sensor module loads firmware to run a particular neural network model. During streaming, the IMX500 generates _both_ an image stream and an inference stream. This inference stream holds the inputs and outputs of the neural network model, also known as input/output **tensors**. + +=== Device drivers + +At the lowest level, the the IMX500 sensor kernel driver configures the camera module over the I2C bus. The CSI2 driver (`CFE` on Pi 5, `Unicam` on all other Pi platforms) sets up the receiver to write the image data stream into a frame buffer, together with the embedded data and inference data streams into another buffer in memory. + +The firmware files also transfer over the I2C bus wires. On most devices, this uses the standard I2C protocol, but Raspberry Pi 5 uses a custom high speed protocol. The RP2040 SPI driver in the kernel handles firmware file transfer, since the transfer uses the RP2040 microcontroller. The microcontroller bridges the I2C transfers from the kernel to the IMX500 via a SPI bus. Additionally, the RP2040 caches firmware files in on-board storage. This avoids the need to transfer entire firmware blobs over the I2C bus, significantly speeding up firmware loading for firmware you've already used. + +=== `libcamera` + +Once `libcamera` dequeues the image and inference data buffers from the kernel, the IMX500 specific `cam-helper` library (part of the Raspberry Pi IPA within `libcamera`) parses the inference buffer to access the input/output tensors. These tensors are packaged as Raspberry Pi vendor-specific https://libcamera.org/api-html/namespacelibcamera_1_1controls.html[`libcamera` controls]. `libcamera` returns the following controls: + +[%header,cols="a,a"] +|=== +| Control +| Description + +| `CnnOutputTensor` +| Floating point array storing the output tensors. + +| `CnnInputTensor` +| Floating point array storing the input tensor. + +| `CnnOutputTensorInfo` +| Network specific parameters describing the output tensors' structure: + +[source,c] +---- +struct OutputTensorInfo { + uint32_t tensorDataNum; + uint32_t numDimensions; + uint16_t size[MaxNumDimensions]; +}; + +struct CnnOutputTensorInfo { + char networkName[NetworkNameLen]; + uint32_t numTensors; + OutputTensorInfo info[MaxNumTensors]; +}; +---- + +| `CnnInputTensorInfo` +| Network specific parameters describing the input tensor's structure: + +[source,c] +---- +struct CnnInputTensorInfo { + char networkName[NetworkNameLen]; + uint32_t width; + uint32_t height; + uint32_t numChannels; +}; +---- + +|=== + +=== `rpicam-apps` + +`rpicam-apps` provides an IMX500 post-processing stage base class that implements helpers for IMX500 post-processing stages: https://github.com/raspberrypi/rpicam-apps/blob/main/post_processing_stages/imx500/imx500_post_processing_stage.hpp[`IMX500PostProcessingStage`]. Use this base class to derive a new post-processing stage for any neural network model running on the IMX500. For an example, see https://github.com/raspberrypi/rpicam-apps/blob/main/post_processing_stages/imx500/imx500_object_detection.cpp[`imx500_object_detection.cpp`]: + +[source,cpp] +---- +class ObjectDetection : public IMX500PostProcessingStage +{ +public: + ObjectDetection(RPiCamApp *app) : IMX500PostProcessingStage(app) {} + + char const *Name() const override; + + void Read(boost::property_tree::ptree const ¶ms) override; + + void Configure() override; + + bool Process(CompletedRequestPtr &completed_request) override; +}; +---- + +For every frame received by the application, the `Process()` function is called (`ObjectDetection::Process()` in the above case). In this function, you can extract the output tensor for further processing or analysis: + +[source,cpp] +---- +auto output = completed_request->metadata.get(controls::rpi::CnnOutputTensor); +if (!output) +{ + LOG_ERROR("No output tensor found in metadata!"); + return false; +} + +std::vector output_tensor(output->data(), output->data() + output->size()); +---- + +Once completed, the final results can either be visualised or saved in metadata and consumed by either another downstream stage, or the top level application itself. In the object inference case: + +[source,cpp] +---- +if (objects.size()) + completed_request->post_process_metadata.Set("object_detect.results", objects); +---- + +The `object_detect_draw_cv` post-processing stage running downstream fetches these results from the metadata and draws the bounding boxes onto the image in the `ObjectDetectDrawCvStage::Process()` function: + +[source,cpp] +---- +std::vector detections; +completed_request->post_process_metadata.Get("object_detect.results", detections); +---- + +The following table contains a full list of helper functions provided by `IMX500PostProcessingStage`: + +[%header,cols="a,a"] +|=== +| Function +| Description + +| `Read()` +| Typically called from `::Read()`, this function reads the config parameters for input tensor parsing and saving. + +This function also reads the neural network model file string (`"network_file"`) and sets up the firmware to be loaded on camera open. + +| `Process()` +| Typically called from `::Process()` this function processes and saves the input tensor to a file if required by the JSON config file. + +| `SetInferenceRoiAbs()` +| Sets an absolute region of interest (ROI) crop rectangle on the sensor image to use for inferencing on the IMX500. + +| `SetInferenceRoiAuto()` +| Automatically calculates region of interest (ROI) crop rectangle on the sensor image to preserve the input tensor aspect ratio for a given neural network. + +| `ShowFwProgressBar()` +| Displays a progress bar on the console showing the progress of the neural network firmware upload to the IMX500. + +| `ConvertInferenceCoordinates()` +| Converts from the input tensor coordinate space to the final ISP output image space. + +There are a number of scaling/cropping/translation operations occurring from the original sensor image to the fully processed ISP output image. This function converts coordinates provided by the output tensor to the equivalent coordinates after performing these operations. + +|=== + +=== Picamera2 + +IMX500 integration in Picamera2 is very similar to what is available in `rpicam-apps`. Picamera2 has an IMX500 helper class that provides the same functionality as the `rpicam-apps` `IMX500PostProcessingStage` base class. This can be imported to any Python script with: + +[source,python] +---- +from picamera2.devices.imx500 import IMX500 + +# This must be called before instantiation of Picamera2 +imx500 = IMX500(model_file) +---- + +To retrieve the output tensors, fetch them from the controls. You can then apply additional processing in your Python script. + +For example, in an object inference use case such as https://github.com/raspberrypi/picamera2/tree/main/examples/imx500/imx500_object_detection_demo.py[imx500_object_detection_demo.py], the object bounding boxes and confidence values are extracted in `parse_detections()` and draw the boxes on the image in `draw_detections()`: + +[source,python] +---- +class Detection: + def __init__(self, coords, category, conf, metadata): + """Create a Detection object, recording the bounding box, category and confidence.""" + self.category = category + self.conf = conf + obj_scaled = imx500.convert_inference_coords(coords, metadata, picam2) + self.box = (obj_scaled.x, obj_scaled.y, obj_scaled.width, obj_scaled.height) + +def draw_detections(request, detections, stream="main"): + """Draw the detections for this request onto the ISP output.""" + labels = get_labels() + with MappedArray(request, stream) as m: + for detection in detections: + x, y, w, h = detection.box + label = f"{labels[int(detection.category)]} ({detection.conf:.2f})" + cv2.putText(m.array, label, (x + 5, y + 15), cv2.FONT_HERSHEY_SIMPLEX, 0.5, (0, 0, 255), 1) + cv2.rectangle(m.array, (x, y), (x + w, y + h), (0, 0, 255, 0)) + if args.preserve_aspect_ratio: + b = imx500.get_roi_scaled(request) + cv2.putText(m.array, "ROI", (b.x + 5, b.y + 15), cv2.FONT_HERSHEY_SIMPLEX, 0.5, (255, 0, 0), 1) + cv2.rectangle(m.array, (b.x, b.y), (b.x + b.width, b.y + b.height), (255, 0, 0, 0)) + +def parse_detections(request, stream='main'): + """Parse the output tensor into a number of detected objects, scaled to the ISP output.""" + outputs = imx500.get_outputs(request.get_metadata()) + boxes, scores, classes = outputs[0][0], outputs[1][0], outputs[2][0] + detections = [ Detection(box, category, score, metadata) + for box, score, category in zip(boxes, scores, classes) if score > threshold] + draw_detections(request, detections, stream) +---- + +Unlike the `rpicam-apps` example, this example applies no additional hysteresis or temporal filtering. + +The IMX500 class in Picamera2 provides the following helper functions: + +[%header,cols="a,a"] +|=== +| Function +| Description + +| `IMX500.get_full_sensor_resolution()` +| Return the full sensor resolution of the IMX500. + +| `IMX500.config` +| Returns a dictionary of the neural network configuration. + +| `IMX500.convert_inference_coords(coords, metadata, picamera2)` +| Converts the coordinates _coords_ from the input tensor coordinate space to the final ISP output image space. Must be passed Picamera2's image metadata for the image, and the Picamera2 object. + +There are a number of scaling/cropping/translation operations occurring from the original sensor image to the fully processed ISP output image. This function converts coordinates provided by the output tensor to the equivalent coordinates after performing these operations. + +| `IMX500.show_network_fw_progress_bar()` +| Displays a progress bar on the console showing the progress of the neural network firmware upload to the IMX500. + +| `IMX500.get_roi_scaled(request)` +| Returns the region of interest (ROI) in the ISP output image coordinate space. + +| `IMX500.get_isp_output_size(picamera2)` +| Returns the ISP output image size. + +| `IMX5000.get_input_size()` +| Returns the input tensor size based on the neural network model used. + +| `IMX500.get_outputs(metadata)` +| Returns the output tensors from the Picamera2 image metadata. + +| `IMX500.get_output_shapes(metadata)` +| Returns the shape of the output tensors from the Picamera2 image metadata for the neural network model used. + +| `IMX500.set_inference_roi_abs(rectangle)` +| Sets the region of interest (ROI) crop rectangle which determines which part of the sensor image is converted to the input tensor that is used for inferencing on the IMX500. The region of interest should be specified in units of pixels at the full sensor resolution, as a `(x_offset, y_offset, width, height)` tuple. + +| `IMX500.set_inference_aspect_ratio(aspect_ratio)` +| Automatically calculates region of interest (ROI) crop rectangle on the sensor image to preserve the given aspect ratio. To make the ROI aspect ratio exactly match the input tensor for this network, use `imx500.set_inference_aspect_ratio(imx500.get_input_size())`. + +| `IMX500.get_kpi_info(metadata)` +| Returns the frame-level performance indicators logged by the IMX500 for the given image metadata. + +|=== diff --git a/documentation/asciidoc/accessories/ai-camera/getting-started.adoc b/documentation/asciidoc/accessories/ai-camera/getting-started.adoc new file mode 100644 index 000000000..b23720895 --- /dev/null +++ b/documentation/asciidoc/accessories/ai-camera/getting-started.adoc @@ -0,0 +1,141 @@ +== Getting started + +The instructions below describe how to run the pre-packaged MobileNet SSD and PoseNet neural network models on the Raspberry Pi AI Camera. + +=== Hardware setup + +Attach the camera to your Raspberry Pi 5 board following the instructions at xref:../accessories/camera.adoc#install-a-raspberry-pi-camera[Install a Raspberry Pi Camera]. + +=== Prerequisites + +These instructions assume you are using the AI Camera attached to either a Raspberry Pi 4 Model B or Raspberry Pi 5 board. With minor changes, you can follow these instructions on other Raspberry Pi models with a camera connector, including the Raspberry Pi Zero 2 W and Raspberry Pi 3 Model B+. + +First, ensure that your Raspberry Pi runs the latest software. Run the following command to update: + +[source,console] +---- +$ sudo apt update && sudo apt full-upgrade +---- + +=== Install the IMX500 firmware + +The AI camera must download runtime firmware onto the IMX500 sensor during startup. To install these firmware files onto your Raspberry Pi, run the following command: + +[source,console] +---- +$ sudo apt install imx500-all +---- + +This command: + +* installs the `/lib/firmware/imx500_loader.fpk` and `/lib/firmware/imx500_firmware.fpk` firmware files required to operate the IMX500 sensor +* places a number of neural network model firmware files in `/usr/share/imx500-models/` +* installs the IMX500 post-processing software stages in `rpicam-apps` +* installs the Sony network model packaging tools + +NOTE: The IMX500 kernel device driver loads all the firmware files when the camera starts. This may take several minutes if the neural network model firmware has not been previously cached. The demos below display a progress bar on the console to indicate firmware loading progress. + +=== Reboot + +Now that you've installed the prerequisites, restart your Raspberry Pi: + +[source,console] +---- +$ sudo reboot +---- + +== Run example applications + +Once all the system packages are updated and firmware files installed, we can start running some example applications. As mentioned earlier, the Raspberry Pi AI Camera integrates fully with `libcamera`, `rpicam-apps`, and `Picamera2`. + +=== `rpicam-apps` + +The xref:../computers/camera_software.adoc#rpicam-apps[`rpicam-apps` camera applications] include IMX500 object detection and pose estimation stages that can be run in the post-processing pipeline. For more information about the post-processing pipeline, see xref:../computers/camera_software.adoc#post-process-file[the post-processing documentation]. + +The examples on this page use post-processing JSON files located in `/usr/share/rpi-camera-assets/`. + +==== Object detection + +The MobileNet SSD neural network performs basic object detection, providing bounding boxes and confidence values for each object found. `imx500_mobilenet_ssd.json` contains the configuration parameters for the IMX500 object detection post-processing stage using the MobileNet SSD neural network. + +`imx500_mobilenet_ssd.json` declares a post-processing pipeline that contains two stages: + +. `imx500_object_detection`, which picks out bounding boxes and confidence values generated by the neural network in the output tensor +. `object_detect_draw_cv`, which draws bounding boxes and labels on the image + +The MobileNet SSD tensor requires no significant post-processing on your Raspberry Pi to generate the final output of bounding boxes. All object detection runs directly on the AI Camera. + +The following command runs `rpicam-hello` with object detection post-processing: + +[source,console] +---- +$ rpicam-hello -t 0s --post-process-file /usr/share/rpi-camera-assets/imx500_mobilenet_ssd.json --viewfinder-width 1920 --viewfinder-height 1080 --framerate 30 +---- + +After running the command, you should see a viewfinder that overlays bounding boxes on objects recognised by the neural network: + +image::images/imx500-mobilenet.jpg[IMX500 MobileNet] + +To record video with object detection overlays, use `rpicam-vid` instead: + +[source,console] +---- +$ rpicam-vid -t 10s -o output.264 --post-process-file /usr/share/rpi-camera-assets/imx500_mobilenet_ssd.json --width 1920 --height 1080 --framerate 30 +---- + +You can configure the `imx500_object_detection` stage in many ways. + +For example, `max_detections` defines the maximum number of objects that the pipeline will detect at any given time. `threshold` defines the minimum confidence value required for the pipeline to consider any input as an object. + +The raw inference output data of this network can be quite noisy, so this stage also preforms some temporal filtering and applies hysteresis. To disable this filtering, remove the `temporal_filter` config block. + +==== Pose estimation + +The PoseNet neural network performs pose estimation, labelling key points on the body associated with joints and limbs. `imx500_posenet.json` contains the configuration parameters for the IMX500 pose estimation post-processing stage using the PoseNet neural network. + +`imx500_posenet.json` declares a post-processing pipeline that contains two stages: + +* `imx500_posenet`, which fetches the raw output tensor from the PoseNet neural network +* `plot_pose_cv`, which draws line overlays on the image + +The AI Camera performs basic detection, but the output tensor requires additional post-processing on your host Raspberry Pi to produce final output. + +The following command runs `rpicam-hello` with pose estimation post-processing: + +[source,console] +---- +$ rpicam-hello -t 0s --post-process-file /usr/share/rpi-camera-assets/imx500_posenet.json --viewfinder-width 1920 --viewfinder-height 1080 --framerate 30 +---- + +image::images/imx500-posenet.jpg[IMX500 PoseNet] + +You can configure the `imx500_posenet` stage in many ways. + +For example, `max_detections` defines the maximum number of bodies that the pipeline will detect at any given time. `threshold` defines the minimum confidence value required for the pipeline to consider input as a body. + +=== Picamera2 + +For examples of image classification, object detection, object segmentation, and pose estimation using Picamera2, see https://github.com/raspberrypi/picamera2/blob/main/examples/imx500/[the `picamera2` GitHub repository]. + +Most of the examples use OpenCV for some additional processing. To install the dependencies required to run OpenCV, run the following command: + +[source,console] +---- +$ sudo apt install python3-opencv python3-munkres +---- + +Now download the https://github.com/raspberrypi/picamera2[the `picamera2` repository] to your Raspberry Pi to run the examples. You'll find example files in the root directory, with additional information in the `README.md` file. + +Run the following script from the repository to run YOLOv8 object detection: + +[source,console] +---- +$ python imx500_object_detection_demo.py --model /usr/share/imx500-models/imx500_network_ssd_mobilenetv2_fpnlite_320x320_pp.rpk +---- + +To try pose estimation in Picamera2, run the following script from the repository: + +[source,console] +---- +$ python imx500_pose_estimation_higherhrnet_demo.py +---- diff --git a/documentation/asciidoc/accessories/ai-camera/images/ai-camera.png b/documentation/asciidoc/accessories/ai-camera/images/ai-camera.png new file mode 100644 index 000000000..a0186287c Binary files /dev/null and b/documentation/asciidoc/accessories/ai-camera/images/ai-camera.png differ diff --git a/documentation/asciidoc/accessories/ai-camera/images/imx500-block-diagram.svg b/documentation/asciidoc/accessories/ai-camera/images/imx500-block-diagram.svg new file mode 100644 index 000000000..142854adb --- /dev/null +++ b/documentation/asciidoc/accessories/ai-camera/images/imx500-block-diagram.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/asciidoc/accessories/ai-camera/images/imx500-comparison.svg b/documentation/asciidoc/accessories/ai-camera/images/imx500-comparison.svg new file mode 100644 index 000000000..5355ecb23 --- /dev/null +++ b/documentation/asciidoc/accessories/ai-camera/images/imx500-comparison.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/asciidoc/accessories/ai-camera/images/imx500-mobilenet.jpg b/documentation/asciidoc/accessories/ai-camera/images/imx500-mobilenet.jpg new file mode 100644 index 000000000..871f7b9eb Binary files /dev/null and b/documentation/asciidoc/accessories/ai-camera/images/imx500-mobilenet.jpg differ diff --git a/documentation/asciidoc/accessories/ai-camera/images/imx500-posenet.jpg b/documentation/asciidoc/accessories/ai-camera/images/imx500-posenet.jpg new file mode 100644 index 000000000..0c145d748 Binary files /dev/null and b/documentation/asciidoc/accessories/ai-camera/images/imx500-posenet.jpg differ diff --git a/documentation/asciidoc/accessories/ai-camera/model-conversion.adoc b/documentation/asciidoc/accessories/ai-camera/model-conversion.adoc new file mode 100644 index 000000000..f449476c6 --- /dev/null +++ b/documentation/asciidoc/accessories/ai-camera/model-conversion.adoc @@ -0,0 +1,106 @@ +== Model deployment + +To deploy a new neural network model to the Raspberry Pi AI Camera, complete the following steps: + +. Provide a floating-point neural network model (PyTorch or TensorFlow). +. Run the model through Edge-MDT (Edge AI Model Development Toolkit). +.. *Quantise* and compress the model so that it can run using the resources available on the IMX500 camera module. +.. *Convert* the compressed model to IMX500 format. +. Package the model into a firmware file that can be loaded at runtime onto the camera. + +The first two steps will normally be performed on a more powerful computer such as a desktop or server. You must run the final packaging step on a Raspberry Pi. + +=== Model creation + +The creation of neural network models is beyond the scope of this guide. Existing models can be re-used, or new ones created using popular AI frameworks like TensorFlow or PyTorch. + +For more information, see the official https://developer.aitrios.sony-semicon.com/en/raspberrypi-ai-camera[AITRIOS developer website]. + +=== Model compression and conversion + +==== Edge-MDT installation + +The Edge-MDT (Model Development Toolkit) software package installs all the tools required to quantise, compress, and convert models to run on your IMX500 device. + +The Edge-MDT package takes a parameter to select between installing the PyTorch or TensorFlow version of the tools. + +[tabs] +====== +PyTorch:: ++ +[source,console] +---- +$ pip install edge-mdt[pt] +---- + +TensorFlow:: ++ +[source,console] +---- +$ pip install edge-mdt[tf] +---- ++ +TIP: Always use the same version of TensorFlow you used to compress your model. +====== + +If you need to install both packages, use two separate Python virtual environments. This prevents TensorFlow and PyTorch from causing conflicts with each other. + +==== Model Optimization + +Models are quantised and compressed using Sony's Model Compression Toolkit (MCT). This tool is automatically installed as part of the Edge-MDT installation step. For more information, see the https://github.com/sony/model_optimization[Sony model optimization GitHub repository]. + +The Model Compression Toolkit generates a quantised model in the following formats: + +* Keras (TensorFlow) +* ONNX (PyTorch) + +=== Conversion + +The converter is a command line application that compiles the quantised model (in .onnx or .keras formats) into a binary file that can be packaged and loaded onto the AI Camera. This tool is automatically installed as part of the Edge-MDT installation step. + +To convert a model model: + +[tabs] +====== +PyTorch:: ++ +[source,console] +---- +$ imxconv-pt -i -o +---- + +TensorFlow:: ++ +[source,console] +---- +$ imxconv-tf -i -o +---- +====== + +IMPORTANT: For optimal use of the memory available to the accelerator on the IMX500 sensor, add `--no-input-persistency` to the above commands. However, this will disable input tensor generation that may be used for debugging purposes. + +Both commands create an output folder that contains a memory usage report and a `packerOut.zip` file. + +For more information on the model conversion process, see the official https://developer.aitrios.sony-semicon.com/en/raspberrypi-ai-camera/documentation/imx500-converter[Sony IMX500 Converter documentation]. + +=== Packaging + +IMPORTANT: You must run this step on a Raspberry Pi. + +The final step packages the model into an RPK file. When running the neural network model, we'll upload this file to the AI Camera. Before proceeding, run the following command to install the necessary tools: + +[source,console] +---- +$ sudo apt install imx500-tools +---- + +To package the model into an RPK file, run the following command: + +[source,console] +---- +$ imx500-package -i -o +---- + +This command should create a file named `network.rpk` in the output folder. You'll pass the name of this file to your IMX500 camera applications. + +For a more comprehensive set of instructions and further specifics on the tools used, see the https://developer.aitrios.sony-semicon.com/en/raspberrypi-ai-camera/documentation/imx500-packager[Sony IMX500 Packager documentation]. diff --git a/documentation/asciidoc/accessories/ai-hat-plus.adoc b/documentation/asciidoc/accessories/ai-hat-plus.adoc new file mode 100644 index 000000000..dc6a3a7cf --- /dev/null +++ b/documentation/asciidoc/accessories/ai-hat-plus.adoc @@ -0,0 +1,5 @@ +include::ai-hat-plus/about.adoc[] + +== Product brief + +For more information about the AI HAT+, including mechanical specifications and operating environment limitations, see the https://datasheets.raspberrypi.com/ai-hat-plus/raspberry-pi-ai-hat-plus-product-brief.pdf[product brief]. diff --git a/documentation/asciidoc/accessories/ai-hat-plus/about.adoc b/documentation/asciidoc/accessories/ai-hat-plus/about.adoc new file mode 100644 index 000000000..1185d338e --- /dev/null +++ b/documentation/asciidoc/accessories/ai-hat-plus/about.adoc @@ -0,0 +1,77 @@ +[[ai-hat-plus]] +== About + +.The 26 tera-operations per second (TOPS) Raspberry Pi AI HAT+ +image::images/ai-hat-plus-hero.jpg[width="80%"] + +The Raspberry Pi AI HAT+ add-on board has a built-in Hailo AI accelerator compatible with +Raspberry Pi 5. The NPU in the AI HAT+ can be used for applications including process control, security, home automation, and robotics. + +The AI HAT+ is available in 13 and 26 tera-operations per second (TOPS) variants, built around the Hailo-8L and Hailo-8 neural network inference accelerators. The 13 TOPS variant works best with moderate workloads, with performance similar to the xref:ai-kit.adoc[AI Kit]. The 26 TOPS variant can run larger networks, can run networks faster, and can more effectively run multiple networks simultaneously. + +The AI HAT+ communicates using Raspberry Pi 5's PCIe interface. The host Raspberry Pi 5 automatically detects the on-board Hailo accelerator and uses the NPU for supported AI computing tasks. Raspberry Pi OS's built-in `rpicam-apps` camera applications automatically use the NPU to run compatible post-processing tasks. + +WARNING: The Raspberry Pi AI HAT+ is not yet supported by Raspberry Pi OS Trixie. To use AI HAT+, install or stay on Raspberry Pi OS Bookworm for now. + +[[ai-hat-plus-installation]] +== Install + +To use the AI HAT+, you will need: + +* a Raspberry Pi 5 + +Each AI HAT+ comes with a ribbon cable, GPIO stacking header, and mounting hardware. Complete the following instructions to install your AI HAT+: + +. First, ensure that your Raspberry Pi runs the latest software. Run the following command to update: ++ +[source,console] +---- +$ sudo apt update && sudo apt full-upgrade +---- + +. Next, xref:../computers/raspberry-pi.adoc#update-the-bootloader-configuration[ensure that your Raspberry Pi firmware is up-to-date]. Run the following command to see what firmware you're running: ++ +[source,console] +---- +$ sudo rpi-eeprom-update +---- ++ +If you see 6 December 2023 or a later date, proceed to the next step. If you see a date earlier than 6 December 2023, run the following command to open the Raspberry Pi Configuration CLI: ++ +[source,console] +---- +$ sudo raspi-config +---- ++ +Under `Advanced Options` > `Bootloader Version`, choose `Latest`. Then, exit `raspi-config` with `Finish` or the *Escape* key. ++ +Run the following command to update your firmware to the latest version: ++ +[source,console] +---- +$ sudo rpi-eeprom-update -a +---- ++ +Then, reboot with `sudo reboot`. + +. Disconnect the Raspberry Pi from power before beginning installation. + +. For the best performance, we recommend using the AI HAT+ with the Raspberry Pi Active Cooler. If you have an Active Cooler, install it before installing the AI HAT+. ++ +-- +image::images/ai-hat-plus-installation-01.png[width="60%"] +-- +. Install the spacers using four of the provided screws. Firmly press the GPIO stacking header on top of the Raspberry Pi GPIO pins; orientation does not matter as long as all pins fit into place. Disconnect the ribbon cable from the AI HAT+, and insert the other end into the PCIe port of your Raspberry Pi. Lift the ribbon cable holder from both sides, then insert the cable with the copper contact points facing inward, towards the USB ports. With the ribbon cable fully and evenly inserted into the PCIe port, push the cable holder down from both sides to secure the ribbon cable firmly in place. ++ +-- +image::images/ai-hat-plus-installation-02.png[width="60%"] +-- +. Set the AI HAT+ on top of the spacers, and use the four remaining screws to secure it in place. + +. Insert the ribbon cable into the slot on the AI HAT+. Lift the ribbon cable holder from both sides, then insert the cable with the copper contact points facing up. With the ribbon cable fully and evenly inserted into the port, push the cable holder down from both sides to secure the ribbon cable firmly in place. + +. Congratulations, you have successfully installed the AI HAT+. Connect your Raspberry Pi to power; Raspberry Pi OS will automatically detect the AI HAT+. + +== Get started with AI on your Raspberry Pi + +To start running AI accelerated applications on your Raspberry Pi, check out our xref:../computers/ai.adoc[Getting Started with the AI Kit and AI HAT+] guide. diff --git a/documentation/asciidoc/accessories/ai-hat-plus/images/ai-hat-plus-hero.jpg b/documentation/asciidoc/accessories/ai-hat-plus/images/ai-hat-plus-hero.jpg new file mode 100644 index 000000000..08064ca25 Binary files /dev/null and b/documentation/asciidoc/accessories/ai-hat-plus/images/ai-hat-plus-hero.jpg differ diff --git a/documentation/asciidoc/accessories/ai-hat-plus/images/ai-hat-plus-installation-01.png b/documentation/asciidoc/accessories/ai-hat-plus/images/ai-hat-plus-installation-01.png new file mode 100644 index 000000000..33fb88280 Binary files /dev/null and b/documentation/asciidoc/accessories/ai-hat-plus/images/ai-hat-plus-installation-01.png differ diff --git a/documentation/asciidoc/accessories/ai-hat-plus/images/ai-hat-plus-installation-02.png b/documentation/asciidoc/accessories/ai-hat-plus/images/ai-hat-plus-installation-02.png new file mode 100644 index 000000000..b2a60016a Binary files /dev/null and b/documentation/asciidoc/accessories/ai-hat-plus/images/ai-hat-plus-installation-02.png differ diff --git a/documentation/asciidoc/accessories/ai-kit.adoc b/documentation/asciidoc/accessories/ai-kit.adoc new file mode 100644 index 000000000..c5d54d1d4 --- /dev/null +++ b/documentation/asciidoc/accessories/ai-kit.adoc @@ -0,0 +1,6 @@ +include::ai-kit/about.adoc[] + +== Product brief + +For more information about the AI Kit, including mechanical specifications and operating environment limitations, see the https://datasheets.raspberrypi.com/ai-kit/raspberry-pi-ai-kit-product-brief.pdf[product brief]. + diff --git a/documentation/asciidoc/accessories/ai-kit/about.adoc b/documentation/asciidoc/accessories/ai-kit/about.adoc new file mode 100644 index 000000000..2a635dcc4 --- /dev/null +++ b/documentation/asciidoc/accessories/ai-kit/about.adoc @@ -0,0 +1,95 @@ +[[ai-kit]] +== About + +.The Raspberry Pi AI Kit +image::images/ai-kit.jpg[width="80%"] + +The Raspberry Pi AI Kit bundles the xref:m2-hat-plus.adoc#m2-hat-plus[Raspberry Pi M.2 HAT+] with a Hailo AI acceleration module for use with Raspberry Pi 5. The kit contains the following: + +* Hailo AI module containing a Neural Processing Unit (NPU) +* Raspberry Pi M.2 HAT+, to connect the AI module to your Raspberry Pi 5 +* thermal pad pre-fitted between the module and the M.2 HAT+ +* mounting hardware kit +* 16mm stacking GPIO header + +WARNING: The Raspberry Pi AI Kit is not yet supported by Raspberry Pi OS Trixie. To use the AI Kit, install or stay on Raspberry Pi OS Bookworm for now. + +== AI module features + +* 13 tera-operations per second (TOPS) neural network inference accelerator built around the Hailo-8L chip. +* M.2 2242 form factor + +[[ai-kit-installation]] +== Install + +To use the AI Kit, you will need: + +* a Raspberry Pi 5 + +Each AI Kit comes with a pre-installed AI module, ribbon cable, GPIO stacking header, and mounting hardware. Complete the following instructions to install your AI Kit: + +. First, ensure that your Raspberry Pi runs the latest software. Run the following command to update: ++ +[source,console] +---- +$ sudo apt update && sudo apt full-upgrade +---- + +. Next, xref:../computers/raspberry-pi.adoc#update-the-bootloader-configuration[ensure that your Raspberry Pi firmware is up-to-date]. Run the following command to see what firmware you're running: ++ +[source,console] +---- +$ sudo rpi-eeprom-update +---- ++ +If you see 6 December 2023 or a later date, proceed to the next step. If you see a date earlier than 6 December 2023, run the following command to open the Raspberry Pi Configuration CLI: ++ +[source,console] +---- +$ sudo raspi-config +---- ++ +Under `Advanced Options` > `Bootloader Version`, choose `Latest`. Then, exit `raspi-config` with `Finish` or the *Escape* key. ++ +Run the following command to update your firmware to the latest version: ++ +[source,console] +---- +$ sudo rpi-eeprom-update -a +---- ++ +Then, reboot with `sudo reboot`. + +. Disconnect the Raspberry Pi from power before beginning installation. + +. For the best performance, we recommend using the AI Kit with the Raspberry Pi Active Cooler. If you have an Active Cooler, install it before installing the AI Kit. ++ +-- +image::images/ai-kit-installation-01.png[width="60%"] +-- +. Install the spacers using four of the provided screws. Firmly press the GPIO stacking header on top of the Raspberry Pi GPIO pins; orientation does not matter as long as all pins fit into place. Disconnect the ribbon cable from the AI Kit, and insert the other end into the PCIe port of your Raspberry Pi. Lift the ribbon cable holder from both sides, then insert the cable with the copper contact points facing inward, towards the USB ports. With the ribbon cable fully and evenly inserted into the PCIe port, push the cable holder down from both sides to secure the ribbon cable firmly in place. ++ +-- +image::images/ai-kit-installation-02.png[width="60%"] +-- +. Set the AI Kit on top of the spacers, and use the four remaining screws to secure it in place. ++ +-- +image::images/ai-kit-installation-03.png[width="60%"] +-- +. Insert the ribbon cable into the slot on the AI Kit. Lift the ribbon cable holder from both sides, then insert the cable with the copper contact points facing up. With the ribbon cable fully and evenly inserted into the port, push the cable holder down from both sides to secure the ribbon cable firmly in place. ++ +-- +image::images/ai-kit-installation-04.png[width="60%"] +-- +. Congratulations, you have successfully installed the AI Kit. Connect your Raspberry Pi to power; Raspberry Pi OS will automatically detect the AI Kit. ++ +-- +image::images/ai-kit-installation-05.png[width="60%"] +-- + +WARNING: Always disconnect your Raspberry Pi from power before connecting or disconnecting a device from the M.2 slot. + +== Get started with AI on your Raspberry Pi + +To start running AI accelerated applications on your Raspberry Pi, check out our xref:../computers/ai.adoc[Getting Started with the AI Kit and AI HAT+] guide. diff --git a/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-01.png b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-01.png new file mode 100644 index 000000000..33fb88280 Binary files /dev/null and b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-01.png differ diff --git a/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-02.png b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-02.png new file mode 100644 index 000000000..b2a60016a Binary files /dev/null and b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-02.png differ diff --git a/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-03.png b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-03.png new file mode 100644 index 000000000..2e821583c Binary files /dev/null and b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-03.png differ diff --git a/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-04.png b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-04.png new file mode 100644 index 000000000..7bf45e816 Binary files /dev/null and b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-04.png differ diff --git a/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-05.png b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-05.png new file mode 100644 index 000000000..67b0d969a Binary files /dev/null and b/documentation/asciidoc/accessories/ai-kit/images/ai-kit-installation-05.png differ diff --git a/documentation/asciidoc/accessories/ai-kit/images/ai-kit.jpg b/documentation/asciidoc/accessories/ai-kit/images/ai-kit.jpg new file mode 100644 index 000000000..d519b0ff4 Binary files /dev/null and b/documentation/asciidoc/accessories/ai-kit/images/ai-kit.jpg differ diff --git a/documentation/asciidoc/accessories/audio.adoc b/documentation/asciidoc/accessories/audio.adoc index 7c4fd154b..87e227f58 100644 --- a/documentation/asciidoc/accessories/audio.adoc +++ b/documentation/asciidoc/accessories/audio.adoc @@ -1,4 +1,3 @@ - include::audio/introduction.adoc[] include::audio/dac_pro.adoc[] @@ -16,4 +15,3 @@ include::audio/getting_started.adoc[] include::audio/hardware-info.adoc[] include::audio/update-firmware.adoc[] - diff --git a/documentation/asciidoc/accessories/audio/codec_zero.adoc b/documentation/asciidoc/accessories/audio/codec_zero.adoc index 9739adf5f..cfb9dd967 100644 --- a/documentation/asciidoc/accessories/audio/codec_zero.adoc +++ b/documentation/asciidoc/accessories/audio/codec_zero.adoc @@ -22,6 +22,7 @@ The Codec Zero includes an EEPROM which can be used for auto-configuration of th In addition to the green (GPIO23) and red (GPIO24) LEDs, a tactile programmable button (GPIO27) is also provided. ==== Pinouts + [cols="1,12"] |=== | *P1/2* | Support external PHONO/RCA sockets if needed. P1: AUX IN, P2: AUX OUT. diff --git a/documentation/asciidoc/accessories/audio/configuration.adoc b/documentation/asciidoc/accessories/audio/configuration.adoc index 0c8f80f84..79a5d2136 100644 --- a/documentation/asciidoc/accessories/audio/configuration.adoc +++ b/documentation/asciidoc/accessories/audio/configuration.adoc @@ -6,42 +6,51 @@ 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 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: +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: +[source,console] ---- $ 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/firmware/config.txt` file should now contain the following entry: +[source,ini] ---- #dtparam=audio=on ---- -Press CTRL+X, then Y and Enter to save, followed by a reboot of your Raspberry Pi in order for the settings to take effect. +Press `Ctrl+X`, then the `Y` key, then *Enter* to save. Finally, reboot your Raspberry Pi in order for the settings to take effect. +[source,console] ---- $ sudo reboot ---- 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 +=== Attach the HAT -The Raspberry Pi audio boards attach to the Raspberry Pi’s 40-pin header. They are designed to be supported on the Raspberry Pi using the supplied circuit board standoffs and screws. No soldering is required on the Raspberry Pi audio boards for normal operation unless you are using hardwired connections for specific connectors such as XLR (External Line Return) connections on the DAC Pro. +The Raspberry Pi audio boards attach to the Raspberry Pi's 40-pin header. They are designed to be supported on the Raspberry Pi using the supplied circuit board standoffs and screws. No soldering is required on the Raspberry Pi audio boards for normal operation unless you are using hardwired connections for specific connectors such as XLR (External Line Return) connections on the DAC Pro. All the necessary mounting hardware including spacers, screws and connectors is provided. The PCB spacers should be screwed, finger-tight only, to the Raspberry Pi before adding the audio board. The remaining screws should then be screwed into the spacers from above. === Hardware versions -There are multiple versions of the audio cards, and the version that you possess determines the actions required to configure it. Older IQaudIO-marked boards (black PCB) are electrically equivalent to the Raspberry Pi-branded boards (green PCB) but have different EEPROM contents. The following command can be used to confirm which version you have: +There are multiple versions of the audio cards. Your specific version determines the actions required for configuration. Older, IQaudIO-branded boards have a black PCB. Newer Raspberry Pi-branded boards have a green PCB. These boards are electrically equivalent, but have different EEPROM contents. +After attaching the HAT and applying power, check that the power LED on your audio card is illuminated, if it has one. For example, the Codec Zero has an LED marked `PWR`. + +After establishing the card has power, use the following command to check the version of your board: + +[source,console] ---- $ grep -a . /proc/device-tree/hat/* ---- If the vendor string says "Raspberry Pi Ltd." then no further action is needed (but see below for the extra Codec Zero configuration). If it says "IQaudIO Limited www.iqaudio.com" then you will need the additional config.txt settings outlined below. If it says "No such file or directory" then the HAT is not being detected, but these config.txt settings may still make it work. +[source,ini] ---- # Some magic to prevent the normal HAT overlay from being loaded dtoverlay= @@ -63,7 +72,7 @@ Each input and output device has its own mixer, allowing the audio levels and vo independently. Within the codec itself, other mixers and switches exist to allow the output to be mixed to a single mono channel for single-speaker output. Signals may also be inverted; there is a five-band equaliser to adjust certain frequency bands. These settings can be controlled interactively, using AlsaMixer, or programmatically. Both the AUX IN and AUX OUT are 1V RMS. It may be necessary to adjust -the AUX IN’s mixer to ensure that the input signal doesn’t saturate the ADC. Similarly, the output mixers can be to be adjusted to get the best possible output. +the AUX IN's mixer to ensure that the input signal doesn't saturate the ADC. Similarly, the output mixers can be to be adjusted to get the best possible output. Preconfigured scripts (loadable ALSA settings) https://github.com/raspberrypi/Pi-Codec[are available on GitHub], offering: @@ -74,32 +83,52 @@ Preconfigured scripts (loadable ALSA settings) https://github.com/raspberrypi/Pi The Codec Zero needs to know which of these input and output settings are being used each time the Raspberry Pi powers on. Using a Terminal session on your Raspberry Pi, run the following command to download the scripts: +[source,console] ---- $ git clone https://github.com/raspberrypi/Pi-Codec.git ---- If git is not installed, run the following command to install it: +[source,console] ---- $ sudo apt install git ---- The following command will set your device to use the on-board MEMS microphone and output for speaker playback: +[source,console] ---- -$ sudo alsactl restore -f /home/pi/Pi-Codec/Codec_Zero_OnboardMIC_record_and_SPK_playback.state +$ sudo alsactl restore -f /home//Pi-Codec/Codec_Zero_OnboardMIC_record_and_SPK_playback.state ---- +This command may result in erroneous messages, including the following: + +* "failed to import hw" +* "No state is present for card" + +In most cases, these warnings are harmless; you can safely ignore them. + +However, the following warnings may indicate a hardware failure: + +* "Remote I/O error" + +In Linux, the following warnings indicate that the kernel can't communicate with an I2C device: + +* "Remote I/O error" (`REMOTEIO`) + In order for your project to operate with your required settings when it is powered on, edit the `/etc/rc.local` file. The contents of this file are run at the end of every boot process, so it is ideal for this purpose. Edit the file: +[source,console] ---- $ sudo nano /etc/rc.local ---- -Add the chosen script command above the exit 0 line and then Ctrl X, Y and Enter to save. The file should now look similar to this depending on your chosen setting: +Add the chosen script command above the exit 0 line and then *Ctrl X*, *Y* and *Enter* to save. The file should now look similar to this depending on your chosen setting: +[source,bash] ---- -#!/bin/sh -e +#!/bin/sh # # rc.local # @@ -112,19 +141,21 @@ Add the chosen script command above the exit 0 line and then Ctrl X, Y and Enter # # By default this script does nothing. -sudo alsactl restore -f /home/pi/Pi-Codec/Codec_Zero_OnboardMIC_record_and_SPK_playback.state +sudo alsactl restore -f /home//Pi-Codec/Codec_Zero_OnboardMIC_record_and_SPK_playback.state exit 0 ---- -Ctrl X, Y and Enter to save and reboot your device for the settings to take effect: +Press `Ctrl+X`, then the `Y` key, then *Enter* to save. Reboot for the settings to take effect: +[source,console] ---- $ sudo reboot ---- If you are using your Raspberry Pi and Codec Zero in a headless environment, there is one final step required to make the Codec Zero the default audio device without access to the GUI audio settings on the desktop. We need to create a small file in your home folder: +[source,console] ---- $ sudo nano .asoundrc ---- @@ -138,13 +169,24 @@ pcm.!default { } ---- -Ctrl X, Y and Enter to save, and reboot once more to complete the configuration: +Press `Ctrl+X`, then the `Y` key, then *Enter* to save. Reboot once more to complete the configuration: + +Modern Linux distributions such as Raspberry Pi OS typically use PulseAudio or PipeWire for audio control. These frameworks are capable of mixing and switching audio from multiple sources. They provide a high-level API for audio applications to use. Many audio apps use these frameworks by default. + +Only create `~/.asoundrc` if an audio application needs to: + +* communicate directly with ALSA +* run in an environment where PulseAudio or PipeWire are not present + +This file can interfere with the UI's view of underlying audio resources. As a result, we do not recommend creating `~/.asoundrc` when running the Raspberry Pi OS desktop. +The UI may automatically clean up and remove this file if it exists. +[source,console] ---- $ sudo reboot ---- -=== Muting and unmuting the DigiAMP{plus} +=== Mute and unmute the DigiAMP{plus} The DigiAMP{plus} mute state is toggled by GPIO22 on Raspberry Pi. The latest audio device tree supports the unmute of the DigiAMP{plus} through additional parameters. @@ -153,12 +195,14 @@ Firstly a "one-shot" unmute when kernel module loads. For Raspberry Pi boards: +[source,ini] ---- dtoverlay=rpi-digiampplus,unmute_amp ---- For IQaudIO boards: +[source,ini] ---- dtoverlay=iqaudio-digiampplus,unmute_amp ---- @@ -169,12 +213,14 @@ window will cancel mute.) For Raspberry Pi boards: +[source,ini] ---- dtoverlay=rpi-digiampplus,auto_mute_amp ---- For IQaudIO boards: +[source,ini] ---- dtoverlay=iqaudio-digiampplus,auto_mute_amp ---- @@ -184,14 +230,16 @@ solution. The amp will start up muted. To unmute the amp: +[source,console] ---- $ sudo sh -c "echo 22 > /sys/class/gpio/export" $ sudo sh -c "echo out >/sys/class/gpio/gpio22/direction" $ sudo sh -c "echo 1 >/sys/class/gpio/gpio22/value" ---- -to mute the amp once more: +To mute the amp once more: +[source,console] ---- $ sudo sh -c "echo 0 >/sys/class/gpio/gpio22/value" ---- diff --git a/documentation/asciidoc/accessories/audio/dac_plus.adoc b/documentation/asciidoc/accessories/audio/dac_plus.adoc index 1d4324f10..dbef84b71 100644 --- a/documentation/asciidoc/accessories/audio/dac_plus.adoc +++ b/documentation/asciidoc/accessories/audio/dac_plus.adoc @@ -7,6 +7,7 @@ image::images/DAC+_Board_Diagram.jpg[width="80%"] A Texas Instruments PCM5122 is used in the DAC{plus} to deliver analogue audio to the phono connectors of the device. It also supports a dedicated headphone amplifier and is powered via the Raspberry Pi through the GPIO header. ==== Pinouts + [cols="1,12"] |=== | *P1* | Analogue out (0-2V RMS), carries GPIO27, MUTE signal (headphone detect), left and right diff --git a/documentation/asciidoc/accessories/audio/dac_pro.adoc b/documentation/asciidoc/accessories/audio/dac_pro.adoc index de360f443..2e8c444a5 100644 --- a/documentation/asciidoc/accessories/audio/dac_pro.adoc +++ b/documentation/asciidoc/accessories/audio/dac_pro.adoc @@ -11,6 +11,7 @@ dedicated headphone amplifier. The DAC Pro is powered by a Raspberry Pi through As part of the DAC Pro, two three-pin headers (P7/P9) are exposed above the Raspberry Pi's USB and Ethernet ports for use by the optional XLR board, allowing differential/balanced output. ==== Pinouts + [cols="1,12"] |=== | *P1* | Analogue out (0-2V RMS), carries GPIO27, MUTE signal (headphone detect), left and right @@ -22,8 +23,8 @@ audio and left and right ground. ==== Optional XLR Board -The Pi-DAC PRO exposes a 6 pin header used by the optional XLR board to provide Differential / Balanced output exposed by XLR sockets above the Pi’s USB/Ethernet ports. +The Pi-DAC PRO exposes a 6 pin header used by the optional XLR board to provide Differential / Balanced output exposed by XLR sockets above the Pi's USB/Ethernet ports. image::images/optional_xlr_board.jpg[width="80%"] -An XLR connector is used in Studio and some hi-end hifi systems. It can also be used to drive ACTIVE “monitor” speakers as used at discos or on stage. +An XLR connector is used in Studio and some hi-end hifi systems. It can also be used to drive ACTIVE "monitor" speakers as used at discos or on stage. diff --git a/documentation/asciidoc/accessories/audio/digiamp_plus.adoc b/documentation/asciidoc/accessories/audio/digiamp_plus.adoc index a2d816e9f..51347778e 100644 --- a/documentation/asciidoc/accessories/audio/digiamp_plus.adoc +++ b/documentation/asciidoc/accessories/audio/digiamp_plus.adoc @@ -6,7 +6,7 @@ DigiAMP{plus} uses the Texas Instruments TAS5756M PowerDAC and must be powered f image::images/DigiAMP+_Board_Diagram.jpg[width="80%"] -DigiAMP{plus}’s power in barrel connector is 5.5mm x 2.5mm. +DigiAMP{plus}'s power in barrel connector is 5.5mm × 2.5mm. At power-on, the amplifier is muted by default (the mute LED is illuminated). Software is responsible for the mute state and LED control (Raspberry Pi GPIO22). diff --git a/documentation/asciidoc/accessories/audio/getting_started.adoc b/documentation/asciidoc/accessories/audio/getting_started.adoc index 114b7c5eb..7efbd7f9a 100644 --- a/documentation/asciidoc/accessories/audio/getting_started.adoc +++ b/documentation/asciidoc/accessories/audio/getting_started.adoc @@ -1,6 +1,6 @@ == Getting started -=== Creating a toy chatter box +=== Create a toy chatter box As an example of what Raspberry Pi Audio Boards can do, let's walk through the creation of a toy chatter box. Its on-board microphone, programmable button and speaker driver make the Codec Zero an ideal choice for this application. @@ -16,22 +16,24 @@ image::images/Chatterbox_Labels.png[width="80%"] Use a small flat-head screwdriver to attach your speaker to the screw terminals. For the additional push button, solder the button wires directly to the Codec Zero pads as indicated, using GPIO pin 27 and Ground for the switch, and +3.3V and Ground for the LED, if necessary. -=== Setting up your Raspberry Pi +=== Set up your Raspberry Pi In this example, we are using Raspberry Pi OS Lite. Refer to our guide on xref:../computers/getting-started.adoc#installing-the-operating-system[installing Raspberry Pi OS] for more details. Make sure that you update your operating system before proceeding and follow the instructions provided for Codec Zero configuration, including the commands to enable the on-board microphone and speaker output. -=== Programming your Raspberry Pi +=== Program your Raspberry Pi Open a shell — for instance by connecting via SSH — on your Raspberry Pi and run the following to create our Python script: +[source,console] ---- $ sudo nano chatter_box.py ---- -Adding the following to the file: +Add the following to the file, replacing `` with your username: +[source,python] ---- #!/usr/bin/env python3 from gpiozero import Button @@ -48,18 +50,18 @@ print(f"{date}") # Make sure that the 'sounds' folder exists, and if it does not, create it -path = '/home/pi/sounds' +path = '/home//sounds' isExist = os.path.exists(path) if not isExist: os.makedirs(path) print("The new directory is created!") - os.system('chmod 777 -R /home/pi/sounds') + os.system('chmod 777 -R /home//sounds') # Download a 'burp' sound if it does not already exist -burp = '/home/pi/burp.wav' +burp = '/home//burp.wav' isExist = os.path.exists(burp) if not isExist: @@ -81,18 +83,18 @@ def released(): print("Released at %s after %.2f seconds" % (release_time, pressed_for)) if pressed_for < button.hold_time: print("This is a short press") - randomfile = random.choice(os.listdir("/home/pi/sounds/")) - file = '/home/pi/sounds/' + randomfile + randomfile = random.choice(os.listdir("/home//sounds/")) + file = '/home//sounds/' + randomfile os.system('aplay ' + file) elif pressed_for > 20: os.system('aplay ' + burp) print("Erasing all recorded sounds") - os.system('rm /home/pi/sounds/*'); + os.system('rm /home//sounds/*'); def held(): print("This is a long press") os.system('aplay ' + burp) - os.system('arecord --format S16_LE --duration=5 --rate 48000 -c2 /home/pi/sounds/$(date +"%d_%m_%Y-%H_%M_%S")_voice.m4a'); + os.system('arecord --format S16_LE --duration=5 --rate 48000 -c2 /home//sounds/$(date +"%d_%m_%Y-%H_%M_%S")_voice.m4a'); button.when_pressed = pressed button.when_released = released @@ -102,31 +104,33 @@ pause() ---- -Ctrl X, Y and Enter to save. To make the script executable, type the following: +Press `Ctrl+X`, then the `Y` key, then *Enter* to save. To make the script executable, type the following: +[source,console] ---- $ sudo chmod +x chatter_box.py ---- -Enter the following to create a crontab daemon that will automatically start the script each time the device is powered on: +Next, we need to create a crontab daemon that will automatically start the script each time the device is powered on. Run the following command to open your crontab for editing: +[source,console] ---- $ crontab -e ---- -You will be asked to select an editor; we recommend you use `nano`. Select it by entering the corresponding number, and press Enter to continue. The following line should be added to the bottom of the file: +You will be asked to select an editor; we recommend you use `nano`. Select it by entering the corresponding number, and press Enter to continue. The following line should be added to the bottom of the file, replacing `` with your username: ---- -@reboot python /home/pi/chatter_box.py +@reboot python /home//chatter_box.py ---- -Ctrl X, Y and Enter to save, then reboot your device. +Press *Ctrl X*, then *Y*, then *Enter* to save, then reboot your device with `sudo reboot`. -=== Operating your device +=== Use the toy chatter box The final step is to ensure that everything is operating as expected. Press the button and release it when you hear the burp. The recording will now begin for a period of five seconds. Once you have released the button, press it briefly again to hear the recording. Repeat this process as many times as you wish, and your sounds will be played at random. You can delete all recordings by pressing and holding the button, keeping the button pressed during the first burp and recording process, and releasing it after at least 20 seconds, at which point you will hear another burp sound confirming that the recordings have been deleted. -video::BjXERzu8nS0[youtube] +video::BjXERzu8nS0[youtube,width=80%,height=400px] === Next steps diff --git a/documentation/asciidoc/accessories/audio/hardware-info.adoc b/documentation/asciidoc/accessories/audio/hardware-info.adoc index 96766033e..240c9fd0f 100644 --- a/documentation/asciidoc/accessories/audio/hardware-info.adoc +++ b/documentation/asciidoc/accessories/audio/hardware-info.adoc @@ -39,7 +39,7 @@ If appropriate then the following are also used: === DAC PRO, DAC{plus}, DigiAMP{plus}, Codec Zero -image::images/pin_table_new.jpg[width="80%"] +image::images/all_audio_boards_gpio_pinouts.png[width="80%"] The DAC PRO, DAC{plus} and DigiAMP{plus} re-expose the Raspberry Pi signals, allowing additional sensors and peripherals to be added easily. Please note that some signals are for exclusive use (I2S and EEPROM) by some @@ -52,27 +52,30 @@ image::images/pin_out_new.jpg[width="80%"] To store the AlsaMixer settings, add the following at the command line: +[source,console] ---- $ sudo alsactl store ---- You can save the current state to a file, then reload that state at startup. -To save: +To save, run the following command, replacing `` with your username: +[source,console] ---- -$ sudo alsactl store -f /home/pi/usecase.state +$ sudo alsactl store -f /home//usecase.state ---- -To restore a saved file: +To restore a saved file, run the following command, replacing `` with your username: +[source,console] ---- -$ sudo alsactl restore -f /home/pi/usecase.state +$ sudo alsactl restore -f /home//usecase.state ---- === MPD-based audio with volume control -To allow Music Player Daemon (MPD)-based audio software to control the audio board’s built in volume, the file +To allow Music Player Daemon (MPD)-based audio software to control the audio board's built in volume, the file `/etc/mpd.conf` may need to be changed to support the correct AlsaMixer name. This can be achieved by ensuring the 'Audio output' section of `/etc/mpd.conf` has the 'mixer_control' diff --git a/documentation/asciidoc/accessories/audio/images/Chatter_Box.jpg b/documentation/asciidoc/accessories/audio/images/Chatter_Box.jpg index 7d7bfb0e0..b09c69521 100644 Binary files a/documentation/asciidoc/accessories/audio/images/Chatter_Box.jpg and b/documentation/asciidoc/accessories/audio/images/Chatter_Box.jpg differ diff --git a/documentation/asciidoc/accessories/audio/images/Chatterbox_Labels.png b/documentation/asciidoc/accessories/audio/images/Chatterbox_Labels.png index 7f54c5b97..379df111f 100644 Binary files a/documentation/asciidoc/accessories/audio/images/Chatterbox_Labels.png and b/documentation/asciidoc/accessories/audio/images/Chatterbox_Labels.png differ diff --git a/documentation/asciidoc/accessories/audio/images/Codec_Zero_Board_Diagram.png b/documentation/asciidoc/accessories/audio/images/Codec_Zero_Board_Diagram.png index 441453078..4e02bdedb 100644 Binary files a/documentation/asciidoc/accessories/audio/images/Codec_Zero_Board_Diagram.png and b/documentation/asciidoc/accessories/audio/images/Codec_Zero_Board_Diagram.png differ diff --git a/documentation/asciidoc/accessories/audio/images/DAC+_Board_Diagram.png b/documentation/asciidoc/accessories/audio/images/DAC+_Board_Diagram.png index afa6ed1d6..7a68f02c4 100644 Binary files a/documentation/asciidoc/accessories/audio/images/DAC+_Board_Diagram.png and b/documentation/asciidoc/accessories/audio/images/DAC+_Board_Diagram.png differ diff --git a/documentation/asciidoc/accessories/audio/images/DAC_Pro_Board_Diagram.png b/documentation/asciidoc/accessories/audio/images/DAC_Pro_Board_Diagram.png index 9cab3ed31..033ed5e1b 100644 Binary files a/documentation/asciidoc/accessories/audio/images/DAC_Pro_Board_Diagram.png and b/documentation/asciidoc/accessories/audio/images/DAC_Pro_Board_Diagram.png differ diff --git a/documentation/asciidoc/accessories/audio/images/DigiAMP+_Board_Diagram.png b/documentation/asciidoc/accessories/audio/images/DigiAMP+_Board_Diagram.png index 7c6411100..e4f2b336b 100644 Binary files a/documentation/asciidoc/accessories/audio/images/DigiAMP+_Board_Diagram.png and b/documentation/asciidoc/accessories/audio/images/DigiAMP+_Board_Diagram.png differ diff --git a/documentation/asciidoc/accessories/audio/images/all_audio_boards_gpio_pinouts.png b/documentation/asciidoc/accessories/audio/images/all_audio_boards_gpio_pinouts.png new file mode 100644 index 000000000..48783e9cd Binary files /dev/null and b/documentation/asciidoc/accessories/audio/images/all_audio_boards_gpio_pinouts.png differ diff --git a/documentation/asciidoc/accessories/audio/images/dac_plus.png b/documentation/asciidoc/accessories/audio/images/dac_plus.png index 6c3ad6455..61154d683 100644 Binary files a/documentation/asciidoc/accessories/audio/images/dac_plus.png and b/documentation/asciidoc/accessories/audio/images/dac_plus.png differ diff --git a/documentation/asciidoc/accessories/audio/images/optional_xlr_board.jpg b/documentation/asciidoc/accessories/audio/images/optional_xlr_board.jpg index 7e6e85d4e..526b1c2d5 100644 Binary files a/documentation/asciidoc/accessories/audio/images/optional_xlr_board.jpg and b/documentation/asciidoc/accessories/audio/images/optional_xlr_board.jpg differ diff --git a/documentation/asciidoc/accessories/audio/images/pin_table_new.jpg b/documentation/asciidoc/accessories/audio/images/pin_table_new.jpg deleted file mode 100644 index b9ca1a8bc..000000000 Binary files a/documentation/asciidoc/accessories/audio/images/pin_table_new.jpg and /dev/null differ diff --git a/documentation/asciidoc/accessories/audio/images/wiring.jpg b/documentation/asciidoc/accessories/audio/images/wiring.jpg index 5481ce90c..3a22c834b 100644 Binary files a/documentation/asciidoc/accessories/audio/images/wiring.jpg and b/documentation/asciidoc/accessories/audio/images/wiring.jpg differ diff --git a/documentation/asciidoc/accessories/audio/images/write_protect_tabs.jpg b/documentation/asciidoc/accessories/audio/images/write_protect_tabs.jpg index 5da7d0723..91e2f65f1 100644 Binary files a/documentation/asciidoc/accessories/audio/images/write_protect_tabs.jpg and b/documentation/asciidoc/accessories/audio/images/write_protect_tabs.jpg differ diff --git a/documentation/asciidoc/accessories/audio/introduction.adoc b/documentation/asciidoc/accessories/audio/introduction.adoc index 935b10087..01abb4690 100644 --- a/documentation/asciidoc/accessories/audio/introduction.adoc +++ b/documentation/asciidoc/accessories/audio/introduction.adoc @@ -5,6 +5,7 @@ Raspberry Pi Audio Boards bring high quality audio to your existing hi-fi or Ras Each board has a specific purpose and set of features. The highest audio quality playback is available from our DAC PRO, DAC{plus} and DigiAMP{plus} boards, which support up to full HD audio (192kHz); while the Codec Zero supports up to HD audio (96kHz) and includes a built-in microphone, making it ideal for compact projects. === Features at a glance + [cols="2,1,1,1,1,1,1,1,1,1"] |=== | | *Line out* | *Balanced out* | *Stereo speakers* | *Mono speaker* | *Headphones* | *Aux in* | *Aux out* | *Ext mic* | *Built-in mic* diff --git a/documentation/asciidoc/accessories/audio/update-firmware.adoc b/documentation/asciidoc/accessories/audio/update-firmware.adoc index 93acd9c41..d5a16fdb9 100644 --- a/documentation/asciidoc/accessories/audio/update-firmware.adoc +++ b/documentation/asciidoc/accessories/audio/update-firmware.adoc @@ -2,7 +2,7 @@ Raspberry Pi Audio Boards use an EEPROM that contains information that is used by the host Raspberry Pi device to select the appropriate driver at boot time. This information is programmed into the EEPROM during manufacture. There are some circumstances where the end user may wish to update the EEPROM contents: this can be done from the command line. -IMPORTANT: Before proceeding, you should update the Raspberry Pi OS running on your Raspberry Pi to the latest version. +IMPORTANT: Before proceeding, update the version of Raspberry Pi OS running on your Raspberry Pi to the latest version. === The EEPROM write-protect link @@ -12,29 +12,30 @@ image::images/write_protect_tabs.jpg[width="80%"] NOTE: In some cases the two pads may already have a 0Ω resistor fitted to bridge the write-protect link, as illustrated in the picture of the Codec Zero board above. -=== EEPROM Programming +=== Program the EEPROM Once the write-protect line has been pulled down, the EEPROM can be programmed. You should first install the utilities and then run the programmer. Open up a terminal window and type the following: +[source,console] ---- $ sudo apt update $ sudo apt install rpi-audio-utils $ sudo rpi-audio-flash ---- -After starting you will be presented with a warning screen. +After starting, you will see a warning screen. image::images/firmware-update/warning.png[] -Selecting "Yes" to proceed will present you with a menu allowing you to select your hardware. +Select "Yes" to proceed. You should see a menu where you can select your hardware. image::images/firmware-update/select.png[] NOTE: If no HAT is present, or if the connected HAT is not a Raspberry Pi Audio board, you will be presented with an error screen. If the firmware has already been updated on the board, a message will be displayed informing you that you do not have to continue. -After selecting the correct hardware a screen will display while the new firmware is flashed to the HAT. +After selecting the hardware, a screen will display while the new firmware is flashed to the HAT. image::images/firmware-update/flashing.png[] @@ -42,5 +43,5 @@ Afterwards a screen will display telling you that the new firmware has installed image::images/firmware-update/flashed.png[] -NOTE: If the firmware fails to install correctly, an error screen will be displayed. In the first instance you should remove and reseat the HAT board and try flashing the firmware again. +NOTE: If the firmware fails to install correctly, you will see an error screen. Try removing and reseating the HAT, then flash the firmware again. diff --git a/documentation/asciidoc/accessories/build-hat.adoc b/documentation/asciidoc/accessories/build-hat.adoc index fcfc20065..472c939c4 100644 --- a/documentation/asciidoc/accessories/build-hat.adoc +++ b/documentation/asciidoc/accessories/build-hat.adoc @@ -29,4 +29,3 @@ include::build-hat/links-to-other.adoc[] include::build-hat/compat.adoc[] include::build-hat/mech.adoc[] - diff --git a/documentation/asciidoc/accessories/build-hat/images/blinking-light.gif b/documentation/asciidoc/accessories/build-hat/images/blinking-light.gif deleted file mode 100644 index 401912503..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/blinking-light.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/blinking-light.webm b/documentation/asciidoc/accessories/build-hat/images/blinking-light.webm new file mode 100644 index 000000000..12ecb8a3b Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/blinking-light.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/images/connect-motor.gif b/documentation/asciidoc/accessories/build-hat/images/connect-motor.gif deleted file mode 100644 index 197a87cc8..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/connect-motor.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/connect-motor.webm b/documentation/asciidoc/accessories/build-hat/images/connect-motor.webm new file mode 100644 index 000000000..70da88129 Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/connect-motor.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.gif b/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.gif deleted file mode 100644 index f1cac0bf3..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.webm b/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.webm new file mode 100644 index 000000000..8d64b6817 Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/fitting-build-hat.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.gif b/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.gif deleted file mode 100644 index e065f39b2..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.webm b/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.webm new file mode 100644 index 000000000..e358683f9 Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/powering-build-hat.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/images/setting-up.png b/documentation/asciidoc/accessories/build-hat/images/setting-up.png old mode 100755 new mode 100644 index 8964b0e44..e69d97a3c Binary files a/documentation/asciidoc/accessories/build-hat/images/setting-up.png and b/documentation/asciidoc/accessories/build-hat/images/setting-up.png differ diff --git a/documentation/asciidoc/accessories/build-hat/images/tall-headers.png b/documentation/asciidoc/accessories/build-hat/images/tall-headers.png index 58eff7352..cf89aa68e 100644 Binary files a/documentation/asciidoc/accessories/build-hat/images/tall-headers.png and b/documentation/asciidoc/accessories/build-hat/images/tall-headers.png differ diff --git a/documentation/asciidoc/accessories/build-hat/images/turning-motor.gif b/documentation/asciidoc/accessories/build-hat/images/turning-motor.gif deleted file mode 100644 index 71b7b0c06..000000000 Binary files a/documentation/asciidoc/accessories/build-hat/images/turning-motor.gif and /dev/null differ diff --git a/documentation/asciidoc/accessories/build-hat/images/turning-motor.webm b/documentation/asciidoc/accessories/build-hat/images/turning-motor.webm new file mode 100644 index 000000000..334b43eae Binary files /dev/null and b/documentation/asciidoc/accessories/build-hat/images/turning-motor.webm differ diff --git a/documentation/asciidoc/accessories/build-hat/introduction.adoc b/documentation/asciidoc/accessories/build-hat/introduction.adoc index ca59abdf1..297dd957b 100644 --- a/documentation/asciidoc/accessories/build-hat/introduction.adoc +++ b/documentation/asciidoc/accessories/build-hat/introduction.adoc @@ -1,6 +1,9 @@ -== Introducing the Build HAT +[[about-build-hat]] +== About -The https://raspberrypi.com/products/build-hat[Raspberry Pi Build HAT] is an add-on board that connects to the 40-pin GPIO header of your Raspberry Pi, which was designed in collaboration with LEGO® Education to make it easy to control LEGO® Technic™ motors and sensors with Raspberry Pi computers. +The https://raspberrypi.com/products/build-hat[Raspberry Pi Build HAT] is an add-on board that connects to the 40-pin GPIO header of your Raspberry Pi, which was designed in collaboration with LEGO® Education to make it easy to control LEGO® Technic™ motors and sensors with Raspberry Pi computers. + +WARNING: The Raspberry Pi Build HAT is not yet supported by Raspberry Pi OS Trixie. To use the Build HAT, install or stay on Raspberry Pi OS Bookworm for now. image::images/build-hat.jpg[width="80%"] @@ -8,7 +11,7 @@ NOTE: A full list of supported devices can be found in the xref:build-hat.adoc#d It provides four connectors for LEGO® Technic™ motors and sensors from the SPIKE™ Portfolio. The available sensors include a distance sensor, a colour sensor, and a versatile force sensor. The angular motors come in a range of sizes and include integrated encoders that can be queried to find their position. -The Build HAT fits all Raspberry Pi computers with a 40-pin GPIO header, including — with the addition of a ribbon cable or other extension device — Raspberry Pi 400. Connected LEGO® Technic™ devices can easily be controlled in Python, alongside standard Raspberry Pi accessories such as a camera module. +The Build HAT fits all Raspberry Pi computers with a 40-pin GPIO header, including, with the addition of a ribbon cable or other extension device, Keyboard-series devices. Connected LEGO® Technic™ devices can easily be controlled in Python, alongside standard Raspberry Pi accessories such as a camera module. The Raspberry Pi Build HAT power supply (PSU), which is https://raspberrypi.com/products/build-hat-power-supply[available separately], is designed to power both the Build HAT and Raspberry Pi computer along with all connected LEGO® Technic™ devices. @@ -16,15 +19,15 @@ image::images/psu.jpg[width="80%"] The LEGO® Education SPIKE™ Prime Set 45678 and SPIKE™ Prime Expansion Set 45681, available separately from LEGO® Education resellers, include a collection of useful elements supported by the Build HAT. -NOTE: The HAT works with all 40-pin GPIO Raspberry Pi boards, including Raspberry Pi 4 and Raspberry Pi Zero. With the addition of a ribbon cable or other extension device, it can also be used with Raspberry Pi 400. +NOTE: The HAT works with all 40-pin GPIO Raspberry Pi boards, including Zero-series devices. With the addition of a ribbon cable or other extension device, it can also be used with Keyboard-series devices. * Controls up to 4 LEGO® Technic™ motors and sensors included in the SPIKE™ Portfolio * Easy-to-use https://buildhat.readthedocs.io/[Python library] to control your LEGO® Technic™ devices * Fits onto any Raspberry Pi computer with a 40-pin GPIO header -* Onboard xref:../microcontrollers/rp2040.adoc[RP2040] microcontroller manages low-level control of LEGO® Technic™ devices +* Onboard xref:../microcontrollers/silicon.adoc[RP2040] microcontroller manages low-level control of LEGO® Technic™ devices * External 8V PSU https://raspberrypi.com/products/build-hat-power-supply[available separately] to power both Build HAT and Raspberry Pi [NOTE] ==== -The Build HAT can not power the Raspberry Pi 400 as it does not support being powered via the GPIO headers. +The Build HAT cannot power Keyboard-series devices, since they do not support power supply over the GPIO headers. ==== diff --git a/documentation/asciidoc/accessories/build-hat/net-brick.adoc b/documentation/asciidoc/accessories/build-hat/net-brick.adoc index 32a14a8c5..f5f42ad8c 100644 --- a/documentation/asciidoc/accessories/build-hat/net-brick.adoc +++ b/documentation/asciidoc/accessories/build-hat/net-brick.adoc @@ -1,17 +1,17 @@ -=== Using the Build HAT from .NET +=== Use the Build HAT from .NET The Raspberry Pi Built HAT is referred to "Brick" in LEGO® parlance and you can talk directly to it from .NET using the https://datasheets.raspberrypi.com/build-hat/build-hat-serial-protocol.pdf[Build HAT Serial Protocol]. You can create a `brick` object as below, -[csharp] +[source,csharp] ---- Brick brick = new("/dev/serial0"); ---- but you need to remember to dispose of the `brick` at the end of your code. -[csharp] +[source,csharp] ---- brick.Dispose(); ---- @@ -20,18 +20,18 @@ WARNING: If you do not call `brick.Dispose()` your program will not terminate. If you want to avoid calling `brick.Dispose` at the end, then create your brick with the `using` statement: -[csharp] +[source,csharp] ---- using Brick brick = new("/dev/serial0"); ---- In this case, when reaching the end of the program, your brick will be automatically disposed. -==== Displaying the information +==== Display Build HAT information You can gather the various software versions, the signature, and the input voltage: -[csharp] +[source,csharp] ---- var info = brick.BuildHatInformation; Console.WriteLine($"version: {info.Version}, firmware date: {info.FirmwareDate}, signature:"); @@ -45,7 +45,7 @@ NOTE: The input voltage is read only once at boot time and is not read again aft The functions `GetSensorType`, `GetSensor` will allow you to retrieve any information on connected sensor. -[csharp] +[source,csharp] ---- SensorType sensor = brick.GetSensorType((SensorPort)i); Console.Write($"Port: {i} {(Brick.IsMotor(sensor) ? "Sensor" : "Motor")} type: {sensor} Connected: "); @@ -53,7 +53,7 @@ Console.Write($"Port: {i} {(Brick.IsMotor(sensor) ? "Sensor" : "Motor")} type: { In this example, you can as well use the `IsMotor` static function to check if the connected element is a sensor or a motor. -[csharp] +[source,csharp] ---- if (Brick.IsActiveSensor(sensor)) { @@ -72,9 +72,9 @@ else Most sensors implements events on their special properties. You can simply subscribe to `PropertyChanged` and `PropertyUpdated`. The changed one will be fired when the value is changing while the updated one when there is a success update to the property. Depending on the modes used, some properties may be updated in the background all the time while some others occasionally. -You may be interested only when a color is changing or the position of the motor is changing, using it as a tachometer. In this case, the `PropertyChanged` is what you need! +You may be interested only when a colour is changing or the position of the motor is changing, using it as a tachometer. In this case, the `PropertyChanged` is what you need! -[csharp] +[source,csharp] ---- Console.WriteLine("Move motor on Port A to more than position 100 to stop this test."); brick.WaitForSensorToConnect(SensorPort.PortA); @@ -102,11 +102,11 @@ void MotorPropertyEvent(object? sender, PropertyChangedEventArgs e) } ---- -==== Waiting for initialization +==== Wait for initialization The brick can take a long time before it initializes. A wait for a sensor to be connected has been implemented. -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortB); ---- diff --git a/documentation/asciidoc/accessories/build-hat/net-installing-software.adoc b/documentation/asciidoc/accessories/build-hat/net-installing-software.adoc index f0bfe12b3..0c9330e0b 100644 --- a/documentation/asciidoc/accessories/build-hat/net-installing-software.adoc +++ b/documentation/asciidoc/accessories/build-hat/net-installing-software.adoc @@ -1,43 +1,43 @@ -== Using the Build HAT from .NET +== Use the Build HAT from .NET -=== Installing the .NET Framework +=== Install the .NET Framework The .NET framework from Microsoft is not available via `apt` on Raspberry Pi. However, you can follow the https://docs.microsoft.com/en-us/dotnet/iot/deployment[official instructions] from Microsoft to install the .NET framework. Alternatively, there is a simplified https://www.petecodes.co.uk/install-and-use-microsoft-dot-net-5-with-the-raspberry-pi/[third party route] to get the .NET toolchain on to your Raspberry Pi. WARNING: The installation script is run as `root`. You should read it first and make sure you understand what it is doing. If you are at all unsure you should follow the https://docs.microsoft.com/en-us/dotnet/iot/deployment[official instructions] manually. -[.bash] +[source,console] ---- $ wget -O - https://raw.githubusercontent.com/pjgpetecodes/dotnet5pi/master/install.sh | sudo bash ---- After installing the .NET framework you can create your project: -[.bash] +[source,console] ---- $ dotnet new console --name buildhat ---- This creates a default program in the `buildhat` subdirectory, and we need to be in that directory in order to continue: -[.bash] +[source,console] ---- $ cd buildhat ---- You will now need to install the following nuget packages: -[.bash] + +[source,console] ---- $ dotnet add package System.Device.Gpio --version 2.1.0 $ dotnet add package Iot.Device.Bindings --version 2.1.0 ---- -=== Running C# Code +=== Run C# Code -You can run the program with the `dotnet run` command. Let's try it now to make sure everything works. -It should print "Hello World!" +You can run the program with the `dotnet run` command. Let's try it now to make sure everything works. It should print "Hello World!" -[.bash] +[source,console] ---- $ dotnet run Hello World! @@ -45,7 +45,8 @@ Hello World! (When instructed to "run the program" in the instructions that follow, you will simply rerun `dotnet run`) -=== Editing C# Code +=== Edit C# Code + In the instructions below, you will be editing the file `buildhat/Program.cs`, the C# program which was generated when you ran the above commands. Any text editor will work to edit C# code, including Geany, the IDE/Text Editor that comes pre-installed. https://code.visualstudio.com/docs/setup/raspberry-pi/[Visual Studio Code] (often called "VS Code") is also a popular alternative. diff --git a/documentation/asciidoc/accessories/build-hat/net-motors.adoc b/documentation/asciidoc/accessories/build-hat/net-motors.adoc index 3945ff203..9e9d9ab54 100644 --- a/documentation/asciidoc/accessories/build-hat/net-motors.adoc +++ b/documentation/asciidoc/accessories/build-hat/net-motors.adoc @@ -1,10 +1,10 @@ -=== Using Motors from .NET +=== Use Motors from .NET There are two types of motors, the *passive* ones and the *active* ones. Active motors will provide detailed position, absolute position and speed while passive motors can only be controlled with speed. A common set of functions to control the speed of the motors are available. There are 2 important ones: `SetPowerLimit` and `SetBias`: -[csharp] +[source,csharp] ---- train.SetPowerLimit(1.0); train.SetBias(0.2); @@ -25,7 +25,7 @@ The typical passive motor is a train and older Powered Up motors. The `Speed` pr Functions to control `Start`, `Stop` and `SetSpeed` are also available. Here is an example of how to use it: -[csharp] +[source,csharp] ---- Console.WriteLine("This will run the motor for 20 secondes incrementing the PWM"); train.SetPowerLimit(1.0); @@ -60,7 +60,7 @@ Active motors have `Speed`, `AbsolutePosition`, `Position` and `TargetSpeed` as The code snippet shows how to get the motors, start them and read the properties: -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortA); brick.WaitForSensorToConnect(SensorPort.PortD); @@ -86,11 +86,11 @@ active.Stop(); active2.Stop(); ---- -NOTE: You should not forget to start and stop your motors when needed. +NOTE: Don't forget to start and stop your motors when needed. Advance features are available for active motors. You can request to move for seconds, to a specific position, a specific absolute position. Here are couple of examples: -[csharp] +[source,csharp] ---- // From the previous example, this will turn the motors back to their initial position: active.TargetSpeed = 100; @@ -103,7 +103,7 @@ active2.MoveToPosition(0, true); Each function allow you to block or not the thread for the time the operation will be performed. Note that for absolute and relative position moves, there is a tolerance of few degrees. -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortA); var active = (ActiveMotor)brick.GetMotor(SensorPort.PortA); diff --git a/documentation/asciidoc/accessories/build-hat/net-sensors.adoc b/documentation/asciidoc/accessories/build-hat/net-sensors.adoc index c8d6d72e8..d6e6284f4 100644 --- a/documentation/asciidoc/accessories/build-hat/net-sensors.adoc +++ b/documentation/asciidoc/accessories/build-hat/net-sensors.adoc @@ -1,12 +1,12 @@ -=== Using Sensors from .NET +=== Use Sensors from .NET -Like for motors, you have active and passive sensors. Most recent sensors are active. The passive one are lights and simple buttons. Active ones are distance or color sensors, as well as small 3x3 pixel displays. +Like for motors, you have active and passive sensors. Most recent sensors are active. The passive one are lights and simple buttons. Active ones are distance or colour sensors, as well as small 3×3 pixel displays. ==== Button/Touch Passive Sensor The button/touch passive sensor have one specific property `IsPressed`. The property is set to true when the button is pressed. Here is a complete example with events: -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortA); var button = (ButtonSensor)brick.GetSensor(SensorPort.PortA); @@ -39,7 +39,7 @@ image::images/passive-light.png[Passive light, width="60%"] The passive light are the train lights. They can be switched on and you can controlled their brightness. -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortA); var light = (PassiveLight)brick.GetSensor(SensorPort.PortA); @@ -55,9 +55,9 @@ light.Off() ==== Active Sensor -The active sensor class is a generic one that all the active sensor heritate including active motors. They contains a set of properties regarding how they are connected to the Build HAT, the modes, the detailed combi modes, the hardware, software versions and a specific property called `ValueAsString`. The value as string contains the last measurement as a collection of strings. A measurement arrives like `P0C0: +23 -42 0`, the enumeration will contains `P0C0:`, `+23`, `-42` and `0`. This is made so if you are using advance modes and managing yourself the combi modes and commands, you'll be able to get the measurements. +The active sensor class is a generic one that all the active sensor inherit including active motors. They contains a set of properties regarding how they are connected to the Build HAT, the modes, the detailed Combi modes, the hardware, software versions and a specific property called `ValueAsString`. The value as string contains the last measurement as a collection of strings. A measurement arrives like `P0C0: +23 -42 0`, the enumeration will contains `P0C0:`, `+23`, `-42` and `0`. This is made so if you are using advance modes and managing yourself the Combi modes and commands, you'll be able to get the measurements. -All active sensor can run a specific measurement mode or a combi mode. You can setup one through the advance mode using the `SelectModeAndRead` and `SelectCombiModesAndRead` functions with the specific mode(s) you'd like to continuously have. It is important to understand that changing the mode or setting up a new mode will stop the previous mode. +All active sensor can run a specific measurement mode or a Combi mode. You can setup one through the advance mode using the `SelectModeAndRead` and `SelectCombiModesAndRead` functions with the specific mode(s) you'd like to continuously have. It is important to understand that changing the mode or setting up a new mode will stop the previous mode. The modes that can be combined in the Combi mode are listed in the `CombiModes` property. Al the properties of the sensors will be updated automatically when you'll setup one of those modes. @@ -70,7 +70,7 @@ WeDo Tilt Sensor has a special `Tilt` property. The type is a point with X is th You can set a continuous measurement for this sensor using the `ContinuousMeasurement` property. -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortA); var tilt = (WeDoTiltSensor)brick.GetSensor(SensorPort.PortA); @@ -89,9 +89,9 @@ while(!console.KeyAvailable) .WeDo Distance sensor, https://www.bricklink.com/v2/catalog/catalogitem.page?S=45304-1&name=WeDo%202.0%20Motion%20Sensor&category=%5BEducational%20&%20Dacta%5D%5BWeDo%5D#T=S&O={%22iconly%22:0}[Image from Bricklink] image::images/wedo-distance.png[WeDo Distance sensor, width="60%"] -WeDo Distance Sensor gives you a distance in millimeters with the Distance property. +WeDo Distance Sensor gives you a distance in millimetres with the Distance property. -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortA); var distance = (WeDoDistanceSensor)brick.GetSensor(SensorPort.PortA); @@ -110,7 +110,7 @@ image::images/spike-force.png[spike force sensor, width="60%"] This force sensor measure the pressure applies on it and if it is pressed. The two properties can be access through `Force` and `IsPressed` properties. -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortA); var force = (ForceSensor)brick.GetSensor(SensorPort.PortA); @@ -122,14 +122,14 @@ while(!force.IsPressed) } ---- -==== SPIKE Essential 3x3 Color Light Matrix +==== SPIKE Essential 3×3 Colour Light Matrix -.spike 3x3 matrix, https://www.bricklink.com/v2/catalog/catalogitem.page?P=45608c01&name=Electric,%203%20x%203%20Color%20Light%20Matrix%20-%20SPIKE%20Prime&category=%5BElectric%5D#T=C[Image from Bricklink] -image::images/3x3matrix.png[spike 3x3 matrix, width="60%"] +.spike 3×3 matrix, https://www.bricklink.com/v2/catalog/catalogitem.page?P=45608c01&name=Electric,%203%20x%203%20Color%20Light%20Matrix%20-%20SPIKE%20Prime&category=%5BElectric%5D#T=C[Image from Bricklink] +image::images/3x3matrix.png[spike 3×3 matrix, width="60%"] -This is a small 3x3 display with 9 different leds that can be controlled individually. The class exposes functions to be able to control the screen. Here is an example using them: +This is a small 3×3 display with 9 different LEDs that can be controlled individually. The class exposes functions to be able to control the screen. Here is an example using them: -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortA); var matrix = (ColorLightMatrix)brick.GetSensor(SensorPort.PortA); @@ -154,23 +154,23 @@ Span col = stackalloc LedColor[9] { LedColor.White, LedColor.White, Le matrix.DisplayColorPerPixel(brg, col); ---- -==== SPIKE Prime Color Sensor and Color and Distance Sensor +==== SPIKE Prime Colour Sensor and Colour and Distance Sensor -SPIKE color sensor: +SPIKE colour sensor: -.spike color sensor, https://www.bricklink.com/v2/catalog/catalogitem.page?P=37308c01&name=Electric%20Sensor,%20Color%20-%20Spike%20Prime&category=%5BElectric%5D#T=C&C=11[Image from Bricklink] +.spike colour sensor, https://www.bricklink.com/v2/catalog/catalogitem.page?P=37308c01&name=Electric%20Sensor,%20Color%20-%20Spike%20Prime&category=%5BElectric%5D#T=C&C=11[Image from Bricklink] image::images/spike-color.png[spike color sensor, width="60%"] -Color and distance sensor: +Colour and distance sensor: .Color distance sensor, https://www.bricklink.com/v2/catalog/catalogitem.page?P=bb0891c01&name=Electric%20Sensor,%20Color%20and%20Distance%20-%20Boost&category=%5BElectric%5D#T=C&C=1[Image from Bricklink] -image::images/color-distance.png[Color distance sensor, width="60%"] +image::images/color-distance.png[Colour distance sensor, width="60%"] -Those color sensor has multiple properties and functions. You can get the `Color`, the `ReflectedLight` and the `AmbiantLight`. +Those colour sensor has multiple properties and functions. You can get the `Color`, the `ReflectedLight` and the `AmbiantLight`. -On top of this, the Color and Distance sensor can measure the `Distance` and has an object `Counter`. It will count automatically the number of objects which will go in and out of the range. This does allow to count objects passing in front of the sensor. The distance is limited from 0 to 10 centimeters. +On top of this, the Colour and Distance sensor can measure the `Distance` and has an object `Counter`. It will count automatically the number of objects which will go in and out of the range. This does allow to count objects passing in front of the sensor. The distance is limited from 0 to 10 centimetres. -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortC); @@ -191,16 +191,16 @@ while (!Console.KeyAvailable) } ---- -NOTE: For better measurement, it is not recommended to change the measurement mode in a very fast way, the color integration may not be done in a proper way. This example gives you the full spectrum of what you can do with the sensor. Also, this class do not implement a continuous measurement mode. You can setup one through the advance mode using the `SelectModeAndRead` function with the specific mode you'd like to continuously have. It is important to understand that changing the mode or setting up a new mode will stop the previous mode. +NOTE: For better measurement, it is not recommended to change the measurement mode in a very fast way, the colour integration may not be done in a proper way. This example gives you the full spectrum of what you can do with the sensor. Also, this class do not implement a continuous measurement mode. You can setup one through the advance mode using the `SelectModeAndRead` function with the specific mode you'd like to continuously have. It is important to understand that changing the mode or setting up a new mode will stop the previous mode. ==== SPIKE Prime Ultrasonic Distance Sensor -.spike distance sensor, https://www.bricklink.com/v2/catalog/catalogitem.page?P=37316c01&name=Electric%20Sensor,%20Distance%20-%20Spike%20Prime&category=%5BElectric%5D#T=C&C=11[Image from Bricklink] -image::images/spike-distance.png[spike distance sensor, width="60%"] +.Spike distance sensor, https://www.bricklink.com/v2/catalog/catalogitem.page?P=37316c01&name=Electric%20Sensor,%20Distance%20-%20Spike%20Prime&category=%5BElectric%5D#T=C&C=11[Image from Bricklink] +image::images/spike-distance.png[Spike distance sensor, width="60%"] -This is a distance sensor and it does implement a `Distance` property that will give the distance in millimeter. A `ContinuousMeasurement` mode is also available on this one. +This is a distance sensor and it does implement a `Distance` property that will give the distance in millimetre. A `ContinuousMeasurement` mode is also available on this one. -[csharp] +[source,csharp] ---- brick.WaitForSensorToConnect(SensorPort.PortA); var distance = (UltrasonicDistanceSensor)brick.GetSensor(SensorPort.PortA); diff --git a/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc b/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc index f535b5971..824d67d74 100644 --- a/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc +++ b/documentation/asciidoc/accessories/build-hat/preparing-build-hat.adoc @@ -1,10 +1,10 @@ -== Preparing your Build HAT +== Prepare your Build HAT NOTE: Before starting to work with your Raspberry Pi Build HAT you should xref:../computers/getting-started.adoc#setting-up-your-raspberry-pi[set up] your Raspberry Pi, xref:../computers/getting-started.adoc#installing-the-operating-system[install] the latest version of the operating system using https://www.raspberrypi.com/downloads/[Raspberry Pi Imager]. -Attach 9mm spacers to the bottom of the board. Seat the Raspberry Pi Build HAT onto your Raspberry Pi. Make sure you put it on the right way up. Unlike other HATs, all the components are on the bottom, leaving room for a breadboard or LEGO® elements on top. +Attach 9mm spacers to the bottom of the board. Seat the Raspberry Pi Build HAT onto your Raspberry Pi. Make sure you put it on the right way up. Unlike other HATs, all the components are on the bottom, leaving room for a breadboard or LEGO® elements on top. -image::images/fitting-build-hat.gif[width="80%"] +video::images/fitting-build-hat.webm[width="80%"] === Access the GPIO Pins @@ -18,30 +18,30 @@ The following pins are used by the Build HAT itself and you should not connect a [cols="^1,^1,^1", width="75%", options="header"] |=== | GPIO| Use | Status -| GPIO0/1 | ID prom | -| GPIO4| Reset | -| GPIO14| Tx | -| GPIO15| Rx | +| GPIO0/1 | ID prom | +| GPIO4| Reset | +| GPIO14| Tx | +| GPIO15| Rx | | GPIO16 | RTS | unused | GPIO17 | CTS | unused |=== -=== Setting up your Raspberry Pi +=== Set up your Raspberry Pi -Once the Raspberry Pi has booted, open the Raspberry Pi Configuration tool by clicking on the Raspberry Menu button and then selecting “Preferences” and then “Raspberry Pi Configuration”. +Once the Raspberry Pi has booted, open the Control Centre tool by selecting the Raspberry Menu button and then selecting **Preferences > Control Centre**. -Click on the “interfaces” tab and adjust the Serial settings as shown below: +Select the **Interfaces** tab and adjust the serial settings as shown in the following image: -image::images/setting-up.png[width="50%"] +image::images/setting-up.png["The Interfaces tab. SSH, VNC, and Serial Port are enabled. The rest of the options are not enabled.", width="50%"] -==== Using your Raspberry Pi Headless +==== Use your Raspberry Pi headless -If you are running your Raspberry Pi headless and using `raspi-config`, select “Interface Options” from the first menu. +If you are running your Raspberry Pi headless and using `raspi-config`, select "Interface Options" from the first menu. image::images/raspi-config-1.png[width="70%"] -Then “P6 Serial Port”. +Then "P6 Serial Port". image::images/raspi-config-2.png[width="70%"] @@ -59,20 +59,20 @@ image::images/raspi-config-5.png[width="70%"] You will need to reboot at this point if you have made any changes. -=== Powering the Build HAT +=== Power the Build HAT -Connect an external power supply — the https://raspberrypi.com/products/build-hat-power-supply[official Raspberry Pi Build HAT power supply] is recommended — however any reliable +8V±10% power supply capable of supplying 48W via a DC 5521 centre positive barrel connector (5.5mm × 2.1mm × 11mm) will power the Build HAT. You don’t need to connect an additional USB power supply to the Raspberry Pi as well, unless you are using a Raspberry Pi 400. +Connect an external power supply — the https://raspberrypi.com/products/build-hat-power-supply[official Raspberry Pi Build HAT power supply] is recommended — however any reliable +8V±10% power supply capable of supplying 48W via a DC 5521 centre positive barrel connector (5.5mm × 2.1mm × 11mm) will power the Build HAT. You don't need to connect an additional USB power supply to the Raspberry Pi unless you are using a Keyboard-series device. [NOTE] ==== -The Build HAT can not power the Raspberry Pi 400 as it does not support being powered via the GPIO headers. +The Build HAT cannot power Keyboard-series devices, since they do not support power supply over the GPIO headers. ==== -image::images/powering-build-hat.gif[width="80%"] +video::images/powering-build-hat.webm[width="80%"] [NOTE] ==== -The LEGO® Technic™ motors are very powerful; so to drive them you’ll need an external 8V power supply. If you want to read from motor encoders and the SPIKE™ force sensor, you can power your Raspberry Pi and Build HAT the usual way, via your Raspberry Pi’s USB power socket. The SPIKE™ colour and distance sensors, like the motors, require an https://raspberrypi.com/products/build-hat-power-supply[external power supply]. +The LEGO® Technic™ motors are very powerful; so to drive them you'll need an external 8V power supply. If you want to read from motor encoders and the SPIKE™ force sensor, you can power your Raspberry Pi and Build HAT the usual way, via your Raspberry Pi's USB power socket. The SPIKE™ colour and distance sensors, like the motors, require an https://raspberrypi.com/products/build-hat-power-supply[external power supply]. ==== You have the choice to use Build HAT with Python or .NET. diff --git a/documentation/asciidoc/accessories/build-hat/py-installing-software.adoc b/documentation/asciidoc/accessories/build-hat/py-installing-software.adoc index 34c012a17..b9a93f8be 100644 --- a/documentation/asciidoc/accessories/build-hat/py-installing-software.adoc +++ b/documentation/asciidoc/accessories/build-hat/py-installing-software.adoc @@ -1,12 +1,19 @@ -== Using the Build HAT from Python +== Use the Build HAT from Python -=== Installing the Python Library +=== Install the Build HAT Python Library -Install the Build HAT Python library. Open a Terminal window and type, +To install the Build HAT Python library, open a terminal window and run the following command: -[source] +[source,console] ---- $ sudo apt install python3-build-hat ---- +Raspberry Pi OS versions prior to _Bookworm_ do not have access to the library with `apt`. Instead, run the following command to install the library using `pip`: + +[source,console] +---- +$ sudo pip3 install buildhat +---- + For more information about the Build HAT Python Library see https://buildhat.readthedocs.io/[ReadTheDocs]. diff --git a/documentation/asciidoc/accessories/build-hat/py-motors.adoc b/documentation/asciidoc/accessories/build-hat/py-motors.adoc index 7c2a1ab3b..7cf498f67 100644 --- a/documentation/asciidoc/accessories/build-hat/py-motors.adoc +++ b/documentation/asciidoc/accessories/build-hat/py-motors.adoc @@ -1,19 +1,19 @@ -=== Using Motors from Python +=== Use Motors from Python There are xref:build-hat.adoc#device-compatibility[a number of motors] that work with the Build HAT. -==== Connecting a Motor +==== Connect a Motor -Connect a motor to port A on the Build HAT. The LPF2 connectors need to be inserted the correct way up. If the connector doesn’t slide in easily, rotate by 180 degrees and try again. +Connect a motor to port A on the Build HAT. The LPF2 connectors need to be inserted the correct way up. If the connector doesn't slide in easily, rotate by 180 degrees and try again. -image::images/connect-motor.gif[width="80%"] +video::images/connect-motor.webm[width="80%"] -==== Working with Motors +==== Work with Motors Start the https://thonny.org/[Thonny IDE]. Add the program code below: -[source,python,linenums] +[source,python] ---- from buildhat import Motor @@ -22,24 +22,24 @@ motor_a = Motor('A') motor_a.run_for_seconds(5) ---- -Run the program by clicking the play/run button. If this is the first time you’re running a Build HAT program since the Raspberry Pi has booted, there will be a few seconds pause while the firmware is copied across to the board. You should see the red LED extinguish and the green LED illuminate. Subsequent executions of a Python program will not require this pause. +Run the program by clicking the play/run button. If this is the first time you're running a Build HAT program since the Raspberry Pi has booted, there will be a few seconds pause while the firmware is copied across to the board. You should see the red LED extinguish and the green LED illuminate. Subsequent executions of a Python program will not require this pause. -image::images/blinking-light.gif[width="80%"] +video::images/blinking-light.webm[width="80%"] Your motor should turn clockwise for 5 seconds. -image::images/turning-motor.gif[width="80%"] +video::images/turning-motor.webm[width="80%"] Change the final line of your program and re-run. -[source,python,linenums, start=5] +[source,python] ---- motor_a.run_for_seconds(5, speed=50) ---- The motor should now turn faster. Make another change: -[source,python,linenums, start=5] +[source,python] ---- motor_a.run_for_seconds(5, speed=-50) ---- diff --git a/documentation/asciidoc/accessories/build-hat/py-sensors.adoc b/documentation/asciidoc/accessories/build-hat/py-sensors.adoc index 889a251ce..15571eae8 100644 --- a/documentation/asciidoc/accessories/build-hat/py-sensors.adoc +++ b/documentation/asciidoc/accessories/build-hat/py-sensors.adoc @@ -1,16 +1,16 @@ -=== Using Sensors from Python +=== Use Sensors from Python There is a xref:build-hat.adoc#device-compatibility[large range of sensors] that work with the Build HAT. -==== Working with Sensors +==== Work with Sensors Connect a Colour sensor to port B on the Build HAT, and a Force sensor to port C. -NOTE: If you’re not intending to drive a motor, then you don’t need an external power supply and you can use a standard USB power supply for your Raspberry Pi. +NOTE: If you're not intending to drive a motor, then you don't need an external power supply and you can use a standard USB power supply for your Raspberry Pi. Create another new program: -[source,python,linenums] +[source,python] ---- from signal import pause from buildhat import ForceSensor, ColorSensor @@ -30,4 +30,4 @@ button.when_released = handle_released pause() ---- -Run it and hold a coloured object (LEGO® elements are ideal) in front of the colour sensor and press the Force sensor plunger. The sensor’s LED should switch on and the name of the closest colour should be displayed in the thonny REPL. +Run it and hold a coloured object (LEGO® elements are ideal) in front of the colour sensor and press the Force sensor plunger. The sensor's LED should switch on and the name of the closest colour should be displayed in the Thonny REPL. diff --git a/documentation/asciidoc/accessories/bumper.adoc b/documentation/asciidoc/accessories/bumper.adoc new file mode 100644 index 000000000..01e8de0fb --- /dev/null +++ b/documentation/asciidoc/accessories/bumper.adoc @@ -0,0 +1 @@ +include::bumper/about.adoc[] diff --git a/documentation/asciidoc/accessories/bumper/about.adoc b/documentation/asciidoc/accessories/bumper/about.adoc new file mode 100644 index 000000000..ee9f12052 --- /dev/null +++ b/documentation/asciidoc/accessories/bumper/about.adoc @@ -0,0 +1,31 @@ +== About + +.The Raspberry Pi Bumper for Raspberry Pi 5 +image::images/bumper.jpg[width="80%"] + +The Raspberry Pi Bumper for Raspberry Pi 5 is a snap-on silicone cover that protects +the bottom and edges of the board. When attached, the mounting holes of the Raspberry Pi remain accessible through the bumper. + +The Bumper is only compatible with Raspberry Pi 5. + +== Assembly instructions + +.Assembling the bumper +image::images/assembly.png[width="80%"] + +To attach the Raspberry Pi Bumper to your Raspberry Pi: + +. Turn off your Raspberry Pi and disconnect the power cable. +. Remove the SD card from the SD card slot of your Raspberry Pi. +. Align the bumper with the board. +. Press the board gently but firmly into the bumper, taking care to avoid contact between the bumper and any of the board’s components. +. Insert your SD card back into the SD card slot of your Raspberry Pi. +. Reconnect your Raspberry Pi to power. + +To remove the Raspberry Pi Bumper from your Raspberry Pi: + +. Turn off your Raspberry Pi and disconnect the power cable. +. Remove the SD card from the SD card slot of your Raspberry Pi. +. Gently but firmly peel the bumper away from the board, taking care to avoid contact between the bumper and any of the board’s components. +. Insert your SD card back into the SD card slot of your Raspberry Pi. +. Reconnect your Raspberry Pi to power. diff --git a/documentation/asciidoc/accessories/bumper/images/assembly.png b/documentation/asciidoc/accessories/bumper/images/assembly.png new file mode 100644 index 000000000..bdcfb0328 Binary files /dev/null and b/documentation/asciidoc/accessories/bumper/images/assembly.png differ diff --git a/documentation/asciidoc/accessories/bumper/images/bumper.jpg b/documentation/asciidoc/accessories/bumper/images/bumper.jpg new file mode 100644 index 000000000..14682676a Binary files /dev/null and b/documentation/asciidoc/accessories/bumper/images/bumper.jpg differ diff --git a/documentation/asciidoc/accessories/camera.adoc b/documentation/asciidoc/accessories/camera.adoc index facfc68da..f5076f9fa 100644 --- a/documentation/asciidoc/accessories/camera.adoc +++ b/documentation/asciidoc/accessories/camera.adoc @@ -6,4 +6,4 @@ include::camera/lens.adoc[] include::camera/synchronous_cameras.adoc[] -include::camera/external_trigger.adoc[] \ No newline at end of file +include::camera/external_trigger.adoc[] diff --git a/documentation/asciidoc/accessories/camera/camera_hardware.adoc b/documentation/asciidoc/accessories/camera/camera_hardware.adoc index c0ff6a561..3b8dafbd5 100644 --- a/documentation/asciidoc/accessories/camera/camera_hardware.adoc +++ b/documentation/asciidoc/accessories/camera/camera_hardware.adoc @@ -11,55 +11,62 @@ image::images/cm3.jpg[Camera Module 3 normal and wide angle] .Camera Module 3 NoIR (left) and Camera Module 3 NoIR Wide (right) image::images/cm3_noir.jpg[Camera Module 3 NoIR normal and wide angle] - -Additionally a 12-megapixel https://www.raspberrypi.com/products/raspberry-pi-high-quality-camera/[High Quality Camera] with CS- or M12-mount variants for use with external lenses was https://www.raspberrypi.com/news/new-product-raspberry-pi-high-quality-camera-on-sale-now-at-50/[released in 2020] and https://www.raspberrypi.com/news/new-autofocus-camera-modules/[2023] respectively. There is no infrared version of the HQ Camera, however the xref:camera.adoc#filter-removal[IR Filter can be removed] if required. +Additionally, a 12-megapixel https://www.raspberrypi.com/products/raspberry-pi-high-quality-camera/[High Quality Camera] with CS- or M12-mount variants for use with external lenses was https://www.raspberrypi.com/news/new-product-raspberry-pi-high-quality-camera-on-sale-now-at-50/[released in 2020] and https://www.raspberrypi.com/news/new-autofocus-camera-modules/[2023] respectively. There is no infrared version of the HQ Camera, however the xref:camera.adoc#filter-removal[IR Filter can be removed] if required. .HQ Camera, M12-mount (left) and C/CS-mount (right) image::images/hq.jpg[M12- and C/CS-mount versions of the HQ Camera] -Finally, there is the Global Shutter camera, which was http://raspberrypi.com/news/new-raspberry-pi-global-shutter-camera[released in 2023]. There is no infrared version of the GS Camera, however the IR Filter can be removed if required. +The Raspberry Pi AI Camera uses the Sony IMX500 imaging sensor to provide low-latency and high-performance AI capabilities to any camera application. Tight integration with xref:../computers/camera_software.adoc[Raspberry Pi's camera software stack] allows users to deploy their own neural network models with minimal effort. + +image::images/ai-camera-hero.png[The Raspberry Pi AI Camera] + +Finally, there is the Global Shutter camera, which was http://raspberrypi.com/news/new-raspberry-pi-global-shutter-camera[released in 2023]. There is no infrared version of the GS Camera, however the xref:camera.adoc#filter-removal[IR Filter can be removed] if required. .Global Shutter Camera image::images/gs-camera.jpg[GS Camera] -NOTE: Raspberry Pi Camera Modules are compatible with all Raspberry Pi computers with CSI connectors - that is, all models except Raspberry Pi 400 and the 2016 launch version of Zero. +NOTE: Raspberry Pi Camera Modules are compatible with all Raspberry Pi computers with CSI connectors. === Rolling or Global shutter? -Most digital cameras — and our Camera Modules — use a rolling shutter: they scan the image they’re capturing line-by-line, then output the results. You may have noticed that this can cause distortion effects in some settings; if you’ve ever photographed rotating propeller blades, you’ve probably spotted the image shimmering rather than looking like an object that is rotating. The propeller blades have had enough time to change position in the tiny moment that the camera has taken to swipe across and observe the scene. +Most digital cameras, including our Camera Modules, use a **rolling shutter**: they scan the image they're capturing line-by-line, then output the results. You may have noticed that this can cause distortion effects in some settings; if you've ever photographed rotating propeller blades, you've probably spotted the image shimmering rather than looking like an object that is rotating. The propeller blades have had enough time to change position in the tiny moment that the camera has taken to swipe across and observe the scene. -A global shutter — and our Global Shutter Camera Module — doesn’t do this. It captures the light from every pixel in the scene at once, so your photograph of propeller blades will not suffer from the same distortion. +A **global shutter**, like the one on our Global Shutter Camera Module, doesn't do this. It captures the light from every pixel in the scene at once, so your photograph of propeller blades will not suffer from the same distortion. Why is this useful? Fast-moving objects, like those propeller blades, are now easy to capture; we can also synchronise several cameras to take a photo at precisely the same moment in time. There are plenty of benefits here, like minimising distortion when capturing stereo images. (The human brain is confused if any movement that appears in the left eye has not appeared in the right eye yet.) The Raspberry Pi Global Shutter Camera can also operate with shorter exposure times - down to 30µs, given enough light - than a rolling shutter camera, which makes it useful for high-speed photography. -NOTE: The Global Shutter Camera’s image sensor has a 6.3mm diagonal active sensing area, which is similar in size to Raspberry Pi’s HQ Camera. However, the pixels are larger and can collect more light. Large pixel size and low pixel count are valuable in machine-vision applications; the more pixels a sensor produces, the harder it is to process the image in real time. To get around this, many applications downsize and crop images. This is unnecessary with the Global Shutter Camera and the appropriate lens magnification, where the lower resolution and large pixel size mean an image can be captured natively. +NOTE: The Global Shutter Camera's image sensor has a 6.3mm diagonal active sensing area, which is similar in size to Raspberry Pi's HQ Camera. However, the pixels are larger and can collect more light. Large pixel size and low pixel count are valuable in machine-vision applications; the more pixels a sensor produces, the harder it is to process the image in real time. To get around this, many applications downsize and crop images. This is unnecessary with the Global Shutter Camera and the appropriate lens magnification, where the lower resolution and large pixel size mean an image can be captured natively. -== Installing a Raspberry Pi camera +== Install a Raspberry Pi camera WARNING: Cameras are sensitive to static. Earth yourself prior to handling the PCB. A sink tap or similar should suffice if you don't have an earthing strap. -=== Connecting the Camera +=== Connect the Camera + +Before connecting any Camera, shut down your Raspberry Pi and disconnect it from power. -The flex cable inserts into the connector labelled CAMERA on the Raspberry Pi, which is located between the Ethernet and HDMI ports. The cable must be inserted with the silver contacts facing the HDMI port. To open the connector, pull the tabs on the top of the connector upwards, then towards the Ethernet port. The flex cable should be inserted firmly into the connector, with care taken not to bend the flex at too acute an angle. To close the connector, push the top part of the connector towards the HDMI port and down, while holding the flex cable in place. +The flex cable inserts into the connector labelled CAMERA on the Raspberry Pi, which is located between the Ethernet and HDMI ports. The cable must be inserted with the silver contacts facing the HDMI port. To open the connector, pull the tabs on the top of the connector upwards, then towards the Ethernet port. The flex cable should be inserted firmly into the connector, with care taken not to bend the flex at too acute an angle. To close the connector, push the top part of the connector down and away from the Ethernet port while holding the flex cable in place. -We have created a video to illustrate the process of connecting the camera. Although the video shows the original camera on the original Raspberry Pi 1, the principle is the same for all camera boards: +The following video shows how to connect the original camera on the original Raspberry Pi 1: -video::GImeVqHQzsE[youtube] +video::GImeVqHQzsE[youtube,width=80%,height=400px] -Depending on the model, the camera may come with a small piece of translucent blue plastic film covering the lens. This is only present to protect the lens while it is being mailed to you, and needs to be removed by gently peeling it off. +All Raspberry Pi boards with a camera connector use the same installation method, though the Raspberry Pi 5 and all Raspberry Pi Zero models require a https://www.raspberrypi.com/products/camera-cable/[different camera cable]. + +Some cameras may come with a small piece of translucent blue plastic film covering the lens. This is only present to protect the lens during shipping. To remove it, gently peel it off. NOTE: There is additional documentation available around fitting the recommended https://datasheets.raspberrypi.com/hq-camera/cs-mount-lens-guide.pdf[6mm] and https://datasheets.raspberrypi.com/hq-camera/c-mount-lens-guide.pdf[16mm] lens to the HQ Camera. -=== Preparing the Software +=== Prepare the Software -Before proceeding, we recommend ensuring that your kernel, GPU firmware and applications are all up to date. Please follow the instructions on xref:../computers/os.adoc#using-apt[keeping your operating system up to date]. +Before proceeding, we recommend ensuring that your kernel, GPU firmware and applications are all up to date. Please follow the instructions on xref:../computers/os.adoc#update-software[keeping your operating system up to date]. -Then, please follow the relevant setup instructions for the xref:../computers/camera_software.adoc#getting-started[libcamera] software stack, and the https://datasheets.raspberrypi.com/camera/picamera2-manual.pdf[Picamera2 Python library]. +Then, please follow the relevant setup instructions for xref:../computers/camera_software.adoc#rpicam-apps[`rpicam-apps`], and the https://datasheets.raspberrypi.com/camera/picamera2-manual.pdf[Picamera2 Python library]. == Hardware Specification |=== -| | Camera Module v1 | Camera Module v2 | Camera Module 3 | Camera Module 3 Wide | HQ Camera | GS Camera +| | Camera Module v1 | Camera Module v2 | Camera Module 3 | Camera Module 3 Wide | HQ Camera | AI Camera | GS Camera | Net price | $25 @@ -67,6 +74,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | $25 | $35 | $50 +| $70 | $50 | Size @@ -74,8 +82,9 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | Around 25 × 24 × 9 mm | Around 25 × 24 × 11.5 mm | Around 25 × 24 × 12.4 mm -| 38 x 38 x 18.4mm (excluding lens) -| 38 x 38 x 19.8mm (29.5mm with adaptor and dust cap) +| 38 × 38 × 18.4mm (excluding lens) +| 25 × 24 × 11.9mm +| 38 × 38 × 19.8mm (29.5mm with adaptor and dust cap) | Weight | 3g @@ -83,15 +92,17 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | 4g | 4g | 30.4g +| 6g | 34g (41g with adaptor and dust cap) | Still resolution -| 5 Megapixels -| 8 Megapixels -| 11.9 Megapixels -| 11.9 Megapixels -| 12.3 Megapixels -| 1.58 Megapixels +| 5 megapixels +| 8 megapixels +| 11.9 megapixels +| 11.9 megapixels +| 12.3 megapixels +| 12.3 megapixels +| 1.58 megapixels | Video modes | 1080p30, 720p60 and 640 × 480p60/90 @@ -99,7 +110,8 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | 2304 × 1296p56, 2304 × 1296p30 HDR, 1536 × 864p120 | 2304 × 1296p56, 2304 × 1296p30 HDR, 1536 × 864p120 | 2028 × 1080p50, 2028 × 1520p40 and 1332 × 990p120 -| 1456 x 1088p60 +| 2028 × 1520p30, 4056 × 3040p10 +| 1456 × 1088p60 | Sensor | OmniVision OV5647 @@ -107,31 +119,35 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | Sony IMX708 | Sony IMX708 | Sony IMX477 +| Sony IMX500 | Sony IMX296 | Sensor resolution | 2592 × 1944 pixels | 3280 × 2464 pixels -| 4608 x 2592 pixels -| 4608 x 2592 pixels -| 4056 x 3040 pixels -| 1456 x 1088 pixels +| 4608 × 2592 pixels +| 4608 × 2592 pixels +| 4056 × 3040 pixels +| 4056 × 3040 pixels +| 1456 × 1088 pixels | Sensor image area | 3.76 × 2.74 mm -| 3.68 x 2.76 mm (4.6 mm diagonal) -| 6.45 x 3.63mm (7.4mm diagonal) -| 6.45 x 3.63mm (7.4mm diagonal) -| 6.287mm x 4.712 mm (7.9mm diagonal) +| 3.68 × 2.76 mm (4.6 mm diagonal) +| 6.45 × 3.63mm (7.4mm diagonal) +| 6.45 × 3.63mm (7.4mm diagonal) +| 6.287mm × 4.712 mm (7.9mm diagonal) +| 6.287mm × 4.712 mm (7.9mm diagonal) | 6.3mm diagonal | Pixel size | 1.4 µm × 1.4 µm -| 1.12 µm x 1.12 µm -| 1.4 µm x 1.4 µm -| 1.4 µm x 1.4 µm -| 1.55 µm x 1.55 µm -| 3.45 µm x 3.45 µm +| 1.12 µm × 1.12 µm +| 1.4 µm × 1.4 µm +| 1.4 µm × 1.4 µm +| 1.55 µm × 1.55 µm +| 1.55 µm × 1.55 µm +| 3.45 µm × 3.45 µm | Optical size | 1/4" @@ -139,6 +155,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | 1/2.43" | 1/2.43" | 1/2.3" +| 1/2.3" | 1/2.9" | Focus @@ -148,6 +165,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | Motorized | Adjustable | Adjustable +| Adjustable | Depth of field | Approx 1 m to ∞ @@ -155,6 +173,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | Approx 10 cm to ∞ | Approx 5 cm to ∞ | N/A +| Approx 20 cm to ∞ | N/A | Focal length @@ -163,6 +182,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | 4.74 mm | 2.75 mmm | Depends on lens +| 4.74 mm | Depends on lens | Horizontal Field of View (FoV) @@ -171,6 +191,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | 66 degrees | 102 degrees | Depends on lens +| 66 ±3 degrees | Depends on lens | Vertical Field of View (FoV) @@ -179,6 +200,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | 41 degrees | 67 degrees | Depends on lens +| 52.3 ±3 degrees | Depends on lens | Focal ratio (F-Stop) @@ -187,14 +209,16 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | F1.8 | F2.2 | Depends on lens +| F1.79 | Depends on lens -| Maximum exposure times (seconds) -| 0.97 +| Maximum exposure time (seconds) +| 3.28 | 11.76 | 112 | 112 | 670.74 +| 112 | 15.5 | Lens Mount @@ -203,6 +227,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | N/A | N/A | C/CS- or M12-mount +| N/A | C/CS | NoIR version available? @@ -212,6 +237,7 @@ Then, please follow the relevant setup instructions for the xref:../computers/ca | Yes | No | No +| No |=== NOTE: There is https://github.com/raspberrypi/libcamera/issues/43[some evidence] to suggest that the Camera Module 3 may emit RFI at a harmonic of the CSI clock rate. This RFI is in a range to interfere with GPS L1 frequencies (1575 MHz). Please see the https://github.com/raspberrypi/libcamera/issues/43[thread on Github] for details and proposed workarounds. diff --git a/documentation/asciidoc/accessories/camera/external_trigger.adoc b/documentation/asciidoc/accessories/camera/external_trigger.adoc index 907878002..642412d54 100644 --- a/documentation/asciidoc/accessories/camera/external_trigger.adoc +++ b/documentation/asciidoc/accessories/camera/external_trigger.adoc @@ -21,20 +21,9 @@ We can use a Raspberry Pi Pico to provide the trigger. Connect any Pico GPIO pin image::images/pico_wiring.jpg[alt="Image showing Raspberry Pi Pico wiring",width="50%"] -==== Boot up the Raspberry Pi with the camera connected. +==== Raspberry Pi Pico MicroPython Code -Enable external triggering through superuser mode: - -[,bash] ----- -sudo su -echo 1 > /sys/module/imx296/parameters/trigger_mode -exit ----- - -==== Raspberry Pi Pico Micropython Code - -[,python] +[source,python] ---- from machine import Pin, PWM @@ -51,20 +40,41 @@ pwm.freq(framerate) pwm.duty_u16(int((1 - (shutter - 14) / frame_length) * 65535)) ---- -The low pulsewidth is equal to the shutter time, and the frequency of the PWM equals the framerate. +The low pulse width is equal to the shutter time, and the frequency of the PWM equals the framerate. + +NOTE: In this example, Pin 28 connects to the XTR touchpoint on the GS camera board. + +=== Camera driver configuration + +This step is only necessary if you have more than one camera with XTR wired in parallel. + +Edit `/boot/firmware/config.txt`. Change `camera_auto_detect=1` to `camera_auto_detect=0`. + +Append this line: +[source] +---- +dtoverlay=imx296,always-on +---- +When using the CAM0 port on a Raspberry Pi 5, CM4 or CM5, append `,cam0` to that line without a space. If both cameras are on the same Raspberry Pi you will need two dtoverlay lines, only one of them ending with `,cam0`. + +If the external trigger will not be started right away, you also need to increase the libcamera timeout xref:camera.adoc#libcamera-configuration[as above]. + +=== Starting the camera -NOTE: In this example Pin 28 is used to connect to the XTR touchpoint on the GS camera board. +Enable external triggering: -=== Operation +[source,console] +---- +$ echo 1 | sudo tee /sys/module/imx296/parameters/trigger_mode +---- -Run the code on the Pico, and set the camera running: +Run the code on the Pico, then set the camera running: -[,bash] +[source,console] ---- -rpicam-hello -t 0 --qt-preview --shutter 3000 +$ rpicam-hello -t 0 --qt-preview --shutter 3000 ---- -A frame should now be generated every time that the Pico pulses the pin. Variable framerate is acceptable, and can be controlled by simply -varying the duration between pulses. No options need to be passed to rpicam-apps to enable external trigger. +Every time the Pico pulses the pin, it should capture a frame. However, if `--gain` and `--awbgains` are not set, some frames will be dropped to allow AGC and AWB algorithms to settle. -NOTE: When running libcamera apps, you will need to specify a fixed shutter duration (the value does not matter). This will ensure the AGC does not try adjusting camera's shutter speed, which is controlled by the external trigger pulse. \ No newline at end of file +NOTE: When running `rpicam-apps`, always specify a fixed shutter duration, to ensure the AGC does not try to adjust the camera's shutter speed. The value is not important, since it is actually controlled by the external trigger pulse. diff --git a/documentation/asciidoc/accessories/camera/filters.adoc b/documentation/asciidoc/accessories/camera/filters.adoc index 676532f8f..32ac70e02 100644 --- a/documentation/asciidoc/accessories/camera/filters.adoc +++ b/documentation/asciidoc/accessories/camera/filters.adoc @@ -30,48 +30,41 @@ The HQ and GS Cameras use a Hoya CM500 infrared filter. Its transmission charact image::images/hoyacm500.png[CM500 Transmission Graph,width="65%"] -== Filter Removal +== IR Filter -NOTE: This procedure applies to both the HQ and GS cameras. +Both the High Quality Camera and Global Shutter Camera contain an IR filter to reduce the camera's sensitivity to infrared light and help outdoor photos look more natural. However, you may remove the filter to: -WARNING: *This procedure cannot be reversed:* the adhesive that attaches the filter will not survive being lifted and replaced, and while the IR filter is about 1.1mm thick, it may crack when it is removed. *Removing it will void the warranty on the product*. Nevertheless, removing the filter will be desirable to some users. +* Enhance colours in certain types of photography, such as images of plants, water, and the sky +* Provide night vision in a location that is illuminated with infrared light -image:images/FILTER_ON_small.jpg[width="65%"] - -Both the High Quality Camera and Global Shutter Camera contain an IR filter, which is used to reduce the camera's sensitivity to infrared light. This ensures that outdoor photos look more natural. However, some nature photography can be enhanced with the removal of this filter; the colours of sky, plants, and water can be affected by its removal. The camera can also be used without the filter for night vision in a location that is illuminated with infrared light. +=== Filter Removal -WARNING: Before proceeding read through all of the steps and decide whether you are willing to void your warranty. *Do not proceed* unless you are sure that you are willing to void your warranty. +WARNING: *This procedure cannot be reversed:* the adhesive that attaches the filter will not survive being lifted and replaced, and while the IR filter is about 1.1mm thick, it may crack when it is removed. *Removing it will void the warranty on the product*. -To remove the filter: +You can remove the filter from both the HQ and GS cameras. The HQ camera is shown in the demonstration below. -* Work in a clean and dust-free environment, as the sensor will be exposed to the air. +image:images/FILTER_ON_small.jpg[width="65%"] -* Unscrew the two 1.5 mm hex lock keys on the underside of the main circuit board. Be careful not to let the washers roll away. There is a gasket of slightly sticky material between the housing and PCB which will require some force to separate. +NOTE: Make sure to work in a clean and dust-free environment, as the sensor will be exposed to the air. +. Unscrew the two 1.5 mm hex lock keys on the underside of the main circuit board. Be careful not to let the washers roll away. ++ image:images/SCREW_REMOVED_small.jpg[width="65%"] - -* Lift up the board and place it down on a very clean surface. Make sure the sensor does not touch the surface. - +. There is a gasket of slightly sticky material between the housing and PCB which will require some force to separate. You may try some ways to weaken the adhesive, such as a little isopropyl alcohol and/or heat (~20-30 C). +. Once the adhesive is loose, lift up the board and place it down on a very clean surface. Make sure the sensor does not touch the surface. ++ image:images/FLATLAY_small.jpg[width="65%"] - -* You may try some ways to weaken the adhesive, such as a little isopropyl alcohol and/or heat (~20-30 C). - +. Face the lens upwards and place the mount on a flat surface. ++ image:images/SOLVENT_small.jpg[width="65%"] - -* Turn the lens mount around so that it is "looking" upwards and place it on a table. - -* Using a pen top or similar soft plastic item, push down on the filter only at the very edges where the glass attaches to the aluminium - to minimise the risk of breaking the filter. The glue will break and the filter will detach from the lens mount. - +. To minimise the risk of breaking the filter, use a pen top or similar soft plastic item to push down on the filter only at the very edges where the glass attaches to the aluminium. The glue will break and the filter will detach from the lens mount. ++ image:images/REMOVE_FILTER_small.jpg[width="65%"] - -* Given that changing lenses will expose the sensor, at this point you could affix a clear filter (for example, OHP plastic) to minimize the chance of dust entering the sensor cavity. - -* Replace the main housing over the circuit board. Be sure to realign the housing with the gasket, which remains on the circuit board. - -* The nylon washer prevents damage to the circuit board; apply this washer first. Next, fit the steel washer, which prevents damage to the nylon washer. - -* Screw down the two hex lock keys. As long as the washers have been fitted in the correct order, they do not need to be screwed very tightly. - +. Given that changing lenses will expose the sensor, at this point you could affix a clear filter (for example, OHP plastic) to minimize the chance of dust entering the sensor cavity. +. Replace the main housing over the circuit board. Be sure to realign the housing with the gasket, which remains on the circuit board. +. Apply the nylon washer first to prevent damage to the circuit board. +. Next, fit the steel washer, which prevents damage to the nylon washer. Screw down the two hex lock keys. As long as the washers have been fitted in the correct order, they do not need to be screwed very tightly. ++ image:images/FILTER_OFF_small.jpg[width="65%"] NOTE: It is likely to be difficult or impossible to glue the filter back in place and return the device to functioning as a normal optical camera. diff --git a/documentation/asciidoc/accessories/camera/images/FILTER_OFF.jpg b/documentation/asciidoc/accessories/camera/images/FILTER_OFF.jpg index c9f4778b9..918eb217f 100644 Binary files a/documentation/asciidoc/accessories/camera/images/FILTER_OFF.jpg and b/documentation/asciidoc/accessories/camera/images/FILTER_OFF.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/FILTER_ON.jpg b/documentation/asciidoc/accessories/camera/images/FILTER_ON.jpg index 3c728b056..47abc24c7 100644 Binary files a/documentation/asciidoc/accessories/camera/images/FILTER_ON.jpg and b/documentation/asciidoc/accessories/camera/images/FILTER_ON.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/FLATLAY.jpg b/documentation/asciidoc/accessories/camera/images/FLATLAY.jpg index ef6512792..6fad88e33 100644 Binary files a/documentation/asciidoc/accessories/camera/images/FLATLAY.jpg and b/documentation/asciidoc/accessories/camera/images/FLATLAY.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/REMOVE_FILTER.jpg b/documentation/asciidoc/accessories/camera/images/REMOVE_FILTER.jpg index bf3d39b58..845fda298 100644 Binary files a/documentation/asciidoc/accessories/camera/images/REMOVE_FILTER.jpg and b/documentation/asciidoc/accessories/camera/images/REMOVE_FILTER.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/SCREW_REMOVED.jpg b/documentation/asciidoc/accessories/camera/images/SCREW_REMOVED.jpg index 6eae6044c..02cb97774 100644 Binary files a/documentation/asciidoc/accessories/camera/images/SCREW_REMOVED.jpg and b/documentation/asciidoc/accessories/camera/images/SCREW_REMOVED.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/SOLVENT.jpg b/documentation/asciidoc/accessories/camera/images/SOLVENT.jpg index d84a386f2..e7c4e965a 100644 Binary files a/documentation/asciidoc/accessories/camera/images/SOLVENT.jpg and b/documentation/asciidoc/accessories/camera/images/SOLVENT.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/ai-camera-hero.png b/documentation/asciidoc/accessories/camera/images/ai-camera-hero.png new file mode 100644 index 000000000..a0186287c Binary files /dev/null and b/documentation/asciidoc/accessories/camera/images/ai-camera-hero.png differ diff --git a/documentation/asciidoc/accessories/camera/images/m12-lens.jpg b/documentation/asciidoc/accessories/camera/images/m12-lens.jpg index dae4e2599..875f0297a 100644 Binary files a/documentation/asciidoc/accessories/camera/images/m12-lens.jpg and b/documentation/asciidoc/accessories/camera/images/m12-lens.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/resistor.jpg b/documentation/asciidoc/accessories/camera/images/resistor.jpg index 21a5451bc..7d9fc1077 100644 Binary files a/documentation/asciidoc/accessories/camera/images/resistor.jpg and b/documentation/asciidoc/accessories/camera/images/resistor.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_clear_filter.jpg b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_clear_filter.jpg index 00daf6b07..dc401f9ad 100644 Binary files a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_clear_filter.jpg and b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_clear_filter.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_gasket.jpg b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_gasket.jpg index b4cd564a4..572ca3167 100644 Binary files a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_gasket.jpg and b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_gasket.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_ir_filter.jpg b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_ir_filter.jpg index 8b786511b..ee09e5b4c 100644 Binary files a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_ir_filter.jpg and b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_ir_filter.jpg differ diff --git a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_sensor.jpg b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_sensor.jpg index d9792c2f3..40bb170bb 100644 Binary files a/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_sensor.jpg and b/documentation/asciidoc/accessories/camera/images/rpi_hq_cam_sensor.jpg differ diff --git a/documentation/asciidoc/accessories/camera/synchronous_cameras.adoc b/documentation/asciidoc/accessories/camera/synchronous_cameras.adoc index 816d16786..9561864ff 100644 --- a/documentation/asciidoc/accessories/camera/synchronous_cameras.adoc +++ b/documentation/asciidoc/accessories/camera/synchronous_cameras.adoc @@ -1,101 +1,108 @@ == Synchronous Captures -Both the HQ Camera and the Global Shutter Camera, have support for synchronous captures. -Making use of the XVS pin (Vertical Sync) allows one camera to pulse when a frame capture is initiated. -The other camera can then listen for this sync pulse, and capture a frame at the same time as the other camera. +The High Quality (HQ) Camera supports synchronous captures. +One camera (the "source") can be configured to generate a pulse on its XVS (Vertical Sync) pin when a frame capture is initiated. +Other ("sink") cameras can listen for this pulse, and capture a frame at the same time as the source camera. -=== Using the HQ Camera +This method is largely superseded by xref:../computers/camera_software.adoc#software-camera-synchronisation[software camera synchronisation] which can operate over long distances without additional wires and has sub-millisecond accuracy. But when cameras are physically close, wired synchronisation may be used. -For correct operation, both cameras require a 1.65V pull up voltage on the XVS line, which is created by a potential divider through the 3.3V and GND pins on the Raspberry Pi. +NOTE: Global Shutter (GS) Cameras can also be operated in a synchronous mode. However, the source camera will record one extra frame. Instead, for GS Cameras we recommend using an xref:camera.adoc#external-trigger-on-the-gs-camera[external trigger source]. You cannot synchronise a GS Camera and an HQ Camera. -image::images/synchronous_camera_wiring.jpg[alt="Image showing potential divider setup",width="50%"] +=== Connecting the cameras -Create a potential divider from two 10kΩ resistors to 3.3V and ground (to make 1.65V with an effective source impedance of 5kΩ). This can be connected to either Raspberry Pi. +Solder a wire to the XVS test point of each camera, and connect them together. -Solder the GND and XVS test points of each HQ Camera board to each other. +Solder a wire to the GND test point of each camera, and connect them together. -Connect the XVS wires to the 1.65V potential divider pull-up. +*For GS Cameras only,* you will also need to connect the XHS (Horizontal Sync) test point of each camera together. On any GS Camera that you wish to act as a sink, bridge the two halves of the MAS pad with solder. -==== Boot up both Raspberry Pis +NOTE: An earlier version of this document recommended an external pull-up for XVS. This is no longer recommended. Instead, ensure you have the latest version of Raspberry Pi OS and set the `always-on` property for all connected cameras. -The file `/sys/module/imx477/parameters/trigger_mode` determines which board outputs pulses, or waits to receive pulses (source and sink). -This parameter can only be altered in superuser mode. +=== Driver configuration -On the sink, run: -[,bash] +You will need to configure the camera drivers to keep their 1.8V power supplies on when not streaming, and optionally to select the source and sink roles. + +==== For the HQ Camera + +Edit `/boot/firmware/config.txt`. Change `camera_auto_detect=1` to `camera_auto_detect=0`. + +Append this line for a source camera: +[source] ---- -sudo su -echo 2 > /sys/module/imx477/parameters/trigger_mode -exit +dtoverlay=imx477,always-on,sync-source ---- -On the source, run: -[,bash] +Or for a sink: +[source] ---- -sudo su -echo 1 > /sys/module/imx477/parameters/trigger_mode -exit +dtoverlay=imx477,always-on,sync-sink ---- -Start the sink running: -[,bash] +When using the CAM0 port on a Raspberry Pi 5, CM4 or CM5, append `,cam0` to that line without a space. If two cameras are on the same Raspberry Pi you will need two dtoverlay lines, only one of them ending with `,cam0`. + +Alternatively, if you wish to swap the cameras' roles at runtime (and they are not both connected to the same Raspberry Pi), omit `,sync-source` or `,sync-sink` above. Instead you can set a module parameter before starting each camera: + +For the Raspbery Pi with the source camera: +[source,console] ---- -rpicam-vid --frames 300 --qt-preview -o sink.h264 +$ echo 1 | sudo tee /sys/module/imx477/parameters/trigger_mode ---- -Start the source running -[,bash] +For the Raspberry Pi with the sink camera: +[source,console] ---- -rpicam-vid --frames 300 --qt-preview -o source.h264 +$ echo 2 | sudo tee /sys/module/imx477/parameters/trigger_mode ---- +You will need to do this every time the system is booted. -Frames should be synchronous. Use `--frames` to ensure the same number of frames are captured, and that the recordings are exactly the same length. -Running the sink first ensures that no frames are missed. - -NOTE: The potential divider is needed to pull up the XVS pin to high whilst the source is in an idle state. This ensures that no frames are created or lost upon startup. The source whilst initialising goes from LOW to HIGH which can trigger a false frame. +==== For the GS Camera -=== Using the GS Camera +Edit `/boot/firmware/config.txt`. Change `camera_auto_detect=1` to `camera_auto_detect=0`. -NOTE: The Global Shutter (GS) camera can also be operated in a synchronous mode. However, the source camera will record one extra frame. A much better alternative method to ensure that both cameras capture the same amount of frames is to use the xref:camera.adoc#external-trigger-on-the-gs-camera[external trigger method]. +For either a source or a sink, append this line: +[source] +---- +dtoverlay=imx296,always-on +---- +When using the CAM0 port on a Raspberry Pi 5, CM4 or CM5, append `,cam0` to that line without a space. If two cameras are on the same Raspberry Pi you will need two dtoverlay lines, only one of them ending with `,cam0`. -To operate as source and sink together, the Global Shutter Cameras also require connection of the XHS (horizontal sync) pins together. However, these do not need connection to a pullup resistor. +On the GS Camera, the sink role is enabled by the MAS pin and cannot be configured by software ("trigger_mode" and "sync-sink" relate to the xref:camera.adoc#external-trigger-on-the-gs-camera[external trigger method], and should _not_ be set for this method). -The wiring setup is identical to the xref:camera.adoc#using-the-hq-camera[HQ Camera method], except that you will also need to connect the XHS pins together. +=== Libcamera configuration -Create a potential divider from two 10kΩ resistors to 3.3V and ground (to make 1.65V with an effective source impedance of 5kΩ). This can be connected to either Raspberry Pi. +If the cameras are not all started within 1 second, the `rpicam` applications can time out. To prevent this, you must edit a configuration file on any Raspberry Pi(s) with sink cameras. -Solder 2 wires to the XVS test points on each board and connect both of these wires together to the 1.65V potential divider. +On Raspberry Pi 5 or CM5: +[source,console] +---- +$ cp /usr/share/libcamera/pipeline/rpi/pisp/example.yaml timeout.yaml +---- -Solder the GND of each Camera board to each other. Also solder 2 wires to the XHS test points on each board and connect these. No pullup is needed for XHS pin. +On other Raspberry Pi models: +[source,console] +---- +$ cp /usr/share/libcamera/pipeline/rpi/vc4/rpi_apps.yaml timeout.yaml +---- -On the boards that you wish to act as sinks, solder the two halves of the MAS pad together. This tells the sensor to act as a sink, and will wait for a signal to capture a frame. +Now edit the copy. In both cases, delete the `#` (comment) from the `"camera_timeout_value_ms":` line, and change the number to `60000` (60 seconds). -==== Boot up both Raspberry Pis +=== Starting the cameras -Start the sink running: -[,bash] ----- -rpicam-vid --frames 300 -o sync.h264 ----- -Allow a delay before you start the source running (see note below). Needs to be roughly > 2 seconds. +Run the following commands to start the sink: -Start the source running: -[,bash] +[source,console] ---- -rpicam-vid --frames 299 -o sync.h264 +$ export LIBCAMERA_RPI_CONFIG_FILE=timeout.yaml +$ rpicam-vid --frames 300 --qt-preview -o sink.h264 ---- -[NOTE] -===== -Due to the limitations of the IMX296 sensor, we are unable to get the sink to record exactly the same amount of frames as the source. -**The source will record one extra frame before the sink starts recording.** This will need to be accounted for later in the application. -Because of this, you need to specify that the sink records one less frame in the `--frames` option. - -FFmpeg has the ability to resync these two videos. By dropping the first frame from the source, we then get two recordings of the same frame - length and with the same starting point. +Wait a few seconds, then run the following command to start the source: -[,bash] +[source,console] ---- -ffmpeg -i source.h264 -vf select="gte(n\, 1)" source.h264 +$ rpicam-vid --frames 300 --qt-preview -o source.h264 ---- -===== +Frames should be synchronised. Use `--frames` to ensure the same number of frames are captured, and that the recordings are exactly the same length. +Running the sink first ensures that no frames are missed. + +NOTE: When using the GS camera in synchronous mode, the sink will not record exactly the same number of frames as the source. **The source records one extra frame before the sink starts recording**. Because of this, you need to specify that the sink records one less frame with the `--frames` option. diff --git a/documentation/asciidoc/accessories/display/display_intro.adoc b/documentation/asciidoc/accessories/display/display_intro.adoc index 98fd19f27..b7f5204ec 100644 --- a/documentation/asciidoc/accessories/display/display_intro.adoc +++ b/documentation/asciidoc/accessories/display/display_intro.adoc @@ -1,15 +1,15 @@ == Raspberry Pi Touch Display -The https://www.raspberrypi.com/products/raspberry-pi-touch-display/[Raspberry Pi Touch Display] is an LCD display that connects to the Raspberry Pi using the DSI connector. You can use both the Touch Display and an HDMI display output at the same time. +The https://www.raspberrypi.com/products/raspberry-pi-touch-display/[Raspberry Pi Touch Display] is an LCD display that connects to a Raspberry Pi using a DSI connector and GPIO connector. .The Raspberry Pi 7-inch Touch Display image::images/display.png[The Raspberry Pi 7-inch Touch Display, width="70%"] -The Touch Display is compatible with all models of Raspberry Pi except the Raspberry Pi Zero and Zero 2 W, which lack a DSI connector. The earliest Raspberry Pi models lack appropriate mounting holes, requiring additional mounting hardware to fit the stand-offs on the display PCB. +The Touch Display is compatible with all models of Raspberry Pi, except the Zero series and Keyboard series, which lack a DSI connector. The earliest Raspberry Pi models lack appropriate mounting holes, requiring additional mounting hardware to fit the stand-offs on the display PCB. -The display has the following key features: +The display has the following key features: -* 800×480 RGB LCD display +* 800×480px RGB LCD display * 24-bit colour * Industrial quality: 140 degree viewing angle horizontal, 120 degree viewing angle vertical * 10-point multi-touch touchscreen @@ -49,7 +49,7 @@ We recommend using the Raspberry Pi's GPIO to provide power to the Touch Display ==== Power from a Raspberry Pi -To power the Touch Display using a Raspberry Pi, you need to connect two jumper wires between the 5V and `GND` pins on xref:../computers/raspberry-pi.adoc#gpio-and-the-40-pin-header[Raspberry Pi's GPIO] and the 5V and `GND` pins on the display, as shown in the following illustration. +To power the Touch Display using a Raspberry Pi, you need to connect two jumper wires between the 5V and `GND` pins on xref:../computers/raspberry-pi.adoc#gpio[Raspberry Pi's GPIO] and the 5V and `GND` pins on the display, as shown in the following illustration. .The location of the display's 5V and `GND` pins image::images/display_plugs.png[Illustration of display pins, width="40%"] @@ -75,22 +75,17 @@ WARNING: When using a micro USB cable to power the display, mount it inside a ch === Use an on-screen keyboard -In Raspberry Pi OS Bookworm and later, you can use the https://github.com/jjsullivan5196/wvkbd[`wvkbd`] on-screen keyboard as an input device. To install `wvkbd`, run the following command: +Raspberry Pi OS _Bookworm_ and later include the Squeekboard on-screen keyboard by default. When a touch display is attached, the on-screen keyboard should automatically show when it is possible to enter text and automatically hide when it is not possible to enter text. -[source,console] ----- -$ sudo apt install wvkbd ----- +For applications which do not support text entry detection, use the keyboard icon at the right end of the taskbar to manually show and hide the keyboard. -TIP: In Raspberry Pi OS releases prior to Bookworm, you can use `matchbox-keyboard` instead. - -=== Change screen orientation +You can also permanently show or hide the on-screen keyboard in the **Display** tab of Control Centre or the `Display` section of `raspi-config`. -If you want to physically rotate the display, or mount it in a specific position, you can use software to adjust the orientation of the screen to better match your setup. +TIP: In Raspberry Pi OS releases prior to _Bookworm_, use `matchbox-keyboard` instead. If you use the wayfire desktop compositor, use `wvkbd` instead. -==== Rotate screen from the desktop +=== Change screen orientation -To set the screen orientation from the desktop environment, select **Screen Configuration** from the **Preferences** menu. Right-click on the DSI-1 display rectangle in the layout editor, select **Orientation**, then pick the best option to fit your needs. You can also ensure that the touch overlay is assigned to the correct display with the **Touchscreen** option. +If you want to physically rotate the display, or mount it in a specific position, select **Screen Configuration** from the **Preferences** menu. Right-click on the touch display rectangle (likely DSI-1) in the layout editor, select **Orientation**, then pick the best option to fit your needs. image::images/display-rotation.png[Screenshot of orientation options in screen configuration, width="80%"] @@ -98,7 +93,7 @@ image::images/display-rotation.png[Screenshot of orientation options in screen c To set the screen orientation on a device that lacks a desktop environment, edit the `/boot/firmware/cmdline.txt` configuration file to pass an orientation to the system. Add the following line to `cmdline.txt`: -[source] +[source,ini] ---- video=DSI-1:800x480@60,rotate= ---- @@ -118,16 +113,16 @@ NOTE: It is not possible to rotate the DSI display separately from the HDMI disp WARNING: Rotating touch input via device tree can cause conflicts with your input library. Whenever possible, configure touch event rotation in your input library or desktop. -Rotation of touch input is independent of the orientation of the display itself. To change this you need to manually add a `dtoverlay` instruction in xref:../computers/config_txt.adoc[`/boot/firmware/config.txt`]. Add the following line in `config.txt`: +Rotation of touch input is independent of the orientation of the display itself. To change this you need to manually add a `dtoverlay` instruction in xref:../computers/config_txt.adoc[`/boot/firmware/config.txt`]. Add the following line at the end of `config.txt`: -[source] +[source,ini] ---- dtoverlay=vc4-kms-dsi-7inch,invx,invy ---- Then, disable automatic display detection by removing the following line from `config.txt`, if it exists: -[source] +[source,ini] ---- display_auto_detect=1 ---- @@ -158,9 +153,13 @@ The `vc4-kms-dsi-7inch` overlay supports the following options: | Disables the touch overlay totally |=== -To specify these options, add them, separated by commas, to your `dtoverlay` line in `/boot/firmware/config.txt`. Boolean values default to true when present, but you can set them to false with the suffix "=0". Integer values require a value, e.g. `sizey=240`. For instance, to set the X resolution to 400 pixels and invert both X and Y coordinates, use the following line: +To specify these options, add them, separated by commas, to your `dtoverlay` line in `/boot/firmware/config.txt`. Boolean values default to true when present, but you can set them to false using the suffix "=0". Integer values require a value, e.g. `sizey=240`. For instance, to set the X resolution to 400 pixels and invert both X and Y coordinates, use the following line: -[source] +[source,ini] ---- dtoverlay=vc4-kms-dsi-7inch,sizex=400,invx,invy ---- + +=== Installation on Compute Module based devices. + +All Raspberry Pi SBCs auto-detect the official Touch Displays as the circuitry connected to the DSI connector on the Raspberry Pi board is fixed; this autodetection ensures the correct Device Tree entries are passed to the kernel. However, Compute Modules are intended for industrial applications where the integrator can use any and all GPIOs and interfaces for whatever purposes they require. Autodetection is therefore not feasible, and hence is disabled on Compute Module devices. This means that the Device Tree fragments required to set up the display need to be loaded via some other mechanism, which can be either with a dtoverlay entry in config.txt as described above, via a custom base DT file, or if present, a HAT EEPROM. \ No newline at end of file diff --git a/documentation/asciidoc/accessories/display/images/display-rotation.png b/documentation/asciidoc/accessories/display/images/display-rotation.png index 81143b3ad..86eb3a10b 100755 Binary files a/documentation/asciidoc/accessories/display/images/display-rotation.png and b/documentation/asciidoc/accessories/display/images/display-rotation.png differ diff --git a/documentation/asciidoc/accessories/display/images/display.png b/documentation/asciidoc/accessories/display/images/display.png index 2e07d6ea5..dd7ae3361 100644 Binary files a/documentation/asciidoc/accessories/display/images/display.png and b/documentation/asciidoc/accessories/display/images/display.png differ diff --git a/documentation/asciidoc/accessories/display/legacy.adoc b/documentation/asciidoc/accessories/display/legacy.adoc index aa0a87554..eab11d275 100644 --- a/documentation/asciidoc/accessories/display/legacy.adoc +++ b/documentation/asciidoc/accessories/display/legacy.adoc @@ -6,7 +6,7 @@ The DSI connector on both the Raspberry Pi 1 Model A and B boards does not have 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: -[source] +[source,ini] ---- ignore_lcd=0 ---- diff --git a/documentation/asciidoc/accessories/keyboard-and-mouse/connecting-things.adoc b/documentation/asciidoc/accessories/keyboard-and-mouse/connecting-things.adoc index 8078b92ac..a23011f5c 100644 --- a/documentation/asciidoc/accessories/keyboard-and-mouse/connecting-things.adoc +++ b/documentation/asciidoc/accessories/keyboard-and-mouse/connecting-things.adoc @@ -1,6 +1,6 @@ == Connecting it all Together -This is the configuration we recommend for using your Raspberry Pi, official keyboard and hub, and official mouse together. The hub on the keyboard ensures easy access to USB drives, and the mouse’s cable is tidy, while being long enough to allow you to use the mouse left- or right-handed. +This is the configuration we recommend for using your Raspberry Pi, official keyboard and hub, and official mouse together. The hub on the keyboard ensures easy access to USB drives, and the mouse's cable is tidy, while being long enough to allow you to use the mouse left- or right-handed. image::images/everything.png[width="80%"] diff --git a/documentation/asciidoc/accessories/keyboard-and-mouse/getting-started-keyboard.adoc b/documentation/asciidoc/accessories/keyboard-and-mouse/getting-started-keyboard.adoc index fc690f669..364973807 100644 --- a/documentation/asciidoc/accessories/keyboard-and-mouse/getting-started-keyboard.adoc +++ b/documentation/asciidoc/accessories/keyboard-and-mouse/getting-started-keyboard.adoc @@ -2,7 +2,7 @@ Our official keyboard includes three host USB ports for connecting external devices, such as USB mice, USB drives, and other USB- controlled devices. -The product’s micro USB port is for connection to the Raspberry Pi. Via the USB hub built into the keyboard, the Raspberry Pi controls, and provides power to, the three USB Type A ports. +The product's micro USB port is for connection to the Raspberry Pi. Via the USB hub built into the keyboard, the Raspberry Pi controls, and provides power to, the three USB Type A ports. image::images/back-of-keyboard.png[width="80%"] diff --git a/documentation/asciidoc/accessories/m2-hat-plus.adoc b/documentation/asciidoc/accessories/m2-hat-plus.adoc new file mode 100644 index 000000000..b9501e937 --- /dev/null +++ b/documentation/asciidoc/accessories/m2-hat-plus.adoc @@ -0,0 +1 @@ +include::m2-hat-plus/about.adoc[] diff --git a/documentation/asciidoc/accessories/m2-hat-plus/about.adoc b/documentation/asciidoc/accessories/m2-hat-plus/about.adoc new file mode 100644 index 000000000..a3194fb13 --- /dev/null +++ b/documentation/asciidoc/accessories/m2-hat-plus/about.adoc @@ -0,0 +1,236 @@ +[[m2-hat-plus]] +== About + +[.clearfix] +-- +[.left] +.The Raspberry Pi M.2 HAT+ +image::images/m2-hat-plus.jpg[width="100%"] +[.left] +.The Raspberry Pi M.2 HAT+ Compact in the Raspberry Pi Case +image::images/m2-hat-plus-compact-with-case.jpg[width="100%"] +-- + +The Raspberry Pi M.2 HAT+ M Key and M.2 HAT+ Compact M Key enable you to connect M.2 peripherals such as NVMe drives and other PCIe accessories to Raspberry Pi 5's PCIe interface. + +The M.2 HAT+ and M.2 HAT+ Compact adapter boards convert between the PCIe connector on Raspberry Pi 5 and a single M.2 M key edge connector. The M.2 HAT+ supports any device that uses the 2230 or 2242 form factor; the M.2 HAT+ Compact supports any device that uses the 2230 form factor. + +We provide the M.2 HAT+ in a standard and a compact format to serve different use cases: + +* The M.2 HAT+ includes threaded spacers that provide ample room to fit the Raspberry Pi Active Cooler beneath it. However, the M.2 HAT+ is _only_ compatible with the https://www.raspberrypi.com/products/raspberry-pi-5-case/[Raspberry Pi Case for Raspberry Pi 5] _if you remove the lid and the included fan_. + +* The M.2 HAT+ Compact is designed to fit around the included fan in the https://www.raspberrypi.com/products/raspberry-pi-5-case/[Raspberry Pi Case for Raspberry Pi 5]. However, you can't fit the Active Cooler beneath it. + +Both the M.2 HAT+ and M.2 HAT+ Compact conform to the https://datasheets.raspberrypi.com/hat/hat-plus-specification.pdf[Raspberry Pi HAT+ specification], which allows Raspberry Pi OS to automatically detect the HAT+ and any connected devices. + +== Features + +The M.2 HAT+ and M.2 HAT+ Compact both have the following features: + +* Single-lane PCIe 2.0 interface (500 MB/s peak transfer rate) +* Support for devices that use the M.2 M key edge connector +* Up to 3 A supply to connected M.2 devices +* Power and activity LEDs + +The M.2 HAT+ and M.2 HAT+ Compact differ in the following ways: + +* M.2 HAT+ supports devices with the 2230 or 2242 form factor; M.2 HAT+ Compact only supports the 2230 form factor. + +=== Hardware + +The Raspberry Pi M.2 HAT+ or M.2 HAT+ Compact box contains the following parts: + +* Ribbon cable +* Threaded spacers +* Screws +* 1 knurled double-flanged drive attachment screw to secure and support the M.2 peripheral + +The M.2 HAT+ also includes a 16 mm GPIO stacking header; M.2 HAT+ Compact doesn't include this component. + +To use the M.2 HAT+ or M.2 HAT+ Compact, you also need: + +* A Raspberry Pi 5 + +[[m2-hat-plus-installation]] +== Prepare your Raspberry Pi + +. Ensure that your Raspberry Pi runs the latest software. Run the following command to update: ++ +[source,console] +---- +$ sudo apt update && sudo apt full-upgrade +---- + +. xref:../computers/raspberry-pi.adoc#update-the-bootloader-configuration[Ensure that your Raspberry Pi firmware is up-to-date]. Run the following command to see what firmware you're running: ++ +[source,console] +---- +$ sudo rpi-eeprom-update +---- ++ +If you see December 6, 2023 or a later date, proceed to the next step. If you see a date earlier than December 6, 2023, run the following command to open the Raspberry Pi Configuration CLI: ++ +[source,console] +---- +$ sudo raspi-config +---- ++ +Under `Advanced Options` > `Bootloader Version`, choose `Latest`. Then, exit `raspi-config` with `Finish` or the *Escape* key. ++ +Run the following command to update your firmware to the latest version: ++ +[source,console] +---- +$ sudo rpi-eeprom-update -a +---- ++ +Then, reboot with `sudo reboot`. + +. Disconnect the Raspberry Pi from power before beginning installation. + +[[standard-installation]] +== Install the M.2 HAT+ + +Follow these steps to install the M.2 HAT+. To install the M.2 HAT+ Compact go to <> instead. + +=== (Optional) Install the Active Cooler + +. The M.2 HAT+ is compatible with the Raspberry Pi 5 Active Cooler. If you have an Active Cooler, install it before installing the M.2 HAT+. ++ +-- +image::images/m2-hat-plus-installation-01.png[width="60%"] +-- + +=== Install the mounting hardware + +. Install the spacers using the provided screws. + +. Firmly press the GPIO stacking header on top of the Raspberry Pi GPIO pins; orientation doesn't matter as long as all pins fit into place. + +. Disconnect the ribbon cable from the M.2 HAT+. Insert the other end into the PCIe port of your Raspberry Pi. Lift the ribbon cable holder from both sides, then insert the cable with the copper contact points facing inward, towards the USB ports. With the ribbon cable fully and evenly inserted into the PCIe port, push the cable holder down from both sides to secure the ribbon cable firmly in place. + +-- +image::images/m2-hat-plus-installation-02.png[width="60%"] +-- + +=== Install the board + +. Set the M.2 HAT+ on top of the spacers and use the remaining screws to secure it in place. ++ +-- +image::images/m2-hat-plus-installation-03.png[width="60%"] +-- + +. Insert the ribbon cable into the slot on the M.2 HAT+. ++ +Lift the ribbon cable holder from both sides, then insert the cable with the copper contact points facing up. With the ribbon cable fully and evenly inserted into the port, push the cable holder down from both sides to secure the ribbon cable firmly in place. ++ +-- +image::images/m2-hat-plus-installation-04.png[width="60%"] +-- + +=== Install your M.2 drive + +. Remove the drive attachment screw by turning the screw counter-clockwise. Insert your M.2 SSD into the M.2 key edge connector, sliding the drive into the slot at a slight upward angle. Do not force the drive into the slot: it should slide in gently. ++ +-- +image::images/m2-hat-plus-installation-05.png[width="60%"] +-- + +. Push the notch on the drive attachment screw into the slot at the end of your M.2 drive. Push the drive flat against the M.2 HAT+, and insert the SSD attachment screw by turning the screw clockwise until the SSD feels secure. Do not over-tighten the screw. ++ +-- +image::images/m2-hat-plus-installation-06.png[width="60%"] +-- + +Congratulations, you have successfully installed the M.2 HAT+. + +.Installed M.2 HAT+ +image::images/m2-hat-plus-installation-07.png[width="80%"] + + +[[compact-installation]] +== Install the M.2 HAT+ Compact + +Follow these steps to install the M.2 HAT+ Compact. To install the M.2 HAT+ go to <> instead. + +=== Install the mounting hardware + +. Install the spacers using the provided screws. ++ +-- +image::images/m2-hat-plus-compact-installation-02.png[width="60%"] +-- + +=== Install the board + +. Set the M.2 HAT+ Compact on top of the spacers and use the remaining screws to secure it in place. ++ +-- +image::images/m2-hat-plus-compact-installation-03.png[width="60%"] +-- + +. Insert the ribbon cable into the PCIe port of your Raspberry Pi. ++ +Lift the ribbon cable holder from both sides, then insert the cable with the copper contact points facing inward, towards the USB ports. With the ribbon cable fully and evenly inserted into the PCIe port, push the cable holder down from both sides to secure the ribbon cable firmly in place. ++ +-- +image::images/m2-hat-plus-compact-installation-04.png[width="60%"] +-- + +=== Install your M.2 drive + +. Remove the drive attachment screw by turning the screw counter-clockwise. Insert your M.2 SSD into the M.2 key edge connector, sliding the drive into the slot at a slight upward angle. Do not force the drive into the slot: it should slide in gently. ++ +-- +image::images/m2-hat-plus-compact-installation-05.png[width="60%"] +-- + +. Push the notch on the drive attachment screw into the slot at the end of your M.2 drive. Push the drive flat against the M.2 HAT+ Compact, and insert the SSD attachment screw by turning the screw clockwise until the SSD feels secure. Do not over-tighten the screw. ++ +-- +image::images/m2-hat-plus-compact-installation-06.png[width="60%"] +-- + +Congratulations, you have successfully installed the M.2 HAT+ Compact. + +.Installed M.2 HAT+ Compact +image::images/m2-hat-plus-compact-installation-07.png[width="80%"] + +== Start your Raspberry Pi + +. Connect your Raspberry Pi to power; Raspberry Pi OS automatically detects the M.2 HAT+ or M.2 HAT+ Compact. If you use Raspberry Pi Desktop, you see an icon representing the drive on your desktop. If you don't use a desktop, you can find the drive at `/dev/nvme0n1`. + +. To make your drive automatically available for file access, consider xref:../computers/configuration.adoc#automatically-mount-a-storage-device[configuring automatic mounting]. + +WARNING: Always disconnect your Raspberry Pi from power before connecting or disconnecting a device from the M.2 slot. + +== Boot from NVMe + +To boot from an NVMe drive attached to the M.2 HAT+ or M.2 HAT+ Compact, complete the following steps: + +. xref:../computers/getting-started.adoc#raspberry-pi-imager[Install an operating system to your NVMe drive by using Raspberry Pi Imager]. You can do this from your Raspberry Pi if you already have an SD card with a Raspberry Pi OS image. +. Reboot your Raspberry Pi. +* If you don't have an SD card inserted in your Raspberry Pi 5, it boots automatically from your NVMe drive. +* If you do have an SD card inserted in your Raspberry Pi 5, it attempts to boot from the SD card first. You can change the boot order on your Raspberry Pi by completing the following steps: +.. Boot your Raspberry Pi into Raspberry Pi OS using an SD card. +.. In a terminal on your Raspberry Pi, run `sudo raspi-config` to open the Raspberry Pi Configuration CLI. +.. Under `Advanced Options` > `Boot Order`, choose `NVMe/USB boot`. +.. Exit `raspi-config` with `Finish` or the *Escape* key. +.. Reboot your Raspberry Pi with `sudo reboot`. + +For more information, see xref:../computers/raspberry-pi.adoc#nvme-ssd-boot[NVMe boot]. + +== Enable PCIe Gen 3 + +WARNING: The Raspberry Pi 5 is not certified for Gen 3.0 speeds. PCIe Gen 3.0 connections may be unstable. + +To enable PCIe Gen 3 speeds, follow the instructions at xref:../computers/raspberry-pi.adoc#pcie-gen-3-0[enable PCIe Gen 3.0]. + +== Schematics + +The schematics for the M.2 HAT+ are available as a https://datasheets.raspberrypi.com/m2-hat-plus/raspberry-pi-m2-hat-plus-schematics.pdf[PDF] + +== Product brief + +For more information about the M.2 HAT+ and M.2 HAT+ Compact, including mechanical specifications and operating environment limitations, see the https://datasheets.raspberrypi.com/m2-hat-plus/raspberry-pi-m2-hat-plus-product-brief.pdf[product brief]. diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-02.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-02.png new file mode 100644 index 000000000..7733a5e5c Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-02.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-03.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-03.png new file mode 100644 index 000000000..c7b34e880 Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-03.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-04.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-04.png new file mode 100644 index 000000000..6b6eace10 Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-04.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-05.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-05.png new file mode 100644 index 000000000..104b024fc Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-05.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-06.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-06.png new file mode 100644 index 000000000..3ca9c2d1f Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-06.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-07.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-07.png new file mode 100644 index 000000000..45ddcdd41 Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-installation-07.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-with-case.jpg b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-with-case.jpg new file mode 100644 index 000000000..84d26b5b7 Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-compact-with-case.jpg differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-01.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-01.png new file mode 100644 index 000000000..89eda454c Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-01.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-02.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-02.png new file mode 100644 index 000000000..b11d07a45 Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-02.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-03.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-03.png new file mode 100644 index 000000000..c11a504ee Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-03.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-04.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-04.png new file mode 100644 index 000000000..ae6e321dc Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-04.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-05.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-05.png new file mode 100644 index 000000000..0a93df849 Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-05.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-06.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-06.png new file mode 100644 index 000000000..209ec6cbc Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-06.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-07.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-07.png new file mode 100644 index 000000000..238b75df8 Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-installation-07.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-schematics.png b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-schematics.png new file mode 100644 index 000000000..5d0688fbd Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus-schematics.png differ diff --git a/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus.jpg b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus.jpg new file mode 100644 index 000000000..30a05a30b Binary files /dev/null and b/documentation/asciidoc/accessories/m2-hat-plus/images/m2-hat-plus.jpg differ diff --git a/documentation/asciidoc/accessories/monitor.adoc b/documentation/asciidoc/accessories/monitor.adoc new file mode 100644 index 000000000..b100eb439 --- /dev/null +++ b/documentation/asciidoc/accessories/monitor.adoc @@ -0,0 +1 @@ +include::monitor/monitor_intro.adoc[] diff --git a/documentation/asciidoc/accessories/monitor/images/drill-hole-template.pdf b/documentation/asciidoc/accessories/monitor/images/drill-hole-template.pdf new file mode 100644 index 000000000..1d77318e3 Binary files /dev/null and b/documentation/asciidoc/accessories/monitor/images/drill-hole-template.pdf differ diff --git a/documentation/asciidoc/accessories/monitor/images/drill-hole-template.png b/documentation/asciidoc/accessories/monitor/images/drill-hole-template.png new file mode 100644 index 000000000..a1553774a Binary files /dev/null and b/documentation/asciidoc/accessories/monitor/images/drill-hole-template.png differ diff --git a/documentation/asciidoc/accessories/monitor/images/mechanical-drawing.pdf b/documentation/asciidoc/accessories/monitor/images/mechanical-drawing.pdf new file mode 100644 index 000000000..d74544841 Binary files /dev/null and b/documentation/asciidoc/accessories/monitor/images/mechanical-drawing.pdf differ diff --git a/documentation/asciidoc/accessories/monitor/images/mechanical-drawing.png b/documentation/asciidoc/accessories/monitor/images/mechanical-drawing.png new file mode 100644 index 000000000..41faee30b Binary files /dev/null and b/documentation/asciidoc/accessories/monitor/images/mechanical-drawing.png differ diff --git a/documentation/asciidoc/accessories/monitor/images/monitor-hero.png b/documentation/asciidoc/accessories/monitor/images/monitor-hero.png new file mode 100644 index 000000000..b8c91e40f Binary files /dev/null and b/documentation/asciidoc/accessories/monitor/images/monitor-hero.png differ diff --git a/documentation/asciidoc/accessories/monitor/images/no-hdmi.png b/documentation/asciidoc/accessories/monitor/images/no-hdmi.png new file mode 100644 index 000000000..408ad418b Binary files /dev/null and b/documentation/asciidoc/accessories/monitor/images/no-hdmi.png differ diff --git a/documentation/asciidoc/accessories/monitor/images/no-valid-hdmi-signal-standby.png b/documentation/asciidoc/accessories/monitor/images/no-valid-hdmi-signal-standby.png new file mode 100644 index 000000000..2c0312118 Binary files /dev/null and b/documentation/asciidoc/accessories/monitor/images/no-valid-hdmi-signal-standby.png differ diff --git a/documentation/asciidoc/accessories/monitor/images/not-supported-resolution.png b/documentation/asciidoc/accessories/monitor/images/not-supported-resolution.png new file mode 100644 index 000000000..533421738 Binary files /dev/null and b/documentation/asciidoc/accessories/monitor/images/not-supported-resolution.png differ diff --git a/documentation/asciidoc/accessories/monitor/images/power-saving-mode.png b/documentation/asciidoc/accessories/monitor/images/power-saving-mode.png new file mode 100644 index 000000000..106694ee1 Binary files /dev/null and b/documentation/asciidoc/accessories/monitor/images/power-saving-mode.png differ diff --git a/documentation/asciidoc/accessories/monitor/monitor_intro.adoc b/documentation/asciidoc/accessories/monitor/monitor_intro.adoc new file mode 100644 index 000000000..b6d3d2233 --- /dev/null +++ b/documentation/asciidoc/accessories/monitor/monitor_intro.adoc @@ -0,0 +1,119 @@ +== Raspberry Pi Monitor + +The https://www.raspberrypi.com/products/raspberry-pi-monitor/[Raspberry Pi Monitor] is a 15.6" 1920 × 1080p IPS LCD display that connects to a computer using an HDMI cable. The Monitor also requires a USB-C power source. For full brightness and volume range, this must be a USB-PD source capable of at least 1.5A of current. + +.The Raspberry Pi Monitor +image::images/monitor-hero.png[The Raspberry Pi Monitor, width="100%"] + +The Monitor is compatible with all models of Raspberry Pi that support HDMI output. + +=== Controls + +The back of the Monitor includes the following controls: + +* a button that enters and exits Standby mode (indicated by the ⏻ (power) symbol) +* buttons that increase and decrease display brightness (indicated by the 🔆 (sun) symbol) +* buttons that increase and decrease speaker volume (indicated by the 🔈 (speaker) symbol) + +=== On screen display messages + +The on-screen display (OSD) may show the following messages: + +[cols="1a,6"] +|=== +| Message | Description + +| image::images/no-hdmi.png[No HDMI signal detected] +| No HDMI signal detected. + +| image::images/no-valid-hdmi-signal-standby.png[Standby mode] +| The monitor will soon enter standby mode to conserve power. + +| image::images/not-supported-resolution.png[Unsupported resolution] +| The output display resolution of the connected device is not supported. + +| image::images/power-saving-mode.png[Power saving mode] +| The monitor is operating in Power Saving mode, with reduced brightness and volume, because the monitor is not connected to a power supply capable of delivering 1.5A of current or greater. +|=== + +Additionally, the OSD shows information about display brightness changes using the 🔆 (sun) symbol, and speaker volume level changes using the 🔈 (speaker) symbol. Both brightness and volume use a scale that ranges from 0 to 100. + +TIP: If you attempt to exit Standby mode when the display cannot detect an HDMI signal, the red LED beneath the Standby button will briefly light, but the display will remain in Standby mode. + +=== Position the Monitor + +Use the following approaches to position the Monitor: + +* Angle the Monitor on the integrated stand. +* Mount the Monitor on an arm or stand using the four VESA mount holes on the back of the red rear plastic housing. ++ +IMPORTANT: Use spacers to ensure adequate space for display and power cable egress. +* Flip the integrated stand fully upwards, towards the top of the monitor. Use the drill hole template to create two mounting points spaced 55mm apart. Hang the Monitor using the slots on the back of the integrated stand. ++ +.Drill hole template +image::images/drill-hole-template.png[Drill hole template, width="40%"] + +=== Power the Monitor + +The Raspberry Pi Monitor draws power from a 5V https://en.wikipedia.org/wiki/USB_hardware#USB_Power_Delivery[USB Power Delivery] (USB-PD) power source. Many USB-C power supplies, including the official power supplies for the Raspberry Pi 4 and Raspberry Pi 5, support this standard. + +When using a power source that provides at least 1.5A of current over USB-PD, the Monitor operates in **Full Power mode**. In Full Power mode, you can use the full range (0%-100%) of display brightness and speaker volume. + +When using a power source that does _not_ supply at least 1.5A of current over USB-PD (including all USB-A power sources), the Monitor operates in **Power Saving mode**. Power Saving mode limits the maximum display brightness and the maximum speaker volume to ensure reliable operation. In Power Saving mode, you can use a limited range (0-50%) of display brightness and a limited range (0-60%) of speaker volume. When powered from a Raspberry Pi, the Monitor operates in Power Saving mode, since Raspberry Pi devices cannot provide 1.5A of current over a USB-A connection. + +To switch from Power Saving mode to Full Power mode, press and hold the *increase brightness* button for 3 seconds. + +[TIP] +==== +If the Monitor flashes on and off, your USB power supply is not capable of providing sufficient current to power the monitor. This can happen if you power the Monitor from a Raspberry Pi 5, 500, or 500+ which is itself powered by a 5V/3A power supply. Try the following fixes to stop the Monitor from flashing on and off: + +* reduce the display brightness and volume (you may have to connect your monitor to another power supply to access the settings) +* switch to a different power source or cable + +==== + +=== Specification + +Diagonal: 15.6" + +Resolution: 1920 × 1080 + +Type: IPS LCD + +Colour gamut: 45% + +Contrast: 800:1 + +Brightness: 250cd/m^2^ + +Screen coating: Anti-glare 3H hardness + +Display area: 344 × 193mm + +Dimensions: 237 × 360 × 20mm + +Weight: 850g + +Supported resolutions: + +* 1920 × 1080p @ 50/60Hz +* 1280 × 720p @ 50/60Hz +* 720 × 576p @ 50/60Hz +* 720 × 480p @ 50/60Hz +* 640 × 480p @ 50/60Hz + +Input: HDMI 1.4; supports DDC-CI + +Power input: USB-C; requires 1.5A over USB-PD at 5V for full brightness and volume range + +Power consumption: 4.5-6.5W during use; < 0.1W at idle + +Speakers: 2 × 1.2W (stereo) + +Ports: 3.5mm audio jack + + +=== Mechanical drawing + +.Mechanical Drawing +image::images/mechanical-drawing.png[Mechanical drawing, width="80%"] diff --git a/documentation/asciidoc/accessories/sd-cards.adoc b/documentation/asciidoc/accessories/sd-cards.adoc new file mode 100644 index 000000000..ffdb0161a --- /dev/null +++ b/documentation/asciidoc/accessories/sd-cards.adoc @@ -0,0 +1 @@ +include::sd-cards/about.adoc[] diff --git a/documentation/asciidoc/accessories/sd-cards/about.adoc b/documentation/asciidoc/accessories/sd-cards/about.adoc new file mode 100644 index 000000000..1d8f41170 --- /dev/null +++ b/documentation/asciidoc/accessories/sd-cards/about.adoc @@ -0,0 +1,37 @@ +== About + +.A Raspberry Pi SD Card inserted into a Raspberry Pi 5 +image::images/sd-hero.jpg[width="80%"] + +SD card quality is a critical factor in determining the overall user experience for a Raspberry Pi. Slow bus speeds and lack of command queueing can reduce the performance of even the most powerful Raspberry Pi models. + +Raspberry Pi's official microSD cards support DDR50 and SDR104 bus speeds. Additionally, Raspberry Pi SD cards support the command queueing (CQ) extension, which permits some pipelining of random read operations, ensuring optimal performance. + +You can even buy Raspberry Pi SD cards pre-programmed with the latest version of Raspberry Pi OS. + +Raspberry Pi SD cards are available in the following sizes: + +* 32GB +* 64GB +* 128GB + +== Specifications + +.A 128GB Raspberry Pi SD Card +image::images/sd-cards.png[width="80%"] + +Raspberry Pi SD cards use the SD6.1 SD specification. + +Raspberry Pi SD cards use the microSDHC/microSDXC form factor. + +Raspberry Pi SD cards have the following Speed Class ratings: C10, U3, V30, A2. + +The following table describes the read and write speeds of Raspberry Pi SD cards using 4KB of random data: + +|=== +| Raspberry Pi Model | Interface | Read Speed | Write Speed + +| 4 | DDR50 | 3,200 IOPS | 1,200 IOPS +| 5 | SDR104 | 5,000 IOPS | 2,000 IOPS +|=== + diff --git a/documentation/asciidoc/accessories/sd-cards/images/sd-cards.png b/documentation/asciidoc/accessories/sd-cards/images/sd-cards.png new file mode 100644 index 000000000..9651ba959 Binary files /dev/null and b/documentation/asciidoc/accessories/sd-cards/images/sd-cards.png differ diff --git a/documentation/asciidoc/accessories/sd-cards/images/sd-hero.jpg b/documentation/asciidoc/accessories/sd-cards/images/sd-hero.jpg new file mode 100644 index 000000000..759745039 Binary files /dev/null and b/documentation/asciidoc/accessories/sd-cards/images/sd-hero.jpg differ diff --git a/documentation/asciidoc/accessories/sense-hat.adoc b/documentation/asciidoc/accessories/sense-hat.adoc index 1f0294676..c0db67f2b 100644 --- a/documentation/asciidoc/accessories/sense-hat.adoc +++ b/documentation/asciidoc/accessories/sense-hat.adoc @@ -1,6 +1,5 @@ - include::sense-hat/intro.adoc[] -include::sense-hat/software.adoc[] - include::sense-hat/hardware.adoc[] + +include::sense-hat/software.adoc[] diff --git a/documentation/asciidoc/accessories/sense-hat/hardware.adoc b/documentation/asciidoc/accessories/sense-hat/hardware.adoc index a7abafd1e..735ce713a 100644 --- a/documentation/asciidoc/accessories/sense-hat/hardware.adoc +++ b/documentation/asciidoc/accessories/sense-hat/hardware.adoc @@ -1,4 +1,4 @@ -== Sense HAT hardware +== Features The Sense HAT has an 8×8 RGB LED matrix and a five-button joystick, and includes the following sensors: @@ -18,142 +18,8 @@ Schematics and mechanical drawings for the Sense HAT and the Sense HAT V2 are av === LED matrix -The LED matrix is an RGB565 https://www.kernel.org/doc/Documentation/fb/framebuffer.txt[framebuffer] with the id "RPi-Sense FB". The appropriate device node can be written to as a standard file or mmap-ed. The included 'snake' example shows how to access the framebuffer. +The LED matrix is an RGB565 https://www.kernel.org/doc/Documentation/fb/framebuffer.txt[framebuffer] with the id `RPi-Sense FB`. The appropriate device node can be written to as a standard file or mmap-ed. The included snake example shows how to access the framebuffer. === Joystick -The joystick comes up as an input event device named "Raspberry Pi Sense HAT Joystick", mapped to the arrow keys and `Enter`. It should be supported by any library which is capable of handling inputs, or directly through the https://www.kernel.org/doc/Documentation/input/input.txt[evdev interface]. Suitable libraries include SDL, http://www.pygame.org/docs/[pygame] and https://python-evdev.readthedocs.org/en/latest/[python-evdev]. The included 'snake' example shows how to access the joystick directly. - -== Hardware calibration - -Install the necessary software and run the calibration program as follows: - -[,bash] ----- -$ sudo apt update -$ sudo apt install octave -y -$ cd -$ cp /usr/share/librtimulib-utils/RTEllipsoidFit ./ -a -$ cd RTEllipsoidFit -$ RTIMULibCal ----- - -You will then see this menu: - ----- -Options are: - - m - calibrate magnetometer with min/max - e - calibrate magnetometer with ellipsoid (do min/max first) - a - calibrate accelerometers - x - exit - -Enter option: ----- - -Press lowercase `m`. The following message will then show. Press any key to start. - ----- - Magnetometer min/max calibration - -------------------------------- - Waggle the IMU chip around, ensuring that all six axes - (+x, -x, +y, -y and +z, -z) go through their extrema. - When all extrema have been achieved, enter 's' to save, 'r' to reset - or 'x' to abort and discard the data. - - Press any key to start... ----- - -After it starts, you will see something similar to this scrolling up the screen: - ----- - Min x: 51.60 min y: 69.39 min z: 65.91 - Max x: 53.15 max y: 70.97 max z: 67.97 ----- - -Focus on the two lines at the very bottom of the screen, as these are the most recently posted measurements from the program. - -Now, pick up the Raspberry Pi and Sense HAT and move it around in every possible way you can think of. It helps if you unplug all non-essential cables to avoid clutter. - -Try and get a complete circle in each of the pitch, roll and yaw axes. Take care not to accidentally eject the SD card while doing this. Spend a few minutes moving the Sense HAT, and stop when you find that the numbers are not changing anymore. - -Now press lowercase `s` then lowercase `x` to exit the program. If you run the `ls` command now, you'll see a new `RTIMULib.ini` file has been created. - -In addition to those steps, you can also do the ellipsoid fit by performing the steps above, but pressing `e` instead of `m`. - -When you're done, copy the resulting `RTIMULib.ini` to /etc/ and remove the local copy in `~/.config/sense_hat/`: - -[,bash] ----- -$ rm ~/.config/sense_hat/RTIMULib.ini -$ sudo cp RTIMULib.ini /etc ----- - -== Reading and writing EEPROM data - -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 - dtparam=i2c_arm=on ----- - -Enter the following command to reboot: - -[,bash] ----- - sudo systemctl reboot ----- - -Download and build the flash tool: - -[,bash] ----- -$ git clone https://github.com/raspberrypi/hats.git -$ cd hats/eepromutils -$ make ----- - -NOTE: These steps may not work on Raspberry Pi 2 Model B Rev 1.0 and Raspberry Pi 3 Model B boards. The firmware will take control of I2C0, causing the ID pins to be configured as inputs. - -=== Reading - -EEPROM data can be read with the following command: - -[,bash] ----- -$ sudo ./eepflash.sh -f=sense_read.eep -t=24c32 -r ----- - -=== Writing - -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/firmware/overlays/rpi-sense-overlay.dtb ----- - -Disable write protection: - -[,bash] ----- -$ i2cset -y -f 1 0x46 0xf3 1 ----- - -Write the EEPROM data: - -[,bash] ----- -$ sudo ./eepflash.sh -f=sense.eep -t=24c32 -w ----- - -Re-enable write protection: - -[,bash] ----- - i2cset -y -f 1 0x46 0xf3 0 ----- - -WARNING: This operation will not damage your Raspberry Pi or Sense Hat, but if an error occurs, the HAT may no longer be automatically detected. The steps above are provided for debugging purposes only. +The joystick comes up as an input event device named `Raspberry Pi Sense HAT Joystick`, mapped to the arrow keys and **Enter**. It should be supported by any library which is capable of handling inputs, or directly through the https://www.kernel.org/doc/Documentation/input/input.txt[evdev interface]. Suitable libraries include SDL, http://www.pygame.org/docs/[pygame] and https://python-evdev.readthedocs.org/en/latest/[python-evdev]. The included `snake` example shows how to access the joystick directly. diff --git a/documentation/asciidoc/accessories/sense-hat/images/Sense-HAT.jpg b/documentation/asciidoc/accessories/sense-hat/images/Sense-HAT.jpg index ef74aa37a..e1eebd815 100644 Binary files a/documentation/asciidoc/accessories/sense-hat/images/Sense-HAT.jpg and b/documentation/asciidoc/accessories/sense-hat/images/Sense-HAT.jpg differ diff --git a/documentation/asciidoc/accessories/sense-hat/intro.adoc b/documentation/asciidoc/accessories/sense-hat/intro.adoc index ebf2c15c5..01f8a2425 100644 --- a/documentation/asciidoc/accessories/sense-hat/intro.adoc +++ b/documentation/asciidoc/accessories/sense-hat/intro.adoc @@ -1,9 +1,9 @@ -== Introducing the Sense HAT +== About -The https://www.raspberrypi.com/products/sense-hat/[Raspberry Pi Sense HAT] is an add-on board that gives your Raspberry Pi an array of sensing capabilities. The on-board sensors allow you to monitor pressure, humidity, temperature, colour, orientation, and movement. The bright 8×8 RGB LED matrix allows you to visualise data from the sensors, and the five-button joystick lets users interact with your projects. +The https://www.raspberrypi.com/products/sense-hat/[Raspberry Pi Sense HAT] is an add-on board that gives your Raspberry Pi an array of sensing capabilities. The on-board sensors allow you to monitor pressure, humidity, temperature, colour, orientation, and movement. The 8×8 RGB LED matrix allows you to visualise data from the sensors. The five-button joystick lets users interact with your projects. image::images/Sense-HAT.jpg[width="70%"] -The Sense HAT was originally developed for use on the International Space Station, as part of the educational https://astro-pi.org/[Astro Pi] programme run by the https://raspberrypi.org[Raspberry Pi Foundation] in partnership with the https://www.esa.int/[European Space Agency]. It is well suited to many projects that require position, motion, orientation, or environmental sensing. The Sense HAT is powered by the Raspberry Pi computer to which it is connected. +The Sense HAT was originally developed for use on the International Space Station as part of the educational https://astro-pi.org/[Astro Pi] programme run by the https://raspberrypi.org[Raspberry Pi Foundation] in partnership with the https://www.esa.int/[European Space Agency]. It can help with any project that requires position, motion, orientation, or environmental sensing. -An officially supported xref:sense-hat.adoc#using-the-sense-hat-with-python[Python library] provides access to all of the on-board sensors, the LED matrix, and the joystick. The Sense HAT is compatible with any Raspberry Pi computer with a 40-pin GPIO header. +An officially supported xref:sense-hat.adoc#use-the-sense-hat-with-python[Python library] provides access to the on-board sensors, LED matrix, and joystick. The Sense HAT is compatible with any Raspberry Pi device with a 40-pin GPIO header. diff --git a/documentation/asciidoc/accessories/sense-hat/software.adoc b/documentation/asciidoc/accessories/sense-hat/software.adoc index 32294cdae..33261939a 100644 --- a/documentation/asciidoc/accessories/sense-hat/software.adoc +++ b/documentation/asciidoc/accessories/sense-hat/software.adoc @@ -1,46 +1,191 @@ -== Installation +== Install -In order to work correctly, the Sense HAT requires an up-to-date kernel, I2C to be enabled, and a few libraries to get started. +In order to work correctly, the Sense HAT requires: -Ensure your APT package list is up-to-date: +* an up-to-date kernel +* https://en.wikipedia.org/wiki/I%C2%B2C[I2C] enabled on your Raspberry Pi +* a few dependencies + +Complete the following steps to get your Raspberry Pi device ready to connect to the Sense HAT: + +. First, ensure that your Raspberry Pi runs the latest software. Run the following command to update: ++ +[source,console] +---- +$ sudo apt update && sudo apt full-upgrade +---- + +. Next, install the `sense-hat` package, which will ensure the kernel is up to date, enable I2C, and install the necessary dependencies: ++ +[source,console] +---- +$ sudo apt install sense-hat +---- + +. Finally, reboot your Raspberry Pi to enable I2C and load the new kernel, if it changed: ++ +[source,console] +---- +$ sudo reboot +---- + +== Calibrate + +Install the necessary software and run the calibration program as follows: + +[source,console] +---- +$ sudo apt update +$ sudo apt install octave -y +$ cd +$ cp /usr/share/librtimulib-utils/RTEllipsoidFit ./ -a +$ cd RTEllipsoidFit +$ RTIMULibCal +---- + +The calibration program displays the following menu: -[,bash] ---- - sudo apt update +Options are: + + m - calibrate magnetometer with min/max + e - calibrate magnetometer with ellipsoid (do min/max first) + a - calibrate accelerometers + x - exit + +Enter option: +---- + +Press lowercase `m`. The following message will then show. Press any key to start. + +---- +Magnetometer min/max calibration +------------------------------- +Waggle the IMU chip around, ensuring that all six axes +(+x, -x, +y, -y and +z, -z) go through their extrema. +When all extrema have been achieved, enter 's' to save, 'r' to reset +or 'x' to abort and discard the data. + +Press any key to start... ---- -Next, install the sense-hat package, which will ensure the kernel is up to date, enable I2C, and install the necessary libraries and programs: +After it starts, you should see output similar to the following scrolling up the screen: -[,bash] ---- - sudo apt install sense-hat +Min x: 51.60 min y: 69.39 min z: 65.91 +Max x: 53.15 max y: 70.97 max z: 67.97 ---- -Finally, a reboot may be required if I2C was disabled or the kernel was not up-to-date prior to the install: +Focus on the two lines at the very bottom of the screen, as these are the most recently posted measurements from the program. + +Now, pick up the Raspberry Pi and Sense HAT and move it around in every possible way you can think of. It helps if you unplug all non-essential cables to avoid clutter. + +Try and get a complete circle in each of the pitch, roll and yaw axes. Take care not to accidentally eject the SD card while doing this. Spend a few minutes moving the Sense HAT, and stop when you find that the numbers are not changing any more. -[,bash] +Now press lowercase `s` then lowercase `x` to exit the program. If you run the `ls` command now, you'll see a new `RTIMULib.ini` file has been created. + +In addition to those steps, you can also do the ellipsoid fit by performing the steps above, but pressing `e` instead of `m`. + +When you're done, copy the resulting `RTIMULib.ini` to `/etc/` and remove the local copy in `~/.config/sense_hat/`: + +[source,console] ---- - sudo reboot +$ rm ~/.config/sense_hat/RTIMULib.ini +$ sudo cp RTIMULib.ini /etc ---- == Getting started After installation, example code can be found under `/usr/src/sense-hat/examples`. -[.booklink, booktype="free", link=https://github.com/raspberrypipress/released-pdfs/raw/main/experiment-with-the-sense-hat.pdf, image=image::images/experiment-with-the-sense-hat.png[]] -=== Further reading -You can find more information on how to use the Sense HAT in the Raspberry Pi Press book https://github.com/raspberrypipress/released-pdfs/raw/main/experiment-with-the-sense-hat.pdf[Experiment with the Sense HAT]. Written by The Raspberry Pi Foundation's Education Team, it is part of the MagPi Essentials series published by Raspberry Pi Press. The book covers the background of the Astro Pi project, and walks you through how to make use of all the Sense HAT features using the xref:sense-hat.adoc#using-the-sense-hat-with-python[Python library]. - -=== Using the Sense HAT with Python +=== Use the Sense HAT with Python `sense-hat` is the officially supported library for the Sense HAT; it provides access to all of the on-board sensors and the LED matrix. Complete documentation for the library can be found at https://sense-hat.readthedocs.io/en/latest/[sense-hat.readthedocs.io]. -=== Using the Sense HAT with {cpp} +=== Use the Sense HAT with C++ https://github.com/RPi-Distro/RTIMULib[RTIMULib] is a {cpp} and Python library that makes it easy to use 9-dof and 10-dof IMUs with embedded Linux systems. A pre-calibrated settings file is provided in `/etc/RTIMULib.ini`, which is also copied and used by `sense-hat`. The included examples look for `RTIMULib.ini` in the current working directory, so you may wish to copy the file there to get more accurate data. The RTIMULibDrive11 example comes pre-compiled to help ensure everything works as intended. It can be launched by running `RTIMULibDrive11` and closed by pressing `Ctrl C`. NOTE: The C/{cpp} examples can be compiled by running `make` in the appropriate directory. + +== Troubleshooting + +=== Read and write EEPROM data + +These steps are provided for debugging purposes only. + +NOTE: On Raspberry Pi 2 Model B Rev 1.0 and Raspberry Pi 3 Model B boards, these steps may not work. The firmware will take control of I2C0, causing the ID pins to be configured as inputs. + +Before you can read and write EEPROM data to and from the Sense HAT, you must complete the following steps: + +. 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: ++ +[source,ini] +---- +dtparam=i2c_vc=on +dtparam=i2c_arm=on +---- + +. Run the following command to reboot: ++ +[source,console] +---- +$ sudo reboot +---- + +. Download and build the flash tool: ++ +[source,console] +---- +$ git clone https://github.com/raspberrypi/hats.git +$ cd hats/eepromutils +$ make +---- + +==== Read + +To read EEPROM data, run the following command: + +[source,console] +---- +$ sudo ./eepflash.sh -f=sense_read.eep -t=24c32 -r +---- + +==== Write + +NOTE: This operation will not damage your Raspberry Pi or Sense HAT, but if an error occurs, your Raspberry Pi may fail to automatically detect the HAT. + + +. First, download EEPROM settings and build the `.eep` binary: ++ +[source,console] +---- +$ wget https://github.com/raspberrypi/rpi-sense/raw/master/eeprom/eeprom_settings.txt -O sense_eeprom.txt +$ ./eepmake sense_eeprom.txt sense.eep /boot/firmware/overlays/rpi-sense-overlay.dtb +---- + +. Next, disable write protection: ++ +[source,console] +---- +$ i2cset -y -f 1 0x46 0xf3 1 +---- + +. Write the EEPROM data: ++ +[source,console] +---- +$ sudo ./eepflash.sh -f=sense.eep -t=24c32 -w +---- + +. Finally, re-enable write protection: ++ +[source,console] +---- +$ i2cset -y -f 1 0x46 0xf3 0 +---- + diff --git a/documentation/asciidoc/accessories/ssd-kit.adoc b/documentation/asciidoc/accessories/ssd-kit.adoc new file mode 100644 index 000000000..2533220b5 --- /dev/null +++ b/documentation/asciidoc/accessories/ssd-kit.adoc @@ -0,0 +1 @@ +include::ssd-kit/about.adoc[] diff --git a/documentation/asciidoc/accessories/ssd-kit/about.adoc b/documentation/asciidoc/accessories/ssd-kit/about.adoc new file mode 100644 index 000000000..390aef6d3 --- /dev/null +++ b/documentation/asciidoc/accessories/ssd-kit/about.adoc @@ -0,0 +1,13 @@ +== About + +.A 512GB Raspberry Pi SSD Kit +image::images/ssd-kit.png[width="80%"] + +The Raspberry Pi SSD Kit bundles a xref:../accessories/m2-hat-plus.adoc[Raspberry Pi M.2 HAT+] with a xref:../accessories/ssds.adoc[Raspberry Pi SSD]. + +The Raspberry Pi SSD Kit includes a 16mm stacking header, spacers, and +screws to enable fitting on Raspberry Pi 5 alongside a Raspberry Pi Active Cooler. + +== Install + +To install the Raspberry Pi SSD Kit, follow the xref:../accessories/m2-hat-plus.adoc#m2-hat-plus-installation[installation instructions for the Raspberry Pi M.2 HAT+]. diff --git a/documentation/asciidoc/accessories/ssd-kit/images/ssd-kit.png b/documentation/asciidoc/accessories/ssd-kit/images/ssd-kit.png new file mode 100644 index 000000000..9381c5ca1 Binary files /dev/null and b/documentation/asciidoc/accessories/ssd-kit/images/ssd-kit.png differ diff --git a/documentation/asciidoc/accessories/ssds.adoc b/documentation/asciidoc/accessories/ssds.adoc new file mode 100644 index 000000000..3934f0db6 --- /dev/null +++ b/documentation/asciidoc/accessories/ssds.adoc @@ -0,0 +1 @@ +include::ssds/about.adoc[] diff --git a/documentation/asciidoc/accessories/ssds/about.adoc b/documentation/asciidoc/accessories/ssds/about.adoc new file mode 100644 index 000000000..662ad3f37 --- /dev/null +++ b/documentation/asciidoc/accessories/ssds/about.adoc @@ -0,0 +1,32 @@ +== About + +.A 512GB Raspberry Pi SSD +image::images/ssd.png[width="80%"] + +SSD quality is a critical factor in determining the overall user experience for a Raspberry Pi. +Raspberry Pi provides official SSDs that are tested to ensure compatibility with Raspberry Pi models and peripherals. + +Raspberry Pi SSDs are available in the following sizes: + +* 256GB +* 512GB + +To use an SSD with your Raspberry Pi, you need a Raspberry Pi 5-compatible M.2 adapter, such as the xref:../accessories/m2-hat-plus.adoc[Raspberry Pi M.2 HAT+ or M.2 HAT+ Compact]. + +== Specifications + +Raspberry Pi SSDs are PCIe Gen 3-compliant. + +Raspberry Pi SSDs use the NVMe 1.4 register interface and command set. + +Raspberry Pi SSDs use the M.2 2230 form factor. + +The following table describes the read and write speeds of Raspberry Pi SSDs using 4KB of random data: + +[cols="1,2,2"] +|=== +| Size | Read Speed | Write Speed + +| 256GB | 40,000 IOPS | 70,000 IOPS +| 512GB | 50,000 IOPS | 90,000 IOPS +|=== diff --git a/documentation/asciidoc/accessories/ssds/images/ssd.png b/documentation/asciidoc/accessories/ssds/images/ssd.png new file mode 100644 index 000000000..25bbdc3a7 Binary files /dev/null and b/documentation/asciidoc/accessories/ssds/images/ssd.png differ diff --git a/documentation/asciidoc/accessories/touch-display-2.adoc b/documentation/asciidoc/accessories/touch-display-2.adoc new file mode 100644 index 000000000..982c35d56 --- /dev/null +++ b/documentation/asciidoc/accessories/touch-display-2.adoc @@ -0,0 +1 @@ +include::touch-display-2/about.adoc[] diff --git a/documentation/asciidoc/accessories/touch-display-2/about.adoc b/documentation/asciidoc/accessories/touch-display-2/about.adoc new file mode 100644 index 000000000..341cb8c75 --- /dev/null +++ b/documentation/asciidoc/accessories/touch-display-2/about.adoc @@ -0,0 +1,223 @@ +The https://www.raspberrypi.com/products/touch-display-2/[Raspberry Pi Touch Display 2] is a portrait orientation touchscreen LCD (with rotation options) designed for interactive projects like tablets, entertainment systems, and information dashboards. + +.The Raspberry Pi Touch Display 2 +image::images/touch-display-2-hero.jpg[width="80%"] + +== Specifications + +This section describes the physical characteristics and capabilities of Touch Display 2, including dimensions, features, and hardware. + +=== Dimensions + +The Touch Display 2 is available in two sizes: 5-inch and 7-inch (measured diagonally). Aside from the physical size, these two displays have identical features and functionality. The following table summarises the dimensions of these two displays: + +[cols="1,1,1,1,1"] +|=== +| +|*Depth* +|*Outline dimensions* +|*Viewing area* +|*Active area* + +|*5-inch display* +|16 mm +|143.5 x 91.5 mm +|111.5 x 63 mm +|110.5 x 62 mm + +|*7-inch display* +|15 mm +|189.5 x 120 mm +|155.5 x 88 mm +|154.5 x 87 mm +|=== + +=== Features +Touch Display 2 (both 5-inch and 7-inch) includes the following features: + +* **720 x 1280 pixel resolution.** High-definition output. +* **24-bit RGB display.** Capable of showing over 16 million colours. +* **Multitouch.** Supports up to five simultaneous touch points. +* **Mouse-equivalence.** Supports full desktop control without a physical mouse, for example, selecting, dragging, scrolling, and long-pressing for menus. +* **On-screen keyboard.** Supports a visual keyboard in place of a physical keyboard. +* **Integrated power.** Powered directly by the host Raspberry Pi, requiring no separate power supply. + +=== Hardware + +The Touch Display 2 box contains the following parts: + +- A Touch Display 2 +- Eight M2.5 screws +- A 15-way to 15-way FFC +- A 22-way to 15-way FFC for Raspberry Pi 5 +- A GPIO power cable + +The following image shows these items from top to bottom, left to right. + +.Parts included in the Touch Display 2 box +image::images/touch-display-2-whats-in-the-booooox.jpg["Parts included in the Touch Display 2 box", width="80%"] + +=== Connectors + +The Touch Display 2 connects to a Raspberry Pi using: + +- A **DSI connector** for video and touch data. +- The **GPIO header** for power. + +To make the DSI connection, use a **Flat Flexible Cable (FFC)** included with your display. The type of FFC you need depends on your Raspberry Pi model: + +- For **Raspberry Pi 5**, use the **22-way to 15-way FFC**. +- For all other Raspberry Pi models, use the **15-way to 15-way FFC**. + +The Touch Display 2 is compatible with all models of Raspberry Pi from Raspberry Pi 1B+ onwards, except the Zero series and Keyboard series, which lack a DSI connector. + +== Connect to Raspberry Pi + +After determining the correct FFC for your Raspberry Pi model, you can connect your Touch Display 2 to your Raspberry Pi. After completing the following steps, you can reconnect your Raspberry Pi to power. It can take up to one minute for Raspberry Pi OS to start displaying output to the Touch Display 2 screen. + +.A Raspberry Pi 5 connected and mounted to the Touch Display 2 +image::images/touch-display-2-installation-diagram.png["A Raspberry Pi 5 connected and mounted to the Touch Display 2", width="80%"] + +IMPORTANT: Disconnect your Raspberry Pi from power before completing the following steps. + +=== Step 1. Connect FFC to Touch Display 2 + +. Slide the retaining clip outwards from both sides of the FFC connector on the Touch Display 2. +. Insert one 15-way end of your FFC into the Touch Display 2 FFC connector, with the metal contacts facing upwards, away from the Touch Display 2. + - If you're connecting to a Raspberry Pi 5, and therefore using the **22-way to 15-way FFC**, the 22-way end is the smaller end of the cable. Insert the larger end of the cable into the Touch Display 2 FFC connector. + - If you're using the **15-way to 15-way FFC**, insert either end of the cable into the Touch Display 2 FFC connector. +. Hold the FFC firmly in place and simultaneously push the retaining clip back in to the Touch Display 2 FFC connector from both sides. + +=== Step 2. Connect FFC to Raspberry Pi + +. Slide the retaining clip upwards from both sides of the DSI connector of your Raspberry Pi. + - This port should be marked with some variation of the term **DISPLAY**, **CAM/DISP**, or **DISP**. + - If your Raspberry Pi has multiple DSI connectors, we recommend using the port labelled **1**. +. Insert the other end of your FFC into the Raspberry Pi DSI connector, with the metal contacts facing the Ethernet and USB-A ports. +. Hold the FFC firmly in place and simultaneously push the retaining clip back down on the FFC connector of the Raspberry Pi to secure the cable. + +=== Step 3. Connect the GPIO power cable + +. Plug the smaller end of the GPIO power cable into the **J1** port on the Touch Display 2. +. Connect the three-pin end of the GPIO power cable to your xref:../computers/raspberry-pi.adoc#gpio[Raspberry Pi's GPIO]. + +This connects the red cable (5 V power) to pin 2 and the black cable (ground) to pin 6. Viewed from above, with the Ethernet and USB-A ports facing down, these pins are located in the top-right corner of the board, with pin 2 in the top right-most position. + +.The GPIO connection to the Touch Display 2 +image::images/touch-display-2-gpio-connection.png[The GPIO connection to the Touch Display 2, width="40%"] + +WARNING: Connecting the power cable incorrectly might cause damage to the display. + +=== Step 4. Mount your Raspberry Pi to the Touch Display 2 (optional) + +Optionally, use the included M2.5 screws to mount your Raspberry Pi to the back of your Touch Display 2. + +. Align the four corner stand-offs of your Raspberry Pi with the four mounting points that surround the FFC connector and J1 port on the back of the Touch Display 2. +. Insert the M2.5 screws (included) into the four corner stand-offs and tighten until your Raspberry Pi is secure. + +Take care not to pinch the FFC. + +== Use an on-screen keyboard + +Raspberry Pi OS **Bookworm** and later already includes the **Squeekboard on-screen keyboard**. With a Touch Display 2 attached, the keyboard automatically appears when you can enter text, and automatically disappears when you can't. + +For applications that don't support text entry detection, you can manually show or hide the keyboard using the keyboard icon at the right side of the taskbar. You can also permanently show or hide the on-screen keyboard using the Raspberry Pi graphical interface or the command line. + +- **Raspberry Pi desktop interface:** From the Raspberry Pi menu, go to **Preferences > Control Centre > Display** and choose your on-screen keyboard setting. +- **Command line:** Open a terminal and enter `sudo raspi-config`. Navigate to the **Display** section of `raspi-config` and then choose your keyboard setting. + +== Change screen orientation + +You can change the orientation behaviour of the Touch Display 2, both with a desktop and without a desktop. This is useful if you want to physically rotate the screen or mount it in a landscape position. + +You have four rotation options: + +- **0** maintains the default display position, which is a portrait orientation. +- **90** rotates the display 90 degrees to the right (clockwise), making it a landscape orientation. +- **180** rotates the display 180 degrees to the right (clockwise), which flips the display upside down. +- **270** rotates the display 270 degrees to the right (clockwise), which is the same as rotating the display 90 degrees to the left (counterclockwise), making it a landscape orientation. + +=== With a desktop +If you have the Raspberry Pi OS desktop running, you can rotate the display through the **Screen Configuration** tool: + +. Go to **Preferences > Screen Configuration**. This opens the layout editor where you can see your connected displays. +. Right-click the rectangle in the layout editor that represents your Touch Display 2 (likely labelled `DSI-1`). +. Select **Orientation**. +. Choose a rotation: *0°*, *90°*, *180°*, or *270°*. This rotates the display by the specified number of degrees to the right. + +=== Without a desktop + +To rotate the display without a desktop, edit the `/boot/firmware/cmdline.txt` file, which contains parameters that Raspberry Pi OS reads when it boots. Add the following to the end of `cmdline.txt`, replacing `` with the number of degrees to rotate by (`0`, `90`, `180`, or `270`): + +[source,ini] +---- +video=DSI-1:720x1280@60,rotate= +---- + +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 + +You can use the Device Tree overlay to tell Raspberry Pi OS how to configure the Touch Display 2 at boot. + +- For the 5-inch display, the overlay is called `vc4-kms-dsi-ili9881-5inch`. +- For the 7-inch display, the overlay is called `vc4-kms-dsi-ili9881-7inch`. + +You can modify the Device Tree overlay in the boot configuration file (`/boot/firmware/config.txt`). + +Open `/boot/firmware/config.txt` and then add the required Device Tree parameters to the `dtoverlay` line, separated by commas. + +- Booleans (`invx`, `invy`, `swapxy`, and `disable_touch`) default to true if present, but you can set them to false using the suffix `=0`. +- Integers (`sizex` and `sizey`) require a number, for example, `sizey=240`. + +See the table below for details. + +=== Device Tree options + +|=== +| Parameter | Action + +| `sizex` +| Sets the touch horizontal resolution (default 720) + +| `sizey` +| Sets the touch vertical resolution (default 1280) + +| `invx` +| Inverts the touch X-axis (left/right) + +| `invy` +| Inverts the touch Y-axis (up/down) + +| `swapxy` +| Swaps the touch X and Y axes (rotate 90° logically) + +| `disable_touch` +| Disables the touchscreen functionality +|=== + +=== Example + +In the following example, `invx` flips the X axis and `invy` flips the Y axis for a 7-inch Touch Display 2: + +[source,ini] +---- +dtoverlay=vc4-kms-dsi-ili9881-7inch,invx,invy +---- + + +== Connect to a Compute Module + +Unlike Raspberry Pi single board computers (SBC), which automatically detect the official Raspberry Pi Touch displays, Raspberry Pi Compute Modules don't automatically detect connected devices; you must tell it what display is attached. + +This is because the connections between the SoC and DSI connectors on a Raspberry Pi are fixed and the system knows what hardware is connected; auto-detection ensures that the correct Device Tree settings are passed to the Linux kernel, so the display works without additional configuration. + +Compute Modules, intended for industrial and custom applications, expose all GPIOs and interfaces. This provides greater flexibility for connecting hardware, but means that a Compute Module can't automatically detect devices like the Touch Display 2. This means that, for Compute Modules, the Device Tree fragments, which tell the kernel how to interact with the display, must be manually specified. You can do this in three ways: + +- By adding an overlay entry in `config.txt`. This is the simplest option. For configuration instructions, see the xref:../computers/compute-module.adoc#attaching-the-touch-display-2-lcd-panel[Compute Module hardware documentation]. +- Using a custom base device tree file. This is an advanced method not covered in this online documentation. +- Using a HAT EEPROM (if present). + + diff --git a/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-gpio-connection.png b/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-gpio-connection.png new file mode 100644 index 000000000..41e59bc42 Binary files /dev/null and b/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-gpio-connection.png differ diff --git a/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-hero.jpg b/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-hero.jpg new file mode 100644 index 000000000..45779c6e2 Binary files /dev/null and b/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-hero.jpg differ diff --git a/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-installation-diagram.png b/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-installation-diagram.png new file mode 100644 index 000000000..f3167f5e6 Binary files /dev/null and b/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-installation-diagram.png differ diff --git a/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-whats-in-the-booooox.jpg b/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-whats-in-the-booooox.jpg new file mode 100644 index 000000000..e28fd789c Binary files /dev/null and b/documentation/asciidoc/accessories/touch-display-2/images/touch-display-2-whats-in-the-booooox.jpg differ diff --git a/documentation/asciidoc/accessories/tv-hat.adoc b/documentation/asciidoc/accessories/tv-hat.adoc index b3724aff5..be04ece4c 100644 --- a/documentation/asciidoc/accessories/tv-hat.adoc +++ b/documentation/asciidoc/accessories/tv-hat.adoc @@ -1 +1 @@ -include::tv-hat/about-tv-hat.adoc[] \ No newline at end of file +include::tv-hat/about-tv-hat.adoc[] diff --git a/documentation/asciidoc/accessories/tv-hat/about-tv-hat.adoc b/documentation/asciidoc/accessories/tv-hat/about-tv-hat.adoc index f642cb1e7..8099b68c6 100644 --- a/documentation/asciidoc/accessories/tv-hat/about-tv-hat.adoc +++ b/documentation/asciidoc/accessories/tv-hat/about-tv-hat.adoc @@ -1,4 +1,5 @@ -== About the TV HAT +[[tv-hat]] +== About .The Raspberry Pi TV HAT image::images/tv-hat.jpg[width="80%"] @@ -23,7 +24,8 @@ Digital Video Broadcasting – Terrestrial (DVB-T) is the DVB European-based con .DTT system implemented or adopted (Source: DVB/EBU/BNE DTT Deployment Database, March 2023) image::images/dvbt-map.png[width="80%"] -== Setup Instructions +[[tv-hat-installation]] +== Install Follow our xref:../computers/getting-started.adoc[getting started] documentation and set up the Raspberry Pi with the newest version of Raspberry Pi OS. @@ -33,7 +35,7 @@ The software we recommend to decode the streams (known as multiplexes, or muxes Boot your Raspberry Pi and then go ahead open a terminal window, and run the following two commands to install the `tvheadend` software: -[source, bash] +[source,console] ---- $ sudo apt update $ sudo apt install tvheadend @@ -43,7 +45,7 @@ During the `tvheadend` installation, you will be asked to choose an administrato On another computer on your network, open up a web browser and type the following into the address bar: `http://raspberrypi.local:9981/extjs.html` -This should connect to `tvheadend` running on the Raspberry Pi. Once you have connected to `tvheadend` via the browser, you will be prompted to sign in using the account name and password you chose when you installed `tvheadend` on the Raspberry Pi. +This should connect to `tvheadend` running on the Raspberry Pi. Once you have connected to `tvheadend` via the browser, you will be prompted to sign in using the account name and password you chose when you installed `tvheadend` on the Raspberry Pi. A setup wizard should appear. @@ -55,13 +57,13 @@ NOTE: Your local transmitter can be found using the https://www.freeview.co.uk/h When you click *Save & Next*, the software will start scanning for the selected mux, and will show a progress bar. After about two minutes, you should see something like: -[source, bash] +[source,console] ---- Found muxes: 8 Found services: 172 ---- -In the next window, titled *Service mapping*, tick all three boxes: *Map all services*, *Create provider tags*, and *Create network tags*. You should see a list of TV channels you can watch, along with the programmes they're currently showing. +In the next window, titled *Service mapping*, tick all three boxes: *Map all services*, *Create provider tags*, and *Create network tags*. You should see a list of TV channels you can watch, along with the programmes they're currently showing. To watch a TV channel in the browser, click the little TV icon to the left of the channel listing, just to the right of the *i* icon. This brings up an in-browser media player. Depending on the decoding facilities built into your browser and the type of stream being played, you may find that playback can be jerky. In these cases, we recommend using a local media player as the playback application. diff --git a/documentation/asciidoc/accessories/usb-3-hub.adoc b/documentation/asciidoc/accessories/usb-3-hub.adoc new file mode 100644 index 000000000..44c1bec1a --- /dev/null +++ b/documentation/asciidoc/accessories/usb-3-hub.adoc @@ -0,0 +1 @@ +include::usb-3-hub/about.adoc[] diff --git a/documentation/asciidoc/accessories/usb-3-hub/about.adoc b/documentation/asciidoc/accessories/usb-3-hub/about.adoc new file mode 100644 index 000000000..c67d1f770 --- /dev/null +++ b/documentation/asciidoc/accessories/usb-3-hub/about.adoc @@ -0,0 +1,17 @@ +== About + +The https://www.raspberrypi.com/products/usb-3-hub/[Raspberry Pi USB 3 Hub] provides extra connectivity for your devices, extending one USB-A port into four. An optional external USB-C power input supports high-power peripherals. You can use the USB 3 Hub to power low-power peripherals, such as most mice and keyboards, using no external power. + +.The Raspberry Pi USB 3.0 Hub +image::images/usb-3-hub-hero.png[width="80%"] + +== Specification + +* 1× upstream USB 3.0 Type-A male connector on 8cm captive cable +* 4× downstream USB 3.0 Type-A ports +* Data transfer speeds up to 5Gbps +* Power transfer up to 900 mA (4.5 W); optional external USB-C power input provides up to 5V @ 3A for high-power downstream peripherals +* Compatible with USB 3.0 and USB 2.0 Type-A host ports + +.Physical specification +image::images/usb-3-hub-physical-specification.png[] diff --git a/documentation/asciidoc/accessories/usb-3-hub/images/usb-3-hub-hero.png b/documentation/asciidoc/accessories/usb-3-hub/images/usb-3-hub-hero.png new file mode 100644 index 000000000..7f3bc2b9a Binary files /dev/null and b/documentation/asciidoc/accessories/usb-3-hub/images/usb-3-hub-hero.png differ diff --git a/documentation/asciidoc/accessories/usb-3-hub/images/usb-3-hub-physical-specification.png b/documentation/asciidoc/accessories/usb-3-hub/images/usb-3-hub-physical-specification.png new file mode 100644 index 000000000..7b469d14c Binary files /dev/null and b/documentation/asciidoc/accessories/usb-3-hub/images/usb-3-hub-physical-specification.png differ diff --git a/documentation/asciidoc/computers/ai.adoc b/documentation/asciidoc/computers/ai.adoc new file mode 100644 index 000000000..af8f6182d --- /dev/null +++ b/documentation/asciidoc/computers/ai.adoc @@ -0,0 +1,2 @@ +include::ai/getting-started.adoc[] + diff --git a/documentation/asciidoc/computers/ai/getting-started.adoc b/documentation/asciidoc/computers/ai/getting-started.adoc new file mode 100644 index 000000000..3a9b7263c --- /dev/null +++ b/documentation/asciidoc/computers/ai/getting-started.adoc @@ -0,0 +1,219 @@ +== Getting Started + +This guide will help you set up a Hailo NPU with your Raspberry Pi 5. This will enable you to run `rpicam-apps` camera demos using an AI neural network accelerator. + +=== Prerequisites + +For this guide, you will need the following: + +* a Raspberry Pi 5 +* one of the following NPUs: +** a xref:../accessories/ai-kit.adoc[Raspberry Pi AI Kit], which includes: +*** an M.2 HAT+ +*** a pre-installed Hailo-8L AI module +** a xref:../accessories/ai-hat-plus.adoc[Raspberry Pi AI HAT+] +* a 64-bit Raspberry Pi OS Bookworm install +* any official Raspberry Pi camera (e.g. Camera Module 3 or High Quality Camera) + +=== Hardware setup + +. Attach the camera to your Raspberry Pi 5 board following the instructions at xref:../accessories/camera.adoc#install-a-raspberry-pi-camera[Install a Raspberry Pi Camera]. You can skip reconnecting your Raspberry Pi to power, because you'll need to disconnect your Raspberry Pi from power for the next step. + +. Depending on your NPU, follow the installation instructions for the xref:../accessories/ai-kit.adoc#ai-kit-installation[AI Kit] or xref:../accessories/ai-hat-plus.adoc#ai-hat-plus-installation[AI HAT+], to get your hardware connected to your Raspberry Pi 5. + +. Follow the instructions to xref:raspberry-pi.adoc#pcie-gen-3-0[enable PCIe Gen 3.0]. This step is optional, but _highly recommended_ to achieve the best performance with your NPU. + +. Install the dependencies required to use the NPU. Run the following command from a terminal window: ++ +[source,console] +---- +$ sudo apt install hailo-all +---- ++ +This installs the following dependencies: ++ +* Hailo kernel device driver and firmware +* HailoRT middleware software +* Hailo Tappas core post-processing libraries +* The `rpicam-apps` Hailo post-processing software demo stages + +. Finally, reboot your Raspberry Pi with `sudo reboot` for these settings to take effect. + +. To ensure everything is running correctly, run the following command: ++ +[source,console] +---- +$ hailortcli fw-control identify +---- ++ +If you see output similar to the following, you've successfully installed the NPU and its software dependencies: ++ +---- +Executing on device: 0000:01:00.0 +Identifying board +Control Protocol Version: 2 +Firmware Version: 4.17.0 (release,app,extended context switch buffer) +Logger Version: 0 +Board Name: Hailo-8 +Device Architecture: HAILO8L +Serial Number: HLDDLBB234500054 +Part Number: HM21LB1C2LAE +Product Name: HAILO-8L AI ACC M.2 B+M KEY MODULE EXT TMP +---- ++ +NOTE: AI HAT+ devices may show `` for `Serial Number`, `Part Number` and `Product Name`. This is expected, and does not impact functionality. ++ +Additionally, you can run `dmesg | grep -i hailo` to check the kernel logs, which should yield output similar to the following: ++ +---- +[ 3.049657] hailo: Init module. driver version 4.17.0 +[ 3.051983] hailo 0000:01:00.0: Probing on: 1e60:2864... +[ 3.051989] hailo 0000:01:00.0: Probing: Allocate memory for device extension, 11600 +[ 3.052006] hailo 0000:01:00.0: enabling device (0000 -> 0002) +[ 3.052011] hailo 0000:01:00.0: Probing: Device enabled +[ 3.052028] hailo 0000:01:00.0: Probing: mapped bar 0 - 000000000d8baaf1 16384 +[ 3.052034] hailo 0000:01:00.0: Probing: mapped bar 2 - 000000009eeaa33c 4096 +[ 3.052039] hailo 0000:01:00.0: Probing: mapped bar 4 - 00000000b9b3d17d 16384 +[ 3.052044] hailo 0000:01:00.0: Probing: Force setting max_desc_page_size to 4096 (recommended value is 16384) +[ 3.052052] hailo 0000:01:00.0: Probing: Enabled 64 bit dma +[ 3.052055] hailo 0000:01:00.0: Probing: Using userspace allocated vdma buffers +[ 3.052059] hailo 0000:01:00.0: Disabling ASPM L0s +[ 3.052070] hailo 0000:01:00.0: Successfully disabled ASPM L0s +[ 3.221043] hailo 0000:01:00.0: Firmware was loaded successfully +[ 3.231845] hailo 0000:01:00.0: Probing: Added board 1e60-2864, /dev/hailo0 +---- + +. To ensure the camera is operating correctly, run the following command: ++ +[source,console] +---- +$ rpicam-hello -t 10s +---- ++ +This starts the camera and shows a preview window for ten seconds. Once you have verified everything is installed correctly, it's time to run some demos. + +=== Demos + +The `rpicam-apps` suite of camera applications implements a xref:camera_software.adoc#post-processing-with-rpicam-apps[post-processing framework]. This section contains a few demo post-processing stages that highlight some of the capabilities of the NPU. + +The following demos use xref:camera_software.adoc#rpicam-hello[`rpicam-hello`], which by default displays a preview window. However, you can use other `rpicam-apps` instead, including xref:camera_software.adoc#rpicam-vid[`rpicam-vid`] and xref:camera_software.adoc#rpicam-still[`rpicam-still`]. You may need to add or modify some command line options to make the demo commands compatible with alternative applications. + +To begin, run the following command to install the latest `rpicam-apps` software package: + +[source,console] +---- +$ sudo apt update && sudo apt install rpicam-apps +---- + +==== Object Detection + +This demo displays bounding boxes around objects detected by a neural network. To disable the viewfinder, use the xref:camera_software.adoc#nopreview[`-n`] flag. To return purely textual output describing the objects detected, add the `-v 2` option. Run the following command to try the demo on your Raspberry Pi: + +[source,console] +---- +$ rpicam-hello -t 0 --post-process-file /usr/share/rpi-camera-assets/hailo_yolov6_inference.json +---- + +Alternatively, you can try another model with different trade-offs in performance and efficiency. + +To run the demo with the Yolov8 model, run the following command: + +[source,console] +---- +$ rpicam-hello -t 0 --post-process-file /usr/share/rpi-camera-assets/hailo_yolov8_inference.json +---- + +To run the demo with the YoloX model, run the following command: + +[source,console] +---- +$ rpicam-hello -t 0 --post-process-file /usr/share/rpi-camera-assets/hailo_yolox_inference.json +---- + +To run the demo with the Yolov5 Person and Face model, run the following command: + +[source,console] +---- +$ rpicam-hello -t 0 --post-process-file /usr/share/rpi-camera-assets/hailo_yolov5_personface.json +---- + +==== Image Segmentation + +This demo performs object detection and segments the object by drawing a colour mask on the viewfinder image. Run the following command to try the demo on your Raspberry Pi: + +[source,console] +---- +$ rpicam-hello -t 0 --post-process-file /usr/share/rpi-camera-assets/hailo_yolov5_segmentation.json --framerate 20 +---- + +==== Pose Estimation + +This demo performs 17-point human pose estimation, drawing lines connecting the detected points. Run the following command to try the demo on your Raspberry Pi: + +[source,console] +---- +$ rpicam-hello -t 0 --post-process-file /usr/share/rpi-camera-assets/hailo_yolov8_pose.json +---- + +=== Alternative Package Versions + +The AI Kit and AI HAT+ do not function if there is a version mismatch between the Hailo software packages and device drivers. In addition, Hailo's neural network tooling may require a particular version for generated model files. If you require a specific version, complete the following steps to install the proper versions of all of the dependencies: + +. If you have previously used `apt-mark` to hold any of the relevant packages, you may need to unhold them: ++ +[source,console] +---- +$ sudo apt-mark unhold hailo-tappas-core hailort hailo-dkms +---- + +. Install the required version of the software packages: + +[tabs] +====== +v4.19:: +To install version 4.19 of Hailo's neural network tooling, run the following commands: ++ +[source,console] +---- +sudo apt install hailo-tappas-core=3.30.0-1 hailort=4.19.0-3 hailo-dkms=4.19.0-1 python3-hailort=4.19.0-2 +---- ++ +[source,console] +---- +$ sudo apt-mark hold hailo-tappas-core hailort hailo-dkms python3-hailort +---- + +4.18:: +To install version 4.18 of Hailo's neural network tooling, run the following commands: ++ +[source,console] +---- +$ sudo apt install hailo-tappas-core=3.29.1 hailort=4.18.0 hailo-dkms=4.18.0-2 +---- ++ +[source,console] +---- +$ sudo apt-mark hold hailo-tappas-core hailort hailo-dkms +---- + +4.17:: +To install version 4.17 of Hailo's neural network tooling, run the following commands: ++ +[source,console] +---- +$ sudo apt install hailo-tappas-core=3.28.2 hailort=4.17.0 hailo-dkms=4.17.0-1 +---- ++ +[source,console] +---- +$ sudo apt-mark hold hailo-tappas-core hailort hailo-dkms +---- +====== + +=== Further Resources + +Hailo has also created a set of demos that you can run on a Raspberry Pi 5, available in the https://github.com/hailo-ai/hailo-rpi5-examples[hailo-ai/hailo-rpi5-examples GitHub repository]. + +You can find Hailo's extensive model zoo, which contains a large number of neural networks, in the https://github.com/hailo-ai/hailo_model_zoo/tree/master/docs/public_models/HAILO8L[hailo-ai/hailo_model_zoo GitHub repository]. + +Check out the https://community.hailo.ai/[Hailo community forums and developer zone] for further discussions on the Hailo hardware and tooling. diff --git a/documentation/asciidoc/computers/camera/camera_usage.adoc b/documentation/asciidoc/computers/camera/camera_usage.adoc index f2709286d..722f37c82 100644 --- a/documentation/asciidoc/computers/camera/camera_usage.adoc +++ b/documentation/asciidoc/computers/camera/camera_usage.adoc @@ -1,13 +1,19 @@ -== Introducing the Raspberry Pi cameras +This documentation describes how to use supported camera modules with our software tools. All Raspberry Pi cameras can record high-resolution photographs and full HD 1080p video (or better) with our software tools. -There are now several official Raspberry Pi camera modules. The original 5-megapixel model was https://www.raspberrypi.com/news/camera-board-available-for-sale/[released] in 2013. It was followed by an 8-megapixel https://www.raspberrypi.com/products/camera-module-v2/[Camera Module 2], which was https://www.raspberrypi.com/news/new-8-megapixel-camera-board-sale-25/[released] in 2016. The latest camera model is the 12-megapixel https://raspberrypi.com/products/camera-module-3/[Camera Module 3] which was https://www.raspberrypi.com/news/new-autofocus-camera-modules/[released] in 2023. The original 5MP device is no longer available from Raspberry Pi. +Raspberry Pi produces several official camera modules, including: -Additionally a 12-megapixel https://www.raspberrypi.com/products/raspberry-pi-high-quality-camera/[High Quality Camera] with CS- or M12-mount variants for use with external lenses was https://www.raspberrypi.com/news/new-product-raspberry-pi-high-quality-camera-on-sale-now-at-50/[released in 2020] and https://www.raspberrypi.com/news/new-autofocus-camera-modules/[2023] respectively. There is no infrared version of the HQ Camera. +* the original 5-megapixel Camera Module 1 (discontinued) +* the 8-megapixel https://www.raspberrypi.com/products/camera-module-v2/[Camera Module 2], with or without an infrared filter +* the 12-megapixel https://raspberrypi.com/products/camera-module-3/[Camera Module 3], with both standard and wide lenses, with or without an infrared filter +* the 12-megapixel https://www.raspberrypi.com/products/raspberry-pi-high-quality-camera/[High Quality Camera] with CS and M12 mount variants for use with external lenses +* the 1.6-megapixel https://www.raspberrypi.com/products/raspberry-pi-global-shutter-camera/[Global Shutter Camera] for fast motion photography +* the 12-megapixel https://www.raspberrypi.com/products/ai-camera/[AI Camera] uses the Sony IMX500 imaging sensor to provide low-latency, high-performance AI capabilities to any camera application -All of these cameras come in visible light and infrared versions, while the Camera Module 3 also comes as a standard or wide field of view (FoV) model for a total of four different variants. - -Further details on the camera modules can be found in the xref:../accessories/camera.adoc#about-the-camera-modules[camera hardware] page. +For more information about camera hardware, see the xref:../accessories/camera.adoc#about-the-camera-modules[camera hardware documentation]. -All Raspberry Pi cameras are capable of taking high-resolution photographs, along with full HD 1080p video, and can be controlled programmatically. This documentation describes how to use the camera in various scenarios, and how to use the various software tools. +First, xref:../accessories/camera.adoc#install-a-raspberry-pi-camera[install your camera module]. Then, follow the guides in this section to put your camera module to use. -Once you've xref:../accessories/camera.adoc#installing-a-raspberry-pi-camera[installed your camera module], there are various ways the cameras can be used. The simplest option is to use one of the provided camera applications, such as `rpicam-still` or `rpicam-vid`. +[WARNING] +==== +This guide no longer covers the _legacy camera stack_ which was available in Bullseye and earlier Raspberry Pi OS releases. The legacy camera stack, using applications like `raspivid`, `raspistill` and the original `Picamera` (_not_ `Picamera2`) Python library, has been deprecated for many years, and is now unsupported. If you are using the legacy camera stack, it will only have support for the Camera Module 1, Camera Module 2 and the High Quality Camera, and will never support any newer camera modules. Nothing in this document is applicable to the legacy camera stack. +==== diff --git a/documentation/asciidoc/computers/camera/csi-2-usage.adoc b/documentation/asciidoc/computers/camera/csi-2-usage.adoc index c15ed86d7..f3515ae94 100644 --- a/documentation/asciidoc/computers/camera/csi-2-usage.adoc +++ b/documentation/asciidoc/computers/camera/csi-2-usage.adoc @@ -1,18 +1,18 @@ -== Camera serial interface 2 (CSI2): Unicam +== Unicam -The SoCs used on the Raspberry Pi range all have two camera interfaces that support either CSI-2 D-PHY 1.1 or Compact Camera Port 2 (CCP2) sources. This interface is known by the codename Unicam. The first instance of Unicam supports two CSI-2 data lanes, while the second supports four. Each lane can run at up to 1Gbit/s (DDR, so the max link frequency is 500MHz). +Raspberry Pi SoCs all have two camera interfaces that support either CSI-2 D-PHY 1.1 or Compact Camera Port 2 (CCP2) sources. This interface is known by the codename Unicam. The first instance of Unicam supports two CSI-2 data lanes, while the second supports four. Each lane can run at up to 1Gbit/s (DDR, so the max link frequency is 500MHz). -However, the normal variants of the Raspberry Pi only expose the second instance, and route out only two of the data lanes to the camera connector. The Compute Module range routes out all lanes from both peripherals. +Compute Modules and Raspberry Pi 5 route out all lanes from both peripherals. Other models prior to Raspberry Pi 5 only expose the second instance, routing out only two of the data lanes to the camera connector. === Software interfaces -The V4L2 software interface is now the only means of communicating with the Unicam peripheral. There used to also be Firmware and MMAL rawcam component interfaces, but these are no longer supported. +The V4L2 software interface is the only means of communicating with the Unicam peripheral. There used to also be firmware and MMAL rawcam component interfaces, but these are no longer supported. ==== V4L2 NOTE: The V4L2 interface for Unicam is available only when using `libcamera`. -There is a fully open source kernel driver available for the Unicam block; this is a kernel module called bcm2835-unicam, which interfaces to V4L2 subdevice drivers for the source to deliver the raw frames. This bcm2835-unicam driver controls the sensor, and configures the CSI-2 receiver so that the peripheral will write the raw frames (after Debayer) to SDRAM for V4L2 to deliver to applications. Except for this ability to unpack the CSI-2 Bayer formats to 16bits/pixel, there is no image processing between the image source (e.g. camera sensor) and bcm2835-unicam placing the image data in SDRAM. +There is a fully open-source kernel driver available for the Unicam block; this kernel module, called `bcm2835-unicam`, interfaces with V4L2 subdevice drivers to deliver raw frames. This `bcm2835-unicam` driver controls the sensor and configures the Camera Serial Interface 2 (CSI-2) receiver. Peripherals write raw frames (after Debayer) to SDRAM for V4L2 to deliver to applications. There is no image processing between the camera sensor capturing the image and the `bcm2835-unicam` driver placing the image data in SDRAM except for Bayer unpacking to 16bits/pixel. ---- |------------------------| @@ -33,7 +33,7 @@ ccp2 | | |-----------------| ---- -Mainline Linux has a range of existing drivers. The Raspberry Pi kernel tree has some additional drivers and Device Tree overlays to configure them: +Mainline Linux contains a range of existing drivers. The Raspberry Pi kernel tree has some additional drivers and Device Tree overlays to configure them: |=== | Device | Type | Notes @@ -71,17 +71,17 @@ Mainline Linux has a range of existing drivers. The Raspberry Pi kernel tree has | Supported by a third party |=== -As the subdevice driver is also a kernel driver, with a standardised API, third parties are free to write their own for any source of their choosing. +As the subdevice driver is also a kernel driver with a standardised API, third parties are free to write their own for any source of their choosing. -=== Developing third-party drivers +=== Write a third-party driver This is the recommended approach to interfacing via Unicam. -When developing a driver for a new device intended to be used with the bcm2835-unicam module, you need the driver and corresponding device tree overlays. Ideally, the driver should be submitted to the http://vger.kernel.org/vger-lists.html#linux-media[linux-media] mailing list for code review and merging into mainline, then moved to the https://github.com/raspberrypi/linux[Raspberry Pi kernel tree]; but exceptions may be made for the driver to be reviewed and merged directly to the Raspberry Pi kernel. +When developing a driver for a new device intended to be used with the `bcm2835-unicam` module, you need the driver and corresponding device tree overlays. Ideally, the driver should be submitted to the http://vger.kernel.org/vger-lists.html#linux-media[linux-media] mailing list for code review and merging into mainline, then moved to the https://github.com/raspberrypi/linux[Raspberry Pi kernel tree]; but exceptions may be made for the driver to be reviewed and merged directly to the Raspberry Pi kernel. NOTE: All kernel drivers are licensed under the GPLv2 licence, therefore source code must be available. Shipping of binary modules only is a violation of the GPLv2 licence under which the Linux kernel is licensed. -The bcm2835-unicam has been written to try and accommodate all types of CSI-2 source driver that are currently found in the mainline Linux kernel. These can be split broadly into camera sensors and bridge chips. Bridge chips allow for conversion between some other format and CSI-2. +The `bcm2835-unicam` module has been written to try and accommodate all types of CSI-2 source driver that are currently found in the mainline Linux kernel. These can be split broadly into camera sensors and bridge chips. Bridge chips allow for conversion between some other format and CSI-2. ==== Camera sensors @@ -91,16 +91,16 @@ The https://github.com/raspberrypi/linux/blob/rpi-6.1.y/drivers/media/i2c/imx219 Sensors generally support https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/control.html[V4L2 user controls]. Not all these controls need to be implemented in a driver. The IMX219 driver only implements a small subset, listed below, the implementation of which is handled by the `imx219_set_ctrl` function. -* `V4L2_CID_PIXEL_RATE` / `V4L2_CID_VBLANK` / `V4L2_CID_HBLANK`: allows the application to set the frame rate. -* `V4L2_CID_EXPOSURE`: sets the exposure time in lines. The application needs to use `V4L2_CID_PIXEL_RATE`, `V4L2_CID_HBLANK`, and the frame width to compute the line time. -* `V4L2_CID_ANALOGUE_GAIN`: analogue gain in sensor specific units. -* `V4L2_CID_DIGITAL_GAIN`: optional digital gain in sensor specific units. -* `V4L2_CID_HFLIP / V4L2_CID_VFLIP`: flips the image either horizontally or vertically. Note that this operation may change the Bayer order of the data in the frame, as is the case on the IMX219. -* `V4L2_CID_TEST_PATTERN` / `V4L2_CID_TEST_PATTERN_*`: Enables output of various test patterns from the sensor. Useful for debugging. +* `V4L2_CID_PIXEL_RATE` / `V4L2_CID_VBLANK` / `V4L2_CID_HBLANK`: allows the application to set the frame rate +* `V4L2_CID_EXPOSURE`: sets the exposure time in lines; the application needs to use `V4L2_CID_PIXEL_RATE`, `V4L2_CID_HBLANK`, and the frame width to compute the line time +* `V4L2_CID_ANALOGUE_GAIN`: analogue gain in sensor specific units +* `V4L2_CID_DIGITAL_GAIN`: optional digital gain in sensor specific units +* `V4L2_CID_HFLIP / V4L2_CID_VFLIP`: flips the image either horizontally or vertically; this operation may change the Bayer order of the data in the frame, as is the case on the IMX219. +* `V4L2_CID_TEST_PATTERN` / `V4L2_CID_TEST_PATTERN_*`: enables output of various test patterns from the sensor; useful for debugging In the case of the IMX219, many of these controls map directly onto register writes to the sensor itself. -Further guidance can be found in libcamera's https://git.linuxtv.org/libcamera.git/tree/Documentation/sensor_driver_requirements.rst[sensor driver requirements], and also in chapter 3 of the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Raspberry Pi Camera tuning guide]. +Further guidance can be found in the `libcamera` https://git.linuxtv.org/libcamera.git/tree/Documentation/sensor_driver_requirements.rst[sensor driver requirements], and in chapter 3 of the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Raspberry Pi Camera tuning guide]. ===== Device Tree @@ -116,7 +116,7 @@ Handling bridge chips is more complicated. Unlike camera sensors, they have to r The mechanisms for handling bridge chips can be split into two categories: either analogue or digital. -When using `ioctls` in the sections below, an `_S_` in the `ioctl` name means it is a set function, while `_G_` is a get function and `_ENUM` enumerates a set of permitted values. +When using `ioctls` in the sections below, an `_S_` in the `ioctl` name means it is a set function, while `_G_` is a get function and `_ENUM_` enumerates a set of permitted values. ===== Analogue video sources @@ -142,7 +142,7 @@ Product details for the various versions of this chip can be found on the Analog Because of some missing code in the current core V4L2 implementation, selecting the source fails, so the Raspberry Pi kernel version adds a kernel module parameter called `dbg_input` to the ADV7180 kernel driver which sets the input source every time VIDIOC_S_STD is called. At some point mainstream will fix the underlying issue (a disjoin between the kernel API call s_routing, and the userspace call `VIDIOC_S_INPUT`) and this modification will be removed. -Please note that receiving interlaced video is not supported, therefore the ADV7281(A)-M version of the chip is of limited use as it doesn't have the necessary I2P deinterlacing block. Also ensure when selecting a device to specify the -M option. Without that you will get a parallel output bus which can not be interfaced to the Raspberry Pi. +Receiving interlaced video is not supported, therefore the ADV7281(A)-M version of the chip is of limited use as it doesn't have the necessary I2P deinterlacing block. Also ensure when selecting a device to specify the -M option. Without that you will get a parallel output bus which can not be interfaced to the Raspberry Pi. There are no known commercially available boards using these chips, but this driver has been tested via the Analog Devices https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/EVAL-ADV7282A-M.html[EVAL-ADV7282-M evaluation board]. @@ -197,4 +197,4 @@ The chip also supports capturing stereo HDMI audio via I2S. The Auvidea boards b The `tc358743-audio` overlay is required _in addition to_ the `tc358743` overlay. This should create an ALSA recording device for the HDMI audio. -Please note that there is no resampling of the audio. The presence of audio is reflected in the V4L2 control TC358743_CID_AUDIO_PRESENT/"audio-present", and the sample rate of the incoming audio is reflected in the V4L2 control TC358743_CID_AUDIO_SAMPLING_RATE/"Audio sampling-frequency". Recording when no audio is present will generate warnings, as will recording at a sample rate different from that reported. +There is no resampling of the audio. The presence of audio is reflected in the V4L2 control `TC358743_CID_AUDIO_PRESENT` (audio-present), and the sample rate of the incoming audio is reflected in the V4L2 control `TC358743_CID_AUDIO_SAMPLING_RATE` (audio sampling-frequency). Recording when no audio is present or at a sample rate different from that reported emits a warning. diff --git a/documentation/asciidoc/computers/camera/gstreamer.adoc b/documentation/asciidoc/computers/camera/gstreamer.adoc deleted file mode 100644 index b688c96f0..000000000 --- a/documentation/asciidoc/computers/camera/gstreamer.adoc +++ /dev/null @@ -1,58 +0,0 @@ -=== Using GStreamer - -https://gstreamer.freedesktop.org/[GStreamer] is a Linux framework for reading, processing and playing multimedia files. Here we show how `rpicam-vid` can be used to stream video over a network. - -On the server we need `rpicam-vid` to output an encoded h.264 bitstream to stdout and can use the GStreamer `fdsrc` element to receive it. Then extra GStreamer elements can send this over the network. As an example, we can send and receive the stream on the same device over a UDP link. On the server: - -[,bash] ----- -rpicam-vid -t 0 -n --inline -o - | gst-launch-1.0 fdsrc fd=0 ! udpsink host=localhost port=5000 ----- - -For the client (type this into another console window), we can use: - -[,bash] ----- -gst-launch-1.0 udpsrc address=localhost port=5000 ! h264parse ! v4l2h264dec ! autovideosink ----- - -==== Using RTP - -To stream using the RTP protocol, on the server you could use: - -[,bash] ----- -rpicam-vid -t 0 -n --inline -o - | gst-launch-1.0 fdsrc fd=0 ! h264parse ! rtph264pay ! udpsink host=localhost port=5000 ----- - -And in the client window: - -[,bash] ----- -gst-launch-1.0 udpsrc address=localhost port=5000 caps=application/x-rtp ! rtph264depay ! h264parse ! v4l2h264dec ! autovideosink ----- - -We conclude with an example that streams from one machine to another. Let us assume that the client machine has the IP address `192.168.0.3`. On the server (a Raspberry Pi) the pipeline is identical, but for the destination address: - -[,bash] ----- -rpicam-vid -t 0 -n --inline -o - | gst-launch-1.0 fdsrc fd=0 ! h264parse ! rtph264pay ! udpsink host=192.168.0.3 port=5000 ----- - -If the client is not a Raspberry Pi it may have different GStreamer elements available. For a Linux PC we might use: - -[,bash] ----- -gst-launch-1.0 udpsrc address=192.168.0.3 port=5000 caps=application/x-rtp ! rtph264depay ! h264parse ! avdec_h264 ! autovideosink ----- - -==== The `libcamerasrc` element - -`libcamera` provides a `libcamerasrc` _gstreamer_ element which can be used directly instead of `rpicam-vid`. On the server you could use: - -[,bash] ----- -gst-launch-1.0 libcamerasrc ! capsfilter caps=video/x-raw,width=1280,height=720,format=NV12 ! v4l2convert ! v4l2h264enc extra-controls="controls,repeat_sequence_header=1" ! 'video/x-h264,level=(string)4.1' ! h264parse ! rtph264pay ! udpsink host=localhost port=5000 ----- - -and on the client we use the same playback pipeline as previously. diff --git a/documentation/asciidoc/computers/camera/images/cam.jpg b/documentation/asciidoc/computers/camera/images/cam.jpg deleted file mode 100644 index 38963884d..000000000 Binary files a/documentation/asciidoc/computers/camera/images/cam.jpg and /dev/null differ diff --git a/documentation/asciidoc/computers/camera/images/cam2.jpg b/documentation/asciidoc/computers/camera/images/cam2.jpg deleted file mode 100644 index 01d39ca9c..000000000 Binary files a/documentation/asciidoc/computers/camera/images/cam2.jpg and /dev/null differ diff --git a/documentation/asciidoc/computers/os/images/image2.jpg b/documentation/asciidoc/computers/camera/images/webcam-image-high-resolution.jpg similarity index 100% rename from documentation/asciidoc/computers/os/images/image2.jpg rename to documentation/asciidoc/computers/camera/images/webcam-image-high-resolution.jpg diff --git a/documentation/asciidoc/computers/os/images/image3.jpg b/documentation/asciidoc/computers/camera/images/webcam-image-no-banner.jpg similarity index 100% rename from documentation/asciidoc/computers/os/images/image3.jpg rename to documentation/asciidoc/computers/camera/images/webcam-image-no-banner.jpg diff --git a/documentation/asciidoc/computers/os/images/image.jpg b/documentation/asciidoc/computers/camera/images/webcam-image.jpg similarity index 100% rename from documentation/asciidoc/computers/os/images/image.jpg rename to documentation/asciidoc/computers/camera/images/webcam-image.jpg diff --git a/documentation/asciidoc/computers/camera/libcamera_3rd_party_tuning.adoc b/documentation/asciidoc/computers/camera/libcamera_3rd_party_tuning.adoc deleted file mode 100644 index c98c2e3ed..000000000 --- a/documentation/asciidoc/computers/camera/libcamera_3rd_party_tuning.adoc +++ /dev/null @@ -1,15 +0,0 @@ -=== Camera tuning and supporting third-party sensors - -==== The camera tuning file - -Most of the image processing applied to frames from the sensor is done by the hardware ISP. This processing is governed by a set of control algorithms, and these in turn must have a wide range of parameters supplied to them. These parameters are tuned specifically for each sensor and are collected together in a JSON file known as the camera tuning file. - -This tuning file can be inspected and edited by users. Using the `--tuning-file` command line option, users can point the system at completely custom camera tuning files. - -==== Third-party sensors - -`libcamera` makes it possible to support third-party sensors (sensors other than Raspberry Pi's officially supported sensors) on the Raspberry Pi platform. To accomplish this, a working open source sensor driver must be provided, which the authors should be happy to submit to the Linux kernel. There are a couple of extra files which need to be added to `libcamera`, supplying device-specific information which is available from the kernel drivers, including the previously discussed camera tuning file. - -Raspberry Pi also supplies a tuning tool which automates the generation of the tuning file from a few simple calibration images. - -While these topics are rather beyond the scope of the documentation here, full information is available in the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Tuning guide for the Raspberry Pi cameras and libcamera]. diff --git a/documentation/asciidoc/computers/camera/libcamera_differences.adoc b/documentation/asciidoc/computers/camera/libcamera_differences.adoc index 51a10333b..1205db97e 100644 --- a/documentation/asciidoc/computers/camera/libcamera_differences.adoc +++ b/documentation/asciidoc/computers/camera/libcamera_differences.adoc @@ -1,42 +1,42 @@ -=== Differences compared to `Raspicam` apps +=== Differences between `rpicam` and `raspicam` -Whilst the `rpicam-apps` attempt to emulate most features of the legacy `Raspicam` applications, there are some differences. +The `rpicam-apps` emulate most features of the legacy `raspicam` applications. However, users may notice the following differences: -* The use of Boost `program_options` doesn't allow multi-character short versions of options, so where these were present they have had to be dropped. The long form options are named the same way, and any single-character short forms are preserved. +* Boost `program_options` don't allow multi-character short versions of options, so where these were present they have had to be dropped. The long form options are named the same way, and any single-character short forms are preserved. -* `rpicam-still` and `rpicam-jpeg` do not show the capture image in the preview window. +* `rpicam-still` and `rpicam-jpeg` do not show the captured image in the preview window. -* `libcamera` performs its own camera mode selection, so the `--mode` option is not supported. It deduces camera modes from the resolutions requested. There is still work ongoing in this area. +* `rpicam-apps` removed the following `raspicam` features: ++ +** opacity (`--opacity`) +** image effects (`--imxfx`) +** colour effects (`--colfx`) +** annotation (`--annotate`, `--annotateex`) +** dynamic range compression, or DRC (`--drc`) +** stereo (`--stereo`, `--decimate` and `--3dswap`) +** image stabilisation (`--vstab`) +** demo modes (`--demo`) ++ +xref:camera_software.adoc#post-processing-with-rpicam-apps[Post-processing] replaced many of these features. -* The following features of the legacy apps are not supported, as the code has to run on the Arm processor now. A number of these effects are now provided by the xref:camera_software.adoc#post-processing[post-processing] mechanism. - - opacity (`--opacity`) - - image effects (`--imxfx`) - - colour effects (`--colfx`) - - annotation (`--annotate`, `--annotateex`) - - dynamic range compression, or DRC (`--drc`) +* `rpicam-apps` removed xref:camera_software.adoc#rotation[`rotation`] option support for 90° and 270° rotations. -* stereo (`--stereo`, `--decimate` and `--3dswap`). There is currently no support in `libcamera` for stereo. +* `raspicam` conflated metering and exposure; `rpicam-apps` separates these options. +* To disable Auto White Balance (AWB) in `rpicam-apps`, set a pair of colour gains with xref:camera_software.adoc#awbgains[`awbgains`] (e.g. `1.0,1.0`). -* There is no image stabilisation (`--vstab`). +* `rpicam-apps` cannot set Auto White Balance (AWB) into greyworld mode for NoIR camera modules. Instead, pass the xref:camera_software.adoc#tuning-file[`tuning-file`] option a NoIR-specific tuning file like `imx219_noir.json`. -* There are no demo modes (`--demo`). +* `rpicam-apps` does not provide explicit control of digital gain. Instead, the xref:camera_software.adoc#gain[`gain`] option sets it implicitly. -* The transformations supported are those which do not involve a transposition. This means that rotations of 180° are among those permitted, but 90° and 270° rotations are not. +* `rpicam-apps` removed the `--ISO` option. Instead, calculate the gain corresponding to the ISO value required. Vendors can provide mappings of gain to ISO. -* There are some differences in the metering, exposure and AWB options. In particular the legacy apps conflate metering (by which we mean the "metering mode") and the exposure (by which we now mean the "exposure profile"). With regards to AWB, to turn it off you will need to set a pair of colour gains (e.g. `--awbgains 1.0,1.0`). +* `rpicam-apps` does not support setting a flicker period. -* `libcamera` has no mechanism to set the AWB into greyworld mode, which is useful for NoIR camera modules. However, tuning files are supplied which switch the AWB into the correct mode. You could use `rpicam-hello --tuning-file /usr/share/libcamera/ipa/rpi/vc4/imx219_noir.json` (for Pi 4 and earlier devices) or `rpicam-hello --tuning-file /usr/share/libcamera/ipa/rpi/pisp/imx219_noir.json` (Pi 5 and later devices). - -* There is support for setting the exposure time (`--shutter`) and analogue gain (`--analoggain` or just `--gain`). There is no explicit control of the digital gain; it will be imposed if the gain requested is larger than the analogue gain can deliver by itself. - -* `libcamera` has no understanding of ISO, so there is no `--ISO` option. Users should calculate the gain corresponding to the ISO value required (usually a manufacturer will tell you that, for example, a gain of 1 corresponds to an ISO of 40), and use the `--gain` parameter instead. - -* There is no support for setting the flicker period yet. - -* `rpicam-still` does not support burst capture. In fact, because the JPEG encoding is not multi-threaded and pipelined it would produce quite poor framerates. Instead, users are advised to consider using `rpicam-vid` in MJPEG mode instead (and `--segment 1` can be used to force each frame into a separate JPEG file). - -* `libcamera` uses open source drivers for all the image sensors, so the mechanism for enabling or disabling on-sensor defective pixel correction (DPC) is different. The imx477 driver on the Raspberry Pi HQ Camera Module enables on-sensor DPC by default. To disable it the user should, as root, enter: +* `rpicam-still` does not support burst capture. Instead, consider using `rpicam-vid` in MJPEG mode with `--segment 1` to force each frame into a separate file. +* `rpicam-apps` uses open source drivers for all image sensors, so the mechanism for enabling or disabling on-sensor Defective Pixel Correction (DPC) is different. The imx477 driver on the Raspberry Pi HQ Camera enables on-sensor DPC by default. To disable on-sensor DPC on the HQ Camera, run the following command: ++ +[source,console] ---- -echo 0 > /sys/module/imx477/parameters/dpc_enable +$ sudo echo 0 > /sys/module/imx477/parameters/dpc_enable ---- diff --git a/documentation/asciidoc/computers/camera/libcamera_known_issues.adoc b/documentation/asciidoc/computers/camera/libcamera_known_issues.adoc deleted file mode 100644 index 05ab2c52a..000000000 --- a/documentation/asciidoc/computers/camera/libcamera_known_issues.adoc +++ /dev/null @@ -1,7 +0,0 @@ -=== Known issues - -We are aware of the following issues in `libcamera` and `rpicam-apps`. - -* On Raspberry Pi 3 (and earlier devices) the graphics hardware can only support images up to 2048×2048 pixels, which places a limit on the camera images that can be resized into the preview window. In practice, this means that video encoding of images larger than 2048 pixels across (which would necessitate using a codec other than h.264) will not support, preview images; or it will produce corrupted preview images. For Raspberry Pi 4, the limit is 4096 pixels. We would recommend using the `-n` (no preview) option. - -* The preview window may show some display tearing when using a desktop environment. This is not likely to be fixable. diff --git a/documentation/asciidoc/computers/camera/libcamera_python.adoc b/documentation/asciidoc/computers/camera/libcamera_python.adoc index 060d23944..d14a17068 100644 --- a/documentation/asciidoc/computers/camera/libcamera_python.adoc +++ b/documentation/asciidoc/computers/camera/libcamera_python.adoc @@ -1,4 +1,5 @@ -=== Python bindings for `libcamera` +[[picamera2]] +=== Use `libcamera` from Python with Picamera2 The https://github.com/raspberrypi/picamera2[Picamera2 library] is a `rpicam`-based replacement for Picamera, which was a Python interface to Raspberry Pi's legacy camera stack. Picamera2 presents an easy-to-use Python API. @@ -6,31 +7,20 @@ Documentation about Picamera2 is available https://github.com/raspberrypi/picame ==== Installation -On Raspberry Pi OS images, Picamera2 is now installed with all the GUI (Qt and OpenGL) dependencies. On Raspberry Pi OS Lite, it is installed without the GUI dependencies, although preview images can still be displayed using DRM/KMS. If users wish to use the additional GUI features, they will need to run: +Recent Raspberry Pi OS images include Picamera2 with all the GUI (Qt and OpenGL) dependencies. Recent Raspberry Pi OS Lite images include Picamera2 without the GUI dependencies, although preview images can still be displayed using DRM/KMS. ----- -$ sudo apt install -y python3-pyqt5 python3-opengl ----- - -NOTE: No changes are required to Picamera2 itself. - -If your image did not come pre-installed with Picamera2, `apt` is the recommended way of installing and updating Picamera2. - ----- -$ sudo apt update -$ sudo apt upgrade ----- - -Now you can install Picamera2 with all the GUI (Qt and OpenGL) dependencies using: +If your image did not include Picamera2, run the following command to install Picamera2 with all of the GUI dependencies: +[source,console] ---- $ sudo apt install -y python3-picamera2 ---- -If you do not want the GUI dependencies, use: +If you don't want the GUI dependencies, you can run the following command to install Picamera2 without the GUI dependencies: +[source,console] ---- $ sudo apt install -y python3-picamera2 --no-install-recommends ---- -NOTE: If you have installed Picamera2 previously using `pip`, then you should also uninstall this, using the command `pip3 uninstall picamera2`. If Picamera2 is already installed, you can update it with `sudo apt install -y python3-picamera2`, or as part of a full system update (for example, `sudo apt upgrade`). +NOTE: If you previously installed Picamera2 with `pip`, uninstall it with: `pip3 uninstall picamera2`. diff --git a/documentation/asciidoc/computers/camera/qt.adoc b/documentation/asciidoc/computers/camera/qt.adoc index 993416c92..66aa9bb9e 100644 --- a/documentation/asciidoc/computers/camera/qt.adoc +++ b/documentation/asciidoc/computers/camera/qt.adoc @@ -1,15 +1,16 @@ -=== Using libcamera and Qt together +=== Use `libcamera` with Qt -Qt is a popular application framework and GUI toolkit. There is the option in `rpicam-apps` to use it to implement a camera preview window. +Qt is a popular application framework and GUI toolkit. `rpicam-apps` includes an option to use Qt for a camera preview window. -However, Qt defines certain symbols as macros in the global namespace (such as `slot` and `emit`) and this causes errors when including libcamera files. The problem is common to all platforms trying to use both Qt and libcamera and not specific to Raspberry Pi. Nonetheless we suggest that developers experiencing difficulties try the following workarounds. +Unfortunately, Qt defines certain symbols (such as `slot` and `emit`) as macros in the global namespace. This causes errors when including `libcamera` files. The problem is common to all platforms that use both Qt and `libcamera`. Try the following workarounds to avoid these errors: -* libcamera include files, or files that include libcamera files (such as `rpicam-apps` files), should be listed before any Qt header files where possible. +* List `libcamera` include files, or files that include `libcamera` files (such as `rpicam-apps` files), _before_ any Qt header files whenever possible. -* If you do need to mix your Qt application files with libcamera includes, replace `signals:` with `Q_SIGNALS:`, `slots:` with `Q_SLOTS:`, `emit` with `Q_EMIT` and `foreach` with `Q_FOREACH`. +* If you do need to mix your Qt application files with `libcamera` includes, replace `signals:` with `Q_SIGNALS:`, `slots:` with `Q_SLOTS:`, `emit` with `Q_EMIT` and `foreach` with `Q_FOREACH`. -* Before any libcamera include files, add +* Add the following at the top of any `libcamera` include files: + +[source,cpp] ---- #undef signals #undef slots @@ -17,6 +18,5 @@ However, Qt defines certain symbols as macros in the global namespace (such as ` #undef foreach ---- -* If you are using qmake, add `CONFIG += no_keywords` to the project file. If using cmake, add `SET(QT_NO_KEYWORDS ON)`. - -We are not aware of any plans for the underlying library problems to be addressed. +* If your project uses `qmake`, add `CONFIG += no_keywords` to the project file. +* If your project uses `cmake`, add `SET(QT_NO_KEYWORDS ON)`. diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_building.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_building.adoc index 87dff3b2b..9fe1ea10a 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_building.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_building.adoc @@ -1,172 +1,293 @@ -=== Building `libcamera` and `rpicam-apps` +== Advanced `rpicam-apps` -Building `libcamera` and `rpicam-apps` for yourself can bring the following benefits. +=== Build `libcamera` and `rpicam-apps` -* You can pick up the latest enhancements and features +Build `libcamera` and `rpicam-apps` for yourself for the following benefits: -* `rpicam-apps` can be compiled with extra optimisation for Raspberry Pi 3 and Raspberry Pi 4 devices running a 32-bit OS +* You can pick up the latest enhancements and features. -* You can include the various optional OpenCV and/or TFLite post-processing stages (or add your own) +* `rpicam-apps` can be compiled with extra optimisation for Raspberry Pi 3 and Raspberry Pi 4 devices running a 32-bit OS. + +* You can include optional OpenCV and/or TFLite post-processing stages, or add your own. * You can customise or add your own applications derived from `rpicam-apps` -NOTE: When building on a Raspberry Pi with 1GB RAM or less, there is a risk that the device may run out of swap and fail. We recommend either increasing the amount of swap, or building with fewer threads (the `-j` option to `ninja` and to `make`). +==== Remove pre-installed `rpicam-apps` + +Raspberry Pi OS includes a pre-installed copy of `rpicam-apps`. Before building and installing your own version of `rpicam-apps`, you must first remove the pre-installed version. Run the following command to remove the `rpicam-apps` package from your Raspberry Pi: + +[source,console] +---- +$ sudo apt remove --purge rpicam-apps +---- -==== Building `rpicam-apps` without rebuilding `libcamera` +==== Building `rpicam-apps` without building `libcamera` -You can rebuild `rpicam-apps` _without_ first rebuilding the whole of `libcamera` and `libepoxy`. If you do not need support for the GLES/EGL preview window then `libepoxy` can be omitted entirely. Raspberry Pi OS Lite users must be sure to use `-Denable_egl=false` when running `meson setup` later: +To build `rpicam-apps` without first rebuilding `libcamera` and `libepoxy`, install `libcamera`, `libepoxy` and their dependencies with `apt`: +[source,console] ---- -sudo apt install -y libcamera-dev libjpeg-dev libtiff5-dev libpng-dev +$ sudo apt install -y libcamera-dev libepoxy-dev libjpeg-dev libtiff5-dev libpng-dev libopencv-dev ---- -All other users should execute: +TIP: If you do not need support for the GLES/EGL preview window, omit `libepoxy-dev`. +To use the Qt preview window, install the following additional dependencies: + +[source,console] ---- -sudo apt install -y libcamera-dev libepoxy-dev libjpeg-dev libtiff5-dev libpng-dev +$ sudo apt install -y qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5 ---- -If you want to use the Qt preview window: +For xref:camera_software.adoc#libav-integration-with-rpicam-vid[`libav`] support in `rpicam-vid`, install the following additional dependencies: +[source,console] ---- -sudo apt install -y qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5 +$ sudo apt install libavcodec-dev libavdevice-dev libavformat-dev libswresample-dev ---- -If you want xref:camera_software.adoc#libav-integration-with-rpicam-vid[`libav`] support in `rpicam-vid`, additional libraries must be installed: +If you run Raspberry Pi OS Lite, install `git`: +[source,console] ---- -sudo apt install libavcodec-dev libavdevice-dev libavformat-dev libswresample-dev +$ sudo apt install -y git ---- -Now proceed directly to the instructions for xref:camera_software.adoc#building-rpicam-apps[building `rpicam-apps`]. Raspberry Pi OS Lite users should check that git is installed first (`sudo apt install -y git`). +Next, xref:camera_software.adoc#building-rpicam-apps[build `rpicam-apps`]. ==== Building `libcamera` -Rebuilding `libcamera` from scratch should be necessary only if you need the latest features that may not yet have reached the `apt` repositories, or if you need to customise its behaviour in some way. +NOTE: Only build `libcamera` from scratch if you need custom behaviour or the latest features that have not yet reached `apt` repositories. -First install all the necessary dependencies for `libcamera`. Raspberry Pi OS Lite users will first need to install the following additional packages if they have not done so previously: +[NOTE] +====== +If you run Raspberry Pi OS Lite, begin by installing the following packages: +[source,console] ---- -sudo apt install -y python3-pip git python3-jinja2 +$ sudo apt install -y python3-pip git python3-jinja2 ---- +====== -All users should then install the following: +First, install the following `libcamera` dependencies: +[source,console] ---- -sudo apt install -y libboost-dev -sudo apt install -y libgnutls28-dev openssl libtiff5-dev pybind11-dev -sudo apt install -y qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5 -sudo apt install -y meson cmake -sudo apt install -y python3-yaml python3-ply +$ sudo apt install -y libboost-dev +$ sudo apt install -y libgnutls28-dev openssl libtiff5-dev pybind11-dev +$ sudo apt install -y qtbase5-dev libqt5core5a libqt5gui5 libqt5widgets5 +$ sudo apt install -y meson cmake +$ sudo apt install -y python3-yaml python3-ply +$ sudo apt install -y libglib2.0-dev libgstreamer-plugins-base1.0-dev ---- -In the `meson` commands below we have enabled the gstreamer plugin. If you do not need this, you can set `-Dgstreamer=disabled` instead and the next pair of dependencies will not be required. But if you do leave _gstreamer_ enabled, then you will need the following: +Now we're ready to build `libcamera` itself. + +Download a local copy of Raspberry Pi's fork of `libcamera` from GitHub: +[source,console] ---- -sudo apt install -y libglib2.0-dev libgstreamer-plugins-base1.0-dev +$ git clone https://github.com/raspberrypi/libcamera.git ---- -Now we can check out and build `libcamera` itself. We check out Raspberry Pi's fork of `libcamera`, which tracks the official repository but lets us control exactly when we pick up new features. +Navigate into the root directory of the repository: +[source,console] ---- -cd -git clone https://github.com/raspberrypi/libcamera.git -cd libcamera +$ cd libcamera ---- -Now run: +Next, run `meson` to configure the build environment: +[source,console] ---- -meson setup build --buildtype=release -Dpipelines=rpi/vc4,rpi/pisp -Dipas=rpi/vc4,rpi/pisp -Dv4l2=true -Dgstreamer=enabled -Dtest=false -Dlc-compliance=disabled -Dcam=disabled -Dqcam=disabled -Ddocumentation=disabled -Dpycamera=enabled +$ meson setup build --buildtype=release -Dpipelines=rpi/vc4,rpi/pisp -Dipas=rpi/vc4,rpi/pisp -Dv4l2=true -Dgstreamer=enabled -Dtest=false -Dlc-compliance=disabled -Dcam=disabled -Dqcam=disabled -Ddocumentation=disabled -Dpycamera=enabled ---- -To complete the `libcamera` build, use: +NOTE: You can disable the `gstreamer` plugin by replacing `-Dgstreamer=enabled` with `-Dgstreamer=disabled` during the `meson` build configuration. If you disable `gstreamer`, there is no need to install the `libglib2.0-dev` and `libgstreamer-plugins-base1.0-dev` dependencies. +Now, you can build `libcamera` with `ninja`: + +[source,console] ---- -ninja -C build # use -j 2 on Raspberry Pi 3 or earlier devices -sudo ninja -C build install +$ ninja -C build ---- -NOTE: At the time of writing, `libcamera` does not yet have a stable binary interface. Therefore, if you have rebuilt `libcamera`, we recommend continuing and rebuilding `rpicam-apps` from scratch too. +Finally, run the following command to install your freshly-built `libcamera` binary: -==== Building `libepoxy` +[source,console] +---- +$ sudo ninja -C build install +---- -Rebuilding `libepoxy` should not normally be necessary as this library changes only very rarely. If you do want to build it from scratch, however, please follow the instructions below. +TIP: On devices with 1GB of memory or less, the build may exceed available memory. Append the `-j 1` flag to `ninja` commands to limit the build to a single process. This should prevent the build from exceeding available memory on devices like the Raspberry Pi Zero and the Raspberry Pi 3. -Start by installing the necessary dependencies. +`libcamera` does not yet have a stable binary interface. Always build `rpicam-apps` after you build `libcamera`. + +==== Building `rpicam-apps` + +First fetch the necessary dependencies for `rpicam-apps`. +[source,console] ---- -sudo apt install -y libegl1-mesa-dev +$ sudo apt install -y cmake libboost-program-options-dev libdrm-dev libexif-dev +$ sudo apt install -y meson ninja-build ---- -Next, check out and build `libepoxy`. +Download a local copy of Raspberry Pi's `rpicam-apps` GitHub repository: +[source,console] ---- -cd -git clone https://github.com/anholt/libepoxy.git -cd libepoxy -mkdir _build -cd _build -meson -ninja -sudo ninja install +$ git clone https://github.com/raspberrypi/rpicam-apps.git ---- -==== Building `rpicam-apps` +Navigate into the root directory of the repository: -First fetch the necessary dependencies for `rpicam-apps`. +[source,console] +---- +$ cd rpicam-apps +---- + +For desktop-based operating systems like Raspberry Pi OS, configure the `rpicam-apps` build with the following `meson` command: + +[source,console] +---- +$ meson setup build -Denable_libav=enabled -Denable_drm=enabled -Denable_egl=enabled -Denable_qt=enabled -Denable_opencv=disabled -Denable_tflite=disabled -Denable_hailo=disabled +---- + +For headless operating systems like Raspberry Pi OS Lite, configure the `rpicam-apps` build with the following `meson` command: + +[source,console] +---- +$ meson setup build -Denable_libav=disabled -Denable_drm=enabled -Denable_egl=disabled -Denable_qt=disabled -Denable_opencv=disabled -Denable_tflite=disabled -Denable_hailo=disabled +---- + +[TIP] +====== + +* Use `-Dneon_flags=armv8-neon` to enable optimisations for 32-bit OSes on Raspberry Pi 3 or Raspberry Pi 4. +* Use `-Denable_opencv=enabled` if you have installed OpenCV and wish to use OpenCV-based post-processing stages. +* Use `-Denable_tflite=enabled` if you have installed TensorFlow Lite and wish to use it in post-processing stages. +* Use `-Denable_hailo=enabled` if you have installed HailoRT and wish to use it in post-processing stages. + +====== + +You can now build `rpicam-apps` with the following command: + +[source,console] +---- +$ meson compile -C build +---- + +TIP: On devices with 1GB of memory or less, the build may exceed available memory. Append the `-j 1` flag to `meson` commands to limit the build to a single process. This should prevent the build from exceeding available memory on devices like the Raspberry Pi Zero and the Raspberry Pi 3. +Finally, run the following command to install your freshly-built `rpicam-apps` binary: + +[source,console] ---- -sudo apt install -y cmake libboost-program-options-dev libdrm-dev libexif-dev -sudo apt install -y meson ninja-build +$ sudo meson install -C build ---- -The `rpicam-apps` build process begins with the following: +[TIP] +==== +The command above should automatically update the `ldconfig` cache. If you have trouble accessing your new `rpicam-apps` build, run the following command to update the cache: +[source,console] ---- -cd -git clone https://github.com/raspberrypi/rpicam-apps.git -cd rpicam-apps +$ sudo ldconfig ---- +==== + +Run the following command to check that your device uses the new binary: + +[source,console] +---- +$ rpicam-still --version +---- + +The output should include the date and time of your local `rpicam-apps` build. + +Finally, follow the `dtoverlay` and display driver instructions in the xref:camera_software.adoc#configuration[Configuration section]. + +==== `rpicam-apps` meson flag reference + +The `meson` build configuration for `rpicam-apps` supports the following flags: + +`-Dneon_flags=armv8-neon`:: Speeds up certain post-processing features on Raspberry Pi 3 or Raspberry Pi 4 devices running a 32-bit OS. + +`-Denable_libav=enabled`:: Enables or disables `libav` encoder integration. + +`-Denable_drm=enabled`:: Enables or disables **DRM/KMS preview rendering**, a preview window used in the absence of a desktop environment. + +`-Denable_egl=enabled`:: Enables or disables the non-Qt desktop environment-based preview. Disable if your system lacks a desktop environment. + +`-Denable_qt=enabled`:: Enables or disables support for the Qt-based implementation of the preview window. Disable if you do not have a desktop environment installed or if you have no intention of using the Qt-based preview window. The Qt-based preview is normally not recommended because it is computationally very expensive, however it does work with X display forwarding. -At this point you will need to run `meson setup` after deciding what extra flags to pass it. The valid flags are: +`-Denable_opencv=enabled`:: Forces OpenCV-based post-processing stages to link or not link. Requires OpenCV to enable. Defaults to `disabled`. -* `-Dneon_flags=armv8-neon` - you may supply this when building for Raspberry Pi 3 or Raspberry Pi 4 devices running a 32-bit OS. Some post-processing features may run more quickly. +`-Denable_tflite=enabled`:: Enables or disables TensorFlow Lite post-processing stages. Disabled by default. Requires Tensorflow Lite to enable. Depending on how you have built and/or installed TFLite, you may need to tweak the `meson.build` file in the `post_processing_stages` directory. -* `-Denable_libav=true` or `-Denable_libav=false` - this enables or disables the libav encoder integration. +`-Denable_hailo=enabled`:: Enables or disables HailoRT-based post-processing stages. Requires HailoRT to enable. Defaults to `auto`. -* `-Denable_drm=true` or `-Denable_drm=false` - this enables or disables the DRM/KMS preview rendering. This is what implements the preview window when a desktop environment is not running. +`-Ddownload_hailo_models=true`:: Downloads and installs models for HailoRT post-processing stages. Requires `wget` to be installed. Defaults to `true`. -* `-Denable_egl=true` or `-Denable_egl=false` - this enables or disables the desktop environment-based preview. You should disable this if your system does not have a desktop environment installed. -* `-Denable_qt=true` or `-Denable_qt=false` - this enables or disables support for the Qt-based implementation of the preview window. You should disable it if you do not have a desktop environment installed, or if you have no intention of using the Qt-based preview window. The Qt-based preview is normally not recommended because it is computationally very expensive, however it does work with X display forwarding. +Each of the above options (except for `neon_flags`) supports the following values: -* `-Denable_opencv=true` or `-Denable_opencv=false` - you may choose one of these to force OpenCV-based post-processing stages to be linked (or not). If you enable them, then OpenCV must be installed on your system. Normally they will be built by default if OpenCV is available. +* `enabled`: enables the option, fails the build if dependencies are not available +* `disabled`: disables the option +* `auto`: enables the option if dependencies are available -* `-Denable_tflite=true` or `-Denable_tflite=false` - choose one of these to enable TensorFlow Lite post-processing stages (or not). By default they will not be enabled. If you enable them then TensorFlow Lite must be available on your system. Depending on how you have built and/or installed TFLite, you may need to tweak the `meson.build` file in the `post_processing_stages` directory. +==== Building `libepoxy` -For Raspberry Pi OS users we recommend the following `meson setup` command: +Rebuilding `libepoxy` should not normally be necessary as this library changes only very rarely. If you do want to build it from scratch, however, please follow the instructions below. +Start by installing the necessary dependencies. + +[source,console] ---- -meson setup build -Denable_libav=true -Denable_drm=true -Denable_egl=true -Denable_qt=true -Denable_opencv=false -Denable_tflite=false +$ sudo apt install -y libegl1-mesa-dev ---- -and for Raspberry Pi OS Lite users: +Next, download a local copy of the `libepoxy` repository from GitHub: +[source,console] ---- -meson setup build -Denable_libav=false -Denable_drm=true -Denable_egl=false -Denable_qt=false -Denable_opencv=false -Denable_tflite=false +$ git clone https://github.com/anholt/libepoxy.git ---- -In both cases, consider `-Dneon_flags=armv8-neon` if you are using a 32-bit OS on a Raspberry Pi 3 or Raspberry Pi 4. Consider `-Denable_opencv=true` if you have installed OpenCV and wish to use OpenCV-based post-processing stages. Finally also consider `-Denable_tflite=true` if you have installed TensorFlow Lite and wish to use it in post-processing stages. +Navigate into the root directory of the repository: -After executing the `meson setup` command of your choice, the whole process concludes with the following: +[source,console] +---- +$ cd libepoxy +---- + +Create a build directory at the root level of the repository, then navigate into that directory: +[source,console] ---- -meson compile -C build # use -j1 on Raspberry Pi 3 or earlier devices -sudo meson install -C build -sudo ldconfig # this is only necessary on the first build +$ mkdir _build +$ cd _build ---- -NOTE: If you are using an image where `rpicam-apps` have been previously installed as an `apt` package, and you want to run the new `rpicam-apps` executables from the same terminal window where you have just built and installed them, you may need to run `hash -r` to be sure to pick up the new executables over the system supplied ones. +Next, run `meson` to configure the build environment: -Finally, if you have not already done so, please be sure to follow the `dtoverlay` and display driver instructions in the xref:camera_software.adoc#getting-started[Getting Started section] (and rebooting if you changed anything there). +[source,console] +---- +$ meson +---- + +Now, you can build `libexpoxy` with `ninja`: + +[source,console] +---- +$ ninja +---- + +Finally, run the following command to install your freshly-built `libepoxy` binary: + +[source,console] +---- +$ sudo ninja install +---- diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_getting_help.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_getting_help.adoc index b0770e490..8cf2367bc 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_getting_help.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_getting_help.adoc @@ -1,15 +1,17 @@ -=== Getting help +== Getting help -For further help with `libcamera` and the `rpicam-apps`, the first port of call will usually be the https://forums.raspberrypi.com/viewforum.php?f=43[Raspberry Pi Camera forum]. Before posting, it's helpful to: +For further help with `libcamera` and the `rpicam-apps`, check the https://forums.raspberrypi.com/viewforum.php?f=43[Raspberry Pi Camera forum]. Before posting: * Make a note of your operating system version (`uname -a`). * Make a note of your `libcamera` and `rpicam-apps` versions (`rpicam-hello --version`). -* Please report the make and model of the camera module you are using. Note that when third-party camera module vendors supply their own software, we are normally unable to offer any support. All queries should be directed back to the vendor. +* Report the make and model of the camera module you are using. -* Please also provide information on what kind of Raspberry Pi you have, including memory size. +* Report the software you are trying to use. We don't support third-party camera module vendor software. -* If it seems like it might be relevant, please include any excerpts from the application's console output. +* Report your Raspberry Pi model, including memory size. -When it seems likely that there are specific problems in the camera software (such as crashes), it may be more appropriate to https://github.com/raspberrypi/rpicam-apps[create an issue in the `rpicam-apps` GitHub repository]. Again, please include all the helpful details that you can. +* Include any relevant excerpts from the application's console output. + +If there are specific problems in the camera software (such as crashes), consider https://github.com/raspberrypi/rpicam-apps[creating an issue in the `rpicam-apps` GitHub repository], including the same details listed above. diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_getting_started.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_getting_started.adoc deleted file mode 100644 index 79c4b25db..000000000 --- a/documentation/asciidoc/computers/camera/rpicam_apps_getting_started.adoc +++ /dev/null @@ -1,72 +0,0 @@ -=== Getting started - -==== Using the camera for the first time - -NOTE: On Raspberry Pi 3 and earlier devices running _Bullseye_, you need to re-enable _Glamor_ in order to make the X Windows hardware accelerated preview window work. Enter `sudo raspi-config` at a terminal window and then choose `Advanced Options`, `Glamor` and `Yes`. Quit `raspi-config` and let it reboot your Raspberry Pi. - -When running a recent version of Raspberry Pi OS, the five basic `rpicam-apps` are already installed. In this case, official Raspberry Pi cameras will also be detected and enabled automatically. - -You can check that everything is working by entering: - -[,bash] ----- -rpicam-hello ----- - -You should see a camera preview window for about five seconds. - -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/firmware/config.txt` file if: - -* You are using a third-party camera (the manufacturer's instructions should explain the changes you need to make) - -* You are using an official Raspberry Pi camera but wish to use a non-standard driver/overlay - -If you do need to add your own `dtoverlay`, the following are currently recognised. - -|=== -| Camera Module | In `/boot/firmware/config.txt` - -| V1 camera (OV5647) -| `dtoverlay=ov5647` - -| V2 camera (IMX219) -| `dtoverlay=imx219` - -| HQ camera (IMX477) -| `dtoverlay=imx477` - -| GS camera (IMX296) -| `dtoverlay=imx296` - -| Camera Module 3 (IMX708) -| `dtoverlay=imx708` - -| IMX290 and IMX327 -| `dtoverlay=imx290,clock-frequency=74250000` or `dtoverlay=imx290,clock-frequency=37125000` (both modules share the imx290 kernel driver; please refer to instructions from the module vendor for the correct frequency) - -| IMX378 -| `dtoverlay=imx378` - -| OV9281 -| `dtoverlay=ov9281` -|=== - -To override the automatic camera detection, you will need to delete the entry `camera_auto_detect=1` if present in the `config.txt` file. Your Raspberry Pi will need to be rebooted after editing this file. - -NOTE: Setting `camera_auto_detect=0` disables the boot-time detection completely. - -=== Troubleshooting - -If the Camera Module isn't working correctly, there are number of things you can try: - -* Is the flat flexible cable attached to the Camera Serial Interface (CSI), not the Display Serial Interface (DSI)? The connector will fit into either port. The Camera port is located near the HDMI connector. -* Are the connectors all firmly seated, and are they the right way round? They must be straight in their sockets. -* Is the Camera Module connector, between the smaller black Camera Module itself and the PCB, firmly attached? Sometimes this connection can come loose during transit or when putting the Camera Module in a case. Using a fingernail, flip up the connector on the PCB, then reconnect it with gentle pressure. It engages with a very slight click. Don't force it; if it doesn't engage, it's probably slightly misaligned. -* Have `sudo apt update` and `sudo apt full-upgrade` been run? -* Is your power supply sufficient? The Camera Module adds about 200-250mA to the power requirements of your Raspberry Pi. -* If you've checked all the above issues and the Camera Module is still not working, try posting on our forums for more help. - diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_intro.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_intro.adoc index b39269273..4accca0a8 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_intro.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_intro.adoc @@ -1,40 +1,47 @@ -== `libcamera` and `rpicam-apps` +== `rpicam-apps` -[WARNING] +[NOTE] ==== -Raspberry Pi OS _Bookworm_ renamed the camera capture applications from `libcamera-\*` to `rpicam-*`. Symbolic links currently allow users to keep using the old application names, but those links will eventually be deprecated. Adopt the new application names as soon as possible. Raspberry Pi OS versions prior to _Bookworm_ only provide access to older versions of the suite using the `libcamera-\*` name prefix. +Raspberry Pi OS _Bookworm_ renamed the camera capture applications from ``libcamera-\*`` to ``rpicam-*``. Symbolic links allow users to use the old names for now. **Adopt the new application names as soon as possible.** Raspberry Pi OS versions prior to _Bookworm_ still use the ``libcamera-*`` name. ==== -=== Introduction +Raspberry Pi supplies a small set of example `rpicam-apps`. These CLI applications, built on top of `libcamera`, capture images and video from a camera. These applications include: -`libcamera` is a new software library aimed at supporting complex camera systems directly from the Linux operating system. It enables us to drive the Raspberry Pi camera system directly from open-source code running on Arm processors. The proprietary code running on the Broadcom GPU, to which users have no access, is almost completely bypassed. +* `rpicam-hello`: A "hello world"-equivalent for cameras, which starts a camera preview stream and displays it on the screen. +* `rpicam-jpeg`: Runs a preview window, then captures high-resolution still images. +* `rpicam-still`: Emulates many of the features of the original `raspistill` application. +* `rpicam-vid`: Captures video. +* `rpicam-raw`: Captures raw (unprocessed Bayer) frames directly from the sensor. +* `rpicam-detect`: Not built by default, but users can build it if they have TensorFlow Lite installed on their Raspberry Pi. Captures JPEG images when certain objects are detected. -`libcamera` presents a {cpp} API to applications. It works at the level of configuring the camera and then allowing an application to request image frames. These image buffers reside in system memory and can be passed directly to still image encoders (such as JPEG) or to video encoders (such as h.264). Ancillary functions such as encoding images or displaying them are beyond the purview of `libcamera` itself. +Recent versions of Raspberry Pi OS include the five basic `rpicam-apps`, so you can record images and videos using a camera even on a fresh Raspberry Pi OS installation. -For this reason Raspberry Pi supplies a small set of example `rpicam-apps`. These are simple applications, built on top of `libcamera`, and are designed to emulate the function of the legacy stack built on Broadcom's proprietary GPU code (some users will recognise these legacy applications as `raspistill` and `raspivid`). The applications we provide are: +Users can create their own `rpicam`-based applications with custom functionality to suit their own requirements. The https://github.com/raspberrypi/rpicam-apps[`rpicam-apps` source code] is freely available under a BSD-2-Clause licence. -* _rpicam-hello_ A simple "hello world" application which starts a camera preview stream and displays it on the screen. -* _rpicam-jpeg_ A simple application to run a preview window and then capture high-resolution still images. -* _rpicam-still_ A more complex still-image capture application, which emulates more of the features of the original `raspistill` application. -* _rpicam-vid_ A video-capture application. -* _rpicam-raw_ A basic application for capturing raw (unprocessed Bayer) frames directly from the sensor. -* _rpicam-detect_ This application is not built by default, but users can build it if they have TensorFlow Lite installed on their Raspberry Pi. It captures JPEG images when certain objects are detected. +=== `libcamera` -Raspberry Pi's `rpicam-apps` are command-line applications that make it easy to capture images and video from the camera. They are also examples of how users can create their own rpicam-based applications with custom functionality to suit their own requirements. The https://github.com/raspberrypi/rpicam-apps[source code for the `rpicam-apps`] is freely available under a BSD 2-Clause licence. +`libcamera` is an open-source software library aimed at supporting camera systems directly from the Linux operating system on Arm processors. Proprietary code running on the Broadcom GPU is minimised. For more information about `libcamera` see the https://libcamera.org[`libcamera` website]. -==== More about `libcamera` +`libcamera` provides a {cpp} API that configures the camera, then allows applications to request image frames. These image buffers reside in system memory and can be passed directly to still image encoders (such as JPEG) or to video encoders (such as H.264). `libcamera` doesn't encode or display images itself: that that functionality, use `rpicam-apps`. -`libcamera` is an open source Linux community project. More information is available at the https://libcamera.org[`libcamera` website]. +You can find the source code in the https://git.linuxtv.org/libcamera.git/[official libcamera repository]. The Raspberry Pi OS distribution uses a https://github.com/raspberrypi/libcamera.git[fork] to control updates. -The `libcamera` source code can be found and checked out from the https://git.linuxtv.org/libcamera.git/[official libcamera repository], although we work from a https://github.com/raspberrypi/libcamera.git[fork] that lets us control when we get _libcamera_ updates. +Underneath the `libcamera` core, we provide a custom pipeline handler. `libcamera` uses this layer to drive the sensor and image signal processor (ISP) on the Raspberry Pi. `libcamera` contains a collection of image-processing algorithms (IPAs) including auto exposure/gain control (AEC/AGC), auto white balance (AWB), and auto lens-shading correction (ALSC). -Underneath the `libcamera` core, Raspberry Pi provides a custom pipeline handler, which is the layer that `libcamera` uses to drive the sensor and image signal processor (ISP) on the Raspberry Pi. There is also a collection of well-known control algorithms, or image-processing algorithms (IPAs) in `libcamera` parlance, such as auto exposure/gain control (AEC/AGC), auto white balance (AWB), auto lens-shading correction (ALSC) and so on. +Raspberry Pi's implementation of `libcamera` supports the following cameras: -All this code is open source and runs on the Raspberry Pi's Arm cores. There is only a very thin layer of code on the GPU which translates Raspberry Pi's own control parameters into register writes for the Broadcom ISP. - -Raspberry Pi's implementation of `libcamera` supports not only the four standard Raspberry Pi cameras (the OV5647 or V1 camera, the IMX219 or V2 camera, the IMX477 or HQ camera and the IMX708 or Camera Module 3) but also third-party senors such as the IMX290, IMX327, OV9281, IMX378. We are always pleased to work with vendors who would like to see their sensors supported directly by `libcamera`. - -We also supply a tuning file for each of these sensors, which can be edited to change the processing performed by the Raspberry Pi hardware on the raw images received from the image sensor, including aspects like the colour processing, the amount of noise suppression or the behaviour of the control algorithms. - -For further information on `libcamera` for the Raspberry Pi, please consult the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Tuning guide for the Raspberry Pi cameras and libcamera]. +* Official cameras: +** OV5647 (V1) +** IMX219 (V2) +** IMX708 (V3) +** IMX477 (HQ) +** IMX500 (AI) +** IMX296 (GS) +* Third-party sensors: +** IMX290 +** IMX327 +** IMX378 +** IMX519 +** OV9281 +To extend support to a new sensor, https://git.linuxtv.org/libcamera.git/[contribute to `libcamera`]. diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_libav.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_libav.adoc deleted file mode 100644 index ded5263f8..000000000 --- a/documentation/asciidoc/computers/camera/rpicam_apps_libav.adoc +++ /dev/null @@ -1,77 +0,0 @@ -=== libav integration with rpicam-vid - -`rpicam-vid` can use the ffmpeg/libav codec backend to encode audio and video streams and either save to a local file or stream over the network. At present, video is encoded through the hardware H.264 encoder on those models of Raspberry Pi that support hardware encoding, and audio is encoded by a number of available software encoders. To list the available output formats, use the `ffmpeg -formats` command. - -To enable the libav backend, use the `--codec libav` command line option. Once enabled, the following configuration options are available: - ----- - --libav-format, libav output format to be used ----- - -Set the libav output format to use. These output formats can be specified as containers (e.g. mkv, mp4, avi), or stream output (e.g. h264 or mpegts). If this option is not provided, libav tries to deduce the output format from the filename specified by the `-o` command line argument. - -Example: To save a video in an mkv container, the following commands are equivalent: - ----- -rpicam-vid --codec libav -o test.mkv -rpicam-vid --codec libav --libav-format mkv -o test.raw ----- - ----- - --libav-audio, Enable audio recording ----- - -Set this option to enable audio encoding together with the video stream. When audio encoding is enabled, an output format that supports audio (e.g. mpegts, mkv, mp4) must be used. - ----- - --audio-codec, Selects the audio codec ----- - -Selects which software audio codec is used for encoding. By default `aac` is used. To list the available audio codecs, use the `ffmpeg -codec` command. - ----- - --audio-bitrate, Selects the audio bitrate ----- - -Sets the audio encoding bitrate in bits per second. - -Example: To record audio at 16 kilobits/sec with the mp2 codec use `rpicam-vid --codec libav -o test.mp4 --audio_codec mp2 --audio-bitrate 16384` - ----- - --audio-samplerate, Set the audio sampling rate ----- - -Set the audio sampling rate in Hz for encoding. Set to 0 (default) to use the input sample rate. - ----- - --audio-device, Chooses an audio recording device to use ----- - -Selects which ALSA input device to use for audio recording. The audio device string can be obtained with the following command: - ----- -$ pactl list | grep -A2 'Source #' | grep 'Name: ' - Name: alsa_output.platform-bcm2835_audio.analog-stereo.monitor - Name: alsa_output.platform-fef00700.hdmi.hdmi-stereo.monitor - Name: alsa_output.usb-GN_Netcom_A_S_Jabra_EVOLVE_LINK_000736B1214E0A-00.analog-stereo.monitor - Name: alsa_input.usb-GN_Netcom_A_S_Jabra_EVOLVE_LINK_000736B1214E0A-00.mono-fallback ----- - ----- - --av-sync, Audio/Video sync control ----- -This option can be used to shift the audio sample timestamp by a value given in microseconds relative to the video frame. Negative values may also be used. - -==== Network streaming with libav - -It is possible to use the libav backend as a network streaming source for audio/video. To do this, the output filename specified by the `-o` argument must be given as a protocol url, see https://ffmpeg.org/ffmpeg-protocols.html[ffmpeg protocols] for more details on protocol usage. Some examples: - -To stream audio/video using TCP ----- -rpicam-vid -t 0 --codec libav --libav-format mpegts --libav-audio -o "tcp://0.0.0.0:1234?listen=1" ----- - -To stream audio/video using UDP ----- -rpicam-vid -t 0 --codec libav --libav-format mpegts --libav-audio -o "udp://:" ----- diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_multicam.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_multicam.adoc index 6bc7abfd2..fb387443a 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_multicam.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_multicam.adoc @@ -1,12 +1,68 @@ -=== Using multiple cameras +=== Use multiple cameras -Basic support for multiple cameras is available within `rpicam-apps`. Multiple cameras may be attached to a Raspberry Pi in the following ways: +`rpicam-apps` has basic support for multiple cameras. You can attach multiple cameras to a Raspberry Pi in the following ways: -* Two cameras connected directly to a Raspberry Pi Compute Module board, see the xref:../computers/compute-module.adoc#attach-a-raspberry-pi-camera-module[Compute Module documentation] for further details. -* Two or more cameras attached to a non-compute Raspberry Pi board using a Video Mux board, like https://www.arducam.com/product/multi-camera-v2-1-adapter-raspberry-pi/[this 3rd party product]. +* For Raspberry Pi Compute Modules, you can connect two cameras directly to a Raspberry Pi Compute Module I/O board. See the xref:../computers/compute-module.adoc#attach-a-camera-module[Compute Module documentation] for further details. With this method, you can _use both cameras simultaneously_. +* For Raspberry Pi 5, you can connect two cameras directly to the board using the dual MIPI connectors. +* For other Raspberry Pi devices with a camera port, you can attach two or more cameras with a Video Mux board such as https://www.arducam.com/product/multi-camera-v2-1-adapter-raspberry-pi/[this third-party product]. Since both cameras are attached to a single Unicam port, _only one camera may be used at a time_. -In the latter case, only one camera may be used at a time, since both cameras are attached to a single Unicam port. For the former, both cameras can run simultaneously. +To list all the cameras available on your platform, use the xref:camera_software.adoc#list-cameras[`list-cameras`] option. To choose which camera to use, pass the camera index to the xref:camera_software.adoc#camera[`camera`] option. -To list all the cameras available on your platform, use the `--list-cameras` command line option. To choose which camera to use, use the `--camera ` option, and provide the index value of the requested camera. +NOTE: `libcamera` does not yet provide stereoscopic camera support. When running two cameras simultaneously, they must be run in separate processes, meaning there is no way to synchronise 3A operation between them. As a workaround, you could synchronise the cameras through an external sync signal for the HQ (IMX477) camera or use the software camera synchronisation support that is described below, switching the 3A to manual mode if necessary. -NOTE: `libcamera` does not yet provide stereoscopic camera support. When running two cameras simultaneously, they must be run in separate processes. This means there is no way to synchronise sensor framing or 3A operation between them. As a workaround, you could synchronise the cameras through an external sync signal for the HQ (IMX477) camera, and switch the 3A to manual mode if necessary. +==== Software Camera Synchronisation + +Raspberry Pi's _libcamera_ implementation has the ability to synchronise the frames of different cameras using only software. This will cause one camera to adjust it's frame timing so as to coincide as closely as possible with the frames of another camera. No soldering or hardware connections are required, and it will work with all of Raspberry Pi's camera modules, and even third party ones so long as their drivers implement frame duration control correctly. + +**How it works** + +The scheme works by designating one camera to be the _server_. The server will broadcast timing messages onto the network at regular intervals, such as once a second. Meanwhile other cameras, known as _clients_, can listen to these messages whereupon they may lengthen or shorten frame times slightly so as to pull them into sync with the server. This process is continual, though after the first adjustment, subsequent adjustments are normally small. + +The client cameras may be attached to the same Raspberry Pi device as the server, or they may be attached to different Raspberry Pis on the same network. The camera model on the clients may match the server, or they may be different. + +Clients and servers need to be set running at the same nominal framerate (such as 30fps). Note that there is no back-channel from the clients back to the server. It is solely the clients' responsibility to be up and running in time to match the server, and the server is completely unaware whether clients have synchronised successfully, or indeed whether there are any clients at all. + +In normal operation, running the same make of camera on the same Raspberry Pi, we would expect the frame start times of the camera images to match within "several tens of microseconds". When the camera models are different this could be significantly larger as the cameras will probably not be able to match framerates exactly and will therefore be continually drifting apart (and brought back together with every timing message). + +When cameras are on different devices, the system clocks should be synchronised using NTP (normally the case by default for Raspberry Pi OS), or if this is insufficiently precise, another protocol like PTP might be used. Any discrepancy between system clocks will feed directly into extra error in frame start times - even though the advertised timestamps on the frames will not tell you. + +**The Server** + +The server, as previously explained, broadcasts timing messages onto the network, by default every second. The server will run for a fixed number of frames, by default 100, after which it will inform the camera application on the device that the "synchronisation point" has been reached. At this moment, the application will start using the frames, so in the case of `rpicam-vid`, they will start being encoded and recorded. Recall that the behaviour and even existence of clients has no bearing on this. + +If required, there can be several servers on the same network so long as they are broadcasting timing messages to different network addresses. Clients, of course, will have to be configured to listen for the correct address. + +**Clients** + +Clients listen out for server timing messages and, when they receive one, will shorten or lengthen a camera frame duration by the required amount so that subsequent frames will start, as far as possible, at the same moment as the server's. + +The clients learn the correct "synchronisation point" from the server's messages, and just like the server, will signal the camera application at the same moment that it should start using the frames. So in the case of `rpicam-vid`, this is once again the moment at which frames will start being recorded. + +Normally it makes sense to start clients _before_ the server, as the clients will simply wait (the "synchronisation point" has not been reached) until a server is seen broadcasting onto the network. This obviously avoids timing problems where a server might reach its "synchronisation point" even before all the clients have been started! + +**Usage in `rpicam-vid`** + +We can use software camera synchronisation with `rpicam-vid` to record videos that are synchronised frame-by-frame. We're going to assume we have two cameras attached, and we're going to use camera 0 as the server, and camera 1 as the client. `rpicam-vid` defaults to a fixed 30 frames per second, which will be fine for us. + +First we should start the client: +[source,console] +---- +$ rpicam-vid -n -t 20s --camera 1 --codec libav -o client.mp4 --sync client +---- + +Note the `--sync client` parameter. This will record for 20 seconds but _only_ once the synchronisation point has been reached. If necessary, it will wait indefinitely for the first server message. + +To start the server: +[source,console] +---- +$ rpicam-vid -n -t 20s --camera 0 --codec libav -o server.mp4 --sync server +---- + +This too will run for 20 seconds counting from when the synchronisation point is reached and the recording starts. With the default synchronisation settings (100 frames at 30fps) this means there will be just over 3 seconds for clients to get synchronised. + +The server's broadcast address and port, the frequency of the timing messages and the number of frames to wait for clients to synchronise, can all be changed in the camera tuning file. Clients only pay attention to the broadcast address here which should match the server's; the other information will be ignored. Please refer to the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Raspberry Pi Camera tuning guide] for more information. + +In practical operation there are a few final points to be aware of: + +* The fixed framerate needs to be below the maximum framerate at which the camera can operate (in the camera mode that is being used). This is because the synchronisation algorithm may need to _shorten_ camera frames so that clients can catch up with the server, and this will fail if it is already running as fast as it can. +* Whilst camera frames should be correctly synchronised, at higher framerates or depending on system load, it is possible for frames, either on the clients or server, to be dropped. In these cases the frame timestamps will help an application to work out what has happened, though it's usually simpler to try and avoid frame drops - perhaps by lowering the framerate, increasing the number of buffers being allocated to the camera queues (see the xref:camera_software.adoc#buffer-count[`--buffer-count` option]), or reducing system load. \ No newline at end of file diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_packages.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_packages.adoc index 3229ed554..031fcc44e 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_packages.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_packages.adoc @@ -1,31 +1,15 @@ -=== `libcamera` and `rpicam-apps` packages +=== Install `libcamera` and `rpicam-apps` -A number of `apt` packages are provided for convenience. In order to access them, we recommend keeping your OS up to date xref:../computers/os.adoc#using-apt[in the usual way]. +Raspberry Pi provides two `rpicam-apps` packages: -==== Binary packages - -There are two `rpicam-apps` packages available, containing the necessary executables: - -* `rpicam-apps` contains the full applications with support for previews using a desktop environment. This package is pre-installed in Raspberry Pi OS. +* `rpicam-apps` contains full applications with support for previews using a desktop environment. This package is pre-installed in Raspberry Pi OS. * `rpicam-apps-lite` omits desktop environment support, and only makes the DRM preview available. This package is pre-installed in Raspberry Pi OS Lite. ==== Dependencies -These applications depend on a number of library packages which are named _library-name_ where __ is a version number (actually the ABI, or Application Binary Interface, version), and which stands at zero at the time of writing. - -* The package `libcamera0` contains the `libcamera` libraries - -* The package `libepoxy0` contains the `libepoxy` libraries - -These will be installed automatically when needed. +`rpicam-apps` depends on library packages named `library-name`, where `` is the ABI version. Your package manager should install these automatically. ==== Dev packages -`rpicam-apps` can be rebuilt on their own without installing and building `libcamera` and `libepoxy` from scratch. To enable this, the following packages should be installed: - -* `libcamera-dev` contains the necessary `libcamera` header files and resources. - -* `libepoxy-dev` contains the necessary `libepoxy` header files and resources. You will only need this if you want support for the GLES/EGL preview window. - -Subsequently `rpicam-apps` can be xref:camera_software.adoc#building-rpicam-apps-without-rebuilding-libcamera[checked out from GitHub and rebuilt]. +You can rebuild `rpicam-apps` without building `libcamera` and `libepoxy` from scratch. For more information, see xref:camera_software.adoc#building-rpicam-apps-without-building-libcamera[Building `rpicam-apps` without rebuilding `libcamera`]. diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_post_processing.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_post_processing.adoc index e60f01546..339828d50 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_post_processing.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_post_processing.adoc @@ -1,214 +1,243 @@ -=== Post-processing +== Post-processing with `rpicam-apps` -`rpicam-apps` share a common post-processing framework. This allows them to pass the images received from the camera system through a number of custom image-processing and image-analysis routines. Each such routine is known as a _post-processing stage_. The description of exactly which stages should be run, and what configuration they may have, is supplied in a JSON file. Every stage, along with its source code, is supplied with a short example JSON file showing how to enable it. +`rpicam-apps` share a common post-processing framework. This allows them to pass the images received from the camera system through a number of custom image-processing and image-analysis routines. Each such routine is known as a _stage_. To run post-processing stages, supply a JSON file instructing the application which stages and options to apply. You can find example JSON files that use the built-in post-processing stages in the https://github.com/raspberrypi/rpicam-apps/tree/main/assets[`assets` folder of the `rpicam-apps` repository]. -For example, the simple _negate_ stage (which negates all the pixels in an image, turning light pixels dark and vice versa) is supplied with a `negate.json` file that configures the post-processing pipeline to run it: - -`rpicam-hello --post-process-file /path/to/negate.json` - -Example JSON files can be found in the https://github.com/raspberrypi/rpicam-apps/tree/main/assets[`assets` folder] of the `rpicam-apps` repository. - -The negate stage is particularly trivial and has no configuration parameters of its own. The JSON file merely has to name the stage, with no further information, and it will be run. So `negate.json` contains: +For example, the **negate** stage turns light pixels dark and dark pixels light. Because the negate stage is basic, requiring no configuration, `negate.json` just names the stage: +[source,json] ---- { - "negate": - { - } + "negate": {} } ---- -To run multiple post-processing stages, the contents of the example JSON files just need to be listed together, and the stages will be run in the order given. For example, to run the Sobel stage (which applies a Sobel filter to an image) followed by the negate stage, we could create a custom JSON file containing: +To apply the negate stage to an image, pass `negate.json` to the `post-process-file` option: + +[source,console] +---- +$ rpicam-hello --post-process-file negate.json +---- + +To run multiple post-processing stages, create a JSON file that contains multiple stages as top-level keys. For example, to the following configuration runs the Sobel stage, then the negate stage: +[source,json] ---- { "sobel_cv": { "ksize": 5 }, - "negate": - { - } + "negate": {} } ---- -The Sobel stage is implemented using OpenCV, hence `cv` in its name. It has a user-configurable parameter, `ksize`, that specifies the kernel size of the filter to be used. In this case, the Sobel filter will produce bright edges on a black background, and the negate stage will turn this into dark edges on a white background. +The xref:camera_software.adoc#sobel_cv-stage[Sobel stage] uses OpenCV, hence the `cv` suffix. It has a user-configurable parameter, `ksize`, that specifies the kernel size of the filter to be used. In this case, the Sobel filter produces bright edges on a black background, and the negate stage turns this into dark edges on a white background. -image::images/sobel_negate.jpg[Image with Sobel and negate] +.A negated Sobel filter. +image::images/sobel_negate.jpg[A negated Sobel filter] -Some stages, such as `negate`, actually alter the image in some way, and this is their primary function. Others are primarily for image analysis, and while they may indicate something on the image, all they really do is generate useful information. For this reason we also have a very flexible form of metadata that can be populated by the post-processing stages, and this will get passed all the way through to the application itself. +Some stages, such as `negate`, alter the image in some way. Other stages analyse the image to generate metadata. Post-processing stages can pass this metadata to other stages and even the application. -Image analysis stages often prefer to work on reduced-resolution images. A ready-made, low-resolution image is provided to applications directly by the ISP hardware`rpicam-apps`, and this can be helpful in improving performance. +To improve performance, image analysis often uses reduced resolution. `rpicam-apps` provide a dedicated low-resolution feed directly from the ISP. -The post-processing framework is open source, and Raspberry Pi welcomes the contribution of new and interesting stages from the community that we can host in the `rpicam-apps` repository. The stages that are currently available are documented below. +NOTE: The `rpicam-apps` supplied with Raspberry Pi OS do not include OpenCV and TensorFlow Lite. As a result, certain post-processing stages that rely on them are disabled. To use these stages, xref:camera_software.adoc#build-libcamera-and-rpicam-apps[re-compile `rpicam-apps`]. On a Raspberry Pi 3 or 4 running a 32-bit kernel, compile with the `-DENABLE_COMPILE_FLAGS_FOR_TARGET=armv8-neon` flag to speed up certain stages. -NOTE: The `rpicam-apps` supplied with the operating system will be built without any optional 3rd party libraries (such as OpenCV or TensorFlow Lite), meaning that certain post-processing stages that rely on them will not be enabled. To use these stages, please follow the instructions for xref:camera_software.adoc#building-libcamera-and-rpicam-apps[building `rpicam-apps` for yourself]. +=== Built-in stages ==== `negate` stage -The `negate` stage requires no third-party libraries. - -On a Raspberry Pi 3 or a Raspberry Pi 4 running a 32-bit OS, it may execute more quickly if xref:camera_software.adoc#building-libcamera-and-rpicam-apps[recompiled] using `-DENABLE_COMPILE_FLAGS_FOR_TARGET=armv8-neon`. +This stage turns light pixels dark and dark pixels light. The `negate` stage has no user-configurable parameters. Default `negate.json` file: +[source,json] ---- { - "negate": - { - } + "negate" : {} } ---- -Example: +Run the following command to use this stage file with `rpicam-hello`: -image::images/negate.jpg[Image with negate] +[source,console] +---- +$ rpicam-hello --post-process-file negate.json +---- -==== `hdr` stage +Example output: + +.A negated image. +image::images/negate.jpg[A negated image] -The `hdr` stage implements both high dynamic range (HDR) imaging and dynamic range compression (DRC). The terminology that we use here regards DRC as operating on single images, while HDR works by accumulating multiple under-exposed images and then performing the same algorithm as DRC. +==== `hdr` stage -The `hdr` stage has no dependencies on third-party libraries, but (like some other stages) may execute faster on Raspberry Pi 3 or Raspberry Pi 4 devices running a 32-bit OS if ref:camera_software.adoc#building-libcamera-and-rpicam-apps[recompiled] using `-DENABLE_COMPILE_FLAGS_FOR_TARGET=armv8-neon`. The image accumulation stage will run faster and result in fewer frame drops, though the tonemapping part of the process is unchanged. +This stage emphasises details in images using High Dynamic Range (HDR) and Dynamic Range Compression (DRC). DRC uses a single image, while HDR combines multiple images for a similar result. -We take the image (which in the case of HDR may be multiple images accumulated together) and apply an edge-preserving smoothing filter to generate a low pass (LP) image. We define the high pass (HP) image to be the difference between the LP image and the original. Next we apply a global tonemap to the LP image and add back the HP image. This procedure, in contrast to applying the tonemap directly to the original image, prevents us from squashing and losing all the local contrast in the resulting image. +Parameters fall into three groups: the LP filter, global tonemapping, and local contrast. -It is worth noting that this all happens using fully-processed images, once the ISP has finished with them. HDR normally works better when carried out in the raw (Bayer) domain, as signals are still linear and have greater bit-depth. We expect to implement such functionality once `libcamera` exports an API for re-processing Bayer images that do not come from the sensor, but which application code can pass in. +This stage applies a smoothing filter to the fully-processed input images to generate a low pass (LP) image. It then generates the high pass (HP) image from the diff of the original and LP images. Then, it applies a global tonemap to the LP image and adds it back to the HP image. This process helps preserve local contrast. -In summary, the user-configurable parameters fall into three groups: those that define the LP filter, those responsible for the global tonemapping, and those responsible for re-applying the local contrast. +You can configure this stage with the following parameters: -[cols=",^"] +[cols="1,3a"] |=== -| num_frames | The number of frames to accumulate. For DRC (in our terminology) this would take the value 1, but for multi-frame HDR we would suggest a value such as 8. -| lp_filter_strength | The coefficient of the low pass IIR filter. -| lp_filter_threshold | A piecewise linear function that relates the pixel level to the threshold that is regarded as being "meaningful detail". -| global_tonemap_points | A list of points in the input image histogram and targets in the output range where we wish to move them. We define an inter-quantile mean (`q` and `width`), a target as a proportion of the full output range (`target`), and maximum and minimum gains by which we are prepared to move the measured inter-quantile mean (as this prevents us from changing an image too drastically). -| global_tonemap_strength | Strength of application of the global tonemap. -| local_pos_strength | A piecewise linear function that defines the gain applied to local contrast when added back to the tonemapped LP image, for positive (bright) detail. -| local_neg_strength | A piecewise linear function that defines the gain applied to local contrast when added back to the tonemapped LP image, for negative (dark) detail. -| local_tonemap_strength | An overall gain applied to all local contrast that is added back. -| local_colour_scale | A factor that allows the output colours to be affected more or less strongly. +| `num_frames` +| The number of frames to accumulate; for DRC, use 1; for HDR, try 8 +| `lp_filter_strength` +| The coefficient of the low pass IIR filter. +| `lp_filter_threshold` +| A piecewise linear function that relates pixel level to the threshold of meaningful detail +| `global_tonemap_points` +| Points in the input image histogram mapped to targets in the output range where we wish to move them. Uses the following sub-configuration: + +* an inter-quantile mean (`q` and `width`) +* a target as a proportion of the full output range (`target`) +* maximum (`max_up`) and minimum (`max_down`) gains to move the measured inter-quantile mean, to prevents the image from changing image too drastically +| `global_tonemap_strength` +| Strength of application of the global tonemap +| `local_pos_strength` +| A piecewise linear function that defines the gain applied to local contrast when added back to the tonemapped LP image, for positive (bright) detail +| `local_neg_strength` +| A piecewise linear function that defines the gain applied to local contrast when added back to the tonemapped LP image, for negative (dark) detail +| `local_tonemap_strength` +| An overall gain applied to all local contrast that is added back +| `local_colour_scale` +| A factor that allows the output colours to be affected more or less strongly |=== -We note that the overall strength of the processing is best controlled by changing the `global_tonemap_strength` and `local_tonemap_strength` parameters. +To control processing strength, changing the `global_tonemap_strength` and `local_tonemap_strength` parameters. -The full processing takes between two and three seconds for a 12MP image on a Raspberry Pi 4. The stage runs only on the still image capture, ignoring preview and video images. When accumulating multiple frames, the stage "swallows" the output images so that the application does not receive them, and finally sends through only the combined and processed image. +Processing a single image takes between two and three seconds for a 12MP image on a Raspberry Pi 4. When accumulating multiple frames, this stage sends only the processed image to the application. Default `drc.json` file for DRC: +[source,json] ---- { - "hdr" : - { - "num_frames" : 1, - "lp_filter_strength" : 0.2, - "lp_filter_threshold" : [ 0, 10.0 , 2048, 205.0, 4095, 205.0 ], - "global_tonemap_points" : - [ - { "q": 0.1, "width": 0.05, "target": 0.15, "max_up": 1.5, "max_down": 0.7 }, - { "q": 0.5, "width": 0.05, "target": 0.5, "max_up": 1.5, "max_down": 0.7 }, - { "q": 0.8, "width": 0.05, "target": 0.8, "max_up": 1.5, "max_down": 0.7 } - ], - "global_tonemap_strength" : 1.0, - "local_pos_strength" : [ 0, 6.0, 1024, 2.0, 4095, 2.0 ], - "local_neg_strength" : [ 0, 4.0, 1024, 1.5, 4095, 1.5 ], - "local_tonemap_strength" : 1.0, - "local_colour_scale" : 0.9 + "hdr" : { + "num_frames" : 1, + "lp_filter_strength" : 0.2, + "lp_filter_threshold" : [ 0, 10.0 , 2048, 205.0, 4095, 205.0 ], + "global_tonemap_points" : + [ + { "q": 0.1, "width": 0.05, "target": 0.15, "max_up": 1.5, "max_down": 0.7 }, + { "q": 0.5, "width": 0.05, "target": 0.5, "max_up": 1.5, "max_down": 0.7 }, + { "q": 0.8, "width": 0.05, "target": 0.8, "max_up": 1.5, "max_down": 0.7 } + ], + "global_tonemap_strength" : 1.0, + "local_pos_strength" : [ 0, 6.0, 1024, 2.0, 4095, 2.0 ], + "local_neg_strength" : [ 0, 4.0, 1024, 1.5, 4095, 1.5 ], + "local_tonemap_strength" : 1.0, + "local_colour_scale" : 0.9 } } ---- Example: -Without DRC: - +.Image without DRC processing image::images/nodrc.jpg[Image without DRC processing] -With full-strength DRC: (use `rpicam-still -o test.jpg --post-process-file drc.json`) +Run the following command to use this stage file with `rpicam-still`: + +[source,console] +---- +$ rpicam-still -o test.jpg --post-process-file drc.json +---- +.Image with DRC processing image::images/drc.jpg[Image with DRC processing] Default `hdr.json` file for HDR: +[source,json] ---- { - "hdr" : - { - "num_frames" : 8, - "lp_filter_strength" : 0.2, - "lp_filter_threshold" : [ 0, 10.0 , 2048, 205.0, 4095, 205.0 ], - "global_tonemap_points" : - [ - { "q": 0.1, "width": 0.05, "target": 0.15, "max_up": 5.0, "max_down": 0.5 }, - { "q": 0.5, "width": 0.05, "target": 0.45, "max_up": 5.0, "max_down": 0.5 }, - { "q": 0.8, "width": 0.05, "target": 0.7, "max_up": 5.0, "max_down": 0.5 } - ], - "global_tonemap_strength" : 1.0, - "local_pos_strength" : [ 0, 6.0, 1024, 2.0, 4095, 2.0 ], - "local_neg_strength" : [ 0, 4.0, 1024, 1.5, 4095, 1.5 ], - "local_tonemap_strength" : 1.0, - "local_colour_scale" : 0.8 + "hdr" : { + "num_frames" : 8, + "lp_filter_strength" : 0.2, + "lp_filter_threshold" : [ 0, 10.0 , 2048, 205.0, 4095, 205.0 ], + "global_tonemap_points" : + [ + { "q": 0.1, "width": 0.05, "target": 0.15, "max_up": 5.0, "max_down": 0.5 }, + { "q": 0.5, "width": 0.05, "target": 0.45, "max_up": 5.0, "max_down": 0.5 }, + { "q": 0.8, "width": 0.05, "target": 0.7, "max_up": 5.0, "max_down": 0.5 } + ], + "global_tonemap_strength" : 1.0, + "local_pos_strength" : [ 0, 6.0, 1024, 2.0, 4095, 2.0 ], + "local_neg_strength" : [ 0, 4.0, 1024, 1.5, 4095, 1.5 ], + "local_tonemap_strength" : 1.0, + "local_colour_scale" : 0.8 } } ---- Example: -Without HDR: - +.Image without HDR processing image::images/nohdr.jpg[Image without HDR processing] -With HDR: (use `rpicam-still -o test.jpg --ev -2 --denoise cdn_off --post-process-file hdr.json`) +Run the following command to use this stage file with `rpicam-still`: + +[source,console] +---- +$ rpicam-still -o test.jpg --ev -2 --denoise cdn_off --post-process-file hdr.json +---- +.Image with HDR processing image::images/hdr.jpg[Image with DRC processing] ==== `motion_detect` stage -The `motion_detect` stage works by analysing frames from the low-resolution image stream, which must be configured for it to work. It compares a region of interest (ROI) in the frame to the corresponding part of a previous frame, and if enough pixels are sufficiently different, that will be taken to indicate motion. The result is added to the metadata under "motion_detect.result". +The `motion_detect` stage analyses frames from the low-resolution image stream. You must configure the low-resolution stream to use this stage. The stage detects motion by comparing a region of interest (ROI) in the frame to the corresponding part of a previous frame. If enough pixels change between frames, this stage indicates the motion in metadata under the `motion_detect.result` key. -This stage has no dependencies on any third-party libraries. +This stage has no dependencies on third-party libraries. -The `motion_detect` stage has the following tuneable parameters. The dimensions are always given as a proportion of the low-resolution image size. +You can configure this stage with the following parameters, passing dimensions as a proportion of the low-resolution image size between 0 and 1: -[cols=",^"] +[cols="1,3"] |=== -| roi_x | x-offset of the region of interest for the comparison -| roi_y | y-offset of the region of interest for the comparison -| roi_width | Width of the region of interest for the comparison -| roi_height | Height of the region of interest for the comparison -| difference_m | Linear coefficient used to construct the threshold for pixels being different -| difference_c | Constant coefficient used to construct the threshold for pixels being different according to threshold = difference_m * pixel_value + difference_c -| frame_period | The motion detector will run only this many frames -| hskip | The pixel tests are subsampled by this amount horizontally -| vksip | The pixel tests are subsampled by this amount vertically -| region_threshold | The proportion of pixels (or "regions") which must be categorised as different for them to count as motion -| verbose | Print messages to the console, including when the "motion"/"no motion" status changes +| `roi_x` | x-offset of the region of interest for the comparison (proportion between 0 and 1) +| `roi_y` | y-offset of the region of interest for the comparison (proportion between 0 and 1) +| `roi_width` | Width of the region of interest for the comparison (proportion between 0 and 1) +| `roi_height` | Height of the region of interest for the comparison (proportion between 0 and 1) +| `difference_m` | Linear coefficient used to construct the threshold for pixels being different +| `difference_c` | Constant coefficient used to construct the threshold for pixels being different according to `threshold = difference_m * pixel_value + difference_c` +| `frame_period` | The motion detector will run only this many frames +| `hskip` | The pixel subsampled by this amount horizontally +| `vksip` | The pixel subsampled by this amount vertically +| `region_threshold` | The proportion of pixels (regions) which must be categorised as different for them to count as motion +| `verbose` | Print messages to the console, including when the motion status changes |=== Default `motion_detect.json` configuration file: +[source,json] ---- { - "motion_detect" : - { - "roi_x" : 0.1, - "roi_y" : 0.1, - "roi_width" : 0.8, - "roi_height" : 0.8, - "difference_m" : 0.1, - "difference_c" : 10, - "region_threshold" : 0.005, - "frame_period" : 5, - "hskip" : 2, - "vskip" : 2, - "verbose" : 0 + "motion_detect" : { + "roi_x" : 0.1, + "roi_y" : 0.1, + "roi_width" : 0.8, + "roi_height" : 0.8, + "difference_m" : 0.1, + "difference_c" : 10, + "region_threshold" : 0.005, + "frame_period" : 5, + "hskip" : 2, + "vskip" : 2, + "verbose" : 0 } } ---- -The field `difference_m` and `difference_c`, and the value of `region_threshold`, can be adjusted to make the algorithm more or less sensitive to motion. If the amount of computation needs to be reduced (perhaps you have other stages that need a larger low resolution image), the amount of computation can be reduced using the `hskip` and `vskip` parameters. +Adjust the differences and the threshold to make the algorithm more or less sensitive. To improve performance, use the `hskip` and `vskip` parameters. -To use the `motion_detect` stage you might enter the following example command: +Run the following command to use this stage file with `rpicam-hello`: -`rpicam-hello --lores-width 128 --lores-height 96 --post-process-file motion_detect.json` +[source,console] +---- +$ rpicam-hello --lores-width 128 --lores-height 96 --post-process-file motion_detect.json +---- diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_opencv.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_opencv.adoc index a277eb734..787393e96 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_opencv.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_opencv.adoc @@ -1,23 +1,25 @@ === Post-processing with OpenCV -NOTE: These stages all require OpenCV to be installed on your system. You may also need to rebuild `rpicam-apps` with OpenCV support - please see the instructions for xref:camera_software.adoc#building-libcamera-and-rpicam-apps[building `rpicam-apps` for yourself]. +NOTE: These stages require an OpenCV installation. You may need to xref:camera_software.adoc#build-libcamera-and-rpicam-apps[rebuild `rpicam-apps` with OpenCV support]. ==== `sobel_cv` stage -The `sobel_cv` stage has the following user-configurable parameters: +This stage applies a https://en.wikipedia.org/wiki/Sobel_operator[Sobel filter] to an image to emphasise edges. -[cols=",^"] +You can configure this stage with the following parameters: + +[cols="1,3"] |=== -| ksize | Kernel size of the Sobel filter +| `ksize` | Kernel size of the Sobel filter |=== Default `sobel_cv.json` file: +[source,json] ---- { - "sobel_cv": - { + "sobel_cv" : { "ksize": 5 } } @@ -25,33 +27,34 @@ Default `sobel_cv.json` file: Example: -image::images/sobel.jpg[Image with Sobel filter] +.Using a Sobel filter to emphasise edges. +image::images/sobel.jpg[Using a Sobel filter to emphasise edges] ==== `face_detect_cv` stage -This stage uses the OpenCV Haar classifier to detect faces in an image. It returns the face locations in the metadata (under the key "face_detect.results"), and offers an option to draw them on the image. +This stage uses the OpenCV Haar classifier to detect faces in an image. It returns face location metadata under the key `face_detect.results` and optionally draws the locations on the image. -The `face_detect_cv` stage has the following user-configurable parameters: +You can configure this stage with the following parameters: -[cols=",^"] +[cols=",3] |=== -| cascade_name | Name of the file where the Haar cascade can be found -| scaling_factor | Determines range of scales at which the image is searched for faces -| min_neighbors | Minimum number of overlapping neighbours required to count as a face -| min_size | Minimum face size -| max_size | Maximum face size -| refresh_rate | How many frames to wait before trying to re-run the face detector -| draw_features | Whether to draw face locations on the returned image +| `cascade_name` | Name of the file where the Haar cascade can be found +| `scaling_factor` | Determines range of scales at which the image is searched for faces +| `min_neighbors` | Minimum number of overlapping neighbours required to count as a face +| `min_size` | Minimum face size +| `max_size` | Maximum face size +| `refresh_rate` | How many frames to wait before trying to re-run the face detector +| `draw_features` | Whether to draw face locations on the returned image |=== -The `face_detect_cv" stage runs only during preview and video capture; it ignores still image capture. It runs on the low resolution stream which would normally be configured to a resolution from about 320x240 to 640x480 pixels. +The `face_detect_cv` stage runs only during preview and video capture. It ignores still image capture. It runs on the low resolution stream with a resolution between 320×240 and 640×480 pixels. Default `face_detect_cv.json` file: +[source,json] ---- { - "face_detect_cv": - { + "face_detect_cv" : { "cascade_name" : "/usr/local/share/OpenCV/haarcascades/haarcascade_frontalface_alt.xml", "scaling_factor" : 1.1, "min_neighbors" : 2, @@ -65,46 +68,53 @@ Default `face_detect_cv.json` file: Example: -image::images/face_detect.jpg[Image showing faces] +.Drawing detected faces onto an image. +image::images/face_detect.jpg[Drawing detected faces onto an image] ==== `annotate_cv` stage -This stage allows text to be written into the top corner of images. It allows the same `%` substitutions as the `--info-text` parameter. +This stage writes text into the top corner of images using the same `%` substitutions as the xref:camera_software.adoc#info-text[`info-text`] option. + +Interprets xref:camera_software.adoc#info-text[`info-text` directives] first, then passes any remaining tokens to https://www.man7.org/linux/man-pages/man3/strftime.3.html[`strftime`]. + +For example, to achieve a datetime stamp on the video, pass `%F %T %z`: -Beside the flags of xref:camera_software.adoc#preview-window-2[`--info-text`], you can provide any token that https://www.man7.org/linux/man-pages/man3/strftime.3.html[strftime] understands to display the current date and time. -The `--info-text` tokens are interpreted first, and any percentage token left is then interpreted by strftime. To achieve a datetime stamp on the video you can use e.g. `%F %T %z`: %F for the ISO-8601 date (2023-03-07), %T for 24h local time (09:57:12) and %z for the timezone difference to UTC (-0800). +* `%F` displays the ISO-8601 date (2023-03-07) +* `%T` displays 24h local time (e.g. "09:57:12") +* `%z` displays the timezone relative to UTC (e.g. "-0800") -The stage does not output any metadata, but if it finds metadata under the key "annotate.text" it will write this text in place of anything in the JSON configuration file. This allows other post-processing stages to pass it text strings to be written onto the top of the images. +This stage does not output any metadata, but it writes metadata found in `annotate.text` in place of anything in the JSON configuration file. This allows other post-processing stages to write text onto images. -The `annotate_cv` stage has the following user-configurable parameters: +You can configure this stage with the following parameters: -[cols=",^"] +[cols="1,3"] |=== -| text | The text string to be written -| fg | Foreground colour -| bg | Background colour -| scale | A number proportional to the size of the text -| thickness | A number that determines the thickness of the text -| alpha | The amount of alpha to apply when overwriting the background pixels +| `text` | The text string to be written +| `fg` | Foreground colour +| `bg` | Background colour +| `scale` | A number proportional to the size of the text +| `thickness` | A number that determines the thickness of the text +| `alpha` | The amount of alpha to apply when overwriting background pixels |=== Default `annotate_cv.json` file: +[source,json] ---- { - "annotate_cv" : - { - "text" : "Frame %frame exp %exp ag %ag dg %dg", - "fg" : 255, - "bg" : 0, - "scale" : 1.0, - "thickness" : 2, - "alpha" : 0.3 + "annotate_cv" : { + "text" : "Frame %frame exp %exp ag %ag dg %dg", + "fg" : 255, + "bg" : 0, + "scale" : 1.0, + "thickness" : 2, + "alpha" : 0.3 } } ---- Example: -image::images/annotate.jpg[Image with text overlay] +.Writing camera and date information onto an image with annotations. +image::images/annotate.jpg[Writing camera and date information onto an image with annotations] diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_tflite.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_tflite.adoc index ddeb9bc3a..39d607f5e 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_tflite.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_tflite.adoc @@ -1,186 +1,220 @@ === Post-Processing with TensorFlow Lite -NOTE: These stages require TensorFlow Lite (TFLite) libraries to be installed that export the {cpp} API. Unfortunately the TFLite libraries are not normally distributed conveniently in this form, however, one place where they can be downloaded is https://lindevs.com/install-precompiled-tensorflow-lite-on-raspberry-pi/[lindevs.com]. Please follow the installation instructions given on that page. Subsequently you may need to recompile `rpicam-apps` with TensorFlow Lite support - please follow the instructions for xref:camera_software.adoc#building-libcamera-and-rpicam-apps[building `rpicam-apps` for yourself]. +==== Prerequisites + +These stages require TensorFlow Lite (TFLite) libraries that export the {cpp} API. TFLite doesn't distribute libraries in this form, but you can download and install a version that exports the API from https://lindevs.com/install-precompiled-tensorflow-lite-on-raspberry-pi/[lindevs.com]. + +After installing, you must xref:camera_software.adoc#build-libcamera-and-rpicam-apps[recompile `rpicam-apps` with TensorFlow Lite support]. ==== `object_classify_tf` stage -`object_classify_tf` uses a Google MobileNet v1 model to classify objects in the camera image. It can be obtained from https://storage.googleapis.com/download.tensorflow.org/models/mobilenet_v1_2018_08_02/mobilenet_v1_1.0_224_quant.tgz[], which will need to be uncompressed. You will also need the `labels.txt` file which can be found in https://storage.googleapis.com/download.tensorflow.org/models/mobilenet_v1_1.0_224_frozen.tgz[]. +Download: https://storage.googleapis.com/download.tensorflow.org/models/mobilenet_v1_2018_08_02/mobilenet_v1_1.0_224_quant.tgz[] + +`object_classify_tf` uses a Google MobileNet v1 model to classify objects in the camera image. This stage requires a https://storage.googleapis.com/download.tensorflow.org/models/mobilenet_v1_1.0_224_frozen.tgz[`labels.txt` file]. -This stage has the following configuratble parameters. +You can configure this stage with the following parameters: -[cols=",^"] +[cols="1,3"] |=== -| top_n_results | How many results to show -| refresh_rate | The number of frames that must elapse before the model is re-run -| threshold_high | Confidence threshold (between 0 and 1) where objects are considered as being present -| threshold_low | Confidence threshold which objects must drop below before being discarded as matches -| model_file | Pathname to the tflite model file -| labels_file | Pathname to the file containing the object labels -| display_labels | Whether to display the object labels on the image. Note that this causes `annotate.text` metadata to be inserted so that the text can be rendered subsequently by the `annotate_cv` stage -| verbose | Output more information to the console +| `top_n_results` | The number of results to show +| `refresh_rate` | The number of frames that must elapse between model runs +| `threshold_high` | Confidence threshold (between 0 and 1) where objects are considered as being present +| `threshold_low` | Confidence threshold which objects must drop below before being discarded as matches +| `model_file` | Filepath of the TFLite model file +| `labels_file` | Filepath of the file containing the object labels +| `display_labels` | Whether to display the object labels on the image; inserts `annotate.text` metadata for the `annotate_cv` stage to render +| `verbose` | Output more information to the console |=== Example `object_classify_tf.json` file: +[source,json] ---- { - "object_classify_tf": - { + "object_classify_tf" : { "top_n_results" : 2, "refresh_rate" : 30, "threshold_high" : 0.6, "threshold_low" : 0.4, - "model_file" : "/home/pi/models/mobilenet_v1_1.0_224_quant.tflite", - "labels_file" : "/home/pi/models/labels.txt", + "model_file" : "/home//models/mobilenet_v1_1.0_224_quant.tflite", + "labels_file" : "/home//models/labels.txt", "display_labels" : 1 }, - "annotate_cv" : - { - "text" : "", - "fg" : 255, - "bg" : 0, - "scale" : 1.0, - "thickness" : 2, - "alpha" : 0.3 + "annotate_cv" : { + "text" : "", + "fg" : 255, + "bg" : 0, + "scale" : 1.0, + "thickness" : 2, + "alpha" : 0.3 } } ---- -The stage operates on a low resolution stream image of size 224x224, so it could be used as follows: +The stage operates on a low resolution stream image of size 224×224. +Run the following command to use this stage file with `rpicam-hello`: -`rpicam-hello --post-process-file object_classify_tf.json --lores-width 224 --lores-height 224` +[source,console] +---- +$ rpicam-hello --post-process-file object_classify_tf.json --lores-width 224 --lores-height 224 +---- -image::images/classify.jpg[Image showing object classifier results] +.Object classification of a desktop computer and monitor. +image::images/classify.jpg[Object classification of a desktop computer and monitor] ==== `pose_estimation_tf` stage -`pose_estimation_tf` uses a Google MobileNet v1 model `posenet_mobilenet_v1_100_257x257_multi_kpt_stripped.tflite` that can be found at https://github.com/Qengineering/TensorFlow_Lite_Pose_RPi_32-bits[]. +Download: https://github.com/Qengineering/TensorFlow_Lite_Pose_RPi_32-bits[] -This stage has the following configurable parameters. +`pose_estimation_tf` uses a Google MobileNet v1 model to detect pose information. -[cols=",^"] +You can configure this stage with the following parameters: + +[cols="1,3"] |=== -| refresh_rate | The number of frames that must elapse before the model is re-run -| model_file | Pathname to the tflite model file -| verbose | Output more information to the console +| `refresh_rate` | The number of frames that must elapse between model runs +| `model_file` | Filepath of the TFLite model file +| `verbose` | Output extra information to the console |=== -Also provided is a separate `plot_pose_cv` stage which can be included in the JSON configuration file and which will draw the detected pose onto the main image. This stage has the following configuration parameters. +Use the separate `plot_pose_cv` stage to draw the detected pose onto the main image. + +You can configure the `plot_pose_cv` stage with the following parameters: -[cols=",^"] +[cols="1,3"] |=== -| confidence_threshold | A confidence level determining how much is drawn. This number can be less than zero; please refer to the GitHub repository for more information. +| `confidence_threshold` | Confidence threshold determining how much to draw; can be less than zero |=== Example `pose_estimation_tf.json` file: +[source,json] ---- { - "pose_estimation_tf": - { + "pose_estimation_tf" : { "refresh_rate" : 5, "model_file" : "posenet_mobilenet_v1_100_257x257_multi_kpt_stripped.tflite" }, - "plot_pose_cv" : - { - "confidence_threshold" : -0.5 + "plot_pose_cv" : { + "confidence_threshold" : -0.5 } } ---- -The stage operates on a low resolution stream image of size 257x257 (but which must be rounded up to 258x258 for YUV420 images), so it could be used as follows: +The stage operates on a low resolution stream image of size 257×257. **Because YUV420 images must have even dimensions, round up to 258×258 for YUV420 images.** -`rpicam-hello --post-process-file pose_estimation_tf.json --lores-width 258 --lores-height 258` +Run the following command to use this stage file with `rpicam-hello`: + +[source,console] +---- +$ rpicam-hello --post-process-file pose_estimation_tf.json --lores-width 258 --lores-height 258 +---- -image::images/pose.jpg[Image showing pose estimation results] +.Pose estimation of an adult human male. +image::images/pose.jpg[Pose estimation of an adult human male] ==== `object_detect_tf` stage -`object_detect_tf` uses a Google MobileNet v1 SSD (Single Shot Detector) model. The model and labels files can be downloaded from https://storage.googleapis.com/download.tensorflow.org/models/tflite/coco_ssd_mobilenet_v1_1.0_quant_2018_06_29.zip[]. +Download: https://storage.googleapis.com/download.tensorflow.org/models/tflite/coco_ssd_mobilenet_v1_1.0_quant_2018_06_29.zip[] + +`object_detect_tf` uses a Google MobileNet v1 SSD (Single Shot Detector) model to detect and label objects. -This stage has the following configurable parameters. +You can configure this stage with the following parameters: -[cols=",^"] +[cols="1,3"] |=== -| refresh_rate | The number of frames that must elapse before the model is re-run -| model_file | Pathname to the tflite model file -| labels_file | Pathname to the file containing the list of labels -| confidence_threshold | Minimum confidence threshold because a match is accepted. -| overlap_threshold | Determines the amount of overlap between matches for them to be merged as a single match. -| verbose | Output more information to the console +| `refresh_rate` | The number of frames that must elapse between model runs +| `model_file` | Filepath of the TFLite model file +| `labels_file` | Filepath of the file containing the list of labels +| `confidence_threshold` | Confidence threshold before accepting a match +| `overlap_threshold` | Determines the amount of overlap between matches for them to be merged as a single match. +| `verbose` | Output extra information to the console |=== -Also provided is a separate `object_detect_draw_cv` stage which can be included in the JSON configuration file and which will draw the detected objects onto the main image. This stage has the following configuration parameters. +Use the separate `object_detect_draw_cv` stage to draw the detected objects onto the main image. + +You can configure the `object_detect_draw_cv` stage with the following parameters: -[cols=",^"] +[cols="1,3"] |=== -| line_thickness | Thickness of the bounding box lines -| font_size | Size of the font used for the label +| `line_thickness` | Thickness of the bounding box lines +| `font_size` | Size of the font used for the label |=== Example `object_detect_tf.json` file: +[source,json] ---- { - "object_detect_tf": - { - "number_of_threads" : 2, - "refresh_rate" : 10, - "confidence_threshold" : 0.5, - "overlap_threshold" : 0.5, - "model_file" : "/home/pi/models/coco_ssd_mobilenet_v1_1.0_quant_2018_06_29/detect.tflite", - "labels_file" : "/home/pi/models/coco_ssd_mobilenet_v1_1.0_quant_2018_06_29/labelmap.txt", - "verbose" : 1 + "object_detect_tf" : { + "number_of_threads" : 2, + "refresh_rate" : 10, + "confidence_threshold" : 0.5, + "overlap_threshold" : 0.5, + "model_file" : "/home//models/coco_ssd_mobilenet_v1_1.0_quant_2018_06_29/detect.tflite", + "labels_file" : "/home//models/coco_ssd_mobilenet_v1_1.0_quant_2018_06_29/labelmap.txt", + "verbose" : 1 }, - "object_detect_draw_cv": - { - "line_thickness" : 2 + "object_detect_draw_cv" : { + "line_thickness" : 2 } } ---- -The stage operates on a low resolution stream image of size 300x300. The following example would pass a 300x300 crop to the detector from the centre of the 400x300 low resolution image. +The stage operates on a low resolution stream image of size 300×300. Run the following command, which passes a 300×300 crop to the detector from the centre of the 400×300 low resolution image, to use this stage file with `rpicam-hello`: -`rpicam-hello --post-process-file object_detect_tf.json --lores-width 400 --lores-height 300` +[source,console] +---- +$ rpicam-hello --post-process-file object_detect_tf.json --lores-width 400 --lores-height 300 +---- -image::images/detection.jpg[Image showing detected objects] +.Detecting apple and cat objects. +image::images/detection.jpg[Detecting apple and cat objects] ==== `segmentation_tf` stage -`segmentation_tf` uses a Google MobileNet v1 model. The model file can be downloaded from https://tfhub.dev/tensorflow/lite-model/deeplabv3/1/metadata/2?lite-format=tflite[], whilst the labels file can be found in the `assets` folder, named `segmentation_labels.txt`. +Download: https://tfhub.dev/tensorflow/lite-model/deeplabv3/1/metadata/2?lite-format=tflite[] -This stage runs on an image of size 257x257. Because YUV420 images must have even dimensions, the low resolution image should be at least 258 pixels in both width and height. The stage adds a vector of 257x257 values to the image metadata where each value indicates which of the categories (listed in the labels file) that the pixel belongs to. Optionally, a representation of the segmentation can be drawn into the bottom right corner of the image. +`segmentation_tf` uses a Google MobileNet v1 model. This stage requires a label file, found at the `assets/segmentation_labels.txt`. -This stage has the following configurable parameters. +This stage runs on an image of size 257×257. Because YUV420 images must have even dimensions, the low resolution image should be at least 258 pixels in both width and height. The stage adds a vector of 257×257 values to the image metadata where each value indicates the categories a pixel belongs to. You can optionally draw a representation of the segmentation into the bottom right corner of the image. -[cols=",^"] +You can configure this stage with the following parameters: + +[cols="1,3"] |=== -| refresh_rate | The number of frames that must elapse before the model is re-run -| model_file | Pathname to the tflite model file -| labels_file | Pathname to the file containing the list of labels -| threshold | When verbose is set, the stage prints to the console any labels where the number of pixels with that label (in the 257x257 image) exceeds this threshold. -| draw | Set this value to draw the segmentation map into the bottom right hand corner of the image. -| verbose | Output more information to the console +| `refresh_rate` | The number of frames that must elapse between model runs +| `model_file` | Filepath of the TFLite model file +| `labels_file` | Filepath of the file containing the list of labels +| `threshold` | When verbose is set, prints when the number of pixels with any label exceeds this number +| `draw` | Draws the segmentation map into the bottom right hand corner of the image +| `verbose` | Output extra information to the console |=== Example `segmentation_tf.json` file: +[source,json] ---- { - "segmentation_tf": - { - "number_of_threads" : 2, - "refresh_rate" : 10, - "model_file" : "/home/pi/models/lite-model_deeplabv3_1_metadata_2.tflite", - "labels_file" : "/home/pi/models/segmentation_labels.txt", - "draw" : 1, - "verbose" : 1 + "segmentation_tf" : { + "number_of_threads" : 2, + "refresh_rate" : 10, + "model_file" : "/home//models/lite-model_deeplabv3_1_metadata_2.tflite", + "labels_file" : "/home//models/segmentation_labels.txt", + "draw" : 1, + "verbose" : 1 } } ---- -This example takes a square camera image and reduces it to 258x258 pixels in size. In fact the stage also works well when non-square images are squashed unequally down to 258x258 pixels without cropping. The image below shows the segmentation map in the bottom right hand corner. +This example takes a camera image and reduces it to 258×258 pixels in size. This stage even works when squashing a non-square image without cropping. This example enables the segmentation map in the bottom right hand corner. + +Run the following command to use this stage file with `rpicam-hello`: -`rpicam-hello --post-process-file segmentation_tf.json --lores-width 258 --lores-height 258 --viewfinder-width 1024 --viewfinder-height 1024` +[source,console] +---- +$ rpicam-hello --post-process-file segmentation_tf.json --lores-width 258 --lores-height 258 --viewfinder-width 1024 --viewfinder-height 1024 +---- -image::images/segmentation.jpg[Image showing segmentation in the bottom right corner] +.Running segmentation and displaying the results on a map in the bottom right. +image::images/segmentation.jpg[Running segmentation and displaying the results on a map in the bottom right] diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_writing.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_writing.adoc index 819615f80..b010133f3 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_writing.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_post_processing_writing.adoc @@ -1,55 +1,51 @@ -=== Writing your own post-processing stages +=== Write your own post-processing stages -The `rpicam-apps` post-processing framework is not only very flexible, but is meant to make it easy for users to create their own custom post-processing stages. It is easy to include algorithms and routines that are already available both in OpenCV and TensorFlow Lite. - -We are always open to accepting and distributing interesting post-processing stages contributed by our users. +With the `rpicam-apps` post-processing framework, users can create their own custom post-processing stages. You can even include algorithms and routines from OpenCV and TensorFlow Lite. ==== Basic post-processing stages -Post-processing stages have a simple API, and users can create their own by deriving from the `PostProcessingStage` class. The member functions that have to be implemented are listed below; some may be unnecessary for simple stages. +To create your own post-processing stage, derive a new class from the `PostProcessingStage` class. +All post-processing stages must implement the following member functions: -[cols=",^"] -|=== -| `char const *Name() const` | Return the name of the stage. This is used to match against stages listed in the JSON post-processing configuration file. -| `void Read(boost::property_tree::ptree const ¶ms)` | This method will read any of the stage's configuration parameters from the JSON file. -| `void AdjustConfig(std::string const &use_case, StreamConfiguration *config)` | This method gives stages a chance to influence the configuration of the camera, though it is not often necessary to implement it. -| `void Configure()` | This is called just after the camera has been configured. It is a good moment to check that the stage has access to the streams it needs, and it can also allocate any resources that it may require. -| `void Start()` | Called when the camera starts. This method is often not required. -| `bool Process(CompletedRequest &completed_request)` | This method presents completed camera requests for post-processing and is where the necessary pixel manipulations or image analysis will happen. The function returns `true` if the post-processing framework is _not_ to deliver this request to the application. -| `void Stop()` | Called when the camera is stopped. Normally a stage would need to shut down any processing that might be running (for example, if it started any asynchronous threads). -| `void Teardown()` | Called when the camera configuration is torn down. This is typically used to de-allocate any resources that were set up in the `Configure` method. -|=== +`char const *Name() const`:: Returns the name of the stage. Matched against stages listed in the JSON post-processing configuration file. +`void Read(boost::property_tree::ptree const ¶ms)`:: Reads the stage's configuration parameters from a provided JSON file. +`void AdjustConfig(std::string const &use_case, StreamConfiguration *config)`:: Gives stages a chance to influence the configuration of the camera. Frequently empty for stages with no need to configure the camera. +`void Configure()`:: Called just after the camera has been configured to allocate resources and check that the stage has access to necessary streams. +`void Start()`:: Called when the camera starts. Frequently empty for stages with no need to configure the camera. +`bool Process(CompletedRequest &completed_request)`:: Presents completed camera requests for post-processing. This is where you'll implement pixel manipulations and image analysis. Returns `true` if the post-processing framework should **not** deliver this request to the application. +`void Stop()`:: Called when the camera stops. Used to shut down any active processing on asynchronous threads. +`void Teardown()`:: Called when the camera configuration is destroyed. Use this as a deconstructor where you can de-allocate resources set up in the `Configure` method. -Some helpful hints on writing your own stages: +In any stage implementation, call `RegisterStage` to register your stage with the system. -* Generally, the `Process` method should not take too long as it will block the imaging pipeline and may cause stuttering. When time-consuming algorithms need to be run, it may be helpful to delegate them to another asynchronous thread. +Don't forget to add your stage to `meson.build` in the post-processing folder. +When writing your own stages, keep these tips in mind: -* When delegating work to another thread, the way image buffers are handled currently means that they will need to be copied. For some applications, such as image analysis, it may be viable to use the low-resolution image stream rather than full-resolution images. +* The `Process` method blocks the imaging pipeline. If it takes too long, the pipeline will stutter. **Always delegate time-consuming algorithms to an asynchronous thread.** -* The post-processing framework adds multi-threading parallelism on a per-frame basis. This is helpful in improving throughput if you want to run on every single frame. Some functions may supply parallelism within each frame (such as OpenCV and TFLite). In these cases it would probably be better to serialise the calls so as to suppress the per-frame parallelism. +* When delegating work to another thread, you must copy the image buffers. For applications like image analysis that don't require full resolution, try using a low-resolution image stream. -* Most streams, and in particular the low resolution stream, have YUV420 format. These formats are sometimes not ideal for OpenCV or TFLite so there may sometimes need to be a conversion step. +* The post-processing framework _uses parallelism to process every frame_. This improves throughput. However, some OpenCV and TensorFlow Lite functions introduce another layer of parallelism _within_ each frame. Consider serialising calls within each frame since post-processing already takes advantage of multiple threads. -* When images need to be altered, doing so in place is much the easiest strategy. +* Most streams, including the low resolution stream, use the YUV420 format. You may need to convert this to another format for certain OpenCV or TFLite functions. -* Implementations of any stage should always include a `RegisterStage` call. This registers your new stage with the system so that it will be correctly identified when listed in a JSON file. You will need to add it to the post-processing folder's `CMakeLists.txt` too, of course. +* For the best performance, always alter images in-place. -The easiest example to start with is `negate_stage.cpp`, which negates an image (turning black white, and vice versa). Aside from a small amount of derived class boiler-plate, it contains barely half a dozen lines of code. +For a basic example, see https://github.com/raspberrypi/rpicam-apps/blob/main/post_processing_stages/negate_stage.cpp[`negate_stage.cpp`]. This stage negates an image by turning light pixels dark and dark pixels light. This stage is mostly derived class boiler-plate, achieving the negation logic in barely half a dozen lines of code. -Next up in complexity is `sobel_cv_stage.cpp`. This implements a Sobel filter using just a few lines of OpenCV functions. +For another example, see https://github.com/raspberrypi/rpicam-apps/blob/main/post_processing_stages/sobel_cv_stage.cpp[`sobel_cv_stage.cpp`], which implements a Sobel filter in just a few lines of OpenCV functions. -==== TFLite Stages +==== TensorFlow Lite stages -For stages wanting to analyse images using TensorFlowLite we provide the `TfStage` base class. This provides a certain amount of boilerplate code and makes it much easier to implement new TFLite-based stages by deriving from this class. In particular, it delegates the execution of the model to another thread, so that the full camera framerate is still maintained - it is just the model that will run at a lower framerate. +For stages that use TensorFlow Lite (TFLite), derive a new class from the `TfStage` class. +This class delegates model execution to a separate thread to prevent camera stuttering. -The `TfStage` class implements all the public `PostProcessingStage` methods that normally have to be redefined, with the exception of the `Name` method, which must still be supplied. It then presents the following virtual methods, which derived classes should implement instead. +The `TfStage` class implements all the `PostProcessingStage` member functions post-processing stages must normally implement, _except for_ ``Name``. +All `TfStage`-derived stages must implement the ``Name`` function, and should implement some or all of the following virtual member functions: -[cols=",^"] -|=== -| `void readExtras()` | The base class reads the named model and certain other parameters like the `refresh_rate`. This method can be supplied to read any extra parameters for the derived stage. It is also a good place to check that the loaded model looks as expected (i.e. has right input and output dimensions). -| `void checkConfiguration()` | The base class fetches the low resolution stream which TFLite will operate on, and the full resolution stream in case the derived stage needs it. This method is provided for the derived class to check that the streams it requires are present. In case any required stream is missing, it may elect simply to avoid processing any images, or it may signal a fatal error. -| `void interpretOutputs()` | The TFLite model runs asynchronously so that it can run every few frames, without holding up the overall framerate. This method gives the derived stage the chance to read and interpret the model's outputs, running right after the model itself and in that same thread. -| `void applyResults()` | Here we are running in the main thread once again, so this method should run reasonably quickly so as not to hold up the supply of frames to the application. It is provided so that the last results of the model (which might be a few frames ago) can be applied to the current frame. Typically this would involve attaching metadata to the image, or perhaps drawing something onto the main image. -|=== +`void readExtras()`:: The base class reads the named model and certain other parameters like the `refresh_rate`. Use this function this to read extra parameters for the derived stage and check that the loaded model is correct (e.g. has right input and output dimensions). +`void checkConfiguration()`:: The base class fetches the low resolution stream that TFLite operates on and the full resolution stream in case the derived stage needs it. Use this function to check for the streams required by your stage. If your stage can't access one of the required streams, you might skip processing or throw an error. +`void interpretOutputs()`:: Use this function to read and interpret the model output. _Runs in the same thread as the model when the model completes_. +`void applyResults()`:: Use this function to apply results of the model (could be several frames old) to the current frame. Typically involves attaching metadata or drawing. _Runs in the main thread, before frames are delivered_. -For further information, readers are referred to the supplied example code implementing the `ObjectClassifyTfStage` and `PoseEstimationTfStage` classes. +For an example implementation, see the https://github.com/raspberrypi/rpicam-apps/blob/main/post_processing_stages/object_classify_tf_stage.cpp[`object_classify_tf_stage.cpp`] and https://github.com/raspberrypi/rpicam-apps/blob/main/post_processing_stages/pose_estimation_tf_stage.cpp[`pose_estimation_tf_stage.cpp`]. diff --git a/documentation/asciidoc/computers/camera/rpicam_apps_writing.adoc b/documentation/asciidoc/computers/camera/rpicam_apps_writing.adoc index e4419add8..fd5a9217b 100644 --- a/documentation/asciidoc/computers/camera/rpicam_apps_writing.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_apps_writing.adoc @@ -1,62 +1,59 @@ -=== Understanding and writing your own apps +=== Write your own `rpicam` apps -`rpicam-apps` is not supposed to offer a full set of all the applications with all the features that anyone could ever need. We offer applications which are commonly used and easy to understand, while enabling those users who require slightly different behaviour to implement that behaviour for themselves. +`rpicam-apps` does not provide all of the camera-related features that anyone could ever need. Instead, these applications are small and flexible. Users who require different behaviour can implement it themselves. -All the applications work by having a simple event loop which receives a message with a new set of frames from the camera system. This set of frames is called a `CompletedRequest`. It contains all the images that have been derived from that single camera frame (so perhaps a low resolution image in addition to the full-size output), as well as metadata from the camera system and further metadata from the post-processing system. +All of the `rpicam-apps` use an event loop that receives messages when a new set of frames arrives from the camera system. This set of frames is called a `CompletedRequest`. The `CompletedRequest` contains: -==== `rpicam-hello` - -`rpicam-hello` is much the easiest application to understand. The only thing it does with the camera images is to extract the `CompletedRequestPtr` (a shared pointer to the `CompletedRequest`) from the message: +* all images derived from that single camera frame: often a low-resolution image and a full-size output +* metadata from the camera and post-processing systems ----- - CompletedRequestPtr &completed_request = std::get(msg.payload); ----- +==== `rpicam-hello` -...and forward it to the preview window: +`rpicam-hello` is the smallest application, and the best place to start understanding `rpicam-apps` design. It extracts the `CompletedRequestPtr`, a shared pointer to the `CompletedRequest`, from the message, and forwards it to the preview window: +[cpp] ---- - app.ShowPreview(completed_request, app.ViewfinderStream()); +CompletedRequestPtr &completed_request = std::get(msg.payload); +app.ShowPreview(completed_request, app.ViewfinderStream()); ---- -One important thing to note is that every `CompletedRequest` must be recycled back to the camera system so that the buffers can be reused, otherwise it will simply run out of buffers in which to receive new camera frames. This recycling process happens automatically when all references to the `CompletedRequest` are dropped, using {cpp}'s _shared pointer_ and _custom deleter_ mechanisms. +Every `CompletedRequest` must be recycled back to the camera system so that the buffers can be reused. Otherwise, the camera runs out of buffers for new camera frames. This recycling process happens automatically when no references to the `CompletedRequest` remain using {cpp}'s _shared pointer_ and _custom deleter_ mechanisms. -This means that in `rpicam-hello`, two things must happen for the `CompletedRequest` to be returned to the camera: +As a result, `rpicam-hello` must complete the following actions to recycle the buffer space: -* The event loop must go round again so that the message (`msg` in the code), which is holding a reference to the shared pointer, is dropped +* The event loop must finish a cycle so the message (`msg` in the code), which holds a reference to `CompletedRequest`, can be replaced with the next message. This discards the reference to the previous message. -* The preview thread, which takes another reference to the `CompletedRequest` when `ShowPreview` is called, must be called again with a new `CompletedRequest`, causing the previous one to be dropped +* When the event thread calls `ShowPreview`, it passes the preview thread a reference to the `CompletedRequest`. The preview thread discards the last `CompletedRequest` instance each time `ShowPreview` is called. ==== `rpicam-vid` -`rpicam-vid` is not unlike `rpicam-hello`, but it adds a codec to the event loop and the preview. Before the event loop starts, we must configure that encoder with a callback which says what happens to the buffer containing the encoded image data. +`rpicam-vid` is similar to `rpicam-hello` with encoding added to the event loop. Before the event loop starts, `rpicam-vid` configures the encoder with a callback. The callback handles the buffer containing the encoded image data. In the code below, we send the buffer to the `Output` object. `Output` could write it to a file or stream it, depending on the options specified. +[cpp] ---- - app.SetEncodeOutputReadyCallback(std::bind(&Output::OutputReady, output.get(), _1, _2, _3, _4)); +app.SetEncodeOutputReadyCallback(std::bind(&Output::OutputReady, output.get(), _1, _2, _3, _4)); ---- -Here we send the buffer to the `Output` object which may write it to a file, or send it over the network, according to our choice when we started the application. - -The encoder also takes a new reference to the `CompletedRequest`, so once the event loop, the preview window and the encoder all drop their references, the `CompletedRequest` will be recycled automatically back to the camera system. +Because this code passes the encoder a reference to the `CompletedRequest`, `rpicam-vid` can't recycle buffer data until the event loop, preview window, _and_ encoder all discard their references. ==== `rpicam-raw` -`rpicam-raw` is not so very different from `rpicam-vid`. It too uses an encoder, although this time it is a dummy encoder called the `NullEncoder`. This just treats the input image directly as the output buffer and is careful not to drop its reference to the input until the output callback has dealt with it first. +`rpicam-raw` is similar to `rpicam-vid`. It also encodes during the event loop. However, `rpicam-raw` uses a dummy encoder called the `NullEncoder`. This uses the input image as the output buffer instead of encoding it with a codec. `NullEncoder` only discards its reference to the buffer once the output callback completes. This guarantees that the buffer isn't recycled before the callback processes the image. -This time, however, we do not forward anything to the preview window, although we could have displayed the (processed) video stream if we had wanted. +`rpicam-raw` doesn't forward anything to the preview window. -The use of the `NullEncoder` is possibly overkill in this application, as we could probably just send the image straight to the `Output` object. However, it serves to underline the general principle that it is normally a bad idea to do too much work directly in the event loop, and that time-consuming processes are often better left to other threads. +`NullEncoder` is possibly overkill in `rpicam-raw`. We could probably send images straight to the `Output` object, instead. However, `rpicam-apps` need to limit work in the event loop. `NullEncoder` demonstrates how you can handle most processes (even holding onto a reference) in other threads. ==== `rpicam-jpeg` -We discuss `rpicam-jpeg` rather than `rpicam-still` as the basic function (that of switching the camera from preview into capture mode) is the same, and `rpicam-jpeg` has far fewer additional options (such as timelapse capture) that serve to distract from the basic function. - -`rpicam-jpeg` starts the camera in preview mode in the usual way, but at the appropriate moment stops it and switches to still capture: +`rpicam-jpeg` starts the camera in preview mode in the usual way. When the timer completes, it stops the preview and switches to still capture: +[cpp] ---- - app.StopCamera(); - app.Teardown(); - app.ConfigureStill(); - app.StartCamera(); +app.StopCamera(); +app.Teardown(); +app.ConfigureStill(); +app.StartCamera(); ---- -Then the event loop will grab the first frame that emerges once it's no longer in preview mode, and saves this as a JPEG. +The event loop grabs the first frame returned from still mode and saves this as a JPEG. diff --git a/documentation/asciidoc/computers/camera/rpicam_configuration.adoc b/documentation/asciidoc/computers/camera/rpicam_configuration.adoc new file mode 100644 index 000000000..c36db3f69 --- /dev/null +++ b/documentation/asciidoc/computers/camera/rpicam_configuration.adoc @@ -0,0 +1,57 @@ +=== Configuration + +Most use cases work automatically with no need to alter the camera configuration. However, some common use cases do require configuration tweaks, including: + +* Third-party cameras (the manufacturer's instructions should explain necessary configuration changes, if any) + +* Using a non-standard driver or overlay with an official Raspberry Pi camera + +Raspberry Pi OS recognises the following overlays in `/boot/firmware/config.txt`. + +|=== +| Camera Module | In `/boot/firmware/config.txt` + +| V1 camera (OV5647) +| `dtoverlay=ov5647` + +| V2 camera (IMX219) +| `dtoverlay=imx219` + +| HQ camera (IMX477) +| `dtoverlay=imx477` + +| GS camera (IMX296) +| `dtoverlay=imx296` + +| Camera Module 3 (IMX708) +| `dtoverlay=imx708` + +| IMX290 and IMX327 +| `dtoverlay=imx290,clock-frequency=74250000` or `dtoverlay=imx290,clock-frequency=37125000` (both modules share the imx290 kernel driver; refer to instructions from the module vendor for the correct frequency) + +| IMX378 +| `dtoverlay=imx378` + +| OV9281 +| `dtoverlay=ov9281` +|=== + +To use one of these overlays, you must disable automatic camera detection. To disable automatic detection, set `camera_auto_detect=0` in `/boot/firmware/config.txt`. If `config.txt` already contains a line assigning an `camera_auto_detect` value, change the value to `0`. Reboot your Raspberry Pi with `sudo reboot` to load your changes. + +If your Raspberry Pi has two camera connectors (Raspberry Pi 5 or one of the Compute Modules, for example), then you can specify the use of camera connector 0 by adding `,cam0` to the `dtoverlay` that you used from the table above. If you do not add this, it will default to checking camera connector 1. Note that for official Raspberry Pi camera modules connected to SBCs (not Compute Modules), auto-detection will correctly identify all the cameras connected to your device. + +[[tuning-files]] +==== Tweak camera behaviour with tuning files + +Raspberry Pi's `libcamera` implementation includes a **tuning file** for each camera. This file controls algorithms and hardware to produce the best image quality. `libcamera` can only determine the sensor in use, not the module. As a result, some modules require a tuning file override. Use the xref:camera_software.adoc#tuning-file[`tuning-file`] option to specify an override. You can also copy and alter existing tuning files to customise camera behaviour. + +For example, the no-IR-filter (NoIR) versions of sensors use Auto White Balance (AWB) settings different from the standard versions. On a Raspberry Pi 5 or later, you can specify the the NoIR tuning file for the IMX219 sensor with the following command: + +[source,console] +---- +$ rpicam-hello --tuning-file /usr/share/libcamera/ipa/rpi/pisp/imx219_noir.json +---- + +NOTE: Raspberry Pi models prior to Raspberry Pi 5 use different tuning files. On those devices, use the files stored in `/usr/share/libcamera/ipa/rpi/vc4/` instead. + +`libcamera` maintains tuning files for a number of cameras, including third-party models. For instance, you can find the tuning file for the Soho Enterprises SE327M12 in `se327m12.json`. diff --git a/documentation/asciidoc/computers/camera/rpicam_detect.adoc b/documentation/asciidoc/computers/camera/rpicam_detect.adoc index 94e1892d4..e75a4a630 100644 --- a/documentation/asciidoc/computers/camera/rpicam_detect.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_detect.adoc @@ -1,22 +1,14 @@ === `rpicam-detect` -`rpicam-detect` is not supplied by default in any Raspberry Pi OS distribution, but can be built by users who have xref:camera_software.adoc#post-processing-with-tensorflow-lite[installed TensorFlow Lite]. Please refer to the xref:camera_software.adoc#building-libcamera-and-rpicam-apps[`rpicam-apps` build instructions]. You will need to run `cmake` with `-DENABLE_TFLITE=1`. +NOTE: Raspberry Pi OS does not include `rpicam-detect`. However, you can build `rpicam-detect` if you have xref:camera_software.adoc#post-processing-with-tensorflow-lite[installed TensorFlow Lite]. For more information, see the xref:camera_software.adoc#build-libcamera-and-rpicam-apps[`rpicam-apps` build instructions]. Don't forget to pass `-Denable_tflite=enabled` when you run `meson`. -This application runs a preview window and monitors the contents using a Google MobileNet v1 SSD (Single Shot Detector) neural network that has been trained to identify about 80 classes of objects using the Coco dataset. It should recognise people, cars, cats and many other objects. +`rpicam-detect` displays a preview window and monitors the contents using a Google MobileNet v1 SSD (Single Shot Detector) neural network trained to identify about 80 classes of objects using the Coco dataset. `rpicam-detect` recognises people, cars, cats and many other objects. -Its starts by running a preview window, and whenever the target object is detected it will perform a full-resolution JPEG capture, before returning back to the preview mode to continue monitoring. It provides a couple of additional command line options that do not apply elsewhere: +Whenever `rpicam-detect` detects a target object, it captures a full-resolution JPEG. Then it returns to monitoring preview mode. -`--object ` +See the xref:camera_software.adoc#object_detect_tf-stage[TensorFlow Lite object detector] section for general information on model usage. For example, you might spy secretly on your cats while you are away with: -Detect objects with the given ``. The name should be taken from the model's label file. - -`--gap ` - -Wait at least this many frames after a capture before performing another. This is necessary because the neural network does not run on every frame, so it is best to give it a few frames to run again before considering another capture. - -Please refer to the xref:camera_software.adoc#object_detect_tf-stage[TensorFlow Lite object detector] section for more general information on how to obtain and use this model. For example, you might spy secretly on your cats while you are away with: - -[,bash] +[source,console] ---- -rpicam-detect -t 0 -o cat%04d.jpg --lores-width 400 --lores-height 300 --post-process-file object_detect_tf.json --object cat +$ rpicam-detect -t 0 -o cat%04d.jpg --lores-width 400 --lores-height 300 --post-process-file object_detect_tf.json --object cat ---- diff --git a/documentation/asciidoc/computers/camera/rpicam_hello.adoc b/documentation/asciidoc/computers/camera/rpicam_hello.adoc index be301c378..de7dae16f 100644 --- a/documentation/asciidoc/computers/camera/rpicam_hello.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_hello.adoc @@ -1,75 +1,41 @@ === `rpicam-hello` -`rpicam-hello` is the equivalent of a "hello world" application for the camera. It starts the camera, displays a preview window, and does nothing else. To display a preview window for about 5 seconds: +`rpicam-hello` briefly displays a preview window containing the video feed from a connected camera. To use `rpicam-hello` to display a preview window for five seconds, run the following command in a terminal: -[,bash] +[source,console] ---- -rpicam-hello +$ rpicam-hello ---- -The `-t ` option lets the user select how long the window is displayed, where `` is given in milliseconds. To run the preview indefinitely, use: -[,bash] +You can pass an optional duration (in milliseconds) with the xref:camera_software.adoc#timeout[`timeout`] option. A value of `0` runs the preview indefinitely: + +[source,console] ---- -rpicam-hello -t 0 +$ rpicam-hello --timeout 0 ---- -The preview can be halted either by clicking the window's close button, or using `Ctrl-C` in the terminal. - -==== Options - -`rpicam-apps` uses a third-party library to interpret command line options. This includes long-form options where the option name consists of more than one character preceded by `--`, and short-form options which can only be a single character preceded by a single `-`. For the most part, option names are chosen to match those used by the legacy `raspicam` applications with the exception that we can no longer handle multi-character option names with a single `-`. Any such legacy options have been dropped, and the long form with `--` must be used instead. +Use `Ctrl+C` in the terminal or the close button on the preview window to stop `rpicam-hello`. -The options are classified broadly into three groups: those that are common, those that are specific to still images, and those that are for video encoding. They are supported in an identical manner across all the applications where they apply. +==== Display an image sensor preview -Please refer to the xref:camera_software.adoc#common-command-line-options[command line options documentation] for a complete list. +Most of the `rpicam-apps` display a preview image in a window. If there is no active desktop environment, the preview draws directly to the display using the Linux Direct Rendering Manager (DRM). Otherwise, `rpicam-apps` attempt to use the desktop environment. Both paths use zero-copy GPU buffer sharing: as a result, X forwarding is _not_ supported. -==== The tuning file +If you run the X window server and want to use X forwarding, pass the xref:camera_software.adoc#qt-preview[`qt-preview`] flag to render the preview window in a https://en.wikipedia.org/wiki/Qt_(software)[Qt] window. The Qt preview window uses more resources than the alternatives. -Raspberry Pi's `libcamera` implementation includes a tuning file for each different type of camera module. This is a file that describes or tunes the parameters that will be passed to the algorithms and hardware to produce the best image quality. `libcamera` is only able to automatically determine the image sensor being used, not the module as a whole, even though the whole module affects the "tuning". For this reason it is sometimes necessary to override the default tuning file for a particular sensor. - -For example, the no-IR-filter (NoIR) versions of sensors require different AWB settings to the standard versions, so the IMX219 NoIR being used with a Pi 4 or earlier device should be run using: - -[,bash] ----- -rpicam-hello --tuning-file /usr/share/libcamera/ipa/rpi/vc4/imx219_noir.json ----- - -Raspberry Pi 5 uses a different tuning file in a different folder, so here you would use: - -[,bash] ----- -rpicam-hello --tuning-file /usr/share/libcamera/ipa/rpi/pisp/imx219_noir.json ----- +NOTE: Older systems using Gtk2 may, when linked with OpenCV, produce `Glib-GObject` errors and fail to show the Qt preview window. In this case edit the file `/etc/xdg/qt5ct/qt5ct.conf` as root and replace the line containing `style=gtk2` with `style=gtk3`. -If you are using a Soho Enterprises SE327M12 module with a Pi 4 you would use: +To suppress the preview window entirely, pass the xref:camera_software.adoc#nopreview[`nopreview`] flag: -[,bash] +[source,console] ---- -rpicam-hello --tuning-file /usr/share/libcamera/ipa/rpi/vc4/se327m12.json +$ rpicam-hello -n ---- -This also means that users can copy an existing tuning file and alter it according to their own preferences, so long as the `--tuning-file` parameter is pointed to the new version. - -The `--tuning-file` parameter, in common with other `rpicam-hello` command line options, applies identically across all the `rpicam-apps`. - -==== Preview window - -Most of the `rpicam-apps` display a preview image in a window. If there is no active desktop environment, it will draw directly to the display using Linux Direct Rendering Manager (DRM), otherwise it will attempt to use the desktop environment. Both paths use zero-copy buffer sharing with the GPU, and a consequence of this is that X forwarding is _not_ supported. - -For this reason there is a third kind of preview window which does support X forwarding, which can be requested with the `--qt-preview` option. This implementation does not benefit from zero-copy buffer sharing, nor from 3D acceleration, which makes it computationally expensive (especially for large previews), and is not recommended. +The xref:camera_software.adoc#info-text[`info-text`] option displays image information on the window title bar using `%` directives. For example, the following command displays the current red and blue gain values: -NOTE: Older systems using Gtk2 may, when linked with OpenCV, produce `Glib-GObject` errors and fail to show the Qt preview window. In this case edit the file `/etc/xdg/qt5ct/qt5ct.conf` as root and replace the line containing `style=gtk2` with `style=gtk3`. - -The preview window can be suppressed entirely with the `-n` (`--nopreview`) option. - -The `--info-text` option allows the user to request that certain helpful image information is displayed on the window title bar using "% directives". For example: - -[,bash] +[source,console] ---- -rpicam-hello --info-text "red gain %rg, blue gain %bg" +$ rpicam-hello --info-text "red gain %rg, blue gain %bg" ---- -...will display the current red and blue gain values. - -For the HQ camera, use `--info-text "%focus"` to display the focus measure, which will be helpful for focusing the lens. -A full description of the `--info-text` parameter is given in the xref:camera_software.adoc#common-command-line-options[command line options documentation]. +For a full list of directives, see the xref:camera_software.adoc#info-text[`info-text` reference]. diff --git a/documentation/asciidoc/computers/camera/rpicam_jpeg.adoc b/documentation/asciidoc/computers/camera/rpicam_jpeg.adoc index fbe69f099..253148728 100644 --- a/documentation/asciidoc/computers/camera/rpicam_jpeg.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_jpeg.adoc @@ -1,50 +1,19 @@ === `rpicam-jpeg` -`rpicam-jpeg` is a simple still image capture application. It deliberately avoids some of the additional features of `rpicam-still`, which attempts to emulate `raspistill` more fully. This means that the code is significantly easier to understand, while still providing many of the same features. +`rpicam-jpeg` helps you capture images on Raspberry Pi devices. -To capture a full resolution JPEG image use: +To capture a full resolution JPEG image and save it to a file named `test.jpg`, run the following command: -[,bash] +[source,console] ---- -rpicam-jpeg -o test.jpg +$ rpicam-jpeg --output test.jpg ---- -This will display a preview for about five seconds, and then capture a full resolution JPEG image to the file `test.jpg`. -The `-t ` option can be used to alter the length of time the preview shows, and the `--width` and `--height` options will change the resolution of the captured still image. For example: +You should see a preview window for five seconds. Then, `rpicam-jpeg` captures a full resolution JPEG image and saves it. -[,bash] ----- -rpicam-jpeg -o test.jpg -t 2000 --width 640 --height 480 ----- -...will capture a VGA sized image. - -==== Exposure control - -All the `rpicam-apps` allow the user to run the camera with fixed shutter-speed and gain. - -Capture an image with an exposure of 20ms and a gain of 1.5×: - -[,bash] ----- -rpicam-jpeg -o test.jpg -t 2000 --shutter 20000 --gain 1.5 ----- -The gain will be applied as analogue gain within the sensor, up until it reaches the maximum analogue gain permitted by the kernel sensor driver, after which the remainder will be applied as digital gain. - -Raspberry Pi's AEC/AGC algorithm allows applications to specify exposure compensation: the ability to make images darker or brighter by a given number of stops. +Use the xref:camera_software.adoc#timeout[`timeout`] option to alter display time of the preview window. The xref:camera_software.adoc#width-and-height[`width` and `height`] options change the resolution of the saved image. For example, the following command displays the preview window for 2 seconds, then captures and saves an image with a resolution of 640×480 pixels: -[,bash] +[source,console] ---- -rpicam-jpeg --ev -0.5 -o darker.jpg -rpicam-jpeg --ev 0 -o normal.jpg -rpicam-jpeg --ev 0.5 -o brighter.jpg +$ rpicam-jpeg --output test.jpg --timeout 2000 --width 640 --height 480 ---- - -===== Further remarks on digital gain - -Digital gain is applied by the ISP, not by the sensor. The digital gain will always be very close to 1.0 unless: - -* The total gain requested (either by the `--gain` option, or by the exposure profile in the camera tuning) exceeds that which can be applied as analogue gain within the sensor. Only the extra gain required will be applied as digital gain. - -* One of the colour gains is less than 1 (note that colour gains are applied as digital gain too). In this case the advertised digital gain will settle to 1 / min(red_gain, blue_gain). This means that one of the colour channels - just not the green one - is having unity digital gain applied to it. - -* The AEC/AGC is changing. When the AEC/AGC is moving the digital gain will typically vary to some extent to try and smooth out any fluctuations, but it will quickly settle back to its normal value. diff --git a/documentation/asciidoc/computers/camera/rpicam_options_common.adoc b/documentation/asciidoc/computers/camera/rpicam_options_common.adoc index 615e60543..90e535ff8 100644 --- a/documentation/asciidoc/computers/camera/rpicam_options_common.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_options_common.adoc @@ -1,29 +1,39 @@ -=== Common command line options +== `rpicam-apps` options reference + +=== Common options The following options apply across all the `rpicam-apps` with similar or identical semantics, unless otherwise noted. ----- - --help, -h Print help information for the application ----- +To pass one of the following options to an application, prefix the option name with `--`. If the option requires a value, pass the value immediately after the option name, separated by a single space. If the value contains a space, surround the value in quotes. -The `--help` option causes every application to print its full set of command line options with a brief synopsis of each, and then quit. +Some options have shorthand aliases, for example `-h` instead of `--help`. Use these shorthand aliases instead of the full option name to save space and time at the expense of readability. ----- - --version Print out a software version number ----- +==== `help` + +Alias: `-h` + +Prints the full set of options, along with a brief synopsis of each option. Does not accept a value. + +==== `version` + +Prints out version strings for `libcamera` and `rpicam-apps`. Does not accept a value. -All `rpicam-apps` will, when they see the `--version` option, print out a version string both for `libcamera` and `rpicam-apps` and then quit, for example: +Example output: ---- rpicam-apps build: ca559f46a97a 27-09-2021 (14:10:24) libcamera build: v0.0.0+3058-c29143f7 ---- ----- - --list-cameras List the cameras available for use ----- +==== `list-cameras` + +Lists the detected cameras attached to your Raspberry Pi and their available sensor modes. Does not accept a value. + +Sensor mode identifiers have the following form: `S_ : ` -The `--list-cameras` will display the available cameras attached to the board that can be used by the application. This option also lists the sensor modes supported by each camera. For example: +Crop is specified in native sensor pixels (even in pixel binning mode) as `(, )/×`. `(x, y)` specifies the location of the crop window of size `width × height` in the sensor array. + +For example, the following output displays information about an `IMX219` sensor at index 0 and an `IMX477` sensor at index 1: ---- Available cameras @@ -44,533 +54,541 @@ Available cameras 4056x3040 [10.00 fps - (0, 0)/4056x3040 crop] ---- -In the above example, the IMX219 sensor is available at index 0 and IMX477 at index 1. The sensor mode identifier takes the following form: ----- -S_ : ----- -For the IMX219 in the above example, all modes have a `RGGB` Bayer ordering and provide either 8-bit or 10-bit CSI2 packed readout at the listed resolutions. The crop is specified as (, )/×, where (x, y) is the location of the crop window of size width × height in the sensor array. The units remain native sensor pixels, even if the sensor is being used in a binning or skipping mode. +For the IMX219 sensor in the above example: ----- - --camera Selects which camera to use ----- +* all modes have an `RGGB` Bayer ordering +* all modes provide either 8-bit or 10-bit CSI2 packed readout at the listed resolutions -The `--camera` option will select which camera to use from the supplied value. The value can be obtained from the `--list-cameras` option. +==== `camera` ----- - --config, -c Read options from the given file ----- +Selects the camera to use. Specify an index from the xref:camera_software.adoc#list-cameras[list of available cameras]. -Normally options are read from the command line, but in case multiple options are required it may be more convenient to keep them in a file. +==== `config` -Example: `rpicam-hello -c config.txt` +Alias: `-c` -This is a text file containing individual lines of `key=value` pairs, for example: +Specify a file containing CLI options and values. Consider a file named `example_configuration.txt` that contains the following text, specifying options and values as key-value pairs, one option per line, long (non-alias) option names only: ---- timeout=99000 verbose= ---- -Note how the `=` is required even for implicit options, and that the `--` used on the command line are omitted. Only long form options are permitted (`t=99000` would not be accepted). +TIP: Omit the leading `--` that you normally pass on the command line. For flags that lack a value, such as `verbose` in the above example, you must include a trailing `=`. + +You could then run the following command to specify a timeout of 99000 milliseconds and verbose output: +[source,console] ---- - --timeout, -t Delay before application stops automatically +$ rpicam-hello --config example_configuration.txt ---- -The `--timeout` option specifies how long the application runs before it stops, whether it is recording a video or showing a preview. In the case of still image capture, the application will show the preview window for this long before capturing the output image. +==== `timeout` -If unspecified, the default value is 5000 (5 seconds). The value zero causes the application to run indefinitely. +Alias: `-t` -Example: `rpicam-hello -t 0` +Default value: 5000 milliseconds (5 seconds) -==== Preview window +Specify how long the application runs before closing. This value is interpreted as a number of milliseconds unless an optional suffix is used to change the unit. The suffix may be one of: ----- - --preview, -p Preview window settings ----- +* `min` - minutes +* `s` or `sec` - seconds +* `ms` - milliseconds (the default if no suffix used) +* `us` - microseconds +* `ns` - nanoseconds. + +This time applies to both video recording and preview windows. When capturing a still image, the application shows a preview window for the length of time specified by the `timeout` parameter before capturing the output image. + +To run the application indefinitely, specify a value of `0`. Floating point values are also permitted. -Sets the size and location of the preview window (both desktop and DRM versions). It does not affect the resolution or aspect ratio of images being requested from the camera. The camera images will be scaled to the size of the preview window for display, and will be pillar/letter-boxed to fit. +Example: `rpicam-hello -t 0.5min` would run for 30 seconds. -Example: `rpicam-hello -p 100,100,500,500` +==== `preview` + +Alias: `-p` + +Sets the location (x,y coordinates) and size (w,h dimensions) of the desktop or DRM preview window. Does not affect the resolution or aspect ratio of images requested from the camera. Scales image size and pillar or letterboxes image aspect ratio to fit within the preview window. + +Pass the preview window dimensions in the following comma-separated form: `x,y,w,h` + +Example: `rpicam-hello --preview 100,100,500,500` image::images/preview_window.jpg[Letterboxed preview image] ----- - --fullscreen, -f Fullscreen preview mode ----- +==== `fullscreen` -Forces the preview window to use the whole screen, and the window will have no border or title bar. Again the image may be pillar/letter-boxed. +Alias: `-f` -Example `rpicam-still -f -o test.jpg` +Forces the preview window to use the entire screen with no border or title bar. Scales image size and pillar or letterboxes image aspect ratio to fit within the entire screen. Does not accept a value. ----- - --qt-preview Use Qt-based preview window ----- +==== `qt-preview` -The preview window is switched to use the Qt-based implementation. This option is not normally recommended because it no longer uses zero-copy buffer sharing, nor GPU acceleration, and is therefore computationally very expensive. However, it does support X forwarding, which the other preview implementations do not. +Uses the Qt preview window, which consumes more resources than the alternatives, but supports X window forwarding. Incompatible with the xref:camera_software.adoc#fullscreen[`fullscreen`] flag. Does not accept a value. -The Qt preview window does not support the `--fullscreen` option. It is advised to try and keep the preview window small. +==== `nopreview` -Example `rpicam-hello --qt-preview` +Alias: `-n` ----- - --nopreview, -n Do not display a preview window ----- +Causes the application to _not_ display a preview window at all. Does not accept a value. -The preview window is suppressed entirely. -Example `rpicam-still -n -o test.jpg` +==== `info-text` ----- - --info-text Set window title bar text ----- +Default value: `"#%frame (%fps fps) exp %exp ag %ag dg %dg"` -The supplied string is set as the title of the preview window, when running in a desktop environment. The string may contain a number of `%` directives, which are substituted with information from the image metadata. The permitted directives are: +Sets the supplied string as the title of the preview window when running in a desktop environment. Supports the following image metadata substitutions: |=== | Directive | Substitution -| %frame -| The sequence number of the frame +| `%frame` +| Sequence number of the frame. -| %fps -| The instantaneous frame rate +| `%fps` +| Instantaneous frame rate. -| %exp -| The shutter speed used to capture the image, in microseconds +| `%exp` +| Shutter speed used to capture the image, in microseconds. -| %ag -| The analogue gain applied to the image in the sensor +| `%ag` +| Analogue gain applied to the image in the sensor. -| %dg -| The digital gain applied to the image by the ISP +| `%dg` +| Digital gain applied to the image by the ISP. -| %rg -| The gain applied to the red component of each pixel +| `%rg` +| Gain applied to the red component of each pixel. -| %bg -| The gain applied to the blue component of each pixel +| `%bg` +| Gain applied to the blue component of each pixel. -| %focus -| The focus metric for the image, where a larger value implies a sharper image +| `%focus` +| Focus metric for the image, where a larger value implies a sharper image. -| %lp -| The current lens position in dioptres (1 / distance in metres). +| `%lp` +| Current lens position in dioptres (1 / distance in metres). -| %afstate -| The autofocus algorithm state (one of `idle`, `scanning`, `focused` or `failed`). +| `%afstate` +| Autofocus algorithm state (`idle`, `scanning`, `focused` or `failed`). |=== -When not provided, the `--info-text` string defaults to `"#%frame (%fps fps) exp %exp ag %ag dg %dg"`. +image::images/focus.jpg[Image showing focus measure] -Example: `rpicam-hello --info-text "Focus measure: %focus"` +==== `width` and `height` -image::images/focus.jpg[Image showing focus measure] +Each accepts a single number defining the dimensions, in pixels, of the captured image. -==== Camera resolution and readout +For `rpicam-still`, `rpicam-jpeg` and `rpicam-vid`, specifies output resolution. ----- - --width Capture image width - --height Capture image height ----- +For `rpicam-raw`, specifies raw frame resolution. For cameras with a 2×2 binned readout mode, specifying a resolution equal to or smaller than the binned mode captures 2×2 binned raw frames. -These numbers specify the output resolution of the camera images captured by `rpicam-still`, `rpicam-jpeg` and `rpicam-vid`. +For `rpicam-hello`, has no effect. -For `rpicam-raw`, it affects the size of the raw frames captured. Where a camera has a 2×2 binned readout mode. Specifying a resolution not larger than this binned mode will result in the capture of 2×2 binned raw frames. +Examples: -For `rpicam-hello` these parameters have no effect. +* `rpicam-vid -o test.h264 --width 1920 --height 1080` captures 1080p video. + +* `rpicam-still -r -o test.jpg --width 2028 --height 1520` captures a 2028×1520 resolution JPEG. If used with the HQ camera, uses 2×2 binned mode, so the raw file (`test.dng`) contains a 2028×1520 raw Bayer image. + +==== `viewfinder-width` and `viewfinder-height` + +Each accepts a single number defining the dimensions, in pixels, of the image displayed in the preview window. Does not effect the preview window dimensions, since images are resized to fit. Does not affect captured still images or videos. + +==== `mode` + +Allows you to specify a camera mode in the following colon-separated format: `:::`. The system selects the closest available option for the sensor if there is not an exact match for a provided value. You can use the packed (`P`) or unpacked (`U`) packing formats. Impacts the format of stored videos and stills, but not the format of frames passed to the preview window. + +Bit-depth and packing are optional. +Bit-depth defaults to 12. +Packing defaults to `P` (packed). + +For information about the bit-depth, resolution, and packing options available for your sensor, see xref:camera_software.adoc#list-cameras[`list-cameras`]. Examples: -`rpicam-vid -o test.h264 --width 1920 --height 1080` will capture 1080p video. +* `4056:3040:12:P` - 4056×3040 resolution, 12 bits per pixel, packed. +* `1632:1224:10` - 1632×1224 resolution, 10 bits per pixel. +* `2592:1944:10:U` - 2592×1944 resolution, 10 bits per pixel, unpacked. +* `3264:2448` - 3264×2448 resolution. -`rpicam-still -r -o test.jpg --width 2028 --height 1520` will capture a 2028x1520 resolution JPEG. When using the HQ camera, the sensor will be driven in its 2×2 binned mode so the raw file - captured in `test.dng` - will contain a 2028×1520 raw Bayer image. +===== Packed format details ----- - --viewfinder-width Capture image width - --viewfinder-height Capture image height ----- +The packed format uses less storage for pixel data. -These options affect only the preview (meaning both `rpicam-hello` and the preview phase of `rpicam-jpeg` and `rpicam-still`), and specify the image size that will be requested from the camera for the preview window. They have no effect on captured still images or videos. Nor do they affect the preview window as the images are resized to fit. +_On Raspberry Pi 4 and earlier devices_, the packed format packs pixels using the MIPI CSI-2 standard. This means: -Example: `rpicam-hello --viewfinder-width 640 --viewfinder-height 480` +* 10-bit camera modes pack 4 pixels into 5 bytes. The first 4 bytes contain the 8 most significant bits (MSBs) of each pixel, and the final byte contains the 4 pairs of least significant bits (LSBs). +* 12-bit camera modes pack 2 pixels into 3 bytes. The first 2 bytes contain the 8 most significant bits (MSBs) of each pixel, and the final byte contains the 4 least significant bits (LSBs) of both pixels. ----- - --rawfull Force sensor to capture in full resolution mode ----- +_On Raspberry Pi 5 and later devices_, the packed format compresses pixel values with a visually lossless compression scheme into 8 bits (1 byte) per pixel. -This option forces the sensor to be driven in its full resolution readout mode for still and video capture, irrespective of the requested output resolution (given by `--width` and `--height`). It has no effect for `rpicam-hello`. +===== Unpacked format details -Using this option often incurs a framerate penalty, as larger-resolution frames are slower to read out. +The unpacked format provides pixel values that are much easier to manually manipulate, at the expense of using more storage for pixel data. -Example: `rpicam-raw -t 2000 --segment 1 --rawfull -o test%03d.raw` will cause multiple full resolution raw frames to be captured. On the HQ camera each frame will be about 18MB in size. Without the `--rawfull` option the default video output resolution would have caused the 2×2 binned mode to be selected, resulting in 4.5MB raw frames. +On all devices, the unpacked format uses 2 bytes per pixel. ----- - --mode Specify sensor mode, given as ::: ----- +_On Raspberry Pi 4 and earlier devices_, applications apply zero padding at the *most significant end*. In the unpacked format, a pixel from a 10-bit camera mode cannot exceed the value 1023. -This option is more general than `--rawfull` and allows the precise selection of one of the camera modes. The mode should be specified by giving its width, height, bit-depth and packing, separated by colons. These numbers do not have to be exact as the system will select the closest it can find. Moreover, the bit-depth and packing are optional (defaulting to 12 and `P` for "packed" respectively). +_On Raspberry Pi 5 and later devices_, applications apply zero padding at the *least significant end*, so images use the full 16-bit dynamic range of the pixel depth delivered by the sensor. -On a Pi 4 or earlier device, "packed" modes will return pixels that are packed according to the MIPI CSI-2 standard, meaning: +==== `viewfinder-mode` -* 10-bit camera modes will be packed with 4 pixels in 5 bytes. The first 4 bytes contain the 8 most significant bits (MSBs) of each pixel, and the final byte contains the 4 pairs of LSBs. -* 12-bit camera modes will be packed with 2 pixels in 3 bytes. The first 2 bytes contain the 8 MSBs, and the final byte contains the 4 LSBs of both pixels. +Identical to the `mode` option, but it applies to the data passed to the preview window. For more information, see the xref:camera_software.adoc#mode[`mode` documentation]. -"Unpacked" modes will use exactly 2 bytes per pixel. The 2-byte words will be zero-padded at the most significant end, meaning that, for example, a pixel from a 10-bit camera mode cannot exceed the value 1023. +==== `lores-width` and `lores-height` -On a Pi 5 (and any subsequent) devices, raw modes are handled somewhat differently. The "packed" modes will give you pixel values that are compressed with a visually lossless compression scheme into 8 bits, therefore using only 1 byte per pixel. +Delivers a second, lower-resolution image stream from the camera, scaled down to the specified dimensions. -"Unpacked" modes on a Pi 5 will be interpreted as a request for uncompressed and unpacked pixels, again using 16 bits per pixel. However, in contrast to the Pi 4, these values are zero-padded at the least significant end. This means they will use the full 16-bit dynamic range, whatever pixel depth the sensor was delivering. +Each accepts a single number defining the dimensions, in pixels, of the lower-resolution stream. -In both cases, users wishing to access the pixel values themselves are advised to use the unpacked formats, as these are much easier to manipulate. +Available for preview and video modes. Not available for still captures. If you specify a aspect ratio different from the normal resolution stream, generates non-square pixels. -* `4056:3040:12:P` - 4056×3040 resolution, 12 bits per pixel, packed. On a Pi 4 (or earlier devices), the raw image buffers will be packed so that 2 pixel values occupy only 3 bytes. On a Pi 5 the pixels will be compressed to 1 byte per pixel. -* `1632:1224:10` - 1632×1224 resolution, 10 bits per pixel. It will default to packed. A 10-bit packed mode would store 4 pixels in every 5 bytes on a Pi 4, or 1 byte per pixel (compressed) on a Pi 5. -* `2592:1944:10:U` - 2592×1944 resolution, 10 bits per pixel, unpacked. An unpacked format will store every pixel in 2 bytes. On a Pi 4 the top 6 bits of each value will be zero, but on a Pi 5 the bottom 6 bits of each value will be zero. -* `3264:2448` - 3264×2448 resolution. It will try to select the default 12-bit mode, but in the case of the v2 camera there isn't one, so a 10-bit mode would be chosen instead. +For `rpicam-vid`, disables extra colour-denoise processing. -The `--mode` option affects the mode choice for video recording and stills capture. To control the mode choice during the preview phase prior to stills capture, use the `--viewfinder-mode` option. ----- - --viewfinder-mode Specify sensor mode, given as ::: ----- +Useful for image analysis when combined with xref:camera_software.adoc#post-processing-with-rpicam-apps[image post-processing]. -This option is identical to the `--mode` option except that it applies only during the preview phase of stills capture (also used by the `rpicam-hello` application). +==== `hflip` ----- - --lores-width Low-resolution image width - --lores-height Low-resolution image height ----- +Flips the image horizontally. Does not accept a value. -`libcamera` allows the possibility of delivering a second, lower-resolution image stream from the camera system to the application. This stream is available in both the preview and the video modes (i.e. `rpicam-hello` and the preview phase of `rpicam-still`, and `rpicam-vid`), and can be used, among other things, for image analysis. For stills captures, the low-resolution image stream is not available. +==== `vflip` -The low-resolution stream has the same field of view as the other image streams. If a different aspect ratio is specified for the low-resolution stream, then those images will be squashed so that the pixels are no longer square. +Flips the image vertically. Does not accept a value. -During video recording (`rpicam-vid`), specifying a low-resolution stream will disable some extra colour-denoise processing that would normally occur. +==== `rotation` -Example: `rpicam-hello --lores-width 224 --lores-height 224` +Rotates the image extracted from the sensor. Accepts only the values 0 or 180. -Note that the low-resolution stream is not particularly useful unless used in conjunction with xref:camera_software.adoc#post-processing[image post-processing]. +==== `roi` ----- - --hflip Read out with horizontal mirror - --vflip Read out with vertical flip - --rotation Use hflip and vflip to create the given rotation ----- +Crops the image extracted from the full field of the sensor. Accepts four decimal values, _ranged 0 to 1_, in the following format: `,,,h>`. Each of these values represents a percentage of the available width and heights as a decimal between 0 and 1. -These options affect the order of read-out from the sensor, and can be used to mirror the image horizontally, and/or flip it vertically. The `--rotation` option permits only the value 0 or 180, so note that 90 or 270 degree rotations are not supported. Moreover, `--rotation 180` is identical to `--hflip --vflip`. +These values define the following proportions: -Example: `rpicam-hello --vflip --hflip` +* ``: X coordinates to skip before extracting an image +* ``: Y coordinates to skip before extracting an image +* ``: image width to extract +* ``: image height to extract ----- - --roi Select a crop (region of interest) from the camera ----- +Defaults to `0,0,1,1` (starts at the first X coordinate and the first Y coordinate, uses 100% of the image width, uses 100% of the image height). -The `--roi` (region of interest) option allows the user to select a particular crop from the full field of view provided by the sensor. The coordinates are specified as a proportion of the available field of view, so `--roi 0,0,1,1` would have no effect at all. +Examples: -The `--roi` parameter implements what is commonly referred to as "digital zoom". +* `rpicam-hello --roi 0.25,0.25,0.5,0.5` selects exactly a half of the total number of pixels cropped from the centre of the image (skips the first 25% of X coordinates, skips the first 25% of Y coordinates, uses 50% of the total image width, uses 50% of the total image height). +* `rpicam-hello --roi 0,0,0.25,0.25` selects exactly a quarter of the total number of pixels cropped from the top left of the image (skips the first 0% of X coordinates, skips the first 0% of Y coordinates, uses 25% of the image width, uses 25% of the image height). -Example `rpicam-hello --roi 0.25,0.25,0.5,0.5` will select exactly a quarter of the total number of pixels cropped from the centre of the image. +==== `hdr` ----- - --hdr Run the camera in HDR mode ----- +Default value: `off` -The `--hdr` option causes the camera to be run in the HDR (High Dynamic Range) mode given by ``. On Pi 4 and earlier devices, this option only works for certain supported cameras, including the _Raspberry Pi Camera Module 3_, and on Pi 5 devices it can be used with all cameras. `` may take the following values: +Runs the camera in HDR mode. If passed without a value, assumes `auto`. Accepts one of the following values: -* `off` - HDR is disabled. This is the default value if the `--hdr` option is omitted entirely. -* `auto` - If the sensor supports HDR, then the on-sensor HDR mode is enabled. Otherwise, on Pi 5 devices, the Pi 5's on-chip HDR mode will be enabled. On a Pi 4 or earlier device, HDR will be disabled if the sensor does not support it. This mode will be applied if the `--hdr` option is supplied without a `` value. -* `single-exp` - On a Pi 5, the on-chip HDR mode will be enabled, even if the sensor itself supports HDR. On earlier devices, HDR (even on-sensor HDR) will be disabled. +* `off` - Disables HDR. +* `auto` - Enables HDR on supported devices. Uses the sensor's built-in HDR mode if available. If the sensor lacks a built-in HDR mode, uses on-board HDR mode, if available. +* `single-exp` - Uses on-board HDR mode, if available, even if the sensor has a built-in HDR mode. If on-board HDR mode is not available, disables HDR. -Example: `rpicam-still --hdr -o hdr.jpg` for capturing a still image, or `rpicam-vid --hdr -o hdr.h264` to capture a video. +Raspberry Pi 5 and later devices have an on-board HDR mode. -When sensors support on-sensor HDR, use of this option may cause different camera modes to be available. This can be checked by comparing the output of `rpicam-hello --list-cameras` with `rpicam-hello --hdr sensor --list-cameras`. +To check for built-in HDR modes in a sensor, pass this option in addition to xref:camera_software.adoc#list-cameras[`list-cameras`]. -NOTE: For the _Raspberry Pi Camera Module 3_, the non-HDR modes include the usual full-resolution (12MP) mode as well as its half-resolution 2×2 binned (3MP) equivalent. In the case of HDR, only a single half-resolution (3MP) mode is available, and it is not possible to switch between HDR and non-HDR modes without restarting the camera application. +=== Camera control options -==== Camera control +The following options control image processing and algorithms that affect camera image quality. -The following options affect the image processing and control algorithms that affect the camera image quality. +==== `sharpness` ----- - --sharpness Set image sharpness ----- +Sets image sharpness. Accepts a numeric value along the following spectrum: -The given `` adjusts the image sharpness. The value zero means that no sharpening is applied, the value 1.0 uses the default amount of sharpening, and values greater than 1.0 use extra sharpening. +* `0.0` applies no sharpening +* values greater than `0.0`, but less than `1.0` apply less than the default amount of sharpening +* `1.0` applies the default amount of sharpening +* values greater than `1.0` apply extra sharpening -Example: `rpicam-still -o test.jpg --sharpness 2.0` +==== `contrast` ----- - --contrast Set image contrast ----- +Specifies the image contrast. Accepts a numeric value along the following spectrum: -The given `` adjusts the image contrast. The value zero produces minimum contrast, the value 1.0 uses the default amount of contrast, and values greater than 1.0 apply extra contrast. +* `0.0` applies minimum contrast +* values greater than `0.0`, but less than `1.0` apply less than the default amount of contrast +* `1.0` applies the default amount of contrast +* values greater than `1.0` apply extra contrast -Example: `rpicam-still -o test.jpg --contrast 1.5` ----- - --brightness Set image brightness ----- +==== `brightness` -The given `` adjusts the image brightness. The value -1.0 produces an (almost) black image, the value 1.0 produces an almost entirely white image and the value 0.0 produces standard image brightness. +Specifies the image brightness, added as an offset to all pixels in the output image. Accepts a numeric value along the following spectrum: -Note that the brightness parameter adds (or subtracts) an offset from all pixels in the output image. The `--ev` option is often more appropriate. +* `-1.0` applies minimum brightness (black) +* `0.0` applies standard brightness +* `1.0` applies maximum brightness (white) -Example: `rpicam-still -o test.jpg --brightness 0.2` +For many use cases, prefer xref:camera_software.adoc#ev[`ev`]. ----- - --saturation Set image colour saturation ----- +==== `saturation` -The given `` adjusts the colour saturation. The value zero produces a greyscale image, the value 1.0 uses the default amount of sautration, and values greater than 1.0 apply extra colour saturation. +Specifies the image colour saturation. Accepts a numeric value along the following spectrum: -Example: `rpicam-still -o test.jpg --saturation 0.8` +* `0.0` applies minimum saturation (grayscale) +* values greater than `0.0`, but less than `1.0` apply less than the default amount of saturation +* `1.0` applies the default amount of saturation +* values greater than `1.0` apply extra saturation ----- - --ev Set EV compensation ----- +==== `ev` -Sets the EV compensation of the image in units of stops, in the range -10 to 10. Default is 0. It works by raising or lowering the target values the AEC/AGC algorithm is attempting to match. +Specifies the https://en.wikipedia.org/wiki/Exposure_value[exposure value (EV)] compensation of the image in stops. Accepts a numeric value that controls target values passed to the Automatic Exposure/Gain Control (AEC/AGC) processing algorithm along the following spectrum: -Example: `rpicam-still -o test.jpg --ev 0.3` +* `-10.0` applies minimum target values +* `0.0` applies standard target values +* `10.0` applies maximum target values ----- - --shutter Set the exposure time in microseconds ----- +==== `shutter` -The shutter time is fixed to the given value. The gain will still be allowed to vary (unless that is also fixed). +Specifies the exposure time, using the shutter, in _microseconds_. Gain can still vary when you use this option. If the camera runs at a framerate so fast it does not allow for the specified exposure time (for instance, a framerate of 1fps and an exposure time of 10000 microseconds), the sensor will use the maximum exposure time allowed by the framerate. -Note that this shutter time may not be achieved if the camera is running at a frame rate that is too fast to allow it. In this case the `--framerate` option may be used to lower the frame rate. See the xref:../accessories/camera.adoc#hardware-specification[maximum possible shutter times] for the official Raspberry Pi cameras. +For a list of minimum and maximum shutter times for official cameras, see the xref:../accessories/camera.adoc#hardware-specification[camera hardware documentation]. Values above the maximum result in undefined behaviour. -Using values above these maximums will result in undefined behaviour. Cameras will also have different minimum shutter times, though in practice this is not important, as they are all low enough to expose bright scenes appropriately. +==== `gain` -Example: `rpicam-hello --shutter 30000` +Alias: `--analoggain` ----- - --gain Sets the combined analogue and digital gains - --analoggain Synonym for --gain ----- +Sets the combined analogue and digital gain. When the sensor driver can provide the requested gain, only uses analogue gain. When analogue gain reaches the maximum value, the ISP applies digital gain. Accepts a numeric value. -These two options are actually identical, and set the combined analogue and digital gains that will be used. The `--analoggain` form is permitted so as to be more compatible with the legacy `raspicam` applications. Where the requested gain can be supplied by the sensor driver, then only analogue gain will be used. Once the analogue gain reaches the maximum permitted value, then extra gain beyond this will be supplied as digital gain. +For a list of analogue gain limits, for official cameras, see the xref:../accessories/camera.adoc#hardware-specification[camera hardware documentation]. -Note that there are circumstances where the digital gain can go above 1 even when the analogue gain limit is not exceeded. This can occur when: +Sometimes, digital gain can exceed 1.0 even when the analogue gain limit is not exceeded. This can occur in the following situations: -* Either of the colour gains goes below 1.0, which will cause the digital gain to settle to 1.0/min(red_gain,blue_gain). This means that the total digital gain being applied to any colour channel does not go below 1.0, as this would cause discolouration artifacts. -* The digital gain can vary slightly while the AEC/AGC changes, though this effect should be only transient. +* Either of the colour gains drops below 1.0, which will cause the digital gain to settle to 1.0/min(red_gain,blue_gain). This keeps the total digital gain applied to any colour channel above 1.0 to avoid discolouration artefacts. +* Slight variances during Automatic Exposure/Gain Control (AEC/AGC) changes. ----- - --metering Set the metering mode ----- +==== `metering` + +Default value: `centre` -Sets the metering mode of the AEC/AGC algorithm. This may one of the following values: +Sets the metering mode of the Automatic Exposure/Gain Control (AEC/AGC) algorithm. Accepts the following values: -* `centre` - centre weighted metering (which is the default) +* `centre` - centre weighted metering * `spot` - spot metering * `average` - average or whole frame metering -* `custom` - custom metering mode which needs to be defined in the camera tuning file +* `custom` - custom metering mode defined in the camera tuning file -For more information on defining a custom metering mode, and also on how to adjust the region weights in the existing metering modes, please refer to the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Tuning guide for the Raspberry Pi cameras and libcamera]. +For more information on defining a custom metering mode, and adjusting region weights in existing metering modes, see the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Tuning guide for the Raspberry Pi cameras and libcamera]. -Example: `rpicam-still -o test.jpg --metering spot` +==== `exposure` ----- - --exposure Set the exposure profile ----- +Sets the exposure profile. Changing the exposure profile should not affect the image exposure. Instead, different modes adjust gain settings to achieve the same net result. Accepts the following values: -The exposure profile may be either `normal`, `sport` or `long`. Changing the exposure profile should not affect the overall exposure of an image, but the `sport` mode will tend to prefer shorter exposure times and larger gains to achieve the same net result. +* `sport`: short exposure, larger gains +* `normal`: normal exposure, normal gains +* `long`: long exposure, smaller gains -Exposure profiles can be edited in the camera tuning file. Please refer to the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Tuning guide for the Raspberry Pi cameras and libcamera] for more information. +You can edit exposure profiles using tuning files. For more information, see the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Tuning guide for the Raspberry Pi cameras and libcamera]. -Example: `rpicam-still -o test.jpg --exposure sport` - ----- - --awb Set the AWB mode ----- +==== `awb` -This option sets the AWB algorithm into the named AWB mode. Valid modes are: +Sets the Auto White Balance (AWB) mode. Accepts the following values: |=== -| Mode name | Colour temperature +| Mode name | Colour temperature range -| auto +| `auto` | 2500K to 8000K -| incandescent +| `incandescent` | 2500K to 3000K -| tungsten +| `tungsten` | 3000K to 3500K -| fluorescent +| `fluorescent` | 4000K to 4700K -| indoor +| `indoor` | 3000K to 5000K -| daylight +| `daylight` | 5500K to 6500K -| cloudy +| `cloudy` | 7000K to 8500K -| custom -| A custom range would have to be defined in the camera tuning file. +| `custom` +| A custom range defined in the tuning file. |=== -There is no mode that turns the AWB off, instead fixed colour gains should be specified with the `--awbgains` option. +These values are only approximate: values could vary according to the camera tuning. -Note that these values are only approximate, the values could vary according to the camera tuning. +No mode fully disables AWB. Instead, you can fix colour gains with xref:camera_software.adoc#awbgains[`awbgains`]. -For more information on AWB modes and how to define a custom one, please refer to the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Tuning guide for the Raspberry Pi cameras and libcamera]. +For more information on AWB modes, including how to define a custom one, see the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Tuning guide for the Raspberry Pi cameras and libcamera]. -Example: `rpicam-still -o test.jpg --awb tungsten` +==== `awbgains` ----- - --awbgains Set fixed colour gains ----- +Sets a fixed red and blue gain value to be used instead of an Auto White Balance (AWB) algorithm. Set non-zero values to disable AWB. Accepts comma-separated numeric input in the following format: `,` -This option accepts a red and a blue gain value and uses them directly in place of running the AWB algorithm. Setting non-zero values here has the effect of disabling the AWB calculation. +==== `denoise` -Example: `rpicam-still -o test.jpg --awbgains 1.5,2.0` +Default value: `auto` ----- - --denoise Set the denoising mode ----- +Sets the denoising mode. Accepts the following values: -The following denoise modes are supported: +* `auto`: Enables standard spatial denoise. Uses extra-fast colour denoise for video, and high-quality colour denoise for images. Enables no extra colour denoise in the preview window. -* `auto` - This is the default. It always enables standard spatial denoise. It uses extra-fast colour denoise for video, and high-quality colour denoise for stills capture. Preview does not enable any extra colour denoise at all. +* `off`: Disables spatial and colour denoise. -* `off` - Disables spatial and colour denoise. +* `cdn_off`: Disables colour denoise. -* `cdn_off` - Disables colour denoise. +* `cdn_fast`: Uses fast colour denoise. -* `cdn_fast` - Uses fast colour denoise. +* `cdn_hq`: Uses high-quality colour denoise. Not appropriate for video/viewfinder due to reduced throughput. -* `cdn_hq` - Uses high-quality colour denoise. Not appropriate for video/viewfinder due to reduced throughput. +Even fast colour denoise can lower framerates. High quality colour denoise _significantly_ lowers framerates. -Note that even the use of fast colour denoise can result in lower framerates. The high quality colour denoise will normally result in much lower framerates. +==== `tuning-file` -Example: `rpicam-vid -o test.h264 --denoise cdn_off` +Specifies the camera tuning file. The tuning file allows you to control many aspects of image processing, including the Automatic Exposure/Gain Control (AEC/AGC), Auto White Balance (AWB), colour shading correction, colour processing, denoising and more. Accepts a tuning file path as input. ----- - --tuning-file Specify the camera tuning to use ----- +For more information about tuning files, see xref:camera_software.adoc#tuning-files[Tuning Files]. -This identifies the name of the JSON format tuning file that should be used. The tuning file covers many aspects of the image processing, including the AEC/AGC, AWB, colour shading correction, colour processing, denoising and so forth. +==== `autofocus-mode` -For more information on the camera tuning file, please consult the https://datasheets.raspberrypi.com/camera/raspberry-pi-camera-guide.pdf[Tuning guide for the Raspberry Pi cameras and libcamera]. +Default value: `default` -Example: `rpicam-hello --tuning-file ~/my-camera-tuning.json` +Specifies the autofocus mode. Accepts the following values: ----- - --autofocus-mode Specify the autofocus mode ----- +* `default`: puts the camera into continuous autofocus mode unless xref:camera_software.adoc#lens-position[`lens-position`] or xref:camera_software.adoc#autofocus-on-capture[`autofocus-on-capture`] override the mode to manual +* `manual`: does not move the lens at all unless manually configured with xref:camera_software.adoc#lens-position[`lens-position`] +* `auto`: only moves the lens for an autofocus sweep when the camera starts or just before capture if xref:camera_software.adoc#autofocus-on-capture[`autofocus-on-capture`] is also used +* `continuous`: adjusts the lens position automatically as the scene changes + +This option is only supported for certain camera modules. + +==== `autofocus-range` -Specifies the autofocus mode to use, which may be one of: +Default value: `normal` -* `default` (also the default if the option is omitted) - normally puts the camera into continuous autofocus mode, except if either `--lens-position` or `--autofocus-on-capture` is given, in which case manual mode is chosen instead -* `manual` - do not move the lens at all, but it can be set with the `--lens-position` option -* `auto` - does not move the lens except for an autofocus sweep when the camera starts (and for `rpicam-still`, just before capture if `--autofocus-on-capture` is given) -* `continuous` - adjusts the lens position automatically as the scene changes +Specifies the autofocus range. Accepts the following values: + +* `normal`: focuses from reasonably close to infinity +* `macro`: focuses only on close objects, including the closest focal distances supported by the camera +* `full`: focus on the entire range, from the very closest objects to infinity This option is only supported for certain camera modules. ----- - --autofocus-range Specify the autofocus range ----- +==== `autofocus-speed` -Specifies the autofocus range, which may be one of +Default value: `normal` -* `normal` (the default) - focuses from reasonably close to infinity -* `macro` - focuses only on close objects, including the closest focal distances supported by the camera -* `full` - will focus on the entire range, from the very closest objects to infinity +Specifies the autofocus speed. Accepts the following values: + +* `normal`: changes the lens position at normal speed +* `fast`: changes the lens position quickly This option is only supported for certain camera modules. ----- - --autofocus-speed Specify the autofocus speed ----- +==== `autofocus-window` -Specifies the autofocus speed, which may be one of: +Specifies the autofocus window within the full field of the sensor. Accepts four decimal values, _ranged 0 to 1_, in the following format: `,,,h>`. Each of these values represents a percentage of the available width and heights as a decimal between 0 and 1. -* `normal` (the default) - the lens position will change at the normal speed -* `fast` - the lens position may change more quickly +These values define the following proportions: -This option is only supported for certain camera modules. +* ``: X coordinates to skip before applying autofocus +* ``: Y coordinates to skip before applying autofocus +* ``: autofocus area width +* ``: autofocus area height ----- - --autofocus-window Specify the autofocus window ----- +The default value uses the middle third of the output image in both dimensions (1/9 of the total image area). -Specifies the autofocus window, in the form `x,y,width,height` where the coordinates are given as a proportion of the entire image. For example, `--autofocus-window 0.25,0.25,0.5,0.5` would choose a window that is half the size of the output image in each dimension, and centred in the middle. +Examples: -The default value causes the algorithm to use the middle third of the output image in both dimensions (so 1/9 of the total image area). +* `rpicam-hello --autofocus-window 0.25,0.25,0.5,0.5` selects exactly half of the total number of pixels cropped from the centre of the image (skips the first 25% of X coordinates, skips the first 25% of Y coordinates, uses 50% of the total image width, uses 50% of the total image height). +* `rpicam-hello --autofocus-window 0,0,0.25,0.25` selects exactly a quarter of the total number of pixels cropped from the top left of the image (skips the first 0% of X coordinates, skips the first 0% of Y coordinates, uses 25% of the image width, uses 25% of the image height). This option is only supported for certain camera modules. ----- - --lens-position Set the lens to a given position ----- +==== `lens-position` -Moves the lens to a fixed focal distance, normally given in dioptres (units of 1 / _distance in metres_). +Default value: `default` -* 0.0 will move the lens to the "infinity" position -* Any other `number`: move the lens to the 1 / `number` position, so the value 2 would focus at approximately 0.5m -* `default` - move the lens to a default position which corresponds to the hyperfocal position of the lens +Moves the lens to a fixed focal distance, normally given in dioptres (units of 1 / _distance in metres_). Accepts the following spectrum of values: -It should be noted that lenses can only be expected to be calibrated approximately, and there may well be variation between different camera modules. +* `0.0`: moves the lens to the "infinity" position +* Any other `number`: moves the lens to the 1 / `number` position. For example, the value `2.0` would focus at approximately 0.5m +* `default`: move the lens to a default position which corresponds to the hyperfocal position of the lens ----- - --verbose, -v Set verbosity level. ----- +Lens calibration is imperfect, so different camera modules of the same model may vary. -Level 0 is no output, 1 is default, 2 is verbose. +==== `verbose` -Example: `rpicam-vid -o test.h264 --verbose 2` +Alias: `-v` +Default value: `1` -==== Output file options +Sets the verbosity level. Accepts the following values: ----- - --output, -o Output file name ----- +* `0`: no output +* `1`: normal output +* `2`: verbose output + +=== Output file options -`--output` sets the name of the output file to which the output image or video is written. Besides regular file names, this may take the following special values: +==== `output` -* `-` - write to stdout. -* `udp://` - a string starting with this is taken as a network address for streaming. -* `tcp://` - a string starting with this is taken as a network address for streaming. -* a string containing a `%d` directive is taken as a file name where the format directive is replaced with a count that increments for each file that is opened. Standard C format directive modifiers are permitted. +Alias: `-o` + +Sets the name of the file used to record images or video. Besides plaintext file names, accepts the following special values: + +* `-`: write to stdout. +* `udp://` (prefix): a network address for UDP streaming. +* `tcp://` (prefix): a network address for TCP streaming. +* Include the `%d` directive in the file name to replace the directive with a count that increments for each opened file. This directive supports standard C format directive modifiers. Examples: -`rpicam-vid -t 100000 --segment 10000 -o chunk%04d.h264` records a 100 second file in 10 second segments, where each file is named `chunk.h264` but with the inclusion of an incrementing counter. Note that `%04d` writes the count to a string, but padded up to a total width of at least four characters by adding leading zeroes. +* `rpicam-vid -t 100000 --segment 10000 -o chunk%04d.h264` records a 100 second file in 10 second segments, where each file includes an incrementing four-digit counter padded with leading zeros: e.g. `chunk0001.h264`, `chunk0002.h264`, etc. -`rpicam-vid -t 0 --inline -o udp://192.168.1.13:5000` stream H.264 video to network address 192.168.1.13 on port 5000. +* `rpicam-vid -t 0 --inline -o udp://192.168.1.13:5000` streams H.264 video to network address 192.168.1.13 using UDP on port 5000. ----- - --wrap Wrap output file counter at ----- +==== `wrap` -When outputting to files with an incrementing counter (e.g. `%d` in the output file name), wrap the counter back to zero when it reaches this value. +Sets a maximum value for the counter used by the xref:camera_software.adoc#output[`output`] `%d` directive. The counter resets to zero after reaching this value. Accepts a numeric value. -Example: `rpicam-vid -t 0 --codec mjpeg --segment 1 --wrap 100 -o image%d.jpg` +==== `flush` ----- - --flush Flush output files immediately ----- +Flushes output files to disk as soon as a frame finishes writing, instead of waiting for the system to handle it. Does not accept a value. + +==== `post-process-file` + +Specifies a JSON file that configures the post-processing applied by the imaging pipeline. This applies to camera images _before_ they reach the application. This works similarly to the legacy `raspicam` "image effects". Accepts a file name path as input. + +Post-processing is a large topic and admits the use of third-party software like OpenCV and TensorFlowLite to analyse and manipulate images. For more information, see xref:camera_software.adoc#post-processing-with-rpicam-apps[post-processing]. + +==== `buffer-count` + +The number of buffers to allocate for still image capture or for video recording. The default value of zero lets each application choose a reasonable number for its own use case (1 for still image capture, and 6 for video recording). Increasing the number can sometimes help to reduce the number of frame drops, particularly at higher framerates. + +==== `viewfinder-buffer-count` + +As the `buffer-count` option, but applies when running in preview mode (that is `rpicam-hello` or the preview, not capture, phase of `rpicam-still`). + +==== `metadata` + +Save captured image metadata to a file or `-` for stdout. The fields in the metadata output will depend on the camera model in use. + +See also `metadata-format`. -`--flush` causes output files to be flushed to disk as soon as every frame is written, rather than waiting for the system to do it. +==== `metadata-format` -Example: `rpicam-vid -t 10000 --flush -o test.h264` +Format to save the metadata in. Accepts the following values: -==== Post-processing options +* `txt` for text format +* `json` for JSON format -The `--post-process-file` option specifies a JSON file that configures the post-processing that the imaging pipeline applies to camera images before they reach the application. It can be thought of as a replacement for the legacy `raspicam` "image effects". +In text format, each line will have the form -Post-processing is a large topic and admits the use of third-party software like OpenCV and TensorFlowLite to analyse and manipulate images. For more information, please refer to the section on xref:camera_software.adoc#post-processing[post-processing]. + key=value -Example: `rpicam-hello --post-process-file negate.json` +In JSON format, the output is a JSON object. -This might apply a "negate" effect to an image, if the file `negate.json` is appropriately configured. +This option does nothing unless `--metadata` is also specified. diff --git a/documentation/asciidoc/computers/camera/rpicam_options_detect.adoc b/documentation/asciidoc/computers/camera/rpicam_options_detect.adoc new file mode 100644 index 000000000..298116505 --- /dev/null +++ b/documentation/asciidoc/computers/camera/rpicam_options_detect.adoc @@ -0,0 +1,15 @@ +=== Detection options + +The command line options specified in this section apply only to object detection using `rpicam-detect`. + +To pass one of the following options to `rpicam-detect`, prefix the option name with `--`. If the option requires a value, pass the value immediately after the option name, separated by a single space. If the value contains a space, surround the value in quotes. + +Some options have shorthand aliases, for example `-h` instead of `--help`. Use these shorthand aliases instead of the full option name to save space and time at the expense of readability. + +==== `object` + +Detects objects with the given name, sourced from the model's label file. Accepts a plaintext file name as input. + +==== `gap` + +Wait at least this many frames between captures. Accepts numeric values. diff --git a/documentation/asciidoc/computers/camera/rpicam_options_libav.adoc b/documentation/asciidoc/computers/camera/rpicam_options_libav.adoc new file mode 100644 index 000000000..3b1f2ce19 --- /dev/null +++ b/documentation/asciidoc/computers/camera/rpicam_options_libav.adoc @@ -0,0 +1,65 @@ +=== `libav` options + +The command line options specified in this section apply only to `libav` video backend. + +To enable the `libav` backend, pass the xref:camera_software.adoc#codec[`codec`] option the value `libav`. + +To pass one of the following options to an application, prefix the option name with `--`. If the option requires a value, pass the value immediately after the option name, separated by a single space. If the value contains a space, surround the value in quotes. + +Some options have shorthand aliases, for example `-h` instead of `--help`. Use these shorthand aliases instead of the full option name to save space and time at the expense of readability. + +==== `libav-format` + +Sets the `libav` output format. Accepts the following values: + +* `mkv` encoding +* `mp4` encoding +* `avi` encoding +* `h264` streaming +* `mpegts` streaming + +If you do not provide this option, the file extension passed to the xref:camera_software.adoc#output[`output`] option determines the file format. + +==== `libav-audio` + +Enables audio recording. When enabled, you must also specify an xref:camera_software.adoc#audio-codec[`audio-codec`]. Does not accept a value. + +==== `audio-codec` + +Default value: `aac` + +Selects an audio codec for output. For a list of available codecs, run `ffmpeg -codecs`. + +==== `audio-bitrate` + +Sets the bitrate for audio encoding in bits per second. Accepts numeric input. + +Example: `rpicam-vid --codec libav -o test.mp4 --audio_codec mp2 --audio-bitrate 16384` (Records audio at 16 kilobits/sec with the mp2 codec) + +==== `audio-samplerate` + +Default value: `0` + +Sets the audio sampling rate in Hz. Accepts numeric input. `0` uses the input sample rate. + +==== `audio-device` + +Select an ALSA input device for audio recording. For a list of available devices, run the following command: + +[source,console] +---- +$ pactl list | grep -A2 'Source #' | grep 'Name: ' +---- + +You should see output similar to the following: + +---- +Name: alsa_output.platform-bcm2835_audio.analog-stereo.monitor +Name: alsa_output.platform-fef00700.hdmi.hdmi-stereo.monitor +Name: alsa_output.usb-GN_Netcom_A_S_Jabra_EVOLVE_LINK_000736B1214E0A-00.analog-stereo.monitor +Name: alsa_input.usb-GN_Netcom_A_S_Jabra_EVOLVE_LINK_000736B1214E0A-00.mono-fallback +---- + +==== `av-sync` + +Shifts the audio sample timestamp by a value in microseconds. Accepts positive and negative numeric values. diff --git a/documentation/asciidoc/computers/camera/rpicam_options_still.adoc b/documentation/asciidoc/computers/camera/rpicam_options_still.adoc index 7bd697532..4e20880dc 100644 --- a/documentation/asciidoc/computers/camera/rpicam_options_still.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_options_still.adoc @@ -1,148 +1,126 @@ -=== Still command line options +=== Image options ----- - --quality, -q JPEG quality ----- +The command line options specified in this section apply only to still image output. -Set the JPEG quality. Maximum quality is 100, and 93 is the default. Only applies when saving JPEG files. +To pass one of the following options to an application, prefix the option name with `--`. If the option requires a value, pass the value immediately after the option name, separated by a single space. If the value contains a space, surround the value in quotes. -Example: `rpicam-jpeg -o test.jpg -q 80` +Some options have shorthand aliases, for example `-h` instead of `--help`. Use these shorthand aliases instead of the full option name to save space and time at the expense of readability. ----- - --exif, -x Add extra EXIF tags ----- +==== `quality` -The extra EXIF tags are saved in the JPEG file. Only applies when saving JPEG files. +Alias: `-q` -EXIF is supported using the `libexif` library, so there are some associated limitations. In particular, `libexif` seems to recognise a number of tags, but without knowing the correct format for them. The software will currently treat these (incorrectly, in many cases) as ASCII, but will print a warning to the terminal. As we come across these they can be added to the table of known exceptions in the software. +Default value: `93` -The application needs to supply EXIF tags that contain specific camera data (like the exposure time). But for other tags that have nothing to do with the camera, a reasonable workaround would simply be to add them _post facto_, using something like `exiftool`. +Sets the JPEG quality. Accepts a value between `1` and `100`. -Example: `rpicam-still -o test.jpg --exif IDO0.Artist=Someone` +==== `exif` + +Saves extra EXIF tags in the JPEG output file. Only applies to JPEG output. Because of limitations in the `libexif` library, many tags are currently (incorrectly) formatted as ASCII and print a warning in the terminal. ----- - --timelapse Time interval between timelapse captures ----- +This option is necessary to add certain EXIF tags related to camera settings. You can add tags unrelated to camera settings to the output JPEG after recording with https://exiftool.org/[ExifTool]. + +Example: `rpicam-still -o test.jpg --exif IDO0.Artist=Someone` -This puts `rpicam-still` into timelapse mode, where it runs according to the timeout (`--timeout` or `-t`) that has been set, and for that period will capture repeated images at the interval specified here. (`rpicam-still` only.) +==== `timelapse` -Example: `rpicam-still -t 100000 -o test%d.jpg --timelapse 10000` captures an image every 10s for about 100s. +Records images at the specified interval. Accepts an interval in milliseconds. Combine this setting with xref:camera_software.adoc#timeout[`timeout`] to capture repeated images over time. ----- - --framestart The starting value for the frame counter ----- +You can specify separate filenames for each output file using string formatting, e.g. `--output test%d.jpg`. -When writing counter values into the output file name, this specifies the starting value for the counter. +Example: `rpicam-still -t 100000 -o test%d.jpg --timelapse 10000` captures an image every 10 seconds for 100 seconds. -Example: `rpicam-still -t 100000 -o test%d.jpg --timelapse 10000 --framestart 1` captures an image every 10s for about 100s, starting at 1 rather than 0. (`rpicam-still` only.) +==== `framestart` ----- - --datetime Use date format for the output file names ----- +Configures a starting value for the frame counter accessed in output file names as `%d`. Accepts an integer starting value. -Use the current date and time to construct the output file name, in the form MMDDhhmmss.jpg, where MM = 2-digit month number, DD = 2-digit day number, hh = 2-digit 24-hour hour number, mm = 2-digit minute number, ss = 2-digit second number. (`rpicam-still` only.) +==== `datetime` -Example: `rpicam-still --datetime` +Uses the current date and time in the output file name, in the form `MMDDhhmmss.jpg`: ----- - --timestamp Use system timestamps for the output file names ----- +* `MM` = 2-digit month number +* `DD` = 2-digit day number +* `hh` = 2-digit 24-hour hour number +* `mm` = 2-digit minute number +* `ss` = 2-digit second number -Uses the current system timestamp (the number of seconds since the start of 1970) as the output file name. (`rpicam-still` only.) +Does not accept a value. -Example: `rpicam-still --timestamp` +==== `timestamp` ----- - --restart Set the JPEG restart interval ----- +Uses the current system https://en.wikipedia.org/wiki/Unix_time[Unix time] as the output file name. Does not accept a value. -Sets the JPEG restart interval to the given value. Default is zero. +==== `restart` -Example: `rpicam-still -o test.jpg --restart 20` +Default value: `0` ----- - --keypress, -k Capture image when Enter pressed ----- +Configures the restart marker interval for JPEG output. JPEG restart markers can help limit the impact of corruption on JPEG images, and additionally enable the use of multi-threaded JPEG encoding and decoding. Accepts an integer value. -This switches `rpicam-still` into keypress mode. It will capture a still image either when the timeout expires or the Enter key is pressed in the terminal window. Typing `x` and Enter causes `rpicam-still` to quit without capturing. +==== `immediate` -Example: `rpicam-still -t 0 -o test.jpg -k` +Captures the image immediately when the application runs. ----- - --signal, -s Capture image when SIGUSR1 received ----- +==== `keypress` -This switches `rpicam-still` into signal mode. It will capture a still image either when the timeout expires or when a SIGUSR1 is received. SIGUSR2 will cause `rpicam-still` to quit without capturing. +Alias: `-k` -Example: +Captures an image when the xref:camera_software.adoc#timeout[`timeout`] expires or on press of the *Enter* key, whichever comes first. Press the `x` key, then *Enter* to exit without capturing. Does not accept a value. -`rpicam-still -t 0 -o test.jpg -s &` +==== `signal` -then +Captures an image when the xref:camera_software.adoc#timeout[`timeout`] expires or when `SIGUSR1` is received. Use `SIGUSR2` to exit without capturing. Does not accept a value. -`kill -SIGUSR1 $!` +==== `thumb` ----- - --thumb Set thumbnail parameters or none ----- +Default value: `320:240:70` -Sets the dimensions and quality parameter of the associated thumbnail image. The defaults are size 320×240, and quality 70. +Configure the dimensions and quality of the thumbnail with the following format: `` (or `none`, which omits the thumbnail). -Example: `rpicam-still -o test.jpg --thumb 640:480:80` +==== `encoding` -The value `none` may be given, in which case no thumbnail is saved in the image at all. +Alias: `-e` ----- - --encoding, -e Set the still image codec ----- +Default value: `jpg` -Select the still image encoding to be used. Valid encoders are: +Sets the encoder to use for image output. Accepts the following values: -* `jpg` - JPEG (the default) -* `png` - PNG format -* `bmp` - BMP format +* `jpg` - JPEG +* `png` - PNG +* `bmp` - BMP * `rgb` - binary dump of uncompressed RGB pixels -* `yuv420` - binary dump of uncompressed YUV420 pixels. +* `yuv420` - binary dump of uncompressed YUV420 pixels -Note that this option determines the encoding and that the extension of the output file name is ignored for this purpose. However, for the `--datetime` and `--timestamp` options, the file extension is taken from the encoder name listed above. (`rpicam-still` only.) +This option always determines the encoding, overriding the extension passed to xref:camera_software.adoc#output[`output`]. -Example: `rpicam-still -e png -o test.png` +When using the xref:camera_software.adoc#datetime[`datetime`] and xref:camera_software.adoc#timestamp[`timestamp`] options, this option determines the output file extension. ----- - --raw, -r Save raw file ----- +==== `raw` -Save a raw Bayer file in DNG format alongside the usual output image. The file name is given by replacing the output file name extension by `.dng`. These are standard DNG files, and can be processed with standard tools like _dcraw_ or _RawTherapee_, among others. (`rpicam-still` only.) +Alias: `-r` -The image data in the raw file is exactly what came out of the sensor, with no processing whatsoever either by the ISP or anything else. The EXIF data saved in the file, among other things, includes: +Saves a raw Bayer file in DNG format in addition to the output image. Replaces the output file name extension with `.dng`. You can process these standard DNG files with tools like _dcraw_ or _RawTherapee_. Does not accept a value. + +The image data in the raw file is exactly what came out of the sensor, with no processing from the ISP or anything else. The EXIF data saved in the file, among other things, includes: * exposure time * analogue gain (the ISO tag is 100 times the analogue gain used) * white balance gains (which are the reciprocals of the "as shot neutral" values) * the colour matrix used by the ISP ----- - --latest Make symbolic link to latest file saved ----- - -This causes `rpicam-still` to make a symbolic link to the most recently saved file, thereby making it easier to identify. (`rpicam-still` only.) - -Example: `rpicam-still -t 100000 --timelapse 10000 -o test%d.jpg --latest latest.jpg` +==== `latest` ----- - --autofocus-on-capture Whether to run an autofocus cycle before capture ----- +Creates a symbolic link to the most recently saved file. Accepts a symbolic link name as input. -If set, this will cause an autofocus cycle to be run just before the image is captured. +==== `autofocus-on-capture` -If `--autofocus-mode` is not specified, or was set to `default` or `manual`, this will be the only autofocus cycle. +If set, runs an autofocus cycle _just before_ capturing an image. Interacts with the following xref:camera_software.adoc#autofocus-mode[`autofocus_mode`] values: -If `--autofocus-mode` was set to `auto`, there will be an additional autofocus cycle at the start of the preview window. +* `default` or `manual`: only runs the capture-time autofocus cycle. -If `--autofocus-mode` was set to `continuous`, this option will be ignored. +* `auto`: runs an additional autofocus cycle when the preview window loads. -You can also use `--autofocus-on-capture 1` in place of `--autofocus-on-capture`, and `--autofocus-on-capture 0` as an alternative to omitting the parameter entirely. +* `continuous`: ignores this option, instead continually focusing throughout the preview. -Example: `rpicam-still --autofocus-on-capture -o test.jpg` +Does not require a value, but you can pass `1` to enable and `0` to disable. Not passing a value is equivalent to passing `1`. -This option is only supported for certain camera modules (such as the _Raspberry Pi Camera Module 3_). +Only supported by some camera modules (such as the _Raspberry Pi Camera Module 3_). diff --git a/documentation/asciidoc/computers/camera/rpicam_options_vid.adoc b/documentation/asciidoc/computers/camera/rpicam_options_vid.adoc index 67c18ebd4..00ac1a258 100644 --- a/documentation/asciidoc/computers/camera/rpicam_options_vid.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_options_vid.adoc @@ -1,138 +1,141 @@ -=== Video command line options +=== Video options ----- - --quality, -q JPEG quality ----- +The command line options specified in this section apply only to video output. -Set the JPEG quality. The maximum quality is 100, and 50 is the default. Only applies when saving in MJPEG format. +To pass one of the following options to an application, prefix the option name with `--`. If the option requires a value, pass the value immediately after the option name, separated by a single space. If the value contains a space, surround the value in quotes. -Example: `rpicam-vid --codec mjpeg -o test.mjpeg -q 80` +Some options have shorthand aliases, for example `-h` instead of `--help`. Use these shorthand aliases instead of the full option name to save space and time at the expense of readability. ----- - --bitrate, -b H.264 bitrate ----- +==== `quality` + +Alias: `-q` + +Default value: `50` + +Accepts an MJPEG quality level between 1 and 100. Only applies to videos encoded in the MJPEG format. + +==== `bitrate` + +Alias: `-b` + +Controls the target bitrate used by the H.264 encoder in bits per second. Only applies to videos encoded in the H.264 format. Impacts the size of the output video. -Set the target bitrate for the H.264 encoder, in _bits per second_. Only applies when encoding in H.264 format. Example: `rpicam-vid -b 10000000 --width 1920 --height 1080 -o test.h264` ----- - --intra, -g Intra-frame period (H.264 only) ----- +==== `intra` -Sets the frequency of I (Intra) frames in the H.264 bitstream, as a number of frames. The default value is 60. +Alias: `-g` -Example: `rpicam-vid --intra 30 --width 1920 --height 1080 -o test.h264` +Default value: `60` ----- - --profile H.264 profile ----- +Sets the frequency of Iframes (intra frames) in the H.264 bitstream. Accepts a number of frames. Only applies to videos encoded in the H.264 format. -Set the H.264 profile. The value may be `baseline`, `main` or `high`. +==== `profile` -Example: `rpicam-vid --width 1920 --height 1080 --profile main -o test.h264` +Sets the H.264 profile. Accepts the following values: ----- - --level H.264 level ----- +* `baseline` +* `main` +* `high` -Set the H.264 level. The value may be `4`, `4.1` or `4.2`. +Only applies to videos encoded in the H.264 format. -Example: `rpicam-vid --width 1920 --height 1080 --level 4.1 -o test.h264` +==== `level` ----- - --codec Encoder to be used ----- +Sets the H.264 level. Accepts the following values: -This can select how the video frames are encoded. Valid options are: +* `4` +* `4.1` +* `4.2` -* h264 - use H.264 encoder (the default) -* mjpeg - use MJPEG encoder -* yuv420 - output uncompressed YUV420 frames. -* libav - use the libav backend to encode audio and video (see the xref:camera_software.adoc#libav-integration-with-rpicam-vid[libav section] for further details) +Only applies to videos encoded in the H.264 format. -Examples: +==== `codec` -`rpicam-vid -t 10000 --codec mjpeg -o test.mjpeg` +Sets the encoder to use for video output. Accepts the following values: -`rpicam-vid -t 10000 --codec yuv420 -o test.data` +* `h264` - use H.264 encoder (the default) +* `mjpeg` - use MJPEG encoder +* `yuv420` - output uncompressed YUV420 frames. +* `libav` - use the libav backend to encode audio and video (for more information, see xref:camera_software.adoc#libav-integration-with-rpicam-vid[`libav`]) ----- - --keypress, -k Toggle between recording and pausing ----- +==== `save-pts` + +WARNING: Raspberry Pi 5 does not support the `save-pts` option. Use `libav` to automatically generate timestamps for container formats instead. -Pressing Enter will toggle `rpicam-vid` between recording the video stream and not recording it (i.e. discarding it). The application starts off in the recording state, unless the `--initial` option specifies otherwise. Typing `x` and Enter causes `rpicam-vid` to quit. +Enables frame timestamp output, which allow you to convert the bitstream into a container format using a tool like `mkvmerge`. Accepts a plaintext file name for the timestamp output file. -Example: `rpicam-vid -t 0 -o test.h264 -k` +Example: `rpicam-vid -o test.h264 --save-pts timestamps.txt` +You can then use the following command to generate an MKV container file from the bitstream and timestamps file: + +[source,console] ---- - --signal, -s Toggle between recording and pausing when SIGUSR1 received +$ mkvmerge -o test.mkv --timecodes 0:timestamps.txt test.h264 ---- -The SIGUSR1 signal will toggle `rpicam-vid` between recording the video stream and not recording it (i.e. discarding it). The application starts off in the recording state, unless the `--initial` option specifies otherwise. SIGUSR2 causes `rpicam-vid` to quit. +==== `keypress` -Example: +Alias: `-k` -`rpicam-vid -t 0 -o test.h264 -s` +Allows the CLI to enable and disable video output using the *Enter* key. Always starts in the recording state unless specified otherwise with xref:camera_software.adoc#initial[`initial`]. Type the `x` key and press *Enter* to exit. Does not accept a value. -then +==== `signal` -`kill -SIGUSR1 $!` +Alias: `-s` ----- - --initial Start the application in the recording or paused state ----- +Allows the CLI to enable and disable video output using `SIGUSR1`. Use `SIGUSR2` to exit. Always starts in the recording state unless specified otherwise with xref:camera_software.adoc#initial[`initial`]. Does not accept a value. -The value passed may be `record` or `pause` to start the application in, respectively, the recording or the paused state. This option should be used in conjunction with either `--keypress` or `--signal` to toggle between the two states. +==== `initial` -Example: `rpicam-vid -t 0 -o test.h264 -k --initial pause` +Default value: `record` ----- - --split Split multiple recordings into separate files ----- +Specifies whether to start the application with video output enabled or disabled. Accepts the following values: -This option should be used in conjunction with `--keypress` or `--signal` and causes each recording session (in between the pauses) to be written to a separate file. +* `record`: Starts with video output enabled. +* `pause`: Starts with video output disabled. -Example: `rpicam-vid -t 0 --keypress --split --initial pause -o test%04d.h264` +Use this option with either xref:camera_software.adoc#keypress[`keypress`] or xref:camera_software.adoc#signal[`signal`] to toggle between the two states. ----- - --segment Write the video recording into multiple segments ----- +==== `split` -This option causes the video recording to be split across multiple files where the parameter gives the approximate duration of each file in milliseconds. +When toggling recording with xref:camera_software.adoc#keypress[`keypress`] or xref:camera_software.adoc#signal[`signal`], writes the video output from separate recording sessions into separate files. Does not accept a value. Unless combined with xref:camera_software.adoc#output[`output`] to specify unique names for each file, overwrites each time it writes a file. -One convenient little trick is to pass a very small duration parameter (namely, `--segment 1`), which will result in each frame being written to a separate output file. This makes it easy to do burst JPEG capture (using the MJPEG codec), or burst raw frame capture (using `rpicam-raw`). +==== `segment` -Example: `rpicam-vid -t 100000 --segment 10000 -o test%04d.h264` +Cuts video output into multiple files of the passed duration. Accepts a duration in milliseconds. If passed a very small duration (for instance, `1`), records each frame to a separate output file to simulate burst capture. ----- - --circular Write the video recording into a circular buffer of the given ----- +You can specify separate filenames for each file using string formatting, e.g. `--output test%04d.h264`. -The video recording is written to a circular buffer which is written to disk when the application quits. The size of the circular buffer may be given in units of megabytes, defaulting to 4MB. +==== `circular` -Example: `rpicam-vid -t 0 --keypress --inline --circular -o test.h264` +Default value: `4` ----- - --inline Write sequence header in every I frame (H.264 only) ----- +Writes video recording into a circular buffer in memory. When the application quits, records the circular buffer to disk. Accepts an optional size in megabytes. -This option causes the H.264 sequence headers to be written into every I (Intra) frame. This is helpful because it means a client can understand and decode the video sequence from any I frame, not just from the very beginning of the stream. It is recommended to use this option with any output type that breaks the output into pieces (`--segment`, `--split`, `--circular`), or transmits the output over a network. +==== `inline` -Example: `rpicam-vid -t 0 --keypress --inline --split -o test%04d.h264` +Writes a sequence header in every Iframe (intra frame). This can help clients decode the video sequence from any point in the video, instead of just the beginning. Recommended with xref:camera_software.adoc#segment[`segment`], xref:camera_software.adoc#split[`split`], xref:camera_software.adoc#circular[`circular`], and streaming options. ----- - --listen Wait for an incoming TCP connection ----- +Only applies to videos encoded in the H.264 format. Does not accept a value. -This option is provided for streaming over a network using TCP/IP. Using `--listen` will cause `rpicam-vid` to wait for an incoming client connection before starting the video encode process, which will then be forwarded to that client. +==== `listen` -Example: `rpicam-vid -t 0 --inline --listen -o tcp://0.0.0.0:8123` +Waits for an incoming client connection before encoding video. Intended for network streaming over TCP/IP. Does not accept a value. ----- - --frames Record exactly this many frames ----- +==== `frames` + +Records exactly the specified number of frames. Any non-zero value overrides xref:camera_software.adoc#timeout[`timeout`]. Accepts a nonzero integer. + +==== `framerate` + +Records exactly the specified framerate. Accepts a nonzero integer. + +==== `low-latency` + +On a Pi 5, the `--low-latency` option will reduce the encoding latency, which may be beneficial for real-time streaming applications, in return for (slightly) less good coding efficiency (for example, B frames and arithmetic coding will no longer be used). -Exactly `` frames are recorded. Specifying a non-zero value will override any timeout. +==== `sync` -Example: `rpicam-vid -o test.h264 --frames 1000` +Run the camera in software synchronisation mode, where multiple cameras synchronise frames to the same moment in time. The `sync` mode can be set to either `client` or `server`. For more information, please refer to the detailed explanation of xref:camera_software.adoc#software-camera-synchronisation[how software synchronisation works]. \ No newline at end of file diff --git a/documentation/asciidoc/computers/camera/rpicam_raw.adoc b/documentation/asciidoc/computers/camera/rpicam_raw.adoc index e914e272b..210e0e20a 100644 --- a/documentation/asciidoc/computers/camera/rpicam_raw.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_raw.adoc @@ -1,25 +1,26 @@ === `rpicam-raw` -`rpicam-raw` behaves like a video-recording application, except that it records raw Bayer frames directly from the sensor. It does not show a preview window. For a two-second raw clip: +`rpicam-raw` records video as raw Bayer frames directly from the sensor. It does not show a preview window. To record a two second raw clip to a file named `test.raw`, run the following command: -[,bash] +[source,console] ---- -rpicam-raw -t 2000 -o test.raw +$ rpicam-raw -t 2000 -o test.raw ---- -The raw frames are dumped with no formatting information at all, one directly after another. The application prints the pixel format and image dimensions to the terminal window so that the user can see how to interpret the pixel data. +`rpicam-raw` outputs raw frames with no formatting information at all, one directly after another. The application prints the pixel format and image dimensions to the terminal window to help the user interpret the pixel data. -By default, the raw frames are saved in a single (and potentially very large) file. As we saw previously, the `--segment` option can be used to direct each to a separate file. -[,bash] +By default, `rpicam-raw` outputs raw frames in a single, potentially very large, file. Use the xref:camera_software.adoc#segment[`segment`] option to direct each raw frame to a separate file, using the `%05d` xref:camera_software.adoc#output[directive] to make each frame filename unique: + +[source,console] ---- -rpicam-raw -t 2000 --segment 1 -o test%05d.raw +$ rpicam-raw -t 2000 --segment 1 -o test%05d.raw ---- -In good conditions (using a fast SSD), `rpicam-raw` can get close to writing 12MP HQ camera frames (18MB of data each) to disk at 10fps. It writes the raw frames with no formatting in order to achieve these speeds; it has no capability to save them as DNG files like `rpicam-still`. If you want to be sure not to drop frames, you can reduce the framerate slightly using the `--framerate` option. +With a fast storage device, `rpicam-raw` can write 18MB 12-megapixel HQ camera frames to disk at 10fps. `rpicam-raw` has no capability to format output frames as DNG files; for that functionality, use xref:camera_software.adoc#rpicam-still[`rpicam-still`]. Use the xref:camera_software.adoc#framerate[`framerate`] option at a level beneath 10 to avoid dropping frames: -[,bash] +[source,console] ---- -rpicam-raw -t 5000 --width 4056 --height 3040 -o test.raw --framerate 8 +$ rpicam-raw -t 5000 --width 4056 --height 3040 -o test.raw --framerate 8 ---- -For more information on the raw formats, including how to choose between packed and unpacked versions, as well as the differences between Pi 5 and earlier models, please refer to the `--mode` option in the xref:camera_software.adoc#camera-resolution-and-readout[camera resolution options section]. +For more information on the raw formats, see the xref:camera_software.adoc#mode[`mode` documentation]. diff --git a/documentation/asciidoc/computers/camera/rpicam_still.adoc b/documentation/asciidoc/computers/camera/rpicam_still.adoc index 52e1d05b5..08ec164e0 100644 --- a/documentation/asciidoc/computers/camera/rpicam_still.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_still.adoc @@ -1,39 +1,44 @@ === `rpicam-still` -`rpicam-still` is very similar to `rpicam-jpeg` but supports more of the legacy `raspistill` options. As before, a single image can be captured with +`rpicam-still`, like `rpicam-jpeg`, helps you capture images on Raspberry Pi devices. +Unlike `rpicam-jpeg`, `rpicam-still` supports many options provided in the legacy `raspistill` application. -[,bash] +To capture a full resolution JPEG image and save it to a file named `test.jpg`, run the following command: + +[source,console] ---- -rpicam-still -o test.jpg +$ rpicam-still --output test.jpg ---- ==== Encoders -`rpicam-still` allows files to be saved in a number of different formats. It supports both `png` and `bmp` encoding. It also allows files to be saved as a binary dump of RGB or YUV pixels with no encoding or file format at all. In these latter cases the application reading the files will have to understand the pixel arrangement for itself. +`rpicam-still` can save images in multiple formats, including `png`, `bmp`, and both RGB and YUV binary pixel dumps. To read these binary dumps, any application reading the files must understand the pixel arrangement. + +Use the xref:camera_software.adoc#encoding[`encoding`] option to specify an output format. The file name passed to xref:camera_software.adoc#output[`output`] has no impact on the output file type. + +To capture a full resolution PNG image and save it to a file named `test.png`, run the following command: -[,bash] +[source,console] ---- -rpicam-still -e png -o test.png -rpicam-still -e bmp -o test.bmp -rpicam-still -e rgb -o test.data -rpicam-still -e yuv420 -o test.data +$ rpicam-still --encoding png --output test.png ---- -Note that the format in which the image is saved depends on the `-e` (equivalently `--encoding`) option and is _not_ selected automatically based on the output file name. -==== Raw Image Capture +For more information about specifying an image format, see the xref:camera_software.adoc#encoding[`encoding` option reference]. -_Raw_ images are the images produced directly by the image sensor, before any processing is applied to them either by the ISP (Image Signal Processor) or any of the CPU cores. For colour image sensors these are usually _Bayer_ format images. Note that _raw_ images are quite different from the processed but unencoded RGB or YUV images that we saw earlier. +==== Capture raw images -To capture a raw image use +Raw images are the images produced directly by the image sensor, before any processing is applied to them either by the Image Signal Processor (ISP) or CPU. Colour image sensors usually use the Bayer format. Use the xref:camera_software.adoc#raw[`raw`] option to capture raw images. -[,bash] +To capture an image, save it to a file named `test.jpg`, and also save a raw version of the image to a file named `test.dng`, run the following command: + +[source,console] ---- -rpicam-still -r -o test.jpg +$ rpicam-still --raw --output test.jpg ---- -Here, the `-r` option (also `--raw`) indicates to capture the raw image as well as the JPEG. In fact, the raw image is the exact image from which the JPEG was produced. Raw images are saved in DNG (Adobe Digital Negative) format and are compatible with many standard applications, such as _dcraw_ or _RawTherapee_. The raw image is saved to a file with the same name but the extension `.dng`, thus `test.dng` in this case. +`rpicam-still` saves raw images in the DNG (Adobe Digital Negative) format. To determine the filename of the raw images, `rpicam-still` uses the same name as the output file, with the extension changed to `.dng`. To work with DNG images, use an application like https://en.wikipedia.org/wiki/Dcraw[Dcraw] or https://en.wikipedia.org/wiki/RawTherapee[RawTherapee]. -These DNG files contain metadata pertaining to the image capture, including black levels, white balance information and the colour matrix used by the ISP to produce the JPEG. This makes these DNG files much more convenient for later "by hand" raw conversion with some of the aforementioned tools. Using `exiftool` shows all the metadata encoded into the DNG file: +DNG files contain metadata about the image capture, including black levels, white balance information and the colour matrix used by the ISP to produce the JPEG. Use https://exiftool.org/[ExifTool] to view DNG metadata. The following output shows typical metadata stored in a raw image captured by a Raspberry Pi using the HQ camera: ---- File Name : test.dng @@ -79,14 +84,123 @@ Image Size : 4056x3040 Megapixels : 12.3 Shutter Speed : 1/20 ---- -We note that there is only a single calibrated illuminant (the one determined by the AWB algorithm even though it gets labelled always as "D65"), and that dividing the ISO number by 100 gives the analogue gain that was being used. -==== Very long exposures +To find the analogue gain, divide the ISO number by 100. +The Auto White Balance (AWB) algorithm determines a single calibrated illuminant, which is always labelled `D65`. + +==== Capture long exposures + +To capture very long exposure images, disable the Automatic Exposure/Gain Control (AEC/AGC) and Auto White Balance (AWB). These algorithms will otherwise force the user to wait for a number of frames while they converge. + +To disable these algorithms, supply explicit values for gain and AWB. Because long exposures take plenty of time already, it often makes sense to skip the preview phase entirely with the xref:camera_software.adoc#immediate[`immediate`] option. + +To perform a 100 second exposure capture, run the following command: + +[source,console] +---- +$ rpicam-still -o long_exposure.jpg --shutter 100000000 --gain 1 --awbgains 1,1 --immediate +---- + +To find the maximum exposure times of official Raspberry Pi cameras, see xref:../accessories/camera.adoc#hardware-specification[the camera hardware specification]. + +==== Create a time lapse video + +To create a time lapse video, capture a still image at a regular interval, such as once a minute, then use an application to stitch the pictures together into a video. + +[tabs] +====== +`rpicam-still` time lapse mode:: ++ +To use the built-in time lapse mode of `rpicam-still`, use the xref:camera_software.adoc#timelapse[`timelapse`] option. This option accepts a value representing the period of time you want your Raspberry Pi to wait between captures, in milliseconds. ++ +First, create a directory where you can store your time lapse photos: ++ +[source,console] +---- +$ mkdir timelapse +---- ++ +Run the following command to create a time lapse over 30 seconds, recording a photo every two seconds, saving output into `image0000.jpg` through `image0013.jpg`: ++ +[source,console] +---- +$ rpicam-still --timeout 30000 --timelapse 2000 -o timelapse/image%04d.jpg +---- + +`cron`:: ++ +You can also automate time lapses with `cron`. First, create the script, named `timelapse.sh` containing the following commands. Replace the `` placeholder with the name of your user account on your Raspberry Pi: ++ +[source,bash] +---- +#!/bin/bash +DATE=$(date +"%Y-%m-%d_%H%M") +rpicam-still -o /home//timelapse/$DATE.jpg +---- ++ +Then, make the script executable: ++ +[source,console] +---- +$ chmod +x timelapse.sh +---- ++ +Create the `timelapse` directory into which you'll save time lapse pictures: ++ +[source,console] +---- +$ mkdir timelapse +---- ++ +Open your crontab for editing: ++ +[source,console] +---- +$ crontab -e +---- ++ +Once you have the file open in an editor, add the following line to schedule an image capture every minute, replacing the `` placeholder with the username of your primary user account: ++ +---- +* * * * * /home//timelapse.sh 2>&1 +---- ++ +Save and exit, and you should see this message: ++ +---- +crontab: installing new crontab +---- ++ +To stop recording images for the time lapse, run `crontab -e` again and remove the above line from your crontab. + +====== + +===== Stitch images together + +Once you have a series of time lapse photos, you probably want to combine them into a video. Use `ffmpeg` to do this on a Raspberry Pi. + +First, install `ffmpeg`: + +[source,console] +---- +$ sudo apt install ffmpeg +---- + +Run the following command from the directory that contains the `timelapse` directory to convert your JPEG files into an mp4 video: -To capture very long exposure images, we need to be careful to disable the AEC/AGC and AWB because these algorithms will otherwise force the user to wait for a number of frames while they converge. The way to disable them is to supply explicit values. Additionally, the entire preview phase of the capture can be skipped with the `--immediate` option. +[source,console] +---- +$ ffmpeg -r 10 -f image2 -pattern_type glob -i 'timelapse/*.jpg' -s 1280x720 -vcodec libx264 timelapse.mp4 +---- -So to perform a 100 second exposure capture, use +The command above uses the following parameters: -`rpicam-still -o long_exposure.jpg --shutter 100000000 --gain 1 --awbgains 1,1 --immediate` +* `-r 10`: sets the frame rate (Hz value) to ten frames per second in the output video +* `-f image2`: sets `ffmpeg` to read from a list of image files specified by a pattern +* `-pattern_type glob`: use wildcard patterns (globbing) to interpret filename input with `-i` +* `-i 'timelapse/*.jpg'`: specifies input files to match JPG files in the `timelapse` directory +* `-s 1280x720`: scales to 720p +* `-vcodec libx264` use the software x264 encoder. +* `timelapse.mp4` The name of the output video file. -For reference, the maximum exposure times of the three official Raspberry Pi cameras can be found in xref:../accessories/camera.adoc#hardware-specification[this table]. +For more information about `ffmpeg` options, run `ffmpeg --help` in a terminal. diff --git a/documentation/asciidoc/computers/camera/rpicam_vid.adoc b/documentation/asciidoc/computers/camera/rpicam_vid.adoc index 496cff56e..e88c5b762 100644 --- a/documentation/asciidoc/computers/camera/rpicam_vid.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_vid.adoc @@ -1,120 +1,98 @@ === `rpicam-vid` -The video capture application for Raspberry Pi is `rpicam-vid`. It will display a preview window and write the encoded bitstream to the specified output. For example, to write a ten-second video to file: +`rpicam-vid` helps you capture video on Raspberry Pi devices. `rpicam-vid` displays a preview window and writes an encoded bitstream to the specified output. This produces an unpackaged video bitstream that is not wrapped in any kind of container (such as an mp4 file) format. -NOTE: On those Raspberry Pi models with a hardware H.264 encoder it is used by default. +NOTE: When available, `rpicam-vid` uses hardware H.264 encoding. -[,bash] ----- -rpicam-vid -t 10000 -o test.h264 ----- -The resulting file can be played with `vlc` (among other applications). -[,bash] +For example, the following command writes a ten-second video to a file named `test.h264`: + +[source,console] ---- -vlc test.h264 +$ rpicam-vid -t 10s -o test.h264 ---- -This is an unpackaged video bitstream, and is not wrapped in any kind of container format (such as an mp4 file). The `--save-pts` option can be used to output frame timestamps so that the bitstream can subsequently be converted into an appropriate format using a tool like `mkvmerge`. -`rpicam-vid -o test.h264 --save-pts timestamps.txt` +You can play the resulting file with ffplay and other video players: -If you want an _mkv_ file: +[source,console] +---- +$ ffplay test.h264 +---- -`mkvmerge -o test.mkv --timecodes 0:timestamps.txt test.h264` +[WARNING] +==== +Older versions of vlc were able to play H.264 files correctly, but recent versions do not - displaying only a few, or possibly garbled, frames. You should either use a different media player, or save your files in a more widely supported container format - such as MP4 (see below). +==== -==== Encoders +On Raspberry Pi 5, you can output to the MP4 container format directly by specifying the `mp4` file extension for your output file: -There is support for motion JPEG, and also for uncompressed and unformatted YUV420: -[,bash] +[source,console] ---- -rpicam-vid -t 10000 --codec mjpeg -o test.mjpeg -rpicam-vid -t 10000 --codec yuv420 -o test.data +$ rpicam-vid -t 10s -o test.mp4 ---- -In both cases the `--codec` parameter determines the output format, not the extension of the output file. -The `--segment` parameter breaks output files up into chunks of the segment size (given in milliseconds). This is handy for breaking a motion JPEG stream up into individual JPEG files by specifying very short (1 millisecond) segments. -[,bash] +On Raspberry Pi 4, or earlier devices, you can save MP4 files using: + +[source,console] ---- -rpicam-vid -t 10000 --codec mjpeg --segment 1 -o test%05d.jpeg +$ rpicam-vid -t 10s --codec libav -o test.mp4 ---- -The output file name may not make sense unless we avoid overwriting the previous file every time, such as by using a file name that includes a counter (as above). - -==== Network streaming -NOTE: This section describes native streaming from `rpicam-vid`. It is also possible to use the xref:camera_software.adoc#libav-integration-with-rpicam-vid[`libav`] backend for network streaming. +==== Encoders -===== UDP +`rpicam-vid` supports motion JPEG as well as both uncompressed and unformatted YUV420: -To stream video using UDP, on the Raspberry Pi (server) use: -[,bash] ----- -rpicam-vid -t 0 --inline -o udp://: +[source,console] ---- -...where `` is the IP address of the client, or multicast address (if appropriately configured to reach the client). On the client use (for example): -[,bash] +$ rpicam-vid -t 10000 --codec mjpeg -o test.mjpeg ---- -vlc udp://@: :demux=h264 ----- -Alternatively, using the same `` value: + +[source,console] ---- -ffplay udp://: -fflags nobuffer -flags low_delay -framedrop +$ rpicam-vid -t 10000 --codec yuv420 -o test.data ---- +The xref:camera_software.adoc#codec[`codec`] option determines the output format, not the extension of the output file. -===== TCP +The xref:camera_software.adoc#segment[`segment`] option breaks output files up into chunks of the segment size (given in milliseconds). This is handy for breaking a motion JPEG stream up into individual JPEG files by specifying very short (1 millisecond) segments. For example, the following command combines segments of 1 millisecond with a counter in the output file name to generate a new filename for each segment: -Video can be streamed using TCP. To use the Raspberry Pi as a server: -[,bash] ----- -rpicam-vid -t 0 --inline --listen -o tcp://0.0.0.0: ----- -On the client: -[,bash] ----- -vlc tcp/h264://: +[source,console] ---- -Alternatively: +$ rpicam-vid -t 10000 --codec mjpeg --segment 1 -o test%05d.jpeg ---- -ffplay tcp://: -vf "setpts=N/30" -fflags nobuffer -flags low_delay -framedrop ----- -...for a 30 frames per second stream with low latency. -The Raspberry Pi will wait until the client connects, and then start streaming video. +==== Capture high framerate video -===== RTSP +To minimise frame drops for high framerate (> 60fps) video, try the following configuration tweaks: -If formatting an RTSP stream, vlc is useful on the Raspberry Pi. (Other RTSP servers are available.) -[,bash] ----- -rpicam-vid -t 0 --inline -o - | cvlc stream:///dev/stdin --sout '#rtp{sdp=rtsp://:8554/stream1}' :demux=h264 ----- -This can be played with: -[,bash] ----- -vlc rtsp://:8554/stream1 ----- -Alternatively: +* Set the https://en.wikipedia.org/wiki/Advanced_Video_Coding#Levels[H.264 target level] to 4.2 with `--level 4.2`. +* Disable software colour denoise processing by setting the xref:camera_software.adoc#denoise[`denoise`] option to `cdn_off`. +* Disable the display window with xref:camera_software.adoc#nopreview[`nopreview`] to free up some additional CPU cycles. +* Set `force_turbo=1` in xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] to ensure that the CPU clock does not throttle during video capture. For more information, see xref:config_txt.adoc#force_turbo[the `force_turbo` documentation]. +* Adjust the ISP output resolution with `--width 1280 --height 720` or something even lower to achieve your framerate target. +* On Raspberry 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. + +The following command demonstrates how you might achieve 1280×720 120fps video: + +[source,console] ---- -ffplay rtsp://:8554/stream1 -vf "setpts=N/30" -fflags nobuffer -flags low_delay -framedrop +$ rpicam-vid --level 4.2 --framerate 120 --width 1280 --height 720 --save-pts timestamp.pts -o video.264 -t 10000 --denoise cdn_off -n ---- -In all cases, the preview window on the server (the Raspberry Pi) can be suppressed with the `-n` (`--nopreview`) option. Note also the use of the `--inline` option, which forces the stream header information to be included with every intra (I) frame. This is important so that a client can correctly understand the stream if it missed the very beginning. +==== `libav` integration with `rpicam-vid` -NOTE: Recent versions of VLC seem to have problems with playback of H.264 streams. We recommend using `ffplay` for playback using the above commands until these issues have been resolved. +`rpicam-vid` can use the `ffmpeg`/`libav` codec backend to encode audio and video streams. You can either save these streams to a file or stream them over the network. `libav` uses hardware H.264 video encoding when present. -==== High framerate capture +To enable the `libav` backend, pass `libav` to the xref:camera_software.adoc#codec[`codec`] option: -Using `rpicam-vid` to capture high framerate video (generally anything over 60fps) while minimising frame drops requires a few considerations. +[source,console] +---- +$ rpicam-vid --codec libav --libav-format avi --libav-audio --output example.avi +---- -* 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. -* Software colour denoise processing must be turned off with the `--denoise cdn_off` argument. -* 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. -* 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. -* Adjust the ISP output resolution with `--width 1280 --height 720` or something even lower to achieve your framerate target. -* 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. +==== Low latency video with the Pi 5 -An example command for 1280×720 120fps video encode would be: +Pi 5 uses software video encoders. These generally output frames with a longer latency than the old hardware encoders, and this can sometimes be an issue for real-time streaming applications. -[,bash] ----- -rpicam-vid --level 4.2 --framerate 120 --width 1280 --height 720 --save-pts timestamp.pts -o video.264 -t 10000 --denoise cdn_off -n ----- +In this case, please add the option `--low-latency` to the `rpicam-vid` command. This will alter certain encoder options to output the encoded frame more quickly. + +The downside is that coding efficiency is (slightly) less good, and that the processor's multiple cores may be used (slightly) less efficiently. The maximum framerate that can be encoded may be slightly reduced (though it will still easily achieve 1080p30). diff --git a/documentation/asciidoc/computers/camera/streaming.adoc b/documentation/asciidoc/computers/camera/streaming.adoc new file mode 100644 index 000000000..ffcf9a656 --- /dev/null +++ b/documentation/asciidoc/computers/camera/streaming.adoc @@ -0,0 +1,206 @@ +== Stream video over a network with `rpicam-apps` + +This section describes how to stream video over a network using `rpicam-vid`. Whilst it's possible to stream very simple formats without using `libav`, for most applications we recommend using the xref:camera_software.adoc#libav-integration-with-rpicam-vid[`libav` backend]. + +=== UDP + +To stream video over UDP using a Raspberry Pi as a server, use the following command, replacing the `` placeholder with the IP address of the client or multicast address and replacing the `` placeholder with the port you would like to use for streaming: + +[source,console] +---- +$ rpicam-vid -t 0 -n --inline -o udp://: +---- + +To view video streamed over UDP using a Raspberry Pi as a client, use the following command, replacing the `` placeholder with the port you would like to stream from: + +[source,console] +---- +$ ffplay udp://@: -fflags nobuffer -flags low_delay -framedrop +---- +As noted previously, `vlc` no longer handles unencapsulated H.264 streams. + +In fact, support for unencapsulated H.264 can generally be quite poor so it is often better to send an MPEG-2 Transport Stream instead. Making use of `libav`, this can be accomplished with: + +[source,console] +---- +$ rpicam-vid -t 0 -n --codec libav --libav-format mpegts -o udp://: +---- + +In this case, we can also play the stream successfully with `vlc`: + +[source,console] +---- +$ vlc udp://@: +---- + +=== TCP + +You can also stream video over TCP. As before, we can send an unencapsulated H.264 stream over the network. To use a Raspberry Pi as a server: + +[source,console] +---- +$ rpicam-vid -t 0 -n --inline --listen -o tcp://0.0.0.0: +---- + +To view video streamed over TCP using a Raspberry Pi as a client, assuming the server is running at 30 frames per second, use the following command: + +[source,console] +---- +$ ffplay tcp://: -vf "setpts=N/30" -fflags nobuffer -flags low_delay -framedrop +---- + +But as with the UDP examples, it is often preferable to send an MPEG-2 Transport Stream as this is generally better supported. To do this, use: + +[source,console] +---- +$ rpicam-vid -t 0 -n --codec libav --libav-format mpegts -o tcp://0.0.0.0:?listen=1 +---- + +We can now play this back using a variety of media players, including `vlc`: + +[source,console] +---- +$ vlc tcp://: +---- + +=== RTSP + +We can use VLC as an RTSP server, however, we must send it an MPEG-2 Transport Stream as it no longer understands unencapsulated H.264: + +[source,console] +---- +$ rpicam-vid -t 0 -n --codec libav --libav-format mpegts -o - | cvlc stream:///dev/stdin --sout '#rtp{sdp=rtsp://:8554/stream1}' +---- + +To view video streamed over RTSP using a Raspberry Pi as a client, use the following command: + +[source,console] +---- +$ ffplay rtsp://:8554/stream1 -fflags nobuffer -flags low_delay -framedrop +---- + +Alternatively, use the following command on a client to stream using VLC: + +[source,console] +---- +$ vlc rtsp://:8554/stream1 +---- + +If you want to see a preview window on the server, just drop the `-n` option (see xref:camera_software.adoc#nopreview[`nopreview`]). + +=== `libav` and Audio + +We have already been using `libav` as the backend for network streaming. `libav` allows us to add an audio stream, so long as we're using a format - like the MPEG-2 Transport Stream - that permits audio data. + +We can take one of our previous commands, like the one for streaming an MPEG-2 Transport Stream over TCP, and simply add the `--libav-audio` option: + +[source,console] +---- +$ rpicam-vid -t 0 --codec libav --libav-format mpegts --libav-audio -o "tcp://:?listen=1" +---- + +You can stream over UDP with a similar command: + +[source,console] +---- +$ rpicam-vid -t 0 --codec libav --libav-format mpegts --libav-audio -o "udp://:" +---- + +=== GStreamer + +https://gstreamer.freedesktop.org/[GStreamer] is a Linux framework for reading, processing and playing multimedia files. We can also use it in conjunction with `rpicam-vid` for network streaming. + +This setup uses `rpicam-vid` to output an H.264 bitstream to stdout, though as we've done previously, we're going to encapsulate it in an MPEG-2 Transport Stream for better downstream compatibility. + +Then, we use the GStreamer `fdsrc` element to receive the bitstream, and extra GStreamer elements to send it over the network. On the server, run the following command to start the stream, replacing the `` placeholder with the IP address of the client or multicast address and replacing the `` placeholder with the port you would like to use for streaming: + +[source,console] +---- +$ rpicam-vid -t 0 -n --codec libav --libav-format mpegts -o - | gst-launch-1.0 fdsrc fd=0 ! udpsink host= port= +---- + +We could of course use anything (such as vlc) as the client, and the best GStreamer clients for playback are beyond the scope of this document. However, we note that the following pipeline (with the obvious substitutions) would work on a Pi 4 or earlier device: + +[source,console] +---- +$ gst-launch-1.0 udpsrc address= port= ! tsparse ! tsdemux ! h264parse ! queue ! v4l2h264dec ! autovideosink +---- + +For a Pi 5, replace `v4l2h264dec` by `avdec_h264`. + +TIP: To test this configuration, run the server and client commands in separate terminals on the same device, using `localhost` as the address. + +==== `libcamerasrc` GStreamer element + +`libcamera` provides a `libcamerasrc` GStreamer element which can be used directly instead of `rpicam-vid`. To use this element, run the following command on the server, replacing the `` placeholder with the IP address of the client or multicast address and replacing the `` placeholder with the port you would like to use for streaming. On a Pi 4 or earlier device, use: + +[source,console] +---- +$ gst-launch-1.0 libcamerasrc ! capsfilter caps=video/x-raw,width=640,height=360,format=NV12,interlace-mode=progressive ! v4l2h264enc extra-controls="controls,repeat_sequence_header=1" ! 'video/x-h264,level=(string)4' ! h264parse ! mpegtsmux ! udpsink host= port= +---- +On a Pi 5 you would have to replace `v4l2h264enc extra-controls="controls,repeat_sequence_header=1"` by `x264enc speed-preset=1 threads=1`. + +On the client we could use the same playback pipeline as we did just above, or other streaming media players. + +=== WebRTC + +Streaming over WebRTC (for example, to web browsers) is best accomplished using third party software. https://github.com/bluenviron/mediamtx[MediaMTX], for example, includes native Raspberry Pi camera support which makes it easy to use. + +To install it, download the latest version from the https://github.com/bluenviron/mediamtx/releases[releases] page. Raspberry Pi OS 64-bit users will want the "linux_arm64v8" compressed tar file (ending `.tar.gz`). Unpack it and you will get a `mediamtx` executable and a configuration file called `mediamtx.yml`. + +It's worth backing up the `mediamtx.yml` file because it documents many Raspberry Pi camera options that you may want to investigate later. + +To stream the camera, replace the contents of `mediamtx.yml` by: +---- +paths: + cam: + source: rpiCamera +---- +and start the `mediamtx` executable. On a browser, enter `http://:8889/cam` into the address bar. + +If you want MediaMTX to acquire the camera only when the stream is requested, add the following line to the previous `mediamtx.yml`: +---- + sourceOnDemand: yes +---- +Consult the original `mediamtx.yml` for additional configuration parameters that let you select the image size, the camera mode, the bitrate and so on - just search for `rpi`. + +==== Customised image streams with WebRTC + +MediaMTX is great if you want to stream just the camera images. But what if we want to add some extra information or overlay, or do some extra processing on the images? + +Before starting, ensure that you've built a version of `rpicam-apps` that includes OpenCV support. Check it by running + +[source,console] +---- +$ rpicam-hello --post-process-file rpicam-apps/assets/annotate_cv.json +---- +and looking for the overlaid text information at the top of the image. + +Next, paste the following into your `mediamtx.yml` file: +---- +paths: + cam: + source: udp://127.0.0.1:1234 +---- + +Now, start `mediamtx` and then, if you're using a Pi 5, in a new terminal window, enter: + +[source,console] +---- +$ rpicam-vid -t 0 -n --codec libav --libav-video-codec-opts "profile=baseline" --libav-format mpegts -o udp://127.0.0.1:1234?pkt_size=1316 --post-process-file rpicam-apps/assets/annotate_cv.json +---- +(On a Pi 4 or earlier device, leave out the `--libav-video-codec-opts "profile=baseline"` part of the command.) + +On another computer, you can now visit the same address as before, namely `http://:8889/cam`. + +The reason for specifying "baseline" profile on a Pi 5 is that MediaMTX doesn't support B frames, so we need to stop the encoder from producing them. On earlier devices, with hardware encoders, B frames are never generated so there is no issue. On a Pi 5 you could alternatively remove this option and replace it with `--low-latency` which will also prevent B frames, and produce a (slightly less well compressed) stream with reduced latency. + +[NOTE] +==== +If you notice occasional pauses in the video stream, this may be because the UDP receive buffers on the Pi (passing data from `rpicam-vid` to MediaMTX) are too small. To increase them permantently, add +---- +net.core.rmem_default=1000000 +net.core.rmem_max=1000000 +---- +to your `/etc/sysctl.conf` file (and reboot or run `sudo sysctl -p`). +==== \ No newline at end of file diff --git a/documentation/asciidoc/computers/camera/timelapse.adoc b/documentation/asciidoc/computers/camera/timelapse.adoc deleted file mode 100644 index d8228345f..000000000 --- a/documentation/asciidoc/computers/camera/timelapse.adoc +++ /dev/null @@ -1,92 +0,0 @@ -== Application notes - -=== Creating timelapse video - -To create a timelapse video, configure the Raspberry Pi to take a picture at a regular interval, such as once a minute, then use an application to stitch the pictures together into a video. - -==== Using `rpicam-still` timelapse mode - -`rpicam-still` has a built-in timelapse mode, using the `--timelapse` command line switch. The value that follows the switch is the time between shots in milliseconds: - ----- -rpicam-still -t 30000 --timelapse 2000 -o image%04d.jpg ----- - -[NOTE] -==== -The `%04d` in the output filename indicates the point in the filename where you want a frame count number to appear. So, for example, the command above will produce a capture every two seconds (2000ms), over a total period of 30 seconds (30000ms), named image0001.jpg, image0002.jpg, and so on, through to image0015.jpg. - -The `%04d` indicates a four-digit number, with leading zeros added to make up the required number of digits. So, for example, `%08d` would result in an eight-digit number. You can miss out the `0` if you don't want leading zeros. - -If a timelapse value of 0 is entered, the application will take pictures as fast as possible. Note that there's an minimum enforced pause of approximately 30 milliseconds between captures to ensure that exposure calculations can be made. -==== - -==== Automating using `cron` jobs - -A good way to automate taking a picture at a regular interval is running a script with `cron`. First create the script that we'll be using with your editor of choice, replacing the `` placeholder below with the name of the user you created during first boot: - ----- -#!/bin/bash -DATE=$(date +"%Y-%m-%d_%H%M") -rpicam-still -o /home//camera/$DATE.jpg ----- - -...and save it as `camera.sh`. You'll need to make the script executable: - ----- -$ chmod +x camera.sh ----- - -...and also create the `camera` directory into which you'll be saving the pictures: - ----- -$ mkdir camera ----- - -Now open the cron table for editing: - ----- -$ crontab -e ----- - -This will either ask which editor you would like to use, or open in your default editor. Once you have the file open in an editor, add the following line to schedule taking a picture every minute, replacing the `` placeholder with the username of your primary user account: - ----- -* * * * * /home//camera.sh 2>&1 ----- - -Save and exit, and you should see this message: - ----- -crontab: installing new crontab ----- - -NOTE: Make sure that you use e.g. `%04d` to ensure that each image is written to a new file: if you don't, then each new image will overwrite the previous file. - -==== Stitching images together - -Now you'll need to stitch the photos together into a video. You can do this on the Raspberry Pi using `ffmpeg` but the processing will be slow. You may prefer to transfer the image files to your desktop computer or laptop and produce the video there. - -First you will need to install `ffmpeg` if it's not already installed. - ----- -sudo apt install ffmpeg ----- - -Now you can use the `ffmpeg` tool to convert your JPEG files into an mp4 video: - ----- -ffmpeg -r 10 -f image2 -pattern_type glob -i 'image*.jpg' -s 1280x720 -vcodec libx264 timelapse.mp4 ----- - -On a Raspberry Pi 3, this can encode a little more than two frames per second. The performance of other Raspberry Pi models will vary. The parameters used are: - -* `-r 10` Set frame rate (Hz value) to ten frames per second in the output video. -* `-f image2` Set ffmpeg to read from a list of image files specified by a pattern. -* `-pattern_type glob` When importing the image files, use wildcard patterns (globbing) to interpret the filename input by `-i`, in this case `image*.jpg`, where `*` would be the image number. -* `-i 'image*.jpg'` The input file specification (to match the files produced during the capture). -* `-s 1280×720` Scale to 720p. You can also use 1920×1080, or lower resolutions, depending on your requirements. -* `-vcodec libx264` Use the software x264 encoder. -* `timelapse.mp4` The name of the output video file. - -`ffmpeg` has a comprehensive parameter set for varying encoding options and other settings. These can be listed using `ffmpeg --help`. diff --git a/documentation/asciidoc/computers/camera/troubleshooting.adoc b/documentation/asciidoc/computers/camera/troubleshooting.adoc new file mode 100644 index 000000000..4c94ce12f --- /dev/null +++ b/documentation/asciidoc/computers/camera/troubleshooting.adoc @@ -0,0 +1,16 @@ +== Troubleshooting + +If your Camera Module doesn't work like you expect, try some of the following fixes: + +* On Raspberry Pi 3 and earlier devices running Raspberry Pi OS _Bullseye_ or earlier: +** To enable hardware-accelerated camera previews, enable *Glamor*. To enable Glamor, enter `sudo raspi-config` in a terminal, select `Advanced Options` > `Glamor` > `Yes`. Then reboot your Raspberry Pi with `sudo reboot`. +** If you see an error related to the display driver, add `dtoverlay=vc4-fkms-v3d` or `dtoverlay=vc4-kms-v3d` to `/boot/config.txt`. Then reboot your Raspberry Pi with `sudo reboot`. +* On Raspberry Pi 3 and earlier, the graphics hardware can only support images up to 2048×2048 pixels, which places a limit on the camera images that can be resized into the preview window. As a result, video encoding of images larger than 2048 pixels wide produces corrupted or missing preview images. +* On Raspberry Pi 4, the graphics hardware can only support images up to 4096×4096 pixels, which places a limit on the camera images that can be resized into the preview window. As a result, video encoding of images larger than 4096 pixels wide produces corrupted or missing preview images. +* The preview window may show display tearing in a desktop environment. This is a known, unfixable issue. +* Check that the FFC (Flat Flexible Cable) is firmly seated, fully inserted, and that the contacts face the correct direction. The FFC should be evenly inserted, not angled. +* If you use a connector between the camera and your Raspberry Pi, check that the ports on the connector are firmly seated, fully inserted, and that the contacts face the correct direction. +* Check to make sure that the FFC (Flat Flexible Cable) is attached to the CSI (Camera Serial Interface), _not_ the DSI (Display Serial Interface). The connector fits into either port, but only the CSI port powers and controls the camera. Look for the `CSI` label printed on the board near the port. +* xref:os.adoc#update-software[Update to the latest software.] +* Try a different power supply. The Camera Module adds about 200-250mA to the power requirements of your Raspberry Pi. If your power supply is low quality, your Raspberry Pi may not be able to power the Camera module. +* If you've checked all the above issues and your Camera Module still doesn't work like you expect, try posting on our forums for more help. diff --git a/documentation/asciidoc/computers/camera/v4l2.adoc b/documentation/asciidoc/computers/camera/v4l2.adoc index 2ef954af0..7cc2ceabc 100644 --- a/documentation/asciidoc/computers/camera/v4l2.adoc +++ b/documentation/asciidoc/computers/camera/v4l2.adoc @@ -1,6 +1,6 @@ == V4L2 drivers -V4L2 drivers provide a standard Linux interface for accessing camera and codec features. They are loaded automatically when the system is started, though in some non-standard situations you may need to xref:camera_software.adoc#if-you-do-need-to-alter-the-configuration[load camera drivers explicitly]. +V4L2 drivers provide a standard Linux interface for accessing camera and codec features. Normally, Linux loads drivers automatically during boot. But in some situations you may need to xref:camera_software.adoc#configuration[load camera drivers explicitly]. === Device nodes when using `libcamera` @@ -8,37 +8,37 @@ V4L2 drivers provide a standard Linux interface for accessing camera and codec f |=== | /dev/videoX | Default action -| video0 +| `video0` | Unicam driver for the first CSI-2 receiver -| video1 +| `video1` | Unicam driver for the second CSI-2 receiver -| video10 +| `video10` | Video decode -| video11 +| `video11` | Video encode -| video12 -| Simple ISP. Can perform conversion and resizing between RGB/YUV formats, and also Bayer to RGB/YUV conversion +| `video12` +| Simple ISP, can perform conversion and resizing between RGB/YUV formats in addition to Bayer to RGB/YUV conversion -| video13 +| `video13` | Input to fully programmable ISP -| video14 +| `video14` | High resolution output from fully programmable ISP -| video15 +| `video15` | Low result output from fully programmable ISP -| video16 +| `video16` | Image statistics from fully programmable ISP -| video19 +| `video19` | HEVC decode |=== -=== Using the driver +=== Use the V4L2 drivers -Please see the https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/v4l2.html[V4L2 documentation] for details on using this driver. +For more information on how to use the V4L2 drivers, see the https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/v4l2.html[V4L2 documentation]. diff --git a/documentation/asciidoc/computers/camera/webcams.adoc b/documentation/asciidoc/computers/camera/webcams.adoc new file mode 100644 index 000000000..dbfe0c8e4 --- /dev/null +++ b/documentation/asciidoc/computers/camera/webcams.adoc @@ -0,0 +1,169 @@ +== Use a USB webcam + +Most Raspberry Pi devices have dedicated ports for camera modules. Camera modules are high-quality, highly-configurable cameras popular with Raspberry Pi users. + +However, for many purposes a USB webcam has everything you need to record pictures and videos from your Raspberry Pi. This section explains how to use a USB webcam with your Raspberry Pi. + +=== Install dependencies + +First, install the `fswebcam` package: + +[source,console] +---- +$ sudo apt install fswebcam +---- + +Next, add your username to the `video` group, otherwise you may see 'permission denied' errors: + +[source,console] +---- +$ sudo usermod -a -G video +---- + +To check that the user has been added to the group correctly, use the `groups` command. + +=== Take a photo + +Run the following command to take a picture using the webcam and save the image to a filename named `image.jpg`: + +[source,console] +---- +$ fswebcam image.jpg +---- + +You should see output similar to the following: + +---- +--- Opening /dev/video0... +Trying source module v4l2... +/dev/video0 opened. +No input was specified, using the first. +Adjusting resolution from 384x288 to 352x288. +--- Capturing frame... +Corrupt JPEG data: 2 extraneous bytes before marker 0xd4 +Captured frame in 0.00 seconds. +--- Processing captured image... +Writing JPEG image to 'image.jpg'. +---- + +.By default, `fswebcam` uses a low resolution and adds a banner displaying a timestamp. +image::images/webcam-image.jpg[By default, `fswebcam` uses a low resolution and adds a banner displaying a timestamp] + +To specify a different resolution for the captured image, use the `-r` flag, passing a width and height as two numbers separated by an `x`: + +[source,console] +---- +$ fswebcam -r 1280x720 image2.jpg +---- + +You should see output similar to the following: + +---- +--- Opening /dev/video0... +Trying source module v4l2... +/dev/video0 opened. +No input was specified, using the first. +--- Capturing frame... +Corrupt JPEG data: 1 extraneous bytes before marker 0xd5 +Captured frame in 0.00 seconds. +--- Processing captured image... +Writing JPEG image to 'image2.jpg'. +---- + +.Specify a resolution to capture a higher quality image. +image::images/webcam-image-high-resolution.jpg[Specify a resolution to capture a higher quality image] + +==== Remove the banner + +To remove the banner from the captured image, use the `--no-banner` flag: + +[source,console] +---- +$ fswebcam --no-banner image3.jpg +---- + +You should see output similar to the following: + +---- +--- Opening /dev/video0... +Trying source module v4l2... +/dev/video0 opened. +No input was specified, using the first. +--- Capturing frame... +Corrupt JPEG data: 2 extraneous bytes before marker 0xd6 +Captured frame in 0.00 seconds. +--- Processing captured image... +Disabling banner. +Writing JPEG image to 'image3.jpg'. +---- + +.Specify `--no-banner` to save the image without the timestamp banner. +image::images/webcam-image-no-banner.jpg[Specify `--no-banner` to save the image without the timestamp banner] + +=== Automate image capture + +Unlike xref:camera_software.adoc#rpicam-apps[`rpicam-apps`], `fswebcam` doesn't have any built-in functionality to substitute timestamps and numbers in output image names. This can be useful when capturing multiple images, since manually editing the file name every time you record an image can be tedious. Instead, use a Bash script to implement this functionality yourself. + +Create a new file named `webcam.sh` in your home folder. Add the following example code, which uses the `bash` programming language to save images to files with a file name containing the year, month, day, hour, minute, and second: + +[,bash] +---- +#!/bin/bash + +DATE=$(date +"%Y-%m-%d_%H-%M-%S") + +fswebcam -r 1280x720 --no-banner $DATE.jpg +---- + +Then, make the bash script executable by running the following command: + +[source,console] +---- +$ chmod +x webcam.sh +---- + +Run the script with the following command to capture an image and save it to a file with a timestamp for a name, similar to `2024-05-10_12-06-33.jpg`: + +[source,console] +---- +$ ./webcam.sh +---- + +You should see output similar to the following: + +---- +--- Opening /dev/video0... +Trying source module v4l2... +/dev/video0 opened. +No input was specified, using the first. +--- Capturing frame... +Corrupt JPEG data: 2 extraneous bytes before marker 0xd6 +Captured frame in 0.00 seconds. +--- Processing captured image... +Disabling banner. +Writing JPEG image to '2024-05-10_12-06-33.jpg'. +---- + +=== Capture a time lapse + +Use `cron` to schedule photo capture at a given interval. With the right interval, such as once a minute, you can capture a time lapse. + +First, open the cron table for editing: + +[source,console] +---- +$ crontab -e +---- + +Once you have the file open in an editor, add the following line to the schedule to take a picture every minute, replacing `` with your username: + +[,bash] +---- +* * * * * /home//webcam.sh 2>&1 +---- + +Save and exit, and you should see the following message: + +---- +crontab: installing new crontab +---- diff --git a/documentation/asciidoc/computers/camera_software.adoc b/documentation/asciidoc/computers/camera_software.adoc index 1d0581a99..a234811a7 100644 --- a/documentation/asciidoc/computers/camera_software.adoc +++ b/documentation/asciidoc/computers/camera_software.adoc @@ -2,8 +2,6 @@ include::camera/camera_usage.adoc[] include::camera/rpicam_apps_intro.adoc[] -include::camera/rpicam_apps_getting_started.adoc[] - include::camera/rpicam_hello.adoc[] include::camera/rpicam_jpeg.adoc[] @@ -12,19 +10,27 @@ include::camera/rpicam_still.adoc[] include::camera/rpicam_vid.adoc[] -include::camera/rpicam_apps_libav.adoc[] - include::camera/rpicam_raw.adoc[] include::camera/rpicam_detect.adoc[] +include::camera/rpicam_configuration.adoc[] + +include::camera/rpicam_apps_multicam.adoc[] + +include::camera/rpicam_apps_packages.adoc[] + +include::camera/streaming.adoc[] + include::camera/rpicam_options_common.adoc[] include::camera/rpicam_options_still.adoc[] include::camera/rpicam_options_vid.adoc[] -include::camera/libcamera_differences.adoc[] +include::camera/rpicam_options_libav.adoc[] + +include::camera/rpicam_options_detect.adoc[] include::camera/rpicam_apps_post_processing.adoc[] @@ -34,28 +40,22 @@ include::camera/rpicam_apps_post_processing_tflite.adoc[] include::camera/rpicam_apps_post_processing_writing.adoc[] -include::camera/rpicam_apps_multicam.adoc[] - -include::camera/rpicam_apps_packages.adoc[] - include::camera/rpicam_apps_building.adoc[] include::camera/rpicam_apps_writing.adoc[] -include::camera/libcamera_python.adoc[] - -include::camera/libcamera_3rd_party_tuning.adoc[] +include::camera/qt.adoc[] -include::camera/libcamera_known_issues.adoc[] +include::camera/libcamera_python.adoc[] -include::camera/rpicam_apps_getting_help.adoc[] +include::camera/webcams.adoc[] -include::camera/timelapse.adoc[] +include::camera/v4l2.adoc[] -include::camera/gstreamer.adoc[] +include::camera/csi-2-usage.adoc[] -include::camera/qt.adoc[] +include::camera/libcamera_differences.adoc[] -include::camera/v4l2.adoc[] +include::camera/troubleshooting.adoc[] -include::camera/csi-2-usage.adoc[] +include::camera/rpicam_apps_getting_help.adoc[] diff --git a/documentation/asciidoc/computers/compute-module.adoc b/documentation/asciidoc/computers/compute-module.adoc index 05c090516..97810c8bc 100644 --- a/documentation/asciidoc/computers/compute-module.adoc +++ b/documentation/asciidoc/computers/compute-module.adoc @@ -1,15 +1,13 @@ -include::compute-module/datasheet.adoc[] - -include::compute-module/designfiles.adoc[] +include::compute-module/introduction.adoc[] include::compute-module/cm-emmc-flashing.adoc[] +include::compute-module/cm-bootloader.adoc[] + include::compute-module/cm-peri-sw-guide.adoc[] include::compute-module/cmio-camera.adoc[] include::compute-module/cmio-display.adoc[] - - - +include::compute-module/datasheet.adoc[] diff --git a/documentation/asciidoc/computers/compute-module/cm-bootloader.adoc b/documentation/asciidoc/computers/compute-module/cm-bootloader.adoc new file mode 100644 index 000000000..aea936e1a --- /dev/null +++ b/documentation/asciidoc/computers/compute-module/cm-bootloader.adoc @@ -0,0 +1,55 @@ +== Compute Module EEPROM bootloader + +Since Compute Module 4, Compute Modules use an EEPROM bootloader. This bootloader lives in a small segment of on-board storage instead of the boot partition. As a result, it requires different procedures to update. Before using a Compute Module with an EEPROM bootloader in production, always follow these best practices: + +* Select a specific bootloader release. Verify that every Compute Module you use has that release. The version in the `usbboot` repo is always a recent stable release. +* Configure the boot device by xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[setting the `BOOT_ORDER` ]. +* Enable hardware write-protection on the bootloader EEPROM to ensure that the bootloader can't be modified on inaccessible products (such as remote or embedded devices). + +=== Flash Compute Module bootloader EEPROM + +To flash the bootloader EEPROM: + +. Set up the hardware as you would when xref:../computers/compute-module.adoc#flash-compute-module-emmc[flashing the eMMC], but ensure `EEPROM_nWP` is _not_ pulled low. +. Run the following command to write `recovery/pieeprom.bin` to the bootloader EEPROM: ++ +[source,console] +---- +$ ./rpiboot -d recovery +---- +. Once complete, `EEPROM_nWP` may be pulled low again. + +=== Flash storage devices other than SD cards + +The Linux-based https://github.com/raspberrypi/usbboot/blob/master/mass-storage-gadget/README.md[`mass-storage-gadget`] supports flashing of NVMe, eMMC and USB block devices. `mass-storage-gadget` writes devices faster than the firmware-based `rpiboot` mechanism, and also provides a UART console to the device for debugging. + +`usbboot` also includes a number of https://github.com/raspberrypi/usbboot/blob/master/Readme.md#compute-module-4-extensions[extensions] that enable you to interact with the EEPROM bootloader on a Compute Module. + +=== Update the Compute Module bootloader + +On Compute Modules with an EEPROM bootloader, ROM never runs `recovery.bin` from SD/eMMC. These Compute Modules disable the `rpi-eeprom-update` service by default, because eMMC is not removable and an invalid `recovery.bin` file could prevent the system from booting. + +You can override this behaviour with `self-update` mode. In `self-update` mode, you can update the bootloader from USB MSD or network boot. + +WARNING: `self-update` mode does not update the bootloader atomically. If a power failure occurs during an EEPROM update, you could corrupt the EEPROM. + +=== Modify the bootloader configuration + +To modify the Compute Module EEPROM bootloader configuration: + +. Navigate to the `usbboot/recovery` directory. +. If you require a specific bootloader release, replace `pieeprom.original.bin` with the equivalent from your bootloader release. +. Edit the default `boot.conf` bootloader configuration file to define a xref:../computers/raspberry-pi.adoc#BOOT_ORDER[`BOOT_ORDER`]: + * For network boot, use `BOOT_ORDER=0xf2`. + * For SD/eMMC boot, use `BOOT_ORDER=0xf1`. + * For USB boot failing over to eMMC, use `BOOT_ORDER=0xf15`. + * For NVMe boot, use `BOOT_ORDER=0xf6`. +. Run `./update-pieeprom.sh` to generate a new EEPROM image `pieeprom.bin` image file. +. If you require EEPROM write-protection, add `eeprom_write_protect=1` to `/boot/firmware/config.txt`. + * Once enabled in software, you can lock hardware write-protection by pulling the `EEPROM_nWP` pin low. +. Run the following command to write the updated `pieeprom.bin` image to EEPROM: ++ +[source,console] +---- +$ ../rpiboot -d . +---- diff --git a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc index a35723feb..664dd97c0 100644 --- a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc +++ b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc @@ -1,144 +1,164 @@ -== Flashing the Compute Module eMMC +[[flash-compute-module-emmc]] +== Flash an image to a Compute Module -[.whitepaper, title="Using the Compute Module provisioner", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003468-WP/Using-the-Compute-Module-Provisioner.pdf] -**** -The CM Provisioner is a web application designed to make programming a large number of Raspberry Pi Compute Module (CM) devices much easier and quicker. It is simple to install and simple to use. +TIP: To flash the same image to multiple Compute Modules, use the https://github.com/raspberrypi/rpi-sb-provisioner[Raspberry Pi Secure Boot Provisioner]. To customise an OS image to flash onto those devices, use https://github.com/RPi-Distro/pi-gen[pi-gen]. -It provides an interface to a database of kernel images that can be uploaded, along with the ability to use scripts to customise various parts of the installation during the flashing process. Label printing and firmware updating is also supported. -**** +[[flashing-the-compute-module-emmc]] -The Compute Module has an on-board eMMC device connected to the primary SD card interface. This guide explains how to write data to the eMMC storage using a Compute Module IO board. +The Compute Module has an on-board eMMC device connected to the primary SD card interface. This guide explains how to flash (write) an operating system image to the eMMC storage of a single Compute Module. -Please also read the section in the xref:compute-module.adoc#datasheets-and-schematics[Compute Module Datasheets]. +**Lite** variants of Compute Modules do not have on-board eMMC. Instead, follow the procedure to flash a storage device for other Raspberry Pi devices at xref:../computers/getting-started.adoc#installing-the-operating-system[Install an operating system]. -IMPORTANT: For mass provisioning of CM3, CM3+ and CM4 the https://github.com/raspberrypi/cmprovision[Raspberry Pi Compute Module Provisioning System] is recommended. +=== Prerequisites -=== Steps to flash the eMMC +To flash the Compute Module eMMC, you need the following: -To flash the Compute Module eMMC, you either need a Linux system (a Raspberry Pi is recommended, or Ubuntu on a PC) or a Windows system (Windows 10 is recommended). For BCM2837 (CM3), a bug which affected the Mac has been fixed, so this will also work. +* Another computer, referred to in this guide as the *host device*. You can use Linux (we recommend Raspberry Pi OS or Ubuntu), Windows 11, or macOS. +* The Compute Module IO Board xref:compute-module.adoc#io-board-compatibility[that corresponds to your Compute Module model]. +* A micro USB cable, or a USB-C cable for Compute Module models since CM5IO. -NOTE: There is a bug in the BCM2835 (CM1) bootloader which returns a slightly incorrect USB packet to the host. Most USB hosts seem to ignore this benign bug and work fine; we do, however, see some USB ports that don't work due to this bug. We don't quite understand why some ports fail, as it doesn't seem to be correlated with whether they are USB2 or USB3 (we have seen both types working), but it's likely to be specific to the host controller and driver. This bug has been fixed in BCM2837. +TIP: In some cases, USB hubs can prevent the host device from recognising the Compute Module. If your host device does not recognise the Compute Module, try connecting the Compute Module directly to the host device. For more diagnostic tips, see https://github.com/raspberrypi/usbboot?tab=readme-ov-file#troubleshooting[the usbboot troubleshooting guide]. -=== Setting up the CMIO board +=== Set up the IO Board -==== Compute Module 4 +To begin, physically set up your IO Board. This includes connecting the Compute Module and host device to the IO Board. -Ensure the Compute Module is fitted correctly installed on the IO board. It should lie flat on the IO board. +[tabs] +====== +Compute Module 5 IO Board:: ++ +To set up the Compute Module 5 IO Board: ++ +. Connect the Compute Module to the IO board. When connected, the Compute Module should lie flat. +. Fit `nRPI_BOOT` to J2 (`disable eMMC Boot`) on the IO board jumper. +. Connect a cable from USB-C slave port J11 on the IO board to the host device. -* Make sure that `nRPI_BOOT` which is on J2 (`disable eMMC Boot`) on the IO board jumper is fitted -* Use a micro USB cable to connect the micro USB slave port J11 on IO board to the host device -* Do not power up yet. +Compute Module 4 IO Board:: ++ +To set up the Compute Module 4 IO Board: ++ +. Connect the Compute Module to the IO board. When connected, the Compute Module should lie flat. +. Fit `nRPI_BOOT` to J2 (`disable eMMC Boot`) on the IO board jumper. +. Connect a cable from micro USB slave port J11 on the IO board to the host device. -==== Compute Module 1 and 3 +Compute Module IO Board:: ++ +To set up the Compute Module IO Board: ++ +. Connect the Compute Module to the IO board. When connected, the Compute Module should lie parallel to the board, with the engagement clips firmly clicked into place. +. Set J4 (`USB SLAVE BOOT ENABLE`) to 1-2 = (`USB BOOT ENABLED`) +. Connect a cable from micro USB slave port J15 on the IO board to the host device. +====== -Ensure the Compute Module itself is correctly installed on the IO board. It should lie parallel with the board, with the engagement clips clicked into place. +=== Set up the host device -* Make sure that J4 (USB SLAVE BOOT ENABLE) is set to the 'EN' position -* Use a micro USB cable to connect the micro USB slave port J15 on IO board to the host device -* Do not power up yet +Next, let's set up software on the host device. -==== For Windows users +TIP: For a host device, we recommend a Raspberry Pi 4 or newer running 64-bit Raspberry Pi OS. -Under Windows, an installer is available to install the required drivers and boot tool automatically. Alternatively, a user can compile and run it using Cygwin and/or install the drivers manually. - -==== Windows installer - -For those who just want to enable the Compute Module eMMC as a mass storage device under Windows, the stand-alone installer is the recommended option. This installer has been tested on Windows 10 64-bit. - -Please ensure you are not writing to any USB devices whilst the installer is running. - -* Download and run the https://github.com/raspberrypi/usbboot/raw/master/win32/rpiboot_setup.exe[Windows installer] to install the drivers and boot tool -* Plug your host PC USB into the USB slave port, making sure you have setup the board as described above -* Apply power to the board; Windows should now find the hardware and install the driver -* Once the driver installation is complete, run the `RPiBoot.exe` tool that was previously installed -* After a few seconds, the Compute Module eMMC will pop up under Windows as a disk (USB mass storage device) - -==== Building `rpiboot` on your host system. - -Instructions for building and running the latest release of `rpiboot` are documented in the https://github.com/raspberrypi/usbboot/blob/master/Readme.md#building[USB boot readme] on GitHub. +[tabs] +====== +Linux:: ++ +To set up software on a Linux host device: ++ +. Run the following command to install `rpiboot` (or, alternatively, https://github.com/raspberrypi/usbboot[build `rpiboot` from source]): ++ +[source,console] +---- +$ sudo apt install rpiboot +---- +. Connect the IO Board to power. +. Then, run `rpiboot`: ++ +[source,console] +---- +$ sudo rpiboot +---- +. After a few seconds, the Compute Module should appear as a mass storage device. Check the `/dev/` directory, likely `/dev/sda` or `/dev/sdb`, for the device. Alternatively, run `lsblk` and search for a device with a storage capacity that matches the capacity of your Compute Module. + +macOS:: ++ +To set up software on a macOS host device: ++ +. First, https://github.com/raspberrypi/usbboot?tab=readme-ov-file#macos[build `rpiboot` from source]. +. Connect the IO Board to power. +. Then, run the `rpiboot` executable with the following command: ++ +[source,console] +---- +$ rpiboot -d mass-storage-gadget64 +---- +. When the command finishes running, you should see a message stating "The disk you inserted was not readable by this computer." Click **Ignore**. Your Compute Module should now appear as a mass storage device. -==== Writing to the eMMC (Windows) +Windows:: ++ +To set up software on a Windows 11 host device: ++ +. Download the https://github.com/raspberrypi/usbboot/raw/master/win32/rpiboot_setup.exe[Windows installer] or https://github.com/raspberrypi/usbboot[build `rpiboot` from source]. +. Double-click on the installer to run it. This installs the drivers and boot tool. Do not close any driver installation windows which appear during the installation process. +. Reboot +. Connect the IO Board to power. Windows should discover the hardware and configure the required drivers. +. On CM4 and later devices, select **Raspberry Pi - Mass Storage Gadget - 64-bit** from the start menu. After a few seconds, the Compute Module eMMC or NVMe will appear as USB mass storage devices. This also provides a debug console as a serial port gadget. +. On CM3 and older devices, select **rpiboot**. Double-click on `RPiBoot.exe` to run it. After a few seconds, the Compute Module eMMC should appear as a USB mass storage device. -After `rpiboot` completes, a new USB mass storage drive will appear in Windows. We recommend using https://www.raspberrypi.com/software/[Raspberry Pi Imager] to write images to the drive. +====== -Make sure J4 (USB SLAVE BOOT ENABLE)/J2 (nRPI_BOOT) is set to the disabled position and/or nothing is plugged into the USB slave port. Power-cycling the IO board should now result in the Compute Module booting from eMMC. -==== Writing to the eMMC (Linux) +=== Flash the eMMC -After `rpiboot` completes, you will see a new device appear; this is commonly `/dev/sda` on a Raspberry Pi but it could be in another location such as `/dev/sdb`, so check in `/dev/` or run `lsblk` before running `rpiboot` so you can see what changes. +You can use xref:../computers/getting-started.adoc#raspberry-pi-imager[Raspberry Pi Imager] to flash an operating system image to a Compute Module. -You now need to write a raw OS image (such as https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-32-bit[Raspberry Pi OS]) to the device. Note the following command may take some time to complete, depending on the size of the image (change `/dev/sdX` to the appropriate device): +Alternatively, use `dd` to write a raw OS image (such as xref:../computers/os.adoc#introduction[Raspberry Pi OS]) to your Compute Module. Run the following command, replacing `/dev/sdX` with the path to the mass storage device representation of your Compute Module and `raw_os_image.img` with the path to your raw OS image: -[,bash] +[source,console] ---- -sudo dd if=raw_os_image_of_your_choice.img of=/dev/sdX bs=4MiB +$ sudo dd if=raw_os_image.img of=/dev/sdX bs=4MiB ---- -Once the image has been written, unplug and re-plug the USB; you should see two partitions appear (for Raspberry Pi OS) in `/dev`. In total, you should see something similar to this: +Once the image has been written, disconnect and reconnect the Compute Module. You should now see two partitions (for Raspberry Pi OS): -[,bash] +[source,console] ---- /dev/sdX <- Device /dev/sdX1 <- First partition (FAT) /dev/sdX2 <- Second partition (Linux filesystem) ---- -The `/dev/sdX1` and `/dev/sdX2` partitions can now be mounted normally. - -Make sure J4 (USB SLAVE BOOT ENABLE)/J2 (nRPI_BOOT) is set to the disabled position and/or that nothing is plugged into the USB slave port. Power-cycling the IO board should now result in the Compute Module booting from eMMC. +You can mount the `/dev/sdX1` and `/dev/sdX2` partitions normally. -[[cm4bootloader]] -=== Compute Module 4 bootloader +=== Boot from eMMC -The default bootloader configuration on CM4 is designed to support bringup and development on a https://www.raspberrypi.com/products/compute-module-4-io-board/[Compute Module 4 IO board], and the software version flashed at manufacture may be older than the latest release. For final products please consider: +[tabs] +====== +Compute Module 5 IO Board:: ++ +Disconnect `nRPI_BOOT` from J2 (`disable eMMC Boot`) on the IO board jumper. -* Selecting and verifying a specific bootloader release. The version in the `usbboot` repo is always a recent stable release. -* Configuring the boot device (e.g. network boot). See `BOOT_ORDER` section in the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] guide. -* Enabling hardware write-protection on the bootloader EEPROM to ensure that the bootloader can't be modified on inaccessible products (such as remote or embedded devices). +Compute Module 4 IO Board:: ++ +Disconnect `nRPI_BOOT` from J2 (`disable eMMC Boot`) on the IO board jumper. -NOTE: The Compute Module 4 ROM never runs `recovery.bin` from SD/EMMC and the `rpi-eeprom-update` service is not enabled by default. This is necessary because the EMMC is not removable and an invalid `recovery.bin` file would prevent the system from booting. This can be overridden and used with `self-update` mode where the bootloader can be updated from USB MSD or network boot. However, `self-update` mode is not an atomic update and therefore is not safe in the event of a power failure while the EEPROM is being updated. +Compute Module IO Board:: ++ +Set J4 (`USB SLAVE BOOT ENABLE`) to 2-3 (`USB BOOT DISABLED`). +====== -==== Flashing storage devices other than SD cards +==== Boot -The Linux-based https://github.com/raspberrypi/usbboot/blob/master/mass-storage-gadget/README.md[mass-storage gadget] supports flashing of NVMe, EMMC and USB block devices. This is normally faster than using the `rpiboot` firmware driver and also provides a UART console to the device for easier debug. +Disconnect the USB slave port. Power-cycle the IO board to boot the Compute Module from the new image you just wrote to eMMC. -See also: https://github.com/raspberrypi/usbboot/blob/master/Readme.md#compute-module-4-extensions[CM4 rpiboot extensions]. +=== Known issues -==== Modifying the bootloader configuration - -To modify the CM4 bootloader configuration: - -* Navigate to the `usbboot/recovery` directory -* Replace `pieeprom.original.bin` if a specific bootloader release is required -* Edit the default `boot.conf` bootloader configuration file; typically, at least the BOOT_ORDER must be updated: - ** For network boot, use `BOOT_ORDER=0xf2` - ** For SD/EMMC boot, use `BOOT_ORDER=0xf1` - ** For USB boot failing over to EMMC, use `BOOT_ORDER=0xf15` -* Run `./update-pieeprom.sh` to update the EEPROM image `pieeprom.bin` image file -* If EEPROM write-protection is required, edit `config.txt` and add `eeprom_write_protect=1`. Hardware write-protection must be enabled via software and then locked by pulling the `EEPROM_nWP` pin low -* Run `../rpiboot -d .` to update the bootloader using the updated EEPROM image `pieeprom.bin` - -The `pieeprom.bin` file is now ready to be flashed to Compute Module 4. - -==== Flashing the bootloader EEPROM - Compute Module 4 - -To flash the bootloader EEPROM, follow the same hardware setup as for flashing the EMMC, but also ensure EEPROM_nWP is NOT pulled low. Once complete `EEPROM_nWP` may be pulled low again. - -[,bash] +* A small percentage of CM3 devices may experience problems booting. We have traced these back to the method used to create the FAT32 partition; we believe the problem is due to a difference in timing between the CPU and eMMC. If you have trouble booting your CM3, create the partitions manually with the following commands: ++ +[source,console] ---- -# Writes recovery/pieeprom.bin to the bootloader EEPROM. -./rpiboot -d recovery ----- - -=== Troubleshooting - -For a small percentage of Raspberry Pi Compute Module 3s, booting problems have been reported. We have traced these back to the method used to create the FAT32 partition; we believe the problem is due to a difference in timing between the BCM2835/6/7 and the newer eMMC devices. The following method of creating the partition is a reliable solution in our hands. - -[,bash] ----- -sudo parted /dev/ +$ sudo parted /dev/ (parted) mkpart primary fat32 4MiB 64MiB (parted) q -sudo mkfs.vfat -F32 /dev/ -sudo cp -r /* +$ sudo mkfs.vfat -F32 /dev/ +$ sudo cp -r /* ---- + +* The CM1 bootloader returns a slightly incorrect USB packet to the host. Most USB hosts ignore it, but some USB ports don't work due to this bug. CM3 fixed this bug. diff --git a/documentation/asciidoc/computers/compute-module/cm-peri-sw-guide.adoc b/documentation/asciidoc/computers/compute-module/cm-peri-sw-guide.adoc index 1a599937c..cb1beac88 100644 --- a/documentation/asciidoc/computers/compute-module/cm-peri-sw-guide.adoc +++ b/documentation/asciidoc/computers/compute-module/cm-peri-sw-guide.adoc @@ -1,46 +1,47 @@ -== Attaching and enabling peripherals +== Wire peripherals -This guide is designed to help developers using Compute Modules get to grips with how to wire up peripherals to the Compute Module pins, and how to make changes to the software to enable these peripherals to work correctly. +This guide helps developers wire up peripherals to the Compute Module pins, and explains how to enable these peripherals in software. -The Compute Modules carry the Raspberry Pi system on a chip (SoC), or processor (BCM2835 for CM1, BCM2837 for CM3 and BCM2711 for CM4) alongside memory and eMMC. The eMMC is similar to an SD card but is soldered onto the board. Unlike SD cards, the eMMC is specifically designed to be used as a disk and has extra features that make it more reliable in this use case. Most of the pins of the SoC (GPIO, two CSI camera interfaces, two DSI display interfaces, HDMI etc) are left available and can be wired up as the user sees fit (or, if unused, can usually be left unconnected). The Compute Module is a DDR2 SODIMM form-factor-compatible module, so any DDR2 SODIMM socket should be able to be used. +Most of the pins of the SoC, including the GPIO, two CSI camera interfaces, two DSI display interfaces, and HDMI are available for wiring. You can can usually leave unused pins disconnected. -NOTE: The pinout is NOT the same as an actual SODIMM memory module. +Compute Modules that come in the DDR2 SODIMM form factor are physically compatible with any DDR2 SODIMM socket. However, the pinout is **not** the same as SODIMM memory modules. -To use the Compute Module, a user needs to design a (relatively simple) motherboard which can provide power to the Compute Module (3.3V and 1.8V at minimum), and which connects the pins to the required peripherals for the user's application. +To use a Compute Module, a user must design a motherboard that: -Raspberry Pi provides a minimal Compute Module motherboard (called the Compute Module IO Board, or CMIO Board) for prototyping, which powers the module, brings out the GPIO to pin headers, and brings the camera and display interfaces out to FFC connectors. It also provides HDMI, USB, and an 'ACT' LED, as well as the ability to program the eMMC of a module via USB from a PC or Raspberry Pi. +* provides power to the Compute Module (3.3V and 1.8V at minimum) +* connects the pins to the required peripherals for the user's application -This guide first explains the boot process and how Device Tree is used to describe attached hardware. These are essential things to understand when designing with the Compute Module. It then provides a worked example of attaching an I2C and an SPI peripheral to a CMIO (or CMIO V3 for CM3) Board and creating the Device Tree files necessary to make both peripherals work under Linux, starting from a vanilla Raspberry Pi OS image. +This guide first explains the boot process and how Device Tree describes attached hardware. -=== BCM283x GPIOs +Then, we'll explain how to attach an I2C and an SPI peripheral to an IO Board. Finally, we'll create the Device Tree files necessary to use both peripherals with Raspberry Pi OS. -BCM283x has three banks of general-purpose input/output (GPIO) pins: 28 pins on Bank 0, 18 pins on Bank 1, and 8 pins on Bank 2, making 54 pins in total. These pins can be used as true GPIO pins, i.e. software can set them as inputs or outputs, read and/or set state, and use them as interrupts. They also can be set to 'alternate functions' such as I2C, SPI, I2S, UART, SD card, and others. +=== BCM283x GPIOs -On a Compute Module, both Bank 0 and Bank 1 are free to use. Bank 2 is used for eMMC and HDMI hot plug detect and ACT LED/USB boot control. +BCM283x has three banks of general-purpose input/output (GPIO) pins: 28 pins on Bank 0, 18 pins on Bank 1, and 8 pins on Bank 2, for a total of 54 pins. These pins can be used as true GPIO pins: software can set them as inputs or outputs, read and/or set state, and use them as interrupts. They also can run alternate functions such as I2C, SPI, I2S, UART, SD card, and others. -It is useful on a running system to look at the state of each of the GPIO pins (what function they are set to, and the voltage level at the pin) so that you can see if the system is set up as expected. This is particularly helpful if you want to see if a Device Tree is working as expected, or to get a look at the pin states during hardware debug. +You can use Bank 0 or Bank 1 on any Compute Module. Don't use Bank 2: it controls eMMC, HDMI hot plug detect, and ACT LED/USB boot control. -Raspberry Pi provides the `pinctrl` package, which is a tool for hacking and debugging GPIO. +Use `pinctrl` to check the voltage and function of the GPIO pins to see if your Device Tree is working as expected. === BCM283x boot process -BCM283x devices consist of a VideoCore GPU and Arm CPU cores. The GPU is in fact a system consisting of a DSP processor and hardware accelerators for imaging, video encode and decode, 3D graphics, and image compositing. +BCM283x devices have a VideoCore GPU and Arm CPU cores. The GPU consists of a DSP processor and hardware accelerators for imaging, video encode and decode, 3D graphics, and image compositing. -In BCM283x devices, it is the DSP core in the GPU that boots first. It is responsible for general setup and housekeeping before booting up the main Arm processor(s). +In BCM283x devices, the DSP core in the GPU boots first. It handles setup before booting up the main Arm processors. -The BCM283x devices as used on Raspberry Pi and Compute Module boards have a three-stage boot process: +Raspberry Pi BCM283x devices have a three-stage boot process: -* The GPU DSP comes out of reset and executes code from a small internal ROM (the boot ROM). The sole purpose of this code is to load a second-stage boot loader via one of the external interfaces. On a Raspberry Pi or Compute Module, this code first looks for a second-stage boot loader on the SD card (eMMC); it expects this to be called `bootcode.bin` and to be on the first partition (which must be FAT32). If no SD card is found or `bootcode.bin` is not found, the boot ROM sits and waits in USB boot mode, waiting for a host to give it a second-stage boot loader via the USB interface. -* The second-stage boot loader (`bootcode.bin` on the sdcard or `usbbootcode.bin` for USB boot) is responsible for setting up the LPDDR2 SDRAM interface and various other critical system functions, and then loading and executing the main GPU firmware (called `start.elf`, again on the primary SD card partition). -* `start.elf` takes over and is responsible for further system setup and booting up the Arm processor subsystem, and contains the firmware that runs on the various parts of the GPU. It first reads `dt-blob.bin` to determine initial GPIO pin states and GPU-specific interfaces and clocks, then parses `config.txt`. It then loads an Arm device tree file (e.g. `bcm2708-rpi-cm.dtb` for a Compute Module 1) and any Device Tree overlays specified in `config.txt` before starting the ARM subsystem and passing the Device Tree data to the booting Linux kernel. +* The GPU DSP comes out of reset and executes code from the small internal boot ROM. This code loads a second-stage bootloader via an external interface. This code first looks for a second-stage boot loader on the boot device called `bootcode.bin` on the boot partition. If no boot device is found or `bootcode.bin` is not found, the boot ROM waits in USB boot mode for a host to provide a second-stage boot loader (`usbbootcode.bin`). +* The second-stage boot loader is responsible for setting up the LPDDR2 SDRAM interface and other critical system functions. Once set up, the second-stage boot loader loads and executes the main GPU firmware (`start.elf`). +* `start.elf` handles additional system setup and boots up the Arm processor subsystem. It contains the GPU firmware. The GPU firmware first reads `dt-blob.bin` to determine initial GPIO pin states and GPU-specific interfaces and clocks, then parses `config.txt`. It then loads a model-specific Arm device tree file and any Device Tree overlays specified in `config.txt` before starting the Arm subsystem and passing the Device Tree data to the booting Linux kernel. === Device Tree -http://www.devicetree.org/[Device Tree] is a special way of encoding all the information about the hardware attached to a system (and consequently the required drivers). +xref:configuration.adoc#device-trees-overlays-and-parameters[Linux Device Tree for Raspberry Pi] encodes information about hardware attached to a system as well as the drivers used to communicate with that hardware. -On a Raspberry Pi or Compute Module there are several files in the first FAT partition of the SD/eMMC that are binary Device Tree files. These binary files (usually with extension `.dtb`) are compiled from human-readable text descriptions (usually files with extension `.dts`) by the Device Tree compiler. +The boot partition contains several binary Device Tree (`.dtb`) files. The Device Tree compiler creates these binary files using human-readable Device Tree descriptions (`.dts`). -On a standard Raspberry Pi OS image in the first (FAT) partition you will find two different types of Device Tree files. One is used by the GPU only, and the rest are standard Arm Device Tree files for each of the BCM283x-based Raspberry Pi products: +The boot partition contains two different types of Device Tree files. One is used by the GPU only; the rest are standard Arm Device Tree files for each of the BCM283x-based Raspberry Pi products: * `dt-blob.bin` (used by the GPU) * `bcm2708-rpi-b.dtb` (Used for Raspberry Pi 1 Models A and B) @@ -50,172 +51,185 @@ On a standard Raspberry Pi OS image in the first (FAT) partition you will find t * `bcm2708-rpi-cm.dtb` (Used for Raspberry Pi Compute Module 1) * `bcm2710-rpi-cm3.dtb` (Used for Raspberry Pi Compute Module 3) -NOTE: `dt-blob.bin` does not exist by default as there is a version compiled into `start.elf`, but for Compute Module projects it will often be necessary to provide a `dt-blob.bin` (which overrides the default built-in file). -+ - `dt-blob.bin` is in compiled Device Tree format, but is only read by the GPU firmware to set up functions exclusive to the GPU - see below. +During boot, the user can specify a specific Arm Device Tree to use via the `device_tree` parameter in `config.txt`. For example, the line `device_tree=mydt.dtb` in `config.txt` specifies an Arm Device Tree in a file named `mydt.dtb`. + +You can create a full Device Tree for a Compute Module product, but we recommend using **overlays** instead. Overlays add descriptions of non-board-specific hardware to the base Device Tree. This includes GPIO pins used and their function, as well as the devices attached, so that the correct drivers can be loaded. The bootloader merges overlays with the base Device Tree before passing the Device Tree to the Linux kernel. Occasionally the base Device Tree changes, usually in a way that will not break overlays. + +Use the `dtoverlay` parameter in `config.txt` to load Device Tree overlays. Raspberry Pi OS assumes that all overlays are located in the `/overlays` directory and use the suffix `-overlay.dtb`. For example, the line `dtoverlay=myoverlay` loads the overlay `/overlays/myoverlay-overlay.dtb`. + +To wire peripherals to a Compute Module, describe all hardware attached to the Bank 0 and Bank 1 GPIOs in an overlay. This allows you to use standard Raspberry Pi OS images, since the overlay is merged into the standard base Device Tree. Alternatively, you can define a custom Device Tree for your application, but you won't be able to use standard Raspberry Pi OS images. Instead, you must create a modified Raspberry Pi OS image that includes your custom device tree for every OS update you wish to distribute. If the base overlay changes, you might need to update your customised Device Tree. + +=== `dt-blob.bin` -* A guide to xref:configuration.adoc#change-the-default-pin-configuration[creating `dt-blob.bin`]. -* A guide to the xref:configuration.adoc#device-trees-overlays-and-parameters[Linux Device Tree for Raspberry Pi]. +When `start.elf` runs, it first reads `dt-blob.bin`. This is a special form of Device Tree blob which tells the GPU how to set up the GPIO pin states. -During boot, the user can specify a specific Arm Device Tree to use via the `device_tree` parameter in `config.txt`, for example adding the line `device_tree=mydt.dtb` to `config.txt` where `mydt.dtb` is the dtb file to load instead of one of the standard Arm dtb files. While a user can create a full Device Tree for their Compute Module product, the recommended way to add hardware is to use overlays (see next section). +`dt-blob.bin` contains information about GPIOs and peripherals controlled by the GPU, instead of the SoC. For example, the GPU manages Camera Modules. The GPU needs exclusive access to an I2C interface and a couple of pins to talk to a Camera Module. -In addition to loading an Arm dtb, `start.elf` supports loading additional Device Tree overlays via the `dtoverlay` parameter in `config.txt`, for example adding as many `dtoverlay=myoverlay` lines as required as overlays to `config.txt`, and noting that overlays live in `/overlays` and are suffixed `-overlay.dtb` (e.g. `/overlays/myoverlay-overlay.dtb`). Overlays are merged with the base dtb file before the data is passed to the Linux kernel when it starts. +On most Raspberry Pi models, I2C0 is reserved for exclusive GPU use. `dt-blob.bin` defines the GPIO pins used for I2C0. -Overlays are used to add data to the base dtb that (nominally) describes non-board-specific hardware. This includes GPIO pins used and their function, as well as the device(s) attached, so that the correct drivers can be loaded. The convention is that on a Raspberry Pi, all hardware attached to the Bank0 GPIOs (the GPIO header) should be described using an overlay. On a Compute Module all hardware attached to the Bank0 and Bank1 GPIOs should be described in an overlay file. You don't have to follow these conventions: you can roll all the information into one single dtb file, as previously described, replacing `bcm2708-rpi-cm.dtb`. However, following the conventions means that you can use a standard Raspberry Pi OS release, with its standard base dtb and all the product-specific information contained in a separate overlay. Occasionally the base dtb might change - usually in a way that will not break overlays - which is why using an overlay is suggested. +By default, `dt-blob.bin` does not exist. Instead, `start.elf` includes a built-in version of the file. Many Compute Module projects provide a custom `dt-blob.bin` which overrides the default built-in file. -=== dt-blob.bin +`dt-blob.bin` specifies: -When `start.elf` runs, it first reads something called `dt-blob.bin`. This is a special form of Device Tree blob which tells the GPU how to (initially) set up the GPIO pin states, and also any information about GPIOs/peripherals that are controlled (owned) by the GPU, rather than being used via Linux on the Arm. For example, the Raspberry Pi Camera peripheral is managed by the GPU, and the GPU needs exclusive access to an I2C interface to talk to it, as well as a couple of control pins. I2C0 on most Raspberry Pi Boards and Compute Modules is nominally reserved for exclusive GPU use. The information on which GPIO pins the GPU should use for I2C0, and to control the camera functions, comes from `dt-blob.bin`. +* the pin used for HDMI hot plug detect +* GPIO pins used as a GPCLK output +* an ACT LED that the GPU can use while booting -NOTE: The `start.elf` firmware has a xref:configuration.adoc#change-the-default-pin-configuration[built-in default] `dt-blob.bin` which is used if no `dt-blob.bin` is found on the root of the first FAT partition. Most Compute Module projects will want to provide their own custom `dt-blob.bin`. Note that `dt-blob.bin` specifies which pin is for HDMI hot plug detect, although this should never change on Compute Module. It can also be used to set up a GPIO as a GPCLK output, and specify an ACT LED that the GPU can use while booting. Other functions may be added in future. +https://datasheets.raspberrypi.com/cm/minimal-cm-dt-blob.dts[`minimal-cm-dt-blob.dts`] is an example `.dts` device tree file. It sets up HDMI hot plug detection, an ACT LED, and sets all other GPIOs as inputs with default pulls. -https://datasheets.raspberrypi.com/cm/minimal-cm-dt-blob.dts[minimal-cm-dt-blob.dts] is an example `.dts` device tree file that sets up the HDMI hot plug detect and ACT LED and sets all other GPIOs to be inputs with default pulls. +To compile `minimal-cm-dt-blob.dts` to `dt-blob.bin`, use the xref:configuration.adoc#device-trees-overlays-and-parameters[Device Tree compiler] `dtc`. +To install `dtc` on a Raspberry Pi, run the following command: -To compile the `minimal-cm-dt-blob.dts` to `dt-blob.bin` use the Device Tree compiler `dtc`: +[source,console] +---- +$ sudo apt install device-tree-compiler +---- + +Then, run the follow command to compile `minimal-cm-dt-blob.dts` into `dt-blob.bin`: +[source,console] ---- -dtc -I dts -O dtb -o dt-blob.bin minimal-cm-dt-blob.dts +$ dtc -I dts -O dtb -o dt-blob.bin minimal-cm-dt-blob.dts ---- +For more information, see our xref:configuration.adoc#change-the-default-pin-configuration[guide to creating `dt-blob.bin`]. + === Arm Linux Device Tree -After `start.elf` has read `dt-blob.bin` and set up the initial pin states and clocks, it reads xref:config_txt.adoc[`config.txt`] which contains many other options for system setup. +After `start.elf` reads `dt-blob.bin` and sets up the initial pin states and clocks, it reads xref:config_txt.adoc[`config.txt`], which contains many other options for system setup. -After reading `config.txt` another device tree file specific to the board the hardware is running on is read: this is `bcm2708-rpi-cm.dtb` for a Compute Module 1, or `bcm2710-rpi-cm.dtb` for Compute Module 3. This file is a standard ARM Linux device tree file, which details how hardware is attached to the processor: it enumerates what peripheral devices exist in the SoC and where, which GPIOs are used, what functions those GPIOs have, and what physical devices are connected. This file will set up the GPIOs appropriately, overwriting the pin state set up in `dt-blob.bin` if it is different. It will also try to load driver(s) for the specific device(s). +After reading `config.txt`, `start.elf` reads a model-specific Device Tree file. For instance, Compute Module 3 uses `bcm2710-rpi-cm.dtb`. This file is a standard Arm Linux Device Tree file that details hardware attached to the processor. It enumerates: -Although the `bcm2708-rpi-cm.dtb` file can be used to load all attached devices, the recommendation for Compute Module users is to leave this file alone. Instead, use the one supplied in the standard Raspberry Pi OS software image, and add devices using a custom 'overlay' file as previously described. The `bcm2708-rpi-cm.dtb` file contains (disabled) entries for the various peripherals (I2C, SPI, I2S etc.). It contains no GPIO pin definitions other than the eMMC/SD Card peripheral which has GPIO defs and is enabled, because it is always on the same pins. The separate overlay file will enable the required interfaces, describe the pins used, and also describe the required drivers. The `start.elf` firmware will read and merge the `bcm2708-rpi-cm.dtb` with the overlay data before giving the merged Device Tree to the Linux kernel as it boots up. +* what and where peripheral devices exist +* which GPIOs are used +* what functions those GPIOs have +* what physical devices are connected -=== Device Tree source and compilation +This file sets up the GPIOs by overwriting the pin state in `dt-blob.bin` if it is different. It will also try to load drivers for the specific devices. -The Raspberry Pi OS image provides compiled dtb files, but where are the source dts files? They live in the Raspberry Pi Linux kernel branch, on https://github.com/raspberrypi/linux[GitHub]. Look in the `arch/arm/boot/dts` folder. +The model-specific Device Tree file contains disabled entries for peripherals. It contains no GPIO pin definitions other than the eMMC/SD Card peripheral which has GPIO defs and always uses the same pins. -Some default overlay dts files live in `arch/arm/boot/dts/overlays`. Corresponding overlays for standard hardware that can be attached to a Raspberry Pi in the Raspberry Pi OS image are on the FAT partition in the `/overlays` directory. Note that these assume certain pins on BANK0, as they are for use on a Raspberry Pi. In general, use the source of these standard overlays as a guide to creating your own, unless you are using the same GPIO pins as you would be using if the hardware was plugged into the GPIO header of a Raspberry Pi. +=== Device Tree source and compilation -Compiling these dts files to dtb files requires an up-to-date version of the xref:configuration.adoc#device-trees-overlays-and-parameters[Device Tree compiler] `dtc`. The way to install an appropriate version on Raspberry Pi is to run: +The Raspberry Pi OS image provides compiled `dtb` files, but the source `dts` files live in the https://github.com/raspberrypi/linux/tree/rpi-6.6.y/arch/arm/boot/dts/broadcom[Raspberry Pi Linux kernel branch]. Look for `rpi` in the file names. ----- -sudo apt install device-tree-compiler ----- +Default overlay `dts` files live at https://github.com/raspberrypi/linux/tree/rpi-6.6.y/arch/arm/boot/dts/overlays[`arch/arm/boot/dts/overlays`]. These overlay files are a good starting point for creating your own overlays. To compile these `dts` files to `dtb` files, use the xref:configuration.adoc#device-trees-overlays-and-parameters[Device Tree compiler] `dtc`. -If you are building your own kernel then the build host also gets a version in `scripts/dtc`. You can arrange for your overlays to be built automatically by adding them to `Makefile` in `arch/arm/boot/dts/overlays`, and using the 'dtbs' make target. +When building your own kernel, the build host requires the Device Tree compiler in `scripts/dtc`. To build your overlays automatically, add them to the `dtbs` make target in `arch/arm/boot/dts/overlays/Makefile`. === Device Tree debugging -When the Linux kernel is booted on the Arm core(s), the GPU provides it with a fully assembled Device Tree, assembled from the base dts and any overlays. This full tree is available via the Linux proc interface in `/proc/device-tree`, where nodes become directories and properties become files. +When booting the Linux kernel, the GPU provides a fully assembled Device Tree created using the base `dts` and any overlays. This full tree is available via the Linux `proc` interface in `/proc/device-tree`. Nodes become directories and properties become files. -You can use `dtc` to write this out as a human readable dts file for debugging. You can see the fully assembled device tree, which is often very useful: +You can use `dtc` to write this out as a human readable `dts` file for debugging. To see the fully assembled device tree, run the following command: +[source,console] ---- -dtc -I fs -O dts -o proc-dt.dts /proc/device-tree +$ dtc -I fs -O dts -o proc-dt.dts /proc/device-tree ---- -As previously explained in the GPIO section, it is also very useful to use `pinctrl` to look at the setup of the GPIO pins to check that they are as you expect. If something seems to be going awry, useful information can also be found by dumping the GPU log messages: +`pinctrl` provides the status of the GPIO pins. If something seems to be going awry, try dumping the GPU log messages: +[source,console] ---- -sudo vclog --msg +$ sudo vclog --msg ---- -You can include more diagnostics in the output by adding `dtdebug=1` to `config.txt`. +TIP: To include even more diagnostics in the output, add `dtdebug=1` to `config.txt`. -=== Examples +Use the https://forums.raspberrypi.com/viewforum.php?f=107[Device Tree Raspberry Pi forum] to ask Device Tree-related questions or report an issue. -NOTE: Please use the https://forums.raspberrypi.com/viewforum.php?f=107[Device Tree subforum] on the Raspberry Pi forums to ask Device Tree-related questions, or to post any issues, questions or bugs. +=== Examples -For these simple examples we used a CMIO board with peripherals attached via jumper wires. We assume a CM1+CMIO or CM3+CMIO3 board with a clean install of the latest Raspberry Pi OS Lite version on the Compute Module. The examples here require internet connectivity, so a USB hub plus keyboard plus wireless LAN or Ethernet dongle plugged into the CMIO USB port is recommended. +The following examples use an IO Board with peripherals attached via jumper wires. We assume a CM1+CMIO or CM3+CMIO3, running a clean install of Raspberry Pi OS Lite. The examples here require internet connectivity, so we recommend a USB hub, keyboard, and wireless LAN or Ethernet dongle plugged into the IO Board USB port. -[discrete] -=== Example 1 - attaching an I2C RTC to BANK1 pins +==== Attach an I2C RTC to Bank 1 pins -In this simple example we wire an NXP PCF8523 real time clock (RTC) to the CMIO board BANK1 GPIO pins: 3V3, GND, I2C1_SDA on GPIO44 and I2C1_SCL on GPIO45. +In this example, we wire an NXP PCF8523 real time clock (RTC) to the IO Board Bank 1 GPIO pins: 3V3, GND, I2C1_SDA on GPIO44 and I2C1_SCL on GPIO45. -Download https://datasheets.raspberrypi.com/cm/minimal-cm-dt-blob.dts[minimal-cm-dt-blob.dts] and copy it to the SD card FAT partition, located in `/boot/firmware/` when the Compute Module has booted. +Download https://datasheets.raspberrypi.com/cm/minimal-cm-dt-blob.dts[`minimal-cm-dt-blob.dts`] and copy it to the boot partition in `/boot/firmware/`. Edit `minimal-cm-dt-blob.dts` and change the pin states of GPIO44 and 45 to be I2C1 with pull-ups: +[source,console] ---- -sudo nano /boot/firmware/minimal-cm-dt-blob.dts +$ sudo nano /boot/firmware/minimal-cm-dt-blob.dts ---- -Change lines: +Replace the following lines: +[source,kotlin] ---- pin@p44 { function = "input"; termination = "pull_down"; }; // DEFAULT STATE WAS INPUT NO PULL pin@p45 { function = "input"; termination = "pull_down"; }; // DEFAULT STATE WAS INPUT NO PULL ---- -to: +With the following pull-up definitions: +[source,kotlin] ---- pin@p44 { function = "i2c1"; termination = "pull_up"; }; // SDA1 pin@p45 { function = "i2c1"; termination = "pull_up"; }; // SCL1 ---- -NOTE: We could use this `dt-blob.dts` with no changes. The Linux Device Tree will (re)configure these pins during Linux kernel boot when the specific drivers are loaded, so it is up to you whether you modify `dt-blob.dts`. You may wish to configure `dt-blob.dts` to what you expect the final GPIOs to be, as they are then set to their final state as soon as possible during the GPU boot stage, but this is not strictly necessary. You may find that in some cases you do need pins to be configured at GPU boot time, so they are in a specific state when Linux drivers are loaded. For example, a reset line may need to be held in the correct orientation. +We could use this `dt-blob.dts` with no changes, because the Linux Device Tree re-configures these pins during Linux kernel boot when the specific drivers load. However, if you configure `dt-blob.dts`, the GPIOs reach their final state as soon as possible during the GPU boot stage. In some cases, pins must be configured at GPU boot time so they are in a specific state when Linux drivers are loaded. For example, a reset line may need to be held in the correct orientation. -Compile `dt-blob.bin`: +Run the following command to compile `dt-blob.bin`: +[source,console] ---- -sudo dtc -I dts -O dtb -o /boot/firmware/dt-blob.bin /boot/firmware/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], put it in `/boot/firmware/`, then compile it: +Download https://datasheets.raspberrypi.com/cm/example1-overlay.dts[`example1-overlay.dts`], copy it to the boot partition in `/boot/firmware/`, then compile it with the following command: +[source,console] ---- -sudo dtc -@ -I dts -O dtb -o /boot/firmware/overlays/example1.dtbo /boot/firmware/example1-overlay.dts +$ sudo dtc -@ -I dts -O dtb -o /boot/firmware/overlays/example1.dtbo /boot/firmware/example1-overlay.dts ---- -NOTE: Pay attention to the '-@' in the `dtc` command line. This is necessary if you are compiling dts files with external references, which is what overlays tend to be. +The `-@` flag compiles `dts` files with external references. It is usually necessary. -Edit xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] and add the line: +Add the following line to xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]: +[source,ini] ---- dtoverlay=example1 ---- -Now save and reboot. +Finally, reboot with `sudo reboot`. -Once rebooted, you should see an rtc0 entry in /dev. Running: +Once rebooted, you should see an `rtc0` entry in `/dev`. Run the following command to view the hardware clock time: +[source,console] ---- -sudo hwclock +$ sudo hwclock ---- -...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/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 3.3V. +==== Attach an ENC28J60 SPI Ethernet controller on Bank 0 -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. +In this example, we use an overlay already defined in `/boot/firmware/overlays` to add an ENC28J60 SPI Ethernet controller to Bank 0. The Ethernet controller uses SPI pins CE0, MISO, MOSI and SCLK (GPIO8-11 respectively), GPIO25 for a falling edge interrupt, in addition to GND and 3.3V. -Edit `/boot/firmware/config.txt` and add the following line: +In this example, we won't change `dt-blob.bin`. Instead, add the following line to `/boot/firmware/config.txt`: +[source,ini] ---- dtoverlay=enc28j60 ---- -Now save and reboot. +Reboot with `sudo reboot`. -Once rebooted you should see, as before, an rtc0 entry in /dev. Running: +If you now run `ifconfig` you should see an aditional `eth` entry for the ENC28J60 NIC. You should also have Ethernet connectivity. Run the following command to test your connectivity: +[source,console] ---- -sudo hwclock +$ ping 8.8.8.8 ---- -...will return with the hardware clock time, and not an error. - -You should also have Ethernet connectivity: - ----- -ping 8.8.8.8 ----- - -Finally running: +Run the following command to show GPIO functions; GPIO8-11 should now provide ALT0 (SPI) functions: +[source,console] ---- -pinctrl +$ pinctrl ---- -...should show that GPIO8-11 have changed to ALT0 (SPI) functions. - diff --git a/documentation/asciidoc/computers/compute-module/cmio-camera.adoc b/documentation/asciidoc/computers/compute-module/cmio-camera.adoc index 479cde2d6..f65fb187f 100644 --- a/documentation/asciidoc/computers/compute-module/cmio-camera.adoc +++ b/documentation/asciidoc/computers/compute-module/cmio-camera.adoc @@ -1,14 +1,15 @@ -== Attach a Raspberry Pi Camera Module +== Attach a Camera Module The Compute Module has two CSI-2 camera interfaces: CAM1 and CAM0. This section explains how to connect one or two Raspberry Pi Cameras to a Compute Module using the CAM1 and CAM0 interfaces with a Compute Module I/O Board. === Update your system -Before configuring a camera, ensure your system runs the latest available software: +Before configuring a camera, xref:../computers/raspberry-pi.adoc#update-the-bootloader-configuration[ensure that your Raspberry Pi firmware is up-to-date].: +[source,console] ---- -sudo apt update -sudo apt full-upgrade +$ sudo apt update +$ sudo apt full-upgrade ---- === Connect one camera @@ -18,7 +19,12 @@ To connect a single camera to a Compute Module, complete the following steps: . Disconnect the Compute Module from power. . Connect the Camera Module to the CAM1 port using a RPI-CAMERA board or a Raspberry Pi Zero camera cable. + -image::images/CMIO-Cam-Adapter.jpg[Connecting the adapter board] +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` @@ -26,28 +32,32 @@ image::images/CMIO-Cam-Adapter.jpg[Connecting the adapter board] * `2` to `CAM1_I01` * `3` to `CAM1_I00` + -image::images/CMIO-Cam-GPIO.jpg[GPIO connection for a single camera] +image::images/CMIO-Cam-GPIO.jpg[alt="GPIO connection for a single camera", width="60%"] . Reconnect the Compute Module to power. . Remove (or comment out with the prefix `#`) the following lines, if they exist, in `/boot/firmware/config.txt`: + +[source,ini] ---- camera_auto_detect=1 ---- + +[source,ini] ---- dtparam=i2c_arm=on ---- . _(CM1, CM3, CM3+, and CM4S only)_: Add the following directive to `/boot/firmware/config.txt` to accommodate the swapped GPIO pin assignment on the I/O board: + +[source,ini] ---- dtoverlay=cm-swap-i2c0 ---- . _(CM1, CM3, CM3+, and CM4S only)_: Add the following directive to `/boot/firmware/config.txt` to assign GPIO 3 as the CAM1 regulator: + +[source,ini] ---- dtparam=cam1_reg ---- @@ -60,27 +70,28 @@ dtparam=cam1_reg | directive | v1 camera -| `dtoverlay=ov5647,cam1` +| `dtoverlay=ov5647` | v2 camera -| `dtoverlay=imx219,cam1` +| `dtoverlay=imx219` | v3 camera -| `dtoverlay=imx708,cam1` +| `dtoverlay=imx708` | HQ camera -| `dtoverlay=imx477,cam1` +| `dtoverlay=imx477` | GS camera -| `dtoverlay=imx296,cam1` +| `dtoverlay=imx296` |=== . Reboot your Compute Module with `sudo reboot`. . Run the following command to check the list of detected cameras: + +[source,console] ---- -rpicam-hello --list +$ rpicam-hello --list ---- You should see your camera model, referred to by the driver directive in the table above, in the output. @@ -92,23 +103,24 @@ To connect two cameras to a Compute Module, complete the following steps: . Disconnect the Compute Module from power. . Connect the Camera Module to the CAM0 port using a RPI-CAMERA board or a Raspberry Pi Zero camera cable. + -image::images/CMIO-Cam-Adapter.jpg[Connect the adapter board] +image::images/CMIO-Cam-Adapter.jpg[alt="Connect the adapter board", width="60%"] . _(CM1, CM3, CM3+, and CM4S only)_: Connect the following GPIO pins with jumper cables: * `28` to `CD0_SDA` * `29` to `CD0_SCL` * `30` to `CAM0_I01` * `31` to `CAM0_I00` + -image:images/CMIO-Cam-GPIO2.jpg[GPIO connection with additional camera] +image:images/CMIO-Cam-GPIO2.jpg[alt="GPIO connection with additional camera", width="60%"] -. _(CM4 only)_: 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[Connect the J6 GPIO pins in vertical orientation] +image:images/j6_vertical.jpg[alt="Connect the J6 GPIO pins in vertical orientation", width="60%"] . Reconnect the Compute Module to power. . _(CM1, CM3, CM3+, and CM4S only)_: Add the following directive to `/boot/firmware/config.txt` to assign GPIO 31 as the CAM0 regulator: + +[source,ini] ---- dtparam=cam0_reg ---- @@ -140,8 +152,9 @@ dtparam=cam0_reg . Run the following command to check the list of detected cameras: + +[source,console] ---- -rpicam-hello --list +$ rpicam-hello --list ---- + You should see both camera models, referred to by the driver directives in the table above, in the output. @@ -154,8 +167,9 @@ Raspberry Pi OS includes the `libcamera` library to help you take images with yo Use the following command to immediately take a picture and save it to a file in PNG encoding using the `MMDDhhmmss` date format as a filename: +[source,console] ---- -rpicam-still --datetime -e png +$ rpicam-still --datetime -e png ---- Use the `-t` option to add a delay in milliseconds. @@ -165,8 +179,9 @@ Use the `--width` and `--height` options to specify a width and height for the i Use the following command to immediately start recording a ten-second long video and save it to a file with the h264 codec named `video.h264`: +[source,console] ---- -rpicam-vid -t 10000 -o video.h264 +$ rpicam-vid -t 10000 -o video.h264 ---- ==== Specify which camera to use @@ -174,6 +189,7 @@ rpicam-vid -t 10000 -o video.h264 By default, `libcamera` always uses the camera with index `0` in the `--list-cameras` list. To specify a camera option, get an index value for each camera from the following command: +[source,console] ---- $ rpicam-hello --list-cameras Available cameras @@ -197,14 +213,16 @@ In the above output: To use the HQ camera, pass its index (`0`) to the `--camera` `libcamera` option: +[source,console] ---- -rpicam-hello --camera 0 +$ rpicam-hello --camera 0 ---- To use the v3 camera, pass its index (`1`) to the `--camera` `libcamera` option: +[source,console] ---- -rpicam-hello --camera 1 +$ rpicam-hello --camera 1 ---- @@ -229,6 +247,7 @@ By default, the supplied camera drivers assume that CAM1 uses `i2c-10` and CAM0 To connect a camera to the CM1, CM3, CM3+ and CM4S I/O Board, add the following directive to `/boot/firmware/config.txt` to accommodate the swapped pin assignment: +[source,ini] ---- dtoverlay=cm-swap-i2c0 ---- diff --git a/documentation/asciidoc/computers/compute-module/cmio-display.adoc b/documentation/asciidoc/computers/compute-module/cmio-display.adoc index 4e5ab9a84..c8f9b4c63 100644 --- a/documentation/asciidoc/computers/compute-module/cmio-display.adoc +++ b/documentation/asciidoc/computers/compute-module/cmio-display.adoc @@ -1,65 +1,71 @@ -== Attaching the official 7-inch display +== Attaching the Touch Display LCD panel -NOTE: These instructions are intended for advanced users. If anything is unclear, use the https://forums.raspberrypi.com/viewforum.php?f=98[Raspberry Pi Compute Module forums] for technical help. +Update your system software and firmware to the latest version before starting. Compute Modules mostly use the same process, but sometimes physical differences force changes for a particular model. -Update your system software and firmware to the latest version before starting. -Compute Modules mostly use the same process, but sometimes physical differences force changes for a particular model. +=== Connect a display to DISP1/DSI1 -=== Connect a display to DISP1 +NOTE: The Raspberry Pi Zero camera cable can't be used as an alternative to the RPI-DISPLAY adapter. The two cables have distinct wiring. -NOTE: The Raspberry Pi Zero camera cable cannot be used as an alternative to the RPI-DISPLAY adapter. The two cables have distinct wiring. - -To connect a display to DISP1: +To connect a display to `DISP1/DSI1`: . Disconnect the Compute Module from power. -. Connect the display to the DISP1 port on the Compute Module IO board through the 22W to 15W display adapter. -. _(CM1, CM3, CM3+, and CM4S only)_: Connect the following GPIO pins with jumper cables: - * `0` to `CD1_SDA` - * `1` to `CD1_SCL` - +. Connect the display to the `DISP1/DSI1` port on the Compute Module IO board through the 22W to 15W display adapter. +. Complete the appropriate jumper connections: + - For *CM1*, *CM3*, *CM3+*, and *CM4S*, connect the following GPIO pins with jumper cables: + * `0` to `CD1_SDA` + * `1` to `CD1_SCL` + - For *CM5*, on the Compute Module 5 IO board, add the appropriate jumpers to J6, as indicated on the silkscreen. . Reconnect the Compute Module to power. -. Add the following line to xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]: -+ -[source,bash] ----- -dtoverlay=vc4-kms-dsi-7inch ----- +. Add `dtoverlay=vc4-kms-dsi-7inch` to xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]. . Reboot your Compute Module with `sudo reboot`. Your device should detect and begin displaying output to your display. -=== Connect a display to DISP0 +=== Connect a display to DISP0/DSI0 -To connect a display to DISP0: - -. Connect the display to the DISP0 port on the Compute Module IO board through the 22W to 15W display adapter. -. _(CM1, CM3, CM3+, and CM4S only)_: Connect the following GPIO pins with jumper cables: - * `28` to `CD0_SDA` - * `29` to `CD0_SCL` +To connect a display to `DISP0/DSI0` on CM1, CM3, and CM4 IO boards: +. Connect the display to the `DISP0/DSI0` port on the Compute Module IO board through the 22W to 15W display adapter. +. Complete the appropriate jumper connections: + - For *CM1*, *CM3*, *CM3+*, and *CM4S*, connect the following GPIO pins with jumper cables: + * `28` to `CD0_SDA` + * `29` to `CD0_SCL` + - For *CM4*, on the Compute Module 4 IO board, add the appropriate jumpers to J6, as indicated on the silkscreen. . Reconnect the Compute Module to power. -. Add the following line to `/boot/firmware/config.txt`: -+ -[source,bash] ----- -dtoverlay=vc4-kms-dsi-7inch ----- +. Add `dtoverlay=vc4-kms-dsi-7inch,dsi0` to `/boot/firmware/config.txt`. . Reboot your Compute Module with `sudo reboot`. Your device should detect and begin displaying output to your display. === Disable touchscreen -The touchscreen requires no additional configuration. Connect it to your Compute Module, and both the touchscreen element and display should work once successfully detected. +The touchscreen requires no additional configuration. Connect it to your Compute Module; both the touchscreen element and display work when successfully detected. To disable the touchscreen element, but still use the display, add the following line to `/boot/firmware/config.txt`: -[source] +[source,ini] ---- disable_touchscreen=1 ---- === Disable display -To entirely ignore the display when connected, add the following line to to `/boot/firmware/config.txt`: +To entirely ignore the display when connected, add the following line to `/boot/firmware/config.txt`: -[source] +[source,ini] ---- ignore_lcd=1 ---- + +== Attaching the Touch Display 2 LCD panel + +Touch Display 2 is an LCD display designed for Raspberry Pi devices (see https://www.raspberrypi.com/products/touch-display-2/). It's available in two sizes: 5 inches or 7 inches (diagonally). For more information about these options, see *Specifications* in xref:../accessories/touch-display-2.adoc[Touch Display 2]. + +Regardless of the size that you use, Touch Display 2 connects in the same way as the original Touch Display, but the software setup on Compute Modules is slightly different because it uses a different display driver. For connection details, see *Connectors* in xref:../accessories/touch-display-2.adoc[Touch Display 2]. + +To enable Touch Display 2 on `DISP1/DSI1`, edit the `/boot/firmware/config.txt` file to add the following. You must also add jumpers to J6 as indicated on the silkscreen. + +- For the *5-inch* display: `dtoverlay=vc4-kms-dsi-ili9881-5inch` +- For the *7-inch* display: `dtoverlay=vc4-kms-dsi-ili9881-7inch` + +To use `DISP0/DSI0`, append `,dsi0` to the overlay name. + +- For the *5-inch* display: `dtoverlay=vc4-kms-dsi-ili9881-5inch,dsi0` +- For the *7-inch* display: `dtoverlay=vc4-kms-dsi-ili9881-7inch,dsi0` + diff --git a/documentation/asciidoc/computers/compute-module/datasheet.adoc b/documentation/asciidoc/computers/compute-module/datasheet.adoc index 2341e253d..3f7ffbd75 100644 --- a/documentation/asciidoc/computers/compute-module/datasheet.adoc +++ b/documentation/asciidoc/computers/compute-module/datasheet.adoc @@ -1,57 +1,84 @@ -== Datasheets and schematics +== Specifications -=== Compute Module 4 +=== Compute Module 5 datasheet -The latest version of the Compute Module is the Compute Module 4 (CM4). It is the recommended Compute Module for all current and future development. +To learn more about Compute Module 5 (CM5) and its corresponding IO Board, see the following documents: -* https://datasheets.raspberrypi.com/cm4/cm4-datasheet.pdf[Compute Module 4 datasheet] -* https://datasheets.raspberrypi.com/cm4io/cm4io-datasheet.pdf[Compute Module 4 IO board datasheet] +* https://datasheets.raspberrypi.com/cm5/cm5-datasheet.pdf[CM5 datasheet] +* https://rpltd.co/cm5-design-files[CM5 design files] -NOTE: Schematics are not available for the Compute Module 4, but are available for the IO board. Schematics for the CMIO4 board are included in the datasheet. +=== Compute Module 5 IO Board datasheet -There is also a KiCad PCB design set available: +Design data for the Compute Module 5 IO Board (CM5IO) can be found in its datasheet: -* https://datasheets.raspberrypi.com/cm4io/CM4IO-KiCAD.zip[Compute Module 4 IO board KiCad files] +* https://datasheets.raspberrypi.com/cm5/cm5io-datasheet.pdf[CM5IO datasheet] +* https://rpltd.co/cm5io-design-files[CM5IO design files] -[.whitepaper, title="Configuring 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] +=== Compute Module 4 datasheet + +To learn more about Compute Module 4 (CM4) and its corresponding IO Board, see the following documents: + +* https://datasheets.raspberrypi.com/cm4/cm4-datasheet.pdf[CM4 datasheet] + +[.whitepaper, title="Configure the Compute Module 4", subtitle="", link=https://pip.raspberrypi.com/documents/RP-003470-WP-Configuring-the-Compute-Module-4.pdf] **** -The Raspberry Pi Compute Module 4 (CM 4) is available in a number of different hardware configurations. Sometimes it may be necessary to disable some of these features when they are not required. +The Compute Module 4 is available in a number of different hardware configurations. Some use cases disable certain features that aren't required. -This document describes how to disable various hardware interfaces, in both hardware and software, and how to reduce the amount of memory used by the Linux operating system (OS). +This document describes how to disable various hardware and software interfaces. **** -=== Older products +=== Compute Module 4 IO Board datasheet -Raspberry Pi CM1, CM3 and CM3L are supported products with an end-of-life (EOL) date no earlier than January 2026. The Compute Module 3+ offers improved thermal performance, and a wider range of flash memory options. +Design data for the Compute Module 4 IO Board (CM4IO) can be found in its datasheet: -* https://datasheets.raspberrypi.com/cm/cm1-and-cm3-datasheet.pdf[Compute Module 1 and Compute Module 3] +* https://datasheets.raspberrypi.com/cm4io/cm4io-datasheet.pdf[CM4IO datasheet] -Raspberry Pi CM3+ and CM3+ Lite are supported products with an end-of-life (EOL) date no earlier than January 2028. +We also provide a KiCad PCB design set for the CM4 IO Board: -* https://datasheets.raspberrypi.com/cm/cm3-plus-datasheet.pdf[Compute Module 3+] +* https://datasheets.raspberrypi.com/cm4io/CM4IO-KiCAD.zip[CM4IO KiCad files] -Schematics for the Compute Module 1, 3 and 3L: +=== Compute Module 4S datasheet -* https://datasheets.raspberrypi.com/cm/cm1-schematics.pdf[CM1 Rev 1.1] -* https://datasheets.raspberrypi.com/cm/cm3-schematics.pdf[CM3 and CM3L Rev 1.0] +Compute Module 4S (CM4S) offers the internals of CM4 in the DDR2-SODIMM form factor of CM1, CM3, and CM3+. To learn more about CM4S, see the following documents: -Schematics for the Compute Module IO board (CMIO): +* https://datasheets.raspberrypi.com/cm4s/cm4s-datasheet.pdf[CM4S datasheet] -* https://datasheets.raspberrypi.com/cmio/cmio-schematics.pdf[CMIO Rev 3.0] (Supports CM1, CM3, CM3L, CM3+ and CM3+L) +=== Compute Module 3+ datasheet -Schematics for the Compute Module camera/display adapter board (CMCDA): +Compute Module 3+ (CM3+) is a supported product with an end-of-life (EOL) date no earlier than January 2028. To learn more about CM3+ and its corresponding IO Board, see the following documents: -* https://datasheets.raspberrypi.com/cmcda/cmcda-schematics.pdf[CMCDA Rev 1.1] +* https://datasheets.raspberrypi.com/cm/cm3-plus-datasheet.pdf[CM3+ datasheet] -[.whitepaper, title="Transitioning from CM3 to CM4", subtitle="", link=https://pip.raspberrypi.com/categories/685-whitepapers-app-notes/documents/RP-003469-WP/Transitioning-from-CM3-to-CM4.pdf] -**** -This white paper is for those who wish to move from using a Raspberry Pi Compute Module (CM) 1 or 3 to a Raspberry Pi CM 4. +=== Compute Module 1 and Compute Module 3 datasheet -From a software perspective, the move from Raspberry Pi CM 1/3 to Raspberry Pi CM 4 is relatively painless, as Raspberry Pi OS should work on all platforms. +Raspberry Pi Compute Module 1 (CM1) and Compute Module 3 (CM3) are supported products with an end-of-life (EOL) date no earlier than January 2026. To learn more about CM1 and CM3, see the following documents: + +* https://datasheets.raspberrypi.com/cm/cm1-and-cm3-datasheet.pdf[CM1 and CM3 datasheet] +* 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/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. **** -==== Under-voltage detection +=== Compute Module IO Board schematics + +The Compute Module IO Board (CMIO) provides a variety of interfaces for CM1, CM3, CM3+, and CM4S. The Compute Module IO Board comes in two variants: Version 1 and Version 3. Version 1 is only compatible with CM1. Version 3 is compatible with CM1, CM3, CM3+, and CM4S. Compute Module IO Board Version 3 is sometimes written as the shorthand CMIO3. To learn more about CMIO1 and CMIO3, see the following documents: + +* https://datasheets.raspberrypi.com/cmio/cmio-schematics.pdf[Schematics for CMIO] +* https://datasheets.raspberrypi.com/cmio/RPi-CMIO-R1P2.zip[Design documents for CMIO Version 1.2 (CMIO/CMIO1)] +* https://datasheets.raspberrypi.com/cmio/RPi-CMIO-R3P0.zip[Design documents for CMIO Version 3.0 (CMIO3)] + +=== Compute Module Camera/Display Adapter Board schematics + +The Compute Module Camera/Display Adapter Board (CMCDA) provides camera and display interfaces for Compute Modules. To learn more about the CMCDA, see the following documents: + +* https://datasheets.raspberrypi.com/cmcda/cmcda-schematics.pdf[Schematics for the CMCDA] +* https://datasheets.raspberrypi.com/cmcda/RPi-CMCDA-1P1.zip[Design documents for CMCDA Version 1.1] + +=== Under-voltage detection -Schematic for an under-voltage detection circuit, as used in older models of Raspberry Pi: +The following schematic describes an under-voltage detection circuit, as used in older models of Raspberry Pi: image::images/under_voltage_detect.png[Under-voltage detect] diff --git a/documentation/asciidoc/computers/compute-module/designfiles.adoc b/documentation/asciidoc/computers/compute-module/designfiles.adoc deleted file mode 100644 index af0d13003..000000000 --- a/documentation/asciidoc/computers/compute-module/designfiles.adoc +++ /dev/null @@ -1,22 +0,0 @@ -== Design files for CMIO Boards - -[discrete] -=== Compute Module IO board for CM4 - -Design data for the Compute Module 4 IO board can be found in its datasheet: - -* https://datasheets.raspberrypi.com/cm4io/cm4io-datasheet.pdf[Compute Module 4 IO Board datasheet] - -There is also a KiCad PCB design set available: - -* https://datasheets.raspberrypi.com/cm4io/CM4IO-KiCAD.zip[Compute Module 4 IO Board KiCad files] - -[discrete] -=== Older products - -* https://datasheets.raspberrypi.com/cmio/RPi-CMIO-R1P2.zip[CMIO Rev 1.2] -* https://datasheets.raspberrypi.com/cmio/RPi-CMIO-R3P0.zip[CMIO Rev 3.0] - -Design data for the Compute Module camera/display adapter board (CMCDA): - -* https://datasheets.raspberrypi.com/cmcda/RPi-CMCDA-1P1.zip[CMCDA Rev 1.1] diff --git a/documentation/asciidoc/computers/compute-module/images/cm1.jpg b/documentation/asciidoc/computers/compute-module/images/cm1.jpg new file mode 100644 index 000000000..caa01fec3 Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm1.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm3-plus.jpg b/documentation/asciidoc/computers/compute-module/images/cm3-plus.jpg new file mode 100644 index 000000000..dc266211b Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm3-plus.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm3.jpg b/documentation/asciidoc/computers/compute-module/images/cm3.jpg new file mode 100644 index 000000000..c82500604 Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm3.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna-assembly.svg b/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna-assembly.svg new file mode 100644 index 000000000..596cda012 --- /dev/null +++ b/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna-assembly.svg @@ -0,0 +1,297 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 5 + + + + + 3 + + + + + + 1 + + + + + + 2 + + + + + 4 + \ No newline at end of file diff --git a/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna-physical.png b/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna-physical.png new file mode 100644 index 000000000..7fcd0da44 Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna-physical.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna-physical.svg b/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna-physical.svg new file mode 100644 index 000000000..232dc6e76 --- /dev/null +++ b/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna-physical.svg @@ -0,0 +1,4711 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 8 + + + + + + + + + + + + + + + + + + + + + + + + + + 10 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 87.5 ± 1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1/4–36UNS–2B + 1/4–36UNS–2A + 11 + + Milling unilateral 5.85 ± 0.02 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 2.0 + 205 ± 1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + S=8 + + + 6.25 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Note:All dimensions in mmAll dimensions are approximate and for reference purposes only. The dimensions shown should not be used for producing production dataThe dimensions are subject to part and manufacturing tolerancesDimensions may be subject to change + diff --git a/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna.jpg b/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna.jpg new file mode 100644 index 000000000..2dd3fbcd7 Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm4-cm5-antenna.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm4.jpg b/documentation/asciidoc/computers/compute-module/images/cm4.jpg new file mode 100644 index 000000000..a60f5b73b Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm4.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm4io.jpg b/documentation/asciidoc/computers/compute-module/images/cm4io.jpg new file mode 100644 index 000000000..fe4ccab2b Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm4io.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm4s.jpg b/documentation/asciidoc/computers/compute-module/images/cm4s.jpg new file mode 100644 index 000000000..7119617d8 Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm4s.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5-case-physical.png b/documentation/asciidoc/computers/compute-module/images/cm5-case-physical.png new file mode 100644 index 000000000..05323596a Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm5-case-physical.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5-case-physical.svg b/documentation/asciidoc/computers/compute-module/images/cm5-case-physical.svg new file mode 100644 index 000000000..4ddf6308f --- /dev/null +++ b/documentation/asciidoc/computers/compute-module/images/cm5-case-physical.svg @@ -0,0 +1,12074 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + SSD + + + + + + + + + + + + + + + + + +Power In + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +STATUS +Power +HDMI0 +HDMI1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +94 + +170 + + + + + + + + + + + + + + + +28 + + + + + + + + + + + + + + + + + +Note:All dimensions in mmAll dimensions are approximate and for reference purposes only. The dimensions shown should not be used for producing production dataThe dimensions are subject to part and manufacturing tolerancesDimensions may be subject to change + diff --git a/documentation/asciidoc/computers/compute-module/images/cm5-cooler-physical.png b/documentation/asciidoc/computers/compute-module/images/cm5-cooler-physical.png new file mode 100644 index 000000000..521410178 Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm5-cooler-physical.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5-cooler-physical.svg b/documentation/asciidoc/computers/compute-module/images/cm5-cooler-physical.svg new file mode 100644 index 000000000..5abb017d8 --- /dev/null +++ b/documentation/asciidoc/computers/compute-module/images/cm5-cooler-physical.svg @@ -0,0 +1,9616 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 41 + 56 + + + + + + + + + + + 33 + 4 × M2.5 + + + + + + + + + + + + + + + + + + + 10 + 2.7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 48 + + + + + + + + + + + Note: + All dimensions in mm + All dimensions are app + ro + ximate and for + reference purposes only. + + The dimensions + shown should not be used for p + r + oducing + p + r + oduction data + The dimensions are subject + t + o pa + r + t and + manufacturing + t + ole + r + ances + Dimensions may be subject + t + o change + + diff --git a/documentation/asciidoc/computers/compute-module/images/cm5-cooler.jpg b/documentation/asciidoc/computers/compute-module/images/cm5-cooler.jpg new file mode 100644 index 000000000..d4781a5cd Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm5-cooler.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5.png b/documentation/asciidoc/computers/compute-module/images/cm5.png new file mode 100644 index 000000000..0431e3e2d Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm5.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5io-case-front.png b/documentation/asciidoc/computers/compute-module/images/cm5io-case-front.png new file mode 100644 index 000000000..055875438 Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm5io-case-front.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5io-case.png b/documentation/asciidoc/computers/compute-module/images/cm5io-case.png new file mode 100644 index 000000000..074e802b6 Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm5io-case.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5io-j6-cam1.png b/documentation/asciidoc/computers/compute-module/images/cm5io-j6-cam1.png new file mode 100644 index 000000000..82800d15d Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm5io-j6-cam1.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cm5io.png b/documentation/asciidoc/computers/compute-module/images/cm5io.png new file mode 100644 index 000000000..382ae0b2c Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cm5io.png differ diff --git a/documentation/asciidoc/computers/compute-module/images/cmio.jpg b/documentation/asciidoc/computers/compute-module/images/cmio.jpg new file mode 100644 index 000000000..347f27f28 Binary files /dev/null and b/documentation/asciidoc/computers/compute-module/images/cmio.jpg differ diff --git a/documentation/asciidoc/computers/compute-module/introduction.adoc b/documentation/asciidoc/computers/compute-module/introduction.adoc new file mode 100644 index 000000000..aa74d7bd5 --- /dev/null +++ b/documentation/asciidoc/computers/compute-module/introduction.adoc @@ -0,0 +1,232 @@ +== Compute Modules + +Raspberry Pi Compute Modules are **system-on-module** variants of the flagship Raspberry Pi models. Compute Modules are especially popular for industrial and commercial applications, including digital signage, thin clients, and process automation. Some of these applications use the flagship Raspberry Pi design, but many users want a more compact design or on-board eMMC storage. + +Compute Modules come in multiple variants, varying both in memory and soldered-on Multi-Media Card (eMMC) flash storage capacity. Like SD cards, eMMC provides persistent storage with minimal energy impact. Unlike SD cards, eMMC is specifically designed to be used as a disk and includes extra features to improve reliability. **Lite** models have no on-board storage, and are sometimes referred to with the shorthand suffix **L**, e.g. "CM3L". + +Compute Modules use the following Raspberry Pi SoCs: + +* BCM2835 for CM1 +* BCM2837 for CM3, CM3+ +* BCM2711 for CM4, CM4S +* BCM2712 for CM5 + +=== Compute Module 5 + +.Compute Module 5 +image::images/cm5.png[alt="Compute Module 5", width="60%"] + +The Compute Module 5 (CM5) combines the internals of a Raspberry Pi 5 (the BCM2712 processor and 2GB, 4GB, 8GB, or 16GB of RAM) with optional 0GB (Lite), 16GB, 32GB or 64GB of eMMC flash storage. + +CM5 uses the same form factor as CM4, featuring two 100-pin high density connectors. + +=== Compute Module 4 + +.Compute Module 4 +image::images/cm4.jpg[alt="Compute Module 4", width="60%"] + +The Compute Module 4 (CM4) combines the internals of a Raspberry Pi 4 (the BCM2711 processor and 1GB, 2GB, 4GB, or 8GB of RAM) with an optional 0GB (Lite), 8GB, 16GB or 32GB of eMMC flash storage. + +Unlike CM1, CM3, and CM3+, CM4 does not use the DDR2 SO-DIMM form factor. Instead, CM4 uses two 100-pin high density connectors in a smaller physical footprint. This change helped add the following interfaces: + +* an additional second HDMI port +* PCIe +* Ethernet + +The previous form factor could not have supported these interfaces. + +=== Compute Module 4S + +.Compute Module 4S +image::images/cm4s.jpg[alt="Compute Module 4S", width="60%"] + +The Compute Module 4S (CM4S) combines the internals of a Raspberry Pi 4 (the BCM2711 processor and 1GB, 2GB, 4GB, or 8GB of RAM) with an optional 0GB (Lite), 8GB, 16GB or 32GB of eMMC flash storage. Unlike CM4, CM4S comes in the same DDR2 SO-DIMM form factor as CM1, CM3, and CM3+. + +[[compute-module-3-plus]] +=== Compute Module 3+ + +.Compute Module 3+ +image::images/cm3-plus.jpg[alt="Compute Module 3+", width="60%"] + +The Compute Module 3+ (CM3+) combines the internals of a Raspberry Pi 3 Model B+ (the BCM2837 processor and 1GB of RAM) with an optional 0GB (Lite), 8GB, 16GB or 32GB of eMMC flash storage. CM3+ comes in the DDR2 SO-DIMM form factor. + +=== Compute Module 3 + +.Compute Module 3 +image::images/cm3.jpg[alt="Compute Module 3", width="60%"] + +The Compute Module 3 (CM3) combines the internals of a Raspberry Pi 3 (the BCM2837 processor and 1GB of RAM) with an optional 4GB of eMMC flash storage. CM3 comes in the DDR2 SO-DIMM form factor. + +=== Compute Module 1 + +.Compute Module 1 +image::images/cm1.jpg[alt="Compute Module 1", width="60%"] + +The Compute Module 1 (CM1) contains the internals of a Raspberry Pi (the BCM2835 processor and 512MB of RAM) as well as an optional 4GB of eMMC flash storage. CM1 comes in the DDR2 SO-DIMM form factor. + +== IO Boards + +Raspberry Pi IO Boards provide a way to connect a single Compute Module to a variety of I/O (input/output) interfaces. Compute Modules are small, lacking ports and connectors. IO Boards provide a way to connect Compute Modules to a variety of peripherals. + +Raspberry Pi IO Boards provide the following functionality: + +* power the module +* connects the GPIO to pin headers +* connects the camera and display interfaces to FFC connectors +* connects HDMI to HDMI ports +* connects USB to USB ports +* connects activity monitoring to LEDs +* eMMC programming over USB +* connects PCIe to connectors used to physically connect storage or peripherals + +IO Boards are breakout boards intended for development or personal use; in production, you should use a smaller, potentially custom board that provides only the ports and peripherals required for your use-case. + +=== Compute Module 5 IO Board + +.Compute Module 5 IO Board +image::images/cm5io.png[alt="Compute Module 5 IO Board", width="60%"] + +Compute Module 5 IO Board provides the following interfaces: + +* HAT footprint with 40-pin GPIO connector +* PoE header +* 2× HDMI ports +* 2× USB 3.0 ports +* Gigabit Ethernet RJ45 with PoE support +* M.2 M key PCIe socket compatible with the 2230, 2242, 2260, and 2280 form factors +* microSD card slot (only for use with Lite variants with no eMMC; other variants ignore the slot) +* 2× MIPI DSI/CSI-2 combined display/camera FPC connectors (22-pin 0.5 mm pitch cable) +* Real-time clock with battery socket +* four-pin JST-SH PWM fan connector +* USB-C power using the same standard as Raspberry Pi 5 (5V, 5A (25W) or 5V, 3A (15W) with a 600mA peripheral limit) +* Jumpers to disable features such as eMMC boot, EEPROM write, and the USB OTG connection + +=== Compute Module 4 IO Board + +.Compute Module 4 IO Board +image::images/cm4io.jpg[alt="Compute Module 4 IO Board", width="60%"] + +Compute Module 4 IO Board provides the following interfaces: + +* HAT footprint with 40-pin GPIO connector and PoE header +* 2× HDMI ports +* 2× USB 2.0 ports +* Gigabit Ethernet RJ45 with PoE support +* microSD card slot (only for use with Lite variants with no eMMC; other variants ignore the slot) +* PCIe Gen 2 socket +* micro USB upstream port +* 2× MIPI DSI display FPC connectors (22-pin 0.5 mm pitch cable) +* 2× MIPI CSI-2 camera FPC connectors (22-pin 0.5 mm pitch cable) +* Real-time clock with battery socket +* 12V input via barrel jack (supports up to 26V if PCIe unused) + +=== Compute Module IO Board + +.Compute Module IO Board +image::images/cmio.jpg[alt="Compute Module IO Board", width="60%"] + +Compute Module IO Board provides the following interfaces: + +* 120 GPIO pins +* HDMI port +* USB-A port +* 2× MIPI DSI display FPC connectors (22-pin 0.5 mm pitch cable) +* 2× MIPI CSI-2 camera FPC connectors (22-pin 0.5 mm pitch cable) + +The Compute Module IO Board comes in two variants: Version 1 and Version 3. Version 1 is only compatible with CM1. Version 3 is compatible with CM1, CM3, CM3+, and CM4S. Compute Module IO Board Version 3 is sometimes written as the shorthand CMIO3. + +Compute Module IO Board Version 3 added a microSD card slot that did not exist in Compute Module IO Board Version 1. + +=== IO Board compatibility + +Not all Compute Module IO Boards work with all Compute Module models. The following table shows which Compute Modules work with each IO Board: + +[cols="1,1"] +|=== +| IO Board | Compatible Compute Modules + +| Compute Module IO Board Version 1 (CMIO)/(CMIO1) +a| +* CM1 +| Compute Module IO Board Version 3 (CMIO)/(CMIO3) +a| +* CM1 +* CM3 +* CM3+ +* CM4S +| Compute Module 4 IO Board (CM4IO) +a| +* CM4 +* CM5 (with reduced functionality) +| Compute Module 5 IO Board (CM5IO) +a| +* CM5 +* CM4 (with reduced functionality) +|=== + +== CM5 Accessories + +=== IO Case + +The world can be a dangerous place. The Compute Module 5 IO Board Case provides physical protection for a CM5IO Board. + +.Compute Module 5 IO Board Case +image::images/cm5io-case.png[alt="Compute Module 5 IO Board Case", width="60%"] + +The Case provides cut-outs for all externally-facing ports and LEDs on the CM5IO Board, and an attachment point for a Raspberry Pi Antenna Kit. + +.Compute Module 5 IO Board Case ports +image::images/cm5io-case-front.png[alt="the port selection on the Compute Module 5 IO Board Case", width="60%"] + +To mount a CM5IO Board within your Case, position your Board in the bottom section of the case, aligning the four mounting points inset slightly from each corner of the Board. Fasten four screws into the mounting points. Take care not to over-tighten the screws. + +To use the Case fan, connect the fan cable to the FAN (J14) port on the Board. + +To close the case, put the top section of the case on top of the bottom section of the case. Facing the front of the case, which has port pass-throughs, carefully align the screw holes on the left and right side of the case and the power button on the back of the case. Tighten four screws into the screw holes. Take care not to over-tighten the screws. + +TIP: The Case comes with a fan pre-installed. To close the case with the passive Cooler attached to your Compute Module, remove the fan. To remove the fan, remove the four screws positioned in the corners of the fan from the bottom of the top case. + +.CM5 Case physical specification +image::images/cm5-case-physical.png[alt="CM5 Case physical specification", width="80%"] + +=== Antenna + +The Raspberry Pi Antenna Kit provides a certified external antenna to boost wireless reception on a CM4 or CM5. + +.CM4 and CM5 Antenna +image::images/cm4-cm5-antenna.jpg[alt="The Antenna, connected to CM4", width="60%"] + +To attach the Antenna to your Compute Module and Case, complete the following steps: + +. Connect the https://en.wikipedia.org/wiki/Hirose_U.FL[U.FL connector] on the cable to the U.FL-compatible connector on your Compute Module. +. Secure the toothed washer onto the male SMA connector at the end of the cable, then insert the SMA connector, with the antenna facing outward, through the hole in the Case. +. Fasten the SMA connector into place with the retaining hexagonal nut and washer. +. Tighten the female SMA connector on the Antenna onto the male SMA connector. +. Adjust the Antenna to its final position by turning it up to 90°. + +.CM4 and CM5 Antenna assembly diagram +image::images/cm4-cm5-antenna-assembly.svg[alt="CM4 and CM5 antenna assembly diagram", width="60%"] + +To **use** the Antenna with your Compute Module, add a `dtoverlay` instruction in xref:../computers/config_txt.adoc[`/boot/firmware/config.txt`]. Add the following line to the end of `config.txt`: + +[source,ini] +---- +dtparam=ant2 +---- + +.CM4 and CM5 Antenna physical specification +image::images/cm4-cm5-antenna-physical.png[alt="CM4 and CM5 antenna physical specification", width="80%"] + +=== Cooler + +The CM5 Cooler helps dissipate heat from your CM5, improving CPU performance, longevity, and bumpiness. + +.CM5 Cooler +image::images/cm5-cooler.jpg[alt="CM5 Cooler", width="60%"] + +To mount the Cooler to your CM5, attach the thermally conductive silicone at the bottom of the Cooler to the top of your CM5. Align the cut-out in the heatsink with the antenna https://en.wikipedia.org/wiki/Hirose_U.FL[U.FL connector]. Optionally, fasten screws in the mounting points found in each corner to secure the Cooler. If you omit the screws, the bond between your Cooler and your Compute Module will improve through time, use, and trust. + +.CM5 Cooler physical specification +image::images/cm5-cooler-physical.png[alt="CM5 Cooler physical specification", width="80%"] + +NOTE: The CM5 Cooler is only compatible with the CM5IO Case if you remove the fan from the case. diff --git a/documentation/asciidoc/computers/config_txt/audio.adoc b/documentation/asciidoc/computers/config_txt/audio.adoc index f6bf2dc87..7ba0b541d 100644 --- a/documentation/asciidoc/computers/config_txt/audio.adoc +++ b/documentation/asciidoc/computers/config_txt/audio.adoc @@ -28,6 +28,7 @@ By default, HDMI audio output is enabled on all Raspberry Pi models with HDMI ou To disable HDMI audio output, append `,noaudio` to the end of the `dtoverlay=vc4-kms-v3d` line in xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]: +[source,ini] ---- dtoverlay=vc4-kms-v3d,noaudio ---- diff --git a/documentation/asciidoc/computers/config_txt/autoboot.adoc b/documentation/asciidoc/computers/config_txt/autoboot.adoc index 59e3a46db..fa37c855e 100644 --- a/documentation/asciidoc/computers/config_txt/autoboot.adoc +++ b/documentation/asciidoc/computers/config_txt/autoboot.adoc @@ -17,8 +17,10 @@ Bootable partitions must be formatted as FAT12, FAT16 or FAT32 and contain a `st === The `[tryboot]` filter This filter passes if the system was booted with the `tryboot` flag set. + +[source,console] ---- -sudo reboot "0 tryboot" +$ sudo reboot "0 tryboot" ---- === `tryboot_a_b` @@ -28,9 +30,11 @@ This enables the `tryboot` switch to be made at the partition level rather than === Example update flow for A/B booting -The following pseudo-code shows how a hypothetical OS `Update service` could use `tryboot` + `autoboot.txt` to perform a fail-safe OS upgrade. +The following pseudo-code shows how a hypothetical OS `Update service` could use `tryboot` in `autoboot.txt` to perform a fail-safe OS upgrade. + +Initial `autoboot.txt`: -Initial `autoboot.txt` +[source,ini] ---- [all] tryboot_a_b=1 @@ -61,7 +65,9 @@ boot_partition=3 ** End If * End If -Updated `autoboot.txt` +Updated `autoboot.txt`: + +[source,ini] ---- [all] tryboot_a_b=1 @@ -72,6 +78,5 @@ boot_partition=2 [NOTE] ====== -* It's not mandatory to reboot after updating `autoboot.txt`. However, the `Update Service` must be careful to avoid overwriting the current partition since `autoboot.txt` has already been modified to commit the last update. -* See also: xref:configuration.adoc#device-trees-overlays-and-parameters[Device-tree parameters]. +It's not mandatory to reboot after updating `autoboot.txt`. However, the `Update Service` must be careful to avoid overwriting the current partition since `autoboot.txt` has already been modified to commit the last update. For more information, see xref:configuration.adoc#device-trees-overlays-and-parameters[Device Tree parameters]. ====== diff --git a/documentation/asciidoc/computers/config_txt/boot.adoc b/documentation/asciidoc/computers/config_txt/boot.adoc index 2f237524d..acdd553f1 100644 --- a/documentation/asciidoc/computers/config_txt/boot.adoc +++ b/documentation/asciidoc/computers/config_txt/boot.adoc @@ -5,13 +5,13 @@ These options specify the firmware files transferred to the VideoCore GPU prior to booting. `start_file` specifies the VideoCore firmware file to use. -`fixup_file` specifies the file used to fix up memory locations used in the `start_file` to match the GPU memory split. +`fixup_file` specifies the file used to fix up memory locations used in the `start_file` to match the GPU memory split. The `start_file` and the `fixup_file` are a matched pair - using unmatched files will stop the board from booting. This is an advanced option, so we advise that you use `start_x` and `start_debug` rather than this option. -NOTE: Cut-down firmware (`start*cd.elf` and `fixup*cd.dat`) cannot be selected this way - the system will fail to boot. The only way to enable the cut-down firmware is to specify `gpu_mem=16`. The cut-down firmware removes support for codecs and 3D as well as limiting the initial early-boot framebuffer to 1080p @16bpp - although KMS can replace this with up to 32bpp 4K framebuffer(s) at a later stage as with any firmware. +NOTE: Cut-down firmware (`start*cd.elf` and `fixup*cd.dat`) cannot be selected this way - the system will fail to boot. The only way to enable the cut-down firmware is to specify `gpu_mem=16`. The cut-down firmware removes support for codecs, 3D and debug logging as well as limiting the initial early-boot framebuffer to 1080p @16bpp - although KMS can replace this with up to 32bpp 4K framebuffer(s) at a later stage as with any firmware. -NOTE: The Raspberry Pi 5 firmware is self-contained in the bootloader EEPROM. +NOTE: The Raspberry Pi 5, 500, 500+, and Compute Module 5 firmware is self-contained in the bootloader EEPROM. === `cmdline` @@ -21,7 +21,7 @@ NOTE: The Raspberry Pi 5 firmware is self-contained in the bootloader EEPROM. `kernel` is the alternative filename on the boot partition for loading the kernel. The default value on the Raspberry Pi 1, Zero and Zero W, and Raspberry Pi Compute Module 1 is `kernel.img`. The default value on the Raspberry Pi 2, 3, 3+ and Zero 2 W, and Raspberry Pi Compute Modules 3 and 3+ is `kernel7.img`. The default value on the Raspberry Pi 4 and 400, and Raspberry Pi Compute Module 4 is `kernel8.img`, or `kernel7l.img` if `arm_64bit` is set to 0. -The Raspberry Pi 5 firmware defaults to loading `kernel_2712.img` because this image contains optimisations specific to Raspberry Pi 5 (e.g. 16K page-size). If this file is not present, then the common 64-bit kernel (`kernel8.img`) will be loaded instead. +The Raspberry Pi 5, 500, 500+, and Compute Module 5 firmware defaults to loading `kernel_2712.img` because this image contains optimisations specific to those models (e.g. 16K page-size). If this file is not present, then the common 64-bit kernel (`kernel8.img`) will be loaded instead. === `arm_64bit` @@ -29,13 +29,40 @@ If set to 1, the kernel will be started in 64-bit mode. Setting to 0 selects 32- In 64-bit mode, the firmware will choose an appropriate kernel (e.g. `kernel8.img`), unless there is an explicit `kernel` option defined, in which case that is used instead. -Defaults to 1 on Pi 4s (Pi 4B, Pi 400, CM4 and CM4S), and 0 on all other platforms. However, if the name given in an explicit `kernel` option matches one of the known kernels then `arm_64bit` will be set accordingly. +Defaults to 1 on Raspberry Pi 4, 400 and Compute Module 4, 4S platforms. Defaults to 0 on all other platforms. However, if the name given in an explicit `kernel` option matches one of the known kernels then `arm_64bit` will be set accordingly. -NOTE: 64-bit kernels may be uncompressed image files or a gzip archive of an image (which can still be called kernel8.img; the bootloader will recognize the archive from the signature bytes at the beginning). The 64-bit kernel will only work on the Raspberry Pi 3, 3+, 4, 400, Zero 2 W and 2B rev 1.2, and Raspberry Pi Compute Modules 3, 3+ and 4. Raspberry Pi 5 only supports a 64-bit kernel, so this parameter has been removed for that device. +64-bit kernels come in the following forms: + +* uncompressed image files +* gzip archives of an image + +Both forms may use the `img` file extension; the bootloader recognizes archives using signature bytes at the start of the file. + +The following Raspberry Pi models support this flag: + +* 2B rev 1.2 +* 3B +* 3A+ +* 3B+ +* 4B +* 400 +* Zero 2 W +* Compute Module 3 +* Compute Module 3+ +* Compute Module 4 +* Compute Module 4S + +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. +`ramfsfile` is the optional filename on the boot partition of a `ramfs` to load. NOTE: Newer firmware supports the loading of multiple `ramfs` files. You should separate the multiple file names with commas, taking care not to exceed the 80-character line length limit. All the loaded files are concatenated in memory and treated as a single `ramfs` blob. More information is available https://forums.raspberrypi.com/viewtopic.php?f=63&t=10532[on the forums]. @@ -43,6 +70,7 @@ NOTE: Newer firmware supports the loading of multiple `ramfs` files. You should `ramfsaddr` is the memory address to which the `ramfsfile` should be loaded. +[[initramfs]] === `initramfs` The `initramfs` command specifies both the ramfs filename *and* the memory address to which to load it. It performs the actions of both `ramfsfile` and `ramfsaddr` in one parameter. The address can also be `followkernel` (or `0`) to place it in memory after the kernel image. Example values are: `initramfs initramf.gz 0x00800000` or `initramfs init.gz followkernel`. As with `ramfsfile`, newer firmwares allow the loading of multiple files by comma-separating their names. @@ -52,7 +80,7 @@ NOTE: This option uses different syntax from all the other options, and you shou [[auto_initramfs]] === `auto_initramfs` -If `auto_initramfs` is set to `1`, look for an initramfs file using the same rules as the kernel selection. +If `auto_initramfs` is set to `1`, the firmware looks for an `initramfs` file to match the kernel. The file must be in the same location as the kernel image, and the name is derived from the name of the kernel by replacing the `kernel` prefix with `initramfs`, and removing any extension such as `.img`, e.g. `kernel8.img` requires `initramfs8`. You can make use of `auto_initramfs` with custom kernel names provided the names begin with `kernel` and `initramfs` respectively and everything else matches (except for the absence of the file extension on the initramfs). Otherwise, an explicit xref:config_txt.adoc#initramfs[`initramfs`] statement is required. [[disable_poe_fan]] === `disable_poe_fan` @@ -65,7 +93,7 @@ If `disable_splash` is set to `1`, the rainbow splash screen will not be shown o === `enable_uart` -`enable_uart=1` (in conjunction with `console=serial0` in `cmdline.txt`) requests that the kernel creates a serial console, accessible using GPIOs 14 and 15 (pins 8 and 10 on the 40-pin header). Editing `cmdline.txt` to remove the line `quiet` enables boot messages from the kernel to also appear there. See also `uart_2ndstage`. +`enable_uart=1` (in conjunction with `console=serial0,115200` in `cmdline.txt`) requests that the kernel creates a serial console, accessible using GPIOs 14 and 15 (pins 8 and 10 on the 40-pin header). Editing `cmdline.txt` to remove the line `quiet` enables boot messages from the kernel to also appear there. See also `uart_2ndstage`. === `force_eeprom_read` @@ -74,7 +102,7 @@ Set this option to `0` to prevent the firmware from trying to read an I2C HAT EE [[os_prefix]] === `os_prefix` -`os_prefix` is an optional setting that allows you to choose between multiple versions of the kernel and Device Tree files installed on the same card. Any value in `os_prefix` is prepended to the name of any operating system files loaded by the firmware, where "operating system files" is defined to mean kernels, initramfs, cmdline.txt, .dtbs and overlays. The prefix would commonly be a directory name, but it could also be part of the filename such as "test-". For this reason, directory prefixes must include the trailing `/` character. +`os_prefix` is an optional setting that allows you to choose between multiple versions of the kernel and Device Tree files installed on the same card. Any value in `os_prefix` is prepended to the name of any operating system files loaded by the firmware, where "operating system files" is defined to mean kernels, `initramfs`, `cmdline.txt`, `.dtbs` and overlays. The prefix would commonly be a directory name, but it could also be part of the filename such as "test-". For this reason, directory prefixes must include the trailing `/` character. In an attempt to reduce the chance of a non-bootable system, the firmware first tests the supplied prefix value for viability - unless the expected kernel and .dtb can be found at the new location/name, the prefix is ignored (set to ""). A special case of this viability test is applied to overlays, which will only be loaded from `+${os_prefix}${overlay_prefix}+` (where the default value of <> is "overlays/") if `+${os_prefix}${overlay_prefix}README+` exists, otherwise it ignores `os_prefix` and treats overlays as shared. @@ -88,11 +116,12 @@ See also <> and xref:legacy_config_txt.adoc#ups USB On-The-Go (often abbreviated to OTG) is a feature that allows supporting USB devices with an appropriate OTG cable to configure themselves as USB hosts. On older Raspberry Pis, a single USB 2 controller was used in both USB host and device mode. -Raspberry Pi 4B and Raspberry Pi 400 (not CM4 or CM4IO) add a high performance USB 3 controller, attached via PCIe, to drive the main USB ports. The legacy USB 2 controller is still available on the USB-C power connector for use as a device (`otg_mode=0`, the default). +Flagship models since Raspberry Pi 4B and Keyboard models since Pi 400 add a high-performance USB 3 controller, attached via PCIe, to drive the main USB ports. The legacy USB 2 controller is still available on the USB-C power connector for use as a device (`otg_mode=0`, the default). Compute Modules before CM5 do not include this high-performance USB 3 controller. + +`otg_mode=1` requests that a more capable XHCI USB 2 controller is used as an alternative host controller on that USB-C connector. -`otg_mode=1` requests that a more capable XHCI USB 2 controller is used as another host controller on that USB-C connector. +NOTE: By default, Raspberry Pi OS includes a line in `/boot/firmware/config.txt` that enables this setting on Compute Module 4. -NOTE: Because CM4 and CM4IO don't include the external USB 3 controller, Raspberry Pi OS images set `otg_mode=1` on CM4 for better performance. [[overlay_prefix]] === `overlay_prefix` @@ -101,3 +130,228 @@ Specifies a subdirectory/prefix from which to load overlays, and defaults to `ov NOTE: Unless `+${os_prefix}${overlay_prefix}README+` exists, overlays are shared with the main OS (i.e. `os_prefix` is ignored). +=== Configuration Properties + +Raspberry Pi 5 requires a `config.txt` file to be present to indicate that the partition is bootable. + +[[boot_ramdisk]] +==== `boot_ramdisk` + +If this property is set to `1` then the bootloader will attempt load a ramdisk file called `boot.img` containing the xref:configuration.adoc#boot-folder-contents[boot filesystem]. Subsequent files (e.g. `start4.elf`) are read from the ramdisk instead of the original boot file system. + +The primary purpose of `boot_ramdisk` is to support `secure-boot`, however, unsigned `boot.img` files can also be useful to Network Boot or `RPIBOOT` configurations. + +* The maximum size for a ramdisk file is 96MB. +* `boot.img` files are raw disk `.img` files. The recommended format is a plain FAT32 partition with no MBR. +* The memory for the ramdisk filesystem is released before the operating system is started. +* If xref:raspberry-pi.adoc#fail-safe-os-updates-tryboot[TRYBOOT] is selected then the bootloader will search for `tryboot.img` instead of `boot.img`. +* See also xref:config_txt.adoc#autoboot-txt[autoboot.txt]. + +For more information about `secure-boot` and creating `boot.img` files please see https://github.com/raspberrypi/usbboot/blob/master/Readme.md[USBBOOT]. + +Default: `0` + +[[boot_load_flags]] +==== `boot_load_flags` + +Experimental property for custom firmware (bare metal). + +Bit 0 (0x1) indicates that the .elf file is custom firmware. This disables any compatibility checks (e.g. is USB MSD boot supported) and resets PCIe before starting the executable. + +Not relevant on Raspberry Pi 5 because there is no `start.elf` file. + +Default: `0x0` + +[[enable_rp1_uart]] +==== `enable_rp1_uart` + +When set to `1`, firmware initialises RP1 UART0 to 115200bps and doesn't reset RP1 before starting the OS (separately configurable using `pciex4_reset=1`). +This makes it easier to get UART output on the 40-pin header in early boot-code, for instance during bare-metal debug. + +Default: `0x0` + +[[pciex4_reset]] +==== `pciex4_reset` + +Raspberry Pi 5 only. + +By default, the PCIe x4 controller used by `RP1` is reset before starting the operating system. If this parameter is set to `0` then the reset is disabled allowing operating system or bare metal code to inherit the PCIe configuration setup from the bootloader. + +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` + +If `uart_2ndstage` is `1` then enable debug logging to the UART. This option also automatically enables UART logging in `start.elf`. This is also described on the xref:config_txt.adoc#boot-options[Boot options] page. + +The `BOOT_UART` property also enables bootloader UART logging but does not enable UART logging in `start.elf` unless `uart_2ndstage=1` is also set. + +Default: `0` + +[[erase_eeprom]] +==== `erase_eeprom` + +If `erase_eeprom` is set to `1` then `recovery.bin` will erase the entire SPI EEPROM instead of flashing the bootloader image. This property has no effect during a normal boot. + +Default: `0` + +[[set_reboot_arg1]] +==== `set_reboot_arg1` +Raspberry Pi 5 only. + +Sets the value of `boot_arg1` to be passed via a reset-safe register to the bootloader after a reboot. +See xref:config_txt.adoc#boot_arg1[`boot_arg1`] for more details. +Default: `` + +[[set_reboot_order]] +==== `set_reboot_order` + +Raspberry Pi 5 only. + +Sets the value of xref:raspberry-pi.adoc#BOOT_ORDER[BOOT_ORDER] to be passed via a reset-safe register to the bootloader after a reboot. As with `tryboot`, this is a one-time setting and is automatically cleared after use. + +This property could be used to debug different xref:raspberry-pi.adoc#BOOT_ORDER[BOOT_ORDER] settings. Alternatively, it could be used in a provisioning system which has control over power and the `nRPIBOOT` GPIO to override the boot mode without specifying xref:config_txt.adoc#conditional-filters[conditional filter] statements in the EEPROM config. + +Default: `` + +[[kernel_watchdog_timeout]] +==== `kernel_watchdog_timeout` + +If set to a non-zero value (in seconds), this property enables a hardware watchdog timer that is handed over to the operating system (OS) at boot. If the OS does not regularly "kick" or reset the watchdog, the system will be reset after the specified timeout. + +This property sets the `systemd` `watchdog.open_timeout` parameter, which controls how long the OS has to initialize and start servicing the watchdog. The value is passed to the OS via the kernel command line. For ongoing operation, the OS must also regularly reset the watchdog, typically controlled by the `RuntimeWatchdogSec` parameter in `systemd`. For more information, see https://www.freedesktop.org/software/systemd/man/systemd-system.conf.html#RuntimeWatchdogSec=[systemd watchdog documentation]. + +[NOTE] +==== +On Raspberry Pi OS Bookworm and earlier, the `RuntimeWatchdogSec` parameter is **not enabled by default** and this setting must be configured first in `/etc/systemd/system.conf` before the firmware kernel watchdog can be used. + +If both `BOOT_WATCHDOG_TIMEOUT` (EEPROM/bootloader setting, only supported on Raspberry Pi 4 and 5) and `kernel_watchdog_timeout` are set, the bootloader will seamlessly hand over from the bootloader watchdog to the kernel watchdog at the point the OS is started. This provides continuous watchdog coverage from power-on through to OS runtime. + +It is preferred to use `kernel_watchdog_timeout` rather than `dtparam=watchdog` because `kernel_watchdog_timeout` explicitly sets the `open_timeout` parameter, ensuring the watchdog is active until systemd takes over. +==== + +This is useful for ensuring that the system can recover from OS hangs or crashes after the boot process has completed. + +Default: `0` (disabled) + +[[kernel_watchdog_partition]] +==== `kernel_watchdog_partition` + +If the kernel watchdog triggers (i.e. the OS fails to reset the watchdog within the timeout), this property specifies the partition number to boot from after the reset. This allows for automatic failover to a recovery or alternate partition. + +You can use this in conjunction with the xref:config_txt.adoc#the-expression-filter[expression filter] to apply different settings or select a different boot flow when the watchdog triggers a reboot to a specific partition. + +See also the xref:raspberry-pi.adoc#PARTITION[PARTITION] property for more information about how to use high partition numbers to detect a watchdog trigger. + +Default: `0` (default partition) + + +[[eeprom_write_protect]] +==== `eeprom_write_protect` + +Configures the EEPROM `write status register`. This can be set either to mark the entire EEPROM as write-protected, or to clear write-protection. + +This option must be used in conjunction with the EEPROM `/WP` pin which controls updates to the EEPROM `Write Status Register`. Pulling `/WP` low (CM4 `EEPROM_nWP` or on a Raspberry Pi 4 `TP5`) does NOT write-protect the EEPROM unless the `Write Status Register` has also been configured. + +See the https://www.winbond.com/resource-files/w25x40cl_f%2020140325.pdf[Winbond W25x40cl] or https://www.winbond.com/hq/product/code-storage-flash-memory/serial-nor-flash/?__locale=en&partNo=W25Q16JV[Winbond W25Q16JV] datasheets for further details. + +`eeprom_write_protect` settings in `config.txt` for `recovery.bin`. + +|=== +| Value | Description + +| 1 +| Configures the write protect regions to cover the entire EEPROM. + +| 0 +| Clears the write protect regions. + +| -1 +| Do nothing. +|=== + +NOTE: `flashrom` does not support clearing of the write-protect regions and will fail to update the EEPROM if write-protect regions are defined. + +On Raspberry Pi 5 `/WP` is pulled low by default and consequently write-protect is enabled as soon as the `Write Status Register` is configured. To clear write-protect pull `/WP` high by connecting `TP14` and `TP1`. + +Default: `-1` + +[[os_check]] +==== `os_check` + +On Raspberry Pi 5 the firmware automatically checks for a compatible Device Tree file before attempting to boot from the current partition. Otherwise, older non-compatible kernels would be loaded and then hang. +To disable this check (e.g. for bare-metal development), set `os_check=0` in config.txt + +Default: `1` + +[[bootloader_update]] +==== `bootloader_update` + +This option may be set to 0 to block self-update without requiring the EEPROM configuration to be updated. This is sometimes useful when updating multiple Raspberry Pis via network boot because this option can be controlled per Raspberry Pi (e.g. via a serial number filter in `config.txt`). + +Default: `1` + +=== Secure Boot configuration properties + +[.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/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. + +For more information about enabling `secure-boot` please see the https://github.com/raspberrypi/usbboot/blob/master/Readme.md#secure-boot[Secure Boot readme] and the https://github.com/raspberrypi/usbboot/blob/master/secure-boot-example/README.md[Secure Boot tutorial] in the https://github.com/raspberrypi/usbboot[USBBOOT] repo. + +[[program_pubkey]] +==== `program_pubkey` + +If this property is set to `1` then `recovery.bin` will write the hash of the public key in the EEPROM image to OTP. Once set, the bootloader will reject EEPROM images signed with different RSA keys or unsigned images. + +Default: `0` + +[[revoke_devkey]] +==== `revoke_devkey` + +Raspberry Pi 4 only. + +If this property is set to `1` then `recovery.bin` will write a value to OTP that prevents the ROM from loading old versions of the second stage bootloader which do not support `secure-boot`. This prevents `secure-boot` from being turned off by reverting to an older release of the bootloader. Therefore, this property must be set if `secure-boot` is enabled on production devices. + +This property is automatically is set by `recovery.bin` `2025/05/16` and newer if `program_pubkey=1`. + + +Default: `0` + +[[program_rpiboot_gpio]] +==== `program_rpiboot_gpio` + +Raspberry Pi 4B and Raspberry Pi 400 only. + +Compute Module 4 and 4S have a dedicated `nRPIBOOT` jumper to select `RPIBOOT` mode. Raspberry Pi 4B and Raspberry Pi 400 lack a dedicated `nRPIBOOT` jumper so one of the following GPIOs must be selected for use as `nRPIBOOT`. + +* `2` +* `4` +* `5` +* `6` +* `7` +* `8` + +The GPIO may be used as a general-purpose I/O pin after the OS has started. However, you should verify that this GPIO configuration does not conflict with any HATs which might pull the GPIO low during boot. + +Although `secure-boot` requires this property to be set on Raspberry Pi 4B and Raspberry Pi 400, it does not depend on `secure-boot`. For example, `RPIBOOT` can be useful for automated testing. + +For safety, this OTP value can _only_ be programmed via `RPIBOOT`. As a result, you must first clear the bootloader EEPROM using `erase_eeprom`. The blank EEPROM causes the ROM to failover to `RPIBOOT` mode, which then allows this option to be set. + +Default: `{nbsp}` + +[[program_jtag_lock]] +==== `program_jtag_lock` + +If this property is set to `1` then `recovery.bin` will program an OTP value that prevents VideoCore JTAG from being used. This option requires that `program_pubkey` and `revoke_devkey` are also set. This option can prevent failure analysis, and should only be set after the device has been fully tested. + +Default: `0` + diff --git a/documentation/asciidoc/computers/config_txt/codeclicence.adoc b/documentation/asciidoc/computers/config_txt/codeclicence.adoc index 597553c07..688591a12 100644 --- a/documentation/asciidoc/computers/config_txt/codeclicence.adoc +++ b/documentation/asciidoc/computers/config_txt/codeclicence.adoc @@ -2,7 +2,9 @@ Hardware decoding of additional codecs on the Raspberry Pi 3 and earlier models can be enabled by https://codecs.raspberrypi.com/license-keys/[purchasing a licence] that is locked to the CPU serial number of your Raspberry Pi. -On the Raspberry Pi 4, the hardware codecs for MPEG2 or VC1 are permanently disabled and cannot be enabled even with a licence key; on the Raspberry Pi 4, thanks to its increased processing power compared to earlier models, MPEG2 and VC1 can be decoded in software via applications such as VLC. Therefore, a hardware codec licence key is not needed if you're using a Raspberry Pi 4. +The Raspberry Pi 4 has permanently disabled hardware decoders for MPEG2 and VC1. These codecs cannot be enabled, so a hardware codec licence key is not needed. Software decoding of MPEG2 and VC1 files performs well enough for typical use cases. + +The Raspberry Pi 5 has H.265 (HEVC) hardware decoding. This decoding is enabled by default, so a hardware codec licence key is not needed. === `decode_MPG2` diff --git a/documentation/asciidoc/computers/config_txt/common.adoc b/documentation/asciidoc/computers/config_txt/common.adoc index 51edba6ef..39c4a225e 100644 --- a/documentation/asciidoc/computers/config_txt/common.adoc +++ b/documentation/asciidoc/computers/config_txt/common.adoc @@ -2,23 +2,29 @@ === Common display options -==== `hdmi_enable_4kp60` (Raspberry Pi 4 only) +==== `hdmi_enable_4kp60` -By default, when connected to a 4K monitor, the Raspberry Pi 4B, 400 and CM4 will select a 30Hz refresh rate. Use this option to allow selection of 60Hz refresh rates. +NOTE: This option applies only to Raspberry Pi 4, Compute Module 4, Compute Module 4S, and Pi 400. -IMPORTANT: It is not possible to output 4Kp60 on both micro HDMI ports simultaneously on your Raspberry Pi 4. - -WARNING: Setting `hdmi_enable_4kp60` will increase power consumption and the temperature of your Raspberry Pi. +By default, when connected to a 4K monitor, certain models select a 30Hz refresh rate. Use this option to allow selection of 60Hz refresh rates. Models impacted by this setting do _not_ support 4Kp60 output on both micro HDMI ports simultaneously. Enabling this setting increases power consumption and temperature. === Common hardware configuration options ==== `camera_auto_detect` -With this setting enabled (in Raspberry Pi OS it is enabled by default), the firmware will automatically load overlays for CSI cameras that it recognises. Set `camera_auto_detect=0` to disable the setting. +By default, Raspberry Pi OS includes a line in `/boot/firmware/config.txt` that enables this setting. + +When enabled, the firmware will automatically load overlays for recognised CSI cameras. + +To disable, set `camera_auto_detect=0` (or remove `camera_auto_detect=1`). ==== `display_auto_detect` -With this setting enabled (it is enabled by default in Raspberry Pi OS), the firmware will automatically load overlays for DSI displays that it recognises. Set `display_auto_detect=0` to disable. +By default, Raspberry Pi OS includes a line in `/boot/firmware/config.txt` that enables this setting. + +When enabled, the firmware will automatically load overlays for recognised DSI displays. + +To disable, set `display_auto_detect=0` (or remove `display_auto_detect=1`). ==== `dtoverlay` @@ -30,14 +36,24 @@ For more details, see xref:configuration.adoc#part3.1[DTBs, overlays and config. ==== `dtparam` -Device Tree configuration files for Raspberry Pis support a number of parameters for such things as enabling I2C and SPI interfaces. Many DT overlays are configurable via the use of parameters. Both types of parameters can be supplied using the `dtparam` setting. In addition, overlay parameters can be appended to the `dtoverlay` option, separated by commas, but keep in mind the line length limit of 98 characters. +Device Tree configuration files for Raspberry Pi devices support various parameters for such things as enabling I2C and SPI interfaces. Many DT overlays are configurable via the use of parameters. Both types of parameters can be supplied using the `dtparam` setting. In addition, overlay parameters can be appended to the `dtoverlay` option, separated by commas, but keep in mind the line length limit of 98 characters. For more details, see xref:configuration.adoc#part3.1[DTBs, overlays and config.txt]. -==== `arm_boost` (Raspberry Pi 4 Only) +==== `arm_boost` + +NOTE: This option applies only to later Raspberry Pi 4B revisions which include two-phase power delivery, and all revisions of Pi 400. + +By default, Raspberry Pi OS includes a line in `/boot/firmware/config.txt` that enables this setting on supported devices. + +Some Raspberry Pi devices have a second switch-mode power supply for the SoC voltage rail. When enabled, increases the default turbo-mode clock from 1.5GHz to 1.8GHz. + +To disable, set `arm_boost=0`. + +==== `power_force_3v3_pwm` -All Raspberry Pi 400s and newer revisions of the Raspberry Pi 4B are equipped with a second switch-mode power supply for the SoC voltage rail, and this allows the default turbo-mode clock to be increased from 1.5GHz to 1.8GHz. This change is enabled by default in Raspberry Pi OS. Set `arm_boost=0` to disable. +NOTE: This option applies only to Raspberry Pi 5, 500, 500+, and Compute Module 5. -==== `power_force_3v3_pwm` (Raspberry Pi 5 Only) +Forces PWM on 3.3V output from the GPIO header or CSI connector. -Forces PWM when using a 3V3 power supply. Set `power_force_3v3_pwm=0` to disable. +To disable, set `power_force_3v3_pwm=0`. diff --git a/documentation/asciidoc/computers/config_txt/conditional.adoc b/documentation/asciidoc/computers/config_txt/conditional.adoc index 9e194a1e8..3cbce087b 100644 --- a/documentation/asciidoc/computers/config_txt/conditional.adoc +++ b/documentation/asciidoc/computers/config_txt/conditional.adoc @@ -11,31 +11,43 @@ The `[all]` filter is the most basic filter. It resets all previously set filter === Model filters -The conditional model filters are applied according to the following table. +The conditional model filters apply according to the following table. |=== -| Filter | Applicable model(s) +| Filter | Applicable models | `[pi1]` -| Model 1A, Model 1B, Model 1A+, Model 1B+, Compute Module 1 +| 1A, 1B, 1A+, 1B+, Compute Module 1 | `[pi2]` -| Model 2B (BCM2836- or BCM2837-based) +| 2B (BCM2836- or BCM2837-based) | `[pi3]` -| Model 3B, Model 3B+, Model 3A+, Compute Module 3, Compute Module 3+ +| 3B, 3B+, 3A+, Compute Module 3, Compute Module 3+ | `[pi3+]` -| Model 3A+, Model 3B+ (also sees `[pi3]` contents) +| 3A+, 3B+ (also sees `[pi3]` contents) | `[pi4]` -| Model 4B, Pi 400, Compute Module 4, Compute Module 4S +| 4B, 400, Compute Module 4, Compute Module 4S | `[pi5]` -| Raspberry Pi 5 +| 5, 500, 500+, Compute Module 5 | `[pi400]` -| Pi 400 (also sees `[pi4]` contents) +| 400 (also sees `[pi4]` contents) + +| `[pi500]` +| 500/500+ (also sees `[pi5]` contents) + +| `[cm1]` +| Compute Module 1 (also sees `[pi1]` contents) + +| `[cm3]` +| Compute Module 3 (also sees `[pi3]` contents) + +| `[cm3+]` +| Compute Module 3+ (also sees `[pi3+]` contents) | `[cm4]` | Compute Module 4 (also sees `[pi4]` contents) @@ -43,6 +55,9 @@ The conditional model filters are applied according to the following table. | `[cm4s]` | Compute Module 4S (also sees `[pi4]` contents) +| `[cm5]` +| Compute Module 5 (also sees `[pi5]` contents) + | `[pi0]` | Zero, Zero W, Zero 2 W @@ -60,41 +75,186 @@ The conditional model filters are applied according to the following table. These are particularly useful for defining different `kernel`, `initramfs`, and `cmdline` settings, as the Raspberry Pi 1 and Raspberry Pi 2 require different kernels. They can also be useful to define different overclocking settings, as the Raspberry Pi 1 and Raspberry Pi 2 have different default speeds. For example, to define separate `initramfs` images for each: ---- - [pi1] - initramfs initrd.img-3.18.7+ followkernel - [pi2] - initramfs initrd.img-3.18.7-v7+ followkernel - [all] +[pi1] +initramfs initrd.img-3.18.7+ followkernel +[pi2] +initramfs initrd.img-3.18.7-v7+ followkernel +[all] ---- Remember to use the `[all]` filter at the end, so that any subsequent settings aren't limited to Raspberry Pi 2 hardware only. -NOTE: Some models of Raspberry Pi (Zero W, Zero 2 W, Model 3B+, Pi 400, Compute Module 4 and Compute Module 4S) see the settings for multiple filters (as listed in the table above). This means that if you want a setting to apply only to (e.g.) a Model 4B without _also_ applying that setting to a Pi 400, then the setting in the `[pi4]` section would need to be reverted by an alternate setting in a following `[pi400]` section - the ordering of such sections is significant. Alternatively, you could use a `[board-type=0x11]` filter which has a one-to-one mapping to different hardware products. +[NOTE] +==== +Some models of Raspberry Pi, including Zero, Compute Module, and Keyboard models, read settings from multiple filters. To apply a setting to only one model: + +* apply the setting to the base model (e.g. `[pi4]`), then revert the setting for all models that read the base model's filters (e.g. `[pi400]`, `[cm4]`, `[cm4s]`) +* use the `board-type` filter with a revision code to target a single model (e.g. `[board-type=0x11]`) +==== === The `[none]` filter The `[none]` filter prevents any settings that follow from being applied to any hardware. Although there is nothing that you can't do without `[none]`, it can be a useful way to keep groups of unused settings in config.txt without having to comment out every line. +[source,ini] +---- +# Bootloader EEPROM config. +# If PM_RSTS is partition 62 then set bootloader properties to disable +# SD high speed and show HDMI diagnostics +# Boot from partition 2 with debug option. +[partition=62] +# Only high (>31) partition can be remapped. +PARTITION=2 +SD_QUIRKS=0x1 +HDMI_DELAY=0 +---- + +Example `config.txt` - (Currently Raspberry Pi 5 onwards) +[source,ini] +---- +# config.txt - If the original requested partition number in PM_RSTS was a +# special number then use an alternate cmdline.txt +[partition=62] +cmdline=cmdline-recovery.txt +---- + +The raw value of the `PM_RSTS` register at bootup is available via `/proc/device-tree/chosen/bootloader/rsts` and the final partition number used for booting is available via `/proc/device-tree/chosen/bootloader/partition`. These are big-endian binary values. + +=== The expression filter + +The expression filter provides support for comparing unsigned integer "boot variables" to constants using a simple set of operators. It is intended to support OTA update mechanisms, debug and test. + +* The "boot variables" are `boot_arg1`, `boot_count`, `boot_partition` and `partition`. +* Boot variables are always lower case. +* Integer constants may either be written as decimal or as hex. +* Expression conditional filters have no side-effects e.g. no assignment operators. +* As with other filter types the expression filter cannot be nested. +* Use the `[all]` filter to reset expressions and all other conditional filter types. + +Syntax: +[source,ini] +---- +# ARG is a boot-variable +# VALUE and MASK are unsigned integer constants +[ARG=VALUE] # selected if (ARG == VALUE) +[ARG&MASK] # selected if ((ARG & VALUE) != 0) +[ARG&MASK=VALUE] # selected if ((ARG & MASK) == VALUE) +[ARGVALUE] # selected if (ARG > VALUE) + +---- + +==== `boot_arg1` +Raspberry Pi 5 and newer devices only. + +The `boot_arg1` variable is a 32-bit user defined value which is stored in a reset-safe register allowing parameters to be passed accross a reboot. + +Setting `boot_arg1` to 42 via `config.txt`: +[source,ini] +---- +set_reboot_arg1=42 +---- +The `set_reboot_arg1` property sets the value for the next boot. It does not change the current value as seen by the config parser. + +Setting `boot_arg1` to 42 via vcmailbox: +[source,console] +---- +sudo vcmailbox 0x0003808c 8 8 1 42 +---- + +Reading `boot_arg1` via vcmailbox: +[source,console] +---- +sudo vcmailbox 0x0003008c 8 8 1 0 +# Example output - boot_arg1 is 42 +# 0x00000020 0x80000000 0x0003008c 0x00000008 0x80000008 0x00000001 0x0000002a 0x0000000 +---- +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. + +The `boot_count` variable is an 8-bit value stored in a reset-safe register that is incremented at boot (wrapping back to zero at 256). It is cleared if power is disconnected. + +To read `boot_count` via vcmailbox: +[source,console] +---- +sudo vcmailbox 0x0003008d 4 4 0 +# Example - boot count is 3 +# 0x0000001c 0x80000000 0x0003008d 0x00000004 0x80000004 0x00000003 0x00000000 +---- + +Setting/clearing `boot_count` via vcmailbox: +[source,console] +---- +# Clear boot_count by setting it to zero. +sudo vcmailbox 0x0003808d 4 4 0 +---- +The value of `boot_count` when the OS was started can be read via xref:configuration.adoc#part4[device-tree] at `/proc/device-tree/chosen/bootloader/count` + +==== `boot_partition` +The `boot_partition` variable can be used to select alternate OS files (e.g. `cmdline.txt`) to be loaded, depending on which partition `config.txt` was loaded from after processing xref:config_txt.adoc#autoboot-txt[autoboot.txt]. This is intended for use with an `A/B` boot-system with `autoboot.txt` where it is desirable to be able to have identical files installed to the boot partition for both the `A` and `B` images. + +The value of the `boot_partition` can be different to the requested `partition` variable if it was overriden by setting `boot_partition` in xref:config_txt.adoc#autoboot-txt[autoboot.txt] or if the specified partion was not bootable and xref:raspberry-pi.adoc#PARTITION_WALK[PARTITION_WALK] was enabled in the EEPROM config. + +Example `config.txt` - select the matching root filesystem for the `A/B` boot file-system: +[source,ini] +---- +# Use different cmdline files to point to different root filesystems based on which partition the system booted from. +[boot_partition=1] +cmdline=cmdline_rootfs_a.txt # Points to root filesystem A + +[boot_partition=2] +cmdline=cmdline_rootfs_b.txt # Points to root filesystem B +---- + +The value of `boot_partition` i.e. the partition used to boot the OS can be read from xref:configuration.adoc#part4[device-tree] at `/proc/device-tree/chosen/bootloader/partition` + +==== `partition` +The `partition` variable can be used to select alternate boot flows according to the requested partition number (`sudo reboot N`) or via direct usage of the `PM_RSTS` watchdog register. + + === The `[tryboot]` filter This filter succeeds if the `tryboot` reboot flag was set. It is intended for use in xref:config_txt.adoc#autoboot-txt[autoboot.txt] to select a different `boot_partition` in `tryboot` mode for fail-safe OS updates. +The value of `tryboot` at the start of boot can be read via xref:configuration.adoc#part4[device-tree] at `/proc/device-tree/chosen/bootloader/tryboot` + === The `[EDID=*]` filter When switching between multiple monitors while using a single SD card in your Raspberry Pi, and where a blank config isn't sufficient to automatically select the desired resolution for each one, this allows specific settings to be chosen based on the monitors' EDID names. To view the EDID name of an attached monitor, you need to follow a few steps. Run the following command to see which output devices you have on your Raspberry Pi: -[source] +[source,console] ---- -ls -1 /sys/class/drm/card?-HDMI-A-?/edid +$ ls -1 /sys/class/drm/card?-HDMI-A-?/edid ---- On a Raspberry Pi 4, this will print something like: -[source] ---- /sys/class/drm/card1-HDMI-A-1/edid /sys/class/drm/card1-HDMI-A-2/edid @@ -102,14 +262,13 @@ On a Raspberry Pi 4, this will print something like: You then need to run `edid-decode` against each of these filenames, for example: -[source] +[source,console] ---- -edid-decode /sys/class/drm/card1-HDMI-A-1/edid +$ edid-decode /sys/class/drm/card1-HDMI-A-1/edid ---- If there's no monitor connected to that particular output device, it'll tell you the EDID was empty; otherwise it will serve you *lots* of information about your monitor's capabilities. You need to look for the lines specifying the `Manufacturer` and the `Display Product Name`. The "EDID name" is then `-`, with any spaces in either string replaced by underscores. For example, if your `edid-decode` output included: -[source] ---- .... Vendor & Product Identification: @@ -123,7 +282,7 @@ The EDID name for this monitor would be `DEL-DELL_U2422H`. You can then use this as a conditional-filter to specify settings that only apply when this particular monitor is connected: -[source] +[source,ini] ---- [EDID=DEL-DELL_U2422H] cmdline=cmdline_U2422H.txt @@ -142,14 +301,13 @@ Sometimes settings should only be applied to a single specific Raspberry Pi, eve To view the serial number of your Raspberry Pi, run the following command: -[source] +[source,console] ---- -cat /proc/cpuinfo +$ cat /proc/cpuinfo ---- A 16-digit hex value will be displayed near the bottom of the output. Your Raspberry Pi's serial number is the last eight hex-digits. For example, if you see: -[source] ---- Serial : 0000000012345678 ---- @@ -160,45 +318,52 @@ NOTE: On some Raspberry Pi models, the first 8 hex-digits contain values other t You can define settings that will only be applied to this specific Raspberry Pi: -[source] +[source,ini] ---- [0x12345678] -# settings here are applied only to the Raspberry Pi with this serial +# settings here apply only to the Raspberry Pi with this serial + [all] -# settings here are applied to all hardware +# settings here apply to all hardware + ---- === The GPIO filter You can also filter depending on the state of a GPIO. For example: -[source] +[source,ini] ---- [gpio4=1] -# Settings here are applied if GPIO 4 is high +# Settings here apply if GPIO 4 is high [gpio2=0] -# Settings here are applied if GPIO 2 is low +# Settings here apply if GPIO 2 is low [all] -# settings here are applied to all hardware +# settings here apply to all hardware + ---- -=== Combining conditional filters +=== Combine conditional filters Filters of the same type replace each other, so `[pi2]` overrides `[pi1]`, because it is not possible for both to be true at once. Filters of different types can be combined by listing them one after the other, for example: -[source] +[source,ini] ---- - # settings here are applied to all hardware - [EDID=VSC-TD2220] - # settings here are applied only if monitor VSC-TD2220 is connected - [pi2] - # settings here are applied only if monitor VSC-TD2220 is connected *and* on a Raspberry Pi 2 - [all] - # settings here are applied to all hardware +# settings here apply to all hardware + +[EDID=VSC-TD2220] +# settings here apply only if monitor VSC-TD2220 is connected + +[pi2] +# settings here apply only if monitor VSC-TD2220 is connected *and* on a Raspberry Pi 2 + +[all] +# settings here apply to all hardware + ---- - + Use the `[all]` filter to reset all previous filters and avoid unintentionally combining different filter types. diff --git a/documentation/asciidoc/computers/config_txt/gpio.adoc b/documentation/asciidoc/computers/config_txt/gpio.adoc index eb4af2577..39d9c64bd 100644 --- a/documentation/asciidoc/computers/config_txt/gpio.adoc +++ b/documentation/asciidoc/computers/config_txt/gpio.adoc @@ -2,9 +2,8 @@ === `gpio` -The `gpio` directive allows GPIO pins to be set to specific modes and values at boot time in a way that would -previously have needed a custom `dt-blob.bin` file. Each line applies the same settings (or at least makes the same -changes) to a set of pins, addressing either a single pin (`3`), a range of pins (`3-4`), or a comma-separated list of either (`3-4,6,8`). +The `gpio` directive allows GPIO pins to be set to specific modes and values at boot time in a way that would previously have needed a custom `dt-blob.bin` file. Each line applies the same settings (or at least makes the same changes) to a set of pins, addressing either a single pin (`3`), a range of pins (`3-4`), or a comma-separated list of either (`3-4,6,8`). + The pin set is followed by an `=` and one or more comma-separated attributes from this list: * `ip` - Input @@ -16,10 +15,11 @@ The pin set is followed by an `=` and one or more comma-separated attributes fro * `pd` - Pull down * `pn/np` - No pull -`gpio` settings are applied in order, so those appearing later override those appearing earlier. +`gpio` settings apply in order, so those appearing later override those appearing earlier. Examples: +[source,ini] ---- # Select Alt2 for GPIO pins 0 to 27 (for DPI24) gpio=0-27=a2 @@ -34,13 +34,36 @@ gpio=18,20=pu gpio=17-21=ip ---- -The `gpio` directive respects the "[...]" conditional filters in `config.txt`, so it is possible to use different settings -based on the model, serial number, and EDID. +The `gpio` directive respects the "[...]" conditional filters in `config.txt`, so it is possible to use different settings based on the model, serial number, and EDID. + +GPIO changes made through this mechanism do not have any direct effect on the kernel. They don't cause GPIO pins to be exported to the `sysfs` interface, and they can be overridden by `pinctrl` entries in the Device Tree as well as utilities like `pinctrl`. + +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` -GPIO changes made through this mechanism do not have any direct effect on the kernel. They don't cause GPIO pins to -be exported to the sysfs interface, and they can be overridden by pinctrl entries in the Device Tree as well as -utilities like `pinctrl`. +| GPIO27 +| `ARM_TMS` +|=== -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. diff --git a/documentation/asciidoc/computers/config_txt/memory.adoc b/documentation/asciidoc/computers/config_txt/memory.adoc index ffc0dcf9b..8c6d90731 100644 --- a/documentation/asciidoc/computers/config_txt/memory.adoc +++ b/documentation/asciidoc/computers/config_txt/memory.adoc @@ -4,6 +4,7 @@ This parameter can be used to force a Raspberry Pi to limit its memory capacity: specify the total amount of RAM, in megabytes, you wish the Raspberry Pi to use. For example, to make a 4GB Raspberry Pi 4B behave as though it were a 1GB model, use the following: +[source,ini] ---- total_mem=1024 ---- diff --git a/documentation/asciidoc/computers/config_txt/overclocking.adoc b/documentation/asciidoc/computers/config_txt/overclocking.adoc index 3054d452c..1c7f33910 100644 --- a/documentation/asciidoc/computers/config_txt/overclocking.adoc +++ b/documentation/asciidoc/computers/config_txt/overclocking.adoc @@ -6,15 +6,16 @@ Overclocking and overvoltage will be disabled at runtime when the SoC reaches `t NOTE: For more information xref:raspberry-pi.adoc#frequency-management-and-thermal-control[see the section on frequency management and thermal control]. -WARNING: Setting any overclocking parameters to values other than those used by xref:configuration.adoc#overclock[raspi-config] may set a permanent bit within the SoC, making it possible to detect that your Raspberry Pi has been overclocked. The specific circumstances where the overclock bit is set are if `force_turbo` is set to `1` and any of the `over_voltage_*` options are set to a value of less than `0`. See the https://www.raspberrypi.com/news/introducing-turbo-mode-up-to-50-more-performance-for-free/[blog post on Turbo mode] for more information. +WARNING: Setting any overclocking parameters to values other than those used by xref:configuration.adoc#overclock[`raspi-config`] may set a permanent bit within the SoC. This makes it possible to detect that your Raspberry Pi was once overclocked. The overclock bit sets when `force_turbo` is set to `1` and any of the `over_voltage_*` options are set to a value of more than `0`. See the https://www.raspberrypi.com/news/introducing-turbo-mode-up-to-50-more-performance-for-free/[blog post on Turbo mode] for more information. === Overclocking +[cols="1m,3"] |=== | Option | Description | arm_freq -| Frequency of the ARM CPU in MHz. +| Frequency of the Arm CPU in MHz. | arm_boost | Increases `arm_freq` to the highest supported frequency for the board-type and firmware. Set to `1` to enable. @@ -54,12 +55,16 @@ WARNING: Setting any overclocking parameters to values other than those used by | over_voltage_sdram_p | SDRAM phy voltage adjustment. [-16,8] equates to [0.8V,1.4V] with 0.025V steps. Not supported on Raspberry Pi 4 or later devices. - + | force_turbo -| Forces turbo mode frequencies even when the ARM cores are not busy. Enabling this may set the warranty bit if `over_voltage_*` is also set. +| Forces turbo mode frequencies even when the Arm cores are not busy. Enabling this may set the warranty bit if `over_voltage_*` is also set. | initial_turbo -| Enables https://forums.raspberrypi.com/viewtopic.php?f=29&t=6201&start=425#p180099[turbo mode from boot] for the given value in seconds, or until cpufreq sets a frequency. The maximum value is `60`. +| Enables https://forums.raspberrypi.com/viewtopic.php?f=29&t=6201&start=425#p180099[turbo mode from boot] for the given value in seconds, or until `cpufreq` sets a frequency. The maximum value is `60`. The November 2024 firmware update made the following changes: + +* changed the default from `0` to `60` to reduce boot time +* switched the kernel CPU performance governor from `powersave` to `ondemand` + | arm_freq_min | Minimum value of `arm_freq` used for dynamic frequency clocking. Note that reducing this value below the default does not result in any significant power savings, and is not currently supported. @@ -96,13 +101,17 @@ WARNING: Setting any overclocking parameters to values other than those used by | temp_soft_limit | *3A+/3B+ only*. CPU speed throttle control. This sets the temperature at which the CPU clock speed throttling system activates. At this temperature, the clock speed is reduced from 1400MHz to 1200MHz. Defaults to `60`, can be raised to a maximum of `70`, but this may cause instability. + +| core_freq_fixed +| Setting to 1 disables active scaling of the core clock frequency and ensures that any peripherals that use the core clock will maintain a consistent speed. The fixed clock speed is the higher/turbo frequency for the platform in use. Use this in preference to setting specific core_clock frequencies as it provides portability of config files between platforms. + |=== -This table gives the default values for the options on various Raspberry Pi models, all frequencies are stated in mHz. +This table gives the default values for the options on various Raspberry Pi models, all frequencies are stated in MHz. -[cols=",^,^,^,^,^,^,^,^,^,^"] +[cols="m,^,^,^,^,^,^,^,^,^,^"] |=== -| Option | Pi 0/W | Pi1 | Pi2 | Pi3 | Pi3A+/Pi3B+ | CM4 & Pi4B <= R1.3 | Pi4B R1.4 | Pi 400 | Pi Zero 2 W | Pi 5 +| Option | Pi Zero W | Pi 1 | Pi 2 | Pi 3 | Pi 3A+/Pi 3B+ | CM4 & Pi 4B <= R1.3 | Pi 4B R1.4 | Pi 400 | Pi Zero 2 W | Pi 5/500/500+ | arm_freq | 1000 @@ -111,7 +120,7 @@ This table gives the default values for the options on various Raspberry Pi mode | 1200 | 1400 | 1500 -| 1500 or 1800 if arm_boost=1 +| 1500 or 1800 if `arm_boost`=1 | 1800 | 1000 | 2400 @@ -162,7 +171,7 @@ This table gives the default values for the options on various Raspberry Pi mode | 500 | 500 | 300 -| 910 +| 960 | hevc_freq | N/A @@ -275,7 +284,7 @@ This table gives the default values for the options on various Raspberry Pi mode This table gives defaults for options which are the same across all models. -[cols=",^"] +[cols="m,^"] |=== | Option | Default @@ -317,11 +326,11 @@ The minimum core frequency when the system is idle must be fast enough to suppor | Default | 500 -| hdmi_enable_4kp60 +| `hdmi_enable_4kp60` | 550 |=== -NOTE: Raspberry Pi 5 supports dual-4Kp60 displays with the idle-clock settings so `hdmi_enable_4kp60` is redundant. +NOTE: There is no need to use `hdmi_enable_4kp60` on Flagship models since Raspberry Pi 5, Compute Modules since CM5, and Keyboard models since Pi 500; they support dual-4Kp60 displays by default. * Overclocking requires the latest firmware release. * The latest firmware automatically scales up the voltage if the system is overclocked. Manually setting `over_voltage` disables automatic voltage scaling for overclocking. @@ -330,28 +339,36 @@ NOTE: Raspberry Pi 5 supports dual-4Kp60 displays with the idle-clock settings s ==== `force_turbo` -By default (`force_turbo=0`) the on-demand CPU frequency driver will raise clocks to their maximum frequencies when the ARM cores are busy, and will lower them to the minimum frequencies when the ARM cores are idle. +By default (`force_turbo=0`) the on-demand CPU frequency driver will raise clocks to their maximum frequencies when the Arm cores are busy, and will lower them to the minimum frequencies when the Arm cores are idle. -`force_turbo=1` overrides this behaviour and forces maximum frequencies even when the ARM cores are not busy. +`force_turbo=1` overrides this behaviour and forces maximum frequencies even when the Arm cores are not busy. === Clocks relationship ==== Raspberry Pi 4 + The GPU core, CPU, SDRAM and GPU each have their own PLLs and can have unrelated frequencies. The h264, v3d and ISP blocks share a PLL. -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. +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. **** -To view the Raspberry Pi's temperature, type `cat /sys/class/thermal/thermal_zone0/temp`. Divide the result by 1000 to find the value in degrees Celsius. Alternatively, there is a vcgencmd, `vcgencmd measure_temp`, that interrogates the GPU directly for its temperature. +To view the temperature of a Raspberry Pi, run the following command: + +[source,console] +---- +$ cat /sys/class/thermal/thermal_zone0/temp +---- + +Divide the result by 1000 to find the value in degrees Celsius. Alternatively, you can use `vcgencmd measure_temp` to report the GPU temperature. -Hitting the temperature limit is not harmful to the SoC, but it will cause the CPU to throttle. A heatsink can help to control the core temperature, and therefore performance. This is especially useful if the Raspberry Pi is running inside a case. Airflow over the heatsink will make cooling more efficient. +Hitting the temperature limit is not harmful to the SoC, but it will cause the CPU to throttle. A heat sink can help to control the core temperature, and therefore performance. This is especially useful if the Raspberry Pi is running inside a case. Airflow over the heat sink will make cooling more efficient. -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. +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`. @@ -361,10 +378,20 @@ It is essential to keep the supply voltage above 4.8V for reliable performance. To monitor the Raspberry Pi's PSU voltage, you will need to use a multimeter to measure between the VCC and GND pins on the GPIO. More information is available in the xref:raspberry-pi.adoc#power-supply[power] section of the documentation. -If the voltage drops below 4.63V (±5%), the ARM cores and the GPU will be throttled back, and a message indicating the low voltage state will be added to the kernel log. +If the voltage drops below 4.63V (±5%), the Arm cores and the GPU will be throttled back, and a message indicating the low voltage state will be added to the kernel log. -The Raspberry Pi 5 PMIC has built in ADCs that allow the supply voltage to be measured. To do this run `vcgencmd pmic_read_adc EXT5V_V` +The Raspberry Pi 5 PMIC has built in ADCs that allow the supply voltage to be measured. To view the current supply voltage, run the following command: + +[source,console] +---- +$ vcgencmd pmic_read_adc EXT5V_V +---- === Overclocking problems -Most overclocking issues show up immediately with a failure to boot. If this occurs, hold down the `shift` key during the next boot. This will temporarily disable all overclocking, allowing you to boot successfully and then edit your settings. +Most overclocking issues show up immediately, when the device fails to boot. If your device fails to boot due to an overclocking configuration change, use the following steps to return your device to a bootable state: + +. Remove any clock frequency overrides from `config.txt`. +. Increase the core voltage using `over_voltage_delta`. +. Re-apply overclocking parameters, taking care to avoid the previous known-bad overclocking parameters. + diff --git a/documentation/asciidoc/computers/config_txt/video.adoc b/documentation/asciidoc/computers/config_txt/video.adoc index 576314218..eac9fba9f 100644 --- a/documentation/asciidoc/computers/config_txt/video.adoc +++ b/documentation/asciidoc/computers/config_txt/video.adoc @@ -2,21 +2,23 @@ === HDMI mode -In order to support dual 4k displays, the Raspberry Pi 4 has updated video hardware, which imposes minor restrictions on the modes supported. +To control HDMI settings, use the xref:configuration.adoc#set-resolution-and-rotation[Screen Configuration utility] or xref:configuration.adoc#set-the-kms-display-mode[KMS video settings] in `cmdline.txt`. -The HDMI settings used to be configured by firmware via settings in `config.txt`; now the settings are configured by KMS via xref:configuration.adoc#hdmi-configuration[settings] in `cmdline.txt`. +==== HDMI Pipeline for 4-series devices -==== HDMI Pipeline for Raspberry Pi 4 and 5 - -In order to support dual displays and modes up to 4k60, the Raspberry Pi 4 and 5 generate 2 output pixels for every clock cycle. +In order to support dual displays and modes up to 4Kp60, Raspberry Pi 4, Compute Module 4, and Pi 400 generate 2 output pixels for every clock cycle. Every HDMI mode has a list of timings that control all the parameters around sync pulse durations. These are typically defined via a pixel clock, and then a number of active pixels, a front porch, sync pulse, and back porch for each of the horizontal and vertical directions. -Running everything at 2 pixels per clock means that the Raspberry Pi 4 and 5 cannot support a timing where _any_ of the horizontal timings are not divisible by 2. The firmware and Linux kernel filter out any mode that does not fulfil this criteria. +Running everything at 2 pixels per clock means that the 4-series devices cannot support a timing where _any_ of the horizontal timings are not divisible by 2. The firmware and Linux kernel filter out any mode that does not fulfil this criteria. There is only one incompatible mode in the CEA and DMT standards: DMT mode 81, 1366x768 @ 60Hz. This mode has odd-numbered values for the horizontal sync and back porch timings and a width that indivisible by 8. -If your monitor has this resolution, Raspberry Pi 4 or 5 automatically drops down to the next mode advertised by the monitor; typically 1280x720. +If your monitor has this resolution, 4-series devices automatically drop down to the next mode advertised by the monitor; typically 1280x720. + +==== HDMI Pipeline for 5-series devices + +Flagship models since Raspberry Pi 5, Compute Module models since CM5, and Keyboard models since Pi 500 also work at 2 output pixels per clock cycle. These models have special handling for odd timings and can handle these modes directly. === Composite video mode @@ -41,11 +43,11 @@ Composite video output can be found on each model of Raspberry Pi computer: | 3.5mm AV jack |=== -NOTE: Composite video output is not available on Raspberry Pi 400. +NOTE: Composite video output is not available on Keyboard models. ==== `enable_tvout` -Set to `1` to enable composite video output and `0` to disable. On Raspberry Pi 4 and 5, composite output is only available if you set this to `1`, which also disables HDMI output. Composite output is not available on the Raspberry Pi 400. +Set to `1` to enable composite video output and `0` to disable. On Flagship models since Raspberry Pi 4, Compute Modules since CM4, and Zero models, composite output is only available if you set this to `1`, which also disables HDMI output. Composite output is not available on Keyboard models. [%header,cols="1,1"] @@ -53,23 +55,25 @@ Set to `1` to enable composite video output and `0` to disable. On Raspberry Pi |Model |Default -|Pi 4, 5 and 400 +|Flagship models since Raspberry Pi 4B, Compute Modules since CM4, Keyboard models |0 |All other models |1 |=== -On all models except Raspberry Pi 4 and 5, 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. +On supported models, you must disable HDMI output to enable composite output. HDMI output is disabled when no HDMI display is detected. Set `enable_tvout=0` to prevent composite being enabled when HDMI is disabled. To enable composite output, 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`]: +[source,ini] ---- dtoverlay=vc4-kms-v3d,composite ---- By default, this outputs composite NTSC video. To choose a different mode, instead append the following to the single line in `/boot/firmware/cmdline.txt`: +[source,ini] ---- vc4.tv_norm= ---- 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 525251144..9f19a2368 100644 --- a/documentation/asciidoc/computers/config_txt/what_is_config_txt.adoc +++ b/documentation/asciidoc/computers/config_txt/what_is_config_txt.adoc @@ -1,25 +1,30 @@ == What is `config.txt`? -NOTE: Prior to _Bookworm_, Raspberry Pi OS stored the boot partition at `/boot/`. Since _Bookworm_, the boot partition is located at `/boot/firmware/`. +Instead of the https://en.wikipedia.org/wiki/BIOS[BIOS] found on a conventional PC, Raspberry Pi devices use a configuration file called `config.txt`. The GPU reads `config.txt` before the Arm CPU and Linux initialise. Raspberry Pi OS looks for this file in the *boot partition*, located at `/boot/firmware/`. -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, create it as a new text file. +NOTE: Prior to Raspberry Pi OS _Bookworm_, Raspberry Pi OS stored the boot partition at `/boot/`. -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: +You can edit `config.txt` directly from your Raspberry Pi OS installation. You can also remove the storage device and edit files in the boot partition, including `config.txt`, from a separate computer. -* `vcgencmd get_config `: displays a specific config value, e.g. `vcgencmd get_config arm_freq` -* `vcgencmd get_config int`: lists all the integer config options that are set (non-zero) -* `vcgencmd get_config str`: lists all the string config options that are set (non-null) +Changes to `config.txt` only take effect after a reboot. You can view the current active settings using the following commands: -NOTE: There are some config settings that cannot be retrieved using `vcgencmd`. +`vcgencmd get_config `:: displays a specific config value, e.g. `vcgencmd get_config arm_freq` +`vcgencmd get_config int`:: lists all non-zero integer config options (non-zero) +`vcgencmd get_config str`:: lists all non-null string config options + +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 has a very simple file format. The format is 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. +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. -There is a 98-character line length limit for entries - any characters past this limit will be ignored. +There is a 98-character line length limit for entries. Raspberry Pi OS ignores any characters past this limit. Here is an example file: +[source,ini] ---- # Enable audio (loads snd_bcm2835) dtparam=audio=on @@ -45,7 +50,7 @@ For example, adding the line `include extraconfig.txt` to `config.txt` will incl [NOTE] ==== -*Include directives are not supported by the bootcode.bin or EEPROM bootloaders*. +The `bootcode.bin` or EEPROM bootloaders do not support the `include` directive. Settings which are handled by the bootloader will only take effect if they are specified in `config.txt` (rather than any additional included file): diff --git a/documentation/asciidoc/computers/configuration.adoc b/documentation/asciidoc/computers/configuration.adoc index da7ce8e29..17ffa15f5 100644 --- a/documentation/asciidoc/computers/configuration.adoc +++ b/documentation/asciidoc/computers/configuration.adoc @@ -1,37 +1,46 @@ include::configuration/raspi-config.adoc[] +include::configuration/display-resolution.adoc[] + +include::configuration/audio-config.adoc[] + include::configuration/configuring-networking.adoc[] +include::configuration/screensaver.adoc[] + +include::configuration/users.adoc[] + +include::configuration/external-storage.adoc[] + +include::configuration/kernel-command-line-config.adoc[] + +include::configuration/localisation.adoc[] + +include::configuration/securing-the-raspberry-pi.adoc[] + include::configuration/headless.adoc[] include::configuration/host-wireless-network.adoc[] include::configuration/use-a-proxy.adoc[] -include::configuration/hdmi-config.adoc[] - -include::configuration/display-resolution.adoc[] +include::configuration/boot_folder.adoc[] -include::configuration/audio-config.adoc[] +include::configuration/led_blink_warnings.adoc[] -include::configuration/external-storage.adoc[] +include::configuration/uart.adoc[] -include::configuration/localisation.adoc[] +include::configuration/device-tree.adoc[] include::configuration/pin-configuration.adoc[] -include::configuration/device-tree.adoc[] -include::configuration/kernel-command-line-config.adoc[] -include::configuration/uart.adoc[] -include::configuration/led_blink_warnings.adoc[] -include::configuration/securing-the-raspberry-pi.adoc[] -include::configuration/screensaver.adoc[] -include::configuration/boot_folder.adoc[] + + diff --git a/documentation/asciidoc/computers/configuration/audio-config.adoc b/documentation/asciidoc/computers/configuration/audio-config.adoc index 6a12bf1d8..e12c032b4 100644 --- a/documentation/asciidoc/computers/configuration/audio-config.adoc +++ b/documentation/asciidoc/computers/configuration/audio-config.adoc @@ -1,37 +1,43 @@ -== Audio configuration +== Audio -The Raspberry Pi has up to three audio output modes: HDMI 1 and 2, and a headphone jack. You can switch between these modes at any time. +Raspberry Pi OS has multiple audio output modes: HDMI 1, the headphone jack (if your device has one), and USB audio. -NOTE: Audio output over HDMI will provide better sound quality than audio output over the headphone jack. +By default, Raspberry Pi OS outputs audio to HDMI 1. If no HDMI output is available, Raspberry Pi OS outputs audio to the headphone jack or a connected USB audio device. -If your HDMI monitor or TV has built-in speakers, the audio can be played over the HDMI cable, but you can switch it to a set of headphones or other speakers plugged into the headphone jack. If your display has integrated speakers, audio output is via HDMI by default. Otherwise, it is played via the headphone jack. If this is not your desired output setup, or if the auto-detection is inaccurate, you can manually switch the output. +=== Change audio output -=== Changing the audio output +Use the following methods to configure audio output in Raspberry Pi OS: -There are two ways of setting the audio output: using the desktop volume control, or using the `raspi-config` command-line tool. - -==== Desktop volume control - -Right-clicking the volume icon on the desktop taskbar brings up the audio output selector, allowing you to choose between the internal audio outputs. It also allows you to select any external audio devices, such as USB sound cards and Bluetooth audio devices. A tick is shown against the currently selected audio output device. Left-click the desired output in the pop-up menu to change this setting. - -===== Pro Audio profile - -You may see a device profile named Pro Audio when viewing an audio device on the system tray. This profile exposes the maximum number of channels across every audio device, allowing you greater control over the routing of signals. Unless you have a specific use-case in mind for this type of control, we recommend using a different device profile. +[[pro-audio-profile]] +[tabs] +====== +Desktop volume control:: ++ +Right-click the volume icon on the system tray to open the **audio output selector**. This interface lets you choose an audio output device. Click an audio output device to switch audio output to that device. ++ +You may see a device profile named **Pro Audio** when viewing an audio device in the audio output selector. This profile exposes the maximum number of channels across every audio device, allowing you greater control over the routing of signals. Unless you require fine-tuned control over audio output, use a different device profile. ++ For more information about the Pro Audio profile, visit https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/FAQ#what-is-the-pro-audio-profile[PipeWire's FAQ]. -==== Using raspi-config - -Open up xref:configuration.adoc#raspi-config[raspi-config] by entering the following into the command line: - +`raspi-config`:: ++ +To change your audio output using xref:configuration.adoc#raspi-config[`raspi-config`], run the following command: ++ +[source,console] ---- -sudo raspi-config +$ sudo raspi-config ---- ++ +You should see a configuration screen. Complete the following steps to change your audio output: ++ +. Select `System options` and press `Enter`. ++ +. Select the `Audio` option and press `Enter`. ++ +. Select your required mode and press `Enter` to select that mode. ++ +. Press the right arrow key to exit the options list. Select `Finish` to exit the configuration tool. +====== -This will open the configuration screen: - -Select `System options` (currently option 1, but yours may be different) and press `Enter`. - -Now select the `Audio` option (currently option S2, but yours may be different) and press `Enter`. -Select your required mode, press `Enter` and press the right arrow key to exit the options list, then select `Finish` to exit the configuration tool. diff --git a/documentation/asciidoc/computers/configuration/boot_folder.adoc b/documentation/asciidoc/computers/configuration/boot_folder.adoc index a686b67a7..472e35b70 100644 --- a/documentation/asciidoc/computers/configuration/boot_folder.adoc +++ b/documentation/asciidoc/computers/configuration/boot_folder.adoc @@ -1,4 +1,4 @@ -== The boot folder +== `boot` folder contents Raspberry Pi OS stores boot files on the first partition of the SD card, formatted with the FAT file system. @@ -18,10 +18,10 @@ The Raspberry Pi 4 and 5 do not use `bootcode.bin`. It has been replaced by boot Binary firmware blobs loaded onto the VideoCore GPU in the SoC, which then take over the boot process. -* `start.elf` is the basic firmware. -* `start_x.elf` includes additional codecs. -* `start_db.elf` can be used for debugging purposes. -* `start_cd.elf` is a cut-down version of the firmware that removes support for hardware blocks such as codecs and 3D; it also imposes initial framebuffer limitations. The cut-down firmware is automatically used when `gpu_mem=16` is specified in `config.txt`. +`start.elf`:: the basic firmware. +`start_x.elf`:: includes additional codecs. +`start_db.elf`:: used for debugging. +`start_cd.elf`:: a cut-down version of the firmware that removes support for hardware blocks such as codecs and 3D as well as debug logging support; it also imposes initial frame buffer limitations. The cut-down firmware is automatically used when `gpu_mem=16` is specified in `config.txt`. `start4.elf`, `start4x.elf`, `start4db.elf` and `start4cd.elf` are equivalent firmware files specific to the Raspberry Pi 4-series (Model 4B, Pi 400, Compute Module 4 and Compute Module 4S). @@ -35,13 +35,13 @@ Linker files found in matched pairs with the `start*.elf` files listed in the pr === `cmdline.txt` -The kernel <> passed into the kernel at boot. +The <> passed into the kernel at boot. === `config.txt` Contains many configuration parameters for setting up the Raspberry Pi. For more information, see the xref:config_txt.adoc[`config.txt` documentation]. -NOTE: Raspberry Pi 5 requires a non-empty `config.txt` file in the boot partition. +IMPORTANT: Raspberry Pi 5 requires a non-empty `config.txt` file in the boot partition. === `issue.txt` @@ -51,13 +51,11 @@ Text-based housekeeping information containing the date and git commit ID of the Contents of the initial ramdisk. This loads a temporary root file system into memory before the real root file system can be mounted. -NOTE: Since Bookworm, Raspberry Pi OS includes an `initramfs` file by default. To enable the initial ramdisk, configure it in xref:config_txt.adoc[`config.txt`] with the xref:config_txt.adoc#auto_initramfs[`auto_initramfs`] keyword. +Since Bookworm, Raspberry Pi OS includes an `initramfs` file by default. To enable the initial ramdisk, configure it in xref:config_txt.adoc[`config.txt`] with the xref:config_txt.adoc#auto_initramfs[`auto_initramfs`] keyword. === `ssh` or `ssh.txt` -When this file is present, enables SSH at boot. SSH is otherwise disabled by default. - -NOTE: The contents do not matter. Even an empty file enables SSH. +When this file is present, enables SSH at boot. SSH is otherwise disabled by default. The contents do not matter. Even an empty file enables SSH. === Device Tree blob files (`*.dtb`) @@ -72,27 +70,27 @@ Various xref:linux_kernel.adoc#kernel[kernel] image files that correspond to Ras | `kernel.img` | BCM2835 -| Pi Zero, Pi 1 +| Pi Zero, Pi 1, CM1 | | `kernel7.img` | BCM2836, BCM2837 -| Pi Zero 2 W, Pi 2, Pi 3 -| Later Pi 2 uses the BCM2837 +| Pi Zero 2 W, Pi 2, Pi 3, CM3, Pi 3+, CM3+ +| Later revisions of Pi 2 use BCM2837 | `kernel7l.img` | BCM2711 -| Pi 4, Pi 400, CM4, CM4-S +| Pi 4, CM4, CM4S, Pi 400 | Large Physical Address Extension (LPAE) | `kernel8.img` | BCM2837, BCM2711, BCM2712 -| Pi Zero 2 W, Pi 2, Pi 3, Pi 4, Pi 400, CM4, CM4-S, Pi 5 -| xref:config_txt.adoc#boot-options[64-bit kernel]. Raspberry Pi 2 with BCM2836 does not support 64-bit kernels. +| Pi Zero 2 W, Pi 2 (later revisions), Pi 3, CM3, Pi 3+, CM3+, Pi 4, CM4, CM4S, Pi 400, CM5, Pi 5, Pi 500, Pi 500+ +| xref:config_txt.adoc#boot-options[64-bit kernel]. Earlier revisions of Raspberry Pi 2 (with BCM2836) do not support 64-bit kernels. | `kernel_2712.img` | BCM2712 -| Pi 5 +| Pi 5, CM5, Pi 500, Pi 500+ | Pi 5-optimized xref:config_txt.adoc#boot-options[64-bit kernel]. |=== diff --git a/documentation/asciidoc/computers/configuration/configuring-networking.adoc b/documentation/asciidoc/computers/configuration/configuring-networking.adoc index b712bbf22..94b702dc1 100644 --- a/documentation/asciidoc/computers/configuration/configuring-networking.adoc +++ b/documentation/asciidoc/computers/configuration/configuring-networking.adoc @@ -1,14 +1,16 @@ -== Configuring networking +== Networking -Raspberry Pi OS provides a graphical user interface (GUI) for setting up wireless connections. Users of Raspberry Pi OS Lite and headless machines can set up wireless networking from the command line with https://developer-old.gnome.org/NetworkManager/stable/nmcli.html[`nmcli`]. +Raspberry Pi OS provides a graphical user interface (GUI) for setting up wireless connections. Users of Raspberry Pi OS Lite and headless machines can set up wireless networking from the command line with https://networkmanager.dev/docs/api/latest/nmcli.html[`nmcli`]. -NOTE: Network Manager is the default networking configuration tool under Raspberry Pi OS _Bookworm_ or later. While Network Manager can be installed on earlier versions of the operating system using `apt` and configured as the default using `raspi-config`, earlier versions used `dhcpd` and other tools for network configuration by default. +NOTE: Starting with Raspberry Pi OS _Bookworm_, Network Manager is the default networking configuration tool. Earlier versions of Raspberry Pi OS used `dhcpd` and other tools for network configuration. -=== Using the desktop +=== Connect to a wireless network + +==== via the desktop Access Network Manager via the network icon at the right-hand end of the menu bar. If you are using a Raspberry Pi with built-in wireless connectivity, or if a wireless dongle is plugged in, click this icon to bring up a list of available wireless networks. If you see the message 'No APs found - scanning...', wait a few seconds, and Network Manager should find your network. -NOTE: Raspberry Pi devices that support dual-band wireless (Raspberry Pi 3B+, Raspberry Pi 4, Compute Module 4, Raspberry Pi 400 and Raspberry Pi 5) automatically disable networking until a you assign a wireless LAN country. To set a wireless LAN country, open the Raspberry Pi Configuration application from the Preferences menu, select *Localisation* and select your country from the menu. +NOTE: Devices with dual-band wireless automatically disable networking until you assign a wireless LAN country. Flagship models since Raspberry Pi 3B+, Compute Modules since CM4, and Keyboard models support dual-band wireless. To set a wireless LAN country, open the Control Centre application from the **Preferences** menu, select *Localisation* and select your country from the menu. image::images/wifi2.png[wifi2] @@ -18,9 +20,9 @@ image::images/key.png[key] Enter the key and click *OK*, then wait a couple of seconds. The network icon will flash briefly to show that a connection is being made. When connected, the icon will stop flashing and show the signal strength. -==== Connect to a hidden network +===== Connect to a hidden network -If you want to use a hidden network, use the *Advanced options* > *Connect to a hidden Wi-Fi network* in the network menu: +To use a hidden network, navigate to *Advanced options* > *Connect to a hidden Wi-Fi network* in the network menu: image::images/network-hidden.png[the connect to a hidden wi-fi network option in advanced options] @@ -31,41 +33,47 @@ image::images/network-hidden-authentication.png[hidden wi-fi network authenticat Click the *Connect* button to initiate the network connection. [[wireless-networking-command-line]] -=== Using the command line +==== via the command line This guide will help you configure a wireless connection on your Raspberry Pi from a terminal without using graphical tools. No additional software is required. NOTE: This guide should work for WEP, WPA, WPA2, or WPA3 networks, but may not work for enterprise networks. -==== Enable wireless networking +===== Enable wireless networking On a fresh install, you must specify the country where you use your device. This allows your device to choose the correct frequency bands for 5GHz networking. Once you have specified a wireless LAN country, you can use your Raspberry Pi's built-in wireless networking module. To do this, set your wireless LAN country with the command line `raspi-config` tool. Run the following command: + +[source,console] ---- -sudo raspi-config +$ sudo raspi-config ---- + Select the *Localisation options* menu item using the arrow keys. Choose the *WLAN country* option. Pick your country from the dropdown using the arrow keys. Press `Enter` to select your country. You should now have access to wireless networking. Run the following command to check if your Wi-Fi radio is enabled: +[source,console] ---- -nmcli radio wifi +$ nmcli radio wifi ---- If this command returns the text "enabled", you're ready to configure a connection. If this command returns "disabled", try enabling Wi-Fi with the following command: +[source,console] ---- -nmcli radio wifi on +$ nmcli radio wifi on ---- -==== Find networks +===== Find networks To scan for wireless networks, run the following command: +[source,console] ---- -nmcli dev wifi list +$ nmcli dev wifi list ---- You should see output similar to the following: @@ -80,30 +88,26 @@ IN-USE BSSID SSID MODE CHAN RATE SIGNAL BARS Look in the "SSID" column for the name of the network you would like to connect to. Use the SSID and a password to connect to the network. -==== Connect to a network +===== Connect to a network -Run the following command to configure a network connection: +Run the following command to configure a network connection, replacing the `` placeholder with the name of the network you're trying to configure: +[source,console] ---- -sudo nmcli --ask dev wifi connect +$ sudo nmcli --ask dev wifi connect ---- -Don't forget to replace `` with the name of the network you're trying to configure. - Enter your network password when prompted. -Your Raspberry Pi should automatically connect to the network once you enter your password. If you see the following output: - ----- -Error: Connection activation failed: Secrets were required, but not provided. ----- +Your Raspberry Pi should automatically connect to the network once you enter your password. -This means that you entered an incorrect password. If you see this error, run the above command again, being careful to enter your password correctly. +If you see error output that claims that "Secrets were required, but not provided", you entered an incorrect password. Run the above command again, carefully entering your password. To check if you're connected to a network, run the following command: +[source,console] ---- -nmcli dev wifi list +$ nmcli dev wifi list ---- You should see output similar to the following: @@ -120,30 +124,33 @@ Check for an asterisk (`*`) in the "IN-USE" column; it should appear in the same NOTE: You can manually edit your connection configurations in the `/etc/NetworkManager/system-connections/` directory. -==== Connect to an unsecured network +===== Connect to an unsecured network If the network you are connecting to does not use a password, run the following command: +[source,console] ---- -sudo nmcli dev wifi connect +$ sudo nmcli dev wifi connect ---- -WARNING: Be careful when using unsecured wireless networks. +WARNING: Unsecured wireless networks can put your personal information at risk. Whenever possible, use a secured wireless network or VPN. -==== Connect to a hidden network +===== Connect to a hidden network If you are using a hidden network, specify the "hidden" option with a value of "yes" when you run `nmcli`: +[source,console] ---- -sudo nmcli --ask dev wifi connect hidden yes +$ sudo nmcli --ask dev wifi connect hidden yes ---- -==== Set priority among multiple networks +===== Set network priority If your device detects more than one known networks at the same time, it could connect any of the detected known networks. Use the priority option to force your Raspberry Pi to prefer certain networks. Your device will connect to the network that is in range with the highest priority. Run the following command to view the priority of known networks: +[source,console] ---- -nmcli --fields autoconnect-priority,name connection +$ nmcli --fields autoconnect-priority,name connection ---- You should see output similar to the following: @@ -160,8 +167,9 @@ AUTOCONNECT-PRIORITY NAME Use the `nmcli connection modify` command to set the priority of a network. The following example command sets the priority of a network named "Pi Towers" to `10`: +[source,console] ---- -nmcli connection modify "Pi Towers" connection.autoconnect-priority 10 +$ nmcli connection modify "Pi Towers" connection.autoconnect-priority 10 ---- Your device will always try to connect to the in-range network with the highest non-negative priority value. You can also assign a network a negative priority; your device will only attempt to connect to a negative priority network if no other known network is in range. For example, consider three networks: @@ -174,10 +182,10 @@ AUTOCONNECT-PRIORITY NAME 1000 dog ---- -- If all of these networks were in range, your device would first attempt to connect to the "dog" network. -- If connection to the "dog" network fails, your device would attempt to connect to the "cat" network. -- If connection to the "cat" network fails, your device would attempt to connect to the "rabbit" network. -- If connection to the "rabbit" network fails, and your device detects no other known networks, your device will attempt to connect to the "snake" network. +* If all of these networks were in range, your device would first attempt to connect to the "dog" network. +* If connection to the "dog" network fails, your device would attempt to connect to the "cat" network. +* If connection to the "cat" network fails, your device would attempt to connect to the "rabbit" network. +* If connection to the "rabbit" network fails, and your device detects no other known networks, your device will attempt to connect to the "snake" network. === Configure DHCP diff --git a/documentation/asciidoc/computers/configuration/device-tree.adoc b/documentation/asciidoc/computers/configuration/device-tree.adoc index adbe61d5a..af8aad80b 100644 --- a/documentation/asciidoc/computers/configuration/device-tree.adoc +++ b/documentation/asciidoc/computers/configuration/device-tree.adoc @@ -1,6 +1,6 @@ == Device Trees, overlays, and parameters -Raspberry Pi kernels and firmware use a Device Tree (DT) to describe the hardware present on the Raspberry Pi. These Device Trees may include DT parameters that provide a degree of control over some onboard features. DT overlays allow optional external hardware to be described and configured, and they also support parameters for more control. +Raspberry Pi kernels and firmware use a Device Tree (DT) to describe hardware. These Device Trees may include DT parameters that to control onboard features. DT overlays allow optional external hardware to be described and configured, and they also support parameters for more control. The firmware loader (`start.elf` and its variants) is responsible for loading the DTB (Device Tree Blob - a machine-readable DT file). It chooses which one to load based on the board revision number, and makes modifications to further tailor it. This runtime customisation avoids the need for many DTBs with only minor differences. @@ -9,7 +9,7 @@ User-provided parameters in `config.txt` are scanned, along with any overlays an [[part1]] === Device Trees -A Device Tree (DT) is a description of the hardware in a system. It should include the name of the base CPU, its memory configuration, and any peripherals (internal and external). A DT should not be used to describe the software, although by listing the hardware modules it does usually cause driver modules to be loaded. +A Device Tree (DT) is a description of the hardware in a system. It should include the name of the base CPU, its memory configuration, and any peripherals (internal and external). A DT should not be used to describe the software, although by listing the hardware modules it does usually cause driver modules to be loaded. NOTE: It helps to remember that DTs are supposed to be OS-neutral, so anything which is Linux-specific shouldn't be there. @@ -22,6 +22,7 @@ Device Trees are usually written in a textual form known as Device Tree Source ( The following is a simple tree in the `.dts` format: +[source,kotlin] ---- /dts-v1/; /include/ "common.dtsi"; @@ -56,42 +57,47 @@ The following is a simple tree in the `.dts` format: This tree contains: * a required header: `/dts-v1/` -* The inclusion of another DTS file, conventionally named `*.dtsi` and analogous to a `.h` header file in C +* The inclusion of another DTS file, conventionally named `*.dtsi` and analogous to a `.h` header file in C * a single root node: `/` * a couple of child nodes: `node1` and `node2` * some children for node1: `child-node1` and `child-node2` * a label (`cousin`) and a reference to that label (`&cousin`) * several properties scattered through the tree -* a repeated node (`/node2`) +* a repeated node (`/node2`) Properties are simple key-value pairs where the value can either be empty or contain an arbitrary byte stream. While data types are not encoded in the data structure, there are a few fundamental data representations that can be expressed in a Device Tree source file. Text strings (NUL-terminated) are indicated with double quotes: +[source,kotlin] ---- string-property = "a string"; ---- Cells are 32-bit unsigned integers delimited by angle brackets: +[source,kotlin] ---- cell-property = <0xbeef 123 0xabcd1234>; ---- Arbitrary byte data is delimited with square brackets, and entered in hex: +[source,kotlin] ---- binary-property = [01 23 45 67 89 ab cd ef]; ---- Data of differing representations can be concatenated using a comma: +[source,kotlin] ---- mixed-property = "a string", [01 23 45 67], <0x12345678>; ---- Commas are also used to create lists of strings: +[source,kotlin] ---- string-list = "red fish", "blue fish"; ---- @@ -103,6 +109,7 @@ The `/include/` directive results in simple textual inclusion, much like C's `#i In the example above, the second appearance of `/node2` causes a new property to be added to the original: +[source,kotlin] ---- /node2 { an-empty-property; @@ -121,30 +128,22 @@ It is therefore possible for one `.dtsi` to overwrite, or provide defaults for, It is often necessary for one part of the tree to refer to another, and there are four ways to do this: -* Path strings -+ -Paths should be self-explanatory, by analogy with a filesystem - `/soc/i2s@7e203000` is the full path to the I2S device in BCM2835 and BCM2836. Note that although it is easy to construct a path to a property (for example, `/soc/i2s@7e203000/status`), the standard APIs don't do that; you first find a node, then choose properties of that node. +Path strings:: Similar to filesystem paths, e.g. `/soc/i2s@7e203000` is the full path to the I2S device in BCM2835 and BCM2836. The standard APIs don't create paths to properties like `/soc/i2s@7e203000/status`: instead, you first find a node, then choose properties of that node. -* Phandles -+ -A phandle is a unique 32-bit integer assigned to a node in its `phandle` property. For historical reasons, you may also see a redundant, matching `linux,phandle`. Phandles are numbered sequentially, starting from 1; 0 is not a valid phandle. They are usually allocated by the DT compiler when it encounters a reference to a node in an integer context, usually in the form of a label. References to nodes using phandles are simply encoded as the corresponding integer (cell) values; there is no markup to indicate that they should be interpreted as phandles, as that is application-defined. +Phandles:: A unique 32-bit integer assigned to a node in its `phandle` property. For historical reasons, you may also see a redundant, matching `linux,phandle`. Phandles are numbered sequentially, starting from 1; 0 is not a valid phandle. They are usually allocated by the DT compiler when it encounters a reference to a node in an integer context, usually in the form of a label. References to nodes using phandles are simply encoded as the corresponding integer (cell) values; there is no markup to indicate that they should be interpreted as phandles, as that is application-defined. -* Labels -+ -Just as a label in C gives a name to a place in the code, a DT label assigns a name to a node in the hierarchy. The compiler takes references to labels and converts them into paths when used in string context (`&node`) and phandles in integer context (`<&node>`); the original labels do not appear in the compiled output. Note that labels contain no structure; they are just tokens in a flat, global namespace. +Labels:: Just as a label in C gives a name to a place in the code, a DT label assigns a name to a node in the hierarchy. The compiler takes references to labels and converts them into paths when used in string context (`&node`) and phandles in integer context (`<&node>`); the original labels do not appear in the compiled output. Note that labels contain no structure; they are just tokens in a flat, global namespace. -* Aliases -+ -Aliases are similar to labels, except that they do appear in the FDT output as a form of index. They are stored as properties of the `/aliases` node, with each property mapping an alias name to a path string. Although the aliases node appears in the source, the path strings usually appear as references to labels (`&node`), rather then being written out in full. DT APIs that resolve a path string to a node typically look at the first character of the path, treating paths that do not start with a slash as aliases that must first be converted to a path using the `/aliases` table. +Aliases:: Similar to labels, except that they do appear in the FDT output as a form of index. They are stored as properties of the `/aliases` node, with each property mapping an alias name to a path string. Although the aliases node appears in the source, the path strings usually appear as references to labels (`&node`), rather then being written out in full. DT APIs that resolve a path string to a node typically look at the first character of the path, treating paths that do not start with a slash as aliases that must first be converted to a path using the `/aliases` table. [[part1.4]] ==== Device Tree semantics How to construct a Device Tree, and how best to use it to capture the configuration of some hardware, is a large and complex subject. There are many resources available, some of which are listed below, but several points deserve highlighting: -`compatible` properties are the link between the hardware description and the driver software. When an OS encounters a node with a `compatible` property, it looks it up in its database of device drivers to find the best match. In Linux, this usually results in the driver module being automatically loaded, provided it has been appropriately labelled and not blacklisted. +* `compatible` properties are the link between the hardware description and the driver software. When an OS encounters a node with a `compatible` property, it looks it up in its database of device drivers to find the best match. In Linux, this usually results in the driver module being automatically loaded, provided it has been appropriately labelled and not blacklisted. -The `status` property indicates whether a device is enabled or disabled. If the `status` is `ok`, `okay` or absent, then the device is enabled. Otherwise, `status` should be `disabled`, so that the device is disabled. It can be useful to place devices in a `.dtsi` file with the status set to `disabled`. A derived configuration can then include that `.dtsi` and set the status for the devices which are needed to `okay`. +* The `status` property indicates whether a device is enabled or disabled. If the `status` is `ok`, `okay` or absent, then the device is enabled. Otherwise, `status` should be `disabled`, so that the device is disabled. It can be useful to place devices in a `.dtsi` file with the status set to `disabled`. A derived configuration can then include that `.dtsi` and set the status for the devices which are needed to `okay`. [[part2]] === Device Tree overlays @@ -155,13 +154,14 @@ When a system like Raspberry Pi also supports optional plug-in accessories such What is needed is a way to describe these optional components using a partial Device Tree, and then to be able to build a complete tree by taking a base DT and adding a number of optional elements. You can do this, and these optional elements are called "overlays". -Unless you want to learn how to write overlays for Raspberry Pis, you might prefer to skip on to <>. +Unless you want to learn how to write overlays for Raspberry Pis, you might prefer to skip on to <>. [[part2.1]] ==== Fragments A DT overlay comprises a number of fragments, each of which targets one node and its subnodes. Although the concept sounds simple enough, the syntax seems rather strange at first: +[source,kotlin] ---- // Enable the i2s interface /dts-v1/; @@ -187,6 +187,7 @@ The `compatible` string identifies this as being for BCM2835, which is the base Each fragment consists of two parts: a `target` property, identifying the node to apply the overlay to; and the `+__overlay__+` itself, the body of which is added to the target node. The example above can be interpreted as if it were written like this: +[source,kotlin] ---- /dts-v1/; /plugin/; @@ -208,8 +209,9 @@ With a sufficiently new version of `dtc` you can write the example exactly as ab The effect of merging that overlay with a standard Raspberry Pi base Device Tree (e.g. `bcm2708-rpi-b-plus.dtb`), provided the overlay is loaded afterwards, would be to enable the I2S interface by changing its status to `okay`. But if you try to compile this overlay using: +[source,console] ---- -dtc -I dts -O dtb -o 2nd.dtbo 2nd-overlay.dts +$ dtc -I dts -O dtb -o 2nd.dtbo 2nd-overlay.dts ---- ...you will get an error: @@ -222,21 +224,29 @@ This shouldn't be too unexpected, since there is no reference to the base `.dtb` Trying again, this time using the original example and adding the `-@` option to allow unresolved references (and `-Hepapr` to remove some clutter): +[source,console] ---- -dtc -@ -Hepapr -I dts -O dtb -o 1st.dtbo 1st-overlay.dts +$ dtc -@ -Hepapr -I dts -O dtb -o 1st.dtbo 1st-overlay.dts ---- If `dtc` returns an error about the third line, it doesn't have the extensions required for overlay work. Run `sudo apt install device-tree-compiler` and try again - this time, compilation should complete successfully. Note that a suitable compiler is also available in the kernel tree as `scripts/dtc/dtc`, built when the `dtbs` make target is used: +[source,console] ---- -make ARCH=arm dtbs +$ make ARCH=arm dtbs ---- Dump the contents of the DTB file to see what the compiler has generated: -[,bash] +[source,console] +---- +$ fdtdump 1st.dtbo +---- + +This should output something similar to the following: + +[source,kotlin] ---- -fdtdump 1st.dtbo /dts-v1/; // magic: 0xd00dfeed // totalsize: 0x207 (519) @@ -300,6 +310,7 @@ Parameters are defined in the DTS by adding an `+__overrides__+` node to the roo String parameters are declared like this: +[source,kotlin] ---- name = <&label>,"property"; ---- @@ -313,6 +324,7 @@ Note that properties called `status` are treated specially; non-zero/true/yes/on Integer parameters are declared like this: +[source,kotlin] ---- name = <&label>,"property.offset"; // 8-bit name = <&label>,"property;offset"; // 16-bit @@ -327,22 +339,23 @@ Here, `label`, `property` and `offset` are replaced by suitable values; the offs Device Tree encodes boolean values as zero-length properties; if present then the property is true, otherwise it is false. They are defined like this: +[source,kotlin] ---- boolean_property; // Set 'boolean_property' to true ---- -A property is assigned the value `false` by not defining it. Boolean parameters are declared like this: +A property is assigned the value `false` by not defining it. Boolean parameters are declared like this, replacing the `label` and `property` placeholders with suitable values: +[source,kotlin] ---- name = <&label>,"property?"; ---- -...where `label` and `property` are replaced by suitable values. - Inverted booleans invert the input value before applying it in the same way as a regular boolean; they are declared similarly, but use `!` to indicate the inversion: +[source,kotlin] ---- -name = <&label>,"property!"; +name = <&label>,"!"; ---- Boolean parameters can cause properties to be created or deleted, but they can't delete a property that already exists in the base DTB. @@ -352,6 +365,7 @@ Boolean parameters can cause properties to be created or deleted, but they can't Byte string properties are arbitrary sequences of bytes, e.g. MAC addresses. They accept strings of hexadecimal bytes, with or without colons between the bytes. +[source,kotlin] ---- mac_address = <ðernet0>,"local_mac_address["; ---- @@ -367,12 +381,13 @@ local_mac_address = [aa bb cc dd ee ff]; There are some situations where it is convenient to be able to set the same value in multiple locations within the Device Tree. Rather than the ungainly approach of creating multiple parameters, it is possible to add multiple targets to a single parameter by concatenating them, like this: +[source,kotlin] ---- - __overrides__ { - gpiopin = <&w1>,"gpios:4", - <&w1_pins>,"brcm,pins:0"; - ... - }; +__overrides__ { + gpiopin = <&w1>,"gpios:4", + <&w1_pins>,"brcm,pins:0"; + ... +}; ---- (example taken from the `w1-gpio` overlay) @@ -386,15 +401,17 @@ The DT parameter mechanism allows multiple targets to be patched from the same p Assignments appear at the end of a declaration, and are indicated by a `=`: +[source,kotlin] ---- str_val = <&target>,"strprop=value"; // 1 -int_val = <&target>,"intprop:0=42 // 2 +int_val = <&target>,"intprop:0=42" // 2 int_val2 = <&target>,"intprop:0=",<42>; // 3 bytes = <&target>,"bytestr[=b8:27:eb:01:23:45"; // 4 ---- Lines 1, 2 and 4 are fairly obvious, but line 3 is more interesting because the value appears as an integer (cell) value. The DT compiler evaluates integer expressions at compile time, which might be convenient (particularly if macro values are used), but the cell can also contain a reference to a label: +[source,kotlin] ---- // Force an LED to use a GPIO on the internal GPIO controller. exp_led = <&led1>,"gpios:0=",<&gpio>, @@ -410,6 +427,7 @@ Bear in mind that parameters do nothing unless they are applied - a default valu Lookup tables allow parameter input values to be transformed before they are used. They act as associative arrays, rather like switch/case statements: +[source,kotlin] ---- phonetic = <&node>,"letter{a=alpha,b=bravo,c=charlie,d,e,='tango uniform'}"; bus = <&fragment>,"target:0{0=",<&i2c0>,"1=",<&i2c1>,"}"; @@ -428,6 +446,7 @@ The DT parameter mechanism as described has a number of limitations, including t A fragment can be excluded from the final merge process (disabled) by renaming the `+__overlay__+` node to `+__dormant__+`. The parameter declaration syntax has been extended to allow the otherwise illegal zero target phandle to indicate that the following string contains operations at fragment or overlay scope. So far, four operations have been implemented: +[source,kotlin] ---- + // Enable fragment - // Disable fragment @@ -437,6 +456,7 @@ A fragment can be excluded from the final merge process (disabled) by renaming t Examples: +[source,kotlin] ---- just_one = <0>,"+1-2"; // Enable 1, disable 2 conditional = <0>,"=3!4"; // Enable 3, disable 4 if value is true, @@ -454,11 +474,12 @@ Assigning to the `bootargs` property appends to it rather than overwriting it - The `reg` property is used to specify device addresses - the location of a memory-mapped hardware block, the address on an I2C bus, etc. The names of child nodes should be qualified with their addresses in hexadecimal, using `@` as a separator: +[source,kotlin] ---- - bmp280@76 { - reg = <0x77>; - ... - }; +bmp280@76 { + reg = <0x77>; + ... +}; ---- When assigning to the `reg` property, the address portion of the parent node name will be replaced with the assigned value. This can be used to prevent a node name clash when using the same overlay multiple times - a technique used by the `i2c-gpio` overlay. @@ -476,33 +497,38 @@ The overlay map is a file that gets loaded by the firmware at bootup. It is writ This is an extract from the current map file (see the https://github.com/raspberrypi/linux/blob/rpi-6.6.y/arch/arm/boot/dts/overlays/overlay_map.dts[full version]): +[source,kotlin] ---- / { - disable-bt { - bcm2835; - bcm2711; - bcm2712 = "disable-bt-pi5"; - }; - - disable-bt-pi5 { - bcm2712; - }; - - uart5 { - bcm2711; - }; - - pi3-disable-bt { - renamed = "disable-bt"; - }; - - lirc-rpi { - deprecated = "use gpio-ir"; - }; + disable-bt { + bcm2835; + bcm2711; + bcm2712 = "disable-bt-pi5"; + }; + + disable-bt-pi5 { + bcm2712; + }; + + uart5 { + bcm2711; + }; + + pi3-disable-bt { + renamed = "disable-bt"; + }; + + lirc-rpi { + deprecated = "use gpio-ir"; + }; }; ---- -Each node has the name of an overlay that requires special handling. The properties of each node are either platform names or one of a small number of special directives. The current supported platforms are `bcm2835`, which includes all Raspberry Pis built around the BCM2835, BCM2836 and BCM2837 SoCs, `bcm2711` for Raspberry Pi 4B, 400 and CM4, and `bcm2712` for Raspberry Pi 5 and CM5. +Each node has the name of an overlay that requires special handling. The properties of each node are either platform names or one of a small number of special directives. The overlay map supports the following platform names: + +* `bcm2835` for all Raspberry Pis built around the BCM2835, BCM2836, BCM2837, and RP3A0 SoCs +* `bcm2711` for Raspberry Pi 4B, CM4, CM4S, and Pi 400 +* `bcm2712` for Raspberry Pi 5, CM5, Pi 500, and Pi 500+ A platform name with no value (an empty property) indicates that the current overlay is compatible with the platform; for example, `uart5` is compatible with the `bcm2711` platform. A non-empty value for a platform is the name of an alternative overlay to use in place of the requested one; asking for `disable-bt` on BCM2712 results in `disable-bt-pi5` being loaded instead. Any platform not included in an overlay's node is not compatible with that overlay. Any overlay not mentioned in the map is assumed to be compatible with all platforms. @@ -533,6 +559,7 @@ They both send errors, warnings and any debug output to STDERR. Here are some examples of different types of properties, with parameters to modify them: +[source,kotlin] ---- / { fragment@0 { @@ -597,12 +624,13 @@ Here are some examples of different types of properties, with parameters to modi For further examples, a large collection of overlay source files is hosted in the https://github.com/raspberrypi/linux/tree/rpi-6.1.y/arch/arm/boot/dts/overlays[Raspberry Pi Linux GitHub repository]. [[part2.3]] -==== Exporting labels +==== Export labels The overlay handling in the firmware, and the run-time overlay application using the `dtoverlay` utility, treat labels defined in an overlay as being private to that overlay. This avoids the need to invent globally unique names for labels (which keeps them short), and it allows the same overlay to be used multiple times without clashing (provided some tricks are used - see <>). Sometimes it is very useful to be able to create a label with one overlay and use it from another. Firmware released since 14th February 2020 has the ability to declare some labels as being global - the `+__exports__+` node: +[source,kotlin] ---- ... public: ... @@ -629,7 +657,7 @@ This split is particularly important for runtime overlays, since the first step === Using Device Trees on Raspberry Pi [[part3.1]] -==== DTBs, overlays and config.txt +==== DTBs, overlays and `config.txt` On a Raspberry Pi it is the job of the loader (one of the `start.elf` images) to combine overlays with an appropriate base device tree, and then to pass a fully resolved Device Tree to the kernel. The base Device Trees are located alongside `start.elf` in the FAT partition (`/boot/firmware/` from Linux), named `bcm2711-rpi-4-b.dtb`, `bcm2710-rpi-3-b-plus.dtb`, etc. Note that some models (3A+, A, A+) will use the "b" equivalents (3B+, B, B+), respectively. This selection is automatic, and allows the same SD card image to be used in a variety of devices. @@ -639,6 +667,7 @@ The loader now supports builds using bcm2835_defconfig, which selects the upstre In order to manage Device Tree and overlays, the loader supports a number of `config.txt` directives: +[source,ini] ---- dtoverlay=acme-board dtparam=foo=bar,level=42 @@ -662,6 +691,7 @@ The flipside is that because platform devices don't get created unless requested As described above, DT parameters are a convenient way to make small changes to a device's configuration. The current base DTBs support parameters for enabling and controlling the onboard audio, I2C, I2S and SPI interfaces without using dedicated overlays. In use, parameters look like this: +[source,ini] ---- dtparam=audio=on,i2c_arm=on,i2c_arm_baudrate=400000,spi=on ---- @@ -670,6 +700,7 @@ NOTE: Multiple assignments can be placed on the same line, but ensure you don't If you have an overlay that defines some parameters, they can be specified either on subsequent lines like this: +[source,ini] ---- dtoverlay=lirc-rpi dtparam=gpio_out_pin=16 @@ -679,12 +710,14 @@ dtparam=gpio_in_pull=down ...or appended to the overlay line like this: +[source,ini] ---- dtoverlay=lirc-rpi,gpio_out_pin=16,gpio_in_pin=17,gpio_in_pull=down ---- Overlay parameters are only in scope until the next overlay is loaded. In the event of a parameter with the same name being exported by both the overlay and the base, the parameter in the overlay takes precedence; it's recommended that you avoid doing this. To expose the parameter exported by the base DTB instead, end the current overlay scope using: +[source,ini] ---- dtoverlay= ---- @@ -692,7 +725,7 @@ dtoverlay= [[part3.3]] ==== Board-specific labels and parameters -Raspberry Pi boards have two I2C interfaces. These are nominally split: one for the ARM, and one for VideoCore (the GPU). On almost all models, `i2c1` belongs to the ARM and `i2c0` to VC, where it is used to control the camera and read the HAT EEPROM. However, there are two early revisions of the Model B that have those roles reversed. +Raspberry Pi boards have two I2C interfaces. These are nominally split: one for the Arm CPU, and one for the VideoCore GPU. On almost all models, `i2c1` belongs to the CPU and `i2c0` to the GPU, where it is used to control the camera and read the HAT EEPROM. However, there are two early revisions of the Model B that have those roles reversed. To make it possible to use one set of overlays and parameters with all Raspberry Pis, the firmware creates some board-specific DT parameters. These are: @@ -707,6 +740,7 @@ These are aliases for `i2c0`, `i2c1`, `i2c0_baudrate`, and `i2c1_baudrate`. It i For people writing overlays, the same aliasing has been applied to the labels on the I2C DT nodes. Thus, you should write: +[source,kotlin] ---- fragment@0 { target = <&i2c_arm>; @@ -794,64 +828,59 @@ The loading of overlays at runtime is a recent addition to the kernel, and at th [[part3.6]] ==== Supported overlays and parameters -Please refer to the https://github.com/raspberrypi/firmware/blob/master/boot/firmware/overlays/README[README] file found alongside the overlay `.dtbo` files in `/boot/firmware/overlays`. It is kept up-to-date with additions and changes. +For a list of supported overlays and parameters, see the https://github.com/raspberrypi/firmware/blob/master/boot/overlays/README[README] file found alongside the overlay `.dtbo` files in `/boot/firmware/overlays`. It is kept up-to-date with additions and changes. [[part4]] === Firmware parameters -The firmware uses the special https://www.kernel.org/doc/html/latest/devicetree/usage-model.html#runtime-configuration[/chosen] node to pass parameters between the bootloader and/or firmware and the operating system. -`overlay_prefix` - string - -The xref:config_txt.adoc#overlay_prefix[overlay_prefix] string selected by `config.txt`. +The firmware uses the special https://www.kernel.org/doc/html/latest/devicetree/usage-model.html#runtime-configuration[/chosen] node to pass parameters between the bootloader and/or firmware and the operating system. -`os_prefix` - string +* Each property is stored as a 32-bit unsigned integer unless indicated otherwise. +* Numbers in device-tree are stored in binary and are big-endian. -The xref:config_txt.adoc#os_prefix[os_prefix] string selected by `config.txt`. +Example shell command for reading a 32-bit unsigned integer property: +[source,console] +---- +printf "%d" "0x$(od "/proc/device-tree/chosen/bootloader/partition" -v -An -t x1 | tr -d ' ' )" +---- -`rpi-boardrev-ext` - 32-bit integer +`overlay_prefix`:: _(string)_ The xref:config_txt.adoc#overlay_prefix[overlay_prefix] string selected by `config.txt`. -The extended board revision code from xref:raspberry-pi.adoc#otp-register-and-bit-definitions[OTP row 33]. +`os_prefix`:: _(string)_ The xref:config_txt.adoc#os_prefix[os_prefix] string selected by `config.txt`. -`rpi-country-code` - 32-bit integer +`rpi-boardrev-ext`:: The extended board revision code from xref:raspberry-pi.adoc#otp-register-and-bit-definitions[OTP row 33]. -The country code used used by https://github.com/raspberrypi-ui/piwiz[PiWiz] - Pi400 only. +`rpi-country-code`:: The country code used used by https://github.com/raspberrypi-ui/piwiz[PiWiz]. Keyboard models only. -`rpi-duid` - string +`rpi-duid`:: _(string)_ Raspberry Pi 5 only. A string representation of the QR code on the PCB. -Raspberry Pi 5 only. A string representation of the QR code on the PCB. +`rpi-serial64`:: _(string)_ A string representation of the 64-bit serial number. On flagship models since Raspberry Pi 5 this is same as the normal serial number (`/proc/device-tree/serial-number`). On earlier models the default serial number is still 32-bit but with newer firmware a 64-bit serial number is now available and is visible through this node. ==== Common bootloader properties `/chosen/bootloader` -`boot-mode` - 32-bit integer -The boot-mode used to load the kernel. See xref:raspberry-pi.adoc#BOOT_ORDER[BOOT_ORDER]. +`boot-mode`:: The boot-mode used to load the kernel. See the xref:raspberry-pi.adoc#BOOT_ORDER[BOOT_ORDER] documentation for a list of possible boot-mode values. -`partition` - 32-bit integer +`partition`:: The partition number used during boot. If a `boot.img` ramdisk is loaded then this refers to partition that the ramdisk was loaded from rather than the partition number within the ramdisk. -The partition number used during boot. If a `boot.img` ramdisk is loaded then this refers to partition that the ramdisk was loaded from rather than the partition number within the ramdisk. +`pm_rsts`:: The value of the `PM_RSTS` register during boot. -`pm_rsts` - 32-bit integer +`tryboot`:: Set to `1` if the `tryboot` flag was set at boot. -The value of the `PM_RSTS` register during boot. - -`tryboot` - 32-bit integer - -Set to `1` if the `tryboot` flag was set at boot. - -==== Power supply properties `/chosen/power` +==== Boot variables `/chosen/bootloader` Raspberry Pi 5 only. -*`max_current` - 32-bit integer - -The maximum current in mA that the power supply can supply. The firmware reports the value indicated by the USB-C, USB-PD or PoE interfaces. +`arg1`:: The value of the user defined reboot argument from the previous boot. See xref:config_txt.adoc#boot_arg1[boot_arg1] -For bench power supplies (e.g. connected to the GPIO header) define `PSU_MAX_CURRENT` in the bootloader configuration to indicate the power supply current capability. +`count`:: The value of the 8-bit `boot_count` variable when the OS was started. See xref:config_txt.adoc#boot_count[boot_count] -*`power_reset` - 32-bit integer +==== Power supply properties `/chosen/power` Raspberry Pi 5 only. -A bit field indicating the reason why the PMIC was reset. +`max_current`:: The maximum current in mA that the power supply can supply. The firmware reports the value indicated by the USB-C, USB-PD or PoE interfaces. For bench power supplies (e.g. connected to the GPIO header) define `PSU_MAX_CURRENT` in the bootloader configuration to indicate the power supply current capability. + +`power_reset`:: Raspberry Pi 5 only. A bit field indicating the reason why the PMIC was reset. |=== | Bit | Reason @@ -872,23 +901,13 @@ A bit field indicating the reason why the PMIC was reset. | Watchdog |=== -`rpi_power_supply` - 2 32-bit integers - -The USB VID and Product VDO of the official Raspberry Pi 27W power supply (if connected). - -`usb_max_current_enable` - 32-bit integer +`rpi_power_supply`:: _(two 32-bit integers)_ The USB VID and Product VDO of the official Raspberry Pi 27W power supply (if connected). -Zero if the USB port current limiter was set to the low-limit during boot; or non-zero if the high limit was enabled. -The high level is automatically enabled if the power supply claims 5A max-current OR `usb_max_current_enable=1` is forced in `config.txt` +`usb_max_current_enable`:: Zero if the USB port current limiter was set to the low-limit during boot; or non-zero if the high limit was enabled. The high level is automatically enabled if the power supply claims 5A max-current OR `usb_max_current_enable=1` is forced in `config.txt` -`usb_over_current_detected` - 32-bit integer +`usb_over_current_detected`:: Non-zero if a USB over-current event occurred during USB boot. -Non-zero if a USB over-current event occurred during USB boot. - -`usbpd_power_data_objects` - binary blob (multiple 32-bit integers) - -The raw binary USB-PD objects (fixed supply only) received by the bootloader during USB-PD negotiation. -To capture this for a bug report run `hexdump -C /proc/device-tree/chosen/power/usbpd_power_data_objects`. +`usbpd_power_data_objects`:: _(binary blob containing multiple 32-bit integers)_ The raw binary USB-PD objects (fixed supply only) received by the bootloader during USB-PD negotiation. To capture this for a bug report, run `hexdump -C /proc/device-tree/chosen/power/usbpd_power_data_objects`. The format is defined by the https://usb.org/document-library/usb-power-delivery[USB Power Delivery] specification. @@ -896,13 +915,9 @@ The format is defined by the https://usb.org/document-library/usb-power-delivery The following properties are specific to the BCM2711 and BCM2712 SPI EEPROM bootloaders. -`build_timestamp` - 32-bit integer - -The UTC build time for the EEPROM bootloader. - -`capabilities` - 32-bit integer +`build_timestamp`:: The UTC build time for the EEPROM bootloader. -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. +`capabilities`:: 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. |=== | Bit | Feature @@ -923,7 +938,7 @@ This bit-field describes the features supported by the current bootloader. This | xref:raspberry-pi.adoc#usb-mass-storage-boot[USB boot] using the BCM2711 USB host controller | 5 -| xref:raspberry-pi.adoc#boot_ramdisk[RAM disk - boot.img] +| xref:config_txt.adoc#boot_ramdisk[RAM disk - boot.img] | 6 | xref:raspberry-pi.adoc#nvme-ssd-boot[NVMe boot] @@ -932,13 +947,9 @@ This bit-field describes the features supported by the current bootloader. This | https://github.com/raspberrypi/usbboot/blob/master/Readme.md#secure-boot[Secure Boot] |=== -`update_timestamp` - 32-bit integer +`update_timestamp`:: The UTC update timestamp set by `rpi-eeprom-update`. -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. +`signed`:: If Secure Boot is enabled, this bit-field will be non-zero. The individual bits indicate the current Secure Boot configuration. |=== | Bit | Description @@ -950,45 +961,38 @@ If Secure Boot is enabled then this bit-field will be non-zero. The individual b | Reserved | 2 -| The ROM development key has been revoked. See xref:raspberry-pi.adoc#revoke_devkey[revoke_devkey]. +| The ROM development key has been revoked. See xref:config_txt.adoc#revoke_devkey[revoke_devkey]. | 3 -| The customer public key digest has been written to OTP. See xref:raspberry-pi.adoc#program_pubkey[program_pubkey]. +| The customer public key digest has been written to OTP. See xref:config_txt.adoc#program_pubkey[program_pubkey]. | 4...31 | Reserved |=== -`version` - string - -The Git version string for the bootloader. +`version`:: _(string)_ The Git version string for the bootloader. ==== BCM2711 and BCM2712 USB boot properties `/chosen/bootloader/usb` The following properties are defined if the system was booted from USB. These may be used to uniquely identify the USB boot device. -`usb-version` - 32-bit integer +`usb-version`:: The USB major protocol version (2 or 3). -The USB major protocol version (2 or 3). +`route-string`:: The USB route-string identifier for the device as defined by the USB 3.0 specification. -`route-string` - 32-bit integer -The USB route-string identifier for the device as defined by the USB 3.0 specification. +`root-hub-port-number`:: The root hub port number that the boot device is connected to - possibly via other USB hubs. -`root-hub-port-number` - 32-bit integer - -The root hub port number that the boot device is connected to - possibly via other USB hubs. - -`lun` - 32-bit integer - -The Logical Unit Number for the mass-storage device. +`lun`:: The Logical Unit Number for the mass-storage device. ==== NVMEM nodes + The firmware provides read-only, in-memory copies of portions of the bootloader EEPROM via the https://www.kernel.org/doc/html/latest/driver-api/nvmem.html[NVMEM] subsystem. Each region appears as an NVMEM device under `/sys/bus/nvmem/devices/` with a named alias under `/sys/firmware/devicetree/base/aliases`. Example shell script code for reading an NVMEM mode from https://github.com/raspberrypi/rpi-eeprom/blob/master/rpi-eeprom-update[rpi-eeprom-update]: +[source,shell] ---- blconfig_alias="/sys/firmware/devicetree/base/aliases/blconfig" blconfig_nvmem_path="" @@ -1003,16 +1007,12 @@ if [ -f "${blconfig_alias}" ]; then fi ---- -`blconfig` - -The `blconfig` alias refers to an NVMEM device that stores a copy of the bootloader EEPROM config file. - -`blpubkey` +`blconfig`:: alias that refers to an NVMEM device that stores a copy of the bootloader EEPROM config file. -The `blpubkey` alias points to an NVMEM device that stores a copy of the bootloader EEPROM public key (if defined) in binary format. +`blpubkey`:: alias that points to an NVMEM device that stores a copy of the bootloader EEPROM public key (if defined) in binary format. The https://github.com/raspberrypi/usbboot/blob/master/tools/rpi-bootloader-key-convert[rpi-bootloader-key-convert] utility can be used to convert the data into PEM format for use with OpenSSL. -See also: https://github.com/raspberrypi/usbboot#secure-boot[secure-boot] +For more information, see https://github.com/raspberrypi/usbboot#secure-boot[secure-boot]. [[part5]] === Troubleshooting @@ -1022,16 +1022,18 @@ See also: https://github.com/raspberrypi/usbboot#secure-boot[secure-boot] The loader will skip over missing overlays and bad parameters, but if there are serious errors, such as a missing or corrupt base DTB or a failed overlay merge, then the loader will fall back to a non-DT boot. If this happens, or if your settings don't behave as you expect, it is worth checking for warnings or errors from the loader: +[source,console] ---- -sudo vclog --msg +$ sudo vclog --msg ---- Extra debugging can be enabled by adding `dtdebug=1` to `config.txt`. You can create a human-readable representation of the current state of DT like this: +[source,console] ---- -dtc -I fs /proc/device-tree +$ dtc -I fs /proc/device-tree ---- This can be useful to see the effect of merging overlays onto the underlying tree. @@ -1051,35 +1053,39 @@ MODULE_DEVICE_TABLE(of, xxx_of_match); Failing that, `depmod` has failed or the updated modules haven't been installed on the target filesystem. [[part5.2]] -==== Testing overlays using dtmerge, dtdiff and ovmerge +==== Test overlays using `dtmerge`, `dtdiff` and `ovmerge` Alongside the `dtoverlay` and `dtparam` commands is a utility for applying an overlay to a DTB - `dtmerge`. To use it you first need to obtain your base DTB, which can be obtained in one of two ways: Generate it from the live DT state in `/proc/device-tree`: +[source,console] ---- -dtc -I fs -O dtb -o base.dtb /proc/device-tree +$ dtc -I fs -O dtb -o base.dtb /proc/device-tree ---- This will include any overlays and parameters you have applied so far, either in `config.txt` or by loading them at runtime, which may or may not be what you want. Alternatively: Copy it from the source DTBs in `/boot/firmware/`. This won't include overlays and parameters, but it also won't include any other modifications by the firmware. To allow testing of all overlays, the `dtmerge` utility will create some of the board-specific aliases ("i2c_arm", etc.), but this means that the result of a merge will include more differences from the original DTB than you might expect. The solution to this is to use dtmerge to make the copy: +[source,console] ---- -dtmerge /boot/firmware/bcm2710-rpi-3-b.dtb base.dtb - +$ dtmerge /boot/firmware/bcm2710-rpi-3-b.dtb base.dtb - ---- (the `-` indicates an absent overlay name). You can now try applying an overlay or parameter: +[source,console] ---- -dtmerge base.dtb merged.dtb - sd_overclock=62 -dtdiff base.dtb merged.dtb +$ dtmerge base.dtb merged.dtb - sd_overclock=62 +$ dtdiff base.dtb merged.dtb ---- which will return: +[source,diff] ---- --- /dev/fd/63 2016-05-16 14:48:26.396024813 +0100 +++ /dev/fd/62 2016-05-16 14:48:26.396024813 +0100 @@ -1096,14 +1102,16 @@ which will return: You can also compare different overlays or parameters. +[source,console] ---- -dtmerge base.dtb merged1.dtb /boot/firmware/overlays/spi1-1cs.dtbo -dtmerge base.dtb merged2.dtb /boot/firmware/overlays/spi1-2cs.dtbo -dtdiff merged1.dtb merged2.dtb +$ dtmerge base.dtb merged1.dtb /boot/firmware/overlays/spi1-1cs.dtbo +$ dtmerge base.dtb merged2.dtb /boot/firmware/overlays/spi1-2cs.dtbo +$ dtdiff merged1.dtb merged2.dtb ---- to get: +[source,diff] ---- --- /dev/fd/63 2016-05-16 14:18:56.189634286 +0100 +++ /dev/fd/62 2016-05-16 14:18:56.189634286 +0100 @@ -1147,19 +1155,21 @@ to get: The https://github.com/raspberrypi/utils[Utils] repo includes another DT utility - `ovmerge`. Unlike `dtmerge`, `ovmerge` combines file and applies overlays in source form. Because the overlay is never compiled, labels are preserved and the result is usually more readable. It also has a number of other tricks, such as the ability to list the order of file inclusion. [[part5.3]] -==== Forcing a specific Device Tree +==== Force a specific Device Tree If you have very specific needs that aren't supported by the default DTBs, or if you just want to experiment with writing your own DTs, you can tell the loader to load an alternate DTB file like this: +[source,ini] ---- device_tree=my-pi.dtb ---- [[part5.4]] -==== Disabling Device Tree usage +==== Disable Device Tree usage Device Tree usage is required in Raspberry Pi Linux kernels. For bare metal and other OSs, DT usage can be disabled by adding: +[source,ini] ---- device_tree= ---- @@ -1171,6 +1181,7 @@ to `config.txt`. The loader understands a few shortcuts: +[source,ini] ---- dtparam=i2c_arm=on dtparam=i2s=on @@ -1178,6 +1189,7 @@ dtparam=i2s=on can be shortened to: +[source,ini] ---- dtparam=i2c,i2s ---- @@ -1185,22 +1197,17 @@ dtparam=i2c,i2s (`i2c` is an alias of `i2c_arm`, and the `=on` is assumed). It also still accepts the long-form versions: `device_tree_overlay` and `device_tree_param`. [[part5.6]] -==== Other DT commands available in config.txt +==== Other DT commands available in `config.txt` -`device_tree_address` -This is used to override the address where the firmware loads the device tree (not dt-blob). By default the firmware will choose a suitable place. +`device_tree_address`:: This is used to override the address where the firmware loads the device tree (not dt-blob). By default the firmware will choose a suitable place. -`device_tree_end` -This sets an (exclusive) limit to the loaded device tree. By default the device tree can grow to the end of usable memory, which is almost certainly what is required. +`device_tree_end`:: This sets an (exclusive) limit to the loaded device tree. By default the device tree can grow to the end of usable memory, which is almost certainly what is required. -`dtdebug` -If non-zero, turn on some extra logging for the firmware's device tree processing. +`dtdebug`:: If non-zero, turn on some extra logging for the firmware's device tree processing. -`enable_uart` -Enable the primary/console xref:configuration.adoc#configuring-uarts[UART] (ttyS0 on a Raspberry Pi 3, 4, 400, Zero W and Zero 2 W, ttyAMA0 otherwise - unless swapped with an overlay such as miniuart-bt). If the primary UART is ttyAMA0 then `enable_uart` defaults to 1 (enabled), otherwise it defaults to 0 (disabled). This is because it is necessary to stop the core frequency from changing which would make ttyS0 unusable, so `enable_uart=1` implies `core_freq=250` (unless `force_turbo=1`). In some cases this is a performance hit, so it is off by default. +`enable_uart`:: Enable the xref:configuration.adoc#primary-and-secondary-uart[primary/console UART]. If the primary UART is `ttyAMA0`, `enable_uart` defaults to 1 (enabled), otherwise it defaults to 0 (disabled). This stops the core frequency from changing, which would make `ttyS0` unusable. As a result, `enable_uart=1` implies `core_freq=250` (unless `force_turbo=1`). In some cases this is a performance hit, so it is off by default. -`overlay_prefix` -Specifies a subdirectory/prefix from which to load overlays - defaults to "overlays/". Note the trailing "/". If desired you can add something after the final "/" to add a prefix to each file, although this is not likely to be needed. +`overlay_prefix`:: Specifies a subdirectory/prefix from which to load overlays - defaults to "overlays/". Note the trailing "/". If desired you can add something after the final "/" to add a prefix to each file, although this is not likely to be needed. Further ports can be controlled by the DT. For more details see <>. diff --git a/documentation/asciidoc/computers/configuration/display-resolution.adoc b/documentation/asciidoc/computers/configuration/display-resolution.adoc index 7394a8bf7..0a294f5b2 100644 --- a/documentation/asciidoc/computers/configuration/display-resolution.adoc +++ b/documentation/asciidoc/computers/configuration/display-resolution.adoc @@ -1,49 +1,86 @@ -== Setting your display's resolution and rotation +== Displays -If you find yourself in a situation where the Raspberry Pi may not be able to determine the best mode, or you specifically wish to set a non-default resolution, you can set the resolution or rotation manually. The method for doing this depends on whether you're booting to the desktop environment or booting to the CLI (text console). +To configure your Raspberry Pi to use a non-default display mode, set the resolution or rotation manually. -=== Setting the desktop environment resolution and rotation +=== Support for HDMI monitors -If you are using the Raspberry Pi desktop, the resolution or rotation is most easily changed by selecting the `Screen Configuration` utility from the desktop `Preferences` menu. This will bring up a graphical representation of the display or displays connected to the Raspberry Pi. Right click on the display you wish to modify, and select the required option(s) before clicking `Apply`. +With most HDMI monitors, Raspberry Pi OS uses the highest resolution and refresh rate supported by the monitor. -NOTE: If you are using the X11 backend, you need to ensure that you close the Screen Configuration utility in order to save the changes you've made. If you don't do this, the changes you made will be forgotten when you reboot. +The Raspberry Pi Zero, Zero W and Zero 2 W have a mini HDMI port, so you need a mini-HDMI-to-full-size-HDMI lead or adapter. -It is also possible to change these settings by editing config files, although the method for doing this depends on whether you're running the Wayland or X11 backend. Open a Terminal window and type: +Flagship models since Raspberry Pi 4B and Keyboard models have two micro HDMI ports, so you need a micro-HDMI-to-full-size-HDMI lead or adapter for each display you wish to attach. Connect the cables before turning on the Raspberry Pi. -[,bash] +Flagship models since Raspberry Pi 4B, Compute Modules since CM4 (except for CM4S), and Keyboard models can drive up to two displays. + +4-series devices support resolutions up to 1080p at a 60Hz refresh rate, or two 4K displays at a 30Hz refresh rate. You can also drive a single display at 4K with a 60Hz refresh rate if you connect the display to the `HDMI0` port and set the `hdmi_enable_4kp60=1` flag in xref:../computers/config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]. + +5-series devices support up to two displays at 4K resolution at a 60hz refresh rate with no additional configuration. + +=== Set resolution and rotation + +On the Raspberry Pi Desktop, open the *Preferences* menu and select the **Screen Configuration** utility. You should see a graphical representation of the displays connected to the Raspberry Pi. Right click on the display you wish to modify, and select an option. Click **Apply** to and close **Screen Configuration** to save your changes. + +Alternatively, use the following command to open the **Screen Configuration** utility: + +[source,console] +---- +$ raindrop +---- + +[TIP] +==== +If your installation of Raspberry Pi OS doesn't already include `raindrop`, you can install it with the following command: + +[source,console] +---- +$ sudo apt install raindrop +---- + +Older versions of Raspberry Pi OS used a different screen configuration utility named `arandr`. To uninstall `arandr`, run the following command: + +[source,console] ---- -ps ax | grep [w]ayfire +$ sudo apt purge arandr ---- +==== -If you see `/usr/bin/wayfire` displayed then you're running Wayland; and if you get no output you're running X11. +=== Manually set resolution and rotation -NOTE: In the current version of Raspberry Pi OS Bookworm, Raspberry Pi 5, Raspberry Pi 4 and Raspberry Pi 400 default to using Wayland to display the desktop environment. Earlier models of Raspberry Pi default to using X11 to display the desktop environment. +==== Determine display device name -==== Manually setting the desktop environment resolution and rotation for Wayland +To manually configure resolution and rotation, you'll need to know the names of your display devices. To determine the device names, run the following command to display information about attached devices: -Under Wayland you can set a custom display resolution by editing the `.config/wayfire.ini` file in your home directory. You need to edit the existing `[output:]` section, or add a new `[output:]` section for your display device if one doesn't exist. For example: +[source,console] ---- -[output:HDMI-A-1] -mode = 1920x1080@60 +$ kmsprint | grep Connector ---- -The `` part of the `output:` line (`HDMI-A-1` in the example shown here) matches the display options <>. +==== Set a custom resolution -The `mode` line is _similar_ to that used by KMS, but slightly different. Consult the https://github.com/WayfireWM/wayfire-wiki/blob/master/Configuration.md#output-configuration[Wayfire documentation] for more extensive information. +To set a custom resolution, use our Screen Configuration tool, `raindrop`. If your Raspberry Pi OS installation doesn't already include `raindrop` (for instance, if you're still using the previous Screen Configuration tool, `arandr`), you can download `raindrop` from `apt` or the Recommended Software GUI. -You can also rotate your display by adding a `transform` line like: +==== Set a custom rotation + +To set a custom resolution, use our Screen Configuration tool, `raindrop`. If your Raspberry Pi OS installation doesn't already include `raindrop` (for instance, if you're still using the previous Screen Configuration tool, `arandr`), you can download `raindrop` from `apt` or the Recommended Software GUI. + +If you run the Wayland desktop compositor, you can set a custom display rotation with `wlr-randr`. The following commands rotate the display by 0°, 90°, 180°, and 270°: + +[source,console] ---- -[output:HDMI-A-1] -mode = 1920x1080@60 -transform = 270 +$ wlr-randr --output HDMI-A-1 --transform normal +$ wlr-randr --output HDMI-A-1 --transform 90 +$ wlr-randr --output HDMI-A-1 --transform 180 +$ wlr-randr --output HDMI-A-1 --transform 270 ---- -where the allowable `transform` options are: `normal`, `90`, `180` and `270`. +The `--output` option specifies the device to be rotated. + +NOTE: To run this command over SSH, add the following prefix: `WAYLAND_DISPLAY=wayland-1`, e.g. `WAYLAND_DISPLAY=wayland-1 wlr-randr --output HDMI-A-1 --transform 90`. -If you've set Raspberry Pi OS to boot to desktop but are *not* using auto-login, then you'll also need to edit `/usr/share/greeter.ini`, which determines the resolution and rotation used by the login screen. This file has the same format as `.config/wayfire.ini` described earlier, so again you'll need to add or edit the `[output:]` section. +You can also use one of the following `--transform` options to mirror the display at the same time as rotating it: `flipped`, `flipped-90`, `flipped-180`, `flipped-270`. -=== Setting the text console resolution and rotation +=== Console resolution and rotation -This is achieved by editing the KMS settings - see <> for more details. +To change the resolution and rotation of your Raspberry Pi in console mode, use the KMS settings. For more information, see <>. -NOTE: If you have multiple screens connected, they must all be set to the same rotation value in console mode, or no rotation will be applied. +NOTE: When using console mode with multiple displays, all connected displays share the same rotation settings. diff --git a/documentation/asciidoc/computers/configuration/display-rotation.adoc b/documentation/asciidoc/computers/configuration/display-rotation.adoc deleted file mode 100644 index 9a0cd4df0..000000000 --- a/documentation/asciidoc/computers/configuration/display-rotation.adoc +++ /dev/null @@ -1,66 +0,0 @@ -// This file is no longer used, but keep it around in case we want to add the `wlr-randr` and `xrandr` commands to display-resolution.adoc at some point - -== Rotating your Display - -The options to rotate the display of your Raspberry Pi depend on whether you're booting to the desktop environment or booting to the CLI (text console). - -=== Rotating the desktop environment - -If you are running the Raspberry Pi desktop then rotation is most easily achieved by using the `Screen Configuration Utility` from the desktop `Preferences` menu. This will bring up a graphical representation of the display or displays connected to the Raspberry Pi. Right click on the display you wish to rotate and select the required option. - -It is also possible to change these settings using the command line, although the method for doing this depends on whether you're running the Wayland or X11 backend. Type -[,bash] ----- -ps ax | grep [w]ayfire ----- -into a Terminal window, and if you get `/usr/bin/wayfire` displayed then you're running Wayland, and if you get no output you're running X11. - -NOTE: In the current version of Raspberry Pi OS Bookworm, Raspberry Pi 4 and 400 default to using Wayland to display the desktop environment; whereas earlier models of Raspberry Pi default to using X11 to display the desktop environment. - -==== Rotating the desktop environment using Wayland - -Under Wayland you can rotate the display using the `wlr-randr` command. The following commands give give 0°, 90°, 180° and 270° rotations respectively. - -[,bash] ----- -wlr-randr --output HDMI-A-1 --transform normal -wlr-randr --output HDMI-A-1 --transform 90 -wlr-randr --output HDMI-A-1 --transform 180 -wlr-randr --output HDMI-A-1 --transform 270 ----- - -Note that the `--output` entry specifies to which device the rotation applies. You can determine the device name by typing `kmsprint | grep Connector` on the command line which will display information for all attached devices. - -NOTE: If running this command over SSH, you'll need to prefix `wlr-randr` with `WAYLAND_DISPLAY=wayland-1`, e.g. `WAYLAND_DISPLAY=wayland-1 wlr-randr --output HDMI-A-1 --transform 90` - -You can also use one of the following `--transform` options to mirror the display at the same time as rotating it: `flipped`, `flipped-90`, `flipped-180`, `flipped-270` - -==== Rotating the desktop environment using X11 - -Under X11 you can rotate the display using the `xrandr` command. The following commands give 0°, 90°, 180° and 270° rotations respectively. - -[,bash] ----- -xrandr --output HDMI-1 --rotate normal -xrandr --output HDMI-1 --rotate left -xrandr --output HDMI-1 --rotate inverted -xrandr --output HDMI-1 --rotate right ----- - -Note that the `--output` entry specifies to which device the rotation applies. You can determine the device name by typing `xrandr --listmonitors` on the command line which will display information for all attached devices. - -NOTE: If running this command over SSH, you'll need to prefix `xrandr` with `DISPLAY=:0`, e.g. `DISPLAY=:0 wlr-randr --output HDMI-1 --rotate right` - -You can also use the command line to mirror the display using the `--reflect` option. Reflection can be one of `normal`, `x`, `y` or `xy`. This causes the output contents to be reflected across the specified axes. For example: - -[,bash] ----- -xrandr --output HDMI-1 --reflect x ----- - -=== Rotating the text console - -This is achieved by editing the KMS settings - see <> for more details. - -NOTE: If you have multiple screens connected, they must all be set to the same rotation value in console mode, or no rotation will be applied. - diff --git a/documentation/asciidoc/computers/configuration/external-storage.adoc b/documentation/asciidoc/computers/configuration/external-storage.adoc index b030ca211..5e1ea106c 100644 --- a/documentation/asciidoc/computers/configuration/external-storage.adoc +++ b/documentation/asciidoc/computers/configuration/external-storage.adoc @@ -1,4 +1,4 @@ -== External storage configuration +== External storage You can connect your external hard disk, SSD, or USB stick to any of the USB ports on the Raspberry Pi, and mount the file system to access the data stored on it. @@ -8,82 +8,92 @@ NOTE: Raspberry Pi OS Lite does not implement automounting. To set up your storage device so that it always mounts to a specific location of your choice, you must mount it manually. -=== Mounting a storage device +=== Mount a storage device You can mount your storage device at a specific folder location. It is conventional to do this within the `/mnt` folder, for example `/mnt/mydisk`. Note that the folder must be empty. Plug the storage device into a USB port on the Raspberry Pi, and list all the disk partitions on the Raspberry Pi using the following command: -+ + +[source,console] ---- - sudo lsblk -o UUID,NAME,FSTYPE,SIZE,MOUNTPOINT,LABEL,MODEL +$ sudo lsblk -o UUID,NAME,FSTYPE,SIZE,MOUNTPOINT,LABEL,MODEL ---- -+ + The Raspberry Pi uses mount points `/` and `/boot/firmware/`. Your storage device will show up in this list, along with any other connected storage. Use the SIZE, LABEL, and MODEL columns to identify the name of the disk partition that points to your storage device. For example, `sda1`. The FSTYPE column contains the filesystem type. If your storage device uses an exFAT file system, install the exFAT driver: -+ + +[source,console] ---- - sudo apt update - sudo apt install exfat-fuse +$ sudo apt update +$ sudo apt install exfat-fuse ---- If your storage device uses an NTFS file system, you will have read-only access to it. If you want to write to the device, you can install the ntfs-3g driver: -+ + +[source,console] ---- - sudo apt update - sudo apt install ntfs-3g +$ sudo apt update +$ sudo apt install ntfs-3g ---- Run the following command to get the location of the disk partition: -+ + +[source,console] ---- - sudo blkid +$ sudo blkid ---- -+ + For example, `/dev/sda1`. Create a target folder to be the mount point of the storage device. The mount point name used in this case is `mydisk`. You can specify a name of your choice: -+ + +[source,console] ---- - sudo mkdir /mnt/mydisk +$ sudo mkdir /mnt/mydisk ---- Mount the storage device at the mount point you created: -+ + +[source,console] ---- - sudo mount /dev/sda1 /mnt/mydisk +$ sudo mount /dev/sda1 /mnt/mydisk ---- Verify that the storage device is mounted successfully by listing the contents: -+ + +[source,console] ---- - ls /mnt/mydisk +$ ls /mnt/mydisk ---- -=== Setting up automatic mounting +=== Automatically mount a storage device You can modify the `fstab` file to define the location where the storage device will be automatically mounted when the Raspberry Pi starts up. In the `fstab` file, the disk partition is identified by the universally unique identifier (UUID). Get the UUID of the disk partition: -+ + +[source,console] ---- - sudo blkid +$ sudo blkid ---- Find the disk partition from the list and note the UUID. (For example, `5C24-1453`.) Open the fstab file using a command line editor such as nano: -+ + +[source,console] ---- - sudo nano /etc/fstab +$ sudo nano /etc/fstab ---- Add the following line in the `fstab` file: -+ + +[source,bash] ---- - UUID=5C24-1453 /mnt/mydisk fstype defaults,auto,users,rw,nofail 0 0 +UUID=5C24-1453 /mnt/mydisk fstype defaults,auto,users,rw,nofail 0 0 ---- -+ + Replace `fstype` with the type of your file system, which you found when you went through the steps above, for example: `ntfs`. If the filesystem type is FAT or NTFS, add `,umask=000` immediately after `nofail` - this will allow all users full read/write access to every file on the storage device. @@ -94,12 +104,13 @@ NOTE: If you do not have the storage device attached when the Raspberry Pi start For more information on each Linux command, refer to the specific manual page using the `man` command. For example, `man fstab`. -=== Unmounting a storage device +=== Unmount a storage device When the Raspberry Pi shuts down, the system takes care of unmounting the storage device so that it is safe to unplug it. If you want to manually unmount a device, you can use the following command: +[source,console] ---- -sudo umount /mnt/mydisk +$ sudo umount /mnt/mydisk ---- If you receive an error that the 'target is busy', this means that the storage device was not unmounted. If no error was displayed, you can now safely unplug the device. @@ -111,14 +122,16 @@ The 'target is busy' message means there are files on the storage device that ar Close any program which has open files on the storage device. If you have a terminal open, make sure that you are not in the folder where the storage device is mounted, or in a sub-folder of it. If you are still unable to unmount the storage device, you can use the `lsof` tool to check which program has files open on the device. You need to first install `lsof` using `apt`: -+ + +[source,console] ---- - sudo apt update - sudo apt install lsof +$ sudo apt update +$ sudo apt install lsof ---- -+ + To use lsof: -+ + +[source,console] ---- - lsof /mnt/mydisk +$ lsof /mnt/mydisk ---- diff --git a/documentation/asciidoc/computers/configuration/hdmi-config.adoc b/documentation/asciidoc/computers/configuration/hdmi-config.adoc deleted file mode 100644 index 075f7e3b9..000000000 --- a/documentation/asciidoc/computers/configuration/hdmi-config.adoc +++ /dev/null @@ -1,8 +0,0 @@ -== HDMI configuration - -In the vast majority of cases, simply plugging your HDMI-equipped monitor into the Raspberry Pi using a standard HDMI cable will result in the Raspberry Pi automatically using the best resolution the monitor can support. The Raspberry Pi Zero, Zero W and Zero 2 W use a mini HDMI port, so you will need a mini-HDMI-to-full-size-HDMI lead or adapter. On Raspberry Pi 4, Raspberry Pi 5 and Raspberry Pi 400 there are two micro HDMI ports, so you will need a micro-HDMI-to-full-size-HDMI lead or adapter for each display you wish to attach. You should connect any HDMI leads before turning on the Raspberry Pi. - -Raspberry Pi 5, Raspberry Pi 4 (and Pi 400) can drive up to two displays, with a resolution up to 1080p at a 60Hz refresh rate. At 4K resolution, if you connect two displays then you are limited to a 30Hz refresh rate. You can also drive a single display at 4K with a 60Hz refresh rate: this requires that the display is attached to the HDMI port adjacent to the USB-C power input (labelled HDMI0). You must also enable 4Kp60 output by setting the `hdmi_enable_4kp60=1` flag in `config.txt`. - -The Screen Configuration tool (`arandr`) is a graphical tool for selecting display modes and setting up multiple displays. You can find this tool in the desktop Preferences menu. Use the Layout menu option to select the screen, resolution, and orientation. If you're using a multi-screen setup, drag around the displays to any position you want. When you are happy with your setup, click the Apply button to apply the settings. - diff --git a/documentation/asciidoc/computers/configuration/headless.adoc b/documentation/asciidoc/computers/configuration/headless.adoc index 4568b2bee..e62c2eef0 100644 --- a/documentation/asciidoc/computers/configuration/headless.adoc +++ b/documentation/asciidoc/computers/configuration/headless.adoc @@ -9,7 +9,7 @@ To access your Raspberry Pi over that network, use SSH. Once you've connected ov If you're setting up your Raspberry Pi from scratch, set up wireless networking and SSH during the xref:getting-started.adoc#installing-the-operating-system[imaging process]. If you've already got a Raspberry Pi set up, you can configure SSH using `raspi-config`. -WARNING: Depending on the model of Raspberry Pi and type of SD card you are using, your Raspberry Pi may require up to five minutes to boot and connect to your wireless network the first time it boots. +WARNING: Depending on the model of Raspberry Pi and type of SD card you use, your Raspberry Pi may require up to five minutes to boot and connect to your wireless network the first time it boots. === Connect to a wired network @@ -26,14 +26,14 @@ NOTE: Previous versions of Raspberry Pi OS made use of a `wpa_supplicant.conf` f With no keyboard or monitor, you need a way to xref:remote-access.adoc[remotely control] your headless Raspberry Pi. On first boot, the only option is SSH. To enable SSH on a fresh installation of Raspberry Pi OS, choose one of the following methods: * enable SSH in the OS customisation menu in Raspberry Pi Imager, then enter a username and password -* create a file named `ssh` at the root of the SD card, then configure a user manually with `userconf.txt` following the instructions in the section below +* create a file named `ssh` at the root of the first partition of the SD card (labeled `bootfs`), then configure a user manually with `userconf.txt` following the instructions in the section below For more information, see xref:remote-access.adoc#ssh[set up an SSH server]. Once you've connected over SSH, you can use `raspi-config` to xref:remote-access.adoc#vnc[enable VNC] if you'd prefer a graphical desktop environment. [[configuring-a-user]] ==== Configure a user manually -At the root of your SD card, create a file named `userconf.txt`. +At the root of the first partition of your SD card (the filesystem labeled `bootfs`), create a file named `userconf.txt`. This file should contain a single line of text, consisting of `:`: your desired username, followed immediately by a colon, followed immediately by an *encrypted* representation of the password you want to use. @@ -41,8 +41,9 @@ NOTE: `` must only contain lower-case letters, digits and hyphens, and To generate the encrypted password, use https://www.openssl.org[OpenSSL] on another computer. Open a terminal and enter the following: +[source,console] ---- -openssl passwd -6 +$ openssl passwd -6 ---- When prompted, enter your password and verify it. This command will then output an encrypted version of the supplied password. diff --git a/documentation/asciidoc/computers/configuration/host-wireless-network.adoc b/documentation/asciidoc/computers/configuration/host-wireless-network.adoc index 9fb9fc04e..9bd7dcc1e 100644 --- a/documentation/asciidoc/computers/configuration/host-wireless-network.adoc +++ b/documentation/asciidoc/computers/configuration/host-wireless-network.adoc @@ -1,4 +1,4 @@ -== Host a wireless network on your Raspberry Pi +== Host a wireless network from your Raspberry Pi Your Raspberry Pi can host its own wireless network using a wireless module. If you connect your Raspberry Pi to the internet via the Ethernet port (or a second wireless module), other devices connected to the wireless network can access the internet through your Raspberry Pi. @@ -11,14 +11,15 @@ image::images/host-a-network.png[] With this network configuration, wireless clients can all communicate with each other through the Raspberry Pi router. However, clients on the wireless network cannot directly interact with clients on the wired network other than the Raspberry Pi; wireless clients exist in a private network separate from the network that serves wired clients. -NOTE: The Raspberry Pi 5, 4, 3, and Raspberry Pi Zero W can host a wireless network using the built-in wireless module. Raspberry Pi models that lack a built-in module support this functionality using a separate wireless dongle. +NOTE: The Raspberry Pi 5, 4, 3, Zero W, and Zero 2 W can host a wireless network using the built-in wireless module. Raspberry Pi models that lack a built-in module support this functionality using a separate wireless dongle. === Enable hotspot To create a hosted wireless network on the command line, run the following command, replacing the `` and `` placeholders with your own values: +[source,console] ---- -sudo nmcli device wifi hotspot ssid password +$ sudo nmcli device wifi hotspot ssid password ---- Use another wireless client, such as a laptop or smartphone, to connect to the network. Look for a network with a SSID matching ``. Enter your network password, and you should connect successfully to the network. If your Raspberry Pi has internet access via an Ethernet connection or a second wireless adapter, you should be able to access the internet. @@ -27,24 +28,25 @@ Use another wireless client, such as a laptop or smartphone, to connect to the n To disable the hotspot network and resume use of your Pi as a wireless client, run the following command: +[source,console] ---- -sudo nmcli device disconnect wlan0 +$ sudo nmcli device disconnect wlan0 ---- After disabling the network, run the following command to reconnect to another Wi-Fi network: +[source,console] ---- -sudo nmcli device up wlan0 +$ sudo nmcli device up wlan0 ---- -TIP: For more information about connecting to wireless networks, see xref:configuration.adoc#configuring-networking[Configuring networking]. +TIP: For more information about connecting to wireless networks, see xref:configuration.adoc#networking[Configure networking]. === Use your Raspberry Pi as a network bridge By default, the wireless network hosted from your Raspberry Pi exists separately from the parent network connected via Ethernet. In this arrangement, devices connected to the parent network cannot directly communicate with devices connected to the wireless network hosted from your Raspberry Pi. If you want connected wireless devices to be able to communicate with devices on the parent network, you can configure your Raspberry Pi as a https://en.wikipedia.org/wiki/Network_bridge[network bridge]. With a network bridge in place, each device connected to the Pi-hosted wireless network is assigned an IP address in the parent network. - -In the diagram below, note that the laptop exists in the same IP block as the router and wired clients: +In the diagram below, the laptop exists in the same IP block as the router and wired clients: image::images/bridge-network.png[] @@ -52,14 +54,16 @@ The following steps describe how to set up a network bridge on your Raspberry Pi First, create a network bridge interface: +[source,console] ---- -sudo nmcli connection add type bridge con-name 'Bridge' ifname bridge0 +$ sudo nmcli connection add type bridge con-name 'Bridge' ifname bridge0 ---- Next, add your device's Ethernet connection to the parent network to the bridge: +[source,console] ---- -sudo nmcli connection add type ethernet slave-type bridge \ +$ sudo nmcli connection add type ethernet slave-type bridge \ con-name 'Ethernet' ifname eth0 master bridge0 ---- @@ -67,16 +71,18 @@ Finally, add your wireless hotspot connection to the bridge. You can either add * If you have already created a wireless hotspot connection using the instructions above, add the existing interface to the bridge with the following command: + +[source,console] ---- -sudo nmcli connection modify 'Hotspot' master bridge0 +$ sudo nmcli connection modify 'Hotspot' master bridge0 ---- -* If you have not yet created a wireless hotspot connection, create a new interface and add it to the bridge with a single command, replacing the `` placeholder with a password of your choice: +* If you have not yet created a wireless hotspot connection, create a new interface and add it to the bridge with a single command, replacing the `` and `` placeholders with a network name and password of your choice, respectively: + +[source,console?prompt=$] ---- -sudo nmcli connection add con-name 'Hotspot' \ +$ sudo nmcli connection add con-name 'Hotspot' \ ifname wlan0 type wifi slave-type bridge master bridge0 \ - wifi.mode ap wifi.ssid Hotspot wifi-sec.key-mgmt wpa-psk \ + wifi.mode ap wifi.ssid wifi-sec.key-mgmt wpa-psk \ wifi-sec.proto rsn wifi-sec.pairwise ccmp \ wifi-sec.psk ---- @@ -84,14 +90,16 @@ sudo nmcli connection add con-name 'Hotspot' \ Now that you've configured your bridge, it's time to activate it. Run the following command to activate the bridge: +[source,console] ---- -sudo nmcli connection up Bridge +$ sudo nmcli connection up Bridge ---- And run the following command to start hosting your wireless network: +[source,console] ---- -sudo nmcli connection up Hotspot +$ sudo nmcli connection up Hotspot ---- You can use the `nmcli device` command to verify that the bridge, Ethernet interface, and wireless hotspot interface are all active. diff --git a/documentation/asciidoc/computers/configuration/images/blanking.png b/documentation/asciidoc/computers/configuration/images/blanking.png index ab3bf654a..0ef13f8a6 100644 Binary files a/documentation/asciidoc/computers/configuration/images/blanking.png and b/documentation/asciidoc/computers/configuration/images/blanking.png differ diff --git a/documentation/asciidoc/computers/configuration/images/create-hotspot-dialog.png b/documentation/asciidoc/computers/configuration/images/create-hotspot-dialog.png index e9626efef..42085c98a 100644 Binary files a/documentation/asciidoc/computers/configuration/images/create-hotspot-dialog.png and b/documentation/asciidoc/computers/configuration/images/create-hotspot-dialog.png differ diff --git a/documentation/asciidoc/computers/configuration/images/create-hotspot-network-menu.png b/documentation/asciidoc/computers/configuration/images/create-hotspot-network-menu.png index 65e6b0d88..39ce5334d 100644 Binary files a/documentation/asciidoc/computers/configuration/images/create-hotspot-network-menu.png and b/documentation/asciidoc/computers/configuration/images/create-hotspot-network-menu.png differ diff --git a/documentation/asciidoc/computers/configuration/images/key.png b/documentation/asciidoc/computers/configuration/images/key.png index ca0c65b11..6469f91fb 100755 Binary files a/documentation/asciidoc/computers/configuration/images/key.png and b/documentation/asciidoc/computers/configuration/images/key.png differ diff --git a/documentation/asciidoc/computers/configuration/images/network-hidden-authentication.png b/documentation/asciidoc/computers/configuration/images/network-hidden-authentication.png index 6a18da47f..1b6310291 100644 Binary files a/documentation/asciidoc/computers/configuration/images/network-hidden-authentication.png and b/documentation/asciidoc/computers/configuration/images/network-hidden-authentication.png differ diff --git a/documentation/asciidoc/computers/configuration/images/network-hidden.png b/documentation/asciidoc/computers/configuration/images/network-hidden.png index ffa628ae0..1e2964305 100644 Binary files a/documentation/asciidoc/computers/configuration/images/network-hidden.png and b/documentation/asciidoc/computers/configuration/images/network-hidden.png differ diff --git a/documentation/asciidoc/computers/configuration/images/pi-configuration.png b/documentation/asciidoc/computers/configuration/images/pi-configuration.png index d4063814c..c5bbf319b 100644 Binary files a/documentation/asciidoc/computers/configuration/images/pi-configuration.png and b/documentation/asciidoc/computers/configuration/images/pi-configuration.png differ diff --git a/documentation/asciidoc/computers/configuration/images/proxy-edit-sudoers.png b/documentation/asciidoc/computers/configuration/images/proxy-edit-sudoers.png deleted file mode 100644 index 3a76f38a3..000000000 Binary files a/documentation/asciidoc/computers/configuration/images/proxy-edit-sudoers.png and /dev/null differ diff --git a/documentation/asciidoc/computers/configuration/images/proxy-environment-variables.png b/documentation/asciidoc/computers/configuration/images/proxy-environment-variables.png deleted file mode 100644 index 137484c73..000000000 Binary files a/documentation/asciidoc/computers/configuration/images/proxy-environment-variables.png and /dev/null differ diff --git a/documentation/asciidoc/computers/configuration/images/raspi-adv.png b/documentation/asciidoc/computers/configuration/images/raspi-adv.png deleted file mode 100755 index b8386d1a5..000000000 Binary files a/documentation/asciidoc/computers/configuration/images/raspi-adv.png and /dev/null differ diff --git a/documentation/asciidoc/computers/configuration/images/raspi-config.png b/documentation/asciidoc/computers/configuration/images/raspi-config.png old mode 100755 new mode 100644 index 8916deaf3..e1af51180 Binary files a/documentation/asciidoc/computers/configuration/images/raspi-config.png and b/documentation/asciidoc/computers/configuration/images/raspi-config.png differ diff --git a/documentation/asciidoc/computers/configuration/images/raspi-display.png b/documentation/asciidoc/computers/configuration/images/raspi-display.png deleted file mode 100755 index f50ea5e46..000000000 Binary files a/documentation/asciidoc/computers/configuration/images/raspi-display.png and /dev/null differ diff --git a/documentation/asciidoc/computers/configuration/images/raspi-interface.png b/documentation/asciidoc/computers/configuration/images/raspi-interface.png deleted file mode 100755 index a07f73744..000000000 Binary files a/documentation/asciidoc/computers/configuration/images/raspi-interface.png and /dev/null differ diff --git a/documentation/asciidoc/computers/configuration/images/raspi-l18n.png b/documentation/asciidoc/computers/configuration/images/raspi-l18n.png deleted file mode 100755 index 65b4b8ad4..000000000 Binary files a/documentation/asciidoc/computers/configuration/images/raspi-l18n.png and /dev/null differ diff --git a/documentation/asciidoc/computers/configuration/images/raspi-perf.png b/documentation/asciidoc/computers/configuration/images/raspi-perf.png deleted file mode 100755 index 8ccaa7de8..000000000 Binary files a/documentation/asciidoc/computers/configuration/images/raspi-perf.png and /dev/null differ diff --git a/documentation/asciidoc/computers/configuration/images/raspi-system.png b/documentation/asciidoc/computers/configuration/images/raspi-system.png deleted file mode 100755 index 8ad3c2d6c..000000000 Binary files a/documentation/asciidoc/computers/configuration/images/raspi-system.png and /dev/null differ diff --git a/documentation/asciidoc/computers/configuration/images/wifi2.png b/documentation/asciidoc/computers/configuration/images/wifi2.png index 536abb0c1..627b04ea9 100755 Binary files a/documentation/asciidoc/computers/configuration/images/wifi2.png and b/documentation/asciidoc/computers/configuration/images/wifi2.png differ diff --git a/documentation/asciidoc/computers/configuration/kernel-command-line-config.adoc b/documentation/asciidoc/computers/configuration/kernel-command-line-config.adoc index 0c1e8f4df..27fbc1c26 100644 --- a/documentation/asciidoc/computers/configuration/kernel-command-line-config.adoc +++ b/documentation/asciidoc/computers/configuration/kernel-command-line-config.adoc @@ -1,55 +1,65 @@ -== The kernel command line +== Kernel command line (`cmdline.txt`) -The Linux kernel accepts a command line of parameters during boot. On the Raspberry Pi, this command line is defined in a file in the boot partition, called `cmdline.txt`. You can edit this text file with any text editor. +The Linux kernel accepts a collection of command line parameters during boot. On the Raspberry Pi, this command line is defined in a file in the boot partition, called `cmdline.txt`. You can edit this text file with any text editor. +[source,console] ---- -sudo nano /boot/firmware/cmdline.txt +$ sudo nano /boot/firmware/cmdline.txt ---- -NOTE: Use `sudo` to edit anything in the boot partition. Put all parameters in `cmdline.txt` on the same line; do not use carriage returns. +IMPORTANT: Put all parameters in `cmdline.txt` on the same line. Do _not_ use newlines. -The command line that was passed to the kernel at boot time can be displayed using `cat /proc/cmdline`. It will not be exactly the same as that in `cmdline.txt` as the firmware can make changes to it prior to launching the kernel. +To view the command line passed to the kernel at boot time, run the following command: + +[source,console] +---- +$ cat /proc/cmdline +---- + +Because Raspberry Pi firmware makes changes to the command line before launching the kernel, the output of this command will not exactly match the contents of `cmdline.txt`. === Command line options There are many kernel command line parameters, some of which are defined by the kernel itself. Others are defined by code that the kernel may be using, such as the Plymouth splash screen system. -[discrete] -===== Standard entries +==== Standard entries + +`console`:: defines the serial console. There are usually two entries: + +* `console=serial0,115200` +* `console=tty1` + +`root`:: defines the location of the root filesystem. e.g. `root=/dev/mmcblk0p2` means multimedia card block 0 partition 2. + +`rootfstype`:: defines what type of filesystem the rootfs uses, e.g. `rootfstype=ext4`. -* console: defines the serial console. There are usually two entries: - ** `console=serial0,115200` - ** `console=tty1` -* root: defines the location of the root filesystem. e.g. `root=/dev/mmcblk0p2` means multimedia card block 0 partition 2. -* rootfstype: defines what type of filesystem the rootfs uses, e.g. `rootfstype=ext4`. -* quiet: sets the default kernel log level to `KERN_WARNING`, which suppresses all but very serious log messages during boot. +`quiet`:: sets the default kernel log level to `KERN_WARNING`, which suppresses all but very serious log messages during boot. -[discrete] -===== Setting the KMS display mode +==== Set the KMS display mode -The "legacy firmware" and "FKMS" display modes used in earlier versions of Raspberry Pi OS are no longer supported; KMS (Kernel Mode Setting) is now used instead. +The legacy firmware and FKMS display modes used in earlier versions of Raspberry Pi OS are no longer supported. Instead, recent OS versions use KMS (Kernel Mode Setting). -If no `video` entry is present in `cmdline.txt` then the Linux kernel will read the EDID of an HDMI-connected monitor, and automatically pick the best resolution supported by your display. If you're using Raspberry Pi OS Lite, or the "boot to CLI" mode of Raspberry Pi OS, and you want to change the resolution of the text console, then you'll need to add a `video` setting to `cmdline.txt`, for example: +If no `video` entry is present in `cmdline.txt`, Raspberry Pi OS uses the https://en.wikipedia.org/wiki/Extended_Display_Identification_Data[EDID] of the HDMI-connected monitor to automatically pick the best resolution supported by your display based on information in the Linux kernel. In Raspberry Pi OS Lite or console mode, you must customise the `video` entry to control resolution and rotation. -[source] +[source,bash] ---- video=HDMI-A-1:1920x1080M@60 ---- -In addition, it is possible to add rotation and reflect parameters as documented in the standard https://github.com/raspberrypi/linux/blob/rpi-6.1.y/Documentation/fb/modedb.rst[Linux framebuffer documentation]. An example entry might look like this: +In addition, it is possible to add rotation and reflect parameters as documented in the standard https://github.com/raspberrypi/linux/blob/rpi-6.1.y/Documentation/fb/modedb.rst[Linux framebuffer documentation]. The following example defines a display named `HDMI-A-1` at a resolution of 1080p, a refresh rate of 60Hz, 90 degrees of rotation, and a reflection over the X axis: -[source] +[source,bash] ---- -video=HDMI-A-1:1920x1080M@60,rotate=90,reflect_x` +video=HDMI-A-1:1920x1080M@60,rotate=90,reflect_x ---- -NOTE: It is not possible to specify the rotation and reflection parameters without also explicitly specifying the resolution. +You must specify the resolution explicitly when specifying rotation and reflection parameters. Possible options for the display type - the first part of the `video=` entry - include: -[cols="^,<"] +[cols="1m,3"] |=== -| video option | Display +| Video Option | Display | HDMI-A-1 | HDMI 1 (HDMI 0 on silkscreen of Raspberry Pi 4B, HDMI on single HDMI boards) @@ -64,16 +74,21 @@ Possible options for the display type - the first part of the `video=` entry - i | Composite |=== -[discrete] -===== Other entries (not exhaustive) - -* splash: tells the boot to use a splash screen via the Plymouth module. -* plymouth.ignore-serial-consoles: normally if the Plymouth module is enabled it will prevent boot messages from appearing on any serial console which may be present. This flag tells Plymouth to ignore all serial consoles, making boot messages visible again, as they would be if Plymouth was not running. -* dwc_otg.lpm_enable=0: turns off Link Power Management (LPM) in the dwc_otg driver, which drives the USB controller built into the processor used on Raspberry Pi computers. -+ -NOTE: On Raspberry Pi 4 this controller is disabled by default, and is only connected to the USB type C power input connector; the USB type A ports on Raspberry Pi 4 are driven by a separate USB controller which is not affected by this setting. -* dwc_otg.speed: sets the speed of the USB controller built into the processor on Raspberry Pi computers. `dwc_otg.speed=1` will set it to full speed (USB 1.0), which is slower than high speed (USB 2.0). This option should not be set except during troubleshooting of problems with USB devices. -* smsc95xx.turbo_mode: enables/disables the wired networking driver turbo mode. `smsc95xx.turbo_mode=N` turns turbo mode off. -* usbhid.mousepoll: specifies the mouse polling interval. If you have problems with a slow or erratic wireless mouse, setting this to 0 with `usbhid.mousepoll=0` might help. -* drm.edid_firmware=HDMI-A-1:edid/your_edid.bin: Override your monitor's built-in EDID with the contents of `/usr/lib/firmware/edid/your_edid.bin`. +==== Other entries + +This section contains some of the other entries you can use in the kernel command line. This list is not exhaustive. + +`splash`:: tells the boot to use a splash screen via the Plymouth module. + +`plymouth.ignore-serial-consoles`:: normally if the Plymouth module is enabled it will prevent boot messages from appearing on any serial console which may be present. This flag tells Plymouth to ignore all serial consoles, making boot messages visible again, as they would be if Plymouth was not running. + +`dwc_otg.lpm_enable=0`:: turns off Link Power Management (LPM) in the `dwc_otg` driver, which drives the USB controller built into the processor used on Raspberry Pi computers. On Raspberry Pi 4, this controller is disabled by default, and is only connected to the USB type C power input connector. The USB-A ports on Raspberry Pi 4 are driven by a separate USB controller which is not affected by this setting. + +`dwc_otg.speed`:: sets the speed of the USB controller built into the processor on Raspberry Pi computers. `dwc_otg.speed=1` will set it to full speed (USB 1.0), which is slower than high speed (USB 2.0). This option should not be set except during troubleshooting of problems with USB devices. + +`smsc95xx.turbo_mode`:: enables/disables the wired networking driver turbo mode. `smsc95xx.turbo_mode=N` turns turbo mode off. + +`usbhid.mousepoll`:: specifies the mouse polling interval. If you have problems with a slow or erratic wireless mouse, setting this to 0 with `usbhid.mousepoll=0` might help. + +`drm.edid_firmware=HDMI-A-1:edid/your_edid.bin`:: Override your monitor's built-in EDID with the contents of `/usr/lib/firmware/edid/your_edid.bin`. diff --git a/documentation/asciidoc/computers/configuration/led_blink_warnings.adoc b/documentation/asciidoc/computers/configuration/led_blink_warnings.adoc index f30bed872..5eebc6d7c 100644 --- a/documentation/asciidoc/computers/configuration/led_blink_warnings.adoc +++ b/documentation/asciidoc/computers/configuration/led_blink_warnings.adoc @@ -30,6 +30,10 @@ If a Raspberry Pi fails to boot for some reason, or has to shut down, in many ca | 10 | In HALT state +| 1 +| 2 +| SD card overcurrent detected + | 2 | 1 | Partition not FAT @@ -44,19 +48,19 @@ If a Raspberry Pi fails to boot for some reason, or has to shut down, in many ca | 2 | 4 -| File signature/hash mismatch - Pi 4 +| File signature/hash mismatch - Pi 4 and Pi 5 | 3 | 1 -| SPI EEPROM error - Pi 4 +| SPI EEPROM error - Pi 4 and Pi 5 | 3 | 2 -| SPI EEPROM is write protected - Pi 4 +| SPI EEPROM is write protected - Pi 4 and Pi 5 | 3 | 3 -| I2C error - Pi 4 +| I2C error - Pi 4 and Pi 5 | 3 | 4 diff --git a/documentation/asciidoc/computers/configuration/localisation.adoc b/documentation/asciidoc/computers/configuration/localisation.adoc index d2e53d22c..47fb2aba5 100644 --- a/documentation/asciidoc/computers/configuration/localisation.adoc +++ b/documentation/asciidoc/computers/configuration/localisation.adoc @@ -1,5 +1,5 @@ -== Localising your Raspberry Pi +== Localise your Raspberry Pi -You can set your Raspberry Pi up to match your regional settings. Language, keyboard layout and time zone can all be changed using the xref:configuration.adoc#raspi-config[`raspi-config`] tool. +You can configure the UI language, keyboard layout, and time zone of Raspberry Pi OS with the xref:configuration.adoc#raspi-config[`raspi-config`] tool. diff --git a/documentation/asciidoc/computers/configuration/pin-configuration.adoc b/documentation/asciidoc/computers/configuration/pin-configuration.adoc index 15a3e7908..d17bcbd9c 100644 --- a/documentation/asciidoc/computers/configuration/pin-configuration.adoc +++ b/documentation/asciidoc/computers/configuration/pin-configuration.adoc @@ -26,14 +26,16 @@ It may take a few seconds to run through the process. During this time, the GPIO In order to compile a Device Tree source (`.dts`) file into a Device Tree blob (`.dtb`) file, the Device Tree compiler must be installed by running `sudo apt install device-tree-compiler`. The `dtc` command can then be used as follows: +[source,console] ---- -sudo dtc -I dts -O dtb -o /boot/firmware/dt-blob.bin dt-blob.dts +$ sudo dtc -I dts -O dtb -o /boot/firmware/dt-blob.bin dt-blob.dts ---- Similarly, a `.dtb` file can be converted back to a `.dts` file, if required. +[source,console] ---- -dtc -I dtb -O dts -o dt-blob.dts /boot/firmware/dt-blob.bin +$ dtc -I dtb -O dts -o dt-blob.dts /boot/firmware/dt-blob.bin ---- === Sections of the `dt-blob` @@ -120,6 +122,7 @@ It is possible to change the configuration of the clocks through this interface, Here are a couple of example configurations that you can use to alter specific clocks. We will add to this resource when requests for clock configurations are made. +[source,kotlin] ---- clock_routing { vco@PLLA { freq = <1966080000>; }; diff --git a/documentation/asciidoc/computers/configuration/raspi-config.adoc b/documentation/asciidoc/computers/configuration/raspi-config.adoc index 6eb6c26ac..e20802967 100644 --- a/documentation/asciidoc/computers/configuration/raspi-config.adoc +++ b/documentation/asciidoc/computers/configuration/raspi-config.adoc @@ -1,733 +1,815 @@ [[raspi-config]] -== The `raspi-config` Tool +== `raspi-config` -`raspi-config` is the Raspberry Pi configuration tool, originally written by https://github.com/asb[Alex Bradbury]. To open the configuration tool, type the following on the command line: +`raspi-config` helps you configure your Raspberry Pi. Changes to `raspi-config` will modify xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] and other configuration files. ----- -sudo raspi-config ----- +=== Getting started -The `sudo` is required because you will be changing files that you do not own as the regular user. +To open the configuration tool from the desktop GUI, go to **Preferences** > **Control Centre**. -NOTE: If you are using the Raspberry Pi desktop, you can use the graphical `Raspberry Pi Configuration` application from the `Preferences` menu to configure your Raspberry Pi. +NOTE: In previous versions of Raspberry Pi OS, the Control Centre application was called Raspberry Pi Configuration. -You should then see a blue screen with options in a grey box: +Alternatively, run the following command to access the configuration tool via the terminal: -image::images/raspi-config.png[raspi-config main screen] +[source,console] +---- +$ sudo raspi-config +---- -NOTE: The menu shown may differ slightly. +TIP: Some advanced configuration is available in the `raspi-config` CLI, but not the Control Centre GUI. -Use the `up` and `down` arrow keys to move the highlighted selection between the options available. Pressing the `right` arrow key will jump out of the Options menu and take you to the `` or `` options using the **Right** arrow or **Tab**. +* Return to the settings list using the **Left** arrow or **Tab**. +* Type a letter to jump ahead alphabetically. For example, type `E` to jump ahead to 'Europe' in the time zone list. -NOTE: In long lists of option values (like the list of timezone cities), you can also type a letter to skip to that section of the list. For example, entering `L` will skip you to Lisbon, just two options away from London, to save you scrolling all the way through the alphabet. +image::images/raspi-config.png[raspi-config main screen] [[menu-options]] -=== List of options - -NOTE: Due to the continuous development of the `raspi-config` tool, the list of options below may not be completely up-to-date. Also please be aware that different models of Raspberry Pi may have different options available. +=== System options -NOTE: All options are available via a non-interactive command line interface. See the section on the <> for more information. +Configure parts of the boot, login, and networking process, along with other system level changes. -==== System options +==== Wireless LAN -The system options submenu allows you to make configuration changes to various parts of the boot, login and networking process, along with some other system level changes. +Configure Wi-Fi SSID and passphrase. -image::images/raspi-system.png[raspi-config system options] - -===== Wireless LAN - -Allows setting of the wireless LAN SSID and passphrase. - -===== Audio +==== Audio Specify the audio output destination. -[[change-user-password]] -===== Password +==== Password -You can change the 'default' user password. +Change your password. -NOTE: Originally, the default user on early versions of Raspberry Pi OS was `pi` with the password `raspberry`. The default user is now set while configuring the OS image or on first boot using a configuration wizard. +For more information, see xref:configuration.adoc#change-user-password[Change a user's password]. [[hostname]] -===== Hostname +==== Hostname -Set the visible name for this Raspberry Pi on a network. +Set the visible xref:remote-access.adoc#resolve-raspberrypi-local-with-mdns[mDNS] name for this Raspberry Pi on a network. [[boot-options]] -===== Boot/auto login +==== Boot/Auto login -From this submenu you can select whether to boot to console or desktop, and whether you need to log in or not. If you select automatic login, you will be logged in with your current username. +Boot to console or desktop with the option of an automatic login to your current user account. -===== Network at boot +==== Network at boot -Use this option to wait for a network connection before letting boot proceed. +Wait for a network connection before proceeding with boot. -===== Splash screen +==== Splash screen -Enable or disable the splash screen displayed at boot time - -===== Power LED +Enable or disable the splash screen displayed at boot time. -If the model of Raspberry Pi you are using permits it, you can change the behaviour of the power LED using this option. +==== Power LED -===== Browser +If your Raspberry Pi model allows, change the behaviour of the power LED. -Use this option to change the default web browser. Choosing a web browser that isn't currently installed won't work. +==== Browser -==== Display options +Change the default web browser. -image::images/raspi-display.png[raspi-config display options] +=== Display options [[underscan]] -===== Underscan +==== Underscan -NOTE: This option isn't available if you're using the Wayland backend. +NOTE: Unavailable when running Wayland. -If the initial text shown on the screen disappears off the edge, you need to enable overscan to bring the border back. On some displays, particularly monitors, disabling overscan will make the picture fill the whole screen and will remove the black border. +If the initial text shown on the screen disappears off the edge, enable overscan to adjust the border. On some displays, particularly monitors, disabling overscan will make the picture fill the whole screen and remove the black border. -===== Screen blanking +==== Screen blanking Enable or disable screen blanking. [[resolution]] -===== VNC resolution +==== VNC resolution Define the video resolution to use in xref:configuration.adoc#setting-up-a-headless-raspberry-pi[headless] setups. -===== Composite +==== Composite Enable or disable composite video. -===== 4Kp60 HDMI +==== 4Kp60 HDMI Enable or disable 4Kp60 resolution for HDMI outputs. [[interfacing-options]] -==== Interface options - -In this submenu there are the following options to enable/disable: SSH, VNC, SPI, I2C, Serial port, 1-wire, and Remote GPIO. +=== Interface options -image::images/raspi-interface.png[raspi-config interface options] +Enable and disable various physical and virtual interfaces. [[ssh]] -===== SSH +==== SSH -Enable/disable remote command-line access to your Raspberry Pi using SSH. +Enable or disable remote terminal access to your Raspberry Pi using SSH. -SSH allows you to remotely access the command line of the Raspberry Pi from another computer. SSH is disabled by default. Read more about using SSH on the xref:remote-access.adoc#ssh[SSH documentation page]. If connecting your Raspberry Pi directly to a public network, you should not enable SSH unless you have set up secure passwords for all users. +SSH allows you to remotely access the command line of the Raspberry Pi from another computer. SSH is disabled by default. For more information about SSH, see the xref:remote-access.adoc#ssh[SSH documentation]. + +[[rpi-connect]] +==== RPi Connect + +Enable or disable xref:../services/connect.adoc[Raspberry Pi Connect], which provides the ability to access your Raspberry Pi remotely with no manual network configuration. [[VNC]] -===== VNC +==== VNC -Enable/disable the WayVNC or RealVNC virtual network computing server. +Enable or disable the WayVNC or RealVNC virtual network computing server. [[spi]] -===== SPI +==== SPI -Enable/disable SPI interfaces and automatic loading of the SPI kernel module. +Enable or disable SPI interfaces and automatic loading of the SPI kernel module. [[i2c]] -===== I2C +==== I2C -Enable/disable I2C interfaces and automatic loading of the I2C kernel module. +Enable or disable I2C interfaces and automatic loading of the I2C kernel module. [[serial]] -===== Serial port +==== Serial port -Enable/disable shell and kernel messages on the serial connection. +Enable or disable shell and kernel messages on the serial connection. [[one-wire]] -===== 1-Wire +==== 1-Wire -Enable/disable the Dallas 1-wire interface. This is usually used for DS18B20 temperature sensors. +Enable or disable the Dallas 1-wire interface, often used for DS18B20 temperature sensors. -===== Remote GPIO +==== Remote GPIO Enable or disable remote access to the GPIO pins. -==== Performance options - -image::images/raspi-perf.png[raspi-config performance options] +=== Performance options [[overclock]] -===== Overclock +==== Overclock -On some models it is possible to overclock your Raspberry Pi's CPU using this tool. The overclocking you can achieve will vary; overclocking too high may result in instability. Selecting this option shows the following warning: +If your Raspberry Pi model allows, overclock the CPU. Overclocking potential varies between individual Raspberry Pi devices, even within the same model. Overclocking too high may result in instability. -*Be aware that overclocking may reduce the lifetime of your Raspberry Pi.* If overclocking at a certain level causes system instability, try a more modest overclock. Hold down the Shift key during boot to temporarily disable overclocking. +WARNING: *Overclocking may reduce the lifetime of your Raspberry Pi.* If overclocking at a certain level causes system instability, try a more modest overclock. Hold down the *Shift* key during boot to temporarily disable overclocking. [[memory-split]] -===== GPU memory +==== GPU memory Change the amount of memory made available to the GPU. -===== Overlay file system +==== Overlay file system Enable or disable a read-only filesystem. -===== Fan +==== Fan -Set the behaviour of a GPIO connected fan. +Customise the behaviour of the GPIO-connected https://www.raspberrypi.com/products/raspberry-pi-4-case-fan/[Raspberry Pi 4 Case Fan]. Not applicable to other fan models. [[localisation-options]] -==== Localisation options - -The localisation submenu gives you these options to choose from: keyboard layout, time zone, locale, and wireless LAN country code. +=== Localisation options -image::images/raspi-l18n.png[raspi-config localisation options] +Configure location and country-related options. [[change-locale]] -===== Locale +==== Locale Select a locale, for example `en_GB.UTF-8 UTF-8`. [[change-timezone]] -===== Time zone +==== Time zone -Select your local time zone, starting with the region, e.g. Europe, then selecting a city, e.g. London. Type a letter to skip down the list to that point in the alphabet. +Set your local time zone in the format `Region/City`, for example 'Europe/London'. Type a letter to jump to that letter in the list. [[change-keyboard-layout]] -===== Keyboard +==== Keyboard -This option opens another menu which allows you to select your keyboard layout. Changes usually take effect immediately, but may require a reboot. +Open a menu where you can select your keyboard layout. Changes usually take effect immediately, but may require a reboot. Type a letter to jump to that letter in the list. -===== WLAN country +==== WLAN country -This option sets the country code for your wireless network. +Set the country code for your wireless network. [[advanced-options]] -==== Advanced options +=== Advanced options -image::images/raspi-adv.png[raspi-config advanced options] -NOTE: The options documented here will change depending on the model of Raspberry Pi that you're using, and whether you're using the Wayland or X11 backend. In the current version of Raspberry Pi OS Bookworm, the Raspberry Pi 4 and Pi 400 use Wayland by default; other models of Raspberry Pi use X11 by default. +WARNING: Changes to advanced options may prevent your Raspberry Pi from working as intended. Avoid configuring advanced options unless instructed by a Raspberry Pi engineer. [[expand-filesystem]] -===== Expand filesystem +==== Expand filesystem -This option will expand your installation to fill the whole SD card, giving you more space to use for files. You will need to reboot the Raspberry Pi to make this available. +Expand your OS partition to fill the whole storage device, giving you more space to use for files. Reboot your Raspberry Pi to complete this action. Normally, Raspberry Pi OS runs this action on first boot. This option can be useful if you clone your OS to a separate storage device with more capacity than the original. -WARNING: There is no confirmation step: selecting the option begins the partition expansion immediately. +WARNING: There is no confirmation step. Selecting the option begins the partition expansion immediately. -===== Network interface names +==== Network interface names Enable or disable predictable network interface names. -===== Network proxy settings +==== Network proxy settings Configure the network's proxy settings. -===== Boot order +==== Boot order -On Raspberry Pi 4, you can specify whether to boot from USB or network if the SD card isn't inserted. For more information, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration]. +On Raspberry Pi 4 and later, specify whether to boot from USB or network when no SD card or SSD has been detected. For more information, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration]. -===== Bootloader version +==== Bootloader version -On the Raspberry Pi 4, you can tell the system to use the very latest boot ROM software, or revert to the factory default if the latest version causes problems. +On the Raspberry Pi 4 and later, switch to the latest boot ROM software. Alternatively, you can revert to the factory default if the latest version causes problems. -===== Wayland +==== Wayland -Use this option to switch between the X11 and Wayland backends. The Wayland backend was introduced in Bookworm, X11 was used in older versions of Raspberry Pi OS. +Switch between the X11 and Wayland backends, and choose a window manager. Since Raspberry Pi OS _Bookworm_, all Raspberry Pi models run Wayland using labwc by default. -===== Audio config +NOTE: To use Wayland on Raspberry Pi models prior to Raspberry Pi 4 running a version of Raspberry Pi OS earlier than _Bookworm_, add `wayland=on` to `/boot/firmware/cmdline.txt`. -Use this option to switch between the PulseAudio and PipeWire audio backends. The PipeWire backend was introduced in Bookworm. PulseAudio was used in older versions of Rasperry Pi OS. +==== Audio config +Switch between the PulseAudio and PipeWire audio backends. Prior to Raspberry Pi OS Bookworm, Raspberry Pi OS used PulseAudio. [[update]] -==== Update +=== Update Update this tool to the latest version. [[about]] -==== About raspi-config +=== About raspi-config -Selecting this option shows the following text: - ----- -This tool provides a straightforward way of doing initial configuration of the Raspberry Pi. -Although it can be run at any time, some of the options may have difficulties if you have heavily customised your installation. ----- +Display a description of `raspi-config`. [[finish]] -==== Finish +=== Finish -Use this option when you have completed your changes. You will be asked whether you want to reboot or not. When implementing changes for the first time, it's best to reboot. There will be a delay in rebooting if you have chosen to resize your SD card. +Exit `raspi-config`. If necessary, `raspi-config` will ask you to reboot when you exit. When implementing changes for the first time, reboot to ensure your changes take effect. [[raspi-config-cli]] -== The `raspi-config` Command Line Interface +== non-interactive `raspi-config` -The `raspi-config` tool can also be run in a non-interactive mode, which is useful for setting up a Raspberry Pi image for distribution. +The `raspi-config` tool also supports non-interactive options and flags that change options entirely on the command line with no visual component. Available options may differ between Raspberry Pi models. +[source,console] ---- -sudo raspi-config nonint +$ sudo raspi-config nonint [optional-argument] ---- -The `sudo` is required because you will be changing files that are not owned by the default user. - -NOTE: There is no consistent meaning for `0` and `1` in arguments. Each function will document what `0` and `1` mean for that particular function. +NOTE: The meaning of `0` and `1` varies between options. Always check the documentation before passing a value to an option. [[raspi-config-cli-commands]] -=== List of options - -NOTE: The `raspi-config` tool is under continuous development, and the list of options below may not be completely up to date. Please be aware that different models of Raspberry Pi may have different options available. -==== System options +=== System options -===== Wireless LAN +==== Wireless LAN -Allows setting of the wireless LAN SSID and passphrase. +Configure Wi-Fi SSID and passphrase. +[source,console] ---- -sudo raspi-config nonint do_wifi_ssid_passphrase [hidden] [plain] +$ sudo raspi-config nonint do_wifi_ssid_passphrase [hidden] [plain] ---- -Hidden: `0` = visible, `1` = hidden. Defaults to visible. +Pass a wireless network name (SSID) and passphrase, if required. The following flags are optional: + +The `` option indicates the visibility of the SSID. If the network broadcasts an open SSID, pass `0` or omit the option. If your SSID is hidden, pass `1`. Defaults to `0`. -Plain: If plain is `1` (the default), the passphrase is quoted. +The `` option indicates whether the given passphrase is wrapped in an extra set of quotation marks. Most users can ignore this option: as an implementation detail, `raspi-config` may need to add quotation marks before passing the passphrase to other parts of the system, and a `` value of `0` indicates that the quotation marks are already present. A value of `1` indicates that the quotation marks are not present, and the implementation should add them as necessary. Defaults to `1`. To pass this option, you must specify a value for ``. -Example: +For example, run the following commands to connect to a: +* non-hidden network named `myssid` with the passphrase `mypassphrase`: ++ +[source,console] ---- -sudo raspi-config nonint do_wifi_ssid_passphrase myssid mypassphrase -sudo raspi-config nonint do_wifi_ssid_passphrase myssid mypassphrase 1 # Hidden SSID -sudo raspi-config nonint do_wifi_ssid_passphrase myssid '"mypassphrase"' 0 0 # Visible SSID, passphrase quoted +$ sudo raspi-config nonint do_wifi_ssid_passphrase myssid mypassphrase ---- -===== Audio +* hidden network named `myssid` with the passphrase `mypassphrase`: ++ +[source,console] +---- +$ sudo raspi-config nonint do_wifi_ssid_passphrase myssid mypassphrase 1 +---- + +* non-hidden network named `myssid` with the passphrase `my passphrase`: ++ +[source,console] +---- +$ sudo raspi-config nonint do_wifi_ssid_passphrase myssid 'my passphrase' +---- + +* non-hidden network named `myssid` with the passphrase `mypassphrase`, where you have already added extra quotes to the passphrase: ++ +[source,console] +---- +$ sudo raspi-config nonint do_wifi_ssid_passphrase myssid '"mypassphrase"' 0 0 +---- + +==== Audio Specify the audio output destination. +[source,console] ---- -sudo raspi-config nonint do_audio +$ sudo raspi-config nonint do_audio ---- -====== Raspberry Pi 4B+ +On Raspberry Pi 4B, you can use the following options: -- `0` - bcm2835 Headphones -- `1` - vc4-hdmi-0 -- `2` - vc4-hdmi-1 +* `0`: bcm2835 headphone jack +* `1`: vc4-hdmi-0 +* `2`: vc4-hdmi-1 -NOTE: You may need to run the interactive version of `raspi-config` to determine the appropriate numbers to use with this option. +For a full list of possible `` values, see the numbers used in the interactive `raspi-config` version of this option. [[change-user-password-nonint]] -===== Password +==== Password -You can change the 'default' user password. +Change your password. -NOTE: Under old versions of Raspberry Pi OS, the default user was `pi` with the password `raspberry`. The default user is now set while configuring the OS image, or on first boot using a configuration wizard. +For more information, see xref:configuration.adoc#change-user-password[Change a user's password]. +[source,console] ---- -sudo raspi-config nonint do_change_pass +$ sudo raspi-config nonint do_change_pass ---- -NOTE: This does not check for the interactive flag, and will show full-screen messages. +NOTE: This function uses a full-screen interactive interface, even when run from a CLI option. [[hostname-nonint]] -===== Hostname +==== Hostname -Set the visible name for this Raspberry Pi on a network. +Set the visible xref:remote-access.adoc#resolve-raspberrypi-local-with-mdns[mDNS] name for this Raspberry Pi on a network. +[source,console] ---- -sudo raspi-config nonint do_hostname +$ sudo raspi-config nonint do_hostname ---- [[boot-options-nonint]] -===== Boot/auto login +==== Boot/Auto login + +Select the following behaviour at boot time: -Select whether to boot to console or desktop and whether you need to log in or not. +* whether to boot to console or desktop +* whether your Raspberry Pi automatically logs into your current user account when powered on +[source,console] ---- -sudo raspi-config nonint do_boot_behaviour +$ sudo raspi-config nonint do_boot_behaviour ---- -- `B1` - Boot to console, requiring login -- `B2` - Boot to console, logging in automatically -- `B3` - Boot to desktop, requiring login -- `B4` - Boot to desktop, logging in automatically +* `B1`: boot to console, requiring login +* `B2`: boot to console, logging in automatically +* `B3`: boot to desktop, requiring login +* `B4`: boot to desktop, logging in automatically -===== Network at boot +==== Network at boot -Use this option to wait for a network connection before letting boot proceed. +Wait for a network connection before letting boot proceed. +[source,console] ---- -sudo raspi-config nonint do_boot_wait <0/1> +$ sudo raspi-config nonint do_boot_wait <0/1> ---- -- `0` - Boot without waiting for network connection -- `1` - Boot after waiting for network connection +* `0`: boot without waiting for network connection +* `1`: boot after waiting for network connection -===== Splash screen +==== Splash screen Enable or disable the splash screen displayed at boot time. +[source,console] ---- -sudo raspi-config nonint do_boot_splash <0/1> +$ sudo raspi-config nonint do_boot_splash <0/1> ---- -- `0` - Enable splash screen -- `1` - Disable splash screen +* `0`: enable splash screen +* `1`: disable splash screen -===== Power LED +==== Power LED -If the model of Raspberry Pi permits it, you can change the behaviour of the power LED using this option. +If your Raspberry Pi model allows, change the behaviour of the power LED. +[source,console] ---- -sudo raspi-config nonint do_leds <0/1> +$ sudo raspi-config nonint do_leds <0/1> ---- -- `0` - Flash for disk activity -- `1` - Be on constantly +* `0`: flash for disk activity +* `1`: keep the power LED lit at all times -===== Browser +==== Browser Change the default web browser. Choosing a web browser that isn't currently installed won't work. +[source,console] ---- -sudo raspi-config nonint do_browser +$ sudo raspi-config nonint do_browser ---- -==== Display options +=== Display options [[underscan-nonint]] -===== Underscan +==== Underscan -If the initial text shown on the screen disappears off the edge, you need to enable overscan to bring the border back. On some displays, particularly monitors, disabling overscan will make the picture fill the whole screen and remove the black border. +NOTE: Unavailable when running Wayland. +If the initial text shown on the screen disappears off the edge, enable overscan to adjust the border. On some displays, particularly monitors, disabling overscan will make the picture fill the whole screen and remove the black border. + +[source,console] ---- -sudo raspi-config nonint do_overscan_kms +$ sudo raspi-config nonint do_overscan_kms ---- -Device: `1` = HDMI-1, `2` = HDMI-2 +Device: + +* `1`: HDMI-1 +* `2`: HDMI-2 + +Enabled: -Enabled: `0` = Enable overscan, `1` = Disable overscan +* `0`: enable overscan +* `1`: disable overscan -===== Screen blanking +==== Screen blanking Enable or disable screen blanking. +[source,console] ---- -sudo raspi-config nonint do_blanking <0/1> +$ sudo raspi-config nonint do_blanking <0/1> ---- -- `0` - Enable screen blanking -- `1` - Disable screen blanking +* `0`: enable screen blanking +* `1`: disable screen blanking [[resolution-nonint]] -===== VNC resolution +==== VNC resolution -Define the video resolution to use in xref:configuration.adoc#setting-up-a-headless-raspberry-pi[headless] setups. +Define the video resolution to use for VNC in xref:configuration.adoc#setting-up-a-headless-raspberry-pi[headless] setups. +[source,console] ---- -sudo raspi-config nonint do_vnc_resolution x +$ sudo raspi-config nonint do_vnc_resolution x ---- -===== Composite +==== Composite Enable or disable composite video output. -On Raspberry Pi 4, use: +On Raspberry Pi 4: +[source,console] ---- -sudo raspi-config nonint do_pi4video +$ sudo raspi-config nonint do_pi4video ---- -- `V1` - Enable 4Kp60 HDMI output -- `V2` - Enable composite video output -- `V3` - Disable 4Kp60 and composite output +* `V1`: enable 4Kp60 HDMI output +* `V2`: enable composite video output +* `V3`: disable 4Kp60 and composite output -On models prior to the Raspberry Pi 4, use: +On other models: +[source,console] ---- -sudo raspi-config nonint do_composite <0/1> +$ sudo raspi-config nonint do_composite <0/1> ---- -- `0` - Enable composite video -- `1` - Disable composite video +* `0`: enable composite video +* `1`: disable composite video [[interfacing-options-nonint]] -==== Interface options +=== Interface options [[ssh-nonint]] -===== SSH +==== SSH -Enable/disable remote command line access to your Raspberry Pi using SSH. +Enable or disable remote terminal access to your Raspberry Pi using SSH. -SSH allows you to remotely access the command line of the Raspberry Pi from another computer. SSH is disabled by default. Read more about using SSH on the xref:remote-access.adoc#ssh[SSH documentation page]. If connecting your Raspberry Pi directly to a public network, you should not enable SSH unless you have set up secure passwords for all users. +SSH allows you to remotely access the command line of the Raspberry Pi from another computer. For more information about SSH, see the xref:remote-access.adoc#ssh[SSH documentation]. +[source,console] ---- -sudo raspi-config nonint do_ssh <0/1> +$ sudo raspi-config nonint do_ssh <0/1> ---- -- `0` - Enable SSH -- `1` - Disable SSH +* `0`: enable SSH +* `1`: disable SSH + +[[rpi-connect-nonit]] +==== Raspberry Pi Connect + +Enable or disable xref:../services/connect.adoc[Raspberry Pi Connect], which provides the ability to access your Raspberry Pi remotely with no manual network configuration. + +[source,console] +---- +$ sudo raspi-config nonint do_rpi_connect <0/1> +---- + +* `0`: enable Raspberry Pi Connect +* `1`: disable Raspberry Pi Connect [[VNC-nonint]] -===== VNC +==== VNC -Enable/disable a virtual network computing server. +Enable or disable a Virtual Network Computing (VNC) server. For more information about VNC, see the xref:remote-access.adoc#vnc[VNC documentation]. +[source,console] ---- -sudo raspi-config nonint do_vnc <0/1> +$ sudo raspi-config nonint do_vnc <0/1> ---- -- `0` - Enable VNC -- `1` - Disable VNC +* `0`: enable VNC +* `1`: disable VNC [[spi-nonint]] -===== SPI +==== SPI -Enable/disable SPI interfaces and automatic loading of the SPI kernel module. +Enable or disable SPI interfaces and automatic loading of the SPI kernel module. +[source,console] ---- -sudo raspi-config nonint do_spi <0/1> +$ sudo raspi-config nonint do_spi <0/1> ---- -- `0` - Enable SPI -- `1` - Disable SPI +* `0`: enable SPI +* `1`: disable SPI [[i2c-nonint]] -===== I2C +==== I2C -Enable/disable I2C interfaces and automatic loading of the I2C kernel module. +Enable or disable I2C interfaces and automatic loading of the I2C kernel module. +[source,console] ---- -sudo raspi-config nonint do_i2c <0/1> +$ sudo raspi-config nonint do_i2c <0/1> ---- -- `0` - Enable I2C -- `1` - Disable I2C +* `0`: enable I2C +* `1`: disable I2C [[serial-nonint]] -===== Serial Port +==== Serial Port -Enable/disable the serial connection hardware. +Enable or disable the serial connection hardware. +[source,console] ---- -sudo raspi-config nonint do_serial_hw <0/1/2> +$ sudo raspi-config nonint do_serial_hw <0/1> ---- -- `0` - Enable serial port -- `1` - Disable serial port +* `0`: enable serial port +* `1`: disable serial port [[serial-console-nonint]] -===== Serial console +==== Serial console -Enable/disable shell and kernel messages on the serial connection. +Enable or disable shell and kernel messages on the serial connection. +[source,console] ---- -raspi-config nonint do_serial_cons <0/1/2> +$ sudo raspi-config nonint do_serial_cons <0/1> ---- -- `0` - Enable console over serial port -- `1` - Disable console over serial port +* `0`: enable console over serial port +* `1`: disable console over serial port [[one-wire-nonint]] -===== 1-wire +==== 1-wire -Enable/disable the Dallas 1-wire interface. This is usually used for DS18B20 temperature sensors. +Enable or disable the Dallas 1-wire interface. This is usually used for DS18B20 temperature sensors. +[source,console] ---- -sudo raspi-config nonint do_onewire <0/1> +$ sudo raspi-config nonint do_onewire <0/1> ---- -- `0` - Enable 1-wire -- `1` - Disable 1-wire +* `0`: enable 1-wire +* `1`: disable 1-wire -===== Remote GPIO +==== Remote GPIO Enable or disable remote access to the GPIO pins. +[source,console] ---- -sudo raspi-config nonint do_rgpio <0/1> +$ sudo raspi-config nonint do_rgpio <0/1> ---- -- `0` - Enable remote GPIO -- `1` - Disable remote GPIO +* `0`: enable remote GPIO +* `1`: disable remote GPIO -==== Performance options +=== Performance options [[overclock-nonint]] -===== Overclock +==== Overclock -On some models it is possible to overclock your Raspberry Pi's CPU using this tool. The overclocking you can achieve will vary, and overclocking too high may result in instability. Selecting this option shows the following warning: +If your Raspberry Pi model allows, overclock the CPU. Overclocking potential varies between individual Raspberry Pi devices, even within the same model. Overclocking too high may result in instability. -*Be aware that overclocking may reduce the lifetime of your Raspberry Pi.* If overclocking at a certain level causes system instability, try a more modest overclock. Hold down the Shift key during boot to temporarily disable overclocking. +WARNING: *Overclocking may reduce the lifetime of your Raspberry Pi.* If overclocking at a certain level causes system instability, try a more modest overclock. Hold down the *Shift* key during boot to temporarily disable overclocking. +[source,console] ---- -sudo raspi-config nonint do_overclock +$ sudo raspi-config nonint do_overclock ---- -Setting is one of: +This command accepts the following `` values: - - `None` - The default - - `Modest` - Overclock to 50% of the maximum - - `Medium` - Overclock to 75% of the maximum - - `High` - Overclock to 100% of the maximum - - `Turbo` - Overclock to 125% of the maximum +* `None`: no overclock (default) +* `Modest`: overclock to 50% of the maximum +* `Medium`: overclock to 75% of the maximum +* `High`: overclock to 100% of the maximum +* `Turbo`: overclock to 125% of the maximum [[memory-split-nonint]] -===== GPU memory +==== GPU memory Change the amount of memory made available to the GPU. +[source,console] ---- -sudo raspi-config nonint do_memory_split +$ sudo raspi-config nonint do_memory_split ---- -===== Overlay file system +==== Overlay file system Enable or disable a read-only filesystem. +[source,console] ---- -sudo raspi-config nonint do_overlayfs <0/1> +$ sudo raspi-config nonint do_overlayfs <0/1> ---- -- `0` - Enable overlay filesystem -- `1` - Disable overlay filesystem +* `0`: enable overlay filesystem +* `1`: disable overlay filesystem -===== Fan +==== Fan -Set the behaviour of a GPIO connected fan. +Customise the behaviour of the GPIO-connected https://www.raspberrypi.com/products/raspberry-pi-4-case-fan/[Raspberry Pi 4 Case Fan]. This setting is inapplicable to other fan models. +[source,console] ---- -sudo raspi-config nonint do_fan <0/1> [gpio] [onTemp] +$ sudo raspi-config nonint do_fan <0/1> [gpio] [onTemp] ---- -- `0` - Enable fan -- `1` - Disable fan +* `0`: enable fan +* `1`: disable fan `gpio` defaults to `14`. -`onTemp` defaults to `80` °C. +`onTemp` defaults to `80` **degrees Celsius**. [[localisation-options-nonint]] -==== Localisation options +=== Localisation options [[change-locale-nonint]] -===== Locale +==== Locale Select a locale, for example `en_GB.UTF-8 UTF-8`. +[source,console] ---- -sudo raspi-config nonint do_change_locale +$ sudo raspi-config nonint do_change_locale ---- +For a full list of possible `` values, see the abbreviations used in the interactive `raspi-config` version of this option. + [[change-timezone-nonint]] -===== Time zone +==== Time zone -Select your local time zone, starting with the region, e.g. Europe, then selecting a city, e.g. London. Type a letter to skip down the list to that point in the alphabet. +Set your local time zone in the format `Region/City`, for example 'Europe/London'. +[source,console] ---- -sudo raspi-config nonint do_change_timezone -sudo raspi-config nonint do_change_timezone America/Los_Angeles +$ sudo raspi-config nonint do_change_timezone ---- +For a full list of possible `` values, see the abbreviations used in the interactive `raspi-config` version of this option. + [[change-keyboard-layout-nonint]] -===== Keyboard +==== Keyboard -This option opens another menu which allows you to select your keyboard layout. Changes usually take effect immediately, but may require a reboot. +Set your keyboard layout. Changes usually take effect immediately, but may require a reboot. +[source,console] ---- -sudo raspi-config nonint do_configure_keyboard -sudo raspi-config nonint do_configure_keyboard us +$ sudo raspi-config nonint do_configure_keyboard ---- -===== WLAN country +For a full list of possible `` values, see the the abbreviations used in the interactive `raspi-config` version of this option. -This option sets the country code for your wireless network. +==== WLAN country +Set the country code for your wireless network. + +[source,console] ---- -sudo raspi-config nonint do_wifi_country -sudo raspi-config nonint do_wifi_country US +$ sudo raspi-config nonint do_wifi_country ---- +For a full list of possible `` values, see the abbreviations used in the interactive `raspi-config` version of this option. + [[advanced-options-nonint]] -==== Advanced options +=== Advanced options + + +WARNING: Changes to advanced options may prevent your Raspberry Pi from working as intended. Avoid configuring advanced options unless instructed by a Raspberry Pi engineer. [[expand-filesystem-nonint]] -===== Expand filesystem +==== Expand filesystem -This option will expand your installation to fill the whole SD card, giving you more space to use for files. You will need to reboot the Raspberry Pi to make this available. +Expand your OS partition to fill the whole storage device, giving you more space to use for files. Reboot the Raspberry Pi to complete this action. Normally, Raspberry Pi OS runs this action on first boot. This option can be useful if you clone your OS to a separate storage device with more capacity than the original. -WARNING: There is no confirmation step: selecting the option begins the partition expansion immediately. +WARNING: There is no confirmation step. Selecting the option begins the partition expansion immediately. +[source,console] ---- -sudo raspi-config nonint do_expand_rootfs +$ sudo raspi-config nonint do_expand_rootfs ---- -===== Network interface names +==== Network interface names Enable or disable predictable network interface names. +[source,console] ---- -sudo raspi-config nonint do_net_names <0/1> +$ sudo raspi-config nonint do_net_names <0/1> ---- -- `0` - Enable predictable network interface names -- `1` - Disable predictable network interface names +* `0`: enable predictable network interface names +* `1`: disable predictable network interface names -===== Network proxy settings +==== Network proxy settings Configure the network's proxy settings. +[source,console] ---- -sudo raspi-config nonint do_proxy
+$ sudo raspi-config nonint do_proxy
---- -===== Boot order +==== Boot order -On the Raspberry Pi 4 and 5, you can specify whether to boot from USB or network if the SD card isn't inserted. See the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] section for more information. +On the Raspberry Pi 4 and later, specify whether to boot from USB or network in absence of an SD card. See the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] section for more information. +[source,console] ---- -sudo raspi-config nonint do_boot_order +$ sudo raspi-config nonint do_boot_order ---- - - `B1` - SD card boot - boot from SD card if available, otherwise boot from USB - - `B2` - USB boot - boot from USB if available, otherwise boot from SD card - - `B3` - Network boot - boot from network if SD card boot fails +Depending on your device, you can choose from the following options: + +* `B1`: SD card boot - boot from SD card if available, otherwise boot from NVMe, otherwise boot from USB +* `B2`: NVMe/USB boot - boot from NVMe if available, otherwise boot from USB if available, otherwise boot from SD card +* `B3`: Network boot - boot from SD card _if inserted_, otherwise boot from network -===== Bootloader version +==== Bootloader version -On Raspberry Pi 4 and 5, you can tell the system to use the very latest boot ROM software, or revert to the factory default if the latest version causes problems. +On the Raspberry Pi 4 and later, switch to the latest boot ROM software. Alternatively, you can revert to the factory default if the latest version causes problems. +[source,console] ---- -sudo raspi-config nonint do_boot_rom +$ sudo raspi-config nonint do_boot_rom ---- -- `E1` - Use the latest boot ROM -- `E2` - Use the factory default +* `E1`: use the latest boot ROM +* `E2`: use the factory default + +==== Wayland -===== Wayland +Switch between the X11 and Wayland backends, and choose a window manager. Since Raspberry Pi OS _Bookworm_, all Raspberry Pi models run Wayland using the labwc window manager by default. -Use this option to switch between the X11 and Wayland backends. On the Raspberry Pi 4 and 5, Wayland is used by default; on other models of Raspberry Pi, X11 is used by default. +NOTE: To use Wayland on Raspberry Pi models prior to Raspberry Pi 4 running a version of Raspberry Pi OS earlier than _Bookworm_, add `wayland=on` to `/boot/firmware/cmdline.txt`. +[source,console] ---- -sudo raspi-config nonint do_wayland +$ sudo raspi-config nonint do_wayland ---- -- `W1` - Use the X11 backend -- `W2` - Use the Wayland backend +* `W1`: use the Openbox window manager with X11 backend +* `W2`: use the wayfire window manager with Wayland backend +* `W3`: use the labwc window manager with Wayland backend -===== Audio config +==== Audio config -Use this option to switch between the PulseAudio and PipeWire audio backends. +Use this option to switch between the PulseAudio and PipeWire audio backends. Prior to Raspberry Pi OS Bookworm, Raspberry Pi OS used PulseAudio. +[source,console] ---- -sudo raspi-config nonint do_audioconf <1/2> +$ sudo raspi-config nonint do_audioconf <1/2> ---- -- `1` - Use the PulseAudio backend -- `2` - Use the PipeWire backend +* `1`: use the PulseAudio backend +* `2`: use the PipeWire backend [[update-nonint]] -==== Update +=== Update Update this tool to the latest version. +[source,console] ---- -sudo raspi-config nonint do_update +$ sudo raspi-config nonint do_update ---- diff --git a/documentation/asciidoc/computers/configuration/screensaver.adoc b/documentation/asciidoc/computers/configuration/screensaver.adoc index 323060ba5..94dd1c19e 100644 --- a/documentation/asciidoc/computers/configuration/screensaver.adoc +++ b/documentation/asciidoc/computers/configuration/screensaver.adoc @@ -1,65 +1,156 @@ -== Configure screen blanking +== Screen blanking -You can configure your Raspberry Pi to blank the screen after a period of inactivity. By default, Raspberry Pi OS blanks the screen after ten minutes of inactivity when screen blanking is enabled. +You can configure your Raspberry Pi to blank the screen after a period of inactivity. When screen blanking is enabled, Raspberry Pi OS blanks the screen after ten minutes of inactivity by default. +How you manage screen blanking depends on your setup: + +* In the <>, you can configure screen blanking with graphical tools or from the command line. +* In <> (text-only without the desktop), screen blanking is controlled through kernel parameters. + +[[desktop]] === Desktop -You can control screen blanking using the *Screen Blanking* option in the Raspberry Pi Configuration menu. +When running Raspberry Pi OS using the desktop environment, you can control screen blanking through built-in configuration tools: the graphical menu (*Control Centre*) or the command-line interface (*CLI*). -==== Raspberry Pi Configuration +If you aren't running the desktop environment, you can manage screen blanking from the terminal interface on your Raspberry Pi. For instructions, see <>. -Click the Raspberry Pi button in the menu bar. Navigate to *Preferences* > *Raspberry Pi Configuration*. +==== Control Centre -image::images/pi-configuration.png[opening the Raspberry Pi Configuration menu from the desktop] +The *Control Centre* application allows you to turn screen blanking on or off without editing configuration files manually. -Select the *Display* tab. Toggle the *Screen Blanking* radio button into the on position. Press *OK* to confirm your selection. +1. Select the Raspberry Pi icon in the top-left corner of the menu bar. +2. Go to *Preferences > Control Centre*. ++ +image::images/pi-configuration.png[opening the Control Centre application from the desktop] +3. Open the *Display* tab in the *Control Centre* window. +4. Use the toggle to turn on *Screen Blanking*. +5. Select *Close* to confirm your selection. ++ +image::images/blanking.png[toggle Screen Blanking on in the Control Centre application] -image::images/blanking.png[toggle Screen Blanking on in the Raspberry Pi Configuration menu] +NOTE: In previous versions of Raspberry Pi OS, the Control Centre application was called Raspberry Pi Configuration. ==== CLI -You can enable and disable screen blanking with the `raspi-config` CLI tool. Run the following command to open the tool: +If you prefer using the terminal, use the `raspi-config` command-line tool to enable or disable screen blanking. This method is useful when working remotely over SSH or when you want quick access to system settings. ----- -sudo raspi-config ----- +1. Run the following command to open the tool: `sudo raspi-config`. +2. Navigate with the arrow keys and press **Enter** or **Return** to select `Display Options` *>* `Screen Blanking`. +3. Use the arrow keys on your keyboard to either: + - Choose `yes` to enable screen blanking. + - Choose `no` to disable screen blanking. -Use the arrow keys to navigate and the *Enter* key to select. Select `Display Options` > `Screen Blanking`. Choose `yes` with the arrow keys to enable screen blanking, or `no` to disable screen blanking. +[[console]] +=== Console -Alternatively, you can add or edit the following lines to `~/.config/wayfire.ini`: +You can control screen blanking in *console mode* using the `consoleblank` kernel parameter. ----- -[idle] -dpms_timeout=600 ----- +Unlike the screen blanking setting modified by the Control Centre and `raspi-config`, which only affects desktop sessions, the `consoleblank` parameter applies when your Raspberry Pi is running with a monitor and keyboard in a text-only terminal session. By setting `consoleblank` in the kernel command line, you can specify how long the console waits before turning off the screen. -The `dpms_timeout` variable controls the number of seconds of inactivity required before Raspberry Pi OS blanks your screen. For example, a value of `600` blanks the screen after 600 seconds, or ten minutes. Set the value to `0` to never blank the screen. +==== Set console mode screen blanking -=== Console +To change the console mode screen blanking configuration: -The `dpms_timeout` screen blanking configuration used by Raspberry Pi Configuration only affects desktop sessions. In *console mode*, when your Raspberry Pi is connected to a monitor and keyboard with only a terminal for input, use the `consoleblank` setting in the kernel command line. +1. Use the following command to open `/boot/firmware/cmdline.txt` in a text editor as an administrator: `sudo nano /boot/firmware/cmdline.txt`. +2. Set the number of seconds before Raspberry Pi OS blanks the console. All parameters must remain on a single line. You can: + * Set how many seconds of inactivity before the screen blanks. For example, adding `consoleblank=600` blanks the screen after 600 seconds of inactivity. + * Add `consoleblank=0` to never blank the screen. +3. Use the following command to reboot the Raspberry Pi: `sudo reboot`. This is a necessary precursor for the changes to take effect. -==== Set console mode screen blanking +After reboot, the console blanking timeout follows your new setting. + +==== View the current screen blanking setting -To change the console mode screen blanking configuration, open `/boot/firmware/cmdline.txt` in a text editor as an administrator: +You can display the current console blank time (in seconds) with the following command: +[source,console] ---- -sudo nano /boot/firmware/cmdline.txt +$ cat /sys/module/kernel/parameters/consoleblank ---- -You can adjust the number of seconds before Raspberry Pi OS blanks the console here. For instance, add `consoleblank=600` to disable display output after 600 seconds of inactivity. Set the value to `0` to never blank the screen. +== Custom fullscreen splash image + +You can configure your Raspberry Pi to display a fullscreen splash image during boot instead of the standard console log messages. + +[[file-reqs]] +=== File requirements + +The splash screen image must meet the following criteria: -Changes to `cmdline.txt` only take effect after a reboot. Use the following command to reboot your Raspberry Pi: +* *Maximum dimensions.* 1920 × 1080 pixels. + - If the image is smaller than the screen, the remaining area around your image is filled with a solid color taken from the top-left pixel of your image `(0, 0)`. + - Scaling isn't applied. If the screen is smaller than the image, the image is clipped and centred. +* *Maximum colours.* 224 unique colours. +* *Colour depth.* 24-bit (8 bits per channel, no alpha channel). +* *Format.* Uncompressed TGA. +You can use ImageMagick's `convert` command to convert an image to the TGA format expected by the kernel. For example, to convert `image.png` to a suitably-formatted `splash-image.tga` file: + +[source,console] ---- -sudo reboot +$ sudo apt install imagemagick +$ convert image.png -colors 224 -depth 8 -type TrueColor -alpha off -compress none -define tga:bits-per-sample=8 splash-image.tga ---- -==== View current screen blanking setting +=== Set up a fullscreen splash image + +There are two ways to enable a fullscreen splash image on your Raspberry Pi. Depending on your technical expertise, you can either: + +* <>.* This method is more straightforward, allowing you to enable the splash screen with minimal configuration. You install a pre-made package (`rpi-splash-screen-support`) that automates most of the setup. It copies your image, sets kernel parameters, and configures the system for you. +* <>.* This method is more technical, but gives you control over every step. You manually configure the splash image on the command line and then update your `initramfs` to contain the splash image. + +[[apt-package]] +==== Use the apt package -You can display the current console blank time in seconds with the following command: +Install the `rpi-splash-screen-support` package to simplify the set up of fullscreen splash images. The package provides the `configure-splash` tool, which sets the necessary kernel parameters and updates your `initramfs`. + +1. Install the package using the following command: ++ +[source,console] +---- +$ sudo apt install rpi-splash-screen-support +---- +2. After the apt package is installed, run the following command to configure your splash image, replacing `` with the name or path of the image file. This path can be relative or absolute: ++ +[source,console] +---- +$ sudo configure-splash +---- +3. Run the following command to reboot your Raspberry Pi and see the splash image: ++ +[source,console] +---- +$ sudo reboot +---- -[,bash] +If the image appears upside down when booting, edit the `convert` command in <> to add the `-flip` flag before the `splash-image.tga`. Then run `configure-splash` to update the image with the correct orientation. + +[[cli]] +==== Edit the `cmdline.txt` system file + +The following method requires editing system files and manually updating the `initramfs`. + +1. Use the following command to open `/boot/firmware/cmdline.txt` in a text editor as an administrator: `sudo nano /boot/firmware/cmdline.txt`. +2. Disable on-screen console messages to prevent boot messages from covering your splash image. Edit `cmdline.txt` to remove the following: + - `console=tty1`. + - `quiet` (if present). + - Any references to `plymouth`, such as `plymouth.ignore-serial-consoles`. +3. Edit `cmdline.txt` to add the following parameters: + - `fullscreen_logo_name=logo.tga fullscreen_logo=1` to enable fullscreen splash. + - `vt.global_cursor_default=0` to remove the flashing cursor in the splash image. ++ +Your entry should end with something like the following: ++ +[source] ---- -cat /sys/module/kernel/parameters/consoleblank +fullscreen_logo_name=logo.tga fullscreen_logo=1 vt.global_cursor_default=0 ---- +4. Place the image file in the correct location. + - The kernel expects the image file in `/lib/firmware`. + - The TGA file is read from the `initramfs` during boot. + - The filename must match fullscreen_logo_name in `cmdline.txt`. + +For example code for embedding TGA images in `initramfs`, see the https://github.com/raspberrypi/rpi-splash-screen-support/blob/master/configure-splash[Raspberry Pi splash screen support tool] in GitHub. + +NOTE: *Step 2* doesn't prevent `getty` from launching a login prompt. Your splash image appears during boot, but when the system is ready for login, the console takes over, and the splash disappears. `getty` clears the splash screen and writes the login prompt over it when the system is ready. + diff --git a/documentation/asciidoc/computers/configuration/securing-the-raspberry-pi.adoc b/documentation/asciidoc/computers/configuration/securing-the-raspberry-pi.adoc index b04ae3162..85a00c8d3 100644 --- a/documentation/asciidoc/computers/configuration/securing-the-raspberry-pi.adoc +++ b/documentation/asciidoc/computers/configuration/securing-the-raspberry-pi.adoc @@ -2,89 +2,20 @@ Here, we describe some common ways to improve the security of your Raspberry Pi. -=== Change a user's password - -You can change the password for the current user account via the `raspi-config` application on from the command line: - -[source,console] ----- -$ sudo raspi-config ----- - -Select option 2, and follow the instructions to change the password. - -Alternatively, use the `passwd` application: - -[source,console] ----- -$ passwd ----- - -=== Add a user - -To add a new user, enter the following command, replacing the `` placeholder with the username for the new user: - -[source,console] ----- -$ sudo adduser ----- - -When prompted, enter a password for the new user. - -You can find the home directory for the new user at `/home//`. - -To grant the new user necessary permissions, like `sudo`, run the following command to add the user to the associated user groups, replacing the `` placeholder with the username for the new user: - -[source,console] ----- -$ sudo usermod -a -G adm,dialout,cdrom,sudo,audio,video,plugdev,games,users,input,netdev,gpio,i2c,spi ----- - -To check that the permissions were successfully granted, run the following command, replacing the `` placeholder with the username for the new user: - -[source,console] ----- -$ sudo su - ----- - -If the above command runs successfully, permissions were successfully configured for the user. - -=== Delete a user - -To delete a user, run the following command, replacing the `` placeholder with the username you would like to delete: - -[source,console] ----- -$ sudo deluser -remove-home ----- - -This command deletes the user as well as their home directory. If you'd like to preserve the user's home directory, run the command without the `-remove-home` option. - -== Change the default user - -To change the user that automatically logs into your Raspberry Pi on boot, run the following command: - -[source,console] ----- -$ sudo raspi-config ----- - -Select option 1, S5 `Boot/Auto login`. Then say yes to reboot. - === Require a password for `sudo` commands -Placing `sudo` in front of a command runs it as a superuser. By default, that does not need a password. However, you can make your Raspberry Pi more secure by requiring a password for all commands run with `sudo`. +Prefixing a command with `sudo` runs it as a superuser. By default, that does not need a password. However, you can make your Raspberry Pi more secure by requiring a password for all commands run with `sudo`. -To force `sudo` to require a password, edit the `nopasswd` sudoers file for your user account, replacing the `` placeholder in the file name with your username: +To force `sudo` to require a password, edit the `010_pi-nopasswd` sudoers file: [source,console] ---- -$ sudo visudo /etc/sudoers.d/010_-nopasswd +$ sudo visudo /etc/sudoers.d/010_pi-nopasswd ---- Change the `` entry to the following, replacing `` with your username: -[source,console] +[source,bash] ---- ALL=(ALL) PASSWD: ALL ---- @@ -93,7 +24,9 @@ Save the file. Your new preference should take effect immediately. === Update Raspberry Pi OS -Only the latest OS distribution contains all the latest security fixes. Always keep your device xref:os.adoc#updating-and-upgrading-raspberry-pi-os[updated] to the latest version of Raspberry Pi OS. +Only the latest OS distribution contains all the latest security fixes. Always keep your device xref:os.adoc#update-software[updated] to the latest version of Raspberry Pi OS. + +=== Automatically update your SSH server If you use SSH to connect to your Raspberry Pi, it can be worthwhile to add a `cron` job that specifically updates the SSH server. The following command, perhaps run as a daily `cron` job, ensures you have the latest SSH security fixes promptly, independent of your normal update process. @@ -102,13 +35,13 @@ If you use SSH to connect to your Raspberry Pi, it can be worthwhile to add a `c $ apt install openssh-server ---- -=== Improving SSH security +=== Improve SSH security -SSH is a common way of accessing a Raspberry Pi remotely. By default, logging in with SSH requires a username/password pair. You can make this even more secure with key-based authentication. +SSH is a common way to remotely access a Raspberry Pi. By default, SSH requires a username and password. To make SSH even more secure, use xref:remote-access.adoc#configure-ssh-without-a-password[key-based authentication]. -==== Improving username/password security +==== Enable and disable SSH users -Always ensure you have a very robust password. You can also *allow* or *deny* specific users by altering the `sshd` configuration. +You can also *allow* or *deny* specific users by altering the `sshd` configuration. [source,console] ---- @@ -129,39 +62,14 @@ You can also use `DenyUsers` to specifically stop some usernames from logging in DenyUsers jane john ---- -After the change you will need to restart the `sshd` service using `sudo systemctl restart ssh` or reboot so the changes take effect. - -==== Using key-based authentication. - -Key pairs are two cryptographically secure keys. One is private, and one is public. They can be used to authenticate a client to an SSH server (in this case the Raspberry Pi). - -The client generates two keys, which are cryptographically linked to each other. The private key should never be released, but the public key can be freely shared. The SSH server takes a copy of the public key, and, when a link is requested, uses this key to send the client a challenge message, which the client will encrypt using the private key. If the server can use the public key to decrypt this message back to the original challenge message, then the identity of the client can be confirmed. - -Generating a key pair in Linux is done using the `ssh-keygen` command on the *client*; the keys are stored by default in the `.ssh` folder in the user's home directory. The private key will be called `id_rsa` and the associated public key will be called `id_rsa.pub`. The key will be 2048 bits long: breaking the encryption on a key of that length would take an extremely long time, so it is very secure. You can make longer keys if the situation demands it. Note that you should only do the generation process once: if repeated, it will overwrite any previous generated keys. Anything relying on those old keys will need to be updated to the new keys. - -You will be prompted for a passphrase during key generation: this offers an extra level of security. For the moment, leave this blank. - -The public key now needs to be xref:remote-access.adoc#copy-your-public-key-to-your-raspberry-pi[moved onto the server]. - -Finally, we need to disable password logins, so that all authentication is done by the key pairs. +After the change, restart the `sshd` service with the following command to put your changes into effect: [source,console] ---- -$ sudo nano /etc/ssh/sshd_config ----- - -There are three lines that need to be changed to `no`, if they are not set that way already: - -[,bash] ----- -ChallengeResponseAuthentication no -PasswordAuthentication no -UsePAM no +$ sudo systemctl restart ssh ---- -Save the file and either restart the ssh system with `sudo service ssh reload` or reboot. - -=== Install a firewall +=== Use a firewall There are many firewall solutions available for Linux. Most use the underlying http://www.netfilter.org/projects/iptables/index.html[iptables] project to provide packet filtering. This project sits over the Linux netfiltering system. By default, `iptables` is installed on Raspberry Pi OS, but is not set up. Setting it up can be a complicated task, and one project that offers a simpler interface than `iptables` is https://www.linux.com/learn/introduction-uncomplicated-firewall-ufw[Uncomplicated Firewall (UFW)]. This is the default firewall tool in Ubuntu, and can be installed on your Raspberry Pi: @@ -170,95 +78,101 @@ There are many firewall solutions available for Linux. Most use the underlying h $ sudo apt install ufw ---- -`ufw` is a fairly straightforward command-line tool, although there are some GUIs available for it. Note that `ufw` needs to be run with superuser privileges, so all commands are preceded with `sudo`. It is also possible to use the option `--dry-run` any `ufw` commands, which indicates the results of the command without actually making any changes. +`ufw` is a command-line tool, although there are some GUIs available for it. Note that `ufw` needs to be run with superuser privileges, so all commands are preceded with `sudo`. It is also possible to use the option `--dry-run` any `ufw` commands, which indicates the results of the command without actually making any changes. To enable the firewall, which will also ensure it starts up on boot, use: -[,bash] +[source,console] ---- -sudo ufw enable +$ sudo ufw enable ---- To disable the firewall, and disable start up on boot, use: -[,bash] +[source,console] ---- -sudo ufw disable +$ sudo ufw disable ---- Allow a particular port to have access (we have used port 22 in our example): -[,bash] +[source,console] ---- -sudo ufw allow 22 +$ sudo ufw allow 22 ---- Denying access on a port is also very simple (again, we have used port 22 as an example): -[,bash] +[source,console] ---- -sudo ufw deny 22 +$ sudo ufw deny 22 ---- -You can also specify which service you are allowing or denying on a port. In this example, we are denying tcp on port 22: +You can also specify which service you are allowing or denying on a port. In this example, we are denying TCP on port 22: -[,bash] +[source,console] ---- -sudo ufw deny 22/tcp +$ sudo ufw deny 22/tcp ---- You can specify the service even if you do not know which port it uses. This example allows the ssh service access through the firewall: -[,bash] +[source,console] ---- -sudo ufw allow ssh +$ sudo ufw allow ssh ---- The status command lists all current settings for the firewall: -[,bash] +[source,console] ---- -sudo ufw status +$ sudo ufw status ---- The rules can be quite complicated, allowing specific IP addresses to be blocked, specifying in which direction traffic is allowed, or limiting the number of attempts to connect (for example to help defeat a DDoS attack). You can also specify the device rules are to be applied to (e.g. eth0, wlan0). Please refer to the `ufw` man page (`man ufw`) for full details beyond the commands below. Limit login attempts on ssh port using TCP. This denies connection if an IP address has attempted to connect six or more times in the last 30 seconds: -[,bash] +[source,console] ---- -sudo ufw limit ssh/tcp +$ sudo ufw limit ssh/tcp ---- Deny access to port 30 from IP address 192.168.2.1 -[,bash] +[source,console] ---- -sudo ufw deny from 192.168.2.1 port 30 +$ sudo ufw deny from 192.168.2.1 port 30 ---- -=== Installing `fail2ban` +=== Block suspicious activity with `fail2ban` -If you are using your Raspberry Pi as some sort of server, for example an `ssh` or a webserver, your firewall will have deliberate 'holes' in it to let the server traffic through. In these cases, http://www.fail2ban.org[Fail2ban] can be useful. Fail2ban, written in Python, is a scanner that examines the log files produced by the Raspberry Pi, and checks them for suspicious activity. It catches things like multiple brute-force attempts to log in, and can inform any installed firewall to stop further login attempts from suspicious IP addresses. It saves you having to manually check log files for intrusion attempts and then update the firewall (via `iptables`) to prevent them. +When using a Raspberry Pi as a server, you must create deliberate holes in your firewall to allow server traffic. http://www.fail2ban.org[Fail2ban] can help secure your server. Fail2ban examines log files and checks for suspicious activity, like multiple brute-force login attempts. It saves you having to manually check log files for intrusion attempts and then update the firewall (via `iptables`) to prevent them. -Install `fail2ban` using the following command: +To install `fail2ban`, run the following command: [source,console] ---- $ sudo apt install fail2ban ---- -On installation, Fail2ban creates a folder `/etc/fail2ban` in which there is a configuration file called `jail.conf`. This needs to be copied to `jail.local` to enable it. Inside this configuration file are a set of default options, together with options for checking specific services for abnormalities. Do the following to examine/change the rules that are used for `ssh`: +On installation, Fail2ban creates `/etc/fail2ban/jail.conf`. To enable Fail2ban, copy `jail.conf` to `jail.local`: [source,console] ---- $ sudo cp /etc/fail2ban/jail.conf /etc/fail2ban/jail.local +---- + +Inside this configuration file are a set of default options, together with options for checking specific services for abnormalities. To examine the rules used for `ssh`, open `jail.local` in an editor: + +[source,console] +---- $ sudo nano /etc/fail2ban/jail.local ---- -Add the following section to the `jail.local` file. On some versions of fail2ban this section may already exist, so update this pre-existing section if it is there. +Create the `[ssh]` section if it does not already exist and add the following lines to the section: -[source,bash] +[source,ini] ---- [ssh] enabled = true @@ -268,9 +182,11 @@ backend = systemd maxretry = 6 ---- -As you can see, this section is named ssh, is enabled, examines the ssh port, filters using the `sshd` parameters, parses the system log for malicious activity, and allows six retries before the detection threshold is reached. Checking the default section, we can see that the default banning action is: +This enables Fail2ban checks for suspicious `ssh` activity, including system log checks, and allows six retries before blocking activity. -[source,bash] +The `[default]` section in this same file defines the default banning action, `iptables-multiport`, which runs the `/etc/fail2ban/action.d/iptables-multiport.conf` file when the detection threshold is reached: + +[source,ini] ---- # Default banning action (e.g. iptables, iptables-new, # iptables-multiport, shorewall, etc) It is used to define @@ -279,11 +195,11 @@ As you can see, this section is named ssh, is enabled, examines the ssh port, fi banaction = iptables-multiport ---- -`iptables-multiport` means that the Fail2ban system will run the `/etc/fail2ban/action.d/iptables-multiport.conf` file when the detection threshold is reached. There are a number of different action configuration files that can be used. Multiport bans all access on all ports. +Multiport bans all access on all ports. The `action.d` folder contains a number of alternative action configuration files you can use to customise your server's response to suspicious activity. -If you want to permanently ban an IP address after three failed attempts, you can change the maxretry value in the `[ssh]` section, and set the bantime to a negative number: +For instance, to permanently ban an IP address after three failed attempts, change the `maxretry` value in the `[ssh]` section to `3` and set the `bantime` to a negative number: -[source,bash] +[source,ini] ---- [ssh] enabled = true @@ -291,5 +207,5 @@ port = ssh filter = sshd backend = systemd maxretry = 3 -bantime = -1 +bantime = -1 ---- diff --git a/documentation/asciidoc/computers/configuration/uart.adoc b/documentation/asciidoc/computers/configuration/uart.adoc index 285878298..a6026e3d5 100644 --- a/documentation/asciidoc/computers/configuration/uart.adoc +++ b/documentation/asciidoc/computers/configuration/uart.adoc @@ -1,4 +1,4 @@ -== Configuring UARTs +== Configure UARTs There are two types of UART available on the Raspberry Pi - http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0183g/index.html[PL011] and mini UART. The PL011 is a capable, broadly 16550-compatible UART, while the mini UART has a reduced feature set. @@ -76,6 +76,7 @@ The first generation Compute Module, together with Compute Module 3 and Compute On all models of Compute Module, the UARTs are disabled by default and can be explicitly enabled using a Device Tree overlay. You may also specify which GPIO pins to use, for example: +[source,ini] ---- dtoverlay=uart1,txd1_pin=32,rxd1_pin=33 ---- @@ -157,7 +158,7 @@ On the Raspberry Pi 5, `/dev/serial0` is a symbolic link that points to `/dev/tt Due to changes in Bookworm, `/dev/serial1` does not exist by default. You can re-enable `serial1` by setting the following values in `config.txt`: -[source,bash] +[source,ini] ---- dtparam=krnbt=off ---- @@ -219,26 +220,30 @@ Although the Linux kernel starts the UARTs relatively early in the boot process, For Raspberry Pi 5, `earlycon` output only appears on the 3-pin debug connector with the following configuration: +[source,ini] ---- earlycon=pl011,0x107d001000,115200n8 ---- -For Raspberry Pi 4, 400 and Compute Module 4: +For Raspberry Pi 4, Compute Module 4, Compute Module 4S, and Pi 400: +[source,ini] ---- earlycon=uart8250,mmio32,0xfe215040 earlycon=pl011,mmio32,0xfe201000 ---- -For Raspberry Pi 2, Pi 3 and Compute Module 3: +For Raspberry Pi 2, 3, 3+, Zero 2 W, Compute Module 3, and Compute Module 3+: +[source,ini] ---- earlycon=uart8250,mmio32,0x3f215040 earlycon=pl011,mmio32,0x3f201000 ---- -For Raspberry Pi 1, Pi Zero and Compute Module 1: +For Raspberry Pi 1, Zero, Zero W, and Compute Module 1: +[source,ini] ---- earlycon=uart8250,mmio32,0x20215040 earlycon=pl011,mmio32,0x20201000 @@ -260,6 +265,7 @@ The overlays `uart2`, `uart3`, `uart4`, and `uart5` are used to enable the four You add a line to the `config.txt` file to apply a xref:configuration.adoc#device-trees-overlays-and-parameters[Device Tree overlay]. Note that the `-overlay.dts` part of the filename is removed. For example: +[source,ini] ---- dtoverlay=disable-bt ---- diff --git a/documentation/asciidoc/computers/configuration/use-a-proxy.adoc b/documentation/asciidoc/computers/configuration/use-a-proxy.adoc index 32b1f129b..56eced10d 100644 --- a/documentation/asciidoc/computers/configuration/use-a-proxy.adoc +++ b/documentation/asciidoc/computers/configuration/use-a-proxy.adoc @@ -1,79 +1,89 @@ -== Using a proxy server +== Use a proxy server -If you want your Raspberry Pi to access the internet via a proxy server (perhaps from a school or other workplace), you will need to configure your Raspberry Pi to use the server before you can get online. +A **proxy server** acts as an intermediary between a client device and the Internet. +To configure your Raspberry Pi as a proxy server client, follow the instructions in this section. You will need: -* The IP address or hostname and port of your proxy server -* A username and password for your proxy (if required) +* the IP address or hostname and port of your proxy server +* a username and password for your proxy (if required) -=== Configuring your Raspberry Pi +=== Configure your Raspberry Pi You will need to set up three environment variables (`http_proxy`, `https_proxy`, and `no_proxy`) so your Raspberry Pi knows how to access the proxy server. Open a terminal window, and open the file `/etc/environment` using nano: +[source,console] ---- -sudo nano /etc/environment +$ sudo nano /etc/environment ---- Add the following to the `/etc/environment` file to create the `http_proxy` variable: +[source,bash] ---- -export http_proxy="http://proxyipaddress:proxyport" +export http_proxy="http://:" ---- -Replace `proxyipaddress` and `proxyport` with the IP address and port of your proxy. +Replace the `` and `` placeholders with the IP address and port of your proxy. -NOTE: If your proxy requires a username and password, add them using the following format: +[NOTE] +==== +If your proxy requires a username and password, add them using the following format: +[source,bash] ---- -export http_proxy="http://username:password@proxyipaddress:proxyport" +export http_proxy="http://:@proxyipaddress:proxyport" ---- +Replace the `` and `` placeholders with the username and password you use to authenticate with your proxy. +==== + Enter the same information for the environment variable `https_proxy`: +[source,bash] ---- export https_proxy="http://username:password@proxyipaddress:proxyport" ---- Create the `no_proxy` environment variable, which is a comma-separated list of addresses your Raspberry Pi should not use the proxy for: +[source,bash] ---- export no_proxy="localhost, 127.0.0.1" ---- -Your `/etc/environment` file should now look like this: +Your `/etc/environment` file should now look like the following: +[source,bash] ---- export http_proxy="http://username:password@proxyipaddress:proxyport" export https_proxy="http://username:password@proxyipaddress:proxyport" export no_proxy="localhost, 127.0.0.1" ---- -image::images/proxy-environment-variables.png[environment variables] - -Press ++++++Ctrl + X++++++ to save and exit. +Press **Ctrl + X** to save and exit. === Update the `sudoers` file -In order for operations that run as `sudo` (e.g. downloading and installing software) to use the new environment variables, you'll need to update `sudoers`. +To use the proxy environment variables with operations that run as `sudo`, such as downloading and installing software, update `sudoers`. Use the following command to open `sudoers`: +[source,console] ---- -sudo visudo +$ sudo visudo ---- Add the following line to the file so `sudo` will use the environment variables you just created: +[source,bash] ---- Defaults env_keep+="http_proxy https_proxy no_proxy" ---- -image::images/proxy-edit-sudoers.png[edit sudoers] - -Press ++++++Ctrl + X++++++ to save and exit. +Press **Ctrl + X** to save and exit. === Reboot your Raspberry Pi diff --git a/documentation/asciidoc/computers/configuration/users.adoc b/documentation/asciidoc/computers/configuration/users.adoc new file mode 100644 index 000000000..7818bd182 --- /dev/null +++ b/documentation/asciidoc/computers/configuration/users.adoc @@ -0,0 +1,78 @@ +== Users + +[[change-user-password]] +=== Change a user's password + +You can change the password for the current user account via the `raspi-config` application on from the command line: + +[source,console] +---- +$ sudo raspi-config +---- + +Select option 2, and follow the instructions to change the password. + +Alternatively, use the `passwd` application: + +[source,console] +---- +$ passwd +---- + +=== Add a user + +To add a new user, enter the following command, replacing the `` placeholder with the username for the new user: + +[source,console] +---- +$ sudo adduser +---- + +When prompted, enter a password for the new user. + +You can find the home directory for the new user at `/home//`. + +To grant the new user necessary permissions, like `sudo`, run the following command to add the user to the associated user groups, replacing the `` placeholder with the username for the new user: + +[source,console] +---- +$ sudo usermod -a -G adm,dialout,cdrom,sudo,audio,video,plugdev,games,users,input,render,netdev,lpadmin,gpio,i2c,spi +---- + +To check that the permissions were successfully granted, run the following command, replacing the `` placeholder with the username for the new user: + +[source,console] +---- +$ sudo su - +---- + +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 `` placeholder with the username you would like to delete: + +[source,console] +---- +$ sudo deluser -remove-home +---- + +This command deletes the user as well as their home directory. If you'd like to preserve the user's home directory, run the command without the `-remove-home` option. + +=== Change the default user + +To change the user that automatically logs into your Raspberry Pi on boot, run the following command: + +[source,console] +---- +$ sudo raspi-config +---- + +Select option `1`, `Boot/Auto login`. Reboot to put your changes into effect. diff --git a/documentation/asciidoc/computers/getting-started/configuring.adoc b/documentation/asciidoc/computers/getting-started/configuring.adoc index 3fb833787..49d7f7d0e 100644 --- a/documentation/asciidoc/computers/getting-started/configuring.adoc +++ b/documentation/asciidoc/computers/getting-started/configuring.adoc @@ -6,11 +6,11 @@ First, unplug your Raspberry Pi's power supply to ensure that the Raspberry Pi i If you installed the operating system on a microSD card, you can plug it into your Raspberry Pi's card slot now. If you installed the operating system on any other storage device, you can connect it to your Raspberry Pi now. -image::images/peripherals/sd-card.png[alt="Inserting a microSD card into a Raspberry Pi."] +image::images/peripherals/sd-card.png[alt="Inserting a microSD card into a Raspberry Pi.",width="80%"] Then, plug in any other peripherals, such as your mouse, keyboard, and monitor. -image::images/peripherals/cable-all.png[alt="Attaching the power supply to a Raspberry Pi."] +image::images/peripherals/cable-all.png[alt="Attaching the power supply to a Raspberry Pi.",width="80%"] Finally, connect the power supply to your Raspberry Pi. You should see the status LED light up when your Pi powers on. If your Pi is connected to a display, you should see the boot screen within minutes. @@ -26,7 +26,7 @@ If your Raspberry Pi does not boot within 5 minutes, check the status LED. If it If you chose to skip OS customisation in Imager, your Raspberry Pi will run a configuration wizard on first boot. You need a monitor and keyboard to navigate through the wizard; a mouse is optional. -image::images/initial-setup/start.png[alt="Click Next to get started with configuration."] +image::images/initial-setup/start.png[alt="Click Next to get started with configuration.",width="80%"] === Bluetooth @@ -38,7 +38,7 @@ This process works with built-in or external USB Bluetooth adapters. If you use This page helps you configure your country, language, and time zone, and keyboard layout. -image::images/initial-setup/locale.png[alt="Adjust country, language, time zone, and keyboard layout."] +image::images/initial-setup/locale.png[alt="Adjust country, language, time zone, and keyboard layout.",width="80%"] === User @@ -46,31 +46,39 @@ This page helps you configure the username and password for the default user acc By default, older versions of Raspberry Pi OS set the username to "pi". If you use the username "pi", avoid the old default password of "raspberry" to keep your Raspberry Pi secure. -image::images/initial-setup/user.png[alt="Create your username and password."] +image::images/initial-setup/user.png[alt="Create your username and password.",width="80%"] -=== WiFi +=== Wi-Fi -This page helps you connect to a WiFi network. Choose your preferred network from the list. +This page helps you connect to a Wi-Fi network. Choose your preferred network from the list. -image::images/initial-setup/network.png[alt="Selecting a wireless network."] +image::images/initial-setup/network.png[alt="Selecting a wireless network.",width="80%"] If your network requires a password, you can enter it here. -image::images/initial-setup/network_password.png[alt="Entering a password for a wireless network."] +image::images/initial-setup/network_password.png[alt="Entering a password for a wireless network.",width="80%"] === Browser This page lets you select Firefox or Chromium as your default internet browser. You can optionally uninstall the browser you don't set as default. -image::images/initial-setup/browser.png[alt="The Choose Browser page."] +image::images/initial-setup/browser.png[alt="The Choose Browser page.",width="80%"] + +=== Raspberry Pi Connect + +This page lets you enable xref:../services/connect.adoc[Raspberry Pi Connect], which provides the ability to access your Raspberry Pi remotely with no manual network configuration. + +image::images/initial-setup/connect.png[alt="The Enable Raspberry Pi Connect page.",width="80%"] === Software updates Once your Raspberry Pi has internet access, this page helps you update your operating system and software to the latest versions. During the software update process, the wizard will remove the non-default browser if you opted to uninstall it in the browser selection step. Downloading updates may take several minutes. -image::images/initial-setup/update.png[alt="You can download the latest software updates during the wizard before you boot for the first time."] +NOTE: If you are updating your Raspberry Pi 500+ for the first time, this can take up to half an hour. Grab a cup of coffee or go for a walk while you wait. + +image::images/initial-setup/update.png[alt="You can download the latest software updates during the wizard before you boot for the first time.",width="80%"] -image::images/initial-setup/download.png[alt="You can download the latest software updates during the wizard before you boot for the first time."] +image::images/initial-setup/download.png[alt="You can download the latest software updates during the wizard before you boot for the first time.",width="80%"] When you see a popup indicating that your system is up to date, click **OK** to proceed to the next step. @@ -78,4 +86,4 @@ When you see a popup indicating that your system is up to date, click **OK** to At the end of the configuration wizard, click **Restart** to reboot your Raspberry Pi. Your Raspberry Pi will apply your configuration and boot to the desktop. -image::images/initial-setup/restart.png[alt="The Setup Complete dialogue prompts to restart your Raspberry Pi."] +image::images/initial-setup/restart.png[alt="The Setup Complete dialogue prompts to restart your Raspberry Pi.",width="80%"] diff --git a/documentation/asciidoc/computers/getting-started/images/initial-setup/connect.png b/documentation/asciidoc/computers/getting-started/images/initial-setup/connect.png new file mode 100644 index 000000000..8f0044d83 Binary files /dev/null and b/documentation/asciidoc/computers/getting-started/images/initial-setup/connect.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-all.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-all.png index 1619e20df..03c0124f2 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-all.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-all.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-hdmi.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-hdmi.png index e5dd0d949..62ebf3713 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-hdmi.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-hdmi.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-key.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-key.png index 919b922c0..4f277513e 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-key.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-key.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-mouse.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-mouse.png index 4a9c8e7e6..a00b9e869 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-mouse.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-mouse.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-net.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-net.png index 7000de9cd..4cf13f939 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-net.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-net.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-power.png b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-power.png index 69d133ab9..44e4b032a 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/cable-power.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/cable-power.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/peripherals/sd-card.png b/documentation/asciidoc/computers/getting-started/images/peripherals/sd-card.png index 5aeb831e7..9ea290c67 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/peripherals/sd-card.png and b/documentation/asciidoc/computers/getting-started/images/peripherals/sd-card.png differ diff --git a/documentation/asciidoc/computers/getting-started/images/recommended-software.png b/documentation/asciidoc/computers/getting-started/images/recommended-software.png index 11eb335ed..ea58679d4 100644 Binary files a/documentation/asciidoc/computers/getting-started/images/recommended-software.png and b/documentation/asciidoc/computers/getting-started/images/recommended-software.png differ diff --git a/documentation/asciidoc/computers/getting-started/install.adoc b/documentation/asciidoc/computers/getting-started/install.adoc index f4719d652..534417311 100644 --- a/documentation/asciidoc/computers/getting-started/install.adoc +++ b/documentation/asciidoc/computers/getting-started/install.adoc @@ -24,7 +24,7 @@ If you have no other computer to write an image to a boot device, you may be abl === Install using Imager //// -TODO: Update this video for the new Imager look & flow (video::ntaXWS8Lk34[youtube]) +TODO: Update this video for the new Imager look & flow (video::ntaXWS8Lk34[youtube,width=80%,height=400px]) //// You can install Imager in the following ways: @@ -34,25 +34,25 @@ You can install Imager in the following ways: Once you've installed Imager, launch the application by clicking the Raspberry Pi Imager icon or running `rpi-imager`. -image::images/imager/welcome.png[alt="Raspberry Pi Imager main window."] +image::images/imager/welcome.png[alt="Raspberry Pi Imager main window.",width="80%"] Click **Choose device** and select your Raspberry Pi model from the list. -image::images/imager/choose-model.png[alt="Raspberry Pi model selections in Imager."] +image::images/imager/choose-model.png[alt="Raspberry Pi model selections in Imager.",width="80%"] Next, click **Choose OS** and select an operating system to install. Imager always shows the recommended version of Raspberry Pi OS for your model at the top of the list. -image::images/imager/choose-os.png[alt="Operating system selections in Imager."] +image::images/imager/choose-os.png[alt="Operating system selections in Imager.",width="80%"] Connect your preferred storage device to your computer. For example, plug a microSD card in using an external or built-in SD card reader. Then, click **Choose storage** and select your storage device. WARNING: If you have more than one storage device connected to your computer, _be sure to choose the correct device!_ You can often identify storage devices by size. If you're unsure, disconnect other devices until you've identified the device you want to image. -image::images/imager/choose-storage.png[alt="Storage selection options in Imager."] +image::images/imager/choose-storage.png[alt="Storage selection options in Imager.",width="80%"] Next, click **Next**. -image::images/imager/os-customisation-prompt.png[alt="Imager prompt to open OS customisation menu."] +image::images/imager/os-customisation-prompt.png[alt="Imager prompt to open OS customisation menu.",width="80%"] In a popup, Imager will ask you to apply OS customisation. We strongly recommend configuring your Raspberry Pi via the OS customisation settings. Click the **Edit Settings** button to open xref:getting-started.adoc#advanced-options[OS customisation]. @@ -64,23 +64,23 @@ If you don't configure your Raspberry Pi via OS customisation settings, Raspberr The OS customisation menu lets you set up your Raspberry Pi before first boot. You can preconfigure: * a username and password -* WiFi credentials +* Wi-Fi credentials * the device hostname * the time zone * your keyboard layout * remote connectivity -When you first open the OS customisation menu, you might see a prompt asking for permission to load WiFi credentials from your host computer. If you respond "yes", Imager will prefill WiFi credentials from the network you're currently connected to. If you respond "no", you can enter WiFi credentials manually. +When you first open the OS customisation menu, you might see a prompt asking for permission to load Wi-Fi credentials from your host computer. If you respond "yes", Imager will prefill Wi-Fi credentials from the network you're currently connected to. If you respond "no", you can enter Wi-Fi credentials manually. The **hostname** option defines the hostname your Raspberry Pi broadcasts to the network using https://en.wikipedia.org/wiki/Multicast_DNS[mDNS]. When you connect your Raspberry Pi to your network, other devices on the network can communicate with your computer using `.local` or `.lan`. The **username and password** option defines the username and password of the admin user account on your Raspberry Pi. -The **wireless LAN** option allows you to enter an SSID (name) and password for your wireless network. If your network does not broadcast an SSID publicly, you should enable the "Hidden SSID" setting. By default, Imager uses the country you're currently in as the "Wireless LAN country". This setting controls the WiFi broadcast frequencies used by your Raspberry Pi. Enter credentials for the wireless LAN option if you plan to run a headless Raspberry Pi. +The **wireless LAN** option allows you to enter an SSID (name) and password for your wireless network. If your network does not broadcast an SSID publicly, you should enable the "Hidden SSID" setting. By default, Imager uses the country you're currently in as the "Wireless LAN country". This setting controls the Wi-Fi broadcast frequencies used by your Raspberry Pi. Enter credentials for the wireless LAN option if you plan to run a headless Raspberry Pi. The **locale settings** option allows you to define the time zone and default keyboard layout for your Pi. -image::images/imager/os-customisation-general.png[alt="General settings in the OS customisation menu."] +image::images/imager/os-customisation-general.png[alt="General settings in the OS customisation menu.",width="80%"] The **Services** tab includes settings to help you connect to your Raspberry Pi remotely. @@ -90,11 +90,11 @@ If you plan to use your Raspberry Pi remotely over your network, check the box n * Choose **Allow public-key authentication only** to preconfigure your Raspberry Pi for passwordless public-key SSH authentication using a private key from the computer you're currently using. If already have an RSA key in your SSH configuration, Imager uses that public key. If you don't, you can click **Run SSH-keygen** to generate a public/private key pair. Imager will use the newly-generated public key. -image::images/imager/os-customisation-services.png[alt="Services settings in the OS customisation menu."] +image::images/imager/os-customisation-services.png[alt="Services settings in the OS customisation menu.",width="80%"] OS customisation also includes an **Options** menu that allows you to configure the behaviour of Imager during a write. These options allow you to play a noise when Imager finishes verifying an image, to automatically unmount storage media after verification, and to disable telemetry. -image::images/imager/os-customisation-options.png[alt="Options in the OS customisation menu."] +image::images/imager/os-customisation-options.png[alt="Options in the OS customisation menu.",width="80%"] ==== Write @@ -104,19 +104,19 @@ Then, click **Yes** to apply OS customisation settings when you write the image Finally, respond **Yes** to the "Are you sure you want to continue?" popup to begin writing data to the storage device. -image::images/imager/are-you-sure.png[alt="Confirming a reimage of a storage device in Imager."] +image::images/imager/are-you-sure.png[alt="Confirming a reimage of a storage device in Imager.",width="80%"] If you see an admin prompt asking for permissions to read and write to your storage medium, grant Imager the permissions to proceed. .Grab a cup of coffee or go for a walk. This could take a few minutes. -image::images/imager/writing.png[alt="Writing an image to a device in Imager."] +image::images/imager/writing.png[alt="Writing an image to a device in Imager.",width="80%"] .If you want to live especially dangerously, you can click **cancel verify** to skip the verification process. -image::images/imager/stop-ask-verify.png[alt="Verifying an image on a device in Imager."] +image::images/imager/stop-ask-verify.png[alt="Verifying an image on a device in Imager.",width="80%"] When you see the "Write Successful" popup, your image has been completely written and verified. You're now ready to boot a Raspberry Pi from the storage device! -image::images/imager/finished.png[alt="The screen Imager shows when it finishes writing an image to a storage device."] +image::images/imager/finished.png[alt="The screen Imager shows when it finishes writing an image to a storage device.",width="80%"] Next, proceed to the xref:getting-started.adoc#configuration-on-first-boot[first boot configuration instructions] to get your Raspberry Pi up and running. @@ -124,12 +124,10 @@ Next, proceed to the xref:getting-started.adoc#configuration-on-first-boot[first Network Install enables a Raspberry Pi to install an operating system on a storage device using a version of Raspberry Pi Imager downloaded over the network. With Network Install, you can get an operating system installed on your Raspberry Pi with no separate SD card reader and no computer other than your Raspberry Pi. You can run Network Install on any compatible storage device, including SD cards and USB storage. -Network Install only runs on Raspberry Pi 4, 400. If your Raspberry Pi runs an older bootloader, you may need to xref:raspberry-pi.adoc#bootloader_update_stable[update the bootloader] to use Network Install. - -IMPORTANT: Currently, Network Install is not available on Raspberry Pi 5. Support will be added in a future bootloader update. +Network Install only runs on Flagship models since Raspberry Pi 4B and Keyboard models. If your Raspberry Pi runs an older bootloader, you may need to xref:raspberry-pi.adoc#bootloader_update_stable[update the bootloader] to use Network Install. //// -TODO: Update this video for the new Imager look & flow video::b1SYVpM9lto[youtube] +TODO: Update this video for the new Imager look & flow video::b1SYVpM9lto[youtube,width=80%,height=400px] //// Network Install requires the following: @@ -145,18 +143,18 @@ To launch Network Install, power on your Raspberry Pi _while pressing and holdin * attached keyboard * attached compatible storage device, such as an SD card or USB storage -image::images/network-install-1.png[alt="The Network Install screen."] +image::images/network-install-1.png[alt="The Network Install screen.",width="80%"] If you haven't already connected your Raspberry Pi to the internet, connect it with an Ethernet cable. -image::images/network-install-2.png[alt="Starting Network Install."] +image::images/network-install-2.png[alt="Starting Network Install.",width="80%"] Once you're connected to the internet, your Raspberry Pi will download Raspberry Pi installer. If the download fails, you can repeat the process to try again. -image::images/network-install-3.png[alt="Downloading Imager using Network Install."] +image::images/network-install-3.png[alt="Downloading Imager using Network Install.",width="80%"] Once you finish downloading Raspberry Pi Installer, your Raspberry Pi will automatically start Raspberry Pi Imager. For more information about running Raspberry Pi Imager, see xref:getting-started.adoc#installing-the-operating-system[install an operating system]. -image::images/network-install-4.png[alt="Choose a storage device."] +image::images/network-install-4.png[alt="Choose a storage device.",width="80%"] For more information about Network Install configuration, see xref:raspberry-pi.adoc#http-boot[HTTP boot]. diff --git a/documentation/asciidoc/computers/getting-started/setting-up.adoc b/documentation/asciidoc/computers/getting-started/setting-up.adoc index d917017e4..818217aac 100644 --- a/documentation/asciidoc/computers/getting-started/setting-up.adoc +++ b/documentation/asciidoc/computers/getting-started/setting-up.adoc @@ -1,7 +1,7 @@ [[setting-up-your-raspberry-pi]] == Getting started with your Raspberry Pi -video::CQtliTJ41ZE[youtube] +video::CQtliTJ41ZE[youtube,width=80%,height=400px] To get started with your Raspberry Pi, you'll need the following: @@ -26,11 +26,15 @@ You can use any high-quality power supply that provides the correct power mode. |Recommended power supply (voltage/current) |Raspberry Pi power supply -|Raspberry Pi 5 +|Raspberry Pi 500+ +|5V/5A +|https://www.raspberrypi.com/products/27w-power-supply/[27W USB-C power supply] + +|Raspberry Pi 5 and Raspberry Pi 500 |5V/5A, 5V/3A limits peripherals to 600mA |https://www.raspberrypi.com/products/27w-power-supply/[27W USB-C power supply] -|Raspberry Pi 4 Model B +|Raspberry Pi 4 Model B and Raspberry Pi 400 |5V/3A |https://www.raspberrypi.com/products/type-c-power-supply/[15W USB-C power supply] @@ -38,7 +42,7 @@ You can use any high-quality power supply that provides the correct power mode. |5V/2.5A |https://www.raspberrypi.com/products/micro-usb-power-supply/[12.5W Micro USB power supply] -|Raspberry Pi 2 (all models) +|Raspberry Pi 2 Model B |5V/2.5A |https://www.raspberrypi.com/products/micro-usb-power-supply/[12.5W Micro USB power supply] @@ -51,18 +55,18 @@ You can use any high-quality power supply that provides the correct power mode. |https://www.raspberrypi.com/products/micro-usb-power-supply/[12.5W Micro USB power supply] |=== -image::images/peripherals/cable-power.png[alt="Plugging a power supply into a Raspberry Pi."] +image::images/peripherals/cable-power.png[alt="Plugging a power supply into a Raspberry Pi.",width="80%"] Plug your power supply into the port marked "POWER IN", "PWR IN", or "PWR". Some Raspberry Pi models, such as the Zero series, have output USB ports with the same form factor as the power port. Be sure to use the correct port on your Raspberry Pi! [[sd-cards]] -=== Boot Media +=== Boot media Raspberry Pi models lack onboard storage, so you have to supply it. You can boot your Raspberry Pi from an operating system image installed on any supported media: microSD cards are used commonly, but USB storage, network storage, and storage connected via a PCIe HAT are also available. However, only recent Raspberry Pi models support all of these media types. All Raspberry Pi consumer models since the Raspberry Pi 1 Model A+ feature a microSD slot. Your Raspberry Pi automatically boots from the microSD slot when the slot contains a card. -image::images/peripherals/sd-card.png[alt="Inserting a microSD card into a Raspberry Pi."] +image::images/peripherals/sd-card.png[alt="Inserting a microSD card into a Raspberry Pi.",width="80%"] ==== Recommended SD cards @@ -70,6 +74,8 @@ image::images/peripherals/sd-card.png[alt="Inserting a microSD card into a Raspb We recommend using an SD card with at least 32GB of storage for Raspberry Pi OS installations. For Raspberry Pi OS Lite, we recommend at least 16GB. You can use any SD card with a capacity of less than 2TB. Capacities above 2TB are currently not supported due to limitations in the https://en.wikipedia.org/wiki/Master_boot_record[MBR]. As with any other boot media, you'll see improved performance on SD cards with faster read and write speeds. +If you're unsure which SD card to buy, consider xref:../accessories/sd-cards.adoc[Raspberry Pi's official SD cards]. + Because of a hardware limitation, the following devices will only boot from a boot partition of 256GB or less: * Raspberry Pi Zero @@ -82,18 +88,16 @@ Other operating systems have different requirements. Check the documentation for You can use any of the USB ports on your Raspberry Pi to connect a https://www.raspberrypi.com/products/raspberry-pi-keyboard-and-hub/[wired keyboard] or USB Bluetooth receiver. -image:images/peripherals/cable-key.png[alt="Plugging a keyboard into a Raspberry Pi."] +image:images/peripherals/cable-key.png[alt="Plugging a keyboard into a Raspberry Pi.",width="80%"] === Mouse You can use any of the USB ports on your Raspberry Pi to connect a https://www.raspberrypi.com/products/raspberry-pi-mouse/[wired mouse] or USB Bluetooth receiver. -image:images/peripherals/cable-mouse.png[alt="Plugging a mouse into a Raspberry Pi."] +image:images/peripherals/cable-mouse.png[alt="Plugging a mouse into a Raspberry Pi.",width="80%"] === Display -If your Raspberry Pi has more than one HDMI port, plug your primary monitor into the port marked `HDMI0`. - Raspberry Pi models have the following display connectivity: [%header,cols="1,1"] @@ -101,31 +105,32 @@ Raspberry Pi models have the following display connectivity: |Model |Display outputs -|Raspberry Pi 5 +|Raspberry Pi 5, Raspberry Pi 400, Raspberry Pi 500, and Raspberry Pi 500+ |2× micro HDMI -|Raspberry Pi 4 (all models) +|Raspberry Pi 4 Model B |2× micro HDMI, audio and composite out via 3.5mm http://en.wikipedia.org/wiki/Phone_connector_(audio)#TRRS_standards[TRRS] jack |Raspberry Pi 3 (all models) |HDMI, audio and composite out via 3.5mm http://en.wikipedia.org/wiki/Phone_connector_(audio)#TRRS_standards[TRRS] jack -|Raspberry Pi 2 (all models) +|Raspberry Pi 2 Model B |HDMI, audio and composite out via 3.5mm http://en.wikipedia.org/wiki/Phone_connector_(audio)#TRRS_standards[TRRS] jack -|Raspberry Pi 1 Model B+ +|Raspberry Pi 1 (all models) |HDMI, audio and composite out via 3.5mm http://en.wikipedia.org/wiki/Phone_connector_(audio)#TRRS_standards[TRRS] jack -|Raspberry Pi 1 Model A+ -|HDMI, RCA connector - |Raspberry Pi Zero (all models) |mini HDMI |=== +NOTE: No Raspberry Pi models support video over USB-C (DisplayPort alt mode). + +If your Raspberry Pi has more than one HDMI port, plug your primary monitor into the port marked `HDMI0`. + Most displays don't have micro or mini HDMI ports. However, you can use a https://www.raspberrypi.com/products/micro-hdmi-to-standard-hdmi-a-cable/[micro-HDMI-to-HDMI cable] or https://www.raspberrypi.com/products/standard-hdmi-a-male-to-mini-hdmi-c-male-cable/[mini-HDMI-to-HDMI cable] to connect those ports on your Raspberry Pi to any HDMI display. For displays that don't support HDMI, consider an adapter that translates display output from HDMI to a port supported by your display. -image::images/peripherals/cable-hdmi.png[alt="Plugging a micro HDMI cable into a Raspberry Pi."] +image::images/peripherals/cable-hdmi.png[alt="Plugging a micro HDMI cable into a Raspberry Pi.",width="80%"] === Audio @@ -135,15 +140,14 @@ All variants of the Raspberry Pi 1, 2, 3, and 4 include a 3.5mm auxiliary http:/ === Networking -The following Raspberry Pi models come with WiFi and Bluetooth connectivity: +The following Raspberry Pi models come with Wi-Fi and Bluetooth connectivity: -* Raspberry Pi 5 -* Raspberry Pi 4 -* Raspberry Pi 3B+ -* Raspberry Pi 3 -* Raspberry Pi Zero W -* Rsapberry Pi Zero 2 W +* Flagship models since Raspberry Pi 3 Model B +* All Keyboard models +* All Zero W models +* All Pico W models +* Compute Modules configured with wireless (available since CM4) -The "Model B" suffix indicates variants with an Ethernet port; "Model A" indicates no Ethernet port. If your Raspberry Pi doesn't have an Ethernet port, you can still connect to a wired internet connection using a USB-to-Ethernet adapter. +The "Model B" suffix indicates variants with an Ethernet port; "Model A" indicates no Ethernet port. The Keyboard models also include an Ethernet port. If your Raspberry Pi doesn't have an Ethernet port, you can still connect to a wired internet connection using a USB-to-Ethernet adapter. -image::images/peripherals/cable-net.png[alt="Plugging an Ethernet cable into a Raspberry Pi."] +image::images/peripherals/cable-net.png[alt="Plugging an Ethernet cable into a Raspberry Pi.",width="80%"] diff --git a/documentation/asciidoc/computers/getting-started/wrapping-up.adoc b/documentation/asciidoc/computers/getting-started/wrapping-up.adoc index 3497f9586..59e587657 100644 --- a/documentation/asciidoc/computers/getting-started/wrapping-up.adoc +++ b/documentation/asciidoc/computers/getting-started/wrapping-up.adoc @@ -6,7 +6,7 @@ Now that your Raspberry Pi is set up and ready to go, what's next? Raspberry Pi OS comes with many essential applications pre-installed so you can start using them straight away. If you'd like to take advantage of other applications we find useful, click the raspberry icon in the top left corner of the screen. Select **Preferences > Recommended Software** from the drop-down menu, and you'll find the package manager. You can install a wide variety of recommended software here for free. -image::images/recommended-software.png[Opening the package manager GUI in Raspberry Pi OS] +image::images/recommended-software.png[alt="Opening the package manager GUI in Raspberry Pi OS",width="80%"] For example, if you plan to use your Raspberry Pi as a home computer, you might find LibreOffice useful for writing and editing documents and spreadsheets. You can also make your Raspberry Pi more accessible with apps like a screen magnifier and Orca screen reader, found under Universal Access. @@ -18,20 +18,3 @@ Our tutorials demonstrate various ways you can use your new computer. You can le For support with official Raspberry Pi products, or to connect with other Raspberry Pi users, visit the https://forums.raspberrypi.com/[Raspberry Pi forums]. - -[.booklink, booktype="buy", link=https://store.rpipress.cc/products/the-official-raspberry-pi-beginners-guide-5th-edition,image=image::images/fifth-editon-cover.png[]] -=== Further reading - -You can find more information on how get started with your Raspberry Pi in the latest edition of https://store.rpipress.cc/collections/latest-releases/products/the-official-raspberry-pi-beginners-guide-5th-edition[Official Raspberry Pi Beginners Guide] by Gareth Halfacree. - -Learn how to: - -* Set up your Raspberry Pi, install its operating system, and start using this fully functional computer. -* Start coding projects, with step-by-step guides using the Scratch 3, Python, and MicroPython programming languages. -* Experiment with connecting electronic components, and have fun creating amazing projects. - -New in the 5th edition: - -* Updated for the latest Raspberry Pi computers: Raspberry Pi 5 and Raspberry Pi Zero 2 W. -* Covers the latest Raspberry Pi OS. -* Includes a new chapter on the Raspberry Pi Pico! \ No newline at end of file diff --git a/documentation/asciidoc/computers/keyboard-computers.adoc b/documentation/asciidoc/computers/keyboard-computers.adoc new file mode 100644 index 000000000..895b1f658 --- /dev/null +++ b/documentation/asciidoc/computers/keyboard-computers.adoc @@ -0,0 +1 @@ +include::keyboard-computers/intro.adoc[] diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2-step-1.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-1.jpg new file mode 100755 index 000000000..06b2f2178 Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-1.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2-step-2.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-2.jpg new file mode 100755 index 000000000..68a806c06 Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-2.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2-step-3.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-3.jpg new file mode 100755 index 000000000..551d9e842 Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-3.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2-step-4.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-4.jpg new file mode 100755 index 000000000..d04bad275 Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-4.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2-step-5.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-5.jpg new file mode 100755 index 000000000..5863f6ab8 Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-5.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2-step-6.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-6.jpg new file mode 100755 index 000000000..025262bbb Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2-step-6.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2step1.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2step1.jpg new file mode 100644 index 000000000..268aefb89 Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2step1.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2step2.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2step2.jpg new file mode 100644 index 000000000..a827e0390 Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2step2.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2step3.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2step3.jpg new file mode 100644 index 000000000..fe68a3042 Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2step3.jpg differ diff --git a/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring-old.png b/documentation/asciidoc/computers/keyboard-computers/images/M2step4.jpg similarity index 70% rename from documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring-old.png rename to documentation/asciidoc/computers/keyboard-computers/images/M2step4.jpg index a8d689a20..0037242a6 100644 Binary files a/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring-old.png and b/documentation/asciidoc/computers/keyboard-computers/images/M2step4.jpg differ diff --git a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/four_picos.png b/documentation/asciidoc/computers/keyboard-computers/images/M2step5.jpg similarity index 55% rename from documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/four_picos.png rename to documentation/asciidoc/computers/keyboard-computers/images/M2step5.jpg index bc3d13b25..37d5ae832 100644 Binary files a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/four_picos.png and b/documentation/asciidoc/computers/keyboard-computers/images/M2step5.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/images/M2step6.jpg b/documentation/asciidoc/computers/keyboard-computers/images/M2step6.jpg new file mode 100644 index 000000000..73941696b Binary files /dev/null and b/documentation/asciidoc/computers/keyboard-computers/images/M2step6.jpg differ diff --git a/documentation/asciidoc/computers/keyboard-computers/intro.adoc b/documentation/asciidoc/computers/keyboard-computers/intro.adoc new file mode 100644 index 000000000..8337af515 --- /dev/null +++ b/documentation/asciidoc/computers/keyboard-computers/intro.adoc @@ -0,0 +1,734 @@ +Raspberry Pi keyboard computers are complete personal computers built into a keyboard. They include the same system-on-chip (SoC) as Raspberry Pi single-board computers (SBC). Raspberry Pi offers three keyboard computers: + +* *Raspberry Pi 400*, based on Raspberry Pi 4 (4 GB), released 2020. +* *Raspberry Pi 500*, based on Raspberry Pi 5 (8 GB), released 2024. +* *Raspberry Pi 500+*, based on Raspberry Pi 5 (16 GB), released 2025. + +Raspberry Pi keyboard computers come in different regional variants affecting keyboard layout and required power supply. + +== Features + +The features of your Raspberry Pi keyboard computer depend on the model. + +*Raspberry Pi 500* and *Raspberry Pi 500+* are faster than *Raspberry Pi 400* due to the Cortex-A76 CPU, increased RAM, and upgraded GPU. The main differences between the Raspberry Pi 400 keyboard computer and the Raspberry Pi 500 and 500+ keyboard computers are: + +* *Processor.* Raspberry Pi 400 uses Cortex-A72 at 1.8 GHz; both Raspberry Pi 500 and 500+ use Cortex-A76 at 2.4 GHz, providing higher performance and efficiency. +* *Memory (RAM).* Raspberry Pi 400 includes 4 GB of RAM; Raspberry Pi 500 includes 8 GB of RAM; Raspberry Pi 500+ includes 16 GB of RAM, providing smoother multitasking and support for more demanding applications. +* *GPU.* Raspberry Pi 400 includes VideoCore VI at 500 MHz; both Raspberry Pi 500 and 500+ include VideoCore VII at 910 MHz, providing faster graphics and improved video decoding. +* *HDR video.* All Raspberry Pi keyboard computers include two micro-HDMI ports, providing 4K displays, but Raspberry Pi 500 and 500+ also support HDR on HDMI outputs. +* *Power button.* Raspberry Pi 400 doesn't have a power button and is instead turned on and off with a combination of key presses; both Raspberry Pi 500 and 500+ do have a power button. +* *SoC.* Raspberry Pi 400 includes the Broadcom chip, BCM2711; both Raspberry Pi 500 and 500+ use the Broadcom chip, BCM2712, in combination with the RP1 I/O controller. + +Raspberry Pi 500+ offers additional features, including: + +* Mechanical keys with customisable RGB LEDs and replaceable keycaps. For more information, see <>. For instructions, see <> and <>. +* Internal 256 GB M.2 SSD, which is replaceable. This SSD comes installed with Raspberry Pi OS. For instructions, see <>. +* More RAM (16 GB). For a comparison, see the following table. + +[cols="1,1,1,1", options="header"] +|=== +| |Raspberry Pi 400 |Raspberry Pi 500 |Raspberry Pi 500+ + +| *Dimensions* +| 286 × 122 × 23 mm +| 286 × 122 × 23 mm +| 312 × 123 × 35 mm + +| *Keys* +| 78, 79, or 83 membrane keys depending on regional variant +| 78, 79, or 83 membrane keys depending on regional variant +| 84, 85, or 88 mechanical keys depending on regional variant + +| *Processor* +| Quad-core 64-bit Arm processor (Cortex-A72 at 1.8 GHz) +| Quad-core 64-bit Arm processor (Cortex-A76 at 2.4 GHz) +| Quad-core 64-bit Arm processor (Cortex-A76 at 2.4 GHz) + +| *SoC and I/O controller* +| BCM2711 SoC +| BCM2712 SoC and RP1 I/O controller +| BCM2712 SoC and RP1 I/O controller + +| *Memory (RAM)* +| 4 GB synchronous dynamic RAM (SDRAM) +| 8 GB synchronous dynamic RAM (SDRAM) +| 16 GB synchronous dynamic RAM (SDRAM) + +| *GPU* +| VideoCore VI at 500 MHz +| VideoCore VII at 910 MHz +| VideoCore VII at 910 MHz + +| *Video output* +| Two micro-HDMI ports that provide either a single 4K display at 60 Hz or two 4K displays at 30Hz +| Two micro-HDMI ports that provide 4K displays at 60 Hz plus HDR support +| Two micro-HDMI ports that provide 4K displays at 60 Hz plus HDR support + +| *Thermal control* +| Aluminium integrated heatsink +| Aluminium integrated heatsink +| Aluminium integrated heatsink + +| *Wireless connectivity* +| Dual-band Wi-Fi and BLE +| Dual-band Wi-Fi and BLE +| Dual-band Wi-Fi and BLE + +| *USB ports* +| Two USB 3.0 ports; one USB 2.0 port +| Two USB 3.0 ports; one USB 2.0 port +| Two USB 3.0 ports; one USB 2.0 port + +| *Gigabit Ethernet* +| Yes +| Yes +| Yes + +| *GPIO* +| Horizontal 40-pin GPIO header +| Horizontal 40-pin GPIO header +| Horizontal 40-pin GPIO header + +| *Storage* +| microSD card slot +| microSD card slot +| microSD card slot and M.2 SSD drive + +| *Power input* +| 5 V at 3 A (15 W) through USB-C +| 5 V at 5 A (25 W) through USB-C +| 5 V at 5 A (25 W) through USB-C + +| *Power button* +| Key combination (*Fn* + *F10*) +| Dedicated button +| Dedicated button + +| *Customisability* +| +| Key remapping +| Key remapping; RGB backlighting; ability to change keycaps +|=== + +== Keyboard computer kits + +Raspberry Pi keyboard computers are available as standalone keyboards or as part of a kit, including basic accessories to get started. + +=== Raspberry Pi 400 kit + +* Raspberry Pi 400 keyboard computer. +* 15 W Raspberry Pi USB-C power supply. +* Raspberry Pi USB mouse. +* 16 GB microSD card, pre-programmed with Raspberry Pi OS. +* micro-HDMI cable. +* _Beginner's Guide_ book. + +=== Raspberry Pi 500 kit + +* Raspberry Pi 500 keyboard computer. +* 27 W Raspberry Pi USB-C power supply. +* Raspberry Pi USB mouse. +* 32 GB A2-class microSD card, pre-programmed with Raspberry Pi OS. +* micro-HDMI cable. +* _Beginner's Guide_ book. + +=== Raspberry Pi 500+ kit + +* Raspberry Pi 500+ keyboard computer, including an SSD pre-programmed with Raspberry Pi OS. +* 27 W Raspberry Pi USB-C power supply. +* Raspberry Pi USB mouse. +* micro-HDMI cable. +* Spudger (opening tool) for access to the M.2 SSD (also provided with the standalone keyboard). +* Keycap puller for removing keycaps (also provided with the standalone keyboard). +* _Beginner's Guide_ book. + +== Getting started + +To get up and running with your Raspberry Pi keyboard computer, you can follow the instructions at xref:../computers/getting-started.adoc#setting-up-your-raspberry-pi[Getting started with your Raspberry Pi]. + +If you have a Raspberry Pi 500+ or got your 400 or 500 as part of a kit that includes a microSD card pre-programmed with Raspberry Pi OS, you can skip ahead in the instructions to xref:../computers/getting-started.adoc#set-up-your-raspberry-pi[Set up your Raspberry Pi]. + +[[mechanical-keys]] +== Raspberry Pi 500+ mechanical keys + +Each key on Raspberry Pi 500+ has its own mechanical switch underneath the keycap that registers a key press. Raspberry Pi 500+ uses Gateron KS-33 low-profile mechanical switches. By default, Gateron KS-33 switches use coloured stems to indicate switch type (clicky, tactile, or linear). Raspberry Pi 500+ uses clicky Gateron KS-33 switches with a custom grey stem. + +Keycaps attach to the cross-shaped stem on top of the Gateron switches. These switches have Cherry MX-compatible, cross-shaped stems, which is the industry standard. For guidance and instructions on removing and replacing keycaps on your Raspberry Pi 500+, see <> on this page. + +== Raspberry Pi 500+ customisation + +Raspberry Pi 500+ is the most recent keyboard computer. It offers the following customisation options: + +* Replaceable M.2 SSD storage. For instructions, see <>. +* Keycap set changes. For instructions, see <>. +* Backlighting presets, colours, and brightness. For instructions, see <>. + +For more advanced users, Raspberry Pi 500+ also allows: + +* LED configuration beyond the built-in presets. +* On-the-fly key remapping. + +For more information, see <>. + +[[replace-m2]] +=== Replace your M.2 SSD + +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). + +1. *Unscrew the keyboard.* Locate the five screws on the bottom of the keyboard and unscrew them using a cross head screwdriver. Keep the screws in a safe place. ++ +image::images/M2-step-1.jpg[alt="Unscrew keyboard"] + +2. *Loosen the top of the keyboard from the bottom of the keyboard.* Position the spudger into the indentation at the front of the keyboard and then angle the spudger upwards to start splitting the keyboard. ++ +image::images/M2-step-2.jpg[alt="Spudger"] + +3. *Detach the top of the keyboard from the bottom of the keyboard.* Wedge and swipe the spudger along the opening groove at the front of the keyboard to detach the top of the keyboard from the bottom. ++ +image::images/M2-step-3.jpg[alt="Slide spudger along groove"] + +4. *Open the keyboard.* Place the bottom of the keyboard on a flat surface and fold (don't lift) the top of the keyboard over to lay it face down on the same surface. Be careful not to pull the top and bottom parts away from each other entirely because they're attached with a flexible cable. ++ +image::images/M2-step-4.jpg[alt="Fold open the keyboard"] + +5. *Release the M.2 SSD.* By hand or with a flat head screwdriver, turn the screw on the right side of the M.2 SSD anticlockwise to loosen it. Remove the screw and keep it in a safe place. The M.2 SSD springs up when you remove the screw. ++ +image::images/M2-step-5.jpg[alt="Fold open the keyboard"] + +6. *Pull out the M.2 SSD.* Pull the M.2 SSD away from and then out of the keyboard. ++ +image::images/M2-step-6.jpg[alt="Pull out M.2 SSD"] + +7. *Add a new M.2 SSD.* Insert another M.2 SSD by sliding it into the slot at the left side. The SSD card fits in only one orientation. Hold the newly inserted M.2 SSD down and replace the screw on the right side of it, turning the screw clockwise to tighten. +8. *Close the keyboard.* Fold the top of the keyboard back onto the bottom of the keyboard and click it back into place. +9. *Screw the keyboard shut.* Place and turn the five screws back into place with your cross head screwdriver. + +[[replace-keycaps]] +=== Change your keycaps + +You can swap out the default keycaps on your Raspberry Pi 500+ for custom sets. Because the Gateron KS-33 switches on Raspberry Pi 500+ use the industry standard Cherry MX stem shape, most third-party keycaps that are designed for Cherry MX are compatible. Avoid taller profiles that could hit the keyboard frame or produce too much noise. For more guidance on choosing alternative keycaps, see <>, <>, and <> in this section. + +To remove a keycap: + +1. Insert the prongs of the keycap puller on opposite sides of a keycap that you want to remove or replace. Allow the prongs to fall below the keycap. +2. Press the sides of the prongs to grip the keycap, ensuring equal pressure on both sides. +3. Gently pull the keycap straight up off of the keyboard. Avoid pulling at an angle. + +NOTE: You can also remove keycaps to allow you to clean underneath them. + +You can now replace the keycap with another one, or reinstall the same keycap in its original place: + +1. Align the keycap by lining up its cross-shaped stem underneath it with the cross-shaped stem on the corresponding switch. +2. Press the keycap down gently but firmly until the keycap is fully seated and feels secure. + +[[layout]] +==== Keyboard layout + +Keycaps are available in various languages, with US layouts being the most widely available, followed by UK layouts. Other languages can be harder to source. + +The Raspberry Pi 500+ keyboard has a modified 75% layout, which means that some keys are non-standard and might not have matching keycaps in typical sets: + +* *Power key.* The power key in the top-right corner of the keyboard might not be included in other keycap sets. +* *Lighting labels.* The lighting labels on the *F4*, *F5*, and *F6* keys of Raspberry Pi 500+ are non-standard. +* *Volume labels.* The volume labels on the *F10*, *F11*, and *F12* keys of Raspberry Pi 500+ are non-standard. +* *System Request key.* The *SysRq* key on Raspberry Pi 500+ is non-standard. +* *Insert key.* The *Ins* key on Raspberry Pi 500+ is non-standard. +* *Command key.* The *Cmd* key typically says *Win* on keycap sets, and third-party keycap sets don't include the Raspberry Pi logo. + +[[profiles]] +==== Keycap profiles + +The low-profile keycaps included on Raspberry Pi 500+ perform like traditional mechanical keys while also keeping the keyboard compact. We recommend *DSA* or *Cherry* profiles for replacement keycaps: + +* *DSA* keycaps have a flat profile and can be swapped across rows. +* *Cherry* keycaps are generally compatible, but have different sculpted profiles for ergonomics. This means that each row can have a slightly different height or angle. For a consistent feel, check row alignment. + +NOTE: *XDA*, *OEM*, and *SA* keycaps aren't recommended because they're taller, and can therefore produce more noise or come into contact with the keyboard frame. + +[[lighting]] +==== Lighting + +The LEDs on the Raspberry Pi 500+ keyboard light the top half of the keycaps, which means that fully opaque keycaps might block illumination. + +[[backlighting]] +=== Customise your backlighting + +Raspberry Pi 500+ has most backlighting turned off by default. The only lighting that's enabled by default includes: + +* The activity LED behind the power button when the Raspberry Pi 500+ keyboard is on. This LED: + - Is red when Raspberry Pi 500+ is receiving power but is turned off. + - Is green when Raspberry Pi 500+ is turned on. + - Blinks with SD card activity. +* The rainbow lighting animation that travels through the keys when you start up the Raspberry Pi 500+ keyboard. Advanced users can turn this off for particular backlighting presets using the configuration software. For more information, see <> in <>. +* The Caps Lock indicator that lights up when active. + +Raspberry Pi 500+ supports other RGB backlighting presets, powered by https://github.com/raspberrypi/vial-qmk[Vial QMK firmware]. For instructions, see <>. + +[[choose-presets]] +==== Choose backlight preset + +Raspberry Pi 500+ comes with seven presets, which are the saved lighting profiles on your Raspberry Pi 500+ keyboard. To cycle forwards through these presets, press *Fn* + *F4* on the keyboard; to cycle backwards through these presets, press *Fn* + *Shift* + *F4* on the keyboard. + +[cols="1,5,16", options="header"] +|=== + +| |Preset name |Description + +| *0* +| *Off* +| The default preset that only lights the power key, the startup animation, and the Caps Lock indicator. + +| *1* +| *Solid Colour White* +| Solid white backlight. + +| *2* +| *Solid Colour* +| Solid colour backlight, which you can change using *Fn* + *F3*. + +| *3* +| *Gradient Left Right* +| Fixed rainbow backlight. + +| *4* +| *Cycle Pinwheel* +| Animated rainbow backlight, where the keys cycle through different colours in a rainbow pattern across the keyboard. + +| *5* +| *Typing Heatmap* +| The more you press a key, the closer to red it gets and the more the keys around it light up. + +| *6* +| *Solid Reactive Simple* +| Reactive keyboard, where the keys light up when you press them. You can choose which colour using *Fn* + *F3*. +|=== + +[[backlight-controls]] +==== Backlight controls + +You can customise the RGB backlighting colour (depending on the preset) and brightness using the following keyboard shortcuts: + +* *Change colour.* Press *Fn* + *F3* to cycle forwards through 16 backlight colours; press *Fn* + *Shift* + *F3* to cycle backwards through the colours. +* *Adjust brightness.* Press *Fn* + *F5* to reduce the brightness; press *Fn* + *F6* to increase the brightness. + +NOTE: The *Shift* key on your keyboard either cycles backwards through available options, or inverts the key function. For example, *Fn* + *Shift* + *F5* increases the brightness instead of decreasing it. + +[[advanced]] +== Advanced software settings + +Raspberry Pi offers firmware that controls the built-in keyboard on Raspberry Pi 500 and 500+. With this tool, you can: + +* Enable and configure advanced LED settings for Raspberry Pi 500+. For more information, see <>. +* Remap keys on both Raspberry Pi 500 and 500+. For more information, see <>. +* Play a Flappy Bird-style game on Raspberry Pi 500+. For information, see <>. + + +For more information and options beyond those described in this page, see the https://github.com/raspberrypi/rpi-keyboard-config/blob/main/README.md[README for the configurator tool] on GitHub. + +=== Firmware setup + +To use software-controlled lighting and to remap keys, you must first update the keyboard firmware and install the configuration tool: + +. Install the firmware update package. Run the following command: `sudo apt install rpi-keyboard-fw-update`. +. Update to the latest keyboard firmware update, which checks for and installs the firmware required for advanced functionality. Run the following command: `sudo rpi-keyboard-fw-update`. +. Install the configuration tool, which allows you to adjust LEDs and remap keys. Run the following command: `sudo apt install rpi-keyboard-config`. + +You can see the keyboard firmware source code in the https://github.com/raspberrypi/vial-qmk[Vial QMK] repository on GitHub. + +=== Basic information commands + +Use the following commands as appropriate to view the current state of your keyboard computer before customising its lighting or remapping its keys. + +[cols="3,5", options="header"] +|=== +|Command|Description + +| `rpi-keyboard-config info --ascii`|View keyboard model, lock status, and layout diagram. If you don't need the layout diagram, remove `--ascii` from the command. + +| `rpi-keyboard-config help`|List all available commands with brief descriptions. + +| `rpi-keyboard-config list-effects`|List all available lighting effects, which can be applied temporarily or to a preset. + +|`rpi-keyboard-config preset get`|List all current presets, numbered 0 to 6. + +|=== + +[[advanced-led]] +=== Advanced LED settings + +Advanced users can customise Raspberry Pi 500+ backlighting beyond the basic presets. Specifically, the `rpi-keyboard-config` software allows you to: + +* Add other lighting effects to your Raspberry Pi 500+, temporarily or as presets. For information, see <>. +* Set a different startup animation for each preset. For information, see <>. +* Add speed, saturation, and hue parameters to an effect or preset. For information, see <>. +* Control global hue and brightness. For information, see <>. +* Control individual LED lighting by configuring and then applying the `direct` effect. For information, see <>. + +NOTE: Advanced LED settings are only available for Raspberry Pi 500+ because only this model of keyboard computer has backlit keys. + +[[effects]] +==== Lighting effects + +You can control Raspberry Pi 500+ backlighting through various effects and parameters. With the exception of the power button, which is unaffected by any effect, keyboard lighting effects are controlled through the configuration software. With this software, you can: + +* Temporarily apply an effect to the keyboard until you shut down and restart the keyboard, or until you start to cycle through the presets again. Cycling through the presets continues from the last preset before you applied a temporary effect. +* Assign an effect to one of the seven keyboard presets. The default presets are listed in <>. You can also add parameters and startup animations to presets. + +Use the following commands to choose, apply, and view a temporary effect on your keyboard. + +[cols="2,3", options="header"] +|=== +|Command|Description + +| `rpi-keyboard-config list-effects`|List available lighting effects. + +| `rpi-keyboard-config effect "effect-name"`|Temporarily apply an effect, replacing `effect-name` with the name of the effect, as listed in the output of the previous command. + +| `rpi-keyboard-config effect`|View the currently active effect. + +|=== + +You can also adjust the following parameters for an effect: speed, saturation, and hue. For example, the following command changes the speed of the `"Cycle Spiral"` effect to 42. + +[source,console] +---- +$ rpi-keyboard-config effect "Cycle Spiral" --speed 42 +---- + +Any parameter you add must be a number between 0 and 255. For more information about these parameters, including when they are and aren't useful to add, see <>. + +[[view-presets]] +==== View presets + +You can use the configuration software to check which preset you're on, move between them, or see details about each one. Each preset has an index number between 0 and 6, representing the seven available slots. + +[cols="1,1,1", options="header"] +|=== +|Command|Description|Example (assuming default presets) + +| `rpi-keyboard-config preset index`|Show the index of the current preset.|If you're currently on the *Gradient Left Right* preset, this command tells you that you're on preset 3. + +| `rpi-keyboard-config preset index X`|Skip to a different position in the preset cycle, where `X` is the index of the preset (a number between `0` and `6`).|The following command takes you to the *Typing Heatmap* preset: +`rpi-keyboard-config preset index 5`. + +| `rpi-keyboard-config preset get`|List all current presets.|This command lists the seven presets, numbered 0 to 6. Default presets are summarised in <>. + +| `rpi-keyboard-config preset get X`|Show details about a specific preset, where `X` is the index of the preset (a number between `0` and `6`). |The following command tells you that preset 5 is the *Typing Heatmap* preset: +`rpi-keyboard-config preset get 5`. + +|=== + +[[reassign]] +==== Reassign presets + +You can reassign presets to use different effects. For information about effects, including how to obtain a list of available effects, see <>. + +NOTE: Changes you make to presets persist every time you restart your Raspberry Pi 500+. You can reset your presets to default at any time using the instructions in <>. + +The following example changes the *Gradient Left Right* (`3`) preset to an effect that you specify in the quotation marks. + +[source,console] +---- +$ rpi-keyboard-config preset set 3 "effect-name" +---- + +While reassigning a preset, you can add one or more of the following parameters: speed, hue, or saturation. You can also set a specific startup animation for that preset. For information about these options, see <> and <>. + +For example, the following command replaces the default *Gradient Left Right* preset with the *Rainbow Beacon* effect at a speed of 140. It would also replace the default startup animation for that preset so that the startup animation finishes on white LEDs and then fades into the *Rainbow Beacon* effect. + +[source,console] +---- +$ rpi-keyboard-config preset set 3 "Rainbow Beacon" --speed 140 --startup-animation "START_ANIM_W_FADE_SAT" +---- + +[[startup]] +==== Change preset startup animation + +For each preset, you can specify a startup animation with the following command: + +[source,console] +---- +$ --startup-animation "name_of_animation" +---- + +Replace `name_of_animation` with one of the following five possible startup animations: + +[cols="1,3", options="header"] +|=== +|Startup animation name|Description + +|`START_ANIM_NONE`|No startup animation. + +|`START_ANIM_B_NO_FADE`|Pulsing rainbow animation followed by blank LEDs and then immediately into the chosen effect. + +|`START_ANIM_B_FADE_VAL`|Pulsing rainbow animation followed by blank LEDs fading into the chosen effect. This is the *default* startup animation. + +|`START_ANIM_W_NO_FADE`|Pulsing rainbow animation followed by white LEDs and then immediately into the chosen effect. + +|`START_ANIM_W_FADE_SAT`|Pulsing rainbow animation followed by white LEDs fading into the chosen effect. + +|=== + +For example, the following command would replace the startup animation for preset 3 with a pulsing rainbow animation that finishes on white LEDs and then fades into the preset: + +[source,console] +---- +$ rpi-keyboard-config preset set 3 --startup-animation "START_ANIM_W_FADE_SAT" +---- + +[[parameters]] +==== Effect and preset parameters + +You can add the following speed, saturation, and hue parameters to any effect or preset: + +* *Speed.* To set the speed, add `--speed X` to the command, where `X` is a number between 0 and 255. If you don't add the speed parameter, the default speed is 128. +* *Saturation.* To set the saturation, add `--sat X` to the command, where `X` is a number between 0 and 255. If you don't add the saturation parameter, the default is 255 (maximum saturation). +* *Hue.* To set the hue, add `--hue X` to the command, where `X` is a number between 0 and 255. If you don't set a hue, the default is to use the global hue of the keyboard, which is set with *Fn + F3* on the keyboard. For more information, see <>. + +Some effects and presets are unaffected by some parameters. For example, a solid colour is a static effect and so isn't affected by a speed change. + +[[global-lighting]] +==== Global lighting controls + +Hue and brightness are managed on a range of 0 to 255. You can view and set the hue and brightness of your Raspberry Pi 500+ by adding `hue` and `brightness` to the `rpi-keyboard-config` command. + +[cols="2,3", options="header"] +|=== +|Command|Description + +| `rpi-keyboard-config hue`|Show the current global hue (colour) of your Raspberry Pi 500+. + +| `rpi-keyboard-config hue X`|Set the global hue, where `X` is a number between 0 and 255. + +| `rpi-keyboard-config brightness`|Show the current lighting brightness of your Raspberry Pi 500+. + +| `rpi-keyboard-config brightness X`|Set the lighting brightness, where `X` is a number between 0 and 255. +|=== + +[[direct]] +==== Individual LED controls + +You can customise the backlighting of individual LEDs on your Raspberry Pi 500+. This is useful for precise visual tweaks and for creating unique backlight patterns. + +All the individual LED customisations that you can make are applied to an effect called `direct`. You then apply the `direct` effect either: + +* Temporarily using the instructions in <>. +* By assigning it to a preset using the instructions on <>. + +If the `direct` effect is not already applied by one of the preceding methods, it is automatically temporarily applied when running any of the individual LED customisations. + +The following table lists commands to set LED colours (globally or for each LED), and save and load LED configurations. + +[cols="2,3", options="header"] +|=== +|Command|Description + +| `rpi-keyboard-config leds clear`|Turn off all LEDs except the power button. + +| `rpi-keyboard-config leds set --colour `|Specify the colour of all the LEDs. Replace `` with either with the common colour name (for example, `red`), HSV numbers ranging from 0 to 255 in quotation marks (for example, `"0,255,255"`), or RGB numbers in quotation marks (for example, `"rgb(255,0,0)"`). + +| `rpi-keyboard-config led set "," --colour `|Specify the colour of a specific LED, where the LED is the row and column co-ordinates (`","`). You can check the LED row and column co-ordinates, as well as what each of the keys is currently set to, with the following command: `rpi-keyboard-config info --ascii`. + +|`rpi-keyboard-config leds save`|Save your LED configuration. To use the saved configuration, you can then either assign the `direct` effect to a preset using the instructions in <>, or load the configuration directly using the `load` command, below. + +|`rpi-keyboard-config leds load`|Temporarily apply the `direct` effect to load the saved LED configuration. This is useful if you haven't assigned the `direct` effect to a preset. + +|=== + +In the following example, the specific LED referenced by the row and column co-ordinates (`"2,6"`) is set to green with hue-saturation-value (HSV) numbers (`"85,255,255"`): + +[source,console] +---- +$ rpi-keyboard-config led set "2,6" --colour "85,255,255" +---- + +[[reset-presets]] +==== Reset presets and LED customisations + +The following command resets your presets to the default settings and clears your saved LED customisations: + +[source,console] +---- +$ rpi-keyboard-config reset-presets +---- + +[[remapping]] +=== Remap keys on your keyboard + +Advanced users can remap the keys on both a Raspberry Pi 500 and 500+, allowing you to customise your keyboard layout to match your workflow or gaming needs. + +Use the `rpi-keyboard-config` software to: + +* List all keycodes available for remapping. For information, see <>. +* Check the current keymap. For information, see <>. +* Remap the keys on your keyboard. For information, see <>. +* Watch key presses in the configuration software. For information, see <>. +* Edit up to four key-mapping layers. For information, see <>. +* Reset your keyboard to the default key mapping. For information, see <>. + +The Raspberry Pi 500 and 500+ are compatible with https://get.vial.today/[Vial]. You can use the Vial web UI to remap your keys. For information, see <>. + +[[keycodes]] +==== List keycodes + +To remap your keyboard, you need to know the keycodes for the keys you want to assign on your Raspberry Pi 500 or 500+. The following command lists all possible keycodes: + +[source,console] +---- +$ rpi-keyboard-config list-keycodes +---- + +You can also list only the keycodes in a specific category using `--category`. For example, the following command lists all the keycodes for the `basic` category: + +[source,console] +---- +$ rpi-keyboard-config list-keycodes --category basic +---- + +[[keymap]] +==== View keymap + +Use the following command to see how keys are currently mapped on all positions on your keyboard: + +[source,console] +---- +$ rpi-keyboard-config key get-all +---- + +Use the following command to see the keycode for a specific key at a position that you specify with the key's row and column co-ordinates. Replace `` and `` with the appropriate numbers: + +[source,console] +---- +$ rpi-keyboard-config key get +---- + +NOTE: You can check a key's row-column co-ordinates using `rpi-keyboard-config info --ascii`. This provides a layout diagram of the keyboard. + +For example, to get the keycode for the *Q* key (with the row-column co-ordinates `2 2`) on your keyboard: + +[source,console] +---- +$ rpi-keyboard-config key 2 2 +---- + +[[remap]] +==== Remap keys + +Use the following command to set a different keycode at a position that you specify with the key's row and column. Replace `` and `` with the appropriate numbers, and replace `` with the keycode that you want to map to the specified key. + +[source,console] +---- +$ rpi-keyboard-config key set +---- + +NOTE: You can check a key's row-column co-ordinates using `rpi-keyboard-config info --ascii`. You can check a key's keycode using `rpi-keyboard-config list-keycodes`. + +For example, if you wanted to remap *Q* (with the row-column co-ordinates `2 2`) on your keyboard as *R* (with the keycode `KC_R`): + +[source,console] +---- +$ rpi-keyboard-config key set 2 2 KC_R +---- + +[[watch]] +==== Watch key presses + +You can read the state of keys to monitor key activity inside the configuration tool to tell you which keys are pressed and released. Before you can do this, you must unlock the keyboard. + +To check the lock status of your keyboard: + +[source,console] +---- +$ rpi-keyboard-config info +---- + +To unlock your keyboard so that you can then watch key presses: + +[source,console] +---- +$ rpi-keyboard-config unlock +---- + +The configuration tool guides you through holding down specific keys until a countdown completes. By default, the keys are *Enter* + *Escape*, which light up in red to guide you. If you've remapped these keys, the unlock sequence uses the physical positions of those keys, not their new labels; the command tells you which remapped keys to press for your setup. + +When the keyboard is unlocked, you can monitor key activity with the following command: + +[source,console] +---- +$ rpi-keyboard-config key watch +---- + +This prints to the terminal whenever a key is pressed or released. For LED feedback, the keys on the keyboard also light up red as you press them. To remove the light-up functionality while watching key presses, add `--no-leds` to the above command: + +[source,console] +---- +$ rpi-keyboard-config key watch --no-leds +---- + +Lock your keyboard when you're done. The following `lock` command doesn't require any confirmation; it locks the keyboard immediately. + +[source,console] +---- +$ rpi-keyboard-config lock +---- + +[[layers]] +==== Manage layers + +You can set different key mappings on different layers. There are four layers that you can edit, numbered 0–3; the default layer is 0. By default, the *Fn* key changes the keyboard from layer 0 to layer 1. You can add `--layer` to any of the following commands, as appropriate: + +* `rpi-keyboard-config key get-all` +* `rpi-keyboard-config key get` +* `rpi-keyboard-config key set` + +[[reset-keymap]] +==== Reset to default keyboard layout + +The following command resets your keyboard layout to the default key mappings, including resetting all layers: + +[source,console] +---- +$ rpi-keyboard-config reset-keymap +---- + +[[vial]] +==== Remap keys with Vial + +Vial works with your keyboard firmware to configure your keyboard in real time. + +. On your Raspberry Pi 500 or 500+, go to https://vial.rocks/[Vial web interface]. +. In the window that appears, select your keyboard and click **Connect**. +. Use the Vial web interface to change your key mappings. + +For information about how to use Vial, see the https://get.vial.today/[Vial documentation]. + +NOTE: We recommend that you use Vial only for working with the key mapping and not for customising the RGB LEDs. + +=== Return to default settings + +Your software-controlled preferences are saved in flash memory and persist after reboot and firmware updates. To reset your backlight settings and keyboard layout, wipe the flash area that they're stored in with the following command: + +[source,console] +---- +$ sudo rpi-keyboard-fw-update -w -i +---- + +This clears all customisations and restores the keyboard to default backlighting and key mapping. + +If the keyboard layout has been misconfigured to the extent that input on the Raspberry Pi 500+ is no longer possible, you can still complete a reset to default settings by connecting an external USB keyboard to one of the available USB ports and entering the command from that device instead. + +[[flappy-bird]] +=== Flappy Bird game + +For a bit of fun, the following command allows you to use the keyboard backlighting to play a basic Flappy Bird-style game on Raspberry Pi 500+: + +[source,console] +---- +$ 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. 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/legacy_config_txt/memory.adoc b/documentation/asciidoc/computers/legacy_config_txt/memory.adoc index 11996ade0..7edd2327a 100644 --- a/documentation/asciidoc/computers/legacy_config_txt/memory.adoc +++ b/documentation/asciidoc/computers/legacy_config_txt/memory.adoc @@ -50,5 +50,5 @@ The `gpu_mem_1024` command sets the GPU memory in megabytes for Raspberry Pis wi === `disable_l2cache` -Setting this to `1` disables the CPU's access to the GPU's L2 cache and requires a corresponding L2 disabled kernel. Default value on BCM2835 is `0`. On BCM2836, BCM2837, BCM2711, and BCM2712, the ARMs have their own L2 cache and therefore the default is `1`. The standard Raspberry Pi `kernel.img` and `kernel7.img` builds reflect this difference in cache setting. +Setting this to `1` disables the CPU's access to the GPU's L2 cache and requires a corresponding L2 disabled kernel. Default value on BCM2835 is `0`. On BCM2836, BCM2837, BCM2711, and BCM2712, the Arm CPUs have their own L2 cache and therefore the default is `1`. The standard Raspberry Pi `kernel.img` and `kernel7.img` builds reflect this difference in cache setting. diff --git a/documentation/asciidoc/computers/legacy_config_txt/pi4-hdmi.adoc b/documentation/asciidoc/computers/legacy_config_txt/pi4-hdmi.adoc index e816edcec..62c6c8bef 100644 --- a/documentation/asciidoc/computers/legacy_config_txt/pi4-hdmi.adoc +++ b/documentation/asciidoc/computers/legacy_config_txt/pi4-hdmi.adoc @@ -1,4 +1,5 @@ -== Legacy Raspberry Pi 4 HDMI pipeline +[[raspberry-pi-4-hdmi-pipeline]] +== Raspberry Pi 4 HDMI pipeline IMPORTANT: When using the VC4 KMS graphics driver, the complete display pipeline is managed by Linux - this includes the HDMI outputs. These settings only apply to the legacy FKMS and firmware-based graphics driver. diff --git a/documentation/asciidoc/computers/legacy_config_txt/video.adoc b/documentation/asciidoc/computers/legacy_config_txt/video.adoc index 9fdc606d9..fd516df93 100644 --- a/documentation/asciidoc/computers/legacy_config_txt/video.adoc +++ b/documentation/asciidoc/computers/legacy_config_txt/video.adoc @@ -3,7 +3,7 @@ === HDMI mode -NOTE: Because Raspberry Pi 4 and Raspberry Pi 400 have two HDMI ports, some HDMI commands can be applied to either port. You can use the syntax `:`, where port is 0 or 1, to specify which port the setting should apply to. If no port is specified, the default is 0. If you specify a port number on a command that does not require a port number, the port is ignored. Further details on the syntax and alternative mechanisms can be found in the HDMI sub-section of the xref:legacy_config_txt.adoc#legacy-conditional-filters[conditionals section] of the documentation. +NOTE: For devices with multiple HDMI ports, some HDMI commands can be applied to any port. You can use the syntax `:`, where port is 0 or 1, to specify which port the setting should apply to. If no port is specified, the default is 0. If you specify a port number on a command that does not require a port number, the port is ignored. Further details on the syntax and alternative mechanisms can be found in the HDMI sub-section of the xref:legacy_config_txt.adoc#legacy-conditional-filters[conditionals section] of the documentation. ==== `hdmi_safe` @@ -1299,7 +1299,7 @@ These values are valid if `hdmi_group=2` (DMT): | 1366x768 | 60Hz | 16:9 -| xref:config_txt.adoc#hdmi-pipeline-for-raspberry-pi-4-and-5[NOT on Raspberry Pi 4 and 5] +| xref:legacy_config_txt.adoc#raspberry-pi-4-hdmi-pipeline[NOT on Raspberry Pi 4] | 82 | 1920x1080 @@ -1678,7 +1678,7 @@ Increase this value if the text flows off the bottom edge of the screen; decreas Set `overscan_scale` to `1` to force any non-framebuffer layers to conform to the overscan settings. The default value is `0`. -*NOTE:* this feature is generally not recommended: it can reduce image quality because all layers on the display will be scaled by the GPU. Disabling overscan on the display itself is the recommended option to avoid images being scaled twice (by the GPU and the display). +NOTE: this feature is generally not recommended: it can reduce image quality because all layers on the display will be scaled by the GPU. Disabling overscan on the display itself is the recommended option to avoid images being scaled twice (by the GPU and the display). ==== `framebuffer_width` diff --git a/documentation/asciidoc/computers/linux_kernel.adoc b/documentation/asciidoc/computers/linux_kernel.adoc index e9bd941d0..81bcb30d6 100644 --- a/documentation/asciidoc/computers/linux_kernel.adoc +++ b/documentation/asciidoc/computers/linux_kernel.adoc @@ -8,3 +8,4 @@ include::linux_kernel/patching.adoc[] include::linux_kernel/headers.adoc[] +include::linux_kernel/contribute.adoc[] diff --git a/documentation/asciidoc/computers/linux_kernel/about-kernel.adoc b/documentation/asciidoc/computers/linux_kernel/about-kernel.adoc index 13c1acebf..4f9f87146 100644 --- a/documentation/asciidoc/computers/linux_kernel/about-kernel.adoc +++ b/documentation/asciidoc/computers/linux_kernel/about-kernel.adoc @@ -1,23 +1,8 @@ -== Kernel +[[kernel]] +== Introduction -The Raspberry Pi kernel is https://github.com/raspberrypi/linux[hosted on GitHub]; updates lag behind the upstream https://github.com/torvalds/linux[Linux kernel]. The upstream kernel is continuously updating; we take long-term releases of the kernel, which are mentioned on the front page, and integrate the changes into our own Raspberry Pi kernel. We then create a 'next' branch which contains an unstable port of the kernel, and after extensive testing and discussion, we push this to the main branch of our repository. +The Raspberry Pi kernel is https://github.com/raspberrypi/linux[hosted on GitHub]; updates lag behind the upstream https://github.com/torvalds/linux[Linux kernel]. The upstream kernel updates continuously, whereas Raspberry Pi integrates **long-term releases** of the Linux kernel into the Raspberry Pi kernel. We generate a `next` branch in https://github.com/raspberrypi/firmware/[raspberrypi/firmware] for each long-term Linux kernel release. After extensive testing and discussion, we merge each `next` branch into the main branch of our repository. -=== Updating your kernel +== Update -If you use the standard Raspberry Pi OS xref:os.adoc#updating-and-upgrading-raspberry-pi-os[update and upgrade process], this will automatically update the kernel to the latest stable version of our kernel. This is the recommended procedure. However, in certain circumstances, you may wish to update to the latest "bleeding edge" or test kernel. You should only do this if recommended to do so by a Raspberry Pi engineer, or if there is a specific feature only available in this latest software. - -=== Getting your code into the kernel - -There are many reasons you may want to put something into the kernel: - -* You've written some Raspberry Pi-specific code that you want everyone to benefit from -* You've written a generic Linux kernel driver for a device and want everyone to use it -* You've fixed a generic kernel bug -* You've fixed a Raspberry Pi-specific kernel bug - -Initially, you should fork the https://github.com/raspberrypi/linux[Linux repository] and clone that on your build system; this can be either on your Raspberry Pi or on a Linux machine you're using for cross-compiling. You can then make your changes, test them, and commit them into your fork. - -Next, depending upon whether the code is Raspberry Pi-specific or not: - -* For Raspberry Pi-specific changes or bug fixes, submit a pull request to the kernel. -* For general Linux kernel changes (i.e. a new driver), these need to be submitted upstream first. Once they've been submitted upstream and accepted, submit the pull request and we'll receive it. +The usual Raspberry Pi OS xref:os.adoc#update-software[update process] automatically updates your kernel to the latest stable release. If you want to try the latest unstable test kernel, you can xref:os.adoc#rpi-update[manually update]. diff --git a/documentation/asciidoc/computers/linux_kernel/building.adoc b/documentation/asciidoc/computers/linux_kernel/building.adoc index ef59222c5..f659797b6 100644 --- a/documentation/asciidoc/computers/linux_kernel/building.adoc +++ b/documentation/asciidoc/computers/linux_kernel/building.adoc @@ -1,266 +1,409 @@ [[building]] -== Building the kernel +== Build the kernel -The default compilers and linkers that come with an OS are configured to build executables to run on that OS - they are native tools - but that doesn't have to be the case. A cross-compiler is configured to build code for a target other than the one running the build process, and using it is called cross-compilation. +The default compilers and linkers distributed with an OS are configured to build executables to run on that OS. **Native builds** use these default compilers and linkers. **Cross-compilation** is the process of building code for a target other than the one running the build process. -Cross-compilation of the Raspberry Pi kernel is useful for two reasons: it allows a 64-bit kernel to be built using a 32-bit OS, and vice versa. It also means that even a modest laptop can cross-compile a Raspberry Pi kernel significantly faster than the Raspberry Pi itself. +Cross-compilation of the Raspberry Pi kernel allows you to build a 64-bit kernel from a 32-bit OS, and vice versa. Alternatively, you can cross-compile a 32-bit or 64-bit Raspberry Pi kernel from a device other than a Raspberry Pi. -The instructions below are divided into native builds and cross-compilation. Choose the section appropriate for your situation; although there are many common steps between the two, there are also some important differences. +The instructions below are divided into native builds and cross-compilation. Choose the section appropriate for your situation; although the two processes share many steps, there are also some important differences. -=== Building the kernel locally +=== Download kernel source -IMPORTANT: Building the 64-bit kernel on the 32-bit distribution of Raspberry Pi OS is a cross-compilation exercise because it requires the installation of the cross-compiler (`gcc-aarch64-linux-gnu`). If you're running the 32-bit distribution of Raspberry Pi OS on a Pi 4B, Pi 400, CM4 or CM4S then you'll be running a 32-bit userland, and 64-bit kernel — so if you want to explicitly build a 32-bit kernel you should set `ARCH=arm`, and to boot this kernel you'll need to set `arm_64bit=0` in `config.txt`. We provide instructions for <>. +Before you can build for any target, you need the kernel source. To get the kernel source, you need Git. Begin by installing Git on your device, if you don't already have it: -On a Raspberry Pi, first install the latest version of https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-32-bit[Raspberry Pi OS]. Then boot your Raspberry Pi, log in, and ensure you're connected to the internet to give you access to the sources. - -First install Git and the build dependencies: - -[,bash] +[source,console] ---- -sudo apt install git bc bison flex libssl-dev make +$ sudo apt install git ---- -Next get the sources, which will take some time: +Next, download the source code for the latest Raspberry Pi kernel: -[,bash] +[source,console] ---- -git clone --depth=1 https://github.com/raspberrypi/linux +$ git clone --depth=1 https://github.com/raspberrypi/linux ---- -[[choosing_sources]] -==== Choosing sources +This can take several minutes. -The `git clone` command above will download the current active branch (the one we are building Raspberry Pi OS images from) without any history. Omitting the `--depth=1` will download the entire repository, including the full history of all branches, but this takes much longer and occupies much more storage. +[TIP] +==== +The `git clone` command above downloads the current active branch, which we build Raspberry Pi OS images from, without any history. Omit `--depth=1` to download the entire repository, including the full history of all branches. This takes much longer and occupies much more storage. -To download a different branch (again with no history), use the `--branch` option: +To download a different branch with no history, add the `--branch` option to the command above, replacing `` with the name of the branch you wish to download: -[,bash] +[source,console] ---- -git clone --depth=1 --branch https://github.com/raspberrypi/linux +$ git clone --depth=1 --branch https://github.com/raspberrypi/linux ---- -where `` is the name of the branch that you wish to download. +For a full list of available branches, see the https://github.com/raspberrypi/linux[the Raspberry Pi kernel repository]. +==== + +Now that you have the kernel source, build a fresh kernel xref:linux_kernel.adoc#natively-build-a-kernel[natively] or via xref:linux_kernel.adoc#cross-compile-the-kernel[cross-compilation]. + +=== Natively build a kernel -Refer to the https://github.com/raspberrypi/linux[original GitHub repository] for information about the available branches. +This guide assumes that your Raspberry Pi runs the latest version of xref:os.adoc[Raspberry Pi OS]. + +First, install the build dependencies: + +[source,console] +---- +$ sudo apt install bc bison flex libssl-dev make +---- -==== Kernel configuration +[[native-build-configuration]] +==== Build configuration -Configure the kernel; as well as the default configuration, you may wish to xref:linux_kernel.adoc#configuring-the-kernel[configure your kernel in more detail] or xref:linux_kernel.adoc#patching-the-kernel[apply patches from another source], to add or remove required functionality. +This section describes how to apply the default configuration when you build a kernel. You can also configure your kernel in the following ways: -[[default_configuration]] -===== Apply the default configuration +* xref:linux_kernel.adoc#configure-the-kernel[enable and disable kernel features] +* xref:linux_kernel.adoc#patch-the-kernel[apply patches from another source] -First, prepare the default configuration by running the following commands, depending on your Raspberry Pi model. +To prepare the default configuration, run the appropriate commands from the table below for your Raspberry Pi model. -For Raspberry Pi 1, Zero and Zero W, and Raspberry Pi Compute Module 1 default (32-bit only) build configuration: +[cols="8,<.^20a,60a"] +|=== +| Architecture | Raspberry Pi Model | Command -[,bash] +.12+^.^| 64-bit +| 3 +.9+.^| +[source,console] ---- -cd linux -KERNEL=kernel -make bcmrpi_defconfig +$ cd linux +$ KERNEL=kernel8 +$ make bcm2711_defconfig ---- +| Compute Module 3 +| 3+ +| Compute Module 3+ +| Zero 2 W +| 4 +| 400 +| Compute Module 4 +| Compute Module 4S -For Raspberry Pi 2, 3, 3+ and Zero 2 W, and Raspberry Pi Compute Modules 3 and 3+ default 32-bit build configuration: -[,bash] +.^| 5 +.3+.^| +[source,console] ---- -cd linux -KERNEL=kernel7 -make bcm2709_defconfig +$ cd linux +$ KERNEL=kernel_2712 +$ make bcm2712_defconfig ---- +| 500/500+ +| Compute Module 5 -For Raspberry Pi 4 and 400, and Raspberry Pi Compute Module 4 default 32-bit build configuration: - -[,bash] +.14+^.^| 32-bit +| 1 +.4+.^| +[source,console] ---- -cd linux -KERNEL=kernel7l -make bcm2711_defconfig +$ cd linux +$ KERNEL=kernel +$ make bcmrpi_defconfig ---- +| Compute Module 1 +| Zero +| Zero W + -For Raspberry Pi 3, 3+, 4, 400 and Zero 2 W, and Raspberry Pi Compute Modules 3, 3+ and 4 default 64-bit build configuration: -[,bash] +| 2 +.6+.^| +[source,console] ---- -cd linux -KERNEL=kernel8 -make bcm2711_defconfig +$ cd linux +$ KERNEL=kernel7 +$ make bcm2709_defconfig ---- +| 3 +| Compute Module 3 +| 3+ +| Compute Module 3+ +| Zero 2 W -For Raspberry Pi 5 default 64-bit build configuration: -[,bash] + +| 4 +.4+.^| +[source,console] ---- -cd linux -KERNEL=kernel_2712 -make bcm2712_defconfig +$ cd linux +$ KERNEL=kernel7l +$ make bcm2711_defconfig ---- +| 400 +| Compute Module 4 +| Compute Module 4S +|=== + +[NOTE] +==== +The 32-bit distribution of Raspberry Pi OS on 4-series devices uses a 32-bit userland, but a _64-bit kernel_. To build a 32-bit kernel, set `ARCH=arm`. To boot a 32-bit kernel, set `arm_64bit=0` in `config.txt`. +==== -===== Customising the kernel version using `LOCALVERSION` +[[native-customisation]] +==== Customise the kernel version using `LOCALVERSION` -In addition to your kernel configuration changes, you may wish to adjust `LOCALVERSION` to ensure your new kernel does not receive the same version string as the upstream kernel. This clarifies that you are running your own kernel in the output of `uname`, and ensures that existing modules in `/lib/modules` are not overwritten. +To prevent the kernel from overwriting existing modules in `/lib/modules` and to clarify that you run your own kernel in `uname` output, adjust `LOCALVERSION`. To adjust `LOCALVERSION`, change the following line in `.config`: +[source,ini] ---- CONFIG_LOCALVERSION="-v7l-MY_CUSTOM_KERNEL" ---- -You can also change this setting graphically as shown in xref:linux_kernel.adoc#configuring-the-kernel[the kernel configuration instructions]. It is located in "General setup" \=> "Local version - append to kernel release". +TIP: You can also change this setting graphically with `menuconfig` at *General setup* > *Local version - append to kernel release*. For more information about `menuconfig`, see xref:linux_kernel.adoc#configure-the-kernel[the kernel configuration instructions]. -==== Building the kernel +[[native-build]] +==== Build -Build and install the kernel, modules, and Device Tree blobs. This step can take a long time depending on the Raspberry Pi model you are using. For the 32-bit kernel: +Next, build the kernel. This step can take a long time, depending on your Raspberry Pi model. -[,bash] +* Run the following commands to build a 64-bit kernel: ++ +[source,console] ---- -make -j4 zImage modules dtbs -sudo make modules_install -# Choose one of the following based on the kernel version - # For kernels up to 6.4: - sudo cp arch/arm/boot/dts/*.dtb /boot/firmware/ - # For kernel 6.5 and above: - sudo cp arch/arm/boot/dts/broadcom/*.dtb /boot/firmware/ -sudo cp arch/arm/boot/dts/overlays/*.dtb* /boot/firmware/overlays/ -sudo cp arch/arm/boot/dts/overlays/README /boot/firmware/overlays/ -sudo cp arch/arm/boot/zImage /boot/firmware/$KERNEL.img +$ make -j6 Image.gz modules dtbs ---- -For the 64-bit kernel: - -[,bash] +* Run the following command to build a 32-bit kernel: ++ +[source,console] ---- -make -j4 Image.gz modules dtbs -sudo make modules_install -sudo cp arch/arm64/boot/dts/broadcom/*.dtb /boot/firmware/ -sudo cp arch/arm64/boot/dts/overlays/*.dtb* /boot/firmware/overlays/ -sudo cp arch/arm64/boot/dts/overlays/README /boot/firmware/overlays/ -sudo cp arch/arm64/boot/Image.gz /boot/firmware/$KERNEL.img +$ make -j6 zImage modules dtbs ---- -NOTE: On Raspberry Pi 2, 3, 4 and 5, the `-j4` flag splits the work between all four cores, speeding up compilation significantly. +TIP: On multi-core Raspberry Pi models, the `make -j` option distributes work between cores. This can speed up compilation significantly. Run `nproc` to see how many processors you have; we recommend passing a number 1.5x your number of processors. -If you now reboot, your Raspberry Pi should be running your freshly-compiled kernel. +[[native-install]] +==== Install the kernel -=== Cross-compiling the kernel +Next, install the kernel modules onto the boot media: -First, you will need a suitable Linux cross-compilation host. We tend to use Ubuntu; since Raspberry Pi OS is also a Debian distribution, it means many aspects are similar, such as the command lines. +[source,console] +---- +$ sudo make -j6 modules_install +---- -You can either do this using VirtualBox (or VMWare) on Windows, or install it directly onto your computer. +Then, install the kernel and Device Tree blobs into the boot partition, backing up your original kernel. -==== Install required dependencies and toolchain +TIP: If you don't want to install the freshly-compiled kernel onto the Raspberry Pi where you run this command, copy the compiled kernel to the boot partition of a separate boot media instead of `/boot/firmware/`. -To build the sources for cross-compilation, make sure you have the dependencies needed on your machine by executing: +To install the 64-bit kernel: -[,bash] +* Run the following commands to create a backup image of the current kernel, install the fresh kernel image, overlays, README, and unmount the partitions: ++ +[source,console] ---- -sudo apt install git bc bison flex libssl-dev make libc6-dev libncurses5-dev +$ sudo cp /boot/firmware/$KERNEL.img /boot/firmware/$KERNEL-backup.img +$ sudo cp arch/arm64/boot/Image.gz /boot/firmware/$KERNEL.img +$ sudo cp arch/arm64/boot/dts/broadcom/*.dtb /boot/firmware/ +$ sudo cp arch/arm64/boot/dts/overlays/*.dtb* /boot/firmware/overlays/ +$ sudo cp arch/arm64/boot/dts/overlays/README /boot/firmware/overlays/ ---- -===== Install the 32-bit toolchain for a 32-bit kernel +To install the 32-bit kernel: -[,bash] +. Create a backup of your current kernel and install the fresh kernel image: ++ +[source,console] +---- +$ sudo cp /boot/firmware/$KERNEL.img /boot/firmware/$KERNEL-backup.img +$ sudo cp arch/arm/boot/zImage /boot/firmware/$KERNEL.img +---- +. Depending on your xref:linux_kernel.adoc#identify-your-kernel-version[kernel version], run the following command: + ** For kernels up to version 6.4: ++ +[source,console] +---- +$ sudo cp arch/arm/boot/dts/*.dtb /boot/firmware/ +---- +** For kernels version 6.5 and above: ++ +[source,console] +---- +$ sudo cp arch/arm/boot/dts/broadcom/*.dtb /boot/firmware/ +---- +. Finally, copy over the overlays and README: ++ +[source,console] ---- -sudo apt install crossbuild-essential-armhf +$ sudo cp arch/arm/boot/dts/overlays/*.dtb* /boot/firmware/overlays/ +$ sudo cp arch/arm/boot/dts/overlays/README /boot/firmware/overlays/ ---- -===== Install the 64-bit toolchain for a 64-bit kernel +Finally, run the following command to reboot your Raspberry Pi and run your freshly-compiled kernel: -[,bash] +[source,console] ---- -sudo apt install crossbuild-essential-arm64 +$ sudo reboot ---- -==== Get the kernel sources +[TIP] +==== +Alternatively, copy the kernel with a different filename (e.g. `kernel-myconfig.img`) instead of overwriting the `kernel.img` file. Then, edit `config.txt` in the boot partition to select your kernel: -To download the minimal source tree for the current branch, run: - -[,bash] +[source,ini] ---- -git clone --depth=1 https://github.com/raspberrypi/linux +kernel=kernel-myconfig.img ---- -See <> above for instructions on how to choose a different branch. +Combine this approach with a custom `LOCALVERSION` to keep your custom kernel separate from the stock kernel image managed by the system. With this arrangement, you can quickly revert to a stock kernel in the event that your kernel cannot boot. +==== -==== Build sources +=== Cross-compile the kernel -Enter the following commands to build the sources and Device Tree files: +First, you will need a suitable Linux cross-compilation host. We tend to use Ubuntu; since Raspberry Pi OS is also a Debian distribution, compilation commands are similar. -===== 32-bit configs +[[cross-compiled-dependencies]] +==== Install required dependencies and toolchain -For Raspberry Pi 1, Zero and Zero W, and for Raspberry Pi Compute Module 1: +To build the sources for cross-compilation, install the required dependencies onto your device. Run the following command to install most dependencies: -[,bash] +[source,console] ---- -cd linux -KERNEL=kernel -make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- bcmrpi_defconfig +$ sudo apt install bc bison flex libssl-dev make libc6-dev libncurses5-dev ---- -For Raspberry Pi 2, 3, 3+ and Zero 2 W, and Raspberry Pi Compute Modules 3 and 3+: +Then, install the proper toolchain for the kernel architecture you wish to build: -[,bash] +* To install the 64-bit toolchain to build a 64-bit kernel, run the following command: ++ +[source,console] ---- -cd linux -KERNEL=kernel7 -make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- bcm2709_defconfig +$ sudo apt install crossbuild-essential-arm64 ---- -For Raspberry Pi 4 and 400, and Raspberry Pi Compute Module 4: - -[,bash] +* To install the 32-bit toolchain to build a 32-bit kernel, run the following command: ++ +[source,console] ---- -cd linux -KERNEL=kernel7l -make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- bcm2711_defconfig +$ sudo apt install crossbuild-essential-armhf ---- -===== 64-bit configs +[[cross-compiled-build-configuration]] +==== Build configuration + +This section describes how to apply the default configuration when you build a kernel. You can also configure your kernel in the following ways: -For Raspberry Pi 3, 3+, 4, 400 and Zero 2 W, and Raspberry Pi Compute Modules 3, 3+ and 4: +* xref:linux_kernel.adoc#configure-the-kernel[enable and disable kernel features] +* xref:linux_kernel.adoc#patch-the-kernel[apply patches from another source] -[,bash] +Enter the following commands to build the sources and Device Tree files: + +[cols="8,<.^20a,60a"] +|=== +| Target Architecture | Target Raspberry Pi Model | Command + +.12+^.^| 64-bit +| 3 +.9+.^| [source,console] ---- -cd linux -KERNEL=kernel8 -make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- bcm2711_defconfig +$ cd linux +$ KERNEL=kernel8 +$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- bcm2711_defconfig ---- +| Compute Module 3 +| 3+ +| Compute Module 3+ +| Zero 2 W +| 4 +| 400 +| Compute Module 4 +| Compute Module 4S -For Raspberry Pi 5: +.^| 5 +.3+.^| +[source,console] +---- +$ cd linux +$ KERNEL=kernel_2712 +$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- bcm2712_defconfig +---- +| 500/500+ +| Compute Module 5 + +.14+^.^| 32-bit +| 1 +.4+.^| [source,console] +---- +$ cd linux +$ KERNEL=kernel +$ make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- bcmrpi_defconfig +---- +| Compute Module 1 +| Zero +| Zero W -[,bash] +| 2 +.6+.^| +[source,console] ---- -cd linux -KERNEL=kernel_2712 -make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- bcm2712_defconfig +$ cd linux +$ KERNEL=kernel7 +$ make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- bcm2709_defconfig ---- +| 3 +| Compute Module 3 +| 3+ +| Compute Module 3+ +| Zero 2 W -NOTE: The standard, `bcm2711_defconfig`-based kernel (`kernel8.img`) also runs on Raspberry Pi 5. For best performance you should use `kernel_2712.img`, but for situations where a 4KB page size is required then `kernel8.img` (`kernel=kernel8.img`) should be used. +| 4 +.4+.^| +[source,console] +---- +$ cd linux +$ KERNEL=kernel7l +$ make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- bcm2711_defconfig +---- +| 400 +| Compute Module 4 +| Compute Module 4S +|=== -===== Build with configs +[[cross-compiled-customisation]] +==== Customise the kernel version using `LOCALVERSION` -NOTE: To speed up compilation on multiprocessor systems, and get some improvement on single-processor devices, use `-j n`, where n is the number of processors × 1.5. You can use the `nproc` command to see how many processors you have. +To prevent the kernel from overwriting existing modules in `/lib/modules` and to clarify that you run your own kernel in `uname` output, adjust `LOCALVERSION`. -====== For all 32-bit builds +To adjust `LOCALVERSION`, change the following line in `.config`: -[,bash] +[source,ini] ---- -make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- zImage modules dtbs +CONFIG_LOCALVERSION="-v7l-MY_CUSTOM_KERNEL" ---- -====== For all 64-bit builds +TIP: You can also change this setting graphically with `menuconfig` at *General setup* > *Local version - append to kernel release*. For more information about `menuconfig`, see xref:linux_kernel.adoc#configure-the-kernel[the kernel configuration instructions]. -NOTE: Note the difference between Image target between 32- and 64-bit. +[[cross-compiled-build]] +==== Build + +* Run the following command to build a 64-bit kernel: ++ +[source,console] +---- +$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- Image modules dtbs +---- -[,bash] +* Run the following command to build a 32-bit kernel: ++ +[source,console] ---- -make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- Image modules dtbs +$ make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- zImage modules dtbs ---- -==== Install directly onto the SD card +[[cross-compiled-install]] +==== Install the kernel -Having built the kernel, you need to copy it onto your Raspberry Pi and install the modules. This is best done directly using an SD card reader. +Having built the kernel, you need to copy it onto your Raspberry Pi boot media (likely an SD card or SSD) and install the modules. -First, use `lsblk` before and after plugging in your SD card to identify it. You should end up with something a lot like this: +===== Find your boot media + +First, run `lsblk`. Then, connect your boot media. Run `lsblk` again; the new device represents your boot media. You should see output similar to the following: ---- sdb @@ -268,75 +411,100 @@ sdb sdb2 ---- -with `sdb1` being the `FAT` filesystem (boot) partition, and `sdb2` being the `ext4` filesystem (root) partition. +If `sdb` represents your boot media, `sdb1` represents the the `FAT32`-formatted **boot partition** and `sdb2` represents the (likely `ext4`-formatted) **root partition**. -Mount these first, adjusting the partition letter as necessary: +First, mount these partitions as `mnt/boot` and `mnt/root`, adjusting the partition letter to match the location of your boot media: -[,bash] +[source,console] ---- -mkdir mnt -mkdir mnt/fat32 -mkdir mnt/ext4 -sudo mount /dev/sdb1 mnt/fat32 -sudo mount /dev/sdb2 mnt/ext4 +$ mkdir mnt +$ mkdir mnt/boot +$ mkdir mnt/root +$ sudo mount /dev/sdb1 mnt/boot +$ sudo mount /dev/sdb2 mnt/root ---- -NOTE: You should adjust the drive letter appropriately for your setup, e.g. if your SD card appears as `/dev/sdc` instead of `/dev/sdb`. - -Next, install the kernel modules onto the SD card: +===== Install -===== For 32-bit +Next, install the kernel modules onto the boot media: -[,bash] +* For 64-bit kernels: ++ +[source,console] ---- -sudo env PATH=$PATH make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- INSTALL_MOD_PATH=mnt/ext4 modules_install +$ sudo env PATH=$PATH make -j12 ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- INSTALL_MOD_PATH=mnt/root modules_install ---- -===== For 64-bit - -[,bash] +* For 32-bit kernels: ++ +[source,console] ---- -sudo env PATH=$PATH make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- INSTALL_MOD_PATH=mnt/ext4 modules_install +$ sudo env PATH=$PATH make -j12 ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- INSTALL_MOD_PATH=mnt/root modules_install ---- -Finally, copy the kernel and Device Tree blobs onto the SD card, making sure to back up your old kernel: +TIP: On multi-core devices, the `make -j` option distributes work between cores. This can speed up compilation significantly. Run `nproc` to see how many processors you have; we recommend passing a number 1.5x your number of processors. + +Next, install the kernel and Device Tree blobs into the boot partition, backing up your original kernel. -===== For 32-bit +To install the 64-bit kernel: -[,bash] +* Run the following commands to create a backup image of the current kernel, install the fresh kernel image, overlays, README, and unmount the partitions: ++ +[source,console] ---- -sudo cp mnt/fat32/$KERNEL.img mnt/fat32/$KERNEL-backup.img -sudo cp arch/arm/boot/zImage mnt/fat32/$KERNEL.img -# Choose one of the following based on the kernel version - # For kernels up to 6.4: - sudo cp arch/arm/boot/dts/*.dtb mnt/fat32/ - # For kernel 6.5 and above: - sudo cp arch/arm/boot/dts/broadcom/*.dtb mnt/fat32/ -sudo cp arch/arm/boot/dts/overlays/*.dtb* mnt/fat32/overlays/ -sudo cp arch/arm/boot/dts/overlays/README mnt/fat32/overlays/ -sudo umount mnt/fat32 -sudo umount mnt/ext4 +$ sudo cp mnt/boot/$KERNEL.img mnt/boot/$KERNEL-backup.img +$ sudo cp arch/arm64/boot/Image mnt/boot/$KERNEL.img +$ sudo cp arch/arm64/boot/dts/broadcom/*.dtb mnt/boot/ +$ sudo cp arch/arm64/boot/dts/overlays/*.dtb* mnt/boot/overlays/ +$ sudo cp arch/arm64/boot/dts/overlays/README mnt/boot/overlays/ +$ sudo umount mnt/boot +$ sudo umount mnt/root ---- -===== For 64-bit +To install the 32-bit kernel: + +. Run the following commands to create a backup image of the current kernel and install the fresh kernel image: ++ +[source,console] +---- +$ sudo cp mnt/boot/$KERNEL.img mnt/boot/$KERNEL-backup.img +$ sudo cp arch/arm/boot/zImage mnt/boot/$KERNEL.img +---- -[,bash] +. Depending on your xref:linux_kernel.adoc#identify-your-kernel-version[kernel version], run the following command to install Device Tree blobs: + ** For kernels up to version 6.4: ++ +[source,console] ---- -sudo cp mnt/fat32/$KERNEL.img mnt/fat32/$KERNEL-backup.img -sudo cp arch/arm64/boot/Image mnt/fat32/$KERNEL.img -sudo cp arch/arm64/boot/dts/broadcom/*.dtb mnt/fat32/ -sudo cp arch/arm64/boot/dts/overlays/*.dtb* mnt/fat32/overlays/ -sudo cp arch/arm64/boot/dts/overlays/README mnt/fat32/overlays/ -sudo umount mnt/fat32 -sudo umount mnt/ext4 +$ sudo cp arch/arm/boot/dts/*.dtb mnt/boot/ +---- +** For kernels version 6.5 and above: ++ +[source,console] +---- +$ sudo cp arch/arm/boot/dts/broadcom/*.dtb mnt/boot/ +---- +. Finally, install the overlays and README, and unmount the partitions: ++ +[source,console] +---- +$ sudo cp arch/arm/boot/dts/overlays/*.dtb* mnt/boot/overlays/ +$ sudo cp arch/arm/boot/dts/overlays/README mnt/boot/overlays/ +$ sudo umount mnt/boot +$ sudo umount mnt/root ---- -Another option is to copy the kernel into the same place, but with a different filename - for instance, using `kernel-myconfig.img` - rather than overwriting the `kernel.img` file. You can then edit the `config.txt` file to select the kernel that the Raspberry Pi will boot: +Finally, connect the boot media to your Raspberry Pi and connect it to power to run your freshly-compiled kernel. + +[TIP] +==== +Alternatively, copy the kernel with a different filename (e.g. `kernel-myconfig.img`) instead of overwriting the `kernel.img` file. Then, edit `config.txt` in the boot partition to select your kernel: + +[source,ini] ---- kernel=kernel-myconfig.img ---- -This has the advantage of keeping your custom kernel separate from the stock kernel image managed by the system and any automatic update tools, and allowing you to easily revert to a stock kernel in the event that your kernel cannot boot. - -Finally, plug the card into the Raspberry Pi and boot it. +Combine this approach with a custom `LOCALVERSION` to keep your custom kernel separate from the stock kernel image managed by the system. With this arrangement, you can quickly revert to a stock kernel in the event that your kernel cannot boot. +==== diff --git a/documentation/asciidoc/computers/linux_kernel/configuring.adoc b/documentation/asciidoc/computers/linux_kernel/configuring.adoc index bc1ee52af..f0bd89da6 100644 --- a/documentation/asciidoc/computers/linux_kernel/configuring.adoc +++ b/documentation/asciidoc/computers/linux_kernel/configuring.adoc @@ -1,49 +1,56 @@ -== Configuring the kernel +== Configure the kernel The Linux kernel is highly configurable. Advanced users may wish to modify the default configuration to customise it to their needs, such as enabling a new or experimental network protocol, or enabling support for new hardware. -Configuration is most commonly done through the `make menuconfig` interface. Alternatively, you can modify your `.config` file manually, but this can be more difficult for new users. +Configuration is most commonly done through the `make menuconfig` interface. Alternatively, you can modify your `.config` file manually, but this can be more difficult. -=== Preparing to configure +=== Prepare to configure -The `menuconfig` tool requires the `ncurses` development headers to compile properly. These can be installed with the following command: +The `menuconfig` tool requires the `ncurses` development headers to compile properly. To install these headers, run the following command: -[,bash] +[source,console] ---- - sudo apt install libncurses5-dev +$ sudo apt install libncurses5-dev ---- -You'll also need to download and prepare your kernel sources, as described in the xref:linux_kernel.adoc#choosing_sources[build guide]. In particular, ensure you have installed the xref:linux_kernel.adoc#default_configuration[default configuration]. +Next, xref:linux_kernel.adoc#download-kernel-source[download your kernel sources]. In particular, ensure you have installed the xref:linux_kernel.adoc#native-build-configuration[default native configuration] or xref:linux_kernel.adoc#cross-compiled-build-configuration[default cross-compilation configuration]. -=== Using `menuconfig` +=== `menuconfig` -Once you've got everything set up and ready to go, you can compile and run the `menuconfig` utility as follows: +Once you've got everything set up, you can compile and run the `menuconfig` utility as follows: -[,bash] +[source,console] ---- - make menuconfig +$ make menuconfig ---- -If you're cross-compiling a 32-bit kernel: +To cross-compile a 64-bit kernel: -[,bash] +[source,console] ---- -make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- menuconfig +$ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- menuconfig ---- -Or, if you are cross-compiling a 64-bit kernel: +To cross-compile a 32-bit kernel: -[,bash] +[source,console] ---- -make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- menuconfig +$ make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- menuconfig ---- -The `menuconfig` utility has simple keyboard navigation. After a brief compilation, you'll be presented with a list of submenus containing all the options you can configure. There are many options, so take your time to read through them and get acquainted. +To navigate the `menuconfig` utility, use your keyboard: -Use the arrow keys to navigate, the Enter key to enter a submenu (indicated by `+--->+`), Escape twice to go up a level or exit, and the space bar to cycle the state of an option. Some options have multiple choices, in which case they'll appear as a submenu and the Enter key will select an option. You can press `h` on most entries to get help about that specific option or menu. +* to navigate directionally, use the *arrow keys* +* to enter a submenu (indicated by `+--->+`), press the *Enter* key +* to go up a level or exit, press *Escape* twice +* to toggle the state of a binary option, press the *space bar* +* to select the state of a multiple choice option, press *Enter* to open a submenu, the *arrow keys* to navigate the submenu, and press *Enter* again to select a state +* to get help with an option or menu, press the *H* key -Resist the temptation to enable or disable a lot of things on your first attempt; it's relatively easy to break your configuration, so start small and get comfortable with the configuration and build process. +After a brief compilation, `menuconfig` presents a list of submenus containing all the options you can configure. There are many options, so take your time to read through them. Resist the temptation to enable or disable a lot of things on your first attempt; it's relatively easy to break your configuration, so start small and get comfortable with the configuration and build process. -=== Saving your changes +=== Save your changes -Once you're done making the changes you want, press Escape until you're prompted to save your new configuration. By default, this will save to the `.config` file. You can save and load configurations by copying this file. +Once you're done making changes, press *Escape* until you're prompted to save your new configuration. By default, this saves to the `.config` file. You can save and load configurations by copying this file. + +After customising, you should now be ready to xref:linux_kernel.adoc#building[build the kernel]. diff --git a/documentation/asciidoc/computers/linux_kernel/contribute.adoc b/documentation/asciidoc/computers/linux_kernel/contribute.adoc new file mode 100644 index 000000000..74d03d865 --- /dev/null +++ b/documentation/asciidoc/computers/linux_kernel/contribute.adoc @@ -0,0 +1,24 @@ +== Contribute + +There are many reasons you may want to put something into the kernel: + +* You've written some Raspberry Pi-specific code that you want everyone to benefit from +* You've written a generic Linux kernel driver for a device and want everyone to use it +* You've fixed a generic kernel bug +* You've fixed a Raspberry Pi-specific kernel bug + +For Raspberry Pi-specific changes or bug fixes, submit a pull request to the Raspberry Pi kernel. +For general Linux kernel changes (i.e. a new driver), submit a pull request to the upstream Linux kernel first. Once the Linux kernel accepts your change, we'll receive it. + +=== Contribute to the Raspberry Pi Kernel + +First, fork the https://github.com/raspberrypi/linux[Raspberry Pi kernel repository] and clone it to your development device. You can then make your changes, test them, and commit them into your fork. + +Then, submit a pull request containing your changes to the https://github.com/raspberrypi/linux[Raspberry Pi kernel repository]. Raspberry Pi engineers will review your contribution and suggest improvements. Once approved, we'll merge in your changes, and they'll eventually make their way to the stable release of the Raspberry Pi kernel. + +=== Contribute to the Linux kernel + +First, clone the https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git[Linux kernel tree] to your development device. You can then make your changes, test them, and commit them into your local tree. + +Once your change is ready you can submit it to the Linux kernel community. Linux kernel development happens on mailing lists, rather than on GitHub. In order for your change to become part of Linux, please email it to the community as a patch. Please follow https://www.kernel.org/doc/html/latest/process/submitting-patches.html[Submitting patches: the essential guide to getting your code into the kernel] and https://www.kernel.org/doc/html/latest/process/coding-style.html[Linux kernel coding style] in the Linux kernel documentation. +Linux kernel contributors will review your contribution and suggest improvements. Once approved, they'll merge in your changes. Eventually, they'll make their way into a long-term release of the Linux kernel. Once we've tested that long-term release for compatibility with the Raspberry Pi kernel, your changes will make their way into a stable release of the Raspberry Pi kernel. diff --git a/documentation/asciidoc/computers/linux_kernel/headers.adoc b/documentation/asciidoc/computers/linux_kernel/headers.adoc index b9bfd1f02..eae5281eb 100644 --- a/documentation/asciidoc/computers/linux_kernel/headers.adoc +++ b/documentation/asciidoc/computers/linux_kernel/headers.adoc @@ -1,23 +1,23 @@ == Kernel headers -If you are compiling a kernel module or similar, you will need the Linux kernel headers. These provide the various function and structure definitions required when compiling code that interfaces with the kernel. +To compile a kernel module, you need the Linux kernel headers. These provide the function and structure definitions required to compile code that interfaces with the kernel. -If you have cloned the entire kernel from GitHub, the headers are already included in the source tree. If you don't need all the extra files, it is possible to install only the kernel headers from the Raspberry Pi OS repo. +If you cloned the entire kernel from GitHub, the headers are already included in the source tree. If you don't need all the extra files, you can instead install only the kernel headers with `apt`. -If you are using the 32-bit version of Raspberry Pi OS, run: +TIP: When a new kernel is released, you need the headers that match that kernel version. It can take several weeks to update the `apt` package to reflect the latest kernel version. For the latest header versions, xref:linux_kernel.adoc#building[clone the kernel]. -[,bash] +If you use a 64-bit version of Raspberry Pi OS, run the following command to install the kernel headers: + +[source,console] ---- - sudo apt install linux-headers-rpi-{v6,v7,v7l} +$ sudo apt install linux-headers-rpi-v8 ---- -Or if you are using the 64-bit version of Raspberry Pi OS, run: +If you use a 32-bit version of Raspberry Pi OS, run the following command to install the kernel headers: -[,bash] +[source,console] ---- - sudo apt install linux-headers-rpi-v8 +$ sudo apt install linux-headers-rpi-{v6,v7,v7l} ---- -NOTE: It can take quite a while for this command to complete, as it installs a lot of small files. There is no progress indicator. - -When a new kernel release is made, you will need the headers that match that kernel version. It can take several weeks for the repo to be updated to reflect the latest kernel version. If this happens, the best approach is to xref:linux_kernel.adoc#building[clone the kernel]. +NOTE: Installation can take several minutes. There is no progress indicator. diff --git a/documentation/asciidoc/computers/linux_kernel/patching.adoc b/documentation/asciidoc/computers/linux_kernel/patching.adoc index 16b9a0ddc..29cf2bb1b 100644 --- a/documentation/asciidoc/computers/linux_kernel/patching.adoc +++ b/documentation/asciidoc/computers/linux_kernel/patching.adoc @@ -1,48 +1,67 @@ -== Patching the kernel +== Patch the kernel -When xref:linux_kernel.adoc#building[building] your custom kernel you may wish to apply patches, or collections of patches (patchsets), to the Linux kernel. +When building your custom kernel, you may wish to apply patches or collections of patches (patchsets) to the Linux kernel. -Patchsets are often provided with newer hardware as a temporary measure, before the patches are applied to the upstream (mainline) Linux kernel and then propagated down to the Raspberry Pi kernel sources. However, patchsets for other purposes exist, for instance to enable a fully preemptible kernel for real-time usage. +Hardware makers sometimes provide patchsets as a temporary measure to support new hardware before the patches make it into the Linux kernel and the Raspberry Pi kernel. However, patchsets for other purposes exist, for instance to enable a fully pre-emptible kernel for real-time usage. -=== Version identification +=== Identify your kernel version -It's important to check what version of the kernel you have when downloading and applying patches. In a kernel source directory, running `head Makefile -n 3` will show you the version the sources relate to: +To check the kernel version currently running on your device, run the following command: -[source] +[source,console] ---- +$ uname -r +---- + +Always check your version of the kernel before applying patches. In a kernel source directory, run the following command to see the kernel version: + +[source,console] +---- +$ head Makefile -n 4 +---- + +You should see output similar to the following: + +---- +# SPDX-License-Identifier: GPL-2.0 VERSION = 6 PATCHLEVEL = 1 SUBLEVEL = 38 ---- -In this instance, the sources are for a 6.1.38 kernel. You can see what version you're running on your system with the `uname -r` command. +In this instance, the sources are for a 6.1.38 kernel. + +=== Apply patches -=== Applying patches +The application of patches depends on the format used to distribute the patch. -How you apply patches depends on the format in which the patches are made available. Most patches are a single file, and are applied with the `patch` utility. To download and patch our example kernel version with the real-time kernel patches: +Developers distribute most patches as a single file. Use the `patch` utility to apply these patches. The following commands download, uncompress, and patch our example kernel version with real-time kernel patches: -[,bash] +[source,console] ---- - wget https://www.kernel.org/pub/linux/kernel/projects/rt/6.1/patch-6.1.38-rt13-rc1.patch.gz - gunzip patch-6.1.38-rt13-rc1.patch.gz - cat patch-6.1.38-rt13-rc1.patch | patch -p1 +$ wget https://www.kernel.org/pub/linux/kernel/projects/rt/6.1/patch-6.1.38-rt13-rc1.patch.gz +$ gunzip patch-6.1.38-rt13-rc1.patch.gz +$ cat patch-6.1.38-rt13-rc1.patch | patch -p1 ---- -In our example we simply download the file, uncompress it, and then pass it to the `patch` utility using the `cat` tool and a Unix pipe. +Some developers distribute patches in the *mailbox format*, a folder containing multiple patch files. Use Git to apply these patches. -Some patchsets come as mailbox-format patchsets, arranged as a folder of patch files. We can use Git to apply these patches to our kernel, but first we must configure Git to let it know who we are when we make these changes: +[NOTE] +==== +Before using Git to apply mailbox patches, configure your local Git installation with a name and email: -[,bash] +[source,console] ---- - git config --global user.name "Your name" - git config --global user.email "your email in here" +$ git config --global user.name "your name" +$ git config --global user.email "your email" ---- +==== -Once we've done this we can apply the patches: +To apply the mailbox formatted patches with Git, run the following command: -[,bash] +[source,console] ---- - git am -3 /path/to/patches/* +$ git am -3 /path/to/patches/* ---- -If in doubt, consult with the distributor of the patches, who should tell you how to apply them. Some patchsets will require a specific commit to patch against; follow the details provided by the patch distributor. +Always follow the instructions provided by the patch distributor. For instance, some patchsets require patching against a specific commit. diff --git a/documentation/asciidoc/computers/os.adoc b/documentation/asciidoc/computers/os.adoc index 3d6194aaa..bdabf4fa4 100644 --- a/documentation/asciidoc/computers/os.adoc +++ b/documentation/asciidoc/computers/os.adoc @@ -4,8 +4,6 @@ include::os/updating.adoc[] include::os/playing-audio-and-video.adoc[] -include::os/using-webcams.adoc[] - include::os/graphics-utilities.adoc[] include::os/accessibility.adoc[] diff --git a/documentation/asciidoc/computers/os/accessibility.adoc b/documentation/asciidoc/computers/os/accessibility.adoc index 5b54e4263..453557162 100644 --- a/documentation/asciidoc/computers/os/accessibility.adoc +++ b/documentation/asciidoc/computers/os/accessibility.adoc @@ -2,12 +2,12 @@ === Visual aids -Users of Raspberry Pi OS who have visual impairments can find helpful tools in the *Recommended Software* menu. +Users of Raspberry Pi OS with visual impairments can find helpful tools in the *Recommended Software* menu. -We offer the https://help.gnome.org/users/orca/stable/introduction.html.en[Orca screen reader] to better navigate the Raspberry Pi operating system, along with a screen magnifier to increase the readability of UI and screen elements. +We offer https://help.gnome.org/users/orca/stable/introduction.html.en[Orca screen reader] to ease navigation of Raspberry Pi Desktop. Additionally, we offer screen magnifier to increase the readability of UI and screen elements. ==== Orca screen reader -You can install Orca screen reader from the *Recommended Software* section of the main Raspberry Pi menu. Alternatively you can press *Ctrl* + *Alt* + *Space* to automatically install Orca. +You can install Orca screen reader from the *Recommended Software* section of the main Raspberry Pi menu. Alternatively, press *Ctrl* + *Alt* + *Space* to automatically install Orca. -When booting Raspberry Pi OS for the first time after installing a new image, an automatic spoken reminder will play after 30 seconds. This reminder will provide instructions on how to install Orca. +When booting Raspberry Pi OS for the first time after installing a new image, an automatic spoken reminder plays after 30 seconds. This reminder provides instructions on how to install Orca. diff --git a/documentation/asciidoc/computers/os/graphics-utilities.adoc b/documentation/asciidoc/computers/os/graphics-utilities.adoc index f0189aafd..3c44bfcaf 100644 --- a/documentation/asciidoc/computers/os/graphics-utilities.adoc +++ b/documentation/asciidoc/computers/os/graphics-utilities.adoc @@ -2,178 +2,177 @@ There are several useful command-line utilities pre-installed in Raspberry Pi OS. -=== kmsprint +=== `kmsprint` The `kmsprint` tool can be used to list the display-modes supported by the monitors attached to the Raspberry Pi. Use `kmsprint` to see details of the monitors connected to the Raspberry Pi, and `kmsprint -m` to see a list of all the display modes supported by each monitor. You can find source code for the `kmsprint` utility https://github.com/tomba/kmsxx[on Github]. -=== vcgencmd +=== `vclog` + +`vclog` displays log messages from the VideoCore GPU from Linux running on the Arm. It needs to be run as root. + +`sudo vclog --msg` prints out the message log, whilst `sudo vclog --assert` prints out the assertion log. + +=== `vcgencmd` The `vcgencmd` tool is used to output information from the VideoCore GPU on the Raspberry Pi. You can find source code for the `vcgencmd` utility https://github.com/raspberrypi/utils/tree/master/vcgencmd[on GitHub]. To get a list of all commands supported by `vcgencmd`, use `vcgencmd commands`. Some useful commands and their required parameters are listed below. -==== vcos +==== `vcos` The `vcos` command has two useful sub-commands: * `version` displays the build date and version of the firmware on the VideoCore * `log status` displays the error log status of the various VideoCore firmware areas -==== version +==== `version` Displays the build date and version of the VideoCore firmware. -==== get_throttled +==== `get_throttled` Returns the throttled state of the system. This is a bit pattern. A bit being set indicates the following meanings: [cols="^,,"] |=== -| Bit | Hex value | Meaning +| Bit | Hexadecimal value | Meaning | 0 -| 0x1 +| `0x1` | Undervoltage detected | 1 -| 0x2 +| `0x2` | Arm frequency capped | 2 -| 0x4 +| `0x4` | Currently throttled | 3 -| 0x8 +| `0x8` | Soft temperature limit active | 16 -| 0x10000 +| `0x10000` | Undervoltage has occurred | 17 -| 0x20000 +| `0x20000` | Arm frequency capping has occurred | 18 -| 0x40000 +| `0x40000` | Throttling has occurred | 19 -| 0x80000 +| `0x80000` | Soft temperature limit has occurred |=== -==== measure_temp +==== `measure_temp` Returns the temperature of the SoC as measured by its internal temperature sensor. On Raspberry Pi 4, `measure_temp pmic` returns the temperature of the PMIC. -==== measure_clock [clock] +==== `measure_clock [clock]` -This returns the current frequency of the specified clock. The options are: +This returns the current frequency of the specified clock. Accepts the following clock values: [cols="^,"] |=== | clock | Description -| arm -| ARM core(s) +| `arm` +| Arm core(s) -| core +| `core` | GPU core -| h264 +| `h264` | H.264 block -| isp +| `isp` | Image Sensor Pipeline -| v3d +| `v3d` | 3D block -| uart +| `uart` | UART -| pwm +| `pwm` | PWM block (analogue audio output) -| emmc +| `emmc` | SD card interface -| pixel +| `pixel` | Pixel valves -| vec +| `vec` | Analogue video encoder -| hdmi +| `hdmi` | HDMI -| dpi +| `dpi` | Display Parallel Interface |=== e.g. `vcgencmd measure_clock arm` -==== measure_volts [block] +==== `measure_volts [block]` -Displays the current voltages used by the specific block. +Displays the current voltages used by the specific block. Accepts the following block values: [cols="^,"] |=== | block | Description -| core +| `core` | VC4 core voltage -| sdram_c +| `sdram_c` | SDRAM Core Voltage -| sdram_i +| `sdram_i` | SDRAM I/O voltage -| sdram_p +| `sdram_p` | SDRAM Phy Voltage |=== -==== otp_dump +==== `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. [[getconfig]] -==== get_config [configuration item|int|str] +==== `get_config [configuration item|int|str]` -Display value of the configuration setting specified: alternatively, specify either `int` (integer) or `str` (string) to see all configuration items of the given type. For example: +Displays the value of the configuration setting specified: alternatively, specify either `int` (integer) or `str` (string) to see all configuration items of the given type. For example, the following command returns the total memory on the device in megabytes: +[source,console] ---- -vcgencmd get_config total_mem +$ vcgencmd get_config total_mem ---- -...returns the total memory on the device in megabytes. - -==== get_mem type +==== `get_mem type` -Reports on the amount of memory addressable by the Arm and the GPU. To show the amount of Arm-addressable memory, use `vcgencmd get_mem arm`; to show the amount of GPU-addressable memory, use `vcgencmd get_mem gpu`. Note that on devices with more than 1GB of memory, the `arm` parameter will always return 1GB minus the `gpu` memory value, since the GPU firmware is only aware of the first 1GB of memory. To get an accurate report of the total memory on the device, see the `total_mem` configuration item and the <> section above. +Reports on the amount of memory addressable by the Arm and the GPU. To show the amount of Arm-addressable memory, use `vcgencmd get_mem arm`; to show the amount of GPU-addressable memory, use `vcgencmd get_mem gpu`. On devices with more than 1GB of memory, the `arm` parameter will always return 1GB minus the `gpu` memory value, since the GPU firmware is only aware of the first 1GB of memory. To get an accurate report of the total memory on the device, see the `total_mem` configuration item and the <> section above. -===== codec_enabled [type] +===== `codec_enabled [type]` -Reports whether the specified codec type is enabled. Possible options for type are AGIF, FLAC, H263, H264, MJPA, MJPB, MJPG, MPG2, MPG4, MVC0, PCM, THRA, VORB, VP6, VP8, WMV9, WVC1. Note that because the H.265 HW block on the Raspberry Pi 4 and 400 is not part of the VideoCore GPU, its status is not accessed via this command. +Reports whether the specified codec type is enabled. Possible options for type are AGIF, FLAC, H263, H264, MJPA, MJPB, MJPG, MPG2, MPG4, MVC0, PCM, THRA, VORB, VP6, VP8, WMV9, WVC1. Because the H.265 HW block on the Raspberry Pi 4 and Pi 400 is not part of the VideoCore GPU, its status is not accessed via this command. -===== mem_oom +===== `mem_oom` Displays statistics on any OOM (out of memory) events occurring in the VideoCore memory space. -===== mem_reloc_stats +===== `mem_reloc_stats` Displays statistics from the relocatable memory allocator on the VideoCore. -===== read_ring_osc +===== `read_ring_osc` Returns the current speed, voltage and temperature of the ring oscillator. - -=== vclog - -`vclog` is an application to display log messages from the VideoCore GPU from Linux running on the Arm. It needs to be run as root. - -`sudo vclog --msg` prints out the message log, whilst `sudo vclog --assert` prints out the assertion log. diff --git a/documentation/asciidoc/computers/os/images/thonny-venv.png b/documentation/asciidoc/computers/os/images/thonny-venv.png index 5025e4fd2..f255b406e 100644 Binary files a/documentation/asciidoc/computers/os/images/thonny-venv.png and b/documentation/asciidoc/computers/os/images/thonny-venv.png differ diff --git a/documentation/asciidoc/computers/os/playing-audio-and-video.adoc b/documentation/asciidoc/computers/os/playing-audio-and-video.adoc index bb3fa490d..11cc62593 100644 --- a/documentation/asciidoc/computers/os/playing-audio-and-video.adoc +++ b/documentation/asciidoc/computers/os/playing-audio-and-video.adoc @@ -1,110 +1,159 @@ -== Playing audio and video +== Play audio and video -The simplest way of playing audio and video on Raspberry Pi is to use the pre-installed VLC application. This is hardware accelerated, and can play back many popular audio and video file formats. More extensive information can be found at https://www.videolan.org/ +Raspberry Pi OS comes with https://www.videolan.org/[VLC media player] pre-installed. You can use VLC to play video and audio files. VLC uses hardware acceleration in Raspberry Pi OS, and supports many popular audio and video file formats. -=== The VLC application +=== VLC media player -To play an audio or video file in the Raspberry Pi OS desktop environment, double-click on the file in the file-manager, and VLC will automatically launch and play the file. Alternatively, you can launch "VLC Media Player" from the "Sound & Video" menu, and then select "Media" -> "Open File..." and navigate to the file you want to play. By default, the audio is sent over the HDMI link; if you instead want to output the audio over the headphone jack, right-click on the speaker icon in the top-right corner of the screen, and select "AV Jack". +==== VLC GUI -For more fine-grained control, you can also launch VLC from the command line. For the examples below, we used a short clip from Big Buck Bunny. +To play an audio or video file from Raspberry Pi Desktop, double-click on a file in the file manager. This automatically launches VLC to play the file. Alternatively, from the *Sound & Video* menu, launch *VLC Media Player*. Then, from the *Media* menu, select *Open File...* and navigate to the file you want to play. +By default, Raspberry Pi OS sends audio to your monitor over HDMI. To output audio to a different interface, such as the headphone jack or USB speakers, right-click on the speaker icon in the system tray and select an option. + +==== `vlc` CLI + +You can also launch VLC from the command line. For the examples below, we used a short clip from Big Buck Bunny. To download this clip from Raspberry Pi, run the following command: + +[source,console] ---- -wget --trust-server-names http://rptl.io/big-buck-bunny -vlc big-buck-bunny-1080p.mp4 +$ wget --trust-server-names http://rpltd.co/big-buck-bunny ---- -To prevent the VLC GUI staying open after your file has finished playing, you can add the `--play-and-exit` flag: +To play the clip in VLC from the command line, run the following command: +[source,console] ---- -vlc --play-and-exit big-buck-bunny-1080p.mp4 +$ vlc big-buck-bunny-1080p.mp4 ---- -You can also add the `--fullscreen` flag to force a video into fullscreen mode. This can also lead to smoother playback in some circumstances. +To prevent the VLC GUI staying open after your file has finished playing, add the `--play-and-exit` flag: +[source,console] ---- -vlc --play-and-exit --fullscreen big-buck-bunny-1080p.mp4 +$ vlc --play-and-exit big-buck-bunny-1080p.mp4 ---- +To play a video in fullscreen mode (which can result in smoother playback in some circumstances), add the `--fullscreen` flag: + +[source,console] +---- +$ vlc --play-and-exit --fullscreen big-buck-bunny-1080p.mp4 +---- + +==== Use `cvlc` to play media without a GUI + If you use `cvlc` instead of `vlc` with any of these commands, then the VLC GUI won't be shown: +[source,console] ---- -cvlc --play-and-exit big-buck-bunny-1080p.mp4 +$ cvlc --play-and-exit big-buck-bunny-1080p.mp4 ---- -If you have a raw H264 stream, for example as captured from the Raspberry Pi Camera Module, you will get much smoother playback in VLC by encapsulating the stream inside a container format. This can be done using `ffmpeg`. For example, this command converts `video.h264` to a containerised `video.mp4` at 30fps: +=== Play audio and video on Raspberry Pi OS Lite -`ffmpeg -r 30 -i video.h264 -c:v copy video.mp4` +Unlike the full version of Raspberry Pi OS, VLC doesn't come pre-installed on Raspberry Pi OS Lite. To play video and audio on Raspberry Pi OS Lite with VLC, install the required packages for playback without a desktop: -=== Playing audio and video on Raspberry Pi OS Lite +[source,console] +---- +$ sudo apt install --no-install-recommends vlc-bin vlc-plugin-base +---- -Begin by installing the necessary VLC components: +For the examples below, we used a short audio clip. To download this clip from Raspberry Pi, run the following command: +[source,console] ---- -sudo apt install --no-install-recommends vlc-bin vlc-plugin-base +$ wget --trust-server-names http://rpltd.co/startup-music ---- -And then download and play an example audio file: +To play the clip in VLC from the command line, run the following command: +[source,console] ---- -wget --trust-server-names http://rptl.io/startup-music -cvlc --play-and-exit computer-startup-music.mp3 +$ cvlc --play-and-exit computer-startup-music.mp3 ---- -To force the audio output to a particular device, you should use: +=== Specify an audio output device + +To force audio output to a particular device, pass the `alsa` value to the the `-A` option to use https://www.alsa-project.org/wiki/Main_Page[ALSA] audio output, and the `--alsa-audio-device` option to specify an audio output device: +[source,console] ---- -cvlc --play-and-exit -A alsa --alsa-audio-device computer-startup-music.mp3 +$ cvlc --play-and-exit -A alsa --alsa-audio-device computer-startup-music.mp3 ---- -...replacing `` with one of the following options: +Replace the `` placeholder with one of the following options: |=== | ALSA device | Description -| sysdefault:CARD=Headphones | The headphone jack +| `sysdefault:CARD=Headphones` | The headphone jack -| sysdefault:CARD=vc4hdmi | The HDMI output on a Raspberry Pi Zero, or Raspberry Pi Model 1, 2 or 3 +| `sysdefault:CARD=vc4hdmi` | The HDMI output on devices with a single HDMI port (Zero models, CM4S, Compute Modules prior to CM4, and Flagship models prior to Raspberry Pi 4) -| sysdefault:CARD=vc4hdmi0 | The HDMI0 output on a Raspberry Pi 4 or 400 +| `sysdefault:CARD=vc4hdmi0` | The HDMI0 output on Flagship models since Raspberry Pi 4B, Compute Modules since CM4, and Keyboard models -| sysdefault:CARD=vc4hdmi1 | The HDMI1 output on a Raspberry Pi 4 or 400 +| `sysdefault:CARD=vc4hdmi1` | The HDMI1 output on Flagship models since Raspberry Pi 4B, Compute Modules since CM4, and Keyboard models |=== +[TIP] +==== Use the following command to get a list of all ALSA devices on your Raspberry Pi: +[source,console] ---- -aplay -L | grep sysdefault +$ aplay -L | grep sysdefault ---- +==== + +=== Specify a video output device -To force the video output to a particular device, you need to use: +To force the video output to a particular device, use the `--drm-vout-display` option to specify a video output device: +[source,console] ---- -cvlc --play-and-exit --drm-vout-display big-buck-bunny-1080p.mp4 +$ cvlc --play-and-exit --drm-vout-display big-buck-bunny-1080p.mp4 ---- -...replacing `` with one of the following options: +Replace the `` placeholder with one of the following options: |=== | DRM device | Description -| HDMI-A-1 | The HDMI output on a Raspberry Pi Zero, or Raspberry Pi Model 1, 2 or 3; *or* the HDMI0 output on a Raspberry Pi 4 or 400 +| `HDMI-A-1` | The HDMI output on a Raspberry Pi Zero, or Raspberry Pi Model 1, 2 or 3; *or* the HDMI0 output on a Raspberry Pi 4, 5, or 400 -| HDMI-A-2 | The HDMI1 output on a Raspberry Pi 4 or 400 +| `HDMI-A-2` | The HDMI1 output on Flagship models since Raspberry Pi 4B, Compute Modules since CM4 (including CM4S), and Keyboard models -| DSI-1 | The Raspberry Pi Touch Display +| `DSI-1` | The Raspberry Pi Touch Display or Raspberry Pi Touch Display 2 + +| `DSI-2` | The second DSI output for models with multiple DSI ports (Flagship models since Raspberry Pi 5, and Compute Module models since CM5) |=== +[TIP] +==== Use the following command to get a list of all DRM devices on your Raspberry Pi: +[source,console] ---- -kmsprint | grep Connector +$ kmsprint | grep Connector ---- +==== + +=== Specify both audio and video output devices -You can combine these options, so to direct the video output to the touchscreen, and the audio output to the headphone jack, you'd use: +You can combine audio and video output options. For example, to direct video output to the touchscreen, and audio output to the headphone jack, use the following combination of the commands above: +[source,console] ---- -cvlc --play-and-exit --fullscreen --drm-vout-display DSI-1 -A alsa --alsa-audio-device sysdefault:CARD=Headphones your_video.mp4 +$ cvlc --play-and-exit --fullscreen --drm-vout-display DSI-1 -A alsa --alsa-audio-device sysdefault:CARD=Headphones your_video.mp4 ---- +=== Improve stream playback performance + +If you have a raw H.264 stream, like those captured from a Raspberry Pi Camera Module, you can improve playback performance in VLC by wrapping the stream inside a container format such as MP4. You can use `ffmpeg` to convert stream content into a container file. For example, the following command converts a stream named `video.h264` to a MP4 container named `video.mp4` at 30fps: + +[source,console] +---- +$ ffmpeg -r 30 -i video.h264 -c:v copy video.mp4 +---- diff --git a/documentation/asciidoc/computers/os/rpi-os-introduction.adoc b/documentation/asciidoc/computers/os/rpi-os-introduction.adoc index d34831701..10fb0d555 100644 --- a/documentation/asciidoc/computers/os/rpi-os-introduction.adoc +++ b/documentation/asciidoc/computers/os/rpi-os-introduction.adoc @@ -1,5 +1,20 @@ == Introduction -Raspberry Pi OS is a free operating system based on Debian, optimised for the Raspberry Pi hardware, and is the recommended operating system for normal use on a Raspberry Pi. The OS comes with over 35,000 packages: pre-compiled software bundled in a nice format for easy installation on your Raspberry Pi. +Raspberry Pi OS is a free, Debian-based operating system optimised for the Raspberry Pi hardware. Raspberry Pi OS supports over 35,000 Debian packages. We recommend Raspberry Pi OS for most Raspberry Pi use cases. -Raspberry Pi OS is under active development, with an emphasis on improving the stability and performance of as many Debian packages as possible on Raspberry Pi. +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/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]. + +== 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 b382b4a1b..224762eb3 100644 --- a/documentation/asciidoc/computers/os/updating.adoc +++ b/documentation/asciidoc/computers/os/updating.adoc @@ -1,163 +1,238 @@ -== Updating and upgrading Raspberry Pi OS +== Update software -It's important to keep your Raspberry Pi up to date. The first and probably the most important reason is security. A device running Raspberry Pi OS contains millions of lines of code that you rely on. Over time, these millions of lines of code will expose well-known vulnerabilities, which are documented in https://cve.mitre.org/index.html[publicly available databases], meaning that they are easy to exploit. The only way to mitigate these exploits as a user of Raspberry Pi OS is to keep your software up to date, as the upstream repositories track CVEs closely and try to mitigate them quickly. +Always keep the software running on your Raspberry Pi updated to the latest version. This keeps your device secure from https://cve.mitre.org/index.html[vulnerabilities] and ensures that you get the latest bug fixes. -The second reason, related to the first, is that the software you are running on your device most certainly contains bugs. Some bugs are CVEs, but bugs could also be affecting the desired functionality without being related to security. By keeping your software up to date, you are lowering the chances of hitting these bugs. +=== Manage software packages with APT -=== Using APT +https://en.wikipedia.org/wiki/APT_(software)[Advanced Package Tool (APT)] is the recommended way to install, update, and remove software in Raspberry Pi OS. You can access APT through the `apt` CLI. -The easiest way to manage installing, upgrading, and removing software is using APT (Advanced Packaging Tool) from Debian. To update software in Raspberry Pi OS, you can use the `apt` tool from a Terminal window. +==== Install updates -==== Keeping your operating system up-to-date +`apt` stores a list of software sources in a file at `/etc/apt/sources.list`. Before installing software, run the following command to *update* your local list of packages using `/etc/apt/sources.list`: -video::2AhCWJ6YQHk[youtube] - -APT keeps a list of software sources on your Raspberry Pi in a file at `/etc/apt/sources.list`. Before installing software, you should update your package list with `apt update`. Open a Terminal window and type: - -[,bash] +[source,console] ---- -sudo apt update +$ sudo apt update ---- -Next, *upgrade* all your installed packages to their latest versions with the following command: +Run the following command to *upgrade* all your installed packages to their latest versions: -[,bash] +[source,console] ---- -sudo apt full-upgrade +$ sudo apt full-upgrade ---- -Note that `full-upgrade` is used in preference to a simple `upgrade`, as it also picks up any dependency changes that may have been made. - -Generally speaking, doing this regularly will keep your installation up to date for the particular major Raspberry Pi OS release you are using (e.g. Bookworm). It will not update from one major release to another (e.g. from Buster to Bullseye, or from Bullseye to Bookworm). +TIP: Unlike Debian, Raspberry Pi OS is under continual development. As a result, package dependencies sometimes change, so you should always use `full-upgrade` instead of the standard `upgrade`. -However, there are occasional changes made in the Raspberry Pi OS image that will require manual intervention, for example a newly introduced package. These are not installed with an upgrade, as this command only updates the packages you already have installed. +Run these commands regularly to keep your software up-to-date. Using `apt` to keep Raspberry Pi OS up to date also keeps your Linux kernel and firmware up to date, since Raspberry Pi distributes them as Debian packages. -NOTE: The kernel and firmware are installed as a Debian package, and so will also get updates when using the procedure above. These packages are updated infrequently and after extensive testing. +When Raspberry Pi releases a new major version of Raspberry Pi OS, the above commands won't upgrade your operating system to that new major version. To upgrade to a new major version, follow our xref:os.adoc#upgrade-your-operating-system-to-a-new-major-version[OS upgrade instructions]. -If moving an existing SD card to a new Raspberry Pi model (for example the Raspberry Pi Zero 2 W), you may also need to update the kernel and the firmware first, using the instructions above. +==== Search for software -==== Running out of space +To search the archives for a package, pass a search keyword to `apt-cache search`: -When running `sudo apt full-upgrade`, it will show how much data will be downloaded, and how much space it will take up on the SD card. It's worth checking with `df -h` that you have enough free disk space, as unfortunately `apt` will not do this for you. Also be aware that downloaded package files (`.deb` files) are kept in `/var/cache/apt/archives`. You can remove these in order to free up space with `sudo apt clean` (`sudo apt-get clean` in older releases of apt). - -==== Upgrading from previous operating system versions +[source,console] +---- +$ apt-cache search +---- -WARNING: Upgrading an existing image is sometimes possible, but is not guaranteed to work in every circumstance, and we do not recommend it. If you do wish to try upgrading your operating system version, we strongly suggest making a backup first. We accept no responsibility for the loss of any data during a failed update. +For example, consider the following search for the keyword "raspi": -The latest version of Raspberry Pi OS is based on Debian Bookworm. The previous version was based on https://www.raspberrypi.com/news/raspberry-pi-os-debian-bullseye/[Debian Bullseye]. +[source,console] +---- +$ apt-cache search raspi +raspi3-firmware - Raspberry Pi 2 and 3 GPU firmware and bootloaders +libcamera-apps - libcamera-apps +libcamera-apps-lite - libcamera-apps-lite +python-picamera - Pure Python interface to the Raspberry Pi's camera module. +python-picamera-docs - Documentation for the Python interface to the RPi's camera module. +python3-picamera - Pure Python interface to the Raspberry Pi's camera module. +raspi-config - Raspberry Pi configuration tool +raspi-gpio - Dump the state of the BCM270x GPIOs +raspi-gpio-dbgsym - debug symbols for raspi-gpio +raspinfo - Dump information about the Pi +rc-gui - raspi-config GUI +raspi-copies-and-fills - ARM-accelerated versions of selected functions from string.h +raspi-copies-and-fills-dbgsym - debug symbols for raspi-copies-and-fills +---- -==== Searching for software +The search returned multiple packages with names or descriptions that included the keyword. -You can search the archives for a package with a given keyword using `apt-cache search`: +Use the following command to view detailed information about a package: -[,bash] +[source,console] ---- -apt-cache search locomotive -sl - Correct you if you type `sl' by mistake +$ apt-cache show ---- -You can view more information about a package before installing it with `apt-cache show`: +For example, consider the following query for the "raspi-config" package: -[,bash] +[source,console] ---- -apt-cache show sl -Package: sl -Version: 3.03-17 -Architecture: armhf -Maintainer: Hiroyuki Yamamoto -Installed-Size: 114 -Depends: libc6 (>= 2.4), libncurses5 (>= 5.5-5~), libtinfo5 -Homepage: http://www.tkl.iis.u-tokyo.ac.jp/~toyoda/index_e.html +$ apt-cache show raspi-config +Package: raspi-config +Version: 20210212 +Architecture: all +Maintainer: Serge Schneider +Installed-Size: 121 +Depends: whiptail, parted, lua5.1, alsa-utils, psmisc, initramfs-tools +Recommends: triggerhappy, iw Priority: optional -Section: games -Filename: pool/main/s/sl/sl_3.03-17_armhf.deb -Size: 26246 -SHA256: 42dea9d7c618af8fe9f3c810b3d551102832bf217a5bcdba310f119f62117dfb -SHA1: b08039acccecd721fc3e6faf264fe59e56118e74 -MD5sum: 450b21cc998dc9026313f72b4bd9807b -Description: Correct you if you type `sl' by mistake - Sl is a program that can display animations aimed to correct you - if you type 'sl' by mistake. - SL stands for Steam Locomotive. +Section: utils +Filename: pool/main/r/raspi-config/raspi-config_20210212_all.deb +Size: 27976 +SHA256: 772d4fd3c6d8c9da47ac56012b74e7828b53c8521ff1c47266bb38ec71750c10 +SHA1: 08254c976a8260bde914c2df72f92ffb9317fef6 +MD5sum: 80aaac13be6a9b455c822edb91cf8ea2 +Description: Raspberry Pi configuration tool + A simple configuration tool for common Raspberry Pi administrative tasks +Description-md5: 19630c04463bfe7193152448b53d85a0 ---- -==== Installing a package with APT +Use this command to verify that the maintainer, version, and size match your expectations for a package. + +==== Install a package + +To install a package on your Raspberry Pi, pass the name of the package to the following command: -[,bash] +[source,console] ---- -sudo apt install tree +$ sudo apt install ---- -Typing this command should tell the user how much disk space the package will take up, and asks for confirmation of the package installation. Entering `Y` (or just pressing `Enter`, as yes is the default action) will allow the installation to occur. This can be bypassed by adding the `-y` flag to the command: +`apt` will display the amount of disk space the package will consume. Enter *Y* and press **Enter** to confirm installation of the package. You can skip this confirmation step by adding the `-y` flag to the command above. -[,bash] +==== Uninstall a package + +To uninstall a package from your Raspberry Pi, pass the name of the package to the following command: + +[source,console] ---- -sudo apt install tree -y +$ sudo apt remove ---- -Installing this package makes `tree` available for the user. +TIP: To completely remove all traces of the package, including configuration files, use `purge` instead of `remove`. + +`apt` will display the amount of disk space removing the package will free up. +Enter *Y* and press **Enter** to confirm removal of the package. You can skip this confirmation step by adding the `-y` flag to the command above. -==== Uninstalling a package with APT +==== Manage `apt` disk usage -You can uninstall a package with `apt remove`: +Before running, `sudo apt full-upgrade` shows the amount of data you'll need to download and store on disk to complete an upgrade. To check that you have enough free disk space, run the following command: -[,bash] +[source,console] ---- -sudo apt remove tree +$ df -h ---- -The user is prompted to confirm the removal. Again, the `-y` flag will auto-confirm. +`apt` stores downloaded package (`.deb`) files in `/var/cache/apt/archives`. During installation, `apt` downloads these packages, then copies files from the packages to the correct installation locations. Depending on the software you have installed, package files can take up significant amounts of space. To delete any lingering package files, run the following command: -You can also choose to completely remove the package and its associated configuration files with `apt purge`: - -[,bash] +[source,console] ---- -sudo apt purge tree +$ sudo apt clean ---- +=== Upgrade your operating system to a new major version + +WARNING: Before attempting a major version upgrade, make a backup. + +To update the operating system to a new major release on your Raspberry Pi, image a second SD card with the new release. Use a USB SD card reader or network storage to copy files and configuration from your current installation to the new SD card. Then, swap the new SD card into the slot on your Raspberry Pi, and boot. + [[rpi-update]] -=== Using `rpi-update` +=== Upgrade your firmware -[.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] -**** -In some circumstances it may be necessary to update the VideoCore firmware in a Raspberry Pi operating system (OS) image without going through the normal upgrade process. This white paper documents how to use the normal upgrade process, and also gives information on how to bypass the standard update process if it is not suitable. -**** +WARNING: Before attempting a firmware upgrade, make a backup. -`rpi-update` is a command line application that will update your Raspberry Pi OS kernel and VideoCore firmware to the latest pre-release versions. +WARNING: Pre-release versions of software are not guaranteed to work. Do not use `rpi-update` on any system unless recommended to do so by a Raspberry Pi engineer. It could leave your system unreliable or broken. Do not use `rpi-update` as part of any regular update process. -WARNING: Pre-release versions of software are not guaranteed to work. You should not use `rpi-update` on any system unless recommended to do so by a Raspberry Pi engineer. It may leave your system unreliable or even completely broken. It should not be used as part of any regular update process. +To update the firmware on your Raspberry Pi to the latest version, use https://github.com/raspberrypi/rpi-update[`rpi-update`]. -The `rpi-update` script was originally written by https://github.com/Hexxeh[Hexxeh], but is now supported by Raspberry Pi engineers. The script source is in the https://github.com/raspberrypi/rpi-update[rpi-update repository]. +`rpi-update` downloads the latest pre-release version of the Linux kernel, its matching modules, device tree files, and the latest versions of the VideoCore firmware. It then installs these files into an existing Raspberry Pi OS install. -==== What it does +All the source data used by `rpi-update` comes from the https://github.com/raspberrypi/rpi-firmware[`rpi-firmware` repository]. This repository contains a subset of the data from the https://github.com/raspberrypi/firmware[official firmware repository]. -`rpi-update` will download the latest pre-release version of the Linux kernel, its matching modules, device tree files, along with the latest versions of the VideoCore firmware. It will then install these files to relevant locations on the SD card, overwriting any previous versions. +Run `rpi-update` as root to initiate the update. Once the update is complete, reboot your Raspberry Pi for these changes to take effect: -All the source data used by `rpi-update` comes from the https://github.com/raspberrypi/rpi-firmware[rpi-firmware repository]. This repository simply contains a subset of the data from the https://github.com/raspberrypi/firmware[official firmware repository], as not all the data from that repo is required. +[source,console] +---- +$ sudo rpi-update +$ sudo reboot +---- -==== Running `rpi-update` +[.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. +**** -If you are sure that you need to use `rpi-update`, it is advisable to take a backup of your current system first as running `rpi-update` could result in a non-booting system. +=== Downgrade firmware to the last stable release -`rpi-update` needs to be run as root. Once the update is complete you will need to reboot. +If you update your firmware to the latest release and experience an issue, use the following command to return to the last stable firmware release: +[source,console] ---- -sudo rpi-update -sudo reboot +$ sudo apt update +$ sudo apt install --reinstall raspi-firmware ---- -It has a number of options documented in the https://github.com/raspberrypi/rpi-update[rpi-update repository]. +=== Convert Raspberry Pi OS Lite into Raspberry Pi OS Desktop -==== How to get back to safety - -If you have done an `rpi-update` and things are not working as you wish but your Raspberry Pi is still bootable, you can return to the stable release using: +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-get update -sudo apt install --reinstall raspi-firmware +$ 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 reboot +---- + +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. Alternatively, to have the Lite experience without removing the desktop packages you've installed, use xref:../computers/configuration.adoc#raspi-config[raspi-config] to set your Raspberry Pi to boot to the command line. + +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**. -NOTE: If your device still runs Raspberry Pi OS Bullseye, use the following command to reinstall `raspberrypi-kernel` instead: `sudo apt install --reinstall libraspberrypi0 libraspberrypi-{bin,dev,doc} raspberrypi-{kernel,bootloader}`. -You will need to reboot your Raspberry Pi for these changes to take effect. diff --git a/documentation/asciidoc/computers/os/using-gpio.adoc b/documentation/asciidoc/computers/os/using-gpio.adoc index 172e82470..b04f8ec6f 100644 --- a/documentation/asciidoc/computers/os/using-gpio.adoc +++ b/documentation/asciidoc/computers/os/using-gpio.adoc @@ -1,65 +1,12 @@ -== GPIO and the 40-pin header - -A powerful feature of the Raspberry Pi is the row of GPIO (general-purpose input/output) pins along the top edge of the board. A 40-pin GPIO header is found on all current Raspberry Pi boards, although it is unpopulated on Raspberry Pi Zero, Raspberry Pi Zero W, and Raspberry Pi Zero 2 W. The GPIO headers on all boards have a 0.1in (2.54mm) pin pitch. - -image::images/GPIO-Pinout-Diagram-2.png[GPIO pins] - -Any of the GPIO pins can be designated in software as an input or output pin and used for a wide range of purposes. - -image::images/GPIO.png[GPIO layout] - -NOTE: The GPIO pin numbering scheme is not in numerical order. GPIO pins 0 and 1 are present on the board (physical pins 27 and 28), but are reserved for advanced use. - -=== Voltages - -Two 5V pins and two 3.3V pins are present on the board, as well as a number of ground pins (GND), which can not be reconfigured. The remaining pins are all general-purpose 3.3V pins, meaning outputs are set to 3.3V and inputs are 3.3V-tolerant. - -=== Outputs - -A GPIO pin designated as an output pin can be set to high (3.3V) or low (0V). - -=== Inputs - -A GPIO pin designated as an input pin can be read as high (3.3V) or low (0V). This is made easier with the use of internal pull-up or pull-down resistors. Pins GPIO2 and GPIO3 have fixed pull-up resistors, but for other pins this can be configured in software. - -=== Other functions - -As well as simple input and output devices, the GPIO pins can be used with a variety of alternative functions, some are available on all pins, others on specific pins. - -* PWM (pulse-width modulation) - ** Software PWM available on all pins - ** Hardware PWM available on GPIO12, GPIO13, GPIO18, GPIO19 -* SPI - ** SPI0: MOSI (GPIO10); MISO (GPIO9); SCLK (GPIO11); CE0 (GPIO8), CE1 (GPIO7) - ** SPI1: MOSI (GPIO20); MISO (GPIO19); SCLK (GPIO21); CE0 (GPIO18); CE1 (GPIO17); CE2 (GPIO16) -* I2C - ** Data: (GPIO2); Clock (GPIO3) - ** EEPROM Data: (GPIO0); EEPROM Clock (GPIO1) -* Serial - ** TX (GPIO14); RX (GPIO15) - -=== GPIO pinout - -A GPIO reference can be accessed on your Raspberry Pi by opening a terminal window and running the command `pinout`. This tool is provided by the https://gpiozero.readthedocs.io/[GPIO Zero] Python library, which is installed by default in Raspberry Pi OS. - -WARNING: While connecting simple components to the GPIO pins is perfectly safe, it's important to be careful how you wire things up. LEDs should have resistors to limit the current passing through them. Do not use 5V for 3.3V components. Do not connect motors directly to the GPIO pins, instead use an https://projects.raspberrypi.org/en/projects/physical-computing/14[H-bridge circuit or a motor controller board]. - -=== Permissions - -In order to use the GPIO ports, your user must be a member of the `gpio` group. The default user account is a member by default, other users need to be added manually. - -[,bash] ----- -sudo usermod -a -G gpio ----- - -=== GPIO in Python +== Use GPIO from Python Using the https://gpiozero.readthedocs.io/[GPIO Zero] library makes it easy to control GPIO devices with Python. The library is comprehensively documented at https://gpiozero.readthedocs.io/[gpiozero.readthedocs.io]. -==== LED +For information about GPIO hardware, see xref:../computers/raspberry-pi.adoc#gpio[GPIO hardware]. -To control an LED connected to GPIO17: +=== LED control + +The following example code controls an LED connected to GPIO17: [,python] ---- @@ -79,9 +26,9 @@ Run this in an IDE like Thonny, and the LED will blink on and off repeatedly. LED methods include `on()`, `off()`, `toggle()`, and `blink()`. -==== Button +=== Read button state -To read the state of a button connected to GPIO2: +The following example code reads the state of a button connected to GPIO2: [,python] ---- @@ -100,11 +47,11 @@ while True: Button functionality includes the properties `is_pressed` and `is_held`; callbacks `when_pressed`, `when_released`, and `when_held`; and methods `wait_for_press()` and `wait_for_release`. -==== Button and LED +=== Control an LED with a button -To connect the LED and button together, you can use this code: +The following example code reads the state of a button connected to GPIO2, and lights an LED connected to GPIO17 when the button is pressed: -[,python] +[source,python] ---- from gpiozero import LED, Button @@ -120,7 +67,7 @@ while True: Alternatively: -[,python] +[source,python] ---- from gpiozero import LED, Button @@ -136,7 +83,7 @@ while True: or: -[,python] +[source,python] ---- from gpiozero import LED, Button @@ -147,7 +94,3 @@ button.when_pressed = led.on button.when_released = led.off ---- -[.booklink, booktype="free", link=https://github.com/raspberrypipress/released-pdfs/raw/main/simple-electronics-with-gpio-zero.pdf, image=image::images/simple-electronics-with-gpio-zero.jpg[]] -==== Going further - -You can find more information on how to program electronics connected to your Raspberry Pi with the GPIO Zero Python library in the Raspberry Pi Press book https://github.com/raspberrypipress/released-pdfs/raw/main/simple-electronics-with-gpio-zero.pdf[Simple Electronics with GPIO Zero]. The book gets you started with the GPIO Zero library, and walks you through how to use it by building a series of projects. diff --git a/documentation/asciidoc/computers/os/using-python.adoc b/documentation/asciidoc/computers/os/using-python.adoc index d8e299793..38dd9e20e 100644 --- a/documentation/asciidoc/computers/os/using-python.adoc +++ b/documentation/asciidoc/computers/os/using-python.adoc @@ -1,42 +1,40 @@ -== Python on Raspberry Pi +== Use Python on a Raspberry Pi -Python 3 is installed by default on Raspberry Pi OS, and is used for many important functions. Interfering with the system Python installation can cause problems for your operating system, so it's important that if you install third-party Python libraries, you use the correct package-management tools. +Raspberry Pi OS comes with Python 3 pre-installed. Interfering with the system Python installation can cause problems for your operating system. When you install third-party Python libraries, always use the correct package-management tools. -There are two routes to installing libraries into the default `python` distribution. You can use `apt` and install pre-configured system packages, or you can use `pip` to install packages which are not distributed as part of Raspberry Pi OS. +On Linux, you can install `python` dependencies in two ways: -IMPORTANT: From _Bookworm_ onwards, packages installed via `pip` must be installed into a Python Virtual Environment using `venv`. This has been introduced by the Python community, not by Raspberry Pi; see https://peps.python.org/pep-0668/[PEP 668] for more details. +* use `apt` to install pre-configured system packages +* use `pip` to install libraries using Python's dependency manager _in a virtual environment_ ++ +IMPORTANT: Starting in Raspberry Pi OS _Bookworm_, you can only use `pip` to install into a Python Virtual Environment (`venv`). This change was introduced by the Python community, not by Raspberry Pi: for more information, see https://peps.python.org/pep-0668/[PEP 668]. -=== Installing Python packages using apt +=== Install Python packages using `apt` -IMPORTANT: Installing packages using `apt` is the preferred method for installing Python libraries under Raspberry Pi OS. +Packages installed via `apt` are packaged specifically for Raspberry Pi OS. These packages usually come pre-compiled, so they install faster. Because `apt` manages dependencies for all packages, installing with this method includes all of the sub-dependencies needed to run the package. And `apt` ensures that you don't break other packages if you uninstall. -Packages installed via `apt` are tested, are usually pre-compiled so they install faster, and are designed for Raspberry Pi OS. They won't break your system. Installing via this route also means that all required dependencies are also installed, and a log of installation is maintained by the OS so installation can be easily rolled back (libraries can be uninstalled) if needed. +For instance, to install the Python 3 library that supports the Raspberry Pi xref:../accessories/build-hat.adoc[Build HAT], run the following command: -For instance, to install the Python 3 library to support the Raspberry Pi xref:../accessories/build-hat.adoc[Build HAT] you would: - -[source,bash] +[source,console] ---- $ sudo apt install python3-build-hat ---- -...to install the pre-built library. +To find Python packages distributed with `apt`, xref:os.adoc#search-for-software[use `apt search`]. In most cases, Python packages use the prefix `python-` or `python3-`: for instance, you can find the `numpy` package under the name `python3-numpy`. -Using `apt` makes installing larger packages, like `numpy` (which has many native dependencies including a Fortran compiler), much simpler than installing individual packages using Python's own package-management system. +=== Install Python libraries using `pip` -If you want to install a Python library called "foobar" you can use `apt search foobar` to find the exact package name. In most cases, you'll find that the required package is going to be called `python-foobar` or `python3-foobar`. +[[python-on-raspberry-pi]] -=== About Python virtual environments +==== Bookworm changes to `pip` installation -In previous versions of the operating system, it was possible to install libraries directly, system-wide, using the package installer for Python, commonly known as `pip`. You'll find the following sort of command in many tutorials online. +In older versions of Raspberry Pi OS, you could install libraries directly into the system version of Python using `pip`. Since Raspberry Pi OS _Bookworm_, users cannot install libraries directly into the system version of Python. -[source,bash] ----- -$ pip install buildhat ----- +Instead, xref:os.adoc#use-pip-with-virtual-environments[install libraries into a virtual environment (`venv`)]. To install a library at the system level for all users, xref:os.adoc#install-python-packages-using-apt[install it with `apt`]. -In newer versions of Raspberry Pi OS, and other operating systems, this is disallowed. If you try and install a Python package system-wide you'll receive an error similar to this: +Attempting to install a Python package system-wide outputs an error similar to the following: -[source,bash] +[source,console] ---- $ pip install buildhat error: externally-managed-environment @@ -57,152 +55,136 @@ note: If you believe this is a mistake, please contact your Python installation hint: See PEP 668 for the detailed specification. ---- -This error is generated because you're trying to install a third-party package into the system Python. A long-standing practical problem for Python users has been conflicts between OS package managers like `apt` and Python-specific package management tools like `pip`. These conflicts include both Python-level API incompatibilities and conflicts over file ownership. - -Therefore from _Bookworm_ onwards, packages installed via `pip` must be installed into a Python virtual environment using `venv`. A virtual environment is a container where you can safely install third-party modules so they won't interfere with, or break, your system Python. - -=== Using pip with virtual environments +Python users have long dealt with conflicts between OS package managers like `apt` and Python-specific package management tools like `pip`. These conflicts include both Python-level API incompatibilities and conflicts over file ownership. -To use a virtual environment you will need to create a container to store the environment. There are several ways you can do this depending on how you want to work with Python. +Starting in Raspberry Pi OS _Bookworm_, packages installed via `pip` _must be installed into a Python virtual environment_ (``venv``). A virtual environment is a container where you can safely install third-party modules so they won't interfere with your system Python. -==== Using a separate environment for each project +==== Use `pip` with virtual environments -One way you can proceed is to create a new virtual environment for each Python project you make. Here, you'll create a directory to hold your own code along with a virtual environment directory: +To use a virtual environment, create a container to store the environment. There are several ways you can do this depending on how you want to work with Python: -[source,bash] +[tabs] +====== +per-project environments:: ++ +Many users create separate virtual environments for each Python project. Locate the virtual environment in the root folder of each project, typically with a shared name like `env`. Run the following command from the root folder of each project to create a virtual environment configuration folder: ++ +[source,console] ---- -$ mkdir my_project -$ cd my_project $ python -m venv env ---- - -If you now look inside the `my_project` directory you'll see a directory called `env`. - -[source,bash] ++ +Before you work on a project, run the following command from the root of the project to start using the virtual environment: ++ +[source,console] ---- -$ ls -la -total 12 -drwxr-xr-x 3 pi pi 4096 Oct 3 14:34 . -drwx------ 20 pi pi 4096 Oct 3 14:34 .. -drwxr-xr-x 5 pi pi 4096 Oct 3 14:34 env -$ +$ source env/bin/activate ---- - -NOTE: If you want to inherit the currently installed packages from the system Python, you should create your virtual environment using `python -m venv --system-site-packages env`. - -Inside this directory is a full Python distribution. To activate your virtual environment and make that version of Python the one you're currently using, you should type: - -[source,bash] ++ +You should then see a prompt similar to the following: ++ +[source,console?prompt=(env) $] ---- -$ source env/bin/activate (env) $ ---- - -You'll see that your prompt is now prepended with `(env)` to indicate that you're no longer using the system Python. Instead, you're using the version of Python contained inside your virtual environment. Any changes you make here won't cause problems for your system Python; nor will any new modules you install into your environment. - -[source,bash] ++ +When you finish working on a project, run the following command from any directory to leave the virtual environment: ++ +[source,console?prompt=(env) $] ---- -(env) $ which python -/home/pi/my_project/env/bin/python +(env) $ deactivate ---- -If you install a third-party package, it'll install into the Python distribution in your virtual environment: - -[source,bash] +per-user environments:: ++ +Instead of creating a virtual environment for each of your Python projects, you can create a single virtual environment for your user account. **Activate that virtual environment before running any of your Python code.** This approach can be more convenient for workflows that share many libraries across projects. ++ +When creating a virtual environment for multiple projects across an entire user account, consider locating the virtual environment configuration files in your home directory. Store your configuration in a https://en.wikipedia.org/wiki/Hidden_file_and_hidden_directory#Unix_and_Unix-like_environments[folder whose name begins with a period] to hide the folder by default, preventing it from cluttering your home folder. ++ +Use the following command to create a virtual environment in a hidden folder in the current user's home directory: ++ +[source,console] ---- -(env) $ pip install buildhat -Looking in indexes: https://pypi.org/simple, https://www.piwheels.org/simple -Collecting buildhat - Downloading https://www.piwheels.org/simple/buildhat/buildhat-0.5.12-py3-none-any.whl (57 kB) - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 57.8/57.8 kB 2.8 MB/s eta 0:00:00 -Collecting gpiozero - Downloading https://www.piwheels.org/simple/gpiozero/gpiozero-2.0-py3-none-any.whl (150 kB) - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 150.5/150.5 kB 6.9 MB/s eta 0:00:00 -Collecting pyserial - Downloading https://www.piwheels.org/simple/pyserial/pyserial-3.5-py2.py3-none-any.whl (90 kB) - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 7.5 MB/s eta 0:00:00 -Collecting colorzero - Downloading https://www.piwheels.org/simple/colorzero/colorzero-2.0-py2.py3-none-any.whl (26 kB) -Requirement already satisfied: setuptools in ./env/lib/python3.11/site-packages (from colorzero->gpiozero->buildhat) (66.1.1) -Installing collected packages: pyserial, colorzero, gpiozero, buildhat -Successfully installed buildhat-0.5.12 colorzero-2.0 gpiozero-2.0 pyserial-3.5 -(env) $ +$ python -m venv ~/.env ---- - -Now, if you `pip list`, you'll see that your current version of Python includes your new modules. - -[source,bash] ++ +Run the following command from any directory to start using the virtual environment: ++ +[source,console] ---- -(env) $ pip list -Package Version ----------- ------- -buildhat 0.5.12 -colorzero 2.0 -gpiozero 2.0 -pip 23.0.1 -pyserial 3.5 -setuptools 66.1.1 +$ source ~/.env/bin/activate ---- - -After writing your code, you can run it from the command line inside the virtual environment as you'd expect, by invoking Python as usual. - -[source,bash] ++ +You should then see a prompt similar to the following: ++ +[source,console?prompt=(.env) $] ---- -(env) $ ls -la -total 12 -drwxr-xr-x 3 pi pi 4096 Oct 3 14:34 . -drwx------ 20 pi pi 4096 Oct 3 14:34 .. -drwxr-xr-x 5 pi pi 4096 Oct 3 14:34 env --rw-r--r-- 1 pi pi 0 Oct 3 14:45 my_code.py -(env) $ python my_code.py -Hello World! -(env) $ +(.env) $ ---- ++ +To leave the virtual environment, run the following command from any directory: ++ +[source,console?prompt=(.env) $] +---- +(.env) $ deactivate +---- +====== -You can leave your virtual environment and return to using the system Python by typing: +===== Create a virtual environment -[source,bash] +Run the following command to create a virtual environment configuration folder, replacing `` with the name you would like to use for the virtual environment (e.g. `env`): + +[source,console] ---- -(env) $ deactivate -$ +$ python -m venv ---- -...and demonstrate to yourself you've done so by checking the installed packages using `pip list`. +TIP: Pass the `--system-site-packages` flag before the folder name to preload all of the currently installed packages in your system Python installation into the virtual environment. -==== Using a separate environment for each user +===== Enter a virtual environment -An alternative method to creating a virtual environment for each of your Python projects is to create a single virtual environment for your user account, and then activate that environment before running any of your Python code. This approach may be preferred if you commonly install the same set of modules for each project, and don't want to have to bother creating individual Python environments for each project, essentially just duplicating your environment. +Then, execute the `bin/activate` script in the virtual environment configuration folder to enter the virtual environment: -[source,bash] +[source,console] ---- -$ python -m venv ~/.env -$ source ~/.env/bin/activate -(.env) $ +$ source /bin/activate +---- + +You should then see a prompt similar to the following: + +[source,console?prompt=() $] +---- +() $ ---- -You can check again that you're in a separate environment by using `pip list`: +The `()` command prompt prefix indicates that the current terminal session is in a virtual environment named ``. -[source,bash] +To check that you're in a virtual environment, use `pip list` to view the list of installed packages: + +[source,console?prompt=() $] ---- -(.env) $ pip list +() $ pip list Package Version ---------- ------- pip 23.0.1 setuptools 66.1.1 ---- -...and leave it using `deactivate`. +The list should be much shorter than the list of packages installed in your system Python. You can now safely install packages with `pip`. Any packages you install with `pip` while in a virtual environment only install to that virtual environment. In a virtual environment, the `python` or `python3` commands automatically use the virtual environment's version of Python and installed packages instead of the system Python. + +===== Exit a virtual environment + +To leave a virtual environment, run the following command: -[source,bash] +[source,console?prompt=() $] ---- -(.env) $ deactivate -$ +() $ deactivate ---- -=== Using the Thonny editor +=== Use the Thonny editor -https://thonny.org/[Thonny] is our recommended editor when you're working with Python on the Raspberry Pi. By default, Thonny uses the system Python. However, you can switch to using a Python virtual environment by clicking on the interpreter menu located at the bottom right of the Thonny window. Clicking on this will offer you a menu to select a configured interpreter or to `Configure interpreter...`. +We recommend https://thonny.org/[Thonny] for editing Python code on the Raspberry Pi. -image::images/thonny-venv.png[width="100%"] +By default, Thonny uses the system Python. However, you can switch to using a Python virtual environment by clicking on the **interpreter menu** in the bottom right of the Thonny window. Select a configured environment or configure a new virtual environment with `Configure interpreter...`. -Selecting this will open a popup allowing you to create a new virtual environment. +image::images/thonny-venv.png[width="100%"] diff --git a/documentation/asciidoc/computers/os/using-webcams.adoc b/documentation/asciidoc/computers/os/using-webcams.adoc deleted file mode 100644 index daa2371be..000000000 --- a/documentation/asciidoc/computers/os/using-webcams.adoc +++ /dev/null @@ -1,178 +0,0 @@ -== Using a USB webcam - -Rather than using the Raspberry Pi xref:../accessories/camera.adoc#about-the-camera-modules[camera module], you can use a standard USB webcam to take pictures and video on your Raspberry Pi. - -NOTE: The quality and configurability of the Raspberry Pi Camera Modules is highly superior to a standard USB webcam. - -First, install the `fswebcam` package: - -[,bash] ----- -sudo apt install fswebcam ----- - -Next, add your username to the `video` group, otherwise you will see 'permission denied' errors: - -[,bash] ----- -sudo usermod -a -G video ----- - -To check that the user has been added to the group correctly, use the `groups` command. - -=== Basic usage - -Enter the command `fswebcam` followed by a filename, and a picture will be taken using the webcam and saved to the filename specified: - -[,bash] ----- -fswebcam image.jpg ----- - -This command will show the following information: - ----- ---- Opening /dev/video0... -Trying source module v4l2... -/dev/video0 opened. -No input was specified, using the first. -Adjusting resolution from 384x288 to 352x288. ---- Capturing frame... -Corrupt JPEG data: 2 extraneous bytes before marker 0xd4 -Captured frame in 0.00 seconds. ---- Processing captured image... -Writing JPEG image to 'image.jpg'. ----- - -image::images/image.jpg[Basic image capture] - -NOTE: The small default resolution used, and the presence of a banner showing the timestamp. - -The webcam used in this example has a resolution of `1280 x 720`. So to specify the resolution you want the image to be taken at, use the `-r` flag: - -[,bash] ----- -fswebcam -r 1280x720 image2.jpg ----- - -This command will show the following information: - ----- ---- Opening /dev/video0... -Trying source module v4l2... -/dev/video0 opened. -No input was specified, using the first. ---- Capturing frame... -Corrupt JPEG data: 1 extraneous bytes before marker 0xd5 -Captured frame in 0.00 seconds. ---- Processing captured image... -Writing JPEG image to 'image2.jpg'. ----- - -image::images/image2.jpg[Full resolution image] - -A picture is now taken using the full resolution of the webcam, with the banner present. - -==== Removing the banner - -Now add the `--no-banner` flag: - -[,bash] ----- -fswebcam -r 1280x720 --no-banner image3.jpg ----- - -...which shows the following information: - ----- ---- Opening /dev/video0... -Trying source module v4l2... -/dev/video0 opened. -No input was specified, using the first. ---- Capturing frame... -Corrupt JPEG data: 2 extraneous bytes before marker 0xd6 -Captured frame in 0.00 seconds. ---- Processing captured image... -Disabling banner. -Writing JPEG image to 'image3.jpg'. ----- - -image::images/image3.jpg[Full resolution image with no banner] - -Now the picture is taken at full resolution with no banner. - -=== Automating image capture - -You can write a Bash script which takes a picture with the webcam. The script below saves the images in the `/home/pi/webcam` directory, so create the `webcam` subdirectory first with: - -[,bash] ----- -mkdir webcam ----- - -To create a script, open up your editor of choice and write the following example code: - -[,bash] ----- -#!/bin/bash - -DATE=$(date +"%Y-%m-%d_%H%M") - -fswebcam -r 1280x720 --no-banner /home/pi/webcam/$DATE.jpg ----- - -This script will take a picture and name the file with a timestamp. Saving the file as `webcam.sh`, first make the file executable: - -[,bash] ----- -chmod +x webcam.sh ----- - -Then run with: - -[,bash] ----- -./webcam.sh ----- - -...which would run the commands in the file and give the usual output. - ----- ---- Opening /dev/video0... -Trying source module v4l2... -/dev/video0 opened. -No input was specified, using the first. ---- Capturing frame... -Corrupt JPEG data: 2 extraneous bytes before marker 0xd6 -Captured frame in 0.00 seconds. ---- Processing captured image... -Disabling banner. -Writing JPEG image to '/home/pi/webcam/2013-06-07_2338.jpg'. ----- - -=== Time-lapse captures - -You can use `cron` to schedule taking a series of pictures at a given interval, such as once a minute, to capture a time-lapse scene. - -First open the cron table for editing: - ----- -crontab -e ----- - -This will either ask which editor you would like to use, or open in your default editor. Once you have the file open in an editor, add the following line to schedule taking a picture every minute (referring to the Bash script from above): - -[,bash] ----- -* * * * * /home/pi/webcam.sh 2>&1 ----- - -Save and exit, and you should see the message: - -[,bash] ----- -crontab: installing new crontab ----- - -Ensure your script does not save each picture with the same filename. This will overwrite the picture every time. - diff --git a/documentation/asciidoc/computers/processors.adoc b/documentation/asciidoc/computers/processors.adoc index 910b87fc4..97a361ba5 100644 --- a/documentation/asciidoc/computers/processors.adoc +++ b/documentation/asciidoc/computers/processors.adoc @@ -10,4 +10,4 @@ include::processors/bcm2711.adoc[] include::processors/bcm2712.adoc[] -include::processors/rp3a0.adoc[] \ No newline at end of file +include::processors/rp3a0.adoc[] diff --git a/documentation/asciidoc/computers/processors/bcm2711.adoc b/documentation/asciidoc/computers/processors/bcm2711.adoc index 17fc0a0bf..4d199dfa7 100644 --- a/documentation/asciidoc/computers/processors/bcm2711.adoc +++ b/documentation/asciidoc/computers/processors/bcm2711.adoc @@ -1,12 +1,12 @@ == BCM2711 -This is the Broadcom chip used in the Raspberry Pi 4 Model B, the Raspberry Pi 400, and the Raspberry Pi Compute Module 4. The architecture of the BCM2711 is a considerable upgrade on that used by the SoCs in earlier Raspberry Pi models. It continues the quad-core CPU design of the BCM2837, but uses the more powerful ARM A72 core. It has a greatly improved GPU feature set with much faster input/output, due to the incorporation of a PCIe link that connects the USB 2 and USB 3 ports, and a natively attached Ethernet controller. It is also capable of addressing more memory than the SoCs used before. +This is the Broadcom chip used in the Raspberry Pi 4 Model B, Compute Module 4, and Pi 400. The architecture of the BCM2711 is a considerable upgrade on that used by the SoCs in earlier Raspberry Pi models. It continues the quad-core CPU design of the BCM2837, but uses the more powerful Arm A72 core. It has a greatly improved GPU feature set with much faster input/output, due to the incorporation of a PCIe link that connects the USB 2 and USB 3 ports, and a natively attached Ethernet controller. It is also capable of addressing more memory than the SoCs used before. -The ARM cores are capable of running at up to 1.5 GHz, making the Raspberry Pi 4 about 50% faster than the Raspberry Pi 3B+. The new VideoCore VI 3D unit now runs at up to 500 MHz. The ARM cores are 64-bit, and while the VideoCore is 32-bit, there is a new Memory Management Unit, which means it can access more memory than previous versions. +The Arm cores are capable of running at up to 1.5 GHz, making the Raspberry Pi 4 about 50% faster than the Raspberry Pi 3B+. The new VideoCore VI 3D unit now runs at up to 500 MHz. The Arm cores are 64-bit, and while the VideoCore is 32-bit, there is a new Memory Management Unit, which means it can access more memory than previous versions. The BCM2711 chip continues to use the heat spreading technology started with the BCM2837B0, which provides better thermal management. -*Processor:* Quad-core https://en.wikipedia.org/wiki/ARM_Cortex-A72[Cortex-A72] (ARM v8) 64-bit SoC @ 1.5 GHz. +*Processor:* Quad-core https://en.wikipedia.org/wiki/ARM_Cortex-A72[Cortex-A72] (Armv8-A) 64-bit SoC @ 1.5 GHz. *Memory:* Accesses up to 8GB LPDDR4-2400 SDRAM (depending on model) diff --git a/documentation/asciidoc/computers/processors/bcm2712.adoc b/documentation/asciidoc/computers/processors/bcm2712.adoc index 9c7e97f6f..e4a97e657 100644 --- a/documentation/asciidoc/computers/processors/bcm2712.adoc +++ b/documentation/asciidoc/computers/processors/bcm2712.adoc @@ -1,13 +1,13 @@ == BCM2712 -Broadcom BCM2712 is the 16nm application processor at the heart of Raspberry Pi 5. It is the successor to the BCM2711 device used in Raspberry Pi 4, and shares many common architectural features with other devices in the BCM27xx family, used on earlier Raspberry Pi products. +Broadcom BCM2712 is the 16nm application processor used in Raspberry Pi 5, 500, 500+, and Compute Module 5. It is the successor to the BCM2711 device used in Raspberry Pi 4, and shares many common architectural features with other devices in the BCM27xx family, used on earlier Raspberry Pi products. -Built around a quad-core Arm Cortex-A76 CPU cluster, clocked at up to 2.4GHz, with 512KB per-core L2 caches and a 2MB shared L3 cache, it integrates an improved 12-core VideoCore VII GPU; a hardware video scaler and HDMI controller capable of driving dual 4kp60 displays; and a Raspberry Pi-developed HEVC decoder and Image Signal Processor. A 32-bit LPDDR4X memory interface provides up to 17GB/s of memory bandwidth, while x1 and x4 PCI Express interfaces support high-bandwidth external peripherals; on Raspberry Pi 5 the latter is used to connect to the Raspberry Pi RP1 south bridge, which provides the bulk of the external-facing I/O functionality on the platform. +Built around a quad-core Arm Cortex-A76 CPU cluster, clocked at up to 2.4GHz, with 512KB per-core L2 caches and a 2MB shared L3 cache, it integrates an improved 12-core VideoCore VII GPU; a hardware video scaler and HDMI controller capable of driving dual 4Kp60 displays; and a Raspberry Pi-developed HEVC decoder and Image Signal Processor. A 32-bit LPDDR4X memory interface provides up to 17GB/s of memory bandwidth, while ×1 and ×4 PCI Express interfaces support high-bandwidth external peripherals; on Raspberry Pi 5 the latter is used to connect to the Raspberry Pi RP1 south bridge, which provides the bulk of the external-facing I/O functionality on the platform. -Headline features include: +Headline features include: * Quad-core Arm Cortex-A76 @ 2.4GHz -** ARMv8-A ISA +** Armv8-A ISA ** 64KByte I and D caches ** 512KB L2 per core, 2MB shared L3 * New Raspberry Pi-developed ISP @@ -15,7 +15,7 @@ Headline features include: * Improved HVS and display pipeline ** Dual 4Kp60 support * VideoCore V3D VII -** ~2-2.5× faster (more hardware, 1GHz versus 600MHz on Pi 4) +** ~2-2.5× faster (more hardware, 960MHz versus 500MHz on Pi 4) ** OpenGL ES 3.1, Vulkan 1.3 * 4Kp60 HEVC hardware decode ** Other CODECs run in software @@ -23,4 +23,21 @@ Headline features include: ** H264 1080p60 decode ~50–60% of CPU ** H264 1080p30 encode (from ISP) ~30–40% CPU -In aggregate, the new features present in BCM2712 deliver a performance uplift of 2-3x over Raspberry Pi 4 for common CPU or I/O-intensive use cases. +In aggregate, the new features present in BCM2712 deliver a performance uplift of 2-3× over Raspberry Pi 4 for common CPU or I/O-intensive use cases. + +=== Vulnerabilities and mitigations + +The Cortex-A76 CPU used in the BCM2712 SoC has known vulnerabilites that are all mitigated in Raspberry Pi OS. + +To determine the full list of vulnerabilities and the mitigations, you can use the following command line which will list all those in place. + +```bash +$ lscpu | grep Vulnerability | grep -v "Not affected" +Vulnerability Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl +Vulnerability Spectre v1: Mitigation; __user pointer sanitization +Vulnerability Spectre v2: Mitigation; CSV2, BHB +``` + +WARNING: The list above was correct as of April 2025 but may have been superceded. You should use `lscpu` on your Raspberry Pi to get up to date information. This is especially important when using a third-party operating system, as these may not include all the latest mitigations in their Linux kernel builds. The Arm processors used by Raspberry Pi Ltd do not use microcode, so all mitigations are at the kernel level. + +The vulnerability information reported by `lscpu` is based on the currently executing kernel's detection scheme. It may not accurately reflect the true vulnerability status of the hardware, especially if the OS lacks recent kernel updates. Further vulnerability information on the CPU vendor advisories can be obtained from https://developer.arm.com/Arm%20Security%20Center/Speculative%20Processor%20Vulnerability referencing the Vendor ID and Model name reported by `lscpu`. diff --git a/documentation/asciidoc/computers/processors/bcm2836.adoc b/documentation/asciidoc/computers/processors/bcm2836.adoc index 7ae9ceb9b..bd5b8c909 100644 --- a/documentation/asciidoc/computers/processors/bcm2836.adoc +++ b/documentation/asciidoc/computers/processors/bcm2836.adoc @@ -5,4 +5,4 @@ The Broadcom chip used in the Raspberry Pi 2 Model B. The underlying architectur You should refer to: * https://datasheets.raspberrypi.com/bcm2836/bcm2836-peripherals.pdf[BCM2836 ARM-local peripherals] -* http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0464f/index.html[Cortex-A7 MPcore Processor Reference Manual] +* https://developer.arm.com/documentation/ddi0464/f/[Cortex-A7 MPcore Processor Reference Manual] diff --git a/documentation/asciidoc/computers/processors/bcm2837.adoc b/documentation/asciidoc/computers/processors/bcm2837.adoc index 16694e5f9..b776c301a 100644 --- a/documentation/asciidoc/computers/processors/bcm2837.adoc +++ b/documentation/asciidoc/computers/processors/bcm2837.adoc @@ -1,10 +1,10 @@ == BCM2837 -This is the Broadcom chip used in the Raspberry Pi 3 Model B, later models of the Raspberry Pi 2 Model B, and the Raspberry Pi Compute Module 3. The underlying architecture of the BCM2837 is identical to the BCM2836. The only significant difference is the replacement of the ARMv7 quad core cluster with a quad-core ARM Cortex A53 (ARMv8) cluster. +This is the Broadcom chip used in the Raspberry Pi 3 Model B, later models of the Raspberry Pi 2 Model B, and the Raspberry Pi Compute Module 3. The underlying architecture of the BCM2837 is identical to the BCM2836. The only significant difference is the replacement of the Armv7 quad core cluster with a quad-core Arm Cortex A53 (Armv8) cluster. -The ARM cores run at 1.2GHz, making the device about 50% faster than the Raspberry Pi 2. The VideoCore IV runs at 400MHz. +The Arm cores run at 1.2GHz, making the device about 50% faster than the Raspberry Pi 2. The VideoCore IV runs at 400MHz. -Please refer to the following BCM2836 document for details on the ARM peripherals specification, which also applies to the BCM2837. +Please refer to the following BCM2836 document for details on the Arm peripherals specification, which also applies to the BCM2837. -* https://datasheets.raspberrypi.com/bcm2836/bcm2836-peripherals.pdf[BCM2836 ARM-local peripherals] +* https://datasheets.raspberrypi.com/bcm2836/bcm2836-peripherals.pdf[BCM2836 Arm-local peripherals] * https://developer.arm.com/documentation/ddi0500/latest/[Cortex-A53 MPCore Processor Technical Reference Manual] diff --git a/documentation/asciidoc/computers/processors/bcm2837b0.adoc b/documentation/asciidoc/computers/processors/bcm2837b0.adoc index 3589bdf10..2ee24cc4b 100644 --- a/documentation/asciidoc/computers/processors/bcm2837b0.adoc +++ b/documentation/asciidoc/computers/processors/bcm2837b0.adoc @@ -1,8 +1,8 @@ == BCM2837B0 -This is the Broadcom chip used in the Raspberry Pi 3 Models A+, B+, and the Raspberry Pi Compute Module 3+. The underlying architecture of the BCM2837B0 is identical to the BCM2837 chip used in other versions of the Raspberry Pi. The ARM core hardware is the same, only the frequency is rated higher. +This is the Broadcom chip used in the Raspberry Pi 3 Models A+, B+, and the Raspberry Pi Compute Module 3+. The underlying architecture of the BCM2837B0 is identical to the BCM2837 chip used in other versions of the Raspberry Pi. The Arm core hardware is the same, only the frequency is rated higher. -The ARM cores are capable of running at up to 1.4GHz, making the 3B+/3A+ about 17% faster than the original Raspberry Pi 3. The VideoCore IV runs at 400MHz. The ARM core is 64-bit, while the VideoCore IV is 32-bit. +The Arm cores are capable of running at up to 1.4GHz, making the 3B+/3A+ about 17% faster than the original Raspberry Pi 3. The VideoCore IV runs at 400MHz. The Arm core is 64-bit, while the VideoCore IV is 32-bit. The BCM2837B0 chip is packaged slightly differently to the BCM2837, and most notably includes a heat spreader for better thermals. This allows higher clock frequencies, and more accurate monitoring and control of the chip's temperature. diff --git a/documentation/asciidoc/computers/processors/rp3a0.adoc b/documentation/asciidoc/computers/processors/rp3a0.adoc index 4ec33136a..6faeed7bf 100644 --- a/documentation/asciidoc/computers/processors/rp3a0.adoc +++ b/documentation/asciidoc/computers/processors/rp3a0.adoc @@ -1,6 +1,6 @@ == RP3A0 -The Raspberry Pi RP3A0 is our first System-in-Package (SiP) consisting of a Broadcom BCM2710A1 — which is the silicon die packaged inside the Broadcom xref:processors.adoc#bcm2837[BCM2837] chip which is used on the xref:raspberry-pi.adoc#raspberry-pi-3-model-b-2[Raspberry Pi 3] — along with 512MB of DRAM. +The Raspberry Pi RP3A0 is our first System-in-Package (SiP) consisting of a Broadcom BCM2710A1 — which is the silicon die packaged inside the Broadcom xref:processors.adoc#bcm2837[BCM2837] chip which is used on the xref:raspberry-pi.adoc#raspberry-pi-3-model-b-2[Raspberry Pi 3] — along with 512MB of DRAM. It is used by the xref:raspberry-pi.adoc#raspberry-pi-zero-2-w[Raspberry Pi Zero 2 W]. @@ -8,12 +8,12 @@ image:images/RP3A0-crosssection.png[width="70%"] The RP3A0 is a Quad-core 64-bit Arm Cortex A53 CPU clocked at 1 GHz, although with a heat sink or other cooling solution in place, the chip can be potentially overclocked to 1.2 GHz. -Please refer to the following BCM2836 document for details on the ARM peripherals specification, which also applies to the BCM2837 and RP3A0. +Please refer to the following BCM2836 document for details on the Arm peripherals specification, which also applies to the BCM2837 and RP3A0. -* https://datasheets.raspberrypi.com/bcm2836/bcm2836-peripherals.pdf[BCM2836 ARM-local peripherals] +* https://datasheets.raspberrypi.com/bcm2836/bcm2836-peripherals.pdf[BCM2836 Arm-local peripherals] * https://developer.arm.com/documentation/ddi0500/latest/[Cortex-A53 MPCore Processor Technical Reference Manual] [NOTE] ==== -The original xref:raspberry-pi.adoc#raspberry-pi-zero[Raspberry Pi Zero] uses Package-on-Package (PoP) DRAM, where the DRAM is soldered directly on top of the xref:processors.adoc#bcm2835[BCM2835] chip. +The original xref:raspberry-pi.adoc#raspberry-pi-zero[Raspberry Pi Zero] uses Package-on-Package (PoP) DRAM, where the DRAM is soldered directly on top of the xref:processors.adoc#bcm2835[BCM2835] chip. ==== diff --git a/documentation/asciidoc/computers/raspberry-pi.adoc b/documentation/asciidoc/computers/raspberry-pi.adoc index 1b5b54d69..3c152ab59 100644 --- a/documentation/asciidoc/computers/raspberry-pi.adoc +++ b/documentation/asciidoc/computers/raspberry-pi.adoc @@ -1,4 +1,4 @@ -include::os/using-gpio.adoc[] +include::raspberry-pi/introduction.adoc[] include::raspberry-pi/raspberry-pi-schematics.adoc[] @@ -6,18 +6,12 @@ include::raspberry-pi/raspberry-pi-compliance.adoc[] include::raspberry-pi/frequency-management.adoc[] -include::raspberry-pi/boot-eeprom-rpi4.adoc[] +include::raspberry-pi/boot-eeprom.adoc[] -include::raspberry-pi/boot-diagnostics-rpi4.adoc[] +include::raspberry-pi/boot-eeprom-diagnostics.adoc[] include::raspberry-pi/bootmodes.adoc[] -include::raspberry-pi/bootflow-legacy.adoc[] - -include::raspberry-pi/bootflow-2711.adoc[] - -include::raspberry-pi/eeprom-bootloader.adoc[] - include::raspberry-pi/boot-usb.adoc[] include::raspberry-pi/boot-msd.adoc[] @@ -30,6 +24,12 @@ include::raspberry-pi/boot-nvme.adoc[] include::raspberry-pi/boot-http.adoc[] +include::raspberry-pi/bootflow-legacy.adoc[] + +include::raspberry-pi/bootflow-eeprom.adoc[] + +include::raspberry-pi/eeprom-bootloader.adoc[] + include::raspberry-pi/display-parallel-interface.adoc[] include::raspberry-pi/gpio-on-raspberry-pi.adoc[] diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-diagnostics-rpi4.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-diagnostics-rpi4.adoc deleted file mode 100644 index f5b493554..000000000 --- a/documentation/asciidoc/computers/raspberry-pi/boot-diagnostics-rpi4.adoc +++ /dev/null @@ -1,54 +0,0 @@ -== Boot diagnostics on the Raspberry Pi 4 - -Starting with version 2020-04-16 of the Raspberry Pi 4 bootloader, diagnostic information can be displayed at boot time on an HDMI display. To see this diagnostic information, power down the Raspberry Pi 4, remove the SD card, then power back up. A diagnostic display similar to below should appear on the attached display. - -image::images/bootloader-diagnostics.png[Boot diagnostics screen] - -This diagnostics page will also appear if the bootloader is unable to boot from an inserted SD card, or is unable to network boot; for example, if there is no bootable image on the card, or if it is defective, or if the network boot parameters are incorrect. - -Once the diagnostics page is displayed, a reboot is only possible by power cycling the device (i.e. unplug then re-plug the power supply). - -The top line describes the model of Raspberry Pi and its memory capacity. The QR code is a link to the https://www.raspberrypi.com/software/[downloads page]. - -The diagnostic information is as follows: - -|=== -| Line: | Information - -| bootloader -| Bootloader git version - RO (if EEPROM is write protected) - software build date - -| update-ts -| The timestamp corresponding to when the EEPROM configuration was updated. This timestamp is checked in xref:raspberry-pi.adoc#ENABLE_SELF_UPDATE[self-update] mode to avoid updating to an old configuration. - -| secure-boot -| If xref:raspberry-pi.adoc#secure-boot[secure-boot] is enabled, then the processor revision (B0/C0) and xref:configuration.adoc#part4[signed-boot status flags] are displayed. Otherwise, this line is blank. - -| board -| xref:raspberry-pi.adoc#raspberry-pi-revision-codes[Board revision] - serial number - Ethernet MAC address - -| boot -| *mode* (current boot mode name and number) *order* (the xref:raspberry-pi.adoc#BOOT_ORDER[BOOT ORDER] configuration) *retry* (retry count in the current boot mode) *restart* (number of cycles through the list of boot modes). - -| SD -| The SD card detect status (detected/not detected). - -| part -| Master Boot Record primary partitions type:LBA. - -| fw -| Filename for `start.elf` and `fixup.dat` if present (e.g. `start4x.elf`, `fixup4x.dat`). - -| net -| Network boot: link status (up/down), client IP address (ip), subnet (sn), default gateway (gw) - -| tftp -| Network boot: TFTP server IP address - -| display -| Indicates whether hotplug was detected (`HPD=1`) and if so whether the EDID was read successfully (`EDID=ok`) for each HDMI output. -|=== - -This display can be disabled using the `DISABLE_HDMI` option, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[Bootloader configuration]. - -NOTE: This is purely for diagnosing boot failures; it is not an interactive bootloader. If you require an interactive bootloader, consider using a tool such as U-Boot. diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom-diagnostics.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom-diagnostics.adoc new file mode 100644 index 000000000..04c792191 --- /dev/null +++ b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom-diagnostics.adoc @@ -0,0 +1,53 @@ +== Boot diagnostics + +The bootloader on Raspberry Pi 4 or later flagship models can display diagnostic information at boot time on an HDMI display. To see this diagnostic information, power down the Raspberry Pi, disconnect the boot media (typically an SD card or SSD), then power back up. If your Raspberry Pi is connected to a display, you should see diagnostics similar to the following: + +image::images/bootloader-diagnostics.png[Boot diagnostics screen] + +This diagnostics page will also appear if the bootloader is unable to boot from any boot media or network boot. This can happen if there is no bootable image on the boot media, if the boot media is defective, or if network boot parameters are incorrect. + +To reboot while displaying the diagnostics page, power cycle the device. You can disconnect, then reconnect the power supply, or press and hold the power button, if your device has one. + +The top line describes the model of Raspberry Pi and its memory capacity. The QR code is a link to the https://www.raspberrypi.com/software/[downloads page]. + +The diagnostic information is as follows: + +[cols="1m,4"] +|=== +| Line | Information + +| bootloader +| Bootloader git version - RO (if EEPROM is write protected) - software build date + +| update-ts +| the timestamp corresponding to when the EEPROM configuration was updated; this timestamp is checked in xref:raspberry-pi.adoc#ENABLE_SELF_UPDATE[self-update] mode to avoid updating to an old configuration + +| secure-boot +| If xref:raspberry-pi.adoc#secure-boot[secure-boot] is enabled, displays the processor revision (B0/C0) and xref:configuration.adoc#part4[signed-boot status flags]; otherwise, this line is blank + +| board +| xref:raspberry-pi.adoc#raspberry-pi-revision-codes[Board revision] - serial number - Ethernet MAC address + +| boot +| *mode* (current boot mode name and number) *order* (the xref:raspberry-pi.adoc#BOOT_ORDER[BOOT ORDER] configuration) *retry* (retry count in the current boot mode) *restart* (number of cycles through the list of boot modes) + +| SD +| The SD card detect status (detected/not detected). + +| part +| Master Boot Record primary partitions type:LBA + +| fw +| Filename for `start.elf` and `fixup.dat` if present (e.g. `start4x.elf`, `fixup4x.dat`) + +| net +| Network boot: link status (up/down), client IP address (ip), subnet (sn), default gateway (gw) + +| tftp +| Network boot: TFTP server IP address + +| display +| Indicates whether hotplug was detected (`HPD=1`) and if so whether the EDID was read successfully (`EDID=ok`) for each HDMI output +|=== + +To disable this diagnostics display, use the `DISABLE_HDMI` option in the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration]. diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom-rpi4.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom-rpi4.adoc deleted file mode 100644 index 10b5393b0..000000000 --- a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom-rpi4.adoc +++ /dev/null @@ -1,276 +0,0 @@ -== Raspberry Pi boot EEPROM - -Raspberry Pi 5, Raspberry Pi 4, 400, Compute Module 4, and Compute Module 4S computers use an EEPROM to boot the system. All other models of Raspberry Pi computer use the `bootcode.bin` file located in the boot filesystem. - -NOTE: The scripts and pre-compiled binaries used to create the `rpi-eeprom` package which is used to update the Raspberry Pi 4 bootloader and VLI USB controller EEPROMs is available https://github.com/raspberrypi/rpi-eeprom/[on GitHub]. - -=== Boot diagnostics - -If an error occurs during boot, then an xref:configuration.adoc#led-warning-flash-codes[error code] will be displayed via the green LED. Newer versions of the bootloader will display a xref:raspberry-pi.adoc#boot-diagnostics-on-the-raspberry-pi-4[diagnostic message] which will be shown on both HDMI displays. - -[[bootloader_update_stable]] -=== Update the bootloader - -There are multiple ways to update the bootloader of your Raspberry Pi. - -==== Raspberry Pi 5, Raspberry Pi 4 and Raspberry Pi 400 - -Raspberry Pi OS automatically updates the bootloader for critical bug fixes. The recommended methods for manually updating the bootloader or changing the boot modes are https://www.raspberrypi.com/software/[Raspberry Pi Imager] and xref:configuration.adoc#raspi-config[raspi-config]. - -[[imager]] -==== Using Raspberry Pi Imager to update the bootloader - -Raspberry Pi Imager provides a GUI for updating the bootloader and selecting the boot mode. - -* Download https://www.raspberrypi.com/software/[Raspberry Pi Imager] -* Select a spare SD card (bootloader images overwrite the entire card) -* Launch Raspberry Pi Imager -* Select `Choose OS` -* Select `Misc utility images` -+ -image::images/misc-utility-images.png[alt="Select Misc utility images"] -* Select `Bootloader` for your version of Raspberry Pi (Pi 400 is part of the 4 family) -+ -image::images/bootloader-family-select.png[alt="Choose a family for your bootloader"] -* Select a boot mode: `SD` (recommended), `USB` or `Network` -+ -image::images/bootloader-storage-select.png[alt="Choose the storage from which you'd like to boot"] -* Select `SD card` and then `Write` -* Click `Yes` to continue -* Boot the Raspberry Pi with the new image and wait for at least ten seconds -* When the green activity LED blinks with a steady pattern and the HDMI display shows a green screen, you have successfully written the bootloader -* Power off the Raspberry Pi and remove the SD card - -[[raspi-config]] -==== Using raspi-config to update the bootloader - -To change the boot-mode or bootloader version from within Raspberry Pi OS, run xref:configuration.adoc#raspi-config[raspi-config]. - -* xref:os.adoc#updating-and-upgrading-raspberry-pi-os[Update] Raspberry Pi OS to get the latest version of the `rpi-eeprom` package -* Run `sudo raspi-config` -* Select `Advanced Options` -* Select `Bootloader Version` -* Select `Default` for factory default settings or `Latest` for the latest stable bootloader release -* Reboot - -=== Updating the EEPROM Configuration - -The default version of the bootloader is only updated for critical fixes and major releases. The `LATEST/STABLE` bootloader updates more often to include the latest fixes and improvements. - -Advanced users can switch to the `LATEST/STABLE` bootloader to get the latest functionality. - -Open a command prompt and start `raspi-config`. - ----- -sudo raspi-config ----- - -Navigate to `Advanced Options` and then `Bootloader Version`. Select `Latest` and choose `Yes` to confirm. Select `Finish` and confirm you want to reboot. After the reboot, open a command prompt again and update your system: - ----- -sudo apt update ----- - -If you run `rpi-eeprom-update`, you should see that a more recent version of the bootloader is available and it's the `stable` release. - ----- -*** UPDATE AVAILABLE *** -BOOTLOADER: update available - CURRENT: Tue 25 Jan 14:30:41 UTC 2022 (1643121041) - LATEST: Thu 19 Oct 11:57:12 UTC 2022 (1646913432) - RELEASE: stable (/lib/firmware/raspberrypi/bootloader/stable) - Use raspi-config to change the release. ----- - -Now you can update your bootloader. - ----- -sudo rpi-eeprom-update -a -sudo reboot ----- - -Reboot, then run `rpi-eeprom-update`. You should now see that the `CURRENT` date has updated to the latest version of the bootloader: - ----- -BOOTLOADER: up to date - CURRENT: Thu 19 Oct 11:57:12 UTC 2023 (1646913432) - LATEST: Thu 19 Oct 11:57:12 UTC 2023 (1646913432) - RELEASE: stable (/lib/firmware/raspberrypi/bootloader/stable) - Use raspi-config to change the release. ----- - -==== Reading the current EEPROM configuration - -To view the configuration used by the current bootloader during the last boot, run one of the following: - -* `rpi-eeprom-config` -* `vcgencmd bootloader_config` - -==== Reading the configuration from an EEPROM image - -To read the configuration from an EEPROM image: - -[,bash] ----- -rpi-eeprom-config pieeprom.bin ----- - -==== Editing the current bootloader configuration - -The following command loads the current EEPROM configuration into a text editor. When the editor is closed, `rpi-eeprom-config` applies the updated configuration to latest available EEPROM release and uses `rpi-eeprom-update` to schedule an update when the system is rebooted: - -[,bash] ----- -sudo -E rpi-eeprom-config --edit -sudo reboot ----- - -If the updated configuration is identical or empty, then no changes are made. - -The editor is selected by the `EDITOR` environment variable. - -==== Applying a saved configuration - -The following command applies `boot.conf` to the latest available EEPROM image and uses `rpi-eeprom-update` to schedule an update when the system is rebooted. - ----- -sudo rpi-eeprom-config --apply boot.conf -sudo reboot ----- - -[[automaticupdates]] -=== Automatic updates - -The `rpi-eeprom-update` `systemd` service runs at startup and applies an update if a new image is available, automatically migrating the current bootloader configuration. - -To disable automatic updates: - -[,bash] ----- -sudo systemctl mask rpi-eeprom-update ----- - -To re-enable automatic updates: - -[,bash] ----- -sudo systemctl unmask rpi-eeprom-update ----- - -NOTE: If the xref:raspberry-pi.adoc#FREEZE_VERSION[FREEZE_VERSION] bootloader EEPROM config is set then the EEPROM update service will skip any automatic updates. This removes the need to individually disable the EEPROM update service if there are multiple operating systems installed, or when swapping SD cards. - -==== `rpi-eeprom-update` - -Raspberry Pi OS uses the `rpi-eeprom-update` script to implement an <> service. The script can also be run interactively or wrapped to create a custom bootloader update service. - -Reading the current EEPROM version: - -[,bash] ----- -vcgencmd bootloader_version ----- - -Check if an update is available: - -[,bash] ----- -sudo rpi-eeprom-update ----- - -Install the update: - ----- -sudo rpi-eeprom-update -a -sudo reboot ----- - -Cancel the pending update: - -[,bash] ----- -sudo rpi-eeprom-update -r ----- - -Installing a specific bootloader EEPROM image: - -[,bash] ----- -sudo rpi-eeprom-update -d -f pieeprom.bin ----- - -The `-d` flag instructs `rpi-eeprom-update` to use the configuration in the specified image file instead of automatically migrating the current configuration. - -Display the built-in documentation: - ----- -rpi-eeprom-update -h ----- - - -[[bootloader-release]] -=== Bootloader release status - -The firmware release status corresponds to a particular subdirectory of bootloader firmware images (`+/lib/firmware/raspberrypi/bootloader/...+`), and can be changed to select a different release stream. - -* `default` - Updated for new hardware support, critical bug fixes and periodic update for new features that have been tested via the `latest` release -* `latest` - Updated when new features are available - -Since the release status string is just a subdirectory name, it is possible to create your own release streams e.g. a pinned release or custom network boot configuration. - -NOTE: `default` and `latest` are symbolic links to the older release names of `critical` and `stable`. - -==== Changing the bootloader release - -NOTE: You can change which release stream is to be used during an update by editing the `/etc/default/rpi-eeprom-update` file and changing the `FIRMWARE_RELEASE_STATUS` entry to the appropriate stream. - -==== Updating the bootloader configuration in an EEPROM image file - -The following command replaces the bootloader configuration in `pieeprom.bin` with `boot.conf` and writes the new image to `new.bin`: - -[,bash] ----- -rpi-eeprom-config --config boot.conf --out new.bin pieeprom.bin ----- - -==== recovery.bin - -At power on, the ROM found on BCM2711 and BCM2712 looks for a file called `recovery.bin` in the root directory of the boot partition on the SD card. If a valid `recovery.bin` is found then the ROM executes this instead of the contents of the EEPROM. This mechanism ensures that the bootloader EEPROM can always be reset to a valid image with factory default settings. - -See also xref:raspberry-pi.adoc#raspberry-pi-4-and-raspberry-pi-5-boot-flow[Raspberry Pi boot-flow] - -==== EEPROM update files - -[cols="1,1"] -|=== -| Filename -| Purpose - -| recovery.bin -| Bootloader EEPROM recovery executable - -| pieeprom.upd -| Bootloader EEPROM image - -| pieeprom.bin -| Bootloader EEPROM image - same as pieeprom.upd but changes recovery.bin behaviour - -| pieeprom.sig -| The sha256 checksum of bootloader image (pieeprom.upd/pieeprom.bin) - -| vl805.bin -| The VLI805 USB firmware EEPROM image - Raspberry Pi 4B revision 1.3 and earlier only. - -| vl805.sig| The sha256 checksum of vl805.bin -|=== - -* If the bootloader update image is called `pieeprom.upd` then `recovery.bin` is renamed to `recovery.000` once the update has completed, then the system is rebooted. Since `recovery.bin` is no longer present the ROM loads the newly updated bootloader from EEPROM and the OS is booted as normal. -* If the bootloader update image is called `pieeprom.bin` then `recovery.bin` will stop after the update has completed. On success the HDMI output will be green and the green activity LED is flashed rapidly. If the update fails, the HDMI output will be red and an xref:configuration.adoc#led-warning-flash-codes[error code] will be displayed via the activity LED. -* The `.sig` files contain the hexadecimal sha256 checksum of the corresponding image file; additional fields may be added in the future. -* The ROM found on BCM2711 and BCM2712 does not support loading `recovery.bin` from USB mass storage or TFTP. Instead, newer versions of the bootloader support a self-update mechanism where the bootloader is able to reflash the EEPROM itself. See `ENABLE_SELF_UPDATE` on the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] page. -* The temporary EEPROM update files are automatically deleted by the `rpi-eeprom-update` service at startup. - -For more information about the `rpi-eeprom-update` configuration file see `rpi-eeprom-update -h`. - -==== EEPROM write protect - -Both the bootloader and VLI EEPROMs support hardware write protection. See the xref:raspberry-pi.adoc#eeprom_write_protect[`eeprom_write_protect`] option for more information about how to enable this when flashing the EEPROMs. diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc new file mode 100644 index 000000000..0e27031dc --- /dev/null +++ b/documentation/asciidoc/computers/raspberry-pi/boot-eeprom.adoc @@ -0,0 +1,302 @@ +== Raspberry Pi boot EEPROM + +The following Raspberry Pi models use an EEPROM to boot the system: + +* Flagship models since Raspberry Pi 4B +* Compute Module models since CM4 (including CM4S) +* Keyboard models since Pi 400 + +All other models of Raspberry Pi computer use the `bootcode.bin` file located in the boot filesystem. + +NOTE: You can find the scripts and pre-compiled binaries used to create `rpi-eeprom` in the https://github.com/raspberrypi/rpi-eeprom/[rpi-eeprom GitHub repository]. + +=== Diagnostics + +If an error occurs during boot, then an xref:configuration.adoc#led-warning-flash-codes[error code] will be displayed via the green LED. Newer versions of the bootloader will display a xref:raspberry-pi.adoc#boot-diagnostics[diagnostic message] on all HDMI displays. + +[[bootloader_update_stable]] +=== Update the bootloader + +There are multiple ways to update the bootloader of your Raspberry Pi. + +==== Flagship models since Raspberry Pi 4B; Compute Modules since CM5; Keyboard models since Pi 400 + +Raspberry Pi OS automatically updates the bootloader for important bug fixes. To manually update the bootloader or change the boot order, use xref:configuration.adoc#raspi-config[raspi-config]. + +NOTE: Compute Module 4 and Compute Module 4S do not support automatic bootloader updates because the bootrom cannot load the `recovery.bin` file from eMMC. The recommended update mechanism is `rpiboot` or via `flashrom` - see `rpi-eeprom-update -h` for more information. + +[[imager]] +==== Use Raspberry Pi Imager to update the bootloader + +Raspberry Pi Imager provides a GUI for updating the bootloader and selecting the boot mode. + +. Download https://www.raspberrypi.com/software/[Raspberry Pi Imager] +. Select a spare SD card (bootloader images overwrite the entire card) +. Launch Raspberry Pi Imager +. Select `Choose OS` +. Select `Misc utility images` ++ +image::images/misc-utility-images.png[alt="Select Misc utility images",width="60%"] +. Select `Bootloader` for your version of Raspberry Pi (Pi 400 is part of the 4 family) ++ +image::images/bootloader-family-select.png[alt="Choose a family for your bootloader",width="60%"] +. Select a boot mode: `SD` (recommended), `USB` or `Network` ++ +image::images/bootloader-storage-select.png[alt="Choose the storage from which you'd like to boot",width="60%"] +. Select `SD card` and then `Write` +. Click `Yes` to continue +. Boot the Raspberry Pi with the new image and wait for at least ten seconds +. When the green activity LED blinks with a steady pattern and the HDMI display shows a green screen, you have successfully written the bootloader +. Power off the Raspberry Pi and remove the SD card + +[[raspi-config]] +==== Use `raspi-config` to update the bootloader + +To change the boot-mode or bootloader version from within Raspberry Pi OS, run xref:configuration.adoc#raspi-config[raspi-config]. + +. xref:os.adoc#update-software[Update] Raspberry Pi OS to get the latest version of the `rpi-eeprom` package. +. Run `sudo raspi-config`. +. Select `Advanced Options`. +. Select `Bootloader Version`. +. Select `Default` for factory default settings or `Latest` for the latest bootloader release. +. Reboot with `sudo reboot`. + +=== Update the bootloader configuration + +The `default` version of the bootloader represents the latest factory default firmware image. It updates to provide critical bug fixes, hardware support and periodically after features have been tested in the `latest` release. +The `latest` bootloader updates more often to include the latest fixes and improvements. + +Advanced users can switch to the `latest` bootloader to get the latest functionality. + +First, ensure that your Raspberry Pi runs the latest software. Run the following command to update: + +[source,console] +---- +$ sudo apt update && sudo apt full-upgrade +---- + +Next, run the following command to open `raspi-config`: + +[source,console] +---- +$ sudo raspi-config +---- + +Navigate to `Advanced Options` > `Bootloader Version`. Select `Latest`, then choose `Yes` to confirm. Select `Finish` and confirm that you want to reboot. + +If you run `sudo rpi-eeprom-update`, you should see that a more recent version of the bootloader is available and it's the `latest` release. + +---- +*** UPDATE AVAILABLE *** +BOOTLOADER: update available + CURRENT: Thu 18 Jan 13:59:23 UTC 2024 (1705586363) + LATEST: Mon 22 Jan 10:41:21 UTC 2024 (1705920081) + RELEASE: latest (/lib/firmware/raspberrypi/bootloader-2711/latest) + Use raspi-config to change the release. + + VL805_FW: Using bootloader EEPROM + VL805: up to date + CURRENT: 000138c0 + LATEST: 000138c0 +---- + +Now you can update your bootloader. + +[source,console] +---- +$ sudo rpi-eeprom-update -a +$ sudo reboot +---- + +Reboot, then run `sudo rpi-eeprom-update`. You should now see that the `CURRENT` date has updated to the latest version of the bootloader: + +---- +BOOTLOADER: up to date + CURRENT: Mon 22 Jan 10:41:21 UTC 2024 (1705920081) + LATEST: Mon 22 Jan 10:41:21 UTC 2024 (1705920081) + RELEASE: latest (/lib/firmware/raspberrypi/bootloader-2711/latest) + Use raspi-config to change the release. + + VL805_FW: Using bootloader EEPROM + VL805: up to date + CURRENT: 000138c0 + LATEST: 000138c0 +---- + +==== Read the current bootloader configuration + +To view the configuration used by the current running bootloader, run the following command: + +[source,console] +---- +$ rpi-eeprom-config +---- + +==== Read the configuration from an bootloader image + +To read the configuration from a bootloader image: + +[source,console] +---- +$ rpi-eeprom-config pieeprom.bin +---- + +==== Editing the current bootloader configuration + +The following command loads the current bootloader configuration into a text editor. When the editor is closed, `rpi-eeprom-config` applies the updated configuration to latest available bootloader release and uses `rpi-eeprom-update` to schedule an update when the system is rebooted: + +[source,console] +---- +$ sudo -E rpi-eeprom-config --edit +$ sudo reboot +---- + +If the updated configuration is identical or empty, then no changes are made. + +The editor is selected by the `EDITOR` environment variable. + +==== Applying a saved configuration + +The following command applies `boot.conf` to the latest available bootloader image and uses `rpi-eeprom-update` to schedule an update when the system is rebooted. + +[source,console] +---- +$ sudo rpi-eeprom-config --apply boot.conf +$ sudo reboot +---- + +[[automaticupdates]] +=== Automatic updates + +The `rpi-eeprom-update` `systemd` service runs at startup and applies an update if a new image is available, automatically migrating the current bootloader configuration. + +To disable automatic updates: + +[source,console] +---- +$ sudo systemctl mask rpi-eeprom-update +---- + +To re-enable automatic updates: + +[source,console] +---- +$ sudo systemctl unmask rpi-eeprom-update +---- + +NOTE: If the xref:raspberry-pi.adoc#FREEZE_VERSION[FREEZE_VERSION] bootloader config is set then the update service will skip any automatic updates. This removes the need to individually disable the update service if there are multiple operating systems installed, or when swapping SD cards. + +==== `rpi-eeprom-update` + +Raspberry Pi OS uses the `rpi-eeprom-update` script to implement an <> service. The script can also be run interactively or wrapped to create a custom bootloader update service. + +Reading the current bootloader version: + +[source,console] +---- +$ vcgencmd bootloader_version +---- + +Check if an update is available: + +[source,console] +---- +$ sudo rpi-eeprom-update +---- + +Install the update: + +[source,console] +---- +$ sudo rpi-eeprom-update -a +$ sudo reboot +---- + +Cancel the pending update: + +[source,console] +---- +$ sudo rpi-eeprom-update -r +---- + +Installing a specific bootloader image: + +[source,console] +---- +$ sudo rpi-eeprom-update -d -f pieeprom.bin +---- + +The `-d` flag instructs `rpi-eeprom-update` to use the configuration in the specified image file instead of automatically migrating the current configuration. + +Display the built-in documentation: + +[source,console] +---- +$ rpi-eeprom-update -h +---- + +[[bootloader-release]] +=== Bootloader release status + +The firmware release status corresponds to a particular subdirectory of bootloader firmware images (`+/lib/firmware/raspberrypi/bootloader/...+`), and can be changed to select a different release stream. + +* `default` - Updated for new hardware support, critical bug fixes and periodic update for new features that have been tested via the `latest` release +* `latest` - Updated when new features are available + +Since the release status string is just a subdirectory name, it is possible to create your own release streams e.g. a pinned release or custom network boot configuration. + +==== Changing the bootloader release + +NOTE: You can change which release stream is to be used during an update by editing the `/etc/default/rpi-eeprom-update` file and changing the `FIRMWARE_RELEASE_STATUS` entry to the appropriate stream. + +==== Updating the bootloader configuration in an bootloader image file + +The following command replaces the bootloader configuration in `pieeprom.bin` with `boot.conf` and writes the new image to `new.bin`: + +[source,console] +---- +$ rpi-eeprom-config --config boot.conf --out new.bin pieeprom.bin +---- + +==== `recovery.bin` + +At power on, the ROM found on BCM2711 and BCM2712 looks for a file called `recovery.bin` in the root directory of the boot partition on the SD card. If a valid `recovery.bin` is found then the ROM executes this instead of the contents of the EEPROM. This mechanism ensures that the bootloader flash image can always be reset to a valid image with factory default settings. + +For more information, see xref:raspberry-pi.adoc#eeprom-boot-flow[EEPROM bootflow]. + +==== Bootloader update files + +[cols="1,1"] +|=== +| Filename | Purpose + +| `recovery.bin` +| Bootloader recovery executable + +| `pieeprom.upd` +| Bootloader EEPROM image + +| `pieeprom.bin` +| Bootloader EEPROM image - same as `pieeprom.upd` but changes `recovery.bin` behaviour to not rename itself to `RECOVERY.000`. + +| `pieeprom.sig` +| The sha256 checksum of bootloader image (pieeprom.upd/pieeprom.bin) + +| `vl805.bin` +| The VLI805 USB firmware EEPROM image - Raspberry Pi 4B revision 1.3 and earlier only. + +| `vl805.sig` +| The sha256 checksum of vl805.bin +|=== + +* If the bootloader update image is called `pieeprom.upd` then `recovery.bin` is renamed to `recovery.000` once the update has completed, then the system is rebooted. Since `recovery.bin` is no longer present the ROM loads the newly updated bootloader from SPI flash and the OS is booted as normal. +* If the bootloader update image is called `pieeprom.bin` then `recovery.bin` will stop after the update has completed. On success the HDMI output will be green and the green activity LED is flashed rapidly. If the update fails, the HDMI output will be red and an xref:configuration.adoc#led-warning-flash-codes[error code] will be displayed via the activity LED. +* The `.sig` files contain the hexadecimal sha256 checksum of the corresponding image file; additional fields may be added in the future. +* The ROM found on BCM2711 and BCM2712 does not support loading `recovery.bin` from USB mass storage or TFTP. Instead, newer versions of the bootloader support a self-update mechanism where the bootloader is able to reflash the SPI flash itself. See `ENABLE_SELF_UPDATE` on the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] page. +* The temporary EEPROM update files are automatically deleted by the `rpi-eeprom-update` service at startup. + +For more information about the `rpi-eeprom-update` configuration file see `rpi-eeprom-update -h`. + +==== EEPROM write protect + +Both the bootloader and VLI EEPROMs support hardware write protection. See the xref:config_txt.adoc#eeprom_write_protect[`eeprom_write_protect`] option for more information about how to enable this when flashing the EEPROMs. diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-gpio.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-gpio.adoc index f646e4868..337261155 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-gpio.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-gpio.adoc @@ -6,11 +6,12 @@ Earlier Raspberry Pis can be configured to allow the boot mode to be selected at To enable GPIO boot mode, add the following line to the `config.txt` file: +[source,ini] ---- program_gpio_bootmode=n ---- -Where `n` is the bank of GPIOs which you wish to use. Then reboot the Raspberry Pi once to program the OTP with this setting. Bank 1 is GPIOs 22-26, bank 2 is GPIOs 39-43. Unless you have a Compute Module, you must use bank 1: the GPIOs in bank 2 are only available on the Compute Module. Because of the way the OTP bits are arranged, if you first program GPIO boot mode for bank 1, you then have the option of selecting bank 2 later. The reverse is not true: once bank 2 has been selected for GPIO boot mode, you cannot select bank 1. +Where `n` is the bank of GPIOs which you wish to use. Then reboot the Raspberry Pi once to program the OTP with this setting. Bank 1 is GPIOs 22-26, Bank 2 is GPIOs 39-43. Unless you have a Compute Module, you must use bank 1: the GPIOs in Bank 2 are only available on the Compute Module. Because of the way the OTP bits are arranged, if you first program GPIO boot mode for Bank 1, you then have the option of selecting Bank 2 later. The reverse is not true: once Bank 2 has been selected for GPIO boot mode, you cannot select Bank 1. Once GPIO boot mode is enabled, the Raspberry Pi will no longer boot. You must pull up at least one boot-mode GPIO pin in order for the Raspberry Pi to boot. @@ -86,4 +87,4 @@ NOTE: The various boot modes are attempted in the numerical order of the GPIO li SD0 is the Broadcom SD card/MMC interface. When the boot ROM within the SoC runs, it always connects SD0 to the built-in microSD card slot. On Compute Modules with an eMMC device, SD0 is connected to that; on the Compute Module Lite SD0 is available on the edge connector and connects to the microSD card slot in the CMIO carrier board. SD1 is the Arasan SD card/MMC interface which is also capable of SDIO. All Raspberry Pi models with built-in wireless LAN use SD1 to connect to the wireless chip via SDIO. -The default pull resistance on the GPIO lines is 50KΩ, as documented on page 102 of the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals.pdf[BCM2835 ARM peripherals datasheet]. A pull resistance of 5KΩ is recommended to pull a GPIO line up: this will allow the GPIO to function but not consume too much power. +The default pull resistance on the GPIO lines is 50KΩ, as documented on page 102 of the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals.pdf[BCM2835 Arm peripherals datasheet]. A pull resistance of 5KΩ is recommended to pull a GPIO line up: this will allow the GPIO to function but not consume too much power. diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-http.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-http.adoc index 3e331e450..f062624dc 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-http.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-http.adoc @@ -7,18 +7,24 @@ In addition to network install, you can explicitly boot your device with files d You could, for example, add this to your `BOOT_ORDER` as a fall-back boot method, or put it behind a GPIO conditional to initiate HTTP boot from your own server when a GPIO pin is pulled low. For example, if you added the following to your EEPROM config and GPIO 8 (which has a default state of 1 or HIGH) were to be pulled low, the files `\http://downloads.raspberrypi.org:80/net_install/boot.img` and `\http://downloads.raspberrypi.org:80/net_install/boot.sig` would be downloaded. If network install on boot were enabled, it would use the same URL. If GPIO 8 were not pulled low the behaviour would be unchanged. -``` + +[source,ini] +---- [gpio8=0] BOOT_ORDER=0xf7 HTTP_HOST=downloads.raspberrypi.org NET_INSTALL_ENABLED=0 -``` +---- + +`boot.img` and the `boot.sig` signature file is a ram disk containing a boot file system. For more details, see xref:config_txt.adoc#boot_ramdisk[boot_ramdisk]. HTTP in the `BOOT_ORDER` will be ignored if secure boot is enabled and xref:raspberry-pi.adoc#HTTP_HOST[HTTP_HOST] is not set. === Requirements -To use HTTP boot, xref:raspberry-pi.adoc#bootloader_update_stable[update the bootloader] to a bootloader dated 10th March 2022 or later. HTTP boot only works over Ethernet, so you need to connect your Raspberry Pi to your network via an Ethernet cable, e.g. to a socket on the back of your router. +To use HTTP boot, xref:raspberry-pi.adoc#bootloader_update_stable[update] to a bootloader released 10th March 2022 or later. HTTP boot requires a wired Ethernet connection. + +To use custom CA certificates, xref:raspberry-pi.adoc#bootloader_update_stable[update] to a bootloader released 5th April 2024 or later. Only devices running the BCM2712 CPU support custom CA certificates. === Keys @@ -28,16 +34,99 @@ WARNING: Using your own network install image will require you to sign the image https://github.com/raspberrypi/usbboot/blob/master/Readme.md[`USBBOOT`] has all the tools needed to program public keys. +Use the following command to add your public key to the EEPROM. `boot.conf` contains your modifications: + +[source,console] +---- +$ rpi-eeprom-config -c boot.conf -p mypubkey.pem -o pieeprom.upd pieeprom.original.bin +---- + +Use the following command to generate a signature for your EEPROM: + +[source,console] +---- +$ rpi-eeprom-digest -i pieeprom.upd -o pieeprom.sig +---- + +Then, use the following command to sign the network install image with your private key: + +[source,console] +---- +$ rpi-eeprom-digest -i boot.img -o boot.sig -k myprivkey.pem +---- + +Finally, put `boot.img` and `boot.sig` on your web server to use your own signed network install image. + +=== Certificates + +For security, Network Install uses HTTPS to download OS images from the Raspberry Pi website. This feature uses our own CA root included in the bootloader to verify the host. + +You can add your own custom CA certificate to your device EEPROM to securely download images from your own website. Use the `--cacertder` option of the `rpi-eeprom-config` tool to add the DER-encoded certificate. You must place a hash of the certificate in the EEPROM config settings to ensure that the certificate is not modified. + +Run the following command to generate a DER-encoded certificate: + +[source,console] +---- +$ openssl x509 -in your_ca_root_cert.pem -out cert.der -outform DER +---- + +Then, run the following command to generate a SHA-256 hash of the certificate: + +[source,console] +---- +$ sha256sum cert.der ---- -# Add your PUBLIC key to the eeprom. boot.conf contains your modifications -rpi-eeprom-config -c boot.conf -p mypubkey.pem -o pieeprom.upd pieeprom.original.bin -# Generate signature for your eeprom -rpi-eeprom-digest -i pieeprom.upd -o pieeprom.sig +You should see output similar to the following: + +---- +701bd97f67b0f5483a9734e6e5cf72f9a123407b346088638f597878563193fc cert.der +---- + +Next, update `boot.conf` to include the hash of the certificate: + +[source,console] +---- +$ sudo rpi-eeprom-config --edit +---- + +Configure the following settings in the `[gpio8=0]` section, replacing: + +* `` with xref:raspberry-pi.adoc#HTTP_HOST[your website], e.g. `yourserver.org` +* `` with the xref:raspberry-pi.adoc#HTTP_PATH[path to your OS image] hosted on your website, e.g. `path/to/files` +* `` with the hash value you generated above, e.g. `701bd97f67b0f5483a9734e6e5cf72f9a123407b346088638f597878563193fc` + +[source,ini] +---- +[all] +BOOT_UART=1 +POWER_OFF_ON_HALT=0 +BOOT_ORDER=0xf461 -# Sign the network install image with your PRIVATE key -# Put boot.img and boot.sig on your web server -rpi-eeprom-digest -i boot.img -o boot.sig -k myprivkey.pem +[gpio8=0] +BOOT_ORDER=0xf7 +NET_INSTALL_ENABLED=0 +HTTP_HOST= +HTTP_PATH= +HTTP_CACERT_HASH= +---- + +When you specify a `HTTP_CACERT_HASH`, Network Install downloads the image using HTTPS over port 443. Without a hash, Network install downloads the image using HTTP over port 80. + +Finally, use the following commands to load everything into EEPROM: + +[source,console] +---- +$ rpi-eeprom-config -c boot.conf -p mypubkey.pem -o pieeprom.bin --cacertder cert.der pieeprom.original.bin +$ rpi-eeprom-digest -k myprivkey.pem -i pieeprom.bin -o pieeprom.sig +---- + +During network boot, your Raspberry Pi should use HTTPS instead of HTTP. To see the full HTTPS URL resolved by Network Install for the download, check the boot output: + +---- +Loading boot.img ... +HTTP: GET request for https://yourserver.org:443/path/to/files/boot.sig +HTTP: GET request for https://yourserver.org:443/path/to/files/boot.img ---- === Secure boot diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-msd.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-msd.adoc index ead79759f..21b4689ba 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-msd.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-msd.adoc @@ -1,26 +1,22 @@ == USB mass storage boot -NOTE: Available on Raspberry Pi 2B v1.2, 3A+, 3B, 3B+, 4B, 400 and Zero 2 W, and Raspberry Pi Compute Module 3, 3+ and 4 only. +NOTE: Available on the xref:raspberry-pi.adoc#compute-module-series[Compute Module series since Compute Module 3], xref:raspberry-pi.adoc#zero-series[Zero series since Zero 2 W], and xref:raspberry-pi.adoc#flagship-series[all flagship series devices since Raspberry Pi 2B (version 1.2)]. -You may wish to boot your Raspberry Pi from a USB mass storage device such as a flash drive or a USB hard disk. When attaching USB devices, particularly hard disks and SSDs, be mindful of their power requirements. If you plan to attach more than one SSD or hard disk to the Raspberry Pi, this will normally require external power - either a powered hard disk enclosure, or a powered USB hub. +USB mass storage boot enables you to boot your Raspberry Pi from a USB mass storage device such as a flash drive or USB disk. When attaching USB devices, particularly hard disks and SSDs, be mindful of their power requirements. Attaching more than one disk typically requires additional external power from either a powered disk enclosure or a powered USB hub. NOTE: Models prior to Raspberry Pi 4B have known issues which prevent booting with some USB devices. -[[pi4]] -=== Raspberry Pi 4B and Raspberry Pi 400 +=== Devices with an EEPROM bootloader -The bootloader in Raspberry Pi 400 and newer Raspberry Pi 4B boards supports USB boot by default, although the `BOOT_ORDER` bootloader configuration may need to be modified. On earlier Raspberry Pi 4B boards, or to select alternate boot modes, the bootloader must be updated. +[[pi4]] -See: +[[cm4]] -* Instructions for changing the boot mode via the xref:raspberry-pi.adoc#imager[Raspberry Pi Imager] -* Instructions for changing the boot mode via xref:raspberry-pi.adoc#raspi-config[raspi-config] -* The xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] page for other boot configuration options +Raspberry Pi 4 and newer flagship series devices and Compute module devices since Compute Module 4 and 4S support USB boot by default, as long as you specify USB boot in the xref:raspberry-pi.adoc#BOOT_ORDER[`BOOT_ORDER`] configuration. -[[cm4]] -=== Compute Module 4 +NOTE: Early editions of Raspberry Pi 4 may require a xref:raspberry-pi.adoc#raspi-config[bootloader update] to boot from USB. -Please see the xref:compute-module.adoc#flashing-the-compute-module-emmc[Flashing the Compute Module eMMC] for bootloader update instructions. +NOTE: Early editions of Compute Module 4 may require a xref:compute-module.adoc#update-the-compute-module-bootloader[bootloader update] to boot from USB. === Raspberry Pi 3B+ @@ -28,46 +24,45 @@ The Raspberry Pi 3B+ supports USB mass storage boot out of the box. === Raspberry Pi 2B, 3A+, 3B, CM3, CM3+, Zero 2 W -On Raspberry Pi 2B v1.2, 3A+, 3B, Zero 2 W, and Compute Module 3 and 3+, you must first enable xref:raspberry-pi.adoc#usb-host-boot-mode[USB host boot mode]. This is to allow USB mass storage boot, and xref:raspberry-pi.adoc#network-booting[network boot]. +On Raspberry Pi 2B v1.2, 3A+, 3B, Zero 2 W, and Compute Module 3 and 3+, you must first enable xref:raspberry-pi.adoc#usb-host-boot-mode[USB host boot mode]. This allows USB mass storage boot and xref:raspberry-pi.adoc#network-booting[network boot]. + +NOTE: Raspberry Pi 3A+ and Zero 2 W do not support network boot. + +To enable USB host boot mode on these devices, set the USB host bit in OTP (one-time programmable) memory. To set the bit, boot from an SD card where xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] contains the line `program_usb_boot_mode=1`. Once you set the bit, you can boot from USB without the SD card. -NOTE: Network boot is not supported on Raspberry Pi 3A+ or Zero 2 W. +==== Enable USB host boot mode with OTP -To enable USB host boot mode, the Raspberry Pi needs to be booted from an SD card with a special option to set the USB host boot mode bit in the one-time programmable (OTP) memory. Once this bit has been set, the SD card is no longer required. +[WARNING] +==== +Any change you make to OTP (one-time programmable) memory is permanent and cannot be undone. -WARNING: Any change you make to the OTP is permanent and cannot be undone. -+ On Raspberry Pi 3A+, setting the OTP bit to enable USB host boot mode will permanently prevent that Raspberry Pi from booting in USB device mode. +==== -You can use any SD card running Raspberry Pi OS to program the OTP bit. +Use any SD card flashed with Raspberry Pi OS to program the OTP bit. -Enable USB host boot mode: +To enable USB host boot mode, add the following line to `config.txt`: -[,bash] +[source,ini] ---- -echo program_usb_boot_mode=1 | sudo tee -a /boot/firmware/config.txt +program_usb_boot_mode=1 ---- -This adds `program_usb_boot_mode=1` to the end of xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]. +Then, use `sudo reboot` to reboot your Raspberry Pi. To check that the OTP has been programmed correctly, run the following command: -Although the option is named `program_usb_boot_mode`, it only enables USB _host_ boot mode. USB _device_ boot mode is only available on certain models of Raspberry Pi - see xref:raspberry-pi.adoc#usb-device-boot-mode[USB device boot mode]. - -Reboot the Raspberry Pi with `sudo reboot` and check that the OTP has been programmed: - -[,bash] +[source,console] ---- -vcgencmd otp_dump | grep 17: +$ vcgencmd otp_dump | grep 17: 17:3020000a ---- -Check that the output `0x3020000a` is shown. If it is not, then the OTP bit has not been successfully programmed. In this case, go through the programming procedure again. If the bit is still not set, this may indicate a fault in the Raspberry Pi hardware itself. - -If you wish, you can remove the `program_usb_boot_mode` line from `config.txt`, so if you put the SD card into another Raspberry Pi, it won't program USB host boot mode. Make sure there is no blank line at the end of `config.txt`. +If the output reads `0x3020000a`, the OTP has been successfully programmed. If you see different output, try the programming procedure again. Make sure there is no blank line at the end of `config.txt`. You can now boot from a USB mass storage device in the same way as booting from an SD card. See the following section for further information. -=== Booting from USB mass storage +=== Boot from USB mass storage -The xref:getting-started.adoc#installing-the-operating-system[procedure] is the same as for SD cards - simply image the USB storage device with the operating system image. +The xref:getting-started.adoc#installing-the-operating-system[procedure] is the same as for SD cards - flash the USB storage device with the operating system image. After preparing the storage device, connect the drive and power up the Raspberry Pi, being aware of the extra USB power requirements of the external drive. @@ -77,25 +72,21 @@ See the xref:raspberry-pi.adoc#raspberry-pi-boot-modes[boot modes documentation] === Known issues -NOTE: These do *not* apply to Raspberry Pi 4 Model B. - * The default timeout for checking bootable USB devices is two seconds. Some flash drives and hard disks power up too slowly. It is possible to extend this timeout to five seconds (add a new file `timeout` to the SD card), but note that some devices take even longer to respond. * Some flash drives have a very specific protocol requirement that is not handled by the bootcode and may thus be incompatible. === Special `bootcode.bin`-only boot mode -IMPORTANT: This does *not* apply to Raspberry Pi 4 Model B. - -If you are unable to use a particular USB device to boot your Raspberry Pi, an alternative (available for the Raspberry Pi 2B v1.2, 3A+, 3B and 3B+) is to use the special xref:raspberry-pi.adoc#raspberry-pi-boot-modes[`bootcode.bin-only`] boot mode. The Raspberry Pi will still boot from the SD card, but `bootcode.bin` is the only file read from it. +On Raspberry Pi 2B v1.2, 3A+, 3B and 3B+, if you are unable to use a particular USB device to boot your Raspberry Pi, you can instead use xref:raspberry-pi.adoc#raspberry-pi-boot-modes[`bootcode.bin`-only] boot mode. The Raspberry Pi will still boot from the SD card, but only reads `bootcode.bin` from the SD card; the rest of your operating system lives on the USB device. === Hardware compatibility -Before attempting to boot from a USB mass storage device it is advisable to verify that the device works correctly under Linux. Boot using an SD card and plug in the USB mass storage device. This should appears as a removable drive. This is especially important with USB SATA adapters, which may be supported by the bootloader in mass storage mode, but fail if Linux selects https://en.wikipedia.org/wiki/USB_Attached_SCSI[USB Attached SCSI-UAS] mode. +Before booting from a USB mass storage device, verify that the device works correctly under Linux. Boot using an SD card and plug in the USB mass storage device. This should appear as a removable drive. This is especially important with USB SATA adapters, which may be supported by the bootloader in mass storage mode, but fail if Linux selects https://en.wikipedia.org/wiki/USB_Attached_SCSI[USB Attached SCSI-UAS] mode. -Spinning hard disk drives nearly always require a powered USB hub. Even if everything appears to work, you are likely to encounter intermittent failures without a powered USB hub. +Hard disk drives (HDDs) typically require a powered USB hub. Even if everything appears to work, you may encounter intermittent failures without a powered USB hub. === Multiple bootable drives -When searching for a bootable partition, the bootloader scans all USB mass storage devices in parallel and will select the first to respond. If the boot partition does not contain a suitable `start.elf` file, the next available device is selected. There is no method for specifying the boot device according to the USB topology because this would slow down boot and adds unnecessary and hard to support configuration complexity. +When searching for a bootable partition, the bootloader scans all USB mass storage devices in parallel and selects the first to respond. If the boot partition does not contain a suitable `start.elf` file, the bootloader attempts the next available device. There is no method for specifying the boot device according to the USB topology; this would slow down boot and adds unnecessary configuration complexity. -NOTE: The `config.txt` file xref:config_txt.adoc#conditional-filters[conditional filters] can be used to select alternate firmware in complex device configurations. +NOTE: Use `config.txt` file xref:config_txt.adoc#conditional-filters[conditional filters] to select alternate firmware in complex device configurations. diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-net.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-net.adoc index 32dddf1bb..48b60a21f 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-net.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-net.adoc @@ -2,7 +2,7 @@ This section describes how network booting works on Raspberry Pi 3B, 3B+ and 2B v1.2. -On Pi 4 and Pi 5, network booting is implemented in the second stage bootloader in the EEPROM. For more information, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[Raspberry Pi 4 bootloader configuration]. +On Pi 4 and Pi 5, network booting is implemented in the second stage bootloader in the EEPROM. For more information, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[Raspberry Pi bootloader configuration]. We also have a xref:remote-access.adoc#network-boot-your-raspberry-pi[tutorial about setting up a network boot system]. @@ -91,7 +91,7 @@ As a minimum you should see a DHCP request and reply which looks like the follow END Option 255, length 0 ---- - `Vendor-Option Option 43` contains the important part of the reply. This must contain the string "Raspberry Pi Boot". Due to a bug in the boot ROM, you may need to add three spaces to the end of the string. +`Vendor-Option Option 43` contains the important part of the reply. This must contain the string "Raspberry Pi Boot". Due to a bug in the boot ROM, you may need to add three spaces to the end of the string. ==== TFTP file read diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-nvme.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-nvme.adoc index 6cefe871c..6db6a0b27 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-nvme.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-nvme.adoc @@ -1,35 +1,55 @@ == NVMe SSD boot -NVMe (non-volatile memory express) is a standard for accessing solid state drives (SSDs) via a PCIe bus. You can connect these drives via the PCIe slot on a Compute Module 4 (CM4) IO board, allowing a CM4 to boot from SSD. +NVMe (Non-Volatile Memory express) is a standard for external storage access over a PCIe bus. You can connect NVMe drives via the PCIe slot on Compute Module 4 IO Board, the M.2 slot on Compute Module 5 IO Board, and Raspberry Pi 5 using an M.2 HAT+ or M.2 HAT+ Compact. With some additional configuration, you can boot from an NVMe drive. -=== Required hardware +=== Prerequisites -You need an NVMe M.2 SSD. You cannot plug an M.2 SSD directly into the PCIe slot on the IO board; an adapter is needed. Be careful to get the correct type: a suitable adapter can be found online by searching for "PCI-E 3.0 ×1 lane to M.2 NGFF M-Key SSD NVMe PCI Express adapter card". +==== Hardware -The latest version of Raspberry Pi OS supports booting from NVMe drives. To check that your NVMe drive is connected correctly, boot Raspberry Pi OS from another drive and run `ls -l /dev/nvme*`. Example output is shown below. +* NVMe M.2 SSD +* an adapter to convert from PCIe to an M.2 standard. +** For Raspberry Pi 5, we recommend the xref:../accessories/m2-hat-plus.adoc[M.2 HAT+ or M.2 HAT+ Compact], which converts from the Raspberry Pi's *PCIe FFC* slot to an M Key interface. +** For the CM4, search for a "PCI-E 3.0 ×1 lane to M.2 NGFF M-Key SSD NVMe PCI Express adapter card" + +To check that your NVMe drive is connected correctly, boot your Raspberry Pi from another storage device (such as an SD card) and run `ls -l /dev/nvme*`. Example output is shown below. ---- crw------- 1 root root 245, 0 Mar 9 14:58 /dev/nvme0 brw-rw---- 1 root disk 259, 0 Mar 9 14:58 /dev/nvme0n1 ---- -If you need to connect the NVMe drive to a PC or Mac, you can use a USB adaptor. Search for "NVMe PCIe M key solid state drive external enclosure". The enclosure must support M key SSDs. +==== Software + +First, ensure that your Raspberry Pi runs the latest software. Run the following command to update: + +[source,console] +---- +$ sudo apt update && sudo apt full-upgrade +---- -=== Required software +=== Edit the bootloader boot priority + +Use the Raspberry Pi Software Configuration Tool to update the bootloader: + +[source,console] +---- +$ sudo raspi-config +---- -To boot from NVMe you need a version of the bootloader later than July 2021, along with a recent version of the VideoCore firmware and Raspberry Pi OS Linux kernel. The latest Raspberry Pi OS release has everything you need, so you can use xref:getting-started.adoc#raspberry-pi-imager[Raspberry Pi Imager] to install the software to your SSD. +Under `Advanced Options` > `Boot Order`, specify an option that includes NVMe. It will then write these changes to the bootloader and return to the Config Tool, in which you can `Finish` and reboot. Your Raspberry Pi will use the new boot order now. -==== Bootloader +For CM4, use `rpiboot` to update the bootloader. You can find instructions for building `rpiboot` and configuring the IO board to switch the ROM to usbboot mode in the https://github.com/raspberrypi/usbboot[USB boot GitHub repository]. -You might need to use `rpiboot` to update the CM4 bootloader. Instructions for building `rpiboot` and configuring the IO board to switch the ROM to usbboot mode are in the https://github.com/raspberrypi/usbboot[USB boot GitHub repository]. +For versions of CM4 with an eMMC, make sure you have set NVMe first in the boot order. Remember to add the NVMe boot mode `6` to `BOOT_ORDER` in `recovery/boot.conf`. -Remember to add the NVMe boot mode `6` to BOOT_ORDER in `recovery/boot.conf`. +CM4 Lite automatically boots from NVMe when the SD card slot is empty. -If you are using CM4 lite, remove the SD card and the board will boot from the NVMe disk. For versions of CM4 with an eMMC, make sure you have set NVMe first in the boot order. +=== NVMe `BOOT_ORDER` -==== NVMe `BOOT_ORDER` +The `BOOT_ORDER` setting in EEPROM configuration controls boot behaviour. +For NVMe boot, use boot mode `6`. For more information, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[Raspberry Pi bootloader configuration]. -This boot behaviour is controlled via the `BOOT_ORDER` setting in the EEPROM configuration: we have added a new boot mode `6` for NVMe. See xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[Raspberry Pi bootloader configuration]. +=== Example Below is an example of UART output when the bootloader detects the NVMe drive: diff --git a/documentation/asciidoc/computers/raspberry-pi/boot-usb.adoc b/documentation/asciidoc/computers/raspberry-pi/boot-usb.adoc index 434066a49..f5225e7ab 100644 --- a/documentation/asciidoc/computers/raspberry-pi/boot-usb.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/boot-usb.adoc @@ -1,46 +1,56 @@ == USB boot modes -WARNING: By default, Raspberry Pi boots from an SD card. This is the recommended method for new and inexperienced users. +There are two separate boot modes for USB: -There are two separate boot modes for USB: USB device boot and USB host boot. +* USB device boot +* USB host boot -The choice between the two boot modes is made by the firmware at boot time when it reads the OTP bits. There are two bits to control USB boot. The first enables USB device boot and is enabled by default; the second enables USB host boot. If the USB host boot mode bit is set, then the processor reads the OTGID pin to decide whether to boot as a host (driven to zero as on any Raspberry Pi Model B/B+) or as a device (left floating). The Raspberry Pi Zero has access to this pin through the OTGID pin on the USB connector, and the Compute Module has access to this pin on the edge connector. +The firmware chooses between the two modes at boot time based on the OTP bits. Two bits control USB boot. The first enables USB device boot and is enabled by default; the second enables USB host boot. -There are also OTP bits that allow certain GPIO pins to be used for selecting which boot modes the Raspberry Pi should attempt to use. +If the USB host boot mode bit is set, the processor reads the OTGID pin to decide whether to boot as a host (driven to zero as on any Raspberry Pi Model B/B+) or as a device (left floating). The Raspberry Pi Zero has access to the OTGID pin through the USB connector; the Compute Module has access to the OTGID pin on the edge connector. -NOTE: USB boot modes only available on certain models. +Some other OTP bits allow certain GPIO pins to select the boot modes. === USB device boot mode -NOTE: Device boot is available on Raspberry Pi Compute Module, Compute Module 3, Raspberry Pi Zero, Zero W, A, A+, and 3A+ only. +NOTE: USB device boot is available on the xref:raspberry-pi.adoc#compute-module-series[Compute Module series], xref:raspberry-pi.adoc#zero-series[Zero series], and xref:raspberry-pi.adoc#flagship-series[Model A variants of the flagship series]. When this boot mode is activated (usually after a failure to boot from the SD card), the Raspberry Pi puts its USB port into device mode and awaits a USB reset from the host. Example code showing how the host needs to talk to the Raspberry Pi can be found https://github.com/raspberrypi/usbboot[on Github]. -The host first sends a structure to the device down control endpoint 0. This contains the size and signature for the boot (security is not enabled, so no signature is required). Secondly, code is transmitted down endpoint 1 (bootcode.bin). Finally, the device will reply with a success code of: +The host first sends a structure to the device down control endpoint 0. This contains the size and signature for the boot (security is not enabled, so no signature is required). Secondly, code is transmitted down endpoint 1 (`bootcode.bin`). Finally, the device will reply with one of the following codes: -* 0 - Success -* 0x80 - Failed +* `0` - Success +* `0x80` - Failure === USB host boot mode -NOTE: Host boot is available on Raspberry Pi 3B, 3B+, 3A+, and 2B v1.2 only. Raspberry Pi 3A+ only supports mass storage boot, not network boot. - -The USB host boot mode follows this sequence: - -* Enable the USB port and wait for D+ line to be pulled high indicating a USB 2.0 device (we only support USB2.0) -* If the device is a hub: - ** Enable power to all downstream ports of the hub - ** For each port, loop for a maximum of two seconds (or five seconds if `program_usb_boot_timeout=1` has been set) - *** Release from reset and wait for D+ to be driven high to indicate that a device is connected - *** If a device is detected: - **** Send "Get Device Descriptor" - ***** If VID == SMSC && PID == 9500 - ****** Add device to Ethernet device list - **** If class interface == mass storage class - ***** Add device to mass storage device list -* Else - ** Enumerate single device -* Go through mass storage device list - ** Boot from xref:raspberry-pi.adoc#usb-mass-storage-boot[mass storage device] -* Go through Ethernet device list - ** Boot from xref:raspberry-pi.adoc#network-booting[Ethernet] +NOTE: Host boot is available on the xref:raspberry-pi.adoc#compute-module-series[Compute Module series since Compute Module 3], xref:raspberry-pi.adoc#zero-series[Zero series since Zero 2 W], Raspberry Pi 2B (version 1.2), Raspberry Pi 3B, and xref:raspberry-pi.adoc#flagship-series[all flagship series devices since Raspberry Pi 3B+]. Raspberry Pi 3A+ supports mass storage boot, but not network boot. + +USB host boot mode uses the following logic: + +. Enable the USB port and wait for D+ line to be pulled high indicating a USB 2.0 device (we only support USB2.0) +. If the device is a hub: +.. Enable power to all downstream ports of the hub +.. For each port, loop for a maximum of two seconds (or five seconds if `program_usb_boot_timeout=1` has been set) +... Release from reset and wait for D+ to be driven high to indicate that a device is connected +... If a device is detected: +.... Send "Get Device Descriptor" +..... If `VID == SMSC` && `PID == 9500` +...... Add device to Ethernet device list +.... If the class interface is mass storage class +..... Add device to mass storage device list +. Else +.. Enumerate single device +. Go through mass storage device list +.. Boot from xref:raspberry-pi.adoc#usb-mass-storage-boot[mass storage device] +. Go through Ethernet device list +.. Boot from xref:raspberry-pi.adoc#network-booting[Ethernet] + +On Raspberry Pi 3B, 3A+, and 3B+, host boot is disabled by default. To enable USB host boot, add a line containing `program_usb_boot_mode=1` to the end of xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]. + +[WARNING] +==== +Any change you make to the OTP is permanent and cannot be undone. + +On Raspberry Pi 3A+, setting the OTP bit to enable USB host boot mode will permanently prevent that Raspberry Pi from booting in USB device mode. +==== diff --git a/documentation/asciidoc/computers/raspberry-pi/bootflow-2711.adoc b/documentation/asciidoc/computers/raspberry-pi/bootflow-eeprom.adoc similarity index 86% rename from documentation/asciidoc/computers/raspberry-pi/bootflow-2711.adoc rename to documentation/asciidoc/computers/raspberry-pi/bootflow-eeprom.adoc index 774b874f2..8d65dd824 100644 --- a/documentation/asciidoc/computers/raspberry-pi/bootflow-2711.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/bootflow-eeprom.adoc @@ -1,6 +1,7 @@ -== Raspberry Pi 4 and Raspberry Pi 5 boot flow +== EEPROM boot flow -The main difference between these and previous products is that the second-stage bootloader is loaded from SPI flash xref:raspberry-pi.adoc#raspberry-pi-boot-eeprom[EEPROM] instead of from the `bootcode.bin` file as on previous products. +Since Raspberry Pi 4, Raspberry Pi flagship devices use an EEPROM bootloader. +The main difference between these and previous products is that the second-stage bootloader is loaded from SPI flash xref:raspberry-pi.adoc#raspberry-pi-boot-eeprom[EEPROM] instead of the `bootcode.bin` file used on previous products. === First stage bootloader @@ -17,7 +18,7 @@ The boot flow for the ROM (first stage) is as follows: *** Success - run second stage bootloader *** Fail - continue * While True - ** Attempt to load `recovery.bin` from xref:compute-module.adoc#flashing-the-compute-module-emmc[USB device boot] + ** Attempt to load `recovery.bin` from xref:compute-module.adoc#flash-compute-module-emmc[USB device boot] *** Success - run `recovery.bin` and update the SPI EEPROM or switch to USB mass storage device mode *** Fail - retry USB device boot @@ -27,7 +28,7 @@ NOTE: `recovery.bin` is a minimal second stage program used to reflash the bootl This section describes the high-level flow of the second stage bootloader. -Please see the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] page for more information about each boot mode, and the xref:configuration.adoc#the-boot-folder[boot folder] page for a description of the GPU firmware files loaded by this stage. +Please see the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] page for more information about each boot mode, and the xref:configuration.adoc#boot-folder-contents[boot folder] page for a description of the GPU firmware files loaded by this stage. * Initialise clocks and SDRAM * Read the EEPROM configuration file @@ -82,10 +83,11 @@ The bootloader may also be updated before the firmware is started if a `pieeprom The bootloader/firmware provide a one-shot flag which, if set, is cleared but causes `tryboot.txt` to be loaded instead of `config.txt`. This alternate config would specify the pending OS update firmware, cmdline, kernel and os_prefix parameters. Since the flag is cleared before starting the firmware, a crash or reset will cause the original `config.txt` file to be loaded on the next reboot. -To set the `tryboot` flag add `tryboot` after the partition number in the `reboot` command. Normally, the partition number defaults to zero but it must be specified if extra arguments are added. +To set the `tryboot` flag, add `tryboot` after the partition number in the `reboot` command. Normally, the partition number defaults to zero but it must be specified if extra arguments are added. Always use quotes when passing arguments to `reboot`: it accepts only a single argument: + +[source,console] ---- -# Quotes are important. Reboot only accepts a single argument. -sudo reboot '0 tryboot' +$ sudo reboot '0 tryboot' ---- All Raspberry Pi models support `tryboot`, however, on Raspberry Pi 4 Model B revision 1.0 and 1.1 the EEPROM must not be write protected. This is because older Raspberry Pi 4B devices have to reset the power supply (losing the tryboot state), so this is stored inside the EEPROM instead. @@ -95,5 +97,5 @@ If `secure-boot` is enabled, then `tryboot` mode will cause `tryboot.img` to be === `tryboot_a_b` mode If the `tryboot_a_b` property in xref:config_txt.adoc#autoboot-txt[autoboot.txt] is set to `1` then `config.txt` is loaded instead of `tryboot.txt`. This is because the `tryboot` switch has already been made at a higher level (the partition), so it's unnecessary to have a `tryboot.txt` file within alternate partition itself. -N.B. The `tryboot_a_b` property is implicitly set to `1` when loading files from within a `boot.img` ramdisk. +The `tryboot_a_b` property is implicitly set to `1` when loading files from within a `boot.img` ramdisk. diff --git a/documentation/asciidoc/computers/raspberry-pi/bootflow-legacy.adoc b/documentation/asciidoc/computers/raspberry-pi/bootflow-legacy.adoc index daf0a83f1..346c513f5 100644 --- a/documentation/asciidoc/computers/raspberry-pi/bootflow-legacy.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/bootflow-legacy.adoc @@ -1,17 +1,17 @@ == Boot sequence -IMPORTANT: The following boot sequence applies to the BCM2837 and BCM2837B0 based models of Raspberry Pi only. On models prior to this, the Raspberry Pi will try SD card boot, followed by xref:raspberry-pi.adoc#usb-device-boot-mode[USB device mode boot]. For the Raspberry Pi 4 and Raspberry Pi 5 boot sequence please see the xref:raspberry-pi.adoc#raspberry-pi-4-and-raspberry-pi-5-boot-flow[Raspberry Pi boot flow] section. +IMPORTANT: The following boot sequence applies to the BCM2837 and BCM2837B0 based models of Raspberry Pi only. On models prior to this, the Raspberry Pi will try SD card boot, followed by xref:raspberry-pi.adoc#usb-device-boot-mode[USB device mode boot]. For the Raspberry Pi 4 and Raspberry Pi 5 boot sequence please see the xref:raspberry-pi.adoc#eeprom-boot-flow[EEPROM bootflow] section. USB boot defaults on Raspberry Pi 3 will depend on which version is being used. See this xref:raspberry-pi.adoc#usb-mass-storage-boot[page] for information on enabling USB boot modes when not enabled by default. When the BCM2837 boots, it uses two different sources to determine which boot modes to enable. Firstly, the one-time-programmable (OTP) memory block is checked to see which boot modes are enabled. If the GPIO boot mode setting is enabled, then the relevant GPIO lines are tested to select which of the OTP-enabled boot modes should be attempted. Note that GPIO boot mode can only be used to select boot modes that are already enabled in the OTP. See xref:raspberry-pi.adoc#gpio-boot-mode[GPIO boot mode] for details on configuring GPIO boot mode. GPIO boot mode is disabled by default. -Next, the boot ROM checks each of the boot sources for a file called bootcode.bin; if it is successful it will load the code into the local 128K cache and jump to it. The overall boot mode process is as follows: +Next, the boot ROM checks each of the boot sources for a file called `bootcode.bin`; if it is successful it will load the code into the local 128K cache and jump to it. The overall boot mode process is as follows: * BCM2837 boots * Read OTP to determine which boot modes to enable * If GPIO boot mode enabled, use GPIO boot mode to refine list of enabled boot modes -* If enabled: check primary SD for bootcode.bin on GPIO 48-53 +* If enabled: check primary SD for `bootcode.bin` on GPIO 48-53 ** Success - boot ** Fail - timeout (five seconds) * If enabled: check secondary SD @@ -33,18 +33,18 @@ Next, the boot ROM checks each of the boot sources for a file called bootcode.bi **** DHCP / TFTP boot ** Else (device mode boot) *** Enable device mode and wait for host PC to enumerate - *** We reply to PC with VID: 0a5c PID: 0x2763 (Raspberry Pi 1 or Raspberry Pi 2) or 0x2764 (Raspberry Pi 3) + *** We reply to PC with VID: `0a5c` PID: `0x2763` (Raspberry Pi 1 or Raspberry Pi 2) or `0x2764` (Raspberry Pi 3) [NOTE] ==== * If there is no SD card inserted, the SD boot mode takes five seconds to fail. To reduce this and fall back to USB more quickly, you can either insert an SD card with nothing on it or use the GPIO bootmode OTP setting described above to only enable USB. -* The default pull for the GPIOs is defined on page 102 of the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals.pdf[ARM Peripherals datasheet]. If the value at boot time does not equal the default pull, then that boot mode is enabled. +* The default pull for the GPIOs is defined on page 102 of the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals.pdf[Arm Peripherals datasheet]. If the value at boot time does not equal the default pull, then that boot mode is enabled. * USB enumeration is a means of enabling power to the downstream devices on a hub, then waiting for the device to pull the D+ and D- lines to indicate if it is either USB 1 or USB 2. This can take time: on some devices it can take up to three seconds for a hard disk drive to spin up and start the enumeration process. Because this is the only way of detecting that the hardware is attached, we have to wait for a minimum amount of time (two seconds). If the device fails to respond after this maximum timeout, it is possible to increase the timeout to five seconds using `program_usb_boot_timeout=1` in `config.txt`. * MSD boot takes precedence over Ethernet boot. * It is no longer necessary for the first partition to be the FAT partition, as the MSD boot will continue to search for a FAT partition beyond the first one. * The boot ROM also now supports GUID partitioning and has been tested with hard drives partitioned using Mac, Windows, and Linux. -* The LAN951x is detected using the Vendor ID 0x0424 and Product ID 0xec00: this is different to the standalone LAN9500 device, which has a product ID of 0x9500 or 0x9e00. To use the standalone LAN9500, an I2C EEPROM would need to be added to change these IDs to match the LAN951x. +* The LAN951x is detected using the Vendor ID `0x0424` and Product ID `0xec00`: this is different to the standalone LAN9500 device, which has a product ID of `0x9500` or `0x9e00`. To use the standalone LAN9500, an I2C EEPROM would need to be added to change these IDs to match the LAN951x. ==== The primary SD card boot mode is, as standard, set to be GPIOs 49-53. It is possible to boot from the secondary SD card on a second set of pins, i.e. to add a secondary SD card to the GPIO pins. However, we have not yet enabled this ability. @@ -53,4 +53,4 @@ NAND boot and SPI boot modes do work, although they do not yet have full GPU sup The USB device boot mode is enabled by default at the time of manufacture, but the USB host boot mode is only enabled with `program_usb_boot_mode=1`. Once enabled, the processor will use the value of the OTGID pin on the processor to decide between the two modes. On any Raspberry Pi Model B/B+, the OTGID pin is driven to 0 and therefore will only boot via host mode once enabled (it is not possible to boot through device mode because the LAN951x device is in the way). -The USB will boot as a USB device on the Raspberry Pi Zero or Compute Module if the OTGID pin is left floating (when plugged into a PC for example), so you can push the bootcode.bin into the device. The `usbboot` code for doing this is https://github.com/raspberrypi/usbboot[available on GitHub]. +The USB will boot as a USB device on the Raspberry Pi Zero or Compute Module if the OTGID pin is left floating (when plugged into a PC for example), so you can push the `bootcode.bin` into the device. The `usbboot` code for doing this is https://github.com/raspberrypi/usbboot[available on GitHub]. diff --git a/documentation/asciidoc/computers/raspberry-pi/bootmodes.adoc b/documentation/asciidoc/computers/raspberry-pi/bootmodes.adoc index 0729cae18..4c4601a2a 100644 --- a/documentation/asciidoc/computers/raspberry-pi/bootmodes.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/bootmodes.adoc @@ -6,36 +6,36 @@ The Raspberry Pi has a number of different stages of booting. This document expl USB host and Ethernet boot can be performed by BCM2837-based Raspberry Pis - that is, Raspberry Pi 2B version 1.2, Raspberry Pi 3B, and Raspberry Pi 3B+ (Raspberry Pi 3A+ cannot net boot since it does not have a built-in Ethernet interface). In addition, all Raspberry Pi models prior to Raspberry Pi 4 can use a `bootcode.bin`-only method to enable USB host boot. -NOTE: Raspberry Pi 4 and 5 do not use the `bootcode.bin` file. Instead, the bootloader is located in an on-board EEPROM chip. See the documentation on the xref:raspberry-pi.adoc#raspberry-pi-4-and-raspberry-pi-5-boot-flow[Raspberry Pi bootflow] and the xref:raspberry-pi.adoc#raspberry-pi-boot-eeprom[SPI boot EEPROM]. +NOTE: Since Raspberry Pi 4, flagship devices do not use the `bootcode.bin` file. Instead, these devices use a bootloader located in an on-board EEPROM chip. For more information, see the documentation on xref:raspberry-pi.adoc#eeprom-boot-flow[EEPROM bootflow] and xref:raspberry-pi.adoc#raspberry-pi-boot-eeprom[SPI boot EEPROM]. -Format an SD card as FAT32 and copy over the latest https://github.com/raspberrypi/firmware/blob/master/boot/bootcode.bin[`bootcode.bin`]. The SD card must be present in the Raspberry Pi for it to boot. Once bootcode.bin is loaded from the SD card, the Raspberry Pi continues booting using USB host mode. +Format an SD card as FAT32 and copy over the latest https://github.com/raspberrypi/firmware/blob/master/boot/bootcode.bin[`bootcode.bin`]. The SD card must be present in the Raspberry Pi for it to boot. Once `bootcode.bin` is loaded from the SD card, the Raspberry Pi continues booting using USB host mode. -This is useful for the Raspberry Pi 1, 2, and Zero models, which are based on the BCM2835 and BCM2836 chips, and in situations where a Raspberry Pi 3 fails to boot (the latest bootcode.bin includes additional bugfixes for the Raspberry Pi 3B, compared to the boot code burned into the BCM2837A0). +This is useful for the Raspberry Pi 1, 2, and Zero models, which are based on the BCM2835 and BCM2836 chips, and in situations where a Raspberry Pi 3 fails to boot (the latest `bootcode.bin` includes additional bugfixes for the Raspberry Pi 3B, compared to the boot code burned into the BCM2837A0). -If you have a problem with a mass storage device still not working, even with this bootcode.bin, then add a new file called "timeout" to the SD card. This will extend to six seconds the time for which it waits for the mass storage device to initialise. +If you have a problem with a mass storage device still not working, even with this `bootcode.bin`, then add a new file called "timeout" to the SD card. This will extend to six seconds the time for which it waits for the mass storage device to initialise. === `bootcode.bin` UART Enable -NOTE: For boards which predate Raspberry Pi 4 Model B. +NOTE: For boards released prior to Raspberry Pi 4. -For information on enabling the UART on the Raspberry Pi 4 bootloader, please see the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] documentation. +For information on enabling UART with the EEPROM bootloader, see the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader configuration] documentation. -It is possible to enable an early stage UART to debug booting issues (useful with the above bootcode.bin only boot mode). To do this, make sure you've got a recent version of the firmware (including bootcode.bin). To check if UART is supported in your current firmware: +It is possible to enable an early stage UART to debug booting issues (useful with the above `bootcode.bin` only boot mode). To do this, make sure you've got a recent version of the firmware (including `bootcode.bin`). To check if UART is supported in your current firmware: -[,bash] +[source,console] ---- - strings bootcode.bin | grep BOOT_UART +$ strings bootcode.bin | grep BOOT_UART ---- -To enable UART from bootcode.bin: +To enable UART from `bootcode.bin`: -[,bash] +[source,console] ---- -sed -i -e "s/BOOT_UART=0/BOOT_UART=1/" bootcode.bin +$ sed -i -e "s/BOOT_UART=0/BOOT_UART=1/" bootcode.bin ---- Next, connect a suitable USB serial cable to your host computer (a Raspberry Pi will work, although you may find that the easiest path is to use a USB serial cable, since it'll work out the box without any pesky config.txt settings). Use the standard pins 6, 8 and 10 (GND, GPIO14, GPIO15) on a Raspberry Pi or Compute Module. -Then use `screen` on Linux or a Mac or `putty` on windows to connect to the serial. +Then use `screen` on Linux or macOS or `putty` on Windows to connect to the serial. -Set up your serial to receive at 115200-8-N-1, and then boot your Raspberry Pi. You should get an immediate serial output from the device as bootcode.bin runs. +Set up your serial to receive at 115200-8-N-1, and then boot your Raspberry Pi. You should get an immediate serial output from the device as `bootcode.bin` runs. diff --git a/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc b/documentation/asciidoc/computers/raspberry-pi/display-parallel-interface.adoc index c176aa268..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 @@ -== Parallel Display Interface +== 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. **** @@ -11,9 +11,9 @@ This interface is controlled by the GPU firmware and can be programmed by a user === GPIO pins -One of the alternate functions selectable on bank 0 of the Raspberry Pi GPIO is DPI (Display Parallel Interface) which is a simple clocked parallel interface (up to 8 bits of R, G and B; clock, enable, hsync, and vsync). This interface is available as alternate function 2 (ALT2) on GPIO bank 0: +One of the alternate functions selectable on Bank 0 of the Raspberry Pi GPIO is DPI (Display Parallel Interface) which is a simple clocked parallel interface (up to 8 bits of R, G and B; clock, enable, hsync, and vsync). This interface is available as alternate function 2 (ALT2) on GPIO Bank 0: -[cols=2] +[cols="1m,1m"] |=== |GPIO |ALT2 @@ -335,6 +335,7 @@ h|*27* h|*26* h|*25* h|*24* h|*23* h|*22* h|*21* h|*20* h|*19* h|*18* h|*17* h|* All other peripheral overlays that use conflicting GPIO pins must be disabled. In `config.txt`, take care to comment out or invert any dtparams that enable I2C or SPI: +[source,ini] ---- dtparam=i2c_arm=off dtparam=spi=off @@ -349,8 +350,9 @@ The https://en.wikipedia.org/wiki/Direct_Rendering_Manager#Kernel_mode_setting[K Auto detect allows your Raspberry Pi to connect with a display without a manually configured device tree overlay. Auto detection is enabled by default. You can enable display auto detect by adding the following line to `config.txt`: +[source,ini] ---- -`display_auto_detect=1` +display_auto_detect=1 ---- Replace the `1` with a `0` to disable auto detect. @@ -362,6 +364,7 @@ NOTE: In Raspberry Pi OS _Bookworm_ or later, the `dpi_output_format` and `dpi_t To use any display other than the official Raspberry Pi display, you must specify a `dtoverlay` entry in `config.txt`. The panel manufacturer should configure timings for your display in Linux kernel code and provide an overlay to enable those settings. See the https://github.com/raspberrypi/linux/blob/rpi-6.1.y/arch/arm/boot/dts/overlays/vc4-kms-kippah-7inch-overlay.dts[Adafruit Kippah display entry] for an example. The following example demonstrates how to set a `dtoverlay` entry for the Kippah display in your xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] file: +[source,ini] ---- dtoverlay=vc4-kms-kippah-7inch-overlay ---- @@ -370,6 +373,7 @@ Display timings are usually defined in the kernel, but you can also define them The following example demonstrates how you can define timings using device tree parameters: +[source,ini] ---- dtoverlay=vc4-kms-v3d dtoverlay=vc4-kms-dpi-generic,hactive=480,hfp=26,hsync=16,hbp=10 diff --git a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc index 83751931c..5ad20922a 100644 --- a/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/eeprom-bootloader.adoc @@ -1,21 +1,21 @@ == Raspberry Pi bootloader configuration -=== Editing the configuration +=== Edit the configuration -Before editing the bootloader configuration, xref:os.adoc#updating-and-upgrading-raspberry-pi-os[update your system] to get the latest version of the `rpi-eeprom` package. +Before editing the bootloader configuration, xref:os.adoc#update-software[update your system] to get the latest version of the `rpi-eeprom` package. To view the current EEPROM configuration, run the following command: [source,console] ---- -rpi-eeprom-config +$ rpi-eeprom-config ---- To edit the current EEPROM configuration and apply the updates to latest EEPROM release, run the following command: [source,console] ---- -sudo -E rpi-eeprom-config --edit +$ sudo -E rpi-eeprom-config --edit ---- For more information about the EEPROM update process, see xref:raspberry-pi.adoc#raspberry-pi-boot-eeprom[boot EEPROM]. @@ -34,7 +34,7 @@ Default: `0` [[UART_BAUD]] ==== `UART_BAUD` -Raspberry Pi 5 only. +Flagship models since Raspberry Pi 5 only. Changes the baud rate for the bootloader UART. @@ -47,7 +47,7 @@ Default: `115200` If `1` then `sudo halt` will run in a lower power mode until either GPIO3 or GLOBAL_EN are shorted to ground. -This setting is not relevant on Raspberry Pi 5 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wakeup from `HALT` or `STANDBY`. +This setting is not relevant on Flagship models since Raspberry Pi 5, Compute Modules since CM5, and Keyboard models since Pi 500 because the xref:raspberry-pi.adoc#power-button[dedicated power button] may always be used to wake from `HALT` or `STANDBY`. Default: `1` @@ -56,9 +56,18 @@ Default: `1` If `1` and `WAKE_ON_GPIO=0` then `sudo halt` will switch off all PMIC outputs. This is lowest possible power state for halt but may cause problems with some HATs because 5V will still be on. `GLOBAL_EN` must be shorted to ground to boot. -Raspberry Pi 400 has a dedicated power button which operates even if the processor is switched off. This behaviour is enabled by default, however, `WAKE_ON_GPIO=2` may be set to use an external GPIO power button instead of the dedicated power button. +The dedicated power button on Pi 400 operates even if the processor is switched off. This behaviour is enabled by default, however, `WAKE_ON_GPIO=2` may be set to use an external GPIO power button instead of the dedicated power button. + +On Flagship models since Raspberry Pi 5 and Keyboard models since Pi 500, this places the PMIC in `STANDBY` mode where all outputs are switched off. There is no need to set `WAKE_ON_GPIO` and pressing the xref:raspberry-pi.adoc#power-button[dedicated power button] boots the device. + +Default: `1` on Compute Modules since CM5 and Keyboard models; otherwise `0` + +[[WAIT_FOR_POWER_BUTTON]] +==== `WAIT_FOR_POWER_BUTTON` -On Raspberry Pi 5 this places the PMIC in `STANDBY` mode where all outputs are switched off. There is no need to set `WAKE_ON_GPIO` and pressing the xref:raspberry-pi.adoc#power-button[dedicated power button] will boot the device. +Flagship models since Raspberry Pi 5 only. + +If this property and `POWER_OFF_ON_HALT` are both set to `1` then the bootloader will immediately power-off and wait for the power to be pressed on the first boot after the power supply has been removed. This means that instead of booting immediately after power-loss the system will wait for the power button to be pressed. Default: `0` @@ -69,14 +78,15 @@ The `BOOT_ORDER` setting allows flexible configuration for the priority of diffe ===== `BOOT_ORDER` fields -The BOOT_ORDER property defines the sequence for the different boot modes. It is read right to left, and up to eight digits may be defined. +The `BOOT_ORDER` property defines the sequence for the different boot modes. It is read right to left, and up to eight digits may be defined. +[cols="1m,1m,2"] |=== | Value | Mode | Description | 0x0 | SD CARD DETECT -| Try SD then wait for card-detect to indicate that the card has changed. Deprecated now that 0xf (RESTART) is available. +| Try SD then wait for card-detect to indicate that the card has changed. Deprecated now that `0xf` (`RESTART`) is available. | 0x1 | SD CARD @@ -112,26 +122,55 @@ The BOOT_ORDER property defines the sequence for the different boot modes. It is | 0xf | RESTART -| Restart from the first boot-mode in the BOOT_ORDER field i.e. loop. +| Restart from the first boot-mode in the `BOOT_ORDER` field i.e. loop. |=== `RPIBOOT` is intended for use with Compute Module 4 to load a custom debug image (e.g. a Linux RAM-disk) instead of the normal boot. This should be the last boot option because it does not currently support timeouts or retries. ===== `BOOT_ORDER` examples +[cols="1m,2"] |=== | BOOT_ORDER | Description | 0xf41 -| Try SD first, followed by USB-MSD then repeat (default if BOOT_ORDER is empty) +| Try SD first, followed by USB-MSD then repeat (default if `BOOT_ORDER` is empty) | 0xf14 | Try USB first, followed by SD then repeat | 0xf21 | Try SD first, followed by NETWORK then repeat + +| 0xf46 +| Try NVMe first, followed by USB-MSD then repeat |=== + +[[BOOT_WATCHDOG_TIMEOUT]] +==== `BOOT_WATCHDOG_TIMEOUT` + +If set to a non-zero value (in seconds), enables a hardware watchdog timer in the bootloader. If the OS is not started within the specified time, the watchdog will reset the system. + +The bootloader watchdog is automatically cancelled as soon as the Arm CPU is started. It does **not** monitor the OS after the handover from the bootloader. + +This is useful for unattended or remote systems to ensure recovery from failed boots (e.g. if the OS never loads). + +Default: `0` (disabled) + +[[BOOT_WATCHDOG_PARTITION]] +==== `BOOT_WATCHDOG_PARTITION` + +If the bootloader watchdog triggers, this property specifies the partition number to boot from after the reset. This allows for automatic failover to a recovery or alternate partition. + +If not set, the bootloader will retry the default partition (0). + +You can use this in conjunction with the xref:config_txt.adoc#the-expression-filter[expression filter] to apply different settings or select a different boot flow when the watchdog triggers a reboot to a specific partition. + +See also the xref:raspberry-pi.adoc#PARTITION[PARTITION] property for more information about how to use high partition numbers to detect a watchdog trigger. + +Default: `0` + [[MAX_RESTARTS]] ==== `MAX_RESTARTS` @@ -146,6 +185,38 @@ The number of times that SD boot will be retried after failure before moving to `-1` means infinite retries. +Default: `0` + +[[SD_OVERCURRENT_CHECK]] +==== `SD_OVERCURRENT_CHECK` + +Raspberry Pi 4 Model B, Raspberry Pi 5, Raspberry Pi 500, and Raspberry Pi 500+ only. + +Before booting, the bootloader checks the SD power switch overcurrent signal. The overcurrent signal occurs if the SD card is damaged and has a short circuit which will cause it to get hot. + +If an over-current condition is detected, the bootloader switches off power to the SD card and waits five seconds before probing the SD card again. This error is displayed on the diagnostic screen, the UART and the activity LED (1 long, 2 short flashes). + +The overcurrent check can be switched from an error to a non-blocking warning by setting `SD_OVERCURRENT_CHECK=0` in the bootloader config. + +Default: `1` + + +[[SD_QUIRKS]] +==== `SD_QUIRKS` + +The `SD_QUIRKS` property provides a set of options to support device bringup and workaround interoperability issues. + +The flags are implemented as a bit-field. Undefined bits are reserved for future use and should be set to zero. + +[cols="1m,3"] +|=== +| Value | Behaviour + +| 0x1 +| Disable SD High Speed modes. The card clock is limited to 12.5 MHz +|=== + + Default: `0` [[NET_BOOT_MAX_RETRIES]] @@ -196,9 +267,9 @@ Default: `""` [[TFTP_PREFIX]] ==== `TFTP_PREFIX` -In order to support unique TFTP boot directories for each Raspberry Pi the bootloader prefixes the filenames with a device specific directory. If neither start4.elf nor start.elf are found in the prefixed directory then the prefix is cleared. +In order to support unique TFTP boot directories for each Raspberry Pi, the bootloader prefixes the filenames with a device-specific directory. If neither start4.elf nor start.elf are found in the prefixed directory then the prefix is cleared. -On earlier models the serial number is used as the prefix, however, on Raspberry Pi 4 the MAC address is no longer generated from the serial number making it difficult to automatically create tftpboot directories on the server by inspecting DHCPDISCOVER packets. To support this the TFTP_PREFIX may be customized to either be the MAC address, a fixed value or the serial number (default). +On earlier models the serial number is used as the prefix, however on Raspberry Pi 4 and 5 the MAC address is no longer generated from the serial number, making it difficult to automatically create tftpboot directories on the server by inspecting DHCPDISCOVER packets. To support this the TFTP_PREFIX may be customized to either be the MAC address, a fixed value or the serial number (default). |=== | Value | Description @@ -207,7 +278,7 @@ On earlier models the serial number is used as the prefix, however, on Raspberry | Use the serial number e.g. `9ffefdef/` | 1 -| Use the string specified by TFTP_PREFIX_STR +| Use the string specified by `TFTP_PREFIX_STR` | 2 | Use the MAC address e.g. `dc-a6-32-01-36-c2/` @@ -234,10 +305,10 @@ Default: `Raspberry Pi Boot` [[DHCP_OPTION97]] ==== `DHCP_OPTION97` -In earlier releases the client GUID (Option97) was just the serial number repeated four times. By default, the new GUID format is the concatenation of the four-character code (FourCC) for `RPi4` (0x34695052 - little endian), the board revision (e.g. 0x00c03111) (4-bytes), the least significant 4 bytes of the mac address and the 4-byte serial number. -This is intended to be unique but also provides structured information to the DHCP server, allowing Raspberry Pi 4 computers to be identified without relying upon the Ethernet MAC OUID. +In earlier releases the client GUID (Option97) was just the serial number repeated four times. By default, the new GUID format is the concatenation of the four-character code (FourCC) (`RPi4` `0x34695052` for Raspberry Pi 4 or `RPi5` `0x35695052` for Raspberry Pi 5), the board revision (e.g. `0x00c03111` or `0x00d04170`) (4-bytes), the least significant 4 bytes of the mac address and the 4-byte serial number. +This is intended to be unique but also provides structured information to the DHCP server, allowing Raspberry Pi 4 and 5 computers to be identified without relying upon the Ethernet MAC OUID. -Specify DHCP_OPTION97=0 to revert the old behaviour or a non-zero hex-value to specify a custom 4-byte prefix. +Specify `DHCP_OPTION97=0` to revert the old behaviour or a non-zero hex-value to specify a custom 4-byte prefix. Default: `0x34695052` @@ -254,6 +325,8 @@ Default: `""` Overrides the Raspberry Pi Ethernet MAC address with a value stored in the xref:raspberry-pi.adoc#write-and-read-customer-otp-values[Customer OTP] registers. For example, to use a MAC address stored in rows 0 and 1 of the `Customer OTP`. + +[source,ini] ---- MAC_ADDRESS_OTP=0,1 ---- @@ -261,7 +334,7 @@ MAC_ADDRESS_OTP=0,1 The first value (row 0 in the example) contains the OUI and the most significant 8 bits of the MAC address. The second value (row 1 in the example) stores the remaining 16-bits of the MAC address. This is the same format as used for the Raspberry Pi MAC address programmed at manufacture. -Any two customer rows may be selected and combined in either order. +Any two customer rows may be selected and combined in either order. The `Customer OTP` rows are OTP registers 36 to 43 in the `vcgencmd otp_dump` output so if the first two rows are programmed as follows then `MAC_ADDRESS_OTP=0,1` would give a MAC address of `e4:5f:01:20:24:7e`. @@ -300,7 +373,7 @@ Default: `""` [[DISABLE_HDMI]] ==== `DISABLE_HDMI` -The xref:raspberry-pi.adoc#boot-diagnostics-on-the-raspberry-pi-4[HDMI boot diagnostics] display is disabled if `DISABLE_HDMI=1`. Other non-zero values are reserved for future use. +The xref:raspberry-pi.adoc#boot-diagnostics[HDMI boot diagnostics] display is disabled if `DISABLE_HDMI=1`. Other non-zero values are reserved for future use. Default: `0` @@ -321,7 +394,7 @@ If self-update is enabled then the bootloader will look for the update files (.s Notes: * Bootloader releases prior to 2021 do not support `self-update`. -* Prior to 2022, self-update was not enabled in SD boot. On a Raspberry Pi 4, the ROM can already load recovery.bin from the SD card. On a CM4, neither self-update nor recovery.bin have any effect and USB boot is required (see the xref:compute-module.adoc#cm4bootloader[CM4 bootloader docs]). +* Prior to 2022, self-update was not enabled in SD boot. On a Raspberry Pi 4, the ROM can already load recovery.bin from the SD card. On a CM4, neither self-update nor recovery.bin have any effect and USB boot is required (see the xref:compute-module.adoc#compute-module-eeprom-bootloader[Compute Module EEPROM bootloader docs]). * Starting in 2022 (https://github.com/raspberrypi/rpi-eeprom/blob/master/firmware-2711/release-notes.md#2022-02-04---network-install---beta[beta] and https://github.com/raspberrypi/rpi-eeprom/blob/master/firmware-2711/release-notes.md#2022-03-10---promote-the-2022-03-10-beta-release-to-lateststable[stable]), self-update from an SD card is enabled. * For network boot make sure that the TFTP `boot` directory can be mounted via NFS and that `rpi-eeprom-update` can write to it. @@ -373,9 +446,9 @@ Default: `net_install` [[IMAGER_REPO_URL]] ==== `IMAGER_REPO_URL` -The embedded Raspberry Pi Imager application is configured with a json file downloaded at startup. +The embedded Raspberry Pi Imager application is configured with a JSON file downloaded at startup. -You can change the URL of the json file used by the embedded Raspberry Pi Imager application to get it to offer your own images. +You can change the URL of the JSON file used by the embedded Raspberry Pi Imager application to get it to offer your own images. You can test this with the standard https://www.raspberrypi.com/software/[Raspberry Pi Imager] application by passing the URL via the `--repo` argument. Default: `\http://downloads.raspberrypi.org/os_list_imagingutility_v3.json` @@ -391,7 +464,22 @@ This setting is ignored and network install is disabled if `DISABLE_HDMI=1` is s In order to detect the keyboard, network install must initialise the USB controller and enumerate devices. This increases boot time by approximately 1 second so it may be advantageous to disable network install in some embedded applications. -Default: `1` on Raspberry Pi 4 and Raspberry Pi 400, and `0` on Compute Module 4. +Default: `1` on Flagship models since Raspberry Pi 4B and Keyboard models; `0` on Compute Modules since CM4 (including CM4S). + +[[NET_INSTALL_AT_POWER_ON]] +==== `NET_INSTALL_AT_POWER_ON` + +When set to `1`, displays the network install UI briefly after a cold boot to make this feature more obvious to new users. Overrides `NET_INSTALL_ENABLED` if the settings conflict. + +The default bootloader images set this value to `1` in the bootloader config. To disable the brief network install UI display, use the `Advanced Options` menu in `raspi-config` or manually delete this line in `rpi-eeprom-config`: + +[source,console] +---- +$ sudo rpi-eeprom-config --edit +---- + + +Default: `0` [[NET_INSTALL_KEYBOARD_WAIT]] ==== `NET_INSTALL_KEYBOARD_WAIT` @@ -409,11 +497,11 @@ Default: `900` `NETCONSOLE` duplicates debug messages to the network interface. The IP addresses and ports are defined by the `NETCONSOLE` string. -NOTE: NETCONSOLE blocks until the ethernet link is established or a timeout occurs. The timeout value is `DHCP_TIMEOUT` although DHCP is not attempted unless network boot is requested. +NOTE: NETCONSOLE blocks until the Ethernet link is established or a timeout occurs. The timeout value is `DHCP_TIMEOUT` although DHCP is not attempted unless network boot is requested. ===== Format -See https://wiki.archlinux.org/index.php/Netconsole +For more information, see the https://wiki.archlinux.org/index.php/Netconsole[Netconsole documentation]. [source] ---- @@ -421,19 +509,19 @@ src_port@src_ip/dev_name,dst_port@dst_ip/dst_mac E.g. 6665@169.254.1.1/,6666@/ ---- -In order to simplify parsing, the bootloader requires every field separator to be present. The source IP address must be specified but the following fields may be left blank and assigned default values. +In order to simplify parsing, the bootloader requires every field separator to be present. You must specify the source IP address, but you can leave the following fields blank to use their default values: -* src_port - 6665 -* dev_name - "" (the device name is always ignored) -* dst_port - 6666 -* dst_ip - 255.255.255.255 -* dst_mac - 00:00:00:00:00 +* `src_port` - `6665` +* `dev_name` - `""` (the device name is always ignored) +* `dst_port` - `6666` +* `dst_ip` - `255.255.255.255` +* `dst_mac` - `00:00:00:00:00` -One way to view the data is to connect the test Raspberry Pi 4 to another Raspberry Pi running WireShark and select "`udp.srcport == 6665`" as a filter and select *Analyze -> Follow -> UDP stream* to view as an ASCII log. +One way to view the data is to connect the test Raspberry Pi 4 to another Raspberry Pi running WireShark and select `udp.srcport == 6665` as a filter and select *Analyze -> Follow -> UDP stream* to view as an ASCII log. `NETCONSOLE` should not be enabled by default because it may cause network problems. It can be enabled on demand via a GPIO filter: -[source] +[source,ini] ---- # Enable debug if GPIO 7 is pulled low [gpio7=0] @@ -449,6 +537,21 @@ Max length: 32 characters The `PARTITION` option may be used to specify the boot partition number, if it has not explicitly been set by the `reboot` command (e.g. `sudo reboot N`) or by `boot_partition=N` in `autoboot.txt`. This could be used to boot from a rescue partition if the user presses a button. + +The latest firmware also allows high partition numbers (> 31) to be overriden. This allows a custom setup of the system hardware watchdog to trigger a reboot with a special high partition number (e.g. 62) which can be detected by the bootloader (using a conditional filter) and remapped to a recovery partition. + +Example: +[source,ini] +---- +# System watchdog fired - boot the rescue partition with additional options +# Disable SD high speed mode and enable HDMI diagnostics immediately. +[partition=62] +PARTITION=2 +HDMI_DELAY=0 +SD_QUIRKS=1 +---- + +[source,ini] ---- # Boot from partition 2 if GPIO 7 is pulled low [gpio7=0] @@ -457,6 +560,21 @@ PARTITION=2 Default: 0 +[[PARTITION_WALK]] +==== `PARTITION_WALK` +This property is designed to improve the reliability of `A/B` boot schemes using `autoboot.txt` by searching for bootable partitions if the specified partition does not appear to be bootable. If `PARTITION_WALK=1` and the requested partition is not bootable and does not have a valid `autoboot.txt` then the bootloader will check each partition in turn (up to 8 and wrapping to 0) to see if it is bootable (contains `start4.elf` on a Pi4, or `config.txt` and a suitable device-tree on Pi 5 or newer). + +During the "partition walk" `autoboot.txt` files are not processed to avoid cycling dependencies. It is assumed that the requested boot partition has failed and the system is attempting recovery. + +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` @@ -501,18 +619,11 @@ Default: `2000` (2 seconds) Raspberry Pi 4 only. -When the Pi is rebooted power USB power is switched off by the hardware. A short power off time can -cause problems with some USB devices so this parameter may be used to force a longer power off -as though the cable was physically removed. +When the Pi is rebooted power USB power is switched off by the hardware. A short power off time can cause problems with some USB devices so this parameter may be used to force a longer power off as though the cable was physically removed. -On Pi4 v1.3 and older the configurable/long power off requires the XHCI controller to be enabled -so there is actually a short power off followed by a longer configurable power off. The longer -configurable power off may be skipped by setting this parameter to zero. +On RaspberryPi 4 version 1.3 and older, the configurable/long power off requires the XHCI controller to be enabled so there is actually a short power off followed by a longer configurable power off. The longer configurable power off may be skipped by setting this parameter to zero. -On newer revisions the hardware ensures that USB power is off from reboot and the bootloader -only enables power after this timeout has elapsed. This is happens after memory is initialised -ensuring that USB power is off for at least two seconds. Therefore, this parameter generally -has no effect on newer hardware revisions. +On newer revisions the hardware ensures that USB power is off from reboot and the bootloader only enables power after this timeout has elapsed. This is happens after memory is initialised ensuring that USB power is off for at least two seconds. Therefore, this parameter generally has no effect on newer hardware revisions. Minimum: `0` @@ -549,6 +660,7 @@ Default: `0` This property is a bit-field which controls the verbosity of USB debug messages for mass storage boot-mode. Enabling all of these messages generates a huge amount of log data which will slow down booting and may even cause boot to fail. For verbose logs it's best to use `NETCONSOLE`. +[cols="1m,3"] |=== | Value | Log @@ -576,6 +688,7 @@ This property is a bit-field which controls the verbosity of USB debug messages To combine values, add them together. For example: +[source,ini] ---- # Enable mass storage and USB descriptor logging XHCI_DEBUG=0x3 @@ -583,144 +696,47 @@ XHCI_DEBUG=0x3 Default: `0x0` (no USB debug messages enabled) -[[config_txt]] -==== `[config.txt]` section - -After reading `config.txt` the GPU firmware `start4.elf` reads the bootloader EEPROM config and checks for a section called `[config.txt]`. If the `[config.txt]` section exists then the contents from the start of this section to the end of the file is appended in memory, to the contents of the `config.txt` file read from the boot partition. This can be used to automatically apply settings to every operating system, for example, dtoverlays. - -WARNING: If an invalid configuration which causes boot to fail is specified, then the bootloader EEPROM will have to be re-flashed. - -=== Configuration Properties in `config.txt` - -Raspberry Pi 5 requires a `config.txt` file to be present to indicate that the partition is bootable. - -[[boot_ramdisk]] -==== `boot_ramdisk` - -If this property is set to `1` then the bootloader will attempt load a ramdisk file called `boot.img` containing the xref:configuration.adoc#the-boot-folder[boot filesystem]. Subsequent files (e.g. `start4.elf`) are read from the ramdisk instead of the original boot file system. - -The primary purpose of `boot_ramdisk` is to support `secure-boot`, however, unsigned `boot.img` files can also be useful to Network Boot or `RPIBOOT` configurations. - -* The maximum size for a ramdisk file is 96MB. -* `boot.img` files are raw disk `.img` files. The recommended format is a plain FAT32 partition with no MBR. -* The memory for the ramdisk filesystem is released before the operating system is started. -* If xref:raspberry-pi.adoc#fail-safe-os-updates-tryboot[TRYBOOT] is selected then the bootloader will search for `tryboot.img` instead of `boot.img`. -* See also xref:config_txt.adoc#autoboot-txt[autoboot.txt]. - -For more information about `secure-boot` and creating `boot.img` files please see https://github.com/raspberrypi/usbboot/blob/master/Readme.md[USBBOOT]. - -Default: `0` - -[[boot_load_flags]] -==== `boot_load_flags` - -Experimental property for custom firmware (bare metal). +[[SDRAM_BANKLOW]] +==== `SDRAM_BANKLOW` -Bit 0 (0x1) indicates that the .elf file is custom firmware. This disables any compatibility checks (e.g. is USB MSD boot supported) and resets PCIe before starting the executable. +SDRAM_BANKLOW controls how the SDRAM banks are arranged within the system address space. The number of bank bits may be selectively mapped to being located in the MSBs of the address, or being located between the row and column address bits. +This setting can significantly affect SDRAM performance. -Not relevant on Raspberry Pi 5 because there is no `start.elf` file. - -Default: `0x0` - -[[uart_2ndstage]] -==== `uart_2ndstage` - -If `uart_2ndstage` is `1` then enable debug logging to the UART. This option also automatically enables UART logging in `start.elf`. This is also described on the xref:config_txt.adoc#boot-options[Boot options] page. - -The `BOOT_UART` property also enables bootloader UART logging but does not enable UART logging in `start.elf` unless `uart_2ndstage=1` is also set. - -Default: `0` - -[[erase_eeprom]] -==== `erase_eeprom` - -If `erase_eeprom` is set to `1` then `recovery.bin` will erase the entire SPI EEPROM instead of flashing the bootloader image. This property has no effect during a normal boot. - -Default: `0` - -[[eeprom_write_protect]] -==== `eeprom_write_protect` - -Configures the EEPROM `write status register`. This can be set either to mark the entire EEPROM as write-protected, or to clear write-protection. - -This option must be used in conjunction with the EEPROM `/WP` pin which controls updates to the EEPROM `Write Status Register`. Pulling `/WP` low (CM4 `EEPROM_nWP` or on a Raspberry Pi 4 `TP5`) does NOT write-protect the EEPROM unless the `Write Status Register` has also been configured. - -See the https://www.winbond.com/resource-files/w25x40cl_f%2020140325.pdf[Winbond W25x40cl] or https://www.winbond.com/hq/product/code-storage-flash-memory/serial-nor-flash/?__locale=en&partNo=W25Q16JV[Winbond W25Q16JV] datasheets for further details. - -`eeprom_write_protect` settings in `config.txt` for `recovery.bin`. +When unset, the bootloader will choose the preferred option. This is currently 3 on Pi 4 family and 1 on Pi 5 family. +[cols="1m,3"] |=== -| Value | Description - -| 1 -| Configures the write protect regions to cover the entire EEPROM. +| BANKLOW | Address Bit Mapping | 0 -| Clears the write protect regions. - -| -1 -| Do nothing. -|=== - -NOTE: `flashrom` does not support clearing of the write-protect regions and will fail to update the EEPROM if write-protect regions are defined. - -On Raspberry Pi 5 `/WP` is pulled low by default and consequently write-protect is enabled as soon as the `Write Status Register` is configured. To clear write-protect pull `/WP` high by connecting `TP14` and `TP1`. - -Default: `-1` - -[[os_check]] -==== `os_check` - -On Raspberry Pi 5 the firmware automatically checks for a compatible Device Tree file before attempting to boot from the current partition. Otherwise, older non-compatible kernels would be loaded and then hang. -To disable this check (e.g. for bare-metal development), set `os_check=0` in config.txt - -Default: `1` - -[[bootloader_update]] -==== `bootloader_update` - -This option may be set to 0 to block self-update without requiring the EEPROM configuration to be updated. This is sometimes useful when updating multiple Raspberry Pis via network boot because this option can be controlled per Raspberry Pi (e.g. via a serial number filter in `config.txt`). - -Default: `1` - -=== Secure Boot configuration properties in `config.txt` +| Address = {bank[3:0], row, column} -[.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] -**** -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. -**** - -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. - -For more information about enabling `secure-boot` please see the https://github.com/raspberrypi/usbboot/blob/master/Readme.md#secure-boot[Secure Boot readme] and the https://github.com/raspberrypi/usbboot/blob/master/secure-boot-example/README.md[Secure Boot tutorial] in the https://github.com/raspberrypi/usbboot[USBBOOT] repo. - - -[[program_pubkey]] -==== `program_pubkey` - -If this property is set to `1` then `recovery.bin` will write the hash of the public key in the EEPROM image to OTP. Once set, the bootloader will reject EEPROM images signed with different RSA keys or unsigned images. - -Default: `0` +| 1 +| Address = {bank[3:1], row, bank[0], column} -[[revoke_devkey]] -==== `revoke_devkey` +| 2 +| Address = {bank[3:2], row, bank[1:0], column} -If this property is set to `1` then `recovery.bin` will write a value to OTP that prevents the ROM from loading old versions of the second stage bootloader which do not support `secure-boot`. This prevents `secure-boot` from being turned off by reverting to an older release of the bootloader. +| 3 +| Address = {bank[3], row, bank[2:0], column} -Default: `0` +| 4 +| Address = {row, bank[3:0], column} +|=== -[[program_rpiboot_gpio]] -==== `program_rpiboot_gpio` +This setting also causes the bootloader to add a setting for the number of NUMA regions to be used by the kernel ("numa=fake="). +For best performance these settings should be left as default. -Since there is no dedicated `nRPIBOOT` jumper on Raspberry Pi 4B or Raspberry Pi 400, an alternative GPIO must be used to select `RPIBOOT` mode by pulling the GPIO low. Only one GPIO may be selected and the available options are `2, 4, 5, 7, 8`. This property does not depend on `secure-boot`, but verify that this GPIO configuration does not conflict with any HATs which might pull the GPIO low during boot. +Note: on a Pi 5 family device, if NUMA is not available in the kernel then performance will be adversely affected. +Manually choosing SDRAM_BANKLOW=3 will mitigate this performance hit, although for highest performance, ensure NUMA is available. -Since for safety this property can only be programmed via `RPIBOOT`, the bootloader EEPROM must first be cleared using `erase_eeprom`. This causes the BCM2711 ROM to failover to `RPIBOOT` mode, which then allows this option to be set. +Default: unset (use bootloader recommended setting) -Default: `` +[[config_txt]] +==== `[config.txt]` section -[[program_jtag_lock]] -==== `program_jtag_lock` +After reading `config.txt` the GPU firmware `start4.elf` reads the bootloader EEPROM config and checks for a section called `[config.txt]`. If the `[config.txt]` section exists then the contents from the start of this section to the end of the file is appended in memory, to the contents of the `config.txt` file read from the boot partition. This can be used to automatically apply settings to every operating system, for example, dtoverlays. -If this property is set to `1` then `recovery.bin` will program an OTP value that prevents VideoCore JTAG from being used. This option requires that `program_pubkey` and `revoke_devkey` are also set. This option can prevent failure analysis, and should only be set after the device has been fully tested. +WARNING: If you configure the bootloader with an invalid configuration that fails to boot, you must re-flash the bootloader EEPROM with a valid configuration to boot. -Default: `0` +TIP: Some configuration properties live in `config.txt`. For more information about those properties, see xref:config_txt.adoc#configuration-properties[configuration properties]. diff --git a/documentation/asciidoc/computers/raspberry-pi/frequency-management.adoc b/documentation/asciidoc/computers/raspberry-pi/frequency-management.adoc index 83fad12b5..e71d65294 100644 --- a/documentation/asciidoc/computers/raspberry-pi/frequency-management.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/frequency-management.adoc @@ -8,16 +8,17 @@ For Raspberry Pi 3 Model B+, the PCB technology has been changed to provide bett The Raspberry Pi 4 Model B continues with the same PCB technology as the Raspberry Pi 3 Model B+, to help dissipate excess heat. There is currently no soft limit defined. -=== Using DVFS +=== Use DVFS -NOTE: Discussion of DVFS applies to Raspberry Pi 4 Model B, Raspberry Pi 400, and Compute Module 4 only. +NOTE: Discussion of DVFS applies to 4-series devices only (Raspberry Pi 4, Compute Module 4, and Pi 400). -Raspberry Pi 4 devices implement dynamic voltage and frequency scaling (DVFS). This technique allows Raspberry Pi 4 devices to run at lower temperatures whilst still providing the same performance. +Raspberry Pi 4 devices implement dynamic voltage and frequency scaling (DVFS). This technique allows 4-series devices to run at lower temperatures whilst still providing the same performance. Various clocks (e.g. Arm, Core, V3D, ISP, H264, HEVC) inside the SoC are monitored by the firmware, and whenever they are not running at full speed, the voltage supplied to the particular part of the chip driven by the clock is reduced relative to the reduction from full speed. In effect, only enough voltage is supplied to keep the block running correctly at the specific speed at which it is running. This can result in significant reductions in power used by the SoC, and therefore in the overall heat being produced. Due to possible system stability problems involved with running an undervoltage, especially when using undervoltaged fixed clock peripherals (eg. PCIe), three DVFS modes are available and can be configured in xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`] with the below properties. Most systems should use `dvfs=3`, headless systems may benefit from a small power reduction with `dvfs=1` at the risk of PCIe stability issues. +[cols="1m,3"] |=== | property=value | Description @@ -31,41 +32,49 @@ Due to possible system stability problems involved with running an undervoltage, | scale voltage up on demand for over clocking (default). If `over_voltage` is specified in `config.txt` then dynamic voltage scaling is disabled causing the system to revert to `dvfs=2`. |=== -NOTE: This setting has been removed on Raspberry Pi 5 and is effectively always mode 3. +NOTE: This setting has been removed on 5-series devices and is effectively always mode 3. -In addition, a more stepped CPU governor is also used to produce finer-grained control of ARM core frequencies, which means the DVFS is more effective. The steps are now 1500MHz, 1000MHz, 750MHz, and 600MHz. These steps can also help when the SoC is being throttled, and mean that throttling all the way back to 600MHz is much less likely, giving an overall increase in fully loaded performance. +In addition, a more stepped CPU governor is also used to produce finer-grained control of Arm core frequencies, which means the DVFS is more effective. The steps are now 1500MHz, 1000MHz, 750MHz, and 600MHz. These steps can also help when the SoC is being throttled, and mean that throttling all the way back to 600MHz is much less likely, giving an overall increase in fully loaded performance. The default CPU governor is `ondemand`. The governor can be manually changed with the `cpufreq-set` command (from the `cpufrequtils` package) to reduce idle power consumption: -[,bash] +[source,console] ---- - sudo apt install cpufrequtils - sudo cpufreq-set -g powersave +$ sudo apt install cpufrequtils +$ sudo cpufreq-set -g powersave ---- -=== Measuring temperatures +=== Measure temperatures Due to the architecture of the SoCs used on Raspberry Pi devices, and the use of the upstream temperature monitoring code in the Raspberry Pi OS distribution, Linux-based temperature measurements can be inaccurate. However, the `vcgencmd` command provides an accurate and instantaneous reading of the current SoC temperature, as it communicates with the GPU directly: -[,bash] +[source,console] ---- - vcgencmd measure_temp +$ vcgencmd measure_temp ---- -=== Adding heatsinks +=== Add heat sinks Thanks to built-in throttling, heatsinks are not necessary to prevent overheating damage to the SoC. However, a heatsink or small fan can reduce thermal throttling and improve performance. Mount the Raspberry Pi vertically for the best airflow and thus slightly improved heat dissipation. === Fan cases -Raspberry Pi 5 has two official fan options to assist with cooling: +To ensure the best performance for your Raspberry Pi, use an active cooling solution such as a fan. Raspberry Pi firmware manages fan speeds for all official fans. + +==== Raspberry Pi 4 fan + +For Raspberry Pi 4, add the https://www.raspberrypi.com/products/raspberry-pi-4-case-fan/[Raspberry Pi 4 Case Fan] to the lid of the Raspberry Pi 4 case. + +==== Raspberry Pi 5 fans + +For Raspberry Pi 5, use one of the official fan options: * https://www.raspberrypi.com/products/active-cooler/[Active Cooler] * https://www.raspberrypi.com/products/raspberry-pi-5-case/[Case for Raspberry Pi 5] -Both of these plug into the four-pin JST-SH PWM fan connector located in the upper right of the board between the 40-pin GPIO header and the USB 2 ports. The fan connector pulls from the same current limit as USB peripherals. We recommend the Active Cooler case for overclockers, since it provides better cooling performance. +Both of the Raspberry Pi 5 fan options plug into the four-pin JST-SH PWM fan connector located in the upper right of the board between the 40-pin GPIO header and the USB 2 ports. The fan connector pulls from the same current limit as USB peripherals. We recommend the Active Cooler case for overclockers, since it provides better cooling performance. -Both of the available official accessories are actively managed by Raspberry Pi firmware. As the temperature of the Raspberry Pi increases, the fan reacts in the following way: +As the temperature of the Raspberry Pi 5 increases, the fan reacts in the following way: * below 50°C, the fan does not spin at all (0% speed) * at 50°C, the fan turns on at a low speed (30% speed) @@ -75,17 +84,18 @@ Both of the available official accessories are actively managed by Raspberry Pi Temperature decreases use the same mapping with a 5°C **hysteresis**; fan speed decreases when the temperature drops to 5°C below each of the above thresholds. -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`. +NOTE: The temperature, hysteresis and speed figures given above can be adjusted by using the various `fan_tempN`, `fan_tempN_hyst` and `fan_tempN_speed` dtoverlay settings (where `N` is 0, 1, 2 or 3). See https://github.com/raspberrypi/linux/blob/rpi-6.12.y/arch/arm/boot/dts/overlays/README[the overlays README] for full details. For example, adding `dtparam=fan_temp0=55000` to `/boot/firmware/config.txt` will cause the fan to remain off until the Raspberry Pi 5's temperature reaches 55°C. -INFO: Both fan options use the Coolcox https://www.coolcox.com/products/pdf/CC3007.pdf[CC3007H05S] part. +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`. -==== Fan connector pinout +==== Raspberry Pi 5 fan connector pinout -The fan connector is a 1mm pitch JST-SH socket containing the following four pins: +The Raspberry Pi 5 fan connector is a 1mm pitch JST-SH socket containing the following four pins: [cols="1,2,2",width="50"%"] |=== | Pin | Function | Wire colour + | 1 | +5V | Red | 2 | PWM | Blue | 3 | GND | Black diff --git a/documentation/asciidoc/computers/raspberry-pi/gpio-on-raspberry-pi.adoc b/documentation/asciidoc/computers/raspberry-pi/gpio-on-raspberry-pi.adoc index 5ae39369c..e74ec7baa 100644 --- a/documentation/asciidoc/computers/raspberry-pi/gpio-on-raspberry-pi.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/gpio-on-raspberry-pi.adoc @@ -1,13 +1,40 @@ [[gpio]] -== General Purpose I/O (GPIO) +== GPIO and the 40-pin header + +You can find a 40-pin GPIO (general-purpose input/output) header on all current Raspberry Pi boards. The GPIO headers on all boards have a 0.1in (2.54mm) pin pitch. + +NOTE: The header is unpopulated (has no headers) on Zero and Pico devices that lack the "H" suffix. + +image::images/GPIO-Pinout-Diagram-2.png[alt="GPIO pinout diagram",width="100%"] General Purpose I/O (GPIO) pins can be configured as either general-purpose input, general-purpose output, or as one of up to six special alternate settings, the functions of which are pin-dependent. -There are three GPIO banks on BCM2835. Each of the three banks has its own VDD input pin. On Raspberry Pi, all GPIO banks are supplied from 3.3V. +image::images/GPIO.png[alt="GPIO layout",width="100%"] + +NOTE: The GPIO pin numbering scheme is not in numerical order. GPIO pins 0 and 1 are present on the board (physical pins 27 and 28), but are reserved for advanced use. + +=== Outputs + +A GPIO pin designated as an output pin can be set to high (3.3V) or low (0V). + +=== Inputs + +A GPIO pin designated as an input pin can be read as high (3.3V) or low (0V). This is made easier with the use of internal pull-up or pull-down resistors. Pins GPIO2 and GPIO3 have fixed pull-up resistors, but for other pins this can be configured in software. -WARNING: Connection of a GPIO to a voltage higher than 3.3V will likely destroy the GPIO block within the SoC. +=== View a GPIO pinout for your Raspberry Pi -A selection of pins from Bank 0 is available on the P1 header on Raspberry Pi. +A GPIO reference can be accessed on your Raspberry Pi by opening a terminal window and running the command `pinout`. This tool is provided by the https://gpiozero.readthedocs.io/[GPIO Zero] Python library, which is installed by default in Raspberry Pi OS. + +WARNING: While connecting simple components to GPIO pins is safe, be careful how you wire things up. LEDs should have resistors to limit the current passing through them. Do not use 5V for 3.3V components. Do not connect motors directly to the GPIO pins, instead use an https://projects.raspberrypi.org/en/projects/physical-computing/14[H-bridge circuit or a motor controller board]. + +=== Permissions + +In order to use the GPIO ports, your user must be a member of the `gpio` group. The default user account is a member by default, but you must add other users manually using the following command: + +[source,console] +---- +$ sudo usermod -a -G gpio +---- === GPIO pads @@ -39,9 +66,25 @@ The normal rising/falling edge detection has a small amount of synchronisation b Almost all of the GPIO pins have alternative functions. Peripheral blocks internal to the SoC can be selected to appear on one or more of a set of GPIO pins, for example the I2C buses can be configured to at least three separate locations. xref:raspberry-pi.adoc#gpio-pads-control[Pad control], such as drive strength or Schmitt filtering, still applies when the pin is configured as an alternate function. +Some functions are available on all pins, others on specific pins: + +* PWM (pulse-width modulation) + ** Software PWM available on all pins + ** Hardware PWM available on GPIO12, GPIO13, GPIO18, GPIO19 +* SPI + ** SPI0: MOSI (GPIO10); MISO (GPIO9); SCLK (GPIO11); CE0 (GPIO8), CE1 (GPIO7) + ** SPI1: MOSI (GPIO20); MISO (GPIO19); SCLK (GPIO21); CE0 (GPIO18); CE1 (GPIO17); CE2 (GPIO16) +* I2C + ** Data: (GPIO2); Clock (GPIO3) + ** EEPROM Data: (GPIO0); EEPROM Clock (GPIO1) +* Serial + ** TX (GPIO14); RX (GPIO15) + === Voltage specifications -The table below gives the various voltage specifications for the GPIO pins for BCM2835, BCM2836, BCM2837 and RP3A0-based products (e.g. Raspberry Pi Zero or Raspberry Pi 3+). For information about Compute Modules you should see the xref:compute-module.adoc#datasheets-and-schematics[relevant datasheets]. +Two 5V pins and two 3.3V pins are present on the board, as well as a number of ground pins (GND), which can not be reconfigured. The remaining pins are all general-purpose 3.3V pins, meaning outputs are set to 3.3V and inputs are 3.3V-tolerant. + +The table below gives the various voltage specifications for the GPIO pins for BCM2835, BCM2836, BCM2837 and RP3A0-based products (e.g. Raspberry Pi Zero or Raspberry Pi 3+). For information about Compute Modules you should see the xref:compute-module.adoc#specifications[relevant datasheets]. |=== | Symbol | Parameter | Conditions   | Min | Typical | Max | Unit @@ -131,7 +174,7 @@ The table below gives the various voltage specifications for the GPIO pins for B ^b^ Default drive strength (8mA) + ^c^ Maximum drive strength (16mA) -The table below gives the voltage specifications for the GPIO pins on BCM2711-based products (e.g. Raspberry Pi 4 and Raspberry Pi 400). For information about Compute Modules you should see the xref:compute-module.adoc#datasheets-and-schematics[relevant datasheets]. +The table below gives the voltage specifications for the GPIO pins on BCM2711-based products (4-series devices). For information about Compute Modules you should see the xref:compute-module.adoc#specifications[relevant datasheets]. |=== | Symbol | Parameter | Conditions   | Min | Typical | Max | Unit diff --git a/documentation/asciidoc/computers/raspberry-pi/gpio-pad-controls.adoc b/documentation/asciidoc/computers/raspberry-pi/gpio-pad-controls.adoc index 721e5c56a..5379d9e05 100644 --- a/documentation/asciidoc/computers/raspberry-pi/gpio-pad-controls.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/gpio-pad-controls.adoc @@ -2,20 +2,18 @@ GPIO drive strengths do not indicate a maximum current, but a maximum current under which the pad will still meet the specification. You should set the GPIO drive strengths to match the device being attached in order for the device to work correctly. -[discrete] -=== How drive strength is controlled +=== Control drive strength -Inside the pad are a number of drivers in parallel. If the drive strength is set low (0b000), most of these are tri-stated so they do not add anything to the output current. If the drive strength is increased, more and more drivers are put in parallel. The diagram shows that behaviour. +Inside the pad are a number of drivers in parallel. If the drive strength is set low (`0b000`), most of these are tri-stated so they do not add anything to the output current. If the drive strength is increased, more and more drivers are put in parallel. The diagram shows that behaviour. -WARNING: For Raspberry Pi 4, Raspberry Pi 400 and Compute Module 4 the current level is half the value shown in the diagram. +WARNING: On 4-series devices, the current level is half the value shown in the diagram. image::images/pi_gpio_drive_strength_diagram.png[GPIO drive strength diagram] -[discrete] -=== What does the current value mean? +=== Current value + +The current value specifies the maximum current under which the pad will still meet the specification. -NOTE: The current value specifies the maximum current under which the pad will still meet the specification. -+ Current value is _not_ the current that the pad will deliver, and is _not_ a current limit. The pad output is a voltage source: @@ -41,18 +39,12 @@ There is more information on the xref:raspberry-pi.adoc#gpio[physical characteri NOTE: On the Compute Module devices, it is possible to change the VDD IO from the standard 3.3V. In this case, V~OL~ and V~OH~ will change according to the table in the xref:raspberry-pi.adoc#gpio[GPIO] section. -[discrete] -=== Why can't I set all my pads to the maximum current? - -* The Raspberry Pi 3.3V supply was designed with a maximum current of ~3mA per GPIO pin. If you load each pin with 16mA, the total current is 272mA. The 3.3V supply will collapse under that level of load. -* Big current spikes will happen, especially if you have a capacitive load. Spikes will bounce around all the other pins near them. This is likely to cause interference with the SD card, or even the SDRAM behaviour. +The Raspberry Pi 3.3V supply was designed with a maximum current of ~3mA per GPIO pin. If you load each pin with 16mA, the total current is 272mA. The 3.3V supply will collapse under that level of load. Big current spikes will happen, especially if you have a capacitive load. Spikes will bounce around all the other pins near them. This is likely to cause interference with the SD card, or even the SDRAM behaviour. -[discrete] -=== What is a safe current? +=== Safe current All the electronics of the pads are designed for 16mA. This is a safe value under which you will not damage the device. Even if you set the drive strength to 2mA and then load it so 16mA comes out, this will not damage the device. Other than that, there is no guaranteed maximum safe current. -[discrete] === GPIO addresses * 0x 7e10 002c PADS (GPIO 0-27) @@ -95,7 +87,6 @@ All the electronics of the pads are designed for 16mA. This is a safe value unde Beware of Simultaneous Switching Outputs (SSO) limitations which are device-dependent as well as dependent on the quality and layout of the PCB, the amount and quality of the decoupling capacitors, the type of load on the pads (resistance, capacitance), and other factors beyond the control of Raspberry Pi. -[discrete] === Drive strength list * 0 = 2mA diff --git a/documentation/asciidoc/computers/raspberry-pi/images/2-model-b.jpg b/documentation/asciidoc/computers/raspberry-pi/images/2-model-b.jpg new file mode 100644 index 000000000..0374da318 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/2-model-b.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/3-model-a-plus.jpg b/documentation/asciidoc/computers/raspberry-pi/images/3-model-a-plus.jpg new file mode 100644 index 000000000..084fb1f82 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/3-model-a-plus.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/3-model-b-plus.jpg b/documentation/asciidoc/computers/raspberry-pi/images/3-model-b-plus.jpg new file mode 100644 index 000000000..b36dcb63d Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/3-model-b-plus.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/3-model-b.jpg b/documentation/asciidoc/computers/raspberry-pi/images/3-model-b.jpg new file mode 100644 index 000000000..56be0d94b Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/3-model-b.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/4-model-b.jpg b/documentation/asciidoc/computers/raspberry-pi/images/4-model-b.jpg new file mode 100644 index 000000000..fcf8e3942 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/4-model-b.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/400.jpg b/documentation/asciidoc/computers/raspberry-pi/images/400.jpg new file mode 100644 index 000000000..392696b3a Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/400.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/5.jpg b/documentation/asciidoc/computers/raspberry-pi/images/5.jpg new file mode 100644 index 000000000..2fe9e165f Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/5.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/500.png b/documentation/asciidoc/computers/raspberry-pi/images/500.png new file mode 100644 index 000000000..d4965dc0b Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/500.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/500plus.png b/documentation/asciidoc/computers/raspberry-pi/images/500plus.png new file mode 100644 index 000000000..4a8d2c0f2 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/500plus.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/500plusfront.png b/documentation/asciidoc/computers/raspberry-pi/images/500plusfront.png new file mode 100644 index 000000000..9a7bd7400 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/500plusfront.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/GPIO-Pinout-Diagram-2.png b/documentation/asciidoc/computers/raspberry-pi/images/GPIO-Pinout-Diagram-2.png new file mode 100644 index 000000000..24238cc23 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/GPIO-Pinout-Diagram-2.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/GPIO.png b/documentation/asciidoc/computers/raspberry-pi/images/GPIO.png new file mode 100644 index 000000000..1f466a43b Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/GPIO.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-1.jpg b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-1.jpg new file mode 100644 index 000000000..caa01fec3 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-1.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-3-plus.jpg b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-3-plus.jpg new file mode 100644 index 000000000..dc266211b Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-3-plus.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-3.jpg b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-3.jpg new file mode 100644 index 000000000..c82500604 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-3.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4.jpg b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4.jpg new file mode 100644 index 000000000..74141b492 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4s.jpg b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4s.jpg new file mode 100644 index 000000000..7119617d8 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-4s.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/compute-module-5.png b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-5.png new file mode 100644 index 000000000..70140e593 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/compute-module-5.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/j5.png b/documentation/asciidoc/computers/raspberry-pi/images/j5.png index ca70ca3e1..1de24e571 100644 Binary files a/documentation/asciidoc/computers/raspberry-pi/images/j5.png and b/documentation/asciidoc/computers/raspberry-pi/images/j5.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/model-a-plus.jpg b/documentation/asciidoc/computers/raspberry-pi/images/model-a-plus.jpg new file mode 100644 index 000000000..40f8231a5 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/model-a-plus.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/model-a.jpg b/documentation/asciidoc/computers/raspberry-pi/images/model-a.jpg new file mode 100644 index 000000000..3a20cbf82 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/model-a.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/model-b-plus.jpg b/documentation/asciidoc/computers/raspberry-pi/images/model-b-plus.jpg new file mode 100644 index 000000000..acab61b8e Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/model-b-plus.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/model-b.jpg b/documentation/asciidoc/computers/raspberry-pi/images/model-b.jpg new file mode 100644 index 000000000..5f8bc84fd Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/model-b.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/pico-2-w.png b/documentation/asciidoc/computers/raspberry-pi/images/pico-2-w.png new file mode 100644 index 000000000..77466f987 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/pico-2-w.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/pico-2.png b/documentation/asciidoc/computers/raspberry-pi/images/pico-2.png new file mode 100644 index 000000000..f3fe1bac9 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/pico-2.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/pico-h.png b/documentation/asciidoc/computers/raspberry-pi/images/pico-h.png new file mode 100644 index 000000000..4e9c6895e Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/pico-h.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/pico-w.png b/documentation/asciidoc/computers/raspberry-pi/images/pico-w.png new file mode 100644 index 000000000..2d42d02ce Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/pico-w.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/pico-wh.png b/documentation/asciidoc/computers/raspberry-pi/images/pico-wh.png new file mode 100644 index 000000000..014f92957 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/pico-wh.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/pico.png b/documentation/asciidoc/computers/raspberry-pi/images/pico.png new file mode 100644 index 000000000..d36e87d79 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/pico.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/zero-2-w.jpg b/documentation/asciidoc/computers/raspberry-pi/images/zero-2-w.jpg new file mode 100644 index 000000000..b1998ce27 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/zero-2-w.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/zero-2-wh.png b/documentation/asciidoc/computers/raspberry-pi/images/zero-2-wh.png new file mode 100644 index 000000000..f87157e22 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/zero-2-wh.png differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/zero-w.jpg b/documentation/asciidoc/computers/raspberry-pi/images/zero-w.jpg new file mode 100644 index 000000000..87c1d9337 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/zero-w.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/zero-wh.jpg b/documentation/asciidoc/computers/raspberry-pi/images/zero-wh.jpg new file mode 100644 index 000000000..d9b00c7b2 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/zero-wh.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/images/zero.jpg b/documentation/asciidoc/computers/raspberry-pi/images/zero.jpg new file mode 100644 index 000000000..c698be8e1 Binary files /dev/null and b/documentation/asciidoc/computers/raspberry-pi/images/zero.jpg differ diff --git a/documentation/asciidoc/computers/raspberry-pi/introduction.adoc b/documentation/asciidoc/computers/raspberry-pi/introduction.adoc new file mode 100644 index 000000000..de3d1cffb --- /dev/null +++ b/documentation/asciidoc/computers/raspberry-pi/introduction.adoc @@ -0,0 +1,447 @@ +== Introduction + +Raspberry Pi makes computers in several different **series**: + +* **<>.** The flagship Raspberry Pi series offers high-performance hardware, a full Linux operating system, and a variety of common ports in a form factor roughly the size of a credit card. +* **<>.** Raspberry Pi keyboard computers combine SBC hardware, a full Linux operating system, and common ports inside a compact keyboard case. +* **<>.** Small and affordable models in a minimal form factor that provide a full Linux operating system and essential ports with low power consumption. +* **<>.** Boards designed for embedded and industrial applications that provide the same hardware as flagship SBCs but in a smaller form factor with no on-board connectors. Instead, they connect to a separate baseboard that supplies the necessary ports and pins. +* **<>.** Small and versatile boards that don't run Linux. Instead of removable storage, programs are flashed directly onto on-board memory. Pico microcontrollers are ideal for real-time control and lightweight embedded projects. + +[[flagship-series]] +=== Flagship single-board computer (SBC) series + +*Model B* indicates the presence of an Ethernet port. +*Model A* indicates a lower-cost model in a smaller form factor with no Ethernet port, reduced RAM, and fewer USB ports to limit board height. + +[cols="6a,2,2,3,5"] +|=== +| Model | SoC | Memory | GPIO | Connectivity + +^.^a| +.Raspberry Pi Model B +image::images/model-b.jpg[alt="Raspberry Pi Model B"] +| xref:processors.adoc#bcm2835[BCM2835] +a| +256 MB + +512 MB | 26-pin GPIO header +a| +* HDMI +* 2 × USB 2.0 +* standard 15-pin, 1.0 mm pitch, 16 mm width, CSI (camera) port +* standard 15-pin, 1.0 mm pitch, 16 mm width, DSI (display) port +* 3.5 mm audio jack +* RCA composite video +* 100 Mb/s Ethernet RJ45 +* SD card slot +* micro-USB power +^.^a| +.Raspberry Pi Model A +image::images/model-a.jpg[alt="Raspberry Pi Model A",width="80%"] +| xref:processors.adoc#bcm2835[BCM2835] | 256 MB | 26-pin GPIO header +a| +* HDMI +* USB 2.0 +* standard 15-pin, 1.0 mm pitch, 16 mm width, CSI (camera) port +* standard 15-pin, 1.0 mm pitch, 16 mm width, DSI (display) port +* 3.5 mm audio jack +* RCA composite video +* SD card slot +* micro-USB power +^.^a| +.Raspberry Pi Model B+ +image::images/model-b-plus.jpg[alt="Raspberry Pi Model B+"] +| xref:processors.adoc#bcm2835[BCM2835] | 512 MB | 40-pin GPIO header +a| +* HDMI +* 4 × USB 2.0 +* standard 15-pin, 1.0 mm pitch, 16 mm width, CSI (camera) port +* standard 15-pin, 1.0 mm pitch, 16 mm width, DSI (display) port +* 3.5 mm AV jack +* 100 Mb/s Ethernet RJ45 +* microSD card slot +* micro-USB power +^.^a| +.Raspberry Pi Model A+ +image::images/model-a-plus.jpg[alt="Raspberry Pi Model A+"] +| xref:processors.adoc#bcm2835[BCM2835] +a| +256 MB + +512 MB | 40-pin GPIO header +a| +* HDMI +* USB 2.0 +* standard 15-pin, 1.0 mm pitch, 16 mm width, CSI (camera) port +* standard 15-pin, 1.0 mm pitch, 16 mm width, DSI (display) port +* 3.5mm AV jack +* microSD card slot +* micro-USB power +^.^a| +.Raspberry Pi 2 Model B +image::images/2-model-b.jpg[alt="Raspberry Pi 2 Model B"] +| xref:processors.adoc#bcm2836[BCM2836] (in version 1.2, switched to xref:processors.adoc#bcm2837[BCM2837]) | 1 GB | 40-pin GPIO header +a| +* HDMI +* 4 × USB 2.0 +* standard 15-pin, 1.0 mm pitch, 16 mm width, CSI (camera) port +* standard 15-pin, 1.0 mm pitch, 16 mm width, DSI (display) port +* 3.5 mm AV jack +* 100 Mb/s Ethernet RJ45 +* microSD card slot +* micro-USB power +^.^a| +.Raspberry Pi 3 Model B +image::images/3-model-b.jpg[alt="Raspberry Pi 3 Model B"] +| xref:processors.adoc#bcm2837[BCM2837] | 1 GB | 40-pin GPIO header +a| +* HDMI +* 4 × USB 2.0 +* standard 15-pin, 1.0 mm pitch, 16 mm width, CSI (camera) port +* standard 15-pin, 1.0 mm pitch, 16 mm width, DSI (display) port +* 3.5 mm AV jack +* 100 Mb/s Ethernet RJ45 +* 2.4 Ghz single-band 802.11n Wi-Fi (35 Mb/s) +* Bluetooth 4.1, Bluetooth Low Energy (BLE) +* microSD card slot +* micro-USB power +^.^a| +.Raspberry Pi 3 Model B+ +image::images/3-model-b-plus.jpg[alt="Raspberry Pi 3 Model B+"] +| xref:processors.adoc#bcm2837b0[BCM2837b0] | 1 GB | 40-pin GPIO header +a| +* HDMI +* 4 × USB 2.0 +* standard 15-pin, 1.0 mm pitch, 16 mm width, CSI (camera) port +* standard 15-pin, 1.0 mm pitch, 16 mm width, DSI (display) port +* 3.5 mm AV jack +* 300 Mb/s Ethernet RJ45 with PoE support +* 2.4/5 GHz dual-band 802.11ac Wi-Fi (100 Mb/s) +* Bluetooth 4.2, Bluetooth Low Energy (BLE) +* microSD card slot +* micro-USB power +^.^a| +.Raspberry Pi 3 Model A+ +image::images/3-model-a-plus.jpg[alt="Raspberry Pi 3 Model A+"] +| xref:processors.adoc#bcm2837b0[BCM2837b0] | 512 MB | 40-pin GPIO header +a| +* HDMI +* USB 2.0 +* standard 15-pin, 1.0 mm pitch, 16 mm width, CSI (camera) port +* standard 15-pin, 1.0 mm pitch, 16 mm width, DSI (display) port +* 3.5 mm AV jack +* 2.4/5 Ghz dual-band 802.11ac Wi-Fi (100 Mb/s) +* Bluetooth 4.2, Bluetooth Low Energy (BLE) +* microSD card slot +* micro-USB power +^.^a| +.Raspberry Pi 4 Model B +image::images/4-model-b.jpg[alt="Raspberry Pi 4 Model B"] +| xref:processors.adoc#bcm2711[BCM2711] +a| +1 GB + +2 GB + +4 GB + +8 GB | 40-pin GPIO header +a| +* 2 × micro-HDMI +* 2 × USB 2.0 +* 2 × USB 3.0 +* standard 15-pin, 1.0 mm pitch, 16 mm width, CSI (camera) port +* standard 15-pin, 1.0 mm pitch, 16 mm width, DSI (display) port +* 3.5 mm AV jack +* Gigabit (1 Gb/s) Ethernet RJ45 with PoE+ support +* 2.4/5 GHz dual-band 802.11ac Wi-Fi (120 Mb/s) +* Bluetooth 5, Bluetooth Low Energy (BLE) +* microSD card slot +* USB-C power; 5 V at 3 A (15W) +^.^a| +.Raspberry Pi 5 +image::images/5.jpg[alt="Raspberry Pi 5"] +| xref:processors.adoc#bcm2712[BCM2712] +a| +2 GB + +4 GB + +8 GB + +16 GB | 40-pin GPIO header +a| +* 2 × micro-HDMI +* 2 × USB 2.0 +* 2 × USB 3.0 +* 2 × mini 22-pin, 0.5 mm (fine) pitch, 11.5 mm width, combined CSI (camera)/DSI (display) ports +* single-lane https://datasheets.raspberrypi.com/pcie/pcie-connector-standard.pdf[PCIe FFC connector] +* https://datasheets.raspberrypi.com/debug/debug-connector-specification.pdf[UART connector] +* RTC battery connector +* xref:raspberry-pi.adoc#raspberry-pi-5-fan-connector-pinout[four-pin JST-SH PWM fan connector] +* Gigabit (1 Gb/s) Ethernet RJ45 with PoE+ support +* 2.4/5 GHz dual-band 802.11ac Wi-Fi 5 (300 Mb/s) +* Bluetooth 5, Bluetooth Low Energy (BLE) +* microSD card slot +* USB-C power; 5 V at 5 A (25W); or 5 V at 3 A (15 W) with a 600 mA peripheral limit +|=== + +For more information about the ports on the Raspberry Pi flagship series, see the xref:raspberry-pi.adoc#schematics-and-mechanical-drawings[Schematics and mechanical drawings]. + +[[keyboard-computers]] +=== Keyboard computer (X00) series + +Keyboard series devices use model identifiers of the form ``, where `X` indicates the corresponding flagship single-board computer (SBC) series device. For example, Raspberry Pi 400 is the keyboard version of Raspberry Pi 4. For more detailed information about Raspberry Pi keyboard computers, see xref:keyboard-computers.adoc[Keyboard computers]. + +[cols="6a,2,2,3,5"] +|=== +| Model | SoC | Memory | GPIO | Connectivity + +^.^a| +.Raspberry Pi 400 +image::images/400.jpg[alt="Raspberry Pi 400"] +| xref:processors.adoc#bcm2711[BCM2711] | 4 GB | 40-pin GPIO header +a| +* 2 × micro-HDMI +* USB 2.0 +* 2 × USB 3.0 +* Gigabit (1 Gb/s) Ethernet RJ45 +* 2.4/5 GHz dual-band 802.11ac Wi-Fi (120 Mb/s) +* Bluetooth 5, Bluetooth Low Energy (BLE) +* microSD card slot +* USB-C power; 5 V at 3 A (15W) +^.^a| +.Raspberry Pi 500 +image::images/500.png[alt="Raspberry Pi 500"] +| xref:processors.adoc#bcm2712[BCM2712] | 8 GB | 40-pin GPIO header +a| +* 2 × micro-HDMI +* USB 2.0 +* 2 × USB 3.0 +* Gigabit (1 Gb/s) Ethernet RJ45 +* 2.4/5 GHz dual-band 802.11ac Wi-Fi 5 (300 Mb/s) +* Bluetooth 5, Bluetooth Low Energy (BLE) +* microSD card slot +* USB-C power; 5 V at 5 A (25W); or 5 V at 3 A (15W) with a 600 mA peripheral limit +^.^a| +.Raspberry Pi 500+ +image::images/500plus.png[alt="Raspberry Pi 500+"] +| xref:processors.adoc#bcm2712[BCM2712] | 16 GB | 40-pin GPIO header +a| +* 2 × micro-HDMI +* USB 2.0 +* 2 × USB 3.0 +* Gigabit (1 Gb/s) Ethernet RJ45 +* 2.4/5 GHz dual-band 802.11ac Wi-Fi 5 (300 Mb/s) +* Bluetooth 5, Bluetooth Low Energy (BLE) +* microSD card slot +* Internal M.2 SSD (256 GB) +* USB-C power; 5 V at 5 A (25W) +|=== + +[[zero-series]] +=== Zero series + +Models with the *H* suffix have header pins pre-soldered to the GPIO header. Models that lack the *H* suffix don't come with header pins attached to the GPIO header; the user must solder pins manually or attach a third-party pin kit. + +All Zero models have the following connectivity: + +* A microSD card slot +* A mini HDMI port +* 2 × micro-USB ports (one for input power, one for external devices) + +Since version 1.3 of the original Zero, all Zero models also include a mini 22-pin, 0.5 mm (fine) pitch, 11.5 mm width, CSI (camera) port. + +[cols="3a,1,1,1,2"] +|=== +| Model | SoC | Memory | GPIO | Wireless Connectivity + +^.^a| +.Raspberry Pi Zero +image::images/zero.jpg[alt="Raspberry Pi Zero"] +| xref:processors.adoc#bcm2835[BCM2835] | 512 MB | 40-pin GPIO header (unpopulated) ^| none +^.^a| +.Raspberry Pi Zero W +image::images/zero-w.jpg[alt="Raspberry Pi Zero W"] +| xref:processors.adoc#bcm2835[BCM2835] | 512 MB | 40-pin GPIO header (unpopulated) +a| +* 2.4 GHz single-band 802.11n Wi-Fi (35 Mb/s) +* Bluetooth 4.0, Bluetooth Low Energy (BLE) +^.^a| +.Raspberry Pi Zero WH +image::images/zero-wh.jpg[alt="Raspberry Pi Zero WH"] +| xref:processors.adoc#bcm2835[BCM2835] | 512 MB | 40-pin GPIO header +a| +* 2.4 GHz single-band 802.11n Wi-Fi (35 Mb/s) +* Bluetooth 4.0, Bluetooth Low Energy (BLE) +^.^a| +.Raspberry Pi Zero 2 W +image::images/zero-2-w.jpg[alt="Raspberry Pi Zero 2 W"] +| xref:processors.adoc#rp3a0[RP3A0] | 512 MB | 40-pin GPIO header (unpopulated) +a| +* 2.4 GHz single-band 802.11n Wi-Fi (35 Mb/s) +* Bluetooth 4.2, Bluetooth Low Energy (BLE) +^.^a| +.Raspberry Pi Zero 2 WH +image::images/zero-2-wh.png[alt="Raspberry Pi Zero 2 WH"] +| xref:processors.adoc#rp3a0[RP3A0] | 512 MB | 40-pin GPIO header +a| +* 2.4 GHz single-band 802.11n Wi-Fi (35 Mb/s) +* Bluetooth 4.2, Bluetooth Low Energy (BLE) +|=== + +[[compute-module-series]] +=== Compute Module series + +For more detailed information about the Raspberry Pi Compute Module hardware, see xref:compute-module.adoc[Compute Module hardware]. + +[cols="3a,1,1,1,1,2"] +|=== +| Model | SoC | Memory | Storage | Form factor | Wireless Connectivity + +^.^a| +.Raspberry Pi Compute Module 1 +image::images/compute-module-1.jpg[alt="Raspberry Pi Compute Module 1"] +| xref:processors.adoc#bcm2835[BCM2835] | 512 MB +| 4 GB | DDR2 SO-DIMM ^| none +^.^a| +.Raspberry Pi Compute Module 3 +image::images/compute-module-3.jpg[alt="Raspberry Pi Compute Module 3"] +| xref:processors.adoc#bcm2837[BCM2837] | 1 GB +a| +0 GB (Lite) + +4 GB | DDR2 SO-DIMM ^| none +^.^a| +.Raspberry Pi Compute Module 3+ +image::images/compute-module-3-plus.jpg[alt="Raspberry Pi Compute Module 3+"] +| xref:processors.adoc#bcm2837b0[BCM2837b0] | 1 GB +a| +0 GB (Lite) + +8 GB + +16 GB + +32 GB | DDR2 SO-DIMM ^| none +^.^a| +.Raspberry Pi Compute Module 4S +image::images/compute-module-4s.jpg[alt="Raspberry Pi Compute Module 4S"] +| xref:processors.adoc#bcm2711[BCM2711] +a| +1 GB + +2 GB + +4 GB + +8 GB +a| +0 GB (Lite) + +8 GB + +16 GB + +32 GB | DDR2 SO-DIMM ^| none +^.^a| +.Raspberry Pi Compute Module 4 +image::images/compute-module-4.jpg[alt="Raspberry Pi Compute Module 4"] +| xref:processors.adoc#bcm2711[BCM2711] +a| +1 GB + +2 GB + +4 GB + +8 GB +a| +0 GB (Lite) + +8 GB + +16 GB + +32 GB +| dual 100-pin high density connectors +a| optional: + +* 2.4/5 GHz dual-band 802.11ac Wi-Fi 5 (300 Mb/s) +* Bluetooth 5, Bluetooth Low Energy (BLE) + +^.^a| +.Raspberry Pi Compute Module 5 +image::images/compute-module-5.png[alt="Raspberry Pi Compute Module 5"] +| xref:processors.adoc#bcm2712[BCM2712] +a| +2 GB + +4 GB + +8 GB + +16 GB +a| +0 GB (Lite) + +16 GB + +32 GB + +64 GB +| dual 100-pin high density connectors +a| optional: + +* 2.4/5 GHz dual-band 802.11ac Wi-Fi 5 (300 Mb/s) +* Bluetooth 5, Bluetooth Low Energy (BLE) +|=== + +NOTE: Compute Modules that use the physical DDR2 SO-DIMM form factor are *not* compatible with DDR2 SO-DIMM electrical specifications. + +[[pico-series]] +=== Pico microcontrollers + +Models with the *H* suffix have header pins pre-soldered to the GPIO header. Models that lack the *H* suffix do not come with header pins attached to the GPIO header; the user must solder pins manually or attach a third-party pin kit. + +[cols="3a,1,1,1,1,2"] +|=== +| Model | SoC | Memory | Storage | GPIO | Wireless Connectivity + +| +.Raspberry Pi Pico +image::images/pico.png[alt="Raspberry Pi Pico"] +| xref:../microcontrollers/silicon.adoc#rp2040[RP2040] | 264 KB | 2 MB | two 20-pin GPIO headers (unpopulated) ^| none +| +.Raspberry Pi Pico H +image::images/pico-h.png[alt="Raspberry Pi Pico H"] +| xref:../microcontrollers/silicon.adoc#rp2040[RP2040] | 264 KB | 2 MB | two 20-pin GPIO headers ^| none +| +.Raspberry Pi Pico W +image::images/pico-w.png[alt="Raspberry Pi Pico W"] +| xref:../microcontrollers/silicon.adoc#rp2040[RP2040] | 264 KB | 2 MB | two 20-pin GPIO headers (unpopulated) +a| +* 2.4 GHz single-band 802.11n Wi-Fi (10 Mb/s) +* Bluetooth 5.2, Bluetooth Low Energy (BLE) +| +.Raspberry Pi Pico WH +image::images/pico-wh.png[alt="Raspberry Pi Pico WH"] +| xref:../microcontrollers/silicon.adoc#rp2040[RP2040] | 264 KB | 2 MB | two 20-pin GPIO headers +a| +* 2.4 GHz single-band 802.11n Wi-Fi (10 Mb/s) +* Bluetooth 5.2, Bluetooth Low Energy (BLE) +| +.Raspberry Pi Pico 2 +image::images/pico-2.png[alt="Raspberry Pi Pico 2"] +| xref:../microcontrollers/silicon.adoc#rp2350[RP2350] | 520 KB | 4 MB | two 20-pin GPIO headers (unpopulated) ^| none +| +.Raspberry Pi Pico 2 W +image::images/pico-2-w.png[alt="Raspberry Pi Pico 2 W"] +| xref:../microcontrollers/silicon.adoc#rp2350[RP2350] | 520 KB | 4 MB | two 20-pin GPIO headers (unpopulated) a| +* 2.4 GHz single-band 802.11n Wi-Fi (10 Mb/s) +* Bluetooth 5.2, Bluetooth Low Energy (BLE) + +|=== + +For more information about Raspberry Pi Pico models, see xref:../microcontrollers/pico-series.adoc[the Pico documentation]. diff --git a/documentation/asciidoc/computers/raspberry-pi/otp-bits.adoc b/documentation/asciidoc/computers/raspberry-pi/otp-bits.adoc index 88184bfc1..c9efabb22 100644 --- a/documentation/asciidoc/computers/raspberry-pi/otp-bits.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/otp-bits.adoc @@ -7,20 +7,27 @@ OTP memory size: * non-BCM2712 devices: 66 32-bit values * BCM2712 devices: 192 32-bit values -The `vcgencmd` to display the contents of the OTP is: +To display the contents of the OTP, run the following command: +[source,console] ---- -vcgencmd otp_dump +$ vcgencmd otp_dump ---- === OTP registers on non-BCM2712 devices This list contains the publicly available information on the registers. If a register or bit is not defined here, then it is not public. -17 -- bootmode register +`16`:: OTP control register - BCM2711 ++ +* Bit 26: disables VC JTAG +* Bit 27: disables VC JTAG +`17`:: bootmode register ++ * Bit 1: sets the oscillator frequency to 19.2MHz * Bit 3: enables pull ups on the SDIO pins +* Bit 15: disables ROM RSA key 0 - (secure boot enabled if set) (BCM2711) * Bit 19: enables GPIO bootmode * Bit 20: sets the bank to check for GPIO bootmode * Bit 21: enables booting from SD card @@ -30,13 +37,13 @@ This list contains the publicly available information on the registers. If a reg NOTE: On BCM2711 the bootmode is defined by the xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[bootloader EEPROM configuration] instead of OTP. -18 -- copy of bootmode register + -28 -- serial number + -29 -- ~(serial number) + -30 -- xref:raspberry-pi.adoc#raspberry-pi-revision-codes[revision code] ^1^ + -33 -- board revision extended - the meaning depends on the board model. + +`18`:: copy of bootmode register +`28`:: serial number +`29`:: ~(serial number) +`30`:: xref:raspberry-pi.adoc#raspberry-pi-revision-codes[revision code] ^1^ +`33`:: board revision extended - the meaning depends on the board model. This is available via device-tree in `/proc/device-tree/chosen/rpi-boardrev-ext` and for testing purposes this OTP value can be temporarily overridden by setting `board_rev_ext` in `config.txt`. - ++ * Compute Module 4 ** Bit 30: Whether the Compute Module has a Wi-Fi module fitted *** 0 - Wi-Fi @@ -47,15 +54,16 @@ This is available via device-tree in `/proc/device-tree/chosen/rpi-boardrev-ext` * Raspberry Pi 400 ** Bits 0-7: The default keyboard country code used by https://github.com/raspberrypi-ui/piwiz[piwiz] -36-43 -- xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer OTP values] + -45 -- MPG2 decode key + -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 -- 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) - +`35` :: High 32 bits of 64-bit serial number +`36-43`:: xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer OTP values] +`45`:: MPG2 decode key +`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`:: 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) ++ * Bits 0-6: GPIO for ETH_CLK output pin * Bit 7: enables ETH_CLK output * Bits 8-14: GPIO for LAN_RUN output pin @@ -71,51 +79,52 @@ This is available via device-tree in `/proc/device-tree/chosen/rpi-boardrev-ext` This list contains the publicly available information on the registers. If a register or bit is not defined here, then it is not public. -22 -- bootmode register + - +`22`:: bootmode register ++ * Bit 1: Boot from SD card * Bits 2-4: Booting from SPI EEPROM (and which GPIOs) * Bit 10: Disable booting from SD card * Bit 11: Disable booting from SPI * Bit 12: Disable booting from USB -23 -- copy of bootmode register + -29 -- advanced boot mode + - +`23`:: copy of bootmode register +`29`:: advanced boot mode ++ * Bits 0-7: GPIO for SD card detect * Bits 8-15: GPIO to use for RPIBOOT -31 -- lower 32 bits of serial number + -32 -- xref:raspberry-pi.adoc#raspberry-pi-revision-codes[board revision] + -33 -- board attributes - the meaning depends on the board model. + +`31`:: lower 32 bits of serial number +`32`:: xref:raspberry-pi.adoc#raspberry-pi-revision-codes[board revision] +`33`:: board attributes - the meaning depends on the board model. This is available via device-tree in `/proc/device-tree/chosen/rpi-boardrev-ext` -35 -- upper 32 bits of serial number + +`35`:: upper 32 bits of serial number The full 64 bit serial number is available in `/proc/device-tree/serial-number` -50-51 -- Ethernet MAC address + +`50-51`:: Ethernet MAC address This is passed to the operating system in the Device Tree, e.g. `/proc/device-tree/axi/pcie@120000/rp1/ethernet@100000/local-mac-address` -52-53 -- Wi-Fi MAC address + +`52-53`:: Wi-Fi MAC address This is passed to the operating system in the Device Tree, e.g. `/proc/device-tree/axi/mmc@1100000/wifi@1/local-mac-address` -54-55 -- Bluetooth MAC address + +`54-55`:: Bluetooth MAC address This is passed to the operating system in the Device Tree, e.g. `/proc/device-tree/soc/serial@7d50c000/bluetooth/local-bd-address` -77-84 -- xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer OTP values] + -86 -- board country - The default keyboard country code used by https://github.com/raspberrypi-ui/piwiz[piwiz] + +`77-84`:: xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer OTP values] + +`86`:: board country - The default keyboard country code used by https://github.com/raspberrypi-ui/piwiz[piwiz] If set, this is available via Device Tree in `/proc/device-tree/chosen/rpi-country-code` -87-88 -- xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer Ethernet MAC address] + +`87-88`:: xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer Ethernet MAC address] Overrides OTP rows 50-51 if set -89-90 -- xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer Wi-Fi MAC address] + +`89-90`:: xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer Wi-Fi MAC address] Overrides OTP rows 52-53 if set -89-90 -- xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer Bluetooth MAC address] + +`89-90`:: xref:raspberry-pi.adoc#industrial-use-of-the-raspberry-pi[customer Bluetooth MAC address] Overrides OTP rows 54-55 if set -109-114 -- Factory device UUID + +`109-114`:: Factory device UUID Currently a 16-digit numerical id which should match the bar code on the device. Padded with zero characters and c40 encoded. This is available via device-tree in `/proc/device-tree/chosen/rpi-duid`. diff --git a/documentation/asciidoc/computers/raspberry-pi/pcie.adoc b/documentation/asciidoc/computers/raspberry-pi/pcie.adoc index c3608ee65..6e5d6d1f9 100644 --- a/documentation/asciidoc/computers/raspberry-pi/pcie.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/pcie.adoc @@ -9,13 +9,13 @@ To connect a PCIe https://datasheets.raspberrypi.com/hat/hat-plus-specification. For more information about the PCIe FPC connector pinout and other details needed to create third-party devices, accessories, and HATs, see the https://datasheets.raspberrypi.com/pcie/pcie-connector-standard.pdf[Raspberry Pi Connector for PCIe] standards document. It should be read alongside the https://datasheets.raspberrypi.com/hat/hat-plus-specification.pdf[Raspberry Pi HAT+ Specification]. -NOTE: Enumeration of PCIe devices behind a switch is https://github.com/raspberrypi/firmware/issues/1833[not currently supported]. +NOTE: Only certain devices https://github.com/raspberrypi/firmware/issues/1833[support] enumeration of PCIe devices behind a switch. === Enable PCIe By default, the PCIe connector is not enabled unless connected to a HAT+ device. To enable the connector, add the following line to `/boot/firmware/config.txt`: -[source,perl] +[source,ini] ---- dtparam=pciex1 ---- @@ -35,14 +35,14 @@ $ sudo rpi-eeprom-config --edit Replace the `BOOT_ORDER` line with the following line: -[source,perl] +[source,ini] ---- BOOT_ORDER=0xf416 ---- To boot from a non-HAT+ device, also add the following line: -[source,perl] +[source,ini] ---- PCIE_PROBE=1 ---- @@ -53,11 +53,36 @@ After saving your changes, reboot your Raspberry Pi with `sudo reboot` to update WARNING: The Raspberry Pi 5 is not certified for Gen 3.0 speeds. PCIe Gen 3.0 connections may be unstable. -The connection is certified for Gen 2.0 speeds (5 GT/sec), but you can force Gen 3.0 (10 GT/sec) speeds. To enable PCIe Gen 3.0 speeds, add the following line to `/boot/firmware/config.txt`: +By default, Raspberry Pi 5 uses Gen 2.0 speeds (5 GT/s). Use one of the following approaches to force Gen 3.0 (8 GT/s) speeds: -[source,perl] +[tabs] +====== +`config.txt`:: ++ +To enable PCIe Gen 3.0 speeds, add the following line to `/boot/firmware/config.txt`: ++ +[source,ini] ---- dtparam=pciex1_gen=3 ---- - ++ Reboot your Raspberry Pi with `sudo reboot` for these settings to take effect. + +`raspi-config`:: ++ +Run the following command to open the Raspberry Pi Configuration CLI: ++ +[source,console] +---- +$ sudo raspi-config +---- ++ +Complete the following steps to enable PCIe Gen 3.0 speeds: ++ +. Select `Advanced Options`. +. Select `PCIe Speed`. +. Choose `Yes` to enable PCIe Gen 3 mode. +. Select `Finish` to exit. +. Reboot your Raspberry Pi with `sudo reboot` for your changes to take effect. + +====== diff --git a/documentation/asciidoc/computers/raspberry-pi/power-supplies.adoc b/documentation/asciidoc/computers/raspberry-pi/power-supplies.adoc index 482d48c9b..68a2d011f 100644 --- a/documentation/asciidoc/computers/raspberry-pi/power-supplies.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/power-supplies.adoc @@ -2,6 +2,8 @@ The power supply requirements differ by Raspberry Pi model. All models require a 5.1V supply, but the current required generally increases according to model. All models up to the Raspberry Pi 3 require a micro USB power connector, while Raspberry Pi 4, Raspberry Pi 400, and Raspberry Pi 5 use a USB-C connector. +[[powering-raspberry-pi-5]] + The current consumed by each Raspberry Pi depends on the peripherals connected. === Recommended power supplies @@ -12,13 +14,17 @@ NOTE: No Raspberry Pi models support USB-PPS. NOTE: If you use a third-party USB-PD multi-port power supply, plugging an additional device into the supply when your Raspberry Pi is connected causes a renegotiation between the supply and the Raspberry Pi. If the Raspberry Pi is powered, this happens seamlessly. If the Raspberry Pi is powered down, this renegotiation may cause the Raspberry Pi to boot. -== Power over Ethernet (PoE) connector - -The Ethernet jack on Raspberry Pi 5 is PoE+ capable, supporting the IEEE 802.3at-2009 PoE standard. The Raspberry Pi 5 has a 4-pin Power-over-Ethernet (PoE) header block, located between the Ethernet jack and the two MIPI connectors. +=== Power over Ethernet (PoE) connector .Raspberry Pi 5 PoE header image::images/poe.jpg[alt="The PoE connector,width="70%"] +The Ethernet jack on Raspberry Pi 5 is PoE+ capable, supporting the IEEE 802.3at-2009 PoE standard. + +The Ethernet jack on Raspberry Pi 4B and Pi 3B+ is PoE capable, supporting the IEEE 802.3af-2003 PoE standard. + +All Raspberry Pi models with a PoE-capable Ethernet jack require a HAT to draw power through the Ethernet port. For models that support PoE, we recommend the https://www.raspberrypi.com/products/poe-hat/[PoE HAT]. For models that support PoE+, we recommend the https://www.raspberrypi.com/products/poe-plus-hat/[PoE+ HAT]. + === Typical power requirements |=== @@ -74,22 +80,32 @@ image::images/poe.jpg[alt="The PoE connector,width="70%"] | 1.6A (600mA if using a 3A power supply) | 800mA -| Raspberry Pi 400 +| Pi 400 | 3.0A | 1.2A | 800mA -| Raspberry Pi Zero +| Pi 500 +| 5.0A +| 1.6A (600mA if using a 3A power supply) +| 800mA + +| Pi 500+ +| 5.0A +| 1.6A +| 800mA (with LEDs off and SSD inactive) + +| Zero | 1.2A | Limited by PSU, board, and connector ratings only | 100mA -| Raspberry Pi Zero W +| Zero W | 1.2A | Limited by PSU, board, and connector ratings only. | 150mA -| Raspberry Pi Zero 2 W +| Zero 2 W | 2A | Limited by PSU, board, and connector ratings only. | 350mA @@ -101,39 +117,39 @@ Most Raspberry Pis provide enough current to USB peripherals to power most USB d The power requirements of the Raspberry Pi increase as you make use of the various interfaces on the Raspberry Pi. Combined, the GPIO pins can draw 50mA safely; each pin can individually draw up to 16mA. The HDMI port uses 50mA. The Camera Module requires 250mA. USB 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, use an externally-powered USB hub. -You can check the status of power output to the USB ports using `vcgencmd`. +Run the following command to check the status of power output to the USB ports: -[source,bash] +[source,console] ---- -vcgencmd get_config usb_max_current_enable +$ vcgencmd get_config usb_max_current_enable ---- 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 +| | | Raspberry Pi 1B+ | Raspberry Pi 2B | Raspberry Pi 3B | Raspberry Pi Zero | Raspberry Pi 4B | Boot | Max | 0.26 | 0.40 | 0.75 | 0.20 | 0.85 -| | Avg | 0.22 | 0.22 | 0.35 | 0.15 | 0.7 +| | Avg | 0.22 | 0.22 | 0.35 | 0.15 | 0.7 | Idle | Avg | 0.20 | 0.22 | 0.30 | 0.10 | 0.6 -| Video playback (H.264) | Max | 0.30 | 0.36 |0.55 |0.23 | 0.85 -| | Avg | 0.22 | 0.28 | 0.33 | 0.16 | 0.78 -| Stress | Max | 0.35 | 0.82 | 1.34 | 0.35 | 1.25 -| | Avg | 0.32 | 0.75 | 0.85 | 0.23 | 1.2 -| Halt current | | | | 0.10 | 0.055 | 0.023 +| Video playback (H.264) | Max | 0.30 | 0.36 |0.55 |0.23 | 0.85 +| | Avg | 0.22 | 0.28 | 0.33 | 0.16 | 0.78 +| Stress | Max | 0.35 | 0.82 | 1.34 | 0.35 | 1.25 +| | Avg | 0.32 | 0.75 | 0.85 | 0.23 | 1.2 +| Halt current | | | | 0.10 | 0.055 | 0.023 |=== 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 By default, the Raspberry Pi 5 consumes around 1W to 1.4W of power when turned off. This can be decreased by manually editing the EEPROM configuration with `sudo rpi-eeprom-config -e`. Change the settings to the following: -[source] +[source,ini] ---- BOOT_UART=1 POWER_OFF_ON_HALT=1 @@ -150,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. @@ -169,12 +185,12 @@ reset_event:: The PMIC reset reason e.g. watchdog, over- or under-voltage, over- The PMIC has built-in ADCs that, among other things, can measure the supply voltage `EXT5V_V`. Use the following command to view ADC measurements: -[source,bash] +[source,console] ---- -vcgencmd pmic_read_adc +$ vcgencmd pmic_read_adc ---- -NOTE: You can't see USB current or anything else connected directly to 5V, because this bypasses the PMIC. You should not expect this to add up to the wattage of the source power supply. However, it can be useful to monitor things like the core voltage. +You can't see USB current or anything else connected directly to 5V, because this bypasses the PMIC. You should not expect this to add up to the wattage of the source power supply. However, it can be useful to monitor things like the core voltage. === Back-powering diff --git a/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-compliance.adoc b/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-compliance.adoc index 748c7ee47..99aea7202 100644 --- a/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-compliance.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-compliance.adoc @@ -16,7 +16,7 @@ Find out more about the https://www.raspberrypi.com/for-industry/integrator-prog === Powered by Raspberry Pi -The Powered by Raspberry Pi progamme provides a process for companies wanting to use a form of the Raspberry Pi logo, and covers products with Raspberry Pi computers or silicon inside, and services provided by a Raspberry Pi. If you wish to start the process to apply you can do so https://www.raspberrypi.com/trademark-rules/powered-raspberry-pi/[online]. +The Powered by Raspberry Pi program provides a process for companies wanting to use a form of the Raspberry Pi logo, and covers products with Raspberry Pi computers or silicon inside, and services provided by a Raspberry Pi. If you wish to start the process to apply you can do so https://www.raspberrypi.com/trademark-rules/powered-raspberry-pi/[online]. === Approved Design Partners diff --git a/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-industrial.adoc b/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-industrial.adoc index 481d21601..41e63c407 100644 --- a/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-industrial.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-industrial.adoc @@ -4,18 +4,18 @@ 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! This whitepaper assumes that the Raspberry Pi is running the Raspberry Pi operating system (OS), and is fully up-to-date with the latest firmware and kernels. **** -There are a number of OTP values that can be used. To see a list of all the xref:raspberry-pi.adoc#otp-register-and-bit-definitions[OTP values], you can use: +There are a number of OTP values that can be used. To see a list of all the xref:raspberry-pi.adoc#otp-register-and-bit-definitions[OTP values], run the following command: -[,bash] +[source,console] ---- -vcgencmd otp_dump +$ vcgencmd otp_dump ---- Some interesting lines from this dump are: @@ -32,9 +32,9 @@ Some of these rows can be programmed with `vcmailbox`. This is a Linux driver in The vcmailbox application can be used directly from the command line on Raspberry Pi OS. An example usage would be: -[,bash] +[source,console] ---- -vcmailbox 0x00010004 8 8 0 0 +$ vcmailbox 0x00010004 8 8 0 0 ---- ...which will return something like: @@ -51,9 +51,9 @@ WARNING: The OTP values are one-time programmable. Once a bit has been changed f To set the customer OTP values you will need to use the `SET_CUSTOMER_OTP` (0x38021) tag as follows: -[,bash] +[source,console] ---- -vcmailbox 0x00038021 [8 + number * 4] [8 + number * 4] [start_num] [number] [value] [value] [value] ... +$ vcmailbox 0x00038021 [8 + number * 4] [8 + number * 4] [start_num] [number] [value] [value] [value] ... ---- * `start_num` = the first row to program from 0-7 @@ -62,18 +62,18 @@ vcmailbox 0x00038021 [8 + number * 4] [8 + number * 4] [start_num] [number] [val So, to program OTP customer rows 4, 5, and 6 to 0x11111111, 0x22222222, 0x33333333 respectively, you would use: -[,bash] +[source,console] ---- -vcmailbox 0x00038021 20 20 4 3 0x11111111 0x22222222 0x33333333 +$ vcmailbox 0x00038021 20 20 4 3 0x11111111 0x22222222 0x33333333 ---- This will then program rows 40, 41, and 42. To read the values back, you can use: -[,bash] +[source,console] ---- -vcmailbox 0x00030021 20 20 4 3 0 0 0 +$ vcmailbox 0x00030021 20 20 4 3 0 0 0 ---- This should display: @@ -90,9 +90,9 @@ It is possible to lock the OTP changes to avoid them being edited again. This can be done using a special argument with the OTP write mailbox: -[,bash] +[source,console] ---- -vcmailbox 0x00038021 8 8 0xffffffff 0xaffe0000 +$ vcmailbox 0x00038021 8 8 0xffffffff 0xaffe0000 ---- Once locked, the customer OTP values can no longer be altered. Note that this locking operation is irreversible. @@ -101,9 +101,9 @@ Once locked, the customer OTP values can no longer be altered. Note that this lo The customer region can be marked as read only with the following command. -[,bash] +[source,console] ---- -vcmailbox 0x00030086 4 4 0 +$ vcmailbox 0x00030086 4 4 0 ---- OTP is only locked until the device is reset, so OTP locks need to be reapplied on every boot. @@ -112,9 +112,9 @@ OTP is only locked until the device is reset, so OTP locks need to be reapplied It is possible to prevent the customer OTP bits from being read at all. This can be done using a special argument with the OTP write mailbox: -[,bash] +[source,console] ---- -vcmailbox 0x00038021 8 8 0xffffffff 0xaffebabe +$ vcmailbox 0x00038021 8 8 0xffffffff 0xaffebabe ---- This operation is unlikely to be useful for the vast majority of users, and is irreversible. @@ -123,47 +123,44 @@ This operation is unlikely to be useful for the vast majority of users, and is i On BCM2712 devices the Ethernet, Wi-Fi and Bluetooth MAC addresses are set in OTP memory. These values can change with customer values. -Get customer mac address `vcmailbox 0x00030082/3/4 6 6 0 0`, where 2 is Ethernet, 3 is Wi-Fi and 4 is Bluetooth. +Get customer mac address `vcmailbox 0x00030082/3/4 6 6 0 0`, where 2 is Ethernet, 3 is Wi-Fi and 4 is Bluetooth: -Example... -[,bash] +[source,console] ---- -vcmailbox 0x00030083 6 6 0 0 +$ vcmailbox 0x00030083 6 6 0 0 0x00000020 0x80000000 0x00030083 0x00000006 0x80000006 0xddccbbaa 0x0000ffee 0x00000000 ---- -In order to set a customer MAC address, it has to be sent as two 32 words with the bytes in the right order. You can run a command to check it's formatted properly. +In order to set a customer MAC address, it has to be sent as two 32 words with the bytes in the right order. You can run a command to check it's formatted properly: -Example... -[,bash] +[source,console] ---- -vcmailbox 0x00030085 6 6 0x44332211 0x6655 +$ vcmailbox 0x00030085 6 6 0x44332211 0x6655 ---- -Check the log to see if the MAC address is what's expected. -[,bash] +Check the log to see if the MAC address matches your expectations: + +[source,console] ---- -sudo vclog -m +$ sudo vclog -m 1057826.701: read mac address 11:22:33:44:55:66 ---- A multicast address is not considered valid. The least significant bit in the most significant octet of a MAC address is the multicast bit, so make sure this is not set. -You can then set the customer mac with the command `vcmailbox 0x00038082/3/4 6 6 ` +You can then set the customer MAC address with the command `vcmailbox 0x00038082/3/4 6 6 `: -Example... -[,bash] +[source,console] ---- -vcmailbox 0x00038082 6 6 0x44332211 0x6655 +$ vcmailbox 0x00038082 6 6 0x44332211 0x6655 ---- -If a customer MAC address is set to ff:ff:ff:ff:ff:ff, then it’s ignored. +If a customer MAC address is set to `ff:ff:ff:ff:ff:ff`, then it's ignored. === Device-specific private key -NOTE: This is not yet implemented for BCM2712 devices - -Eight rows of OTP (256 bits) are available for use as a device-specific private key. This is intended to support file-system encryption. +Devices that use the Broadcom BCM2712 processor have 16 rows of OTP data (512 bits) to support filesystem encryption. +Devices that do not use BCM2712 have 8 rows of OTP (256 bits) available for use as a device-specific private key. 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. @@ -174,46 +171,64 @@ secure-boot / file-system encryption is not required, then the device private ke See https://gitlab.com/cryptsetup/cryptsetup[Cryptsetup] for more information about open-source disk encryption. -==== Key programming script `rpi-otp-private-key` -The https://github.com/raspberrypi/usbboot/blob/master/tools/rpi-otp-private-key[`rpi-otp-private-key`] script wraps the device private key `vcmailbox` APIs in order to make it easier to read/write a key in the same format as OpenSSL. +==== Program a key into OTP with `rpi-otp-private-key` + +NOTE: The `rpi-otp-private-key` script only works on devices that use the Broadcom xref:processors.adoc#bcm2711[BCM2711] or xref:processors.adoc#bcm2712[BCM2712] processors. + +The https://github.com/raspberrypi/rpi-eeprom/blob/master/tools/rpi-otp-private-key[`rpi-otp-private-key`] script wraps the device private key `vcmailbox` APIs to make it easier to read and write a key in the OpenSSL format. -Read the key as a 64-byte hex number: -[,bash] +NOTE: The https://github.com/raspberrypi/usbboot[`usbboot`] repository contains all the tools you need, including https://github.com/raspberrypi/rpi-eeprom[`rpi-eeprom`] as a Git submodule. + +Read the 32-byte key as a 64-character hex number: + +[source,console] ---- -rpi-otp-private-key +$ cd usbboot/tools +$ rpi-otp-private-key ---- Example output: + ---- f8dbc7b0a4fcfb1d706e298ac9d0485c2226ce8df7f7596ac77337bd09fbe160 ---- -Writes a 64-byte randomly generated number to the device private key. + -WARNING: This operation cannot be undone. -[,bash] +Writes a 32-byte randomly generated number to the device private key. + +WARNING: This operation cannot be undone. + +[source,console] ---- -# rpi-otp-private-key -w $(openssl rand -hex 32) +$ rpi-otp-private-key -w $(openssl rand -hex 32) ---- -==== Mailbox API for reading/writing the key. +NOTE: To specify the number of OTP rows to use, pass `-l `. To specify a start location in the key store, pass `-o `. + +==== Mailbox API for reading/writing the key + Read all of the rows. -[,bash] + +[source,console] ---- -vcmailbox 0x00030081 40 40 0 8 0 0 0 0 0 0 0 0 +$ vcmailbox 0x00030081 40 40 0 8 0 0 0 0 0 0 0 0 ---- Example output: + ---- 0x00000040 0x80000000 0x00030081 0x00000028 0x80000028 0x00000000 0x00000008 0xf8dbc7b0 0xa4fcfb1d 0x706e298a 0xc9d0485c 0x2226ce8d 0xf7f7596a 0xc77337bd 0x09fbe160 0x00000000 ---- Write all of the row (replace the trailing eight zeros with the key data): -[,bash] + +[source,console] ---- -vcmailbox 0x00038081 40 40 0 8 0 0 0 0 0 0 0 0 +$ vcmailbox 0x00038081 40 40 0 8 0 0 0 0 0 0 0 0 ---- Write the key shown in the previous example: + +[source,console] ---- -vcmailbox 0x38081 40 40 0 8 0xf8dbc7b0 0xa4fcfb1d 0x706e298a 0xc9d0485c 0x2226ce8d 0xf7f7596a 0xc77337bd 0x09fbe160 +$ vcmailbox 0x38081 40 40 0 8 0xf8dbc7b0 0xa4fcfb1d 0x706e298a 0xc9d0485c 0x2226ce8d 0xf7f7596a 0xc77337bd 0x09fbe160 ---- diff --git a/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-schematics.adoc b/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-schematics.adoc index 4831a2c57..6af0d0dd3 100644 --- a/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-schematics.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/raspberry-pi-schematics.adoc @@ -20,6 +20,12 @@ Schematics for the various Raspberry Pi board versions: * https://datasheets.raspberrypi.com/rpi3/raspberry-pi-3-b-plus-mechanical-drawing.dxf[Mechanical drawings, DXF] * https://datasheets.raspberrypi.com/case/raspberry-pi-3-b-plus-case-mechanical-drawing.pdf[Case drawings, PDF] +=== Raspberry Pi 3 Model A+ + +* https://datasheets.raspberrypi.com/rpi3/raspberry-pi-3-a-plus-reduced-schematics.pdf[Schematics, revision 1.0] +* https://datasheets.raspberrypi.com/rpi3/raspberry-pi-3-a-plus-mechanical-drawing.pdf[Mechanical drawings, PDF] +* https://datasheets.raspberrypi.com/case/raspberry-pi-3-a-plus-case-mechanical-drawing.pdf[Case drawings, PDF] + === Raspberry Pi 3 Model B * https://datasheets.raspberrypi.com/rpi3/raspberry-pi-3-b-reduced-schematics.pdf[Schematics, revision 1.2] @@ -33,33 +39,14 @@ Schematics for the various Raspberry Pi board versions: === Raspberry Pi 1 Model B+ * https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-reduced-schematics.pdf[Schematics, revision 1.2] -* https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-mecahnical-drawing.pdf[Mechanical drawings, PDF] -* https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-mecahnical-drawing.dxf[Mechanical drawings, DXF] - -=== Raspberry Pi 3 Model A+ - -* https://datasheets.raspberrypi.com/rpi3/raspberry-pi-3-a-plus-reduced-schematics.pdf[Schematics, revision 1.0] -* https://datasheets.raspberrypi.com/rpi3/raspberry-pi-3-a-plus-mechanical-drawing.pdf[Mechanical drawings, PDF] -* https://datasheets.raspberrypi.com/case/raspberry-pi-3-a-plus-case-mechanical-drawing.pdf[Case drawings, PDF] - -NOTE: Mechanical drawings for the Raspberry Pi 3 Model A+ are also applicable to the Raspberry Pi 1 Model A+. +* https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-mechanical-drawing.pdf[Mechanical drawings, PDF] +* https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-mechanical-drawing.dxf[Mechanical drawings, DXF] === Raspberry Pi 1 Model A+ * https://datasheets.raspberrypi.com/rpi/raspberry-pi-a-plus-reduced-schematics.pdf[Schematics, revision 1.1] -=== Raspberry Pi Zero - -* https://datasheets.raspberrypi.com/rpizero/raspberry-pi-zero-reduced-schematics.pdf[Schematics, revision 1.3] -* https://datasheets.raspberrypi.com/rpizero/raspberry-pi-zero-mechanical-drawing.pdf[Mechanical drawings, PDF] -* https://datasheets.raspberrypi.com/case/raspberry-pi-zero-case-mechanical-drawing.pdf[Case drawings, PDF - blank lid] -* https://datasheets.raspberrypi.com/case/raspberry-pi-zero-case-with-gpio-mechanical-drawing.pdf[Case drawings, PDF - GPIO lid] -* https://datasheets.raspberrypi.com/case/raspberry-pi-zero-case-with-camera-mechanical-drawing.pdf[Case Drawings, PDF - camera lid] - -=== Raspberry Pi Zero W - -* https://datasheets.raspberrypi.com/rpizero/raspberry-pi-zero-w-reduced-schematics.pdf[Schematics, revision 1.1] -* https://datasheets.raspberrypi.com/rpizero/raspberry-pi-zero-w-mechanical-drawing.pdf[Mechanical drawings, PDF] +NOTE: Mechanical drawings for the Raspberry Pi 3 Model A+ are also applicable to the Raspberry Pi 1 Model A+. === Raspberry Pi Zero 2 W @@ -69,7 +56,7 @@ NOTE: Mechanical drawings for the Raspberry Pi 3 Model A+ are also applicable to ==== Test pad locations -The Raspberry Pi Zero 2 W has a number of test pad locations used during production of the board. +The Raspberry Pi Zero 2 W has a number of test pad locations used during production of the board. image::images/zero2-pad-diagram.png[width="70%"] @@ -101,3 +88,17 @@ image::images/zero2-pad-diagram.png[width="70%"] | WL_ON | Wireless LAN power status | 27.7 | 19.2 |=== + + +=== Raspberry Pi Zero W + +* https://datasheets.raspberrypi.com/rpizero/raspberry-pi-zero-w-reduced-schematics.pdf[Schematics, revision 1.1] +* https://datasheets.raspberrypi.com/rpizero/raspberry-pi-zero-w-mechanical-drawing.pdf[Mechanical drawings, PDF] + +=== Raspberry Pi Zero + +* https://datasheets.raspberrypi.com/rpizero/raspberry-pi-zero-reduced-schematics.pdf[Schematics, revision 1.3] +* https://datasheets.raspberrypi.com/rpizero/raspberry-pi-zero-mechanical-drawing.pdf[Mechanical drawings, PDF] +* https://datasheets.raspberrypi.com/case/raspberry-pi-zero-case-mechanical-drawing.pdf[Case drawings, PDF - blank lid] +* https://datasheets.raspberrypi.com/case/raspberry-pi-zero-case-with-gpio-mechanical-drawing.pdf[Case drawings, PDF - GPIO lid] +* https://datasheets.raspberrypi.com/case/raspberry-pi-zero-case-with-camera-mechanical-drawing.pdf[Case Drawings, PDF - camera lid] diff --git a/documentation/asciidoc/computers/raspberry-pi/revision-codes.adoc b/documentation/asciidoc/computers/raspberry-pi/revision-codes.adoc index 9de5b2dd9..e75cef87d 100644 --- a/documentation/asciidoc/computers/raspberry-pi/revision-codes.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/revision-codes.adoc @@ -2,9 +2,9 @@ Each distinct Raspberry Pi model revision has a unique revision code. You can look up a Raspberry Pi's revision code by running: -[,bash] +[source,console] ---- -cat /proc/cpuinfo +$ cat /proc/cpuinfo ---- The last three lines show the hardware type, the revision code, and the Raspberry Pi's unique serial number. For example: @@ -15,7 +15,7 @@ Revision : a02082 Serial : 00000000765fc593 ---- -NOTE: All Raspberry Pi computers report `BCM2835`, even those with BCM2836, BCM2837, BCM2711, and BCM2712 processors. You should not use this string to detect the processor. Decode the revision code using the information below, or `cat /sys/firmware/devicetree/base/model`. +NOTE: All Raspberry Pi computers report `BCM2835`, even those with BCM2836, BCM2837, BCM2711, and BCM2712 processors. You should not use this string to detect the processor. Decode the revision code using the information below, or `cat /sys/firmware/devicetree/base/model`. Depending on which kernel you're running, your `cpuinfo` might also have a "Model" line, and might not have a "Hardware" line. === Old-style revision codes @@ -210,6 +210,10 @@ NOQuuuWuFMMMCCCCPPPPTTTTTTTTRRRR | | 5: 8GB +| +| +| 6: 16GB + | CCCC (bits 16-19) | Manufacturer | 0: Sony UK @@ -256,91 +260,103 @@ NOQuuuWuFMMMCCCCPPPPTTTTTTTTRRRR | TTTTTTTT (bits 4-11) | Type -| 0: A +| 0x00: A + +| +| +| 0x01: B + +| +| +| 0x02: A+ | | -| 1: B +| 0x03: B+ | | -| 2: A+ +| 0x04: 2B | | -| 3: B+ +| 0x05: Alpha (early prototype) | | -| 4: 2B +| 0x06: CM1 | | -| 5: Alpha (early prototype) +| 0x08: 3B | | -| 6: CM1 +| 0x09: Zero | | -| 8: 3B +| 0x0a: CM3 | | -| 9: Zero +| 0x0c: Zero W | | -| a: CM3 +| 0x0d: 3B+ | | -| c: Zero W +| 0x0e: 3A+ | | -| d: 3B+ +| 0x0f: Internal use only | | -| e: 3A+ +| 0x10: CM3+ | | -| f: Internal use only +| 0x11: 4B | | -| 10: CM3+ +| 0x12: Zero 2 W | | -| 11: 4B +| 0x13: 400 | | -| 12: Zero 2 W +| 0x14: CM4 | | -| 13: 400 +| 0x15: CM4S | | -| 14: CM4 +| 0x16: Internal use only | | -| 15: CM4S +| 0x17: 5 | | -| 16: Internal use only +| 0x18: CM5 | | -| 17: 5 +| 0x19: 500/500+ + +| +| +| 0x1a: CM5 Lite | RRRR (bits 0-3) | Revision @@ -355,6 +371,8 @@ NOQuuuWuFMMMCCCCPPPPTTTTTTTTRRRR NOTE: This list is not exhaustive - there may be codes in use that are not in this table. Please see the next section for best practices on using revision codes to identify boards. +// This table is now sorted by Type (from table above), then Revision, then RAM, and finally Code. This is the most likley order-of-manufacture, which means we'll normally just add new revision-codes to the very bottom of the table, without having to worry about re-ordering entries. + |=== | Code | Model | Revision | RAM | Manufacturer @@ -370,54 +388,6 @@ NOTE: This list is not exhaustive - there may be codes in use that are not in th | 512MB | Sony UK -| 900092 -| Zero -| 1.2 -| 512MB -| Sony UK - -| 900093 -| Zero -| 1.3 -| 512MB -| Sony UK - -| 9000c1 -| Zero W -| 1.1 -| 512MB -| Sony UK - -| 9020e0 -| 3A+ -| 1.0 -| 512MB -| Sony UK - -| 9020e1 -| 3A+ -| 1.1 -| 512MB -| Sony UK - -| 920092 -| Zero -| 1.2 -| 512MB -| Embest - -| 920093 -| Zero -| 1.3 -| 512MB -| Embest - -| 900061 -| CM1 -| 1.1 -| 512MB -| Sony UK - | a01040 | 2B | 1.0 @@ -430,29 +400,11 @@ NOTE: This list is not exhaustive - there may be codes in use that are not in th | 1GB | Sony UK -| a02082 -| 3B -| 1.2 -| 1GB -| Sony UK - -| a020a0 -| CM3 -| 1.0 -| 1GB -| Sony UK - -| a020d3 -| 3B+ -| 1.3 -| 1GB -| Sony UK - -| a020d4 -| 3B+ -| 1.4 +| a21041 +| 2B +| 1.1 | 1GB -| Sony UK +| Embest | a02042 | 2B (with BCM2837) @@ -460,27 +412,27 @@ NOTE: This list is not exhaustive - there may be codes in use that are not in th | 1GB | Sony UK -| a21041 -| 2B -| 1.1 -| 1GB -| Embest - | a22042 | 2B (with BCM2837) | 1.2 | 1GB | Embest -| a22082 +| 900061 +| CM1 +| 1.1 +| 512MB +| Sony UK + +| a02082 | 3B | 1.2 | 1GB -| Embest +| Sony UK -| a220a0 -| CM3 -| 1.0 +| a22082 +| 3B +| 1.2 | 1GB | Embest @@ -502,6 +454,72 @@ NOTE: This list is not exhaustive - there may be codes in use that are not in th | 1GB | Embest +| 900092 +| Zero +| 1.2 +| 512MB +| Sony UK + +| 920092 +| Zero +| 1.2 +| 512MB +| Embest + +| 900093 +| Zero +| 1.3 +| 512MB +| Sony UK + +| 920093 +| Zero +| 1.3 +| 512MB +| Embest + +| a020a0 +| CM3 +| 1.0 +| 1GB +| Sony UK + +| a220a0 +| CM3 +| 1.0 +| 1GB +| Embest + +| 9000c1 +| Zero W +| 1.1 +| 512MB +| Sony UK + +| a020d3 +| 3B+ +| 1.3 +| 1GB +| Sony UK + +| a020d4 +| 3B+ +| 1.4 +| 1GB +| Sony UK + +| 9020e0 +| 3A+ +| 1.0 +| 512MB +| Sony UK + +| 9020e1 +| 3A+ +| 1.1 +| 512MB +| Sony UK + | a02100 | CM3+ | 1.0 @@ -520,40 +538,46 @@ NOTE: This list is not exhaustive - there may be codes in use that are not in th | 2GB | Sony UK +| c03111 +| 4B +| 1.1 +| 4GB +| Sony UK + | b03112 | 4B | 1.2 | 2GB | Sony UK -| b03114 +| c03112 | 4B -| 1.4 -| 2GB +| 1.2 +| 4GB | Sony UK -| b03115 +| b03114 | 4B -| 1.5 +| 1.4 | 2GB | Sony UK -| c03111 +| c03114 | 4B -| 1.1 +| 1.4 | 4GB | Sony UK -| c03112 +| d03114 | 4B -| 1.2 -| 4GB +| 1.4 +| 8GB | Sony UK -| c03114 +| b03115 | 4B -| 1.4 -| 4GB +| 1.5 +| 2GB | Sony UK | c03115 @@ -562,20 +586,20 @@ NOTE: This list is not exhaustive - there may be codes in use that are not in th | 4GB | Sony UK -| d03114 -| 4B -| 1.4 -| 8GB -| Sony UK - | d03115 | 4B | 1.5 | 8GB | Sony UK +| 902120 +| Zero 2 W +| 1.0 +| 512MB +| Sony UK + | c03130 -| Pi 400 +| 400 | 1.0 | 4GB | Sony UK @@ -604,10 +628,10 @@ NOTE: This list is not exhaustive - there may be codes in use that are not in th | 8GB | Sony UK -| 902120 -| Zero 2 W +| b04170 +| 5 | 1.0 -| 512MB +| 2GB | Sony UK | c04170 @@ -622,13 +646,85 @@ NOTE: This list is not exhaustive - there may be codes in use that are not in th | 8GB | Sony UK +| b04171 +| 5 +| 1.1 +| 2GB +| Sony UK + +| c04171 +| 5 +| 1.1 +| 4GB +| Sony UK + +| d04171 +| 5 +| 1.1 +| 8GB +| Sony UK + +| e04171 +| 5 +| 1.1 +| 16GB +| Sony UK + +| b04180 +| CM5 +| 1.0 +| 2GB +| Sony UK + +| c04180 +| CM5 +| 1.0 +| 4GB +| Sony UK + +| d04180 +| CM5 +| 1.0 +| 8GB +| Sony UK + +| d04190 +| 500 +| 1.0 +| 8GB +| Sony UK + +| e04190 +| 500+ +| 1.0 +| 16GB +| Sony UK + +| b041a0 +| CM5 Lite +| 1.0 +| 2GB +| Sony UK + +| c041a0 +| CM5 Lite +| 1.0 +| 4GB +| Sony UK + +| d041a0 +| CM5 Lite +| 1.0 +| 8GB +| Sony UK + |=== === Using revision codes for board identification From the command line we can use the following to get the revision code of the board: -[source, console] +[source,console] ---- $ cat /proc/cpuinfo | grep Revision Revision : c03111 @@ -643,7 +739,7 @@ Starting from the lowest order bits, the bottom four (0-3) are the board revisio Obviously there are so many programming languages out there it's not possible to give examples for all of them, but here are two quick examples for `C` and `Python`. Both these examples use a system call to run a bash command that gets the `cpuinfo` and pipes the result to `awk` to recover the required revision code. They then use bit operations to extract the `New`, `Model`, and `Memory` fields from the code. -[source, c] +[source,c] ---- #include #include @@ -673,14 +769,14 @@ int main( int argc, char *argv[] ) And the same in Python: -[source, python] +[source,python] ---- import subprocess cmd = "cat /proc/cpuinfo | awk '/Revision/ {print $3}'" revcode = subprocess.check_output(cmd, shell=True) -code = int(revcode, 16) +code = int(revcode, 16) new = (code >> 23) & 0x1 model = (code >> 4) & 0xff mem = (code >> 20) & 0x7 @@ -710,7 +806,7 @@ NOTE: Always check bit 23, the 'New' flag, to ensure that the revision code is t Support and formatting for `/proc/cpuinfo` varies across Linux distributions. To check the model or CPU of a Raspberry Pi device on any Linux distribution (including Raspberry Pi OS), check the device tree: -[source, console] +[source,console] ---- $ cat /proc/device-tree/compatible | tr '\0' '\n' raspberrypi,5-model-b @@ -727,25 +823,28 @@ This outputs two null-separated string values, each containing a comma-separated Raspberry Pi models have the following device tree values: |=== -| Device Name | Make | Model | CPU Make | CPU - -| Raspberry Pi 5 | `raspberrypi` | `5-model-b` | `brcm` | `bcm2712` -| Raspberry Pi 400 | `raspberrypi` | `400` | `brcm` | `bcm2711` -| Raspberry Pi Compute Module 4 | `raspberrypi` | `4-compute-module` | `brcm` | `bcm2711` -| Raspberry Pi 4 Model A | `raspberrypi` | `4-model-a` | `brcm` | `bcm2711` -| Raspberry Pi 4 Model B | `raspberrypi` | `4-model-b` | `brcm` | `bcm2711` -| Raspberry Pi Compute Module 3 | `raspberrypi` | `3-compute-module` | `brcm` | `bcm2837` -| Raspberry Pi 3 Model A+ | `raspberrypi` | `3-model-a-plus` | `brcm` | `bcm2837` -| Raspberry Pi 3 Model B+ | `raspberrypi` | `3-model-b-plus` | `brcm` | `bcm2837` -| Raspberry Pi 3 Model B | `raspberrypi` | `3-model-b` | `brcm` | `bcm2837` -| Raspberry Pi 2 Model B | `raspberrypi` | `2-model-b` | `brcm` | `bcm2836` -| Raspberry Pi Compute Module | `raspberrypi` | `compute-module` | `brcm` | `bcm2835` -| Raspberry Pi Model A+ | `raspberrypi` | `model-a-plus` | `brcm` | `bcm2835` -| Raspberry Pi Model B+ | `raspberrypi` | `model-b-plus` | `brcm` | `bcm2835` -| Raspberry Pi Model B Rev 2 | `raspberrypi` | `model-b-rev2` | `brcm` | `bcm2835` -| Raspberry Pi Model A | `raspberrypi` | `model-a` | `brcm` | `bcm2835` -| Raspberry Pi Model B | `raspberrypi` | `model-b` | `brcm` | `bcm2835` -| Raspberry Pi Zero 2 W | `raspberrypi` | `model-zero-2-w` | `brcm` | `bcm2837` -| Raspberry Pi Zero | `raspberrypi` | `model-zero` | `brcm` | `bcm2835` -| Raspberry Pi Zero W | `raspberrypi` | `model-zero-w` | `brcm` | `bcm2835` +| Device Name | Make | Model | CPU Make | CPU + +| Raspberry Pi 500 /500+ | `raspberrypi` | `500` | `brcm` | `bcm2712` +| Compute Module 5 | `raspberrypi` | `5-compute-module` | `brcm` | `bcm2712` +| Raspberry Pi 5 | `raspberrypi` | `5-model-b` | `brcm` | `bcm2712` +| Raspberry Pi 400 | `raspberrypi` | `400` | `brcm` | `bcm2711` +| Compute Module 4S | `raspberrypi` | `4s-compute-module` | `brcm` | `bcm2711` +| Compute Module 4 | `raspberrypi` | `4-compute-module` | `brcm` | `bcm2711` +| Raspberry Pi 4 Model B | `raspberrypi` | `4-model-b` | `brcm` | `bcm2711` +| Raspberry Pi Zero 2 W | `raspberrypi` | `model-zero-2-w` | `brcm` | `bcm2837` +| Compute Module 3+ | `raspberrypi` | `3-plus-compute-module` | `brcm` | `bcm2837` +| Compute Module 3 | `raspberrypi` | `3-compute-module` | `brcm` | `bcm2837` +| Raspberry Pi 3 Model A+ | `raspberrypi` | `3-model-a-plus` | `brcm` | `bcm2837` +| Raspberry Pi 3 Model B+ | `raspberrypi` | `3-model-b-plus` | `brcm` | `bcm2837` +| Raspberry Pi 3 Model B | `raspberrypi` | `3-model-b` | `brcm` | `bcm2837` +| Raspberry Pi 2 Model B | `raspberrypi` | `2-model-b` | `brcm` | `bcm2836` +| Raspberry Pi Zero W | `raspberrypi` | `model-zero-w` | `brcm` | `bcm2835` +| Raspberry Pi Zero | `raspberrypi` | `model-zero` | `brcm` | `bcm2835` +| Compute Module 1 | `raspberrypi` | `compute-module` | `brcm` | `bcm2835` +| Raspberry Pi Model A+ | `raspberrypi` | `model-a-plus` | `brcm` | `bcm2835` +| Raspberry Pi Model B+ | `raspberrypi` | `model-b-plus` | `brcm` | `bcm2835` +| Raspberry Pi Model B Rev 2 | `raspberrypi` | `model-b-rev2` | `brcm` | `bcm2835` +| Raspberry Pi Model A | `raspberrypi` | `model-a` | `brcm` | `bcm2835` +| Raspberry Pi Model B | `raspberrypi` | `model-b` | `brcm` | `bcm2835` |=== diff --git a/documentation/asciidoc/computers/raspberry-pi/rtc.adoc b/documentation/asciidoc/computers/raspberry-pi/rtc.adoc index 37d21b7cb..3ae95bdbc 100644 --- a/documentation/asciidoc/computers/raspberry-pi/rtc.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/rtc.adoc @@ -16,7 +16,7 @@ $ sudo -E rpi-eeprom-config --edit adding the following two lines. -[source, bash] +[source,ini] ---- POWER_OFF_ON_HALT=1 WAKE_ON_GPIO=0 @@ -34,7 +34,6 @@ That will halt the board into a very low-power state, then wake and restart afte The RTC also provides the time on boot e.g. in `dmesg`, for use cases that lack access to NTP: -[source,bash] ---- [ 1.295799] rpi-rtc soc:rpi_rtc: setting system clock to 2023-08-16T15:58:50 UTC (1692201530) ---- @@ -58,7 +57,6 @@ The RTC is equipped with a constant-current (3mA) constant-voltage charger. Charging of the battery is disabled by default. There are `sysfs` files that show the charging voltage and limits: -[source,bash] ---- /sys/devices/platform/soc/soc:rpi_rtc/rtc/rtc0/charging_voltage:0 /sys/devices/platform/soc/soc:rpi_rtc/rtc/rtc0/charging_voltage_max:4400000 @@ -67,7 +65,7 @@ Charging of the battery is disabled by default. There are `sysfs` files that sho To charge the battery at a set voltage, add https://github.com/raspberrypi/firmware/blob/master/boot/overlays/README#L279[`rtc_bbat_vchg`] to `/boot/firmware/config.txt`: -[source,bash] +[source,ini] ---- dtparam=rtc_bbat_vchg=3000000 ---- diff --git a/documentation/asciidoc/computers/raspberry-pi/spi-bus-on-raspberry-pi.adoc b/documentation/asciidoc/computers/raspberry-pi/spi-bus-on-raspberry-pi.adoc index 1b9436646..6f5d85f16 100644 --- a/documentation/asciidoc/computers/raspberry-pi/spi-bus-on-raspberry-pi.adoc +++ b/documentation/asciidoc/computers/raspberry-pi/spi-bus-on-raspberry-pi.adoc @@ -8,9 +8,9 @@ Raspberry Pi computers are equipped with a number of https://en.wikipedia.org/wi Raspberry Pi Zero, 1, 2 and 3 have three SPI controllers: -* SPI0, with two hardware chip selects, is available on the header of all Raspberry Pis; there is also an alternate mapping that is only available on Compute Modules. -* SPI1, with three hardware chip selects, is available on all Raspberry Pi models except the original Raspberry Pi 1 Model A and Model B. -* SPI2, also with three hardware chip selects, is only available on Compute Module 1, 3 and 3+. +* `SPI0`, with two hardware chip selects, is available on the header of all Raspberry Pis; there is also an alternate mapping that is only available on Compute Modules. +* `SPI1`, with three hardware chip selects, is available on all Raspberry Pi models except the original Raspberry Pi 1 Model A and Model B. +* `SPI2`, also with three hardware chip selects, is only available on Compute Module 1, 3 and 3+. On the Raspberry Pi 4, 400 and Compute Module 4 there are four additional SPI buses: SPI3 to SPI6, each with two hardware chip selects. These extra SPI buses are available via alternate function assignments on certain GPIO pins. For more information, see the https://datasheets.raspberrypi.com/bcm2711/bcm2711-peripherals.pdf[BCM2711 Arm peripherals] datasheet. @@ -20,12 +20,9 @@ Chapter 10 in the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals ===== SPI0 -[cols="1,1,1,1"] +[cols="1m,1,1m,1m"] |=== -| SPI function -| Header pin -| Broadcom pin name -| Broadcom pin function +a| SPI function | Header pin a| Broadcom pin name a| Broadcom pin function | MOSI | 19 @@ -55,11 +52,9 @@ Chapter 10 in the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals ===== SPI0 alternate mapping (Compute Modules only, except CM4) -[cols="1,1,1"] +[cols="1m,1m,1m"] |=== -| SPI function -| Broadcom pin name -| Broadcom pin function +a| SPI function a| Broadcom pin name a| Broadcom pin function | MOSI | GPIO38 @@ -84,12 +79,9 @@ Chapter 10 in the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals ===== SPI1 -[cols="1,1,1,1"] +[cols="1m,1,1m,1m"] |=== -| SPI function -| Header pin -| Broadcom pin name -| Broadcom pin function +a| SPI function | Header pin | Broadcom pin name | Broadcom pin function | MOSI | 38 @@ -124,11 +116,9 @@ Chapter 10 in the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals ===== SPI2 (Compute Modules only, except CM4) -[cols="1,1,1"] +[cols="1m,1m,1m"] |=== -| SPI function -| Broadcom pin name -| Broadcom pin function +a| SPI function a| Broadcom pin name a| Broadcom pin function | MOSI | GPIO41 @@ -157,12 +147,9 @@ Chapter 10 in the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals ===== SPI3 (BCM2711 only) -[cols="1,1,1,1"] +[cols="1m,1,1m,1m"] |=== -| SPI function -| Header pin -| Broadcom pin name -| Broadcom pin function +a| SPI function | Header pin a| Broadcom pin name a| Broadcom pin function | MOSI | 03 @@ -192,12 +179,9 @@ Chapter 10 in the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals ===== SPI4 (BCM2711 only) -[cols="1,1,1,1"] +[cols="1m,1,1m,1m"] |=== -| SPI function -| Header pin -| Broadcom pin name -| Broadcom pin function +a| SPI function | Header pin a| Broadcom pin name a| Broadcom pin function | MOSI | 31 @@ -227,12 +211,9 @@ Chapter 10 in the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals ===== SPI5 (BCM2711 only) -[cols="1,1,1,1"] +[cols="1m,1,1m,1m"] |=== -| SPI function -| Header pin -| Broadcom pin name -| Broadcom pin function +a| SPI function | Header pin a| Broadcom pin name a| Broadcom pin function | MOSI | 08 @@ -264,10 +245,7 @@ Chapter 10 in the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals [cols="1,1,1,1"] |=== -| SPI function -| Header pin -| Broadcom pin name -| Broadcom pin function +| SPI function | Header pin | Broadcom pin name | Broadcom pin function | MOSI | 38 @@ -297,15 +275,13 @@ Chapter 10 in the https://datasheets.raspberrypi.com/bcm2835/bcm2835-peripherals ==== Master modes -Signal name abbreviations +Signal name abbreviations: ----- -SCLK - serial clock -CE - chip enable (often called chip select) -MOSI - master out slave in -MISO - master in slave out -MOMI - master out master in ----- +SCLK:: serial clock +CE:: chip enable (often called chip select) +MOSI:: master out slave in +MISO:: master in slave out +MOMI:: master out master in ===== Standard mode @@ -331,9 +307,7 @@ NOTE: Some commands trigger an automatic read by the SPI controller, so this mod The clock divider (CDIV) field of the CLK register sets the SPI clock speed: ----- -SCLK = Core Clock / CDIV ----- +SCLK:: Core Clock / CDIV If CDIV is set to 0, the divisor is 65536. The divisor must be a multiple of 2, with odd numbers rounded down. Note that not all possible clock rates are usable because of analogue electrical issues (rise times, drive strengths, etc). @@ -346,7 +320,6 @@ Setup and hold times related to the automatic assertion and de-assertion of the * The CS line will be asserted at least three core clock cycles before the msb of the first byte of the transfer. * The CS line will be de-asserted no earlier than one core clock cycle after the trailing edge of the final clock pulse. -[[software]] === SPI software [[driver]] @@ -356,15 +329,19 @@ The default Linux driver is `spi-bcm2835`. SPI0 is disabled by default. To enable it, use xref:configuration.adoc#raspi-config[raspi-config], or ensure the line `dtparam=spi=on` is not commented out in xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]. By default it uses two chip select lines, but this can be reduced to one using `dtoverlay=spi0-1cs`. There is also `dtoverlay=spi0-2cs`; without any parameters it is equivalent to `dtparam=spi=on`. -To enable SPI1, you can use 1, 2 or 3 chip select lines, adding in each case: +To enable SPI1, you can use 1, 2 or 3 chip select lines. Add the appropriate lines to `/boot/firmware/config.txt`:" +[source,ini] ---- -dtoverlay=spi1-1cs #1 chip select -dtoverlay=spi1-2cs #2 chip select -dtoverlay=spi1-3cs #3 chip select +#1 chip select +dtoverlay=spi1-1cs +#2 chip select +dtoverlay=spi1-2cs +#3 chip select +dtoverlay=spi1-3cs ---- -...to the `/boot/firmware/config.txt` file. Similar overlays exist for SPI2, SPI3, SPI4, SPI5 and SPI6. +Similar overlays exist for SPI2, SPI3, SPI4, SPI5 and SPI6. The driver does not make use of the hardware chip select lines because of some limitations. Instead, it can use an arbitrary number of GPIOs as software/GPIO chip selects. This means you are free to choose any spare GPIO as a CS line, and all of these SPI overlays include that control - see `/boot/firmware/overlays/README` for details, or run (for example) `dtoverlay -h spi0-2cs` (`dtoverlay -a | grep spi` might be helpful to list them all). @@ -374,20 +351,18 @@ The driver supports all speeds which are even integer divisors of the core clock ===== Supported mode bits ----- -SPI_CPOL - clock polarity -SPI_CPHA - clock phase -SPI_CS_HIGH - chip select active high -SPI_NO_CS - 1 device per bus, no Chip select -SPI_3WIRE - bidirectional mode, data in and out pin shared ----- +SPI_CPOL:: clock polarity +SPI_CPHA:: clock phase +SPI_CS_HIGH:: chip select active high +SPI_NO_CS:: 1 device per bus, no Chip select +SPI_3WIRE:: bidirectional mode, data in and out pin shared -Bidirectional mode, also called 3-wire mode, is supported by the `spi-bcm2835` kernel module. Please note that in this mode, either the tx or rx field of the `spi_transfer` struct must be a NULL pointer, since only half-duplex communication is possible. Otherwise, the transfer will fail. The `spidev_test.c` source code does not consider this correctly, and therefore does not work at all in 3-wire mode. +Bidirectional mode, also called 3-wire mode, is supported by the `spi-bcm2835` kernel module. Please note that in this mode, either the `tx` or `rx` field of the `spi_transfer` struct must be a NULL pointer, since only half-duplex communication is possible. Otherwise, the transfer will fail. The `spidev_test.c` source code does not consider this correctly, and therefore does not work at all in 3-wire mode. ===== Supported bits per word * 8 - normal -* 9 - this is supported using LoSSI mode +* 9 - supported using LoSSI mode ===== Transfer modes @@ -399,27 +374,28 @@ This https://forums.raspberrypi.com/viewtopic.php?f=44&t=19489[thread] discusses ==== spidev -`spidev` presents an ioctl-based userspace interface to individual SPI CS lines. Device Tree is used to indicate whether a CS line is going to be driven by a kernel driver module or managed by spidev on behalf of the user; it is not possible to do both at the same time. Note that Raspberry Pi's own kernels are more relaxed about the use of Device Tree to enable `spidev` - the upstream kernels print warnings about such usage, and ultimately may prevent it altogether. +`spidev` presents an `ioctl`-based userspace interface to individual SPI CS lines. Device Tree is used to indicate whether a CS line is going to be driven by a kernel driver module or managed by `spidev` on behalf of the user; it is not possible to do both at the same time. Note that Raspberry Pi's own kernels are more relaxed about the use of Device Tree to enable `spidev` - the upstream kernels print warnings about such usage, and ultimately may prevent it altogether. -===== Using spidev from C +===== Use `spidev` from C There is a loopback test program in the Linux documentation that can be used as a starting point. See the <> section. -===== Using spidev from Python +===== Use `spidev` from Python There are several Python libraries that provide access to `spidev`, including `spidev` (`pip install spidev` - see https://pypi.org/project/spidev/) and `SPI-Py` (https://github.com/lthiery/SPI-Py). -===== Using spidev from a shell such as bash +===== Use `spidev` from a shell such as bash + +The following command writes binary 1, 2, and 3: -[,bash] +[source,console] ---- -# Write binary 1, 2 and 3 -echo -ne "\x01\x02\x03" > /dev/spidev0.0 +$ echo -ne "\x01\x02\x03" > /dev/spidev0.0 ---- ==== Other SPI libraries -There are other userspace libraries that provide SPI control by directly manipulating the hardware: this is not recommended. +There are other user space libraries that provide SPI control by directly manipulating the hardware: this is not recommended. [[troubleshooting-spi-hardware]] === Troubleshooting @@ -428,11 +404,11 @@ There are other userspace libraries that provide SPI control by directly manipul This can be used to test SPI send and receive. Put a wire between MOSI and MISO. It does not test CE0 and CE1. -[,bash] +[source,console] ---- -wget https://raw.githubusercontent.com/raspberrypi/linux/rpi-6.1.y/tools/spi/spidev_test.c -gcc -o spidev_test spidev_test.c -./spidev_test -D /dev/spidev0.0 +$ wget https://raw.githubusercontent.com/raspberrypi/linux/rpi-6.1.y/tools/spi/spidev_test.c +$ gcc -o spidev_test spidev_test.c +$ ./spidev_test -D /dev/spidev0.0 spi mode: 0 bits per word: 8 max speed: 500000 Hz (500 KHz) diff --git a/documentation/asciidoc/computers/remote-access.adoc b/documentation/asciidoc/computers/remote-access.adoc index 9b69f749b..def7f582f 100644 --- a/documentation/asciidoc/computers/remote-access.adoc +++ b/documentation/asciidoc/computers/remote-access.adoc @@ -1,12 +1,12 @@ -include::remote-access/remote-access-introduction.adoc[] +include::remote-access/introduction.adoc[] include::remote-access/find-your-ip-address.adoc[] -include::remote-access/ssh-server.adoc[] +include::remote-access/ssh.adoc[] -include::remote-access/ssh-client.adoc[] +include::remote-access/vnc.adoc[] -include::remote-access/ssh-passwordless.adoc[] +include::remote-access/raspberry-pi-connect.adoc[] include::remote-access/scp.adoc[] @@ -16,8 +16,6 @@ include::remote-access/nfs.adoc[] include::remote-access/samba.adoc[] -include::remote-access/vnc.adoc[] - include::remote-access/apache.adoc[] include::remote-access/network-boot-raspberry-pi.adoc[] diff --git a/documentation/asciidoc/computers/remote-access/apache.adoc b/documentation/asciidoc/computers/remote-access/apache.adoc index df9097e69..1b9f59aa5 100644 --- a/documentation/asciidoc/computers/remote-access/apache.adoc +++ b/documentation/asciidoc/computers/remote-access/apache.adoc @@ -1,10 +1,10 @@ -== Setting up an Apache Web Server +== Set up an Apache web server Apache is a popular web server application you can install on the Raspberry Pi to allow it to serve web pages. On its own, Apache can serve HTML files over HTTP, and with additional modules can serve dynamic web pages using scripting languages such as PHP. -=== Installing Apache +=== Install Apache First, update the available packages by typing the following command into the Terminal: @@ -20,7 +20,7 @@ Then, install the `apache2` package with this command: sudo apt install apache2 -y ---- -=== Test the Web Server +=== Test the web server By default, Apache puts a test HTML file in the web folder. This default web page is served when you browse to `+http://localhost/+` on the Raspberry Pi itself, or `+http://192.168.1.10+` (whatever the Raspberry Pi's IP address is) from another computer on the network. To find the Raspberry Pi's IP address, type `hostname -I` at the command line (or read more about finding your xref:remote-access.adoc#ip-address[IP address]). @@ -30,7 +30,7 @@ image::images/apache-it-works.png[Apache success message] This means you have Apache working! -==== Changing the Default Web Page +==== Change the default web page This default web page is just an HTML file on the filesystem. It is located at `/var/www/html/index.html`. @@ -60,7 +60,7 @@ $ sudo chown : index.html You can now try editing this file and then refreshing the browser to see the web page change. If you know HTML you can put your own HTML files and other assets in this directory and serve them as a website on your local network. -=== Installing PHP for Apache +=== Install PHP for Apache To allow your Apache server to process PHP files, you'll need to install the latest version of PHP and the PHP module for Apache. Type the following command to install these: diff --git a/documentation/asciidoc/computers/remote-access/find-your-ip-address.adoc b/documentation/asciidoc/computers/remote-access/find-your-ip-address.adoc index 50cab3c2c..d3a946e62 100644 --- a/documentation/asciidoc/computers/remote-access/find-your-ip-address.adoc +++ b/documentation/asciidoc/computers/remote-access/find-your-ip-address.adoc @@ -1,32 +1,38 @@ [[ip-address]] -=== How to find your IP address +== Find the IP address of your Raspberry Pi + +Most methods of connecting to your Raspberry Pi from another machine require you to know the local IP address of your Raspberry Pi. + +Any device connected to a Local Area Network is assigned an IP address. In order to connect to your Raspberry Pi from another machine using xref:remote-access.adoc#ssh[SSH] or xref:remote-access.adoc#vnc[VNC], you need to know the Raspberry Pi's IP address. This is easy if you have a display connected, and there are a number of methods for finding it remotely from another machine on the network. To find the local IP address of your Raspberry Pi, use one of the following methods. -==== Desktop +=== Desktop Hover over the network icon in the system tray, and a tooltip will appear. This tooltip displays the name of the network you're currently connected to and your IP address. -image::images/network-tooltip.png[the Network Manager tooltip displaying a WiFi network name and IP address] +image::images/network-tooltip.png[the Network Manager tooltip displaying a Wi-Fi network name and IP address] -==== Command line +=== Command line -Run the following command to output your IP address to the command line: +Run the following command to output your local IP address to the command line: +[source,console] ---- -hostname -I +$ hostname -I ---- -==== Boot output +=== Boot output -If you use a display with your Raspberry Pi and you boot to the command line instead of the desktop, the boot sequence will include your IP address as one of the last few output messages before your login prompt. +If you use a display with your Raspberry Pi and you boot to the command line instead of the desktop, the boot sequence includes your IP address as one of the last few output messages before your login prompt. -==== Network Manager +=== Network Manager You can use the built-in Network Manager CLI (`nmcli`) to access details about your network. Run the following command: +[source,console] ---- -nmcli device show +$ nmcli device show ---- You should see output similar to the following: @@ -89,16 +95,16 @@ Once you've identified the correct network interface block, look for a field nam In the example above, the Raspberry Pi uses Wi-Fi to access the internet. Check the block where the `GENERAL.TYPE` field reads "wifi" to find the IP address. In this case, you can access this device using the IPv4 address in the `IP4.ADDRESS[1]` field: `192.168.1.42`. -==== Resolving `raspberrypi.local` with mDNS +=== Resolve `raspberrypi.local` with mDNS -On Raspberry Pi OS, multicast DNS is supported out-of-the-box by the Avahi service. +Raspberry Pi OS supports multicast DNS as part of the Avahi service. If your device supports mDNS, you can reach your Raspberry Pi by using its hostname and the `.local` suffix. The default hostname on a fresh Raspberry Pi OS install is `raspberrypi`, so by default any Raspberry Pi running Raspberry Pi OS responds to: -[,bash] +[source,console] ---- -ping raspberrypi.local +$ ping raspberrypi.local ---- If the Raspberry Pi is reachable, `ping` will show its IP address: @@ -108,37 +114,41 @@ PING raspberrypi.local (192.168.1.131): 56 data bytes 64 bytes from 192.168.1.131: icmp_seq=0 ttl=255 time=2.618 ms ---- -If you change the system hostname of the Raspberry Pi (e.g., by editing `/etc/hostname`), Avahi also changes the `.local` mDNS address. +TIP: If you change the system hostname of your Raspberry Pi using Control Centre, `raspi-config`, or `/etc/hostname`, Avahi updates the `.local` mDNS address. If you don't remember the hostname of your Raspberry Pi, you can install Avahi on another device, then use https://linux.die.net/man/1/avahi-browse[`avahi-browse`] to browse all the hosts and services on your local network. + +=== Check your router's list of devices + +In a web browser, navigate to your router's IP address. Then, log in using your credentials. -If you don't remember the hostname of the Raspberry Pi, but have a system with Avahi installed, you can browse all the hosts and services on the LAN with the https://linux.die.net/man/1/avahi-browse[`avahi-browse`] command. +TIP: Your router's IP address is often `http://192.168.1.1`, but not always. You may be able to find your router's address and credentials printed on a label on your router. -==== Router devices list +This will take you to a control panel. Browse to the list of connected devices or similar (all routers are different), and you should see some devices you recognise. Some devices are detected as PCs, tablets, phones, printers, etc. so you should recognise some and rule them out to figure out which is your Raspberry Pi. -In a web browser, navigate to your router's IP address. This is often `http://192.168.1.1`, but you may be able to find it printed on a label on your router. This will take you to a control panel. Then log in using your credentials, which is usually also printed on the router or sent to you in the accompanying paperwork. Browse to the list of connected devices or similar (all routers are different), and you should see some devices you recognise. Some devices are detected as PCs, tablets, phones, printers, etc. so you should recognise some and rule them out to figure out which is your Raspberry Pi. Also note the connection type; if your Raspberry Pi is connected with a wire there should be fewer devices to choose from. +TIP: If you connect your Raspberry Pi to your network with a wire, try filtering for wired devices in the list. There should be fewer devices to choose from. -==== nmap command +=== Find devices with `nmap` -The `nmap` command (Network Mapper) is a free and open-source tool for network discovery, available for Linux, macOS, and Windows. +The Network Mapper command (`nmap`) is a free and open source tool for network discovery. It is available for Linux, macOS, and Windows. * To install on *Linux*, install the `nmap` package e.g. `apt install nmap`. * To install on *macOS* or *Windows*, see the http://nmap.org/download.html[nmap.org download page]. -To use `nmap` to scan the devices on your network, you need to know the subnet you are connected to. First find your own IP address, in other words the one of the computer you're using to find your Raspberry Pi's IP address: +To use `nmap` to scan the devices on your network, you need to know the subnet you are connected to. First, find the local IP address of the computer you're using: * On *Linux*, type `hostname -I` into a terminal window -* On *macOS*, go to `System Preferences` then `Network` and select your active network connection to view the IP address -* On *Windows*, go to the Control Panel, then under `Network and Sharing Center`, click `View network connections`, select your active network connection and click `View status of this connection` to view the IP address +* On *macOS*, go to *System Settings* > *Network*, select your active network connection, then click the *Details...* button +* On *Windows*, go to the Control Panel, then under *Network and Sharing Center*, click *View network connections*, select your active network connection and click *View status of this connection* -Now you have the IP address of your computer, you will scan the whole subnet for other devices. For example, if your IP address is `192.168.1.5`, other devices will use addresses like `192.168.1.2`, `192.168.1.6`, `192.168.1.20`, etc. The notation of this subnet range is `192.168.1.0/24` (this covers `192.168.1.0` to `192.168.1.255`). +Next, scan the whole **subnet** for other devices. Most local networks use IPv4, which uses four numbers with values between 1 and 255 for each IP address. Devices on your subnet all use the same first three numbers. For example, if your IP address is `192.168.1.5`, other devices will use addresses like `192.168.1.2`, `192.168.1.6` and `192.168.1.200`. To scan this subnet with `nmap`, pass the string `192.168.1.0/24`, which covers the subnet range `192.168.1.0` to `192.168.1.255`. Use the `-sn` flag to run a **ping scan** on the entire subnet range: -Now use the `nmap` command with the `-sn` flag (ping scan) on the whole subnet range. This may take a few seconds: - -[,bash] +[source,console] ---- -nmap -sn 192.168.1.0/24 +$ sudo nmap -sn 192.168.1.0/24 ---- -Ping scan just pings all the IP addresses to see if they respond. For each device that responds to the ping, the output shows the hostname and IP address like so: +TIP: This may take up to a minute depending on your local network speed. + +A ping scan queries all IP addresses in the range for a response. For each device that responds to the ping, the output shows the hostname and IP address as follows: ---- Starting Nmap 6.40 ( http://nmap.org ) at 2014-03-10 12:46 GMT @@ -153,12 +163,13 @@ Host is up (0.0030s latency). Nmap done: 256 IP addresses (4 hosts up) scanned in 2.41 seconds ---- -Here you can see a device with hostname `raspberrypi` has IP address `192.168.1.8`. Note, to see the hostnames, you must run nmap as root by prepending `sudo` to the command. +The output above shows a device with hostname `raspberrypi` has IP address `192.168.1.8`. -==== Getting the IP address of a Raspberry Pi using your smartphone +=== Find devices with a smartphone app The Fing app is a free network scanner for smartphones. It is available for https://play.google.com/store/apps/details?id=com.overlook.android.fing[Android] and https://itunes.apple.com/gb/app/fing-network-scanner/id430921107?mt=8[iOS]. -Your phone and your Raspberry Pi have to be on the same network, so connect your phone to the correct wireless network. - -When you open the Fing app, touch the refresh button in the upper right-hand corner of the screen. After a few seconds you will get a list with all the devices connected to your network. Scroll down to the entry with the manufacturer "Raspberry Pi". You will see the IP address in the bottom left-hand corner, and the MAC address in the bottom right-hand corner of the entry. +. Connect your phone to the same network as your Raspberry Pi. +. When you open the Fing app, touch the refresh button in the upper right-hand corner of the screen. +. After a few seconds, you should see a list with all the devices connected to your network. +. Scroll down to the entry with the manufacturer "Raspberry Pi". The IP address appears in the bottom left corner, and the MAC address in the bottom right corner of the entry. diff --git a/documentation/asciidoc/computers/remote-access/images/network-tooltip.png b/documentation/asciidoc/computers/remote-access/images/network-tooltip.png index e3c05343d..38e9fc34d 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/network-tooltip.png and b/documentation/asciidoc/computers/remote-access/images/network-tooltip.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png b/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png index d4063814c..d7667147b 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png and b/documentation/asciidoc/computers/remote-access/images/raspberry-pi-configuration.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/vnc-enable.png b/documentation/asciidoc/computers/remote-access/images/vnc-enable.png index 63b07d841..37a6f7123 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/vnc-enable.png and b/documentation/asciidoc/computers/remote-access/images/vnc-enable.png differ diff --git a/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png b/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png index 96eeff4d0..5fed688dd 100644 Binary files a/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png and b/documentation/asciidoc/computers/remote-access/images/vnc-tigervnc-desktop.png differ diff --git a/documentation/asciidoc/computers/remote-access/introduction.adoc b/documentation/asciidoc/computers/remote-access/introduction.adoc new file mode 100644 index 000000000..68c3109d7 --- /dev/null +++ b/documentation/asciidoc/computers/remote-access/introduction.adoc @@ -0,0 +1,24 @@ +== Introduction to remote access + +Sometimes you need to access a Raspberry Pi without connecting it to a monitor, keyboard, and mouse. Perhaps the Raspberry Pi is embedded in a robot or mounted in an inconvenient location. Or maybe you don't have a spare monitor. + +=== Remote control over the local network + +To remotely control your Raspberry Pi from another device on your local network, use one of the following services: + +* xref:remote-access.adoc#ssh[SSH] +* xref:remote-access.adoc#vnc[VNC] +* xref:remote-access.adoc#raspberry-pi-connect[Raspberry Pi Connect] + +SSH (**S**ecure **SH**ell) provides secure access to a terminal session on your Raspberry Pi. VNC (**V**irtual **N**etwork **C**omputing) provides secure access to a desktop screen share on your Raspberry Pi. All you need is another computer, a local network, and the local https://en.wikipedia.org/wiki/IP_address[IP address] of your Raspberry Pi. Raspberry Pi Connect shares your Raspberry Pi's screen securely with no need to determine your local IP address. + +=== Share files between devices over the local network + +Services like xref:remote-access.adoc#nfs[NFS] (Network File System), xref:remote-access.adoc#scp[SCP] (Secure Copy Protocol), xref:remote-access.adoc#samba[Samba], and xref:remote-access.adoc#rsync[`rsync`] enable you to share files between devices on the local network without directly controlling the remote device. These services can be useful when you need to access data stored on one device from another device. + +=== Remote control over the Internet + +To remotely control your Raspberry Pi from any device connected to the Internet, you can: + +* Expose xref:remote-access.adoc#ssh[SSH] or xref:remote-access.adoc#vnc[VNC] on your Raspberry Pi over the open internet, within a VPN, or using an external service like RealVNC's cloud https://www.realvnc.com/download/viewer/[VNC Viewer]. +* Use xref:remote-access.adoc#raspberry-pi-connect[Raspberry Pi Connect], a free screen sharing and remote shell service provided by Raspberry Pi. diff --git a/documentation/asciidoc/computers/remote-access/network-boot-ipv6.adoc b/documentation/asciidoc/computers/remote-access/network-boot-ipv6.adoc index ecb2c60b8..e2db3adc1 100644 --- a/documentation/asciidoc/computers/remote-access/network-boot-ipv6.adoc +++ b/documentation/asciidoc/computers/remote-access/network-boot-ipv6.adoc @@ -1,4 +1,4 @@ -== Network booting using IPv6 +== Network boot using IPv6 There are 4 stages to booting a Raspberry Pi computer over the network: @@ -47,13 +47,13 @@ With IPv4 netboot, `nfsroot` is used to mount `rootfs` over the network. This do NOTE: A mechanism to boot the Linux kernel with NFS via IPv6 is still to be demonstrated. -=== Test Setup +=== Test setup If you want to try this out you will need another Raspberry Pi to act as the TFTP and DHCP server. The TFTP server can in theory be on any routable network but the DHCP server has to be on the same network as the devices it will serve. -==== TFTP Server +==== TFTP server If you have a working IPv4 network boot setup you can reuse the TFTP server in dnsmasq to supply the files (it can talk to both IPv4 and IPv6). @@ -62,17 +62,17 @@ Alternatively you can use a standalone TFTP server like `tftpd-hpa`. [,bash] ---- -$ sudo apt-get install tftpd-hpa +$ sudo apt install tftpd-hpa $ sudo systemctl start tftpd-hpa ---- -==== DHCP Server +==== DHCP server DHCP in IPv6 has changed a lot. We need DHCP to at least tell us the address of the TFTP server, which in this case is the same machine. [,bash] ---- -$ sudo apt-get install isc-dhcp-server +$ sudo apt install isc-dhcp-server ---- Modify the configuration in `/etc/default/isc-dhcp-server` @@ -133,7 +133,7 @@ To use IPv6 you really need a router and ISP that supports IPv6. There are sites [,bash] ---- -sudo apt-get install ndisc6 +sudo apt install ndisc6 rdisc6 -1 eth0 ---- @@ -168,9 +168,9 @@ Retransmit time : unspecified (0x00000000) === Debugging -==== Logs and Traces +==== Logs and traces -If the boot uart is enabled you should see something like this from the serial port. The lines starting RX6 indicate that IPv6 is in use. +If the boot UART is enabled, you should see something like this from the serial port. The lines starting RX6 indicate that IPv6 is in use. Here `dc:a6:32:6f:73:f4` is the MAC address of the TFTP server and it has an IPv6 address of `fd49:869:6f93::1`. The device itself has a MAC address `e4:5f:01:20:24:0b` and an IPv6 address of `fd49:869:6f93::1000` @@ -196,9 +196,10 @@ TFTP_GET: dc:a6:32:6f:73:f4 fd49:869:6f93::1 ab5a4158/config.txt Finally the bootloader hands over to firmware which should load the kernel. ==== Stateful configuration + You can examine network activity with tcpdump. -[,bash] +[source,console] ---- $ sudo tcpdump -i eth0 -e ip6 -XX -l -v -vv ---- diff --git a/documentation/asciidoc/computers/remote-access/network-boot-raspberry-pi.adoc b/documentation/asciidoc/computers/remote-access/network-boot-raspberry-pi.adoc index 5d2afdc24..75db65a00 100644 --- a/documentation/asciidoc/computers/remote-access/network-boot-raspberry-pi.adoc +++ b/documentation/asciidoc/computers/remote-access/network-boot-raspberry-pi.adoc @@ -6,7 +6,7 @@ The instructions assume that you have an existing home network, and that you wan NOTE: Due to the huge range of networking devices and routers available, we can't guarantee that network booting will work with any device. We have had reports that, if you cannot get network booting to work, disabling STP frames on your network may help. -=== Client Configuration +=== Configure a network boot client ==== Raspberry Pi 3 Model B @@ -16,16 +16,16 @@ Before the Raspberry Pi 3 Model B will network boot it needs to be booted from a Install Raspberry Pi OS Lite, or Raspberry Pi OS with desktop, on the SD card in the usual fashion. Next, enable USB boot mode with the following command: -[,bash] +[source,console] ---- -echo program_usb_boot_mode=1 | sudo tee -a /boot/firmware/config.txt +$ echo program_usb_boot_mode=1 | sudo tee -a /boot/firmware/config.txt ---- This adds `program_usb_boot_mode=1` to the end of xref:config_txt.adoc#what-is-config-txt[`/boot/firmware/config.txt`]. Reboot the Raspberry Pi with `sudo reboot`. Once the client Raspberry Pi has rebooted, check that the OTP has been programmed with: -[,bash] +[source,console] ---- -vcgencmd otp_dump | grep 17: +$ vcgencmd otp_dump | grep 17: 17:3020000a ---- @@ -33,9 +33,9 @@ Ensure the output `0x3020000a` is correct. The client configuration is almost done. As a final step, disable USB booting. Run the following command: -[,bash] +[source,console] ---- -sudo nano /boot/firmware/config.txt +$ sudo nano /boot/firmware/config.txt ---- Remove the line that contains the text `program_usb_boot_mode=1`. Finally, shut the client Raspberry Pi down with `sudo poweroff`. @@ -44,16 +44,16 @@ Remove the line that contains the text `program_usb_boot_mode=1`. Finally, shut Network boot can be enabled on the Raspberry Pi 4 using the `raspi-config` tool. First, run `raspi-config` as follows: -[,bash] +[source,console] ---- -sudo raspi-config +$ sudo raspi-config ---- Within `raspi-config`, choose `Advanced Options`, then `Boot Order`, then `Network Boot`. You must then reboot the device for the change to the boot order to be programmed into the bootloader EEPROM. Once the Raspberry Pi has rebooted, check that the boot order is now `0xf21`: -[,bash] +[source,console] ---- -vcgencmd bootloader_config +$ vcgencmd bootloader_config ---- For further details of configuring the Raspberry Pi 4 bootloader, see xref:raspberry-pi.adoc#raspberry-pi-bootloader-configuration[Raspberry Pi Bootloader Configuration]. @@ -62,65 +62,64 @@ For further details of configuring the Raspberry Pi 4 bootloader, see xref:raspb Before configuring network boot, make a note of the serial number and mac address so that the board can be identified by the TFTP/DHCP server. -On Raspberry Pi 4 the MAC address is programmed at manufacture and there is no link between the MAC address and serial number. Both the MAC address and serial numbers are displayed on the bootloader xref:raspberry-pi.adoc#boot-diagnostics-on-the-raspberry-pi-4[HDMI diagnostics] screen. +On Raspberry Pi 4 and later flagship models, the MAC address is programmed at manufacture and there is no link between the MAC address and serial number. Both the MAC address and serial numbers are displayed on the bootloader xref:raspberry-pi.adoc#boot-diagnostics[HDMI diagnostics] screen. -To find the Ethernet MAC address: +To find the Ethernet MAC address, run the following command: -[,bash] +[source,console] ---- -ethtool -P eth0 +$ ethtool -P eth0 ---- -To find the serial number: +To find the serial number, run the following command: -[,bash] +[source,console] ---- -grep Serial /proc/cpuinfo | cut -d ' ' -f 2 | cut -c 9-16 +$ grep Serial /proc/cpuinfo | cut -d ' ' -f 2 | cut -c 9-16 ---- -=== Server Configuration +=== Configure a network boot server Plug the SD card into the server Raspberry Pi, and then boot the server. The client Raspberry Pi will need a root file system to boot from: we will use a copy of the server's root filesystem and place it in `/nfs/client1`: -[,bash] +[source,console] ---- -sudo mkdir -p /nfs/client1 -sudo apt install rsync -sudo rsync -xa --progress --exclude /nfs / /nfs/client1 +$ sudo mkdir -p /nfs/client1 +$ sudo apt install rsync +$ sudo rsync -xa --progress --exclude /nfs / /nfs/client1 ---- Regenerate SSH host keys on the client filesystem by chrooting into it: -[,bash] +[source,console] ---- -cd /nfs/client1 -sudo mount --bind /dev dev -sudo mount --bind /sys sys -sudo mount --bind /proc proc -sudo chroot . -rm /etc/ssh/ssh_host_* -dpkg-reconfigure openssh-server -exit -sudo umount dev sys proc +$ cd /nfs/client1 +$ sudo mount --bind /dev dev +$ sudo mount --bind /sys sys +$ sudo mount --bind /proc proc +$ sudo chroot . +$ rm /etc/ssh/ssh_host_* +$ dpkg-reconfigure openssh-server +$ exit +$ sudo umount dev sys proc ---- Find the settings of your local network. You need to find the address of your router (or gateway), which can be done with: -[,bash] +[source,console] ---- -ip route | awk '/default/ {print $3}' +$ ip route | awk '/default/ {print $3}' ---- Then run: -[,bash] +[source,console] ---- -ip -4 addr show dev eth0 | grep inet +$ ip -4 addr show dev eth0 | grep inet ---- -which should give an output like: +You should see output similar to the following: -[,bash] ---- inet 10.42.0.211/24 brd 10.42.0.255 scope global eth0 ---- @@ -129,18 +128,18 @@ The first address is the IP address of your server Raspberry Pi on the network, Finally, note down the address of your DNS server, which is the same address as your gateway. You can find this with: -[,bash] +[source,console] ---- -cat /etc/resolv.conf +$ cat /etc/resolv.conf ---- Configure a static network address on your server Raspberry Pi via the `systemd` networking, which works as the network handler and DHCP server. To do that, you'll need to create a `10-eth0.netdev` and a `11-eth0.network` like so: -[,bash] +[source,console] ---- -sudo nano /etc/systemd/network/10-eth0.netdev +$ sudo nano /etc/systemd/network/10-eth0.netdev ---- Add the following lines: @@ -155,9 +154,9 @@ DHCP=no Then create a network file: -[,bash] +[source,console] ---- -sudo nano /etc/systemd/network/11-eth0.network +$ sudo nano /etc/systemd/network/11-eth0.network ---- Add the following contents: @@ -176,14 +175,13 @@ Gateway=10.42.0.1 At this point, you will not have working DNS, so you will need to add the server you noted down before to `systemd/resolved.conf`. In this example, the gateway address is 10.42.0.1. -[,bash] +[source,console] ---- -sudo nano /etc/systemd/resolved.conf +$ sudo nano /etc/systemd/resolved.conf ---- Uncomment the DNS line and add the DNS IP address there. Additionally, if you have a fallback DNS server, add it there as well. -[,bash] ---- [Resolve] DNS=10.42.0.1 @@ -192,19 +190,19 @@ DNS=10.42.0.1 Enable `systemd-networkd` and then reboot for the changes to take effect: -[,bash] +[source,console] ---- -sudo systemctl enable systemd-networkd -sudo reboot +$ sudo systemctl enable systemd-networkd +$ sudo reboot ---- Now start `tcpdump` so you can search for DHCP packets from the client Raspberry Pi: -[,bash] +[source,console] ---- -sudo apt install tcpdump dnsmasq -sudo systemctl enable dnsmasq -sudo tcpdump -i eth0 port bootpc +$ sudo apt install tcpdump dnsmasq +$ sudo systemctl enable dnsmasq +$ sudo tcpdump -i eth0 port bootpc ---- Connect the client Raspberry Pi to your network and power it on. Check that the LEDs illuminate on the client after around 10 seconds, then you should get a packet from the client "DHCP/BOOTP, Request from ..." @@ -215,10 +213,10 @@ IP 0.0.0.0.bootpc > 255.255.255.255.bootps: BOOTP/DHCP, Request from b8:27:eb... Now you need to modify the `dnsmasq` configuration to enable DHCP to reply to the device. Press ++++++CTRL + C++++++ to exit the `tcpdump` program, then type the following: -[,bash] +[source,console] ---- -echo | sudo tee /etc/dnsmasq.conf -sudo nano /etc/dnsmasq.conf +$ echo | sudo tee /etc/dnsmasq.conf +$ sudo nano /etc/dnsmasq.conf ---- Then replace the contents of `dnsmasq.conf` with: @@ -237,19 +235,19 @@ Where the first address of the `dhcp-range` line is, use the broadcast address y Now create a `/tftpboot` directory: -[,bash] +[source,console] ---- -sudo mkdir /tftpboot -sudo chmod 777 /tftpboot -sudo systemctl enable dnsmasq.service -sudo systemctl restart dnsmasq.service +$ sudo mkdir /tftpboot +$ sudo chmod 777 /tftpboot +$ sudo systemctl enable dnsmasq.service +$ sudo systemctl restart dnsmasq.service ---- Now monitor the `dnsmasq` log: -[,bash] +[source,console] ---- -journalctl -f +$ journalctl -f ---- You should see something like this: @@ -260,18 +258,18 @@ raspberrypi dnsmasq-tftp[1903]: file /tftpboot/bootcode.bin not found Next, you will need to copy the contents of the boot folder into the `/tftpboot` directory. -First, press ++++++CTRL + C++++++ to exit the monitoring state. Then type the following: +First, press *CTRL + C* to exit the monitoring state. Then type the following: -[,bash] +[source,console] ---- -cp -r /boot/firmware/* /tftpboot +$ cp -r /boot/firmware/* /tftpboot ---- Since the tftp location has changed, restart `dnsmasq`: -[,bash] +[source,console] ---- -sudo systemctl restart dnsmasq +$ sudo systemctl restart dnsmasq ---- ==== Set up NFS root @@ -280,21 +278,21 @@ This should now allow your Raspberry Pi client to attempt to boot through until At this point, export the `/nfs/client1` file system created earlier, and the TFTP boot folder. -[,bash] +[source,console] ---- -sudo apt install nfs-kernel-server -echo "/nfs/client1 *(rw,sync,no_subtree_check,no_root_squash)" | sudo tee -a /etc/exports -echo "/tftpboot *(rw,sync,no_subtree_check,no_root_squash)" | sudo tee -a /etc/exports +$ sudo apt install nfs-kernel-server +$ echo "/nfs/client1 *(rw,sync,no_subtree_check,no_root_squash)" | sudo tee -a /etc/exports +$ echo "/tftpboot *(rw,sync,no_subtree_check,no_root_squash)" | sudo tee -a /etc/exports ---- Restart RPC-Bind and the NFS server in order to have them detect the new files. -[,bash] +[source,console] ---- -sudo systemctl enable rpcbind -sudo systemctl restart rpcbind -sudo systemctl enable nfs-kernel-server -sudo systemctl restart nfs-kernel-server +$ sudo systemctl enable rpcbind +$ sudo systemctl restart rpcbind +$ sudo systemctl enable nfs-kernel-server +$ sudo systemctl restart nfs-kernel-server ---- Edit `/tftpboot/cmdline.txt` and from `root=` onwards, and replace it with: @@ -307,9 +305,9 @@ You should substitute the IP address here with the IP address you have noted dow Finally, edit `/nfs/client1/etc/fstab` and remove the `/dev/mmcblk0p1` and `p2` lines (only `proc` should be left). Then, add the boot partition back in: -[,bash] +[source,console] ---- -echo "10.42.0.211:/tftpboot /boot/firmware/ nfs defaults,vers=3 0 0" | sudo tee -a /nfs/client1/etc/fstab +$ echo "10.42.0.211:/tftpboot /boot/firmware/ nfs defaults,vers=3 0 0" | sudo tee -a /nfs/client1/etc/fstab ---- -Good luck! If it doesn't boot on the first attempt, keep trying. It can take a minute or so for the Raspberry Pi to boot, so be patient. +If it doesn't boot on the first attempt, keep trying. It can take a minute or so for the Raspberry Pi to boot, so be patient. diff --git a/documentation/asciidoc/computers/remote-access/nfs.adoc b/documentation/asciidoc/computers/remote-access/nfs.adoc index c6d8f5d22..5db9c843c 100644 --- a/documentation/asciidoc/computers/remote-access/nfs.adoc +++ b/documentation/asciidoc/computers/remote-access/nfs.adoc @@ -1,39 +1,49 @@ +[[nfs]] == Network File System (NFS) Network File System (NFS) allows you to share a directory located on one networked computer with other computers or devices on the same network. The computer where the directory is located is called the *server*, and computers or devices connecting to that server are called clients. Clients usually `mount` the shared directory to make it a part of their own directory structure. The shared directory is an example of a shared resource or network share. -For smaller networks, an NFS is perfect for creating a simple NAS (Network-attached storage) in a Linux/Unix environment. +NFS is a popular way to create a simple NAS (Network-attached storage) in a Linux/Unix environment. -An NFS is perhaps best suited to more permanent network-mounted directories, such as `/home` directories or regularly-accessed shared resources. If you want a network share that guest users can easily connect to, Samba is better suited to the task. This is because tools to temporarily mount and detach from Samba shares are more readily available across old and proprietary operating systems. +An NFS is perhaps best suited to more permanent network-mounted directories, such as `/home` directories or regularly-accessed shared resources. If you want a network share that guest users can easily connect to, Samba is better suited to the task. Tools to temporarily mount and detach from Samba shares are more readily available across operating systems. Before deploying an NFS, you should be familiar with: * Linux file and directory permissions * mounting and unmounting filesystems -=== Setting up a Basic NFS Server +=== Set up a basic NFS server Install the packages required using the command below: -[,bash] +[source,console] ---- -sudo apt install nfs-kernel-server +$ sudo apt install nfs-kernel-server ---- For easier maintenance, we will isolate all NFS exports in single directory, into which the real directories will be mounted with the `--bind` option. Suppose we want to export our users' home directories, which are in `/home/users`. First we create the export filesystem: -[,bash] +[source,console] ---- -sudo mkdir -p /export/users +$ sudo mkdir -p /export/users ---- -Note that `/export` and `/export/users` will need 777 permissions, as we will be accessing the NFS share from the client without LDAP/NIS authentication. This will not apply if using authentication (see below). Now mount the real `users` directory with: +TIP: If you plan to configure LDAP/NIS authentication, skip the `chmod` step below. -[,bash] +Grant `/export` and `/export/users` read, write, and execute permissions (`777`) so you can access the NFS share from the client without LDAP/NIS authentication: + +[source,console] +---- +$ chmod -R 777 /export +---- + +Next, mount the real `users` directory with: + +[source,console] ---- -sudo mount --bind /home/users /export/users +$ sudo mount --bind /home/users /export/users ---- To save us from retyping this after every reboot, we add the following line to `/etc/fstab`: @@ -61,10 +71,10 @@ Nobody-Group = nogroup However, note that the client may have different requirements for the Nobody-User and Nobody-Group. For example, on RedHat variants, it is `nfsnobody` for both. If you're not sure, check via the following commands to see if `nobody` and `nogroup` are there: -[,bash] +[source,console] ---- -cat /etc/passwd -cat /etc/group +$ cat /etc/passwd +$ cat /etc/group ---- This way, server and client do not need the users to share same UID/GUID. For those who use LDAP-based authentication, add the following lines to the `idmapd.conf` of your clients: @@ -77,7 +87,7 @@ Method = nsswitch This will cause `idmapd` to know to look at `nsswitch.conf` to determine where it should look for credential information. If you have LDAP authentication already working, `nsswitch` shouldn't require further explanation. -To export our directories to a local network `192.168.1.0/24`, we add the following two lines to `/etc/exports`: +To export our directories to a local network `192.168.1.0/24`, add the following two lines to `/etc/exports`: ---- /export 192.168.1.0/24(rw,fsid=0,insecure,no_subtree_check,async) @@ -108,25 +118,25 @@ Please ensure that the list of authorised IP addresses includes the `localhost` Finally, to make your changes take effect, restart the service: -[,bash] +[source,console] ---- -sudo systemctl restart nfs-kernel-server +$ sudo systemctl restart nfs-kernel-server ---- -=== Configuring an NFS Client +=== Configure an NFS client Now that your server is running, you need to set up any clients to be able to access it. To start, install the required packages: -[,bash] +[source,console] ---- -sudo apt install nfs-common +$ sudo apt install nfs-common ---- On the client, we can mount the complete export tree with one command: -[,bash] +[source,console] ---- -mount -t nfs -o proto=tcp,port=2049 :/ /mnt +$ mount -t nfs -o proto=tcp,port=2049 :/ /mnt ---- You can also specify the NFS server hostname instead of its IP address, but in this case you need to ensure that the hostname can be resolved to an IP on the client side. A robust way of ensuring that this will always resolve is to use the `/etc/hosts` file. @@ -135,9 +145,9 @@ Note that `:/export` is not necessary in NFSv4, as it was in NFSv We can also mount an exported subtree with: -[,bash] +[source,console] ---- -mount -t nfs -o proto=tcp,port=2049 :/users /home/users +$ mount -t nfs -o proto=tcp,port=2049 :/users /home/users ---- To ensure this is mounted on every reboot, add the following line to `/etc/fstab`: @@ -166,7 +176,7 @@ rpcbind : where `` is the IP address of the server. -=== A More Complex NFS Server +=== Configure a complex NFS server NFS user permissions are based on user ID (UID). UIDs of any users on the client must match those on the server in order for the users to have access. The typical ways of doing this are: @@ -199,9 +209,9 @@ where `myclients` is the netgroup name. Next run this command to rebuild the NIS database: -[,bash] +[source,console] ---- -sudo make -C /var/yp +$ sudo make -C /var/yp ---- The filename `yp` refers to Yellow Pages, the former name of NIS. @@ -228,9 +238,9 @@ where `` is a list of the IP addresses of the server and all client Install the necessary packages: -[,bash] +[source,console] ---- -sudo apt install rpcbind nfs-kernel-server +$ sudo apt install rpcbind nfs-kernel-server ---- Edit `/etc/exports` and add the shares: @@ -258,22 +268,21 @@ Here, `rw` makes the share read/write, and `sync` requires the server to only re After setting up `/etc/exports`, export the shares: -[,bash] +[source,console] ---- -sudo exportfs -ra +$ sudo exportfs -ra ---- You'll want to run this command whenever `/etc/exports` is modified. ==== Restart services +Restart `rpcbind` and NFS for the changes to take effect: -If any changes are made, rpcbind and NFS will need to be restarted: - -[,bash] +[source,console] ---- -sudo systemctl restart rpcbind -sudo systemctl restart nfs-kernel-server +$ sudo systemctl restart rpcbind +$ sudo systemctl restart nfs-kernel-server ---- ==== Security items to consider @@ -290,10 +299,10 @@ Mounting an NFS share inside an encrypted home directory will only work after yo . Create an alternative directory to mount the NFS shares in: -[,bash] +[source,console] ---- -sudo mkdir /nfs -sudo mkdir /nfs/music +$ sudo mkdir /nfs +$ sudo mkdir /nfs/music ---- . Edit `/etc/fstab` to mount the NFS share into that directory instead: @@ -304,8 +313,8 @@ nfsServer:music /nfs/music nfs auto 0 0 . Create a symbolic link inside your home, pointing to the actual mount location. For example, and in this case deleting the `Music` directory already existing there first: -[,bash] +[source,console] ---- -rmdir /home/user/Music -ln -s /nfs/music/ /home/user/Music +$ rmdir /home/user/Music +$ ln -s /nfs/music/ /home/user/Music ---- diff --git a/documentation/asciidoc/computers/remote-access/raspberry-pi-connect.adoc b/documentation/asciidoc/computers/remote-access/raspberry-pi-connect.adoc new file mode 100644 index 000000000..cf720a74d --- /dev/null +++ b/documentation/asciidoc/computers/remote-access/raspberry-pi-connect.adoc @@ -0,0 +1,8 @@ +[[raspberry-pi-connect]] +== Remote access with Raspberry Pi Connect + +You can access a Raspberry Pi remotely from a browser on another device using Raspberry Pi Connect. Connect handles configuration automatically, so you don't have to find your Raspberry Pi's local IP address, your network's public IP address, or modify your local network firewall to enable external access. + +Connect includes the ability to screen share on Raspberry Pi models running the Wayland window server and remote shell (terminal) access on all Raspberry Pi models. + +For more information, see xref:../services/connect.adoc[the Connect documentation]. diff --git a/documentation/asciidoc/computers/remote-access/remote-access-introduction.adoc b/documentation/asciidoc/computers/remote-access/remote-access-introduction.adoc deleted file mode 100644 index 31cb02978..000000000 --- a/documentation/asciidoc/computers/remote-access/remote-access-introduction.adoc +++ /dev/null @@ -1,7 +0,0 @@ -== Introduction to remote access - -Sometimes you need to access a Raspberry Pi without connecting it to a monitor. Perhaps the Raspberry Pi is embedded in something like a robot, or you want to view some information from it from elsewhere. Or perhaps you simply don't have a spare monitor! - -You can connect to your Raspberry Pi from another machine. But in order to do so you'll need to know its IP address. - -Any device connected to a Local Area Network is assigned an IP address. In order to connect to your Raspberry Pi from another machine using xref:remote-access.adoc#ssh[SSH] or xref:remote-access.adoc#vnc[VNC], you need to know the Raspberry Pi's IP address. This is easy if you have a display connected, and there are a number of methods for finding it remotely from another machine on the network. diff --git a/documentation/asciidoc/computers/remote-access/rsync.adoc b/documentation/asciidoc/computers/remote-access/rsync.adoc index cabccee5d..d7330cecb 100644 --- a/documentation/asciidoc/computers/remote-access/rsync.adoc +++ b/documentation/asciidoc/computers/remote-access/rsync.adoc @@ -1,23 +1,28 @@ -== Using `rsync` +[[rsync]] +== Synchronise folders between computers with `rsync` -You can use the tool `rsync` to synchronise folders between computers. You might want to transfer some files from your desktop computer or laptop to your Raspberry Pi, for example, and for them to be kept up to date, or you might want the pictures taken by your Raspberry Pi transferred to your computer automatically. +You can use `rsync` to synchronise folders between computers. For example, you could use `rsync` to transfer new pictures taken by your Raspberry Pi to your personal computer automatically. -Using `rsync` over SSH allows you to transfer files to your computer automatically. +Before you can configure `rsync`, determine values for the following: -Here is an example of how to set up the sync of a folder of pictures on your Raspberry Pi to your computer: +* ``: your Raspberry Pi's local IP address: see xref:remote-access.adoc#ip-address[Find your Raspberry Pi's IP address] for more information +* ``: the username you use to log into your Raspberry Pi +* ``: the name of the folder you want to copy files from on your Raspberry Pi +* ``: the name of the folder you would like to synchronise on your personal computer -On your computer, create a folder called `camera`: +To configure `rsync` to synchronise files, complete the following steps on your personal computer, replacing placeholders in the commands with the values you determined above: +. Create the folder you would like to synchronise to: ++ +[source,console] ---- -mkdir camera +$ mkdir ---- - -Look up the Raspberry Pi's IP address by logging in to it and running `hostname -I`. In this example, the Raspberry Pi is creating a timelapse by capturing a photo every minute, and saving the picture with a timestamp in the local folder `camera` on its SD card. - -Now run the following command (substituting your own Raspberry Pi's IP address): - +. Synchronise files to the folder with `rsync`: ++ +[source,console] ---- -rsync -avz -e ssh pi@192.168.1.10:camera/ camera/ +$ rsync -avz -e ssh @:/ / ---- -This will copy all files from the Raspberry Pi's `camera` folder to your computer's new `camera` folder. +This command copies all files from the selected folder on your Raspberry Pi to the selected folder on your personal computer. If you run the command multiple times, `rsync` keeps track of the files you have already downloaded and skips them. If you delete or modify an already synchronised file on the Raspberry Pi, `rsync` updates the files on your personal computer accordingly. diff --git a/documentation/asciidoc/computers/remote-access/samba.adoc b/documentation/asciidoc/computers/remote-access/samba.adoc index bdf51d566..8735264cb 100644 --- a/documentation/asciidoc/computers/remote-access/samba.adoc +++ b/documentation/asciidoc/computers/remote-access/samba.adoc @@ -1,88 +1,91 @@ +[[samba]] == Samba (SMB/CIFS) -Samba is an implementation of the SMB/CIFS networking protocol that is used by Microsoft Windows devices to provide shared access to files, printers, and serial ports. +Samba is a free software reimplementation of the https://en.wikipedia.org/wiki/Server_Message_Block[Server Message Block] (SMB) networking protocol. With Samba, you can share folders between Windows, macOS, and Linux machines. -You can use Samba to mount a folder shared from a Windows machine so it appears on your Raspberry Pi, or to share a folder from your Raspberry Pi so it can be accessed by your Windows machine. +=== Install Samba on your Raspberry Pi -=== Installing Samba Support +By default, Raspberry Pi OS does not include Samba. To install Samba on your Raspberry Pi, run the following command, which installs all the dependencies you need to run a Samba server or client: -By default, Raspberry Pi OS does not include CIFS/Samba support, but this can be added. The following commands will install all the required components for using Samba as a server or a client. - -[,bash] +[source,console] ---- -sudo apt update -sudo apt install samba samba-common-bin smbclient cifs-utils +$ sudo apt update +$ sudo apt install samba samba-common-bin smbclient cifs-utils ---- -=== Mount a Folder Shared from Windows +=== Mount a folder shared from Windows -First, you need to share a folder on your Windows device. This is quite a convoluted process! +First, you need to share a folder on your Windows device. ==== Turn on sharing -. Open the Networking and Sharing Centre by right-clicking on the system tray and selecting it -. Click on *Change advanced sharing settings* -. Select *Turn on network discovery* -. Select *Turn on file and printer sharing* -. Save changes +. Right click the system tray and select *Networking and Sharing Centre* from the menu. +. Select *Change advanced sharing settings*. +. Select *Turn on network discovery*. +. Select *Turn on file and printer sharing*. +. Click the *Save* button to save your changes. ==== Share the folder -You can share any folder you want, but for this example, simply create a folder called `share`. +Follow these steps to share a folder from Windows: -. Create the folder `share` on your desktop. -. Right-click on the new folder, and select *Properties*. -. Click on the *Sharing* tab, and then the *Advanced Sharing* button -. Select *Share this folder*; by default, the share name is the name of the folder -. Click on the *Permissions* button -. For this example, select *Everyone* and *Full Control* (you can limit access to specific users if required); click *OK* when done, then *OK* again to leave the *Advanced Sharing* page -. Click on the *Security* tab, as we now need to configure the same permissions -. Select the same settings as the *Permissions* tab, adding the chosen user if necessary -. Click *OK* +. Right click the folder you want to share and select *Properties*. +. Select the *Sharing* tab. +. Click the *Advanced Sharing* button. +. Select *Share this folder*; by default, Windows uses the folder name as the share name. +. Click the *Permissions* button. +. Configure the *Everyone* and *Full Control* permissions. +. Click the *OK* button to leave the *Permissions* page. +. Click the *OK* button again to leave the *Advanced Sharing* page. +. Select the *Security* tab. +. Configure the *Everyone* and *Full Control* permissions. +. Click the *OK* button. -The folder should now be shared. +The folder should now be shared. You can modify shared folder permissions by changing permissions on both the *Permissions* and *Security* pages. ==== Windows 10 Sharing Wizard On Windows 10 there is a Sharing Wizard that helps with some of these steps. -. Run the Computer Management application from the Start Bar -. Select *Shared Folders*, then *Shares* -. Right-click and select *New Share*, which will start up the Sharing Wizard; click *Next* -. Select the folder you wish to share, and click *Next* -. Click *Next* to use all the sharing defaults -. Select *Custom* and set the required permissions, and click *OK*, then *Finish* +. Run the *Computer Management* application from the Start Bar. +. Select *Shared Folders* > *Shares*. +. Right click and select *New Share* to begin the Sharing Wizard. +. Click the *Next* button. +. Select the folder you wish to share, then click the *Next* button. +. Click *Next* to use the sharing defaults or select *Custom* and set the required permissions. +. Click the *OK* button. +. Click the *Finish* button to share the folder. ==== Mount the folder on the Raspberry Pi *Mounting* in Linux is the process of attaching a folder to a location, so firstly we need that location. -[,bash] +[source,console] ---- -mkdir windowshare +$ mkdir windowshare ---- -Now, we need to mount the remote folder to that location. The remote folder is the host name or IP address of the Windows PC, and the share name used when sharing it. We also need to provide the Windows username that will be used to access the remote machine. +Now, we need to mount the remote folder to that location. The remote folder is the host name or IP address of the Windows PC, and the share name used when sharing it. We also need to provide the Windows username that will be used to access the remote machine. Don't forget to replace the `` placeholder with your Raspberry Pi OS username. -[,bash] +[source,console] ---- -sudo mount.cifs ///share /home/pi/windowshare -o user= +$ sudo mount.cifs /// /home//windowshare -o user= ---- You should now be able to view the content of the Windows share on your Raspberry Pi. -[,bash] +[source,console] ---- -cd windowshare -ls +$ ls windowshare/ ---- ==== "Host is down" error -This error is caused by a combination of two things: A SMB protocol version mismatch, and the CIFS client on Linux returning a misleading error message. In order to fix this a version entry needs to be added to the mount command. By default Raspberry Pi OS will only use versions 2.1 and above, which are compatible with Windows 7 and later. Older devices, including some NAS, may require version 1.0: +This error occurs when SMB protocol version do not match and the Linux Samba client returns a misleading error message. By default Raspberry Pi OS uses versions 2.1 and above, compatible with Windows 7 and later. Older devices, including some NAS, may require version 1.0. To fix this error, append a version entry (e.g. `,vers=1.0`) to your mount command: +[source,console] ---- -sudo mount.cifs //IP/share /mnt/point -o user=,vers=1.0 +$ sudo mount.cifs //IP/share /mnt/point -o user=,vers=1.0 ---- You may need to try different versions to match up with the server version. Possible values are: @@ -137,7 +140,7 @@ Now we need to tell Samba to share this folder, using the Samba configuration fi sudo nano /etc/samba/smb.conf ---- -At the end of the file, add the following to share the folder, giving the remote user read/write permissions. Replace the `` placeholder with the username of your primary user account: +At the end of the file, add the following to share the folder, giving the remote user read/write permissions. Replace the `` placeholder with the username of the primary user account on your Raspberry Pi: ---- [share] @@ -154,4 +157,4 @@ In the same file, find the `workgroup` line, and if necessary, change it to the workgroup = ---- -That should be enough to share the folder. On your Windows device, when you browse the network, the folder should appear and you should be able to connect to it. +The shared folder should now appear to Windows or macOS devices on the network. Enter your Raspberry Pi username and password to mount the folder. diff --git a/documentation/asciidoc/computers/remote-access/scp.adoc b/documentation/asciidoc/computers/remote-access/scp.adoc index 56ce4195d..159d6d7ed 100644 --- a/documentation/asciidoc/computers/remote-access/scp.adoc +++ b/documentation/asciidoc/computers/remote-access/scp.adoc @@ -1,82 +1,81 @@ -== Using Secure Copy +[[scp]] +== Share files with SCP -Secure Copy (`scp`) is a command for sending files over SSH. This means you can copy files between computers, say from your Raspberry Pi to your desktop or laptop, or vice-versa. +Secure Copy Protocol (`scp`) sends files over SSH. You can use `scp` to copy files between your Raspberry Pi and another computer. -First of all, you'll need to know your Raspberry Pi's xref:remote-access.adoc#ip-address[IP address]. +To use `scp`, xref:remote-access.adoc#ip-address[find your Raspberry Pi's IP address]. -=== Copying Files to your Raspberry Pi +=== Copy files to your Raspberry Pi -Copy the file `myfile.txt` from your computer to the `pi` user's home folder of your Raspberry Pi at the IP address `192.168.1.3` with the following command: +To copy a file named `myfile.txt` from your personal computer to a user's home folder on your Raspberry Pi, run the following command from the directory containing `myfile.txt`, replacing the `` placeholder with the username you use to log in to your Raspberry Pi and the `` placeholder with your Raspberry Pi's IP address: -[,bash] +[source,console] ---- -scp myfile.txt pi@192.168.1.3: +$ scp myfile.txt @: ---- -Copy the file to the `/home/pi/project/` directory on your Raspberry Pi (the `project` folder must already exist): +To copy a file to a specific directory, append the directory path after the `:` in the `scp` command. Create the folder before you run `scp`, since `scp` won't create folders automatically. For instance, the following command copies a file named `myfile.txt` into the `project/` directory within a user's home folder: -[,bash] +[source,console] ---- -scp myfile.txt pi@192.168.1.3:project/ +$ scp myfile.txt @:project/ ---- -=== Copying Files from your Raspberry Pi +=== Copy files from your Raspberry Pi -Copy the file `myfile.txt` from your Raspberry Pi to the current directory on your other computer: +To copy a file named `myfile.txt` from a user's home directory on a Raspberry Pi to the current directory on another computer, run the following command: -[,bash] +[source,console] ---- -scp pi@192.168.1.3:myfile.txt . +$ scp @:myfile.txt . ---- -=== Copying Multiple Files +=== Copy multiple files with one command -Copy multiple files by separating them with spaces: +To copy multiple files, list the file names in a single command, separated by spaces: -[,bash] +[source,console] ---- -scp myfile.txt myfile2.txt pi@192.168.1.3: +$ scp myfile.txt myfile2.txt @: ---- -Alternatively, use a wildcard to copy all files matching a particular search with: +Alternatively, use a wildcard to copy all files matching a particular filter. The following command copies all files that end with `.txt`: -[,bash] +[source,console] ---- -scp *.txt pi@192.168.1.3: +$ scp *.txt @: ---- -(all files ending in `.txt`) +The following command copies all files that start with `m`: -[,bash] +[source,console] ---- -scp m* pi@192.168.1.3: +$ scp m* @: ---- -(all files starting with `m`) +The following command copies all files that start with `m` and end with `.txt`: -[,bash] +[source,console] ---- -scp m*.txt pi@192.168.1.3: +$ scp m*.txt @: ---- -(all files starting with `m` and ending in `.txt`) - [NOTE] ==== -Some of the examples above will not work for file names containing spaces. Names like this need to be enclosed in quotes: +To copy files with names that contain spaces, enclose the file name in quotes: -[,bash] +[source,console] ---- -scp "my file.txt" pi@192.168.1.3: +$ scp "my file.txt" @: ---- ==== -=== Copying a Whole Directory +=== Copy a folder -Copy the directory `project/` from your computer to the `pi` user's home folder of your Raspberry Pi at the IP address `192.168.1.3` with the following command: +To copy a folder and all of its contents, pass the folder name with the `-r` (recursive) flag: -[,bash] +[source,console] ---- -scp -r project/ pi@192.168.1.3: +$ scp -r project/ @: ---- diff --git a/documentation/asciidoc/computers/remote-access/ssh-client.adoc b/documentation/asciidoc/computers/remote-access/ssh-client.adoc deleted file mode 100644 index 0f63f1c06..000000000 --- a/documentation/asciidoc/computers/remote-access/ssh-client.adoc +++ /dev/null @@ -1,44 +0,0 @@ -== Secure Shell - -You can use SSH to connect to your Raspberry Pi remotely. - -Open a terminal window on your computer and enter the following command, replacing the `` placeholder with the xref:remote-access.adoc#ip-address[IP address of the Raspberry Pi you're trying to connect to] and `` with your username: - -[source,console] ----- -$ ssh @ ----- - -When the connection works, you will see a security warning. Type `yes` to continue. You will only see this warning the first time you connect. - -Enter your account password when prompted. - -You should now see the Raspberry Pi command prompt: - -[source,console] ----- -@ ~ $ ----- - -You are now connected to the Raspberry Pi remotely, and can execute commands. - -NOTE: If you receive a `connection timed out` error, you may have entered the wrong IP address for the Raspberry Pi. Check the xref:remote-access.adoc#ip-address[IP address of the Raspberry Pi]. - -[discrete] -=== Forwarding X11 - -NOTE: X11 is no longer installed by default on many desktop environments. Install a third-party X server such as https://www.xquartz.org/[XQuartz] to use X11 forwarding. - -X11 enables graphical applications over SSH. Pass the `-Y` flag to forward an X session over SSH: - -[source,console] ----- -$ ssh -Y @ ----- - -Once authenticated, you will see the command line as usual. However, you can also open graphical windows that an X server can render for you. For example, type the following command to launch a https://www.geany.org/[Geany] window: - -[source,console] ----- -$ geany & ----- diff --git a/documentation/asciidoc/computers/remote-access/ssh-passwordless.adoc b/documentation/asciidoc/computers/remote-access/ssh-passwordless.adoc deleted file mode 100644 index 9ff26c2a9..000000000 --- a/documentation/asciidoc/computers/remote-access/ssh-passwordless.adoc +++ /dev/null @@ -1,92 +0,0 @@ -== Configure SSH without a password - -To remotely access your Raspberry Pi without providing a password each time you connect, use an SSH keypair. - -=== Preconfigure a boot image with Raspberry Pi Imager - -When configuring a boot image with Raspberry Pi Imager, you can preconfigure SSH keys. You can use a new SSH keypair or an existing SSH key. - -Follow the xref:getting-started.adoc#raspberry-pi-imager[install using Imager] guide to configure your boot image. During the OS Customisation step, navigate to the Services tab and select the *Enable SSH* checkbox. Select the *Allow public-key authentication only* radio button. - -If you already have an SSH public key stored in `~/.ssh/id_rsa.pub`, Imager will automatically use that public key to prefill the text box. If Imager doesn't find an SSH public key, you can click the *RUN SSH-KEYGEN* button to generate a new keypair. - -=== Manually configure an SSH key - -If you already have an installation of Raspberry Pi OS, you can update your existing configuration to use SSH key authentication. - -==== Set up SSH on your Raspberry Pi - -First, xref:remote-access.adoc#ssh[set up an SSH server] on your Raspberry Pi. - -==== Check for existing SSH public keys - -Next, check for an existing SSH public key on the computer you use to remotely connect to the Raspberry Pi: - -[source,console] ----- -$ ls ~/.ssh ----- - -If you see files named `id_ed25519.pub`, `id_rsa.pub`, or `id_dsa.pub`, you already have an SSH key. Skip SSH keypair generation and proceed to xref:remote-access.adoc#add-ssh-key-identity[add the SSH key to your list of SSH identities]. - -==== Generate new SSH keypair - -To generate a new SSH keypair, enter the following command: - -[source,console] ----- -$ ssh-keygen ----- - -When asked where to save the key, press *Enter* to use the default location, `~/.ssh/id_rsa`. - - -When asked for an optional keyphrase, press *Enter* to use no keyphrase. - -Run the following command to check the contents of the `.ssh` directory: - -[source,console] ----- -$ ls ~/.ssh ----- - -You should see the files `id_rsa` and `id_rsa.pub`: - ----- -authorized_keys id_rsa id_rsa.pub known_hosts ----- - -The `id_rsa` file contains your private key. Keep this secure on the computer you use to remotely connect to the Raspberry Pi. - -The `id_rsa.pub` file contains your public key. You will share this key with your Raspberry Pi. When you connect with the Raspberry Pi remotely, it will use this key to verify your identity. - -[[add-ssh-key-identity]] -==== Add the SSH key to your list of SSH identities - -Start the SSH agent: - -[source,console] ----- -$ eval "$(ssh-agent -s)" ----- - -Next, add your key identities to `ssh-agent` with the following command: - -[source,console] ----- -ssh-add ~/.ssh/id_rsa ----- - -[[copy-your-public-key-to-your-raspberry-pi]] -==== Copy the public key to your Raspberry Pi - -On the computer you use to remotely connect to the Raspberry Pi, use the following command to securely copy your public key to the Raspberry Pi: - -[source,console] ----- -ssh-copy-id @ ----- - -When prompted, enter the password for your user account on the Raspberry Pi. - -Finally, connect to your Raspberry Pi via SSH. You should now connect without entering a password. diff --git a/documentation/asciidoc/computers/remote-access/ssh-server.adoc b/documentation/asciidoc/computers/remote-access/ssh-server.adoc deleted file mode 100644 index 9e62f0f0b..000000000 --- a/documentation/asciidoc/computers/remote-access/ssh-server.adoc +++ /dev/null @@ -1,36 +0,0 @@ -[[ssh]] -== Set up an SSH server - -You can access the command line of a Raspberry Pi remotely from another computer or device on the same network using the Secure Shell (SSH) protocol. - -SSH provides access to the command line, not a desktop environment. For a full remote desktop, configure xref:remote-access.adoc#vnc[VNC]. - -=== Set up your local network - -You can connect your Raspberry Pi to the network using a wired or wireless connection. -Configure your connection using the desktop, command line, or by plugging your Raspberry Pi directly into your router. - -=== Enable the SSH server - -By default, Raspberry Pi OS disables the SSH server. Enable SSH in one of the following ways: - -==== On the desktop - -* From the *Preferences* menu, launch *Raspberry Pi Configuration* -* Navigate to the *Interfaces* tab -* Select *Enabled* next to *SSH* -* Click *OK* - -==== From the terminal - -* Enter `sudo raspi-config` in a terminal window -* Select `Interfacing Options` -* Navigate to and select `SSH` -* Choose `Yes` -* Select `Ok` -* Choose `Finish` - -==== Manually - -* Create an empty `ssh` file in the boot partition: `sudo touch /boot/firmware/ssh` -* Reboot the machine: `sudo reboot` diff --git a/documentation/asciidoc/computers/remote-access/ssh.adoc b/documentation/asciidoc/computers/remote-access/ssh.adoc new file mode 100644 index 000000000..c6861b784 --- /dev/null +++ b/documentation/asciidoc/computers/remote-access/ssh.adoc @@ -0,0 +1,222 @@ +[[ssh]] +== Access a remote terminal with SSH + +You can access the terminal of a Raspberry Pi remotely from another computer on the same network using the **S**ecure **SH**ell (SSH) protocol. + +=== Enable the SSH server + +By default, Raspberry Pi OS disables the SSH server. Enable SSH in one of the following ways: + +[tabs] +====== +On the desktop:: ++ +. From the *Preferences* menu, launch *Control Centre*. +. Navigate to the *Interfaces* tab. +. Select *Enabled* next to *SSH*. +. Click *OK*. + +While flashing a fresh OS image:: ++ +To configure SSH on a completely new installation of Raspberry Pi OS: ++ +. Follow the instructions in the xref:../computers/getting-started.adoc#raspberry-pi-imager[Install with Imager] guide. +. During the **OS Customisation** step, navigate to the **Services** tab. +. Tick the checkbox to **Enable SSH**. +. Select **password authentication** to log in using the same username and password you use while physically using your Raspberry Pi. Select **Allow public-key authentication only** to xref:remote-access.adoc#configure-ssh-without-a-password[configure an SSH key] for passwordless login. + +From the terminal:: ++ +. Enter `sudo raspi-config` in a terminal window. +. Select `Interfacing Options`. +. Navigate to and select `SSH`. +. Choose `Yes`. +. Select `Ok`. +. Choose `Finish`. + +Manually:: ++ +. Create an empty file named `ssh` in the boot partition: ++ +[source,console] +---- +$ sudo touch /boot/firmware/ssh +---- +. Reboot the machine: ++ +[source,console] +---- +$ sudo reboot +---- +====== + +=== Connect to an SSH server + +Open a terminal window on your computer and enter the following command, replacing the `` placeholder with the xref:remote-access.adoc#ip-address[IP address of the Raspberry Pi you're trying to connect to] and `` with your username: + +[source,console] +---- +$ ssh @ +---- + +When the connection works, you will see a security warning. Type `yes` to continue. You will only see this warning the first time you connect. + +Enter your account password when prompted. + +You should now see the Raspberry Pi command prompt: + +[source,console?prompt=@ ~ $] +---- +@ ~ $ +---- + +You are now connected to the Raspberry Pi remotely, and can execute commands. + +NOTE: If you receive a `connection timed out` error, you may have entered the wrong IP address for the Raspberry Pi. Check the xref:remote-access.adoc#ip-address[IP address of the Raspberry Pi]. + +==== Forward X11 over SSH + +NOTE: Raspberry Pi OS uses the Wayland window server by default. You can only forward X11 if you use the X window server. To enable window forwarding over X11, switch your desktop to the X window server in Control Centre or the Raspberry Pi configuration CLI. + +NOTE: X11 is no longer installed by default on many desktop environments. Install a third-party X server such as https://www.xquartz.org/[XQuartz] to use X11 forwarding. + +X11 enables graphical applications over SSH. Pass the `-Y` flag to forward an X session over SSH: + +[source,console] +---- +$ ssh -Y @ +---- + +Once authenticated, you will see the command line as usual. However, you can also open graphical windows that an X server can render for you. For example, type the following command to launch a https://www.geany.org/[Geany] window: + +[source,console] +---- +$ geany & +---- + +=== Configure SSH without a password + +To remotely access your Raspberry Pi without providing a password each time you connect, use an SSH keypair. + +==== Preconfigure an OS image with Raspberry Pi Imager + +When configuring a boot image with Raspberry Pi Imager, you can preconfigure SSH keys. You can generate a new SSH keypair or an existing SSH key. + +. Follow the xref:getting-started.adoc#raspberry-pi-imager[install using Imager] guide to configure your boot image. +. During the *OS Customisation* step, navigate to the *Services* tab and tick the *Enable SSH* checkbox. +. Select the *Allow public-key authentication only* radio button. If you already have an SSH public key stored in `~/.ssh/id_rsa.pub`, Imager automatically uses that public key to prefill the text box. If Imager doesn't find an SSH public key, you can click the *RUN SSH-KEYGEN* button to generate a new keypair. + +==== Manually configure an SSH key + +If you already have an installation of Raspberry Pi OS, you can update your existing configuration to use SSH key authentication. + +==== Check for existing SSH public keys + +To check for an existing SSH public key on the computer you use to remotely connect to the Raspberry Pi, run the following command: + +[source,console] +---- +$ ls ~/.ssh +---- + +If you see files named `id_ed25519.pub`, `id_rsa.pub`, or `id_dsa.pub`, you already have an SSH key. Skip SSH keypair generation and proceed to xref:remote-access.adoc#add-ssh-key-identity[add the SSH key to your list of SSH identities]. + +==== Generate new SSH keypair + +TIP: This guide provides instructions to generate a new RSA key. For additional security, you can instead generate a http://ed25519.cr.yp.to/[Ed25519] key. Pass `-t ed25519` to `ssh-keygen` and replace `rsa` with `ed25519` when referencing your public and private key file names to use an Ed25519 key. + +To generate a new SSH keypair, enter the following command: + +[source,console] +---- +$ ssh-keygen +---- + +When asked where to save the key, press *Enter* to use the default location, `~/.ssh/id_rsa`. + +When asked for an optional keyphrase, press *Enter* to use no keyphrase. + +Run the following command to check the contents of the `.ssh` directory: + +[source,console] +---- +$ ls ~/.ssh +---- + +You should see the files `id_rsa` and `id_rsa.pub`: + +---- +authorized_keys id_rsa id_rsa.pub known_hosts +---- + +The `id_rsa` file contains your private key. Keep this secure on the computer you use to remotely connect to the Raspberry Pi. + +The `id_rsa.pub` file contains your public key. You will share this key with your Raspberry Pi. When you connect with the Raspberry Pi remotely, it will use this key to verify your identity. + +[[add-ssh-key-identity]] +==== Add the SSH key to your list of SSH identities + +Start the SSH agent: + +[source,console] +---- +$ eval "$(ssh-agent -s)" +---- + +Next, add your key identities to `ssh-agent` with the following command: + +[source,console] +---- +$ ssh-add ~/.ssh/id_rsa +---- + +[[copy-your-public-key-to-your-raspberry-pi]] +==== Copy a public key to your Raspberry Pi + +On the computer you use to remotely connect to the Raspberry Pi, use the following command to securely copy your public key to the Raspberry Pi: + +[source,console] +---- +$ ssh-copy-id @ +---- + +When prompted, enter the password for your user account on the Raspberry Pi. +You can now connect to your Raspberry Pi without entering a password. + +==== Manually copy a public key to your Raspberry Pi + +If your operating system does not support `ssh-copy-id`, you can instead copy your public key with xref:remote-access.adoc#scp[`scp`]. + +First, _on your Raspberry Pi_, create the directory where Linux expects to find keys: + +[source,console] +---- +$ mkdir .ssh +---- + +Then, configure the proper permissions for the `.ssh` directory: + +[source,console] +---- +$ chmod 700 .ssh +---- + +_On your usual computer_, use `scp` to copy your public key to a file named `.ssh/authorized_keys` on your Raspberry Pi: + +[source,console] +---- +$ scp .ssh/id_rsa.pub @:.ssh/authorized_keys +---- + +TIP: The command above assumes you have never before authorized any keys to access your Raspberry Pi. If you have previously added at least one key, you should instead add a new line containing the public key to the end of the `authorized_keys` file to preserve your existing keys. + +When prompted, enter the password for your user account on the Raspberry Pi. + +Then, _on your Raspberry Pi_, configure permissions for the `authorized_keys` file: + +[source,console] +---- +$ chmod 644 .ssh/authorized_keys +---- + +You can now connect to your Raspberry Pi without entering a password. diff --git a/documentation/asciidoc/computers/remote-access/vnc.adoc b/documentation/asciidoc/computers/remote-access/vnc.adoc index dbef6aa61..a482e3178 100644 --- a/documentation/asciidoc/computers/remote-access/vnc.adoc +++ b/documentation/asciidoc/computers/remote-access/vnc.adoc @@ -1,5 +1,5 @@ [[vnc]] -== Virtual Network Computing (VNC) +== Screen share with VNC Sometimes it is not convenient to physically work with a device. Virtual Network Computing (VNC) allows you to control the desktop of one device from another. @@ -12,88 +12,84 @@ Raspberry Pi OS includes https://github.com/any1/wayvnc[wayvnc]. This provides a Before you can use VNC on your Raspberry Pi, you must enable the VNC server. -NOTE: Previous versions of Raspberry Pi OS supported client connections from RealVNC. In Raspberry Pi OS _Bookworm_ or later, RealVNC is no longer supported. Instead, you can connect using TigerVNC. - === Enable the VNC server Raspberry Pi OS supports enabling the VNC server both graphically and at the command line. -TIP: Once enabled, you can access your WayVNC configuration at `~/.config/wayvnc/`. +TIP: Once enabled, you can access your WayVNC configuration at `/etc/wayvnc/`. ==== Enable VNC Server Graphically -1. Boot into the graphical desktop on your Raspberry Pi. -2. Click the Raspberry Pi icon in the system tray of your desktop. -3. Select *Preferences* > *Raspberry Pi Configuration* from the menu. +. Boot into the graphical desktop on your Raspberry Pi. +. Select the Raspberry Pi icon in the system tray of your desktop. +. Select *Preferences* > *Control Centre* from the menu. + -- -image::images/raspberry-pi-configuration.png[Select Raspberry Pi Configuration from the Preferences menu in the system tray] +image::images/raspberry-pi-configuration.png[alt="Select Control Centre from the Preferences menu in the system tray",width="80%"] -- -4. Navigate to the *Interfaces* tab. -5. Click the radio button next to *VNC* into the active position. +. Navigate to the *Interfaces* tab. +. Toggle the radio button next to *VNC* into the active position. + -- -image::images/vnc-enable.png[In the Interfaces tab, click the VNC toggle into the active position to enable VNC.] +image::images/vnc-enable.png[alt="In the Interfaces tab, click the VNC toggle into the active position to enable VNC.",width="80%"] -- -6. Click the "OK" button to save your configuration changes. +. Select the *OK* button to save your configuration changes. ==== Enable the VNC server on the command line -Use using xref:configuration.adoc#raspi-config[raspi-config] to enable the VNC server on the command line. +Use xref:configuration.adoc#raspi-config[raspi-config] to enable the VNC server on the command line. -1. Open `raspi-config` with the following line: +. Open `raspi-config` with the following line: + --- [source,console] ---- -sudo raspi-config +$ sudo raspi-config ---- --- -2. Navigate to *Interface Options*. Press `Enter` to select. -3. Select *VNC*. Press `Enter` to select. -4. Under "Would you like the VNC Server to be enabled?", highlight `` and press `Enter`. -5. Press `Enter` to return to the menu. Press `Esc` to exit `raspi-config`. +. Navigate to *Interface Options*. Press `Enter` to select. +. Select *VNC*. Press `Enter` to select. +. Under *Would you like the VNC Server to be enabled?*, highlight `` and press `Enter`. +. Press `Enter` to return to the menu. Press `Esc` to exit `raspi-config`. -=== Connect to your Raspberry Pi +=== Connect to a VNC server To connect to your Raspberry Pi, you'll need the following: -* your Raspberry Pi and the device running the VNC client must be connected to the same network (e.g. a home wireless network) -* the IP address of your Raspberry Pi +* your Raspberry Pi and the device running the VNC client, connected to the same network (e.g. a home wireless network or VPN) +* the hostname or IP address of your Raspberry Pi * a valid username and password combination for an account on your Raspberry Pi If you don't know the IP address of your device, see xref:remote-access.adoc#ip-address[our instructions on finding your IP address]. -1. Download https://tigervnc.org/[TigerVNC]. You can install the latest version from the https://github.com/TigerVNC/tigervnc/releases[Releases page of their GitHub repository]. Click on the link in the latest release, and find the binary for your platform. Windows users should download an `exe`; macOS users should download the `dmg`; Linux users should install the `jar`. -2. On your client device, launch TigerVNC. On macOS and Windows, you can double-click the binary. On Linux, install java with `sudo apt install default-jre`, then run `java -jar VncViewer-.jar`, replacing the `` placeholder with the version you downloaded. -3. In the "VNC server" field, enter the IP address of your Raspberry Pi. +. Download https://tigervnc.org/[TigerVNC]. You can install the latest version from the https://github.com/TigerVNC/tigervnc/releases[Releases page of their GitHub repository]. Click on the link in the latest release, and find the binary for your platform. Windows users should download an `exe`; macOS users should download the `dmg`; Linux users should install the `jar`. +. On your client device, launch TigerVNC. On macOS and Windows, you can double-click the binary. On Linux, install java with `sudo apt install default-jre`, then run `java -jar VncViewer-.jar`, replacing the `` placeholder with the version you downloaded. +. In the "VNC server" field, enter the IP address of your Raspberry Pi. + -- -image::images/vnc-tigervnc-enter-ip.png[Entering the Raspberry Pi's local IP address into TigerVNC,400] +image::images/vnc-tigervnc-enter-ip.png[alt="Entering the Raspberry Pi's local IP address into TigerVNC",width="60%"] -- -4. Click the "Options" button. Navigate to the "Input" tab. Check the box next to "Show dot when no cursor" to ensure that you can always see a cursor in TigerVNC. +. Click the "Options" button. Navigate to the "Input" tab. Check the box next to "Show dot when no cursor" to ensure that you can always see a cursor in TigerVNC. + -- -image::images/vnc-tigervnc-show-dot.png[TigerVNC option to render the cursor at all times as a dot,400] +image::images/vnc-tigervnc-show-dot.png[alt="TigerVNC option to render the cursor at all times as a dot",width="60%"] -- -5. Click the "Connect" button to initiate a connection with the server. +. Click the "Connect" button to initiate a connection with the server. * If TigerVNC warns you that the "Hostname does not match the server certificate", click the "Yes" button to continue. + -- -image::images/vnc-tigervnc-cert-warning.png[TigerVNC warning about mismatched certificates,400] +image::images/vnc-tigervnc-cert-warning.png[alt=TigerVNC warning about mismatched certificates",width="60%"] -- * If TigerVNC warns you that the "certificate has been signed by an unknown authority", click the "Yes" button to grant an exception for your Raspberry Pi. + -- -image::images/vnc-tigervnc-cert-signer-warning.png[TigerVNC warning about certificates signed by an unknown authority,400] +image::images/vnc-tigervnc-cert-signer-warning.png[alt="TigerVNC warning about certificates signed by an unknown authority",width="60%"] -- -6. When prompted for a username and password, enter your credentials. +. When prompted for a username and password, enter your credentials. + -- -image::images/vnc-tigervnc-username-password.png[Entering a username and password to authenticate via TigerVNC,400] +image::images/vnc-tigervnc-username-password.png[alt="Entering a username and password to authenticate via TigerVNC",width="60%"] -- -7. Click the "OK" button to authenticate with the VNC server. If your credentials are correct, TigerVNC should open a window containing the desktop corresponding to your account on the Raspberry Pi. You should be able to move your mouse and keyboard to input text and interact with the desktop. +. Click the "OK" button to authenticate with the VNC server. If your credentials are correct, TigerVNC should open a window containing the desktop corresponding to your account on the Raspberry Pi. You should be able to use your mouse and keyboard to interact with the desktop and input text. + -- -image::images/vnc-tigervnc-desktop.png[The desktop of a Raspberry Pi after successfully authenticating with TigerVNC] --- +image::images/vnc-tigervnc-desktop.png[alt="The desktop of a Raspberry Pi after successfully authenticating with TigerVNC",width="60%"] +-- \ No newline at end of file diff --git a/documentation/asciidoc/computers/software-sources.adoc b/documentation/asciidoc/computers/software-sources.adoc new file mode 100644 index 000000000..4a6d0b0ec --- /dev/null +++ b/documentation/asciidoc/computers/software-sources.adoc @@ -0,0 +1,191 @@ +At Raspberry Pi we're trying to open source as much of our code as possible to make it easy to use and adapt for your own uses. Raspberry Pi develops and supports software specifically for our products and focuses its energy on software which provides the most optimal user experience. For example, drivers which optimize multimedia acceleration such as the 3D, HEVC decode, the camera imaging pipeline, AI acceleration, dual HDMI and audio. + +== 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 change each "Types: deb" line to "Types: deb deb-src": + +* `+/etc/apt/sources.list.d/debian.sources+` (on 64-bit images) +or +* `+/etc/apt/sources.list.d/raspbian.sources+` (on 32-bit images) +and +* `+/etc/apt/sources.list.d/raspi.sources+` + +Next you must update the package lists: + +[source,console] +---- +$ sudo apt update +---- + +Now you can fetch the package source, for example: + +[source,console] +---- +$ 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 +---- + +== Our GitHub organizations + +The other place you can find our software in a more standard form is in our GitHub repositories, we have three GitHub organisations we use to store our sources: + +* https://github.com/raspberrypi +* https://github.com/raspberrypi-ui +* https://github.com/RPi-Distro + +== List of categorized sources + +The following is a curated list of repositories that most people are interested in: + +=== Main sources + +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:: +A collection of useful utilities such as pinctrl, piolib and raspinfo, also gpiolib a Raspberry Pi supported method of directly accessing GPIO pins. + +https://github.com/raspberrypi/libcamera:: +A libcamera library implementation for controlling the Raspberry Pi's ISP and cameras. + +https://github.com/raspberrypi/rpicam-apps:: +A C++ library and application suite for image/video processing and encoding with Raspberry Pi cameras using libcamera. + +https://github.com/raspberrypi/picamera2:: +A Python library for using and controlling the Raspberry Pi cameras. + +https://github.com/raspberrypi/drmu:: +A library for directly controlling and accessing multimedia interfaces. + +=== Desktop + +https://github.com/raspberrypi-ui/rpd-metas:: +The metapackages used to create the desktop. + +https://github.com/raspberrypi-ui/wf-panel-pi:: +The taskbar displayed at the top of the screen when running the Wayland-based desktop. + +https://github.com/raspberrypi-ui/lxpanel-pi:: +The taskbar displayed at the top of the screen when running the legacy X-based desktop. + +https://github.com/raspberrypi-ui/pplug-batt:: +https://github.com/raspberrypi-ui/pplug-bluetooth:: +https://github.com/raspberrypi-ui/pplug-clock:: +https://github.com/raspberrypi-ui/pplug-cpu:: +https://github.com/raspberrypi-ui/pplug-cputemp:: +https://github.com/raspberrypi-ui/pplug-ejecter:: +https://github.com/raspberrypi-ui/pplug-gpu:: +https://github.com/raspberrypi-ui/pplug-menu:: +https://github.com/raspberrypi-ui/pplug-netman:: +https://github.com/raspberrypi-ui/pplug-power:: +https://github.com/raspberrypi-ui/pplug-updater:: +https://github.com/raspberrypi-ui/pplug-volumepulse:: +The plugins displayed on the taskbars. + +https://github.com/raspberrypi-ui/pcmanfm:: +https://github.com/raspberrypi-ui/libfm:: +The file manager used by the desktop, which also displays the desktop background. + +https://github.com/raspberrypi-ui/rpcc:: +The Control Centre application. + +https://github.com/raspberrypi-ui/rc_gui:: +The Raspberry Pi configuration plugin for Control Centre. + +https://github.com/raspberrypi-ui/appset:: +The appearance settings plugin for Control Centre. + +https://github.com/raspberrypi-ui/rasputin:: +The mouse and keyboard settings plugin for Control Centre. + +https://github.com/raspberrypi-ui/raindrop:: +The screen configuration plugin for Control Centre. + +https://github.com/raspberrypi-ui/rpinters:: +The printer settings plugin for Control Centre. + +=== Applications + +https://github.com/raspberrypi-ui/agnostics:: +The Diagnostics application used to check SD cards. + +https://github.com/raspberrypi-ui/bookshelf:: +The code for the Bookshelf application which allows you to download and read e-books and past issues of the Raspberry Pi Official Magazine. + +https://github.com/raspberrypi-ui/piclone:: +The SD Card Copier application which allows cards and drives to be cloned. + +https://github.com/raspberrypi-ui/rp-prefapps:: +The Recommended Software application which allows selected programs to be installed or removed. + +=== Debug + +https://github.com/raspberrypi/rpi-analyse-boot:: +A boot analysis service that gathers boot-time metrics from various different sources. + +=== Tools + +https://github.com/raspberrypi/rpi-imager:: +The code for the Raspberry Pi Imager application which flashes an operating system to an SD card. + +https://github.com/raspberrypi/rpi-image-gen:: +A build system for developing an operating system for an embedded Raspberry Pi system. + +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, including secure boot and encrypted file systems. (Raspberry Pi 5, Compute Module 4, and Compute Module 5 are supported.) + +=== Feedback + +http://github.com/raspberrypi/trixie-feedback:: +A repo specifically reserved for bug-reporting for the current Raspberry Pi OS release. + +=== Raspberry Pi Pico + +https://marketplace.visualstudio.com/items?itemName=raspberry-pi.raspberry-pi-pico:: +This is where you can go to download and install the Microsoft Visual Studio Code extension for the Raspberry Pi Pico SDK. + +https://github.com/raspberrypi/pico-setup:: +Quick-start installation tool for the Raspberry Pi Pico SDK for command line use. + +https://github.com/raspberrypi/pico-sdk:: +The Raspberry Pi Pico SDK sources. + +https://github.com/raspberrypi/debugprobe:: +Sources for the Raspberry Pi Debug Probe, providing both SWD and UART easily. + +https://github.com/raspberrypi/openocd:: +The Raspberry Pi downstream OpenOCD sources. + +https://github.com/raspberrypi/pico-examples:: +Examples for Raspberry Pi Pico. + +https://github.com/raspberrypi/picotool:: +Tool for interacting with RP-series devices in BOOTSEL mode. diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360-v2.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360-v2.gif deleted file mode 100644 index ac47dd4c1..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360-v2.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360.gif deleted file mode 100644 index a2a1042e6..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-640x360.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-FINAL.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-FINAL.gif deleted file mode 100644 index cf249e8ef..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED-FINAL.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED.webm b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED.webm new file mode 100644 index 000000000..5d1c3df81 Binary files /dev/null and b/documentation/asciidoc/microcontrollers/c_sdk/images/Blink-an-LED.webm differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360-v2.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360-v2.gif deleted file mode 100644 index ca3c4ab3c..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360-v2.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360.gif deleted file mode 100644 index 99ef951b5..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-640x360.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-No-Wires-FINAL.gif b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-No-Wires-FINAL.gif deleted file mode 100644 index 8112a16ef..000000000 Binary files a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World-No-Wires-FINAL.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World.webm b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World.webm new file mode 100644 index 000000000..e6d5e34ab Binary files /dev/null and b/documentation/asciidoc/microcontrollers/c_sdk/images/Hello-World.webm differ diff --git a/documentation/asciidoc/microcontrollers/c_sdk/official_sdk.adoc b/documentation/asciidoc/microcontrollers/c_sdk/official_sdk.adoc index a2b447302..691c6511a 100644 --- a/documentation/asciidoc/microcontrollers/c_sdk/official_sdk.adoc +++ b/documentation/asciidoc/microcontrollers/c_sdk/official_sdk.adoc @@ -1,32 +1,27 @@ -== Raspberry Pi Pico C/{cpp} SDK +== Raspberry Pi Pico C/C++ SDK -Our official C SDK can be used from the command line, or from popular integrated development environments like Visual Studio Code, Eclipse, and CLion. To get started, download our C/{cpp} SDK and Examples, and take a look at our 'https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[getting started]' documentation to get going. Or for a quick setup see the next section. +Our official C SDK can be used from the command line, or from popular integrated development environments like Visual Studio Code, Eclipse, and CLion. To get started, download our C/{cpp} SDK and Examples, and take a look at our 'https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[getting started]' documentation. Or for a quick setup see the next section. -* The SDK https://github.com/raspberrypi/pico-sdk[Github repository] +You can find documentation around the C/{cpp} SDK at: -* The Examples https://github.com/raspberrypi/pico-examples[Github repository] - -You can find documentation around the C/{cpp} SDK at; - -https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico]:: C/{cpp} development with Raspberry Pi Pico and other RP2040-based microcontroller boards +https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico-series]:: C/{cpp} development with Raspberry Pi Pico, Pico 2, and other Raspberry Pi microcontroller-based boards https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W]:: Getting Raspberry Pi Pico W online with C/{cpp} or MicroPython -https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf[Raspberry Pi Pico C/{cpp} SDK]:: Libraries and tools for C/{cpp} development on RP2040 microcontrollers +https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf[Raspberry Pi Pico-series C/{cpp} SDK]:: Libraries and tools for C/{cpp} development on Raspberry Pi microcontrollers xref:../pico-sdk/index_doxygen.adoc[API level documentation]:: Documentation for the Raspberry Pi Pico C/{cpp} SDK -[NOTE] -==== -If you are building applications with the C/{cpp} SDK and targeting boards other than the Raspberry Pi Pico, you will need to pass `-DPICO_BOARD=boardname` to CMake. Here `boardname` is the name of your board, e.g. for the Adafruit Feather RP2040 you should pass `-DPICO_BOARD=adafruit_feather_rp2040`. See the https://github.com/raspberrypi/pico-sdk/tree/master/src/boards[`boards/` directory] in the Raspberry Pi Pico SDK, and the https://forums.raspberrypi.com/viewtopic.php?f=147&t=304393[forums], for more information. -==== +https://github.com/raspberrypi/pico-examples[The pico-examples repository]:: Example projects + +SDK source code is open source, available via the https://github.com/raspberrypi/pico-sdk[pico-sdk Github repository]. [NOTE] ==== -Documentation introducing working with Wi-Fi and Bluetooth on Raspberry Pi Pico W with C/{cpp} or MicroPython is presented in the https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W] book. -==== +To build applications with the C/{cpp} SDK for a board _other than the Raspberry Pi Pico_, pass `-DPICO_BOARD=boardname` to CMake, where `boardname` is the name of your board. For example: -[NOTE] +* to build an application for the Adafruit Feather RP2040, pass `-DPICO_BOARD=adafruit_feather_rp2040` +* to build an application for Pico W, pass `-DPICO_BOARD=pico_w` (in addition to -DWIFI_SSID="Your Network" -DWIFI_PASSWORD="Your Password", should you wish to connect to a wireless network) + +For more information, see the https://github.com/raspberrypi/pico-sdk/tree/master/src/boards[`boards/` directory] in the Raspberry Pi Pico SDK and the https://forums.raspberrypi.com/viewtopic.php?f=147&t=304393[forums]. ==== -If you are building applications with the C/{cpp} SDK for Raspberry Pi Pico W and, to connect to a network you will need to pass `-DPICO_BOARD=pico_w -DWIFI_SSID="Your Network" -DWIFI_PASSWORD="Your Password"` to CMake. If you only need to enable Bluetooth support then you do not need to pass a SSID and password, but still need to pass the `-DPICO_BOARD=pico_w` string to CMake. -==== \ No newline at end of file diff --git a/documentation/asciidoc/microcontrollers/c_sdk/quick_start.adoc b/documentation/asciidoc/microcontrollers/c_sdk/quick_start.adoc index 36df8da7d..b36220c80 100644 --- a/documentation/asciidoc/microcontrollers/c_sdk/quick_start.adoc +++ b/documentation/asciidoc/microcontrollers/c_sdk/quick_start.adoc @@ -4,12 +4,14 @@ NOTE: The following instructions are terse, and Linux-based only. For detailed s Install CMake (at least version 3.13), and GCC cross compiler +[source,console] ---- $ sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib ---- Set up your project to point to use the Raspberry Pi Pico SDK by cloning the SDK locally: +[source,console] ---- $ git clone https://github.com/raspberrypi/pico-sdk.git ---- @@ -39,6 +41,7 @@ Go ahead and write your code, see https://github.com/raspberrypi/pico-examples[p About the simplest you can do is a single source file (e.g. `hello_world.c`) +[source,c] ---- #include #include "pico/stdlib.h" @@ -68,6 +71,7 @@ NOTE: This example uses the default UART for stdout; if you want to use the defa Setup a CMake build directory. For example, if not using an IDE: +[source,console] ---- $ mkdir build $ cd build @@ -82,6 +86,7 @@ For a list of boards defined in the SDK itself, look in https://github.com/raspb Make your target from the build directory you created. +[source,console] ---- $ make hello_world ---- diff --git a/documentation/asciidoc/microcontrollers/c_sdk/sdk_setup.adoc b/documentation/asciidoc/microcontrollers/c_sdk/sdk_setup.adoc index 8594a5210..e59fbc857 100644 --- a/documentation/asciidoc/microcontrollers/c_sdk/sdk_setup.adoc +++ b/documentation/asciidoc/microcontrollers/c_sdk/sdk_setup.adoc @@ -2,5 +2,5 @@ For a full walk-through of how to get going with the C/{cpp} SDK, you should read our 'https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[getting started]' documentation. However, if you are intending to develop for Pico on a xref:../computers/os.adoc[Raspberry Pi], then you can set up the C/{cpp} toolchain quickly by running our https://raw.githubusercontent.com/raspberrypi/pico-setup/master/pico_setup.sh[setup script] from the command line. -NOTE: You should make sure the OS on your Raspberry Pi is xref:../computers/os.adoc#updating-and-upgrading-raspberry-pi-os[up to date] before running the setup script. +NOTE: You should make sure the OS on your Raspberry Pi is xref:../computers/os.adoc#update-software[up to date] before running the setup script. diff --git a/documentation/asciidoc/microcontrollers/c_sdk/your_first_binary.adoc b/documentation/asciidoc/microcontrollers/c_sdk/your_first_binary.adoc index 696b6f0c2..9beb1fc8e 100644 --- a/documentation/asciidoc/microcontrollers/c_sdk/your_first_binary.adoc +++ b/documentation/asciidoc/microcontrollers/c_sdk/your_first_binary.adoc @@ -1,12 +1,10 @@ == Your First Binaries -WARNING: If you are using an Apple Mac, and running macOS Ventura, there has been a change in how the Finder works which causes drag-and-drop to fail. Please see our https://www.raspberrypi.com/news/the-ventura-problem/[blog post] for a full explanation, and workarounds, and our https://github.com/raspberrypi/pico-sdk/issues/1081[Github issue] tracking the problem for the current status. - === Blink an LED The first program anyone writes when using a new microcontroller is to blink an LED on and off. The Raspberry Pi Pico comes with a single LED on-board. The LED is connected to `GP25` on the board's Raspberry Pi RP2040 for Pico, and `WL_GPIO0` on the Infineon 43439 wireless chip for Pico W. -image:images/Blink-an-LED-640x360-v2.gif[] +video::images/Blink-an-LED.webm[width="80%"] You can blink this on and off by, @@ -23,7 +21,7 @@ You can see the code on Github for the https://github.com/raspberrypi/pico-examp The next program anyone writes is to say 'Hello World' over a USB serial connection. -image:images/Hello-World-640x360-v2.gif[] +video::images/Hello-World.webm[width="80%"] . Download the https://datasheets.raspberrypi.com/soft/hello_world.uf2['Hello World' UF2]. . Push and hold the BOOTSEL button and plug your Pico into the USB port of your Raspberry Pi or other computer. @@ -31,10 +29,10 @@ image:images/Hello-World-640x360-v2.gif[] . Drag and drop the 'Hello World' UF2 binary onto the RPI-RP2 volume. Pico will reboot. . Open a Terminal window and type: + -[source] +[source,console] ------ -sudo apt install minicom -minicom -b 115200 -o -D /dev/ttyACM0 +$ sudo apt install minicom +$ minicom -b 115200 -o -D /dev/ttyACM0 ------ You should see 'Hello, world!' printed to the Terminal. diff --git a/documentation/asciidoc/microcontrollers/debug-probe/getting-started.adoc b/documentation/asciidoc/microcontrollers/debug-probe/getting-started.adoc index 3a7af7d07..aec938471 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/getting-started.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/getting-started.adoc @@ -2,9 +2,9 @@ image:images/labelled-wiring.jpg[width="100%"] -Depending on your setup, there are several ways to wire the Debug Probe to a xref:raspberry-pi-pico.adoc[Raspberry Pi Pico]. Below, we connect the Debug Probe to a Raspberry Pi Pico H which has the newer three-pin JST-SH connector for SWD. +Depending on your setup, there are several ways to wire the Debug Probe to a xref:pico-series.adoc[Pico-series device]. Below, we connect the Debug Probe to a Raspberry Pi Pico H which has the newer three-pin JST-SH connector for SWD. -video::4RCZBZsfsek[youtube] +video::4RCZBZsfsek[youtube,width=80%,height=400px] Connect the following: @@ -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%"] diff --git a/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring.jpg b/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring.jpg index 514cc0581..81a0c3b1a 100644 Binary files a/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring.jpg and b/documentation/asciidoc/microcontrollers/debug-probe/images/labelled-wiring.jpg differ diff --git a/documentation/asciidoc/microcontrollers/debug-probe/images/wiring-real.jpg b/documentation/asciidoc/microcontrollers/debug-probe/images/wiring-real.jpg index d265a5e90..80f89a630 100644 Binary files a/documentation/asciidoc/microcontrollers/debug-probe/images/wiring-real.jpg and b/documentation/asciidoc/microcontrollers/debug-probe/images/wiring-real.jpg differ diff --git a/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc b/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc index 105c46745..1ac3f94b4 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc @@ -1,68 +1,12 @@ == Install tools -To use the Debug Probe, install the following tools. +To use the Debug Probe, OpenOCD and the GNU Project Debugger (GDB) are required. An Integrated Development Environment (IDE) may also be useful. -=== Install OpenOCD +On Raspberry Pi OS, most Linux variants, macOS, and Microsoft Windows, it is recommended to install our VS Code extension. This extension bundles OpenOCD, Arm toolchains, GDB, and register definitions for Pico-series microcontrollers. -You need to install OpenOCD. +See Chapter 3 of our https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting Started with Raspberry Pi Pico] guide. -To install OpenOCD, run the following command in a terminal: +Alternatively, tools can be manually installed by following Appendix C in the guide. -[source,console] ----- -$ sudo apt install openocd ----- +NOTE: Manual installation of the tools on Windows is not recommended. -To run OpenOCD, use the `openocd` command in your terminal. - -==== Install OpenOCD on macOS - -First, install the https://brew.sh/[Homebrew] package manager: - -[source,console] ----- -$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" ----- - -To install OpenOCD on macOS, run the following commands: - -[source,console] ----- -$ brew install openocd ----- - -To run OpenOCD, use the `openocd` command in your terminal. - -=== Install GDB - -We also need to install the GNU debugger (GDB). - -==== Linux - -Install `gdb-multiarch`: - -[source,console] ----- -$ sudo apt install gdb-multiarch ----- - -==== macOS - -Run the following command to install `gdb`: - -[source,console] ----- -$ brew install gdb ----- - -You can safely ignore the request for "special privileges" messages on installation. - -IMPORTANT: GDB does not support `gdb` Arm-based Macs. Instead, either https://gist.github.com/m0sys/711d0ec5e52102c6ba44451caf38bd38[install `gdb` from source] or use `lldb` instead of `gdb`. There is https://inbox.sourceware.org/gdb/3185c3b8-8a91-4beb-a5d5-9db6afb93713@Spark/[no official support] from the developers for running GDB on Arm-based Macs. Support for GDB can be found on the https://inbox.sourceware.org/gdb/[GDB mailing list] on Sourceware.org. `lldb` is installed as part of the Xcode Command Line Tools. - -==== MS Windows - -GDB is available as part of our https://github.com/raspberrypi/pico-setup-windows/releases/latest[Pico setup for Windows installer]. It is also included in the https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads[Arm GNU Toolchain Downloads]. - -Alternatively information about manual installation can be found in Chapter 9 and Appendix A of our https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting Started with Raspberry Pi Pico] book. - -NOTE: Manual installation of GDB on Windows is not recommended. diff --git a/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc b/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc index 80e0f9fba..3703a213c 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/introduction.adoc @@ -4,13 +4,13 @@ image::images/debug-probe.jpg[width="100%"] The Raspberry Pi Debug Probe is a USB device that provides both a UART serial port and a standard Arm Serial Wire Debug (SWD) interface. The probe is designed for easy, solderless, plug-and-play debugging. It has the following features: -* USB to ARM https://developer.arm.com/documentation/ihi0031/a/The-Serial-Wire-Debug-Port\--SW-DP-/Introduction-to-the-ARM-Serial-Wire-Debug\--SWD\--protocol[Serial Wire Debug] (SWD) port +* USB to Arm https://developer.arm.com/documentation/ihi0031/a/The-Serial-Wire-Debug-Port\--SW-DP-/Introduction-to-the-ARM-Serial-Wire-Debug\--SWD\--protocol[Serial Wire Debug] (SWD) port * USB to UART bridge * Compatible with the https://developer.arm.com/documentation/101451/0100/About-CMSIS-DAP[CMSIS-DAP] standard * 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/debug-probe/swd-connection.adoc b/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc index e51ef08c7..7b7fbfa95 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc @@ -1,12 +1,14 @@ -== Serial Wire Debug (SWD) +== Starting a Debug Session -Serial Wire Debug (SWD) is a two-pin interface (https://developer.arm.com/documentation/101761/1-0/Debug-and-trace-interface/Serial-Wire-Debug-signals[SWDIO and SWCLK]) alternative to the JTAG four- or five-pin debugging interface standard. +The Debug Probe will let you load binaries via the SWD port and OpenOCD: you will not need to unplug, and then push-and-hold, the BOOTSEL button every time you push a new binary to your Pico. Using the Debug Probe to upload new binaries is an entirely hands-off affair. -=== Uploading new programs to your Pico +GDB is then used to debug the binary running on the Pico. -The Pico Debug Probe will let you load binaries via the SWD port and OpenOCD: you will not need to unplug, and then push-and-hold, the BOOTSEL button every time you push a new binary to your Pico. Using the Debug Probe uploading new binaries is an entirely hands off affair. +We recommend the use of the Raspberry Pi Pico VSCode extension, which integrates the use of OpenOCD and GDB, to upload and debug programs. See Chapter 4 of https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico] for more information. -Once you have built a binary: +=== Standalone program upload + +Once you have built a binary: [source,console] ---- @@ -15,11 +17,11 @@ $ sudo openocd -f interface/cmsis-dap.cfg -f target/rp2040.cfg -c "adapter speed NOTE: When you use the Debug Probe to upload a binary the ELF version of the file is used, not the UF2 file that you would use when you drag-and-drop. -=== Debugging with SWD +=== Standalone debug session -It’ll also let you use `openocd` in server mode, and connect GDB, which gives you break points and “proper” debugging. +This will use `openocd` in server mode, and connect GDB, which gives you breakpoints and single-step over a console interface. -[IMPORTANT] +[IMPORTANT] ====== To allow debugging, you must build your binaries as `Debug` rather than `Release` build type, e.g. @@ -35,10 +37,12 @@ $ make -j4 ---- In a debug build you will get more information when you run it under the debugger, as the compiler builds your program with the information to tell GDB what your program is doing. - -See Chapter 6 of https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico] for more information. ====== +NOTE: For computers that are _not_ Raspberry Pis, a variant of GDB that can debug Arm processors is required. Use one of the following alternatives depending on your operating system and device: +* On Linux devices, use `gdb-multiarch`. +* On macOS and Windows devices, use `arm-none-eabi-gdb` from the toolchain on https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads[Arm's website] + To start an OpenOCD server, run the following command: [source,console] @@ -55,8 +59,3 @@ $ gdb blink.elf > monitor reset init > continue ---- - -GDB doesn't work on all platforms. Use one of the following alternatives instead of `gdb`, depending on your operating system and device: - -* On Linux devices that are _not_ Raspberry Pis, use `gdb-multiarch`. -* On Arm-based macOS devices, use `lldb`. diff --git a/documentation/asciidoc/microcontrollers/debug-probe/uart-connection.adoc b/documentation/asciidoc/microcontrollers/debug-probe/uart-connection.adoc index 459cc821d..ebc84205d 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/uart-connection.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/uart-connection.adoc @@ -19,12 +19,14 @@ Once connected, traffic over the Raspberry Pi Pico's UART will be relayed to you If you have not already done so you should install minicom: +[source,console] ---- $ sudo apt install minicom ---- and open the serial port: +[source,console] ---- $ minicom -b 115200 -o -D /dev/ttyACM0 ---- @@ -35,6 +37,7 @@ To test serial communication you can build and upload the "Hello World" example Change directory into the `hello_world` directory inside the `pico-examples` tree, and run `make`. Afterwards, you can upload it to your Raspberry Pi Pico using `openocd`. For a full walkthrough of building the `hello_serial` example program, see Chapter 4 of https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico]. +[source,console] ---- $ cd pico-examples $ mkdir build diff --git a/documentation/asciidoc/microcontrollers/debug-probe/updating-firmware.adoc b/documentation/asciidoc/microcontrollers/debug-probe/updating-firmware.adoc index 1aa884ec4..4fb879a5c 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/updating-firmware.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/updating-firmware.adoc @@ -1,10 +1,22 @@ == Updating the firmware on the Debug Probe -NOTE: The current version of the Debug Probe firmware is version 1.0.3. If you're running an older version, or if you have accidentally overwritten the firmware on your Debug Probe, the latest release of the firmware can be found on https://github.com/raspberrypi/debugprobe/releases/latest[GitHub]. +Firmware for the Debug Probe is available as a UF2 file distributed by Raspberry Pi. -From time to time you may need to update the Debug Probe firmware. New firmware for the probe will be made available as a UF2 file distributed by Raspberry Pi. +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]. -Pinch to remove the top of the Debug Probe enclosure, then push and hold the BOOTSEL button as you plug the Debug Probe into your computer. This will mount an RPI-RP2 volume on your desktop. Drag-and-drop the firmware UF2 onto the RPI-RP2 volume. The firmware will be copied to the Debug Probe and the volume will dismount. +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. -Your Debug Probe will reboot. You are now running an updated version of the Debug Probe firmware. +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). +To update the firmware version of your Debug Probe: + +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. diff --git a/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc b/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc index bb63e78f2..12c3b197e 100644 --- a/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc +++ b/documentation/asciidoc/microcontrollers/microcontroller_docs.adoc @@ -1,28 +1,44 @@ -// Included from both rp2040.adoc and raspberry-pi-pico.adoc +// Included from both silicon.adoc and pico-series.adoc == Documentation -Documentation for Raspberry Pi Pico and other RP2040-based boards. +Documentation for Pico-series and other Raspberry Pi microcontroller-based boards. -=== RP2040 Device +=== RP2350 + +https://datasheets.raspberrypi.com/rp2350/rp2350-datasheet.pdf[RP2350 Datasheet]:: A microcontroller by Raspberry Pi + +https://datasheets.raspberrypi.com/rp2350/hardware-design-with-rp2350.pdf[Hardware design with RP2350]:: Using RP2350 microcontrollers to build boards and products + +=== RP2040 https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf[RP2040 Datasheet]:: A microcontroller by Raspberry Pi https://datasheets.raspberrypi.com/rp2040/hardware-design-with-rp2040.pdf[Hardware design with RP2040]:: Using RP2040 microcontrollers to build boards and products +=== Raspberry Pi Pico 2 + +https://datasheets.raspberrypi.com/pico/pico-2-datasheet.pdf[Raspberry Pi Pico 2 Datasheet]:: An RP2350-based microcontroller board + +https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico-series Microcontrollers]:: C/{cpp} development with Raspberry Pi Pico-series devices and other Raspberry Pi microcontroller-based boards + === Raspberry Pi Pico https://datasheets.raspberrypi.com/pico/pico-datasheet.pdf[Raspberry Pi Pico Datasheet]:: An RP2040-based microcontroller board -https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico]:: C/{cpp} development with Raspberry Pi Pico and other RP2040-based microcontroller boards +https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting started with Raspberry Pi Pico-series Microcontrollers]:: C/{cpp} development with Raspberry Pi Pico-series devices and other Raspberry Pi microcontroller-based boards + +=== Raspberry Pi Pico 2 W + +https://datasheets.raspberrypi.com/picow/pico-2-w-datasheet.pdf[Raspberry Pi Pico 2 W Datasheet]:: An RP2350-based microcontroller board with wireless + +https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W-series]:: Getting Raspberry Pi Pico W-series devices online with C/{cpp} or MicroPython === Raspberry Pi Pico W https://datasheets.raspberrypi.com/picow/pico-w-datasheet.pdf[Raspberry Pi Pico W Datasheet]:: An RP2040-based microcontroller board with wireless -https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W]:: Getting Raspberry Pi Pico W online with C/{cpp} or MicroPython - -NOTE: Documentation introducing working with Wi-Fi and Bluetooth on Raspberry Pi Pico W with C/{cpp} or MicroPython is presented in the https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W] book. +https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W-series]:: Getting Raspberry Pi Pico W-series devices online with C/{cpp} or MicroPython === Software Development @@ -30,7 +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]. - -NOTE: A https://github.com/raspberrypi/pico-setup-windows/releases/latest/download/pico-setup-windows-x64-standalone.exe[one-click installer] for the Pico C/{cpp} SDK for Windows 10 and Windows 11 is available. +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/micropython/drag-and-drop.adoc b/documentation/asciidoc/microcontrollers/micropython/drag-and-drop.adoc index 80a9df47c..70931fea6 100644 --- a/documentation/asciidoc/microcontrollers/micropython/drag-and-drop.adoc +++ b/documentation/asciidoc/microcontrollers/micropython/drag-and-drop.adoc @@ -1,35 +1,31 @@ == Drag-and-Drop MicroPython -You can program your Pico by connecting it to a computer via USB, then dragging and dropping a file onto it so we’ve put together a downloadable UF2 file to let you install MicroPython more easily. +You can program your Pico by connecting it to a computer via USB, then dragging and dropping a file onto it so we've put together a downloadable UF2 file to let you install MicroPython more easily. -image::images/MicroPython-640x360-v2.gif[] +video::images/MicroPython.webm[width="80%"] Download the correct MicroPython UF2 file for your board: -* https://micropython.org/download/rp2-pico/rp2-pico-latest.uf2[Raspberry Pi Pico] +* https://micropython.org/download/rp2-pico/rp2-pico-latest.uf2[Pico] -* https://micropython.org/download/rp2-pico-w/rp2-pico-w-latest.uf2[Raspberry Pi Pico W] with Wi-Fi and Bluetooth LE support -//(with https://makeblock-micropython-api.readthedocs.io/en/latest/public_library/Third-party-libraries/urequests.html[urequests] and https://docs.micropython.org/en/latest/reference/packages.html[upip] preinstalled) +* https://micropython.org/download/rp2-pico-w/rp2-pico-w-latest.uf2[Pico W] -//* https://datasheets.raspberrypi.com/soft/micropython-firmware-pico-w-130623.uf2[Raspberry Pi Pico W] with Wi-Fi and Bluetooth LE support +* https://micropython.org/download/RPI_PICO2/RPI_PICO2-latest.uf2[Pico 2] -//IMPORTANT: Until Bluetooth support is integrated into the upstream repo you should download the beta https://datasheets.raspberrypi.com/soft/micropython-firmware-pico-w-130623.uf2[UF2 firmware] which has both Wi-Fi and Bluetooth support built in. Documentation introducing working with Wi-Fi and Bluetooth on Raspberry Pi Pico W with C/{cpp} or MicroPython is presented in the https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W] book. Full details of https://github.com/bluekitchen/btstack#supported-protocols-and-profiles[supported Bluetooth protocols and profiles] are Blue Kitchen https://github.com/bluekitchen/btstack[BTStack] Github repository. +* https://downloads.raspberrypi.com/micropython/mp_firmware_unofficial_latest.uf2[Pico 2 W] -Documentation introducing working with Wi-Fi and Bluetooth on Raspberry Pi Pico W with C/{cpp} or MicroPython is presented in the https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W] book. Full details of https://github.com/bluekitchen/btstack#supported-protocols-and-profiles[supported Bluetooth protocols and profiles] are Blue Kitchen https://github.com/bluekitchen/btstack[BTStack] Github repository. +For more information about using Wi-Fi and Bluetooth on Raspberry Pi Pico W-series devices with C/{cpp} or MicroPython, see https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf[Connecting to the Internet with Raspberry Pi Pico W-series]. -NOTE: MicroPython distributions for other RP2040-based boards are available on the https://micropython.org/download/[MicroPython download page]. +For more information about https://github.com/bluekitchen/btstack#supported-protocols-and-profiles[supported Bluetooth protocols and profiles], see the Blue Kitchen https://github.com/bluekitchen/btstack[BTStack] Github repository. -Then go ahead and: +NOTE: MicroPython distributions for other RP2040- and RP2350-based boards are available on the https://micropython.org/download/[MicroPython download page]. -. Push and hold the BOOTSEL button and plug your Pico into the USB port of your Raspberry Pi or other computer. Release the BOOTSEL button after your Pico is connected. +To program your device, follow these steps: -. It will mount as a Mass Storage Device called RPI-RP2. +. Push and hold the BOOTSEL button while connecting your Pico with a USB cable to a computer. Release the BOOTSEL button once your Pico appears as a Mass Storage Device called RPI-RP2. . Drag and drop the MicroPython UF2 file onto the RPI-RP2 volume. Your Pico will reboot. You are now running MicroPython. -. You can access the REPL via USB Serial. - -The https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-python-sdk.pdf[Raspberry Pi Pico Python SDK] book contains step-by-step instructions for connecting to your Pico and programming it in MicroPython using both the command line and the https://thonny.org/[Thonny] IDE. - -WARNING: If you are using an Apple Mac and running macOS Ventura there has been a change in how the Finder works which causes drag-and-drop to fail. This https://github.com/raspberrypi/pico-sdk/issues/1081[issue] was fixed as of macOS Ventura version 13.1. Please see our https://www.raspberrypi.com/news/the-ventura-problem/[blog post] for a full explanation along with workarounds if you are unable to upgrade to the latest version of Ventura. +. Access the REPL via USB Serial. +The https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-python-sdk.pdf[Raspberry Pi Pico-series Python SDK] book contains step-by-step instructions for connecting to your Pico and programming it in MicroPython using both the command line and the https://thonny.org/[Thonny] IDE. diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360-v2.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360-v2.gif deleted file mode 100644 index 4a350f0b0..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360-v2.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360.gif deleted file mode 100644 index 8acc04df3..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x360.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x480.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x480.gif deleted file mode 100644 index d816b70e6..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-640x480.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-OLD.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-OLD.gif deleted file mode 100644 index 6d311a9e5..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-OLD.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-Update-v1.gif b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-Update-v1.gif deleted file mode 100644 index fc89da05e..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython-Update-v1.gif and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/MicroPython.webm b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython.webm new file mode 100644 index 000000000..9ef956aa8 Binary files /dev/null and b/documentation/asciidoc/microcontrollers/micropython/images/MicroPython.webm differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/micropython_book.png b/documentation/asciidoc/microcontrollers/micropython/images/micropython_book.png index a860068e5..86f9ec0a0 100644 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/micropython_book.png and b/documentation/asciidoc/microcontrollers/micropython/images/micropython_book.png differ diff --git a/documentation/asciidoc/microcontrollers/micropython/images/micropython_book_thumb.png b/documentation/asciidoc/microcontrollers/micropython/images/micropython_book_thumb.png deleted file mode 100644 index e7c347eef..000000000 Binary files a/documentation/asciidoc/microcontrollers/micropython/images/micropython_book_thumb.png and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/micropython/micropython-documentation.adoc b/documentation/asciidoc/microcontrollers/micropython/micropython-documentation.adoc index 5d85eb22c..d40b32c25 100644 --- a/documentation/asciidoc/microcontrollers/micropython/micropython-documentation.adoc +++ b/documentation/asciidoc/microcontrollers/micropython/micropython-documentation.adoc @@ -7,14 +7,3 @@ https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w. https://docs.micropython.org/en/latest/rp2/quickref.html[RP2 Quick Reference]:: The official documentation around the RP2040 port of MicroPython https://docs.micropython.org/en/latest/library/rp2.html[RP2 Library]:: The official documentation about the `rp2` module in MicroPython -[.booklink, booktype="buy", link=https://store.rpipress.cc/products/get-started-with-micropython-on-raspberry-pi-pico,image=image::images/micropython_book_thumb.png[]] -=== Further reading -There is also a book by https://store.rpipress.cc/[Raspberry Pi Press] available written by Gareth Halfacree and Ben Everard. - -In "Get Started with MicroPython on Raspberry Pi Pico", you will learn how to use the beginner-friendly language MicroPython to write programs and connect hardware to make your Raspberry Pi Pico interact with the world around it. Using these skills, you can create your own electro-mechanical projects, whether for fun or to make your life easier. - -* Set up your Raspberry Pi Pico and start using it -* Start writing programs using MicroPython -* Control and sense electronic components -* Discover how to use Pico’s unique Programmable IO -* Make a reaction game, burglar alarm, temperature gauge, and many more \ No newline at end of file diff --git a/documentation/asciidoc/microcontrollers/micropython/what-board.adoc b/documentation/asciidoc/microcontrollers/micropython/what-board.adoc index 2b4fdd192..fa3c8ab56 100644 --- a/documentation/asciidoc/microcontrollers/micropython/what-board.adoc +++ b/documentation/asciidoc/microcontrollers/micropython/what-board.adoc @@ -18,4 +18,4 @@ Alternatively, you can inspect the MicroPython firmware version to check whether (name='micropython', version=(1, 19, 1), _machine='Raspberry Pi Pico W with RP2040', _mpy=4102) ---- -So if the 'Pico W' string is present and in `sys.implementation._machine` that can be used to determine whether your firmware was compiled for Pico W. +If the 'Pico W' string is present and in `sys.implementation._machine`, your firmware was compiled for Pico W. diff --git a/documentation/asciidoc/microcontrollers/pico-series.adoc b/documentation/asciidoc/microcontrollers/pico-series.adoc new file mode 100644 index 000000000..e063028a1 --- /dev/null +++ b/documentation/asciidoc/microcontrollers/pico-series.adoc @@ -0,0 +1,5 @@ +include::pico-series/about_pico.adoc[] + +include::microcontroller_docs.adoc[] + +include::pico-series/utilities.adoc[] diff --git a/documentation/asciidoc/microcontrollers/pico-series/about_pico.adoc b/documentation/asciidoc/microcontrollers/pico-series/about_pico.adoc new file mode 100644 index 000000000..aed8798cb --- /dev/null +++ b/documentation/asciidoc/microcontrollers/pico-series/about_pico.adoc @@ -0,0 +1,164 @@ +Pico-series devices are organised into **families** based on product generation. + +The original Raspberry Pi Pico family, referred to as Pico or Pico 1, comes in the following variants: + +* Pico +* Pico H +* Pico W +* Pico WH + +The second-generation Raspberry Pi Pico family is referred to as Pico 2. Pico 2 comes in the following variants: + +* Pico 2 +* Pico 2 W + +== Pico 2 family + +image::images/pico-2.png[width="75%"] + +[[pico-2-technical-specification]] +=== Raspberry Pi Pico 2 + +Raspberry Pi Pico 2 is a low-cost, high-performance microcontroller board with flexible digital interfaces. Key features include: + +* xref:silicon.adoc#rp2350[RP2350] microcontroller chip designed by Raspberry Pi in the United Kingdom +* Dual Cortex-M33 or Hazard3 processors at up to 150MHz +* 520KB of SRAM, and 4MB of on-board flash memory +* USB 1.1 with device and host support +* Low-power sleep and dormant modes +* Drag-and-drop programming using mass storage over USB +* 26× multi-function GPIO pins including 3 that can be used for ADC +* 2× SPI, 2× I2C, 2× UART, 3× 12-bit 500ksps Analogue to Digital Converter (ADC), 24× controllable PWM channels +* 2× Timer with 4 alarms, 1× AON Timer +* Temperature sensor +* 3 × Programmable IO (PIO) blocks, 12 state machines total for custom peripheral support +** Flexible, user-programmable high-speed IO +** Can emulate interfaces such as SD Card and VGA + +The Raspberry Pi Pico 2 comes as a castellated module which allows soldering direct to carrier boards, while the Pico 2 _with headers_ comes with pre-soldered headers. + +NOTE: Both boards have a three pin Serial Wire Debug (SWD) header. However, the Pico 2 with headers breaks this out into a small, keyed, https://datasheets.raspberrypi.com/debug/debug-connector-specification.pdf[3-pin connector] while the Pico has three castellated through-hole pins adjacent to the edge of the board. + +==== Pinout and design files + +image::images/pico-2-r4-pinout.svg[] + +* Download the https://datasheets.raspberrypi.com/pico/Pico-2-Pinout.pdf[Pinout Diagram] (PDF) +* Download https://datasheets.raspberrypi.com/pico/Pico-2-step-20240708.zip[STEP File] +* Download https://datasheets.raspberrypi.com/pico/Pico-2-Fritzing-20240708.fzpz[Fritzing Part] for Raspberry Pi Pico + +NOTE: More information on Fritzing is available on the https://fritzing.org/[fritzing.org] website. + +[[pico2w-technical-specification]] +=== Raspberry Pi Pico 2 W + +Raspberry Pi Pico 2 W adds on-board single-band 2.4GHz wireless interfaces (802.11n) using the Infineon CYW43439 to the Pico 2 hardware. The on-board 2.4GHz wireless interface has the following features: + +* Wireless (802.11n), single-band (2.4 GHz) +* WPA3 +* Soft access point supporting up to four clients +* Bluetooth 5.2 +** Support for Bluetooth LE Central and Peripheral roles +** Support for Bluetooth Classic + +The onboard antenna is licensed from ABRACON (formerly ProAnt). The wireless interface is connected via +SPI to the xref:silicon.adoc#rp2350[RP2350] microcontroller. + +Due to pin limitations, some of the wireless interface pins are shared. The CLK is shared with VSYS monitor, so only +when there isn't an SPI transaction in progress can VSYS be read via the ADC. The Infineon CYW43439 DIN/DOUT and +IRQ all share one pin on the RP2350. Only when an SPI transaction isn't in progress is it suitable to check for IRQs. The interface typically runs at 33MHz. + +For best wireless performance, position the antenna in free space. For instance, metal underneath or nearby the +antenna can reduce performance both in terms of gain and bandwidth. Adding grounded metal to the sides of the +antenna can improve the antenna's bandwidth. + +`libcyw43` is licensed for non-commercial use. However, Pico 2 W users, and anyone else who builds their product around RP2350 and CYW43439, benefit from a free https://github.com/georgerobotics/cyw43-driver/blob/195dfcc10bb6f379e3dea45147590db2203d3c7b/LICENSE.RP[commercial-use license]. + +In addition to the https://github.com/bluekitchen/btstack/blob/master/LICENSE[standard BTstack licensing] terms, a https://github.com/raspberrypi/pico-sdk/blob/master/src/rp2_common/pico_btstack/LICENSE.RP[supplemental licence] covers commercial use of BTstack with Raspberry Pi Pico 2 W. + +==== Pinout and design files + +image::images/pico2w-pinout.svg[] + +* https://datasheets.raspberrypi.com/picow/pico-2-w-pinout.pdf[Pinout Diagram] (PDF) +* https://datasheets.raspberrypi.com/picow/pico-2-w-schematic.pdf[Schematic] +// TODO: add these when available +// * Download https://datasheets.raspberrypi.com/pico2w/RPi-PicoW-PUBLIC-20220607.zip[Design Files] (Cadence Allegro) +// * Download https://datasheets.raspberrypi.com/pico2w/PicoW-step.zip[STEP File] + +== Pico 1 family + +image::images/pico-1s.png[width="75%"] + +The Raspberry Pi Pico 1 family consists of four boards; Raspberry Pi Pico (far left), Pico H (middle left), Pico W (middle right), and Pico WH (far right). + +[[pico-1-technical-specification]] +=== Raspberry Pi Pico and Pico H + +Raspberry Pi Pico is a low-cost, high-performance microcontroller board with flexible digital interfaces. Key features include: + +* xref:silicon.adoc#rp2040[RP2040] microcontroller chip designed by Raspberry Pi in the United Kingdom +* Dual-core Arm Cortex M0+ processor, flexible clock running up to 133 MHz +* 264KB of SRAM, and 2MB of on-board flash memory +* USB 1.1 with device and host support +* Low-power sleep and dormant modes +* Drag-and-drop programming using mass storage over USB +* 26 × multi-function GPIO pins +* 2 × SPI, 2 × I2C, 2 × UART, 3 × 12-bit ADC, 16 × controllable PWM channels +* Accurate clock and timer on-chip +* Temperature sensor +* Accelerated floating-point libraries on-chip +* 8 × Programmable I/O (PIO) state machines for custom peripheral support + +The Raspberry Pi Pico comes as a castellated module which allows soldering direct to carrier boards, while the Pico H comes with pre-soldered headers. + +NOTE: Both boards have a three pin Serial Wire Debug (SWD) header. However, the Pico H has this broken out into a small, keyed, https://datasheets.raspberrypi.com/debug/debug-connector-specification.pdf[3-pin connector] while the Pico has three castellated through-hole pins adjacent to the edge of the board. + +==== Pinout and design files + +image::images/pico-pinout.svg[] + +* Download the https://datasheets.raspberrypi.com/pico/Pico-R3-A4-Pinout.pdf[Pinout Diagram] (PDF) +* Download https://datasheets.raspberrypi.com/pico/RPi-Pico-R3-PUBLIC-20200119.zip[Design Files] (Cadence Allegro) +* Download https://datasheets.raspberrypi.com/pico/Pico-R3-step.zip[STEP File] +* Download https://datasheets.raspberrypi.com/pico/Pico-R3-Fritzing.fzpz[Fritzing Part] for Raspberry Pi Pico +* Download https://datasheets.raspberrypi.com/pico/PicoH-Fritzing.fzpz[Fritzing Part] for Raspberry Pi Pico H + +NOTE: More information on Fritzing is available on the https://fritzing.org/[fritzing.org] website. + +[[picow-technical-specification]] +=== Raspberry Pi Pico W and Pico WH + +Raspberry Pi Pico W adds on-board single-band 2.4GHz wireless interfaces (802.11n) using the Infineon CYW43439 while retaining the Pico form factor. The on-board 2.4GHz wireless interface has the following features: + +* Wireless (802.11n), single-band (2.4 GHz) +* WPA3 +* Soft access point supporting up to four clients +* Bluetooth 5.2 +** Support for Bluetooth LE Central and Peripheral roles +** Support for Bluetooth Classic + +The antenna is an onboard antenna licensed from ABRACON (formerly ProAnt). The CYW43439 wireless chip is connected via +SPI to the xref:silicon.adoc#rp2040[RP2040] microcontroller. + +Due to pin limitations, some of the wireless interface pins are shared. The CLK is shared with VSYS monitor, so only +when there isn't an SPI transaction in progress can VSYS be read via the ADC. The Infineon CYW43439 DIN/DOUT and +IRQ all share one pin on the RP2040. Only when an SPI transaction isn't in progress is it suitable to check for IRQs. The +interface typically runs at 33MHz. + +For best wireless performance, the antenna should be in free space. For instance, putting metal under or close by the +antenna can reduce its performance both in terms of gain and bandwidth. Adding grounded metal to the sides of the +antenna can improve the antenna's bandwidth. + +`libcyw43` is licensed for non-commercial use. However, Pico W users, and anyone else who builds their product around RP2040 and CYW43439, benefit from a free https://github.com/georgerobotics/cyw43-driver/blob/195dfcc10bb6f379e3dea45147590db2203d3c7b/LICENSE.RP[commercial-use license]. + +In addition to the https://github.com/bluekitchen/btstack/blob/master/LICENSE[standard BTstack licensing] terms, a https://github.com/raspberrypi/pico-sdk/blob/master/src/rp2_common/pico_btstack/LICENSE.RP[supplemental licence] covers commercial use of BTstack with Raspberry Pi Pico W or Raspberry Pi Pico WH. + +==== Pinout and design files + +image::images/picow-pinout.svg[] + +* Download the https://datasheets.raspberrypi.com/picow/PicoW-A4-Pinout.pdf[Pinout Diagram] (PDF) +* Download https://datasheets.raspberrypi.com/picow/RPi-PicoW-PUBLIC-20220607.zip[Design Files] (Cadence Allegro) +* Download https://datasheets.raspberrypi.com/picow/PicoW-step.zip[STEP File] +* Download https://datasheets.raspberrypi.com/picow/PicoW-Fritzing.fzpz[Fritzing Part] for Raspberry Pi Pico W diff --git a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/Pico-R3-SDK11-Pinout.svg b/documentation/asciidoc/microcontrollers/pico-series/images/Pico-R3-SDK11-Pinout.svg similarity index 100% rename from documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/Pico-R3-SDK11-Pinout.svg rename to documentation/asciidoc/microcontrollers/pico-series/images/Pico-R3-SDK11-Pinout.svg diff --git a/documentation/asciidoc/microcontrollers/pico-series/images/pico-1s.png b/documentation/asciidoc/microcontrollers/pico-series/images/pico-1s.png new file mode 100644 index 000000000..434a35c44 Binary files /dev/null and b/documentation/asciidoc/microcontrollers/pico-series/images/pico-1s.png differ diff --git a/documentation/asciidoc/microcontrollers/pico-series/images/pico-2-r4-pinout.svg b/documentation/asciidoc/microcontrollers/pico-series/images/pico-2-r4-pinout.svg new file mode 100644 index 000000000..be839bab9 --- /dev/null +++ b/documentation/asciidoc/microcontrollers/pico-series/images/pico-2-r4-pinout.svg @@ -0,0 +1,1816 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 2 + + + 39 + + + DEBUG + + + 1 + + + LED + + + USB + + + BOOTSEL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/asciidoc/microcontrollers/pico-series/images/pico-2.png b/documentation/asciidoc/microcontrollers/pico-series/images/pico-2.png new file mode 100644 index 000000000..6b0c28246 Binary files /dev/null and b/documentation/asciidoc/microcontrollers/pico-series/images/pico-2.png differ diff --git a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/pico-pinout.svg b/documentation/asciidoc/microcontrollers/pico-series/images/pico-pinout.svg similarity index 100% rename from documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/pico-pinout.svg rename to documentation/asciidoc/microcontrollers/pico-series/images/pico-pinout.svg diff --git a/documentation/asciidoc/microcontrollers/pico-series/images/pico2w-pinout.png b/documentation/asciidoc/microcontrollers/pico-series/images/pico2w-pinout.png new file mode 100644 index 000000000..d130346b5 Binary files /dev/null and b/documentation/asciidoc/microcontrollers/pico-series/images/pico2w-pinout.png differ diff --git a/documentation/asciidoc/microcontrollers/pico-series/images/pico2w-pinout.svg b/documentation/asciidoc/microcontrollers/pico-series/images/pico2w-pinout.svg new file mode 100644 index 000000000..50faeacd5 --- /dev/null +++ b/documentation/asciidoc/microcontrollers/pico-series/images/pico2w-pinout.svg @@ -0,0 +1,9360 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/picow-pinout.svg b/documentation/asciidoc/microcontrollers/pico-series/images/picow-pinout.svg similarity index 100% rename from documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/picow-pinout.svg rename to documentation/asciidoc/microcontrollers/pico-series/images/picow-pinout.svg diff --git a/documentation/asciidoc/microcontrollers/pico-series/utilities.adoc b/documentation/asciidoc/microcontrollers/pico-series/utilities.adoc new file mode 100644 index 000000000..532f8f6b3 --- /dev/null +++ b/documentation/asciidoc/microcontrollers/pico-series/utilities.adoc @@ -0,0 +1,30 @@ +== Software Utilities + +=== What is on your Pico-series device? + +If you are unsure what is programmed into your Raspberry Pi Pico-series device, and the program was built using the Pico C/{cpp} SDK, it will usually have a name and other useful information embedded into the binary. You can use the https://github.com/raspberrypi/picotool[Picotool] command line utility to find out these details. Full instructions on how to use Picotool to do this are available in our 'https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[getting started]' documentation. + +* Go to the https://github.com/raspberrypi/picotool[Picotool Github repository]. + +=== Debugging using another Pico-series device + +You can use one Pico-series device to debug another Pico-series device. This is possible via `debugprobe`, an application that allows a Pico to act as a USB → SWD and UART converter. + +You can find the latest release of the firmware in https://github.com/raspberrypi/debugprobe/releases/latest[the debugprobe GitHub repository]. + +Download `debugprobe_on_pico.uf2` (for Pico) or `debugprobe_on_pico2.uf2` (for Pico 2) from the latest release. + +Push and hold the BOOTSEL button as you plug the debugger device into your computer to mount a volume called "RPI-RP2". + +Copy the UF2 file onto the volume. The volume will dismount automatically after the file finishes copying onto the device. + +Your device will reboot and now runs an updated version of the `debugprobe` firmware. It is now ready for debugging. + +TIP: For instructions on how to use the debugger, see https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting Started with Pico-series Microcontrollers]. + +=== Resetting Flash memory + +For Pico-series devices, BOOTSEL mode lives in read-only memory inside the RP2040 or RP2350 chip, and can't be overwritten accidentally. No matter what, if you hold down the BOOTSEL button when you plug in your Pico, it will appear as a drive onto which you can drag a new UF2 file. There is no way to brick the board through software. However, there are some circumstances where you might want to make sure your flash memory is empty. You can do this by dragging and dropping a special UF2 binary onto your Pico when it is in mass storage mode. + +* Download the https://datasheets.raspberrypi.com/soft/flash_nuke.uf2[UF2 file] +* See the https://github.com/raspberrypi/pico-examples/blob/master/flash/nuke/nuke.c[code on Github] diff --git a/documentation/asciidoc/microcontrollers/raspberry-pi-pico.adoc b/documentation/asciidoc/microcontrollers/raspberry-pi-pico.adoc deleted file mode 100644 index 2cbfa4d21..000000000 --- a/documentation/asciidoc/microcontrollers/raspberry-pi-pico.adoc +++ /dev/null @@ -1,5 +0,0 @@ -include::raspberry-pi-pico/about_pico.adoc[] - -include::microcontroller_docs.adoc[] - -include::raspberry-pi-pico/utilities.adoc[] diff --git a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/about_pico.adoc b/documentation/asciidoc/microcontrollers/raspberry-pi-pico/about_pico.adoc deleted file mode 100644 index 4fd212239..000000000 --- a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/about_pico.adoc +++ /dev/null @@ -1,77 +0,0 @@ -== The family - -image::images/four_picos.jpg[width="75%"] - -The Raspberry Pi Pico family currently consists of four boards; Raspberry Pi Pico (far left), Pico H (middle left), Pico W (middle right), and Pico WH (far right). - -[[technical-specification]] -== Raspberry Pi Pico and Pico H - -Raspberry Pi Pico is a low-cost, high-performance microcontroller board with flexible digital interfaces. Key features include: - -* xref:rp2040.adoc#welcome-to-rp2040[RP2040] microcontroller chip designed by Raspberry Pi in the United Kingdom -* Dual-core Arm Cortex M0+ processor, flexible clock running up to 133 MHz -* 264kB of SRAM, and 2MB of on-board flash memory -* USB 1.1 with device and host support -* Low-power sleep and dormant modes -* Drag-and-drop programming using mass storage over USB -* 26 × multi-function GPIO pins -* 2 × SPI, 2 × I2C, 2 × UART, 3 × 12-bit ADC, 16 × controllable PWM channels -* Accurate clock and timer on-chip -* Temperature sensor -* Accelerated floating-point libraries on-chip -* 8 × Programmable I/O (PIO) state machines for custom peripheral support - -The Raspberry Pi Pico comes as a castellated module allows soldering direct to carrier boards, while the Pico H comes with pre-soldered headers. - -NOTE: Both boards have a three pin Serial Wire Debug (SWD) header. However, the Pico H has this broken out into a small, keyed, https://datasheets.raspberrypi.com/debug/debug-connector-specification.pdf[3-pin connector] while the Pico has three castellated through-hole pins adjacent to the edge of the board. - -=== Pinout and design files - -image::images/pico-pinout.svg[] - -* Download the https://datasheets.raspberrypi.com/pico/Pico-R3-A4-Pinout.pdf[Pinout Diagram] (PDF) -* Download https://datasheets.raspberrypi.com/pico/RPi-Pico-R3-PUBLIC-20200119.zip[Design Files] (Cadence Allegro) -* Download https://datasheets.raspberrypi.com/pico/Pico-R3-step.zip[STEP File] -* Download https://datasheets.raspberrypi.com/pico/Pico-R3-Fritzing.fzpz[Fritzing Part] for Raspberry Pi Pico -* Download https://datasheets.raspberrypi.com/pico/PicoH-Fritzing.fzpz[Fritzing Part] for Raspberry Pi Pico H - -NOTE: More information on Fritzing is available on the https://fritzing.org/[fritzing.org] website. - -== Raspberry Pi Pico W and Pico WH - -Raspberry Pi Pico W adds on-board single-band 2.4GHz wireless interfaces (802.11n) using the Infineon CYW43439 while retaining the Pico form factor. The on-board 2.4GHz wireless interface has the following features: - -* Wireless (802.11n), single-band (2.4 GHz) -* WPA3 -* Soft access point supporting up to four clients -* Bluetooth 5.2 -** Support for Bluetooth LE Central and Peripheral roles -** Support for Bluetooth Classic - -The antenna is an onboard antenna licensed from ABRACON (formerly ProAnt). The wireless interface is connected via -SPI to the xref:rp2040.adoc#welcome-to-rp2040[RP2040] microcontroller. - -Due to pin limitations, some of the wireless interface pins are shared. The CLK is shared with VSYS monitor, so only -when there isn’t an SPI transaction in progress can VSYS be read via the ADC. The Infineon CYW43439 DIN/DOUT and -IRQ all share one pin on the RP2040. Only when an SPI transaction isn’t in progress is it suitable to check for IRQs. The -interface typically runs at 33MHz. - -For best wireless performance, the antenna should be in free space. For instance, putting metal under or close by the -antenna can reduce its performance both in terms of gain and bandwidth. Adding grounded metal to the sides of the -antenna can improve the antenna’s bandwidth. - -NOTE: The CYW43439 wireless chip is connected via SPI to the RP2040.The CYW43439 supports both 802.11 wireless and Bluetooth over this interface. - -IMPORTANT: By default `libcyw43` is licensed for non-commercial use, but Pico W users, and anyone else who builds their product around RP2040 and CYW43439, benefit from a free https://github.com/georgerobotics/cyw43-driver/blob/195dfcc10bb6f379e3dea45147590db2203d3c7b/LICENSE.RP[commercial-use license]. - -IMPORTANT: In addition to the https://github.com/bluekitchen/btstack/blob/master/LICENSE[standard BTstack licensing] terms, a https://github.com/raspberrypi/pico-sdk/blob/master/src/rp2_common/pico_btstack/LICENSE.RP[supplemental licence] which covers commercial use of BTstack with Raspberry Pi Pico W or Raspberry Pi Pico WH is provided. - -=== Pinout and design files - -image::images/picow-pinout.svg[] - -* Download the https://datasheets.raspberrypi.com/picow/PicoW-A4-Pinout.pdf[Pinout Diagram] (PDF) -* Download https://datasheets.raspberrypi.com/picow/RPi-PicoW-PUBLIC-20220607.zip[Design Files] (Cadence Allegro) -* Download https://datasheets.raspberrypi.com/picow/PicoW-step.zip[STEP File] -* Download https://datasheets.raspberrypi.com/picow/PicoW-Fritzing.fzpz[Fritzing Part] for Raspberry Pi Pico W diff --git a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/four_picos.jpg b/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/four_picos.jpg deleted file mode 100644 index 45836d9bb..000000000 Binary files a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/four_picos.jpg and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/three_picos.jpg b/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/three_picos.jpg deleted file mode 100644 index 9099585b4..000000000 Binary files a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/images/three_picos.jpg and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/utilities.adoc b/documentation/asciidoc/microcontrollers/raspberry-pi-pico/utilities.adoc deleted file mode 100644 index 5f2748749..000000000 --- a/documentation/asciidoc/microcontrollers/raspberry-pi-pico/utilities.adoc +++ /dev/null @@ -1,21 +0,0 @@ -== Software Utilities - -=== What is on your Pico? - -If you have forgotten what has been programmed into your Raspberry Pi Pico, and the program was built using our Pico C/{cpp} SDK, it will usually have a name and other useful information embedded into the binary. You can use the https://github.com/raspberrypi/picotool[Picotool] command line utility to find out these details. Full instructions on how to use Picotool to do this are available in our 'https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[getting started]' documentation. - -* Go to the https://github.com/raspberrypi/picotool[Picotool Github repository]. - -=== Debugging using another Raspberry Pi Pico - -It is possible to use one Raspberry Pi Pico to debug another Pico. This is possible via debugprobe, an application that allows a Pico to act as a USB → SWD and UART converter. This makes it easy to use a Pico on non-Raspberry Pi platforms such as Windows, Mac, and Linux computers where you don’t have GPIOs to connect directly to your Pico. Full instructions on how to use debugprobe to do this are available in our 'https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[getting started]' documentation. - -* Download the https://github.com/raspberrypi/debugprobe/releases/latest/download/debugprobe_on_pico.uf2[UF2 file] -* Go to the https://github.com/raspberrypi/debugprobe[Debug Probe Github repository] - -=== Resetting Flash memory - -Pico's BOOTSEL mode lives in read-only memory inside the RP2040 chip, and can't be overwritten accidentally. No matter what, if you hold down the BOOTSEL button when you plug in your Pico, it will appear as a drive onto which you can drag a new UF2 file. There is no way to brick the board through software. However, there are some circumstances where you might want to make sure your Flash memory is empty. You can do this by dragging and dropping a special UF2 binary onto your Pico when it is in mass storage mode. - -* Download the https://datasheets.raspberrypi.com/soft/flash_nuke.uf2[UF2 file] -* See the https://github.com/raspberrypi/pico-examples/blob/master/flash/nuke/nuke.c[code on Github] diff --git a/documentation/asciidoc/microcontrollers/rp1.adoc b/documentation/asciidoc/microcontrollers/rp1.adoc deleted file mode 100644 index 043280982..000000000 --- a/documentation/asciidoc/microcontrollers/rp1.adoc +++ /dev/null @@ -1 +0,0 @@ -include::rp1/about_rp1.adoc[] diff --git a/documentation/asciidoc/microcontrollers/rp1/images/rp1.jpg b/documentation/asciidoc/microcontrollers/rp1/images/rp1.jpg deleted file mode 100644 index 63b872af3..000000000 Binary files a/documentation/asciidoc/microcontrollers/rp1/images/rp1.jpg and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/rp2040.adoc b/documentation/asciidoc/microcontrollers/rp2040.adoc deleted file mode 100644 index c69627bc0..000000000 --- a/documentation/asciidoc/microcontrollers/rp2040.adoc +++ /dev/null @@ -1,9 +0,0 @@ -include::rp2040/about_rp2040.adoc[] - -include::rp2040/technical_specification.adoc[] - -include::rp2040/temp_sensor.adoc[] - -include::microcontroller_docs.adoc[] - -include::rp2040/rp2040_based_boards.adoc[] diff --git a/documentation/asciidoc/microcontrollers/rp2040/about_rp2040.adoc b/documentation/asciidoc/microcontrollers/rp2040/about_rp2040.adoc deleted file mode 100644 index 671d85523..000000000 --- a/documentation/asciidoc/microcontrollers/rp2040/about_rp2040.adoc +++ /dev/null @@ -1,7 +0,0 @@ -== Welcome to RP2040 - -Welcome to RP2040, a microcontroller designed here at Raspberry Pi. - -image::images/rp2040.jpg[] - -Whether you have a xref:raspberry-pi-pico.adoc#technical-specification[Raspberry Pi Pico] or another RP2040-based microcontroller board, everything you need to get started is here. You'll find support for getting started with xref:c_sdk.adoc#sdk-setup[C/{cpp}] or xref:micropython.adoc#what-is-micropython[MicroPython] on Raspberry Pi Pico, and links to resources for other boards that use RP2040. There are also links to the technical documentation for both the Raspberry Pi Pico microcontroller board and our RP2040 microcontroller chip. diff --git a/documentation/asciidoc/microcontrollers/rp2040/images/pico_family.jpg b/documentation/asciidoc/microcontrollers/rp2040/images/pico_family.jpg deleted file mode 100644 index 45836d9bb..000000000 Binary files a/documentation/asciidoc/microcontrollers/rp2040/images/pico_family.jpg and /dev/null differ diff --git a/documentation/asciidoc/microcontrollers/rp2040/rp2040_based_boards.adoc b/documentation/asciidoc/microcontrollers/rp2040/rp2040_based_boards.adoc deleted file mode 100644 index b4c9d171a..000000000 --- a/documentation/asciidoc/microcontrollers/rp2040/rp2040_based_boards.adoc +++ /dev/null @@ -1,30 +0,0 @@ -== RP2040-based Boards - -Designed by Raspberry Pi as both a development board, and as a reference design, the xref:raspberry-pi-pico.adoc[Raspberry Pi Pico] series is a family of RP2040-based boards. The Pico family currently consists of Raspberry Pi Pico (far left), Pico H (left), Pico W (right), and Pico WH (far right). - -image::images/pico_family.jpg[width="75%"] - -The design files for Raspberry Pi Pico and Pico W are available openly, with no limitations. - -* Download https://datasheets.raspberrypi.com/pico/RPi-Pico-R3-PUBLIC-20200119.zip[Design Files] for Raspberry Pi Pico (Cadence Allegro) -* Download https://datasheets.raspberrypi.com/picow/RPi-PicoW-PUBLIC-20220607.zip[Design Files] for Raspberry Pi Pico W (Cadence Allegro) - -Permission to use, copy, modify, and/or distribute this design for any purpose with or without fee is hereby granted. - -THE DESIGN IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS DESIGN INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS DESIGN. - -=== Other Boards - -You can find discussions around third-party RP2040-based boards on the https://forums.raspberrypi.com/viewforum.php?f=147[Raspberry Pi forums]. - -==== USB PIDs - -Many RP2040-based devices use Raspberry Pi's USB Vendor ID and Product ID combination. If you build a third-party board based on RP2040, you may require a unique USB Product ID (PID). - -You might need a unique USB PID if you need to provide a custom driver for Windows users. - -USB-IF have given Raspberry Pi permission to license USB product ID values for its Vendor ID (`0x2E8A`) for common silicon components used with RP2040. - -To reserve a USB PID associated with Raspberry Pi's vendor ID, follow the instructions in the https://github.com/raspberrypi/usb-pid[Raspberry Pi USB PID git repository]. - -NOTE: If you use the standard RP2040 PID, you can use the `iManufacturer`, `iProduct`, and `iSerial` strings to uniquely identify your device. diff --git a/documentation/asciidoc/microcontrollers/rp2040/technical_specification.adoc b/documentation/asciidoc/microcontrollers/rp2040/technical_specification.adoc deleted file mode 100644 index 1ab0ea4c7..000000000 --- a/documentation/asciidoc/microcontrollers/rp2040/technical_specification.adoc +++ /dev/null @@ -1,59 +0,0 @@ -== Technical Specification - -RP2040 is the debut microcontroller from Raspberry Pi. It brings our signature values of high performance, low cost, -and ease of use to the microcontroller space. - -With a large on-chip memory, symmetric dual-core processor complex, deterministic bus fabric, and rich peripheral set -augmented with our unique Programmable I/O (PIO) subsystem, it provides professional users with unrivalled power -and flexibility. With detailed documentation, a polished MicroPython port, and a UF2 bootloader in ROM, it has the -lowest possible barrier to entry for beginner and hobbyist users. - -RP2040 is a stateless device, with support for cached execute-in-place from external QSPI memory. This design -decision allows you to choose the appropriate density of non-volatile storage for your application, and to benefit from -the low pricing of commodity flash parts. - -RP2040 is manufactured on a modern 40nm process node, delivering high performance, low dynamic power -consumption, and low leakage, with a variety of low-power modes to support extended-duration operation on battery -power - -Key features: - -* Dual ARM Cortex-M0+ @ 133MHz -* 264kB on-chip SRAM in six independent banks -* Support for up to 16MB of off-chip Flash memory via dedicated QSPI bus -* DMA controller -* Fully-connected AHB crossbar -* Interpolator and integer divider peripherals -* On-chip programmable LDO to generate core voltage -* 2 on-chip PLLs to generate USB and core clocks -* 30 GPIO pins, 4 of which can be used as analogue inputs -* Peripherals -** 2 UARTs -** 2 SPI controllers -** 2 I2C controllers -** 16 PWM channels -** 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] -**** -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). - -For many use cases where minimal current draw is required, the best option is to power off the system (or the RP2040 part of the system) completely if possible. This application note gives a couple of options for how this can be done, and these circuits are simple enough that a designer can adjust them for their own use case. -**** - -=== Why is the chip called RP2040? - -The post-fix numeral on RP2040 comes from the following, - -image::images/rp2040_explanation.svg[width=640] - -. Number of processor cores (2) -. Loosely which type of processor (M0+) -. floor(log2(ram / 16k)) -. floor(log2(nonvolatile / 16k)) or 0 if no onboard nonvolatile storage - -=== Design Files - -* Download https://datasheets.raspberrypi.com/rp2040/Minimal-KiCAD.zip[Minimal Viable Board] Design Files (KiCad) -* Download https://datasheets.raspberrypi.com/rp2040/VGA-KiCAD.zip[VGA Carrier Board] Design Files (KiCad) diff --git a/documentation/asciidoc/microcontrollers/rp2040/temp_sensor.adoc b/documentation/asciidoc/microcontrollers/rp2040/temp_sensor.adoc deleted file mode 100644 index e24289053..000000000 --- a/documentation/asciidoc/microcontrollers/rp2040/temp_sensor.adoc +++ /dev/null @@ -1,9 +0,0 @@ -== Internal Temperature Sensor - -The internal temperature sensor in the RP2040 package is a low-resolution sensor that needs to be user-calibrated to be useful to any degree of accuracy. - -A crucial part of accurately determining the temperature measured is knowing the ADC VREF voltage. The conversion formula means that small errors in the ADC VREF voltage can give quite large discrepancies in temperature calculated. The RP2040 doesn't have an internal Fixed Voltage Reference which can be used to determine VREF voltage so VREF voltage needs to be measured manually - with the caveat it could change - or an external Fixed Voltage Reference needs to be provided. - -NOTE: The RP2040 sensor voltage falls as temperature rises. - -See Chapter 4, section 4.9.5 of the https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf[RP2040 Datasheet] for further details of the internal temperature sensor. \ No newline at end of file diff --git a/documentation/asciidoc/microcontrollers/silicon.adoc b/documentation/asciidoc/microcontrollers/silicon.adoc new file mode 100644 index 000000000..ae4236834 --- /dev/null +++ b/documentation/asciidoc/microcontrollers/silicon.adoc @@ -0,0 +1,8 @@ +include::silicon/rp2350.adoc[] + +include::silicon/rp2040.adoc[] + +include::silicon/rp1.adoc[] + +include::microcontroller_docs.adoc[] + diff --git a/documentation/asciidoc/microcontrollers/rp2040/images/pico.jpg b/documentation/asciidoc/microcontrollers/silicon/images/pico.jpg similarity index 100% rename from documentation/asciidoc/microcontrollers/rp2040/images/pico.jpg rename to documentation/asciidoc/microcontrollers/silicon/images/pico.jpg diff --git a/documentation/asciidoc/microcontrollers/silicon/images/rp1.jpg b/documentation/asciidoc/microcontrollers/silicon/images/rp1.jpg new file mode 100644 index 000000000..bf7b21eea Binary files /dev/null and b/documentation/asciidoc/microcontrollers/silicon/images/rp1.jpg differ diff --git a/documentation/asciidoc/microcontrollers/rp2040/images/rp2040.jpg b/documentation/asciidoc/microcontrollers/silicon/images/rp2040.jpg similarity index 100% rename from documentation/asciidoc/microcontrollers/rp2040/images/rp2040.jpg rename to documentation/asciidoc/microcontrollers/silicon/images/rp2040.jpg diff --git a/documentation/asciidoc/microcontrollers/rp2040/images/rp2040_explanation.svg b/documentation/asciidoc/microcontrollers/silicon/images/rp2040_explanation.svg similarity index 100% rename from documentation/asciidoc/microcontrollers/rp2040/images/rp2040_explanation.svg rename to documentation/asciidoc/microcontrollers/silicon/images/rp2040_explanation.svg diff --git a/documentation/asciidoc/microcontrollers/silicon/images/rp2350.png b/documentation/asciidoc/microcontrollers/silicon/images/rp2350.png new file mode 100644 index 000000000..a824c6647 Binary files /dev/null and b/documentation/asciidoc/microcontrollers/silicon/images/rp2350.png differ diff --git a/documentation/asciidoc/microcontrollers/silicon/images/rp2350_explanation.svg b/documentation/asciidoc/microcontrollers/silicon/images/rp2350_explanation.svg new file mode 100644 index 000000000..5eae2b251 --- /dev/null +++ b/documentation/asciidoc/microcontrollers/silicon/images/rp2350_explanation.svg @@ -0,0 +1,376 @@ + + + + + + + + + + + + + + + + + RP 2 3 5 0  + + + + + + + + + + + + + + + + + + Raspberry Pi + + + + + + + + + + + + + + + Number of cores + + + + + + + + + + Type of core (e.g. Cortex-M33) + + + + + + + + + + floor(log2(RAM / 16 kB)) + + floor(log2(nonvolatile / 128 kB)) + + diff --git a/documentation/asciidoc/microcontrollers/rp1/about_rp1.adoc b/documentation/asciidoc/microcontrollers/silicon/rp1.adoc similarity index 92% rename from documentation/asciidoc/microcontrollers/rp1/about_rp1.adoc rename to documentation/asciidoc/microcontrollers/silicon/rp1.adoc index ba83f96c3..c6e66772b 100644 --- a/documentation/asciidoc/microcontrollers/rp1/about_rp1.adoc +++ b/documentation/asciidoc/microcontrollers/silicon/rp1.adoc @@ -1,12 +1,14 @@ -== About RP1 +== RP1 + +[[about-rp1]] .Architecture image::images/rp1.jpg[alt="Architecture diagram of the RP1",width="70%"] RP1 is a 12×12mm, 0.65mm-pitch BGA southbridge, which provides the majority of the I/O capabilities for Raspberry Pi 5. -video::aioB40BGQYU[youtube] +video::aioB40BGQYU[youtube,width=80%,height=400px] It provides: diff --git a/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc b/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc new file mode 100644 index 000000000..f80c1c515 --- /dev/null +++ b/documentation/asciidoc/microcontrollers/silicon/rp2040.adoc @@ -0,0 +1,106 @@ +== RP2040 + +RP2040 is a microcontroller designed by Raspberry Pi. + +image::images/rp2040.jpg[] + +Whether you have a xref:pico-series.adoc#pico-1-technical-specification[Raspberry Pi Pico 1] or another RP2040-based microcontroller board, everything you need to get started is here. You'll find support for getting started with xref:c_sdk.adoc#sdk-setup[C/{cpp}] or xref:micropython.adoc#what-is-micropython[MicroPython] on Raspberry Pi Pico, and links to resources for other boards that use RP2040. There are also links to the technical documentation for both the Raspberry Pi Pico microcontroller board and our RP2040 microcontroller chip. + +=== Why is the chip called RP2040? + +The post-fix numeral on RP2040 comes from the following, + +image::images/rp2040_explanation.svg[width=640] + +. Number of processor cores (2) +. Loosely which type of processor (M0+) +. floor(log2(RAM / 16k)) +. floor(log2(nonvolatile / 16k)) or 0 if no onboard nonvolatile storage + +=== Technical Specification + +RP2040 is the debut microcontroller from Raspberry Pi. It brings our signature values of high performance, low cost, +and ease of use to the microcontroller space. + +With a large on-chip memory, symmetric dual-core processor complex, deterministic bus fabric, and rich peripheral set +augmented with our unique Programmable I/O (PIO) subsystem, it provides professional users with unrivalled power +and flexibility. With detailed documentation, a polished MicroPython port, and a UF2 bootloader in ROM, it has the +lowest possible barrier to entry for beginner and hobbyist users. + +RP2040 is a stateless device, with support for cached execute-in-place from external QSPI memory. This design +decision allows you to choose the appropriate density of non-volatile storage for your application, and to benefit from +the low pricing of commodity flash parts. + +RP2040 is manufactured on a modern 40nm process node, delivering high performance, low dynamic power +consumption, and low leakage, with a variety of low-power modes to support extended-duration operation on battery +power + +Key features: + +* Dual Arm Cortex-M0+ @ 133MHz +* 264kB on-chip SRAM in six independent banks +* Support for up to 16MB of off-chip Flash memory via dedicated QSPI bus +* DMA controller +* Fully-connected AHB crossbar +* Interpolator and integer divider peripherals +* On-chip programmable LDO to generate core voltage +* 2 on-chip PLLs to generate USB and core clocks +* 30 GPIO pins, 4 of which can be used as analogue inputs +* Peripherals +** 2 UARTs +** 2 SPI controllers +** 2 I2C controllers +** 16 PWM channels +** 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/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). + +For many use cases where minimal current draw is required, the best option is to power off the system (or the RP2040 part of the system) completely if possible. This application note gives a couple of options for how this can be done, and these circuits are simple enough that a designer can adjust them for their own use case. +**** + +==== Design Files + +* Download https://datasheets.raspberrypi.com/rp2040/Minimal-KiCAD.zip[Minimal Viable Board] Design Files (KiCad) +* Download https://datasheets.raspberrypi.com/rp2040/VGA-KiCAD.zip[VGA Carrier Board] Design Files (KiCad) + +=== RP2040-based Boards + +Designed by Raspberry Pi as both a development board, and as a reference design, the xref:pico-series.adoc#pico-1-family[Raspberry Pi Pico 1] is a family of RP2040-based boards. + +The design files for Raspberry Pi Pico and Pico W are available openly, with no limitations. + +* Download https://datasheets.raspberrypi.com/pico/RPi-Pico-R3-PUBLIC-20200119.zip[Design Files] for Raspberry Pi Pico (Cadence Allegro) +* Download https://datasheets.raspberrypi.com/picow/RPi-PicoW-PUBLIC-20220607.zip[Design Files] for Raspberry Pi Pico W (Cadence Allegro) + +Permission to use, copy, modify, and/or distribute this design for any purpose with or without fee is hereby granted. + +THE DESIGN IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS DESIGN INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS DESIGN. + +==== Other Boards + +You can find discussions around third-party RP2040-based boards on the https://forums.raspberrypi.com/viewforum.php?f=147[Raspberry Pi forums]. + +==== USB PIDs + +Many RP2040-based devices use Raspberry Pi's USB Vendor ID and Product ID combination. If you build a third-party board based on RP2040, you may require a unique USB Product ID (PID). + +You might need a unique USB PID if you need to provide a custom driver for Windows users. + +USB-IF have given Raspberry Pi permission to license USB product ID values for its Vendor ID (`0x2E8A`) for common silicon components used with RP2040. + +To reserve a USB PID associated with Raspberry Pi's vendor ID, follow the instructions in the https://github.com/raspberrypi/usb-pid[Raspberry Pi USB PID git repository]. + +NOTE: If you use the standard RP2040 PID, you can use the `iManufacturer`, `iProduct`, and `iSerial` strings to uniquely identify your device. + +=== Internal Temperature Sensor + +The internal temperature sensor in the RP2040 package is a low-resolution sensor that needs to be user-calibrated to be useful to any degree of accuracy. + +A crucial part of accurately determining the temperature measured is knowing the ADC VREF voltage. The conversion formula means that small errors in the ADC VREF voltage can give quite large discrepancies in temperature calculated. The RP2040 doesn't have an internal Fixed Voltage Reference which can be used to determine VREF voltage so VREF voltage needs to be measured manually - with the caveat it could change - or an external Fixed Voltage Reference needs to be provided. + +NOTE: The RP2040 sensor voltage falls as temperature rises. + +See Chapter 4, section 4.9.5 of the https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf[RP2040 Datasheet] for further details of the internal temperature sensor. diff --git a/documentation/asciidoc/microcontrollers/silicon/rp2350.adoc b/documentation/asciidoc/microcontrollers/silicon/rp2350.adoc new file mode 100644 index 000000000..23508f7c1 --- /dev/null +++ b/documentation/asciidoc/microcontrollers/silicon/rp2350.adoc @@ -0,0 +1,85 @@ +== RP2350 + +RP2350 is a microcontroller designed by Raspberry Pi. + +image::images/rp2350.png[] + +Whether you have a xref:pico-series.adoc#pico-2-technical-specification[Raspberry Pi Pico 2] or another RP2350-based microcontroller board, everything you need to get started is here. You'll find support for getting started with xref:c_sdk.adoc#sdk-setup[C/{cpp}] or xref:micropython.adoc#what-is-micropython[MicroPython] on Raspberry Pi Pico 2, and links to resources for other boards that use RP2350. There are also links to the technical documentation for both the Raspberry Pi Pico 2 microcontroller board and our RP2350 microcontroller chip. + +=== Why is the chip called RP2350? + +The post-fix numeral on RP2350 comes from the following, + +image::images/rp2350_explanation.svg[width=640] + +. Number of processor cores (2) +. Loosely which type of processor (M33) +. floor(log2(RAM / 16KB)) +. floor(log2(nonvolatile / 128KB)) or 0 if no onboard nonvolatile storage + +=== Technical Specification + +RP2350 is a high-performance, secure, low-cost, easy-to-use microcontroller from Raspberry Pi. + +With a large on-chip memory, symmetric dual-core processor complex, deterministic bus fabric, and rich peripheral set augmented with our unique Programmable I/O (PIO) subsystem, it provides professional users with unrivalled power and flexibility. With detailed documentation, a polished MicroPython port, and a UF2 bootloader in ROM, it has the lowest possible barrier to entry for beginner and hobbyist users. + +RP2350 is a stateless device, with support for cached execute-in-place from external QSPI memory. This design decision allows you to choose the appropriate density of non-volatile storage for your application, and to benefit from the low pricing of commodity flash parts. + +RP2350 is manufactured on a modern 40nm process node, delivering high performance, low dynamic power consumption, and low leakage, with a variety of low-power modes to support extended-duration operation on battery power. + +Key features include: + +* Dual Cortex-M33 or Hazard3 processors at up to 150MHz +* 520KB multi-bank high performance SRAM +* Support for up to 16MB of off-chip Flash memory via dedicated QSPI bus +* DMA controller +* Fully-connected AHB crossbar +* On-chip programmable LDO to generate core voltage +* 2 on-chip PLLs to generate USB and core clocks +* 30 GPIO pins, 4 of which can be used as analogue inputs +* Peripherals +** 2 UARTs +** 2 SPI controllers +** 2 I2C controllers +** 24 PWM channels +** USB 1.1 controller and PHY, with host and device support +** 3 Programmable IO (PIO) blocks, 12 state machines total + +==== Security + +RP2350 has a comprehensive security architecture, built around Arm TrustZone for Cortex-M, including the following features: + +* Signed boot support +* 8KB of on-chip antifuse one-time-programmable (OTP) memory +* SHA-256 acceleration +* A hardware true random number generator (TRNG) + +==== Architecture Switching + +RP2350 includes a pair of open-hardware Hazard3 RISC-V cores which can be substituted at boot time for the Cortex-M33 cores. Our boot ROM can even auto-detect the architecture for which a second-stage binary has been built and reboot the chip into the appropriate mode. All features of the chip, apart from a handful of security features, and the double-precision floating-point accelerator, are available in RISC-V mode. + +=== RP2350-based Boards + +Designed by Raspberry Pi as both a development board, and as a reference design, the xref:pico-series.adoc#pico-2-technical-specification[Raspberry Pi Pico 2] is based on the RP2350. + +Permission to use, copy, modify, and/or distribute this design for any purpose with or without fee is hereby granted. + +THE DESIGN IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS DESIGN INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS DESIGN. + +==== Other Boards + +You can find discussions around third-party RP2350-based boards on the https://forums.raspberrypi.com/viewforum.php?f=147[Raspberry Pi forums]. + +==== USB PIDs + +Many RP2350-based devices use Raspberry Pi's USB Vendor ID and Product ID combination. If you build a third-party board based on RP2350, you may require a unique USB Product ID (PID). + +You might need a unique USB PID if you need to provide a custom driver for Windows users. + +USB-IF have given Raspberry Pi permission to license USB product ID values for its Vendor ID (`0x2E8A`) for common silicon components used with RP2350. + +To reserve a USB PID associated with Raspberry Pi's vendor ID, follow the instructions in the https://github.com/raspberrypi/usb-pid[Raspberry Pi USB PID git repository]. + +NOTE: If you use the standard RP2350 PID, you can use the `iManufacturer`, `iProduct`, and `iSerial` strings to uniquely identify your device. + + 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.adoc b/documentation/asciidoc/services/connect.adoc new file mode 100644 index 000000000..1b6adb991 --- /dev/null +++ b/documentation/asciidoc/services/connect.adoc @@ -0,0 +1,9 @@ +include::connect/introduction.adoc[] + +include::connect/install.adoc[] + +include::connect/use.adoc[] + +include::connect/troubleshooting.adoc[] + +include::connect/security.adoc[] diff --git a/documentation/asciidoc/services/connect/images/browser-sign-in.png b/documentation/asciidoc/services/connect/images/browser-sign-in.png new file mode 100644 index 000000000..81bbb213a Binary files /dev/null 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/device.png b/documentation/asciidoc/services/connect/images/device.png new file mode 100644 index 000000000..a3bef029d Binary files /dev/null and b/documentation/asciidoc/services/connect/images/device.png differ diff --git a/documentation/asciidoc/services/connect/images/devices.png b/documentation/asciidoc/services/connect/images/devices.png new file mode 100644 index 000000000..c6f9d48f1 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/devices.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 new file mode 100644 index 000000000..dffe0f5ec Binary files /dev/null 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 new file mode 100644 index 000000000..5deb8a2bf Binary files /dev/null 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 new file mode 100644 index 000000000..b1a0b9841 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/hero.png differ diff --git a/documentation/asciidoc/services/connect/images/new-device.png b/documentation/asciidoc/services/connect/images/new-device.png new file mode 100644 index 000000000..08b794e71 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/new-device.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-disabled.png b/documentation/asciidoc/services/connect/images/remote-shell-disabled.png new file mode 100644 index 000000000..1196bf4fa Binary files /dev/null and b/documentation/asciidoc/services/connect/images/remote-shell-disabled.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-ended.png b/documentation/asciidoc/services/connect/images/remote-shell-ended.png new file mode 100644 index 000000000..0f4ce1f43 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/remote-shell-ended.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-in-progress.png b/documentation/asciidoc/services/connect/images/remote-shell-in-progress.png new file mode 100644 index 000000000..fc75efc7f Binary files /dev/null and b/documentation/asciidoc/services/connect/images/remote-shell-in-progress.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-notification.png b/documentation/asciidoc/services/connect/images/remote-shell-notification.png new file mode 100644 index 000000000..29d22a96d Binary files /dev/null and b/documentation/asciidoc/services/connect/images/remote-shell-notification.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell.png b/documentation/asciidoc/services/connect/images/remote-shell.png new file mode 100644 index 000000000..398165e17 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/remote-shell.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-disabled.png b/documentation/asciidoc/services/connect/images/screen-sharing-disabled.png new file mode 100644 index 000000000..75c2950f2 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/screen-sharing-disabled.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-ended.png b/documentation/asciidoc/services/connect/images/screen-sharing-ended.png new file mode 100644 index 000000000..58c4190a5 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/screen-sharing-ended.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-in-progress.png b/documentation/asciidoc/services/connect/images/screen-sharing-in-progress.png new file mode 100644 index 000000000..ff840eb8e Binary files /dev/null and b/documentation/asciidoc/services/connect/images/screen-sharing-in-progress.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-notification.png b/documentation/asciidoc/services/connect/images/screen-sharing-notification.png new file mode 100644 index 000000000..54287856f Binary files /dev/null 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 new file mode 100644 index 000000000..18938febd Binary files /dev/null and b/documentation/asciidoc/services/connect/images/screen-sharing.png differ diff --git a/documentation/asciidoc/services/connect/images/sign-in-email.png b/documentation/asciidoc/services/connect/images/sign-in-email.png new file mode 100644 index 000000000..57875a219 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/sign-in-email.png differ diff --git a/documentation/asciidoc/services/connect/images/sign-in.png b/documentation/asciidoc/services/connect/images/sign-in.png new file mode 100644 index 000000000..8a3991925 Binary files /dev/null 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 new file mode 100644 index 000000000..142ad9e3f Binary files /dev/null and b/documentation/asciidoc/services/connect/images/turn-on-connect.png differ diff --git a/documentation/asciidoc/services/connect/images/waiting-for-remote-shell.png b/documentation/asciidoc/services/connect/images/waiting-for-remote-shell.png new file mode 100644 index 000000000..0197088f1 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/waiting-for-remote-shell.png differ diff --git a/documentation/asciidoc/services/connect/images/waiting-for-screen-sharing.png b/documentation/asciidoc/services/connect/images/waiting-for-screen-sharing.png new file mode 100644 index 000000000..87ba5fcec Binary files /dev/null and b/documentation/asciidoc/services/connect/images/waiting-for-screen-sharing.png differ diff --git a/documentation/asciidoc/services/connect/install.adoc b/documentation/asciidoc/services/connect/install.adoc new file mode 100644 index 000000000..321984e02 --- /dev/null +++ b/documentation/asciidoc/services/connect/install.adoc @@ -0,0 +1,36 @@ +[[install-connect-lite]] +== Install Connect Lite + +For Raspberry Pi OS Lite, we distribute an alternate *Lite* variant of Connect that only supports remote shell access, with no ability to screen share. + +Run the following command on your Raspberry Pi to install Connect Lite: + +[source,console] +---- +$ sudo apt install rpi-connect-lite +---- + +After installation, use the `rpi-connect` command line interface to start Connect for your current user: + +[source,console] +---- +$ rpi-connect on +---- + +xref:connect.adoc#enable-remote-shell-at-all-times[Enable user-lingering] to make your device accessible even when your user account isn't logged in. + +== Manually start and stop Connect + +To start Connect or Connect Lite from the command line, run the following command: + +[source,console] +---- +$ rpi-connect on +---- + +To stop Connect, run the following command: + +[source,console] +---- +$ rpi-connect off +---- diff --git a/documentation/asciidoc/services/connect/introduction.adoc b/documentation/asciidoc/services/connect/introduction.adoc new file mode 100644 index 000000000..bfccb6487 --- /dev/null +++ b/documentation/asciidoc/services/connect/introduction.adoc @@ -0,0 +1,13 @@ +== Introduction + +Raspberry Pi Connect provides secure access to your Raspberry Pi from anywhere in the world. + +image::images/hero.png[width="100%"] + +Connect is installed by default in Raspberry Pi OS Desktop and Raspberry Pi OS Full (desktop with recommended software). Raspberry Pi OS Lite doesn't include Connect by default, but you can xref:connect.adoc#install-connect-lite[install Connect Lite]. + +To use Connect, xref:connect.adoc#link-connect[link your device with a Connect account]. Visit https://connect.raspberrypi.com[connect.raspberrypi.com] to access the desktop or a shell running on your Raspberry Pi in a browser window. + +Connect uses a secure, encrypted connection. By default, Connect communicates directly between your Raspberry Pi and your browser. However, when Connect can't establish a direct connection between your Raspberry Pi and your browser, we use a relay server. In such cases, Raspberry Pi only retains the metadata required to operate Connect. + +NOTE: To use Connect, your Raspberry Pi must run https://www.raspberrypi.com/news/bookworm-the-new-version-of-raspberry-pi-os/[Raspberry Pi OS Bookworm] or later. diff --git a/documentation/asciidoc/services/connect/security.adoc b/documentation/asciidoc/services/connect/security.adoc new file mode 100644 index 000000000..356e2a9a8 --- /dev/null +++ b/documentation/asciidoc/services/connect/security.adoc @@ -0,0 +1,17 @@ +== Security + +All connections between Raspberry Pi devices and the user's browser use https://webrtc.org[WebRTC]: the same real-time communication technology used by Zoom, Microsoft Teams, and Google Meet. + +This means that all screen sharing and remote shell access traffic is encrypted using https://en.wikipedia.org/wiki/Datagram_Transport_Layer_Security[DTLS] on the Raspberry Pi device and the user's browser. We don't (and can't) decrypt the traffic, ensuring your data remains private. + +Furthermore, traffic is mostly peer-to-peer, meaning that the encrypted traffic doesn't pass through our infrastructure. Instead, the encrypted traffic is sent directly between your Raspberry Pi device and your browser. This makes it impossible for us to observe it. + +In situations where direct peer-to-peer connections aren't possible (for example, due to networking issues), only encrypted data is relayed through one of our https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT[TURN] servers. These servers are hosted in London and California, and your traffic is routed through the relay closest to you. We don't have the keys to decrypt this data, and it's neither logged nor stored. + +The Raspberry Pi Connect API temporarily stores the IP addresses and ports required to negotiate a peer-to-peer connection. All traffic to this API is encrypted using https://en.wikipedia.org/wiki/HTTPS[HTTP over TLS], supporting only TLS 1.2 and newer for security. This ensures that connection information is never sent in the clear. This metadata is stored securely for at most 1 minute, and deleted as soon as a connection is established. + +Raspberry Pi Connect, along with its API and software components, has undergone security assessments by penetration testing and security analysts at https://cure53.de[Cure53]. + +For more details on WebRTC security, see https://webrtc-security.github.io/[A Study of WebRTC Security]. + +For **Connect for Organisations** customers, we provide an audit log to review activity from the past 90 days. To preserve privacy, we store only the country code when geolocating events by IP address. diff --git a/documentation/asciidoc/services/connect/troubleshooting.adoc b/documentation/asciidoc/services/connect/troubleshooting.adoc new file mode 100644 index 000000000..aaf45e767 --- /dev/null +++ b/documentation/asciidoc/services/connect/troubleshooting.adoc @@ -0,0 +1,227 @@ +== Troubleshooting + +=== Known issues + +* Screen sharing only supports sharing a single, primary display of your Raspberry Pi. When a Raspberry Pi is connected to multiple HDMI screens, Connect sometimes shares the contents of the secondary screen. You can work around this by right-clicking the desktop and changing the location of the taskbar in **Desktop Preferences...**. + +* Connect does not support on-screen keyboards. For full functionality, use a physical keyboard. + +* Connect requires a browser that implements https://caniuse.com/?search=es2022[ECMAScript 2022] (ES13) as it makes use of features unavailable in older browsers. + +* Browsers intercept certain keys and key combinations. As a result, you can't type these keys into your Connect window. Screen sharing includes a toolbar to simulate some of the most popular intercepted keys. + +* Upgrading `rpi-connect` and `rpi-connect-lite` using Connect's remote shell is not supported. The upgrade process will terminate all remote shell sessions and drop all connections. To upgrade Connect in a remote shell session, use a tool like `screen` or `tmux` to ensure the process continues uninterrupted after your connection is closed. + +* To upgrade from version 1 to version 2, you must first upgrade the package you currently have installed before switching between `rpi-connect` and `rpi-connect-lite`. This ensures that Connect's services properly migrate to the version 2 format. If you currently have `rpi-connect` installed, run the following command: ++ +[source,console] +---- +$ sudo apt install --only-upgrade rpi-connect +---- ++ +Alternatively, if you currently have `rpi-connect-lite` installed, run the following command: ++ +[source,console] +---- +$ sudo apt install --only-upgrade rpi-connect-lite +---- ++ +You should see output similar to the following during the upgrade, indicating that Connect's services have migrated to the version 2 format: ++ +[source,console] +---- +Replacing globally-enabled rpi-connect services with user-enabled ones... +---- + +=== Common issues + +==== Screen sharing not available + +If Connect states that screen sharing is unavailable, one or more requirements for screen sharing support are not met. To help debug the problem, `rpi-connect` and `rpi-connect-lite` include the `doctor` command. Use `rpi-connect doctor` to identify issues with screen sharing. + +Run the following command: + +[source,console] +---- +$ rpi-connect doctor +---- + +If all is well, you should see output similar to the following: + +---- +Screen sharing is supported by this version of rpi-connect +✓ Wayland compositor available +✓ Screen sharing services enabled and active +✓ Communication with Raspberry Pi Connect WebSocket server +✓ Communication with Raspberry Pi Connect API +✓ Authentication with Raspberry Pi Connect API +✓ Peer-to-peer connection candidate via STUN +✓ Peer-to-peer connection candidate via TURN +---- + +If there is an issue, you will see something like so: + +---- +Screen sharing is supported by this version of rpi-connect +✓ Wayland compositor available +✗ Screen sharing services enabled and active - Please run rpi-connect on to enable and start all required services +✓ Communication with Raspberry Pi Connect WebSocket server +✓ Communication with Raspberry Pi Connect API +✓ Authentication with Raspberry Pi Connect API +✓ Peer-to-peer connection candidate via STUN +✓ Peer-to-peer connection candidate via TURN + +✗ Some checks failed +---- + +If you have repeated issues trying to run Connect's required services, run the following commands to check their status in more detail: + +[source,console] +---- +$ systemctl --user status rpi-connect-wayvnc.service rpi-connect-wayvnc-watcher.path +$ journalctl --follow --user-unit rpi-connect-wayvnc.service --user-unit rpi-connect-wayvnc-watcher.path +---- + +If the service fails to start or doesn't exist, ensure that your environment meets the following criteria: + +. You use `rpi-connect` version 1.1.0 or later. +. You do not use `rpi-connect-lite`, which lacks screen sharing support. +. You use a Wayland compositor such as wayfire or labwc, not X. You can control this setting via ``raspi-config``'s Advanced Options. +. You use a desktop environment supported by WayVNC, e.g. Raspberry Pi Desktop. For instance, using KDE switches your Wayland compositor to kwin, which is unsupported. +. You have an active graphical desktop session running as the same user as the one you signed into. For most, this means enabling "Desktop Autologin" via ``raspi-config``'s System Options. + +==== Can't connect after restarting or ending SSH session + +Connect runs as a user-level service and is therefore only available if there is an active session for the user signed into the service. If you want remote shell access without also running another login session, xref:connect.adoc#enable-remote-shell-at-all-times[enable user-lingering] for your user, which will keep Connect running at all times. + +For screen sharing, Connect can only share an existing graphical desktop session: it does not create entirely new sessions. There must already be a desktop session in progress. To start such a session automatically on boot, enable Desktop Autologin via ``raspi-config``'s System Options. + +==== Networking and firewall issues + +Connect usually communicates between devices without requiring changes to your network or firewall. However, especially restrictive networks can sometimes block Connect communication. To help debug problems with such networks, `rpi-connect` and `rpi-connect-lite` include the `rpi-connect doctor` command. `rpi-connect doctor` runs a series of tests to check that Connect communication functions properly on your network. + +To run these tests on your device, run the following command: + +[source,console] +---- +$ rpi-connect doctor +---- + +If Connect can communicate properly on your network, you should see output similar to the following: + +---- +Screen sharing is supported by this version of rpi-connect +✓ Wayland compositor available +✓ Screen sharing services enabled and active +✓ Communication with Raspberry Pi Connect WebSocket server +✓ Communication with Raspberry Pi Connect API +✓ Authentication with Raspberry Pi Connect API +✓ Peer-to-peer connection candidate via STUN +✓ Peer-to-peer connection candidate via TURN +---- + +If Connect can't communicate properly on your network, you'll see an "x" instead of a check next to the failing test case. Ask your network administrator to enable the following connections on your network: + +* HTTPS requests to the Raspberry Pi Connect API and WebSocket server on port 443 of `api.connect.raspberrypi.com` and `ws.connect.raspberrypi.com` +* requests to Raspberry Pi Connect STUN or TURN servers on UDP port 3478 of all of the following: +** `stun.raspberrypi.com` +** `turn1.raspberrypi.com` +** `turn2.raspberrypi.com` +** `turn3.raspberrypi.com` +* requests to Raspberry Pi Connect TURN servers on TCP ports 3478 or 443 of all of the following: +** `turn1.raspberrypi.com` +** `turn2.raspberrypi.com` +** `turn3.raspberrypi.com` +* requests to Raspberry Pi Connect TURN servers on UDP ports 3478, 443, or 49152 -> 65535 of all of the following: +** `turn1.raspberrypi.com` +** `turn2.raspberrypi.com` +** `turn3.raspberrypi.com` + +=== View Connect status + +To view the current status of the Connect service, run the following command: + +[source,console] +---- +$ rpi-connect status +---- + +You should see output similar to the following: + +---- +Signed in: yes +Subscribed to events: yes +Screen sharing: allowed (0 sessions active) +Remote shell: allowed (0 sessions active) +---- + +The output of this command indicates whether or not you are currently signed in to Connect, as well as the remote services enabled on your Raspberry Pi. + +If you see output including "Raspberry Pi Connect is not running, run rpi-connect on", run `rpi-connect on` to start Connect. + +=== Enable enhanced logging + +You can enable debug logging for both `rpi-connect` and its dedicated WayVNC server for a detailed account of local operations on your Raspberry Pi. + +==== Enable enhanced logging in `rpi-connect` + +Override the `rpi-connect` service definition with the following command: + +[source,console] +---- +$ systemctl --user edit rpi-connect +---- + +Enter the following lines of configuration between the comments: + +[source,bash] +---- +[Service] +ExecStart= +ExecStart=/usr/bin/rpi-connectd -socket %t/rpi-connect-wayvnc.sock -v +---- + +NOTE: You need **both** lines that begin with `ExecStart=`. + +Finally, restart Connect with the following command: + +[source,console] +---- +$ rpi-connect restart +---- + +==== Enable enhanced logging in the dedicated `wayvnc` server + +Override the `rpi-connect-wayvnc` service definition with the following command: + +[source,console] +---- +$ systemctl --user edit rpi-connect-wayvnc +---- + +Enter the following lines of configuration between the comments (including the `-Ldebug` flag): + +[source,bash] +---- +[Service] +ExecStart= +ExecStart=/usr/bin/rpi-connect-env /usr/bin/wayvnc --config /etc/rpi-connect/wayvnc.config --render-cursor --unix-socket --socket=%t/rpi-connect-wayvnc-ctl.sock -Ldebug %t/rpi-connect-wayvnc.sock +---- + +NOTE: You need **both** lines that begin with `ExecStart=`. + +Finally, restart Connect with the following command: + +[source,console] +---- +$ rpi-connect restart +---- + +=== View Connect logs + +To view logs for the Connect service and its dedicated WayVNC server, run the following command: + +[source,console] +---- +$ journalctl --follow --user-unit rpi-connect --user-unit rpi-connect-wayvnc +---- diff --git a/documentation/asciidoc/services/connect/use.adoc b/documentation/asciidoc/services/connect/use.adoc new file mode 100644 index 000000000..2388242c4 --- /dev/null +++ b/documentation/asciidoc/services/connect/use.adoc @@ -0,0 +1,262 @@ +[[link-connect]] +== Link a Raspberry Pi device with a Connect account + +Now that you've installed and started Connect on your Raspberry Pi device, you must associate your device with your Connect account. + +[tabs] +====== +Desktop:: ++ +From the Connect icon in the menu bar, select **Turn On Raspberry Pi Connect** for the first time to open your browser, prompting you to sign in with your Raspberry Pi ID: ++ +image::images/browser-sign-in.png[width="80%"] ++ +If you have already turned on Connect, choose **Sign In...** from the dropdown menu: ++ +image::images/sign-in.png[width="80%"] ++ +If you don't already have a Raspberry Pi ID, select *create one for free* to xref:id.adoc#create-a-raspberry-pi-id[create one]. + +CLI:: ++ +Use the following command to generate a link that will connect your device with your Connect account: ++ +[source,console] +---- +$ rpi-connect signin +---- ++ +This command outputs something like the following: ++ +---- +Complete sign in by visiting https://connect.raspberrypi.com/verify/XXXX-XXXX +---- ++ +Visit the verification URL on any device and sign in with your Raspberry Pi ID to link your device with your Connect account. + +====== + +=== Finish linking your Raspberry Pi + +After authenticating, assign a name to your device. Choose a name that uniquely identifies the device. Select the **Create device and sign in** button to continue. + +image::images/new-device.png[width="80%"] + +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. + +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. + +== Access your Raspberry Pi device + +Now that your device appears on your Connect dashboard, you can access your device from anywhere using only a browser. Connect provides multiple ways to interact with your device remotely. + +=== Screen sharing + +Connect includes the ability to share your device's screen in a browser. Use the following instructions to share your device's screen. + +NOTE: Screen sharing requires the **Wayland** window server. Raspberry Pi OS _Bookworm_ and later use Wayland by default. Screen sharing is **not** compatible with Raspberry Pi OS Lite or systems that use the X window server. + +Visit https://connect.raspberrypi.com[connect.raspberrypi.com] on any computer. + +Connect redirects you to the Raspberry Pi ID service to sign in. After signing in, Connect displays a list of linked devices. Devices available for screen sharing show a grey **Screen sharing** badge below the name of the device. + +image::images/devices.png[width="80%"] + +Select the **Connect via** button to the right of the device you want to access. Select the **Screen sharing** option from the menu. This opens a browser window that displays your device's desktop. + +image::images/waiting-for-screen-sharing.png[width="80%"] + +You can now use your device as you would locally. For more information about the connection, hover your mouse over the padlock icon immediately to the right of the **Disconnect** button. + +image::images/screen-sharing.png[width="80%"] + +TIP: Use the **Copy from remote** and **Paste to remote** buttons above your desktop to transfer text between your local and remote clipboards. + +Once connected, a green dot appears next to the **Screen sharing** badge in the Connect dashboard. This indicates an active screen sharing session. Hover to see the current number of screen sharing sessions. + +image::images/screen-sharing-in-progress.png[width="80%"] + +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%"] + +==== Stop screen sharing + +To close a screen sharing session, select the **Disconnect** button above your desktop. + +image::images/screen-sharing-ended.png[width="80%"] + +==== Disallow screen sharing + +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%"] + +Alternatively, you can disallow screen sharing with the following command: + +[source,console] +---- +$ rpi-connect vnc off +---- + +In the Connect dashboard, the **Screen sharing** badge and the **Screen sharing** option in the **Connect via** menu will appear crossed-out. + +image::images/screen-sharing-disabled.png[width="80%"] + +To re-enable screen sharing, do one of the following: + +* Select the Connect icon in the menu bar and then choose **Allow Screen Sharing** +* Run the following command: ++ +[source,console] +---- +$ rpi-connect vnc on +---- + +=== Remote shell + +Connect includes the ability to start a shell running on your device from a browser. Use the following instructions to access the remote shell. + +Visit https://connect.raspberrypi.com[connect.raspberrypi.com] on any computer. + +Connect redirects you to the Raspberry Pi ID service to sign in. After signing in, Connect displays a list of linked devices. Devices available for remote shell access show a grey **Remote shell** badge below the name of the device. + +image::images/devices.png[width="80%"] + +Select the **Connect via** button to the right of the device you would like to access. Select the **Remote shell** option from the menu. This opens a shell session on your device. + +image::images/waiting-for-remote-shell.png[width="80%"] + +You can now use your device as you would locally. + +image::images/remote-shell.png[width="80%"] + +TIP: On some operating systems, the browser intercepts key combinations like **Ctrl+Shift+C** and **Ctrl+C**. Instead, you can use the right click menu or **Ctrl+Insert** to copy and **Shift+Insert** to paste. + +Once connected, a green dot appears next to the **Remote shell** badge in the Connect dashboard. This indicates an active remote shell session. Hover to see the current number of remote shell sessions. + +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 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%"] + +TIP: The `CONNECT_TTY` environment variable indicates that a session uses a remote shell provided by Connect. + +==== End your remote shell session + +To close a remote shell session, run the `exit` command or close the window. + +image::images/remote-shell-ended.png[width="80%"] + +==== Disallow remote shell access + +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%"] + +Alternatively, you can disallow remote shell access with the following command: + +[source,console] +---- +$ rpi-connect shell off +---- + +In the Connect dashboard, the **Remote shell** badge and the **Remote shell** option in the **Connect via** menu will appear crossed-out. + +image::images/remote-shell-disabled.png[width="80%"] + +To re-enable remote shell access, do one of the following: + +* Select the Connect system tray icon and choose **Allow Remote Shell Access** +* Run the following command: ++ +[source,console] +---- +$ rpi-connect shell on +---- + +== Enable remote shell at all times + +Connect runs as a user-level service, not as root. As a result, Connect only works when your user account is currently logged in on your device. This can make your device unreachable if you reboot with automatic login disabled. To continue running Connect even when you aren't logged into your device, enable **user-lingering**. Run the following command from your user account to enable user-lingering: + +[source,console] +---- +$ 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. + +image::images/devices.png[width="80%"] + +Select a device name to open the device details page. This screen provides low-level information about your device. You can also edit the device name or remove the device from Connect. + +image::images/device.png[width="80%"] + +Deleting a device from Connect automatically signs you out of Connect on the device. The Connect icon in the menu bar turns grey and the menu only provides a **Sign In...** option. + +== Update + +To update to the latest version of Connect, run the following command: + +[source, console] +---- +$ sudo apt update +$ sudo apt install --only-upgrade rpi-connect +---- + +TIP: If you installed Connect Lite, replace `rpi-connect` with `rpi-connect-lite` in the above command. + +== Disconnect a device from Connect + +Run the following command on your device to sign out of your Raspberry Pi ID, which will disable your device on the Connect screen: + +[source,console] +---- +$ rpi-connect signout +---- + +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]. + +== Uninstall + +Run the following command to stop and remove Connect from a device: + +[source,console] +---- +$ sudo apt remove --purge rpi-connect +---- + +TIP: If you installed Connect Lite, replace `rpi-connect` with `rpi-connect-lite` in the above command. + +After uninstalling, the serial number of the device remains linked with your Connect account. The device still appears in the Connect dashboard, but can't be used for remote access. If you install Connect again, even with a different SD card, on the same device, it will reuse the existing device name in the Connect dashboard. + +To sever the link between a device and a Connect account, remove the device from the list of devices in the Connect dashboard. diff --git a/documentation/asciidoc/services/id/2fa.adoc b/documentation/asciidoc/services/id/2fa.adoc index 9c6eae82c..d15b3b64a 100644 --- a/documentation/asciidoc/services/id/2fa.adoc +++ b/documentation/asciidoc/services/id/2fa.adoc @@ -1,45 +1,37 @@ -== Two-factor authentication +== Enable Two-factor authentication -Like most modern web services, the Raspberry Pi ID service supports two-factor authentication (2FA) using a https://en.wikipedia.org/wiki/Time-based_one-time_password[time-based one-time password] (TOTP). +Like most modern web services, Raspberry Pi ID supports two-factor authentication (2FA) using a https://en.wikipedia.org/wiki/Time-based_one-time_password[time-based one-time password] (TOTP). -Two-factor authentication is an extra layer of protection. As well as a password (“something you know”), you’ll need another piece of information to log in. This second factor will be based either on “something you have”, like a smart phone, or on “something you are”, like biometric information. +Two-factor authentication adds an extra layer of protection. In addition to a password, 2FA requires another piece of information to log in. You should base this second factor on either _something you have_ (like a smart phone) or _something you are_ (like biometric information). -We’re going to go ahead and set up “something you have”, and use your smart phone as the second factor to protect your Raspberry Pi ID. +This guide uses your smart phone as a second factor for authentication. -=== Installing a two-factor authenticator application +TIP: Raspberry Pi ID supports macOS and iOS iCloud Keychain integration. Right click the QR code to get the "Set up verification code" option on your Mac or iPhone. -You will need to download an app to your phone that will generate the TOTP. One of the most commonly used is Google Authenticator. It’s available for both https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en_GB[Android] and https://apps.apple.com/us/app/google-authenticator/id388497605[iOS], and there is even an open source version of the app available https://github.com/google/google-authenticator[on GitHub]. +=== Install a 2FA application -image::images/auth_app.png[width="80%"] +First, download an app to your phone that generates TOTP. Install any 2FA app like https://authy.com/[Authy] or Google Authenticator. -So go ahead and install Google Authenticator, or another 2FA app like https://authy.com/[Authy] on your phone before going any further. +=== Enable 2FA -=== Enabling two-factor authentication - -To enable 2FA, click on the “Two-factor authentication” option when signed in to the https://id.raspberrypi.com[identity service]. +To enable 2FA, click the **Two-factor authentication** option when signed in to your https://id.raspberrypi.com[Raspberry Pi ID]. image::images/enable_2fa.png[width="80%"] -Open the Google Authenticator app on your phone and tap the plus sign (+) at the top right, then tap on “Scan barcode”. - -Your phone will ask you whether you want to allow the app access to your camera; you should say “Yes”. The camera view will open. Position the QR code squarely in the green box on the screen. As soon as your phone app recognises the code, the authenticator app will add your new account, and will start generating TOTP codes automatically. - -image::images/id_2fa.png[width="80%"] +Open the 2FA app on your phone. Scan the QR code provided by your Raspberry Pi ID with your 2FA app to begin generating tokens. -NOTE: The Raspberry Pi ID service also support macOS and iOS iCloud Keychain integration, so you can right click (long press) the QR code until you get the "Set up verification code" option on your Mac or iPhone. - -Now you should go ahead and enter the six-digit TOTP generated by your authenticator app on your phone into the Raspberry Pi ID service. +NOTE: See the documentation for your 2FA app to find out how to scan a QR code to generate a token. image::images/authenticate.png[width="80%"] -If you enter the TOTP correctly, you will see a confirmation screen with a recovery code. +Enter the six-digit TOTP generated by your 2FA app to register the 2FA app with your Raspberry Pi ID. -image::images/totp_enabled.png[width="80%"] +A confirmation screen will appear, containing a recovery code. Store the recovery code in a safe place. **This is the only way to bypass 2FA** if you lose your phone and the 2FA app. -IMPORTANT: You should copy the recovery code down and store it in a safe place. This is the only way to bypass two-factor authentication in the future if you lose, or otherwise don't have access to, your phone and the authenticator app running on it. +image::images/totp_enabled.png[width="80%"] -You’ll now need your phone, and a TOTP, every time you log in to Raspberry Pi services. But because of that, you’ve just given a huge boost to the security of your devices on the service. +You have now configured your Raspberry Pi ID to require 2FA. From now on, sign in requires a TOTP generated by the 2FA app on your phone. -NOTE: If you need to disable two-factor authentication at any point in the future, you can do that by logging back in to the https://id.raspberrypi.com[identity service]. +NOTE: You can disable two-factor authentication at any point in the future at https://id.raspberrypi.com[id.raspberrypi.com]. diff --git a/documentation/asciidoc/services/id/images/auth_app.png b/documentation/asciidoc/services/id/images/auth_app.png deleted file mode 100644 index 7c4951342..000000000 Binary files a/documentation/asciidoc/services/id/images/auth_app.png and /dev/null differ diff --git a/documentation/asciidoc/services/id/images/id_2fa.png b/documentation/asciidoc/services/id/images/id_2fa.png deleted file mode 100644 index 8d5d4f5ee..000000000 Binary files a/documentation/asciidoc/services/id/images/id_2fa.png and /dev/null differ diff --git a/documentation/asciidoc/services/id/images/sign_in_identity.png b/documentation/asciidoc/services/id/images/sign_in_identity.png deleted file mode 100644 index e338e2530..000000000 Binary files a/documentation/asciidoc/services/id/images/sign_in_identity.png and /dev/null differ diff --git a/documentation/asciidoc/services/id/signing_up.adoc b/documentation/asciidoc/services/id/signing_up.adoc index 134405491..ef9366cc1 100644 --- a/documentation/asciidoc/services/id/signing_up.adoc +++ b/documentation/asciidoc/services/id/signing_up.adoc @@ -1,23 +1,20 @@ -== Signing up to Raspberry Pi ID +[[create-a-raspberry-pi-id]] +== Create a Raspberry Pi ID -To use Raspberry Pi services, you will first have to create a Raspberry Pi ID account using our https://id.raspberrypi.com[identity service]. This account will be your gateway to the Raspberry Pi website and other services such as the https://events.raspberrypi.com/[Raspberry Pi Events] pages. +To use Raspberry Pi services, you must first create a https://id.raspberrypi.com[Raspberry Pi ID]. -=== Creating a Raspberry Pi ID +In a browser, navigate to https://id.raspberrypi.com[id.raspberrypi.com]. -Go to https://id.raspberrypi.com[id.raspberrypi.com] in your browser and click on "sign up". - -image::images/sign_in_identity.png[width="80%"] - -This will take you to an account creation page. Enter your email along with a password. You will need to type the password a second time in the password confirmation box. +Enter an email and password. Click the **Sign up** button to create your account. image::images/create_account_identity.png[width="80%"] -If your password matches, the service will send an email to the email address you entered. Go to your inbox and open the email, then click on the "Verify email" button in the email. +Once you have created an account, you will receive a verification email. image::images/verify_identity.png[width="80%"] -You will be signed into the identity service. +Click the **Verify email** button in the email to verify your email address and complete account creation. image::images/signed_in_identity.png[width="80%"] -After creating a Raspberry Pi ID, you can log in to Raspberry Pi services using the "Sign in with Raspberry Pi" button to sign in with your Raspberry Pi ID. +After creating a Raspberry Pi ID, you can log in to Raspberry Pi services using the **Sign in with Raspberry Pi ID** button. diff --git a/documentation/global_boxes.json b/documentation/global_boxes.json deleted file mode 100644 index 37b59b7a4..000000000 --- a/documentation/global_boxes.json +++ /dev/null @@ -1,26 +0,0 @@ -[ - { - "title": "Product Information Portal", - "description": "Raspberry Pi compliance documents", - "imagepath": "/images/full-sized/PIP.png", - "url": "https://pip.raspberrypi.com/" - }, - { - "title": "Datasheets", - "description": "PDF-based documentation", - "imagepath": "/images/full-sized/Datasheets.png", - "url": "https://datasheets.raspberrypi.com" - }, - { - "title": "Tutorials", - "description": "Hands-on hardware and software tutorials", - "imagepath": "/images/full-sized/Tutorials.png", - "url": "https://www.raspberrypi.com/tutorials/" - }, - { - "title": "Forums", - "description": "User and product support forums", - "imagepath": "/images/full-sized/Forums.png", - "url": "https://forums.raspberrypi.com" - } -] \ No newline at end of file diff --git a/documentation/htaccess_extra.txt b/documentation/htaccess_extra.txt index 1d991ae5d..db4cf0491 100644 --- a/documentation/htaccess_extra.txt +++ b/documentation/htaccess_extra.txt @@ -24,5 +24,10 @@ RedirectMatch 302 "^/documentation/setup/" "/documentation/computers/getting-sta RedirectMatch 302 "^/documentation/usage/camera/" "/documentation/accessories/camera.html" RedirectMatch 302 "^/documentation/usage/" "/documentation/computers/os.html" RedirectMatch 302 "^/documentation/configuration/" "/documentation/computers/configuration.html" +RedirectMatch 302 "^/documentation/computers/raspberry-pi-5.html" "/documentation/computers/raspberry-pi.html" +RedirectMatch 302 "^/documentation/microcontrollers/rp1.html" "/documentation/microcontrollers/silicon.html" +RedirectMatch 302 "^/documentation/microcontrollers/rp2040.html" "/documentation/microcontrollers/silicon.html" +RedirectMatch 302 "^/documentation/microcontrollers/raspberry-pi-pico.html" "/documentation/microcontrollers/pico-series.html" +RedirectMatch 302 "^/documentation/microcontrollers/pico.html" "/documentation/microcontrollers/pico-series.html" 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/Pico-SMALL.png b/documentation/images/Pico-SMALL.png deleted file mode 100644 index 21d169209..000000000 Binary files a/documentation/images/Pico-SMALL.png and /dev/null differ diff --git a/documentation/images/Touch-Display-2-SMALL.png b/documentation/images/Touch-Display-2-SMALL.png new file mode 100644 index 000000000..1a5f61550 Binary files /dev/null and b/documentation/images/Touch-Display-2-SMALL.png differ diff --git a/documentation/images/ai-cam-SMALL.png b/documentation/images/ai-cam-SMALL.png new file mode 100644 index 000000000..f4a2e75c2 Binary files /dev/null and b/documentation/images/ai-cam-SMALL.png differ diff --git a/documentation/images/ai-hat-plus-SMALL.png b/documentation/images/ai-hat-plus-SMALL.png new file mode 100644 index 000000000..48233f4bb Binary files /dev/null and b/documentation/images/ai-hat-plus-SMALL.png differ diff --git a/documentation/images/ai-kit-SMALL.png b/documentation/images/ai-kit-SMALL.png new file mode 100644 index 000000000..28ab2b343 Binary files /dev/null and b/documentation/images/ai-kit-SMALL.png differ diff --git a/documentation/images/ai.png b/documentation/images/ai.png new file mode 100644 index 000000000..f4a2e75c2 Binary files /dev/null and b/documentation/images/ai.png differ diff --git a/documentation/images/bumper-SMALL.png b/documentation/images/bumper-SMALL.png new file mode 100644 index 000000000..346b6510a Binary files /dev/null and b/documentation/images/bumper-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/images/full-sized/Connect-BIG.png b/documentation/images/full-sized/Connect-BIG.png new file mode 100644 index 000000000..8e9eff4f6 Binary files /dev/null and b/documentation/images/full-sized/Connect-BIG.png differ diff --git a/documentation/images/full-sized/RP2040.png b/documentation/images/full-sized/RP2040.png deleted file mode 100644 index a9e2c5157..000000000 Binary files a/documentation/images/full-sized/RP2040.png and /dev/null differ diff --git a/documentation/images/full-sized/Touch-Display-2.png b/documentation/images/full-sized/Touch-Display-2.png new file mode 100644 index 000000000..e9b7d96cc Binary files /dev/null and b/documentation/images/full-sized/Touch-Display-2.png differ diff --git a/documentation/images/full-sized/ai-cam.png b/documentation/images/full-sized/ai-cam.png new file mode 100644 index 000000000..13e2da0a3 Binary files /dev/null and b/documentation/images/full-sized/ai-cam.png differ diff --git a/documentation/images/full-sized/ai-hat-plus.png b/documentation/images/full-sized/ai-hat-plus.png new file mode 100644 index 000000000..f2e81af82 Binary files /dev/null and b/documentation/images/full-sized/ai-hat-plus.png differ diff --git a/documentation/images/full-sized/ai-kit.png b/documentation/images/full-sized/ai-kit.png new file mode 100644 index 000000000..7d8ddfdaa Binary files /dev/null and b/documentation/images/full-sized/ai-kit.png differ diff --git a/documentation/images/full-sized/ai.png b/documentation/images/full-sized/ai.png new file mode 100644 index 000000000..13e2da0a3 Binary files /dev/null and b/documentation/images/full-sized/ai.png differ diff --git a/documentation/images/full-sized/bumper.png b/documentation/images/full-sized/bumper.png new file mode 100644 index 000000000..7dfd8e1c7 Binary files /dev/null and b/documentation/images/full-sized/bumper.png differ diff --git a/documentation/images/full-sized/keyboard-computers.png b/documentation/images/full-sized/keyboard-computers.png new file mode 100644 index 000000000..36973962d Binary files /dev/null and b/documentation/images/full-sized/keyboard-computers.png differ diff --git a/documentation/images/full-sized/m2-hat-plus.png b/documentation/images/full-sized/m2-hat-plus.png new file mode 100644 index 000000000..b8423f39c Binary files /dev/null and b/documentation/images/full-sized/m2-hat-plus.png differ diff --git a/documentation/images/full-sized/monitor.png b/documentation/images/full-sized/monitor.png new file mode 100644 index 000000000..612a5d801 Binary files /dev/null and b/documentation/images/full-sized/monitor.png differ diff --git a/documentation/images/full-sized/pico-series.png b/documentation/images/full-sized/pico-series.png new file mode 100644 index 000000000..d2da8d096 Binary files /dev/null and b/documentation/images/full-sized/pico-series.png differ diff --git a/documentation/images/full-sized/sd-card.png b/documentation/images/full-sized/sd-card.png new file mode 100644 index 000000000..fe6fc104e Binary files /dev/null and b/documentation/images/full-sized/sd-card.png differ diff --git a/documentation/images/full-sized/RP1.png b/documentation/images/full-sized/silicon.png similarity index 100% rename from documentation/images/full-sized/RP1.png rename to documentation/images/full-sized/silicon.png diff --git a/documentation/images/full-sized/software-sources.png b/documentation/images/full-sized/software-sources.png new file mode 100644 index 000000000..64cf707be Binary files /dev/null and b/documentation/images/full-sized/software-sources.png differ diff --git a/documentation/images/full-sized/ssd-kit.png b/documentation/images/full-sized/ssd-kit.png new file mode 100644 index 000000000..f208c1d8f Binary files /dev/null and b/documentation/images/full-sized/ssd-kit.png differ diff --git a/documentation/images/full-sized/ssds.png b/documentation/images/full-sized/ssds.png new file mode 100644 index 000000000..4c47488ff Binary files /dev/null and b/documentation/images/full-sized/ssds.png differ diff --git a/documentation/images/full-sized/usb-3-hub.png b/documentation/images/full-sized/usb-3-hub.png new file mode 100644 index 000000000..31c75a1a2 Binary files /dev/null and b/documentation/images/full-sized/usb-3-hub.png differ diff --git a/documentation/images/keyboard-computers-SMALL.png b/documentation/images/keyboard-computers-SMALL.png new file mode 100644 index 000000000..97a0cd796 Binary files /dev/null and b/documentation/images/keyboard-computers-SMALL.png differ diff --git a/documentation/images/m2-hat-plus-SMALL.png b/documentation/images/m2-hat-plus-SMALL.png new file mode 100644 index 000000000..267da74b8 Binary files /dev/null and b/documentation/images/m2-hat-plus-SMALL.png differ diff --git a/documentation/images/monitor-SMALL.png b/documentation/images/monitor-SMALL.png new file mode 100644 index 000000000..e4c3547b3 Binary files /dev/null and b/documentation/images/monitor-SMALL.png differ diff --git a/documentation/images/pico-series-SMALL.png b/documentation/images/pico-series-SMALL.png new file mode 100644 index 000000000..d1cd300aa Binary files /dev/null and b/documentation/images/pico-series-SMALL.png differ diff --git a/documentation/images/placeholder/placeholder_circle-SMALL.png b/documentation/images/placeholder/placeholder_circle-SMALL.png new file mode 100644 index 000000000..d87e8121a Binary files /dev/null and b/documentation/images/placeholder/placeholder_circle-SMALL.png differ diff --git a/documentation/images/placeholder/placeholder_circle.png b/documentation/images/placeholder/placeholder_circle.png index d87e8121a..258267657 100644 Binary files a/documentation/images/placeholder/placeholder_circle.png and b/documentation/images/placeholder/placeholder_circle.png differ diff --git a/documentation/images/placeholder/placeholder_square-SMALL.png b/documentation/images/placeholder/placeholder_square-SMALL.png new file mode 100644 index 000000000..b51bc8fb1 Binary files /dev/null and b/documentation/images/placeholder/placeholder_square-SMALL.png differ diff --git a/documentation/images/placeholder/placeholder_square.png b/documentation/images/placeholder/placeholder_square.png index b51bc8fb1..8583725b8 100644 Binary files a/documentation/images/placeholder/placeholder_square.png and b/documentation/images/placeholder/placeholder_square.png differ diff --git a/documentation/images/placeholder/placeholder_triangle-SMALL.png b/documentation/images/placeholder/placeholder_triangle-SMALL.png new file mode 100644 index 000000000..0ee52120c Binary files /dev/null and b/documentation/images/placeholder/placeholder_triangle-SMALL.png differ diff --git a/documentation/images/placeholder/placeholder_triangle.png b/documentation/images/placeholder/placeholder_triangle.png index 0ee52120c..17d54ff2d 100644 Binary files a/documentation/images/placeholder/placeholder_triangle.png and b/documentation/images/placeholder/placeholder_triangle.png differ diff --git a/documentation/images/sd-card-SMALL.png b/documentation/images/sd-card-SMALL.png new file mode 100644 index 000000000..ee96081dd Binary files /dev/null and b/documentation/images/sd-card-SMALL.png differ diff --git a/documentation/images/ssd-kit-SMALL.png b/documentation/images/ssd-kit-SMALL.png new file mode 100644 index 000000000..464260cc3 Binary files /dev/null and b/documentation/images/ssd-kit-SMALL.png differ diff --git a/documentation/images/ssds-SMALL.png b/documentation/images/ssds-SMALL.png new file mode 100644 index 000000000..74667b5af Binary files /dev/null and b/documentation/images/ssds-SMALL.png differ diff --git a/documentation/images/usb-3-hub-SMALL.png b/documentation/images/usb-3-hub-SMALL.png new file mode 100644 index 000000000..41e1d6bc4 Binary files /dev/null and b/documentation/images/usb-3-hub-SMALL.png differ diff --git a/documentation/index.json b/documentation/index.json index 644346e9f..8be16f78c 100644 --- a/documentation/index.json +++ b/documentation/index.json @@ -24,17 +24,11 @@ "subpath": "configuration.adoc" }, { - "title": "The config.txt file", + "title": "`config.txt`", "description": "Low-level settings control", "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", @@ -54,11 +48,23 @@ "subpath": "camera_software.adoc" }, { - "title": "Raspberry Pi hardware", - "description": "Technical information about Raspberry Pi hardware", + "title": "AI Kit and AI HAT+ software", + "description": "Software and libraries for artificial intelligence on a Raspberry Pi hardware", + "image": "full-sized/ai.png", + "subpath": "ai.adoc" + }, + { + "title": "Raspberry Pi computer hardware", + "description": "Technical information about Raspberry Pi computer hardware", "image": "full-sized/Raspberry-Pi-Hardware.png", "subpath": "raspberry-pi.adoc" }, + { + "title": "Keyboard computers", + "description": "Technical information about Raspberry Pi keyboard computers", + "image": "full-sized/keyboard-computers.png", + "subpath": "keyboard-computers.adoc" + }, { "title": "Compute Module hardware", "description": "Technical information about Raspberry Pi Compute Module hardware", @@ -70,6 +76,18 @@ "description": "Technical information about the CPUs used by Raspberry Pi", "image": "full-sized/Processors.png", "subpath": "processors.adoc" + }, + { + "title": "Software sources", + "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" } ] }, @@ -78,6 +96,42 @@ "path": "accessories", "default_tab": "no", "subitems": [ + { + "title": "SD Cards", + "description": "Raspberry Pi's official SD cards", + "image": "full-sized/sd-card.png", + "subpath": "sd-cards.adoc" + }, + { + "title": "SSDs", + "description": "Raspberry Pi's official Solid State Drives", + "image": "full-sized/ssds.png", + "subpath": "ssds.adoc" + }, + { + "title": "SSD Kit", + "description": "Storage for your Raspberry Pi", + "image": "full-sized/ssd-kit.png", + "subpath": "ssd-kit.adoc" + }, + { + "title": "M.2 HAT+", + "description": "Connect storage to your Raspberry Pi via PCIe", + "image": "full-sized/m2-hat-plus.png", + "subpath": "m2-hat-plus.adoc" + }, + { + "title": "Touch Display 2", + "description": "The Raspberry Pi Touch Display 2", + "image": "full-sized/Touch-Display-2.png", + "subpath": "touch-display-2.adoc" + }, + { + "title": "Monitor", + "description": "The Raspberry Pi Monitor", + "image": "full-sized/monitor.png", + "subpath": "monitor.adoc" + }, { "title": "Camera", "description": "Raspberry Pi camera boards", @@ -85,10 +139,10 @@ "subpath": "camera.adoc" }, { - "title": "Display", - "description": "The Raspberry Pi Touch Display", - "image": "full-sized/Display.png", - "subpath": "display.adoc" + "title": "AI Camera", + "description": "An AI Camera for your Raspberry Pi", + "image": "full-sized/ai-cam.png", + "subpath": "ai-camera.adoc" }, { "title": "Keyboard and mouse", @@ -96,6 +150,12 @@ "image": "full-sized/Keyboard-and-Mouse.png", "subpath": "keyboard-and-mouse.adoc" }, + { + "title": "USB Hub", + "description": "Official Raspberry Pi USB hub", + "image": "full-sized/usb-3-hub.png", + "subpath": "usb-3-hub.adoc" + }, { "title": "Build HAT", "description": "How to use the Build HAT", @@ -104,15 +164,21 @@ }, { "title": "Sense HAT", - "description": "How to use the Sense HAT", + "description": "Monitor and visualise sensor data", "image": "full-sized/Sense-HAT.png", "subpath": "sense-hat.adoc" }, { - "title": "TV HAT", - "description": "How to watch TV on your Raspberry Pi", - "image": "full-sized/TV-HAT.png", - "subpath": "tv-hat.adoc" + "title": "AI Kit", + "description": "An NPU that connects to your Raspberry Pi via M.2", + "image": "full-sized/ai-kit.png", + "subpath": "ai-kit.adoc" + }, + { + "title": "AI HAT+", + "description": "An NPU HAT+ for your Raspberry Pi", + "image": "full-sized/ai-hat-plus.png", + "subpath": "ai-hat-plus.adoc" }, { "title": "Raspberry Pi Audio", @@ -124,7 +190,25 @@ "title": "Designing a HAT", "description": "Information on the HAT specification", "image": "full-sized/Designing-a-HAT.png", - "url": "https://github.com/raspberrypi/hats" + "url": "https://datasheets.raspberrypi.com/hat/hat-plus-specification.pdf" + }, + { + "title": "Touch Display", + "description": "The Raspberry Pi Touch Display", + "image": "full-sized/Display.png", + "subpath": "display.adoc" + }, + { + "title": "TV HAT", + "description": "Watch TV on your Raspberry Pi", + "image": "full-sized/TV-HAT.png", + "subpath": "tv-hat.adoc" + }, + { + "title": "Bumper", + "description": "A protective case for your Raspberry Pi 5", + "image": "full-sized/bumper.png", + "subpath": "bumper.adoc" } ] }, @@ -133,16 +217,16 @@ "path": "microcontrollers", "subitems": [ { - "title": "RP2040", - "description": "Raspberry Pi's flagship microcontroller device", - "image": "full-sized/RP2040.png", - "subpath": "rp2040.adoc" + "title": "Silicon", + "description": "Raspberry Pi in-house Silicon", + "image": "full-sized/silicon.png", + "subpath": "silicon.adoc" }, { - "title": "Raspberry Pi Pico and Pico W", - "description": "Support for Raspberry Pi Pico, Pico H, Pico W, and Pico WH", - "image": "full-sized/Pico.png", - "subpath": "raspberry-pi-pico.adoc" + "title": "Pico-series Microcontrollers", + "description": "Support for Raspberry Pi Pico-series devices", + "image": "full-sized/pico-series.png", + "subpath": "pico-series.adoc" }, { "title": "Raspberry Pi Debug Probe", @@ -150,12 +234,6 @@ "image": "full-sized/Debug-Probe.png", "subpath": "debug-probe.adoc" }, - { - "title": "RP1", - "description": "Our southbridge for Raspberry Pi 5", - "image": "full-sized/RP1.png", - "subpath": "rp1.adoc" - }, { "title": "MicroPython", "description": "Getting started with MicroPython", @@ -179,6 +257,18 @@ "description": "Our identity service", "image": "full-sized/Raspberry-Pi-ID.png", "subpath": "id.adoc" + }, + { + "title": "Raspberry Pi Connect", + "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" } ] }, @@ -188,4 +278,4 @@ "directory": "pico-sdk" } ] -} +} \ No newline at end of file diff --git a/documentation/redirects/datasheets.csv b/documentation/redirects/datasheets.csv index 528db7f2c..241df2db5 100644 --- a/documentation/redirects/datasheets.csv +++ b/documentation/redirects/datasheets.csv @@ -64,8 +64,8 @@ /documentation/hardware/raspberrypi/mechanical/rpi_MECH_Zero_case_blank.pdf,https://datasheets.raspberrypi.com/case/raspberry-pi-zero-case-mechanical-drawing.pdf /documentation/hardware/raspberrypi/mechanical/rpi_MECH_Zero_case_camera.pdf,https://datasheets.raspberrypi.com/case/raspberry-pi-zero-case-with-camera-mechanical-drawing.pdf /documentation/hardware/raspberrypi/mechanical/rpi_MECH_Zero_case_gpio.pdf,https://datasheets.raspberrypi.com/case/raspberry-pi-zero-case-with-gpio-mechanical-drawing.pdf -/documentation/hardware/raspberrypi/mechanical/rpi_MECH_bplus_1p2.dxf,https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-mecahnical-drawing.dxf -/documentation/hardware/raspberrypi/mechanical/rpi_MECH_bplus_1p2.pdf,https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-mecahnical-drawing.pdf +/documentation/hardware/raspberrypi/mechanical/rpi_MECH_bplus_1p2.dxf,https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-mechanical-drawing.dxf +/documentation/hardware/raspberrypi/mechanical/rpi_MECH_bplus_1p2.pdf,https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-mechanical-drawing.pdf /documentation/hardware/raspberrypi/mechanical/rpi_MECH_TVHAT_1p0.PNG,https://datasheets.raspberrypi.com/tv-hat/tv-hat-mechanical-drawing.pdf /documentation/hardware/raspberrypi/schematics/rpi_SCH_1aplus_1p1_reduced.pdf,https://datasheets.raspberrypi.com/rpi/raspberry-pi-a-plus-reduced-schematics.pdf /documentation/hardware/raspberrypi/schematics/rpi_SCH_1bplus_1p2_reduced.pdf,https://datasheets.raspberrypi.com/rpi/raspberry-pi-b-plus-reduced-schematics.pdf diff --git a/jekyll-assets/_includes/contribute.html b/jekyll-assets/_includes/contribute.html deleted file mode 100644 index fc0aea05e..000000000 --- a/jekyll-assets/_includes/contribute.html +++ /dev/null @@ -1,5 +0,0 @@ -
-
- -
-
diff --git a/jekyll-assets/_includes/copyright.html b/jekyll-assets/_includes/copyright.html deleted file mode 100644 index 9b00e43e6..000000000 --- a/jekyll-assets/_includes/copyright.html +++ /dev/null @@ -1,7 +0,0 @@ -
-
- - - -
-
diff --git a/jekyll-assets/_includes/footer.html b/jekyll-assets/_includes/footer.html index 3da7a8af4..c278ebebf 100644 --- a/jekyll-assets/_includes/footer.html +++ b/jekyll-assets/_includes/footer.html @@ -1,4 +1,5 @@ +
+
+

+ We use some essential cookies to make our website work. +

+

+ We use optional cookies, as detailed in our cookie policy, to remember your + settings and understand how you use our website. +

+
+ + +
+
+
- - + +