9
0
Fork 0
Commit Graph

30 Commits

Author SHA1 Message Date
Lucas Stach 6dc8ef5007 docs: correct link to microcom repo
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>
2015-03-26 08:00:13 +01:00
Sascha Hauer ccee789e67 Documentation: booting-linux: Fix wrong variable name
All variables starting with global.linux.bootargs. are concatemated
to bootargs, not global.bootargs. .

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2015-03-18 09:51:18 +01:00
Wadim Egorov f0f6a7477b Fix spelling: pathes -> paths
Signed-off-by: Wadim Egorov <w.egorov@phytec.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2015-01-28 10:02:56 +01:00
Lucas Stach 68f772e10c docs: fix broken reference
Signed-off-by: Lucas Stach <dev@lynxeye.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2015-01-19 08:46:04 +01:00
Jean-Christophe PLAGNIOL-VILLARD f648eb9e65 netconsole: fix Documentation
since
commit 8eacfa71ab
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>
2014-12-17 15:11:59 +01:00
Lucas Stach e88a7c36ed doc: usb: add missing new line in codeblock
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>
2014-12-09 10:00:05 +01:00
Sascha Hauer 3249006a2f Add support for non volatile variables
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>
2014-11-06 10:58:54 +01:00
Sascha Hauer a65334019b Merge branch 'for-next/musb' 2014-10-02 08:54:42 +02:00
Sascha Hauer 3d8cf91b89 Documentation: Add some TI AM335x specific documentation
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-09-30 15:07:26 +02:00
Sascha Hauer f59f20b953 Documentation: USB: Add description for OTG device
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-09-26 21:36:58 +02:00
Sascha Hauer 7782c08047 Merge branch 'for-next/usb-gadget'
Conflicts:
	commands/Makefile
	common/Kconfig
	common/Makefile
	drivers/usb/gadget/dfu.c
2014-08-07 20:34:28 +02:00
Sascha Hauer 97e81f2d78 Add support for metadata in barebox images
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>
2014-08-07 06:13:52 +02:00
Sascha Hauer 46ff98b011 Documentation: Add documentation for Fastboot and Composite Multifunction Gadget
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-07-24 08:32:57 +02:00
Sascha Hauer 530731353d Documentation: Add documentation for USB serial console
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-07-24 08:32:57 +02:00
Robert P. J. Day 37f47a2a8c crc32: Proper name of command is "crc32".
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-07-08 07:45:45 +02:00
Robert P. J. Day b7d2e23fe2 Documentation: usb chapter of user manual
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>
2014-07-04 07:33:28 +02:00
Robert P. J. Day 1df8c9efbf Documentation: Various tweaks to user manual, device tree chapter.
Grammar, typoes, font, link fixes.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-07-04 07:32:21 +02:00
Robert P. J. Day 4d62410b74 Documentation: defaultenv chapter from user manual.
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>
2014-07-04 07:30:37 +02:00
Robert P. J. Day aac1b35c88 Documentation: Numerous typoes/fixes in first few chapters of user manual.
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>
2014-07-03 08:32:29 +02:00
Robert P. J. Day 009e5365d0 Documentation: User manual, "barebox" section
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>
2014-07-02 07:50:50 +02:00
Holger Schurig 3332609187 doc: link back from variables to device parameters
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-06-27 21:46:59 +02:00
Holger Schurig 5a18d484f2 doc: move variables near device parameters
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-06-27 21:46:59 +02:00
Holger Schurig 4845d8e354 doc: remove board type from barebox prompt examples
I kept however the one example that directly demos the bootup on an
Efika board.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-06-27 21:46:58 +02:00
Holger Schurig 0b293a5397 doc: add hint on how to calculate in hush
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-06-27 21:46:58 +02:00
Holger Schurig d4efb42f80 doc: add colon after NOTE and HINT
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-06-27 21:45:34 +02:00
Holger Schurig ce9d79cc4f doc: mention "make xconfig"
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-06-27 21:45:34 +02:00
Holger Schurig 22c0ee7fe3 doc: only include own download chapter
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>
2014-06-27 21:45:34 +02:00
Holger Schurig cbd9947fe0 doc: start (almost) all headlines with a capital
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-06-27 21:45:34 +02:00
Holger Schurig 70e49ff162 doc: make "System setup" an appendix
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>
2014-06-27 21:45:34 +02:00
Sascha Hauer 3fef396bb4 Documentation: Add new sphinxs docs
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>
2014-06-26 11:07:10 +02:00