summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Fiege <c.fiege@pengutronix.de>2017-06-27 10:18:09 +0200
committerRobert Schwebel <r.schwebel@pengutronix.de>2017-06-30 21:50:36 +0200
commit5e4ffe588b621fccbb4de36042b0d4f02915edee (patch)
tree12308fb0292a4f08a6ee6c24c1fc620eae2a9ee5
parent07bedf7d2107d8ad7b7600c0cad0f0863890d6f9 (diff)
downloadDistroKit-5e4ffe588b621fccbb4de36042b0d4f02915edee.tar.gz
DistroKit-5e4ffe588b621fccbb4de36042b0d4f02915edee.tar.xz
doc: extend documentation for supported hardware
The documentation does now contain the names of the images and information about where to find the serial console ports of the boards. As some hardware platforms do currently not work again after the recent rework, we remove them from the ToC for now and re-add them later when they have been tested and fixed. Adding Build doc to .gitignore. Signed-off-by: Chris Fiege <c.fiege@pengutronix.de> [improve commit message] Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--.gitignore1
-rw-r--r--doc/hardware.rst3
-rw-r--r--doc/hardware_v7a_beaglebone_black.rst13
-rw-r--r--doc/hardware_v7a_beaglebone_white.rst7
-rw-r--r--doc/hardware_v7a_qemu.rst7
5 files changed, 26 insertions, 5 deletions
diff --git a/.gitignore b/.gitignore
index 75033d3..44c6a75 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,4 @@
/p
/src
*.sw*
+Documentation/
diff --git a/doc/hardware.rst b/doc/hardware.rst
index 2691503..719baeb 100644
--- a/doc/hardware.rst
+++ b/doc/hardware.rst
@@ -42,6 +42,3 @@ Hardware for the v7a Platform
hardware_v7a_qemu
hardware_v7a_beaglebone_white
hardware_v7a_beaglebone_black
- hardware_v7a_raspi2
- hardware_v7a_raspi3
-
diff --git a/doc/hardware_v7a_beaglebone_black.rst b/doc/hardware_v7a_beaglebone_black.rst
index ce10d0b..bb523b6 100644
--- a/doc/hardware_v7a_beaglebone_black.rst
+++ b/doc/hardware_v7a_beaglebone_black.rst
@@ -1,5 +1,16 @@
Beaglebone Black
================
-foo bar baz
+Boot Media
+----------
+Use the image ``platform-v7a/images/beaglebone.hdimg`` and copy it onto your MicroSD-Card.
+Press the user-button ``S2`` when powering up the Beaglebone Black to boot from MicroSD-Card. ``S2`` is the button above the MicroSD-Card.
+
+Serial Console
+--------------
+The serial boot console is available via the debug connector J1 at 115200 Baud and 8N1. The pinout is:
+
+* J1.1: GND
+* J1.4: RxD
+* J1.5: TxD
diff --git a/doc/hardware_v7a_beaglebone_white.rst b/doc/hardware_v7a_beaglebone_white.rst
index c62522e..540066b 100644
--- a/doc/hardware_v7a_beaglebone_white.rst
+++ b/doc/hardware_v7a_beaglebone_white.rst
@@ -1,5 +1,10 @@
Beaglebone White
================
-foo bar baz
+Boot Media
+----------
+Use the image ``platform-v7a/images/beaglebone.hdimg`` and copy it onto your MicroSD-Card.
+Serial Console
+--------------
+The serial boot console is available via the Mini-USB-Jack P3 at 115200 Baud with 8N1.
diff --git a/doc/hardware_v7a_qemu.rst b/doc/hardware_v7a_qemu.rst
index 7352f8c..996323e 100644
--- a/doc/hardware_v7a_qemu.rst
+++ b/doc/hardware_v7a_qemu.rst
@@ -4,3 +4,10 @@ QEmu
The v7a platform is ready to run in qemu, using the versatile express
hardware simulation.
+There are two ways to run DistoKit inside qemu:
+
+* With barebox:
+ Run ``./configs/platform-v7a/run barebox`` to boot the current image with barebox.
+* Without barebox:
+ Run ``./configs/platform-v7a/run`` to directly start the kernel without barebox.
+