summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: kvx: Fix broken linkJules Maselbas2021-05-031-1/+1
| | | | | | | | The link to toolchain releases was missing a part Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu> Link: https://lore.barebox.org/20210417211419.26883-1-jmaselbas@kalray.eu Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: user: watchdog: sync with current stateAhmad Fatoum2021-05-031-4/+32
| | | | | | | | | Since most of the documentation was written, the watchdog framework has gained three more device parameters. Document them. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20210426113408.24903-2-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/virtio'Sascha Hauer2021-04-152-3/+3
|\
| * Documentation: virtio: Fix virtio referenceAhmad Fatoum2021-04-132-2/+2
| | | | | | | | | | | | | | | | Sphinx complains, probably, because _virtio is used for footnote in the same document. Rename it to fix the reference. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * input: add virtio input driverAhmad Fatoum2021-04-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | We already support Linux event codes, because they are used in the device tree bindings for e.g. gpio-keys. Virtio input devices report events using the same codes, so a driver just has to shovel the codes from virtqueue into the input layer. Do so. Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2021-04-153-156/+71
|\ \
| * | Documentation: Add qemu instructions for OpenRISCStafford Horne2021-04-131-0/+68
| | | | | | | | | | | | | | | | | | | | | | | | | | | Most developers have qemu and rather not download and install the or1ksim. Also, this adds details on how to get a openrisc toolchain. Signed-off-by: Stafford Horne <shorne@gmail.com> Link: https://lore.pengutronix.de/20210304210747.3679483-1-shorne@gmail.com Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | doc: fix note about disassembling PBLAhmad Fatoum2021-03-251-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | The described ``make`` incantations no longer work. Refer to the current names of the files instead. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | x86: drop legacy (PC BIOS) boot in favor of EFIAhmad Fatoum2021-03-251-153/+0
| |/ | | | | | | | | | | | | | | | | | | | | | | | | The 16-bit port has experienced bitrot and failed to compile with more recent linkers for at least a year. Fixing the linker error is insufficient to restore a barebox that can boot to shell. This continued breakage likely means that there are no users interested in updating. As new x86 projects should be using MACH_EFI_GENERIC anyway, retire support for 16-bit legacy boot (MACH_X86_GENERIC). Acked-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: add barebox porter's guideAhmad Fatoum2021-04-133-0/+512
| | | | | | | | | | | | | | | | Make new porters' life easier by having a central place for porting advice and add some initial content there. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: reference reboot-mode DocumentationAhmad Fatoum2021-04-131-0/+1
| | | | | | | | | | | | | | No ToC is referencing the page. Fix this. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: reboot-mode: fix headingsAhmad Fatoum2021-04-131-4/+5
| | | | | | | | | | | | | | | | What was supposed to be subheadings of the Disambiguation headings weren't by mistake. Bump up the other headings to restore the balance. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: fix sucessfuly -> successfully typoVivien Didelot2021-04-131-1/+1
| | | | | | | | | | | | | | | | system-reset.rst was embedded a classic sucess -> success typo. Fix it. Signed-off-by: Vivien Didelot <vdidelot@pbsc.com> Link: https://lore.pengutronix.de/20210406150120.4194149-1-vivien.didelot@gmail.com Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: dlink-dir-320: update device linksAntony Pavlov2021-04-011-2/+2
| | | | | | | | | | Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: dlink-dir-320: update image file nameAntony Pavlov2021-04-011-2/+2
|/ | | | | | | | The commit 102676feb218ab59 ("MIPS: port all mach* to multiimage") changed D-Link DIR-320 image name so update it in documentation. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* RISC-V: add Qemu virt supportRouven Czerwinski2021-03-231-0/+59
| | | | | | | | | | | | | | | | The generic dt board added in a previous commit can be booted on RISC-V qemu -M virt. Add defconfigs for both 32- and 64-bit machines. We could in theory drop the mach directory altogether like it's done on arm64, but for now it's left in as it provides <mach/debug_ll.h>. It's expected that we can drop it in future in favor of generic earlycon support (which also wouldn't require manual adjustment of the shared entry point like with debug_ll). Signed-off-by: Rouven Czerwinski <r.czerwinksi@pengutronix.de> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* RISC-V: erizo: migrate to PBLAhmad Fatoum2021-03-231-5/+8
| | | | | | | | | | We now have everything in place to migrate erizo to PBL. As currently, this is the only board, we can drop all non-PBL support in the same go. Cc: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/virtio'Sascha Hauer2021-03-231-13/+17
|\
| * virtio: support virtio-based device drivers over PCIAhmad Fatoum2021-03-041-13/+17
| | | | | | | | | | | | | | | | | | This driver provides support for virtio based paravirtual device drivers over PCI. This is useful with Qemu for boards that barebox has PCI support for, e.g. MIPS Malta. Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2021-03-231-2/+33
|\ \
| * | ARM: stm32mp: add support for STM32MP157-EV1 boardAhmad Fatoum2021-03-171-2/+33
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The STM32MP157A-EV1 and STM32MP157C-EV1 Evaluation boards are the full-feature demonstration and development platforms for STMicroelectronics Arm®-based dual Cortex®-A7 32 bits and Cortex®-M4 32 bits MPUs in the STM32MP1 Series. Add support for running barebox as SSBL on either of them. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | | Merge branch 'for-next/bthreads'Sascha Hauer2021-03-231-4/+33
|\ \ \
| * | | common: introduce bthreads, co-operative barebox threadsAhmad Fatoum2021-03-221-4/+33
| | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the new setjmp/longjmp/initjmp support, we have all the architecture support in place to have suspendable green threads in barebox. These are expected to replace pollers and workqueues. For now we still have a differentiation between the main and secondary threads. The main thread is allowed I/O access unconditionally. If it's in a delay loop, a secondary thread running needs to be wary of not entering the same driver and doing hardware manipulation. We already have slices as mechanism to guard against this, but they aren't used as widely as needed. Preferably, in the end, threads will automatically yield until they can claim a resource (i.e. lock a mutex). Until we are there, take the same care when using bthreads as with pollers. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | | Merge branch 'for-next/arm-qemu-virt64'Sascha Hauer2021-03-231-1/+2
|\ \ \
| * | | ARM64: qemu-virt64: migrate to generic DT imageAhmad Fatoum2021-03-171-1/+2
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Current qemu-virt64 barebox support doesn't look much like what's offered on physical boards. It's not relocatable, lacks PBL and doesn't use device tree. As qemu-system-aarch64 -M virt -kernel already supplies an external device tree, we could just replace all existing support with BOARD_ARM_GENERIC_DT, which builds a barebox image that reuses an externally passed device tree. The 32-bit ARM VIRT support has some board code for host name setting and overlay applying to handle environment and state on flash. We could do without that, given the new virtio-blk support, but the code is already there, so reuse it and drop all current virt64-specific board code. As the barebox ELF image resulting from the build can no longer be directly booted as before and only with -kernel, not -bios, rename the Kconfig symbol, so existing users can notice this during build. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / / Documentation: mips: fixup qemu-system-mipsel cmdlineAntony Pavlov2021-03-221-1/+1
|/ / | | | | | | | | | | | | | | Fix spelling mistake introduced in the commit 2ab6d2a76994 ("MIPS: qemu-malta_defconfig: enable VGA output"). Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/arch-remove'Sascha Hauer2021-03-011-1/+0
|\ \
| * | nios2: Remove architectureSascha Hauer2021-02-241-1/+0
| |/ | | | | | | | | | | | | | | barebox nios2 support was merged in 2011. It hasn't seen very much active development since then and appears to have no active users. Remove the architecture. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / Documentation: devicetree: include firmware in toctreeThorsten Scherer2021-02-241-0/+1
|/ | | | | | | | Fix Sphinx consistency warning. Fixes: fcdcb8177 ("documentation: devicetree: migrate remaining binding to reST") Signed-off-by: Thorsten Scherer <tsc@scherer.tk> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/virtio'Sascha Hauer2021-02-222-0/+83
|\
| * Documentation: add Documentation on VirtIO for bareboxAhmad Fatoum2021-02-222-0/+83
| | | | | | | | | | | | | | | | | | Save users the trip to the commit log and reproduce some example qemu invocations in the documentation. The text around it is adapted from the U-Boot doc/README.virtio. Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: state: recommend a partition type GUID for state GPT partitionsBastian Krause2021-02-161-0/+3
|/ | | | | | | | | | | | | | | The partition type GUID was generated randomly. Having a defined GUID should reduce the risk of collisions in the future. A dedicated GUID could also allow us to implement a fallback in case no state backend property is defined. This could then look for a GPT partition with this partition type GUID and use that as the backend. dt-utils could do the same in userspace. This would be similar to [1]. [1] https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/ Signed-off-by: Bastian Krause <bst@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/video'Sascha Hauer2021-01-191-2/+2
|\
| * MIPS: qemu-malta_defconfig: enable VGA outputAhmad Fatoum2021-01-051-2/+2
| | | | | | | | | | | | | | | | Now that we have a driver for the Qemu's default -device VGA, enable it in defconfig, along with fbtest for testing it. Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2021-01-194-49/+56
|\ \
| * | documentation: devicetree: migrate remaining binding to reSTAhmad Fatoum2021-01-134-49/+56
| |/ | | | | | | | | | | | | | | | | | | | | Eventually, we will want to have formalized YAML bindings and scripts to turn them into reST for display in the online documentation. For now, just turn the remaining text files into reST, so they can be searched as well. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / Documentation: boards: sandbox: describe --image flagsAhmad Fatoum2021-01-131-0/+14
|/ | | | | | | | | | barebox partition table parsing can be tested in sandbox using the recently added ,blkdev flag. Extend the documentation to cover this. Cc: Juergen Borleis <jbe@pengutronix.de> Reported-by: Lucas Stach <lst@pengutronix.de> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bcm283x: document use of mini-uart on Raspberry Pi Zero W / CM3Ahmad Fatoum2020-12-101-0/+7
| | | | | | | | | | | | | | | | | | As described in the UART configuration[1] article in the Raspberry Pi Foundation documentation, Raspberry Pi 3 & 4 as well as Zero W use the mini-uart as primary (easily user-accessible) UART. At least on the Raspberry Zero W and CM3, we need to pass uart_2ndstage=1, so the BootROM leaves the 8250 IP in a suitable state for use by barebox. Document this. [1]: https://www.raspberrypi.org/documentation/configuration/uart.md Cc: Roland Hieber <rhi@pengutronix.de> Cc: Rouven Czerwinski <rcz@pengutronix.de> Cc: Robert Carnecky <robert@neopsis.com> Cc: Andrew John <andrew@mobius-embedded-systems.co.uk> Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bcm283x: fix mix up regarding SoC on raspberry pi zeroAhmad Fatoum2020-11-231-2/+2
| | | | | | | | The Raspberry Pi Zero has the same ARMv6 SoC as the very first Raspberry Pi 1, not an ARMv8. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: state: clarify how to access state device parametersAhmad Fatoum2020-11-131-3/+3
| | | | | | | | | | | | Users may be inclined to use hyphens in state variable names as this is customary for device tree nodes. Such variables can't be read with $state.example-variable or written with state.example-variable=, because it's incompatible with Hush. Adjust the documentation to nudge users into the correct direction (${state.example-variabe} and setenv) Suggested-by: Matthias Fend <Matthias.Fend@wolfvision.net> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: add note about characters like hyphens in variable namesAhmad Fatoum2020-11-131-1/+8
| | | | | | | | | | | | | | The mismatch between the allowed characters in shell variables and device parameters is a common pitfall, especially because device tree node names often have hyphens in them, which is disallowed by hush. While such variables can be read by the ${variable-example}, setting them is only possible with the setenv command. Reflect this in the documentation. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/at91'Sascha Hauer2020-11-102-21/+19
|\
| * ARM: at91: define new at91_multi_defconfigAhmad Fatoum2020-10-192-12/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | We now have 5 boards supporting multi-image, so add a defconfig that covers these five boards: - Microchip KSZ-9477 EVB - Microchip SAMA5D27-SOM1-EK - Groboards Giantboard - Atmel AT91SAM9263-EK - Atmel AT91SAM9x5 Series Evaluation Kit Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * doc: at91: delete done TODOsAhmad Fatoum2020-10-191-9/+0
| | | | | | | | | | | | | | | | | | e52a250d2381 ("ARM: boards: Harmonize barebox_arm_reset_vector() prototype") has unified the prototype, so we can drop this TODO item. Cc: Sam Ravnborg <sam@ravnborg.org> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: aarch64-qemu-virt: note physical target supportAhmad Fatoum2020-10-211-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | The documentation structure is a bit unfortunate because it says 4.1. Aarch64, but lists only a single virtual board. Fix this by: - Removing the Aarch64 heading, as there are more boards outside it - Explicitly note that this documentation page only refers to the virtual target Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: x86: note EFI supportAhmad Fatoum2020-10-211-0/+5
| | | | | | | | | | | | | | | | Most users are better served by using the EFI support. Add an info box to nudge them into the correct direction. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: glossary: add some extra infoAhmad Fatoum2020-10-211-6/+6
| | | | | | | | | | | | | | | | Besides expanding the acronyms, a short description text can be useful. Add one where appropriate and sort the list alphabetically. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: boards: stm32mp: search engine optimizationAhmad Fatoum2020-10-211-1/+1
| | | | | | | | | | | | | | | | The vendor calls it STM32MP1. Have this name appear in the documentation as well to be easier found during web search. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: smhfs: fix some typosAhmad Fatoum2020-10-211-4/+4
|/ | | | | | | There are a few typos in the document. Fix them. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/reboot-mode' into masterSascha Hauer2020-10-142-4/+109
|\
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-27 15:36:51 +0000