Commit 5722e30d authored by David Boddie's avatar David Boddie 💬
Browse files

Merge branch 'devkit-howto' into 'master'

Move the USB host use case to a separate document

See merge request Librem5/developer.puri.sm!114
parents a96ecc32 07a8b6fb
......@@ -21,6 +21,7 @@ commands and some application setup that is not board specific.
Boards/imx8
Boards/Known_Issues
Boards/Troubleshooting
Boards/HowTo
Boards/dev-kit/modem
Boards/mini-tutorials
Boards/Legacy/index
......
.. _devkit_howto:
How To Guides
=============
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 port 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.
......@@ -73,14 +73,20 @@ for the sockets, buttons and switches.
Test Run
--------
Connect the development board to a network using the Ethernet socket and a
suitable cable. Connect the board to the provided power supply using the
provided cable. Two green LEDs will immediately light up between the SoM and
the battery holder.
There are two simple ways to verify that the development board is
functioning. It is useful to try both of these to ensure that you can access
the board via serial and Ethernet connections.
After a moment, the orange Ethernet light should start blinking and the
vibration motor will give a short burst shortly after, as the MMC image is
loading. Soon after, it will register as a USB serial device:
If neither of these procedures work for you, please `get in touch`_.
.. _`get in touch`: https://developer.puri.sm/Librem5/Contact.html
USB Console
~~~~~~~~~~~
Connect the board to a workstation using the USB A to USB C cable provided.
The haptic motor will sound briefly and the board should appear shortly
after as a USB serial device to the workstation.
::
......@@ -97,12 +103,21 @@ It will appear in the ``/dev/`` directory as a serial port, such as
pureos-test login:
It will be possible to log in using ``root`` as both the user name and
It should be possible to log in using ``root`` as both the user name and
password, or ``purism`` as the user name and ``123456`` as the password.
If this procedure didn't work for you, please `get in touch`_.
Ethernet Connection
~~~~~~~~~~~~~~~~~~~
.. _`get in touch`: https://developer.puri.sm/Librem5/Contact.html
Connect the board to a network using the Ethernet socket and a suitable
cable. Connect the board to the provided power supply using the provided
cable. Two green LEDs will immediately light up between the SoM and the
battery holder. After a moment, the orange Ethernet light should start
blinking and the haptic motor will sound briefly. The board should be
accessible over the network via SSH.
It should be possible to log in using ``purism`` as the user name and
``123456`` as the password.
Flashing eMMC
-------------
......@@ -210,30 +225,6 @@ The serial console should appear at ``/dev/ttyACM0``, confirming a successful re
As usual, don't hesitate to `get in touch`_ if you find yourself stuck.
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 port 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.
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.
Power on/off
------------
......
Supports Markdown
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