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 their 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 ``packagegroup-agl-demo-qt-examples``
  80 which are under ``recipes-qt/``.
  81
  82 The ``packagegroup-agl-appfw-native-qt5`` is included by
  83 ``packagegroup-agl-appfw-native`` because Qt5 belongs to native application
  84 framework of AGL Distro.
  85
  86 The ``packagegroup-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   2a. Specifically If you are building the CES2016 demos you will want to add the following to your "conf/local.conf" file to install the demo code in the image:
 155 IMAGE_INSTALL_append = " CES2016-demo"
 156
 157   2b. If you want to run QEMU directly as VM in Virtual Box or your other favorite VM software then add this line to your "conf/local.conf" file.
 158 IMAGE_FSTYPES += "vmdk"
 159
 160   2c. The Weston IVI-Shell always gets built ; it will not be started, however, unless you specify the following in your "conf/local.conf" file :
 161
 162 IMAGE_INSTALL_append = " \
 163     weston-ivi-shell-config \
 164     "
 165       or you manually overwrite the "/etc/xdg/weston/weston.ini" file with a correct one.
 166
 167 3. Run the emulator. The path for the emulator (runqemu) was added during the envsetup.
 168         $ cd tmp/deploy/images/qemex86-64
 169         $ runqemu bzImage-qemux86-64.bin agl-demo-platform-qemux86-64.ext3
 170
 171    For large screen:
 172         $ runqemu bzImage-qemux86-64.bin agl-demo-platform-qemux86-64.ext3 \
 173         bootparams="uvesafb.mode_option=1280x720-32"
 174
 175    To extend the amount of memory, add to runqemu:
 176         qemuparams="-m 512"
 177
 178    or use the virtual disk in Virtual Box from this location:
 179         tmp/deploy/images/qemux86-64/agl-demo-platform-qemux86-64.vmdk
 180
 181 4. Some weston samples are available from weston terminal.
 182
 183
 184
 185
 186 Build a R-Car M2 (porter) image
 187 -------------------------------
 188
 189 #### Obtain and Install Renesas Graphics/Multimedia Drivers
 190
 191 1. Download packages from Renesas
 192
 193   The graphics and multimedia acceleration packages for the R-Car M2 Porter board
 194   can be download directory from [here](http://www.renesas.com/secret/r_car_download/rcar_demoboard.jsp).
 195
 196   There are 2 ZIP files can be downloaded.
 197     * Multimedia and Graphics library which require registeration and click through license
 198     > r-car_series_evaluation_software_package_for_linux-*.zip
 199     * Related Linux drivers
 200     > r-car_series_evaluation_software_package_of_linux_drivers-*.zip
 201
 202   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.
 203
 204 #### Build from the Source code
 205
 206 You can build a R-Car2 M2 (porter) image using the following steps:
 207
 208 1. Set up environment: You can specify any name for directory which storing all stuffs to build.
 209         $ source meta-agl/scripts/envsetup.sh porter [BUILD_DIR]
 210
 211 2. (Optional) If you want to install various Qt5 examples, add below
 212    configuration to your local.conf.
 213         IMAGE_INSTALL_append = " \
 214             packagegroup-agl-demo-qt-examples \
 215         "
 216         PACKAGECONFIG_append_pn-qtbase = " examples"
 217
 218    IMPORTANT NOTE:
 219         To run examples with wayland-egl plugin,
 220         use ``LD_PRELOAD=/usr/lib/libEGL.so <command>``.
 221         If not, programs should not launch by error,
 222         'EGL not available'.
 223
 224 3. (Optional) If you want to use multimedia accelerations, uncomment
 225    manually 4 `IMAGE_INSTALL_append_porter` in conf/local.conf.
 226         #IMAGE_INSTALL_append_porter = " \
 227         #    gstreamer1.0-plugins-bad-waylandsink \
 228         #    "
 229
 230         #IMAGE_INSTALL_append_porter = " \
 231         #    gstreamer1.0-plugins-base-videorate \
 232         ...
 233         #"
 234
 235         #IMAGE_INSTALL_append_porter = " \
 236         #    libegl libegl-dev libgbm-dev \
 237         ...
 238         #    "
 239
 240         #IMAGE_INSTALL_append_porter = " \
 241         #    packagegroup-rcar-gen2-multimedia \
 242         ...
 243         #    "
 244
 245    Also it is needed to uncomment this,
 246         #MACHINE_FEATURES_append = " multimedia"
 247
 248    This `multimedia` enables meta-renesas's multimedia configuration.
 249    The version of GStreamer1.0 which AGL distro use, will be changed
 250    to 1.2.3 (meta-renesas prefers) from 1.4.1(meta-agl default) by this switch.
 251
 252 4. Build the full image of AGL Demo Platform and applications
 253         $ bitbake agl-demo-platform
 254
 255 ### Deployment (SDCARD)
 256
 257 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).
 258
 259 #### Instructions on the host
 260
 261 1. Format SD-Card and then, create single EXT3 partition on it.
 262
 263 2. Mount the SD-Card, for example `/media/$SDCARD_LABEL`.
 264
 265 3. Copy AGL root file system onto the SD-Card
 266    1. Go to build directory
 267            $ cd $AGL_TOP/build/tmp/deploy/images/porter
 268    2. Extract the root file system into the SD-Card
 269            $ sudo tar --extract --numeric-owner --preserve-permissions --preserve-order \
 270            --totals --directory=/media/$SDCARD_LABEL --file=agl-demo-platform-porter.tar.bz2
 271    3. Copy kernel and DTB into the `/boot` of the SD-Card
 272            $ sudo cp uImage uImage-r8a7791-porter.dtb /media/$SDCARD_LABEL/boot
 273
 274 4. After the copy finished, unmount SD-Card and insert it into the SD-Card slot of the porter board.
 275
 276 #### Instructions on the host
 277
 278 NOTE: There is details about porter board [here](http://elinux.org/R-Car/Boards/Porter).
 279
 280 NOTE: To boot weston on porter board, we need keyboard and mouse. (USB2.0 can be use for this)
 281
 282 ##### Change U-Boot parameters to boot from SD card
 283
 284 1. Power up the board and, using your preferred terminal emulator, stop the board's autoboot by hitting any key.
 285
 286   > Debug serial settings are 38400 8N1. Any standard terminal emulator program can be used.
 287
 288 2. Set the follow environment variables and save them
 289         => setenv bootargs_console console=ttySC6,${baudrate}
 290         => setenv bootargs_video vmalloc=384M video=HDMI-A-1:1024x768-32@60
 291         => setenv bootcmd_sd 'ext4load mmc 0:1 0x40007fc0 boot/uImage;ext4load mmc 0:1 0x40f00000 boot/uImage-r8a7791-porter.dtb'
 292         => setenv bootcmd 'setenv bootargs ${bootargs_console} ${bootargs_video} root=/dev/mmcblk0p1 rw rootfstype=ext3;run bootcmd_sd;bootm 0x40007fc0 - 0x40f00000'
 293         => saveenv
 294
 295 ##### Boot from SD card
 296
 297 1. After board reset, U-Boot is started and after a countdown, ...
 298    Linux boot message should be displayed. Please wait a moment.
 299 2. Then weston is booted automatically, and weston-terminal appears.
 300
 301 3. Have fun! :)
 302
 303 4. (Optional) This is how to test and play multimedia contents with acceleration.
 304
 305     1. Boot porter without mouse and keyboard, it avoid to boot weston automatically.
 306        For now, when running weston, V4L2 deosn't work correctly, so we have to
 307        stop weston first (GST plugin `waylandsink` also doesn't work correctly for now).
 308
 309     2. Execute these instructions:
 310             $ export LD_LIBRARY_PATH="/lib:/usr/lib:/usr/local/lib:"
 311
 312             # Set the mixer
 313             $ amixer set "LINEOUT Mixer DACL" on
 314             $ amixer set "DVC Out" 10
 315
 316             $ modprobe -a mmngr mmngrbuf s3ctl uvcs_cmn vspm fdpm
 317
 318             $ media-ctl -d /dev/media0 -r
 319             $ media-ctl -d /dev/media0 -l '"vsp1.2 rpf.0":1 -> "vsp1.2 uds.0":0 [1]'
 320             $ media-ctl -d /dev/media0 -l '"vsp1.2 uds.0":1 -> "vsp1.2 wpf.0":0 [1]'
 321             $ media-ctl -d /dev/media0 -l '"vsp1.2 wpf.0":1 -> "vsp1.2 lif":0 [1]'
 322             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":0 [fmt:AYUV32/1920x1080]'
 323             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":1 [fmt:AYUV32/1920x1080]'
 324             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":0 [fmt:AYUV32/1920x1080]'
 325             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":1 [fmt:AYUV32/640x480]'
 326             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":0 [fmt:AYUV32/640x480]'
 327             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":1 [fmt:ARGB32/640x480]'
 328             $ media-ctl -d /dev/media0 -V '"vsp1.2 lif":0 [fmt:ARGB32/640x480]'
 329
 330             # in caes R-Car M2 (HDMI - DU1 - vspd0)
 331             $ modetest -M rcar-du -s 10@8:1280x720@AR24 -d -P '8@19:640x480+100+200@XR24' &
 332
 333     After these command, Test pattern will show on display connected to
 334     porter's HDMI port.
 335
 336     Then, you can play H264(MP4) movie like these,
 337             $ gst-launch-1.0 filesrc location=./sample.mp4  ! qtdemux name=d d. ! \
 338             queue ! omxh264dec no-copy=true ! v4l2sink device=/dev/video1 \
 339             io-mode=userptr d. ! queue ! faad ! alsasink device=hw:0,0
 340