summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: RIoT: mention the 'fastboot' capabilitiesJuergen Borleis2023-08-252-0/+68
| | | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Link: https://lore.barebox.org/20230825101559.29166-3-jbe@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* arch: fastboot: testing: fix typosJuergen Borleis2023-08-251-7/+7
| | | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Link: https://lore.barebox.org/20230825101559.29166-1-jbe@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: replace "copy onto" by "write to" to prevent confusionRoland Hieber2023-06-209-13/+13
| | | | | | | | | | | | | | | "Copy" could be misunderstood as "use cp (on the file system level)", which will not lead to the intended results, i.e. writing to the device directly (e.g. using dd). Furthermore, using "write onto" [1] instead of "write to" [2] feels unnatural here – as if writing something on top of another. Use "to" instead. [1]: about 460.000 Google results [2]: about 146.000.000 Google results Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: intro: link to license and Git historyRoland Hieber2023-06-201-2/+5
| | | | | | | | | | For the people who only have a tarball of the DistroKit source, the version history is not included, so link to it. Also link to the full license to make it easier to find when reading the HTML version. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.barebox.org/20230510133915.1724757-2-rhi@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: use layered documentation instead of overwriting doc/guru.rstoRoland Hieber2023-06-202-19/+0
| | | | | | | | | | | | | | | Since PTXdist 2023.01.0, all files named index-layer-*.rst are included in the main toctree by upstream PTXdist, so there is no need anymore to fork the upstream guru.rst. See the docs for more info. We have to remove the :numbered: argument because the main toctree in the upstream guru.rst is already numbered, otherwise this will generate a warning. Link: https://www.ptxdist.org/doc/daily_work_section.html#integrate-project-specific-documentation-into-the-manual Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.barebox.org/20230510133915.1724757-1-rhi@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* v8a: barebox: switch to upstream ruleAhmad Fatoum2023-05-311-1/+1
| | | | | | | Now that we have configured the upstream rule to support both i.MX8M and Rockchip, let's wire it into the image rules. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
* arch: bootloader: enable 'fastboot' support over USB and networkJuergen Borleis2023-05-082-0/+164
| | | | | | | | | | | | | Enabling: - CONFIG_BOOTM_INITRD = y - CONFIG_USB_GADGET = y - CONFIG_USB_GADGET_FASTBOOT = y - CONFIG_NET_FASTBOOT = y - CONFIG_FASTBOOT_SPARSE = y - CONFIG_FASTBOOT_CMD_OEM = y Signed-off-by: Jürgen Borleis <jbe@pengutronix.de>
* v7a: add Wifx L1 SD-Card imageAhmad Fatoum2023-04-182-0/+17
| | | | | | | | | | | | The Wifx L1 is a SAMA5D4-based LoRaWAN gateway. This commit adds first support for booting DistroKit on it from SD-Card. Default boot medium is NAND, but a bootable SD-Card always has precedence over NAND. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.pengutronix.de/20230417131141.908678-6-a.fatoum@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: v8a: ROCK 3A: add documentation on writing barebox-only images to ↵Johannes Zink2023-03-271-1/+9
| | | | | | | | | | | | | | | | SD-Card and NOR Flash It may be useful to sometimes only write a barebox image to SD-Card, e.g. for chainloading, TFTP-Boot or if Android Fastboot is used for flashing the actual full image to a storage medium. Add documentation on which image to use. Also add a short section about how to write barebox to the fallback NOR SPI Flash on the ROCK 3A board. Signed-off-by: Johannes Zink <j.zink@pengutronix.de> Link: https://lore.pengutronix.de/20230324182952.501117-1-j.zink@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* rpi: rename platform to rpi1Roland Hieber2022-11-232-11/+11
| | | | | | | | | Make it clear that this platform is really only used for the legacy ARMv6-based RPi 1 boards, so that there is no confusion when trying to use it for RPi 2 or later, even for people who don't read the documentation. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: v8a: rock3a: Add documentationMichael Tretter2022-09-062-1/+30
| | | | | | Signed-off-by: Michael Tretter <m.tretter@pengutronix.de> Link: https://lore.pengutronix.de/20220905163615.2807729-21-m.tretter@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: intro: document helper scriptsRoland Hieber2022-09-051-0/+16
| | | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.pengutronix.de/20220905110709.1832516-5-rhi@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: fix some typosRoland Hieber2022-09-055-5/+5
| | | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.pengutronix.de/20220905110709.1832516-4-rhi@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: hardware: document v7a_noneon platformRoland Hieber2022-09-051-0/+19
| | | | | | | | | This also fixes the sphinx warning about hardware_v7a_noneon_sama5d3.rst not being included in any toctree. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.pengutronix.de/20220905110709.1832516-3-rhi@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: hardware: fix referencing nonexisting documents in toctreeRoland Hieber2022-09-051-2/+1
| | | | | | | | | These two files were merged into one in commit 17e0620b641f671a91a4. Fixes: 17e0620b641f671a91a4 (2022-04-26, "v7a: rpi: unify rpi{2, 3, cm3}.hdimg into common rpi.hdimg") Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.pengutronix.de/20220905110709.1832516-2-rhi@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: hardware: fix malformed tableRoland Hieber2022-09-051-3/+3
| | | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.pengutronix.de/20220905110709.1832516-1-rhi@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* v7a: rpi: unify rpi{2, 3, cm3}.hdimg into common rpi.hdimgOleksij Rempel2022-04-262-17/+17
| | | | | | | | | | | | | | barebox has had the ability to generate an extra image that's bootable like a kernel for a while now. With small adjustment, we can let the videocore use this image and pass it the appropriate device tree depending on the board used. Moving this decision into the VideoCore allows us to use the same image for both Raspberry Pi 2, Rasperry Pi 3 and Raspberry Pi CM3. Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.pengutronix.de/20220426083821.1829442-3-a.fatoum@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: document patch download with b4 from lore.distrokit.orgAhmad Fatoum2022-01-081-0/+7
| | | | | | | | | | b4 needs configuration when a project isn't hosted or mirrored by lore.kernel.org. We want DistroKit to be mirrored there, but until then, document how to fetch patches with the current setup. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.pengutronix.de/20220108082818.441480-1-a.fatoum@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* platform-v7a_noneon: sama5: platform w/out NEON extensionHolger Assmann2021-11-241-0/+22
| | | | | | | | | | | | | | | | | Some ARMv7 MPUs like the Microchip SAMA5D3 series do not implement the ARM SIMD (single instruction multiple data) extension NEON. Therefore, the new DistroKit platform-v7a_noneon provides a configuration setup targeting at ARMv7 processors that only include a no-NEON implementation. In this commit the platform gets populated with the files necessary to run a SAMA5D3 MCU on a KSZ9477 evaluation board and copy of vexpress target for qemu testing. Signed-off-by: Holger Assmann <h.assmann@pengutronix.de> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Link: https://lore.pengutronix.de/20211109092212.2774811-1-o.rempel@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* platform-mipsel: add basic qemu malta supportOleksij Rempel2021-07-162-0/+28
| | | | | | | | Add MIPSEL (MIPS little-endian 32bit) platform. Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Link: https://lore.pengutronix.de/20210708041628.17608-1-o.rempel@pengutronix.de Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: hardware: Fix swapped references in toctreesAlexander Dahl2021-05-101-2/+2
| | | | | | | Fixes: 26a961f79aa8 ("doc: hardware: add toctrees for mips and x86_64") Signed-off-by: Alexander Dahl <ada@thorsis.com> Link: https://lore.pengutronix.de/20210510112130.15491-3-ada@thorsis.com Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: hardware: v7a: raspi3: Add missing closing bracketAlexander Dahl2021-05-101-1/+1
| | | | | | | | | | | | | Fixes the following doc build error: reading sources... [100%] welcome /mnt/data/adahl/src/DistroKit/platform-v7a/state/docs/hardware_v7a_raspi3.rst:23: WARNING: Unknown target name: "usbboot <https://github.com/raspberrypi/usbboot". looking for now-outdated files... none found Fixes: e9c32bad6e9f ("v7a: Add support for Raspberry Pi CM3") Signed-off-by: Alexander Dahl <ada@thorsis.com> Link: https://lore.pengutronix.de/20210510112130.15491-2-ada@thorsis.com Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* v7a: Add support for Raspberry Pi CM3Uwe Kleine-König2021-03-151-1/+23
| | | | Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
* doc: document the new SAMA5D2 boardsAhmad Fatoum2020-11-012-0/+24
| | | | | | | | Add some basic documentation for the two new boards added in the previous commits. Suggested-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
* doc: rpi: mention that Raspberry Pi Zero W is also supportedRoland Hieber2020-09-152-4/+4
| | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: hardware: add toctrees for mips and x86_64Roland Hieber2020-09-041-0/+30
| | | | | | | | | | | sphinx complained about them: checking consistency... .../distrokit/platform-x86_64/state/docs/hardware_mips_qemu.rst: WARNING: document isn't included in any toctree .../distrokit/platform-x86_64/state/docs/hardware_x86_64_qemu.rst: WARNING: document isn't included in any toctree done Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: hardware: strip down boilerplate documentationRoland Hieber2020-09-041-55/+39
| | | | | | | | | It is enough to describe only once how to select the platform and build the images, as the steps are the same for every platform. Only the platformconfig and the toolchain architecture changes, so summarise them in a table at the beginning of the section. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: restructure the quick start steps in the introRoland Hieber2020-09-042-13/+32
| | | | | | | | | | Give a brief documentation on how to install the correct PTXdist and toolchain versions, and update outdated links to the PTXdist homepage. Signed-off-by: Roland Hieber <rhi@pengutronix.de> --- Robert, this relies on updated documentation on the PTX homepage. Please merge www.pengutronix.de, branch rhi/topic/toolchain-install first :-)
* add x86_64 platformOleksij Rempel2020-07-241-0/+6
| | | | | | and add a qemu script for testing. Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
* platform-mips: add basic qemu malta supportOleksij Rempel2020-02-161-0/+13
| | | | | | | | Currently this platform can build rootfs and run only barebox. Other parts need more work, but even on this stage we would be able to make toolchain and barebox regression tests. Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
* doc: hardware: reduce clutter in sub-toctreesRoland Hieber2020-01-071-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | All those hardware sections have roughly the same sub-sections, reduce it to only the board names: 2.1.1.1. QEmu 2.1.1.2. Beaglebone White 2.1.1.2.1. Boot Media 2.1.1.2.2. Serial Console 2.1.1.3. Beaglebone Black 2.1.1.3.1. Boot Media 2.1.1.3.2. Serial Console 2.1.1.4. Boundary Devices Nitrogen6X 2.1.1.4.1. Bootloader 2.1.1.4.2. Boot Media 2.1.1.4.3. Serial Console 2.1.1.5. RIoT-Board 2.1.1.5.1. Boot Media 2.1.1.5.2. Serial Console 2.1.1.6. Raspberry Pi 2 2.1.1.6.1. Boot Media 2.1.1.6.2. Serial Console 2.1.1.7. Raspberry Pi 3 2.1.1.7.1. Boot Media 2.1.1.7.2. Serial Console 2.1.1.8. Udoo Neo 2.1.1.8.1. Boot Media 2.1.1.8.2. Serial Console Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: fix sphinx warning "guru is already assigned section numbers"Roland Hieber2020-01-071-1/+0
| | | | | | | | guru.rst is included from index.rst, which already assigned the numbers in the toctree, so we don't need to number the toctree in guru.rst again. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: add infos about contributing and licenseRoland Hieber2020-01-071-0/+54
| | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: hardware: degrade header levelRoland Hieber2020-01-071-3/+3
| | | | | | These subsections belong to the respective platform sections. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: guru: sync with upstream PTXdistRoland Hieber2020-01-072-4/+2
| | | | | | | | | | | | Add contributing.rst from upstream PTXdist (sphinx warns about "docs/contributing.rst: WARNING: document isn't included in any toctree") and move faq.rst from intro.rst to guru.rst for the sake of consistency. Remove the index and search pages in guru.rst, as they are already included in index.rst at the top level. Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* doc: note that platform-rpi is not actively maintained currentlyRoland Hieber2020-01-071-0/+8
| | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de>
* Add support for Marvell espressobin2018-02-espressobin-v3Uwe Kleine-König2018-03-112-0/+32
|
* doc: v7a: riotboard: document boot switch settingsRoland Hieber2018-03-111-1/+12
| | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: v7a: document Nitrogen6X boardDistroKit-2018.03.0Roland Hieber2018-02-192-0/+23
| | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: v7a: include a generic way to get DistroKit running on new boardsRoland Hieber2018-01-221-0/+42
| | | | | | | | A short overview of our several barebox packages and images should suffice here, everything else should be added in the upstream PTXdist manual. Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: index: also include the FAQRoland Hieber2018-01-221-0/+1
| | | | | | | | Sphinx warns that this document isn't included in any toctree, and we should include it as it probably constitutes the most important section :-) Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: raspi3: fix typo in headerRoland Hieber2018-01-221-1/+1
| | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
* doc: add documentation for platform-rpiRoland Hieber2017-07-132-0/+52
| | | | Signed-off-by: Roland Hieber <rohieb@rohieb.name>
* doc: udoo neo: extend documentationChris Fiege2017-07-042-0/+19
| | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message, split from last patch] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: rpi3: extend documentationChris Fiege2017-07-042-1/+12
| | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message, split from last patch] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: rpi2: extend documentationChris Fiege2017-07-042-1/+12
| | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message, split from last patch] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: riotboard: extend documentationChris Fiege2017-06-302-0/+16
| | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message, split from last patch] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: extend documentation for supported hardwareChris Fiege2017-06-304-5/+25
| | | | | | | | | | | | | | | The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. As some hardware platforms do currently not work again after the recent rework, we remove them from the ToC for now and re-add them later when they have been tested and fixed. Adding Build doc to .gitignore. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
* doc: add sphinx/rst based documentationRobert Schwebel2017-06-269-0/+155
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-19 01:28:38 +0000