summaryrefslogtreecommitdiffstats
path: root/docs
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
parenta4013befcbb2c82273067e401d3d393445a5a100 (diff)
Raspberry PI build: Integrated old debug stuff into main build.
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/getting-started/footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpgbin96123 -> 0 bytes
-rw-r--r--docs/getting-started/footers/raspberrypi-footer.md56
-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
4 files changed, 48 insertions, 57 deletions
diff --git a/docs/getting-started/footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg b/docs/getting-started/footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg
deleted file mode 100644
index e8026d6..0000000
--- a/docs/getting-started/footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/getting-started/footers/raspberrypi-footer.md b/docs/getting-started/footers/raspberrypi-footer.md
deleted file mode 100644
index f5ff16f..0000000
--- a/docs/getting-started/footers/raspberrypi-footer.md
+++ /dev/null
@@ -1,56 +0,0 @@
-# Commercial Licensed Packages
-
-Append to following lines to **conf/local.conf** to include libomxil under a commercial license to your build:
-
-```bash
-# For libomxil
-LICENSE_FLAGS_WHITELIST = "commercial"
-
-IMAGE_INSTALL_append = " libomxil"
-```
-
-# Raspberry Pi Touchscreen with Rotation
-
-If you have Raspberry Pi official 7" touchscreen connected, you can rotate it with these lines in /etc/xdg/weston/weston.ini
-
-```bash
-root@raspberrypi3:/etc/xdg/weston# cat weston.ini
-[core]
-backend=drm-backend.so
-shell=desktop-shell.so
-
-[shell]
-locking=true
-# Uncomment below to hide panel
-#panel-location=none
-
-[launcher]
-icon=/usr/share/weston/terminal.png
-path=/usr/bin/weston-terminal
-
-[launcher]
-icon=/usr/share/weston/icon_flower.png
-path=/usr/bin/weston-flower
-
-[output]
-name=DSI-1
-transform=270
-```
-
-# Debugging
-
-It is possible to debug AGL images on Raspberry Pi using 3.3V USB to serial cable, such as [Olimex USB-Serial-Cable-F](https://www.olimex.com/Products/Components/Cables/USB-Serial-Cable/USB-Serial-Cable-F/), connected to the UART of the board. Follow the instructions below to connect a cable to the board (do it on your own risk, no warranty is provided):
-
-* Connect the BLUE wire if you are using Olimex USB-Serial-Cable-F to pin 6 of Raspberry Pi,
-* Connect the RX line of the cable (GREEN wire if you are using Olimex USB-Serial-Cable-F) to pin 8 (TX line) of Raspberry Pi,
-* Connect the TX line of the cable (RED wire if you are using Olimex USB-Serial-Cable-F) to pin 10 (RX line) of Raspberry Pi.
-
-![Olimex USB-Serial-Cable-F attached to Raspberry PI 2 for debugging through the serial console](images/RaspberryPi2-ModelB-debug-serial-cable.jpg)
-
-* Plug the USB connector of the cable to your computer and use your favorite tool for serial communication, for example on Ubuntu and other Linux distributions you may use screen:
-
-```bash
-sudo screen /dev/ttyUSB0 115200
-```
-
-Pay attention that the colors of the cable may vary depending on the vendor. If you have USB console cable from Adafruit please have a look [here](https://learn.adafruit.com/adafruits-raspberry-pi-lesson-5-using-a-console-cable/connect-the-lead).
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
+ ```