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:   jethro (b/c of qt-5.5.x)
  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    To separate console from VGA screen (to avoid corrupt screen while booting),
 179    add to runqemu:
 180         serial
 181
 182    or use the virtual disk in Virtual Box from this location:
 183         tmp/deploy/images/qemux86-64/agl-demo-platform-qemux86-64.vmdk
 184
 185 4. Some weston samples are available from weston terminal.
 186
 187
 188
 189
 190 Build a R-Car M2 (porter) image
 191 -------------------------------
 192
 193 #### Obtain and Install Renesas Graphics/Multimedia Drivers
 194
 195 1. Download packages from Renesas
 196
 197   The graphics and multimedia acceleration packages for the R-Car M2 Porter board
 198   can be download directory from [here](http://www.renesas.com/secret/r_car_download/rcar_demoboard.jsp).
 199
 200   There are 2 ZIP files can be downloaded.
 201     * Multimedia and Graphics library which require registeration and click through license
 202     > r-car_series_evaluation_software_package_for_linux-*.zip
 203     * Related Linux drivers
 204     > r-car_series_evaluation_software_package_of_linux_drivers-*.zip
 205
 206   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.
 207
 208 #### Build from the Source code
 209
 210 You can build a R-Car2 M2 (porter) image using the following steps:
 211
 212 1. Set up environment: You can specify any name for directory which storing all stuffs to build.
 213         $ source meta-agl/scripts/envsetup.sh porter [BUILD_DIR]
 214
 215 2. (Optional) If you want to install various Qt5 examples, add below
 216    configuration to your local.conf.
 217         IMAGE_INSTALL_append = " \
 218             packagegroup-agl-demo-qt-examples \
 219         "
 220         PACKAGECONFIG_append_pn-qtbase = " examples"
 221
 222    IMPORTANT NOTE:
 223         To run examples with wayland-egl plugin,
 224         use ``LD_PRELOAD=/usr/lib/libEGL.so <command>``.
 225         If not, programs should not launch by error,
 226         'EGL not available'.
 227
 228 3. (Optional) If you want to use multimedia accelerations, uncomment
 229    manually 4 `IMAGE_INSTALL_append_porter` in conf/local.conf.
 230         #IMAGE_INSTALL_append_porter = " \
 231         #    gstreamer1.0-plugins-bad-waylandsink \
 232         #    "
 233
 234         #IMAGE_INSTALL_append_porter = " \
 235         #    gstreamer1.0-plugins-base-videorate \
 236         ...
 237         #"
 238
 239         #IMAGE_INSTALL_append_porter = " \
 240         #    libegl libegl-dev libgbm-dev \
 241         ...
 242         #    "
 243
 244         #IMAGE_INSTALL_append_porter = " \
 245         #    packagegroup-rcar-gen2-multimedia \
 246         ...
 247         #    "
 248
 249    Also it is needed to uncomment this,
 250         #MACHINE_FEATURES_append = " multimedia"
 251
 252    This `multimedia` enables meta-renesas's multimedia configuration.
 253    The version of GStreamer1.0 which AGL distro use, will be changed
 254    to 1.2.3 (meta-renesas prefers) from 1.4.1(meta-agl default) by this switch.
 255
 256 4. Build the full image of AGL Demo Platform and applications
 257         $ bitbake agl-demo-platform
 258
 259 ### Deployment (SDCARD)
 260
 261 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).
 262
 263 #### Instructions on the host
 264
 265 1. Format SD-Card and then, create single EXT3 partition on it.
 266
 267 2. Mount the SD-Card, for example `/media/$SDCARD_LABEL`.
 268
 269 3. Copy AGL root file system onto the SD-Card
 270    1. Go to build directory
 271            $ cd $AGL_TOP/build/tmp/deploy/images/porter
 272    2. Extract the root file system into the SD-Card
 273            $ sudo tar --extract --numeric-owner --preserve-permissions --preserve-order \
 274            --totals --directory=/media/$SDCARD_LABEL --file=agl-demo-platform-porter.tar.bz2
 275    3. Copy kernel and DTB into the `/boot` of the SD-Card
 276            $ sudo cp uImage uImage-r8a7791-porter.dtb /media/$SDCARD_LABEL/boot
 277
 278 4. After the copy finished, unmount SD-Card and insert it into the SD-Card slot of the porter board.
 279
 280 #### Instructions on the target board
 281
 282 NOTE: There is details about porter board [here](http://elinux.org/R-Car/Boards/Porter).
 283
 284 NOTE: To boot weston on porter board, we need keyboard and mouse. (USB2.0 can be use for this)
 285
 286 ##### Change U-Boot parameters to boot from SD card
 287
 288 1. Power up the board and, using your preferred terminal emulator, stop the board's autoboot by hitting any key.
 289
 290   > Debug serial settings are 38400 8N1. Any standard terminal emulator program can be used.
 291
 292 2. Set the follow environment variables and save them
 293         => setenv bootargs_console console=ttySC6,${baudrate}
 294         => setenv bootargs_video vmalloc=384M video=HDMI-A-1:1024x768-32@60
 295         => setenv bootcmd_sd 'ext4load mmc 0:1 0x40007fc0 boot/uImage;ext4load mmc 0:1 0x40f00000 boot/uImage-r8a7791-porter.dtb'
 296         => setenv bootcmd 'setenv bootargs ${bootargs_console} ${bootargs_video} root=/dev/mmcblk0p1 rw rootfstype=ext3;run bootcmd_sd;bootm 0x40007fc0 - 0x40f00000'
 297         => saveenv
 298
 299 ##### Boot from SD card
 300
 301 1. After board reset, U-Boot is started and after a countdown, ...
 302    Linux boot message should be displayed. Please wait a moment.
 303 2. Then weston is booted automatically, and weston-terminal appears.
 304
 305 3. Have fun! :)
 306
 307 4. (Optional) This is how to test and play multimedia contents with acceleration.
 308
 309     1. Boot porter without mouse and keyboard, it avoid to boot weston automatically.
 310        For now, when running weston, V4L2 deosn't work correctly, so we have to
 311        stop weston first (GST plugin `waylandsink` also doesn't work correctly for now).
 312
 313     2. Execute these instructions:
 314             $ export LD_LIBRARY_PATH="/lib:/usr/lib:/usr/local/lib:"
 315
 316             # Set the mixer
 317             $ amixer set "LINEOUT Mixer DACL" on
 318             $ amixer set "DVC Out" 10
 319
 320             $ modprobe -a mmngr mmngrbuf s3ctl uvcs_cmn vspm fdpm
 321
 322             $ media-ctl -d /dev/media0 -r
 323             $ media-ctl -d /dev/media0 -l '"vsp1.2 rpf.0":1 -> "vsp1.2 uds.0":0 [1]'
 324             $ media-ctl -d /dev/media0 -l '"vsp1.2 uds.0":1 -> "vsp1.2 wpf.0":0 [1]'
 325             $ media-ctl -d /dev/media0 -l '"vsp1.2 wpf.0":1 -> "vsp1.2 lif":0 [1]'
 326             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":0 [fmt:AYUV32/1920x1080]'
 327             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":1 [fmt:AYUV32/1920x1080]'
 328             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":0 [fmt:AYUV32/1920x1080]'
 329             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":1 [fmt:AYUV32/640x480]'
 330             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":0 [fmt:AYUV32/640x480]'
 331             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":1 [fmt:ARGB32/640x480]'
 332             $ media-ctl -d /dev/media0 -V '"vsp1.2 lif":0 [fmt:ARGB32/640x480]'
 333
 334             # in caes R-Car M2 (HDMI - DU1 - vspd0)
 335             $ modetest -M rcar-du -s 10@8:1280x720@AR24 -d -P '8@19:640x480+100+200@XR24' &
 336
 337     After these command, Test pattern will show on display connected to
 338     porter's HDMI port.
 339
 340     Then, you can play H264(MP4) movie like these,
 341             $ gst-launch-1.0 filesrc location=./sample.mp4  ! qtdemux name=d d. ! \
 342             queue ! omxh264dec no-copy=true ! v4l2sink device=/dev/video1 \
 343             io-mode=userptr d. ! queue ! faad ! alsasink device=hw:0,0
 344
 345 ### Deployment (TFTP/NFS)
 346
 347 NOTE: These instructions are based on Embedded Linux Wiki, [here](http://www.elinux.org/R-Car/Boards/Yocto#Loading_kernel_via_TFTP_and_rootfs_via_NFS). And a Debian (wheezy, ip: 192.168.30.70) is used as the host for this instructions.
 348
 349 #### Instructions on the host
 350 1. Setup a TFTP server
 351    1. Install necessary packages
 352            $ sudo apt-get install tftp tftpd-hpa
 353    2. Go to build directory, and copy kernel and DTB into TFTP server root (default server dir: /srv/tftp)
 354            $ cd $AGL_TOP/build/tmp/deploy/images/porter
 355            $ sudo cp uImage uImage-r8a7791-porter.dtb /srv/tftp
 356    3. Verify TFTP server is working
 357            $ ls uImage
 358            ls: cannot access uImage: No such file or directory
 359            $ cd /tmp/
 360            $ tftp 192.168.30.70
 361            tftp> get uImage
 362            Received 3583604 bytes in 0.2 seconds
 363            tftp> q
 364            $ ls uImage
 365            uImage
 366
 367 2. set NFS server
 368    1. Install necessary packages
 369            $ sudo apt-get install nfs-kernel-server nfs-common
 370    2. Go to build directory, and extract the root file system into a dedicated directory (here we use /nfs/porter)
 371            $ cd $AGL_TOP/build/tmp/deploy/images/porter
 372            $ sudo mkdir -p /nfs/porter
 373            $ sudo tar --extract --numeric-owner --preserve-permissions --preserve-order \
 374            --totals --directory=/nfs/porter --file=agl-demo-platform-porter.tar.bz2
 375    3. Edit /etc/exports
 376            $ sudo vi /etc/exports
 377       Add
 378            /nfs/porter  *(rw,no_subtree_check,sync,no_root_squash,no_all_squash)
 379       Save the file and exit.
 380    4. Restart nfs service
 381            $ sudo service nfs-kernel-server restart
 382    5. Verify NFS server is working
 383            $ sudo mount -t nfs 192.168.30.70:/nfs/porter /tmp/
 384            $ ls /tmp
 385            bin  boot  dev  etc  home  lib  media  mnt  proc  run  sbin  sh-thd-430987335390  sys  tmp  usr  var
 386
 387 #### Instructions on the target board
 388
 389 NOTE: There is details about porter board [here](http://elinux.org/R-Car/Boards/Porter).
 390
 391 NOTE: To boot weston on porter board, we need keyboard and mouse. (USB2.0 can be use for this)
 392
 393 ##### Change U-Boot parameters to boot from TFTP/NFS
 394
 395 1. Power up the board and, using your preferred terminal emulator, stop the board's autoboot by hitting any key.
 396
 397   > Debug serial settings are 38400 8N1. Any standard terminal emulator program can be used.
 398
 399 2. Set the follow environment variables and save them
 400         => setenv ipaddr <board-ip>
 401         => setenv serverip <host-ip>
 402         => setenv bootargs_console console=ttySC6,${baudrate}
 403         => setenv bootargs_video vmalloc=384M video=HDMI-A-1:1024x768-32@60
 404         => setenv bootcmd_net 'tftp 0x40007fc0 uImage; tftp 0x40f00000 uImage-r8a7791-porter.dtb'
 405         => setenv bootcmd 'setenv bootargs ${bootargs_console} ${bootargs_video} ip=${ipaddr} root=/dev/nfs nfsroot=${serverip}:/nfs/porter,vers=3;run bootcmd_net;bootm 0x40007fc0 - 0x40f00000'
 406         => saveenv
 407
 408     Replace <board-ip> with a proper IP address for the board, like 192.168.30.60.
 409     Replace <host-ip> with the IP address of the host, here we use 192.168.30.70.
 410
 411 ##### Boot from TFTP/NFS
 412
 413 1. After board reset, U-Boot is started and after a countdown, ...
 414    Linux boot message should be displayed. Please wait a moment.
 415 2. Then weston is booted automatically, and weston-terminal appears.
 416
 417 3. Have fun! :)