summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* | Merge branch 'for-next/misc'Sascha Hauer2014-08-071-0/+2
|\ \ | | | | | | | | | | | | Conflicts: lib/Makefile
| * | led: try to get LED's label from the 'label' propertyAntony Pavlov2014-07-291-0/+2
| |/ | | | | | | | | Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/metadata'Sascha Hauer2014-08-073-0/+58
|\ \ | | | | | | | | | | | | | | | | | | Conflicts: arch/arm/dts/Makefile common/Makefile lib/Makefile
| * | 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>
* | Merge branch 'for-next/efi'Sascha Hauer2014-08-072-0/+301
|\ \ | | | | | | | | | | | | | | | | | | Conflicts: .gitignore Makefile drivers/serial/Makefile
| * | Documentation: Add EFI documentationSascha Hauer2014-07-162-0/+301
| |/ | | | | | | | | | | This adds documentation for the upcoming barebox on EFI support. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | Merge branch 'for-next/doc'Sascha Hauer2014-08-073-5/+161
|\ \ | | | | | | | | | | | | Conflicts: Makefile
| * | trivial: Correct word spelling, s/miscelleanous/miscellaneousEzequiel Garcia2014-08-041-1/+1
| | | | | | | | | | | | | | | Signed-off-by: Ezequiel Garcia <ezequiel.garcia@free-electrons.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: change generated help linesHolger Schurig2014-07-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Someone loadx (load binary file over serial line (X-Modem)) looked more silly than loadx - load binary file over serial line (X-Modem) Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: only write changed *.rst filesHolger Schurig2014-07-221-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Documentation/gen_commands.py use to re-write all auto-generated *.rst file, changed or not. That in turn didn't work well with the internal cache of the Sphinx documentation generator. By comparing the SHA1 hash of the newly generated *.rst with the current sha1 file, the time to execute "make docs" can be reduced from 6.2s to 2.4s on my humble laptop. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: use command groupsJan Luebbe2014-07-142-4/+95
| | | | | | | | | | | | | | | | | | | | | | | | The help definition already contained a group declaration. This is now reused for the HTML documentation. Signed-off-by: Jan Luebbe <jlu@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| * | Documentation: add virt2real barebox mini-howtoAntony Pavlov2014-07-141-0/+51
| |/ | | | | | | | | Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* / Documentation: add QEMU Canon A1100 barebox mini-howtoAntony Pavlov2014-08-011-0/+16
|/ | | | | Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: add uemd mb7707 barebox mini-howtoAntony Pavlov2014-07-091-0/+40
| | | | | Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> 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>
* Documentation: Fix glossary entry, "FTD" -> "FDT"Robert P. J. Day2014-07-021-1/+1
| | | | | Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: device tree bindings.Robert P. J. Day2014-07-024-20/+22
| | | | | | | Adjusted Sphinx markup for devicetree bindings pages. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Minor editing changes to filesystems content.Robert P. J. Day2014-07-023-7/+7
| | | | | Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Clean up sandbox.rst, use definition list.Robert P. J. Day2014-07-021-39/+27
| | | | | | | | Some minor cleanup to the sandbox.rst documentation file, mostly involving using a definition list for the options. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation/boards/: Numerous grammar/typo/rendering fixes.Robert P. J. Day2014-07-0210-47/+78
| | | | | | | | | | | | | | | Various fixes related to fonts, rendering, grammar, etc., such as: * spelling mistakes * hyphenation * capitalization for proper names * proper bullet list formatting * sentence structure and so on. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: add mips boards filesAntony Pavlov2014-07-026-0/+257
| | | | | Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> 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>
* doc: reformat overly long linesHolger Schurig2014-06-275-13/+37
| | | | | | | Lines over 120 are just too long :-) Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: remove board type from barebox prompt examplesHolger Schurig2014-06-274-8/+8
| | | | | | | I kept however the one example that directly demos the bootup on an Efika board. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: add hint on how to calculate in hushHolger Schurig2014-06-271-0/+8
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: add colon after NOTE and HINTHolger Schurig2014-06-2713-17/+17
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: mention "make xconfig"Holger Schurig2014-06-271-0/+3
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: filesystemtype -> filesystem typeHolger Schurig2014-06-271-1/+1
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: only include own download chapterHolger Schurig2014-06-273-18/+6
| | | | | | | Also make this download chapter note the next branch. Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: start (almost) all headlines with a capitalHolger Schurig2014-06-2710-14/+14
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: make "System setup" an appendixHolger Schurig2014-06-272-3/+3
| | | | | | | | Note that I used "Appendix: " as text, because it looks like python-sphinx doesn't know about appendices. Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Add new sphinxs docsSascha Hauer2014-06-2661-0/+2935
| | | | | | | | | | This is a rewrite of the Documentation in reStructuredText format using Sphinx as build system, see http://sphinx-doc.org/. The documentation is built into static html pages with 'make docs'. The pages can be found under Documentation/html after building. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: remove devicetree docsSascha Hauer2014-06-266-89/+0
| | | | | | | Remove the barebox devicetree documentation. It will be replaced with sphinx based documentation later. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: remove remaining documentationSascha Hauer2014-06-265-240/+0
| | | | | | | This removes the documentation texts in Documentation/. It will be replaced with sphinx based documentation later. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: remove doxygen documentationSascha Hauer2014-06-269-595/+0
| | | | | | | The doxygen documentation is long outdated. Remove it. It will be replaced with sphinx based documentation later. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Update binding doc for i.MX IIMAlexander Shiyan2014-04-081-2/+2
| | | | | Signed-off-by: Alexander Shiyan <shc_work@mail.ru> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Merge branch 'for-next/davinci'Sascha Hauer2014-04-041-0/+1
|\
| * ARM: virt2real: add documentationAntony Pavlov2014-03-191-0/+1
| | | | | | | | | | Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | MIPS: tplink-mr3020: add documentationAntony Pavlov2014-03-281-0/+1
| | | | | | | | | | Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* | MIPS: boards: rename rzx50 -> ritmix-rzx50Antony Pavlov2014-03-261-1/+1
|/ | | | | | | | All MIPS board use <vendor>-<model> name template save Ritmix RZX-50. This commit fixes this inconsistency. Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: fix example call to devfs_add_partitionUwe Kleine-König2014-02-281-1/+1
| | | | | | | | The flags parameter was skipped in the example. Add it as DEVFS_PARTITION_FIXED. Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>