summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* docs: mvebu: describe -n more accurately in the sphinx documentUwe Kleine-König2017-06-301-3/+9
| | | | | Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/misc'Sascha Hauer2017-06-147-32/+135
|\
| * 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>
| * firmware: altera-serial: add support for Arria 10Bastian Stender2017-06-091-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | Make FPGA specific settings configurable (padding, spi bits per word, delays) and add Arria 10 support. The Arria 10 compatible is the same as in the kernel patch "fpga manager: Add altera-ps-spi driver for Altera FPGAs" (drivers/fpga/altera-ps-spi.c). The Arria 5 compatible works unchanged. This patch was tested with Arria 5 and Arria 10. Signed-off-by: Bastian Stender <bst@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * docs: move kwboot description to generic mvebu sectionUwe Kleine-König2017-06-062-12/+6
| | | | | | | | | | | | | | | | Expand the generic part about kwboot to the mvebu page and advertise the parameter -n to make it simpler to boot some machines. Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * docs: mvebu can do 2nd stage bootingUwe Kleine-König2017-06-061-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | Since commit 823d08e3e261 ("kwbimage_v1: add support to boot a mvebu image") barebox can use bootm to load a 2nd barebox image. Update the documentation accordingly. Signed-off-by: Uwe Kleine-König <u.kleine-koenig@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>
* | Merge branch 'for-next/imx'Sascha Hauer2017-06-141-0/+21
|\ \
| * | ARM: i.MX6 Wandboard: add DocumentationAlexander Kurz2017-06-131-0/+21
| |/ | | | | | | | | Signed-off-by: Alexander Kurz <akurz@blala.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>
* | docs: render DIP switches as verbatim textStefan Lengfeld2017-05-171-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | Render images of DIP switches as <pre> html tags/verbatim text. This fixes the sphinx errors: Documentation/boards/imx/Element14-WaRP7.rst:25: ERROR: Malformed table. Documentation/boards/imx/Element14-WaRP7.rst:36: ERROR: Malformed table. Documentation/boards/imx/Element14-WaRP7.rst:47: ERROR: Malformed table. Signed-off-by: Stefan Lengfeld <contact@stefanchrist.eu> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | docs: add file suffix rst for inclusion in sphinx documentationStefan Lengfeld2017-05-171-0/+0
| | | | | | | | | | Signed-off-by: Stefan Lengfeld <contact@stefanchrist.eu> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | docs: fix hiding of chapter from imx.rstStefan Lengfeld2017-05-171-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The files 'mxs.rst' and 'imx.rst' used the same chapter headline: Freescale i.MXs This confuses sphinx. It does not support having the same headline at the same level twice and hides the other chapter. Just rename the chapter heading to avoid that. And rename the subchapter headline to 'MXS boards' for clarity. Signed-off-by: Stefan Lengfeld <contact@stefanchrist.eu> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | state: Fix example in documentationSascha Hauer2017-05-091-1/+1
|/ | | | | | | The backend property must contain a phandle, so use a phandle in the example. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/state'Sascha Hauer2017-05-051-1/+7
|\
| * state: Make an alias mandatorySascha Hauer2017-05-041-0/+6
| | | | | | | | | | | | | | | | The userspace barebox-state utility gets confused when no alias exists. Make the alias mandatory, so that people make it right^tm without having to ask. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * state: Binding: remove @0 from node nameSascha Hauer2017-05-041-1/+1
| | | | | | | | | | | | | | | | The '@0' suffix is for nodes which have a reg property, so do not use this suffix in the state example node which does not have a reg property. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | docs: update vendor URL for Vincell-LTUlrich Ölmann2017-04-261-1/+1
| | | | | | | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | ARM: i.MX50: Add support for i.MX50 based Amazon Kindle e-book readersAlexander Kurz2017-04-241-0/+58
|/ | | | | | | | | | | | | | | | | | | | | | | | The Kindle Model No. D01100 (Kindle Wi-Fi), D01200 (Kindle Touch) and EY21 (Kindle Paperwhite) are refered as the Kindle 4th and 5th generation. Those models are based on an i.MX50 SoC and use LPDDR1 or LPDDR2 Memory. The devices boot in internal boot mode from a build-in eMMC, alternatively some devices may be set into USB-downloader mode by pressing a specific key at startup. Add support for the i.MX50 based Kindle device and make barebox a drop-in replacement for the factory shipped u-boot image. Notable features: - Support for eMMC, USB, UART, I2C, SPI and Keys (except keyboard). - LPDDR1 and LPDDR2 setup is done via DCD, the same imximage may be used for USB-startup and for installation. - Support for vendor specific ATAGs that are required for the Kindle-System. - usbserial barebox console access by pressing Select button at startup, alternatively full console support on connector J14. Signed-off-by: Alexander Kurz <akurz@blala.de> 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>
* state: backend_circular: default to circular storageSascha Hauer2017-03-311-3/+3
| | | | | | | | Default to the new circular storage format which saves erase cycles. The old format can still be selected with backend-storage-type = "noncircular". Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* state: Make pointing to the backend using a phandle the only supported methodSascha Hauer2017-03-311-7/+20
| | | | | | | | | | All other methods are broken for some time already: When starting the kernel the state code rewrites the state node in the device tree and replaced the "backend" property with a phandle - even when the target can't be described as a phandle. Since using phandles is the nicest way to point to the storage device anyway remove the other methods. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* efi: move x86 efi boot support to x86 archJean-Christophe PLAGNIOL-VILLARD2017-02-271-1/+1
| | | | | | | prepare to drop the efi arch as efi boot up is not arch sepecific Signed-off-by: Jean-Christophe PLAGNIOL-VILLARD <plagnioj@jcrosoft.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* ARM: i.MX: Add WaRP7 board supportJuergen Borleis2017-01-201-0/+54
| | | | | Signed-off-by Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* ARM: i.MX: Add i.MX7 base architecture supportJuergen Borleis2017-01-201-0/+1
| | | | | Signed-off-by Juergen Borleis <jbe@pengutronix.de> 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>
* docs: state: make string variable type clearerStefan Lengfeld2016-11-031-2/+2
| | | | | | | Only fixed length strings are supported. Make the wording clearer. Signed-off-by: Stefan Lengfeld <s.lengfeld@phytec.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/mvebu'Sascha Hauer2016-10-102-0/+69
|\
| * ARM: mvebu: document some general mvebu stuff and the rn2120 boardUwe Kleine-König2016-10-072-0/+69
| | | | | | | | | | Signed-off-by: Uwe Kleine-König <u.kleine-koenig@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>
* | | boot: add framework for redundant boot scenariosMarc Kleine-Budde2016-09-223-0/+277
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are several use cases where a redundant Linux system is needed. The barebox bootchooser framework provides the building blocks to model different use cases without the need to start from the scratch over and over again. The bootchooser works on abstract boot targets, each with a set of properties and implements an algorithm which selects the highest priority target to boot. See the documentation contained in this patch for more information. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de> Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / Documentation: imd: fix sphinx warningAntony Pavlov2016-09-211-2/+6
|/ | | | | | | | | | The patch fixes this sphinx warnings: barebox/Documentation/user/imd.rst:27: WARNING: Could not lex literal_block as "c". Highlighting skipped. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Cc: Sascha Hauer <s.hauer@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/rockchip'Sascha Hauer2016-09-132-0/+81
|\
| * doc: Add RK3288 DocumentationWadim Egorov2016-09-012-0/+81
| | | | | | | | | | Signed-off-by: Wadim Egorov <w.egorov@phytec.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/imx'Sascha Hauer2016-09-131-0/+1
|\ \
| * | ARM: add common definitions for i.MX50 SOCAlexander Kurz2016-09-121-0/+1
| |/ | | | | | | | | Signed-off-by: Alexander Kurz <akurz@blala.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: aarch64-qemu-virt: fix sphinx issuesAntony Pavlov2016-09-091-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The patch fixes these sphinx issues: barebox/Documentation/boards/aarch64-qemu-virt.rst:7: WARNING: Title underline too short. Running barebox on QEMU aarch64 virt machine ^^^^^^^^^^^^^^^^^^^^^^^ barebox/Documentation/boards/aarch64-qemu-virt.rst:1: ERROR: Document or section may not begin with a transition. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Cc: Raphael Poggi <poggi.raph@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: usb: fix sphinx warningAntony Pavlov2016-09-091-1/+3
|/ | | | | | | | | | The patch fixes this sphinx warnings: barebox/Documentation/user/usb.rst:61: WARNING: Could not lex literal_block as "c". Highlighting skipped. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Cc: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: variables: fix error in "code-block" directiveAntony Pavlov2016-08-151-0/+1
| | | | | | | | | | | | | | | | | | The patch fixes this sphinx error: barebox/Documentation/user/variables.rst:79: ERROR: Error in "code-block" directive: maximum 1 argument(s) allowed, 15 supplied. .. code-block:: sh barebox@Phytec phyCARD-i.MX27:/ nv dev.nand0.partitions: 4M(barebox),1M(barebox-environment),-(root) barebox@Phytec phyCARD-i.MX27:/ devinfo nand0 Parameters: [...] partitions: 4M(barebox),1M(barebox-environment),8M(kernel),1011M(root) [...] Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: barebox: fix 'Could not lex literal_block as "c"' warningAntony Pavlov2016-08-151-15/+45
| | | | | | | | | | | | The patch fixes these sphinx warnings: barebox/Documentation/user/barebox.rst:19: WARNING: Could not lex literal_block as "c". Highlighting skipped. barebox/Documentation/user/barebox.rst:33: WARNING: Could not lex literal_block as "c". Highlighting skipped. barebox/Documentation/user/barebox.rst:186: WARNING: Could not lex literal_block as "c". Highlighting skipped. barebox/Documentation/user/barebox.rst:205: WARNING: Could not lex literal_block as "c". Highlighting skipped. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: tplink-mr3020: fix 'Could not lex literal_block as "c"' warningAntony Pavlov2016-08-151-3/+9
| | | | | | | | | | The patch fixes these sphinx warnings: barebox/Documentation/boards/mips/tplink-mr3020.rst:31: WARNING: Could not lex literal_block as "c". Highlighting skipped. barebox/Documentation/boards/mips/tplink-mr3020.rst:40: WARNING: Could not lex literal_block as "c". Highlighting skipped. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/state'Sascha Hauer2016-07-113-1/+53
|\
| * docs: Add/Update state documentationMarkus Pargmann2016-07-083-1/+53
| | | | | | | | | | Signed-off-by: Markus Pargmann <mpa@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/nvdevvars'Sascha Hauer2016-07-111-0/+18
|\ \
| * | Introduce non volatile device variablesSascha Hauer2016-07-061-0/+18
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | Non volatile device variables are used to make device parameters persistent. They are like normal non volatile variables, but set the values of the device parameters with the corresponding name. Every nv variable beginning with nv.dev is a non volatile device variable. They have the form nv.dev.<devname>.<paramname> and act on the parameter <paramname> of the device named <devname>. The non volatile device variables are designated for example for video modes, ethernet device ip addresses or mtd partitioning. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/imx'Sascha Hauer2016-07-112-2/+29
|\ \
| * | ARM i.MX35: Add support for the Amazon Kindle3Alexander Kurz2016-07-111-0/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The Amazon Model No. D00901 Kindle3 is an E-Book reader based on the i.MX35 SOC. The device boots in internal boot mode from a build-in eMMC, alternatively the device may be set into USB-downloader mode when the Vol+ key is pressed on startup. Add support for this device and make barebox a drop-in replacement for the factory shipped u-boot image. Constraints for the use as drop-in replacement: - imximg header (offset 0x400) has a maximum size of 2kB minus 16 byte since the last 16 bytes are used to store a vendor specific hardware desctription identifier - the bootloader space (application plus env) is limited to 256kB minus 16 bytes when installed with offset of 4kB (the u-boot offset was 3kB). A vendor specific device identifier is stored in the gap between application and kernel. The vendor specific identifiers should not be overwritten. Notable features: - Support for eMMC, USB, UART, I2C, SPI and Keys (except keyboard) - Full support for vendor specific ATAGs - usbserial barebox console access by pressing Select button at startup, alternatively full console support on connector J14. Signed-off-by: Alexander Kurz <akurz@blala.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>