AMB (automotive-message-broker): fix GPSd dependency
[AGL/meta-agl.git] / README.md
1 meta-agl, the Yocto layer for Automotive Grade Linux Distribution
2 =================================================================
3
4 The yocto layer 'meta-agl' provides a minimal set of software
5 to boot system 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 ## The Renesas R-Car Gen2 (Porter) board depends in addition on: ##
37
38 URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-renesas
39 > branch:   agl-1.0-bsp-1.8.0
40 > revision: bf30de66badcac7ef82d3758aa44c116ee791a28
41 > (or later)
42
43 Layers
44 ------
45
46 There are 3 layers in top-level `meta-agl`.
47
48 `meta-ivi-common` is a layer which contains common packages to AGL
49 Distribution and other platforms for In-Vehicle Infotainment system.
50 > meta-agl/meta-ivi-common
51
52 `meta-agl` is a layer which contains AGL common and middleware packages.
53 > meta-agl/meta-agl
54
55 `meta-agl-bsp` is a layer which contains required packages to boot AGL
56 distribution on an emulated machine(QEMU).
57 > meta-agl/meta-agl-bsp
58
59 Packagegroups
60 -------------
61
62 AGL package group design:
63
64 * packagegroup-agl-core*
65
66 These are for making image ``agl-image-minimal`` which is small image just
67 capable of allowing a device to boot.
68
69 Subsystem should maintain packagegroup-agl-core-[subsystem].bb which should
70 hold sufficient packages to build ``agl-image-minimal``.
71
72 * packagegroup-agl-ivi*
73
74 These are for making image ``agl-image-ivi`` which is baseline for IVI profile
75 of AGL distro. 'Baseline' means Service Layer and Operating System Layer defined
76 in AGL Spec v1.0. I think this is the same as GENIVI baseline.
77 All packages which belong to AppHMI and Application Framework should be put
78 into ``meta-agl-demo``.
79
80 * packagegroup-ivi-common*
81
82 These are for picking up some packages from GENIVI/Tizen/Others. The layer of
83 ``meta-ivi-common`` has no image to build, all packagegroups are aggregated
84 to ``packagegrou-ivi-common-core' and it is included by images,
85 ``agl-image-ivi.bb`` and ``agl-demo-platform.bb``.
86
87 Supported Machine
88 -----------------
89
90 * QEMU (x86-64) - emulated machine: qemux86-64
91 * Renesas R-Car Gen2 (R-Car M2) - machine: porter
92
93 Supported Target of bitbake
94 ------------------------
95
96 * `agl-image-ivi` The baseline image of AGL Distributions
97
98 * `agl-image-minimal` For internal use to develop distribution (experimental)
99 * `agl-image-weston`  For internal use to develop distribution (experimental)
100
101 Supposed Directory Trees of Layers to build
102 -------------------------------------------
103
104 * For QEMU
105
106       ${TOPDIR}/
107                 meta-agl/
108                 meta-openembedded/
109                 poky/
110
111 * For R-Car M2
112
113       ${TOPDIR}/
114                 meta-agl/
115                 meta-openembedded/
116                 meta-renesas/
117                 poky/
118
119 Build a QEMU image
120 ------------------
121
122 You can build a QEMU image using the following steps:
123
124 1. Export TEMPLATECONF to pick up correct configuration for the build
125    > $ export TEMPLATECONF=/full/path/to/meta-agl/meta-agl/conf
126
127 2. Run the following command:
128    > $ source poky/oe-init-build-env
129
130 3. Build the minimal image of AGL Distribution
131    > $ bitbake agl-image-ivi
132
133 4. Run the emulator
134    > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64
135
136    For large screen:
137    > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64 bootparams="uvesafb.mode_option=1280x720-32"
138
139 5. Some weston samples are available from weston terminal.
140
141 Build a R-Car M2 (porter) image
142 -------------------------------
143
144 ### Software setup
145
146 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.
147
148 #### Getting Source Code and Build image
149
150 1. Create a directory for working, then go to there.
151         $ mkdir -p $HOME/ANYWHERE_YOU_WANT_TO_WORK_THERE
152         $ cd $HOME/ANYWHERE_YOU_WANT_TO_WORK_THERE
153         $ export AGL_TOP=`pwd`
154
155 2. Get the meta data and checkout
156         $ git clone git://git.yoctoproject.org/poky
157         $ cd poky
158         $ git checkout df87cb27efeaea1455f20692f9f1397c6fcab254
159         $ cd -
160         $ git clone git://git.openembedded.org/meta-openembedded
161         $ cd meta-openembedded
162         $ git checkout 9efaed99125b1c4324663d9a1b2d3319c74e7278
163         $ cd -
164         $ git clone https://gerrit.automotivelinux.org/gerrit/AGL/meta-renesas
165         $ cd meta-renesas
166         $ git checkout bf30de66badcac7ef82d3758aa44c116ee791a28
167         $ cd -
168         $ git clone https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl
169
170 #### Obtain and Install Renesas Graphics Drivers
171
172 1. Download packages from Renesas
173
174   The graphics and multimedia acceleration packages for the R-Car M2 Porter board
175   can be download directory from [here](http://www.renesas.com/secret/r_car_download/rcar_demoboard.jsp).
176
177   There are 2 ZIP files can be downloaded.
178     * Multimedia and Graphics library which require registeration and click through license
179     > r-car_series_evaluation_software_package_for_linux-*.zip
180     * Related Linux drivers
181     > r-car_series_evaluation_software_package_of_linux_drivers-*.zip
182
183 2. Unzip the two downloads into a temporary directory.
184         $ cd $AGL_TOP
185         $ mkdir binary-tmp
186         $ cd binary-tmp
187         $ unzip PATH_TO_DOWNLOAD/r-car_series_evaluation_software_package_for_linux-*.zip
188         $ unzip PATH_TO_DOWNLOAD/r-car_series_evaluation_software_package_of_linux_drivers-*.zip
189
190    After this step there should be two files in binary-tmp:
191    * Multimedia and Graphics library
192    > R-Car_Series_Evaluation_Software_Package_for_Linux-*.tar.gz
193    * Related Linux drivers
194    > R-Car_Series_Evaluation_Software_Package_of_Linux_Drivers-*.tar.gz
195
196 3. Copy the graphics acceleration drivers by shell script.
197         $ cd $AGL_TOP/meta-renesas/meta-rcar-gen2
198         $ ./copy_gfx_software_porter.sh ../../binary-tmp
199
200 4. Copy the multimedia acceleration drivers by shell script.
201         $ cd $AGL_TOP/meta-renesas/meta-rcar-gen2
202         $ ./copy_mm_software_lcb.sh ../../binary-tmp
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. Export TEMPLATECONF to pick up correct configuration for the build
209         $ export TEMPLATECONF=$AGL_TOP/meta-renesas/meta-rcar-gen2/conf
210
211 2. Run the following command:
212         $ cd $AGL_TOP
213         $ source poky/oe-init-build-env
214
215    Edit conf/bblayers.conf then remove this line.
216         ##OEROOT##/../meta-agl-demo \
217
218    (Optional) If you want to use multimedia accelerations, confirm your
219    conf/bblayer.conf has a entry of `meta-openembedded/meta-multimedia`
220    in BBLAYERS because packagegroup-rcar-gen2-multimedia needs some extra
221    packages there.
222
223 3. (Optional) If you want to use multimedia accelerations, uncomment
224    manually 4 `IMAGE_INSTALL_append_porter` in conf/local.conf.
225         #IMAGE_INSTALL_append_porter = " \
226         #    gstreamer1.0-plugins-bad-waylandsink \
227         #    "
228
229         #IMAGE_INSTALL_append_porter = " \
230         #    gstreamer1.0-plugins-base-videorate \
231         ...
232         #"
233
234         #IMAGE_INSTALL_append_porter = " \
235         #    libegl libegl-dev libgbm-dev \
236         ...
237         #    "
238
239         #IMAGE_INSTALL_append_porter = " \
240         #    packagegroup-rcar-gen2-multimedia \
241         ...
242         #    "
243
244    Also it is needed to uncomment this,
245         #MACHINE_FEATURES_append = " multimedia"
246
247    This `multimedia` enables meta-renesas's multimedia configuration.
248    The version of GStreamer1.0 which AGL distro use, will be changed
249    to 1.2.3 (meta-renesas prefers) from 1.4.1(meta-agl default) by this switch.
250
251 4. Build the minimal image of AGL Distribution
252         $ bitbake agl-image-ivi
253
254 ### Deployment (SDCARD)
255
256 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).
257
258 #### Instructions on the host
259
260 1. Format SD-Card and then, create single EXT3 partition on it.
261
262 2. Mount the SD-Card, for example `/media/$SDCARD_LABEL`.
263
264 3. Copy AGL root file system onto the SD-Card
265    1. Go to build directory
266            $ cd $AGL_TOP/build/tmp/deploy/images/porter
267    2. Extract the root file system into the SD-Card
268            $ sudo tar --extract --numeric-owner --preserve-permissions --preserve-order \
269            --totals --directory=/media/$SDCARD_LABEL --file=agl-image-ivi-porter.tar.bz2
270    3. Copy kernel and DTB into the `/boot` of the SD-Card
271            $ sudo cp uImage uImage-r8a7791-porter.dtb /media/$SDCARD_LABEL/boot
272
273 4. After the copy finished, unmount SD-Card and insert it into the SD-Card slot of the porter board.
274
275 #### Instructions on the host
276
277 NOTE: There is details about porter board [here](http://elinux.org/R-Car/Boards/Porter).
278
279 NOTE: To boot weston on porter board, we need keyboard and mouse. (USB2.0 can be use for this)
280
281 ##### Change U-Boot parameters to boot from SD card
282
283 1. Power up the board and, using your preferred terminal emulator, stop the board's autoboot by hitting any key.
284
285   > Debug serial settings are 38400 8N1. Any standard terminal emulator program can be used.
286
287 2. Set the follow environment variables and save them
288         => setenv bootargs_console console=ttySC6,${baudrate}
289         => setenv bootargs_video vmalloc=384M video=HDMI-A-1:1024x768-32@60
290         => setenv bootcmd_sd 'ext4load mmc 0:1 0x40007fc0 boot/uImage;ext4load mmc 0:1 0x40f00000 boot/uImage-r8a7791-porter.dtb'
291         => setenv bootcmd 'setenv bootargs ${bootargs_console} ${bootargs_video} root=/dev/mmcblk0p1 rw rootfstype=ext3;run bootcmd_sd;bootm 0x40007fc0 - 0x40f00000'
292         => saveenv
293
294 ##### Boot from SD card
295
296 1. After board reset, U-Boot is started and after a countdown, ...
297    Linux boot message should be displayed. Please wait a moment.
298 2. Then weston is booted automatically, and weston-terminal appears.
299
300 3. Have fun! :)
301
302 4. (Optional) This is how to test and play multimedia contents with acceleration.
303
304     1. Boot porter without mouse and keyboard, it avoid to boot weston automatically.
305        For now, when running weston, V4L2 deosn't work correctly, so we have to
306        stop weston first (GST plugin `waylandsink` also doesn't work correctly for now).
307
308     2. Execute these instructions:
309             $ export LD_LIBRARY_PATH="/lib:/usr/lib:/usr/local/lib:"
310
311             # Set the mixer
312             $ amixer set "LINEOUT Mixer DACL" on
313             $ amixer set "DVC Out" 10
314
315             $ modprobe -a mmngr mmngrbuf s3ctl uvcs_cmn vspm fdpm
316
317             $ media-ctl -d /dev/media0 -r
318             $ media-ctl -d /dev/media0 -l '"vsp1.2 rpf.0":1 -> "vsp1.2 uds.0":0 [1]'
319             $ media-ctl -d /dev/media0 -l '"vsp1.2 uds.0":1 -> "vsp1.2 wpf.0":0 [1]'
320             $ media-ctl -d /dev/media0 -l '"vsp1.2 wpf.0":1 -> "vsp1.2 lif":0 [1]'
321             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":0 [fmt:AYUV32/1920x1080]'
322             $ media-ctl -d /dev/media0 -V '"vsp1.2 rpf.0":1 [fmt:AYUV32/1920x1080]'
323             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":0 [fmt:AYUV32/1920x1080]'
324             $ media-ctl -d /dev/media0 -V '"vsp1.2 uds.0":1 [fmt:AYUV32/640x480]'
325             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":0 [fmt:AYUV32/640x480]'
326             $ media-ctl -d /dev/media0 -V '"vsp1.2 wpf.0":1 [fmt:ARGB32/640x480]'
327             $ media-ctl -d /dev/media0 -V '"vsp1.2 lif":0 [fmt:ARGB32/640x480]'
328
329             # in caes R-Car M2 (HDMI - DU1 - vspd0)
330             $ modetest -M rcar-du -s 10@8:1280x720@AR24 -d -P '8@19:640x480+100+200@XR24' &
331
332     After these command, Test pattern will show on display connected to
333     porter's HDMI port.
334
335     Then, you can play H264(MP4) movie like these,
336             $ gst-launch-1.0 filesrc location=./sample.mp4  ! qtdemux name=d d. ! \
337             queue ! omxh264dec no-copy=true ! v4l2sink device=/dev/video1 \
338             io-mode=userptr d. ! queue ! faad ! alsasink device=hw:0,0