summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2016-03-11 10:49:43 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2016-03-11 10:49:43 +0100
commitd69ea86d795aea0ad833f271f0690e5e02b8bbb6 (patch)
treeb7ce0a49e0bda76e3267db28c5f33cf1478aabe2 /Documentation
parent09c1f8244d4106cdb4d970a0a89928307230d8fb (diff)
parent1a0cebc5722675b72080958a90f163767876da92 (diff)
downloadbarebox-d69ea86d795aea0ad833f271f0690e5e02b8bbb6.tar.gz
barebox-d69ea86d795aea0ad833f271f0690e5e02b8bbb6.tar.xz
Merge branch 'for-next/doc'
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/devicetree/index.rst1
-rw-r--r--Documentation/filesystems/fat.rst9
-rw-r--r--Documentation/filesystems/nfs.rst4
-rw-r--r--Documentation/filesystems/pstore.rst3
-rw-r--r--Documentation/filesystems/ramfs.rst2
-rw-r--r--Documentation/filesystems/smhfs.rst2
-rw-r--r--Documentation/filesystems/tftp.rst16
-rw-r--r--Documentation/user/barebox.rst10
-rw-r--r--Documentation/user/booting-linux.rst4
-rw-r--r--Documentation/user/networking.rst44
-rw-r--r--Documentation/user/user-manual.rst1
11 files changed, 57 insertions, 39 deletions
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
index abb9088e91..c5992c0fc9 100644
--- a/Documentation/devicetree/index.rst
+++ b/Documentation/devicetree/index.rst
@@ -11,3 +11,4 @@ Contents:
bindings/barebox/*
bindings/leds/*
bindings/misc/*
+ bindings/mtd/*
diff --git a/Documentation/filesystems/fat.rst b/Documentation/filesystems/fat.rst
index 2138328d18..e39e34a0e9 100644
--- a/Documentation/filesystems/fat.rst
+++ b/Documentation/filesystems/fat.rst
@@ -7,9 +7,8 @@ barebox supports FAT filesystems in both read and write modes with optional
support for long filenames. A FAT filesystem can be mounted using the
:ref:`command_mount` command::
- mkdir /mnt
- mount /dev/disk0.0 fat /mnt
- ls /mnt
+ barebox:/ mkdir /mnt
+ barebox:/ mount /dev/disk0.0 fat /mnt
+ barebox:/ ls /mnt
zImage barebox.bin
- umount /mnt
-
+ barebox:/ umount /mnt
diff --git a/Documentation/filesystems/nfs.rst b/Documentation/filesystems/nfs.rst
index 4469ac1dff..ab51241549 100644
--- a/Documentation/filesystems/nfs.rst
+++ b/Documentation/filesystems/nfs.rst
@@ -9,7 +9,7 @@ barebox has readonly support for NFSv3 in UDP mode.
Example::
- mount -t nfs 192.168.23.4:/home/user/nfsroot /mnt/nfs
+ barebox:/ mount -t nfs 192.168.23.4:/home/user/nfsroot /mnt/nfs
The barebox NFS driver adds a ``linux.bootargs`` device parameter to the NFS device.
This parameter holds a Linux kernel commandline snippet containing a suitable root=
@@ -17,7 +17,7 @@ option for booting from exactly that NFS share.
Example::
- devinfo nfs0
+ barebox:/ devinfo nfs0
...
linux.bootargs: root=/dev/nfs nfsroot=192.168.23.4:/home/sha/nfsroot/generic-v7,v3,tcp
diff --git a/Documentation/filesystems/pstore.rst b/Documentation/filesystems/pstore.rst
index 74acd87ca0..0f3a2239e3 100644
--- a/Documentation/filesystems/pstore.rst
+++ b/Documentation/filesystems/pstore.rst
@@ -12,6 +12,7 @@ messages are stored by the kernel in a specified RAM area which is never
overwritten by any user. This data can be accessed after a reboot through
/pstore in Barebox or the kernel. The pstore filesystem is automatically mounted
at boot::
+
none on / type ramfs
none on /dev type devfs
none on /pstore type pstore
@@ -40,7 +41,7 @@ and RAM backend support. The kernel receives the parameters describing the
layout over the kernel command line. These parameters are automatically
generated by Barebox. You can change these parameters in Barebox menuconfig. The
RAMOOPS parameters for the Kernel are stored in the variable
-global.linux.bootargs.ramoops::
+global.linux.bootargs.ramoops.
To see where the RAMOOPS area is located, you can execute iomem in Barebox. The
RAMOOPS area is listed as 'persistent ram'::
diff --git a/Documentation/filesystems/ramfs.rst b/Documentation/filesystems/ramfs.rst
index b7ece1a9d8..d27f88561f 100644
--- a/Documentation/filesystems/ramfs.rst
+++ b/Documentation/filesystems/ramfs.rst
@@ -9,4 +9,4 @@ is ``ramfs``.
Example::
- mount none ramfs /somedir
+ barebox:/ mount none ramfs /somedir
diff --git a/Documentation/filesystems/smhfs.rst b/Documentation/filesystems/smhfs.rst
index 28de14677d..9e9993cb28 100644
--- a/Documentation/filesystems/smhfs.rst
+++ b/Documentation/filesystems/smhfs.rst
@@ -20,7 +20,7 @@ directory. Nevertheless, the files are there.
Example::
- mount -t smhfs /dev/null /mnt/smhfs
+ barebox:/ mount -t smhfs /dev/null /mnt/smhfs
Host Side Setup
diff --git a/Documentation/filesystems/tftp.rst b/Documentation/filesystems/tftp.rst
index e0a1159264..eeb3fcb688 100644
--- a/Documentation/filesystems/tftp.rst
+++ b/Documentation/filesystems/tftp.rst
@@ -2,15 +2,19 @@
.. _filesystems_tftp:
-TFTP support
-============
+TFTP filesystem
+===============
-barebox has read/write support for the Trivial File Transfer Protocol.
+barebox has read/write support for the Trivial File Transfer Protocol (TFTP,
+`RFC1350 <https://tools.ietf.org/html/rfc1350>`_).
TFTP is not designed as a filesystem. It does not have support for listing
-directories. This means a :ref:`command_ls` to a TFTP-mounted path will show an empty
-directory. Nevertheless, the files are there.
+directories. This means a :ref:`ls <command_ls>` to a TFTP-mounted path will
+show an empty directory. Nevertheless, the files are there.
Example::
- mount -t tftp 192.168.23.4 /mnt/tftp
+ barebox:/ mount -t tftp 192.168.23.4 /mnt/tftp
+
+In addition to the TFTP filesystem implementation, barebox does also have a
+:ref:`tftp command <command_tftp>`.
diff --git a/Documentation/user/barebox.rst b/Documentation/user/barebox.rst
index 00ceabb925..530693d743 100644
--- a/Documentation/user/barebox.rst
+++ b/Documentation/user/barebox.rst
@@ -113,9 +113,9 @@ with the most popular being ``menuconfig``::
make menuconfig
-barebox uses the same (Kbuild) configuration system as Linux, so you can use
-all the kernel config targets you already know, e.g. ``make xconfig``,
-``make allyesconfig`` etc.
+barebox uses the same configuration and build system as Linux (Kconfig,
+Kbuild), so you can use all the kernel config targets you already know, e.g.
+``make xconfig``, ``make allyesconfig`` etc.
Configuring and compiling "out-of-tree"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -186,7 +186,9 @@ with U-Boot's 'go' command::
U-Boot: tftp $load_addr barebox.bin
U-Boot: go $load_addr
-With barebox already running on your board, this can be used to chainload another barebox::
+With barebox already running on your board, this can be used to chainload
+another barebox. For instance, if you mounted a TFTP server to ``/mnt/tftp``
+(see :ref:`filesystems_tftp` for how to do that), chainload barebox with::
bootm /mnt/tftp/barebox.bin
diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst
index 5b021f0662..98628faf9d 100644
--- a/Documentation/user/booting-linux.rst
+++ b/Documentation/user/booting-linux.rst
@@ -6,7 +6,7 @@ Booting Linux
Introduction
------------
-The basic boot command in barebox is :ref:`command_bootm`. This command
+The lowlevel boot command in barebox is :ref:`command_bootm`. This command
can be used directly, but there is also a :ref:`command_boot` command
which offers additional features like a boot sequence which tries to
boot different entries until one succeeds.
@@ -14,7 +14,7 @@ boot different entries until one succeeds.
The bootm command
-----------------
-The :ref:`command_bootm` command is the basic boot command. Depending on the
+The :ref:`command_bootm` command is the lowlevel boot command. Depending on the
architecture the bootm command handles different image types. On ARM the
following images are supported:
diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
index 6eeb93dd88..8afb433837 100644
--- a/Documentation/user/networking.rst
+++ b/Documentation/user/networking.rst
@@ -1,26 +1,25 @@
Networking
==========
-barebox has IPv4 networking support. Several protocols such as
-:ref:`command_dhcp`, :ref:`filesystems_nfs`, :ref:`command_tftp` are
-supported.
+barebox has IPv4 networking support. Several protocols such as :ref:`DHCP
+<command_dhcp>`, NFS and TFTP are supported.
Network configuration
---------------------
The first step for networking is configuring the network device. The network
device is usually ``eth0``. The current configuration can be viewed with the
-:ref:`command_devinfo` command:
+:ref:`devinfo <command_devinfo>` command:
.. code-block:: sh
barebox:/ devinfo eth0
Parameters:
- ipaddr: 192.168.23.197
- serverip: 192.168.23.1
+ ethaddr: 00:1c:49:01:03:4b
gateway: 192.168.23.1
+ ipaddr: 192.168.23.197
netmask: 255.255.0.0
- ethaddr: 00:1c:49:01:03:4b
+ serverip: 192.168.23.1
The configuration can be changed on the command line with:
@@ -28,19 +27,21 @@ The configuration can be changed on the command line with:
eth0.ipaddr=172.0.0.10
-The :ref:`command_dhcp` command will change the settings based on the answer
+The :ref:`dhcp command <command_dhcp>` will change the settings based on the answer
from the DHCP server.
This low-level configuration of the network interface is often not necessary. Normally
the network settings should be edited in ``/env/network/eth0``, then the network interface
-can be brought up using the :ref:`command_ifup` command.
+can be brought up using the :ref:`ifup command <command_ifup>`.
Network filesystems
-------------------
-barebox supports NFS and TFTP as filesystem implementations. See :ref:`filesystems_nfs`
-and :ref:`filesystems_tftp` for more information. After the network device has been
-brought up a network filesystem can be mounted with:
+barebox supports NFS and TFTP both with commands (:ref:`nfs <command_nfs>` and
+:ref:`tftp <command_tftp>`) and as filesystem implementations; see
+:ref:`filesystems_nfs` and :ref:`filesystems_tftp` for more information. After
+the network device has been brought up, a network filesystem can be mounted
+with:
.. code-block:: sh
@@ -52,8 +53,9 @@ or
mount -t nfs 192.168.2.1:/export none /mnt
-**NOTE:** this can often be hidden behind the :ref:`command_automount` command to make
-mounting transparent to the user.
+**NOTE:** The execution of the mount command can often be hidden behind the
+:ref:`automount command <command_automount>`, to make mounting transparent to
+the user.
Network console
---------------
@@ -71,11 +73,19 @@ risks. It can be enabled using:
netconsole.ip=192.168.23.2
netconsole.active=ioe
-This will send UDP packets to 192.168.23.2 on port 6666. On 192.168.23.2 the
-scripts/netconsole script can be used to control barebox:
+This will send UDP packets to a PC with IP address 192.168.23.2 and port 6666.
+
+The ``netconsole.active`` parameter consists of the fields "input" (i),
+"output" (o) and "error" (e); if the fields are set, the respective channel is
+activated on the network console.
+
+On the PC side, the ``scripts/netconsole`` script can be used to remote control
+barebox:
.. code-block:: sh
scripts/netconsole <board IP> 6666
-The netconsole can be used just like any other console.
+The netconsole can be used just like any other console. Note, however, that the
+simple console protocol is UDP based, so there is no guarantee about packet
+loss.
diff --git a/Documentation/user/user-manual.rst b/Documentation/user/user-manual.rst
index 0d6daee70e..be44f0d645 100644
--- a/Documentation/user/user-manual.rst
+++ b/Documentation/user/user-manual.rst
@@ -27,6 +27,7 @@ Contents:
usb
ubi
booting-linux
+ remote-control
system-setup
reset-reason
system-reset