Qt5 now avairable in agl-demo-platfrom.
[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 Top-level packagegroup,
58 > packagegroup-agl-appfw (all packages for demo platform)
59
60 This package group can contain sub-package groups like these.
61 > packagegroup-agl-appfw-graphics (for graphics subsystem)
62 > packagegroup-agl-appfw-agl (for AGL App Fw subystem)
63 > ...
64
65 The "packagegroups-agl-appfw-*" will contain packages for application and
66 frameworks.
67 > directory: meta-agl-demo/recipes-demo-platform/packagegroups
68 > recipes  : packagegroup-agl-appfw-[subsystem].bb
69
70 Supported Machine
71 -----------------
72
73 * QEMU (x86-64) - emulated machine: qemux86-64
74 * Renesas R-Car Gen2 (R-Car M2) - machine: porter
75
76 Supported Target of bitbake
77 ------------------------
78
79 * `agl-demo-platform` The full image of AGL Demo Platform and applications
80
81 Supposed Directory Trees of Layers to build
82 -------------------------------------------
83
84 * For QEMU
85
86       ${TOPDIR}/
87                 meta-agl/
88                 meta-agl-demo/
89                 meta-openembedded/
90                 meta-qt5/
91                 poky/
92
93 * For R-Car M2
94
95       ${TOPDIR}/
96                 meta-agl/
97                 meta-agl-demo/
98                 meta-openembedded/
99                 meta-qt5/
100                 meta-renesas/
101                 poky/
102
103 Build a QEMU image
104 ------------------
105
106 You can build a QEMU image using the following steps:
107
108 1. Export TEMPLATECONF to pick up correct configuration for the build
109         $ export TEMPLATECONF=/full/path/to/meta-agl-demo/conf
110
111 2. Run the following command:
112         $ source poky/oe-init-build-env
113
114 3. Build the full image of AGL Demo Platform and applications
115         $ bitbake agl-demo-platform
116
117 4. Run the emulator
118         $ cd $BUILD_DIR/tmp/deploy/images/qemex86-64
119         $ PATH_TO_POKY/poky/scripts/runqemu qemux86-64 bzImage-qemux86-64.bin \
120         agl-demo-platform-qemux86-64.ext3
121
122    For large screen:
123         $ PATH_TO_POKY/poky/scripts/runqemu qemux86-64 bzImage-qemux86-64.bin \
124         agl-demo-platform-qemux86-64.ext3 \
125         bootparams="uvesafb.mode_option=1280x720-32"
126
127 5. Some weston samples are available from weston terminal.
128
129 Build a R-Car M2 (porter) image
130 -------------------------------
131
132 ### Software setup
133
134 NOTE: These instructions are based on GENIVI wiki, [here](http://wiki.projects.genivi.org/index.php/Hardware_Setup_and_Software_Installation/koelsch%26porter). If these didn't work correctly especially around Renesas Binary Packages, please check there and updated instructions.
135
136 #### Getting Source Code and Build image
137
138 1. Create a directory for working, then go to there.
139         $ mkdir -p $HOME/ANYWHERE_YOU_WANT_TO_WORK_THERE
140         $ cd $HOME/ANYWHERE_YOU_WANT_TO_WORK_THERE
141         $ export AGL_TOP=`pwd`
142
143 2. Get the meta data and checkout
144         $ git clone git://git.yoctoproject.org/poky
145         $ cd poky
146         $ git checkout df87cb27efeaea1455f20692f9f1397c6fcab254
147         $ cd -
148         $ git clone git://git.openembedded.org/meta-openembedded
149         $ cd meta-openembedded
150         $ git checkout 9efaed99125b1c4324663d9a1b2d3319c74e7278
151         $ cd -
152         $ git clone https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl
153         $ cd meta-agl
154         $ git checkout 4d71b6fbe454ff51342ab1eb6791fad66ba98c3e
155         $ cd -
156         $ git clone https://github.com/meta-qt5/meta-qt5.git
157         $ cd meta-qt5
158         $ git checkout adeca0db212d61a933d7952ad44ea1064cfca747
159         $ cd -
160         $ git clone https://gerrit.automotivelinux.org/gerrit/AGL/meta-renesas
161         $ cd meta-renesas
162         $ git checkout bf30de66badcac7ef82d3758aa44c116ee791a28
163         $ cd -
164         $ git clone https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl-demo
165
166 #### Obtain and Install Renesas Graphics/Multimedia Drivers
167
168 1. Download packages from Renesas
169
170   The graphics and multimedia acceleration packages for the R-Car M2 Porter board
171   can be download directory from [here](http://www.renesas.com/secret/r_car_download/rcar_demoboard.jsp).
172
173   There are 2 ZIP files can be downloaded.
174     * Multimedia and Graphics library which require registeration and click through license
175     > r-car_series_evaluation_software_package_for_linux-*.zip
176     * Related Linux drivers
177     > r-car_series_evaluation_software_package_of_linux_drivers-*.zip
178
179 2. Unzip the two downloads into a temporary directory.
180         $ cd $AGL_TOP
181         $ mkdir binary-tmp
182         $ cd binary-tmp
183         $ unzip PATH_TO_DOWNLOAD/r-car_series_evaluation_software_package_for_linux-*.zip
184         $ unzip PATH_TO_DOWNLOAD/r-car_series_evaluation_software_package_of_linux_drivers-*.zip
185
186    After this step there should be two files in binary-tmp:
187    * Multimedia and Graphics library
188    > R-Car_Series_Evaluation_Software_Package_for_Linux-*.tar.gz
189    * Related Linux drivers
190    > R-Car_Series_Evaluation_Software_Package_of_Linux_Drivers-*.tar.gz
191
192 3. Copy the graphics acceleration drivers by shell script.
193         $ cd $AGL_TOP/meta-renesas/meta-rcar-gen2
194         $ ./copy_gfx_software_porter.sh ../../binary-tmp
195
196 4. Copy the multimedia acceleration drivers by shell script.
197         $ cd $AGL_TOP/meta-renesas/meta-rcar-gen2
198         $ ./copy_mm_software_lcb.sh ../../binary-tmp
199
200 #### Build from the Source code
201
202 You can build a R-Car2 M2 (porter) image using the following steps:
203
204 1. Export TEMPLATECONF to pick up correct configuration for the build
205         $ export TEMPLATECONF=$AGL_TOP/meta-renesas/meta-rcar-gen2/conf
206
207 2. Run the following command:
208         $ cd $AGL_TOP
209         $ source poky/oe-init-build-env
210
211    (Optional) If you want to use multimedia accelerations, confirm your
212    conf/bblayer.conf has a entry of `meta-openembedded/meta-multimedia`
213    in BBLAYERS because packagegroup-rcar-gen2-multimedia needs some extra
214    packages there.
215
216 3. Add 2 layers to bblayer.conf,
217    > meta-openembedded/meta-ruby
218    > meta-qt5
219
220    So it looks something like,
221         BBLAYERS ?= " \
222         ##OEROOT##/meta \
223         ##OEROOT##/meta-yocto \
224         ##OEROOT##/meta-yocto-bsp \
225         ##OEROOT##/../meta-agl/meta-ivi-common \
226         ##OEROOT##/../meta-agl/meta-agl \
227         ##OEROOT##/../meta-openembedded/meta-oe \
228         ##OEROOT##/../meta-openembedded/meta-multimedia \
229         ##OEROOT##/../meta-openembedded/meta-ruby \
230         ##OEROOT##/../meta-qt5 \
231         ##OEROOT##/../meta-renesas \
232         ##OEROOT##/../meta-renesas/meta-rcar-gen2 \
233         ##OEROOT##/../meta-agl-demo \
234         "
235
236 4. (Optional) If you want to install various Qt5 examples, add below
237    configuration to your local.conf.
238         IMAGE_INSTALL_append = " \
239             packagegroup-agl-demo-qt-examples \
240         "
241         PACKAGECONFIG_append_pn-qtbase = " examples"
242
243    IMPORTANT NOTE:
244         To run examples with wayland-egl plugin,
245         use ``LD_PRELOAD=/usr/lib/libEGL.so <command>``.
246         If not, programs should not launch by error,
247         'EGL not available'.
248
249 5. (Optional) If you want to use multimedia accelerations, uncomment
250    manually 4 `IMAGE_INSTALL_append_porter` in conf/local.conf.
251         #IMAGE_INSTALL_append_porter = " \
252         #    gstreamer1.0-plugins-bad-waylandsink \
253         #    "
254
255         #IMAGE_INSTALL_append_porter = " \
256         #    gstreamer1.0-plugins-base-videorate \
257         ...
258         #"
259
260         #IMAGE_INSTALL_append_porter = " \
261         #    libegl libegl-dev libgbm-dev \
262         ...
263         #    "
264
265         #IMAGE_INSTALL_append_porter = " \
266         #    packagegroup-rcar-gen2-multimedia \
267         ...
268         #    "
269
270    Also it is needed to uncomment this,
271         #MACHINE_FEATURES_append = " multimedia"
272
273    This `multimedia` enables meta-renesas's multimedia configuration.
274    The version of GStreamer1.0 which AGL distro use, will be changed
275    to 1.2.3 (meta-renesas prefers) from 1.4.1(meta-agl default) by this switch.
276
277 6. Build the full image of AGL Demo Platform and applications
278         $ bitbake agl-demo-platform
279
280 ### Deployment (SDCARD)
281
282 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).
283
284 #### Instructions on the host
285
286 1. Format SD-Card and then, create single EXT3 partition on it.
287
288 2. Mount the SD-Card, for example `/media/$SDCARD_LABEL`.
289
290 3. Copy AGL root file system onto the SD-Card
291    1. Go to build directory
292            $ cd $AGL_TOP/build/tmp/deploy/images/porter
293    2. Extract the root file system into the SD-Card
294            $ sudo tar --extract --numeric-owner --preserve-permissions --preserve-order \
295            --totals --directory=/media/$SDCARD_LABEL --file=agl-demo-platform-porter.tar.bz2
296    3. Copy kernel and DTB into the `/boot` of the SD-Card
297            $ sudo cp uImage uImage-r8a7791-porter.dtb /media/$SDCARD_LABEL/boot
298
299 4. After the copy finished, unmount SD-Card and insert it into the SD-Card slot of the porter board.
300
301 #### Instructions on the host
302
303 NOTE: There is details about porter board [here](http://elinux.org/R-Car/Boards/Porter).
304
305 NOTE: To boot weston on porter board, we need keyboard and mouse. (USB2.0 can be use for this)
306
307 ##### Change U-Boot parameters to boot from SD card
308
309 1. Power up the board and, using your preferred terminal emulator, stop the board's autoboot by hitting any key.
310
311   > Debug serial settings are 38400 8N1. Any standard terminal emulator program can be used.
312
313 2. Set the follow environment variables and save them
314         => setenv bootargs_console console=ttySC6,${baudrate}
315         => setenv bootargs_video vmalloc=384M video=HDMI-A-1:1024x768-32@60
316         => setenv bootcmd_sd 'ext4load mmc 0:1 0x40007fc0 boot/uImage;ext4load mmc 0:1 0x40f00000 boot/uImage-r8a7791-porter.dtb'
317         => setenv bootcmd 'setenv bootargs ${bootargs_console} ${bootargs_video} root=/dev/mmcblk0p1 rw rootfstype=ext3;run bootcmd_sd;bootm 0x40007fc0 - 0x40f00000'
318         => saveenv
319
320 ##### Boot from SD card
321
322 1. After board reset, U-Boot is started and after a countdown, ...
323    Linux boot message should be displayed. Please wait a moment.
324 2. Then weston is booted automatically, and weston-terminal appears.
325
326 3. Have fun! :)
327
328 4. (Optional) This is how to test and play multimedia contents with acceleration.
329
330     1. Boot porter without mouse and keyboard, it avoid to boot weston automatically.
331        For now, when running weston, V4L2 deosn't work correctly, so we have to
332        stop weston first (GST plugin `waylandsink` also doesn't work correctly for now).
333
334     2. Execute these instructions:
335             $ export LD_LIBRARY_PATH="/lib:/usr/lib:/usr/local/lib:"
336
337             # Set the mixer
338             $ amixer set "LINEOUT Mixer DACL" on
339             $ amixer set "DVC Out" 10
340
341             $ modprobe -a mmngr mmngrbuf s3ctl uvcs_cmn vspm fdpm
342
343             $ media-ctl -d /dev/media0 -r
344             $ media-ctl -d /dev/media0 -l '"vsp1.2 rpf.0":1 -> "vsp1.2 uds.0":0 [1]'
345             $ media-ctl -d /dev/media0 -l '"vsp1.2 uds.0":1 -> "vsp1.2 wpf.0":0 [1]'
346             $ media-ctl -d /dev/media0 -l '"vsp1.2 wpf.0":1 -> "vsp1.2 lif":0 [1]'
347             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":0 [fmt:AYUV32/1920x1080]'
348             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":1 [fmt:AYUV32/1920x1080]'
349             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":0 [fmt:AYUV32/1920x1080]'
350             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":1 [fmt:AYUV32/640x480]'
351             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":0 [fmt:AYUV32/640x480]'
352             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":1 [fmt:ARGB32/640x480]'
353             $ media-ctl -d /dev/media0 -V '"vsp1.2 lif":0 [fmt:ARGB32/640x480]'
354
355             # in caes R-Car M2 (HDMI - DU1 - vspd0)
356             $ modetest -M rcar-du -s 10@8:1280x720@AR24 -d -P '8@19:640x480+100+200@XR24' &
357
358     After these command, Test pattern will show on display connected to
359     porter's HDMI port.
360
361     Then, you can play H264(MP4) movie like these,
362             $ gst-launch-1.0 filesrc location=./sample.mp4  ! qtdemux name=d d. ! \
363             queue ! omxh264dec no-copy=true ! v4l2sink device=/dev/video1 \
364             io-mode=userptr d. ! queue ! faad ! alsasink device=hw:0,0
365