summaryrefslogtreecommitdiffstats
path: root/Documentation/user
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'for-next/misc'Sascha Hauer2022-02-181-2/+3
|\
| * Documentation: reboot-mode: mention that system.reboot_mode.next is ↵Ulrich Ölmann2022-01-241-1/+2
| | | | | | | | | | | | | | | | initially set to 'normal' Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Link: https://lore.barebox.org/20220120114725.2580392-2-u.oelmann@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: reboot-mode: fix typosUlrich Ölmann2022-01-241-2/+2
| | | | | | | | | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Link: https://lore.barebox.org/20220120114725.2580392-1-u.oelmann@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/doc'Sascha Hauer2022-02-182-2/+22
|\ \
| * | Documentation: user: watchdog: note new wd -x optionAhmad Fatoum2022-01-261-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | wd command documentation is generated automatically and will list the new -x option. It's still a good idea to reference this in the watchdog user doc as well. Do so. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20220124151827.3313412-6-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: user: introduction: update with lore/matrix/libera infoAhmad Fatoum2022-01-261-2/+11
| |/ | | | | | | | | | | | | | | | | | | | | The Website already points at Libera instead of Freenode. Update the intro section, so the docs are correct as well. While at it, mention lore and matrix. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20220124151827.3313412-1-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: devel: add new project ideas sectionAhmad Fatoum2022-02-171-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This section will collect ideas to improve barebox and should serve as a pool of ideas for people who want to enter the field of firmware development but need some guidance what to work on. These tasks can be adopted as part of programs like Google Summer of Code or by motivated individuals outside such programs. It's structured after coreboot's https://doc.coreboot.org/contributing/project_ideas.html Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20220217082714.81749-2-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: user: barebox: fix formatting for code blockAhmad Fatoum2022-02-171-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx build warns that: Error in "code-block" directive: maximum 1 argument(s) allowed, 17 supplied. .. code-block:: console sh: mkimage -n barebox -A arm -T kernel -C none -a 0x80000000 -d \ build/images/barebox-freescale-imx53-loco.img image Problem is a missing blank line. Add it. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20220217082349.81494-1-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: Describe how to generate a uImage for use with bootmSascha Hauer2022-02-071-1/+12
| | | | | | | | | | | | | | U-Boot's bootm command doesn't take raw barebox images. Describe how to generate a uImage from them which then can be started with bootm. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: user: barebox: mention generic dt 2nd stage supportAhmad Fatoum2022-02-071-3/+15
| | | | | | | | | | | | | | | | | | | | | | Most users interested in chainloading barebox will probably want to use the generic DT format for that: It will pass the checks the boot command may have and it will ensure the system is in the correct state, e.g. that caches are disabled. Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Link: https://lore.barebox.org/20220205231930.2948516-2-ahmad@a3f.at Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: remove some references to zbarebox.binAhmad Fatoum2022-02-072-5/+5
|/ | | | | | | | | | At least ARM doesn't generate zbarebox.bin anymore. Remove some of the left-over references. Reported-by: Frank Wunderlich <frank-w@public-files.de> Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Link: https://lore.barebox.org/20220205231930.2948516-1-ahmad@a3f.at Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: reboot-mode: fix typosUlrich Ölmann2021-10-221-4/+4
| | | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Link: https://lore.barebox.org/20211021143654.13824-1-u.oelmann@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/targettools'Sascha Hauer2021-10-071-0/+45
|\
| * scripts: allow building USB loader tools for target as wellAhmad Fatoum2021-10-021-0/+45
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We currently build the USB loader tools only for the host (build) system, but it can be useful to cross compile them as well for the target. We already have some target tools, but support for those is easier, because they don't link against libraries. We use pkg-config to get cc and ld flags, but we always assume that pkg-config is for the host system and there is no well-defined way to request pkg-config for the target system. Support this by introducing a new CROSS_PKG_CONFIG. This will be consulted only for target tools and default to $(CROSS_COMPILE)pkgconfig. Users can override it as necessary, for example, with Yocto, pkg-config will be for the cross environment, so target tools can now be built with: export ARCH=sandbox CROSS_COMPILE=aarch64-linux-gnu- export CROSS_PKG_CONFIG=pkg-config scripts make targettools_defconfig make scripts Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20210917174127.23345-4-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2021-10-072-5/+3
|\ \
| * | Documentation: framebuffer: remove note about lack of backlight supportAhmad Fatoum2021-10-051-4/+2
| | | | | | | | | | | | | | | | | | | | | | | | barebox supports PWM backlight. Remove the notice about lack of support. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20210825092701.30436-1-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | net: add virtio network driverAhmad Fatoum2021-10-051-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This gives virtio-enabled boards an easy route to network connectivity: qemu-system-aarch64 -M virt -serial mon:stdio -trace file=/dev/null \ -kernel images/barebox-dt-2nd.img -cpu cortex-a57 -nographic \ -device virtio-net-device,netdev=network0 -netdev tap,id=network0,ifname=tap0 The tap0 interface created by QEMU can then be bridged/listened on. Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | | Documentation: Typo fix in command exampleJules Maselbas2021-10-041-1/+1
| |/ |/| | | | | | | | | | | | | The ``make`` command is missing a closing angle bracket ``>``. Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu> Link: https://lore.barebox.org/20210907130131.26755-2-jmaselbas@kalray.eu Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: reboot-mode: add note about /env/bmodeAhmad Fatoum2021-10-012-2/+4
|/ | | | | | | | | | | | This directory is an optional part of the defaultenv-2 and is documented there. There should be a sentence about it in the reboot-mode docs as well, because users can add it to their environments as well to avoid doing if-else chains in the init scripts. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20210922091549.23185-1-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/usb-gadget'Sascha Hauer2021-07-181-0/+5
|\
| * usbgadget: add support for USB mass storage gadgetAhmad Fatoum2021-06-251-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This driver is based on the f_mass_storage drivers in Linux v5.11 and U-Boot v2021.01. Unlike the U-Boot version, it runs asynchronously without blocking the bootloader from doing other tasks, like exporting other USB gadgets at the same time or enabling shell access. With pollers and workqueues, enabling this would need a large rework of the code to be completely callback based, whenever the original Linux code sleeps waiting for events. With the new bthread support, we can actually sleep and handover control to other bthreads until there is actual work to do. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20210622082617.18011-9-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: Add documentation for device tree overlaysSascha Hauer2021-06-281-0/+43
| | | | | | | | | | | | | | | | Document the recently gained device tree overlay features. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de> Link: https://lore.barebox.org/20210624085223.14616-18-s.hauer@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | doc: devicetree: Refer to internal device tree also as live treeSascha Hauer2021-06-281-1/+1
|/ | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de> Link: https://lore.barebox.org/20210624085223.14616-17-s.hauer@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Update env sources documentationTrent Piepho2021-05-251-6/+10
| | | | | | | | | | | Add CONFIG_DEFAULT_ENVIRONMENT_PATH to the list in the proper place. Update the board env to follow the new pattern for naming and note that, unlike the other directories, one must add code to get this directory in the environment. Link: https://lore.barebox.org/20210519060134.2976676-1-tpiepho@gmail.com 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-151-2/+2
|\
| * Documentation: virtio: Fix virtio referenceAhmad Fatoum2021-04-131-1/+1
| | | | | | | | | | | | | | | | 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-151-3/+3
|\ \
| * | 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>
* | 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>
* 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>
* 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>
* 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>
* 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>
* 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/net' into masterSascha Hauer2020-09-251-2/+2
|\
| * 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: 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: 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>
* 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-25 07:17:36 +0000