packagegroup-agl-demo-platform: Fix waltham-remoting feature
[AGL/meta-agl-demo.git] / README.md
1 meta-agl-demo, the Yocto layer for DEMO platform of Automotive Grade Linux
2 ==========================================================================
3
4 The yocto layer 'meta-agl-demo' provides a demo platform and applications
5 of AGL Distribution.
6
7 AGL is creating an automotive specific Linux distribution that unifies
8 the software that has been written in a number of places already,
9 such as GENIVI and Tizen IVI.
10
11 The AGL community appreciates feedback, ideas, suggestion, bugs and
12 documentation just as much as code. Please join the irc conversation
13 at the #automotive channel on irc.freenode.net and our mailing list.
14
15 For infomation for subscribing to the mailing list
16     [automotive-discussions](http://lists.linuxfoundation.org/mailman/listinfo/automotive-discussions)
17 For information about AGL Distribution, see the
18     [AGL Distribution](https://wiki.automotivelinux.org/agl-distro)
19 For information abount Getting started with AGL
20     [here](https://wiki.automotivelinux.org/start/getting-started)
21 For information about contributing to the AGL Distro
22     [here](https://wiki.automotivelinux.org/agl-distro/contributing)
23
24 Layer Dependencies
25 ------------------
26
27 URI: git://git.yoctoproject.org/poky
28 > branch:   dizzy
29 > revision: df87cb27efeaea1455f20692f9f1397c6fcab254
30
31 URI: git://git.openembedded.org/meta-openembedded
32 > layer:    meta-oe
33 > branch:   dizzy
34 > revision: 9efaed99125b1c4324663d9a1b2d3319c74e7278
35
36 URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl
37 > branch:   master
38 > revision: 4d71b6fbe454ff51342ab1eb6791fad66ba98c3e
39 > (or later)
40
41 URI: https://github.com/meta-qt5/meta-qt5.git
42 > branch:   dizzy
43 > revision: adeca0db212d61a933d7952ad44ea1064cfca747
44
45 ## The Renesas R-Car Gen2 (Porter) board depends in addition on: ##
46
47 URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-renesas
48 > branch:   agl-1.0-bsp-1.8.0
49 > revision: bf30de66badcac7ef82d3758aa44c116ee791a28
50 > (or later)
51
52 Packagegroups
53 -------------
54
55 AGL Demo Platform's package group design:
56
57 * packagegroup-agl-demo-platform
58
59 This is for making image 'agl-demo-platform' which is full image
60 for IVI profile of AGL distro.
61
62 As meta-agl's design of packagegroups, ``agl-demo-platform.bb`` contains
63 only ``packagegroup-agl-demo-platform`` and packages of DEMO apps.
64
65 ``packagegroup-agl-demo-platform`` has 4 packagegroups in it,
66 ``packagegroup-agl-core``, ``packagegroup-agl-ivi``,
67 ``packagegroup-agl-ivi-common-core``, and ``packagegroup-agl-appfw``.
68
69 * packagegroup-agl-appfw*
70
71 These packagegroups contains packages for application framework of AGL Distro.
72 Subsystem should maintain ``packagegroup-agl-appfw-[subsystem].bb`` which
73 should hold sufficient packages for application framework of AGL Distro.
74
75 Subsystems also can maintain thier own packagegroups under appropriate
76 ``recipes-*/``.
77
78 For example, Qt5 has 2 packagegroups in ``meta-agl-demo``,
79 ``packagegroup-agl-appfw-native-qt5`` and ``pacakgegroup-agl-demo-qt-examples``
80 which are under ``recipes-qt/``.
81
82 The ``packagegroup-agl-appfw-native-qt5`` is included by
83 ``pacakgegroup-agl-appfw-native`` because Qt5 belongs to native application
84 framework of AGL Distro.
85
86 The ``pacakgegroup-agl-demo-qt-examples`` is added to local.conf if needed
87 because they are not mandatory for AGL application framework and AGL Demo
88 Platform.
89
90 Supported Machine
91 -----------------
92
93 * QEMU (x86-64) - emulated machine: qemux86-64
94 * Renesas R-Car Gen2 (R-Car M2) - machine: porter
95
96 Supported Target of bitbake
97 ------------------------
98
99 * `agl-demo-platform` The full image of AGL Demo Platform and applications
100
101 Supposed Directory Trees of Layers to build
102 -------------------------------------------
103
104 * For QEMU
105
106       ${TOPDIR}/
107                 meta-agl/
108                 meta-agl-demo/
109                 meta-openembedded/
110                 meta-qt5/
111                 poky/
112
113 * For R-Car M2
114
115       ${TOPDIR}/
116                 meta-agl/
117                 meta-agl-demo/
118                 meta-openembedded/
119                 meta-qt5/
120                 meta-renesas/
121                 poky/
122
123 Downloading the Source
124 --------------------
125 You can use repo tool to get all layers which are needed to build AGL Distribution.
126
127 1. Installing Repo. Make sure you have a bin/ in your $HOME and it's included in your $PATH.
128         $ mkdir ~/bin
129         $ export PATH=~/bin:$PATH
130
131    Download the repo tool.
132         $ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
133         $ chmod a+x ~/bin/repo
134
135 2. Preparing download. Create an empty directory to hold all recipes and build environment. You can make it as any name you like.
136         $ mkdir WORKING-DIRECTORY
137         $ cd WORKING-DIRECTORY
138
139 3. Getting all layers.
140         $ repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
141         $ repo sync
142
143 Build a QEMU image
144 ------------------
145
146 You can build a QEMU image using the following steps:
147
148 1. Set up environment: You can specify any name for directory which storing all stuffs to build.
149         $ source meta-agl/scripts/envsetup.sh qemux86-64 [BUILD_DIR]
150
151 2. Build the full image of AGL Demo Platform and applications
152         $ bitbake agl-demo-platform
153
154 3. Run the emulator. The path for the emulator (runqemu) was added during the envsetup.
155         $ cd tmp/deploy/images/qemex86-64
156         $ runqemu bzImage-qemux86-64.bin agl-demo-platform-qemux86-64.ext3
157
158    For large screen:
159         $ runqemu bzImage-qemux86-64.bin agl-demo-platform-qemux86-64.ext3 \
160         bootparams="uvesafb.mode_option=1280x720-32"
161
162 5. Some weston samples are available from weston terminal.
163
164 Build a R-Car M2 (porter) image
165 -------------------------------
166
167 #### Obtain and Install Renesas Graphics/Multimedia Drivers
168
169 1. Download packages from Renesas
170
171   The graphics and multimedia acceleration packages for the R-Car M2 Porter board
172   can be download directory from [here](http://www.renesas.com/secret/r_car_download/rcar_demoboard.jsp).
173
174   There are 2 ZIP files can be downloaded.
175     * Multimedia and Graphics library which require registeration and click through license
176     > r-car_series_evaluation_software_package_for_linux-*.zip
177     * Related Linux drivers
178     > r-car_series_evaluation_software_package_of_linux_drivers-*.zip
179
180   These 2 files from Renesas should be store in your download directory in $HOME. (e.g. $HOME/Downloads) If not, envsetup.sh in below will stop and show some instruction, then please follow it.
181
182 #### Build from the Source code
183
184 You can build a R-Car2 M2 (porter) image using the following steps:
185
186 1. Set up environment: You can specify any name for directory which storing all stuffs to build.
187         $ source meta-agl/scripts/envsetup.sh porter [BUILD_DIR]
188
189 2. (Optional) If you want to install various Qt5 examples, add below
190    configuration to your local.conf.
191         IMAGE_INSTALL_append = " \
192             packagegroup-agl-demo-qt-examples \
193         "
194         PACKAGECONFIG_append_pn-qtbase = " examples"
195
196    IMPORTANT NOTE:
197         To run examples with wayland-egl plugin,
198         use ``LD_PRELOAD=/usr/lib/libEGL.so <command>``.
199         If not, programs should not launch by error,
200         'EGL not available'.
201
202 3. (Optional) If you want to use multimedia accelerations, uncomment
203    manually 4 `IMAGE_INSTALL_append_porter` in conf/local.conf.
204         #IMAGE_INSTALL_append_porter = " \
205         #    gstreamer1.0-plugins-bad-waylandsink \
206         #    "
207
208         #IMAGE_INSTALL_append_porter = " \
209         #    gstreamer1.0-plugins-base-videorate \
210         ...
211         #"
212
213         #IMAGE_INSTALL_append_porter = " \
214         #    libegl libegl-dev libgbm-dev \
215         ...
216         #    "
217
218         #IMAGE_INSTALL_append_porter = " \
219         #    packagegroup-rcar-gen2-multimedia \
220         ...
221         #    "
222
223    Also it is needed to uncomment this,
224         #MACHINE_FEATURES_append = " multimedia"
225
226    This `multimedia` enables meta-renesas's multimedia configuration.
227    The version of GStreamer1.0 which AGL distro use, will be changed
228    to 1.2.3 (meta-renesas prefers) from 1.4.1(meta-agl default) by this switch.
229
230 4. Build the full image of AGL Demo Platform and applications
231         $ bitbake agl-demo-platform
232
233 ### Deployment (SDCARD)
234
235 NOTE: These instructions are based on GENIVI wiki, [here](http://wiki.projects.genivi.org/index.php/Hardware_Setup_and_Software_Installation/koelsch%26porter#Deployment_.28SDCARD.29).
236
237 #### Instructions on the host
238
239 1. Format SD-Card and then, create single EXT3 partition on it.
240
241 2. Mount the SD-Card, for example `/media/$SDCARD_LABEL`.
242
243 3. Copy AGL root file system onto the SD-Card
244    1. Go to build directory
245            $ cd $AGL_TOP/build/tmp/deploy/images/porter
246    2. Extract the root file system into the SD-Card
247            $ sudo tar --extract --numeric-owner --preserve-permissions --preserve-order \
248            --totals --directory=/media/$SDCARD_LABEL --file=agl-demo-platform-porter.tar.bz2
249    3. Copy kernel and DTB into the `/boot` of the SD-Card
250            $ sudo cp uImage uImage-r8a7791-porter.dtb /media/$SDCARD_LABEL/boot
251
252 4. After the copy finished, unmount SD-Card and insert it into the SD-Card slot of the porter board.
253
254 #### Instructions on the host
255
256 NOTE: There is details about porter board [here](http://elinux.org/R-Car/Boards/Porter).
257
258 NOTE: To boot weston on porter board, we need keyboard and mouse. (USB2.0 can be use for this)
259
260 ##### Change U-Boot parameters to boot from SD card
261
262 1. Power up the board and, using your preferred terminal emulator, stop the board's autoboot by hitting any key.
263
264   > Debug serial settings are 38400 8N1. Any standard terminal emulator program can be used.
265
266 2. Set the follow environment variables and save them
267         => setenv bootargs_console console=ttySC6,${baudrate}
268         => setenv bootargs_video vmalloc=384M video=HDMI-A-1:1024x768-32@60
269         => setenv bootcmd_sd 'ext4load mmc 0:1 0x40007fc0 boot/uImage;ext4load mmc 0:1 0x40f00000 boot/uImage-r8a7791-porter.dtb'
270         => setenv bootcmd 'setenv bootargs ${bootargs_console} ${bootargs_video} root=/dev/mmcblk0p1 rw rootfstype=ext3;run bootcmd_sd;bootm 0x40007fc0 - 0x40f00000'
271         => saveenv
272
273 ##### Boot from SD card
274
275 1. After board reset, U-Boot is started and after a countdown, ...
276    Linux boot message should be displayed. Please wait a moment.
277 2. Then weston is booted automatically, and weston-terminal appears.
278
279 3. Have fun! :)
280
281 4. (Optional) This is how to test and play multimedia contents with acceleration.
282
283     1. Boot porter without mouse and keyboard, it avoid to boot weston automatically.
284        For now, when running weston, V4L2 deosn't work correctly, so we have to
285        stop weston first (GST plugin `waylandsink` also doesn't work correctly for now).
286
287     2. Execute these instructions:
288             $ export LD_LIBRARY_PATH="/lib:/usr/lib:/usr/local/lib:"
289
290             # Set the mixer
291             $ amixer set "LINEOUT Mixer DACL" on
292             $ amixer set "DVC Out" 10
293
294             $ modprobe -a mmngr mmngrbuf s3ctl uvcs_cmn vspm fdpm
295
296             $ media-ctl -d /dev/media0 -r
297             $ media-ctl -d /dev/media0 -l '"vsp1.2 rpf.0":1 -> "vsp1.2 uds.0":0 [1]'
298             $ media-ctl -d /dev/media0 -l '"vsp1.2 uds.0":1 -> "vsp1.2 wpf.0":0 [1]'
299             $ media-ctl -d /dev/media0 -l '"vsp1.2 wpf.0":1 -> "vsp1.2 lif":0 [1]'
300             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":0 [fmt:AYUV32/1920x1080]'
301             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":1 [fmt:AYUV32/1920x1080]'
302             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":0 [fmt:AYUV32/1920x1080]'
303             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":1 [fmt:AYUV32/640x480]'
304             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":0 [fmt:AYUV32/640x480]'
305             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":1 [fmt:ARGB32/640x480]'
306             $ media-ctl -d /dev/media0 -V '"vsp1.2 lif":0 [fmt:ARGB32/640x480]'
307
308             # in caes R-Car M2 (HDMI - DU1 - vspd0)
309             $ modetest -M rcar-du -s 10@8:1280x720@AR24 -d -P '8@19:640x480+100+200@XR24' &
310
311     After these command, Test pattern will show on display connected to
312     porter's HDMI port.
313
314     Then, you can play H264(MP4) movie like these,
315             $ gst-launch-1.0 filesrc location=./sample.mp4  ! qtdemux name=d d. ! \
316             queue ! omxh264dec no-copy=true ! v4l2sink device=/dev/video1 \
317             io-mode=userptr d. ! queue ! faad ! alsasink device=hw:0,0
318

©2017 Automotive Grade Linux, a Linux Foundation Collaborative Project. All Rights Reserved. Linux Foundation is a registered trademark of The Linux Foundation.
Linux is a registered trademark of Linus Torvalds.