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