summaryrefslogtreecommitdiffstats
path: root/Documentation/user
Commit message (Collapse)AuthorAgeFilesLines
* doc: clarify state framework driver requirementMoritz Augsburger2019-04-261-1/+7
|
* doc: variables: nv vars are saved automatically.Tomaz Solc2019-04-231-3/+5
| | | | | | | | | | In recent barebox versions, nv variables are saved automatically upon reset or kernel start (console message "nv variable modified, will save nv variables on shutdown" warns about that). There is no need to explicitly call saveenv. This change was introduced in 3fadbdae. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bootchooser: add retry handling to algorithm descriptionEnrico Jorns2019-02-181-0/+5
| | | | | Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bootchooser: add details about bootchooser.reset_attempts handlingEnrico Jorns2019-02-181-5/+7
| | | | | | | | For understanding and correctly using the algorith it is useful to know when the values are evaluated. Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bootchooser: be more explicit about when the bootchooser terminatesEnrico Jorns2019-02-181-0/+3
| | | | | Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bootchooser: note how to actually start the bootchooserEnrico Jorns2019-02-181-0/+11
| | | | | Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bootchooser: be more explicit about attempts reset on successful bootEnrico Jorns2019-02-181-9/+32
| | | | | | | | | From the current description of how the bootchooser algorithm works it is not that easy to figure out how to actually use it in a full (redundancy) boot chain. Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bootchooser: be more explicit what bootchooser.state_prefix is forEnrico Jorns2019-02-181-2/+3
| | | | | Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bootchooser: explicitly note configuration vs. storage backendEnrico Jorns2019-02-181-0/+5
| | | | | | | It is quite confusing for some users sometimes where to set what. Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: bootchooser: fix typos etc.Enrico Jorns2019-02-181-5/+5
| | | | | Signed-off-by: Enrico Jorns <ejo@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: state: fix closing brace without opening braceRoland Hieber2019-01-211-1/+0
| | | | | | | | | Also fix the resulting sphinx warning: Documentation/user/state.rst:650: WARNING: Explicit markup ends without a blank line; unexpected unindent. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* net: Allow hostnames for global.net.serverSascha Hauer2019-01-041-2/+2
| | | | | | | Additional to IPv4 addresses add support for global.net.server being a hostname. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* usbgadget: autostart: add DFU supportLadislav Michl2018-10-291-0/+2
| | | | | | | | | | | Use global variable dfu_function to autostart DFU. As similar code is used to start multifunction gadget using command, move common code to common/usbgadget.c and consolidate it. It turned out that '-s' option of usbgadget command does nothing, so remove its help text and make it function as '-a'. Signed-off-by: Ladislav Michl <ladis@linux-mips.org> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: USB gadget: document usbgadget.fastboot_bbu variableLadislav Michl2018-10-291-0/+2
| | | | | Signed-off-by: Ladislav Michl <ladis@linux-mips.org> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/state'Sascha Hauer2018-08-131-43/+43
|\
| * Documentation: state: add unit name to state variable in DTUlrich Ölmann2018-07-131-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | Starting with DT compiler version 1.4.6 (included since v2018.07.0) one gets warnings <node>: node has a reg or ranges property, but no unit name if the first address field of a reg-property is not taken as the unit name for its parent node. Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: state: fix typosUlrich Ölmann2018-07-131-31/+31
| | | | | | | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: state: harmonize capitalization in headingsUlrich Ölmann2018-07-131-7/+7
| | | | | | | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: fix code block and literal block highlightingRoland Hieber2018-08-109-29/+77
|/ | | | | | | | | Use shell script highlighting where it is resonable, use console highlighting for transcripts, and fix some of the few cases where the syntax was broken, resulting in text not being rendered at all. Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/kill-oftree-f'Sascha Hauer2018-07-092-14/+6
|\ | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: explain new way to boot using ATAGsSascha Hauer2018-06-112-14/+6
| | | | | | | | | | | | | | oftree -f is gone and now global.bootm.boot_atag must be set to true if boot using ATAGs is desired. Update the documentation accordingly. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: use https for Pengutronix servicesUwe Kleine-König2018-06-133-4/+4
|/ | | | | | | | Also adapt the links to git.pengutronix.de to use the cgit URLs instead the old gitweb ones. Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* defaultenv-2: make abort key to stop autoboot configurableOleksij Rempel2018-06-071-0/+3
| | | | | | | | | | | | currently supported only two options: any key and ctrl-c "any key" is default option. To configure it, use: nv autoboot_abort_key=any or nv autoboot_abort_key=ctrl-c Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/net'Sascha Hauer2018-05-091-0/+4
|\
| * net: on ifup -a only detect devices when necessarySascha Hauer2018-04-091-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | For network boot we once used to hardcode eth0, but in latest changes this was changed to work with different network devices and the 'ifup eth0' was replaced with 'ifup -a' which lead to the result that we now detect all devices in order to eventually also bring up USB network adapters. In most of the cases this is not desired. When a board has internal network support this is likely to be used. With this patch we only detect all devices when we do not have a network device already. For the unusual case in which a USB network adapter shall be used even when an internal network interface is present we introduce the global variable "global.net.ifup_force_detect" which can be used to force detection of devices. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | blspec: add checking of optional key machine-idAndreas Schmidt2018-05-081-0/+6
|/ | | | | | | | | | | | | For filtering of Bootloader Spec entries, Bootloader Spec specify an optional key machine-id. By set the global.boot.machine-id variable the checking of machine-id key in Bootloader Spec entries will be activate. If the variable and key match, appropriate boot entry will be booting. If it not match boot entry will be ignore and barebox check the next boot entry. Signed-off-by: Andreas Schmidt <mail@schmidt-andreas.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: framebuffer: update documentation to current stateOleksij Rempel2018-04-051-3/+4
| | | | | | | | Framebuffer console support was added in 2015. Reported-by: TobSnyder at #barebox irc Signed-off-by: Oleksij Rempel <linux@rempel-privat.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* docs: add reference to libratp-barebox in the remote-control docsAleksander Morgado2018-03-011-0/+7
| | | | | Signed-off-by: Aleksander Morgado <aleksander@aleksander.es> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/fastboot-sparse'Sascha Hauer2018-01-221-10/+39
|\
| * usb: gadget: fastboot: Add sparse image supportSascha Hauer2018-01-181-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sparse images are needed for fastboot to flash images that do not fit into memory. Android fastboot is kind of a dumb protocol. It first sends you a big image and afterwards it tells you where to put this image. This of course limits fastboot to files smaller than the available memory. To bypass this issue fastboot has so called Sparse image support. This is a new image format that can contain holes in the data so a big image can be written in multiple steps with holes in other areas each step. Implementing this for UBI images is kind of tricky since ubiformat normally expects to get a single image. Preparations to ubiformat a device in multiple parts have been done in previous patches. It is however, only for the first part possible to detect if it is a UBI image. The other parts are just binary data and we cannot know if we have to pass this data raw to the flash or use ubiformat. For this reason this patch makes the 'u' flag in the partition description mandatory for proper UBI image flashing on MTD devices. fastboot passes a max_download_size variable to the host. This variable contains the image size fastboot can take in one go. We have to choose a good compromise here. On one hand we do not want to risk that we actually do not have enough memory to hold the transferred image, on the other hand we want images like bootloaders not as sparse images, but in one go instead to make atomic exchange of the bootloader possible. Right now we have chosen 8MiB which should be big enough for all bootloaders. The value is configurable via global.usbgadget.fastboot_max_download_size. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: USB gadget: Add section for partition descriptionSascha Hauer2018-01-111-10/+38
| | | | | | | | | | | | | | Partition descriptions are used with both fastboot and DFU, so add a separate section describing them and remove it from the DFU section. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: Bootchooser: fix typoBastian Stender2018-01-221-1/+1
|/ | | | | Signed-off-by: Bastian Stender <bst@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/net'Sascha Hauer2018-01-053-37/+106
|\
| * net: environment: update automountsSascha Hauer2017-12-151-1/+1
| | | | | | | | | | | | | | | | | | | | | | Instead of using "ifup ethx" use "ifup -a" which works with all network interfaces. Also replace "$ethx.serverip" with "$global.net.server". This makes the automount independent of the actual network interface. Remove all board specific /env/init/automount files which were only there to use eth1 instead of the previously hardcoded eth0. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * net: update network docsSascha Hauer2017-12-142-36/+105
| | | | | | | | | | | | | | The network configuration has changed in the previous patches. Update the documentation accordingly. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2018-01-051-2/+44
|\ \
| * | Documentation: state: mention SD/eMMC devicesSascha Hauer2017-12-111-2/+44
| |/ | | | | | | | | | | | | The state framework also has support for SD/eMMC devices, so mention them in the documentation. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: remove :numbered: from lower level toctreesSascha Hauer2017-12-011-1/+0
| | | | | | | | | | | | | | Only the highest level toctree may have :numbered:, otherwise sphinxs complains loudly that the subtree is already numbered. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: defaultenv-2: Change highlight to makeSascha Hauer2017-12-011-1/+3
|/ | | | | | It's a make snippet, so change highlighting accordingly. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* docs: rework and extend the 'state' and 'bootchooser' documentationJuergen Borleis2017-09-062-196/+993
| | | | | | | | Many links between sections and examples were added to give the developer the help to get it work. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/misc'Sascha Hauer2017-06-144-17/+124
|\
| * Documentation: improve network boot sectionRoland Hieber2017-06-131-17/+39
| | | | | | | | | | Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: provide documentation for RNG interfaces.Oleksij Rempel2017-05-112-0/+64
| | | | | | | | | | Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: usbgadget: provide autostart notesOleksij Rempel2017-05-081-0/+21
| | | | | | | | | | | | | | | | The usbgadget autostart functionality is already added. It's time to reflect it in the documentation. Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: remote-control: fix typoAleksander Morgado2017-06-011-4/+3
|/ | | | | | | | Correctly reference `--port` instead of `--baudrate` when explaining how to specify the port. Signed-off-by: Aleksander Morgado <aleksander@aleksander.es> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* state: Update documentationSascha Hauer2017-03-311-7/+26
| | | | | | | | - explain what buckets are - rework text about storage backends - explain redundancy concept Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: remote-control: fix markupStefan Lengfeld2017-01-101-2/+2
| | | | | | | | Fix missing '*' for bold text and remove indentation. It should be rendered as a single paragraph. Signed-off-by: Stefan Lengfeld <s.lengfeld@phytec.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: bootchooser: fix typosUlrich Ölmann2017-01-101-26/+31
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/misc'Sascha Hauer2016-10-101-3/+5
|\
| * Documentation: clarify that patches should target the master branch.Robert Schwebel2016-09-261-3/+5
| | | | | | | | | | | | | | | | | | I asked Sascha if he still prefers patches against 'next', and it turned out that this is not true any more and patches should be sent against master. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-26 05:08:54 +0000