summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qtee-install-guide.qdoc
blob: ed9a74286a442550c97bf88805a6db4970a16952 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc
** All rights reserved.
** For any questions to Digia, please use the contact form at
** http://www.qt.io
**
** 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://www.qt.io
**
****************************************************************************/

/*!
    \page qtee-installation-guide.html
    \title Installation Guide
    \previouspage qtee-overview.html
    \nextpage qtee-supported-platforms.html

    To successfully set up \SDK, you must closely follow the instructions in
    this section and perform all the described tasks.

    In case of problems, see \l{Troubleshooting}.

    \target Requirements for Development Host
    \section1 Requirements for Development Host

    Either 64-bit Linux or a Windows system is required to install and use \SDK.
    Instructions in this documentation assume Windows 7 or later or Ubuntu Linux 64-bit 12.04 LTS
    or later. Other Linux distributions may work, but have not been tested. C/C++ build
    essentials must be installed on the Linux host.

    \target Host Specific Requirements
    \section1 1. Host Specific Requirements

    \target Linux: Installing 32-bit Support Libraries
    \section2 1.1 Linux: Installing 32-bit Support Libraries

    Some of the build tools in \SDK are 32-bit programs, and on 64-bit
    systems they require support libraries for running 32-bit code. To
    install the required packages in recent versions of Ubuntu, use
    the following command in a terminal:

    \badcode
        sudo apt-get install g++-multilib zlib1g:i386
    \endcode

    For older Ubuntu versions such as 12.04, instead do:

    \badcode
        sudo apt-get install g++-multilib ia32-libs
    \endcode

    \target Windows: Installing ADB
    \section2 1.2 Windows: Installing ADB

    Qt Creator needs \e adb to communicate and deploy data to the target device.
    You can install adb as a part of the Android SDK Tools Package, which can be downloaded
    from \l{http://developer.android.com/sdk/index.html#Other}.
    Make sure to select \b {Tools} > \b {Android SDK Platform-tools} and \b {Extras} > \b {Google USB Driver}
    in the Android SDK manager (anything else is not needed and can be disabled).

    \target Installing VirtualBox
    \section1 2. Installing VirtualBox

    The \B2Q emulator in \SDK relies on VirtualBox virtualization software. You can
    download it from \l{https://www.virtualbox.org/wiki/Downloads} or
    install it via distribution tools.

    On Windows you just have to follow the installation wizard of the downloaded package.

    If you are running an older Ubuntu system such as 12.04, the version of
    VirtualBox provided by the distribution is not recent enough. To install a
    newer version, first add a foreign package source:

    \badcode
        wget -q http://download.virtualbox.org/virtualbox/debian/oracle_vbox.asc -O- | sudo apt-key add -
        echo "deb http://download.virtualbox.org/virtualbox/debian $(lsb_release -sc) contrib" | sudo tee /etc/apt/sources.list.d/virtualbox.list
        sudo apt-get update
    \endcode

    Then, install VirtualBox on your computer:
    \badcode
        sudo apt-get install virtualbox-4.3
    \endcode

    To configure VirtualBox:

    \list 1
        \li Start the VirtualBox user interface.
        \li Select \b{File > Preferences} > \b{Network} to open VirtualBox
            network settings.
        \li Create a new host-only network named \e{vboxnet0} on Linux and
            \e{VirtualBox Host-Only Ethernet Adapter} on Windows. This should be the default naming
            on those host platforms. Edit its properties:

        \list 1
            \li Change the IPv4 address to \c{192.168.56.1} and the IPv4 network
                 mask to \c{255.255.255.0}.
            \li In the \b{DCHP Server} tab, select the \b{Enable Server} check
                box.
            \li Change the server address to \c{192.168.56.1}.
            \li Change both the lower and upper address bounds to
                \c{192.168.56.101}.
        \endlist
    \endlist

    If a firewall is enabled on the development host, it needs to
    allow TCP and UDP packets between your host and the virtual
    machine.

    \section1 3. Installing \SDK

    \list 1

        \li Download the binary \SDK installer.

        \li On Linux make sure it is executable
            by using one of the following methods:

    \list
        \li Enter the \c{chmod +x <filename>} command.
        \li Right-click the file, and select \b{Properties} >
            \b{Permissions} > \b{Allow executing file as program}.
    \endlist

        \li Run the installer and follow its instructions.

    \endlist

    \note Do not execute the installer as root user or with sudo.

    The installer will let you select a directory where \SDK will be
    installed. In this documentation, the installation directory is referred
    to as \b{\c{<INSTALL_DIR>}}. The default installation directory is
    \tt{~/Qt} on Linux and \tt{C:\\Qt} on Windows.

    \target Installing Boot to Qt on Target Devices
    \section1 4. Install \B2Q on Target Devices

    \e{If you target only the emulator, you can skip this step.}

    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. The steps vary from device to device. Follow the instructions
    specific to your device in \l {Preparing Hardware}.

    \section1 5. Setting up USB Access to Embedded Devices

    \e{If you target only the emulator, you can skip this step.}

    \include b2qt-post-install-setup.qdocinc setting up usb access

    \section1 6. 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}.
*/