summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* | Documentation: user: usb: bring up to dateAhmad Fatoum2023-06-161-9/+26
| | | | | | | | | | | | | | | | | | The USB support got a few features since the docs were last touched. Document them. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230615133647.4115139-1-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: boards: nxp-imx8mp-evk; clarify firmware folderMarc Reilly2023-05-261-1/+1
|/ | | | | | | | | The imx8mp-bp31.bin file is expected to be in the firmware/ folder Signed-off-by: Marc Reilly <marc@cpdesign.com.au> Reviewed-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230526081541.29415-1-marc@cpdesign.com.au Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/vexpress'Sascha Hauer2023-05-243-3/+6
|\
| * ARM: remove vexpress_defconfigSascha Hauer2023-05-023-3/+6
| | | | | | | | | | | | | | | | | | vexpress is now covered by multi_v7_defconfig. To reduce the number of defconfigs remove vexpress_defconfig. While at it add a hint to the documentation how to build the vexpress images. Link: https://lore.barebox.org/20230425133535.273920-2-s.hauer@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/versatile'Sascha Hauer2023-05-244-4/+4
|\ \
| * | ARM: Merge imx_defconfig and versatilepb_defconfig into multi_v5_v6_defconfigSascha Hauer2023-05-024-4/+4
| |/ | | | | | | | | | | | | | | We have a imx_defconfig with only a few boards enabled and also a versatilepb_defconfig. Merge both configs into a multi_v5_v6_defconfig to reduce the number of defconfigs. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2023-05-242-2/+2
|\ \
| * | treewide: drop trailing spaceAhmad Fatoum2023-05-022-2/+2
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | Found by manual inspection of the output of: rg '\s+$' | rg -v dts/ Patch can be verified by observing that no diff results from: git show --ignore-space-at-eol Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Link: https://lore.barebox.org/20230424121805.150434-4-ahmad@a3f.at Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / of: platform: remap memory when encountering virtual-reg propertyAhmad Fatoum2023-05-231-0/+29
|/ | | | | | | | | | | | | | | | | | | | | Quoting the Device Tree specification v0.4-rc1[1]: The virtual-reg property specifies an effective address that maps to the first physical address specified in the reg property of the device node. This property enables boot programs to provide client programs with virtual- to-physical mappings that have been set up. The only upstream use of this device tree property are some PowerPC device trees that use it to find the virtual address of the early UART. Let's start handling this property in barebox as well by remapping the device to start at virtual-reg. [1]: https://github.com/devicetree-org/devicetree-specification/releases/tag/v0.4-rc1 Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230522052835.1039143-6-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/rockchip'Sascha Hauer2023-04-192-0/+11
|\
| * arm: rockchip: add support for CM3 on IO boardRouven Czerwinski2023-04-051-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | Working: - RKBIN DDR training (rk3566_ddr_1056MHz_v1.13.bin) - RKBIN TF-A (v1.34) from RKBIN - Environment storage - DHCP, ping and link detection Signed-off-by: Rouven Czerwinski <rouven@czerwinskis.de> Link: https://lore.barebox.org/20230330161101.58529-1-r.czerwinski@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: booting-linux: document booting specific FIT configurationAhmad Fatoum2023-03-281-0/+10
| | | | | | | | | | | | | | | | | | Apparently, this was so far undocumented, but it's useful in some setups where board type is detected dynamically. Document it. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230326112211.2900004-1-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2023-04-191-0/+3
|\ \
| * | Documentation: barebox environment: recommend a partition type GUID for GPT ↵Marco Felsch2023-04-171-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | partitions The partition type GUID was generated randomly. Having a defined GUID should reduce the risk of collisions in the future. The GUID and a phandle reference to the storage medium could be used as replacement for device-path if the medium supports GPT. Signed-off-by: Marco Felsch <m.felsch@pengutronix.de> Reviewed-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230327131218.247157-1-m.felsch@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | | Merge branch 'for-next/imx-image'Sascha Hauer2023-04-193-0/+35
|\ \ \
| * | | Documentation: i.MX8M: add EVK QSPI NOR barebox installation documentationMarco Felsch2023-04-043-0/+35
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Document the steps required to flash the barebox image to a QSPI NOR flash. This can be helpful if the user-space wants to update the QSPI NOR barebox image. These steps can be skipped if barebox is updated by the qspi bbu-handler. Signed-off-by: Marco Felsch <m.felsch@pengutronix.de> Link: https://lore.barebox.org/20230228-v2023-02-0-topic-flexspi-v2-23-3d33126d2434@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | / treewide: fix includes missed by multiarch supportAhmad Fatoum2023-04-111-2/+2
| |/ |/| | | | | | | | | | | | | | | | | | | Found by manual inspection of the results of: rg '#include\s*<mach/[^/]+>' | rg -v 'arch/(powerpc|sandbox|mips|x86|kvx)' Fixes: 68b778c24314 ("ARM: Drop mach dir include path") Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230411071436.1630752-13-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: imx: improve reboot mode sectionRoland Hieber2023-03-211-4/+11
| | | | | | | | | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.barebox.org/20230320114123.2202362-1-rhi@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: devicetree: list automatic boot argument fixupsJohannes Zink2023-03-211-0/+22
|/ | | | | | | | | | | | | | | | Barebox automatically fixes up several properties to the root and chosen node of the device tree passed to the booted system. These entries contain information about the hardware, reset source and the barebox version string. Add documentation on how to query these information from the booted linux system. Signed-off-by: Johannes Zink <j.zink@pengutronix.de> Reviewed-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230317121937.958131-1-j.zink@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* ARM: remove samsung archSascha Hauer2023-03-012-101/+0
| | | | | | | | | arch/arm/mach-samsung/ hasn't seen any active maintenance or interest for a long time. Remove the architecture, boards and defconfig files Reviewed-by: Marco Felsch <m.felsch@pengutronix.de> Link: https://lore.barebox.org/20230228135727.1602351-2-s.hauer@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: IMX: add doc for the Variscite DT8MCustomBoardMichael Kopfensteiner2023-02-271-0/+149
| | | | | | | | | | | | | This commit adds a page for the newly added Variscite board. The information about downloading the NXP firmware blobs was obtained from NXP's public U-Boot sources for the i.MX processors [1]. [1] https://github.com/nxp-imx/uboot-imx Signed-off-by: Michael Kopfensteiner <michael.kopfensteiner@vahle.com> Link: https://lore.barebox.org/20230223153601.59357-3-michael.kopfensteiner@vahle.com Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/rockchip'Sascha Hauer2023-02-231-3/+3
|\
| * Documentation: Rockchip: Update documentation to latest binariesSascha Hauer2023-01-241-3/+3
| | | | | | | | | | | | | | | | Upstream rkbin repository has been updated, update the paths in the documentation accordingly. Link: https://lore.barebox.org/20230123083511.991626-1-s.hauer@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2023-02-233-5/+9
|\ \
| * | treewide: rename leftover device_dAhmad Fatoum2023-02-211-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | We have some instances of device_d and driver_d still lingering in documentation and commented out code. Let's drop these as well. Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Link: https://lore.barebox.org/20230221070758.1130869-1-ahmad@a3f.at Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: networking: improve net.* variable descriptionRoland Hieber2023-02-082-4/+8
| |/ | | | | | | | | | | Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.barebox.org/20230206134551.3227602-1-rhi@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/ifupa'Sascha Hauer2023-02-231-1/+1
|\ \
| * | defaultenv-2: automount: use ifup -a1 for NFS/TFTP automountsAhmad Fatoum2023-02-031-1/+1
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | The ifup -a in the automounts has too big a scope: The remote server is specified at mount time, so we could stop bringing up interfaces once $global.net.server becomes resolvable. For the common case, where $global.net.server is initially empty and then set via DHCP, ifup provides the new -1 option to early-exit once $global.net.server was set. For setups where one, but not all, Ethernet interfaces have a cable attached, this normally reduces ifup -a time from 10s to 1s. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230130072057.34349-4-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: devicetree: describe new label-relative-path syntaxAhmad Fatoum2023-02-221-6/+39
| | | | | | | | | | | | | | | | | | | | | | | | For use in barebox, DTC v1.7.0 now allows constructing labels that are comprised of a parent label and a relative path. This is a middle ground for when no suitable label is defined upstream and a full path is too verbose and more likely to cause breakages that could've been avoided by restricting the path component. Describe this in the docs. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230217173057.1839835-4-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: i.MX8M: add EVK barebox installation documentationAhmad Fatoum2023-02-213-0/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | The barebox i.MX images have a preamble that pads the i.MX header to the offset expected by the BootROM. This allows writing barebox images directly to offset 0 on SD-Cards and eMMC user area. For some i.MX8M, these images can't be directly written to eMMC boot partitions and instead require special handling. Add a note about this to the documentation. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230217132140.2240388-1-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | bootsource: use /chosen instead of /aliases/barebox,bootsource-Ahmad Fatoum2023-02-211-7/+12
|/ | | | | | | | | | | Aliases were a bad choice for this as barebox could end up calling MMC devices /dev/barebox,bootsource-mmc0, which was not intended. Move over to using chosen instead. Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Link: https://lore.barebox.org/20230221070735.1130600-2-ahmad@a3f.at Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Rename struct device_d to deviceSascha Hauer2023-01-101-1/+1
| | | | | | | | | | | | | The '_d' suffix was originally introduced in case we want to import Linux struct device as a separate struct into barebox. Over time it became clear that this won't happen, instead barebox struct device_d is basically the same as Linux struct device. Rename the struct name accordingly to make porting Linux code easier. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de> Reviewed-by: Marco Felsch <m.felsch@pengutronix.de> Link: https://lore.barebox.org/20221214123512.189688-3-s.hauer@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Rename device_d::device_node to device_d::of_nodeSascha Hauer2023-01-101-1/+0
| | | | | | | | | | | | | | | | | | | | Linux struct device has the member of_node for the device_node pointer. Rename this in barebox accordingly to minimize the necessary changes when porting Linux code. This was done with the semantic patch: @@ struct device_d E; @@ - E.device_node + E.of_node @@ struct device_d *E; @@ - E->device_node + E->of_node Plus some manual adjustments. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de> Reviewed-by: Marco Felsch <m.felsch@pengutronix.de> Link: https://lore.barebox.org/20221214123512.189688-2-s.hauer@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: devicetree: Add folders to toctreeThorsten Scherer2022-12-071-0/+2
| | | | | | | | Fixes: 594d5d58af ("Documentations: devicetree: bindings: document watchdog-priority") Fixes: 21dda946e7 ("restart: do restart-priority OF parsing in restart_handler_register") Signed-off-by: Thorsten Scherer <t.scherer@eckelmann.de> Link: https://lore.barebox.org/20221205211149.olbstungmceamcsu@NB142.eckelmann.group Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: devicetree: bindings: Fix broken refThorsten Scherer2022-12-072-2/+2
| | | | | | | | Fixes: 594d5d58af ("Documentations: devicetree: bindings: document watchdog-priority") Fixes: 21dda946e7 ("restart: do restart-priority OF parsing in restart_handler_register") Signed-off-by: Thorsten Scherer <t.scherer@eckelmann.de> Link: https://lore.barebox.org/20221205211054.zi77zva7xns54kbc@NB142.eckelmann.group Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/imx'Sascha Hauer2022-11-145-3/+37
|\
| * ARM: stm32mp: mark iwdg2 with barebox,restart-warm-bootromAhmad Fatoum2022-10-271-1/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | All STM32MP1 DTs already include their respective barebox SoC header, so set barebox,restart-warm-bootrom there, so users can portably run: tamp.reboot_mode.next=serial reset -w To get into DFU mode. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20221017071000.1458292-9-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentations: devicetree: bindings: document watchdog-priorityAhmad Fatoum2022-10-271-0/+10
| | | | | | | | | | | | | | | | | | We parse watchdog-priority for every OF-enabled watchdog device, but failed to document it. Remedy this. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20221017071000.1458292-7-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * restart: add reset -w for warm bootrom resetAhmad Fatoum2022-10-273-2/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We currently support reboot mode communication with BootROMs of the i.MX6Q/DL, i.MX8MM and STM32MP15x. For each of these, the user must take care to use the correct reset as the highest priority reset often clears the non-volatile register mapped by the syscon holding the reboot mode. As we only have one BootROM, we can improve usability by adding a global flag that describes whether a restart handler is suitable for use after a bootrom reboot mode write. Add a flag bit describing this and allow populating it from the device tree as well as from drivers. Existing i.MX/STM32 drivers will be moved onto this in follow-up commits. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20221017071000.1458292-4-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * restart: do restart-priority OF parsing in restart_handler_registerAhmad Fatoum2022-10-271-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | The restart-priority OF property is parsed for a number of MFDs, but there is no reason really not to parse it for every restart handler that has a device tree node like we already do for watchdogs. Add a new struct restart_handler::of_node field and look into it if populated. With this of_get_restart_priority, is no longer used, so drop it. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20221017071000.1458292-3-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/arm64-entry'Sascha Hauer2022-11-141-8/+18
|\ \ | |/ |/|
| * Documentation: devel: porting: bring it up-to-dateAhmad Fatoum2022-10-261-8/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | A number of changes happened since this guide was first drafted: - We no longer use inline assembly for the header on ARM64, which lacks __attribute__((naked)) - FDT compression algorithm is no longer limited to LZO Update the guide to reflect this and while at it, fix some typos. Link: https://lore.barebox.org/20221024065716.1215046-9-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | documentation: devicetree: mtd: partition: fix partuuid exampleAhmad Fatoum2022-10-271-2/+2
|/ | | | | | | | | Having flash@0 in the binding example is misleading, because lookup is global. Point that out explicitly and modify the example. Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Link: https://lore.barebox.org/20221019091122.1713784-1-ahmad@a3f.at Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: slightly improve the porting guideRoland Hieber2022-10-241-21/+37
| | | | | | | | | | | Turn the first board code excerpt into a full example by adding the necessary includes files. Then in the line-by-line explanation, ensure a line break after each explained line by turning the list into a definition list, and be a bit more verbose when explaining some lines. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.barebox.org/20221021090510.399348-1-rhi@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/riscv'Sascha Hauer2022-10-132-5/+107
|\
| * RISC-V: add Allwinner Sun20i D1 Nezha supportMarco Felsch2022-10-071-0/+102
| | | | | | | | | | | | | | | | Add Allwinner sun20i SoC and D1-Nezha board support. Signed-off-by: Marco Felsch <m.felsch@pengutronix.de> Link: https://lore.barebox.org/20221005111214.148844-7-m.felsch@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * RISC-V: squash 64bit defconfigs into rv64i_defconfigMarco Felsch2022-10-072-5/+5
| | | | | | | | | | | | | | | | | | | | This commit squashes all 64bit risc-v defconfigs into one like armv8. The 32bit defconfigs are not changed since those systems have tight resource constraints and a generic defconfig may break some systems. Signed-off-by: Marco Felsch <m.felsch@pengutronix.de> Link: https://lore.barebox.org/20221005111214.148844-6-m.felsch@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | USB: gadget: fastboot: introduce optional flag for fastboot partitionsJohannes Zink2022-09-261-0/+1
|/ | | | | | | | | | | | | | | | | | | On some boards, some partitions exposed to fastboot may become unavailable under certain circumstances, e.g. if an SD-Card exposed to fastboot is removed. Previously, this lead to an error and the fastboot gadget did not initialize the remaining partitions exposed via fastboot, e.g. an eMMC which usually is permanently soldered on the board. This patch allows to append an optional flag 'o' to the description of a fastboot partition. If this partition is unavailable at the initialization of the fastboot gadget, said partition is skipped, while the remaining available partitions are still exposed. Signed-off-by: Johannes Zink <j.zink@pengutronix.de> Link: https://lore.barebox.org/20220922132410.2653284-1-j.zink@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation/conf.py: fix copyright yearsAntony Pavlov2022-09-161-1/+1
| | | | | | | | N.B. N-dash is used! Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Link: https://lore.barebox.org/20220912084627.84575-1-antonynpavlov@gmail.com Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/tftp'Sascha Hauer2022-09-141-0/+40
|\