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