diff options
author | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-17 10:37:25 +0200 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-26 11:07:10 +0200 |
commit | 3fef396bb42efc0bb12b0a8caf0d076ab1c4d879 (patch) | |
tree | 91625b2407ed25dffd093b19159135481eb80f84 /Documentation/user/system-setup.rst | |
parent | 7e65163b9165bccca780da91fad247c0e4ac7f9f (diff) | |
download | barebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.gz barebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.xz |
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>
Diffstat (limited to 'Documentation/user/system-setup.rst')
-rw-r--r-- | Documentation/user/system-setup.rst | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/Documentation/user/system-setup.rst b/Documentation/user/system-setup.rst new file mode 100644 index 0000000000..35d61475f3 --- /dev/null +++ b/Documentation/user/system-setup.rst @@ -0,0 +1,64 @@ +System Setup +============ + +Serial Console Access +--------------------- + +As most current development machines don't have serial ports, the usual setup +is to use a USB-Serial-Converter. Some evaluation boards have such a converter +on board. After connecting, these usually show up on your host as +``/dev/ttyUSB#`` or ``/dev/ttyACM#`` (check ``dmesg`` to find out). + +On Debian systems, the device node will be accessible to the ``dialout`` group, +so adding your user to that group (``adduser <user> dialout``) removes the need +for root privileges. + +Using the "screen" program +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The terminal manager ``screen`` can also be used as a simple terminal emulator:: + + screen /dev/ttyUSB0 115200 + +To exit from ``screen``, press ``<CTRL-A> <K> <y>``. + +Using the "microcom" program +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A good alternative terminal program is microcom. On Debian it can be installed +with ``apt-get install microcom``, on other distributions it can be installed +from source: + +http://git.pengutronix.de/?p=tools/microcom;a=summary + +Usage is simple:: + + microcom -p /dev/ttyUSB0 + +Network Access +-------------- + +Having network connectivity between your host and your target will save you a +lot of time otherwise spent on writing SD cards or using JTAG. The main +protocols used with barebox are DHCP, TFTP and NFS. + +Configuration of dnsmasq for DHCP and TFTP +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The ``dnsmasq`` program can be configured as a DHCP and TFTP server in addition +to its original DNS functionality:: + + sudo ip addr add 192.168.23.1/24 dev <interface> + sudo ip link set <interface> up + sudo /usr/sbin/dnsmasq --interface=<interface> --no-daemon --log-queries \ + --enable-tftp --tftp-root=<absolute-path-to-your-images>/ \ + --dhcp-range=192.168.23.240,192.168.23.250 + +Configuration of a TFTP Server +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Configuration of a BOOTP / DHCP Server +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Configuring a NFS Server +^^^^^^^^^^^^^^^^^^^^^^^^ |