diff --git a/documentation/asciidoc/accessories/ai-camera/details.adoc b/documentation/asciidoc/accessories/ai-camera/details.adoc index ed07d996c..f7331d4d0 100644 --- a/documentation/asciidoc/accessories/ai-camera/details.adoc +++ b/documentation/asciidoc/accessories/ai-camera/details.adoc @@ -1,5 +1,5 @@ -== Under the Hood +== Under the hood === Overview @@ -19,7 +19,7 @@ Region of Interest (ROI):: Specifies exactly which part of the sensor image is c Output Tensor:: 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 tensor. -=== System Architecture +=== 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): diff --git a/documentation/asciidoc/accessories/ai-camera/model-conversion.adoc b/documentation/asciidoc/accessories/ai-camera/model-conversion.adoc index 78cb13cb6..0b95f8789 100644 --- a/documentation/asciidoc/accessories/ai-camera/model-conversion.adoc +++ b/documentation/asciidoc/accessories/ai-camera/model-conversion.adoc @@ -1,4 +1,4 @@ -== Model Deployment +== Model deployment To deploy a new neural network model to the Raspberry Pi AI Camera, complete the following steps: @@ -9,13 +9,13 @@ To deploy a new neural network model to the Raspberry Pi AI Camera, complete the The first three 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 +=== 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 frameworks like TensorFlow or PyTorch. For more information, see the official https://developer.aitrios.sony-semicon.com/en/raspberrypi-ai-camera[AITRIOS developer website]. -=== Quantisation and Compression +=== Quantisation and compression Models are quantised and compressed using Sony's Model Compression Toolkit. To install the toolkit, run the following command: diff --git a/documentation/asciidoc/accessories/camera/synchronous_cameras.adoc b/documentation/asciidoc/accessories/camera/synchronous_cameras.adoc index 77962897c..58734110c 100644 --- a/documentation/asciidoc/accessories/camera/synchronous_cameras.adoc +++ b/documentation/asciidoc/accessories/camera/synchronous_cameras.adoc @@ -23,7 +23,7 @@ This parameter can only be altered in superuser mode. Run the following commands to configure the sink: -[[source,console]h] +[source,console] ---- $ sudo su $ echo 2 > /sys/module/imx477/parameters/trigger_mode diff --git a/documentation/asciidoc/accessories/sd-cards/about.adoc b/documentation/asciidoc/accessories/sd-cards/about.adoc index 99b94199d..1d8f41170 100644 --- a/documentation/asciidoc/accessories/sd-cards/about.adoc +++ b/documentation/asciidoc/accessories/sd-cards/about.adoc @@ -1,9 +1,9 @@ == About -.A 64GB Raspberry Pi SD Card -image::images/sd-cards.jpg[width="80%"] +.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 computer. Slow bus speeds and lack of command queueing can reduce the performance of even the most powerful Raspberry Pi models. +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. @@ -17,20 +17,21 @@ Raspberry Pi SD cards are available in the following sizes: == Specifications -Raspberry Pi SD cards have the following specifications: +.A 128GB Raspberry Pi SD Card +image::images/sd-cards.png[width="80%"] -Speed Class: C10, U3, V30, A2 +Raspberry Pi SD cards use the SD6.1 SD specification. -Random 4KB read performance: +Raspberry Pi SD cards use the microSDHC/microSDXC form factor. -* 3,200 IOPS on Raspberry Pi 4 (DDR50) -* 5,000 IOPS on Raspberry Pi 5 (SDR104) +Raspberry Pi SD cards have the following Speed Class ratings: C10, U3, V30, A2. -Random 4KB write performance: +The following table describes the read and write speeds of Raspberry Pi SD cards using 4KB of random data: -* 1,200 IOPS on Raspberry Pi 4 (DDR50) -* 2,000 IOPS on Raspberry Pi 5 (SDR104) +|=== +| Raspberry Pi Model | Interface | Read Speed | Write Speed -Form factor: microSDHC/microSDXC +| 4 | DDR50 | 3,200 IOPS | 1,200 IOPS +| 5 | SDR104 | 5,000 IOPS | 2,000 IOPS +|=== -SD specification: SD6.1 diff --git a/documentation/asciidoc/accessories/sd-cards/images/sd-cards.jpg b/documentation/asciidoc/accessories/sd-cards/images/sd-cards.jpg deleted file mode 100644 index 9a1416ac3..000000000 Binary files a/documentation/asciidoc/accessories/sd-cards/images/sd-cards.jpg and /dev/null differ 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/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..579927dc6 --- /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+]. + +== 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 from 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/computers/camera/rpicam_options_libav.adoc b/documentation/asciidoc/computers/camera/rpicam_options_libav.adoc index dec631c82..3b1f2ce19 100644 --- a/documentation/asciidoc/computers/camera/rpicam_options_libav.adoc +++ b/documentation/asciidoc/computers/camera/rpicam_options_libav.adoc @@ -44,7 +44,7 @@ Sets the audio sampling rate in Hz. Accepts numeric input. `0` uses the input sa ==== `audio-device` -Select an ALSO input device for audio recording. For a list of available devices, run the following command: +Select an ALSA input device for audio recording. For a list of available devices, run the following command: [source,console] ---- diff --git a/documentation/asciidoc/computers/getting-started/setting-up.adoc b/documentation/asciidoc/computers/getting-started/setting-up.adoc index a88504418..60bf49c20 100644 --- a/documentation/asciidoc/computers/getting-started/setting-up.adoc +++ b/documentation/asciidoc/computers/getting-started/setting-up.adoc @@ -56,7 +56,7 @@ image::images/peripherals/cable-power.png[alt="Plugging a power supply into a Ra 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. diff --git a/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc b/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc index 105c46745..69ab3024c 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc @@ -52,13 +52,11 @@ Run the following command to install `gdb`: [source,console] ---- -$ brew install gdb +$ brew install arm-none-eabi-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]. diff --git a/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc b/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc index f8842c0bd..1dcc14cee 100644 --- a/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc +++ b/documentation/asciidoc/microcontrollers/debug-probe/swd-connection.adoc @@ -59,4 +59,4 @@ $ gdb blink.elf 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`. +* On macOS devices, use `arm-none-eabi-gdb`. diff --git a/documentation/images/full-sized/sd-cards.png b/documentation/images/full-sized/sd-cards.png index 86f47cf03..fe6fc104e 100644 Binary files a/documentation/images/full-sized/sd-cards.png and b/documentation/images/full-sized/sd-cards.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/sd-cards-SMALL.png b/documentation/images/sd-cards-SMALL.png index c866834b2..ee96081dd 100644 Binary files a/documentation/images/sd-cards-SMALL.png and b/documentation/images/sd-cards-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/index.json b/documentation/index.json index 709292b71..dc057ae92 100644 --- a/documentation/index.json +++ b/documentation/index.json @@ -78,12 +78,42 @@ "path": "accessories", "default_tab": "no", "subitems": [ + { + "title": "SD Cards", + "description": "Raspberry Pi's official SD cards", + "image": "full-sized/sd-cards.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": "Camera", "description": "Raspberry Pi camera boards", "image": "full-sized/Camera.png", "subpath": "camera.adoc" }, + { + "title": "AI Camera", + "description": "An AI Camera for your Raspberry Pi", + "image": "full-sized/ai-cam.png", + "subpath": "ai-camera.adoc" + }, { "title": "Display", "description": "The Raspberry Pi Touch Display", @@ -96,12 +126,6 @@ "image": "full-sized/Keyboard-and-Mouse.png", "subpath": "keyboard-and-mouse.adoc" }, - { - "title": "SD Cards", - "description": "Raspberry Pi's official SD cards", - "image": "full-sized/sd-cards.png", - "subpath": "sd-cards.adoc" - }, { "title": "Build HAT", "description": "How to use the Build HAT", @@ -114,24 +138,12 @@ "image": "full-sized/Sense-HAT.png", "subpath": "sense-hat.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": "AI Kit", "description": "An NPU for your Raspberry Pi", "image": "full-sized/ai-kit.png", "subpath": "ai-kit.adoc" }, - { - "title": "AI Camera", - "description": "An AI Camera for your Raspberry Pi", - "image": "full-sized/ai-cam.png", - "subpath": "ai-camera.adoc" - }, { "title": "Raspberry Pi Audio", "description": "High-definition audio with Raspberry Pi", diff --git a/lib/doxygentoasciidoc b/lib/doxygentoasciidoc index 09e14b6d2..c086fe850 160000 --- a/lib/doxygentoasciidoc +++ b/lib/doxygentoasciidoc @@ -1 +1 @@ -Subproject commit 09e14b6d2fc7fd016e4556a8e10027033fb7b517 +Subproject commit c086fe850344ec408e0aae7a1ed18053047562d9