summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* 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
|\
| * defaultenv: provide defaults for generic reboot modesAhmad Fatoum2020-09-291-4/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | While reboot mode magic identifiers can be very board specific, we can settle on common names to allow some generic reboot mode handling: - loader -> drop to bootloader shell on next boot - bootloader -> enable fastboot on next boot - recovery -> display barebox boot menu Boot modes loader and bootloader are admittedly a bit ambiguous, but this nomenclature was chosen, because it's already in use on Android and Rockchip systems. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * power: reset: reboot-mode: port syscon-reboot-mode supportAhmad Fatoum2020-09-291-0/+11
| | | | | | | | | | | | | | | | | | | | Reboot modes are one-shot information that should be valid for only a single reset. Syscons that survive a warm reset are one way to implement this. This is used by many BootROMs to allow falling into a recovery mode on the next boot. This ports the Linux syscon-reboot-mode support. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * drivers: add reboot-mode infrastructureAhmad Fatoum2020-09-291-0/+84
| | | | | | | | | | | | | | | | | | | | | | Reboot modes provide a well-defined way to exchange information between different stage of the boot process. When configured, users can type `reboot bootloader` in the OS and barebox can read it out a device parameter. Likewise barebox can write a reboot mode for the BootROM to evaluate and then reset to fall into a serial recovery mode for example. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc' into masterSascha Hauer2020-10-141-1/+1
|\ \
| * | ARM: stm32mp: dk2: rename to dkx to make dk1 support clearerAhmad Fatoum2020-10-071-1/+1
| |/ | | | | | | | | | | | | | | | | | | As we now support both the stm32mp157a-dk1 and stm32mp157c-dk2 with the same barebox image, we should call the board stm32mp15xx-dkx instead. That's also how the upstream DTSI is named. Suggested-by: Holger Assmann <has@pengutronix.de> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / Documentation: efi: update SnpDxe build instructionsPhilipp Zabel2020-10-091-2/+3
|/ | | | | | | | Some sources have been moved into git submodules and SnpDxe was moved from MdeModulePkg to NetworkPkg. Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/net' into masterSascha Hauer2020-09-254-2/+142
|\
| * Documentation: Add document about background execution in bareboxSascha Hauer2020-08-193-0/+140
| | | | | | | | | | | | | | With pollers, slices and now workqueues it's time to add some documentation how these things work and how they all play together. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * fastboot: rename usbgadget.fastboot_* variables to fastboot.*Daniel Glöckner2020-08-191-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | There is nothing USB-specific in the defined usbgadget.fastboot_* variables. Rename them to be usable also for the UDP fastboot transport. The usbgadget.fastboot_function variable is used to define the files and devices accessible with the erase and flash commands. Since "function" is a term from the USB specification and the Fastboot specification uses the term "partition", we rename that variable to "fastboot.partitions". Signed-off-by: Daniel Glöckner <dg@emlix.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: boards: stm32mp: document eMMC boot configurationAhmad Fatoum2020-09-141-1/+12
| | | | | | | | | | | | | | | | | | | | In order to boot from eMMC on the STM32MP15x, the boot_ack bit in the ext_csd register must be set. Document this and while at it, fix a misformatted code block in the same section. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Bastian Krause <bst@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: user: fix referenced filenameThorsten Scherer2020-09-141-1/+1
| | | | | | | | | | | | | | Adjust filename and path of nfsroot.txt according to Linux commit f9a9349 ("Documentation: nfsroot.txt: convert to ReST") Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: update for loongson1 boardDu Huanpeng2020-08-191-1/+1
| | | | | | | | | | Signed-off-by: Du Huanpeng <u74147@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/stm32' into masterSascha Hauer2020-08-191-0/+1
|\ \ | |/ |/|
| * ARM: stm32mp: add support for Seeed Odyssey boardAhmad Fatoum2020-08-031-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Board consists of SoM with stm32mp157c with 4G eMMC and 512M DDR3 RAM. Carrier board features USB and ETH interfaces and SD card connector. USB and ETH interfaces not yet operational. Boot from eMMC requires boot ack bit set. Device Tree taken from v5 of kernel device tree off mailing list[1]. [1]: https://lore.kernel.org/linux-arm-kernel/20200724145107.35772-3-marcin.sloniewski@gmail.com/ Tested-by: Jookia <contact@jookia.org> Tested-by: Xogium <contact@xogium.me> Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation/sandbox: fix code blockYegor Yefremov2020-08-031-1/+1
|/ | | | | | | Remove unneeded colon. Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/misc'Sascha Hauer2020-07-271-3/+5
|\
| * Documentation: devicetree: hint at libfdt being availableAhmad Fatoum2020-06-181-3/+5
| | | | | | | | | | | | | | | | | | Since 7e5a875fff7d ("Compile libfdt for barebox"), we now also have libfdt for operating on flattened device trees out of the PBL. Document this. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/mips'Sascha Hauer2020-07-271-0/+144
|\ \
| * | MIPS: AR9331: OKUD Max9331Du Huanpeng2020-06-181-0/+144
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Oleksij and Kevin's Useless Devices. O&KUD Max9331 AR9331 400MHz MIPS 64M DRAM 16M SPI Flash 4G USB Nand Flash 3 User LEDs 3 Ports(1Wan/2Lan) 1 TTL Debug Uart Signed-off-by: Du Huanpeng <u74147@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/imx'Sascha Hauer2020-07-272-1/+66
|\ \
| * | arm: boards: add initial imx8mp-evk supportOleksij Rempel2020-07-141-0/+65
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds support for the NXP i.MX8MP-EVK board. The SDRAM timings are taken from U-Boot-2020.07-rc4, other information how to initialize the board are form U-Boot as well. Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | scripts: imx-image: rename dcdofs to ivtofsSascha Hauer2020-07-141-1/+1
| |/ | | | | | | | | | | | | | | | | This renames the dcdofs config option in the imx-image tool to ivtofs. dcdofs is a misnomer. The DCD (Device Configuration Data) is only one part of the data linked into the IVT (Image Vector Table), but the meaning of the option is really the latter, not the former. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / Documentation: devicetree: codify extension of upstream DTS by phandlesAhmad Fatoum2020-06-231-0/+43
|/ | | | | | | | | | | | | | | | Sync with the upstream device tree repository has been a common cause for breakage in barebox. Often unnoticed: * New bindings are merged upstream and device trees migrated, but barebox didn't yet have support * Nodes are renamed upstream, but barebox still extends the old name, with duplicate nodes resulting We can solve the second one by requiring dtc to give us errors when paths we extend no longer exist. Document how to do so. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* ARM: stm32mp: expand stm32mp_defconfig for new drivers and boardAhmad Fatoum2020-04-281-0/+1
| | | | | | | | | | | While some support is still missing (USB, LCD), we already have some prerequisites in place like USB PHY and PWM (for backlight). We also have gained one new board and some other new drivers since the last time the defconfig was touched, so enable them all, as well as some possibly useful commands. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: kvx: add first documentationClement Leger2020-04-222-0/+109
| | | | | | | Add documentation on kvx architecture and kalray k200 board. Signed-off-by: Clement Leger <cleger@kalray.eu> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/imx'Sascha Hauer2020-03-181-0/+71
|\
| * ARM: i.MX: Add i.MX8MM EVK board supportSascha Hauer2020-02-191-0/+71
| | | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: blspec: drop documentation of devicetree-overlayMichael Tretter2020-03-091-4/+0
| | | | | | | | | | | | | | | | The devicetree-overlay key is part of the official Boot Loader Specification. There is no need to document it in Barebox, again. Signed-off-by: Michael Tretter <m.tretter@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: blspec: update link to Boot Loader SpecificationMichael Tretter2020-03-091-1/+1
| | | | | | | | | | | | | | | | | | | | There is a big warning on the linked page that the page is obsolete and a link to the current version of the Boot Loader Specification. The Barebox documentation shall directly link to the current version of the specification. Signed-off-by: Michael Tretter <m.tretter@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: boards: stm32mp: document eMMC partition layoutAhmad Fatoum2020-03-021-2/+17
|/ | | | | | | | | For eMMC, the boot partitions are used for FSBL instead of having these two partitions in the user area, like with SD-Cards. Document this. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/optee'Sascha Hauer2020-02-182-0/+30
|\
| * user: add documentation for OP-TEE loadingRouven Czerwinski2020-01-302-0/+30
| | | | | | | | | | | | | | Some rudimentary documentation how to load OP-TEE. Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2020-02-181-0/+3
|\ \
| * | Documentation/sandbox: Add hint how to end a sandboxed bareboxUwe Kleine-König2020-02-101-0/+3
| |/ | | | | | | | | Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / doc: bootchooser: Fix barebox-state exampleChristian Eggers2020-02-101-1/+3
|/ | | | | | | | | | - Fix prefix - attemps --> attempts - add missing equal sign - Add 2 examples Signed-off-by: Christian Eggers <ceggers@arri.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* led: parse panic-indicator from device-treeHubert Feurstein2019-12-111-0/+3
| | | | | Signed-off-by: Hubert Feurstein <h.feurstein@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* led: add documentation for net-tx and net-rx triggersHubert Feurstein2019-12-111-1/+3
| | | | | Signed-off-by: Hubert Feurstein <h.feurstein@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/stm32'Sascha Hauer2019-12-101-0/+10
|\