a56d6671596bc54666d4177656c8f846a7b7440b
[AGL/documentation.git] / docs / 2_Hardware_Support / Renesas_Gen3_Boards / 2_Proprietary_Drivers.md
1 ---
2 edit_link: ''
3 title: Proprietary Drivers
4 origin_url: >-
5   https://git.automotivelinux.org/AGL/meta-renesas-rcar-gen3/plain/meta-rcar-gen3/README.proprietary.md?h=master
6 ---
7
8 <!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/hardware/master/renesas-gen3-boards-docs-book.yml -->
9
10 # Proprietary libraries for meta-rcar-gen3
11
12
13 The meta-rcar-gen3 layer of meta-renesas is supported Graphic GLES(GSX)
14 libraries, proprietary library of multimedia, and ICCOM software.
15
16 This README describes how to use these features and setting to local.conf.
17
18 ```bash
19     I/   Board configuration
20     II/  Build with GLES
21     III/ Build with Renesas multimedia libraries
22     IV/  Enable Linux ICCOM driver and Linux ICCOM library
23 ```
24
25 There are 2 main paths:
26
27 * Please check section II to config for GLES.
28 * Please check section III to enable Multimedia functions.
29
30 If you would like to use Linux ICCOM driver and Linux ICCOM library, please
31 check section IV.
32
33 **NOTE:**
34
35 * However, to have a completed local.conf, please also refer to Build
36 Instruction in [meta-renesas/meta-rcar-gen3/README.md](README.md).
37
38 * In addition, these libraries are not provided with recipes. If you would like
39 to use, you will need to get them from Renesas.
40
41 ## I/ Board configuration
42
43
44 * Add this line to local.conf
45
46     * For Salvator-X board
47
48     ```bash
49        MACHINE = "salvator-x"
50     ```
51
52     * For R-Car Starter Kit Premier(H3ULCB) board
53
54     ```bash
55        MACHINE = "h3ulcb"
56     ```
57
58     * For R-Car Starter Kit Pro(M3ULCB) board
59
60     ```bash
61        MACHINE = "m3ulcb"
62     ```
63
64     * For R-Car Starter Kit Pro(M3NULCB) board
65
66     ```bash
67         MACHINE = "m3nulcb"
68     ```
69
70     * For Ebisu board
71
72     ```bash
73        MACHINE = "ebisu"
74     ```
75
76 * Set SOC family name
77
78     * For H3: r8a7795
79
80     ```bash
81        SOC_FAMILY = "r8a7795"
82     ```
83
84     * For M3: r8a7796
85
86     ```bash
87        SOC_FAMILY = "r8a7796"
88     ```
89
90     * For M3N: r8a77965
91
92     ```bash
93        SOC_FAMILY = "r8a77965"
94     ```
95
96     * For E3: r8a77990
97
98     ```bash
99         # Already added in machine config: ebisu.conf
100         SOC_FAMILY = "r8a77990"
101     ```
102
103 ## II/ Build with GLES
104
105
106 For wayland with GSX
107
108 * Please copy proprietary libraries to the directory of recipes.
109
110 * Set local.conf the following.
111
112 ```bash
113     # Enable Gfx Pkgs
114     MACHINE_FEATURES_append = " gsx"
115     MULTI_PROVIDER_WHITELIST += "virtual/libgl virtual/egl virtual/libgles1 virtual/libgles2"
116
117     # for Wayland/Weston
118     DISTRO_FEATURES_NATIVESDK_append = " wayland"
119     DISTRO_FEATURES_append = " pam"
120     PREFERRED_PROVIDER_virtual/libgles1 = ""
121     PREFERRED_PROVIDER_virtual/libgles2 = "gles-user-module"
122     PREFERRED_PROVIDER_virtual/egl = "libegl"
123     PREFERRED_PROVIDER_virtual/libgl = ""
124     PREFERRED_PROVIDER_virtual/mesa = ""
125     PREFERRED_PROVIDER_libgbm = "libgbm"
126     PREFERRED_PROVIDER_libgbm-dev = "libgbm"
127     BBMASK = "mesa-gl"
128 ```
129
130 * Run `bitbake core-image-weston`
131
132 ## III/ Build with Renesas multimedia libraries
133
134
135 Multimedia portions depend on GLES portions.
136
137 ### A/ Configuration for Multimedia features
138
139
140 * Please copy proprietary libraries to the directory of recipes.
141
142 * Please set local.conf the following.
143
144 ```bash
145     # Enable multimedia features.
146     # This provides package group of plug-ins of the GStreamer, multimedia
147     # libraries and kernel drivers.
148
149         MACHINE_FEATURES_append = " multimedia"
150 ```
151
152 ### B/ Configuration for optional codecs and middleware
153
154
155 * Please copy proprietary libraries to the directory of recipes.
156
157 * Add features to DISTRO_FEATURES_append to local.conf
158
159 ```bash
160     # Additional configuration in OMX module
161     " h263dec_lib"       - for OMX Media Component H263 Decoder Library
162     " h264dec_lib"       - for OMX Media Component H264 Decoder Library
163     " h264enc_lib"       - for OMX Media Component H.264 Encoder Library
164     " h265dec_lib"       - for OMX Media Component H265 Decoder Library
165     " mpeg2dec_lib"      - for OMX Media Component MPEG2 Decoder Library
166     " mpeg4dec_lib"      - for OMX Media Component MPEG4 Decoder Library
167     " vc1dec_lib"        - for OMX Media Component VC-1 Decoder Library
168     " divxdec_lib"       - for OMX Media Component DivX Decoder Library
169     " rvdec_lib"         - for OMX Media Component RealVideo Decoder Library
170     " alacdec_lib"       - for OMX Media Component ALAC Decoder Library
171     " flacdec_lib"       - for OMX Media Component FLAC Decoder Library
172     " aaclcdec_lib"      - for OMX Media Component AAC-LC Decoder Library
173     " aaclcdec_mdw"      - for AAC-LC 2ch Decoder Middleware for Linux
174     " aacpv2dec_lib"     - for OMX Media Component aacPlus V2 Decoder Library
175     " aacpv2dec_mdw"     - for aacPlus V2 Decoder Middleware for Linux
176     " mp3dec_lib"        - for OMX Media Component MP3 Decoder Library
177     " mp3dec_mdw"        - for MP3 Decoder Middleware for Linux
178     " wmadec_lib"        - for OMX Media Component WMA Standard Decoder Library
179     " wmadec_mdw"        - for WMA Standard Decoder Middleware for Linux
180     " dddec_lib"         - for OMX Media Component Dolby(R) Digital Decoder Library
181     " dddec_mdw"         - for Dolby(R) Digital Decoder Middleware for Linux
182     " aaclcenc_lib"      - for OMX Media Component AAC-LC Encoder Library
183     " vp8dec_lib"        - for OMX Media Component VP8 Decoder Library for Linux
184     " vp8enc_lib"        - for OMX Media Component VP8 Encoder Library for Linux
185     " vp9dec_lib"        - for OMX Media Component VP9 Decoder Library for Linux
186     " aaclcenc_mdw"      - for AAC-LC Encoder Middleware for Linux
187     " cmsbcm"            - for CMS Basic Color Management Middleware for Linux
188     " cmsblc"            - for CMS CMM3 Backlight Control Middleware for Linux
189     " cmsdgc"            - for CMS VSP2 Dynamic Gamma Correction Middleware for Linux
190     " dtv"               - for ISDB-T DTV Software Package for Linux
191     " dvd"               - for DVD Core-Middleware for Linux
192     " adsp"              - for ADSP driver, ADSP interface and ADSP framework for Linux
193     " avb"               - for AVB Software Package for Linux
194 ```
195
196 Ex:
197 ```
198     DISTRO_FEATURES_append = " h264dec_lib h265dec_lib mpeg2dec_lib aaclcdec_lib aaclcdec_mdw"
199 ```
200
201 ### C/ Configuration for test packages
202
203
204 Must ensure that Multimedia features have been enabled.
205 (Please refer to III/A to enable Multimedia.)
206
207 * Please add feature to DISTRO_FEATURES_append to local.conf.
208
209 ```bash
210     # Configuration for multimedia test package
211
212         DISTRO_FEATURES_append = " mm-test"
213 ```
214
215 ## IV/ Enable Linux ICCOM driver and Linux ICCOM library
216
217
218 For Linux ICCOM driver and Linux ICCOM library
219
220 * Please copy proprietary libraries to the directory of recipes.
221
222 * Please set local.conf the following.
223
224 ```bash
225     DISTRO_FEATURES_append = " iccom"
226 ```
227 END.
228