4 This directory contains Device Tree overlays. Device Tree makes it possible
5 to support many hardware configurations with a single kernel and without the
6 need to explicitly load or blacklist kernel modules. Note that this isn't a
7 "pure" Device Tree configuration (c.f. MACH_BCM2835) - some on-board devices
8 are still configured by the board support code, but the intention is to
9 eventually reach that goal.
11 On Raspberry Pi, Device Tree usage is controlled from /boot/config.txt. By
12 default, the Raspberry Pi kernel boots with device tree enabled. You can
13 completely disable DT usage (for now) by adding:
17 to your config.txt, which should cause your Pi to revert to the old way of
18 doing things after a reboot.
20 In /boot you will find a .dtb for each base platform. This describes the
21 hardware that is part of the Raspberry Pi board. The loader (start.elf and its
22 siblings) selects the .dtb file appropriate for the platform by name, and reads
23 it into memory. At this point, all of the optional interfaces (i2c, i2s, spi)
24 are disabled, but they can be enabled using Device Tree parameters:
26 dtparam=i2c=on,i2s=on,spi=on
28 However, this shouldn't be necessary in many use cases because loading an
29 overlay that requires one of those interfaces will cause it to be enabled
30 automatically, and it is advisable to only enable interfaces if they are
33 Configuring additional, optional hardware is done using Device Tree overlays
36 GPIO numbering uses the hardware pin numbering scheme (aka BCM scheme) and
37 not the physical pin numbers.
42 The Advanced Options section of the raspi-config utility can enable and disable
43 Device Tree use, as well as toggling the I2C and SPI interfaces. Note that it
44 is possible to both enable an interface and blacklist the driver, if for some
45 reason you should want to defer the loading.
50 As well as describing the hardware, Device Tree also gives enough information
51 to allow suitable driver modules to be located and loaded, with the corollary
52 that unneeded modules are not loaded. As a result it should be possible to
53 remove lines from /etc/modules, and /etc/modprobe.d/raspi-blacklist.conf can
54 have its contents deleted (or commented out).
59 Overlays are loaded using the "dtoverlay" config.txt setting. As an example,
60 consider I2C Real Time Clock drivers. In the pre-DT world these would be loaded
61 by writing a magic string comprising a device identifier and an I2C address to
62 a special file in /sys/class/i2c-adapter, having first loaded the driver for
63 the I2C interface and the RTC device - something like this:
67 echo ds1307 0x68 > /sys/class/i2c-adapter/i2c-1/new_device
69 With DT enabled, this becomes a line in config.txt:
71 dtoverlay=i2c-rtc,ds1307
73 This causes the file /boot/overlays/i2c-rtc.dtbo to be loaded and a "node"
74 describing the DS1307 I2C device to be added to the Device Tree for the Pi. By
75 default it usees address 0x68, but this can be modified with an additional DT
78 dtoverlay=i2c-rtc,ds1307,addr=0x68
80 Parameters usually have default values, although certain parameters are
81 mandatory. See the list of overlays below for a description of the parameters
84 Making new Overlays based on existing Overlays
85 ==============================================
87 Recent overlays have been designed in a more general way, so that they can be
88 adapted to hardware by changing their parameters. When you have additional
89 hardware with more than one device of a kind, you end up using the same overlay
90 multiple times with other parameters, e.g.
92 # 2 CAN FD interfaces on spi but with different pins
93 dtoverlay=mcp251xfd,spi0-0,interrupt=25
94 dtoverlay=mcp251xfd,spi0-1,interrupt=24
96 # a realtime clock on i2c
97 dtoverlay=i2c-rtc,pcf85063
99 While this approach does work, it requires knowledge about the hardware design.
100 It is more feasible to simplify things for the end user by providing a single
101 overlay as it is done the traditional way.
103 A new overlay can be generated by using ovmerge utility.
104 https://github.com/raspberrypi/utils/blob/master/ovmerge/ovmerge
106 To generate an overlay for the above configuration we pass the configuration
107 to ovmerge and add the -c flag.
109 ovmerge -c mcp251xfd-overlay.dts,spi0-0,interrupt=25 \
110 mcp251xfd-overlay.dts,spi0-1,interrupt=24 \
111 i2c-rtc-overlay.dts,pcf85063 \
112 >> merged-overlay.dts
114 The -c option writes the command above as a comment into the overlay as
115 a marker that this overlay is generated and how it was generated.
116 After compiling the overlay it can be loaded in a single line.
120 It does the same as the original configuration but without parameters.
122 The Overlay and Parameter Reference
123 ===================================
125 N.B. When editing this file, please preserve the indentation levels to make it
126 simple to parse programmatically. NO HARD TABS.
130 Info: Configures the base Raspberry Pi hardware
131 Load: <loaded automatically>
133 ant1 Select antenna 1 (default). CM4 only.
135 ant2 Select antenna 2. CM4 only.
137 noant Disable both antennas. CM4 only.
139 audio Set to "on" to enable the onboard ALSA audio
140 interface (default "off")
142 axiperf Set to "on" to enable the AXI bus performance
144 See /sys/kernel/debug/raspberrypi_axi_monitor
147 bdaddr Set an alternative Bluetooth address (BDADDR).
148 The value should be a 6-byte hexadecimal value,
149 with or without colon separators, written least-
150 significant-byte first. For example,
151 bdaddr=06:05:04:03:02:01
152 will set the BDADDR to 01:02:03:04:05:06.
154 button_debounce Set the debounce delay (in ms) on the power/
155 shutdown button (default 50ms)
157 cam0_reg Enables CAM 0 regulator.
158 Only required on CM1 & 3.
160 cam0_reg_gpio Set GPIO for CAM 0 regulator.
161 Default 31 on CM1, 3, and 4S.
162 Default of GPIO expander 5 on CM4, but override
163 switches to normal GPIO.
165 cam1_reg Enables CAM 1 regulator.
166 Only required on CM1 & 3.
168 cam1_reg_gpio Set GPIO for CAM 1 regulator.
169 Default 3 on CM1, 3, and 4S.
170 Default of GPIO expander 5 on CM4, but override
171 switches to normal GPIO.
173 cooling_fan Enables the Pi 5 cooling fan (enabled
174 automatically by the firmware)
176 drm_fb0_rp1_dpi Assign /dev/fb0 to the RP1 DPI output
178 drm_fb0_rp1_dsi0 Assign /dev/fb0 to the RP1 DSI0 output
180 drm_fb0_rp1_dsi1 Assign /dev/fb0 to the RP1 DSI1 output
182 drm_fb0_vc4 Assign /dev/fb0 to the vc4 outputs
184 drm_fb1_rp1_dpi Assign /dev/fb1 to the RP1 DPI output
186 drm_fb1_rp1_dsi0 Assign /dev/fb1 to the RP1 DSI0 output
188 drm_fb1_rp1_dsi1 Assign /dev/fb1 to the RP1 DSI1 output
190 drm_fb1_vc4 Assign /dev/fb1 to the vc4 outputs
192 drm_fb2_rp1_dpi Assign /dev/fb2 to the RP1 DPI output
194 drm_fb2_rp1_dsi0 Assign /dev/fb2 to the RP1 DSI0 output
196 drm_fb2_rp1_dsi1 Assign /dev/fb2 to the RP1 DSI1 output
198 drm_fb2_vc4 Assign /dev/fb2 to the vc4 outputs
200 eee Enable Energy Efficient Ethernet support for
201 compatible devices (default "on"). See also
202 "tx_lpi_timer". Pi3B+ only.
204 eth_downshift_after Set the number of auto-negotiation failures
205 after which the 1000Mbps modes are disabled.
206 Legal values are 2, 3, 4, 5 and 0, where
207 0 means never downshift (default 2). Pi3B+ only.
209 eth_led0 Set mode of LED0 - amber on Pi3B+ (default "1"),
210 green on Pi4 (default "0").
211 The legal values are:
215 0=link/activity 1=link1000/activity
216 2=link100/activity 3=link10/activity
217 4=link100/1000/activity 5=link10/1000/activity
218 6=link10/100/activity 14=off 15=on
222 0=Speed/Activity 1=Speed
223 2=Flash activity 3=FDX
228 eth_led1 Set mode of LED1 - green on Pi3B+ (default "6"),
229 amber on Pi4 (default "8"). See eth_led0 for
232 eth_max_speed Set the maximum speed a link is allowed
233 to negotiate. Legal values are 10, 100 and
234 1000 (default 1000). Pi3B+ only.
236 hdmi Set to "off" to disable the HDMI interface
239 i2c An alias for i2c_arm
241 i2c_arm Set to "on" to enable the ARM's i2c interface
244 i2c_arm_baudrate Set the baudrate of the ARM's i2c interface
247 i2c_baudrate An alias for i2c_arm_baudrate
249 i2c_csi_dsi Set to "on" to enable the i2c_csi_dsi interface
251 i2c_csi_dsi0 Set to "on" to enable the i2c_csi_dsi0 interface
253 i2c_csi_dsi1 Set to "on" to enable the i2c_csi_dsi1 interface
255 i2c_vc Set to "on" to enable the i2c interface
256 usually reserved for the VideoCore processor
259 i2c_vc_baudrate Set the baudrate of the VideoCore i2c interface
262 i2s Set to "on" to enable the i2s interface
265 i2s_dma4 Use to enable 40-bit DMA on the i2s interface
266 (the assigned value doesn't matter)
269 krnbt Set to "off" to disable autoprobing of Bluetooth
270 driver without need of hciattach/btattach
273 krnbt_baudrate Set the baudrate of the PL011 UART when used
276 nvme Alias for "pciex1" (2712 only)
278 pcie Set to "off" to disable the PCIe interface
280 (2711 only, but not applicable on CM4S)
281 N.B. USB-A ports on 4B are subsequently disabled
283 pcie_tperst_clk_ms Add N milliseconds between PCIe reference clock
284 activation and PERST# deassertion
285 (CM4 and 2712, default "0")
287 pciex1 Set to "on" to enable the external PCIe link
288 (2712 only, default "off")
290 pciex1_gen Sets the PCIe "GEN"/speed for the external PCIe
291 link (2712 only, default "2")
293 pciex1_no_l0s Set to "on" to disable ASPM L0s on the external
294 PCIe link for devices that have broken
295 implementations (2712 only, default "off")
297 pciex1_tperst_clk_ms Alias for pcie_tperst_clk_ms
298 (2712 only, default "0")
300 spi Set to "on" to enable the spi interfaces
303 spi_dma4 Use to enable 40-bit DMA on spi interfaces
304 (the assigned value doesn't matter)
307 random Set to "on" to enable the hardware random
308 number generator (default "on")
310 rtc_bbat_vchg Set the RTC backup battery charging voltage in
311 microvolts. If set to 0 or not specified, the
312 trickle charger is disabled.
313 (2712 only, default "0")
315 sd Set to "off" to disable the SD card (or eMMC on
316 non-lite SKU of CM4).
319 sd_overclock Clock (in MHz) to use when the MMC framework
322 sd_poll_once Looks for a card once after booting. Useful
323 for network booting scenarios to avoid the
324 overhead of continuous polling. N.B. Using
325 this option restricts the system to using a
326 single card per boot (or none at all).
329 sd_force_pio Disable DMA support for SD driver (default off)
331 sd_pio_limit Number of blocks above which to use DMA for
334 sd_debug Enable debug output from SD driver (default off)
336 sdio_overclock Clock (in MHz) to use when the MMC framework
337 requests 50MHz for the SDIO/WLAN interface.
339 suspend Make the power button trigger a suspend rather
340 than a power-off (2712 only, default "off")
342 tx_lpi_timer Set the delay in microseconds between going idle
343 and entering the low power state (default 600).
344 Requires EEE to be enabled - see "eee".
346 uart0 Set to "off" to disable uart0 (default "on")
348 uart0_console Move the kernel boot console to UART0 on pins
349 6, 8 and 10 of the 40-way header (2712 only,
352 uart1 Set to "on" or "off" to enable or disable uart1
355 watchdog Set to "on" to enable the hardware watchdog
358 wifiaddr Set an alternative WiFi MAC address.
359 The value should be a 6-byte hexadecimal value,
360 with or without colon separators, written in the
361 natural (big-endian) order.
363 act_led_trigger Choose which activity the LED tracks.
364 Use "heartbeat" for a nice load indicator.
367 act_led_activelow Set to "on" to invert the sense of the LED
369 N.B. For Pi 3B, 3B+, 3A+ and 4B, use the act-led
372 act_led_gpio Set which GPIO to use for the activity LED
373 (in case you want to connect it to an external
375 (default "16" on a non-Plus board, "47" on a
377 N.B. For Pi 3B, 3B+, 3A+ and 4B, use the act-led
383 As for act_led_*, but using the PWR LED.
384 Not available on Model A/B boards.
386 N.B. It is recommended to only enable those interfaces that are needed.
387 Leaving all interfaces enabled can lead to unwanted behaviour (i2c_vc
388 interfering with Pi Camera, I2S and SPI hogging GPIO pins, etc.)
389 Note also that i2c, i2c_arm and i2c_vc are aliases for the physical
390 interfaces i2c0 and i2c1. Use of the numeric variants is still possible
391 but deprecated because the ARM/VC assignments differ between board
392 revisions. The same board-specific mapping applies to i2c_baudrate,
393 and the other i2c baudrate parameters.
397 Info: Pi 3B, 3B+, 3A+ and 4B use a GPIO expander to drive the LEDs which can
398 only be accessed from the VPU. There is a special driver for this with a
399 separate DT node, which has the unfortunate consequence of breaking the
400 act_led_gpio and act_led_activelow dtparams.
401 This overlay changes the GPIO controller back to the standard one and
402 restores the dtparams.
403 Load: dtoverlay=act-led,<param>=<val>
404 Params: activelow Set to "on" to invert the sense of the LED
407 gpio Set which GPIO to use for the activity LED
408 (in case you want to connect it to an external
413 Name: adafruit-st7735r
414 Info: Overlay for the SPI-connected Adafruit 1.8" 160x128 or 128x128 displays,
415 based on the ST7735R chip.
416 This overlay uses the newer DRM/KMS "Tiny" driver.
417 Load: dtoverlay=adafruit-st7735r,<param>=<val>
418 Params: 128x128 Select the 128x128 driver (default 160x128)
419 rotate Display rotation {0,90,180,270} (default 90)
420 speed SPI bus speed in Hz (default 4000000)
421 dc_pin GPIO pin for D/C (default 24)
422 reset_pin GPIO pin for RESET (default 25)
423 led_pin GPIO used to control backlight (default 18)
427 Info: Overlay for the SPI-connected Adafruit 1.8" display (based on the
428 ST7735R chip). It includes support for the "green tab" version.
429 This overlay uses the older fbtft driver.
430 Load: dtoverlay=adafruit18,<param>=<val>
431 Params: green Use the adafruit18_green variant.
432 rotate Display rotation {0,90,180,270}
433 speed SPI bus speed in Hz (default 4000000)
434 fps Display frame rate in Hz
435 bgr Enable BGR mode (default off)
436 debug Debug output level {0-7}
437 dc_pin GPIO pin for D/C (default 24)
438 reset_pin GPIO pin for RESET (default 25)
439 led_pin GPIO used to control backlight (default 18)
443 Info: Overlay for activation of ADAU1977 ADC codec over I2C for control
445 Load: dtoverlay=adau1977-adc
449 Name: adau7002-simple
450 Info: Overlay for the activation of ADAU7002 stereo PDM to I2S converter.
451 Load: dtoverlay=adau7002-simple,<param>=<val>
452 Params: card-name Override the default, "adau7002", card name.
456 Info: Overlay for activation of Texas Instruments ADS1015 ADC over I2C
457 Load: dtoverlay=ads1015,<param>=<val>
458 Params: addr I2C bus address of device. Set based on how the
459 addr pin is wired. (default=0x48 assumes addr
461 cha_enable Enable virtual channel a. (default=true)
462 cha_cfg Set the configuration for virtual channel a.
463 (default=4 configures this channel for the
464 voltage at A0 with respect to GND)
465 cha_datarate Set the datarate (samples/sec) for this channel.
466 (default=4 sets 1600 sps)
467 cha_gain Set the gain of the Programmable Gain
468 Amplifier for this channel. (default=2 sets the
469 full scale of the channel to 2.048 Volts)
471 Channel (ch) parameters can be set for each enabled channel.
472 A maximum of 4 channels can be enabled (letters a thru d).
473 For more information refer to the device datasheet at:
474 http://www.ti.com/lit/ds/symlink/ads1015.pdf
478 Info: Texas Instruments ADS1115 ADC
479 Load: dtoverlay=ads1115,<param>[=<val>]
480 Params: addr I2C bus address of device. Set based on how the
481 addr pin is wired. (default=0x48 assumes addr
483 cha_enable Enable virtual channel a.
484 cha_cfg Set the configuration for virtual channel a.
485 (default=4 configures this channel for the
486 voltage at A0 with respect to GND)
487 cha_datarate Set the datarate (samples/sec) for this channel.
488 (default=7 sets 860 sps)
489 cha_gain Set the gain of the Programmable Gain
490 Amplifier for this channel. (Default 1 sets the
491 full scale of the channel to 4.096 Volts)
493 Channel parameters can be set for each enabled channel.
494 A maximum of 4 channels can be enabled (letters a thru d).
495 For more information refer to the device datasheet at:
496 http://www.ti.com/lit/ds/symlink/ads1115.pdf
500 Info: ADS7846 Touch controller
501 Load: dtoverlay=ads7846,<param>=<val>
502 Params: cs SPI bus Chip Select (default 1)
503 speed SPI bus speed (default 2MHz, max 3.25MHz)
504 penirq GPIO used for PENIRQ. REQUIRED
505 penirq_pull Set GPIO pull (default 0=none, 2=pullup)
506 swapxy Swap x and y axis
507 xmin Minimum value on the X axis (default 0)
508 ymin Minimum value on the Y axis (default 0)
509 xmax Maximum value on the X axis (default 4095)
510 ymax Maximum value on the Y axis (default 4095)
511 pmin Minimum reported pressure value (default 0)
512 pmax Maximum reported pressure value (default 65535)
513 xohms Touchpanel sensitivity (X-plate resistance)
516 penirq is required and usually xohms (60-100) has to be set as well.
517 Apart from that, pmax (255) and swapxy are also common.
518 The rest of the calibration can be done with xinput-calibrator.
519 See: github.com/notro/fbtft/wiki/FBTFT-on-Raspian
520 Device Tree binding document:
521 www.kernel.org/doc/Documentation/devicetree/bindings/input/ads7846.txt
525 Info: Analog Devices ADV7282M analogue video to CSI2 bridge.
526 Uses Unicam1, which is the standard camera connector on most Pi
528 Load: dtoverlay=adv7282m,<param>=<val>
529 Params: addr Overrides the I2C address (default 0x21)
530 media-controller Configure use of Media Controller API for
531 configuring the sensor (default off)
535 Info: Analog Devices ADV728[0|1|2]-M analogue video to CSI2 bridges.
536 This is a wrapper for adv7282m, and defaults to ADV7282M.
537 Load: dtoverlay=adv728x-m,<param>=<val>
538 Params: addr Overrides the I2C address (default 0x21)
539 adv7280m Select ADV7280-M.
540 adv7281m Select ADV7281-M.
541 adv7281ma Select ADV7281-MA.
542 media-controller Configure use of Media Controller API for
543 configuring the sensor (default off)
546 Name: akkordion-iqdacplus
547 Info: Configures the Digital Dreamtime Akkordion Music Player (based on the
548 OEM IQAudIO DAC+ or DAC Zero module).
549 Load: dtoverlay=akkordion-iqdacplus,<param>=<val>
550 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
551 Digital volume control. Enable with
552 dtoverlay=akkordion-iqdacplus,24db_digital_gain
553 (The default behaviour is that the Digital
554 volume control is limited to a maximum of
555 0dB. ie. it can attenuate but not provide
556 gain. For most users, this will be desired
557 as it will prevent clipping. By appending
558 the 24db_digital_gain parameter, the Digital
559 volume control will allow up to 24dB of
560 gain. If this parameter is enabled, it is the
561 responsibility of the user to ensure that
562 the Digital volume control is set to a value
563 that does not result in clipping/distortion!)
566 Name: allo-boss-dac-pcm512x-audio
567 Info: Configures the Allo Boss DAC audio cards.
568 Load: dtoverlay=allo-boss-dac-pcm512x-audio,<param>
569 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
570 Digital volume control. Enable with
571 "dtoverlay=allo-boss-dac-pcm512x-audio,
573 (The default behaviour is that the Digital
574 volume control is limited to a maximum of
575 0dB. ie. it can attenuate but not provide
576 gain. For most users, this will be desired
577 as it will prevent clipping. By appending
578 the 24db_digital_gain parameter, the Digital
579 volume control will allow up to 24dB of
580 gain. If this parameter is enabled, it is the
581 responsibility of the user to ensure that
582 the Digital volume control is set to a value
583 that does not result in clipping/distortion!)
584 slave Force Boss DAC into slave mode, using Pi a
585 master for bit clock and frame clock. Enable
586 with "dtoverlay=allo-boss-dac-pcm512x-audio,
590 Name: allo-boss2-dac-audio
591 Info: Configures the Allo Boss2 DAC audio card
592 Load: dtoverlay=allo-boss2-dac-audio
597 Info: Configures the Allo Digione audio card
598 Load: dtoverlay=allo-digione
602 Name: allo-katana-dac-audio
603 Info: Configures the Allo Katana DAC audio card
604 Load: dtoverlay=allo-katana-dac-audio
608 Name: allo-piano-dac-pcm512x-audio
609 Info: Configures the Allo Piano DAC (2.0/2.1) audio cards.
610 (NB. This initial support is for 2.0 channel audio ONLY! ie. stereo.
611 The subwoofer outputs on the Piano 2.1 are not currently supported!)
612 Load: dtoverlay=allo-piano-dac-pcm512x-audio,<param>
613 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
614 Digital volume control.
615 (The default behaviour is that the Digital
616 volume control is limited to a maximum of
617 0dB. ie. it can attenuate but not provide
618 gain. For most users, this will be desired
619 as it will prevent clipping. By appending
620 the 24db_digital_gain parameter, the Digital
621 volume control will allow up to 24dB of
622 gain. If this parameter is enabled, it is the
623 responsibility of the user to ensure that
624 the Digital volume control is set to a value
625 that does not result in clipping/distortion!)
628 Name: allo-piano-dac-plus-pcm512x-audio
629 Info: Configures the Allo Piano DAC (2.1) audio cards.
630 Load: dtoverlay=allo-piano-dac-plus-pcm512x-audio,<param>
631 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
632 Digital volume control.
633 (The default behaviour is that the Digital
634 volume control is limited to a maximum of
635 0dB. ie. it can attenuate but not provide
636 gain. For most users, this will be desired
637 as it will prevent clipping. By appending
638 the 24db_digital_gain parameter, the Digital
639 volume control will allow up to 24dB of
640 gain. If this parameter is enabled, it is the
641 responsibility of the user to ensure that
642 the Digital volume control is set to a value
643 that does not result in clipping/distortion!)
644 glb_mclk This option is only with Kali board. If enabled,
645 MCLK for Kali is used and PLL is disabled for
646 better voice quality. (default Off)
650 Info: Universal device tree overlay for SPI devices
652 Just specify the SPI address and device name ("compatible" property).
653 This overlay lacks any device-specific parameter support!
655 For devices on spi1 or spi2, the interfaces should be enabled
656 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
659 1. SPI NOR flash on spi0.1, maximum SPI clock frequency 45MHz:
660 dtoverlay=anyspi:spi0-1,dev="jedec,spi-nor",speed=45000000
661 2. MCP3204 ADC on spi1.2, maximum SPI clock frequency 500kHz:
662 dtoverlay=anyspi:spi1-2,dev="microchip,mcp3204"
663 Load: dtoverlay=anyspi,<param>=<val>
664 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
666 dev Set device name to search compatible module
668 speed Set SPI clock frequency in Hz
669 (integer, optional, default 500000)
673 Info: Configures the AVAGO APDS9960 digital proximity, ambient light, RGB and
675 Load: dtoverlay=apds9960,<param>=<val>
676 Params: gpiopin GPIO used for INT (default 4)
677 noints Disable the interrupt GPIO line.
681 Info: Configures the Orchard Audio ApplePi-DAC audio card
682 Load: dtoverlay=applepi-dac
687 Info: Arducam 64MP camera module.
688 Uses Unicam 1, which is the standard camera connector on most Pi
690 Load: dtoverlay=arducam-64mp,<param>=<val>
691 Params: rotation Mounting rotation of the camera sensor (0 or
693 orientation Sensor orientation (0 = front, 1 = rear,
694 2 = external, default external)
695 media-controller Configure use of Media Controller API for
696 configuring the sensor (default on)
697 cam0 Adopt the default configuration for CAM0 on a
698 Compute Module (CSI0, i2c_vc, and cam0_reg).
699 vcm Select lens driver state. Default is enabled,
700 but vcm=off will disable.
703 Name: arducam-pivariety
704 Info: Arducam Pivariety camera module.
705 Uses Unicam 1, which is the standard camera connector on most Pi
707 Load: dtoverlay=arducam-pivariety,<param>=<val>
708 Params: rotation Mounting rotation of the camera sensor (0 or
710 orientation Sensor orientation (0 = front, 1 = rear,
711 2 = external, default external)
712 media-controller Configure use of Media Controller API for
713 configuring the sensor (default on)
714 cam0 Adopt the default configuration for CAM0 on a
715 Compute Module (CSI0, i2c_vc, and cam0_reg).
719 Info: Configures the Atmel AT86RF233 802.15.4 low-power WPAN transceiver,
721 Load: dtoverlay=at86rf233,<param>=<val>
722 Params: interrupt GPIO used for INT (default 23)
723 reset GPIO used for Reset (default 24)
724 sleep GPIO used for Sleep (default 25)
725 speed SPI bus speed in Hz (default 3000000)
726 trim Fine tuning of the internal capacitance
727 arrays (0=+0pF, 15=+4.5pF, default 15)
730 Name: audioinjector-addons
731 Info: Configures the audioinjector.net audio add on soundcards
732 Load: dtoverlay=audioinjector-addons,<param>=<val>
733 Params: non-stop-clocks Keeps the clocks running even when the stream
734 is paused or stopped (default off)
737 Name: audioinjector-bare-i2s
738 Info: Configures the audioinjector.net audio bare i2s soundcard
739 Load: dtoverlay=audioinjector-bare-i2s
743 Name: audioinjector-isolated-soundcard
744 Info: Configures the audioinjector.net isolated soundcard
745 Load: dtoverlay=audioinjector-isolated-soundcard
749 Name: audioinjector-ultra
750 Info: Configures the audioinjector.net ultra soundcard
751 Load: dtoverlay=audioinjector-ultra
755 Name: audioinjector-wm8731-audio
756 Info: Configures the audioinjector.net audio add on soundcard
757 Load: dtoverlay=audioinjector-wm8731-audio
762 Info: Configures the audiosense-pi add on soundcard
763 For more information refer to
764 https://gitlab.com/kakar0t/audiosense-pi
765 Load: dtoverlay=audiosense-pi
770 Info: Switches PWM sound output to GPIOs on the 40-pin header
771 Load: dtoverlay=audremap,<param>=<val>
772 Params: swap_lr Reverse the channel allocation, which will also
773 swap the audio jack outputs (default off)
774 enable_jack Don't switch off the audio jack output. Does
775 nothing on BCM2711 (default off)
776 pins_12_13 Select GPIOs 12 & 13 (default)
777 pins_18_19 Select GPIOs 18 & 19
778 pins_40_41 Select GPIOs 40 & 41 (not available on CM4, used
780 pins_40_45 Select GPIOs 40 & 45 (don't use on BCM2711 - the
781 pins are on different controllers)
785 Info: Overlay that enables WLAN, Bluetooth and the GPIO expander on the
786 balenaFin carrier board for the Raspberry Pi Compute Module 3/3+ Lite.
787 Load: dtoverlay=balena-fin
791 Name: bmp085_i2c-sensor
792 Info: This overlay is now deprecated - see i2c-sensor
796 Name: camera-mux-2port
797 Info: Configures a 2 port camera multiplexer
798 Note that currently ALL IMX290 modules share a common clock, therefore
799 all modules will need to have the same clock frequency.
800 Load: dtoverlay=camera-mux-2port,<param>=<val>
801 Params: cam0-arducam-64mp Select Arducam64MP for camera on port 0
802 cam0-imx219 Select IMX219 for camera on port 0
803 cam0-imx258 Select IMX258 for camera on port 0
804 cam0-imx290 Select IMX290 for camera on port 0
805 cam0-imx477 Select IMX477 for camera on port 0
806 cam0-imx519 Select IMX519 for camera on port 0
807 cam0-imx708 Select IMX708 for camera on port 0
808 cam0-ov2311 Select OV2311 for camera on port 0
809 cam0-ov5647 Select OV5647 for camera on port 0
810 cam0-ov7251 Select OV7251 for camera on port 0
811 cam0-ov9281 Select OV9281 for camera on port 0
812 cam0-imx290-clk-freq Set clock frequency for an IMX290 on port 0
813 cam1-arducam-64mp Select Arducam64MP for camera on port 1
814 cam1-imx219 Select IMX219 for camera on port 1
815 cam1-imx258 Select IMX258 for camera on port 1
816 cam1-imx290 Select IMX290 for camera on port 1
817 cam1-imx477 Select IMX477 for camera on port 1
818 cam1-imx519 Select IMX519 for camera on port 1
819 cam1-imx708 Select IMX708 for camera on port 1
820 cam1-ov2311 Select OV2311 for camera on port 1
821 cam1-ov5647 Select OV5647 for camera on port 1
822 cam1-ov7251 Select OV7251 for camera on port 1
823 cam1-ov9281 Select OV9281 for camera on port 1
824 cam1-imx290-clk-freq Set clock frequency for an IMX290 on port 1
827 Name: camera-mux-4port
828 Info: Configures a 4 port camera multiplexer
829 Note that currently ALL IMX290 modules share a common clock, therefore
830 all modules will need to have the same clock frequency.
831 Load: dtoverlay=camera-mux-4port,<param>=<val>
832 Params: cam0-arducam-64mp Select Arducam64MP for camera on port 0
833 cam0-imx219 Select IMX219 for camera on port 0
834 cam0-imx258 Select IMX258 for camera on port 0
835 cam0-imx290 Select IMX290 for camera on port 0
836 cam0-imx477 Select IMX477 for camera on port 0
837 cam0-imx519 Select IMX519 for camera on port 0
838 cam0-imx708 Select IMX708 for camera on port 0
839 cam0-ov2311 Select OV2311 for camera on port 0
840 cam0-ov5647 Select OV5647 for camera on port 0
841 cam0-ov7251 Select OV7251 for camera on port 0
842 cam0-ov9281 Select OV9281 for camera on port 0
843 cam0-imx290-clk-freq Set clock frequency for an IMX290 on port 0
844 cam1-arducam-64mp Select Arducam64MP for camera on port 1
845 cam1-imx219 Select IMX219 for camera on port 1
846 cam1-imx258 Select IMX258 for camera on port 1
847 cam1-imx290 Select IMX290 for camera on port 1
848 cam1-imx477 Select IMX477 for camera on port 1
849 cam1-imx519 Select IMX519 for camera on port 1
850 cam1-imx708 Select IMX708 for camera on port 1
851 cam1-ov2311 Select OV2311 for camera on port 1
852 cam1-ov5647 Select OV5647 for camera on port 1
853 cam1-ov7251 Select OV7251 for camera on port 1
854 cam1-ov9281 Select OV9281 for camera on port 1
855 cam1-imx290-clk-freq Set clock frequency for an IMX290 on port 1
856 cam2-arducam-64mp Select Arducam64MP for camera on port 2
857 cam2-imx219 Select IMX219 for camera on port 2
858 cam2-imx258 Select IMX258 for camera on port 2
859 cam2-imx290 Select IMX290 for camera on port 2
860 cam2-imx477 Select IMX477 for camera on port 2
861 cam2-imx519 Select IMX519 for camera on port 2
862 cam2-imx708 Select IMX708 for camera on port 2
863 cam2-ov2311 Select OV2311 for camera on port 2
864 cam2-ov5647 Select OV5647 for camera on port 2
865 cam2-ov7251 Select OV7251 for camera on port 2
866 cam2-ov9281 Select OV9281 for camera on port 2
867 cam2-imx290-clk-freq Set clock frequency for an IMX290 on port 2
868 cam3-arducam-64mp Select Arducam64MP for camera on port 3
869 cam3-imx219 Select IMX219 for camera on port 3
870 cam3-imx258 Select IMX258 for camera on port 3
871 cam3-imx290 Select IMX290 for camera on port 3
872 cam3-imx477 Select IMX477 for camera on port 3
873 cam3-imx519 Select IMX519 for camera on port 3
874 cam3-imx708 Select IMX708 for camera on port 3
875 cam3-ov2311 Select OV2311 for camera on port 3
876 cam3-ov5647 Select OV5647 for camera on port 3
877 cam3-ov7251 Select OV7251 for camera on port 3
878 cam3-ov9281 Select OV9281 for camera on port 3
879 cam3-imx290-clk-freq Set clock frequency for an IMX290 on port 3
883 Info: Enables the ability to use the cap1106 touch sensor as a keyboard
884 Load: dtoverlay=cap1106,<param>=<val>
885 Params: int_pin GPIO pin for interrupt signal (default 23)
889 Info: Configures Chip Dip audio cards.
890 Load: dtoverlay=chipdip-dac
895 Info: Configures the Cirrus Logic Audio Card
896 Load: dtoverlay=cirrus-wm5102
901 Info: Largely for Compute Modules 1&3 where the original instructions for
902 adding a camera used GPIOs 0&1 for CAM1 and 28&29 for CAM0, whilst all
903 other platforms use 28&29 (or 44&45) for CAM1.
904 The default assignment through using this overlay is for
905 i2c0 to use 28&29, and i2c10 (aka i2c_csi_dsi) to use 28&29, but the
906 overrides allow this to be changed.
907 Load: dtoverlay=cm-swap-i2c0,<param>=<val>
908 Params: i2c0-gpio0 Use GPIOs 0&1 for i2c0
909 i2c0-gpio28 Use GPIOs 28&29 for i2c0 (default)
910 i2c0-gpio44 Use GPIOs 44&45 for i2c0
911 i2c10-gpio0 Use GPIOs 0&1 for i2c0 (default)
912 i2c10-gpio28 Use GPIOs 28&29 for i2c0
913 i2c10-gpio44 Use GPIOs 44&45 for i2c0
917 Info: Set custom CMA sizes, only use if you know what you are doing, might
918 clash with other overlays like vc4-fkms-v3d and vc4-kms-v3d.
919 Load: dtoverlay=cma,<param>=<val>
920 Params: cma-512 CMA is 512MB (needs 1GB)
921 cma-448 CMA is 448MB (needs 1GB)
922 cma-384 CMA is 384MB (needs 1GB)
923 cma-320 CMA is 320MB (needs 1GB)
924 cma-256 CMA is 256MB (needs 1GB)
925 cma-192 CMA is 192MB (needs 1GB)
929 cma-size CMA size in bytes, 4MB aligned
930 cma-default Use upstream's default value
933 Name: crystalfontz-cfa050_pi_m
934 Info: Configures the Crystalfontz CFA050-PI-M series of Raspberry Pi CM4
935 based modules using the CFA7201280A0_050Tx 7" TFT LCD displays,
936 with or without capacitive touch screen.
937 Requires use of vc4-kms-v3d.
938 Load: dtoverlay=crystalfontz-cfa050_pi_m,<param>=<val>
939 Params: captouch Enable capacitive touch display
943 Info: 8" TFT LCD display and touch panel used by cutiepi.io
944 Load: dtoverlay=cutiepi-panel
949 Info: Configures the dacberry400 add on soundcard
950 Load: dtoverlay=dacberry400
955 Info: Overlay for the DHT11/DHT21/DHT22 humidity/temperature sensors
956 Also sometimes found with the part number(s) AM230x.
957 Load: dtoverlay=dht11,<param>=<val>
958 Params: gpiopin GPIO connected to the sensor's DATA output.
963 Info: Configures the Dion Audio KIWI STREAMER
964 Load: dtoverlay=dionaudio-kiwi
969 Info: Configures the Dion Audio LOCO DAC-AMP
970 Load: dtoverlay=dionaudio-loco
974 Name: dionaudio-loco-v2
975 Info: Configures the Dion Audio LOCO-V2 DAC-AMP
976 Load: dtoverlay=dionaudio-loco-v2,<param>=<val>
977 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
978 Digital volume control. Enable with
979 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
980 (The default behaviour is that the Digital
981 volume control is limited to a maximum of
982 0dB. ie. it can attenuate but not provide
983 gain. For most users, this will be desired
984 as it will prevent clipping. By appending
985 the 24dB_digital_gain parameter, the Digital
986 volume control will allow up to 24dB of
987 gain. If this parameter is enabled, it is the
988 responsibility of the user to ensure that
989 the Digital volume control is set to a value
990 that does not result in clipping/distortion!)
994 Info: Disable onboard Bluetooth on Bluetooth-capable Raspberry Pis. On Pis
995 prior to Pi 5 this restores UART0/ttyAMA0 over GPIOs 14 & 15.
996 Load: dtoverlay=disable-bt
1000 Name: disable-bt-pi5
1001 Info: See disable-bt
1005 Info: Disable EMMC2 controller on BCM2711.
1006 The allows the onboard EMMC storage on Compute Module 4 to be disabled
1007 e.g. if a fault has occurred.
1008 Load: dtoverlay=disable-emmc2
1013 Info: Disable onboard WLAN on WiFi-capable Raspberry Pis.
1014 Load: dtoverlay=disable-wifi
1018 Name: disable-wifi-pi5
1019 Info: See disable-wifi
1023 Info: Overlay for a generic 18-bit DPI display
1024 This uses GPIOs 0-21 (so no I2C, uart etc.), and activates the output
1025 2-3 seconds after the kernel has started.
1026 Load: dtoverlay=dpi18
1031 Info: Overlay for a generic 18-bit DPI display (in 'mode 6' connection scheme)
1032 This uses GPIOs 0-9,12-17,20-25 (so no I2C, uart etc.), and activates
1033 the output 3-3 seconds after the kernel has started.
1034 Load: dtoverlay=dpi18cpadhi
1039 Info: Overlay for a generic 24-bit DPI display
1040 This uses GPIOs 0-27 (so no I2C, uart etc.), and activates the output
1041 2-3 seconds after the kernel has started.
1042 Load: dtoverlay=dpi24
1047 Info: Configures the NW Digital Radio DRAWS Hat
1049 The board includes an ADC to measure various board values and also
1050 provides two analog user inputs on the expansion header. The ADC
1051 can be configured for various sample rates and gain values to adjust
1052 the input range. Tables describing the two parameters follow.
1064 ADC Datarate Values:
1069 4 = 1600sps (default)
1073 Load: dtoverlay=draws,<param>=<val>
1074 Params: draws_adc_ch4_gain Sets the full scale resolution of the ADCs
1075 input voltage sensor (default 1)
1077 draws_adc_ch4_datarate Sets the datarate of the ADCs input voltage
1080 draws_adc_ch5_gain Sets the full scale resolution of the ADCs
1081 5V rail voltage sensor (default 1)
1083 draws_adc_ch5_datarate Sets the datarate of the ADCs 4V rail voltage
1086 draws_adc_ch6_gain Sets the full scale resolution of the ADCs
1087 AIN2 input (default 2)
1089 draws_adc_ch6_datarate Sets the datarate of the ADCs AIN2 input
1091 draws_adc_ch7_gain Sets the full scale resolution of the ADCs
1092 AIN3 input (default 2)
1094 draws_adc_ch7_datarate Sets the datarate of the ADCs AIN3 input
1096 alsaname Name of the ALSA audio device (default "draws")
1100 Info: Selects the dwc_otg USB controller driver which has fiq support. This
1101 is the default on all except the Pi Zero which defaults to dwc2.
1102 Load: dtoverlay=dwc-otg
1107 Info: Selects the dwc2 USB controller driver
1108 Load: dtoverlay=dwc2,<param>=<val>
1109 Params: dr_mode Dual role mode: "host", "peripheral" or "otg"
1111 g-rx-fifo-size Size of rx fifo size in gadget mode
1113 g-np-tx-fifo-size Size of non-periodic tx fifo size in gadget
1118 Info: See dwc2 (this is the Pi 5 version)
1121 [ The ds1307-rtc overlay has been deleted. See i2c-rtc. ]
1125 Info: Overlay for the EDT FT5406 touchscreen.
1126 This works with the Raspberry Pi 7" touchscreen when not being polled
1128 By default the overlay uses the i2c_csi_dsi I2C interface, but this
1130 You MUST use either "disable_touchscreen=1" or "ignore_lcd=1" in
1131 config.txt to stop the firmware polling the touchscreen.
1132 Load: dtoverlay=edt-ft5406,<param>=<val>
1133 Params: sizex Touchscreen size x (default 800)
1134 sizey Touchscreen size y (default 480)
1135 invx Touchscreen inverted x axis
1136 invy Touchscreen inverted y axis
1137 swapxy Touchscreen swapped x y axis
1138 i2c0 Choose the I2C0 bus on GPIOs 0&1
1139 i2c1 Choose the I2C1 bus on GPIOs 2&3
1140 i2c3 Choose the I2C3 bus (configure with the i2c3
1141 overlay - BCM2711 only)
1142 i2c4 Choose the I2C4 bus (configure with the i2c4
1143 overlay - BCM2711 only)
1144 i2c5 Choose the I2C5 bus (configure with the i2c5
1145 overlay - BCM2711 only)
1146 i2c6 Choose the I2C6 bus (configure with the i2c6
1147 overlay - BCM2711 only)
1148 addr Sets the address for the touch controller. Note
1149 that the device must be configured to use the
1154 Info: Overlay for the Microchip ENC28J60 Ethernet Controller on SPI0
1155 Load: dtoverlay=enc28j60,<param>=<val>
1156 Params: int_pin GPIO used for INT (default 25)
1158 speed SPI bus speed (default 12000000)
1162 Info: Overlay for the Microchip ENC28J60 Ethernet Controller on SPI2
1163 Load: dtoverlay=enc28j60-spi2,<param>=<val>
1164 Params: int_pin GPIO used for INT (default 39)
1166 speed SPI bus speed (default 12000000)
1170 Info: Enables I2C connected EETI EXC3000 multiple touch controller using
1171 GPIO 4 (pin 7 on GPIO header) for interrupt.
1172 Load: dtoverlay=exc3000,<param>=<val>
1173 Params: interrupt GPIO used for interrupt (default 4)
1174 sizex Touchscreen size x (default 4096)
1175 sizey Touchscreen size y (default 4096)
1176 invx Touchscreen inverted x axis
1177 invy Touchscreen inverted y axis
1178 swapxy Touchscreen swapped x y axis
1182 Info: Overlay for SPI-connected displays using the fbtft drivers.
1184 This overlay seeks to replace the functionality provided by fbtft_device
1185 which is now gone from the kernel.
1187 Most displays from fbtft_device have been ported over.
1189 dtoverlay=fbtft,spi0-0,rpi-display,reset_pin=23,dc_pin=24,led_pin=18,rotate=270
1191 It is also possible to specify the controller (this will use the default
1192 init sequence in the driver).
1194 dtoverlay=fbtft,spi0-0,ili9341,bgr,reset_pin=23,dc_pin=24,led_pin=18,rotate=270
1196 For devices on spi1 or spi2, the interfaces should be enabled
1197 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
1199 The following features of fbtft_device have not been ported over:
1200 - parallel bus is not supported
1201 - the init property which overrides the controller initialization
1202 sequence is not supported as a parameter due to memory limitations in
1203 the bootloader responsible for applying the overlay.
1205 See https://github.com/notro/fbtft/wiki/FBTFT-RPI-overlays for how to
1208 Load: dtoverlay=fbtft,<param>=<val>
1210 spi<n>-<m> Configure device at spi<n>, cs<m>
1212 speed SPI bus speed in Hz (default 32000000)
1213 cpha Shifted clock phase (CPHA) mode
1214 cpol Inverse clock polarity (CPOL) mode
1216 adafruit18 Adafruit 1.8
1217 adafruit22 Adafruit 2.2 (old)
1218 adafruit22a Adafruit 2.2
1219 adafruit28 Adafruit 2.8
1220 adafruit13m Adafruit 1.3 OLED
1221 admatec_c-berry28 C-Berry28
1223 er_tftm050_2 ER-TFTM070-2
1224 er_tftm070_5 ER-TFTM070-5
1226 ew24ha0_9bit EW24HA0 in 9-bit mode
1227 freetronicsoled128 Freetronics OLED128
1230 itdb28_spi ITDB02-2.8 with SPI interface circuit
1231 mi0283qt-2 Watterott MI0283QT-2
1232 mi0283qt-9a Watterott MI0283QT-9A
1233 nokia3310 Nokia 3310
1234 nokia3310a Nokia 3310a
1235 nokia5110 Nokia 5110
1237 pitft Adafruit PiTFT 2.8
1239 rpi-display Watterott rpi-display
1240 sainsmart18 Sainsmart 1.8
1241 sainsmart32_spi Sainsmart 3.2 with SPI interfce circuit
1242 tinylcd35 TinyLCD 3.5
1243 tm022hdh26 Tianma TM022HDH26
1244 tontec35_9481 Tontect 3.5 with ILI9481 controller
1245 tontec35_9486 Tontect 3.5 with ILI9486 controller
1246 waveshare32b Waveshare 3.2
1247 waveshare22 Waveshare 2.2
1249 bd663474 BD663474 display controller
1250 hx8340bn HX8340BN display controller
1251 hx8347d HX8347D display controller
1252 hx8353d HX8353D display controller
1253 hx8357d HX8357D display controller
1254 ili9163 ILI9163 display controller
1255 ili9320 ILI9320 display controller
1256 ili9325 ILI9325 display controller
1257 ili9340 ILI9340 display controller
1258 ili9341 ILI9341 display controller
1259 ili9481 ILI9481 display controller
1260 ili9486 ILI9486 display controller
1261 pcd8544 PCD8544 display controller
1262 ra8875 RA8875 display controller
1263 s6d02a1 S6D02A1 display controller
1264 s6d1121 S6D1121 display controller
1265 seps525 SEPS525 display controller
1266 sh1106 SH1106 display controller
1267 ssd1289 SSD1289 display controller
1268 ssd1305 SSD1305 display controller
1269 ssd1306 SSD1306 display controller
1270 ssd1325 SSD1325 display controller
1271 ssd1331 SSD1331 display controller
1272 ssd1351 SSD1351 display controller
1273 st7735r ST7735R display controller
1274 st7789v ST7789V display controller
1275 tls8204 TLS8204 display controller
1276 uc1611 UC1611 display controller
1277 uc1701 UC1701 display controller
1278 upd161704 UPD161704 display controller
1280 width Display width in pixels
1281 height Display height in pixels
1282 regwidth Display controller register width (default is
1284 buswidth Display bus interface width (default 8)
1285 debug Debug output level {0-7}
1286 rotate Display rotation {0, 90, 180, 270} (counter
1287 clockwise). Not supported by all drivers.
1288 bgr Enable BGR mode (default off). Use if Red and
1289 Blue are swapped. Not supported by all drivers.
1290 fps Frames per second (default 30). In effect this
1291 states how long the driver will wait after video
1292 memory has been changed until display update
1293 transfer is started.
1294 txbuflen Length of the FBTFT transmit buffer
1296 startbyte Sets the Start byte used by fb_ili9320,
1297 fb_ili9325 and fb_hx8347d. Common value is 0x70.
1298 gamma String representation of Gamma Curve(s). Driver
1299 specific. Not supported by all drivers.
1300 reset_pin GPIO pin for RESET
1301 dc_pin GPIO pin for D/C
1302 led_pin GPIO pin for LED backlight
1306 Info: Configures the Fe-Pi Audio Sound Card
1307 Load: dtoverlay=fe-pi-audio
1312 Info: A demonstration of the gpio-fsm driver. The GPIOs are chosen to work
1313 nicely with a "traffic-light" display of red, amber and green LEDs on
1314 GPIOs 7, 8 and 25 respectively.
1315 Load: dtoverlay=fsm-demo,<param>=<val>
1316 Params: fsm_debug Enable debug logging (default off)
1320 Info: Enables GalaxyCore's GC9A01 single chip driver based displays on
1321 SPI0 as fb1, using GPIOs DC=25, RST=27 and BL=18 (physical
1322 GPIO header pins 22, 13 and 12 respectively) in addition to the
1323 SPI0 pins DIN=10, CLK=11 and CS=8 (physical GPIO header pins 19,
1324 23 and 24 respectively).
1325 Load: dtoverlay=gc9a01,<param>=<val>
1326 Params: speed Display SPI bus speed
1328 rotate Display rotation {0,90,180,270}
1330 width Width of the display
1332 height Height of the display
1334 fps Delay between frame updates
1336 debug Debug output level {0-7}
1340 Info: An overlay for the Ghost amplifier.
1341 Load: dtoverlay=ghost-amp,<param>=<val>
1342 Params: fsm_debug Enable debug logging of the GPIO FSM (default
1347 Info: Enables I2C connected Goodix gt9271 multiple touch controller using
1348 GPIOs 4 and 17 (pins 7 and 11 on GPIO header) for interrupt and reset.
1349 Load: dtoverlay=goodix,<param>=<val>
1350 Params: interrupt GPIO used for interrupt (default 4)
1351 reset GPIO used for reset (default 17)
1354 Name: googlevoicehat-soundcard
1355 Info: Configures the Google voiceHAT soundcard
1356 Load: dtoverlay=googlevoicehat-soundcard
1361 Info: This is a generic overlay for detecting charger with GPIO.
1362 Load: dtoverlay=gpio-charger,<param>=<val>
1363 Params: gpio GPIO pin to trigger on (default 4)
1364 active_low When this is 1 (active low), a falling
1365 edge generates a charging event and a
1366 rising edge generates a discharging event.
1367 When this is 0 (active high), this is
1368 reversed. The default is 0 (active high)
1369 gpio_pull Desired pull-up/down state (off, down, up)
1371 type Set a charger type for the pin. (Default: mains)
1375 Info: Configure a GPIO pin to control a cooling fan.
1376 Load: dtoverlay=gpio-fan,<param>=<val>
1377 Params: gpiopin GPIO used to control the fan (default 12)
1378 temp Temperature at which the fan switches on, in
1379 millicelcius (default 55000)
1380 hyst Temperature delta (in millicelcius) below
1381 temp at which the fan will drop to minrpm
1386 Info: Activate a "hog" for a GPIO - request that the kernel configures it as
1387 an output, driven low or high as indicated by the presence or absence
1388 of the active_low parameter. Note that a hogged GPIO is not available
1389 to other drivers or for gpioset/gpioget.
1390 Load: dtoverlay=gpio-hog,<param>=<val>
1391 Params: gpio GPIO pin to hog (default 26)
1392 active_low If set, the hog drives the GPIO low (defaults
1393 to off - the GPIO is driven high)
1397 Info: Use GPIO pin as rc-core style infrared receiver input. The rc-core-
1398 based gpio_ir_recv driver maps received keys directly to a
1399 /dev/input/event* device, all decoding is done by the kernel - LIRC is
1400 not required! The key mapping and other decoding parameters can be
1401 configured by "ir-keytable" tool.
1402 Load: dtoverlay=gpio-ir,<param>=<val>
1403 Params: gpio_pin Input pin number. Default is 18.
1405 gpio_pull Desired pull-up/down state (off, down, up)
1408 invert "1" = invert the input (active-low signalling).
1409 "0" = non-inverted input (active-high
1410 signalling). Default is "1".
1412 rc-map-name Default rc keymap (can also be changed by
1413 ir-keytable), defaults to "rc-rc6-mce"
1417 Info: Use GPIO pin as bit-banged infrared transmitter output.
1418 This is an alternative to "pwm-ir-tx". gpio-ir-tx doesn't require
1419 a PWM so it can be used together with onboard analog audio.
1420 Load: dtoverlay=gpio-ir-tx,<param>=<val>
1421 Params: gpio_pin Output GPIO (default 18)
1423 invert "1" = invert the output (make it active-low).
1424 Default is "0" (active-high).
1428 Info: This is a generic overlay for activating GPIO keypresses using
1429 the gpio-keys library and this dtoverlay. Multiple keys can be
1430 set up using multiple calls to the overlay for configuring
1431 additional buttons or joysticks. You can see available keycodes
1432 at https://github.com/torvalds/linux/blob/v4.12/include/uapi/
1433 linux/input-event-codes.h#L64
1434 Load: dtoverlay=gpio-key,<param>=<val>
1435 Params: gpio GPIO pin to trigger on (default 3)
1436 active_low When this is 1 (active low), a falling
1437 edge generates a key down event and a
1438 rising edge generates a key up event.
1439 When this is 0 (active high), this is
1440 reversed. The default is 1 (active low)
1441 gpio_pull Desired pull-up/down state (off, down, up)
1442 Default is "up". Note that the default pin
1443 (GPIO3) has an external pullup
1444 label Set a label for the key
1445 keycode Set the key code for the button
1450 Info: This is a generic overlay for activating LEDs (or any other component)
1451 by a GPIO pin. Multiple LEDs can be set up using multiple calls to the
1452 overlay. While there are many existing methods to activate LEDs on the
1453 RPi, this method offers some advantages:
1454 1) Does not require any userspace programs.
1455 2) LEDs can be connected to the kernel's led-trigger framework,
1456 and drive the LED based on triggers such as cpu load, heartbeat,
1457 kernel panic, key input, timers and others.
1458 3) LED can be tied to the input state of another GPIO pin.
1459 4) The LED is setup early during the kernel boot process (useful
1460 for cpu/heartbeat/panic triggers).
1462 Typical electrical connection is:
1463 RPI-GPIO.19 -> LED -> 300ohm resister -> RPI-GND
1464 The GPIO pin number can be changed with the 'gpio=' parameter.
1466 To control an LED from userspace, write a 0 or 1 value:
1467 echo 1 > /sys/class/leds/myled1/brightness
1468 The 'myled1' name can be changed with the 'label=' parameter.
1470 To connect the LED to a kernel trigger from userspace:
1471 echo cpu > /sys/class/leds/myled1/trigger
1472 echo heartbeat > /sys/class/leds/myled1/trigger
1473 echo none > /sys/class/leds/myled1/trigger
1474 To connect the LED to GPIO.26 pin (physical pin 37):
1475 echo gpio > /sys/class/leds/myled1/trigger
1476 echo 26 > /sys/class/leds/myled1/gpio
1478 cat /sys/class/leds/myled1/trigger
1480 More information about the Linux kernel LED/Trigger system:
1481 https://www.kernel.org/doc/Documentation/leds/leds-class.rst
1482 https://www.kernel.org/doc/Documentation/leds/ledtrig-oneshot.rst
1483 Load: dtoverlay=gpio-led,<param>=<val>
1484 Params: gpio GPIO pin connected to the LED (default 19)
1485 label The label for this LED. It will appear under
1486 /sys/class/leds/<label> . Default 'myled1'.
1487 trigger Set the led-trigger to connect to this LED.
1488 default 'none' (LED is user-controlled).
1489 Some possible triggers:
1490 cpu - CPU load (all CPUs)
1491 cpu0 - CPU load of first CPU.
1492 mmc - disk activity (all disks)
1493 panic - turn on on kernel panic
1494 heartbeat - indicate system health
1495 gpio - connect to a GPIO input pin (note:
1496 currently the GPIO PIN can not be set
1497 using overlay parameters, must be
1498 done in userspace, see examples above.
1499 active_low Set to 1 to turn invert the LED control
1500 (writing 0 to /sys/class/leds/XXX/brightness
1501 will turn on the GPIO/LED). Default '0'.
1504 Name: gpio-no-bank0-irq
1505 Info: Use this overlay to disable GPIO interrupts for GPIOs in bank 0 (0-27),
1506 which can be useful for UIO drivers.
1507 N.B. Using this overlay will trigger a kernel WARN during booting, but
1508 this can safely be ignored - the system should work as expected.
1509 Load: dtoverlay=gpio-no-bank0-irq
1514 Info: Use this overlay to disable all GPIO interrupts, which can be useful
1515 for user-space GPIO edge detection systems.
1516 Load: dtoverlay=gpio-no-irq
1521 Info: Drives a GPIO high or low on poweroff (including halt). Using this
1522 overlay interferes with the normal power-down sequence, preventing the
1523 kernel from resetting the SoC (a necessary step in a normal power-off
1524 or reboot). This also disables the ability to trigger a boot by driving
1527 The GPIO starts in an inactive state. At poweroff time it is driven
1528 active for 100ms, then inactive for 100ms, then active again. It is
1529 safe to remove the power at any point after the initial activation of
1532 Users of this overlay are required to provide an external mechanism to
1533 switch off the power supply when signalled - failure to do so results
1534 in a kernel BUG, increased power consumption and undefined behaviour.
1535 Load: dtoverlay=gpio-poweroff,<param>=<val>
1536 Params: gpiopin GPIO for signalling (default 26)
1538 active_low Set if the power control device requires a
1539 high->low transition to trigger a power-down.
1540 Note that this will require the support of a
1541 custom dt-blob.bin to prevent a power-down
1542 during the boot process, and that a reboot
1543 will also cause the pin to go low.
1544 input Set if the gpio pin should be configured as
1546 export Set to export the configured pin to sysfs
1547 active_delay_ms Initial GPIO active period (default 100)
1548 inactive_delay_ms Subsequent GPIO inactive period (default 100)
1549 timeout_ms Specify (in ms) how long the kernel waits for
1550 power-down before issuing a WARN (default 3000).
1554 Info: Initiates a shutdown when GPIO pin changes. The given GPIO pin
1555 is configured as an input key that generates KEY_POWER events.
1557 This event is handled by systemd-logind by initiating a
1558 shutdown. Systemd versions older than 225 need an udev rule
1559 enable listening to the input device:
1561 ACTION!="REMOVE", SUBSYSTEM=="input", KERNEL=="event*", \
1562 SUBSYSTEMS=="platform", DRIVERS=="gpio-keys", \
1563 ATTRS{keys}=="116", TAG+="power-switch"
1565 Alternatively this event can be handled also on systems without
1566 systemd, just by traditional SysV init daemon. KEY_POWER event
1567 (keycode 116) needs to be mapped to KeyboardSignal on console
1568 and then kb::kbrequest inittab action which is triggered by
1569 KeyboardSignal from console can be configured to issue system
1570 shutdown. Steps for this configuration are:
1572 Add following lines to the /etc/console-setup/remap.inc file:
1574 # Key Power as special keypress
1575 keycode 116 = KeyboardSignal
1577 Then add following lines to /etc/inittab file:
1579 # Action on special keypress (Key Power)
1580 kb::kbrequest:/sbin/shutdown -t1 -a -h -P now
1582 And finally reload configuration by calling following commands:
1584 # dpkg-reconfigure console-setup
1585 # service console-setup reload
1588 This overlay only handles shutdown. After shutdown, the system
1589 can be powered up again by driving GPIO3 low. The default
1590 configuration uses GPIO3 with a pullup, so if you connect a
1591 button between GPIO3 and GND (pin 5 and 6 on the 40-pin header),
1592 you get a shutdown and power-up button. Please note that
1593 Raspberry Pi 1 Model B rev 1 uses GPIO1 instead of GPIO3.
1594 Load: dtoverlay=gpio-shutdown,<param>=<val>
1595 Params: gpio_pin GPIO pin to trigger on (default 3)
1596 For Raspberry Pi 1 Model B rev 1 set this
1597 explicitly to value 1, e.g.:
1599 dtoverlay=gpio-shutdown,gpio_pin=1
1601 active_low When this is 1 (active low), a falling
1602 edge generates a key down event and a
1603 rising edge generates a key up event.
1604 When this is 0 (active high), this is
1605 reversed. The default is 1 (active low).
1607 gpio_pull Desired pull-up/down state (off, down, up)
1610 Note that the default pin (GPIO3) has an
1611 external pullup. Same applies for GPIO1
1612 on Raspberry Pi 1 Model B rev 1.
1614 debounce Specify the debounce interval in milliseconds
1619 Info: Configures an HD44780 compatible LCD display. Uses 4 gpio pins for
1620 data, 2 gpio pins for enable and register select and 1 optional pin
1621 for enabling/disabling the backlight display.
1622 Load: dtoverlay=hd44780-lcd,<param>=<val>
1623 Params: pin_d4 GPIO pin for data pin D4 (default 6)
1625 pin_d5 GPIO pin for data pin D5 (default 13)
1627 pin_d6 GPIO pin for data pin D6 (default 19)
1629 pin_d7 GPIO pin for data pin D7 (default 26)
1631 pin_en GPIO pin for "Enable" (default 21)
1633 pin_rs GPIO pin for "Register Select" (default 20)
1635 pin_bl Optional pin for enabling/disabling the
1636 display backlight. (default disabled)
1638 display_height Height of the display in characters
1640 display_width Width of the display in characters
1643 Name: hdmi-backlight-hwhack-gpio
1644 Info: Devicetree overlay for GPIO based backlight on/off capability.
1645 Use this if you have one of those HDMI displays whose backlight cannot
1646 be controlled via DPMS over HDMI and plan to do a little soldering to
1647 use an RPi gpio pin for on/off switching. See:
1648 https://www.waveshare.com/wiki/7inch_HDMI_LCD_(C)#Backlight_Control
1649 Load: dtoverlay=hdmi-backlight-hwhack-gpio,<param>=<val>
1650 Params: gpio_pin GPIO pin used (default 17)
1651 active_low Set this to 1 if the display backlight is
1652 switched on when the wire goes low.
1653 Leave the default (value 0) if the backlight
1654 expects a high to switch it on.
1658 Info: Configures the HifiBerry Amp and Amp+ audio cards
1659 Load: dtoverlay=hifiberry-amp
1663 Name: hifiberry-amp100
1664 Info: Configures the HifiBerry AMP100 audio card
1665 Load: dtoverlay=hifiberry-amp100,<param>=<val>
1666 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1667 Digital volume control. Enable with
1668 "dtoverlay=hifiberry-amp100,24db_digital_gain"
1669 (The default behaviour is that the Digital
1670 volume control is limited to a maximum of
1671 0dB. ie. it can attenuate but not provide
1672 gain. For most users, this will be desired
1673 as it will prevent clipping. By appending
1674 the 24dB_digital_gain parameter, the Digital
1675 volume control will allow up to 24dB of
1676 gain. If this parameter is enabled, it is the
1677 responsibility of the user to ensure that
1678 the Digital volume control is set to a value
1679 that does not result in clipping/distortion!)
1680 slave Force AMP100 into slave mode, using Pi as
1681 master for bit clock and frame clock.
1682 leds_off If set to 'true' the onboard indicator LEDs
1683 are switched off at all times.
1684 auto_mute If set to 'true' the amplifier is automatically
1685 muted when the DAC is not playing.
1686 mute_ext_ctl The amplifier's HW mute control is enabled
1687 in ALSA mixer and set to <val>.
1688 Will be overwritten by ALSA user settings.
1691 Name: hifiberry-amp3
1692 Info: Configures the HifiBerry Amp3 audio card
1693 Load: dtoverlay=hifiberry-amp3
1698 Info: Configures the HifiBerry DAC audio cards
1699 Load: dtoverlay=hifiberry-dac
1703 Name: hifiberry-dacplus
1704 Info: Configures the HifiBerry DAC+ audio card
1705 Load: dtoverlay=hifiberry-dacplus,<param>=<val>
1706 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1707 Digital volume control. Enable with
1708 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
1709 (The default behaviour is that the Digital
1710 volume control is limited to a maximum of
1711 0dB. ie. it can attenuate but not provide
1712 gain. For most users, this will be desired
1713 as it will prevent clipping. By appending
1714 the 24dB_digital_gain parameter, the Digital
1715 volume control will allow up to 24dB of
1716 gain. If this parameter is enabled, it is the
1717 responsibility of the user to ensure that
1718 the Digital volume control is set to a value
1719 that does not result in clipping/distortion!)
1720 slave Force DAC+ into slave mode, using Pi as
1721 master for bit clock and frame clock.
1722 leds_off If set to 'true' the onboard indicator LEDs
1723 are switched off at all times.
1726 Name: hifiberry-dacplusadc
1727 Info: Configures the HifiBerry DAC+ADC audio card
1728 Load: dtoverlay=hifiberry-dacplusadc,<param>=<val>
1729 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1730 Digital volume control. Enable with
1731 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
1732 (The default behaviour is that the Digital
1733 volume control is limited to a maximum of
1734 0dB. ie. it can attenuate but not provide
1735 gain. For most users, this will be desired
1736 as it will prevent clipping. By appending
1737 the 24dB_digital_gain parameter, the Digital
1738 volume control will allow up to 24dB of
1739 gain. If this parameter is enabled, it is the
1740 responsibility of the user to ensure that
1741 the Digital volume control is set to a value
1742 that does not result in clipping/distortion!)
1743 slave Force DAC+ADC into slave mode, using Pi as
1744 master for bit clock and frame clock.
1745 leds_off If set to 'true' the onboard indicator LEDs
1746 are switched off at all times.
1749 Name: hifiberry-dacplusadcpro
1750 Info: Configures the HifiBerry DAC+ADC PRO audio card
1751 Load: dtoverlay=hifiberry-dacplusadcpro,<param>=<val>
1752 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1753 Digital volume control. Enable with
1754 "dtoverlay=hifiberry-dacplusadcpro,24db_digital_gain"
1755 (The default behaviour is that the Digital
1756 volume control is limited to a maximum of
1757 0dB. ie. it can attenuate but not provide
1758 gain. For most users, this will be desired
1759 as it will prevent clipping. By appending
1760 the 24dB_digital_gain parameter, the Digital
1761 volume control will allow up to 24dB of
1762 gain. If this parameter is enabled, it is the
1763 responsibility of the user to ensure that
1764 the Digital volume control is set to a value
1765 that does not result in clipping/distortion!)
1766 slave Force DAC+ADC Pro into slave mode, using Pi as
1767 master for bit clock and frame clock.
1768 leds_off If set to 'true' the onboard indicator LEDs
1769 are switched off at all times.
1772 Name: hifiberry-dacplusdsp
1773 Info: Configures the HifiBerry DAC+DSP audio card
1774 Load: dtoverlay=hifiberry-dacplusdsp
1778 Name: hifiberry-dacplushd
1779 Info: Configures the HifiBerry DAC+ HD audio card
1780 Load: dtoverlay=hifiberry-dacplushd
1784 Name: hifiberry-digi
1785 Info: Configures the HifiBerry Digi and Digi+ audio card
1786 Load: dtoverlay=hifiberry-digi
1790 Name: hifiberry-digi-pro
1791 Info: Configures the HifiBerry Digi+ Pro and Digi2 Pro audio card
1792 Load: dtoverlay=hifiberry-digi-pro
1797 Info: Enables "High Peripheral" mode
1798 Load: dtoverlay=highperi
1803 Info: HY28A - 2.8" TFT LCD Display Module by HAOYU Electronics
1804 Default values match Texy's display shield
1805 Load: dtoverlay=hy28a,<param>=<val>
1806 Params: speed Display SPI bus speed
1808 rotate Display rotation {0,90,180,270}
1810 fps Delay between frame updates
1812 debug Debug output level {0-7}
1814 xohms Touchpanel sensitivity (X-plate resistance)
1816 resetgpio GPIO used to reset controller
1818 ledgpio GPIO used to control backlight
1822 Info: HY28B - 2.8" TFT LCD Display Module by HAOYU Electronics
1823 Default values match Texy's display shield
1824 Load: dtoverlay=hy28b,<param>=<val>
1825 Params: speed Display SPI bus speed
1827 rotate Display rotation {0,90,180,270}
1829 fps Delay between frame updates
1831 debug Debug output level {0-7}
1833 xohms Touchpanel sensitivity (X-plate resistance)
1835 resetgpio GPIO used to reset controller
1837 ledgpio GPIO used to control backlight
1841 Info: HY28B 2017 version - 2.8" TFT LCD Display Module by HAOYU Electronics
1842 Default values match Texy's display shield
1843 Load: dtoverlay=hy28b-2017,<param>=<val>
1844 Params: speed Display SPI bus speed
1846 rotate Display rotation {0,90,180,270}
1848 fps Delay between frame updates
1850 debug Debug output level {0-7}
1852 xohms Touchpanel sensitivity (X-plate resistance)
1854 resetgpio GPIO used to reset controller
1856 ledgpio GPIO used to control backlight
1860 Info: Configures the Audiophonics I-SABRE Q2M DAC
1861 Load: dtoverlay=i-sabre-q2m
1866 Info: Fall back to the i2c_bcm2708 driver for the i2c_arm bus.
1867 Load: dtoverlay=i2c-bcm2708
1872 Info: Adds support for a number of I2C fan controllers
1873 Load: dtoverlay=i2c-fan,<param>=<val>
1874 Params: addr Sets the address for the fan controller. Note
1875 that the device must be configured to use the
1878 i2c0 Choose the I2C0 bus on GPIOs 0&1
1880 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
1882 i2c3 Choose the I2C3 bus (configure with the i2c3
1883 overlay - BCM2711 only)
1885 i2c4 Choose the I2C4 bus (configure with the i2c4
1886 overlay - BCM2711 only)
1888 i2c5 Choose the I2C5 bus (configure with the i2c5
1889 overlay - BCM2711 only)
1891 i2c6 Choose the I2C6 bus (configure with the i2c6
1892 overlay - BCM2711 only)
1894 minpwm PWM setting for the fan when the SoC is below
1895 mintemp (range 0-255. default 0)
1896 maxpwm PWM setting for the fan when the SoC is above
1897 maxtemp (range 0-255. default 255)
1898 midtemp Temperature (in millicelcius) at which the fan
1899 begins to speed up (default 50000)
1901 midtemp_hyst Temperature delta (in millicelcius) below
1902 mintemp at which the fan will drop to minrpm
1905 maxtemp Temperature (in millicelcius) at which the fan
1906 will be held at maxrpm (default 70000)
1908 maxtemp_hyst Temperature delta (in millicelcius) below
1909 maxtemp at which the fan begins to slow down
1912 emc2301 Select the Microchip EMC230x controller family
1913 - EMC2301, EMC2302, EMC2303, EMC2305.
1917 Info: Adds support for software i2c controller on gpio pins
1918 Load: dtoverlay=i2c-gpio,<param>=<val>
1919 Params: i2c_gpio_sda GPIO used for I2C data (default "23")
1921 i2c_gpio_scl GPIO used for I2C clock (default "24")
1923 i2c_gpio_delay_us Clock delay in microseconds
1924 (default "2" = ~100kHz)
1926 bus Set to a unique, non-zero value if wanting
1927 multiple i2c-gpio busses. If set, will be used
1928 as the preferred bus number (/dev/i2c-<n>). If
1929 not set, the default value is 0, but the bus
1930 number will be dynamically assigned - probably
1935 Info: Adds support for a number of I2C bus multiplexers on i2c_arm
1936 Load: dtoverlay=i2c-mux,<param>=<val>
1937 Params: pca9542 Select the NXP PCA9542 device
1939 pca9545 Select the NXP PCA9545 device
1941 pca9548 Select the NXP PCA9548 device
1943 addr Change I2C address of the device (default 0x70)
1945 i2c0 Choose the I2C0 bus on GPIOs 0&1
1947 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
1949 i2c3 Choose the I2C3 bus (configure with the i2c3
1950 overlay - BCM2711 only)
1952 i2c4 Choose the I2C3 bus (configure with the i2c3
1953 overlay - BCM2711 only)
1955 i2c5 Choose the I2C5 bus (configure with the i2c4
1956 overlay - BCM2711 only)
1958 i2c6 Choose the I2C6 bus (configure with the i2c6
1959 overlay - BCM2711 only)
1962 [ The i2c-mux-pca9548a overlay has been deleted. See i2c-mux. ]
1965 Name: i2c-pwm-pca9685a
1966 Info: Adds support for an NXP PCA9685A I2C PWM controller on i2c_arm
1967 Load: dtoverlay=i2c-pwm-pca9685a,<param>=<val>
1968 Params: addr I2C address of PCA9685A (default 0x40)
1969 i2c0 Choose the I2C0 bus on GPIOs 0&1
1970 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
1971 i2c3 Choose the I2C3 bus (configure with the i2c3
1972 overlay - BCM2711 only)
1973 i2c4 Choose the I2C3 bus (configure with the i2c3
1974 overlay - BCM2711 only)
1975 i2c5 Choose the I2C5 bus (configure with the i2c4
1976 overlay - BCM2711 only)
1977 i2c6 Choose the I2C6 bus (configure with the i2c6
1978 overlay - BCM2711 only)
1982 Info: Adds support for a number of I2C Real Time Clock devices
1983 Load: dtoverlay=i2c-rtc,<param>=<val>
1984 Params: abx80x Select one of the ABx80x family:
1985 AB0801, AB0803, AB0804, AB0805,
1986 AB1801, AB1803, AB1804, AB1805
1988 bq32000 Select the TI BQ32000 device
1990 ds1307 Select the DS1307 device
1992 ds1339 Select the DS1339 device
1994 ds1340 Select the DS1340 device
1996 ds3231 Select the DS3231 device
1998 m41t62 Select the M41T62 device
2000 mcp7940x Select the MCP7940x device
2002 mcp7941x Select the MCP7941x device
2004 pcf2127 Select the PCF2127 device
2006 pcf2129 Select the PCF2129 device
2008 pcf85063 Select the PCF85063 device
2010 pcf85063a Select the PCF85063A device
2012 pcf8523 Select the PCF8523 device
2014 pcf85363 Select the PCF85363 device
2016 pcf8563 Select the PCF8563 device
2018 rv1805 Select the Micro Crystal RV1805 device
2020 rv3028 Select the Micro Crystal RV3028 device
2022 rv3032 Select the Micro Crystal RV3032 device
2024 rv8803 Select the Micro Crystal RV8803 device
2026 sd3078 Select the ZXW Shenzhen whwave SD3078 device
2028 s35390a Select the ABLIC S35390A device
2030 i2c0 Choose the I2C0 bus on GPIOs 0&1
2032 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2034 i2c3 Choose the I2C3 bus (configure with the i2c3
2035 overlay - BCM2711 only)
2037 i2c4 Choose the I2C3 bus (configure with the i2c3
2038 overlay - BCM2711 only)
2040 i2c5 Choose the I2C5 bus (configure with the i2c4
2041 overlay - BCM2711 only)
2043 i2c6 Choose the I2C6 bus (configure with the i2c6
2044 overlay - BCM2711 only)
2046 addr Sets the address for the RTC. Note that the
2047 device must be configured to use the specified
2050 trickle-diode-disable Do not use the internal trickle charger diode
2053 trickle-diode-type Diode type for trickle charge - "standard" or
2054 "schottky" (ABx80x and RV1805 only)
2056 trickle-resistor-ohms Resistor value for trickle charge (DS1339,
2057 ABx80x, BQ32000, RV1805, RV3028, RV3032)
2059 trickle-voltage-mv Charge pump voltage for trickle charge (RV3032)
2061 wakeup-source Specify that the RTC can be used as a wakeup
2064 backup-switchover-mode Backup power supply switch mode. Must be 0 for
2065 off or 1 for Vdd < VBackup (RV3028, RV3032)
2069 Info: Adds support for a number of I2C Real Time Clock devices
2070 using the software i2c controller
2071 Load: dtoverlay=i2c-rtc-gpio,<param>=<val>
2072 Params: abx80x Select one of the ABx80x family:
2073 AB0801, AB0803, AB0804, AB0805,
2074 AB1801, AB1803, AB1804, AB1805
2076 bq32000 Select the TI BQ32000 device
2078 ds1307 Select the DS1307 device
2080 ds1339 Select the DS1339 device
2082 ds1340 Select the DS1340 device
2084 ds3231 Select the DS3231 device
2086 m41t62 Select the M41T62 device
2088 mcp7940x Select the MCP7940x device
2090 mcp7941x Select the MCP7941x device
2092 pcf2127 Select the PCF2127 device
2094 pcf2129 Select the PCF2129 device
2096 pcf85063 Select the PCF85063 device
2098 pcf85063a Select the PCF85063A device
2100 pcf8523 Select the PCF8523 device
2102 pcf85363 Select the PCF85363 device
2104 pcf8563 Select the PCF8563 device
2106 rv1805 Select the Micro Crystal RV1805 device
2108 rv3028 Select the Micro Crystal RV3028 device
2110 rv3032 Select the Micro Crystal RV3032 device
2112 rv8803 Select the Micro Crystal RV8803 device
2114 sd3078 Select the ZXW Shenzhen whwave SD3078 device
2116 s35390a Select the ABLIC S35390A device
2118 addr Sets the address for the RTC. Note that the
2119 device must be configured to use the specified
2122 trickle-diode-disable Do not use the internal trickle charger diode
2125 trickle-diode-type Diode type for trickle charge - "standard" or
2126 "schottky" (ABx80x and RV1805 only)
2128 trickle-resistor-ohms Resistor value for trickle charge (DS1339,
2129 ABx80x, BQ32000, RV1805, RV3028, RV3032)
2131 trickle-voltage-mv Charge pump voltage for trickle charge (RV3032)
2133 wakeup-source Specify that the RTC can be used as a wakeup
2136 backup-switchover-mode Backup power supply switch mode. Must be 0 for
2137 off or 1 for Vdd < VBackup (RV3028, RV3032)
2139 i2c_gpio_sda GPIO used for I2C data (default "23")
2141 i2c_gpio_scl GPIO used for I2C clock (default "24")
2143 i2c_gpio_delay_us Clock delay in microseconds
2144 (default "2" = ~100kHz)
2148 Info: Adds support for a number of I2C barometric pressure, temperature,
2149 light level and chemical sensors on i2c_arm
2150 Load: dtoverlay=i2c-sensor,<param>=<val>
2151 Params: addr Set the address for the ADT7410, BH1750, BME280,
2152 BME680, BMP280, BMP380, CCS811, DS1621, HDC100X,
2153 JC42, LM75, MCP980x, MPU6050, MPU9250, MS5637,
2154 MS5803, MS5805, MS5837, MS8607, SHT3x or TMP102
2156 adt7410 Select the Analog Devices ADT7410 and ADT7420
2158 Valid address 0x48-0x4b, default 0x48
2160 aht10 Select the Aosong AHT10 temperature and humidity
2163 bh1750 Select the Rohm BH1750 ambient light sensor
2164 Valid addresses 0x23 or 0x5c, default 0x23
2166 bme280 Select the Bosch Sensortronic BME280
2167 Valid addresses 0x76-0x77, default 0x76
2169 bme680 Select the Bosch Sensortronic BME680
2170 Valid addresses 0x76-0x77, default 0x76
2172 bmp085 Select the Bosch Sensortronic BMP085
2174 bmp180 Select the Bosch Sensortronic BMP180
2176 bmp280 Select the Bosch Sensortronic BMP280
2177 Valid addresses 0x76-0x77, default 0x76
2179 bmp380 Select the Bosch Sensortronic BMP380
2180 Valid addresses 0x76-0x77, default 0x76
2182 bno055 Select the Bosch Sensortronic BNO055 IMU
2183 Valid address 0x28-0x29, default 0x29
2185 ccs811 Select the AMS CCS811 digital gas sensor
2186 Valid addresses 0x5a-0x5b, default 0x5b
2188 ds1621 Select the Dallas Semiconductors DS1621 temp
2189 sensor. Valid addresses 0x48-0x4f, default 0x48
2191 hdc100x Select the Texas Instruments HDC100x temp sensor
2192 Valid addresses 0x40-0x43, default 0x40
2194 htu21 Select the HTU21 temperature and humidity sensor
2196 int_pin Set the GPIO to use for interrupts (max30102,
2197 mpu6050 and mpu9250 only)
2199 jc42 Select any of the many JEDEC JC42.4-compliant
2200 temperature sensors, including:
2201 ADT7408, AT30TS00, CAT34TS02, CAT6095,
2202 MAX6604, MCP9804, MCP9805, MCP9808,
2203 MCP98242, MCP98243, MCP98244, MCP9843,
2204 SE97, SE98, STTS424(E), STTS2002, STTS3000,
2205 TSE2002, TSE2004, TS3000, and TS3001.
2206 The default address is 0x18.
2208 lm75 Select the Maxim LM75 temperature sensor
2209 Valid addresses 0x48-0x4f, default 0x4f
2211 lm75addr Deprecated - use addr parameter instead
2213 max17040 Select the Maxim Integrated MAX17040 battery
2216 max30102 Select the Maxim Integrated MAX30102 heart-rate
2217 and blood-oxygen sensor
2219 mcp980x Select the Maxim MCP980x range of temperature
2220 sensors (i.e. MCP9800, MCP9801, MCP9802 and
2221 MCP9803). N.B. For MCP9804, MCP9805 and MCP9808,
2222 use the "jc42" option.
2223 Valid addresses are 0x18-0x1f (default 0x18)
2225 mpu6050 Select the InvenSense MPU6050 IMU. Valid
2226 valid addresses are 0x68 and 0x69 (default 0x68)
2228 mpu9250 Select the InvenSense MPU9250 IMU. Valid
2229 valid addresses are 0x68 and 0x69 (default 0x68)
2231 ms5637 Select the Measurement Specialities MS5637
2232 pressure and temperature sensor.
2234 ms5803 Select the Measurement Specialities MS5803
2235 pressure and temperature sensor.
2237 ms5805 Select the Measurement Specialities MS5805
2238 pressure and temperature sensor.
2240 ms5837 Select the Measurement Specialities MS5837
2241 pressure and temperature sensor.
2243 ms8607 Select the Measurement Specialities MS8607
2244 pressure and temperature sensor.
2246 no_timeout Disable the SMBUS timeout. N.B. Only supported
2247 by some jc42 devices - using with an
2248 incompatible device can stop it from being
2251 reset_pin GPIO to be used to reset the device (bno055
2252 only, disabled by default)
2254 sht3x Select the Sensirion SHT3x temperature and
2255 humidity sensors. Valid addresses 0x44-0x45,
2258 sht4x Select the Sensirion SHT4x temperature and
2259 humidity sensors. Valid addresses 0x44-0x45,
2262 si7020 Select the Silicon Labs Si7013/20/21 humidity/
2265 sps30 Select the Sensirion SPS30 particulate matter
2266 sensor. Fixed address 0x69.
2268 sgp30 Select the Sensirion SGP30 VOC sensor.
2271 tmp102 Select the Texas Instruments TMP102 temp sensor
2272 Valid addresses 0x48-0x4b, default 0x48
2274 tsl4531 Select the AMS TSL4531 digital ambient light
2277 veml6070 Select the Vishay VEML6070 ultraviolet light
2280 i2c0 Choose the I2C0 bus on GPIOs 0&1
2282 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2284 i2c3 Choose the I2C3 bus (configure with the i2c3
2285 overlay - BCM2711 only)
2287 i2c4 Choose the I2C3 bus (configure with the i2c3
2288 overlay - BCM2711 only)
2290 i2c5 Choose the I2C5 bus (configure with the i2c4
2291 overlay - BCM2711 only)
2293 i2c6 Choose the I2C6 bus (configure with the i2c6
2294 overlay - BCM2711 only)
2298 Info: Change i2c0 pin usage. Not all pin combinations are usable on all
2299 platforms - platforms other then Compute Modules can only use this
2300 to disable transaction combining.
2301 Do NOT use in conjunction with dtparam=i2c_vc=on. From the 5.4 kernel
2302 onwards the base DT includes the use of i2c_mux_pinctrl to expose two
2303 muxings of BSC0 - GPIOs 0&1, and whichever combination is used for the
2304 camera and display connectors. This overlay disables that mux and
2305 configures /dev/i2c0 to point at whichever set of pins is requested.
2306 dtparam=i2c_vc=on will try and enable the mux, so combining the two
2307 will cause conflicts.
2308 Load: dtoverlay=i2c0,<param>=<val>
2309 Params: pins_0_1 Use pins 0 and 1 (default)
2310 pins_28_29 Use pins 28 and 29
2311 pins_44_45 Use pins 44 and 45
2312 pins_46_47 Use pins 46 and 47
2313 combine Allow transactions to be combined (default
2318 Info: Deprecated, legacy version of i2c0.
2323 Info: Enable i2c0 (Pi 5 only)
2324 Load: dtoverlay=i2c0-pi5,<param>=<val>
2325 Params: pins_0_1 Use GPIOs 0 and 1 (default)
2326 pins_8_9 Use GPIOs 8 and 9
2327 baudrate Set the baudrate for the interface (default
2332 Info: Change i2c1 pin usage. Not all pin combinations are usable on all
2333 platforms - platforms other then Compute Modules can only use this
2334 to disable transaction combining.
2335 Load: dtoverlay=i2c1,<param>=<val>
2336 Params: pins_2_3 Use pins 2 and 3 (default)
2337 pins_44_45 Use pins 44 and 45
2338 combine Allow transactions to be combined (default
2343 Info: Deprecated, legacy version of i2c1.
2348 Info: Enable i2c1 (Pi 5 only)
2349 Load: dtoverlay=i2c1-pi5,<param>=<val>
2350 Params: pins_2_3 Use GPIOs 2 and 3 (default)
2351 pins_10_11 Use GPIOs 10 and 11
2352 baudrate Set the baudrate for the interface (default
2357 Info: Enable i2c2 (Pi 5 only)
2358 Load: dtoverlay=i2c2-pi5,<param>=<val>
2359 Params: pins_4_5 Use GPIOs 4 and 5 (default)
2360 pins_12_13 Use GPIOs 12 and 13
2361 baudrate Set the baudrate for the interface (default
2366 Info: Enable the i2c3 bus. BCM2711 only.
2367 Load: dtoverlay=i2c3,<param>
2368 Params: pins_2_3 Use GPIOs 2 and 3
2369 pins_4_5 Use GPIOs 4 and 5 (default)
2370 baudrate Set the baudrate for the interface (default
2375 Info: Enable i2c3 (Pi 5 only)
2376 Load: dtoverlay=i2c3-pi5,<param>=<val>
2377 Params: pins_6_7 Use GPIOs 6 and 7 (default)
2378 pins_14_15 Use GPIOs 14 and 15
2379 pins_22_23 Use GPIOs 22 and 23
2380 baudrate Set the baudrate for the interface (default
2385 Info: Enable the i2c4 bus. BCM2711 only.
2386 Load: dtoverlay=i2c4,<param>
2387 Params: pins_6_7 Use GPIOs 6 and 7
2388 pins_8_9 Use GPIOs 8 and 9 (default)
2389 baudrate Set the baudrate for the interface (default
2394 Info: Enable the i2c5 bus. BCM2711 only.
2395 Load: dtoverlay=i2c5,<param>
2396 Params: pins_10_11 Use GPIOs 10 and 11
2397 pins_12_13 Use GPIOs 12 and 13 (default)
2398 baudrate Set the baudrate for the interface (default
2403 Info: Enable the i2c6 bus. BCM2711 only.
2404 Load: dtoverlay=i2c6,<param>
2405 Params: pins_0_1 Use GPIOs 0 and 1
2406 pins_22_23 Use GPIOs 22 and 23 (default)
2407 baudrate Set the baudrate for the interface (default
2412 Info: Configures any passive I2S DAC soundcard.
2413 Load: dtoverlay=i2s-dac
2418 Info: move I2S function block to GPIO 28 to 31
2419 Load: dtoverlay=i2s-gpio28-31
2424 Info: Enables I2C connected Ilitek 251x multiple touch controller using
2425 GPIO 4 (pin 7 on GPIO header) for interrupt.
2426 Load: dtoverlay=ilitek251x,<param>=<val>
2427 Params: interrupt GPIO used for interrupt (default 4)
2428 sizex Touchscreen size x, horizontal resolution of
2429 touchscreen (in pixels)
2430 sizey Touchscreen size y, vertical resolution of
2431 touchscreen (in pixels)
2435 Info: Sony IMX219 camera module.
2436 Uses Unicam 1, which is the standard camera connector on most Pi
2438 Load: dtoverlay=imx219,<param>=<val>
2439 Params: rotation Mounting rotation of the camera sensor (0 or
2441 orientation Sensor orientation (0 = front, 1 = rear,
2442 2 = external, default external)
2443 media-controller Configure use of Media Controller API for
2444 configuring the sensor (default on)
2445 cam0 Adopt the default configuration for CAM0 on a
2446 Compute Module (CSI0, i2c_vc, and cam0_reg).
2447 vcm Configure a VCM focus drive on the sensor.
2451 Info: Sony IMX258 camera module.
2452 Uses Unicam 1, which is the standard camera connector on most Pi
2454 Load: dtoverlay=imx258,<param>=<val>
2455 Params: rotation Mounting rotation of the camera sensor (0 or
2457 orientation Sensor orientation (0 = front, 1 = rear,
2458 2 = external, default external)
2459 media-controller Configure use of Media Controller API for
2460 configuring the sensor (default on)
2461 cam0 Adopt the default configuration for CAM0 on a
2462 Compute Module (CSI0, i2c_vc, and cam0_reg).
2463 vcm Configure a VCM focus drive on the sensor.
2464 4lane Enable 4 CSI2 lanes. This requires a Compute
2465 Module (1, 3, or 4).
2469 Info: Sony IMX290 camera module.
2470 Uses Unicam 1, which is the standard camera connector on most Pi
2472 Load: dtoverlay=imx290,<param>
2473 Params: 4lane Enable 4 CSI2 lanes. This requires a Compute
2474 Module (1, 3, or 4).
2475 clock-frequency Sets the clock frequency to match that used on
2477 Modules from Vision Components use 37.125MHz
2478 (the default), whilst those from Innomaker use
2480 mono Denote that the module is a mono sensor.
2481 orientation Sensor orientation (0 = front, 1 = rear,
2482 2 = external, default external)
2483 rotation Mounting rotation of the camera sensor (0 or
2485 media-controller Configure use of Media Controller API for
2486 configuring the sensor (default on)
2487 cam0 Adopt the default configuration for CAM0 on a
2488 Compute Module (CSI0, i2c_vc, and cam0_reg).
2492 Info: Sony IMX296 camera module.
2493 Uses Unicam 1, which is the standard camera connector on most Pi
2495 Load: dtoverlay=imx296,<param>=<val>
2496 Params: rotation Mounting rotation of the camera sensor (0 or
2498 orientation Sensor orientation (0 = front, 1 = rear,
2499 2 = external, default external)
2500 media-controller Configure use of Media Controller API for
2501 configuring the sensor (default on)
2502 cam0 Adopt the default configuration for CAM0 on a
2503 Compute Module (CSI0, i2c_vc, and cam0_reg).
2504 clock-frequency Sets the clock frequency to match that used on
2505 the board, which should be one of 54000000
2506 (the default), 37125000 or 74250000.
2510 Info: Sony IMX327 camera module.
2511 Uses Unicam 1, which is the standard camera connector on most Pi
2513 Load: dtoverlay=imx327,<param>
2514 Params: 4lane Enable 4 CSI2 lanes. This requires a Compute
2515 Module (1, 3, or 4).
2516 clock-frequency Sets the clock frequency to match that used on
2518 Modules from Vision Components use 37.125MHz
2519 (the default), whilst those from Innomaker use
2521 mono Denote that the module is a mono sensor.
2522 orientation Sensor orientation (0 = front, 1 = rear,
2523 2 = external, default external)
2524 rotation Mounting rotation of the camera sensor (0 or
2526 media-controller Configure use of Media Controller API for
2527 configuring the sensor (default on)
2528 cam0 Adopt the default configuration for CAM0 on a
2529 Compute Module (CSI0, i2c_vc, and cam0_reg).
2533 Info: Sony IMX378 camera module.
2534 Uses Unicam 1, which is the standard camera connector on most Pi
2536 Load: dtoverlay=imx378,<param>=<val>
2537 Params: rotation Mounting rotation of the camera sensor (0 or
2539 orientation Sensor orientation (0 = front, 1 = rear,
2540 2 = external, default external)
2541 media-controller Configure use of Media Controller API for
2542 configuring the sensor (default on)
2543 cam0 Adopt the default configuration for CAM0 on a
2544 Compute Module (CSI0, i2c_vc, and cam0_reg).
2548 Info: Sony IMX462 camera module.
2549 Uses Unicam 1, which is the standard camera connector on most Pi
2551 Load: dtoverlay=imx462,<param>
2552 Params: 4lane Enable 4 CSI2 lanes. This requires a Compute
2553 Module (1, 3, or 4).
2554 clock-frequency Sets the clock frequency to match that used on
2556 Modules from Vision Components use 37.125MHz
2557 (the default), whilst those from Innomaker use
2559 mono Denote that the module is a mono sensor.
2560 orientation Sensor orientation (0 = front, 1 = rear,
2561 2 = external, default external)
2562 rotation Mounting rotation of the camera sensor (0 or
2564 media-controller Configure use of Media Controller API for
2565 configuring the sensor (default on)
2566 cam0 Adopt the default configuration for CAM0 on a
2567 Compute Module (CSI0, i2c_vc, and cam0_reg).
2571 Info: Sony IMX477 camera module.
2572 Uses Unicam 1, which is the standard camera connector on most Pi
2574 Load: dtoverlay=imx477,<param>=<val>
2575 Params: rotation Mounting rotation of the camera sensor (0 or
2577 orientation Sensor orientation (0 = front, 1 = rear,
2578 2 = external, default external)
2579 media-controller Configure use of Media Controller API for
2580 configuring the sensor (default on)
2581 cam0 Adopt the default configuration for CAM0 on a
2582 Compute Module (CSI0, i2c_vc, and cam0_reg).
2586 Info: Sony IMX519 camera module.
2587 Uses Unicam 1, which is the standard camera connector on most Pi
2589 Load: dtoverlay=imx519,<param>=<val>
2590 Params: rotation Mounting rotation of the camera sensor (0 or
2592 orientation Sensor orientation (0 = front, 1 = rear,
2593 2 = external, default external)
2594 media-controller Configure use of Media Controller API for
2595 configuring the sensor (default on)
2596 cam0 Adopt the default configuration for CAM0 on a
2597 Compute Module (CSI0, i2c_vc, and cam0_reg).
2598 vcm Select lens driver state. Default is enabled,
2599 but vcm=off will disable.
2603 Info: Sony IMX708 camera module.
2604 Uses Unicam 1, which is the standard camera connector on most Pi
2606 Load: dtoverlay=imx708,<param>=<val>
2607 Params: rotation Mounting rotation of the camera sensor (0 or
2609 orientation Sensor orientation (0 = front, 1 = rear,
2610 2 = external, default external)
2611 vcm Select lens driver state. Default is enabled,
2612 but vcm=off will disable.
2613 media-controller Configure use of Media Controller API for
2614 configuring the sensor (default on)
2615 cam0 Adopt the default configuration for CAM0 on a
2616 Compute Module (CSI0, i2c_vc, and cam0_reg).
2617 link-frequency Allowable link frequency values to use in Hz:
2618 450000000 (default), 447000000, 453000000.
2622 Info: Configures the IQaudio Codec audio card
2623 Load: dtoverlay=iqaudio-codec
2628 Info: Configures the IQaudio DAC audio card
2629 Load: dtoverlay=iqaudio-dac,<param>
2630 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2631 Digital volume control. Enable with
2632 "dtoverlay=iqaudio-dac,24db_digital_gain"
2633 (The default behaviour is that the Digital
2634 volume control is limited to a maximum of
2635 0dB. ie. it can attenuate but not provide
2636 gain. For most users, this will be desired
2637 as it will prevent clipping. By appending
2638 the 24db_digital_gain parameter, the Digital
2639 volume control will allow up to 24dB of
2640 gain. If this parameter is enabled, it is the
2641 responsibility of the user to ensure that
2642 the Digital volume control is set to a value
2643 that does not result in clipping/distortion!)
2646 Name: iqaudio-dacplus
2647 Info: Configures the IQaudio DAC+ audio card
2648 Load: dtoverlay=iqaudio-dacplus,<param>=<val>
2649 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2650 Digital volume control. Enable with
2651 "dtoverlay=iqaudio-dacplus,24db_digital_gain"
2652 (The default behaviour is that the Digital
2653 volume control is limited to a maximum of
2654 0dB. ie. it can attenuate but not provide
2655 gain. For most users, this will be desired
2656 as it will prevent clipping. By appending
2657 the 24db_digital_gain parameter, the Digital
2658 volume control will allow up to 24dB of
2659 gain. If this parameter is enabled, it is the
2660 responsibility of the user to ensure that
2661 the Digital volume control is set to a value
2662 that does not result in clipping/distortion!)
2663 auto_mute_amp If specified, unmute/mute the IQaudIO amp when
2664 starting/stopping audio playback.
2665 unmute_amp If specified, unmute the IQaudIO amp once when
2666 the DAC driver module loads.
2669 Name: iqaudio-digi-wm8804-audio
2670 Info: Configures the IQAudIO Digi WM8804 audio card
2671 Load: dtoverlay=iqaudio-digi-wm8804-audio,<param>=<val>
2672 Params: card_name Override the default, "IQAudIODigi", card name.
2673 dai_name Override the default, "IQAudIO Digi", dai name.
2674 dai_stream_name Override the default, "IQAudIO Digi HiFi",
2679 Info: Enables I2C connected Azoteq IQS550 trackpad/touchscreen controller
2680 using GPIO 4 (pin 7 on GPIO header) for interrupt.
2681 Load: dtoverlay=iqs550,<param>=<val>
2682 Params: interrupt GPIO used for interrupt (default 4)
2683 reset GPIO used for reset (optional)
2684 sizex Touchscreen size x (default 800)
2685 sizey Touchscreen size y (default 480)
2686 invx Touchscreen inverted x axis
2687 invy Touchscreen inverted y axis
2688 swapxy Touchscreen swapped x y axis
2692 Info: Infineon irs1125 TOF camera module.
2693 Uses Unicam 1, which is the standard camera connector on most Pi
2695 Load: dtoverlay=irs1125,<param>=<val>
2696 Params: media-controller Configure use of Media Controller API for
2697 configuring the sensor (default off)
2698 cam0 Adopt the default configuration for CAM0 on a
2699 Compute Module (CSI0, i2c_vc, and cam0_reg).
2703 Info: Adds support for JEDEC-compliant SPI NOR flash devices. (Note: The
2704 "jedec,spi-nor" kernel driver was formerly known as "m25p80".)
2705 Load: dtoverlay=jedec-spi-nor,<param>=<val>
2706 Params: spi<n>-<m> Enable flash device on SPI<n>, CS#<m>
2707 fastr Add fast read capability to the flash device
2708 speed Maximum SPI frequency (Hz)
2709 flash-spi<n>-<m> Same as spi<n>-<m> (deprecated)
2710 flash-fastr-spi<n>-<m> Same as spi<n>->m>,fastr (deprecated)
2714 Info: Simultaneous usage of an justboom-dac and justboom-digi based
2716 Load: dtoverlay=justboom-both,<param>=<val>
2717 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2718 Digital volume control. Enable with
2719 "dtoverlay=justboom-dac,24db_digital_gain"
2720 (The default behaviour is that the Digital
2721 volume control is limited to a maximum of
2722 0dB. ie. it can attenuate but not provide
2723 gain. For most users, this will be desired
2724 as it will prevent clipping. By appending
2725 the 24dB_digital_gain parameter, the Digital
2726 volume control will allow up to 24dB of
2727 gain. If this parameter is enabled, it is the
2728 responsibility of the user to ensure that
2729 the Digital volume control is set to a value
2730 that does not result in clipping/distortion!)
2734 Info: Configures the JustBoom DAC HAT, Amp HAT, DAC Zero and Amp Zero audio
2736 Load: dtoverlay=justboom-dac,<param>=<val>
2737 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2738 Digital volume control. Enable with
2739 "dtoverlay=justboom-dac,24db_digital_gain"
2740 (The default behaviour is that the Digital
2741 volume control is limited to a maximum of
2742 0dB. ie. it can attenuate but not provide
2743 gain. For most users, this will be desired
2744 as it will prevent clipping. By appending
2745 the 24dB_digital_gain parameter, the Digital
2746 volume control will allow up to 24dB of
2747 gain. If this parameter is enabled, it is the
2748 responsibility of the user to ensure that
2749 the Digital volume control is set to a value
2750 that does not result in clipping/distortion!)
2754 Info: Configures the JustBoom Digi HAT and Digi Zero audio cards
2755 Load: dtoverlay=justboom-digi
2760 Info: This overlay has been deprecated and removed - see gpio-ir
2765 Info: Adds support for the ltc294x family of battery gauges
2766 Load: dtoverlay=ltc294x,<param>=<val>
2767 Params: ltc2941 Select the ltc2941 device
2769 ltc2942 Select the ltc2942 device
2771 ltc2943 Select the ltc2943 device
2773 ltc2944 Select the ltc2944 device
2775 resistor-sense The sense resistor value in milli-ohms.
2776 Can be a 32-bit negative value when the battery
2777 has been connected to the wrong end of the
2780 prescaler-exponent Range and accuracy of the gauge. The value is
2781 programmed into the chip only if it differs
2782 from the current setting.
2784 - Default value is 128
2785 - the exponent is in the range 0-7 (default 7)
2786 See the datasheet for more information.
2790 Info: Configures the Maxim MAX98357A I2S DAC
2791 Load: dtoverlay=max98357a,<param>=<val>
2792 Params: no-sdmode Driver does not manage the state of the DAC's
2793 SD_MODE pin (i.e. chip is always on).
2794 sdmode-pin integer, GPIO pin connected to the SD_MODE input
2795 of the DAC (default GPIO4 if parameter omitted).
2799 Info: Configure a MAX6675, MAX31855 or MAX31856 thermocouple as an IIO device.
2801 For devices on spi1 or spi2, the interfaces should be enabled
2802 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2803 The overlay expects to disable the relevant spidev node, so also using
2804 e.g. cs0_spidev=off is unnecessary.
2807 MAX31855 on /dev/spidev0.0
2808 dtoverlay=maxtherm,spi0-0,max31855
2809 MAX31856 using a type J thermocouple on /dev/spidev2.1
2811 dtoverlay=maxtherm,spi2-1,max31856,type_j
2813 Load: dtoverlay=maxtherm,<param>=<val>
2814 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
2816 max6675 Enable support for the MAX6675 (default)
2817 max31855 Enable support for the MAX31855
2818 max31855e Enable support for the MAX31855E
2819 max31855j Enable support for the MAX31855J
2820 max31855k Enable support for the MAX31855K
2821 max31855n Enable support for the MAX31855N
2822 max31855r Enable support for the MAX31855R
2823 max31855s Enable support for the MAX31855S
2824 max31855t Enable support for the MAX31855T
2825 max31856 Enable support for the MAX31856 (with type K)
2826 type_b Select a type B sensor for max31856
2827 type_e Select a type E sensor for max31856
2828 type_j Select a type J sensor for max31856
2829 type_k Select a type K sensor for max31856
2830 type_n Select a type N sensor for max31856
2831 type_r Select a type R sensor for max31856
2832 type_s Select a type S sensor for max31856
2833 type_t Select a type T sensor for max31856
2837 Info: Configures the mbed AudioCODEC (TLV320AIC23B)
2838 Load: dtoverlay=mbed-dac
2843 Info: Configures the MCP23017 I2C GPIO expander
2844 Load: dtoverlay=mcp23017,<param>=<val>
2845 Params: gpiopin Gpio pin connected to the INTA output of the
2846 MCP23017 (default: 4)
2848 addr I2C address of the MCP23017 (default: 0x20)
2850 mcp23008 Configure an MCP23008 instead.
2851 noints Disable the interrupt GPIO line.
2852 i2c0 Choose the I2C0 bus on GPIOs 0&1
2853 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2854 i2c3 Choose the I2C3 bus (configure with the i2c3
2855 overlay - BCM2711 only)
2856 i2c4 Choose the I2C4 bus (configure with the i2c4
2857 overlay - BCM2711 only)
2858 i2c5 Choose the I2C5 bus (configure with the i2c5
2859 overlay - BCM2711 only)
2860 i2c6 Choose the I2C6 bus (configure with the i2c6
2861 overlay - BCM2711 only)
2865 Info: Configures the MCP23S08/17 SPI GPIO expanders.
2866 If devices are present on SPI1 or SPI2, those interfaces must be enabled
2867 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2868 If interrupts are enabled for a device on a given CS# on a SPI bus, that
2869 device must be the only one present on that SPI bus/CS#.
2870 Load: dtoverlay=mcp23s17,<param>=<val>
2871 Params: s08-spi<n>-<m>-present 4-bit integer, bitmap indicating MCP23S08
2872 devices present on SPI<n>, CS#<m>
2874 s17-spi<n>-<m>-present 8-bit integer, bitmap indicating MCP23S17
2875 devices present on SPI<n>, CS#<m>
2877 s08-spi<n>-<m>-int-gpio integer, enables interrupts on a single
2878 MCP23S08 device on SPI<n>, CS#<m>, specifies
2879 the GPIO pin to which INT output of MCP23S08
2882 s17-spi<n>-<m>-int-gpio integer, enables mirrored interrupts on a
2883 single MCP23S17 device on SPI<n>, CS#<m>,
2884 specifies the GPIO pin to which either INTA
2885 or INTB output of MCP23S17 is connected.
2889 Info: Configures the MCP2515 CAN controller on spi0/1/2
2890 For devices on spi1 or spi2, the interfaces should be enabled
2891 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2892 Load: dtoverlay=mcp2515,<param>=<val>
2893 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
2896 oscillator Clock frequency for the CAN controller (Hz)
2898 speed Maximum SPI frequence (Hz)
2900 interrupt GPIO for interrupt signal
2904 Info: Configures the MCP2515 CAN controller on spi0.0
2905 Load: dtoverlay=mcp2515-can0,<param>=<val>
2906 Params: oscillator Clock frequency for the CAN controller (Hz)
2908 spimaxfrequency Maximum SPI frequence (Hz)
2910 interrupt GPIO for interrupt signal
2914 Info: Configures the MCP2515 CAN controller on spi0.1
2915 Load: dtoverlay=mcp2515-can1,<param>=<val>
2916 Params: oscillator Clock frequency for the CAN controller (Hz)
2918 spimaxfrequency Maximum SPI frequence (Hz)
2920 interrupt GPIO for interrupt signal
2924 Info: Configures the MCP251XFD CAN controller family
2925 For devices on spi1 or spi2, the interfaces should be enabled
2926 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2927 Load: dtoverlay=mcp251xfd,<param>=<val>
2928 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
2931 oscillator Clock frequency for the CAN controller (Hz)
2933 speed Maximum SPI frequence (Hz)
2935 interrupt GPIO for interrupt signal
2937 rx_interrupt GPIO for RX interrupt signal (nINT1) (optional)
2939 xceiver_enable GPIO for CAN transceiver enable (optional)
2941 xceiver_active_high specifiy if CAN transceiver enable pin is
2942 active high (optional, default: active low)
2946 Info: Configures MCP3008 A/D converters
2947 For devices on spi1 or spi2, the interfaces should be enabled
2948 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2949 Load: dtoverlay=mcp3008,<param>[=<val>]
2950 Params: spi<n>-<m>-present boolean, configure device at spi<n>, cs<m>
2951 spi<n>-<m>-speed integer, set the spi bus speed for this device
2955 Info: Configures MCP3202 A/D converters
2956 For devices on spi1 or spi2, the interfaces should be enabled
2957 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2958 Load: dtoverlay=mcp3202,<param>[=<val>]
2959 Params: spi<n>-<m>-present boolean, configure device at spi<n>, cs<m>
2960 spi<n>-<m>-speed integer, set the spi bus speed for this device
2964 Info: Overlay for activation of Microchip MCP3421-3428 ADCs over I2C
2965 Load: dtoverlay=mcp342x,<param>=<val>
2966 Params: addr I2C bus address of device, for devices with
2967 addresses that are configurable, e.g. by
2968 hardware links (default=0x68)
2969 mcp3421 The device is an MCP3421
2970 mcp3422 The device is an MCP3422
2971 mcp3423 The device is an MCP3423
2972 mcp3424 The device is an MCP3424
2973 mcp3425 The device is an MCP3425
2974 mcp3426 The device is an MCP3426
2975 mcp3427 The device is an MCP3427
2976 mcp3428 The device is an MCP3428
2980 Info: Media Center HAT - 2.83" Touch Display + extras by Pi Supply
2981 Load: dtoverlay=media-center,<param>=<val>
2982 Params: speed Display SPI bus speed
2983 rotate Display rotation {0,90,180,270}
2984 fps Delay between frame updates
2985 xohms Touchpanel sensitivity (X-plate resistance)
2986 swapxy Swap x and y axis
2987 backlight Change backlight GPIO pin {e.g. 12, 18}
2988 debug "on" = enable additional debug messages
2993 Info: Configures the merus-amp audio card
2994 Load: dtoverlay=merus-amp
2999 Info: Configures UART0 (ttyAMA0) so that a requested 38.4kbaud actually gets
3000 31.25kbaud, the frequency required for MIDI
3001 Load: dtoverlay=midi-uart0
3005 Name: midi-uart0-pi5
3006 Info: See midi-uart0 (this is the Pi 5 version)
3010 Info: Configures UART1 (ttyS0) so that a requested 38.4kbaud actually gets
3011 31.25kbaud, the frequency required for MIDI
3012 Load: dtoverlay=midi-uart1
3016 Name: midi-uart1-pi5
3017 Info: See midi-uart1 (this is the Pi 5 version)
3021 Info: Configures UART2 (ttyAMA2) so that a requested 38.4kbaud actually gets
3022 31.25kbaud, the frequency required for MIDI
3023 Load: dtoverlay=midi-uart2
3027 Name: midi-uart2-pi5
3028 Info: See midi-uart2 (this is the Pi 5 version)
3032 Info: Configures UART3 (ttyAMA3) so that a requested 38.4kbaud actually gets
3033 31.25kbaud, the frequency required for MIDI
3034 Load: dtoverlay=midi-uart3
3038 Name: midi-uart3-pi5
3039 Info: See midi-uart3 (this is the Pi 5 version)
3043 Info: Configures UART4 (ttyAMA4) so that a requested 38.4kbaud actually gets
3044 31.25kbaud, the frequency required for MIDI
3045 Load: dtoverlay=midi-uart4
3049 Name: midi-uart4-pi5
3050 Info: See midi-uart4 (this is the Pi 5 version)
3054 Info: Configures UART5 (ttyAMA5) so that a requested 38.4kbaud actually gets
3055 31.25kbaud, the frequency required for MIDI
3056 Load: dtoverlay=midi-uart5
3061 Info: Overlay for AdaFruit Mini Pi 1.3" TFT via SPI using fbtft driver.
3062 Load: dtoverlay=minipitft13,<param>=<val>
3063 Params: speed SPI bus speed (default 32000000)
3064 rotate Display rotation (0, 90, 180 or 270; default 0)
3065 width Display width (default 240)
3066 height Display height (default 240)
3067 fps Delay between frame updates (default 25)
3068 debug Debug output level (0-7; default 0)
3072 Info: Switch the onboard Bluetooth function of a BT-equipped Raspberry Pi
3073 to use the mini-UART (ttyS0) and restore UART0/ttyAMA0 over GPIOs 14 &
3074 15. Note that this option uses a lower baudrate, and should only be used
3075 with low-bandwidth peripherals.
3076 Load: dtoverlay=miniuart-bt,<param>=<val>
3077 Params: krnbt Set to "off" to disable autoprobing of Bluetooth
3078 driver without need of hciattach/btattach
3082 Info: Overlay for SPI-connected MIPI DBI displays using the panel-mipi-dbi
3083 driver. The driver will load a file /lib/firmware/panel.bin containing
3084 the initialisation commands.
3087 dtoverlay=mipi-dbi-spi,spi0-0,speed=70000000
3088 dtparam=width=320,height=240
3089 dtparam=reset-gpio=23,dc-gpio=24
3090 dtparam=backlight-gpio=18
3092 Compared to fbtft panel-mipi-dbi runs pixel data at spi-max-frequency
3093 and init commands at 10MHz. This makes it possible to push the envelope
3094 without messing up the controller configuration due to command
3095 transmission errors.
3097 For devices on spi1 or spi2, the interfaces should be enabled
3098 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
3100 See https://github.com/notro/panel-mipi-dbi/wiki for more info.
3102 Load: dtoverlay=mipi-dbi-spi,<param>=<val>
3104 compatible Set the compatible string to load a different
3105 firmware file. Both the panel compatible value
3106 used to load the firmware file and the value
3107 used to load the driver has to be set having a
3108 NUL (\0) separator between them.
3110 dtparam=compatible=mypanel\0panel-mipi-dbi-spi
3111 spi<n>-<m> Configure device at spi<n>, cs<m>
3113 speed SPI bus speed in Hz (default 32000000)
3114 cpha Shifted SPI clock phase (CPHA) mode
3115 cpol Inverse SPI clock polarity (CPOL) mode
3116 write-only Controller is not readable
3117 (ie. MISO is not wired up).
3119 width Panel width in pixels (required)
3120 height Panel height in pixels (required)
3121 width-mm Panel width in mm
3122 height-mm Panel height in mm
3123 x-offset Panel x-offset in controller RAM
3124 y-offset Panel y-offset in controller RAM
3126 clock-frequency Panel clock frequency in Hz
3127 (optional, just informational).
3129 reset-gpio GPIO pin to be used for RESET
3130 dc-gpio GPIO pin to be used for D/C
3132 backlight-gpio GPIO pin to be used for backlight control
3134 backlight-pwm PWM channel to be used for backlight control
3135 (default of none). NB Disables audio headphone
3136 output as that also uses PWM.
3137 backlight-pwm-chan Choose channel on &pwm node for backlight
3138 control (default 0).
3139 backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See
3140 pwm-2chan for valid options (default 18).
3141 backlight-pwm-func Pin function of GPIO used for the PWM backlight.
3142 See pwm-2chan for valid options (default 2).
3143 backlight-def-brightness
3144 Set the default brightness. Normal range 1-16.
3149 Info: Overlay for i2c connected mlx90640 thermal camera
3150 Load: dtoverlay=mlx90640
3155 Info: Selects the bcm2835-mmc SD/MMC driver, optionally with overclock
3156 Load: dtoverlay=mmc,<param>=<val>
3157 Params: overclock_50 Clock (in MHz) to use when the MMC framework
3162 Info: This overlay has been deprecated - use "dtoverlay=i2c-sensor,mpu6050"
3163 instead. Note that "int_pin" is the new name for the "interrupt"
3169 Info: MZ61581 display by Tontec
3170 Load: dtoverlay=mz61581,<param>=<val>
3171 Params: speed Display SPI bus speed
3173 rotate Display rotation {0,90,180,270}
3175 fps Delay between frame updates
3177 txbuflen Transmit buffer length (default 32768)
3179 debug Debug output level {0-7}
3181 xohms Touchpanel sensitivity (X-plate resistance)
3185 Info: Omnivision OV2311 camera module.
3186 Uses Unicam 1, which is the standard camera connector on most Pi
3188 Load: dtoverlay=ov2311,<param>=<val>
3189 Params: rotation Mounting rotation of the camera sensor (0 or
3191 orientation Sensor orientation (0 = front, 1 = rear,
3192 2 = external, default external)
3193 media-controller Configure use of Media Controller API for
3194 configuring the sensor (default on)
3195 cam0 Adopt the default configuration for CAM0 on a
3196 Compute Module (CSI0, i2c_vc, and cam0_reg).
3200 Info: Omnivision OV5647 camera module.
3201 Uses Unicam 1, which is the standard camera connector on most Pi
3203 Load: dtoverlay=ov5647,<param>=<val>
3204 Params: rotation Mounting rotation of the camera sensor (0 or
3206 orientation Sensor orientation (0 = front, 1 = rear,
3207 2 = external, default external)
3208 media-controller Configure use of Media Controller API for
3209 configuring the sensor (default on)
3210 cam0 Adopt the default configuration for CAM0 on a
3211 Compute Module (CSI0, i2c_vc, and cam0_reg).
3212 vcm Configure a VCM focus drive on the sensor.
3216 Info: Omnivision OV7251 camera module.
3217 Uses Unicam 1, which is the standard camera connector on most Pi
3219 Load: dtoverlay=ov7251,<param>=<val>
3220 Params: rotation Mounting rotation of the camera sensor (0 or
3222 orientation Sensor orientation (0 = front, 1 = rear,
3223 2 = external, default external)
3224 media-controller Configure use of Media Controller API for
3225 configuring the sensor (default off)
3226 cam0 Adopt the default configuration for CAM0 on a
3227 Compute Module (CSI0, i2c_vc, and cam0_reg).
3231 Info: Omnivision OV9281 camera module.
3232 Uses Unicam 1, which is the standard camera connector on most Pi
3234 Load: dtoverlay=ov9281,<param>=<val>
3235 Params: rotation Mounting rotation of the camera sensor (0 or
3237 orientation Sensor orientation (0 = front, 1 = rear,
3238 2 = external, default external)
3239 media-controller Configure use of Media Controller API for
3240 configuring the sensor (default on)
3241 cam0 Adopt the default configuration for CAM0 on a
3242 Compute Module (CSI0, i2c_vc, and cam0_reg).
3246 Info: PaPiRus ePaper Screen by Pi Supply (both HAT and pHAT)
3247 Load: dtoverlay=papirus,<param>=<val>
3248 Params: panel Display panel (required):
3253 speed Display SPI bus speed
3257 Info: TI PCA953x family of I2C GPIO expanders. Default is for NXP PCA9534.
3258 Load: dtoverlay=pca953x,<param>=<val>
3259 Params: addr I2C address of expander. Default 0x20.
3260 pca6416 Select the NXP PCA6416 (16 bit)
3261 pca9505 Select the NXP PCA9505 (40 bit)
3262 pca9535 Select the NXP PCA9535 (16 bit)
3263 pca9536 Select the NXP PCA9536 or TI PCA9536 (4 bit)
3264 pca9537 Select the NXP PCA9537 (4 bit)
3265 pca9538 Select the NXP PCA9538 (8 bit)
3266 pca9539 Select the NXP PCA9539 (16 bit)
3267 pca9554 Select the NXP PCA9554 (8 bit)
3268 pca9555 Select the NXP PCA9555 (16 bit)
3269 pca9556 Select the NXP PCA9556 (8 bit)
3270 pca9557 Select the NXP PCA9557 (8 bit)
3271 pca9574 Select the NXP PCA9574 (8 bit)
3272 pca9575 Select the NXP PCA9575 (16 bit)
3273 pca9698 Select the NXP PCA9698 (40 bit)
3274 pcal6416 Select the NXP PCAL6416 (16 bit)
3275 pcal6524 Select the NXP PCAL6524 (24 bit)
3276 pcal9555a Select the NXP PCAL9555A (16 bit)
3277 max7310 Select the Maxim MAX7310 (8 bit)
3278 max7312 Select the Maxim MAX7312 (16 bit)
3279 max7313 Select the Maxim MAX7313 (16 bit)
3280 max7315 Select the Maxim MAX7315 (8 bit)
3281 pca6107 Select the TI PCA6107 (8 bit)
3282 tca6408 Select the TI TCA6408 (8 bit)
3283 tca6416 Select the TI TCA6416 (16 bit)
3284 tca6424 Select the TI TCA6424 (24 bit)
3285 tca9539 Select the TI TCA9539 (16 bit)
3286 tca9554 Select the TI TCA9554 (8 bit)
3287 cat9554 Select the Onnn CAT9554 (8 bit)
3288 pca9654 Select the Onnn PCA9654 (8 bit)
3289 xra1202 Select the Exar XRA1202 (8 bit)
3293 Info: NXP PCF857x family of I2C GPIO expanders.
3294 Load: dtoverlay=pcf857x,<param>=<val>
3295 Params: addr I2C address of expander. Default
3296 depends on model selected.
3297 pcf8574 Select the NXP PCF8574 (8 bit)
3298 pcf8574a Select the NXP PCF8574A (8 bit)
3299 pcf8575 Select the NXP PCF8575 (16 bit)
3300 pca8574 Select the NXP PCA8574 (8 bit)
3303 Name: pcie-32bit-dma
3304 Info: Force PCIe config to support 32bit DMA addresses at the expense of
3305 having to bounce buffers.
3306 Load: dtoverlay=pcie-32bit-dma
3310 [ The pcf2127-rtc overlay has been deleted. See i2c-rtc. ]
3313 [ The pcf8523-rtc overlay has been deleted. See i2c-rtc. ]
3316 [ The pcf8563-rtc overlay has been deleted. See i2c-rtc. ]
3320 Info: This overlay has been renamed act-led, keeping pi3-act-led as an alias
3321 for backwards compatibility.
3325 Name: pi3-disable-bt
3326 Info: This overlay has been renamed disable-bt, keeping pi3-disable-bt as an
3327 alias for backwards compatibility.
3331 Name: pi3-disable-wifi
3332 Info: This overlay has been renamed disable-wifi, keeping pi3-disable-wifi as
3333 an alias for backwards compatibility.
3337 Name: pi3-miniuart-bt
3338 Info: This overlay has been renamed miniuart-bt, keeping pi3-miniuart-bt as
3339 an alias for backwards compatibility.
3344 Info: Configures the pibell audio card.
3345 Load: dtoverlay=pibell,<param>=<val>
3346 Params: alsaname Set the name as it appears in ALSA (default
3351 Info: Configures the PiFace Digital mcp23s17 GPIO port expander.
3352 Load: dtoverlay=pifacedigital,<param>=<val>
3353 Params: spi-present-mask 8-bit integer, bitmap indicating MCP23S17 SPI0
3354 CS0 address. PiFace Digital supports addresses
3355 0-3, which can be configured with JP1 and JP2.
3359 Info: Configures the PiFi 40W stereo amplifier
3360 Load: dtoverlay=pifi-40
3365 Info: Configures the PiFi DAC HD
3366 Load: dtoverlay=pifi-dac-hd
3371 Info: Configures the PiFi DAC Zero
3372 Load: dtoverlay=pifi-dac-zero
3377 Info: Configures the PiFi Mini stereo amplifier
3378 Load: dtoverlay=pifi-mini-210
3383 Info: Configures the PiGlow by pimoroni.com
3384 Load: dtoverlay=piglow
3389 Info: PiScreen display by OzzMaker.com
3390 Load: dtoverlay=piscreen,<param>=<val>
3391 Params: speed Display SPI bus speed
3393 rotate Display rotation {0,90,180,270}
3395 fps Delay between frame updates
3397 debug Debug output level {0-7}
3399 xohms Touchpanel sensitivity (X-plate resistance)
3401 drm Select the DRM/KMS driver instead of the FBTFT
3406 Info: PiScreen 2 with resistive TP display by OzzMaker.com
3407 Load: dtoverlay=piscreen2r,<param>=<val>
3408 Params: speed Display SPI bus speed
3410 rotate Display rotation {0,90,180,270}
3412 fps Delay between frame updates
3414 debug Debug output level {0-7}
3416 xohms Touchpanel sensitivity (X-plate resistance)
3420 Info: Configures the Blokas Labs pisound card
3421 Load: dtoverlay=pisound
3426 Info: Adafruit PiTFT 2.2" screen
3427 Load: dtoverlay=pitft22,<param>=<val>
3428 Params: speed Display SPI bus speed
3430 rotate Display rotation {0,90,180,270}
3432 fps Delay between frame updates
3434 debug Debug output level {0-7}
3437 Name: pitft28-capacitive
3438 Info: Adafruit PiTFT 2.8" capacitive touch screen
3439 Load: dtoverlay=pitft28-capacitive,<param>=<val>
3440 Params: speed Display SPI bus speed
3442 rotate Display rotation {0,90,180,270}
3444 fps Delay between frame updates
3446 debug Debug output level {0-7}
3448 touch-sizex Touchscreen size x (default 240)
3450 touch-sizey Touchscreen size y (default 320)
3452 touch-invx Touchscreen inverted x axis
3454 touch-invy Touchscreen inverted y axis
3456 touch-swapxy Touchscreen swapped x y axis
3459 Name: pitft28-resistive
3460 Info: Adafruit PiTFT 2.8" resistive touch screen
3461 Load: dtoverlay=pitft28-resistive,<param>=<val>
3462 Params: speed Display SPI bus speed
3464 rotate Display rotation {0,90,180,270}
3466 fps Delay between frame updates
3468 debug Debug output level {0-7}
3470 drm Force the use of the mi0283qt DRM driver (by
3471 default the ili9340 framebuffer driver will
3472 be used in preference if available)
3475 Name: pitft35-resistive
3476 Info: Adafruit PiTFT 3.5" resistive touch screen
3477 Load: dtoverlay=pitft35-resistive,<param>=<val>
3478 Params: speed Display SPI bus speed
3480 rotate Display rotation {0,90,180,270}
3482 fps Delay between frame updates
3484 debug Debug output level {0-7}
3486 drm Force the use of the hx8357d DRM driver (by
3487 default the fb_hx8357d framebuffer driver will
3488 be used in preference if available)
3492 Info: Configures the pps-gpio (pulse-per-second time signal via GPIO).
3493 Load: dtoverlay=pps-gpio,<param>=<val>
3494 Params: gpiopin Input GPIO (default "18")
3495 assert_falling_edge When present, assert is indicated by a falling
3496 edge, rather than by a rising edge (default
3498 capture_clear Generate clear events on the trailing edge
3500 pull Desired pull-up/down state (off, down, up)
3505 Info: Configures the PROTO Audio Codec card
3506 Load: dtoverlay=proto-codec
3511 Info: Configures a single PWM channel
3512 Legal pin,function combinations for each channel:
3513 PWM0: 12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
3514 PWM1: 13,4(Alt0) 19,2(Alt5) 41,4(Alt0) 45,4(Alt0) 53,5(Alt1)
3516 1) Pin 18 is the only one available on all platforms, and
3517 it is the one used by the I2S audio interface.
3518 Pins 12 and 13 might be better choices on an A+, B+ or Pi2.
3519 2) The onboard analogue audio output uses both PWM channels.
3520 3) So be careful mixing audio and PWM.
3521 4) Currently the clock must have been enabled and configured
3523 Load: dtoverlay=pwm,<param>=<val>
3524 Params: pin Output pin (default 18) - see table
3525 func Pin function (default 2 = Alt5) - see above
3526 clock PWM clock frequency (informational)
3530 Info: Configures both PWM channels
3531 Legal pin,function combinations for each channel:
3532 PWM0: 12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
3533 PWM1: 13,4(Alt0) 19,2(Alt5) 41,4(Alt0) 45,4(Alt0) 53,5(Alt1)
3535 1) Pin 18 is the only one available on all platforms, and
3536 it is the one used by the I2S audio interface.
3537 Pins 12 and 13 might be better choices on an A+, B+ or Pi2.
3538 2) The onboard analogue audio output uses both PWM channels.
3539 3) So be careful mixing audio and PWM.
3540 4) Currently the clock must have been enabled and configured
3542 Load: dtoverlay=pwm-2chan,<param>=<val>
3543 Params: pin Output pin (default 18) - see table
3544 pin2 Output pin for other channel (default 19)
3545 func Pin function (default 2 = Alt5) - see above
3546 func2 Function for pin2 (default 2 = Alt5)
3547 clock PWM clock frequency (informational)
3551 Info: Use GPIO pin as pwm-assisted infrared transmitter output.
3552 This is an alternative to "gpio-ir-tx". pwm-ir-tx makes use
3553 of PWM0 to reduce the CPU load during transmission compared to
3554 gpio-ir-tx which uses bit-banging.
3555 Legal pin,function combinations are:
3556 12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
3557 Load: dtoverlay=pwm-ir-tx,<param>=<val>
3558 Params: gpio_pin Output GPIO (default 18)
3560 func Pin function (default 2 = Alt5)
3564 Info: Configures one or two PWM channel on PWM1 (BCM2711 only)
3566 1) The onboard analogue audio output uses both PWM channels.
3567 2) So be careful mixing audio and PWM.
3568 Note that even when only one pin is enabled, both channels are available
3569 from the PWM driver, so be careful to use the correct one.
3570 Load: dtoverlay=pwm1,<param>=<val>
3571 Params: clock PWM clock frequency (informational)
3572 pins_40 Enable channel 0 (PWM1_0) on GPIO 40
3573 pins_41 Enable channel 1 (PWM1_1) on GPIO 41
3574 pins_40_41 Enable channels 0 (PWM1_0) and 1 (PW1_1) on
3575 GPIOs 40 and 41 (default)
3576 pull_up Enable pull-ups on the PWM pins (default)
3577 pull_down Enable pull-downs on the PWM pins
3578 pull_off Disable pulls on the PWM pins
3582 Info: in-tech's Evaluation Board for PLC Stamp micro
3583 This uses spi0 and a separate GPIO interrupt to connect the QCA7000.
3584 Load: dtoverlay=qca7000,<param>=<val>
3585 Params: int_pin GPIO pin for interrupt signal (default 23)
3587 speed SPI bus speed (default 12 MHz)
3591 Info: in-tech's Evaluation Board for PLC Stamp micro (UART)
3592 This uses uart0/ttyAMA0 over GPIOs 14 & 15 to connect the QCA7000.
3593 But it requires disabling of onboard Bluetooth on
3594 Pi 3B, 3B+, 3A+, 4B and Zero W.
3595 Load: dtoverlay=qca7000-uart0,<param>=<val>
3596 Params: baudrate Set the baudrate for the UART (default
3601 Info: Enable the preservation of crash logs across a reboot. With
3602 systemd-pstore enabled (as it is on Raspberry Pi OS) the crash logs
3603 are moved to /var/lib/systemd/pstore/ on reboot.
3604 Load: dtoverlay=ramoops,<param>=<val>
3605 Params: base-addr Where to place the capture buffer (default
3607 total-size How much memory to allocate altogether (in
3608 bytes - default 64kB)
3609 record-size How much space to use for each capture, i.e.
3610 total-size / record-size = number of captures
3612 console-size Size of non-panic dmesg captures (default 0)
3616 Info: The version of the ramoops overlay for the Pi 4 family. It should be
3617 loaded automatically if dtoverlay=ramoops is specified on a Pi 4.
3618 Load: dtoverlay=ramoops-pi4,<param>=<val>
3619 Params: base-addr Where to place the capture buffer (default
3621 total-size How much memory to allocate altogether (in
3622 bytes - default 64kB)
3623 record-size How much space to use for each capture, i.e.
3624 total-size / record-size = number of captures
3626 console-size Size of non-panic dmesg captures (default 0)
3629 Name: rotary-encoder
3630 Info: Overlay for GPIO connected rotary encoder.
3631 Load: dtoverlay=rotary-encoder,<param>=<val>
3632 Params: pin_a GPIO connected to rotary encoder channel A
3634 pin_b GPIO connected to rotary encoder channel B
3636 relative_axis register a relative axis rather than an
3637 absolute one. Relative axis will only
3638 generate +1/-1 events on the input device,
3639 hence no steps need to be passed.
3640 linux_axis the input subsystem axis to map to this
3641 rotary encoder. Defaults to 0 (ABS_X / REL_X)
3642 rollover Automatic rollover when the rotary value
3643 becomes greater than the specified steps or
3644 smaller than 0. For absolute axis only.
3645 steps-per-period Number of steps (stable states) per period.
3646 The values have the following meaning:
3647 1: Full-period mode (default)
3649 4: Quarter-period mode
3650 steps Number of steps in a full turnaround of the
3651 encoder. Only relevant for absolute axis.
3652 Defaults to 24 which is a typical value for
3654 wakeup Boolean, rotary encoder can wake up the
3656 encoding String, the method used to encode steps.
3657 Supported are "gray" (the default and more
3658 common) and "binary".
3662 Info: Raspberry Pi official display backlight driver
3663 Load: dtoverlay=rpi-backlight
3667 Name: rpi-cirrus-wm5102
3668 Info: This overlay has been renamed to cirrus-wm5102
3673 Info: Configures the Raspberry Pi Codec Zero sound card
3674 Load: dtoverlay=rpi-codeczero
3679 Info: This overlay has been renamed to i2s-dac.
3684 Info: Configures the Raspberry Pi DAC+ card
3685 Load: dtoverlay=rpi-dacplus,<param>=<val>
3686 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
3687 digital volume control. Enable by adding
3688 "dtparam=24db_digital_gain" to config.txt
3689 before any "dtoverlay" lines.
3690 The default behaviour is that the digital
3691 volume control is limited to a maximum of
3692 0dB. ie. it can attenuate but not provide
3693 gain. For most users, this will be desired
3694 as it will prevent clipping. By appending
3695 the 24db_digital_gain parameter, the digital
3696 volume control will allow up to 24dB of
3697 gain. If this parameter is enabled, it is the
3698 responsibility of the user to ensure that
3699 the digital volume control is set to a value
3700 that does not result in clipping/distortion!
3704 Info: Configures the Raspberry Pi DAC Pro sound card
3705 Load: dtoverlay=rpi-dacpro,<param>=<val>
3706 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
3707 digital volume control. Enable by adding
3708 "dtparam=24db_digital_gain" to config.txt
3709 before any "dtoverlay" lines.
3710 The default behaviour is that the digital
3711 volume control is limited to a maximum of
3712 0dB. ie. it can attenuate but not provide
3713 gain. For most users, this will be desired
3714 as it will prevent clipping. By appending
3715 the 24db_digital_gain parameter, the digital
3716 volume control will allow up to 24dB of
3717 gain. If this parameter is enabled, it is the
3718 responsibility of the user to ensure that
3719 the digital volume control is set to a value
3720 that does not result in clipping/distortion!
3723 Name: rpi-digiampplus
3724 Info: Configures the Raspberry Pi DigiAMP+ sound card
3725 Load: dtoverlay=rpi-digiampplus,<param>=<val>
3726 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
3727 digital volume control. Enable by adding
3728 "dtparam=24db_digital_gain" to config.txt
3729 before any "dtoverlay" lines.
3730 The default behaviour is that the digital
3731 volume control is limited to a maximum of
3732 0dB. ie. it can attenuate but not provide
3733 gain. For most users, this will be desired
3734 as it will prevent clipping. By appending
3735 the 24db_digital_gain parameter, the digital
3736 volume control will allow up to 24dB of
3737 gain. If this parameter is enabled, it is the
3738 responsibility of the user to ensure that
3739 the digital volume control is set to a value
3740 that does not result in clipping/distortion!
3741 auto_mute_amp If specified, unmute/mute the DigiAMP+ when
3742 starting/stopping audio playback (default "on").
3743 unmute_amp If specified, unmute the DigiAMP+ amp once when
3744 the DAC driver module loads (default "off").
3748 Info: This overlay has been renamed to watterott-display
3753 Info: Official Raspberry Pi display touchscreen
3754 Load: dtoverlay=rpi-ft5406,<param>=<val>
3755 Params: touchscreen-size-x Touchscreen X resolution (default 800)
3756 touchscreen-size-y Touchscreen Y resolution (default 480);
3757 touchscreen-inverted-x Invert touchscreen X coordinates (default 0);
3758 touchscreen-inverted-y Invert touchscreen Y coordinates (default 0);
3759 touchscreen-swapped-x-y Swap X and Y cordinates (default 0);
3763 Info: Raspberry Pi PoE HAT fan
3764 Load: dtoverlay=rpi-poe,<param>[=<val>]
3765 Params: poe_fan_temp0 Temperature (in millicelcius) at which the fan
3766 turns on (default 40000)
3767 poe_fan_temp0_hyst Temperature delta (in millicelcius) at which
3768 the fan turns off (default 2000)
3769 poe_fan_temp1 Temperature (in millicelcius) at which the fan
3770 speeds up (default 45000)
3771 poe_fan_temp1_hyst Temperature delta (in millicelcius) at which
3772 the fan slows down (default 2000)
3773 poe_fan_temp2 Temperature (in millicelcius) at which the fan
3774 speeds up (default 50000)
3775 poe_fan_temp2_hyst Temperature delta (in millicelcius) at which
3776 the fan slows down (default 2000)
3777 poe_fan_temp3 Temperature (in millicelcius) at which the fan
3778 speeds up (default 55000)
3779 poe_fan_temp3_hyst Temperature delta (in millicelcius) at which
3780 the fan slows down (default 5000)
3781 i2c Control the fan via Linux I2C drivers instead of
3786 Info: Raspberry Pi PoE+ HAT fan
3787 Load: dtoverlay=rpi-poe-plus,<param>[=<val>]
3788 Params: poe_fan_temp0 Temperature (in millicelcius) at which the fan
3789 turns on (default 40000)
3790 poe_fan_temp0_hyst Temperature delta (in millicelcius) at which
3791 the fan turns off (default 2000)
3792 poe_fan_temp1 Temperature (in millicelcius) at which the fan
3793 speeds up (default 45000)
3794 poe_fan_temp1_hyst Temperature delta (in millicelcius) at which
3795 the fan slows down (default 2000)
3796 poe_fan_temp2 Temperature (in millicelcius) at which the fan
3797 speeds up (default 50000)
3798 poe_fan_temp2_hyst Temperature delta (in millicelcius) at which
3799 the fan slows down (default 2000)
3800 poe_fan_temp3 Temperature (in millicelcius) at which the fan
3801 speeds up (default 55000)
3802 poe_fan_temp3_hyst Temperature delta (in millicelcius) at which
3803 the fan slows down (default 5000)
3804 i2c Control the fan via Linux I2C drivers instead of
3809 Info: This overlay has been renamed to proto-codec.
3814 Info: Raspberry Pi Sense HAT
3815 Load: dtoverlay=rpi-sense
3820 Info: Raspberry Pi Sense HAT v2
3821 Load: dtoverlay=rpi-sense-v2
3826 Info: Raspberry Pi TV HAT
3827 Load: dtoverlay=rpi-tv
3832 Info: This overlay has been deprecated and deleted as the V4L2 stateless
3833 video decoder driver is enabled by default.
3837 Name: rra-digidac1-wm8741-audio
3838 Info: Configures the Red Rocks Audio DigiDAC1 soundcard
3839 Load: dtoverlay=rra-digidac1-wm8741-audio
3844 Info: Overlay for the SPI-connected Sainsmart 1.8" display (based on the
3846 Load: dtoverlay=sainsmart18,<param>=<val>
3847 Params: rotate Display rotation {0,90,180,270}
3848 speed SPI bus speed in Hz (default 4000000)
3849 fps Display frame rate in Hz
3850 bgr Enable BGR mode (default off)
3851 debug Debug output level {0-7}
3852 dc_pin GPIO pin for D/C (default 24)
3853 reset_pin GPIO pin for RESET (default 25)
3857 Info: Overlay for the NXP SC16IS750 UART with I2C Interface
3858 Enables the chip on I2C1 at 0x48 (or the "addr" parameter value). To
3859 select another address, please refer to table 10 in reference manual.
3860 Load: dtoverlay=sc16is750-i2c,<param>=<val>
3861 Params: int_pin GPIO used for IRQ (default 24)
3862 addr Address (default 0x48)
3863 xtal On-board crystal frequency (default 14745600)
3867 Info: Overlay for the NXP SC16IS752 dual UART with I2C Interface
3868 Enables the chip on I2C1 at 0x48 (or the "addr" parameter value). To
3869 select another address, please refer to table 10 in reference manual.
3870 Load: dtoverlay=sc16is752-i2c,<param>=<val>
3871 Params: int_pin GPIO used for IRQ (default 24)
3872 addr Address (default 0x48)
3873 xtal On-board crystal frequency (default 14745600)
3876 Name: sc16is752-spi0
3877 Info: Overlay for the NXP SC16IS752 Dual UART with SPI Interface
3878 Enables the chip on SPI0.
3879 Load: dtoverlay=sc16is752-spi0,<param>=<val>
3880 Params: int_pin GPIO used for IRQ (default 24)
3881 xtal On-board crystal frequency (default 14745600)
3884 Name: sc16is752-spi1
3885 Info: Overlay for the NXP SC16IS752 Dual UART with SPI Interface
3886 Enables the chip on SPI1.
3887 N.B.: spi1 is only accessible on devices with a 40pin header, eg:
3888 A+, B+, Zero and PI2 B; as well as the Compute Module.
3890 Load: dtoverlay=sc16is752-spi1,<param>=<val>
3891 Params: int_pin GPIO used for IRQ (default 24)
3892 xtal On-board crystal frequency (default 14745600)
3896 Info: Selects the bcm2835-sdhost SD/MMC driver, optionally with overclock.
3897 N.B. This overlay is designed for situations where the mmc driver is
3898 the default, so it disables the other (mmc) interface - this will kill
3899 WLAN on a Pi3. If this isn't what you want, either use the sdtweak
3900 overlay or the new sd_* dtparams of the base DTBs.
3901 Load: dtoverlay=sdhost,<param>=<val>
3902 Params: overclock_50 Clock (in MHz) to use when the MMC framework
3905 force_pio Disable DMA support (default off)
3907 pio_limit Number of blocks above which to use DMA
3910 debug Enable debug output (default off)
3914 Info: Selects the bcm2835-sdhost SD/MMC driver, optionally with overclock,
3915 and enables SDIO via GPIOs 22-27. An example of use in 1-bit mode is
3916 "dtoverlay=sdio,bus_width=1,gpios_22_25"
3917 Load: dtoverlay=sdio,<param>=<val>
3918 Params: sdio_overclock SDIO Clock (in MHz) to use when the MMC
3919 framework requests 50MHz
3921 poll_once Disable SDIO-device polling every second
3922 (default on: polling once at boot-time)
3924 bus_width Set the SDIO host bus width (default 4 bits)
3926 gpios_22_25 Select GPIOs 22-25 for 1-bit mode. Must be used
3927 with bus_width=1. This replaces the sdio-1bit
3928 overlay, which is now deprecated.
3930 gpios_34_37 Select GPIOs 34-37 for 1-bit mode. Must be used
3933 gpios_34_39 Select GPIOs 34-39 for 4-bit mode. Must be used
3934 with bus_width=4 (the default).
3938 Info: This overlay is now deprecated. Use
3939 "dtoverlay=sdio,bus_width=1,gpios_22_25" instead.
3944 Info: Selects the rp1_mmc0 interface and enables it on GPIOs 22-27.
3946 Load: dtoverlay=sdio-pi5
3951 Info: This overlay is now deprecated. Use the sd_* dtparams in the
3952 base DTB, e.g. "dtoverlay=sdtweak,poll_once" becomes
3953 "dtparam=sd_poll_once".
3957 Name: seeed-can-fd-hat-v1
3958 Info: Overlay for Seeed Studio CAN BUS FD HAT with two CAN FD
3959 channels without RTC. Use this overlay if your HAT has no
3961 https://www.seeedstudio.com/2-Channel-CAN-BUS-FD-Shield-for-Raspberry-Pi-p-4072.html
3962 Load: dtoverlay=seeed-can-fd-hat-v1
3966 Name: seeed-can-fd-hat-v2
3967 Info: Overlay for Seeed Studio CAN BUS FD HAT with two CAN FD
3968 channels and an RTC. Use this overlay if your HAT has a
3970 https://www.seeedstudio.com/CAN-BUS-FD-HAT-for-Raspberry-Pi-p-4742.html
3971 Load: dtoverlay=seeed-can-fd-hat-v2
3976 Info: Overlay for SH1106 OLED via SPI using fbtft staging driver.
3977 Load: dtoverlay=sh1106-spi,<param>=<val>
3978 Params: speed SPI bus speed (default 4000000)
3979 rotate Display rotation (0, 90, 180 or 270; default 0)
3980 fps Delay between frame updates (default 25)
3981 debug Debug output level (0-7; default 0)
3982 dc_pin GPIO pin for D/C (default 24)
3983 reset_pin GPIO pin for RESET (default 25)
3984 height Display height (32 or 64; default 64)
3988 Info: Overlay for Si446x UHF Transceiver via SPI using si446x driver.
3989 The driver is currently out-of-tree at
3990 https://github.com/sunipkmukherjee/silabs.git
3991 Load: dtoverlay=si446x-spi0,<param>=<val>
3992 Params: speed SPI bus speed (default 4000000)
3993 int_pin GPIO pin for interrupts (default 17)
3994 reset_pin GPIO pin for RESET (default 27)
3998 Info: Enables the Secondary Memory Interface peripheral. Uses GPIOs 2-25!
4004 Info: Enables the userspace interface for the SMI driver
4005 Load: dtoverlay=smi-dev
4010 Info: Enables access to NAND flash via the SMI interface
4011 Load: dtoverlay=smi-nand
4016 Info: Move SPI function block to GPIO 35 to 39
4017 Load: dtoverlay=spi-gpio35-39
4022 Info: Move SPI function block to GPIOs 40 to 45
4023 Load: dtoverlay=spi-gpio40-45
4028 Info: Adds support for a number of SPI Real Time Clock devices
4029 Load: dtoverlay=spi-rtc,<param>=<val>
4030 Params: ds3232 Select the DS3232 device
4031 ds3234 Select the DS3234 device
4032 pcf2123 Select the PCF2123 device
4034 spi0_0 Use spi0.0 (default)
4040 cs_high This device requires an active-high CS
4044 Info: Don't claim any CS pins for SPI0. Requires a device with its chip
4045 select permanently enabled, but frees a GPIO for e.g. a DPI display.
4046 Load: dtoverlay=spi0-0cs,<param>=<val>
4047 Params: no_miso Don't claim and use the MISO pin (9), freeing
4052 Info: Only use one CS pin for SPI0
4053 Load: dtoverlay=spi0-1cs,<param>=<val>
4054 Params: cs0_pin GPIO pin for CS0 (default 8)
4055 no_miso Don't claim and use the MISO pin (9), freeing
4060 Info: Change the CS pins for SPI0
4061 Load: dtoverlay=spi0-2cs,<param>=<val>
4062 Params: cs0_pin GPIO pin for CS0 (default 8)
4063 cs1_pin GPIO pin for CS1 (default 7)
4064 no_miso Don't claim and use the MISO pin (9), freeing
4069 Info: This overlay has been renamed spi0-2cs, keeping spi0-cs as an
4070 alias for backwards compatibility.
4075 Info: This overlay has been deprecated and removed because it is no longer
4076 necessary and has been seen to prevent spi0 from working.
4081 Info: Enables spi1 with a single chip select (CS) line and associated spidev
4082 dev node. The gpio pin number for the CS line and spidev device node
4083 creation are configurable.
4084 N.B.: spi1 is not accessible on old Pis without a 40-pin header.
4085 Load: dtoverlay=spi1-1cs,<param>=<val>
4086 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
4087 cs0_spidev Set to 'off' to stop the creation of a
4088 userspace device node /dev/spidev1.0 (default
4089 is 'on' or enabled).
4093 Info: Enables spi1 with two chip select (CS) lines and associated spidev
4094 dev nodes. The gpio pin numbers for the CS lines and spidev device node
4095 creation are configurable.
4096 N.B.: spi1 is not accessible on old Pis without a 40-pin header.
4097 Load: dtoverlay=spi1-2cs,<param>=<val>
4098 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
4099 cs1_pin GPIO pin for CS1 (default 17 - BCM SPI1_CE1).
4100 cs0_spidev Set to 'off' to stop the creation of a
4101 userspace device node /dev/spidev1.0 (default
4102 is 'on' or enabled).
4103 cs1_spidev Set to 'off' to stop the creation of a
4104 userspace device node /dev/spidev1.1 (default
4105 is 'on' or enabled).
4109 Info: Enables spi1 with three chip select (CS) lines and associated spidev
4110 dev nodes. The gpio pin numbers for the CS lines and spidev device node
4111 creation are configurable.
4112 N.B.: spi1 is not accessible on old Pis without a 40-pin header.
4113 Load: dtoverlay=spi1-3cs,<param>=<val>
4114 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
4115 cs1_pin GPIO pin for CS1 (default 17 - BCM SPI1_CE1).
4116 cs2_pin GPIO pin for CS2 (default 16 - BCM SPI1_CE2).
4117 cs0_spidev Set to 'off' to stop the creation of a
4118 userspace device node /dev/spidev1.0 (default
4119 is 'on' or enabled).
4120 cs1_spidev Set to 'off' to stop the creation of a
4121 userspace device node /dev/spidev1.1 (default
4122 is 'on' or enabled).
4123 cs2_spidev Set to 'off' to stop the creation of a
4124 userspace device node /dev/spidev1.2 (default
4125 is 'on' or enabled).
4129 Info: Enables spi2 on GPIOs 40-42 with a single chip select (CS) line and
4130 associated spidev dev node. The gpio pin number for the CS line and
4131 spidev device node creation are configurable. spi2-2cs-pi5 is
4132 substituted on a Pi 5.
4133 N.B.: spi2 is only accessible with the Compute Module or Pi 5.
4134 Load: dtoverlay=spi2-1cs,<param>=<val>
4135 Params: cs0_pin GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
4136 cs0_spidev Set to 'off' to stop the creation of a
4137 userspace device node /dev/spidev2.0 (default
4138 is 'on' or enabled).
4142 Info: Enables spi2 on GPIOs 1-3 with a single chip select (CS) line and
4143 associated spidev dev node. The gpio pin number for the CS line and
4144 spidev device node creation are configurable. Pi 5 only.
4145 Load: dtoverlay=spi2-1cs-pi5,<param>=<val>
4146 Params: cs0_pin GPIO pin for CS0 (default 0).
4147 cs0_spidev Set to 'off' to stop the creation of a
4148 userspace device node /dev/spidev2.0 (default
4149 is 'on' or enabled).
4153 Info: Enables spi2 on GPIOs 40-42 with two chip select (CS) lines and
4154 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4155 spidev device node creation are configurable. spi2-2cs-pi5 is
4156 substituted on a Pi 5.
4157 N.B.: spi2 is only accessible with the Compute Module or Pi 5.
4158 Load: dtoverlay=spi2-2cs,<param>=<val>
4159 Params: cs0_pin GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
4160 cs1_pin GPIO pin for CS1 (default 44 - BCM SPI2_CE1).
4161 cs0_spidev Set to 'off' to stop the creation of a
4162 userspace device node /dev/spidev2.0 (default
4163 is 'on' or enabled).
4164 cs1_spidev Set to 'off' to stop the creation of a
4165 userspace device node /dev/spidev2.1 (default
4166 is 'on' or enabled).
4170 Info: Enables spi2 on GPIOs 1-3 with two chip select (CS) lines and
4171 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4172 spidev device node creation are configurable. Pi 5 only.
4173 Load: dtoverlay=spi2-2cs-pi5,<param>=<val>
4174 Params: cs0_pin GPIO pin for CS0 (default 0).
4175 cs1_pin GPIO pin for CS1 (default 24).
4176 cs0_spidev Set to 'off' to stop the creation of a
4177 userspace device node /dev/spidev2.0 (default
4178 is 'on' or enabled).
4179 cs1_spidev Set to 'off' to stop the creation of a
4180 userspace device node /dev/spidev2.1 (default
4181 is 'on' or enabled).
4185 Info: Enables spi2 on GPIOs 40-42 with three chip select (CS) lines and
4186 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4187 spidev device node creation are configurable.
4188 N.B.: spi2 is only accessible with the Compute Module or Pi 5.
4189 Load: dtoverlay=spi2-3cs,<param>=<val>
4190 Params: cs0_pin GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
4191 cs1_pin GPIO pin for CS1 (default 44 - BCM SPI2_CE1).
4192 cs2_pin GPIO pin for CS2 (default 45 - BCM SPI2_CE2).
4193 cs0_spidev Set to 'off' to stop the creation of a
4194 userspace device node /dev/spidev2.0 (default
4195 is 'on' or enabled).
4196 cs1_spidev Set to 'off' to stop the creation of a
4197 userspace device node /dev/spidev2.1 (default
4198 is 'on' or enabled).
4199 cs2_spidev Set to 'off' to stop the creation of a
4200 userspace device node /dev/spidev2.2 (default
4201 is 'on' or enabled).
4205 Info: Enables spi3 on GPIOs 1-3 with a single chip select (CS) line and
4206 associated spidev dev node. The gpio pin number for the CS line and
4207 spidev device node creation are configurable. BCM2711 only,
4208 spi3-1cs-pi5 is substituted on Pi 5.
4209 Load: dtoverlay=spi3-1cs,<param>=<val>
4210 Params: cs0_pin GPIO pin for CS0 (default 0 - BCM SPI3_CE0).
4211 cs0_spidev Set to 'off' to prevent the creation of a
4212 userspace device node /dev/spidev3.0 (default
4213 is 'on' or enabled).
4217 Info: Enables spi3 on GPIOs 5-7 with a single chip select (CS) line and
4218 associated spidev dev node. The gpio pin number for the CS line and
4219 spidev device node creation are configurable. Pi 5 only.
4220 Load: dtoverlay=spi3-1cs-pi5,<param>=<val>
4221 Params: cs0_pin GPIO pin for CS0 (default 4).
4222 cs0_spidev Set to 'off' to prevent the creation of a
4223 userspace device node /dev/spidev3.0 (default
4224 is 'on' or enabled).
4228 Info: Enables spi3 on GPIO2 1-3 with two chip select (CS) lines and
4229 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4230 spidev device node creation are configurable. BCM2711 only,
4231 spi3-2cs-pi5 is substituted on Pi 5.
4232 Load: dtoverlay=spi3-2cs,<param>=<val>
4233 Params: cs0_pin GPIO pin for CS0 (default 0 - BCM SPI3_CE0).
4234 cs1_pin GPIO pin for CS1 (default 24 - BCM SPI3_CE1).
4235 cs0_spidev Set to 'off' to prevent the creation of a
4236 userspace device node /dev/spidev3.0 (default
4237 is 'on' or enabled).
4238 cs1_spidev Set to 'off' to prevent the creation of a
4239 userspace device node /dev/spidev3.1 (default
4240 is 'on' or enabled).
4244 Info: Enables spi3 on GPIOs 5-7 with two chip select (CS) lines and
4245 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4246 spidev device node creation are configurable. Pi 5 only.
4247 Load: dtoverlay=spi3-2cs-pi5,<param>=<val>
4248 Params: cs0_pin GPIO pin for CS0 (default 4).
4249 cs1_pin GPIO pin for CS1 (default 25).
4250 cs0_spidev Set to 'off' to prevent the creation of a
4251 userspace device node /dev/spidev3.0 (default
4252 is 'on' or enabled).
4253 cs1_spidev Set to 'off' to prevent the creation of a
4254 userspace device node /dev/spidev3.1 (default
4255 is 'on' or enabled).
4259 Info: Enables spi4 on GPIOs 5-7 with a single chip select (CS) line and
4260 associated spidev dev node. The gpio pin number for the CS line and
4261 spidev device node creation are configurable. BCM2711 only.
4262 Load: dtoverlay=spi4-1cs,<param>=<val>
4263 Params: cs0_pin GPIO pin for CS0 (default 4 - BCM SPI4_CE0).
4264 cs0_spidev Set to 'off' to prevent the creation of a
4265 userspace device node /dev/spidev4.0 (default
4266 is 'on' or enabled).
4270 Info: Enables spi4 on GPIOs 5-6 with two chip select (CS) lines and
4271 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4272 spidev device node creation are configurable. BCM2711 only.
4273 Load: dtoverlay=spi4-2cs,<param>=<val>
4274 Params: cs0_pin GPIO pin for CS0 (default 4 - BCM SPI4_CE0).
4275 cs1_pin GPIO pin for CS1 (default 25 - BCM SPI4_CE1).
4276 cs0_spidev Set to 'off' to prevent the creation of a
4277 userspace device node /dev/spidev4.0 (default
4278 is 'on' or enabled).
4279 cs1_spidev Set to 'off' to prevent the creation of a
4280 userspace device node /dev/spidev4.1 (default
4281 is 'on' or enabled).
4285 Info: Enables spi5 on GPIOs 13-15 with a single chip select (CS) line and
4286 associated spidev dev node. The gpio pin numbers for the CS lines and
4287 spidev device node creation are configurable. BCM2711 and Pi 5.
4288 Load: dtoverlay=spi5-1cs,<param>=<val>
4289 Params: cs0_pin GPIO pin for CS0 (default 12).
4290 cs0_spidev Set to 'off' to prevent the creation of a
4291 userspace device node /dev/spidev5.0 (default
4292 is 'on' or enabled).
4300 Info: Enables spi5 on GPIOs 13-15 with two chip select (CS) lines and
4301 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4302 spidev device node creation are configurable. BCM2711 and Pi 5.
4303 Load: dtoverlay=spi5-2cs,<param>=<val>
4304 Params: cs0_pin GPIO pin for CS0 (default 12).
4305 cs1_pin GPIO pin for CS1 (default 26).
4306 cs0_spidev Set to 'off' to prevent the creation of a
4307 userspace device node /dev/spidev5.0 (default
4308 is 'on' or enabled).
4309 cs1_spidev Set to 'off' to prevent the creation of a
4310 userspace device node /dev/spidev5.1 (default
4311 is 'on' or enabled).
4319 Info: Enables spi6 with a single chip select (CS) line and associated spidev
4320 dev node. The gpio pin number for the CS line and spidev device node
4321 creation are configurable. BCM2711 only.
4322 Load: dtoverlay=spi6-1cs,<param>=<val>
4323 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI6_CE0).
4324 cs0_spidev Set to 'off' to prevent the creation of a
4325 userspace device node /dev/spidev6.0 (default
4326 is 'on' or enabled).
4330 Info: Enables spi6 with two chip select (CS) lines and associated spidev
4331 dev nodes. The gpio pin numbers for the CS lines and spidev device node
4332 creation are configurable. BCM2711 only.
4333 Load: dtoverlay=spi6-2cs,<param>=<val>
4334 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI6_CE0).
4335 cs1_pin GPIO pin for CS1 (default 27 - BCM SPI6_CE1).
4336 cs0_spidev Set to 'off' to prevent the creation of a
4337 userspace device node /dev/spidev6.0 (default
4338 is 'on' or enabled).
4339 cs1_spidev Set to 'off' to prevent the creation of a
4340 userspace device node /dev/spidev6.1 (default
4341 is 'on' or enabled).
4345 Info: Overlay for activation of SSD1306 over I2C OLED display framebuffer.
4346 Load: dtoverlay=ssd1306,<param>=<val>
4347 Params: address Location in display memory of first character.
4349 width Width of display. (default=128)
4350 height Height of display. (default=64)
4351 offset virtual channel a. (default=0)
4352 normal Has no effect on displays tested. (default=not
4354 sequential Set this if every other scan line is missing.
4356 remapped Set this if display is garbled. (default=not
4358 inverted Set this if display is inverted and mirrored.
4362 Typical usage for 128x64 display: dtoverlay=ssd1306,inverted
4364 Typical usage for 128x32 display: dtoverlay=ssd1306,inverted,sequential
4366 i2c_baudrate=400000 will speed up the display.
4368 i2c_baudrate=1000000 seems to work even though it's not officially
4369 supported by the hardware, and is faster still.
4371 For more information refer to the device datasheet at:
4372 https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf
4376 Info: Overlay for SSD1306 OLED via SPI using fbtft staging driver.
4377 Load: dtoverlay=ssd1306-spi,<param>=<val>
4378 Params: speed SPI bus speed (default 10000000)
4379 rotate Display rotation (0, 90, 180 or 270; default 0)
4380 fps Delay between frame updates (default 25)
4381 debug Debug output level (0-7; default 0)
4382 dc_pin GPIO pin for D/C (default 24)
4383 reset_pin GPIO pin for RESET (default 25)
4384 height Display height (32 or 64; default 64)
4385 inverted Set this if display is inverted and mirrored.
4390 Info: Overlay for SSD1331 OLED via SPI using fbtft staging driver.
4391 Load: dtoverlay=ssd1331-spi,<param>=<val>
4392 Params: speed SPI bus speed (default 4500000)
4393 rotate Display rotation (0, 90, 180 or 270; default 0)
4394 fps Delay between frame updates (default 25)
4395 debug Debug output level (0-7; default 0)
4396 dc_pin GPIO pin for D/C (default 24)
4397 reset_pin GPIO pin for RESET (default 25)
4401 Info: Overlay for SSD1351 OLED via SPI using fbtft staging driver.
4402 Load: dtoverlay=ssd1351-spi,<param>=<val>
4403 Params: speed SPI bus speed (default 4500000)
4404 rotate Display rotation (0, 90, 180 or 270; default 0)
4405 fps Delay between frame updates (default 25)
4406 debug Debug output level (0-7; default 0)
4407 dc_pin GPIO pin for D/C (default 24)
4408 reset_pin GPIO pin for RESET (default 25)
4411 Name: superaudioboard
4412 Info: Configures the SuperAudioBoard sound card
4413 Load: dtoverlay=superaudioboard,<param>=<val>
4414 Params: gpiopin GPIO pin for codec reset
4418 Info: Configures the Semtech SX150X I2C GPIO expanders.
4419 Load: dtoverlay=sx150x,<param>=<val>
4420 Params: sx150<x>-<n>-<m> Enables SX150X device on I2C#<n> with slave
4421 address <m>. <x> may be 1-9. <n> may be 0 or 1.
4422 Permissible values of <m> (which is denoted in
4423 hex) depend on the device variant. For SX1501,
4424 SX1502, SX1504 and SX1505, <m> may be 20 or 21.
4425 For SX1503 and SX1506, <m> may be 20. For
4426 SX1507 and SX1509, <m> may be 3E, 3F, 70 or 71.
4427 For SX1508, <m> may be 20, 21, 22 or 23.
4429 sx150<x>-<n>-<m>-int-gpio
4430 Integer, enables interrupts on SX150X device on
4431 I2C#<n> with slave address <m>, specifies
4432 the GPIO pin to which NINT output of SX150X is
4437 Info: Toshiba TC358743 HDMI to CSI-2 bridge chip.
4438 Uses Unicam 1, which is the standard camera connector on most Pi
4440 Load: dtoverlay=tc358743,<param>=<val>
4441 Params: 4lane Use 4 lanes (only applicable to Compute Modules
4444 link-frequency Set the link frequency. Only values of 297000000
4445 (574Mbit/s) and 486000000 (972Mbit/s - default)
4446 are supported by the driver.
4447 media-controller Configure use of Media Controller API for
4448 configuring the sensor (default off)
4449 cam0 Adopt the default configuration for CAM0 on a
4450 Compute Module (CSI0, i2c_vc, and cam0_reg).
4453 Name: tc358743-audio
4454 Info: Used in combination with the tc358743-fast overlay to route the audio
4455 from the TC358743 over I2S to the Pi.
4456 Wiring is LRCK/WFS to GPIO 19, BCK/SCK to GPIO 18, and DATA/SD to GPIO
4458 Load: dtoverlay=tc358743-audio,<param>=<val>
4459 Params: card-name Override the default, "tc358743", card name.
4463 Info: 3.5" Color TFT Display by www.tinylcd.com
4464 Options: Touch, RTC, keypad
4465 Load: dtoverlay=tinylcd35,<param>=<val>
4466 Params: speed Display SPI bus speed
4468 rotate Display rotation {0,90,180,270}
4470 fps Delay between frame updates
4472 debug Debug output level {0-7}
4474 touch Enable touch panel
4476 touchgpio Touch controller IRQ GPIO
4478 xohms Touchpanel: Resistance of X-plate in ohms
4480 rtc-pcf PCF8563 Real Time Clock
4482 rtc-ds DS1307 Real Time Clock
4484 keypad Enable keypad
4487 Display with touchpanel, PCF8563 RTC and keypad:
4488 dtoverlay=tinylcd35,touch,rtc-pcf,keypad
4490 dtoverlay=tinylcd35,touch,touchgpio=3
4494 Info: Enables support for Infineon SLB9670 Trusted Platform Module add-on
4495 boards, which can be used as a secure key storage and hwrng,
4496 available as "Iridium SLB9670" by Infineon and "LetsTrust TPM" by pi3g.
4497 Load: dtoverlay=tpm-slb9670
4502 Info: Enables support for Infineon SLB9673 Trusted Platform Module add-on
4503 boards, which can be used as a secure key storage and hwrng
4504 via the I2C protocol.
4505 Load: dtoverlay=tpm-slb9673
4510 Info: Change the pin usage of uart0
4511 Load: dtoverlay=uart0,<param>=<val>
4512 Params: txd0_pin GPIO pin for TXD0 (14, 32 or 36 - default 14)
4514 rxd0_pin GPIO pin for RXD0 (15, 33 or 37 - default 15)
4516 pin_func Alternative pin function - 4(Alt0) for 14&15,
4517 7(Alt3) for 32&33, 6(Alt2) for 36&37
4521 Info: Enable uart 0 on GPIOs 14-15. Pi 5 only.
4522 Load: dtoverlay=uart0-pi5,<param>
4523 Params: ctsrts Enable CTS/RTS on GPIOs 16-17 (default off)
4527 Info: Change the pin usage of uart1
4528 Load: dtoverlay=uart1,<param>=<val>
4529 Params: txd1_pin GPIO pin for TXD1 (14, 32 or 40 - default 14)
4531 rxd1_pin GPIO pin for RXD1 (15, 33 or 41 - default 15)
4535 Info: Enable uart 1 on GPIOs 0-1. Pi 5 only.
4536 Load: dtoverlay=uart1-pi5,<param>
4537 Params: ctsrts Enable CTS/RTS on GPIOs 2-3 (default off)
4541 Info: Enable uart 2 on GPIOs 0-3. BCM2711 only.
4542 Load: dtoverlay=uart2,<param>
4543 Params: ctsrts Enable CTS/RTS on GPIOs 2-3 (default off)
4547 Info: Enable uart 2 on GPIOs 4-5. Pi 5 only.
4548 Load: dtoverlay=uart2-pi5,<param>
4549 Params: ctsrts Enable CTS/RTS on GPIOs 6-7 (default off)
4553 Info: Enable uart 3 on GPIOs 4-7. BCM2711 only.
4554 Load: dtoverlay=uart3,<param>
4555 Params: ctsrts Enable CTS/RTS on GPIOs 6-7 (default off)
4559 Info: Enable uart 3 on GPIOs 8-9. Pi 5 only.
4560 Load: dtoverlay=uart3-pi5,<param>
4561 Params: ctsrts Enable CTS/RTS on GPIOs 10-11 (default off)
4565 Info: Enable uart 4 on GPIOs 8-11. BCM2711 only.
4566 Load: dtoverlay=uart4,<param>
4567 Params: ctsrts Enable CTS/RTS on GPIOs 10-11 (default off)
4571 Info: Enable uart 4 on GPIOs 12-13. Pi 5 only.
4572 Load: dtoverlay=uart4-pi5,<param>
4573 Params: ctsrts Enable CTS/RTS on GPIOs 14-15 (default off)
4577 Info: Enable uart 5 on GPIOs 12-15. BCM2711 only.
4578 Load: dtoverlay=uart5,<param>
4579 Params: ctsrts Enable CTS/RTS on GPIOs 14-15 (default off)
4583 Info: Configures the NW Digital Radio UDRC Hat
4584 Load: dtoverlay=udrc,<param>=<val>
4585 Params: alsaname Name of the ALSA audio device (default "udrc")
4588 Name: ugreen-dabboard
4589 Info: Configures the ugreen-dabboard I2S overlay
4590 This is a simple overlay based on the simple-audio-card and the dmic
4591 codec. It has the speciality that it is configured to use the codec
4592 as a master I2S device. It works for example with the Si468x DAB
4593 receiver on the uGreen DABBoard.
4594 Load: dtoverlay=ugreen-dabboard,<param>=<val>
4595 Params: card-name Override the default, "dabboard", card name.
4599 Info: Allow usage of downstream .dtb with upstream kernel. Comprises the
4600 vc4-kms-v3d and dwc2 overlays.
4601 Load: dtoverlay=upstream
4605 Name: upstream-aux-interrupt
4606 Info: This overlay has been deprecated and removed because it is no longer
4612 Info: Allow usage of downstream .dtb with upstream kernel on Pi 4. Comprises
4613 the vc4-kms-v3d-pi4 and dwc2 overlays.
4614 Load: dtoverlay=upstream-pi4
4619 Info: Enable Eric Anholt's DRM VC4 V3D driver on top of the dispmanx
4621 Load: dtoverlay=vc4-fkms-v3d,<param>
4622 Params: cma-512 CMA is 512MB (needs 1GB)
4623 cma-448 CMA is 448MB (needs 1GB)
4624 cma-384 CMA is 384MB (needs 1GB)
4625 cma-320 CMA is 320MB (needs 1GB)
4626 cma-256 CMA is 256MB (needs 1GB)
4627 cma-192 CMA is 192MB (needs 1GB)
4628 cma-128 CMA is 128MB
4631 cma-size CMA size in bytes, 4MB aligned
4632 cma-default Use upstream's default value
4635 Name: vc4-fkms-v3d-pi4
4636 Info: Enable Eric Anholt's DRM VC4 V3D driver on top of the dispmanx
4638 Load: dtoverlay=vc4-fkms-v3d-pi4,<param>
4639 Params: cma-512 CMA is 512MB (needs 1GB)
4640 cma-448 CMA is 448MB (needs 1GB)
4641 cma-384 CMA is 384MB (needs 1GB)
4642 cma-320 CMA is 320MB (needs 1GB)
4643 cma-256 CMA is 256MB (needs 1GB)
4644 cma-192 CMA is 192MB (needs 1GB)
4645 cma-128 CMA is 128MB
4648 cma-size CMA size in bytes, 4MB aligned
4649 cma-default Use upstream's default value
4652 Name: vc4-kms-dpi-at056tn53v1
4653 Info: This overlay is now deprecated - see vc4-kms-dpi-panel,at056tn53v1
4657 Name: vc4-kms-dpi-generic
4658 Info: Enable a generic DPI display under KMS. Default timings are for the
4659 Adafruit Kippah with 800x480 panel and RGB666 (GPIOs 0-21)
4660 Requires vc4-kms-v3d to be loaded.
4661 Load: dtoverlay=vc4-kms-dpi-generic,<param>=<val>
4662 Params: clock-frequency Display clock frequency (Hz)
4663 hactive Horizontal active pixels
4664 hfp Horizontal front porch
4665 hsync Horizontal sync pulse width
4666 hbp Horizontal back porch
4667 vactive Vertical active lines
4668 vfp Vertical front porch
4669 vsync Vertical sync pulse width
4670 vbp Vertical back porch
4671 hsync-invert Horizontal sync active low
4672 vsync-invert Vertical sync active low
4673 de-invert Data Enable active low
4674 pixclk-invert Negative edge pixel clock
4675 width-mm Define the screen width in mm
4676 height-mm Define the screen height in mm
4677 rgb565 Change to RGB565 output on GPIOs 0-19
4678 rgb565-padhi Change to RGB565 output on GPIOs 0-8, 12-17, and
4680 bgr666 Change to BGR666 output on GPIOs 0-21.
4681 bgr666-padhi Change to BGR666 output on GPIOs 0-9, 12-17, and
4683 rgb666-padhi Change to RGB666 output on GPIOs 0-9, 12-17, and
4685 bgr888 Change to BGR888 output on GPIOs 0-27
4686 rgb888 Change to RGB888 output on GPIOs 0-27
4687 bus-format Override the bus format for a MEDIA_BUS_FMT_*
4688 value. NB also overridden by rgbXXX overrides.
4689 backlight-gpio Defines a GPIO to be used for backlight control
4691 backlight-pwm Defines a PWM channel to be used for backlight
4692 control (default of none). NB Disables audio
4693 headphone output as that also uses PWM.
4694 backlight-pwm-chan Choose channel on &pwm node for backlight
4697 backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See
4698 pwm-2chan for valid options.
4699 (default 18 - note this can only work with
4701 backlight-pwm-func Pin function of GPIO used for the PWM
4703 See pwm-2chan for valid options.
4705 backlight-def-brightness
4706 Set the default brightness. Normal range 1-16.
4708 rotate Display rotation {0,90,180,270} (default 0)
4711 Name: vc4-kms-dpi-hyperpixel2r
4712 Info: Enable the KMS drivers for the Pimoroni HyperPixel2 Round DPI display.
4713 Requires vc4-kms-v3d to be loaded.
4714 Load: dtoverlay=vc4-kms-dpi-hyperpixel2r,<param>=<val>
4715 Params: disable-touch Disables the touch controller
4716 touchscreen-inverted-x Inverts X direction of touch controller
4717 touchscreen-inverted-y Inverts Y direction of touch controller
4718 touchscreen-swapped-x-y Swaps X & Y axes of touch controller
4719 rotate Display rotation {0,90,180,270} (default 0)
4722 Name: vc4-kms-dpi-hyperpixel4
4723 Info: Enable the KMS drivers for the Pimoroni HyperPixel4 DPI display.
4724 Requires vc4-kms-v3d to be loaded.
4725 Load: dtoverlay=vc4-kms-dpi-hyperpixel4,<param>=<val>
4726 Params: disable-touch Disables the touch controller
4727 touchscreen-inverted-x Inverts X direction of touch controller
4728 touchscreen-inverted-y Inverts Y direction of touch controller
4729 touchscreen-swapped-x-y Swaps X & Y axes of touch controller
4730 rotate Display rotation {0,90,180,270} (default 0)
4733 Name: vc4-kms-dpi-hyperpixel4sq
4734 Info: Enable the KMS drivers for the Pimoroni HyperPixel4 Square DPI display.
4735 Requires vc4-kms-v3d to be loaded.
4736 Load: dtoverlay=vc4-kms-dpi-hyperpixel4sq,<param>=<val>
4737 Params: disable-touch Disables the touch controller
4738 touchscreen-inverted-x Inverts X direction of touch controller
4739 touchscreen-inverted-y Inverts Y direction of touch controller
4740 touchscreen-swapped-x-y Swaps X & Y axes of touch controller
4741 rotate Display rotation {0,90,180,270} (default 0)
4744 Name: vc4-kms-dpi-panel
4745 Info: Enable a preconfigured KMS DPI panel.
4746 Requires vc4-kms-v3d to be loaded.
4747 Load: dtoverlay=vc4-kms-dpi-panel,<param>=<val>
4748 Params: at056tn53v1 Enable an Innolux 5.6in VGA TFT
4749 kippah-7inch Enable an Adafruit Kippah with 7inch panel.
4750 mzp280 Enable a Geekworm MZP280 panel.
4751 backlight-gpio Defines a GPIO to be used for backlight control
4753 backlight-pwm Defines a PWM channel to be used for backlight
4754 control (default of none). NB Disables audio
4755 headphone output as that also uses PWM.
4756 backlight-pwm-chan Choose channel on &pwm node for backlight
4759 backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See
4760 pwm-2chan for valid options.
4761 (default 18 - note this can only work with
4763 backlight-pwm-func Pin function of GPIO used for the PWM
4765 See pwm-2chan for valid options.
4767 backlight-def-brightness
4768 Set the default brightness. Normal range 1-16.
4770 rotate Display rotation {0,90,180,270} (default 0)
4773 Name: vc4-kms-dsi-7inch
4774 Info: Enable the Raspberry Pi DSI 7" screen.
4775 Includes the edt-ft5406 for the touchscreen element.
4776 Requires vc4-kms-v3d to be loaded.
4777 Load: dtoverlay=vc4-kms-dsi-7inch,<param>=<val>
4778 Params: sizex Touchscreen size x (default 800)
4779 sizey Touchscreen size y (default 480)
4780 invx Touchscreen inverted x axis
4781 invy Touchscreen inverted y axis
4782 swapxy Touchscreen swapped x y axis
4783 disable_touch Disables the touch screen overlay driver
4784 dsi0 Use DSI0 and i2c_csi_dsi0 (rather than
4785 the default DSI1 and i2c_csi_dsi).
4788 Name: vc4-kms-dsi-lt070me05000
4789 Info: Enable a JDI LT070ME05000 DSI display on DSI1.
4790 Note that this is a 4 lane DSI device, so it will only work on a Compute
4792 Requires vc4-kms-v3d to be loaded.
4793 Load: dtoverlay=vc4-kms-dsi-lt070me05000,<param>
4794 Params: reset GPIO for the reset signal (default 17)
4795 enable GPIO for the enable signal (default 4)
4796 dcdc-en GPIO for the DC-DC converter enable (default 5)
4799 Name: vc4-kms-dsi-lt070me05000-v2
4800 Info: Enable a JDI LT070ME05000 DSI display on DSI1 using Harlab's V2
4802 Note that this is a 4 lane DSI device, so it will only work on a Compute
4804 Requires vc4-kms-v3d to be loaded.
4805 Load: dtoverlay=vc4-kms-dsi-lt070me05000-v2
4809 Name: vc4-kms-dsi-waveshare-panel
4810 Info: Enable a Waveshare DSI touchscreen
4811 Includes the Goodix driver for the touchscreen element.
4812 The default is for the display to be using the I2C0 option for control.
4813 Use the i2c1 override if using the I2C1 wiring with jumper wires from
4814 GPIOs 2&3 (pins 3&5).
4815 invx/invy/swapxy should be used with caution as the panel specifier will
4816 set the default inversions for that panel. Always use them after the
4817 panel specifier, and be aware that you may need to set them as =0, not
4819 Requires vc4-kms-v3d to be loaded.
4820 Load: dtoverlay=vc4-kms-dsi-waveshare-panel,<param>=<val>
4821 Params: 2_8_inch 2.8" 480x640
4822 3_4_inch 3.4" 800x800 round
4823 4_0_inch 4.0" 480x800
4824 7_0_inchC 7.0" C 1024x600
4825 7_9_inch 7.9" 400x1280
4826 8_0_inch 8.0" 1280x800
4827 10_1_inch 10.1" 1280x800
4828 11_9_inch 11.9" 320x1480
4829 i2c1 Use i2c-1 with jumper wires from GPIOs 2&3
4830 disable_touch Disable the touch controller
4831 rotation Set the panel orientation property
4832 invx Touchscreen inverted x axis
4833 invy Touchscreen inverted y axis
4834 swapxy Touchscreen swapped x y axis
4835 dsi0 Use DSI0 and i2c_csi_dsi0 (rather than
4836 the default DSI1 and i2c_csi_dsi).
4839 Name: vc4-kms-kippah-7inch
4840 Info: This overlay is now deprecated - see vc4-kms-dpi-panel,kippah-7inch
4845 Info: Enable Eric Anholt's DRM VC4 HDMI/HVS/V3D driver.
4846 Load: dtoverlay=vc4-kms-v3d,<param>
4847 Params: cma-512 CMA is 512MB (needs 1GB)
4848 cma-448 CMA is 448MB (needs 1GB)
4849 cma-384 CMA is 384MB (needs 1GB)
4850 cma-320 CMA is 320MB (needs 1GB)
4851 cma-256 CMA is 256MB (needs 1GB)
4852 cma-192 CMA is 192MB (needs 1GB)
4853 cma-128 CMA is 128MB
4856 cma-size CMA size in bytes, 4MB aligned
4857 cma-default Use upstream's default value
4858 audio Enable or disable audio over HDMI (default "on")
4859 noaudio Disable all HDMI audio (default "off")
4860 composite Enable the composite output (default "off")
4861 N.B. Disables all other outputs on a Pi 4.
4862 nohdmi Disable HDMI output
4865 Name: vc4-kms-v3d-pi4
4866 Info: Enable Eric Anholt's DRM VC4 HDMI/HVS/V3D driver for Pi4.
4867 Load: dtoverlay=vc4-kms-v3d-pi4,<param>
4868 Params: cma-512 CMA is 512MB
4869 cma-448 CMA is 448MB
4870 cma-384 CMA is 384MB
4871 cma-320 CMA is 320MB
4872 cma-256 CMA is 256MB
4873 cma-192 CMA is 192MB
4874 cma-128 CMA is 128MB
4877 cma-size CMA size in bytes, 4MB aligned
4878 cma-default Use upstream's default value
4879 audio Enable or disable audio over HDMI0 (default
4881 audio1 Enable or disable audio over HDMI1 (default
4883 noaudio Disable all HDMI audio (default "off")
4884 composite Enable the composite output (disables all other
4886 nohdmi Disable both HDMI 0 & 1 outputs
4887 nohdmi0 Disable HDMI 0 output
4888 nohdmi1 Disable HDMI 1 output
4891 Name: vc4-kms-v3d-pi5
4892 Info: See vc4-kms-v3d-pi4 (this is the Pi 5 version)
4895 Name: vc4-kms-vga666
4896 Info: Enable the VGA666 (resistor ladder ADC) for the vc4-kms-v3d driver.
4897 Requires vc4-kms-v3d to be loaded.
4898 Load: dtoverlay=vc4-kms-vga666,<param>
4899 Params: ddc Enables GPIOs 0&1 as the I2C to read the EDID
4900 from the display. NB These are NOT 5V tolerant
4901 GPIOs, therefore level shifters are required.
4905 Info: Overlay for the Fen Logic VGA666 board
4906 This uses GPIOs 2-21 (so no I2C), and activates the output 2-3 seconds
4907 after the kernel has started.
4908 NOT for use with vc4-kms-v3d.
4909 Load: dtoverlay=vga666
4914 Info: Overlay to enable a VIA VL805 USB3 controller on CM4 carriers
4915 Will be loaded automatically by up-to-date firmware if "VL805=1" is
4916 set in the EEPROM config.
4917 Load: dtoverlay=vl805
4922 Info: Configures the w1-gpio Onewire interface module.
4923 Use this overlay if you *don't* need a GPIO to drive an external pullup.
4924 Load: dtoverlay=w1-gpio,<param>=<val>
4925 Params: gpiopin GPIO for I/O (default "4")
4926 pullup Now enabled by default (ignored)
4929 Name: w1-gpio-pullup
4930 Info: Configures the w1-gpio Onewire interface module.
4931 Use this overlay if you *do* need a GPIO to drive an external pullup.
4932 Load: dtoverlay=w1-gpio-pullup,<param>=<val>
4933 Params: gpiopin GPIO for I/O (default "4")
4934 extpullup GPIO for external pullup (default "5")
4935 pullup Now enabled by default (ignored)
4939 Info: Overlay for the Wiznet W5500 Ethernet Controller on SPI0
4940 Load: dtoverlay=w5500,<param>=<val>
4941 Params: int_pin GPIO used for INT (default 25)
4943 speed SPI bus speed (default 30000000)
4945 cs SPI bus Chip Select (default 0)
4948 Name: watterott-display
4949 Info: Watterott RPi-Display - 2.8" Touch Display
4950 Linux has 2 drivers that support this display and this overlay supports
4954 fbtft/fb_ili9341: dtoverlay=watterott-display
4955 drm/mi0283qt: dtoverlay=watterott-display,drm,backlight-pwm,rotate=180
4957 Some notable differences with the DRM driver compared to fbtft:
4958 - The display is turned on when it's first used and not on driver load
4959 as with fbtft. So if nothing uses the display it stays off.
4960 - Can run with a higher SPI clock increasing framerate. This is possible
4961 since the driver avoids messing up the controller configuration due to
4962 transmission errors by running config commands at 10MHz and only pixel
4963 data at full speed (occasional pixel glitch might occur).
4964 - PWM backlight is supported.
4966 Load: dtoverlay=watterott-display,<param>=<val>
4967 Params: speed Display SPI bus speed
4968 rotate Display rotation {0,90,180,270}
4969 fps Delay between frame updates (fbtft only)
4970 debug Debug output level {0-7} (fbtft only)
4971 xohms Touchpanel sensitivity (X-plate resistance)
4972 swapxy Swap x and y axis
4973 backlight Change backlight GPIO pin {e.g. 12, 18}
4975 drm Use DRM/KMS driver mi0283qt instead of fbtft.
4976 Set the SPI clock to 70MHz.
4977 This has to be the first parameter.
4978 backlight-pwm Use pwm for backlight (drm only). NB: Disables
4979 audio headphone output as that also uses PWM.
4982 Name: waveshare-can-fd-hat-mode-a
4983 Info: Overlay for the Waveshare 2-Channel Isolated CAN FD Expansion HAT
4984 for Raspberry Pi, Multi Protections. Use this overlay when the
4985 HAT is configured in Mode A (Default), with can0 on spi0.0
4987 https://www.waveshare.com/2-ch-can-fd-hat.htm
4988 Load: dtoverlay=waveshare-can-fd-hat-mode-a
4992 Name: waveshare-can-fd-hat-mode-b
4993 Info: Overlay for the Waveshare 2-Channel Isolated CAN FD Expansion HAT
4994 for Raspberry Pi, Multi Protections. Use this overlay when the
4995 HAT is configured in Mode B (requires hardware modification), with
4996 can0 on spi0.0 and can1 on spi0.1.
4997 https://www.waveshare.com/2-ch-can-fd-hat.htm
4998 Load: dtoverlay=waveshare-can-fd-hat-mode-b
5003 Info: Configures the wittypi RTC module.
5004 Load: dtoverlay=wittypi,<param>=<val>
5005 Params: led_gpio GPIO for LED (default "17")
5006 led_trigger Choose which activity the LED tracks (default
5010 Name: wm8960-soundcard
5011 Info: Overlay for the Waveshare wm8960 soundcard
5012 Load: dtoverlay=wm8960-soundcard,<param>=<val>
5013 Params: alsaname Changes the card name in ALSA
5014 compatible Changes the codec compatibility
5020 If you are experiencing problems that you think are DT-related, enable DT
5021 diagnostic output by adding this to /boot/config.txt:
5025 and rebooting. Then run:
5029 and look for relevant messages.
5034 This is only meant to be a quick introduction to the subject of Device Tree on
5035 Raspberry Pi. There is a more complete explanation here:
5037 http://www.raspberrypi.org/documentation/configuration/device-tree.md