meta-raspberrypi/docs/extra-build-config.md

3 There are a set of ways in which a user can influence different parameters of
6 <http://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html>
24   the 512MB RP. Overrides gpu_mem. Max 192. Default not set.
27   the 256MB RP. Overrides gpu_mem. Max 448. Default not set.
30   the 256MB/512MB RP. Overrides gpu_mem. Max 944. Default not set.
32 See: <https://www.raspberrypi.com/documentation/computers/config_txt.html#memory-options>
36 …set to `1` to disable this behaviour falling back to using `userland`. Be aware that `userland` ha…
50 See: <https://www.raspberrypi.com/documentation/computers/config_txt.html#licence-key-and-codec-opt…
55 TVs which cut off part of the image. To disable this set this variable in
63 To disable this set this variable in local.conf:
72 To remove (or adjust) this delay set these variables in local.conf:
84 …ev/mmcblk0p2" to mount SD card. If you want to mount USB memory partition, set CMDLINE_ROOT_PARTIT…
85 …om the SD card, following the u-boot specification. Similarly, if you want to load a boot image fi…
93 ## Set overclocking options
108 See: <https://www.raspberrypi.com/documentation/computers/config_txt.html#overclocking-options>
125 See: <https://www.raspberrypi.com/documentation/computers/configuration.html#hdmi-configuration>
127 ## Video camera support with V4L2 drivers
129 Set this variable to enable support for the video camera (Linux 3.12.4+
136 Set this variable to enable support for dispmanx offline compositing:
140 This will enable the firmware to fall back to off-line compositing of Dispmanx
141 elements. Normally the compositing is done on-line, during scanout, but cannot
142 handle too many elements. With off-line enabled, an off-screen buffer is
144 of elements) is high, compositing will happen off-line into the buffer.
152 To add the kdbg over console (kgdboc) parameter to the kernel command line, set
159 To disable rpi boot logo, set this variable in local.conf:
163 ## Boot to U-Boot
165 To have u-boot load kernel image, set in your local.conf:
169 This will select the appropriate image format for use with u-boot automatically.
171 be overridden to select the exact kernel image type (eg. zImage) and u-boot
172 command (eg. bootz) to be used.
174 To operate correctly, U-Boot requires `enable_uart=1` in `config.txt` file for
177 * Raspberry Pi 3 32-bit
178 * Raspberry Pi 3 64-bit
179 * Raspberry Pi 4 32-bit
180 * Raspberry Pi 4 64-bit
189 * Set this 3 kernel variables (in kernel's do_configure:prepend in linux-raspberrypi.inc after the …
191   - kernel_configure_variable BLK_DEV_INITRD y
192   - kernel_configure_variable INITRAMFS_SOURCE ""
193   - kernel_configure_variable RD_GZIP y
195 * Set the yocto variables (e.g. in local.conf)
196   - `INITRAMFS_IMAGE = "<name for your initramfs image>"`
197   - `INITRAMFS_IMAGE_BUNDLE = "1"`
198   - `BOOT_SPACE = "1073741"`
199   - `INITRAMFS_MAXSIZE = "315400"`
200   - `IMAGE_FSTYPES:pn-${INITRAMFS_IMAGE} = "${INITRAMFS_FSTYPES}"`
209 FATPAYLOAD is a simple space-separated list of files to be copied:
214 listed in the DEPLOYPAYLOAD as a space-separated list of entries.
218     DEPLOYPAYLOAD = "example1-${MACHINE}:example1 example2"
229 When using device tree kernels, set this variable to enable the SPI bus:
235 When using device tree kernels, set this variable to enable I2C:
239 Furthermore, to auto-load I2C kernel modules set:
241     KERNEL_MODULE_AUTOLOAD:rpi += "i2c-dev i2c-bcm2708"
249   - This will enable SPI bus and i2c device-trees, it will also setup
255 Below is a list of currently supported PiTFT models in meta-raspberrypi, the
269 Screen LCD, HDMI interface (<http://www.waveshare.com/7inch-HDMI-LCD-C.htm>) Rev
270 2.1, please set the following in your local.conf:
279 needs a fixed core frequency and enable_uart will set it to the minimum. Certain
280 operations - 60fps h264 decode, high quality deinterlace - which aren't
283 RaspberryPi 0 Wifi or 3 will have to explicitly set in local.conf:
289 * <https://github.com/RPi-Distro/repo/issues/22>
294 want to use gadget modules like g_ether should set the following in
303 Users who want to use the 2 USB built-in ports or the other ports provided via
304 the header extension should set the following in local.conf:
308 ## Set CPUs to be isolated from the standard Linux scheduler
316 separated list ("1,2"), a range("1-3"), or a mixture of these ("1,3-5")
318     ISOLATED_CPUS = "1-2"
322 When using device tree kernels, set this variable to enable the 802.15.4 hat:
326 See: <https://openlabs.co/OSHW/Raspberry-Pi-802.15.4-radio>
330 In order to use CAN with an MCP2515-based module, set the following variables:
335 In case of dual CAN module (e.g. PiCAN2 Duo), set following variables instead:
340 …e of the crystal. By default, it is set to 16 MHz. To change that to 8 MHz, the following variable…
345 the pins are set to 25 for can0 and 24 for can1. To change them to 12 and 16,
346 the following variables also have to be set:
353 * PiCAN2 (16 MHz crystal): <http://skpang.co.uk/catalog/pican2-canbus-board-for-raspberry-pi-23-p-1…
354 * WaveShare RS485 CAN HAT (8 MHz or 12 MHz crystal): <https://www.waveshare.com/rs485-can-hat.htm>
355 …uo (16 MHz crystal): <http://skpang.co.uk/catalog/pican2-duo-canbus-board-for-raspberry-pi-23-p-14…
360 Infrared Remote Control), have to explicitly set in local.conf:
364 This will add device tree overlays gpio-ir and gpio-ir-tx to config.txt.
366 GPIO pin for gpio-ir is set to 18 and the pin for gpio-ir-tx is 17. Both pins
369 ## Enable gpio-shutdown
371 When using device tree kernels, set this variable to enable gpio-shutdown:
376 the gpio-keys kernel module in the image. If System V init is used, additional
377 mapping is applied to bind the button event to shutdown command. Systemd init
381 the pin as gpio 1). This conflicts with the I2C bus. If you set `ENABLE_I2C`
387 ## Enable One-Wire Interface
389 One-wire is a single-wire communication bus typically used to connect sensors
390 to the RaspberryPi. The Raspberry Pi supports one-wire on any GPIO pin, but
391 the default is GPIO 4. To enable the one-wire interface explicitly set it in
397 discovered via all 1-Wire busses check the interface with this command
406 If double-quotes are needed in the lines you are adding you can use single
409 For example, to add a comment containing a double-quote and a configuration
416 ## Enable Raspberry Pi Camera Module
418 Raspberry Pi does not have the unicam device ( Raspberry Pi Camera ) enabled by default.
419 Because this unicam device ( bcm2835-unicam ) as of now is used by libcamera opensource.
424 This will add the device tree overlay imx219 ( Raspberry Pi Camera Module V2 sensor driver
428 Similarly, the Raspberry Pi Camera Module v3 also has to be explicitly enabled in local.conf.
432 This will add the device tree overlay imx708 ( Raspberry Pi Camera Module V3 sensor driver )
437 * <https://www.raspberrypi.org/blog/an-open-source-camera-stack-for-raspberry-pi-using-libcamera/>
441 Support for WM8960 based sound cards such as the WM8960 Hi-Fi Sound Card HAT for Raspberry Pi from …
447     amixer -c1 sset 'Headphone',0 80%,80%
448     amixer -c1 sset 'Speaker',0 80%,80%
449     amixer -c1 sset 'Left Input Mixer Boost' toggle
450     amixer -c1 sset 'Left Output Mixer PCM' toggle
451     amixer -c1 sset 'Right Input Mixer Boost' toggle
452     amixer -c1 sset 'Right Output Mixer PCM' toggle
478 To enable Raspberry Pi Distro VLC, the `meta-openembedded/meta-multimedia` layer must be
481 VLC does not support HW accelerated video decode through MMAL on a 64-bit OS.
491 to `local.conf`. Adding `vlc` to `IMAGE_INSTALL` will then default to building the oe-core
492 implementation of ffmpeg and the meta-openembedded/meta-multimedia implementation of VLC.
496     PREFERRED_PROVIDER_vlc = "rpidistro-vlc"
497     PREFERRED_PROVIDER_ffmpeg = "rpidistro-ffmpeg"
498     PREFERRED_PROVIDER_libav = "rpidistro-ffmpeg"
499     PREFERRED_PROVIDER_libpostproc = "rpidistro-ffmpeg"
503     DISPLAYNUM=$(tvservice -l | tail -c 2)
505 … VLC_SETTINGS="-I dummy --vout=mmal_vout --mmal-resize --mmal-display hdmi-$MMAL_DISPLAY --no-dbus"