diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guru.rst | 17 | ||||
| -rw-r--r-- | doc/hardware_v7a_beaglebone_black.rst | 2 | ||||
| -rw-r--r-- | doc/hardware_v7a_beaglebone_white.rst | 2 | ||||
| -rw-r--r-- | doc/hardware_v7a_noneon_sama5d3.rst | 2 | ||||
| -rw-r--r-- | doc/hardware_v7a_raspi23.rst | 6 | ||||
| -rw-r--r-- | doc/hardware_v7a_riot.rst | 68 | ||||
| -rw-r--r-- | doc/hardware_v7a_sama5d2.rst | 2 | ||||
| -rw-r--r-- | doc/hardware_v7a_udoo_neo.rst | 2 | ||||
| -rw-r--r-- | doc/hardware_v8a_espressobin.rst | 2 | ||||
| -rw-r--r-- | doc/hardware_v8a_rock3a.rst | 6 | ||||
| -rw-r--r-- | doc/index-layer-1-distrokit.rst (renamed from doc/index.rst) | 2 | ||||
| -rw-r--r-- | doc/intro.rst | 7 | ||||
| -rw-r--r-- | doc/testing.rst | 16 |
13 files changed, 93 insertions, 41 deletions
diff --git a/doc/guru.rst b/doc/guru.rst deleted file mode 100644 index 1929464..0000000 --- a/doc/guru.rst +++ /dev/null @@ -1,17 +0,0 @@ -Welcome to the PTXdist Universe -=============================== - -.. toctree:: - :glob: - :maxdepth: 3 - - welcome - environment - user_manual_section - dev_manual - ref_manual - daily_work_section - contributing - getting_help - faq - diff --git a/doc/hardware_v7a_beaglebone_black.rst b/doc/hardware_v7a_beaglebone_black.rst index bb523b6..f0adfb9 100644 --- a/doc/hardware_v7a_beaglebone_black.rst +++ b/doc/hardware_v7a_beaglebone_black.rst @@ -3,7 +3,7 @@ Beaglebone Black Boot Media ---------- -Use the image ``platform-v7a/images/beaglebone.hdimg`` and copy it onto your MicroSD-Card. +Use the image ``platform-v7a/images/beaglebone.hdimg`` and write it to your MicroSD-Card. Press the user-button ``S2`` when powering up the Beaglebone Black to boot from MicroSD-Card. ``S2`` is the button above the MicroSD-Card. Serial Console diff --git a/doc/hardware_v7a_beaglebone_white.rst b/doc/hardware_v7a_beaglebone_white.rst index 540066b..2ed669b 100644 --- a/doc/hardware_v7a_beaglebone_white.rst +++ b/doc/hardware_v7a_beaglebone_white.rst @@ -3,7 +3,7 @@ Beaglebone White Boot Media ---------- -Use the image ``platform-v7a/images/beaglebone.hdimg`` and copy it onto your MicroSD-Card. +Use the image ``platform-v7a/images/beaglebone.hdimg`` and write it to your MicroSD-Card. Serial Console -------------- diff --git a/doc/hardware_v7a_noneon_sama5d3.rst b/doc/hardware_v7a_noneon_sama5d3.rst index db784e3..aaeed3e 100644 --- a/doc/hardware_v7a_noneon_sama5d3.rst +++ b/doc/hardware_v7a_noneon_sama5d3.rst @@ -10,7 +10,7 @@ Boot Media ---------- DistroKit generates ``platform-v7a_noneon/images/*.hdimg``. -Use the respective image for your board and copy it onto your SD card. +Use the respective image for your board and write it to your SD card. The EVB-KSZ9477 board has only 1 SD slot. To boot from SD, J13 (NAND Enable) jumper should be removed. diff --git a/doc/hardware_v7a_raspi23.rst b/doc/hardware_v7a_raspi23.rst index 0f6eee6..f1d2041 100644 --- a/doc/hardware_v7a_raspi23.rst +++ b/doc/hardware_v7a_raspi23.rst @@ -3,7 +3,7 @@ Raspberry Pi 2 Boot Media ---------- -Use the same ``platform-v7a/images/rpi.hdimg`` image and copy it onto your MicroSD-Card. +Use the same ``platform-v7a/images/rpi.hdimg`` image and write it to your MicroSD-Card. Serial Console -------------- @@ -18,7 +18,7 @@ Raspberry Pi 3 Boot Media ---------- -Use the same ``platform-v7a/images/rpi.hdimg`` image and copy it onto your MicroSD-Card. +Use the same ``platform-v7a/images/rpi.hdimg`` image and write it to your MicroSD-Card. Serial Console -------------- @@ -33,7 +33,7 @@ Raspberry Pi Compute Module 3+ Boot Media ---------- -Use the same ``platform-v7a/images/rpi.hdimg`` image and copy it onto your MicroSD-Card. +Use the same ``platform-v7a/images/rpi.hdimg`` image and write it to your MicroSD-Card. If you have a hardware with eMMC the uSD slot is not functional, in this case you have to use `usbboot <https://github.com/raspberrypi/usbboot>`_ to switch diff --git a/doc/hardware_v7a_riot.rst b/doc/hardware_v7a_riot.rst index 0ea4ce7..a6e2365 100644 --- a/doc/hardware_v7a_riot.rst +++ b/doc/hardware_v7a_riot.rst @@ -3,7 +3,7 @@ RIoT-Board Boot Media ---------- -Use the image ``platform-v7a/images/riotboard.hdimg`` and copy it onto your SD card. +Use the image ``platform-v7a/images/riotboard.hdimg`` and write it to your SD card. Set the DIP switches (SW1) accordingly to boot from a full-size SD card (J6 on the bottom) or a Micro SD card (J7 on top): @@ -24,3 +24,69 @@ The serial boot console is available at the debug-header J18 at 115200 Baud and * J18.2: RxD * J18.3: GND +Fast development +---------------- + +For development the RIoT-Board bootloader supports 'fastboot'. Refer +:ref:`fast_development` for Linux and BSP preparation on demand. + +RIoT i.MX6S +~~~~~~~~~~~ + +The BSP already supports 'fastboot' and prepares the target accordingly. +The PARTITION names might differ, so you should check first, what PARTITIONs +are exported. + +To get the exported PARTITION names, available via 'fastboot', you can run:: + + $ fastboot getvar all + (bootloader) version: 0.4 + (bootloader) bootloader-version: barebox-2023.02.1 + (bootloader) max-download-size: 8388608 + (bootloader) partition-size:mmc1: 00000000 + (bootloader) partition-type:mmc1: unavailable + (bootloader) partition-size:mmc2: 00000000 + (bootloader) partition-type:mmc2: unavailable + (bootloader) partition-size:mmc3: e5000000 + (bootloader) partition-type:mmc3: basic + (bootloader) partition-size:ram-kernel: 00000000 + (bootloader) partition-type:ram-kernel: file + (bootloader) partition-size:ram-initramfs: 00000000 + (bootloader) partition-type:ram-initramfs: file + (bootloader) partition-size:ram-oftree: 00000000 + (bootloader) partition-type:ram-oftree: file + (bootloader) partition-size:bbu-emmc: 000e0000 + (bootloader) partition-type:bbu-emmc: basic + +In this example, the PARTITION names are 'mmc1', 'mmc2', 'mmc3', 'ram-kernel', +'ram-initramfs', 'ram-oftree' and 'bbu-emmc'. In this example the two possible +SD cards are not plugged in (e.g. "unavailable"). + +.. note:: You need to restart the fastboot usbgadget, if you probe the SD cards + later on. + +Just connect the USB OTG connector to your host and run:: + + $ fastboot flash ram-kernel platform-v7a/images/linuximage -S 1 + $ fastboot flash ram-oftree platform-v7a/images/imx6dl-riotboard.dtb -S 1 + $ fastboot flash ram-initramfs platform-v7a/images/root.cpio.gz -S 1 + $ fastboot oem exec -- boot ram-fastboot + +You can populate local memory like the eMMC as well. But only full memory +devices and no particular partitions. + +If inserted, the regular SD card:: + + $ fastboot flash mmc1 platform-v7a/images/riotboard.hdimg -S 1 + +If inserted, the µSD card:: + + $ fastboot flash mmc2 platform-v7a/images/riotboard.hdimg -S 1 + +The built-in eMMC:: + + $ fastboot flash mmc3 platform-v7a/images/riotboard.hdimg -S 1 + +.. note:: If you have no USB connection to the RIoT i.MX6S, you can use + a network connection instead. Just run all the 'fastboot' commands + shown above with the additional option '-s udp:<RIoT i.MX6S IP address>'. diff --git a/doc/hardware_v7a_sama5d2.rst b/doc/hardware_v7a_sama5d2.rst index ae39cdf..083a46d 100644 --- a/doc/hardware_v7a_sama5d2.rst +++ b/doc/hardware_v7a_sama5d2.rst @@ -10,7 +10,7 @@ Boot Media ---------- DistroKit generates ``platform-v7a/images/sama5d27-*.hdimg``. -Use the respective image for your board and copy it onto your SD card. +Use the respective image for your board and write it to your SD card. The Giant board has only 1 microSD slot, the EK has additionally 1 normal SD-sized slot. Both can be used. diff --git a/doc/hardware_v7a_udoo_neo.rst b/doc/hardware_v7a_udoo_neo.rst index b84fde7..674bdfe 100644 --- a/doc/hardware_v7a_udoo_neo.rst +++ b/doc/hardware_v7a_udoo_neo.rst @@ -4,7 +4,7 @@ Udoo Neo Boot Media ---------- -Use the image ``platform-v7a/images/udoo-neo.hdimg`` and copy it onto your MicroSD-Card. +Use the image ``platform-v7a/images/udoo-neo.hdimg`` and write it to your MicroSD-Card. Serial Console diff --git a/doc/hardware_v8a_espressobin.rst b/doc/hardware_v8a_espressobin.rst index 63d3e89..dc4fc77 100644 --- a/doc/hardware_v8a_espressobin.rst +++ b/doc/hardware_v8a_espressobin.rst @@ -3,7 +3,7 @@ Marvell espressobin Boot Media ---------- -Use the image ``platform-v8a/images/espressobin.hdimg`` and copy it onto your MicroSD-Card, e.g: +Use the image ``platform-v8a/images/espressobin.hdimg`` and write it to your MicroSD-Card, e.g: .. code-block:: shell diff --git a/doc/hardware_v8a_rock3a.rst b/doc/hardware_v8a_rock3a.rst index 72eb9d8..72bf187 100644 --- a/doc/hardware_v8a_rock3a.rst +++ b/doc/hardware_v8a_rock3a.rst @@ -4,12 +4,12 @@ Radxa Rock 3 Model A Boot Media ---------- -Copy the image ``platform-v8a/images/rock3a.img`` onto a microSD card. Put the +Write the image ``platform-v8a/images/rock3a.img`` to a microSD card. Put the microSD card into the Rock 3A and boot it, the system will autoboot to linux. If you just want to boot to barebox instead of a full linux image from microSD card (e.g. for chainloading or tftpboot), -copy the image ``platform-v8a/images/barebox-rock3a.norimg`` onto a microSD card instead. +write the image ``platform-v8a/images/barebox-rock3a.norimg`` to a microSD card instead. Alternatively, you may put the Rock 3A into MASKROM mode following the `Rock 3 Hardware User Manual <https://wiki.radxa.com/Rock3/hardware/3a>`_ and boot @@ -19,7 +19,7 @@ Barebox via USB: platform-v8a/sysroot-host/bin/rk-usb-loader platform-v8a/images/barebox-rock3a.img -Once Barebox is booted, copy the image ``platform-v8a/images/rock3a.img`` via +Once Barebox is booted, write the image ``platform-v8a/images/rock3a.img`` via tftp or NFS to the eMMC to persist it. Disable MASKROM mode and reboot the board to start from eMMC. diff --git a/doc/index.rst b/doc/index-layer-1-distrokit.rst index f76f48c..751ef3f 100644 --- a/doc/index.rst +++ b/doc/index-layer-1-distrokit.rst @@ -3,12 +3,10 @@ Welcome to DistroKit .. toctree:: :glob: - :numbered: :maxdepth: 2 intro hardware - guru testing * :ref:`search` diff --git a/doc/intro.rst b/doc/intro.rst index 2d4ec2f..d07a238 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -138,5 +138,8 @@ License Copyright (C) 2020 Pengutronix and individual contributors DistroKit is licensed under the GNU General Public License, version 2.0. -See the file named LICENSE in the root directory of this project for the full -license terms, and the version control history for contributor information. +See the file named `LICENSE`_ in the root directory of this project for the full +license terms, and the `version control history`_ for contributor information. + +.. _LICENSE: https://git.pengutronix.de/cgit/DistroKit/tree/LICENSE +.. _version control history: https://git.pengutronix.de/cgit/DistroKit/log diff --git a/doc/testing.rst b/doc/testing.rst index afa1be8..ef477cb 100644 --- a/doc/testing.rst +++ b/doc/testing.rst @@ -1,3 +1,5 @@ +.. _fast_development: + Fast development ================ @@ -5,19 +7,19 @@ Sometimes a quick test should be done: a new kernel feature or a tool should be tested on a real target. If the target suports USB OTG (or peripheral mode) or network, 'fastboot' -can be an easy to use solution. +can be an easy-to-use solution. 'fastboot' support ------------------ For a fast development or testing cycle you can use 'fastboot' via -USB or networt to transfer the required parts to the target system. +USB or network to transfer the required parts to the target system. Here we want to run a Linux kernel and a corresponding root filesystem, -without writing target system local memories againg and again for each +without writing target system local memories again and again for each development or test cycle. -In this text, we transfer the required files to the target system +In this test, we transfer the required files to the target system which only needs to run a 'fastboot' capable bootloader. Since we want to use an initramfs as the kernel's root filesystem, we @@ -76,7 +78,7 @@ And we want run the downloaded files, so we need: BSP --- -Create a initramf of the root filesystem: +Create an initramf of the root filesystem: - PTXCONF_IMAGE_ROOT_CPIO = y @@ -100,7 +102,7 @@ Some BPS settings do not make sense regarding used in an initramfs instead of a persistent target system local memory. For development or testing some settings should be changed, to reduce the file sizes and boot time. -The Linux kernel will be transfered separately, so it makes less sense to +The Linux kernel will be transferred separately, so it makes less sense to have it in the root filesystem as well. This will reduce the size of the initramfs. @@ -128,7 +130,7 @@ size hits some threshold. In this case, there are some additional requirements to the size of the file itself: its size must be a multiple of 4 kiB. Note: if this additional requirement isn't met, the error message is - missleading and states about an 'invalid value' after the first + misleading and states about an 'invalid value' after the first transfer. Most of the time the initramfs file hits the threshold. Thus, it must |