fd129dde02e1f43e0bce265fbaa851a6c6fe769f
[AGL/meta-agl.git] / README.md
1 meta-agl, the Yocto layer for Automotive Grade Linux Distribution
2 =================================================================
3
4 This layer's purpose is ... [TBD]
5
6 Layer Dependencies
7 ------------------
8
9 URI: git://git.yoctoproject.org/poky
10 > branch:   dizzy
11 > revision: 5f0d25152bac2d3798663a4ebfdd2df24060f153
12
13 URI: git://git.openembedded.org/meta-openembedded
14 > layer:    meta-oe
15 > branch:   dizzy
16 > revision: 853dcfa0d618dc26bd27b3a1b49494b98d6eee97
17
18 ## The Renesas R-Car Gen2 (Porter) board depends in addition on: ##
19
20 URI: https://gerrit.automotivelinux.org/gerrit/AGL/meta-renesas
21 > branch:   agl-1.0-bsp-1.8.0
22 > revision: 0a69b07cfca17d1435f2bc7bf779139c5fac09a3
23
24 Layers
25 ------
26
27 There are 2 sub-layers in top-level `meta-agl`.
28
29 `meta-agl` is a layer which contains AGL common and middleware packages.
30 > meta-agl/meta-agl
31
32 `meta-agl-bsp` is a layer which contains required packages to boot AGL distribution on an emulated machine(QEMU).
33 > meta-agl/meta-agl-bsp
34
35 Packagegroups
36 -------------
37
38 AGL package group design:
39
40 These are the top-level packagegroups for AGL Distribution.
41 > packagegroup-agl-core  (basic/common packages out of oe-core)
42 > packagegroup-agl-ivi   (middlewares for AGL IVI)
43
44 Each package group can contain sub-package groups like these.
45 > packagegroup-agl-core-multimedia
46 > packagegroup-agl-core-connectivity
47 > ...
48 > packagegroup-agl-ivi-multimedia
49 > packagegroup-agl-ivi-connectivity
50 > ...
51
52 The recipe for `packagegroup-agl-core-*.bb` will contain common packages between meta-agl, meta-ivi and meta-tizen.
53 > directory: meta-agl/meta-agl/recipes-core/packagegroups
54 > recipes  : packagegroup-agl-core-[subsystem].bb
55
56 The "packagegroups-agl-ivi-*" will contain AGL specific middleware packages.
57 > directory: meta-agl/meta-agl/recipes-ivi/packagegroups
58 > recipes  : packagegroup-agl-ivi-[subsystem].bb
59
60 Supported Machine
61 -----------------
62
63 * QEMU (x86-64) - emulated machine: qemux86-64
64 * Renesas R-Car Gen2 (R-Car M2) - machine: porter
65
66 Supported Target of bitbake
67 ------------------------
68
69 * `agl-image-ivi` The baseline image of AGL Distributions
70
71 * `agl-image-minimal` For internal use to develop distribution (experimental)
72 * `agl-image-weston`  For internal use to develop distribution (experimental)
73
74 Supposed Directory Trees of Layers to build
75 -------------------------------------------
76
77 * For QEMU
78
79       ${TOPDIR}/
80                 meta-agl/
81                 meta-openembedded/
82                 poky/
83
84 * For R-Car M2
85
86       ${TOPDIR}/
87                 meta-agl/
88                 meta-openembedded/
89                 meta-renesas/
90                 poky/
91
92 Build a QEMU image
93 ------------------
94
95 You can build a QEMU image using the following steps:
96
97 1. Export TEMPLATECONF to pick up correct configuration for the build
98    > $ export TEMPLATECONF=/full/path/to/meta-agl/meta-agl/conf
99
100 2. Run the following command:
101    > $ source poky/oe-init-build-env
102
103 3. Build the minimal image of AGL Distribution
104    > $ bitbake agl-image-ivi
105
106 4. Run the emulator
107    > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64
108
109    For large screen:
110    > $ PATH_TO_POKY/poky/scripts/runqemu agl-image-ivi qemux86-64 bootparams="uvesafb.mode_option=1280x720-32"
111
112 5. Some weston samples are available from weston terminal.
113
114 Build a R-Car M2 (porter) image
115 -------------------------------
116
117 ### Software setup
118
119 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.
120
121 #### Getting Source Code and Build image
122
123 1. Create a directory for working, then go to there.
124         $ mkdir -p $HOME/ANYWHERE_YOU_WANT_TO_WORK_THERE
125         $ cd $HOME/ANYWHERE_YOU_WANT_TO_WORK_THERE
126         $ export AGL_TOP=`pwd`
127
128 2. Get the meta data and checkout
129         $ git clone git://git.yoctoproject.org/poky
130         $ cd poky
131         $ git checkout 5f0d25152bac2d3798663a4ebfdd2df24060f153
132         $ cd -
133         $ git clone git://git.openembedded.org/meta-openembedded
134         $ cd meta-openembedded
135         $ git checkout 853dcfa0d618dc26bd27b3a1b49494b98d6eee97
136         $ cd -
137         $ git clone https://gerrit.automotivelinux.org/gerrit/AGL/meta-renesas
138         $ cd meta-renesas
139         $ git checkout 0a69b07cfca17d1435f2bc7bf779139c5fac09a3
140         $ cd -
141         $ git clone https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl
142
143 #### Obtain and Install Renesas Graphics Drivers
144
145 1. Download packages from Renesas
146
147   The graphics and multimedia acceleration packages for the R-Car M2 Porter board
148   can be download directory from [here](http://www.renesas.com/secret/r_car_download/rcar_demoboard.jsp).
149
150   There are 2 ZIP files can be downloaded.
151     * Multimedia and Graphics library which require registeration and click through license
152     > r-car_series_evaluation_software_package_for_linux-*.zip
153     * Related Linux drivers
154     > r-car_series_evaluation_software_package_of_linux_drivers-*.zip
155
156 2. Unzip the two downloads into a temporary directory.
157         $ cd $AGL_TOP
158         $ mkdir binary-tmp
159         $ cd binary-tmp
160         $ unzip PATH_TO_DOWNLOAD/r-car_series_evaluation_software_package_for_linux-*.zip
161         $ unzip PATH_TO_DOWNLOAD/r-car_series_evaluation_software_package_of_linux_drivers-*.zip
162
163    After this step there should be two files in binary-tmp:
164    * Multimedia and Graphics library
165    > R-Car_Series_Evaluation_Software_Package_for_Linux-*.tar.gz
166    * Related Linux drivers
167    > R-Car_Series_Evaluation_Software_Package_of_Linux_Drivers-*.tar.gz
168
169 3. Extract 2 tar archives
170         $ tar xf R-Car_Series_Evaluation_Software_Package_for_Linux-*.tar.gz
171         $ tar xf R-Car_Series_Evaluation_Software_Package_of_Linux_Drivers-*.tar.gz
172
173 4. Copy 2 files manually
174    1. Locate `EVA_r8a7791_linux_sgx_binaries_gles2.tar.bz2` in the Multimedia and Graphics library deliverable and copy it into the BSP layer.
175           $ cd $AGL_TOP
176           $ cp <path_to_file>/EVA_r8a7791_linux_sgx_binaries_gles2.tar.bz2 \
177           meta-renesas/meta-rcar-gen2/recipes-graphics/gles-module/\
178           gles-user-module/r8a7791_linux_sgx_binaries_gles2.tar.bz2
179
180    2. Locate `SGX_KM_M2.tar.bz2` in the related linux drivers deliverable and copy it into the BSP layer.
181           $ cp <path_to_file>SGX_KM_M2.tar.bz2 \
182           $ meta-renesas/meta-rcar-gen2/recipes-kernel/gles-module/gles-kernel-module
183
184 #### Build from the Source code
185
186 You can build a R-Car2 M2 (porter) image using the following steps:
187
188 1. Export TEMPLATECONF to pick up correct configuration for the build
189         $ export TEMPLATECONF=$AGL_TOP/meta-renesas/meta-rcar-gen2/conf
190
191 2. Run the following command:
192         $ cd $AGL_TOP
193         $ source poky/oe-init-build-env
194
195 3. Build the minimal image of AGL Distribution
196         $ bitbake agl-image-ivi
197
198 ### Deployment (SDCARD)
199
200 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).
201
202 #### Instructions on the host
203
204 1. Format SD-Card and then, create single EXT3 partition on it.
205
206 2. Mount the SD-Card, for example `/media/$SDCARD_LABEL`.
207
208 3. Copy AGL root file system onto the SD-Card
209    1. Go to build directory
210            $ cd $AGL_TOP/build/tmp/deploy/images/porter
211    2. Extract the root file system into the SD-Card
212            $ sudo tar --extract --numeric-owner --preserve-permissions --preserve-order \
213            --totals --directory=/media/$SDCARD_LABEL --file=agl-image-ivi-porter.tar.bz2
214    3. Copy kernel and DTB into the `/boot` of the SD-Card
215            $ sudo cp uImage uImage-r8a7791-porter.dtb /media/$SDCARD_LABEL
216
217 4. After the copy finished, unmount SD-Card and insert it into the SD-Card slot of the porter board.
218
219 #### Instructions on the host
220
221 NOTE: There is details about porter board [here](http://elinux.org/R-Car/Boards/Porter).
222
223 NOTE: To boot weston on porter board, we need keyboard and mouse. (USB2.0 can be use for this)
224
225 ##### Change U-Boot parameters to boot from SD card
226
227 1. Power up the board and, using your preferred terminal emulator, stop the board's autoboot by hitting any key.
228
229   > Debug serial settings are 38400 8N1. Any standard terminal emulator program can be used.
230
231 2. Set the follow environment variables and save them
232         => setenv bootargs_console console=ttySC6,${baudrate}
233         => setenv bootargs_video vmalloc=384M video=HDMI-A-1:1024x768-32@60
234         => setenv bootcmd_sd 'ext4load mmc 0:1 0x40007fc0 boot/uImage;ext4load mmc 0:1 0x40f00000 boot/uImage-r8a7791-porter.dtb'
235         => setenv bootcmd 'setenv bootargs ${bootargs_console} ${bootargs_video} root=/dev/mmcblk0p1 rw rootfstype=ext3;run bootcmd_sd;bootm 0x40007fc0 - 0x40f00000'
236         => saveenv
237
238 ##### Boot from SD card
239
240 1. After board reset, U-Boot is started and after a countdown, ...
241    Linux boot message should be displayed. Please wait a moment.
242 2. Then weston is booted automatically, and weston-terminal appears.
243
244 3. Have fun! :)