summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* | state: Documentation: Fix typoSascha Hauer2018-01-221-2/+2
| | | | | | | | | | | | underlaying -> underlying Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | state: Documentation: fix typoUlrich Ölmann2018-01-221-1/+1
| | | | | | | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> 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-052-3/+45
|\ \
| * | 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: devicetree: m25p80: fix referenced filenameUlrich Ölmann2017-11-281-1/+1
| |/ | | | | | | | | | | | | | | | | Linux changed the filename in commit 8947e396a829 ("Documentation: dt: mtd: replace "nor-jedec" binding with "jedec, spi-nor"") and barebox imported this change in commit 8ed978b79062 ("dts: update to v4.1-rc4"). Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: remove :numbered: from lower level toctreesSascha Hauer2017-12-0112-12/+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>
* | Documentation: change default highlight language to shellSascha Hauer2017-12-011-1/+1
| | | | | | | | | | | | | | | | | | | | There are many places where sphinx complains that blocks cannot be hilghlighted in 'c' and in fact I am not aware of any C code snippets in the documentation, so change the default highlighting style to shell which fits our needs much better. With this we get rid of many warnings while building the documentation. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: socfpga: Fix numbered listSascha Hauer2017-12-011-11/+11
| | | | | | | | | | | | This is no code block, change to numbered list. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: Change many code blocks to no highlightSascha Hauer2017-12-016-27/+47
| | | | | | | | | | | | | | Several blocks cannot be sensibly highlighted, so change the highliting to 'none'. Fixes many warnings in building the documentation. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: arm-qemu-vexpress: Fix too short underlineSascha Hauer2017-12-011-1/+1
|/ | | | | | Fixes sphinx warning about too short underline. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* docs: add qemu vexpressLucas Stach2017-10-171-0/+20
| | | | | | | Add a basic command line for QEMU vexpress. Signed-off-by: Lucas Stach <l.stach@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/state'Sascha Hauer2017-09-084-317/+1207
|\
| * state: use the given backend storage type nameJuergen Borleis2017-09-061-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Change 119f92b27e131a0cb506fe8d8bffe8010fb14a3d already tried to fix it, but forgets the 'direct' usecase. The 'backend-storage-type' node is optional. Its default depends on the capability of the used backend memory, which means "circular" or NULL. The latter defaults to 'direct' in the routines. If it is NULL, the devicetree fixup routine skips exporting a 'backend-storage-type' node to the kernel's devicetree. But currently if the 'backend-storage-type' node is explicitly given as 'direct', it will be skipped silently and set to NULL instead. In this case the user of the 'barebox-state' tool then ends up with the warning: "No backend-storage-type found, using default" which is annoying, because it was given. Storing the given value will still use a NULL if the 'backend-storage-type' node isn't defined, but stores everything else if it is defined. Then the 'backend-storage-type' node is present in the kernel's devicetree as well. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * docs: rework and extend the 'state' and 'bootchooser' documentationJuergen Borleis2017-09-063-317/+1204
| | | | | | | | | | | | | | | | 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>
| * docs: remove build warningJuergen Borleis2017-09-061-0/+1
| | | | | | | | | | | | | | | | | | This change removes: "devicetree/bindings/rtc/dallas,ds1307.rst: WARNING: document isn't included in any toctree" warning Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/misc'Sascha Hauer2017-09-081-1/+6
|\ \
| * | docs/DS1307: fix layoutJuergen Borleis2017-09-061-1/+6
| |/ | | | | | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | efi: add iBASE MI991AF documentation.Oleksij Rempel2017-09-082-0/+45
| | | | | | | | | | Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: efi: add example how to create EFI partitionOleksij Rempel2017-09-081-0/+25
|/ | | | | Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/socfpga'Lucas Stach2017-07-311-4/+11
|\
| * Documentation: socfpga: update sequencer documentationSteffen Trumtrar2017-07-111-4/+11
| | | | | | | | | | | | Update the documentation in regard of the sequencer importer. Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de>
* | efi: efi: load state from devicetreeSteffen Trumtrar2017-07-111-0/+4
| | | | | | | | | | Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de> Signed-off-by: Lucas Stach <l.stach@pengutronix.de>
* | of: of_path: find device via partuuidSteffen Trumtrar2017-07-101-0/+21
|/ | | | | | | | When a node is compatible to a fixed-partitions, support searching the corresponding device via the partuuid, if it specified in the device tree. Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de> Signed-off-by: Lucas Stach <l.stach@pengutronix.de>
* 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-20 00:44:27 +0000