From 5bbd7f92e895d63439165fd0d3dfd5ee80bd6d7b Mon Sep 17 00:00:00 2001 From: Topi Reinio 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 Reviewed-by: Kalle Viironen --- src/doc/src/devices/qtee-bd-sl-imx6.qdoc | 110 ++++++++++++++++++++++++ src/doc/src/devices/qtee-beagleboard-xm.qdoc | 69 +++++++++++++++ src/doc/src/devices/qtee-beaglebone-black.qdoc | 101 ++++++++++++++++++++++ src/doc/src/devices/qtee-imx53.qdoc | 70 +++++++++++++++ src/doc/src/devices/qtee-nexus-7.qdoc | 103 ++++++++++++++++++++++ src/doc/src/devices/qtee-raspberry-pi.qdoc | 69 +++++++++++++++ src/doc/src/devices/qtee-sabre-sd-imx6quad.qdoc | 69 +++++++++++++++ src/doc/src/devices/qtee-supported-devices.qdoc | 106 +++++++++++++++++++++++ src/doc/src/devices/qtee-toradex-apalis.qdoc | 80 +++++++++++++++++ 9 files changed, 777 insertions(+) create mode 100644 src/doc/src/devices/qtee-bd-sl-imx6.qdoc create mode 100644 src/doc/src/devices/qtee-beagleboard-xm.qdoc create mode 100644 src/doc/src/devices/qtee-beaglebone-black.qdoc create mode 100644 src/doc/src/devices/qtee-imx53.qdoc create mode 100644 src/doc/src/devices/qtee-nexus-7.qdoc create mode 100644 src/doc/src/devices/qtee-raspberry-pi.qdoc create mode 100644 src/doc/src/devices/qtee-sabre-sd-imx6quad.qdoc create mode 100644 src/doc/src/devices/qtee-supported-devices.qdoc create mode 100644 src/doc/src/devices/qtee-toradex-apalis.qdoc (limited to 'src/doc/src/devices') diff --git a/src/doc/src/devices/qtee-bd-sl-imx6.qdoc b/src/doc/src/devices/qtee-bd-sl-imx6.qdoc new file mode 100644 index 0000000..700375c --- /dev/null +++ b/src/doc/src/devices/qtee-bd-sl-imx6.qdoc @@ -0,0 +1,110 @@ +/**************************************************************************** +** +** 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 BD-SL-i.MX6 (embedded Android and Linux) + \page qtee-preparing-hardware-imx6.html + \title Preparing BD-SL-i.MX6 + \previouspage qtee-installation-guide.html + + Take the following steps to prepare a + \l{http://boundarydevices.com/products/sabre-lite-imx6-sbc/} + {Boundary Devices BD-SL-i.MX6} (SABRE Lite) 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 BD-SL-i.MX6 are included + in \SDK, ready to be copied to an SD card. + + \section1 Preparing an SD Card + + For \B2QA, an SD card of at least 4 GB capacity is needed. For \B2QL, + a card of at least 512 MB capacity is sufficient. + + \include detect-sd-card-device-name.qdocinc instructions + + \section1 Installing the Android image + + \e{If installing} \B2QL, \e{you can skip this step and proceed to} + \l{Installing the Boot to Qt Image}. + + Download the package \e{imx6-jb-20130628.tar.gz} from + \l{http://boundarydevices.com/android-jellybean-on-i-mx6-with-no-disclaimers/}{Boundary + Devices Android Jellybean i.MX6 images} (registration required). + + Use the following commands to create an SD card containing the + downloaded image: + + \list 1 + \li Extract the downloaded package: + \badcode + ~/$ mkdir bd-android + ~/$ cd bd-android + ~/bd-android$ tar zxvf ~/Downloads/imx6-jb-20130628.tar.gz + \endcode + \li Run device/boundary/mksdcard.sh: + \badcode + ~/bd-android$ sudo device/boundary/mksdcard.sh /dev/ + ~/bd-android$ sync + \endcode + \endlist + + \section1 Installing the \B2Q Image + + Make sure you have the required tools installed in your development machine: + + \badcode + sudo apt-get install u-boot-tools + \endcode + + Then, upgrade the SD card with \B2Q. First, ensure that no partitions on the + SD card are mounted: + + \include detect-sd-card-device-name.qdocinc unmount + + Then, use one of the commands below, depending on whether you are developing + for embedded Android or Linux: + + \list + \li \b{\B2QA} + \badcode + cd + ./Boot2Qt-3.x/generic-4.2-eAndroid/images/iMX6/deploy.sh /dev/ + \endcode + \li \b{\B2QL} + \badcode + cd + sudo ./Boot2Qt-3.x/iMX6-eLinux/images/deploy.sh /dev/ + \endcode + \endlist + + After the installation is complete, insert the SD card, power on the device and check that + the \B2Q welcome screen and/or demo appear. + + \section1 Setting up USB Access + + \include b2qt-post-install-setup.qdocinc setting up usb access + + \section1 Configuring a Device Kit in Qt Creator + + \include b2qt-post-install-setup.qdocinc configuring device kit android linux + + You are now ready to start developing for your device. For more information, + see \l{Building and Running an Example}. +*/ diff --git a/src/doc/src/devices/qtee-beagleboard-xm.qdoc b/src/doc/src/devices/qtee-beagleboard-xm.qdoc new file mode 100644 index 0000000..fae5725 --- /dev/null +++ b/src/doc/src/devices/qtee-beagleboard-xm.qdoc @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** 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 BeagleBoard-xM (embedded Linux) + \page qtee-preparing-hardware-beagleboard.html + \title Preparing BeagleBoard-xM + \previouspage qtee-installation-guide.html + \nextpage qtee-building-and-running.html + + Take the following steps to prepare a \l{http://beagleboard.org/hardware-xM} + {BeagleBoard-xM} for + \B2Q. + + \note BeagleBoard-xM is no longer supported in \SDK 3.0. It is still, + however, supported and tested under the previous 2.x versions. + + The image containing \B2Q stack for BeagleBoard-xM 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 needed. + + \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 + sudo Boot2Qt-3.x/beagleboard-eLinux/images/deploy.sh /dev/ + \endcode + + After the image has been deployed, power on the device and check that + the \B2Q welcome screen and/or demo appear. + + \section1 Setting up USB Access + + \include b2qt-post-install-setup.qdocinc setting up usb access + + \section1 Configuring a Device Kit in Qt Creator + + \include b2qt-post-install-setup.qdocinc configuring device kit + + You are now ready to start developing for your device. For more information, + see \l{Building and Running an Example}. +*/ diff --git a/src/doc/src/devices/qtee-beaglebone-black.qdoc b/src/doc/src/devices/qtee-beaglebone-black.qdoc new file mode 100644 index 0000000..360eb6d --- /dev/null +++ b/src/doc/src/devices/qtee-beaglebone-black.qdoc @@ -0,0 +1,101 @@ +/**************************************************************************** +** +** 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 BeagleBone Black (embedded Android and Linux) + \page qtee-preparing-hardware-beaglebone.html + \title Preparing BeagleBone Black + \previouspage qtee-installation-guide.html + + Take the following steps to prepare a + \l{http://beagleboard.org/products/beaglebone%20black}{BeagleBone Black} 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 BeagleBone Black are included + in \SDK, ready to be copied to an SD card. + + \section1 Preparing an SD Card + + For \B2QA, an SD card of at least 2 GB capacity is needed. For \B2QL, + a card of at least 512 MB capacity is sufficient. + + \include detect-sd-card-device-name.qdocinc instructions + + \section1 Installing the Android image + + \e{If installing} \B2QL, \e{you can skip this step and proceed to} + \l{Installing the Boot to Qt Image}. + + Download the package \e{TI_Android_JB_4.2.2_DevKit_4.1.1_beagleboneblack.tar.gz} from + \l{http://downloads.ti.com/sitara_android/esd/TI_Android_DevKit/TI_Android_JB_4_2_2_DevKit_4_1_1/index_FDS.html} + {Texas Instruments} (search for \e {BeagleBone Black} in the list of download packages). + + Use the following commands to create an SD card containing the + downloaded image: + + \list 1 + \li Extract the downloaded package: + \badcode + ~$ tar zxvf ~/Downloads/TI_Android_JB_4.2.2_DevKit_4.1.1_beagleboneblack.tar.gz + \endcode + \li Run beagleboneblack/mkmmc-android.sh: + \badcode + ~$ cd beagleboneblack + ~/beagleboneblack$ sudo ./mkmmc-android.sh /dev/ + \endcode + \endlist + + \section1 Installing the \B2Q Image + + Then, upgrade the SD card with \B2Q. First, ensure that no partitions on the + SD card are mounted: + + \include detect-sd-card-device-name.qdocinc unmount + + Then, use one of the commands below, depending on whether you are developing + for embedded Android or Linux: + + \list + \li \b{\B2QA} + \badcode + cd + ./Boot2Qt-3.x/generic-4.2-eAndroid/images/beaglebone/deploy.sh + \endcode + \li \b{\B2QL} + \badcode + cd + sudo ./Boot2Qt-3.x/beaglebone-eLinux/images/deploy.sh /dev/ + \endcode + \endlist + + After the installation is complete, insert the SD card, power on the device and check that + the \B2Q welcome screen and/or demo appear. + + \section1 Setting up USB Access + + \include b2qt-post-install-setup.qdocinc setting up usb access + + \section1 Configuring a Device Kit in Qt Creator + + \include b2qt-post-install-setup.qdocinc configuring device kit android linux + + You are now ready to start developing for your device. For more information, + see \l{Building and Running an Example}. +*/ diff --git a/src/doc/src/devices/qtee-imx53.qdoc b/src/doc/src/devices/qtee-imx53.qdoc new file mode 100644 index 0000000..96dcbea --- /dev/null +++ b/src/doc/src/devices/qtee-imx53.qdoc @@ -0,0 +1,70 @@ +/**************************************************************************** +** +** 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 i.MX53 Quick Start Board (embedded Linux) + \page qtee-preparing-hardware-imx53qsb.html + \title Preparing i.MX53 Quick Start Board + \previouspage qtee-installation-guide.html + \nextpage qtee-building-and-running.html + + Take the following steps to prepare a + \l{http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=IMX53QSB} {i.MX53 Quick Start Board} + for \B2Q. + + \note Ethernet networking is required to connect the device to Qt Creator. + + \note It is important that you repeat the steps in this section after you + update \SDK. + + As i.MX53 Quick Start Board is not a \SDK reference board, there is no ready-made + image containing a \B2Q stack available. Instead, you must build it yourself using + the Yocto recipes and build scripts from the \B2Q source packages. + For more information, see \l{Building Your Own Embedded Linux Image}. + + \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 + sudo deploy.sh /dev/ + \endcode + + 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}. +*/ + diff --git a/src/doc/src/devices/qtee-nexus-7.qdoc b/src/doc/src/devices/qtee-nexus-7.qdoc new file mode 100644 index 0000000..c461fb6 --- /dev/null +++ b/src/doc/src/devices/qtee-nexus-7.qdoc @@ -0,0 +1,103 @@ +/**************************************************************************** +** +** 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 Nexus 7 (2012/2013) (embedded Android) + \page qtee-preparing-hardware-nexus-7.html + \title Preparing Nexus 7 (2012/2013) + \previouspage qtee-installation-guide.html + \nextpage qtee-building-and-running.html + + Take the following steps to prepare a + \l{http://www.google.com/nexus/7/specs/}{Nexus 7 (2012/2013)} for + \B2Q. + + \note The installation process will wipe the device. Make sure to + backup any personal data. The device can later be restored to + factory state, see \l{nexus-factory-reset}{Troubleshooting}. + + The Nexus 7 must have the same Android main version (e.g. \c{4.2} + or \c{4.4}) as the generic \B2Q eAndroid stack that is to be + installed. If needed, you can update the Android version either by + using Android's upgrading tool, or by flashing a factory image of + the right version. See \l{nexus-factory-reset}{Troubleshooting}. + + \section1 Enabling Developer Mode + + In order to install the \B2Q stack into the Nexus 7, you need to + enable developer mode and USB debugging. This is only needed for + the first time install. + + \note If for some reason the device does not boot up normally, it + is also possible to install to a Nexus 7 started up in + \c{fastboot} (bootloader) mode (see + \l{nexus-factory-reset}{Troubleshooting}). Just skip this section + and add the \c{-fastboot} argument to the \c{deploy.sh} command + below. + + \list 1 + \li Power up the device. + \li Open the \b{Settings} app and select the \b{About tablet} item. + \li Press the \b{Build number} item seven times, until the message "You are now a developer!" appears. + + \li Back in the \b{Settings} menu, select \b{Developer options}. + \li Press the \b{USB debugging} item and confirm that you allow USB debugging. + \endlist + + You should now be able to establish USB connection to the device as follows. + + \section1 Setting up USB Access + + \include b2qt-post-install-setup.qdocinc setting up usb access + + \section1 Deploying the \B2Q Stack + + Depending on the edition of your Nexus 7 device, use one of the + commands below to install the \B2Q stack. Replace \c{X.Y} with the + device's Android version number, for example \c{4.2} or \c{4.4}. + + \note The deploy script will check that the connected Nexus device + is of the expected type and Android version, and abort the + installation if it is not. + + \list + \li \b{Nexus 7 (2013):} + \badcode + cd + ./Boot2Qt-3.x/generic-X.Y-eAndroid/images/nexus7v2/deploy.sh + \endcode + \li \b{Nexus 7 (2012):} + \badcode + cd + ./Boot2Qt-3.x/generic-X.Y-eAndroid/images/nexus7/deploy.sh + \endcode + \endlist + + During the installation, the device may ask for confirmation to be + unlocked. Press the power button once to confirm. + + The device will reboot during the process. Do not interact with it + or unplug it until the process is fully completed. + + \section1 Configuring a Device Kit in Qt Creator + + \include b2qt-post-install-setup.qdocinc configuring device kit android + + You are now ready to start developing for your device. For more information, + see \l{Building and Running an Example}. +*/ diff --git a/src/doc/src/devices/qtee-raspberry-pi.qdoc b/src/doc/src/devices/qtee-raspberry-pi.qdoc new file mode 100644 index 0000000..9a30dce --- /dev/null +++ b/src/doc/src/devices/qtee-raspberry-pi.qdoc @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** 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 Raspberry Pi Model B (embedded Linux) + \page qtee-preparing-hardware-rasberrypi.html + \title Preparing Raspberry Pi + \previouspage qtee-installation-guide.html + \nextpage qtee-building-and-running.html + + Take the following steps to prepare a \l{http://www.raspberrypi.org/} + {Raspberry Pi} for + \B2Q. + + \note Ethernet networking is required to connect the device to Qt Creator. + This means that the support is currently limited to Raspberry Pi Model B, which + includes an Ethernet port. + + \note It is important that you repeat the steps in this section after you + update \SDK. + + The image containing \B2Q stack for Raspberry Pi is included in the 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 + sudo Boot2Qt-3.x/raspberrypi-eLinux/images/deploy.sh /dev/ + \endcode + + 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}. +*/ diff --git a/src/doc/src/devices/qtee-sabre-sd-imx6quad.qdoc b/src/doc/src/devices/qtee-sabre-sd-imx6quad.qdoc new file mode 100644 index 0000000..15898c7 --- /dev/null +++ b/src/doc/src/devices/qtee-sabre-sd-imx6quad.qdoc @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** 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 SABRE SD i.MX6Quad (embedded Linux) + \page qtee-preparing-hardware-imx6sabresd.html + \title Preparing SABRE SD i.MX6Quad + \previouspage qtee-installation-guide.html + + Take the following steps to prepare a + \l{http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=RDIMX6SABREBRD} + {Freescale SABRE SD i.MX6Quad} 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 SABRE SD i.MX6Quad 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 + sudo Boot2Qt-3.x/imx6qsabresd-eLinux/images/deploy.sh /dev/ + \endcode + + 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 Setting up USB Access + + \include b2qt-post-install-setup.qdocinc setting up usb access + + \section1 Configuring a Device Kit in Qt Creator + + \include b2qt-post-install-setup.qdocinc configuring device kit + + You are now ready to start developing for your device. For more information, + see \l{Building and Running an Example}. +*/ + diff --git a/src/doc/src/devices/qtee-supported-devices.qdoc b/src/doc/src/devices/qtee-supported-devices.qdoc new file mode 100644 index 0000000..ad33aa9 --- /dev/null +++ b/src/doc/src/devices/qtee-supported-devices.qdoc @@ -0,0 +1,106 @@ +/**************************************************************************** +** +** 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/ +** +****************************************************************************/ + +/*! + \page qtee-preparing-hardware.html + \title Preparing Hardware + \previouspage qtee-supported-platforms.html + \nextpage qtee-building-and-running.html + + Before you can deploy and test your Qt application on hardware, you must + flash the target device with an image that contains the + \B2Q stack. These steps vary from device to device: + + \list + \li \l{Nexus 7 (2012/2013) (embedded Android)} + \li \l{BD-SL-i.MX6 (embedded Android and Linux)} + \li \l{SABRE SD i.MX6Quad (embedded Linux)} + \li \l{Toradex Apalis iMX6 (embedded Linux)} + \li \l{BeagleBone Black (embedded Android and Linux)} + \li \l{BeagleBoard-xM (embedded Linux)} + \li \l{Raspberry Pi Model B (embedded Linux)} + \endlist + + If you use only the emulator, you can skip this step + and continue straight to \l {Building and Running an Example}. +*/ + +/*! + \page qtee-supported-platforms.html + \title Supported Platforms + \previouspage qtee-installation-guide.html + \nextpage qtee-preparing-hardware.html + + \section1 Supported Reference Devices + + The \B2Q stack can be made to run on a variety of hardware. For \SDK license + holders, tooling is provided to customize the contents of the stack as well + as to take it into desired production hardware. For more information on how + to customize the stack for embedded Linux, see + \l {Building Your Own Embedded Linux Image}. + + Approximate minimal hardware requirements for running \B2Q are: + \list + \li 256 MB of RAM + \li 500 MHz CPU, 1 GHz preferred for 60-FPS velvet-smooth UI + \li OpenGL ES 2.0 support + \endlist + + \B2QA requires hardware that has support for the Android operating + system, version 4.2 or later. + + \B2Q software stack is provided pre-built, tested and supported for the + following hardware: + \list + \li \l{http://www.google.com/nexus/7/specs/} + {Google/Asus Nexus 7 (2012 and 2013 models)} + \li \l{http://beagleboard.org/products/beaglebone%20black} + {BeagleBone Black} + \li \l{http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=RDIMX6SABREBRD} + {Freescale SABRE SD i.MX6Quad} + \li \l{http://boundarydevices.com/products/sabre-lite-imx6-sbc/} + {BD-SL-i.MX6} + \li \l{http://www.toradex.com/products/apalis-arm-computer-modules/freescale-imx-6-computer-module} + {Toradex Apalis iMX6} + \li \l{http://www.raspberrypi.org/faqs} + {Raspberry Pi Model B} + \endlist + + \section2 Legacy Reference Devices + + The following devices are no longer tested or supported by the latest + release of \SDK. + + \list + \li \l{http://beagleboard.org/hardware-xM} + {BeagleBoard-xM} + \list + \li Starting from \SDK 3.0 release, BeagleBoard-xM is no longer + tested and supported. It is, however, still tested and supported + in the earlier 2.x releases. + \endlist + \endlist + + \section1 Supported Development Environment + + The development environment supported by \SDK is Ubuntu Linux 64-bit (12.04 LTS or later). + + \sa {Requirements for Development Host} + +*/ 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 + sudo Boot2Qt-3.x/apalis-imx6-eLinux/images/deploy.sh /dev/ + \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