Commit bf2ee0ec authored by David Boddie's avatar David Boddie

Split the How To page

Leave room for more guides without putting them all on the same page.
parent c6010ee1
......@@ -3,66 +3,11 @@
How To Guides
=============
This page contains short guides to help with common use cases and describe
This section contains short guides to help with common use cases and describe
how to perform routine tasks.
SSH Access and X11 Forwarding
-----------------------------
.. toctree::
:maxdepth: 2
Once you have networking set up for the development board, you should be able
to log in using ``ssh`` once the OpenSSH daemon has started. This may take
some time due to a lack of entropy (see `linux-emcraft issue 2`_ for details).
Log in to the board using one of the network connections (Wi-Fi or Ethernet).
Install the ``xauth`` package to enable X11 forwarding and check that the
``/etc/ssh/sshd_config`` file contains the following line::
X11Forwarding yes
Log out and log in again using ``ssh -X`` and check that the environment has
the ``DISPLAY`` variable set.
To run a GNOME application, like `gnome-chess`, on the board while displaying
the output on a workstation running an X server, set the ``GDK_BACKEND``
environment variable [#]_ when running the executable, like this::
GDK_BACKEND=x11 gnome-chess
The application should appear on the workstation's screen.
.. [#] Described in the `Running GTK+ Applications`_ GNOME developer document.
USB Access
----------
In the default configuration, as shipped, USB in is peripheral mode and a
"wall wart" AC adaptor can be used for power. In this mode, it is also
possible to connect the development board to a workstation's USB **3.0+** port
(where VBUS can supply up to 900mA) and access a serial console, as described in
:ref:`devkit_test_run` above.
Alternate Configuration - USB C Host
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In this configuration, USB host mode is used to allow keyboard, mouse and flash
memory sticks to be connected to the development board.
**Note:** Using the board in this mode means that you will lose access to the
USB serial console, so it is important to have set up SSH access via Ethernet
before following these steps.
1. On the target, backup the device tree and copy in the USB host version::
cp /boot/dtbs/librem5-evk.dtb /boot/dtbs/librem5-evk.dtb.bak
cp /boot/dtbs/librem5-evk-usbhost.dtb /boot/dtbs/librem5-evk.dtb
2. Attach a USB C hub to the development board.
3. Attach power to the USB C hub.
4. Plug in USB devices and they should appear in the output of the ``dmesg``
and ``lsusb`` tools.
The `J5 Create JCA374 <J5 Create JCA374_>`_ USB Type-C Multi-Adapter
is known to work as a hub and power the board using USB Power
Delivery.
.. include:: /links.rst
HowTo/SSH_Access
HowTo/USB_Access
SSH Access and X11 Forwarding
=============================
Once you have networking set up for the development board, you should be able
to log in using ``ssh`` once the OpenSSH daemon has started. This may take
some time due to a lack of entropy (see `linux-emcraft issue 2`_ for details).
Log in to the board using one of the network connections (Wi-Fi or Ethernet).
Install the ``xauth`` package to enable X11 forwarding and check that the
``/etc/ssh/sshd_config`` file contains the following line::
X11Forwarding yes
Log out and log in again using ``ssh -X`` and check that the environment has
the ``DISPLAY`` variable set.
To run a GNOME application, like `gnome-chess`, on the board while displaying
the output on a workstation running an X server, set the ``GDK_BACKEND``
environment variable [#]_ when running the executable, like this::
GDK_BACKEND=x11 gnome-chess
The application should appear on the workstation's screen.
.. [#] Described in the `Running GTK+ Applications`_ GNOME developer document.
.. include:: /links.rst
USB Access
==========
In the default configuration, as shipped, USB in is peripheral mode and a
"wall wart" AC adaptor can be used for power. In this mode, it is also
possible to connect the development board to a workstation's USB **3.0+** port
(where VBUS can supply up to 900mA) and access a serial console, as described in
:ref:`devkit_test_run`.
Alternate Configuration - USB C Host
------------------------------------
In this configuration, USB host mode is used to allow keyboard, mouse and flash
memory sticks to be connected to the development board.
**Note:** Using the board in this mode means that you will lose access to the
USB serial console, so it is important to have set up SSH access via Ethernet
before following these steps.
1. On the target, backup the device tree and copy in the USB host version::
cp /boot/dtbs/librem5-evk.dtb /boot/dtbs/librem5-evk.dtb.bak
cp /boot/dtbs/librem5-evk-usbhost.dtb /boot/dtbs/librem5-evk.dtb
2. Attach a USB C hub to the development board.
3. Attach power to the USB C hub.
4. Plug in USB devices and they should appear in the output of the ``dmesg``
and ``lsusb`` tools.
The `J5 Create JCA374`_ USB Type-C Multi-Adapter is known to work as a hub and
power the board using USB Power Delivery.
.. include:: /links.rst
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment