summaryrefslogtreecommitdiffstats
path: root/docs/getting-started/machines
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-12-17 11:54:49 -0800
committerScott Rifenbark <srifenbark@gmail.com>2018-12-17 11:54:49 -0800
commitc416cea789822940c2241e61b0cb00dbbc3c25b6 (patch)
tree6938b97f41b889db17753c5d2667269bcfd16533 /docs/getting-started/machines
parenta4013befcbb2c82273067e401d3d393445a5a100 (diff)
Raspberry PI build: Integrated old debug stuff into main build.
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Diffstat (limited to 'docs/getting-started/machines')
-rw-r--r--docs/getting-started/machines/images/RaspberryPi2-ModelB-debug-serial-cable.pngbin0 -> 411744 bytes
-rw-r--r--docs/getting-started/machines/raspberrypi.md49
2 files changed, 48 insertions, 1 deletions
diff --git a/docs/getting-started/machines/images/RaspberryPi2-ModelB-debug-serial-cable.png b/docs/getting-started/machines/images/RaspberryPi2-ModelB-debug-serial-cable.png
new file mode 100644
index 0000000..f4374d0
--- /dev/null
+++ b/docs/getting-started/machines/images/RaspberryPi2-ModelB-debug-serial-cable.png
Binary files differ
diff --git a/docs/getting-started/machines/raspberrypi.md b/docs/getting-started/machines/raspberrypi.md
index 7727267..ce9337c 100644
--- a/docs/getting-started/machines/raspberrypi.md
+++ b/docs/getting-started/machines/raspberrypi.md
@@ -176,7 +176,7 @@ the image on the Raspberry PI 2 or 3 board:
4. Plug your MicroSD card into the Raspberry PI board and boot the device.
-## 5. Raspberry PI Touch Display
+## 5. Using the Raspberry PI Touch Display
If you have connected the official
[Raspberry PI Touch Display](https://www.raspberrypi.org/products/raspberry-pi-touch-display/),
@@ -221,3 +221,50 @@ path=/usr/bin/weston-flower
name=DSI-1
transform=270
```
+
+## 6. Debugging
+
+When things go wrong, you can take steps to debug your Raspberry PI.
+For debugging, you need a 3.3 Volt USB Serial cable to fascilitate
+communication between your Raspberry PI board and your build host.
+A good cable to use is the 3.3V USB-to-Serial cable
+[Olimex USB-Serial-Cable-F](https://www.olimex.com/Products/Components/Cables/USB-Serial-Cable/USB-Serial-Cable-F/).
+
+**NOTE:** If you are using a USB console cable from Adafruit, see
+"[Adafruit's Raspberry Pi Lesson 5](https://learn.adafruit.com/adafruits-raspberry-pi-lesson-5-using-a-console-cable/connect-the-lead)"
+for connection information.
+
+Use the following steps, which assume you are using the previously mentioned
+Olimex cable.
+You can reference the following diagram for information on the following steps:
+
+<p align="center">
+ <img src="./images/RaspberryPi2-ModelB-debug-serial-cable.png">
+</p>
+
+1. Connect the Olimex cable to the Universal Asynchronous Receiver-Transmitter
+ (UART) connection on your Raspberry PI board.
+ Do not connect the USB side of the cable to your build host at this time.
+
+ **CAUTION:** No warranty is provided using the following procedure.
+ Pay particular attention to the collors of your cable as they could
+ vary depending on the vendor.
+
+2. Connect the cable's BLUE wire to pin 6 (i.e. Ground) of the UART.
+
+3. Connect the cable's GREEN RX line to pin 8 (i.e. the TXD line) of
+ the UART.
+
+4. Connect the cable's RED TX line to pin 10 (i.e. the RXD line) of
+ the UART.
+
+5. Plug the USB connector of the cable into your build host's USB port.
+
+6. Use your favorite tool for serial communication between your build host
+ and your Raspberry PI.
+ For example, if your build host is a native Linux machine (e.g. Ubuntu)
+ you could use `screen` as follows from a terminal on the build host:
+
+ ```bash
+ $ sudo screen /dev/ttyUSB0 115200
+ ```