summaryrefslogtreecommitdiffstats
path: root/src/doc/src
diff options
context:
space:
mode:
authorSamuli Piippo <samuli.piippo@qt.io>2016-06-07 16:18:03 +0300
committerSamuli Piippo <samuli.piippo@qt.io>2016-06-07 16:18:08 +0300
commitdee9f0867ad66cb3a9848f2391ba450aa6f65f25 (patch)
treedced1c5dbcb7b9886c7bcdcb1ba03f63569da913 /src/doc/src
parentd911547fa765cfccbdc2e5389e795681ee7c9c3a (diff)
parent62095d715fb2149b73264b66660f9b7451721549 (diff)
Merge remote-tracking branch 'origin/dev' into 5.7
* origin/dev: Add support for Raspberry Pi 3 doc: Add emulator build instructions Change-Id: I4d294cb1246700ef9948032734770ced5a805389
Diffstat (limited to 'src/doc/src')
-rw-r--r--src/doc/src/devices/qtee-raspberry-pi.qdoc12
-rw-r--r--src/doc/src/devices/qtee-supported-devices.qdoc16
-rw-r--r--src/doc/src/qtee-build-emulator.qdoc207
-rw-r--r--src/doc/src/qtee-changelog.qdoc13
-rw-r--r--src/doc/src/qtee-custom-embedded-linux.qdoc3
-rw-r--r--src/doc/src/qtee-index.qdoc3
-rw-r--r--src/doc/src/qtee-static-linking.qdoc2
7 files changed, 241 insertions, 15 deletions
diff --git a/src/doc/src/devices/qtee-raspberry-pi.qdoc b/src/doc/src/devices/qtee-raspberry-pi.qdoc
index 9e58089..d634be2 100644
--- a/src/doc/src/devices/qtee-raspberry-pi.qdoc
+++ b/src/doc/src/devices/qtee-raspberry-pi.qdoc
@@ -17,19 +17,19 @@
**
****************************************************************************/
/*!
- \keyword Raspberry Pi 2 Model B
+ \keyword Raspberry Pi 3 Model B
\page qtee-preparing-hardware-rasberrypi.html
- \title Preparing Raspberry Pi 2
+ \title Preparing Raspberry Pi 3
\previouspage qtee-installation-guide.html
\nextpage qtee-building-and-running.html
- Take the following steps to prepare a \l{https://www.raspberrypi.org/products/raspberry-pi-2-model-b/}
- {Raspberry Pi 2} for \B2Q.
+ Take the following steps to prepare a \l{https://www.raspberrypi.org/products/raspberry-pi-3-model-b/}
+ {Raspberry Pi 3} for \B2Q.
\note It is important that you repeat the steps in this section after you
update \SDK.
- The image containing \B2Q stack for Raspberry Pi 2 is included in the SDK,
+ The image containing \B2Q stack for Raspberry Pi 3 is included in the SDK,
ready to be copied to an SD card.
\section1 Preparing an SD Card
@@ -51,7 +51,7 @@
\badcode
cd <INSTALL_DIR>
- sudo dd bs=4k if=5.6/Boot2Qt/raspberrypi2/images/b2qt-embedded-qt5-image-raspberrypi2.img of=/dev/<device_name>
+ sudo dd bs=4k if=5.7/Boot2Qt/raspberrypi3/images/b2qt-embedded-qt5-image-raspberrypi3.img of=/dev/<device_name>
\endcode
After the image has been deployed, insert the SD card, power on the device and check that
diff --git a/src/doc/src/devices/qtee-supported-devices.qdoc b/src/doc/src/devices/qtee-supported-devices.qdoc
index b78449e..2d730c8 100644
--- a/src/doc/src/devices/qtee-supported-devices.qdoc
+++ b/src/doc/src/devices/qtee-supported-devices.qdoc
@@ -36,7 +36,7 @@
\li \l{ArchiTech Tibidabo}
\li \l{Kontron SMARC-sAMX6i}
\li \l{BeagleBone Black}
- \li \l{Raspberry Pi 2 Model B}
+ \li \l{Raspberry Pi 3 Model B}
\endlist
If you use only the emulator, you can skip this step
@@ -155,10 +155,10 @@
{Kontron SMARC-sAMX6i}\br
Freescale® i.MX 6 ARM Cortex™-A9 @800MHz - 1.2GHz,\br
2GB DDR3, 2-64GB eMMC, Vivante GC2000 GPU
- \row \li \l{https://www.raspberrypi.org/products/raspberry-pi-2-model-b/}
- {Raspberry Pi 2 Model B}\br
- 900 Mhz ARM Cortex™-A7, Broadcom VideoCore IV\br
- @250MHz GPU, 1GB LPDDR2 SDRAM
+ \row \li \l{https://www.raspberrypi.org/products/raspberry-pi-3-model-b/}
+ {Raspberry Pi 3 Model B}\br
+ 1.2 Ghz ARM Cortex™-A53, Broadcom VideoCore IV\br
+ @400MHz GPU, 1GB LPDDR2 SDRAM
\endtable
\section2 Group 3
@@ -190,6 +190,10 @@
{Raspberry Pi Model B}\br
700 Mhz ARM11, Broadcom VideoCore IV\br
@250MHz GPU, 512 MB (shared with GPU) RAM
+ \row \li \l{https://www.raspberrypi.org/products/raspberry-pi-2-model-b/}
+ {Raspberry Pi 2 Model B}\br
+ 900 Mhz ARM Cortex™-A7, Broadcom VideoCore IV\br
+ @250MHz GPU, 1GB LPDDR2 SDRAM
\endtable
\section2 Supported Features on Reference Devices
@@ -300,7 +304,7 @@
\li \image ok
\li \image ok
\li
- \row \li Raspberry Pi 2
+ \row \li Raspberry Pi 3
\li \image ok
\li \image ok
\li
diff --git a/src/doc/src/qtee-build-emulator.qdoc b/src/doc/src/qtee-build-emulator.qdoc
new file mode 100644
index 0000000..f87354d
--- /dev/null
+++ b/src/doc/src/qtee-build-emulator.qdoc
@@ -0,0 +1,207 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** All rights reserved.
+** For any questions to The Qt Company, please use the contact form at
+** http://www.qt.io/contact-us
+**
+** This file is part of Qt for Device Creation.
+**
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+****************************************************************************/
+
+/*!
+ \page qtee-build-emulator.html
+ \title Building the Emulator from Sources
+ \previouspage qtee-static-linking.html
+ \nextpage qtee-changelog.html
+
+ To build the emulator from source, you need to build the emulator host part
+ and an emulator device image for a VirtualBox virtual machine.
+
+ \section1 Building Emulator Host Part from Sources
+
+ To build the emulator host part from sources:
+
+ \list 1
+ \li Create a directory for the emulator parts:
+
+ \badcode
+ mkdir emulator
+ cd emulator
+ \endcode
+
+ \li Clone the emulator repositories:
+
+ \badcode
+ git clone ssh://codereview.qt-project.org/tqtc-boot2qt/emulator-scripts.git scripts
+ git clone ssh://codereview.qt-project.org/tqtc-boot2qt/emulator emulator
+ cd emulator
+ git submodule update --init
+ cd ..
+ \endcode
+
+ \li Create a build directory for a shadow build:
+
+ \badcode
+ mkdir build
+ cd build
+ \endcode
+
+ \li Build the QtSystems module:
+
+ \badcode
+ mkdir qtsystems
+ pushd qtsystems
+ qmake "${EMULATOR_SOURCE_DIR}"/src/qtsystems
+ make
+ make install
+ popd
+ \endcode
+
+ \li Build the QtSimulator module:
+
+ \badcode
+ mkdir simulator
+ pushd simulator
+ qmake "${EMULATOR_SOURCE_DIR}"/src/qtsimulator
+ make
+ make install
+ popd
+ \endcode
+
+ \li Build the QtGlesStream component:
+
+ \badcode
+ mkdir qtglesstream
+ pushd qtglesstream
+ qmake "${EMULATOR_SOURCE_DIR}"/src/qtglesstream
+ make
+ make install
+ popd
+ \endcode
+
+ \li Build the emulator:
+
+ \badcode
+ mkdir emulator
+ pushd emulator
+ EMULATOR_INSTALL_DIR=../install/
+ qmake "${EMULATOR_SOURCE_DIR}" PREFIX="${EMULATOR_INSTALL_DIR}"
+ make
+ make install
+ popd
+ \endcode
+
+ \endlist
+
+ \section1 Building Emulator Device Image for VirtualBox VM
+
+ To build the emulator device image for a VirtualBox VM:
+
+ \list 1
+ \li Make sure that your Qt library is built with GLES support and
+ defaults to eglfs.
+ \li Make sure that the virtual machine is reachable with the IP address
+ \c 192.168.56.101.
+ \li Create a shared folder on the virtual machine and mount it to
+ \c /var/vqvideo by using the \c vboxsf kernel module and a mount
+ tool for the folder. You can get these from the VirtualBox addons
+ provided by Oracle or compile them yourself from the VirtualBox
+ sources.
+
+ \badcode
+ mkdir -p /var/vqvideo
+ mount.vboxsf vqvideo /var/vqvideo
+ \endcode
+
+ \li Set up \c appcontroller, as instructed in
+ \l{Setting Up appcontroller}.
+ \li Build the \c emulatorproxy daemon that is located in the emulator
+ sources in the \c src/helperlibs/proxy directory:
+
+ \badcode
+ cd "${EMULATOR_SOURCE_DIR}"/src/helperlibs/proxy
+ sdk-qmake && make
+ \endcode
+
+ \li Start the \c emulatorproxy daemon on the device to enable the
+ emulator to perform several tasks on the running machine. The daemon
+ will fork itself.
+ \li Clone the QtSimulator module from
+ \c ssh://codereview.qt-project.org/tqtc-boot2qt/qtsimulator, and
+ then build and deploy it on the device as any Qt module:
+
+ \badcode
+ git clone ssh://codereview.qt-project.org:29418/tqtc-boot2qt/qtsimulator
+ cd qtsimulator
+ sdk-qmake && make && make install
+ \endcode
+
+ \li Clone the QtGlesStream module from
+ \c ssh://codereview.qt-project.org/qt/tqtc-qtglesstream, and then
+ build and deploy it on the device:
+
+ \badcode
+ git clone ssh://codereview.qt-project.org:29418/qt/tqtc-qtglesstream
+ tqtc-qtglesstream
+ sdk-qmake && make && make install
+ \endcode
+
+ \li To enable handling touch and keyboard input, build the emulator
+ specific input plugin from the emulator sources in the
+ \c src/helperlibs/vinput directory using qmake and deploy it to the
+ Qt input plugin folder on the device:
+
+ \badcode
+ cd "${EMULATOR_SOURCE_DIR}"/src/helperlibs/vinput
+ sdk-qmake && make && make install
+ \endcode
+
+ \endlist
+
+ \section2 Setting Up appcontroller
+
+ To set up \c appcontroller:
+
+ \list 1
+ \li Clone the \c appcontroller sources from
+ \c git://codereview.qt-project.org/tqtc-boot2qt/appcontroller.
+ \li Build \c appcontroller using qmake and make.
+ \li Set \c appcontroller in the PATH.
+ \li Create a configuration file for \c appcontroller to configure device
+ specific variables for your application.
+ \endlist
+
+ An example \c /etc/appcontroller.conf configuration file looks like this:
+
+ \badcode
+ env=QT_QPA_GENERIC_PLUGINS=simulator
+ env=QT_QPA_EGLFS_HIDECURSOR=1
+ env=QML2_IMPORT_PATH=/data/user/qt/qmlplugins
+ env=QT_IM_MODULE=qtvirtualkeyboard
+ env=QTGLESSTREAM_DISPLAY=192.168.56.1
+ env=QT_QUICK_CONTROLS_STYLE=Flat
+ base=linux
+ platform=emulator
+ \endcode
+
+ \table
+ \row
+ \li \c base
+ \li Has to be \c linux
+ \row
+ \li \c platform
+ \li Has to be \c emulator
+ \row
+ \li \c env
+ \li All these variables will be added to the environment before
+ starting the application.
+ \endtable
+*/
diff --git a/src/doc/src/qtee-changelog.qdoc b/src/doc/src/qtee-changelog.qdoc
index 5e96d45..0768c63 100644
--- a/src/doc/src/qtee-changelog.qdoc
+++ b/src/doc/src/qtee-changelog.qdoc
@@ -20,9 +20,20 @@
/*!
\page qtee-changelog.html
\title ChangeLog
- \previouspage qtee-customization.html
+ \previouspage qtee-build-emulator.html
\nextpage qtee-troubleshooting.html
+ \section1 Boot to Qt 5.7
+ \list
+ \li Release date: April 6, 2016
+ \endlist
+
+ \b{New Features}:
+ \list
+ \li \B2Q stack was updated to use Qt 5.7
+ \li New reference device: Raspberry Pi 3
+ \endlist
+
\section1 Boot to Qt 5.6.0
\b{New Features}:
diff --git a/src/doc/src/qtee-custom-embedded-linux.qdoc b/src/doc/src/qtee-custom-embedded-linux.qdoc
index c08c7ed..d0436d6 100644
--- a/src/doc/src/qtee-custom-embedded-linux.qdoc
+++ b/src/doc/src/qtee-custom-embedded-linux.qdoc
@@ -109,6 +109,9 @@
\li Raspberry Pi 2
\li raspberrypi2
\row
+ \li Raspberry Pi 3
+ \li raspberrypi3
+ \row
\li BeagleBone Black
\li beaglebone
\row
diff --git a/src/doc/src/qtee-index.qdoc b/src/doc/src/qtee-index.qdoc
index 02403f1..cfb5e07 100644
--- a/src/doc/src/qtee-index.qdoc
+++ b/src/doc/src/qtee-index.qdoc
@@ -52,7 +52,7 @@
\li \l{Preparing ArchiTech Tibidabo}{ArchiTech Tibidabo}
\li \l{Preparing Kontron SMARC-sAMX6i}{Kontron SMARC-sAMX6i}
\li \l{Preparing BeagleBone Black}{BeagleBone Black}
- \li \l{Preparing Raspberry Pi 2}{Raspberry Pi 2 Model B}
+ \li \l{Preparing Raspberry Pi 3}{Raspberry Pi 3 Model B}
\endlist
\li \l{Building and Running Embedded Applications}
\list
@@ -63,6 +63,7 @@
\list
\li \l{Linking to Static Builds of Qt}
\endlist
+ \li \l{Building the Emulator from Sources}
\li \l{ChangeLog}
\li \l{Troubleshooting}
\li \l{Known Issues}
diff --git a/src/doc/src/qtee-static-linking.qdoc b/src/doc/src/qtee-static-linking.qdoc
index 4014dbc..4357784 100644
--- a/src/doc/src/qtee-static-linking.qdoc
+++ b/src/doc/src/qtee-static-linking.qdoc
@@ -20,7 +20,7 @@
\page qtee-static-linking.html
\title Linking to Static Builds of Qt
\previouspage qtee-custom-embedded-linux-image.html
- \nextpage qtee-changelog.html
+ \nextpage qtee-build-emulator.html
The device-specific sysroots in \B2Q come with a dynamically linked version
of Qt libraries (\c *.so files). In some cases, using static linking may be