From 5bbd7f92e895d63439165fd0d3dfd5ee80bd6d7b Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@digia.com>
Date: Mon, 30 Jun 2014 11:37:43 +0200
Subject: Doc: split up the docs into multiple files

Split up the monolithic b2qt.qdoc into separate documentation
files, making future edits and maintenance easier.

Device-specific instructions are created in devices/ subdirectory,
and shared documentation (referenced in multiple places) are
moved to shared/.

Change-Id: I9425297781a1dda9c08a149b0870a0389c575560
Reviewed-by: Samuli Piippo <samuli.piippo@digia.com>
Reviewed-by: Kalle Viironen <kalle.viironen@digia.com>
---
 src/doc/src/devices/qtee-toradex-apalis.qdoc | 80 ++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 src/doc/src/devices/qtee-toradex-apalis.qdoc

(limited to 'src/doc/src/devices/qtee-toradex-apalis.qdoc')

diff --git a/src/doc/src/devices/qtee-toradex-apalis.qdoc b/src/doc/src/devices/qtee-toradex-apalis.qdoc
new file mode 100644
index 0000000..4af35c3
--- /dev/null
+++ b/src/doc/src/devices/qtee-toradex-apalis.qdoc
@@ -0,0 +1,80 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use the contact form at
+** http://qt.digia.com/
+**
+** This file is part of Qt Enterprise Embedded.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** the contact form at http://qt.digia.com/
+**
+****************************************************************************/
+/*!
+    \target Toradex Apalis iMX6 (embedded Linux)
+    \page qtee-preparing-hardware-apalis-imx6.html
+    \title Preparing Toradex Apalis iMX6
+    \previouspage qtee-installation-guide.html
+
+    Take the following steps to prepare a
+    \l{http://www.toradex.com/products/apalis-arm-computer-modules/freescale-imx-6-computer-module}
+    {Toradex Apalis iMX6} for \B2Q.
+
+    \note It is important that you repeat the steps in this section after you
+    update \SDK.
+
+    The images containing the \B2Q stack for Toradex Apalis iMX6 are included
+    in \SDK, ready to be copied to an SD card.
+
+    \section1 Preparing an SD Card
+
+    An SD card of at least 512 MB capacity is sufficient.
+
+    \include detect-sd-card-device-name.qdocinc instructions
+
+    \section1 Installing the \B2Q Image
+
+    To write the image to the SD card, ensure that no partitions on the
+    SD card are mounted:
+
+    \include detect-sd-card-device-name.qdocinc unmount
+
+    Then,
+
+    \badcode
+        cd <INSTALL_DIR>
+        sudo Boot2Qt-3.x/apalis-imx6-eLinux/images/deploy.sh /dev/<device_name>
+    \endcode
+
+    By default, the Toradex Apalis iMX6 boots from its internal eMMC. In order to boot from
+    the external SD card, the U-Boot environment needs to be updated. Connect a serial cable
+    to the device and enter into the U-Boot environment by pressing any key before the autoboot.
+    Enter following lines into U-Boot:
+
+    \badcode
+        setenv bootcmd 'run sdboot ; echo sdboot failed ; run emmcboot ; echo ; echo emmcboot failed ; run nfsboot ; echo ; echo nfsboot failed ; usb start ;setenv stdout serial,vga ; setenv stdin serial,usbkbd'
+        setenv sdboot 'run setup; setenv bootargs ${defargs} ${sdargs} ${setupargs} ${vidargs};echo Booting from SD card in 4bit slot...; fatload mmc 2:1 10800000 uImage && bootm 10800000'
+        setenv sdargs 'ip=off root=/dev/mmcblk1p2 rw,noatime rootfstype=ext3 rootwait'
+        saveenv
+    \endcode
+
+    New U-Boot command are now stored into the device, and you can start \B2Q. For more information
+    about the boot process on Toredex Apalis iMX6, see
+    \l{http://developer.toradex.com/software-resources/arm-family/linux/linux-booting}{Toradex Linux Booting}
+
+    After the image has been deployed, insert the SD card, power on the device and check that
+    the \B2Q welcome screen and/or demo appear.
+
+    \section1 Configuring a Device Kit in Qt Creator
+
+    \include b2qt-post-install-setup.qdocinc configuring network device
+
+    You are now ready to start developing for your device. For more information,
+    see \l{Building and Running an Example}.
+*/
-- 
cgit v1.2.3