summaryrefslogtreecommitdiffstats
path: root/Documentation/user
Commit message (Collapse)AuthorAgeFilesLines
* bbu: Allow to refresh/repair imagesSascha Hauer2016-04-081-0/+8
| | | | | | | | | | Some SoCs allow to store multiple boot images on a device in order to improve robustness. This adds a -r option to barebox_update to indicate we do not want to make an update but instead repair/refresh an existing image. Handlers which want to support this feature must set the BBU_HANDLER_CAN_REFRESH flag during registration. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/misc'Sascha Hauer2016-03-111-2/+51
|\
| * Documentation: fastboot: fastboot erase is implementedSascha Hauer2016-02-231-3/+0
| | | | | | | | | | | | | | fastboot erase was implemented from the start, remove note stating that it's not implemented. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: Update USB fastboot sectionMarkus Pargmann2016-02-231-0/+52
| | | | | | | | | | | | | | | | Add some documentation about fastboot 'flash' command and some useful example how to use it to boot an initrd. Signed-off-by: Markus Pargmann <mpa@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/doc'Sascha Hauer2016-03-114-23/+36
|\ \
| * | Documentation: networking: improve docsRobert Schwebel2016-02-111-17/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add the following improvements: - clarify commands vs. filesystems for network file transport protocols - Beautify links with prosa text instead of standard headlines - adapt 'devinfo eth0' parameter output to current code - improve console texts - add docs for netconsole.active Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: user manual: improve tftp descriptionRobert Schwebel2016-02-111-1/+3
| | | | | | | | | | | | | | | Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: user manual: clarify kconfig+kbuildRobert Schwebel2016-02-111-3/+3
| | | | | | | | | | | | | | | Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: user manual: include documentation for remote-controlRobert Schwebel2016-02-101-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | This documentation snippet was already added to the tree, but not included anywhere. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: booting linux: improve wordingRobert Schwebel2016-02-101-2/+2
| |/ | | | | | | | | | | | | | | 'bootm' is the lowlevel boot command, in contrast to 'boot', which is more highlevel. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / Documentation: usb: fix otg mode parameter descriptionPhilipp Zabel2016-02-171-1/+1
|/ | | | | | | Replace ``device`` otg.mode option with the correct ``peripheral``. Signed-off-by: Philipp Zabel <philipp.zabel@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/ratp'Sascha Hauer2016-02-081-0/+134
|\
| * barebox remote control: DocumentationSascha Hauer2016-01-181-0/+134
| | | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | nfs: forward filesystem options to the kernel command lineJuergen Borleis2016-02-081-1/+1
|/ | | | | | | | | | | | | | | | | | | | | | | | | | Using NFS in conjunction with boot spec and the feature to let Barebox auto generate a kernel command line must keep the options the NFS filesystem was mounted in Barebox. This patch extends the kernel command line parameter on demand if something different than the defaults are used. The command: barebox:/ boot nfs://myhost//root expands to the kernel command line: nfsroot=myhost:/root,v3,tcp while the command: barebox:/ boot nfs://myhost:2049//root expands now to the kernel command line: nfsroot=myhost:/root,v3,tcp,mountport=2049,port=2049 Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* video: implement framebuffer consoleAntony Pavlov2015-07-201-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | This patch realizes framebuffer console support for barebox. It supports colors and enough escape sequences to show the barebox console and editor properly. fbconsole mini-HOWTO ==================== 1. compile sandbox barebox with CONFIG_VIDEO=y CONFIG_FRAMEBUFFER_CONSOLE=y CONFIG_DRIVER_VIDEO_SDL=y 2. run barebox 3. test fbconsole fbconsole0.active=oe Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/blspec'Sascha Hauer2015-07-061-0/+7
|\
| * blspec: Automatically append rootargSascha Hauer2015-06-181-0/+7
| | | | | | | | | | | | | | | | | | | | | | This patch makes it possible to automatically add a suitable root= option for booting Linux from the same filesystem on which the bootspec entry has been found. This adds an additional 'linux-appendroot' option to bootspec which if set to 'true' will cause barebox to automatically add a root= option. This currently works for NFS, UBIFS and regular block devices like ATA, SD/MMC using the root=PARTUUID= mechanism. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/mtd'Sascha Hauer2015-07-031-29/+15
|\ \ | | | | | | | | | | | | Conflicts: drivers/mtd/core.c
| * | ubi: Update documentationSascha Hauer2015-06-261-29/+15
| |/ | | | | | | | | | | | | The previous patches changed the UBI naming and made automounting UBIFS easier. Update the documentation accordingly. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: be more precise about the topicJuergen Borleis2015-06-221-4/+4
| | | | | | | | | | | | | | 'system restart' is the correct topic here. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: fix spellingJuergen Borleis2015-06-221-1/+1
| | | | | | | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: add some info about the reset variantsJuergen Borleis2015-06-172-0/+65
| | | | | | | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: add some info about the reset reason frameworkJuergen Borleis2015-06-172-0/+48
|/ | | | | Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: fix typoJuergen Borleis2015-06-161-1/+1
| | | | | | | This change enables Sphinx to resolve the reference. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/misc'Sascha Hauer2015-06-091-6/+7
|\
| * Documentation: booting linux: improve doc textRobert Schwebel2015-05-151-6/+7
| | | | | | | | | | Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: blspec: Document blspec over NFSSascha Hauer2015-05-261-0/+7
| | | | | | | | | | | | | | We support booting blspec entries found on NFS servers, add documentation for it. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: blspec: Fix typoSascha Hauer2015-05-261-1/+1
|/ | | | | | The device index is missing in the example, add it. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* docs: correct link to microcom repoLucas Stach2015-03-261-1/+1
| | | | | | | | It's not nice to land on a 404 page and having to search for the right location manually. Signed-off-by: Lucas Stach <dev@lynxeye.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: booting-linux: Fix wrong variable nameSascha Hauer2015-03-181-1/+1
| | | | | | | All variables starting with global.linux.bootargs. are concatemated to bootargs, not global.bootargs. . Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Fix spelling: pathes -> pathsWadim Egorov2015-01-282-3/+3
| | | | | Signed-off-by: Wadim Egorov <w.egorov@phytec.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* docs: fix broken referenceLucas Stach2015-01-191-2/+2
| | | | | Signed-off-by: Lucas Stach <dev@lynxeye.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* netconsole: fix DocumentationJean-Christophe PLAGNIOL-VILLARD2014-12-171-3/+3
| | | | | | | | | | | since commit 8eacfa71abcba857ab9aa1dcad49e2ba7d83406b Refs: v2014.07.0-156-g8eacfa7 Author: Sascha Hauer <s.hauer@pengutronix.de> the netconsole device have a static device name 'netconsole' Signed-off-by: Jean-Christophe PLAGNIOL-VILLARD <plagnioj@jcrosoft.com>
* doc: usb: add missing new line in codeblockLucas Stach2014-12-091-0/+1
| | | | | | | | Fixes an error during doc generation that leads to the code block being missing in the resulting docs. Signed-off-by: Lucas Stach <l.stach@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Add support for non volatile variablesSascha Hauer2014-11-061-0/+41
| | | | | | | | | | | | | | | This adds (back) support for non volatile variables. Non volatile variables are variables which are stored in the environment over reboot. They are used in the same way as the global variables, but with a 'nv' command and device. The variables are stored under /env/nv/, one variable per file. Adding a nv variable automatically adds a global variable with the same name. Changing a nv variable also changes the same global variable, but not the other way round. This allows for example to configure the username as: nv user=sha; saveenv Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/musb'Sascha Hauer2014-10-021-0/+21
|\
| * Documentation: USB: Add description for OTG deviceSascha Hauer2014-09-261-0/+21
| | | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Documentation: Add some TI AM335x specific documentationSascha Hauer2014-09-301-0/+2
|/ | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/usb-gadget'Sascha Hauer2014-08-071-0/+55
|\ | | | | | | | | | | | | | | Conflicts: commands/Makefile common/Kconfig common/Makefile drivers/usb/gadget/dfu.c
| * Documentation: Add documentation for Fastboot and Composite Multifunction GadgetSascha Hauer2014-07-241-0/+48
| | | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * Documentation: Add documentation for USB serial consoleSascha Hauer2014-07-241-0/+7
| | | | | | | | Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Add support for metadata in barebox imagesSascha Hauer2014-08-073-0/+58
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It's often useful to get some information about a barebox image before starting or flashing it. This patch introduces barebox Image MetaData (IMD). When enabled a barebox image will contain a list of tags containing the desired information. We have tags for: - the barebox release (2014.07.0-00160-g035de50-dirty) - the build timestamp (#741 Mon Jul 28 15:08:54 CEST 2014) - the board model the image is intended for - the device tree toplevel compatible property Also there is an additional generic key-value store which stores parameters for which no dedicated tag exists. In this patch it is used for the memory size an image supports. Since there is no fixed offset in a barebox image which can be used for storing the information, the metadata is stored somewhere in the image and found by iterating over the image. This works for most image types, but obviously not for SoC images which are encoded or encrypted in some way. There is a 'imd' tool compiled from the same sources for barebox, for the compile host and for the target, so the metadata information is available whereever needed. For device tree boards the model and of_compatible tags are automatically generated. Example output of the imd tool for a Phytec phyFLEX image: build: #889 Wed Jul 30 16:08:54 CEST 2014 release: 2014.07.0-00167-g6b2070d-dirty parameter: memsize=1024 of_compatible: phytec,imx6x-pbab01 phytec,imx6dl-pfla02 fsl,imx6dl model: Phytec phyFLEX-i.MX6 Duallite Carrier-Board Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* crc32: Proper name of command is "crc32".Robert P. J. Day2014-07-081-1/+1
| | | | | Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: usb chapter of user manualRobert P. J. Day2014-07-041-16/+41
| | | | | | | | A number of minor fixes, and including the help output from the "dfu-util" command for the benefit of the reader. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Various tweaks to user manual, device tree chapter.Robert P. J. Day2014-07-041-14/+15
| | | | | | | Grammar, typoes, font, link fixes. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: defaultenv chapter from user manual.Robert P. J. Day2014-07-041-17/+37
| | | | | | | | A number of grammar fixes, typoes, font changes from the defaultenv-2 chapter. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Numerous typoes/fixes in first few chapters of user manual.Robert P. J. Day2014-07-037-22/+24
| | | | | | | | | | | | Doc fixes such as: * font changes * spelling * punctuation * capitalization Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: User manual, "barebox" sectionRobert P. J. Day2014-07-021-22/+66
| | | | | | | | | Various grammar/font fixes to that section, including adding an additional section describing how to properly do "out of tree" configuration and building. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: link back from variables to device parametersHolger Schurig2014-06-272-2/+7
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: move variables near device parametersHolger Schurig2014-06-271-1/+1
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>