diff options
Diffstat (limited to 'src/doc/src')
-rw-r--r-- | src/doc/src/devices/qtee-drive-cx.qdoc | 65 | ||||
-rw-r--r-- | src/doc/src/devices/qtee-intel-nuc.qdoc | 75 | ||||
-rw-r--r-- | src/doc/src/qtee-build-emulator.qdoc | 207 |
3 files changed, 347 insertions, 0 deletions
diff --git a/src/doc/src/devices/qtee-drive-cx.qdoc b/src/doc/src/devices/qtee-drive-cx.qdoc new file mode 100644 index 0000000..439d2a4 --- /dev/null +++ b/src/doc/src/devices/qtee-drive-cx.qdoc @@ -0,0 +1,65 @@ +/**************************************************************************** +** +** 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-preparing-hardware-drivecx.html + \title NVIDIA DRIVE CX + \previouspage qtee-installation-guide.html + + Take the following steps when preparing \l {http://www.nvidia.com/object/drive-cx.html} + {NVIDIA DRIVE CX} for \B2Q: + + \note It is important that you repeat the steps in this section after you + update \QAS. + + The image containing the \B2Q stack for the device, as well as the + flashing tool are included in \QAS. + + \section1 Installing the \B2Q Image + + Connect the DRIVE CX board to the development host via USB, and set it in + \e {recovery mode} by changing the position of J9 jumper on the board. + + Then, run the flashing tool: + + \badcode + cd <INSTALL_DIR> + sudo 5.7/Automotive/tegra-t18x/flash-nvidia/flash_device.sh + \endcode + + After the installation is complete, replace the J9 jumper to its original + position, and restart the device. After reboot, check that the automotive + UI appears. + + \section1 Setting up USB Access + + \include b2qt-post-install-setup.qdocinc setting up usb access + + \section1 Configuring a Device Kit in Qt Creator + + After you have prepared the hardware, you must perform one final step + to set up the development tools in Qt Creator for your device. Run the + following command: + + \badcode + cd <INSTALL_DIR> + 5.7/Automotive/tegra-t18x/toolchain/configure-qtcreator.sh + \endcode + + 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-intel-nuc.qdoc b/src/doc/src/devices/qtee-intel-nuc.qdoc new file mode 100644 index 0000000..7213e3b --- /dev/null +++ b/src/doc/src/devices/qtee-intel-nuc.qdoc @@ -0,0 +1,75 @@ +/**************************************************************************** +** +** 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-preparing-hardware-nuc.html + \title Intel NUC + \previouspage qtee-installation-guide.html + + Take the following steps when preparing an + \l {http://www.intel.com/content/www/us/en/nuc/overview.html}{Intel NUC} + 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 the device are included + in \SDK. In these instructions, we prepare a USB device (a flash drive + or an external USB hard drive) to boot from. + + \section1 Preparing a USB Boot Device + + For \B2Q, a USB drive of at least 2 GB capacity is needed. + + \include detect-sd-card-device-name.qdocinc instructions-usbdevice + + \section1 Installing the \B2Q Image + + \include common.qdocinc wizard + + Install the \B2Q image onto the USB device. First, ensure that no + partitions are mounted: + + \include detect-sd-card-device-name.qdocinc unmount + + Then, use the following command to install the image: + + \badcode + cd <INSTALL_DIR> + sudo dd bs=4k if=5.7/Automotive/intel-corei7-64/images/b2qt-embedded-qt5-image-intel-corei7-64.img of=/dev/<device_name> + \endcode + + After the installation is complete, connect the USB drive to the device, + power it on, and enter the BIOS setup (\b F2). Follow the instructions on + \l {http://www.intel.com/content/www/us/en/support/boards-and-kits/000005471.html} + {Operating System Installation for IntelĀ® NUC} for how to select the + USB drive as a boot device. + + Press \b F10 to save your changes and exit BIOS setup. After reboot, 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 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/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 +*/ |