Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Update getting started docs for parity with tutorials page #3039

Closed
wants to merge 9 commits into from
Closed

Update getting started docs for parity with tutorials page #3039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
78f6577
Update OpenOCD branch name
lurch Jul 26, 2023
65f24e5
Merge pull request #3025 from raspberrypi/lurch-patch-1
Jul 26, 2023
25cea98
Update installing-tools.adoc
Jul 26, 2023
807d506
Merge pull request #3026 from raspberrypi/aallan-patch-1
Jul 26, 2023
888e191
Adding NOTE about building 32-bit kernel
Jul 27, 2023
30408d5
Update building.adoc
Jul 27, 2023
0e99ba4
Merge pull request #3027 from raspberrypi/aallan-patch-1
Jul 27, 2023
c7f8415
Wording tweak to kernel building
lurch Jul 27, 2023
6dff34e
Merge pull request #3030 from raspberrypi/lurch-patch-1
Jul 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions documentation/asciidoc/computers/linux_kernel/building.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ The instructions below are divided into native builds and cross-compilation; cho

=== Building the Kernel Locally

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`. Instructions for <<cross-compiling-the-kernel,cross-compiling the kernel>> can be found later on this page.

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:
Expand Down
12 changes: 3 additions & 9 deletions documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Before we get started we need to install some tools.

You need to install OpenOCD.

NOTE: SMP support for debugging on both RP2040 cores is not yet available in the release version of `openocd`. However, support is available in the `rp2040` branch and will be enabled if you build from source.
NOTE: SMP support for debugging on both RP2040 cores is not yet available in the release version of `openocd`. However, support is available in the `rp2040-v0.12.0` branch and will be enabled if you build from source.

==== Linux (and Raspberry Pi)

Expand Down Expand Up @@ -45,19 +45,13 @@ Install https://brew.sh/[Homebrew] if needed,
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
----

and then OpenOCD.

----
$ brew install open-ocd
----

Alternatively you can install needed dependencies,
install needed dependencies,

----
$ brew install libtool automake libusb wget pkg-config gcc texinfo
----

and build OpenOCD from source.
and then build OpenOCD from source.

----
$ cd ~/pico
Expand Down