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/5 (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/5 (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 fan_temp0 Temperature threshold (in millicelcius) for
237 1st cooling level (default 50000). Pi5 only.
238 fan_temp0_hyst Temperature hysteresis (in millicelcius) for
239 1st cooling level (default 5000). Pi5 only.
240 fan_temp0_speed Fan PWM setting for 1st cooling level (0-255,
241 default 75). Pi5 only.
242 fan_temp1 Temperature threshold (in millicelcius) for
243 2nd cooling level (default 60000). Pi5 only.
244 fan_temp1_hyst Temperature hysteresis (in millicelcius) for
245 2nd cooling level (default 5000). Pi5 only.
246 fan_temp1_speed Fan PWM setting for 2nd cooling level (0-255,
247 default 125). Pi5 only.
248 fan_temp2 Temperature threshold (in millicelcius) for
249 3rd cooling level (default 67500). Pi5 only.
250 fan_temp2_hyst Temperature hysteresis (in millicelcius) for
251 3rd cooling level (default 5000). Pi5 only.
252 fan_temp2_speed Fan PWM setting for 3rd cooling level (0-255,
253 default 175). Pi5 only.
254 fan_temp3 Temperature threshold (in millicelcius) for
255 4th cooling level (default 75000). Pi5 only.
256 fan_temp3_hyst Temperature hysteresis (in millicelcius) for
257 4th cooling level (default 5000). Pi5 only.
258 fan_temp3_speed Fan PWM setting for 4th cooling level (0-255,
259 default 250). Pi5 only.
261 hdmi Set to "off" to disable the HDMI interface
264 i2c An alias for i2c_arm
266 i2c_arm Set to "on" to enable the ARM's i2c interface
269 i2c_arm_baudrate Set the baudrate of the ARM's i2c interface
272 i2c_baudrate An alias for i2c_arm_baudrate
274 i2c_csi_dsi Set to "on" to enable the i2c_csi_dsi interface
276 i2c_csi_dsi0 Set to "on" to enable the i2c_csi_dsi0 interface
278 i2c_csi_dsi1 Set to "on" to enable the i2c_csi_dsi1 interface
280 i2c_vc Set to "on" to enable the i2c interface
281 usually reserved for the VideoCore processor
284 i2c_vc_baudrate Set the baudrate of the VideoCore i2c interface
287 i2s Set to "on" to enable the i2s interface
290 i2s_dma4 Use to enable 40-bit DMA on the i2s interface
291 (the assigned value doesn't matter)
294 krnbt Set to "off" to disable autoprobing of Bluetooth
295 driver without need of hciattach/btattach
298 krnbt_baudrate Set the baudrate of the PL011 UART when used
301 nvme Alias for "pciex1" (2712 only)
303 pcie Set to "off" to disable the PCIe interface
305 (2711 only, but not applicable on CM4S)
306 N.B. USB-A ports on 4B are subsequently disabled
308 pcie_tperst_clk_ms Add N milliseconds between PCIe reference clock
309 activation and PERST# deassertion
310 (CM4 and 2712, default "0")
312 pciex1 Set to "on" to enable the external PCIe link
313 (2712 only, default "off")
315 pciex1_gen Sets the PCIe "GEN"/speed for the external PCIe
316 link (2712 only, default "2")
318 pciex1_no_l0s Set to "on" to disable ASPM L0s on the external
319 PCIe link for devices that have broken
320 implementations (2712 only, default "off")
322 pciex1_tperst_clk_ms Alias for pcie_tperst_clk_ms
323 (2712 only, default "0")
325 spi Set to "on" to enable the spi interfaces
328 spi_dma4 Use to enable 40-bit DMA on spi interfaces
329 (the assigned value doesn't matter)
332 random Set to "on" to enable the hardware random
333 number generator (default "on")
335 rtc Set to "off" to disable the onboard Real Time
336 Clock (2712 only, default "on")
338 rtc_bbat_vchg Set the RTC backup battery charging voltage in
339 microvolts. If set to 0 or not specified, the
340 trickle charger is disabled.
341 (2712 only, default "0")
343 sd Set to "off" to disable the SD card (or eMMC on
344 non-lite SKU of CM4).
347 sd_overclock Clock (in MHz) to use when the MMC framework
350 sd_poll_once Looks for a card once after booting. Useful
351 for network booting scenarios to avoid the
352 overhead of continuous polling. N.B. Using
353 this option restricts the system to using a
354 single card per boot (or none at all).
357 sd_force_pio Disable DMA support for SD driver (default off)
359 sd_pio_limit Number of blocks above which to use DMA for
362 sd_debug Enable debug output from SD driver (default off)
364 sdio_overclock Clock (in MHz) to use when the MMC framework
365 requests 50MHz for the SDIO/WLAN interface.
367 suspend Make the power button trigger a suspend rather
368 than a power-off (2712 only, default "off")
370 tx_lpi_timer Set the delay in microseconds between going idle
371 and entering the low power state (default 600).
372 Requires EEE to be enabled - see "eee".
374 uart0 Set to "off" to disable uart0 (default "on")
376 uart0_console Move the kernel boot console to UART0 on pins
377 6, 8 and 10 of the 40-way header (2712 only,
380 uart1 Set to "on" or "off" to enable or disable uart1
383 watchdog Set to "on" to enable the hardware watchdog
386 wifiaddr Set an alternative WiFi MAC address.
387 The value should be a 6-byte hexadecimal value,
388 with or without colon separators, written in the
389 natural (big-endian) order.
391 act_led_trigger Choose which activity the LED tracks.
392 Use "heartbeat" for a nice load indicator.
395 act_led_activelow Set to "on" to invert the sense of the LED
397 N.B. For Pi 3B, 3B+, 3A+ and 4B, use the act-led
400 act_led_gpio Set which GPIO to use for the activity LED
401 (in case you want to connect it to an external
403 (default "16" on a non-Plus board, "47" on a
405 N.B. For Pi 3B, 3B+, 3A+ and 4B, use the act-led
411 As for act_led_*, but using the PWR LED.
412 Not available on Model A/B boards.
414 N.B. It is recommended to only enable those interfaces that are needed.
415 Leaving all interfaces enabled can lead to unwanted behaviour (i2c_vc
416 interfering with Pi Camera, I2S and SPI hogging GPIO pins, etc.)
417 Note also that i2c, i2c_arm and i2c_vc are aliases for the physical
418 interfaces i2c0 and i2c1. Use of the numeric variants is still possible
419 but deprecated because the ARM/VC assignments differ between board
420 revisions. The same board-specific mapping applies to i2c_baudrate,
421 and the other i2c baudrate parameters.
425 Info: Pi 3B, 3B+, 3A+ and 4B use a GPIO expander to drive the LEDs which can
426 only be accessed from the VPU. There is a special driver for this with a
427 separate DT node, which has the unfortunate consequence of breaking the
428 act_led_gpio and act_led_activelow dtparams.
429 This overlay changes the GPIO controller back to the standard one and
430 restores the dtparams.
431 Load: dtoverlay=act-led,<param>=<val>
432 Params: activelow Set to "on" to invert the sense of the LED
435 gpio Set which GPIO to use for the activity LED
436 (in case you want to connect it to an external
441 Name: adafruit-st7735r
442 Info: Overlay for the SPI-connected Adafruit 1.8" 160x128 or 128x128 displays,
443 based on the ST7735R chip.
444 This overlay uses the newer DRM/KMS "Tiny" driver.
445 Load: dtoverlay=adafruit-st7735r,<param>=<val>
446 Params: 128x128 Select the 128x128 driver (default 160x128)
447 rotate Display rotation {0,90,180,270} (default 90)
448 speed SPI bus speed in Hz (default 4000000)
449 dc_pin GPIO pin for D/C (default 24)
450 reset_pin GPIO pin for RESET (default 25)
451 led_pin GPIO used to control backlight (default 18)
455 Info: Overlay for the SPI-connected Adafruit 1.8" display (based on the
456 ST7735R chip). It includes support for the "green tab" version.
457 This overlay uses the older fbtft driver.
458 Load: dtoverlay=adafruit18,<param>=<val>
459 Params: green Use the adafruit18_green variant.
460 rotate Display rotation {0,90,180,270}
461 speed SPI bus speed in Hz (default 4000000)
462 fps Display frame rate in Hz
463 bgr Enable BGR mode (default off)
464 debug Debug output level {0-7}
465 dc_pin GPIO pin for D/C (default 24)
466 reset_pin GPIO pin for RESET (default 25)
467 led_pin GPIO used to control backlight (default 18)
471 Info: Overlay for activation of ADAU1977 ADC codec over I2C for control
473 Load: dtoverlay=adau1977-adc
477 Name: adau7002-simple
478 Info: Overlay for the activation of ADAU7002 stereo PDM to I2S converter.
479 Load: dtoverlay=adau7002-simple,<param>=<val>
480 Params: card-name Override the default, "adau7002", card name.
484 Info: Overlay for activation of Texas Instruments ADS1015 ADC over I2C
485 Load: dtoverlay=ads1015,<param>=<val>
486 Params: addr I2C bus address of device. Set based on how the
487 addr pin is wired. (default=0x48 assumes addr
489 cha_enable Enable virtual channel a. (default=true)
490 cha_cfg Set the configuration for virtual channel a.
491 (default=4 configures this channel for the
492 voltage at A0 with respect to GND)
493 cha_datarate Set the datarate (samples/sec) for this channel.
494 (default=4 sets 1600 sps)
495 cha_gain Set the gain of the Programmable Gain
496 Amplifier for this channel. (default=2 sets the
497 full scale of the channel to 2.048 Volts)
499 Channel (ch) parameters can be set for each enabled channel.
500 A maximum of 4 channels can be enabled (letters a thru d).
501 For more information refer to the device datasheet at:
502 http://www.ti.com/lit/ds/symlink/ads1015.pdf
506 Info: Texas Instruments ADS1115 ADC
507 Load: dtoverlay=ads1115,<param>[=<val>]
508 Params: addr I2C bus address of device. Set based on how the
509 addr pin is wired. (default=0x48 assumes addr
511 cha_enable Enable virtual channel a.
512 cha_cfg Set the configuration for virtual channel a.
513 (default=4 configures this channel for the
514 voltage at A0 with respect to GND)
515 cha_datarate Set the datarate (samples/sec) for this channel.
516 (default=7 sets 860 sps)
517 cha_gain Set the gain of the Programmable Gain
518 Amplifier for this channel. (Default 1 sets the
519 full scale of the channel to 4.096 Volts)
520 i2c0 Choose the I2C0 bus on GPIOs 0&1
521 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
522 i2c3 Choose the I2C3 bus (configure with the i2c3
523 overlay - BCM2711 only)
524 i2c4 Choose the I2C4 bus (configure with the i2c4
525 overlay - BCM2711 only)
526 i2c5 Choose the I2C5 bus (configure with the i2c5
527 overlay - BCM2711 only)
528 i2c6 Choose the I2C6 bus (configure with the i2c6
529 overlay - BCM2711 only)
531 Channel parameters can be set for each enabled channel.
532 A maximum of 4 channels can be enabled (letters a thru d).
533 For more information refer to the device datasheet at:
534 http://www.ti.com/lit/ds/symlink/ads1115.pdf
538 Info: ADS7846 Touch controller
539 Load: dtoverlay=ads7846,<param>=<val>
540 Params: cs SPI bus Chip Select (default 1)
541 speed SPI bus speed (default 2MHz, max 3.25MHz)
542 penirq GPIO used for PENIRQ. REQUIRED
543 penirq_pull Set GPIO pull (default 0=none, 2=pullup)
544 swapxy Swap x and y axis
545 xmin Minimum value on the X axis (default 0)
546 ymin Minimum value on the Y axis (default 0)
547 xmax Maximum value on the X axis (default 4095)
548 ymax Maximum value on the Y axis (default 4095)
549 pmin Minimum reported pressure value (default 0)
550 pmax Maximum reported pressure value (default 65535)
551 xohms Touchpanel sensitivity (X-plate resistance)
554 penirq is required and usually xohms (60-100) has to be set as well.
555 Apart from that, pmax (255) and swapxy are also common.
556 The rest of the calibration can be done with xinput-calibrator.
557 See: github.com/notro/fbtft/wiki/FBTFT-on-Raspian
558 Device Tree binding document:
559 www.kernel.org/doc/Documentation/devicetree/bindings/input/ads7846.txt
563 Info: Analog Devices ADV7282M analogue video to CSI2 bridge.
564 Uses Unicam1, which is the standard camera connector on most Pi
566 Load: dtoverlay=adv7282m,<param>=<val>
567 Params: addr Overrides the I2C address (default 0x21)
568 media-controller Configure use of Media Controller API for
569 configuring the sensor (default off)
573 Info: Analog Devices ADV728[0|1|2]-M analogue video to CSI2 bridges.
574 This is a wrapper for adv7282m, and defaults to ADV7282M.
575 Load: dtoverlay=adv728x-m,<param>=<val>
576 Params: addr Overrides the I2C address (default 0x21)
577 adv7280m Select ADV7280-M.
578 adv7281m Select ADV7281-M.
579 adv7281ma Select ADV7281-MA.
580 media-controller Configure use of Media Controller API for
581 configuring the sensor (default off)
584 Name: akkordion-iqdacplus
585 Info: Configures the Digital Dreamtime Akkordion Music Player (based on the
586 OEM IQAudIO DAC+ or DAC Zero module).
587 Load: dtoverlay=akkordion-iqdacplus,<param>=<val>
588 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
589 Digital volume control. Enable with
590 dtoverlay=akkordion-iqdacplus,24db_digital_gain
591 (The default behaviour is that the Digital
592 volume control is limited to a maximum of
593 0dB. ie. it can attenuate but not provide
594 gain. For most users, this will be desired
595 as it will prevent clipping. By appending
596 the 24db_digital_gain parameter, the Digital
597 volume control will allow up to 24dB of
598 gain. If this parameter is enabled, it is the
599 responsibility of the user to ensure that
600 the Digital volume control is set to a value
601 that does not result in clipping/distortion!)
604 Name: allo-boss-dac-pcm512x-audio
605 Info: Configures the Allo Boss DAC audio cards.
606 Load: dtoverlay=allo-boss-dac-pcm512x-audio,<param>
607 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
608 Digital volume control. Enable with
609 "dtoverlay=allo-boss-dac-pcm512x-audio,
611 (The default behaviour is that the Digital
612 volume control is limited to a maximum of
613 0dB. ie. it can attenuate but not provide
614 gain. For most users, this will be desired
615 as it will prevent clipping. By appending
616 the 24db_digital_gain parameter, the Digital
617 volume control will allow up to 24dB of
618 gain. If this parameter is enabled, it is the
619 responsibility of the user to ensure that
620 the Digital volume control is set to a value
621 that does not result in clipping/distortion!)
622 slave Force Boss DAC into slave mode, using Pi a
623 master for bit clock and frame clock. Enable
624 with "dtoverlay=allo-boss-dac-pcm512x-audio,
628 Name: allo-boss2-dac-audio
629 Info: Configures the Allo Boss2 DAC audio card
630 Load: dtoverlay=allo-boss2-dac-audio
635 Info: Configures the Allo Digione audio card
636 Load: dtoverlay=allo-digione
640 Name: allo-katana-dac-audio
641 Info: Configures the Allo Katana DAC audio card
642 Load: dtoverlay=allo-katana-dac-audio
646 Name: allo-piano-dac-pcm512x-audio
647 Info: Configures the Allo Piano DAC (2.0/2.1) audio cards.
648 (NB. This initial support is for 2.0 channel audio ONLY! ie. stereo.
649 The subwoofer outputs on the Piano 2.1 are not currently supported!)
650 Load: dtoverlay=allo-piano-dac-pcm512x-audio,<param>
651 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
652 Digital volume control.
653 (The default behaviour is that the Digital
654 volume control is limited to a maximum of
655 0dB. ie. it can attenuate but not provide
656 gain. For most users, this will be desired
657 as it will prevent clipping. By appending
658 the 24db_digital_gain parameter, the Digital
659 volume control will allow up to 24dB of
660 gain. If this parameter is enabled, it is the
661 responsibility of the user to ensure that
662 the Digital volume control is set to a value
663 that does not result in clipping/distortion!)
666 Name: allo-piano-dac-plus-pcm512x-audio
667 Info: Configures the Allo Piano DAC (2.1) audio cards.
668 Load: dtoverlay=allo-piano-dac-plus-pcm512x-audio,<param>
669 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
670 Digital volume control.
671 (The default behaviour is that the Digital
672 volume control is limited to a maximum of
673 0dB. ie. it can attenuate but not provide
674 gain. For most users, this will be desired
675 as it will prevent clipping. By appending
676 the 24db_digital_gain parameter, the Digital
677 volume control will allow up to 24dB of
678 gain. If this parameter is enabled, it is the
679 responsibility of the user to ensure that
680 the Digital volume control is set to a value
681 that does not result in clipping/distortion!)
682 glb_mclk This option is only with Kali board. If enabled,
683 MCLK for Kali is used and PLL is disabled for
684 better voice quality. (default Off)
688 Info: Universal device tree overlay for SPI devices
690 Just specify the SPI address and device name ("compatible" property).
691 This overlay lacks any device-specific parameter support!
693 For devices on spi1 or spi2, the interfaces should be enabled
694 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
697 1. SPI NOR flash on spi0.1, maximum SPI clock frequency 45MHz:
698 dtoverlay=anyspi:spi0-1,dev="jedec,spi-nor",speed=45000000
699 2. MCP3204 ADC on spi1.2, maximum SPI clock frequency 500kHz:
700 dtoverlay=anyspi:spi1-2,dev="microchip,mcp3204"
701 Load: dtoverlay=anyspi,<param>=<val>
702 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
704 dev Set device name to search compatible module
706 speed Set SPI clock frequency in Hz
707 (integer, optional, default 500000)
711 Info: Configures the AVAGO APDS9960 digital proximity, ambient light, RGB and
713 Load: dtoverlay=apds9960,<param>=<val>
714 Params: gpiopin GPIO used for INT (default 4)
715 noints Disable the interrupt GPIO line.
719 Info: Configures the Orchard Audio ApplePi-DAC audio card
720 Load: dtoverlay=applepi-dac
725 Info: Arducam 64MP camera module.
726 Uses Unicam 1, which is the standard camera connector on most Pi
728 Load: dtoverlay=arducam-64mp,<param>=<val>
729 Params: rotation Mounting rotation of the camera sensor (0 or
731 orientation Sensor orientation (0 = front, 1 = rear,
732 2 = external, default external)
733 media-controller Configure use of Media Controller API for
734 configuring the sensor (default on)
735 cam0 Adopt the default configuration for CAM0 on a
736 Compute Module (CSI0, i2c_vc, and cam0_reg).
737 vcm Select lens driver state. Default is enabled,
738 but vcm=off will disable.
741 Name: arducam-pivariety
742 Info: Arducam Pivariety camera module.
743 Uses Unicam 1, which is the standard camera connector on most Pi
745 Load: dtoverlay=arducam-pivariety,<param>=<val>
746 Params: rotation Mounting rotation of the camera sensor (0 or
748 orientation Sensor orientation (0 = front, 1 = rear,
749 2 = external, default external)
750 media-controller Configure use of Media Controller API for
751 configuring the sensor (default on)
752 cam0 Adopt the default configuration for CAM0 on a
753 Compute Module (CSI0, i2c_vc, and cam0_reg).
757 Info: Configures the Atmel AT86RF233 802.15.4 low-power WPAN transceiver,
759 Load: dtoverlay=at86rf233,<param>=<val>
760 Params: interrupt GPIO used for INT (default 23)
761 reset GPIO used for Reset (default 24)
762 sleep GPIO used for Sleep (default 25)
763 speed SPI bus speed in Hz (default 3000000)
764 trim Fine tuning of the internal capacitance
765 arrays (0=+0pF, 15=+4.5pF, default 15)
768 Name: audioinjector-addons
769 Info: Configures the audioinjector.net audio add on soundcards
770 Load: dtoverlay=audioinjector-addons,<param>=<val>
771 Params: non-stop-clocks Keeps the clocks running even when the stream
772 is paused or stopped (default off)
775 Name: audioinjector-bare-i2s
776 Info: Configures the audioinjector.net audio bare i2s soundcard
777 Load: dtoverlay=audioinjector-bare-i2s
781 Name: audioinjector-isolated-soundcard
782 Info: Configures the audioinjector.net isolated soundcard
783 Load: dtoverlay=audioinjector-isolated-soundcard
787 Name: audioinjector-ultra
788 Info: Configures the audioinjector.net ultra soundcard
789 Load: dtoverlay=audioinjector-ultra
793 Name: audioinjector-wm8731-audio
794 Info: Configures the audioinjector.net audio add on soundcard
795 Load: dtoverlay=audioinjector-wm8731-audio
800 Info: Configures the audiosense-pi add on soundcard
801 For more information refer to
802 https://gitlab.com/kakar0t/audiosense-pi
803 Load: dtoverlay=audiosense-pi
808 Info: Switches PWM sound output to GPIOs on the 40-pin header
809 Load: dtoverlay=audremap,<param>=<val>
810 Params: swap_lr Reverse the channel allocation, which will also
811 swap the audio jack outputs (default off)
812 enable_jack Don't switch off the audio jack output. Does
813 nothing on BCM2711 (default off)
814 pins_12_13 Select GPIOs 12 & 13 (default)
815 pins_18_19 Select GPIOs 18 & 19
816 pins_40_41 Select GPIOs 40 & 41 (not available on CM4, used
818 pins_40_45 Select GPIOs 40 & 45 (don't use on BCM2711 - the
819 pins are on different controllers)
823 Info: Overlay that enables WLAN, Bluetooth and the GPIO expander on the
824 balenaFin carrier board for the Raspberry Pi Compute Module 3/3+ Lite.
825 Load: dtoverlay=balena-fin
830 Info: Overlay encapsulating the BCM2712 C0->D0 differences
831 Load: dtoverlay=bcm2712d0
835 Name: bmp085_i2c-sensor
836 Info: This overlay is now deprecated - see i2c-sensor
840 Name: camera-mux-2port
841 Info: Configures a 2 port camera multiplexer
842 Note that currently ALL IMX290 modules share a common clock, therefore
843 all modules will need to have the same clock frequency.
844 Load: dtoverlay=camera-mux-2port,<param>=<val>
845 Params: cam0-arducam-64mp Select Arducam64MP for camera on port 0
846 cam0-imx219 Select IMX219 for camera on port 0
847 cam0-imx258 Select IMX258 for camera on port 0
848 cam0-imx290 Select IMX290 for camera on port 0
849 cam0-imx477 Select IMX477 for camera on port 0
850 cam0-imx519 Select IMX519 for camera on port 0
851 cam0-imx708 Select IMX708 for camera on port 0
852 cam0-ov2311 Select OV2311 for camera on port 0
853 cam0-ov5647 Select OV5647 for camera on port 0
854 cam0-ov64a40 Select OV64A40 for camera on port 0
855 cam0-ov7251 Select OV7251 for camera on port 0
856 cam0-ov9281 Select OV9281 for camera on port 0
857 cam0-imx290-clk-freq Set clock frequency for an IMX290 on port 0
858 cam1-arducam-64mp Select Arducam64MP for camera on port 1
859 cam1-imx219 Select IMX219 for camera on port 1
860 cam1-imx258 Select IMX258 for camera on port 1
861 cam1-imx290 Select IMX290 for camera on port 1
862 cam1-imx477 Select IMX477 for camera on port 1
863 cam1-imx519 Select IMX519 for camera on port 1
864 cam1-imx708 Select IMX708 for camera on port 1
865 cam1-ov2311 Select OV2311 for camera on port 1
866 cam1-ov5647 Select OV5647 for camera on port 1
867 cam1-ov64a40 Select OV64A40 for camera on port 1
868 cam1-ov7251 Select OV7251 for camera on port 1
869 cam1-ov9281 Select OV9281 for camera on port 1
870 cam1-imx290-clk-freq Set clock frequency for an IMX290 on port 1
872 cam0 Connect the mux to CAM0 port (default is CAM1)
875 Name: camera-mux-4port
876 Info: Configures a 4 port camera multiplexer
877 Note that currently ALL IMX290 modules share a common clock, therefore
878 all modules will need to have the same clock frequency.
879 Load: dtoverlay=camera-mux-4port,<param>=<val>
880 Params: cam0-arducam-64mp Select Arducam64MP for camera on port 0
881 cam0-imx219 Select IMX219 for camera on port 0
882 cam0-imx258 Select IMX258 for camera on port 0
883 cam0-imx290 Select IMX290 for camera on port 0
884 cam0-imx477 Select IMX477 for camera on port 0
885 cam0-imx519 Select IMX519 for camera on port 0
886 cam0-imx708 Select IMX708 for camera on port 0
887 cam0-ov2311 Select OV2311 for camera on port 0
888 cam0-ov5647 Select OV5647 for camera on port 0
889 cam0-ov64a40 Select OV64A40 for camera on port 0
890 cam0-ov7251 Select OV7251 for camera on port 0
891 cam0-ov9281 Select OV9281 for camera on port 0
892 cam0-imx290-clk-freq Set clock frequency for an IMX290 on port 0
893 cam1-arducam-64mp Select Arducam64MP for camera on port 1
894 cam1-imx219 Select IMX219 for camera on port 1
895 cam1-imx258 Select IMX258 for camera on port 1
896 cam1-imx290 Select IMX290 for camera on port 1
897 cam1-imx477 Select IMX477 for camera on port 1
898 cam1-imx519 Select IMX519 for camera on port 1
899 cam1-imx708 Select IMX708 for camera on port 1
900 cam1-ov2311 Select OV2311 for camera on port 1
901 cam1-ov5647 Select OV5647 for camera on port 1
902 cam1-ov64a40 Select OV64A40 for camera on port 1
903 cam1-ov7251 Select OV7251 for camera on port 1
904 cam1-ov9281 Select OV9281 for camera on port 1
905 cam1-imx290-clk-freq Set clock frequency for an IMX290 on port 1
906 cam2-arducam-64mp Select Arducam64MP for camera on port 2
907 cam2-imx219 Select IMX219 for camera on port 2
908 cam2-imx258 Select IMX258 for camera on port 2
909 cam2-imx290 Select IMX290 for camera on port 2
910 cam2-imx477 Select IMX477 for camera on port 2
911 cam2-imx519 Select IMX519 for camera on port 2
912 cam2-imx708 Select IMX708 for camera on port 2
913 cam2-ov2311 Select OV2311 for camera on port 2
914 cam2-ov5647 Select OV5647 for camera on port 2
915 cam2-ov64a40 Select OV64A40 for camera on port 2
916 cam2-ov7251 Select OV7251 for camera on port 2
917 cam2-ov9281 Select OV9281 for camera on port 2
918 cam2-imx290-clk-freq Set clock frequency for an IMX290 on port 2
919 cam3-arducam-64mp Select Arducam64MP for camera on port 3
920 cam3-imx219 Select IMX219 for camera on port 3
921 cam3-imx258 Select IMX258 for camera on port 3
922 cam3-imx290 Select IMX290 for camera on port 3
923 cam3-imx477 Select IMX477 for camera on port 3
924 cam3-imx519 Select IMX519 for camera on port 3
925 cam3-imx708 Select IMX708 for camera on port 3
926 cam3-ov2311 Select OV2311 for camera on port 3
927 cam3-ov5647 Select OV5647 for camera on port 3
928 cam3-ov64a40 Select OV64A40 for camera on port 3
929 cam3-ov7251 Select OV7251 for camera on port 3
930 cam3-ov9281 Select OV9281 for camera on port 3
931 cam3-imx290-clk-freq Set clock frequency for an IMX290 on port 3
933 cam0 Connect the mux to CAM0 port (default is CAM1)
937 Info: Enables the ability to use the cap1106 touch sensor as a keyboard
938 Load: dtoverlay=cap1106,<param>=<val>
939 Params: int_pin GPIO pin for interrupt signal (default 23)
943 Info: Configures Chip Dip audio cards.
944 Load: dtoverlay=chipdip-dac
949 Info: Configures the Cirrus Logic Audio Card
950 Load: dtoverlay=cirrus-wm5102
955 Info: Largely for Compute Modules 1&3 where the original instructions for
956 adding a camera used GPIOs 0&1 for CAM1 and 28&29 for CAM0, whilst all
957 other platforms use 28&29 (or 44&45) for CAM1.
958 The default assignment through using this overlay is for
959 i2c0 to use 28&29, and i2c10 (aka i2c_csi_dsi) to use 28&29, but the
960 overrides allow this to be changed.
961 Load: dtoverlay=cm-swap-i2c0,<param>=<val>
962 Params: i2c0-gpio0 Use GPIOs 0&1 for i2c0
963 i2c0-gpio28 Use GPIOs 28&29 for i2c0 (default)
964 i2c0-gpio44 Use GPIOs 44&45 for i2c0
965 i2c10-gpio0 Use GPIOs 0&1 for i2c0 (default)
966 i2c10-gpio28 Use GPIOs 28&29 for i2c0
967 i2c10-gpio44 Use GPIOs 44&45 for i2c0
971 Info: Set custom CMA sizes, only use if you know what you are doing, might
972 clash with other overlays like vc4-fkms-v3d and vc4-kms-v3d.
973 Load: dtoverlay=cma,<param>=<val>
974 Params: cma-512 CMA is 512MB (needs 1GB)
975 cma-448 CMA is 448MB (needs 1GB)
976 cma-384 CMA is 384MB (needs 1GB)
977 cma-320 CMA is 320MB (needs 1GB)
978 cma-256 CMA is 256MB (needs 1GB)
979 cma-192 CMA is 192MB (needs 1GB)
983 cma-size CMA size in bytes, 4MB aligned
984 cma-default Use upstream's default value
987 Name: crystalfontz-cfa050_pi_m
988 Info: Configures the Crystalfontz CFA050-PI-M series of Raspberry Pi CM4
989 based modules using the CFA7201280A0_050Tx 7" TFT LCD displays,
990 with or without capacitive touch screen.
991 Requires use of vc4-kms-v3d.
992 Load: dtoverlay=crystalfontz-cfa050_pi_m,<param>=<val>
993 Params: captouch Enable capacitive touch display
997 Info: 8" TFT LCD display and touch panel used by cutiepi.io
998 Load: dtoverlay=cutiepi-panel
1003 Info: Configures the dacberry400 add on soundcard
1004 Load: dtoverlay=dacberry400
1009 Info: Overlay for the DHT11/DHT21/DHT22 humidity/temperature sensors
1010 Also sometimes found with the part number(s) AM230x.
1011 Load: dtoverlay=dht11,<param>=<val>
1012 Params: gpiopin GPIO connected to the sensor's DATA output.
1016 Name: dionaudio-kiwi
1017 Info: Configures the Dion Audio KIWI STREAMER
1018 Load: dtoverlay=dionaudio-kiwi
1022 Name: dionaudio-loco
1023 Info: Configures the Dion Audio LOCO DAC-AMP
1024 Load: dtoverlay=dionaudio-loco
1028 Name: dionaudio-loco-v2
1029 Info: Configures the Dion Audio LOCO-V2 DAC-AMP
1030 Load: dtoverlay=dionaudio-loco-v2,<param>=<val>
1031 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1032 Digital volume control. Enable with
1033 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
1034 (The default behaviour is that the Digital
1035 volume control is limited to a maximum of
1036 0dB. ie. it can attenuate but not provide
1037 gain. For most users, this will be desired
1038 as it will prevent clipping. By appending
1039 the 24dB_digital_gain parameter, the Digital
1040 volume control will allow up to 24dB of
1041 gain. If this parameter is enabled, it is the
1042 responsibility of the user to ensure that
1043 the Digital volume control is set to a value
1044 that does not result in clipping/distortion!)
1048 Info: Disable onboard Bluetooth on Bluetooth-capable Raspberry Pis. On Pis
1049 prior to Pi 5 this restores UART0/ttyAMA0 over GPIOs 14 & 15.
1050 Load: dtoverlay=disable-bt
1054 Name: disable-bt-pi5
1055 Info: See disable-bt
1059 Info: Disable EMMC2 controller on BCM2711.
1060 The allows the onboard EMMC storage on Compute Module 4 to be disabled
1061 e.g. if a fault has occurred.
1062 Load: dtoverlay=disable-emmc2
1067 Info: Disable onboard WLAN on WiFi-capable Raspberry Pis.
1068 Load: dtoverlay=disable-wifi
1072 Name: disable-wifi-pi5
1073 Info: See disable-wifi
1077 Info: Overlay for a generic 18-bit DPI display
1078 This uses GPIOs 0-21 (so no I2C, uart etc.), and activates the output
1079 2-3 seconds after the kernel has started.
1080 Load: dtoverlay=dpi18
1085 Info: Overlay for a generic 18-bit DPI display (in 'mode 6' connection scheme)
1086 This uses GPIOs 0-9,12-17,20-25 (so no I2C, uart etc.), and activates
1087 the output 3-3 seconds after the kernel has started.
1088 Load: dtoverlay=dpi18cpadhi
1093 Info: Overlay for a generic 24-bit DPI display
1094 This uses GPIOs 0-27 (so no I2C, uart etc.), and activates the output
1095 2-3 seconds after the kernel has started.
1096 Load: dtoverlay=dpi24
1101 Info: Configures the NW Digital Radio DRAWS Hat
1103 The board includes an ADC to measure various board values and also
1104 provides two analog user inputs on the expansion header. The ADC
1105 can be configured for various sample rates and gain values to adjust
1106 the input range. Tables describing the two parameters follow.
1118 ADC Datarate Values:
1123 4 = 1600sps (default)
1127 Load: dtoverlay=draws,<param>=<val>
1128 Params: draws_adc_ch4_gain Sets the full scale resolution of the ADCs
1129 input voltage sensor (default 1)
1131 draws_adc_ch4_datarate Sets the datarate of the ADCs input voltage
1134 draws_adc_ch5_gain Sets the full scale resolution of the ADCs
1135 5V rail voltage sensor (default 1)
1137 draws_adc_ch5_datarate Sets the datarate of the ADCs 4V rail voltage
1140 draws_adc_ch6_gain Sets the full scale resolution of the ADCs
1141 AIN2 input (default 2)
1143 draws_adc_ch6_datarate Sets the datarate of the ADCs AIN2 input
1145 draws_adc_ch7_gain Sets the full scale resolution of the ADCs
1146 AIN3 input (default 2)
1148 draws_adc_ch7_datarate Sets the datarate of the ADCs AIN3 input
1150 alsaname Name of the ALSA audio device (default "draws")
1154 Info: Selects the dwc_otg USB controller driver which has fiq support. This
1155 is the default on all except the Pi Zero which defaults to dwc2.
1156 Load: dtoverlay=dwc-otg
1161 Info: Selects the dwc2 USB controller driver
1162 Load: dtoverlay=dwc2,<param>=<val>
1163 Params: dr_mode Dual role mode: "host", "peripheral" or "otg"
1165 g-rx-fifo-size Size of rx fifo size in gadget mode
1167 g-np-tx-fifo-size Size of non-periodic tx fifo size in gadget
1171 [ The ds1307-rtc overlay has been deleted. See i2c-rtc. ]
1175 Info: Overlay for the EDT FT5406 touchscreen.
1176 This works with the Raspberry Pi 7" touchscreen when not being polled
1178 By default the overlay uses the i2c_csi_dsi I2C interface, but this
1180 You MUST use either "disable_touchscreen=1" or "ignore_lcd=1" in
1181 config.txt to stop the firmware polling the touchscreen.
1182 Load: dtoverlay=edt-ft5406,<param>=<val>
1183 Params: sizex Touchscreen size x (default 800)
1184 sizey Touchscreen size y (default 480)
1185 invx Touchscreen inverted x axis
1186 invy Touchscreen inverted y axis
1187 swapxy Touchscreen swapped x y axis
1188 i2c0 Choose the I2C0 bus on GPIOs 0&1
1189 i2c1 Choose the I2C1 bus on GPIOs 2&3
1190 i2c3 Choose the I2C3 bus (configure with the i2c3
1191 overlay - BCM2711 only)
1192 i2c4 Choose the I2C4 bus (configure with the i2c4
1193 overlay - BCM2711 only)
1194 i2c5 Choose the I2C5 bus (configure with the i2c5
1195 overlay - BCM2711 only)
1196 i2c6 Choose the I2C6 bus (configure with the i2c6
1197 overlay - BCM2711 only)
1198 addr Sets the address for the touch controller. Note
1199 that the device must be configured to use the
1204 Info: Overlay for the Microchip ENC28J60 Ethernet Controller on SPI0
1205 Load: dtoverlay=enc28j60,<param>=<val>
1206 Params: int_pin GPIO used for INT (default 25)
1208 speed SPI bus speed (default 12000000)
1212 Info: Overlay for the Microchip ENC28J60 Ethernet Controller on SPI2
1213 Load: dtoverlay=enc28j60-spi2,<param>=<val>
1214 Params: int_pin GPIO used for INT (default 39)
1216 speed SPI bus speed (default 12000000)
1220 Info: Enables I2C connected EETI EXC3000 multiple touch controller using
1221 GPIO 4 (pin 7 on GPIO header) for interrupt.
1222 Load: dtoverlay=exc3000,<param>=<val>
1223 Params: interrupt GPIO used for interrupt (default 4)
1224 sizex Touchscreen size x (default 4096)
1225 sizey Touchscreen size y (default 4096)
1226 invx Touchscreen inverted x axis
1227 invy Touchscreen inverted y axis
1228 swapxy Touchscreen swapped x y axis
1232 Info: Overlay for SPI-connected displays using the fbtft drivers.
1234 This overlay seeks to replace the functionality provided by fbtft_device
1235 which is now gone from the kernel.
1237 Most displays from fbtft_device have been ported over.
1239 dtoverlay=fbtft,spi0-0,rpi-display,reset_pin=23,dc_pin=24,led_pin=18,rotate=270
1241 It is also possible to specify the controller (this will use the default
1242 init sequence in the driver).
1244 dtoverlay=fbtft,spi0-0,ili9341,bgr,reset_pin=23,dc_pin=24,led_pin=18,rotate=270
1246 For devices on spi1 or spi2, the interfaces should be enabled
1247 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
1249 The following features of fbtft_device have not been ported over:
1250 - parallel bus is not supported
1251 - the init property which overrides the controller initialization
1252 sequence is not supported as a parameter due to memory limitations in
1253 the bootloader responsible for applying the overlay.
1255 See https://github.com/notro/fbtft/wiki/FBTFT-RPI-overlays for how to
1258 Load: dtoverlay=fbtft,<param>=<val>
1260 spi<n>-<m> Configure device at spi<n>, cs<m>
1262 speed SPI bus speed in Hz (default 32000000)
1263 cpha Shifted clock phase (CPHA) mode
1264 cpol Inverse clock polarity (CPOL) mode
1266 adafruit18 Adafruit 1.8
1267 adafruit22 Adafruit 2.2 (old)
1268 adafruit22a Adafruit 2.2
1269 adafruit28 Adafruit 2.8
1270 adafruit13m Adafruit 1.3 OLED
1271 admatec_c-berry28 C-Berry28
1273 er_tftm050_2 ER-TFTM070-2
1274 er_tftm070_5 ER-TFTM070-5
1276 ew24ha0_9bit EW24HA0 in 9-bit mode
1277 freetronicsoled128 Freetronics OLED128
1280 itdb28_spi ITDB02-2.8 with SPI interface circuit
1281 mi0283qt-2 Watterott MI0283QT-2
1282 mi0283qt-9a Watterott MI0283QT-9A
1283 nokia3310 Nokia 3310
1284 nokia3310a Nokia 3310a
1285 nokia5110 Nokia 5110
1287 pitft Adafruit PiTFT 2.8
1289 rpi-display Watterott rpi-display
1290 sainsmart18 Sainsmart 1.8
1291 sainsmart32_spi Sainsmart 3.2 with SPI interfce circuit
1292 tinylcd35 TinyLCD 3.5
1293 tm022hdh26 Tianma TM022HDH26
1294 tontec35_9481 Tontect 3.5 with ILI9481 controller
1295 tontec35_9486 Tontect 3.5 with ILI9486 controller
1296 waveshare32b Waveshare 3.2
1297 waveshare22 Waveshare 2.2
1299 bd663474 BD663474 display controller
1300 hx8340bn HX8340BN display controller
1301 hx8347d HX8347D display controller
1302 hx8353d HX8353D display controller
1303 hx8357d HX8357D display controller
1304 ili9163 ILI9163 display controller
1305 ili9320 ILI9320 display controller
1306 ili9325 ILI9325 display controller
1307 ili9340 ILI9340 display controller
1308 ili9341 ILI9341 display controller
1309 ili9481 ILI9481 display controller
1310 ili9486 ILI9486 display controller
1311 pcd8544 PCD8544 display controller
1312 ra8875 RA8875 display controller
1313 s6d02a1 S6D02A1 display controller
1314 s6d1121 S6D1121 display controller
1315 seps525 SEPS525 display controller
1316 sh1106 SH1106 display controller
1317 ssd1289 SSD1289 display controller
1318 ssd1305 SSD1305 display controller
1319 ssd1306 SSD1306 display controller
1320 ssd1325 SSD1325 display controller
1321 ssd1331 SSD1331 display controller
1322 ssd1351 SSD1351 display controller
1323 st7735r ST7735R display controller
1324 st7789v ST7789V display controller
1325 tls8204 TLS8204 display controller
1326 uc1611 UC1611 display controller
1327 uc1701 UC1701 display controller
1328 upd161704 UPD161704 display controller
1330 width Display width in pixels
1331 height Display height in pixels
1332 regwidth Display controller register width (default is
1334 buswidth Display bus interface width (default 8)
1335 debug Debug output level {0-7}
1336 rotate Display rotation {0, 90, 180, 270} (counter
1337 clockwise). Not supported by all drivers.
1338 bgr Enable BGR mode (default off). Use if Red and
1339 Blue are swapped. Not supported by all drivers.
1340 fps Frames per second (default 30). In effect this
1341 states how long the driver will wait after video
1342 memory has been changed until display update
1343 transfer is started.
1344 txbuflen Length of the FBTFT transmit buffer
1346 startbyte Sets the Start byte used by fb_ili9320,
1347 fb_ili9325 and fb_hx8347d. Common value is 0x70.
1348 gamma String representation of Gamma Curve(s). Driver
1349 specific. Not supported by all drivers.
1350 reset_pin GPIO pin for RESET
1351 dc_pin GPIO pin for D/C
1352 led_pin GPIO pin for LED backlight
1356 Info: Configures the Fe-Pi Audio Sound Card
1357 Load: dtoverlay=fe-pi-audio
1362 Info: A demonstration of the gpio-fsm driver. The GPIOs are chosen to work
1363 nicely with a "traffic-light" display of red, amber and green LEDs on
1364 GPIOs 7, 8 and 25 respectively.
1365 Load: dtoverlay=fsm-demo,<param>=<val>
1366 Params: fsm_debug Enable debug logging (default off)
1370 Info: Enables GalaxyCore's GC9A01 single chip driver based displays on
1371 SPI0 as fb1, using GPIOs DC=25, RST=27 and BL=18 (physical
1372 GPIO header pins 22, 13 and 12 respectively) in addition to the
1373 SPI0 pins DIN=10, CLK=11 and CS=8 (physical GPIO header pins 19,
1374 23 and 24 respectively).
1375 Load: dtoverlay=gc9a01,<param>=<val>
1376 Params: speed Display SPI bus speed
1378 rotate Display rotation {0,90,180,270}
1380 width Width of the display
1382 height Height of the display
1384 fps Delay between frame updates
1386 debug Debug output level {0-7}
1390 Info: An overlay for the Ghost amplifier.
1391 Load: dtoverlay=ghost-amp,<param>=<val>
1392 Params: fsm_debug Enable debug logging of the GPIO FSM (default
1397 Info: Enables I2C connected Goodix gt9271 multiple touch controller using
1398 GPIOs 4 and 17 (pins 7 and 11 on GPIO header) for interrupt and reset.
1399 Load: dtoverlay=goodix,<param>=<val>
1400 Params: interrupt GPIO used for interrupt (default 4)
1401 reset GPIO used for reset (default 17)
1404 Name: googlevoicehat-soundcard
1405 Info: Configures the Google voiceHAT soundcard
1406 Load: dtoverlay=googlevoicehat-soundcard
1411 Info: This is a generic overlay for detecting charger with GPIO.
1412 Load: dtoverlay=gpio-charger,<param>=<val>
1413 Params: gpio GPIO pin to trigger on (default 4)
1414 active_low When this is 1 (active low), a falling
1415 edge generates a charging event and a
1416 rising edge generates a discharging event.
1417 When this is 0 (active high), this is
1418 reversed. The default is 0 (active high)
1419 gpio_pull Desired pull-up/down state (off, down, up)
1421 type Set a charger type for the pin. (Default: mains)
1425 Info: Configure a GPIO pin to control a cooling fan.
1426 Load: dtoverlay=gpio-fan,<param>=<val>
1427 Params: gpiopin GPIO used to control the fan (default 12)
1428 temp Temperature at which the fan switches on, in
1429 millicelcius (default 55000)
1430 hyst Temperature delta (in millicelcius) below
1431 temp at which the fan will drop to minrpm
1436 Info: Activate a "hog" for a GPIO - request that the kernel configures it as
1437 an output, driven low or high as indicated by the presence or absence
1438 of the active_low parameter. Note that a hogged GPIO is not available
1439 to other drivers or for gpioset/gpioget.
1440 Load: dtoverlay=gpio-hog,<param>=<val>
1441 Params: gpio GPIO pin to hog (default 26)
1442 active_low If set, the hog drives the GPIO low (defaults
1443 to off - the GPIO is driven high)
1447 Info: Use GPIO pin as rc-core style infrared receiver input. The rc-core-
1448 based gpio_ir_recv driver maps received keys directly to a
1449 /dev/input/event* device, all decoding is done by the kernel - LIRC is
1450 not required! The key mapping and other decoding parameters can be
1451 configured by "ir-keytable" tool.
1452 Load: dtoverlay=gpio-ir,<param>=<val>
1453 Params: gpio_pin Input pin number. Default is 18.
1455 gpio_pull Desired pull-up/down state (off, down, up)
1458 invert "1" = invert the input (active-low signalling).
1459 "0" = non-inverted input (active-high
1460 signalling). Default is "1".
1462 rc-map-name Default rc keymap (can also be changed by
1463 ir-keytable), defaults to "rc-rc6-mce"
1467 Info: Use GPIO pin as bit-banged infrared transmitter output.
1468 This is an alternative to "pwm-ir-tx". gpio-ir-tx doesn't require
1469 a PWM so it can be used together with onboard analog audio.
1470 Load: dtoverlay=gpio-ir-tx,<param>=<val>
1471 Params: gpio_pin Output GPIO (default 18)
1473 invert "1" = invert the output (make it active-low).
1474 Default is "0" (active-high).
1478 Info: This is a generic overlay for activating GPIO keypresses using
1479 the gpio-keys library and this dtoverlay. Multiple keys can be
1480 set up using multiple calls to the overlay for configuring
1481 additional buttons or joysticks. You can see available keycodes
1482 at https://github.com/torvalds/linux/blob/v4.12/include/uapi/
1483 linux/input-event-codes.h#L64
1484 Load: dtoverlay=gpio-key,<param>=<val>
1485 Params: gpio GPIO pin to trigger on (default 3)
1486 active_low When this is 1 (active low), a falling
1487 edge generates a key down event and a
1488 rising edge generates a key up event.
1489 When this is 0 (active high), this is
1490 reversed. The default is 1 (active low)
1491 gpio_pull Desired pull-up/down state (off, down, up)
1492 Default is "up". Note that the default pin
1493 (GPIO3) has an external pullup
1494 label Set a label for the key
1495 keycode Set the key code for the button
1500 Info: This is a generic overlay for activating LEDs (or any other component)
1501 by a GPIO pin. Multiple LEDs can be set up using multiple calls to the
1502 overlay. While there are many existing methods to activate LEDs on the
1503 RPi, this method offers some advantages:
1504 1) Does not require any userspace programs.
1505 2) LEDs can be connected to the kernel's led-trigger framework,
1506 and drive the LED based on triggers such as cpu load, heartbeat,
1507 kernel panic, key input, timers and others.
1508 3) LED can be tied to the input state of another GPIO pin.
1509 4) The LED is setup early during the kernel boot process (useful
1510 for cpu/heartbeat/panic triggers).
1512 Typical electrical connection is:
1513 RPI-GPIO.19 -> LED -> 300ohm resister -> RPI-GND
1514 The GPIO pin number can be changed with the 'gpio=' parameter.
1516 To control an LED from userspace, write a 0 or 1 value:
1517 echo 1 > /sys/class/leds/myled1/brightness
1518 The 'myled1' name can be changed with the 'label=' parameter.
1520 To connect the LED to a kernel trigger from userspace:
1521 echo cpu > /sys/class/leds/myled1/trigger
1522 echo heartbeat > /sys/class/leds/myled1/trigger
1523 echo none > /sys/class/leds/myled1/trigger
1524 To connect the LED to GPIO.26 pin (physical pin 37):
1525 echo gpio > /sys/class/leds/myled1/trigger
1526 echo 26 > /sys/class/leds/myled1/gpio
1528 cat /sys/class/leds/myled1/trigger
1530 More information about the Linux kernel LED/Trigger system:
1531 https://www.kernel.org/doc/Documentation/leds/leds-class.rst
1532 https://www.kernel.org/doc/Documentation/leds/ledtrig-oneshot.rst
1533 Load: dtoverlay=gpio-led,<param>=<val>
1534 Params: gpio GPIO pin connected to the LED (default 19)
1535 label The label for this LED. It will appear under
1536 /sys/class/leds/<label> . Default 'myled1'.
1537 trigger Set the led-trigger to connect to this LED.
1538 default 'none' (LED is user-controlled).
1539 Some possible triggers:
1540 cpu - CPU load (all CPUs)
1541 cpu0 - CPU load of first CPU.
1542 mmc - disk activity (all disks)
1543 panic - turn on on kernel panic
1544 heartbeat - indicate system health
1545 gpio - connect to a GPIO input pin (note:
1546 currently the GPIO PIN can not be set
1547 using overlay parameters, must be
1548 done in userspace, see examples above.
1549 active_low Set to 1 to turn invert the LED control
1550 (writing 0 to /sys/class/leds/XXX/brightness
1551 will turn on the GPIO/LED). Default '0'.
1554 Name: gpio-no-bank0-irq
1555 Info: Use this overlay to disable GPIO interrupts for GPIOs in bank 0 (0-27),
1556 which can be useful for UIO drivers.
1557 N.B. Using this overlay will trigger a kernel WARN during booting, but
1558 this can safely be ignored - the system should work as expected.
1559 Load: dtoverlay=gpio-no-bank0-irq
1564 Info: Use this overlay to disable all GPIO interrupts, which can be useful
1565 for user-space GPIO edge detection systems.
1566 Load: dtoverlay=gpio-no-irq
1571 Info: Drives a GPIO high or low on poweroff (including halt). Using this
1572 overlay interferes with the normal power-down sequence, preventing the
1573 kernel from resetting the SoC (a necessary step in a normal power-off
1574 or reboot). This also disables the ability to trigger a boot by driving
1577 The GPIO starts in an inactive state. At poweroff time it is driven
1578 active for 100ms, then inactive for 100ms, then active again. It is
1579 safe to remove the power at any point after the initial activation of
1582 Users of this overlay are required to provide an external mechanism to
1583 switch off the power supply when signalled - failure to do so results
1584 in a kernel BUG, increased power consumption and undefined behaviour.
1585 Load: dtoverlay=gpio-poweroff,<param>=<val>
1586 Params: gpiopin GPIO for signalling (default 26)
1588 active_low Set if the power control device requires a
1589 high->low transition to trigger a power-down.
1590 Note that this will require the support of a
1591 custom dt-blob.bin to prevent a power-down
1592 during the boot process, and that a reboot
1593 will also cause the pin to go low.
1594 input Set if the gpio pin should be configured as
1596 export Set to export the configured pin to sysfs
1597 active_delay_ms Initial GPIO active period (default 100)
1598 inactive_delay_ms Subsequent GPIO inactive period (default 100)
1599 timeout_ms Specify (in ms) how long the kernel waits for
1600 power-down before issuing a WARN (default 3000).
1604 Info: Initiates a shutdown when GPIO pin changes. The given GPIO pin
1605 is configured as an input key that generates KEY_POWER events.
1607 This event is handled by systemd-logind by initiating a
1608 shutdown. Systemd versions older than 225 need an udev rule
1609 enable listening to the input device:
1611 ACTION!="REMOVE", SUBSYSTEM=="input", KERNEL=="event*", \
1612 SUBSYSTEMS=="platform", DRIVERS=="gpio-keys", \
1613 ATTRS{keys}=="116", TAG+="power-switch"
1615 Alternatively this event can be handled also on systems without
1616 systemd, just by traditional SysV init daemon. KEY_POWER event
1617 (keycode 116) needs to be mapped to KeyboardSignal on console
1618 and then kb::kbrequest inittab action which is triggered by
1619 KeyboardSignal from console can be configured to issue system
1620 shutdown. Steps for this configuration are:
1622 Add following lines to the /etc/console-setup/remap.inc file:
1624 # Key Power as special keypress
1625 keycode 116 = KeyboardSignal
1627 Then add following lines to /etc/inittab file:
1629 # Action on special keypress (Key Power)
1630 kb::kbrequest:/sbin/shutdown -t1 -a -h -P now
1632 And finally reload configuration by calling following commands:
1634 # dpkg-reconfigure console-setup
1635 # service console-setup reload
1638 This overlay only handles shutdown. After shutdown, the system
1639 can be powered up again by driving GPIO3 low. The default
1640 configuration uses GPIO3 with a pullup, so if you connect a
1641 button between GPIO3 and GND (pin 5 and 6 on the 40-pin header),
1642 you get a shutdown and power-up button. Please note that
1643 Raspberry Pi 1 Model B rev 1 uses GPIO1 instead of GPIO3.
1644 Load: dtoverlay=gpio-shutdown,<param>=<val>
1645 Params: gpio_pin GPIO pin to trigger on (default 3)
1646 For Raspberry Pi 1 Model B rev 1 set this
1647 explicitly to value 1, e.g.:
1649 dtoverlay=gpio-shutdown,gpio_pin=1
1651 active_low When this is 1 (active low), a falling
1652 edge generates a key down event and a
1653 rising edge generates a key up event.
1654 When this is 0 (active high), this is
1655 reversed. The default is 1 (active low).
1657 gpio_pull Desired pull-up/down state (off, down, up)
1660 Note that the default pin (GPIO3) has an
1661 external pullup. Same applies for GPIO1
1662 on Raspberry Pi 1 Model B rev 1.
1664 debounce Specify the debounce interval in milliseconds
1669 Info: Configures an HD44780 compatible LCD display. Uses 4 gpio pins for
1670 data, 2 gpio pins for enable and register select and 1 optional pin
1671 for enabling/disabling the backlight display.
1672 Load: dtoverlay=hd44780-lcd,<param>=<val>
1673 Params: pin_d4 GPIO pin for data pin D4 (default 6)
1675 pin_d5 GPIO pin for data pin D5 (default 13)
1677 pin_d6 GPIO pin for data pin D6 (default 19)
1679 pin_d7 GPIO pin for data pin D7 (default 26)
1681 pin_en GPIO pin for "Enable" (default 21)
1683 pin_rs GPIO pin for "Register Select" (default 20)
1685 pin_bl Optional pin for enabling/disabling the
1686 display backlight. (default disabled)
1688 display_height Height of the display in characters
1690 display_width Width of the display in characters
1693 Name: hdmi-backlight-hwhack-gpio
1694 Info: Devicetree overlay for GPIO based backlight on/off capability.
1695 Use this if you have one of those HDMI displays whose backlight cannot
1696 be controlled via DPMS over HDMI and plan to do a little soldering to
1697 use an RPi gpio pin for on/off switching. See:
1698 https://www.waveshare.com/wiki/7inch_HDMI_LCD_(C)#Backlight_Control
1699 Load: dtoverlay=hdmi-backlight-hwhack-gpio,<param>=<val>
1700 Params: gpio_pin GPIO pin used (default 17)
1701 active_low Set this to 1 if the display backlight is
1702 switched on when the wire goes low.
1703 Leave the default (value 0) if the backlight
1704 expects a high to switch it on.
1708 Info: Configures the HifiBerry Amp and Amp+ audio cards
1709 Load: dtoverlay=hifiberry-amp
1713 Name: hifiberry-amp100
1714 Info: Configures the HifiBerry AMP100 audio card
1715 Load: dtoverlay=hifiberry-amp100,<param>=<val>
1716 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1717 Digital volume control. Enable with
1718 "dtoverlay=hifiberry-amp100,24db_digital_gain"
1719 (The default behaviour is that the Digital
1720 volume control is limited to a maximum of
1721 0dB. ie. it can attenuate but not provide
1722 gain. For most users, this will be desired
1723 as it will prevent clipping. By appending
1724 the 24dB_digital_gain parameter, the Digital
1725 volume control will allow up to 24dB of
1726 gain. If this parameter is enabled, it is the
1727 responsibility of the user to ensure that
1728 the Digital volume control is set to a value
1729 that does not result in clipping/distortion!)
1730 slave Force AMP100 into slave mode, using Pi as
1731 master for bit clock and frame clock.
1732 leds_off If set to 'true' the onboard indicator LEDs
1733 are switched off at all times.
1734 auto_mute If set to 'true' the amplifier is automatically
1735 muted when the DAC is not playing.
1736 mute_ext_ctl The amplifier's HW mute control is enabled
1737 in ALSA mixer and set to <val>.
1738 Will be overwritten by ALSA user settings.
1741 Name: hifiberry-amp3
1742 Info: Configures the HifiBerry Amp3 audio card
1743 Load: dtoverlay=hifiberry-amp3
1748 Info: Configures the HifiBerry DAC audio cards
1749 Load: dtoverlay=hifiberry-dac
1753 Name: hifiberry-dacplus
1754 Info: Configures the HifiBerry DAC+ audio card
1755 Load: dtoverlay=hifiberry-dacplus,<param>=<val>
1756 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1757 Digital volume control. Enable with
1758 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
1759 (The default behaviour is that the Digital
1760 volume control is limited to a maximum of
1761 0dB. ie. it can attenuate but not provide
1762 gain. For most users, this will be desired
1763 as it will prevent clipping. By appending
1764 the 24dB_digital_gain parameter, the Digital
1765 volume control will allow up to 24dB of
1766 gain. If this parameter is enabled, it is the
1767 responsibility of the user to ensure that
1768 the Digital volume control is set to a value
1769 that does not result in clipping/distortion!)
1770 slave Force DAC+ into slave mode, using Pi as
1771 master for bit clock and frame clock.
1772 leds_off If set to 'true' the onboard indicator LEDs
1773 are switched off at all times.
1776 Name: hifiberry-dacplusadc
1777 Info: Configures the HifiBerry DAC+ADC audio card
1778 Load: dtoverlay=hifiberry-dacplusadc,<param>=<val>
1779 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1780 Digital volume control. Enable with
1781 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
1782 (The default behaviour is that the Digital
1783 volume control is limited to a maximum of
1784 0dB. ie. it can attenuate but not provide
1785 gain. For most users, this will be desired
1786 as it will prevent clipping. By appending
1787 the 24dB_digital_gain parameter, the Digital
1788 volume control will allow up to 24dB of
1789 gain. If this parameter is enabled, it is the
1790 responsibility of the user to ensure that
1791 the Digital volume control is set to a value
1792 that does not result in clipping/distortion!)
1793 slave Force DAC+ADC into slave mode, using Pi as
1794 master for bit clock and frame clock.
1795 leds_off If set to 'true' the onboard indicator LEDs
1796 are switched off at all times.
1799 Name: hifiberry-dacplusadcpro
1800 Info: Configures the HifiBerry DAC+ADC PRO audio card
1801 Load: dtoverlay=hifiberry-dacplusadcpro,<param>=<val>
1802 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1803 Digital volume control. Enable with
1804 "dtoverlay=hifiberry-dacplusadcpro,24db_digital_gain"
1805 (The default behaviour is that the Digital
1806 volume control is limited to a maximum of
1807 0dB. ie. it can attenuate but not provide
1808 gain. For most users, this will be desired
1809 as it will prevent clipping. By appending
1810 the 24dB_digital_gain parameter, the Digital
1811 volume control will allow up to 24dB of
1812 gain. If this parameter is enabled, it is the
1813 responsibility of the user to ensure that
1814 the Digital volume control is set to a value
1815 that does not result in clipping/distortion!)
1816 slave Force DAC+ADC Pro into slave mode, using Pi as
1817 master for bit clock and frame clock.
1818 leds_off If set to 'true' the onboard indicator LEDs
1819 are switched off at all times.
1822 Name: hifiberry-dacplusdsp
1823 Info: Configures the HifiBerry DAC+DSP audio card
1824 Load: dtoverlay=hifiberry-dacplusdsp
1828 Name: hifiberry-dacplushd
1829 Info: Configures the HifiBerry DAC+ HD audio card
1830 Load: dtoverlay=hifiberry-dacplushd
1834 Name: hifiberry-digi
1835 Info: Configures the HifiBerry Digi and Digi+ audio card
1836 Load: dtoverlay=hifiberry-digi
1840 Name: hifiberry-digi-pro
1841 Info: Configures the HifiBerry Digi+ Pro and Digi2 Pro audio card
1842 Load: dtoverlay=hifiberry-digi-pro
1847 Info: Enables "High Peripheral" mode
1848 Load: dtoverlay=highperi
1853 Info: HY28A - 2.8" TFT LCD Display Module by HAOYU Electronics
1854 Default values match Texy's display shield
1855 Load: dtoverlay=hy28a,<param>=<val>
1856 Params: speed Display SPI bus speed
1858 rotate Display rotation {0,90,180,270}
1860 fps Delay between frame updates
1862 debug Debug output level {0-7}
1864 xohms Touchpanel sensitivity (X-plate resistance)
1866 resetgpio GPIO used to reset controller
1868 ledgpio GPIO used to control backlight
1872 Info: HY28B - 2.8" TFT LCD Display Module by HAOYU Electronics
1873 Default values match Texy's display shield
1874 Load: dtoverlay=hy28b,<param>=<val>
1875 Params: speed Display SPI bus speed
1877 rotate Display rotation {0,90,180,270}
1879 fps Delay between frame updates
1881 debug Debug output level {0-7}
1883 xohms Touchpanel sensitivity (X-plate resistance)
1885 resetgpio GPIO used to reset controller
1887 ledgpio GPIO used to control backlight
1891 Info: HY28B 2017 version - 2.8" TFT LCD Display Module by HAOYU Electronics
1892 Default values match Texy's display shield
1893 Load: dtoverlay=hy28b-2017,<param>=<val>
1894 Params: speed Display SPI bus speed
1896 rotate Display rotation {0,90,180,270}
1898 fps Delay between frame updates
1900 debug Debug output level {0-7}
1902 xohms Touchpanel sensitivity (X-plate resistance)
1904 resetgpio GPIO used to reset controller
1906 ledgpio GPIO used to control backlight
1910 Info: Configures the Audiophonics I-SABRE Q2M DAC
1911 Load: dtoverlay=i-sabre-q2m
1916 Info: Fall back to the i2c_bcm2708 driver for the i2c_arm bus.
1917 Load: dtoverlay=i2c-bcm2708
1922 Info: Adds support for a number of I2C fan controllers
1923 Load: dtoverlay=i2c-fan,<param>=<val>
1924 Params: addr Sets the address for the fan controller. Note
1925 that the device must be configured to use the
1928 i2c0 Choose the I2C0 bus on GPIOs 0&1
1930 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
1932 i2c3 Choose the I2C3 bus (configure with the i2c3
1933 overlay - BCM2711 only)
1935 i2c4 Choose the I2C4 bus (configure with the i2c4
1936 overlay - BCM2711 only)
1938 i2c5 Choose the I2C5 bus (configure with the i2c5
1939 overlay - BCM2711 only)
1941 i2c6 Choose the I2C6 bus (configure with the i2c6
1942 overlay - BCM2711 only)
1944 minpwm PWM setting for the fan when the SoC is below
1945 mintemp (range 0-255. default 0)
1946 maxpwm PWM setting for the fan when the SoC is above
1947 maxtemp (range 0-255. default 255)
1948 midtemp Temperature (in millicelcius) at which the fan
1949 begins to speed up (default 50000)
1951 midtemp_hyst Temperature delta (in millicelcius) below
1952 mintemp at which the fan will drop to minrpm
1955 maxtemp Temperature (in millicelcius) at which the fan
1956 will be held at maxrpm (default 70000)
1958 maxtemp_hyst Temperature delta (in millicelcius) below
1959 maxtemp at which the fan begins to slow down
1962 emc2301 Select the Microchip EMC230x controller family
1963 - EMC2301, EMC2302, EMC2303, EMC2305.
1967 Info: Adds support for software i2c controller on gpio pins
1968 Load: dtoverlay=i2c-gpio,<param>=<val>
1969 Params: i2c_gpio_sda GPIO used for I2C data (default "23")
1971 i2c_gpio_scl GPIO used for I2C clock (default "24")
1973 i2c_gpio_delay_us Clock delay in microseconds
1974 (default "2" = ~100kHz)
1976 bus Set to a unique, non-zero value if wanting
1977 multiple i2c-gpio busses. If set, will be used
1978 as the preferred bus number (/dev/i2c-<n>). If
1979 not set, the default value is 0, but the bus
1980 number will be dynamically assigned - probably
1985 Info: Adds support for a number of I2C bus multiplexers on i2c_arm
1986 Load: dtoverlay=i2c-mux,<param>=<val>
1987 Params: pca9542 Select the NXP PCA9542 device
1989 pca9545 Select the NXP PCA9545 device
1991 pca9548 Select the NXP PCA9548 device
1993 addr Change I2C address of the device (default 0x70)
1995 i2c0 Choose the I2C0 bus on GPIOs 0&1
1997 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
1999 i2c3 Choose the I2C3 bus (configure with the i2c3
2000 overlay - BCM2711 only)
2002 i2c4 Choose the I2C3 bus (configure with the i2c3
2003 overlay - BCM2711 only)
2005 i2c5 Choose the I2C5 bus (configure with the i2c4
2006 overlay - BCM2711 only)
2008 i2c6 Choose the I2C6 bus (configure with the i2c6
2009 overlay - BCM2711 only)
2012 [ The i2c-mux-pca9548a overlay has been deleted. See i2c-mux. ]
2015 Name: i2c-pwm-pca9685a
2016 Info: Adds support for an NXP PCA9685A I2C PWM controller on i2c_arm
2017 Load: dtoverlay=i2c-pwm-pca9685a,<param>=<val>
2018 Params: addr I2C address of PCA9685A (default 0x40)
2019 i2c0 Choose the I2C0 bus on GPIOs 0&1
2020 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2021 i2c3 Choose the I2C3 bus (configure with the i2c3
2022 overlay - BCM2711 only)
2023 i2c4 Choose the I2C3 bus (configure with the i2c3
2024 overlay - BCM2711 only)
2025 i2c5 Choose the I2C5 bus (configure with the i2c4
2026 overlay - BCM2711 only)
2027 i2c6 Choose the I2C6 bus (configure with the i2c6
2028 overlay - BCM2711 only)
2032 Info: Adds support for a number of I2C Real Time Clock devices
2033 Load: dtoverlay=i2c-rtc,<param>=<val>
2034 Params: abx80x Select one of the ABx80x family:
2035 AB0801, AB0803, AB0804, AB0805,
2036 AB1801, AB1803, AB1804, AB1805
2038 bq32000 Select the TI BQ32000 device
2040 ds1307 Select the DS1307 device
2042 ds1339 Select the DS1339 device
2044 ds1340 Select the DS1340 device
2046 ds3231 Select the DS3231 device
2048 m41t62 Select the M41T62 device
2050 mcp7940x Select the MCP7940x device
2052 mcp7941x Select the MCP7941x device
2054 pcf2127 Select the PCF2127 device
2056 pcf2129 Select the PCF2129 device
2058 pcf85063 Select the PCF85063 device
2060 pcf85063a Select the PCF85063A device
2062 pcf8523 Select the PCF8523 device
2064 pcf85363 Select the PCF85363 device
2066 pcf8563 Select the PCF8563 device
2068 rv1805 Select the Micro Crystal RV1805 device
2070 rv3028 Select the Micro Crystal RV3028 device
2072 rv3032 Select the Micro Crystal RV3032 device
2074 rv8803 Select the Micro Crystal RV8803 device
2076 sd3078 Select the ZXW Shenzhen whwave SD3078 device
2078 s35390a Select the ABLIC S35390A device
2080 i2c0 Choose the I2C0 bus on GPIOs 0&1
2082 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2084 i2c3 Choose the I2C3 bus (configure with the i2c3
2085 overlay - BCM2711 only)
2087 i2c4 Choose the I2C3 bus (configure with the i2c3
2088 overlay - BCM2711 only)
2090 i2c5 Choose the I2C5 bus (configure with the i2c4
2091 overlay - BCM2711 only)
2093 i2c6 Choose the I2C6 bus (configure with the i2c6
2094 overlay - BCM2711 only)
2096 addr Sets the address for the RTC. Note that the
2097 device must be configured to use the specified
2100 trickle-diode-disable Do not use the internal trickle charger diode
2103 trickle-diode-type Diode type for trickle charge - "standard" or
2104 "schottky" (ABx80x and RV1805 only)
2106 trickle-resistor-ohms Resistor value for trickle charge (DS1339,
2107 ABx80x, BQ32000, RV1805, RV3028, RV3032)
2109 trickle-voltage-mv Charge pump voltage for trickle charge (RV3032)
2111 wakeup-source Specify that the RTC can be used as a wakeup
2114 backup-switchover-mode Backup power supply switch mode. Must be 0 for
2115 "Switchover disabled", 1 for "Direct Switching"
2116 (if Vdd < VBackup), 2 for "Standby
2117 Mode" (if Vdd < Vbackup,
2118 does not draw current) or 3 for
2119 "Level Switching" (if Vdd < Vbackup
2120 and Vdd < Vddsw and Vbackup > Vddsw)
2125 Info: Adds support for a number of I2C Real Time Clock devices
2126 using the software i2c controller
2127 Load: dtoverlay=i2c-rtc-gpio,<param>=<val>
2128 Params: abx80x Select one of the ABx80x family:
2129 AB0801, AB0803, AB0804, AB0805,
2130 AB1801, AB1803, AB1804, AB1805
2132 bq32000 Select the TI BQ32000 device
2134 ds1307 Select the DS1307 device
2136 ds1339 Select the DS1339 device
2138 ds1340 Select the DS1340 device
2140 ds3231 Select the DS3231 device
2142 m41t62 Select the M41T62 device
2144 mcp7940x Select the MCP7940x device
2146 mcp7941x Select the MCP7941x device
2148 pcf2127 Select the PCF2127 device
2150 pcf2129 Select the PCF2129 device
2152 pcf85063 Select the PCF85063 device
2154 pcf85063a Select the PCF85063A device
2156 pcf8523 Select the PCF8523 device
2158 pcf85363 Select the PCF85363 device
2160 pcf8563 Select the PCF8563 device
2162 rv1805 Select the Micro Crystal RV1805 device
2164 rv3028 Select the Micro Crystal RV3028 device
2166 rv3032 Select the Micro Crystal RV3032 device
2168 rv8803 Select the Micro Crystal RV8803 device
2170 sd3078 Select the ZXW Shenzhen whwave SD3078 device
2172 s35390a Select the ABLIC S35390A device
2174 addr Sets the address for the RTC. Note that the
2175 device must be configured to use the specified
2178 trickle-diode-disable Do not use the internal trickle charger diode
2181 trickle-diode-type Diode type for trickle charge - "standard" or
2182 "schottky" (ABx80x and RV1805 only)
2184 trickle-resistor-ohms Resistor value for trickle charge (DS1339,
2185 ABx80x, BQ32000, RV1805, RV3028, RV3032)
2187 trickle-voltage-mv Charge pump voltage for trickle charge (RV3032)
2189 wakeup-source Specify that the RTC can be used as a wakeup
2192 backup-switchover-mode Backup power supply switch mode. Must be 0 for
2193 "Switchover disabled", 1 for "Direct Switching"
2194 (if Vdd < VBackup), 2 for "Standby
2195 Mode" (if Vdd < Vbackup,
2196 does not draw current) or 3 for
2197 "Level Switching" (if Vdd < Vbackup
2198 and Vdd < Vddsw and Vbackup > Vddsw)
2201 i2c_gpio_sda GPIO used for I2C data (default "23")
2203 i2c_gpio_scl GPIO used for I2C clock (default "24")
2205 i2c_gpio_delay_us Clock delay in microseconds
2206 (default "2" = ~100kHz)
2210 Info: Adds support for a number of I2C barometric pressure, temperature,
2211 light level and chemical sensors on i2c_arm
2212 Load: dtoverlay=i2c-sensor,<param>=<val>
2213 Params: addr Set the address for the ADT7410, BH1750, BME280,
2214 BME680, BMP280, BMP380, CCS811, DS1621, HDC100X,
2215 JC42, LM75, MCP980x, MPU6050, MPU9250, MS5637,
2216 MS5803, MS5805, MS5837, MS8607, SHT3x or TMP102
2218 adt7410 Select the Analog Devices ADT7410 and ADT7420
2220 Valid address 0x48-0x4b, default 0x48
2222 aht10 Select the Aosong AHT10 temperature and humidity
2225 bh1750 Select the Rohm BH1750 ambient light sensor
2226 Valid addresses 0x23 or 0x5c, default 0x23
2228 bme280 Select the Bosch Sensortronic BME280
2229 Valid addresses 0x76-0x77, default 0x76
2231 bme680 Select the Bosch Sensortronic BME680
2232 Valid addresses 0x76-0x77, default 0x76
2234 bmp085 Select the Bosch Sensortronic BMP085
2236 bmp180 Select the Bosch Sensortronic BMP180
2238 bmp280 Select the Bosch Sensortronic BMP280
2239 Valid addresses 0x76-0x77, default 0x76
2241 bmp380 Select the Bosch Sensortronic BMP380
2242 Valid addresses 0x76-0x77, default 0x76
2244 bno055 Select the Bosch Sensortronic BNO055 IMU
2245 Valid address 0x28-0x29, default 0x29
2247 ccs811 Select the AMS CCS811 digital gas sensor
2248 Valid addresses 0x5a-0x5b, default 0x5b
2250 ds1621 Select the Dallas Semiconductors DS1621 temp
2251 sensor. Valid addresses 0x48-0x4f, default 0x48
2253 hdc100x Select the Texas Instruments HDC100x temp sensor
2254 Valid addresses 0x40-0x43, default 0x40
2256 htu21 Select the HTU21 temperature and humidity sensor
2258 int_pin Set the GPIO to use for interrupts (max30102,
2259 mpu6050 and mpu9250 only)
2261 jc42 Select any of the many JEDEC JC42.4-compliant
2262 temperature sensors, including:
2263 ADT7408, AT30TS00, CAT34TS02, CAT6095,
2264 MAX6604, MCP9804, MCP9805, MCP9808,
2265 MCP98242, MCP98243, MCP98244, MCP9843,
2266 SE97, SE98, STTS424(E), STTS2002, STTS3000,
2267 TSE2002, TSE2004, TS3000, and TS3001.
2268 The default address is 0x18.
2270 lm75 Select the Maxim LM75 temperature sensor
2271 Valid addresses 0x48-0x4f, default 0x4f
2273 lm75addr Deprecated - use addr parameter instead
2275 max17040 Select the Maxim Integrated MAX17040 battery
2278 max30102 Select the Maxim Integrated MAX30102 heart-rate
2279 and blood-oxygen sensor
2281 mcp980x Select the Maxim MCP980x range of temperature
2282 sensors (i.e. MCP9800, MCP9801, MCP9802 and
2283 MCP9803). N.B. For MCP9804, MCP9805 and MCP9808,
2284 use the "jc42" option.
2285 Valid addresses are 0x18-0x1f (default 0x18)
2287 mpu6050 Select the InvenSense MPU6050 IMU. Valid
2288 valid addresses are 0x68 and 0x69 (default 0x68)
2290 mpu9250 Select the InvenSense MPU9250 IMU. Valid
2291 valid addresses are 0x68 and 0x69 (default 0x68)
2293 ms5637 Select the Measurement Specialities MS5637
2294 pressure and temperature sensor.
2296 ms5803 Select the Measurement Specialities MS5803
2297 pressure and temperature sensor.
2299 ms5805 Select the Measurement Specialities MS5805
2300 pressure and temperature sensor.
2302 ms5837 Select the Measurement Specialities MS5837
2303 pressure and temperature sensor.
2305 ms8607 Select the Measurement Specialities MS8607
2306 pressure and temperature sensor.
2308 no_timeout Disable the SMBUS timeout. N.B. Only supported
2309 by some jc42 devices - using with an
2310 incompatible device can stop it from being
2313 reset_pin GPIO to be used to reset the device (bno055
2314 only, disabled by default)
2316 sht3x Select the Sensirion SHT3x temperature and
2317 humidity sensors. Valid addresses 0x44-0x45,
2320 sht4x Select the Sensirion SHT4x temperature and
2321 humidity sensors. Valid addresses 0x44-0x45,
2324 si7020 Select the Silicon Labs Si7013/20/21 humidity/
2327 sps30 Select the Sensirion SPS30 particulate matter
2328 sensor. Fixed address 0x69.
2330 sgp30 Select the Sensirion SGP30 VOC sensor.
2333 tmp102 Select the Texas Instruments TMP102 temp sensor
2334 Valid addresses 0x48-0x4b, default 0x48
2336 tsl4531 Select the AMS TSL4531 digital ambient light
2339 veml6070 Select the Vishay VEML6070 ultraviolet light
2342 i2c0 Choose the I2C0 bus on GPIOs 0&1
2344 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2346 i2c3 Choose the I2C3 bus (configure with the i2c3
2347 overlay - BCM2711 only)
2349 i2c4 Choose the I2C3 bus (configure with the i2c3
2350 overlay - BCM2711 only)
2352 i2c5 Choose the I2C5 bus (configure with the i2c4
2353 overlay - BCM2711 only)
2355 i2c6 Choose the I2C6 bus (configure with the i2c6
2356 overlay - BCM2711 only)
2360 Info: Change i2c0 pin usage. Not all pin combinations are usable on all
2361 platforms - platforms other then Compute Modules can only use this
2362 to disable transaction combining.
2363 Do NOT use in conjunction with dtparam=i2c_vc=on. From the 5.4 kernel
2364 onwards the base DT includes the use of i2c_mux_pinctrl to expose two
2365 muxings of BSC0 - GPIOs 0&1, and whichever combination is used for the
2366 camera and display connectors. This overlay disables that mux and
2367 configures /dev/i2c0 to point at whichever set of pins is requested.
2368 dtparam=i2c_vc=on will try and enable the mux, so combining the two
2369 will cause conflicts.
2370 Load: dtoverlay=i2c0,<param>=<val>
2371 Params: pins_0_1 Use pins 0 and 1 (default)
2372 pins_28_29 Use pins 28 and 29
2373 pins_44_45 Use pins 44 and 45
2374 pins_46_47 Use pins 46 and 47
2375 combine Allow transactions to be combined (default
2380 Info: Deprecated, legacy version of i2c0.
2385 Info: Enable i2c0 (Pi 5 only)
2386 Load: dtoverlay=i2c0-pi5,<param>=<val>
2387 Params: pins_0_1 Use GPIOs 0 and 1 (default)
2388 pins_8_9 Use GPIOs 8 and 9
2389 baudrate Set the baudrate for the interface (default
2394 Info: Change i2c1 pin usage. Not all pin combinations are usable on all
2395 platforms - platforms other then Compute Modules can only use this
2396 to disable transaction combining.
2397 Load: dtoverlay=i2c1,<param>=<val>
2398 Params: pins_2_3 Use pins 2 and 3 (default)
2399 pins_44_45 Use pins 44 and 45
2400 combine Allow transactions to be combined (default
2405 Info: Deprecated, legacy version of i2c1.
2410 Info: Enable i2c1 (Pi 5 only)
2411 Load: dtoverlay=i2c1-pi5,<param>=<val>
2412 Params: pins_2_3 Use GPIOs 2 and 3 (default)
2413 pins_10_11 Use GPIOs 10 and 11
2414 baudrate Set the baudrate for the interface (default
2419 Info: Enable i2c2 (Pi 5 only)
2420 Load: dtoverlay=i2c2-pi5,<param>=<val>
2421 Params: pins_4_5 Use GPIOs 4 and 5 (default)
2422 pins_12_13 Use GPIOs 12 and 13
2423 baudrate Set the baudrate for the interface (default
2428 Info: Enable the i2c3 bus. BCM2711 only.
2429 Load: dtoverlay=i2c3,<param>
2430 Params: pins_2_3 Use GPIOs 2 and 3
2431 pins_4_5 Use GPIOs 4 and 5 (default)
2432 baudrate Set the baudrate for the interface (default
2437 Info: Enable i2c3 (Pi 5 only)
2438 Load: dtoverlay=i2c3-pi5,<param>=<val>
2439 Params: pins_6_7 Use GPIOs 6 and 7 (default)
2440 pins_14_15 Use GPIOs 14 and 15
2441 pins_22_23 Use GPIOs 22 and 23
2442 baudrate Set the baudrate for the interface (default
2447 Info: Enable the i2c4 bus. BCM2711 only.
2448 Load: dtoverlay=i2c4,<param>
2449 Params: pins_6_7 Use GPIOs 6 and 7
2450 pins_8_9 Use GPIOs 8 and 9 (default)
2451 baudrate Set the baudrate for the interface (default
2456 Info: Enable the i2c5 bus. BCM2711 only.
2457 Load: dtoverlay=i2c5,<param>
2458 Params: pins_10_11 Use GPIOs 10 and 11
2459 pins_12_13 Use GPIOs 12 and 13 (default)
2460 baudrate Set the baudrate for the interface (default
2465 Info: Enable the i2c6 bus. BCM2711 only.
2466 Load: dtoverlay=i2c6,<param>
2467 Params: pins_0_1 Use GPIOs 0 and 1
2468 pins_22_23 Use GPIOs 22 and 23 (default)
2469 baudrate Set the baudrate for the interface (default
2474 Info: Configures any passive I2S DAC soundcard.
2475 Load: dtoverlay=i2s-dac
2480 Info: move I2S function block to GPIO 28 to 31
2481 Load: dtoverlay=i2s-gpio28-31
2486 Info: Enables I2C connected Ilitek 251x multiple touch controller using
2487 GPIO 4 (pin 7 on GPIO header) for interrupt.
2488 Load: dtoverlay=ilitek251x,<param>=<val>
2489 Params: interrupt GPIO used for interrupt (default 4)
2490 sizex Touchscreen size x, horizontal resolution of
2491 touchscreen (in pixels)
2492 sizey Touchscreen size y, vertical resolution of
2493 touchscreen (in pixels)
2497 Info: Sony IMX219 camera module.
2498 Uses Unicam 1, which is the standard camera connector on most Pi
2500 Load: dtoverlay=imx219,<param>=<val>
2501 Params: rotation Mounting rotation of the camera sensor (0 or
2503 orientation Sensor orientation (0 = front, 1 = rear,
2504 2 = external, default external)
2505 media-controller Configure use of Media Controller API for
2506 configuring the sensor (default on)
2507 cam0 Adopt the default configuration for CAM0 on a
2508 Compute Module (CSI0, i2c_vc, and cam0_reg).
2509 vcm Configure a VCM focus drive on the sensor.
2513 Info: Sony IMX258 camera module.
2514 Uses Unicam 1, which is the standard camera connector on most Pi
2516 Load: dtoverlay=imx258,<param>=<val>
2517 Params: rotation Mounting rotation of the camera sensor (0 or
2519 orientation Sensor orientation (0 = front, 1 = rear,
2520 2 = external, default external)
2521 media-controller Configure use of Media Controller API for
2522 configuring the sensor (default on)
2523 cam0 Adopt the default configuration for CAM0 on a
2524 Compute Module (CSI0, i2c_vc, and cam0_reg).
2525 vcm Configure a VCM focus drive on the sensor.
2526 4lane Enable 4 CSI2 lanes. This requires a Compute
2527 Module (1, 3, or 4).
2531 Info: Sony IMX290 camera module.
2532 Uses Unicam 1, which is the standard camera connector on most Pi
2534 Load: dtoverlay=imx290,<param>
2535 Params: 4lane Enable 4 CSI2 lanes. This requires a Compute
2536 Module (1, 3, or 4).
2537 clock-frequency Sets the clock frequency to match that used on
2539 Modules from Vision Components use 37.125MHz
2540 (the default), whilst those from Innomaker use
2542 mono Denote that the module is a mono sensor.
2543 orientation Sensor orientation (0 = front, 1 = rear,
2544 2 = external, default external)
2545 rotation Mounting rotation of the camera sensor (0 or
2547 media-controller Configure use of Media Controller API for
2548 configuring the sensor (default on)
2549 cam0 Adopt the default configuration for CAM0 on a
2550 Compute Module (CSI0, i2c_vc, and cam0_reg).
2554 Info: Sony IMX296 camera module.
2555 Uses Unicam 1, which is the standard camera connector on most Pi
2557 Load: dtoverlay=imx296,<param>=<val>
2558 Params: rotation Mounting rotation of the camera sensor (0 or
2560 orientation Sensor orientation (0 = front, 1 = rear,
2561 2 = external, default external)
2562 media-controller Configure use of Media Controller API for
2563 configuring the sensor (default on)
2564 cam0 Adopt the default configuration for CAM0 on a
2565 Compute Module (CSI0, i2c_vc, and cam0_reg).
2566 clock-frequency Sets the clock frequency to match that used on
2567 the board, which should be one of 54000000
2568 (the default), 37125000 or 74250000.
2569 always-on Leave the regulator powered up, to stop the
2570 camera clamping I/Os such as XTRIG to 0V.
2574 Info: Sony IMX327 camera module.
2575 Uses Unicam 1, which is the standard camera connector on most Pi
2577 Load: dtoverlay=imx327,<param>
2578 Params: 4lane Enable 4 CSI2 lanes. This requires a Compute
2579 Module (1, 3, or 4).
2580 clock-frequency Sets the clock frequency to match that used on
2582 Modules from Vision Components use 37.125MHz
2583 (the default), whilst those from Innomaker use
2585 mono Denote that the module is a mono sensor.
2586 orientation Sensor orientation (0 = front, 1 = rear,
2587 2 = external, default external)
2588 rotation Mounting rotation of the camera sensor (0 or
2590 media-controller Configure use of Media Controller API for
2591 configuring the sensor (default on)
2592 cam0 Adopt the default configuration for CAM0 on a
2593 Compute Module (CSI0, i2c_vc, and cam0_reg).
2597 Info: Sony IMX378 camera module.
2598 Uses Unicam 1, which is the standard camera connector on most Pi
2600 Load: dtoverlay=imx378,<param>=<val>
2601 Params: rotation Mounting rotation of the camera sensor (0 or
2603 orientation Sensor orientation (0 = front, 1 = rear,
2604 2 = external, default external)
2605 media-controller Configure use of Media Controller API for
2606 configuring the sensor (default on)
2607 cam0 Adopt the default configuration for CAM0 on a
2608 Compute Module (CSI0, i2c_vc, and cam0_reg).
2609 always-on Leave the regulator powered up, to stop the
2610 camera clamping I/Os such as XVS to 0V.
2614 Info: Sony IMX462 camera module.
2615 Uses Unicam 1, which is the standard camera connector on most Pi
2617 Load: dtoverlay=imx462,<param>
2618 Params: 4lane Enable 4 CSI2 lanes. This requires a Compute
2619 Module (1, 3, or 4).
2620 clock-frequency Sets the clock frequency to match that used on
2622 Modules from Vision Components use 37.125MHz
2623 (the default), whilst those from Innomaker use
2625 mono Denote that the module is a mono sensor.
2626 orientation Sensor orientation (0 = front, 1 = rear,
2627 2 = external, default external)
2628 rotation Mounting rotation of the camera sensor (0 or
2630 media-controller Configure use of Media Controller API for
2631 configuring the sensor (default on)
2632 cam0 Adopt the default configuration for CAM0 on a
2633 Compute Module (CSI0, i2c_vc, and cam0_reg).
2637 Info: Sony IMX477 camera module.
2638 Uses Unicam 1, which is the standard camera connector on most Pi
2640 Load: dtoverlay=imx477,<param>=<val>
2641 Params: rotation Mounting rotation of the camera sensor (0 or
2643 orientation Sensor orientation (0 = front, 1 = rear,
2644 2 = external, default external)
2645 media-controller Configure use of Media Controller API for
2646 configuring the sensor (default on)
2647 cam0 Adopt the default configuration for CAM0 on a
2648 Compute Module (CSI0, i2c_vc, and cam0_reg).
2649 always-on Leave the regulator powered up, to stop the
2650 camera clamping I/Os such as XVS to 0V.
2654 Info: Sony IMX519 camera module.
2655 Uses Unicam 1, which is the standard camera connector on most Pi
2657 Load: dtoverlay=imx519,<param>=<val>
2658 Params: rotation Mounting rotation of the camera sensor (0 or
2660 orientation Sensor orientation (0 = front, 1 = rear,
2661 2 = external, default external)
2662 media-controller Configure use of Media Controller API for
2663 configuring the sensor (default on)
2664 cam0 Adopt the default configuration for CAM0 on a
2665 Compute Module (CSI0, i2c_vc, and cam0_reg).
2666 vcm Select lens driver state. Default is enabled,
2667 but vcm=off will disable.
2671 Info: Sony IMX708 camera module.
2672 Uses Unicam 1, which is the standard camera connector on most Pi
2674 Load: dtoverlay=imx708,<param>=<val>
2675 Params: rotation Mounting rotation of the camera sensor (0 or
2677 orientation Sensor orientation (0 = front, 1 = rear,
2678 2 = external, default external)
2679 vcm Select lens driver state. Default is enabled,
2680 but vcm=off will disable.
2681 media-controller Configure use of Media Controller API for
2682 configuring the sensor (default on)
2683 cam0 Adopt the default configuration for CAM0 on a
2684 Compute Module (CSI0, i2c_vc, and cam0_reg).
2685 link-frequency Allowable link frequency values to use in Hz:
2686 450000000 (default), 447000000, 453000000.
2690 Info: Configures the IQaudio Codec audio card
2691 Load: dtoverlay=iqaudio-codec
2696 Info: Configures the IQaudio DAC audio card
2697 Load: dtoverlay=iqaudio-dac,<param>
2698 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2699 Digital volume control. Enable with
2700 "dtoverlay=iqaudio-dac,24db_digital_gain"
2701 (The default behaviour is that the Digital
2702 volume control is limited to a maximum of
2703 0dB. ie. it can attenuate but not provide
2704 gain. For most users, this will be desired
2705 as it will prevent clipping. By appending
2706 the 24db_digital_gain parameter, the Digital
2707 volume control will allow up to 24dB of
2708 gain. If this parameter is enabled, it is the
2709 responsibility of the user to ensure that
2710 the Digital volume control is set to a value
2711 that does not result in clipping/distortion!)
2714 Name: iqaudio-dacplus
2715 Info: Configures the IQaudio DAC+ audio card
2716 Load: dtoverlay=iqaudio-dacplus,<param>=<val>
2717 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2718 Digital volume control. Enable with
2719 "dtoverlay=iqaudio-dacplus,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!)
2731 auto_mute_amp If specified, unmute/mute the IQaudIO amp when
2732 starting/stopping audio playback.
2733 unmute_amp If specified, unmute the IQaudIO amp once when
2734 the DAC driver module loads.
2737 Name: iqaudio-digi-wm8804-audio
2738 Info: Configures the IQAudIO Digi WM8804 audio card
2739 Load: dtoverlay=iqaudio-digi-wm8804-audio,<param>=<val>
2740 Params: card_name Override the default, "IQAudIODigi", card name.
2741 dai_name Override the default, "IQAudIO Digi", dai name.
2742 dai_stream_name Override the default, "IQAudIO Digi HiFi",
2747 Info: Enables I2C connected Azoteq IQS550 trackpad/touchscreen controller
2748 using GPIO 4 (pin 7 on GPIO header) for interrupt.
2749 Load: dtoverlay=iqs550,<param>=<val>
2750 Params: interrupt GPIO used for interrupt (default 4)
2751 reset GPIO used for reset (optional)
2752 sizex Touchscreen size x (default 800)
2753 sizey Touchscreen size y (default 480)
2754 invx Touchscreen inverted x axis
2755 invy Touchscreen inverted y axis
2756 swapxy Touchscreen swapped x y axis
2760 Info: Infineon irs1125 TOF camera module.
2761 Uses Unicam 1, which is the standard camera connector on most Pi
2763 Load: dtoverlay=irs1125,<param>=<val>
2764 Params: media-controller Configure use of Media Controller API for
2765 configuring the sensor (default off)
2766 cam0 Adopt the default configuration for CAM0 on a
2767 Compute Module (CSI0, i2c_vc, and cam0_reg).
2771 Info: Adds support for JEDEC-compliant SPI NOR flash devices. (Note: The
2772 "jedec,spi-nor" kernel driver was formerly known as "m25p80".)
2773 Load: dtoverlay=jedec-spi-nor,<param>=<val>
2774 Params: spi<n>-<m> Enable flash device on SPI<n>, CS#<m>
2775 fastr Add fast read capability to the flash device
2776 speed Maximum SPI frequency (Hz)
2777 flash-spi<n>-<m> Same as spi<n>-<m> (deprecated)
2778 flash-fastr-spi<n>-<m> Same as spi<n>->m>,fastr (deprecated)
2782 Info: Simultaneous usage of an justboom-dac and justboom-digi based
2784 Load: dtoverlay=justboom-both,<param>=<val>
2785 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2786 Digital volume control. Enable with
2787 "dtoverlay=justboom-dac,24db_digital_gain"
2788 (The default behaviour is that the Digital
2789 volume control is limited to a maximum of
2790 0dB. ie. it can attenuate but not provide
2791 gain. For most users, this will be desired
2792 as it will prevent clipping. By appending
2793 the 24dB_digital_gain parameter, the Digital
2794 volume control will allow up to 24dB of
2795 gain. If this parameter is enabled, it is the
2796 responsibility of the user to ensure that
2797 the Digital volume control is set to a value
2798 that does not result in clipping/distortion!)
2802 Info: Configures the JustBoom DAC HAT, Amp HAT, DAC Zero and Amp Zero audio
2804 Load: dtoverlay=justboom-dac,<param>=<val>
2805 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2806 Digital volume control. Enable with
2807 "dtoverlay=justboom-dac,24db_digital_gain"
2808 (The default behaviour is that the Digital
2809 volume control is limited to a maximum of
2810 0dB. ie. it can attenuate but not provide
2811 gain. For most users, this will be desired
2812 as it will prevent clipping. By appending
2813 the 24dB_digital_gain parameter, the Digital
2814 volume control will allow up to 24dB of
2815 gain. If this parameter is enabled, it is the
2816 responsibility of the user to ensure that
2817 the Digital volume control is set to a value
2818 that does not result in clipping/distortion!)
2822 Info: Configures the JustBoom Digi HAT and Digi Zero audio cards
2823 Load: dtoverlay=justboom-digi
2828 Info: This overlay has been deprecated and removed - see gpio-ir
2833 Info: Adds support for the ltc294x family of battery gauges
2834 Load: dtoverlay=ltc294x,<param>=<val>
2835 Params: ltc2941 Select the ltc2941 device
2837 ltc2942 Select the ltc2942 device
2839 ltc2943 Select the ltc2943 device
2841 ltc2944 Select the ltc2944 device
2843 resistor-sense The sense resistor value in milli-ohms.
2844 Can be a 32-bit negative value when the battery
2845 has been connected to the wrong end of the
2848 prescaler-exponent Range and accuracy of the gauge. The value is
2849 programmed into the chip only if it differs
2850 from the current setting.
2852 - Default value is 128
2853 - the exponent is in the range 0-7 (default 7)
2854 See the datasheet for more information.
2858 Info: Configures the Maxim MAX98357A I2S DAC
2859 Load: dtoverlay=max98357a,<param>=<val>
2860 Params: no-sdmode Driver does not manage the state of the DAC's
2861 SD_MODE pin (i.e. chip is always on).
2862 sdmode-pin integer, GPIO pin connected to the SD_MODE input
2863 of the DAC (default GPIO4 if parameter omitted).
2867 Info: Configure a MAX6675, MAX31855 or MAX31856 thermocouple as an IIO device.
2869 For devices on spi1 or spi2, the interfaces should be enabled
2870 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2871 The overlay expects to disable the relevant spidev node, so also using
2872 e.g. cs0_spidev=off is unnecessary.
2875 MAX31855 on /dev/spidev0.0
2876 dtoverlay=maxtherm,spi0-0,max31855
2877 MAX31856 using a type J thermocouple on /dev/spidev2.1
2879 dtoverlay=maxtherm,spi2-1,max31856,type_j
2881 Load: dtoverlay=maxtherm,<param>=<val>
2882 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
2884 max6675 Enable support for the MAX6675 (default)
2885 max31855 Enable support for the MAX31855
2886 max31855e Enable support for the MAX31855E
2887 max31855j Enable support for the MAX31855J
2888 max31855k Enable support for the MAX31855K
2889 max31855n Enable support for the MAX31855N
2890 max31855r Enable support for the MAX31855R
2891 max31855s Enable support for the MAX31855S
2892 max31855t Enable support for the MAX31855T
2893 max31856 Enable support for the MAX31856 (with type K)
2894 type_b Select a type B sensor for max31856
2895 type_e Select a type E sensor for max31856
2896 type_j Select a type J sensor for max31856
2897 type_k Select a type K sensor for max31856
2898 type_n Select a type N sensor for max31856
2899 type_r Select a type R sensor for max31856
2900 type_s Select a type S sensor for max31856
2901 type_t Select a type T sensor for max31856
2905 Info: Configures the mbed AudioCODEC (TLV320AIC23B)
2906 Load: dtoverlay=mbed-dac
2911 Info: Configures the MCP23017 I2C GPIO expander
2912 Load: dtoverlay=mcp23017,<param>=<val>
2913 Params: gpiopin Gpio pin connected to the INTA output of the
2914 MCP23017 (default: 4)
2916 addr I2C address of the MCP23017 (default: 0x20)
2918 mcp23008 Configure an MCP23008 instead.
2919 noints Disable the interrupt GPIO line.
2920 i2c0 Choose the I2C0 bus on GPIOs 0&1
2921 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2922 i2c3 Choose the I2C3 bus (configure with the i2c3
2923 overlay - BCM2711 only)
2924 i2c4 Choose the I2C4 bus (configure with the i2c4
2925 overlay - BCM2711 only)
2926 i2c5 Choose the I2C5 bus (configure with the i2c5
2927 overlay - BCM2711 only)
2928 i2c6 Choose the I2C6 bus (configure with the i2c6
2929 overlay - BCM2711 only)
2933 Info: Configures the MCP23S08/17 SPI GPIO expanders.
2934 If devices are present on SPI1 or SPI2, those interfaces must be enabled
2935 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2936 If interrupts are enabled for a device on a given CS# on a SPI bus, that
2937 device must be the only one present on that SPI bus/CS#.
2938 Load: dtoverlay=mcp23s17,<param>=<val>
2939 Params: s08-spi<n>-<m>-present 4-bit integer, bitmap indicating MCP23S08
2940 devices present on SPI<n>, CS#<m>
2942 s17-spi<n>-<m>-present 8-bit integer, bitmap indicating MCP23S17
2943 devices present on SPI<n>, CS#<m>
2945 s08-spi<n>-<m>-int-gpio integer, enables interrupts on a single
2946 MCP23S08 device on SPI<n>, CS#<m>, specifies
2947 the GPIO pin to which INT output of MCP23S08
2950 s17-spi<n>-<m>-int-gpio integer, enables mirrored interrupts on a
2951 single MCP23S17 device on SPI<n>, CS#<m>,
2952 specifies the GPIO pin to which either INTA
2953 or INTB output of MCP23S17 is connected.
2957 Info: Configures the MCP2515 CAN controller on spi0/1/2
2958 For devices on spi1 or spi2, the interfaces should be enabled
2959 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2960 Load: dtoverlay=mcp2515,<param>=<val>
2961 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
2964 oscillator Clock frequency for the CAN controller (Hz)
2966 speed Maximum SPI frequence (Hz)
2968 interrupt GPIO for interrupt signal
2972 Info: Configures the MCP2515 CAN controller on spi0.0
2973 Load: dtoverlay=mcp2515-can0,<param>=<val>
2974 Params: oscillator Clock frequency for the CAN controller (Hz)
2976 spimaxfrequency Maximum SPI frequence (Hz)
2978 interrupt GPIO for interrupt signal
2982 Info: Configures the MCP2515 CAN controller on spi0.1
2983 Load: dtoverlay=mcp2515-can1,<param>=<val>
2984 Params: oscillator Clock frequency for the CAN controller (Hz)
2986 spimaxfrequency Maximum SPI frequence (Hz)
2988 interrupt GPIO for interrupt signal
2992 Info: Configures the MCP251XFD CAN controller family
2993 For devices on spi1 or spi2, the interfaces should be enabled
2994 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2995 Load: dtoverlay=mcp251xfd,<param>=<val>
2996 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
2999 oscillator Clock frequency for the CAN controller (Hz)
3001 speed Maximum SPI frequence (Hz)
3003 interrupt GPIO for interrupt signal
3005 rx_interrupt GPIO for RX interrupt signal (nINT1) (optional)
3007 xceiver_enable GPIO for CAN transceiver enable (optional)
3009 xceiver_active_high specifiy if CAN transceiver enable pin is
3010 active high (optional, default: active low)
3014 Info: Configures MCP3008 A/D converters
3015 For devices on spi1 or spi2, the interfaces should be enabled
3016 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
3017 Load: dtoverlay=mcp3008,<param>[=<val>]
3018 Params: spi<n>-<m>-present boolean, configure device at spi<n>, cs<m>
3019 spi<n>-<m>-speed integer, set the spi bus speed for this device
3023 Info: Configures MCP3202 A/D converters
3024 For devices on spi1 or spi2, the interfaces should be enabled
3025 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
3026 Load: dtoverlay=mcp3202,<param>[=<val>]
3027 Params: spi<n>-<m>-present boolean, configure device at spi<n>, cs<m>
3028 spi<n>-<m>-speed integer, set the spi bus speed for this device
3032 Info: Overlay for activation of Microchip MCP3421-3428 ADCs over I2C
3033 Load: dtoverlay=mcp342x,<param>=<val>
3034 Params: addr I2C bus address of device, for devices with
3035 addresses that are configurable, e.g. by
3036 hardware links (default=0x68)
3037 mcp3421 The device is an MCP3421
3038 mcp3422 The device is an MCP3422
3039 mcp3423 The device is an MCP3423
3040 mcp3424 The device is an MCP3424
3041 mcp3425 The device is an MCP3425
3042 mcp3426 The device is an MCP3426
3043 mcp3427 The device is an MCP3427
3044 mcp3428 The device is an MCP3428
3048 Info: Media Center HAT - 2.83" Touch Display + extras by Pi Supply
3049 Load: dtoverlay=media-center,<param>=<val>
3050 Params: speed Display SPI bus speed
3051 rotate Display rotation {0,90,180,270}
3052 fps Delay between frame updates
3053 xohms Touchpanel sensitivity (X-plate resistance)
3054 swapxy Swap x and y axis
3055 backlight Change backlight GPIO pin {e.g. 12, 18}
3056 debug "on" = enable additional debug messages
3061 Info: Configures the merus-amp audio card
3062 Load: dtoverlay=merus-amp
3067 Info: Configures UART0 (ttyAMA0) so that a requested 38.4kbaud actually gets
3068 31.25kbaud, the frequency required for MIDI
3069 Load: dtoverlay=midi-uart0
3073 Name: midi-uart0-pi5
3074 Info: See midi-uart0 (this is the Pi 5 version)
3078 Info: Configures UART1 (ttyS0) so that a requested 38.4kbaud actually gets
3079 31.25kbaud, the frequency required for MIDI
3080 Load: dtoverlay=midi-uart1
3084 Name: midi-uart1-pi5
3085 Info: See midi-uart1 (this is the Pi 5 version)
3089 Info: Configures UART2 (ttyAMA2) so that a requested 38.4kbaud actually gets
3090 31.25kbaud, the frequency required for MIDI
3091 Load: dtoverlay=midi-uart2
3095 Name: midi-uart2-pi5
3096 Info: See midi-uart2 (this is the Pi 5 version)
3100 Info: Configures UART3 (ttyAMA3) so that a requested 38.4kbaud actually gets
3101 31.25kbaud, the frequency required for MIDI
3102 Load: dtoverlay=midi-uart3
3106 Name: midi-uart3-pi5
3107 Info: See midi-uart3 (this is the Pi 5 version)
3111 Info: Configures UART4 (ttyAMA4) so that a requested 38.4kbaud actually gets
3112 31.25kbaud, the frequency required for MIDI
3113 Load: dtoverlay=midi-uart4
3117 Name: midi-uart4-pi5
3118 Info: See midi-uart4 (this is the Pi 5 version)
3122 Info: Configures UART5 (ttyAMA5) so that a requested 38.4kbaud actually gets
3123 31.25kbaud, the frequency required for MIDI
3124 Load: dtoverlay=midi-uart5
3129 Info: Overlay for AdaFruit Mini Pi 1.3" TFT via SPI using fbtft driver.
3130 Load: dtoverlay=minipitft13,<param>=<val>
3131 Params: speed SPI bus speed (default 32000000)
3132 rotate Display rotation (0, 90, 180 or 270; default 0)
3133 width Display width (default 240)
3134 height Display height (default 240)
3135 fps Delay between frame updates (default 25)
3136 debug Debug output level (0-7; default 0)
3140 Info: Switch the onboard Bluetooth function of a BT-equipped Raspberry Pi
3141 to use the mini-UART (ttyS0) and restore UART0/ttyAMA0 over GPIOs 14 &
3142 15. Note that this option uses a lower baudrate, and should only be used
3143 with low-bandwidth peripherals.
3144 Load: dtoverlay=miniuart-bt,<param>=<val>
3145 Params: krnbt Set to "off" to disable autoprobing of Bluetooth
3146 driver without need of hciattach/btattach
3150 Info: Overlay for SPI-connected MIPI DBI displays using the panel-mipi-dbi
3151 driver. The driver will load a file /lib/firmware/panel.bin containing
3152 the initialisation commands.
3155 dtoverlay=mipi-dbi-spi,spi0-0,speed=70000000
3156 dtparam=width=320,height=240
3157 dtparam=reset-gpio=23,dc-gpio=24
3158 dtparam=backlight-gpio=18
3160 Compared to fbtft panel-mipi-dbi runs pixel data at spi-max-frequency
3161 and init commands at 10MHz. This makes it possible to push the envelope
3162 without messing up the controller configuration due to command
3163 transmission errors.
3165 For devices on spi1 or spi2, the interfaces should be enabled
3166 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
3168 See https://github.com/notro/panel-mipi-dbi/wiki for more info.
3170 Load: dtoverlay=mipi-dbi-spi,<param>=<val>
3172 compatible Set the compatible string to load a different
3173 firmware file. Both the panel compatible value
3174 used to load the firmware file and the value
3175 used to load the driver has to be set having a
3176 NUL (\0) separator between them.
3178 dtparam=compatible=mypanel\0panel-mipi-dbi-spi
3179 spi<n>-<m> Configure device at spi<n>, cs<m>
3181 speed SPI bus speed in Hz (default 32000000)
3182 cpha Shifted SPI clock phase (CPHA) mode
3183 cpol Inverse SPI clock polarity (CPOL) mode
3184 write-only Controller is not readable
3185 (ie. MISO is not wired up).
3187 width Panel width in pixels (required)
3188 height Panel height in pixels (required)
3189 width-mm Panel width in mm
3190 height-mm Panel height in mm
3191 x-offset Panel x-offset in controller RAM
3192 y-offset Panel y-offset in controller RAM
3194 clock-frequency Panel clock frequency in Hz
3195 (optional, just informational).
3197 reset-gpio GPIO pin to be used for RESET
3198 dc-gpio GPIO pin to be used for D/C
3200 backlight-gpio GPIO pin to be used for backlight control
3202 backlight-pwm PWM channel to be used for backlight control
3203 (default of none). NB Disables audio headphone
3204 output as that also uses PWM.
3205 backlight-pwm-chan Choose channel on &pwm node for backlight
3206 control (default 0).
3207 backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See
3208 pwm-2chan for valid options (default 18).
3209 backlight-pwm-func Pin function of GPIO used for the PWM backlight.
3210 See pwm-2chan for valid options (default 2).
3211 backlight-def-brightness
3212 Set the default brightness. Normal range 1-16.
3217 Info: Overlay for i2c connected mlx90640 thermal camera
3218 Load: dtoverlay=mlx90640
3223 Info: Selects the bcm2835-mmc SD/MMC driver, optionally with overclock
3224 Load: dtoverlay=mmc,<param>=<val>
3225 Params: overclock_50 Clock (in MHz) to use when the MMC framework
3230 Info: This overlay has been deprecated - use "dtoverlay=i2c-sensor,mpu6050"
3231 instead. Note that "int_pin" is the new name for the "interrupt"
3237 Info: MZ61581 display by Tontec
3238 Load: dtoverlay=mz61581,<param>=<val>
3239 Params: speed Display SPI bus speed
3241 rotate Display rotation {0,90,180,270}
3243 fps Delay between frame updates
3245 txbuflen Transmit buffer length (default 32768)
3247 debug Debug output level {0-7}
3249 xohms Touchpanel sensitivity (X-plate resistance)
3253 Info: Omnivision OV2311 camera module.
3254 Uses Unicam 1, which is the standard camera connector on most Pi
3256 Load: dtoverlay=ov2311,<param>=<val>
3257 Params: rotation Mounting rotation of the camera sensor (0 or
3259 orientation Sensor orientation (0 = front, 1 = rear,
3260 2 = external, default external)
3261 media-controller Configure use of Media Controller API for
3262 configuring the sensor (default on)
3263 cam0 Adopt the default configuration for CAM0 on a
3264 Compute Module (CSI0, i2c_vc, and cam0_reg).
3268 Info: Omnivision OV5647 camera module.
3269 Uses Unicam 1, which is the standard camera connector on most Pi
3271 Load: dtoverlay=ov5647,<param>=<val>
3272 Params: rotation Mounting rotation of the camera sensor (0 or
3274 orientation Sensor orientation (0 = front, 1 = rear,
3275 2 = external, default external)
3276 media-controller Configure use of Media Controller API for
3277 configuring the sensor (default on)
3278 cam0 Adopt the default configuration for CAM0 on a
3279 Compute Module (CSI0, i2c_vc, and cam0_reg).
3280 vcm Configure a VCM focus drive on the sensor.
3284 Info: Arducam OV64A40 camera module.
3285 Uses Unicam 1, which is the standard camera connector on most Pi
3287 Load: dtoverlay=ov64a40,<param>=<val>
3288 Params: rotation Mounting rotation of the camera sensor (0 or
3290 orientation Sensor orientation (0 = front, 1 = rear,
3291 2 = external, default external)
3292 media-controller Configure use of Media Controller API for
3293 configuring the sensor (default on)
3294 cam0 Adopt the default configuration for CAM0 on a
3295 Compute Module (CSI0, i2c_vc, and cam0_reg).
3296 vcm Select lens driver state. Default is enabled,
3297 but vcm=off will disable.
3298 link-frequency Allowable link frequency values to use in Hz:
3299 456000000 (default), 360000000
3303 Info: Omnivision OV7251 camera module.
3304 Uses Unicam 1, which is the standard camera connector on most Pi
3306 Load: dtoverlay=ov7251,<param>=<val>
3307 Params: rotation Mounting rotation of the camera sensor (0 or
3309 orientation Sensor orientation (0 = front, 1 = rear,
3310 2 = external, default external)
3311 media-controller Configure use of Media Controller API for
3312 configuring the sensor (default off)
3313 cam0 Adopt the default configuration for CAM0 on a
3314 Compute Module (CSI0, i2c_vc, and cam0_reg).
3318 Info: Omnivision OV9281 camera module.
3319 Uses Unicam 1, which is the standard camera connector on most Pi
3321 Load: dtoverlay=ov9281,<param>=<val>
3322 Params: rotation Mounting rotation of the camera sensor (0 or
3324 orientation Sensor orientation (0 = front, 1 = rear,
3325 2 = external, default external)
3326 media-controller Configure use of Media Controller API for
3327 configuring the sensor (default on)
3328 cam0 Adopt the default configuration for CAM0 on a
3329 Compute Module (CSI0, i2c_vc, and cam0_reg).
3333 Info: PaPiRus ePaper Screen by Pi Supply (both HAT and pHAT)
3334 Load: dtoverlay=papirus,<param>=<val>
3335 Params: panel Display panel (required):
3340 speed Display SPI bus speed
3344 Info: TI PCA953x family of I2C GPIO expanders. Default is for NXP PCA9534.
3345 Load: dtoverlay=pca953x,<param>=<val>
3346 Params: addr I2C address of expander. Default 0x20.
3347 pca6416 Select the NXP PCA6416 (16 bit)
3348 pca9505 Select the NXP PCA9505 (40 bit)
3349 pca9535 Select the NXP PCA9535 (16 bit)
3350 pca9536 Select the NXP PCA9536 or TI PCA9536 (4 bit)
3351 pca9537 Select the NXP PCA9537 (4 bit)
3352 pca9538 Select the NXP PCA9538 (8 bit)
3353 pca9539 Select the NXP PCA9539 (16 bit)
3354 pca9554 Select the NXP PCA9554 (8 bit)
3355 pca9555 Select the NXP PCA9555 (16 bit)
3356 pca9556 Select the NXP PCA9556 (8 bit)
3357 pca9557 Select the NXP PCA9557 (8 bit)
3358 pca9574 Select the NXP PCA9574 (8 bit)
3359 pca9575 Select the NXP PCA9575 (16 bit)
3360 pca9698 Select the NXP PCA9698 (40 bit)
3361 pcal6416 Select the NXP PCAL6416 (16 bit)
3362 pcal6524 Select the NXP PCAL6524 (24 bit)
3363 pcal9555a Select the NXP PCAL9555A (16 bit)
3364 max7310 Select the Maxim MAX7310 (8 bit)
3365 max7312 Select the Maxim MAX7312 (16 bit)
3366 max7313 Select the Maxim MAX7313 (16 bit)
3367 max7315 Select the Maxim MAX7315 (8 bit)
3368 pca6107 Select the TI PCA6107 (8 bit)
3369 tca6408 Select the TI TCA6408 (8 bit)
3370 tca6416 Select the TI TCA6416 (16 bit)
3371 tca6424 Select the TI TCA6424 (24 bit)
3372 tca9539 Select the TI TCA9539 (16 bit)
3373 tca9554 Select the TI TCA9554 (8 bit)
3374 cat9554 Select the Onnn CAT9554 (8 bit)
3375 pca9654 Select the Onnn PCA9654 (8 bit)
3376 xra1202 Select the Exar XRA1202 (8 bit)
3380 Info: NXP PCF857x family of I2C GPIO expanders.
3381 Load: dtoverlay=pcf857x,<param>=<val>
3382 Params: addr I2C address of expander. Default
3383 depends on model selected.
3384 pcf8574 Select the NXP PCF8574 (8 bit)
3385 pcf8574a Select the NXP PCF8574A (8 bit)
3386 pcf8575 Select the NXP PCF8575 (16 bit)
3387 pca8574 Select the NXP PCA8574 (8 bit)
3390 Name: pcie-32bit-dma
3391 Info: Force PCIe config to support 32bit DMA addresses at the expense of
3392 having to bounce buffers.
3393 Load: dtoverlay=pcie-32bit-dma
3397 [ The pcf2127-rtc overlay has been deleted. See i2c-rtc. ]
3400 [ The pcf8523-rtc overlay has been deleted. See i2c-rtc. ]
3403 [ The pcf8563-rtc overlay has been deleted. See i2c-rtc. ]
3407 Info: This overlay has been renamed act-led, keeping pi3-act-led as an alias
3408 for backwards compatibility.
3412 Name: pi3-disable-bt
3413 Info: This overlay has been renamed disable-bt, keeping pi3-disable-bt as an
3414 alias for backwards compatibility.
3418 Name: pi3-disable-wifi
3419 Info: This overlay has been renamed disable-wifi, keeping pi3-disable-wifi as
3420 an alias for backwards compatibility.
3424 Name: pi3-miniuart-bt
3425 Info: This overlay has been renamed miniuart-bt, keeping pi3-miniuart-bt as
3426 an alias for backwards compatibility.
3431 Info: Configures the pibell audio card.
3432 Load: dtoverlay=pibell,<param>=<val>
3433 Params: alsaname Set the name as it appears in ALSA (default
3438 Info: Configures the PiFace Digital mcp23s17 GPIO port expander.
3439 Load: dtoverlay=pifacedigital,<param>=<val>
3440 Params: spi-present-mask 8-bit integer, bitmap indicating MCP23S17 SPI0
3441 CS0 address. PiFace Digital supports addresses
3442 0-3, which can be configured with JP1 and JP2.
3446 Info: Configures the PiFi 40W stereo amplifier
3447 Load: dtoverlay=pifi-40
3452 Info: Configures the PiFi DAC HD
3453 Load: dtoverlay=pifi-dac-hd
3458 Info: Configures the PiFi DAC Zero
3459 Load: dtoverlay=pifi-dac-zero
3464 Info: Configures the PiFi Mini stereo amplifier
3465 Load: dtoverlay=pifi-mini-210
3470 Info: Configures the PiGlow by pimoroni.com
3471 Load: dtoverlay=piglow
3476 Info: PiScreen display by OzzMaker.com
3477 Load: dtoverlay=piscreen,<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 xohms Touchpanel sensitivity (X-plate resistance)
3488 drm Select the DRM/KMS driver instead of the FBTFT
3493 Info: PiScreen 2 with resistive TP display by OzzMaker.com
3494 Load: dtoverlay=piscreen2r,<param>=<val>
3495 Params: speed Display SPI bus speed
3497 rotate Display rotation {0,90,180,270}
3499 fps Delay between frame updates
3501 debug Debug output level {0-7}
3503 xohms Touchpanel sensitivity (X-plate resistance)
3507 Info: Configures the Blokas Labs Pisound card
3508 Load: dtoverlay=pisound
3513 Info: Pi 5 specific overlay override for Blokas Labs Pisound card, see pisound
3514 Load: dtoverlay=pisound-pi5
3519 Info: Adafruit PiTFT 2.2" screen
3520 Load: dtoverlay=pitft22,<param>=<val>
3521 Params: speed Display SPI bus speed
3523 rotate Display rotation {0,90,180,270}
3525 fps Delay between frame updates
3527 debug Debug output level {0-7}
3530 Name: pitft28-capacitive
3531 Info: Adafruit PiTFT 2.8" capacitive touch screen
3532 Load: dtoverlay=pitft28-capacitive,<param>=<val>
3533 Params: speed Display SPI bus speed
3535 rotate Display rotation {0,90,180,270}
3537 fps Delay between frame updates
3539 debug Debug output level {0-7}
3541 touch-sizex Touchscreen size x (default 240)
3543 touch-sizey Touchscreen size y (default 320)
3545 touch-invx Touchscreen inverted x axis
3547 touch-invy Touchscreen inverted y axis
3549 touch-swapxy Touchscreen swapped x y axis
3552 Name: pitft28-resistive
3553 Info: Adafruit PiTFT 2.8" resistive touch screen
3554 Load: dtoverlay=pitft28-resistive,<param>=<val>
3555 Params: speed Display SPI bus speed
3557 rotate Display rotation {0,90,180,270}
3559 fps Delay between frame updates
3561 debug Debug output level {0-7}
3563 drm Force the use of the mi0283qt DRM driver (by
3564 default the ili9340 framebuffer driver will
3565 be used in preference if available)
3568 Name: pitft35-resistive
3569 Info: Adafruit PiTFT 3.5" resistive touch screen
3570 Load: dtoverlay=pitft35-resistive,<param>=<val>
3571 Params: speed Display SPI bus speed
3573 rotate Display rotation {0,90,180,270}
3575 fps Delay between frame updates
3577 debug Debug output level {0-7}
3579 drm Force the use of the hx8357d DRM driver (by
3580 default the fb_hx8357d framebuffer driver will
3581 be used in preference if available)
3585 Info: Configures the pps-gpio (pulse-per-second time signal via GPIO).
3586 Load: dtoverlay=pps-gpio,<param>=<val>
3587 Params: gpiopin Input GPIO (default "18")
3588 assert_falling_edge When present, assert is indicated by a falling
3589 edge, rather than by a rising edge (default
3591 capture_clear Generate clear events on the trailing edge
3593 pull Desired pull-up/down state (off, down, up)
3598 Info: Configures the PROTO Audio Codec card
3599 Load: dtoverlay=proto-codec
3604 Info: Configures a single PWM channel
3605 Legal pin,function combinations for each channel:
3606 PWM0: 12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
3607 PWM1: 13,4(Alt0) 19,2(Alt5) 41,4(Alt0) 45,4(Alt0) 53,5(Alt1)
3609 1) Pin 18 is the only one available on all platforms, and
3610 it is the one used by the I2S audio interface.
3611 Pins 12 and 13 might be better choices on an A+, B+ or Pi2.
3612 2) The onboard analogue audio output uses both PWM channels.
3613 3) So be careful mixing audio and PWM.
3614 4) Currently the clock must have been enabled and configured
3616 Load: dtoverlay=pwm,<param>=<val>
3617 Params: pin Output pin (default 18) - see table
3618 func Pin function (default 2 = Alt5) - see above
3619 clock PWM clock frequency (informational)
3623 Info: Configures both PWM channels
3624 Legal pin,function combinations for each channel:
3625 PWM0: 12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
3626 PWM1: 13,4(Alt0) 19,2(Alt5) 41,4(Alt0) 45,4(Alt0) 53,5(Alt1)
3628 1) Pin 18 is the only one available on all platforms, and
3629 it is the one used by the I2S audio interface.
3630 Pins 12 and 13 might be better choices on an A+, B+ or Pi2.
3631 2) The onboard analogue audio output uses both PWM channels.
3632 3) So be careful mixing audio and PWM.
3633 4) Currently the clock must have been enabled and configured
3635 Load: dtoverlay=pwm-2chan,<param>=<val>
3636 Params: pin Output pin (default 18) - see table
3637 pin2 Output pin for other channel (default 19)
3638 func Pin function (default 2 = Alt5) - see above
3639 func2 Function for pin2 (default 2 = Alt5)
3640 clock PWM clock frequency (informational)
3644 Info: Use GPIO pin as pwm-assisted infrared transmitter output.
3645 This is an alternative to "gpio-ir-tx". pwm-ir-tx makes use
3646 of PWM0 to reduce the CPU load during transmission compared to
3647 gpio-ir-tx which uses bit-banging.
3648 Legal pin,function combinations are:
3649 12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
3650 Load: dtoverlay=pwm-ir-tx,<param>=<val>
3651 Params: gpio_pin Output GPIO (default 18)
3653 func Pin function (default 2 = Alt5)
3657 Info: Configures one or two PWM channel on PWM1 (BCM2711 only)
3659 1) The onboard analogue audio output uses both PWM channels.
3660 2) So be careful mixing audio and PWM.
3661 Note that even when only one pin is enabled, both channels are available
3662 from the PWM driver, so be careful to use the correct one.
3663 Load: dtoverlay=pwm1,<param>=<val>
3664 Params: clock PWM clock frequency (informational)
3665 pins_40 Enable channel 0 (PWM1_0) on GPIO 40
3666 pins_41 Enable channel 1 (PWM1_1) on GPIO 41
3667 pins_40_41 Enable channels 0 (PWM1_0) and 1 (PW1_1) on
3668 GPIOs 40 and 41 (default)
3669 pull_up Enable pull-ups on the PWM pins (default)
3670 pull_down Enable pull-downs on the PWM pins
3671 pull_off Disable pulls on the PWM pins
3675 Info: in-tech's Evaluation Board for PLC Stamp micro
3676 This uses spi0 and a separate GPIO interrupt to connect the QCA7000.
3677 Load: dtoverlay=qca7000,<param>=<val>
3678 Params: int_pin GPIO pin for interrupt signal (default 23)
3680 speed SPI bus speed (default 12 MHz)
3684 Info: in-tech's Evaluation Board for PLC Stamp micro (UART)
3685 This uses uart0/ttyAMA0 over GPIOs 14 & 15 to connect the QCA7000.
3686 But it requires disabling of onboard Bluetooth on
3687 Pi 3B, 3B+, 3A+, 4B and Zero W.
3688 Load: dtoverlay=qca7000-uart0,<param>=<val>
3689 Params: baudrate Set the baudrate for the UART (default
3694 Info: Enable the preservation of crash logs across a reboot. With
3695 systemd-pstore enabled (as it is on Raspberry Pi OS) the crash logs
3696 are moved to /var/lib/systemd/pstore/ on reboot.
3697 Load: dtoverlay=ramoops,<param>=<val>
3698 Params: base-addr Where to place the capture buffer (default
3700 total-size How much memory to allocate altogether (in
3701 bytes - default 64kB)
3702 record-size How much space to use for each capture, i.e.
3703 total-size / record-size = number of captures
3705 console-size Size of non-panic dmesg captures (default 0)
3709 Info: The version of the ramoops overlay for the Pi 4 family. It should be
3710 loaded automatically if dtoverlay=ramoops is specified on a Pi 4.
3711 Load: dtoverlay=ramoops-pi4,<param>=<val>
3712 Params: base-addr Where to place the capture buffer (default
3714 total-size How much memory to allocate altogether (in
3715 bytes - default 64kB)
3716 record-size How much space to use for each capture, i.e.
3717 total-size / record-size = number of captures
3719 console-size Size of non-panic dmesg captures (default 0)
3722 Name: rotary-encoder
3723 Info: Overlay for GPIO connected rotary encoder.
3724 Load: dtoverlay=rotary-encoder,<param>=<val>
3725 Params: pin_a GPIO connected to rotary encoder channel A
3727 pin_b GPIO connected to rotary encoder channel B
3729 relative_axis register a relative axis rather than an
3730 absolute one. Relative axis will only
3731 generate +1/-1 events on the input device,
3732 hence no steps need to be passed.
3733 linux_axis the input subsystem axis to map to this
3734 rotary encoder. Defaults to 0 (ABS_X / REL_X)
3735 rollover Automatic rollover when the rotary value
3736 becomes greater than the specified steps or
3737 smaller than 0. For absolute axis only.
3738 steps-per-period Number of steps (stable states) per period.
3739 The values have the following meaning:
3740 1: Full-period mode (default)
3742 4: Quarter-period mode
3743 steps Number of steps in a full turnaround of the
3744 encoder. Only relevant for absolute axis.
3745 Defaults to 24 which is a typical value for
3747 wakeup Boolean, rotary encoder can wake up the
3749 encoding String, the method used to encode steps.
3750 Supported are "gray" (the default and more
3751 common) and "binary".
3755 Info: Raspberry Pi official display backlight driver
3756 Load: dtoverlay=rpi-backlight
3760 Name: rpi-cirrus-wm5102
3761 Info: This overlay has been renamed to cirrus-wm5102
3766 Info: Configures the Raspberry Pi Codec Zero sound card
3767 Load: dtoverlay=rpi-codeczero
3772 Info: This overlay has been renamed to i2s-dac.
3777 Info: Configures the Raspberry Pi DAC+ card
3778 Load: dtoverlay=rpi-dacplus,<param>=<val>
3779 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
3780 digital volume control. Enable by adding
3781 "dtparam=24db_digital_gain" to config.txt
3782 before any "dtoverlay" lines.
3783 The default behaviour is that the digital
3784 volume control is limited to a maximum of
3785 0dB. ie. it can attenuate but not provide
3786 gain. For most users, this will be desired
3787 as it will prevent clipping. By appending
3788 the 24db_digital_gain parameter, the digital
3789 volume control will allow up to 24dB of
3790 gain. If this parameter is enabled, it is the
3791 responsibility of the user to ensure that
3792 the digital volume control is set to a value
3793 that does not result in clipping/distortion!
3797 Info: Configures the Raspberry Pi DAC Pro sound card
3798 Load: dtoverlay=rpi-dacpro,<param>=<val>
3799 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
3800 digital volume control. Enable by adding
3801 "dtparam=24db_digital_gain" to config.txt
3802 before any "dtoverlay" lines.
3803 The default behaviour is that the digital
3804 volume control is limited to a maximum of
3805 0dB. ie. it can attenuate but not provide
3806 gain. For most users, this will be desired
3807 as it will prevent clipping. By appending
3808 the 24db_digital_gain parameter, the digital
3809 volume control will allow up to 24dB of
3810 gain. If this parameter is enabled, it is the
3811 responsibility of the user to ensure that
3812 the digital volume control is set to a value
3813 that does not result in clipping/distortion!
3816 Name: rpi-digiampplus
3817 Info: Configures the Raspberry Pi DigiAMP+ sound card
3818 Load: dtoverlay=rpi-digiampplus,<param>=<val>
3819 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
3820 digital volume control. Enable by adding
3821 "dtparam=24db_digital_gain" to config.txt
3822 before any "dtoverlay" lines.
3823 The default behaviour is that the digital
3824 volume control is limited to a maximum of
3825 0dB. ie. it can attenuate but not provide
3826 gain. For most users, this will be desired
3827 as it will prevent clipping. By appending
3828 the 24db_digital_gain parameter, the digital
3829 volume control will allow up to 24dB of
3830 gain. If this parameter is enabled, it is the
3831 responsibility of the user to ensure that
3832 the digital volume control is set to a value
3833 that does not result in clipping/distortion!
3834 auto_mute_amp If specified, unmute/mute the DigiAMP+ when
3835 starting/stopping audio playback (default "on").
3836 unmute_amp If specified, unmute the DigiAMP+ amp once when
3837 the DAC driver module loads (default "off").
3841 Info: This overlay has been renamed to watterott-display
3846 Info: Official Raspberry Pi display touchscreen
3847 Load: dtoverlay=rpi-ft5406,<param>=<val>
3848 Params: touchscreen-size-x Touchscreen X resolution (default 800)
3849 touchscreen-size-y Touchscreen Y resolution (default 480);
3850 touchscreen-inverted-x Invert touchscreen X coordinates (default 0);
3851 touchscreen-inverted-y Invert touchscreen Y coordinates (default 0);
3852 touchscreen-swapped-x-y Swap X and Y cordinates (default 0);
3856 Info: Raspberry Pi PoE HAT fan
3857 Load: dtoverlay=rpi-poe,<param>[=<val>]
3858 Params: poe_fan_temp0 Temperature (in millicelcius) at which the fan
3859 turns on (default 40000)
3860 poe_fan_temp0_hyst Temperature delta (in millicelcius) at which
3861 the fan turns off (default 2000)
3862 poe_fan_temp1 Temperature (in millicelcius) at which the fan
3863 speeds up (default 45000)
3864 poe_fan_temp1_hyst Temperature delta (in millicelcius) at which
3865 the fan slows down (default 2000)
3866 poe_fan_temp2 Temperature (in millicelcius) at which the fan
3867 speeds up (default 50000)
3868 poe_fan_temp2_hyst Temperature delta (in millicelcius) at which
3869 the fan slows down (default 2000)
3870 poe_fan_temp3 Temperature (in millicelcius) at which the fan
3871 speeds up (default 55000)
3872 poe_fan_temp3_hyst Temperature delta (in millicelcius) at which
3873 the fan slows down (default 5000)
3874 i2c Control the fan via Linux I2C drivers instead of
3879 Info: Raspberry Pi PoE+ HAT fan
3880 Load: dtoverlay=rpi-poe-plus,<param>[=<val>]
3881 Params: poe_fan_temp0 Temperature (in millicelcius) at which the fan
3882 turns on (default 40000)
3883 poe_fan_temp0_hyst Temperature delta (in millicelcius) at which
3884 the fan turns off (default 2000)
3885 poe_fan_temp1 Temperature (in millicelcius) at which the fan
3886 speeds up (default 45000)
3887 poe_fan_temp1_hyst Temperature delta (in millicelcius) at which
3888 the fan slows down (default 2000)
3889 poe_fan_temp2 Temperature (in millicelcius) at which the fan
3890 speeds up (default 50000)
3891 poe_fan_temp2_hyst Temperature delta (in millicelcius) at which
3892 the fan slows down (default 2000)
3893 poe_fan_temp3 Temperature (in millicelcius) at which the fan
3894 speeds up (default 55000)
3895 poe_fan_temp3_hyst Temperature delta (in millicelcius) at which
3896 the fan slows down (default 5000)
3897 i2c Control the fan via Linux I2C drivers instead of
3902 Info: This overlay has been renamed to proto-codec.
3907 Info: Raspberry Pi Sense HAT
3908 Load: dtoverlay=rpi-sense
3913 Info: Raspberry Pi Sense HAT v2
3914 Load: dtoverlay=rpi-sense-v2
3919 Info: Raspberry Pi TV HAT
3920 Load: dtoverlay=rpi-tv
3925 Info: This overlay has been deprecated and deleted as the V4L2 stateless
3926 video decoder driver is enabled by default.
3930 Name: rra-digidac1-wm8741-audio
3931 Info: Configures the Red Rocks Audio DigiDAC1 soundcard
3932 Load: dtoverlay=rra-digidac1-wm8741-audio
3937 Info: Overlay for the SPI-connected Sainsmart 1.8" display (based on the
3939 Load: dtoverlay=sainsmart18,<param>=<val>
3940 Params: rotate Display rotation {0,90,180,270}
3941 speed SPI bus speed in Hz (default 4000000)
3942 fps Display frame rate in Hz
3943 bgr Enable BGR mode (default off)
3944 debug Debug output level {0-7}
3945 dc_pin GPIO pin for D/C (default 24)
3946 reset_pin GPIO pin for RESET (default 25)
3950 Info: Overlay for the NXP SC16IS750 UART with I2C Interface
3951 Enables the chip on I2C1 at 0x48 (or the "addr" parameter value). To
3952 select another address, please refer to table 10 in reference manual.
3953 Load: dtoverlay=sc16is750-i2c,<param>=<val>
3954 Params: int_pin GPIO used for IRQ (default 24)
3955 addr Address (default 0x48)
3956 xtal On-board crystal frequency (default 14745600)
3960 Info: Overlay for the NXP SC16IS752 dual UART with I2C Interface
3961 Enables the chip on I2C1 at 0x48 (or the "addr" parameter value). To
3962 select another address, please refer to table 10 in reference manual.
3963 Load: dtoverlay=sc16is752-i2c,<param>=<val>
3964 Params: int_pin GPIO used for IRQ (default 24)
3965 addr Address (default 0x48)
3966 xtal On-board crystal frequency (default 14745600)
3969 Name: sc16is752-spi0
3970 Info: Overlay for the NXP SC16IS752 Dual UART with SPI Interface
3971 Enables the chip on SPI0.
3972 Load: dtoverlay=sc16is752-spi0,<param>=<val>
3973 Params: int_pin GPIO used for IRQ (default 24)
3974 xtal On-board crystal frequency (default 14745600)
3977 Name: sc16is752-spi1
3978 Info: Overlay for the NXP SC16IS752 Dual UART with SPI Interface
3979 Enables the chip on SPI1.
3980 N.B.: spi1 is only accessible on devices with a 40pin header, eg:
3981 A+, B+, Zero and PI2 B; as well as the Compute Module.
3983 Load: dtoverlay=sc16is752-spi1,<param>=<val>
3984 Params: int_pin GPIO used for IRQ (default 24)
3985 xtal On-board crystal frequency (default 14745600)
3989 Info: Selects the bcm2835-sdhost SD/MMC driver, optionally with overclock.
3990 N.B. This overlay is designed for situations where the mmc driver is
3991 the default, so it disables the other (mmc) interface - this will kill
3992 WLAN on a Pi3. If this isn't what you want, either use the sdtweak
3993 overlay or the new sd_* dtparams of the base DTBs.
3994 Load: dtoverlay=sdhost,<param>=<val>
3995 Params: overclock_50 Clock (in MHz) to use when the MMC framework
3998 force_pio Disable DMA support (default off)
4000 pio_limit Number of blocks above which to use DMA
4003 debug Enable debug output (default off)
4007 Info: Selects the bcm2835-sdhost SD/MMC driver, optionally with overclock,
4008 and enables SDIO via GPIOs 22-27. An example of use in 1-bit mode is
4009 "dtoverlay=sdio,bus_width=1,gpios_22_25"
4010 Load: dtoverlay=sdio,<param>=<val>
4011 Params: sdio_overclock SDIO Clock (in MHz) to use when the MMC
4012 framework requests 50MHz
4014 poll_once Disable SDIO-device polling every second
4015 (default on: polling once at boot-time)
4017 bus_width Set the SDIO host bus width (default 4 bits)
4019 gpios_22_25 Select GPIOs 22-25 for 1-bit mode. Must be used
4020 with bus_width=1. This replaces the sdio-1bit
4021 overlay, which is now deprecated.
4023 gpios_34_37 Select GPIOs 34-37 for 1-bit mode. Must be used
4026 gpios_34_39 Select GPIOs 34-39 for 4-bit mode. Must be used
4027 with bus_width=4 (the default).
4031 Info: This overlay is now deprecated. Use
4032 "dtoverlay=sdio,bus_width=1,gpios_22_25" instead.
4037 Info: Selects the rp1_mmc0 interface and enables it on GPIOs 22-27.
4039 Load: dtoverlay=sdio-pi5
4044 Info: This overlay is now deprecated. Use the sd_* dtparams in the
4045 base DTB, e.g. "dtoverlay=sdtweak,poll_once" becomes
4046 "dtparam=sd_poll_once".
4050 Name: seeed-can-fd-hat-v1
4051 Info: Overlay for Seeed Studio CAN BUS FD HAT with two CAN FD
4052 channels without RTC. Use this overlay if your HAT has no
4054 https://www.seeedstudio.com/2-Channel-CAN-BUS-FD-Shield-for-Raspberry-Pi-p-4072.html
4055 Load: dtoverlay=seeed-can-fd-hat-v1
4059 Name: seeed-can-fd-hat-v2
4060 Info: Overlay for Seeed Studio CAN BUS FD HAT with two CAN FD
4061 channels and an RTC. Use this overlay if your HAT has a
4063 https://www.seeedstudio.com/CAN-BUS-FD-HAT-for-Raspberry-Pi-p-4742.html
4064 Load: dtoverlay=seeed-can-fd-hat-v2
4069 Info: Overlay for SH1106 OLED via SPI using fbtft staging driver.
4070 Load: dtoverlay=sh1106-spi,<param>=<val>
4071 Params: speed SPI bus speed (default 4000000)
4072 rotate Display rotation (0, 90, 180 or 270; default 0)
4073 fps Delay between frame updates (default 25)
4074 debug Debug output level (0-7; default 0)
4075 dc_pin GPIO pin for D/C (default 24)
4076 reset_pin GPIO pin for RESET (default 25)
4077 height Display height (32 or 64; default 64)
4081 Info: Overlay for Si446x UHF Transceiver via SPI using si446x driver.
4082 The driver is currently out-of-tree at
4083 https://github.com/sunipkmukherjee/silabs.git
4084 Load: dtoverlay=si446x-spi0,<param>=<val>
4085 Params: speed SPI bus speed (default 4000000)
4086 int_pin GPIO pin for interrupts (default 17)
4087 reset_pin GPIO pin for RESET (default 27)
4091 Info: Enables the Secondary Memory Interface peripheral. Uses GPIOs 2-25!
4097 Info: Enables the userspace interface for the SMI driver
4098 Load: dtoverlay=smi-dev
4103 Info: Enables access to NAND flash via the SMI interface
4104 Load: dtoverlay=smi-nand
4109 Info: Move SPI function block to GPIO 35 to 39
4110 Load: dtoverlay=spi-gpio35-39
4115 Info: Move SPI function block to GPIOs 40 to 45
4116 Load: dtoverlay=spi-gpio40-45
4121 Info: Adds support for a number of SPI Real Time Clock devices
4122 Load: dtoverlay=spi-rtc,<param>=<val>
4123 Params: ds3232 Select the DS3232 device
4124 ds3234 Select the DS3234 device
4125 pcf2123 Select the PCF2123 device
4127 spi0_0 Use spi0.0 (default)
4133 cs_high This device requires an active-high CS
4137 Info: Don't claim any CS pins for SPI0. Requires a device with its chip
4138 select permanently enabled, but frees a GPIO for e.g. a DPI display.
4139 Load: dtoverlay=spi0-0cs,<param>=<val>
4140 Params: no_miso Don't claim and use the MISO pin (9), freeing
4145 Info: Only use one CS pin for SPI0
4146 Load: dtoverlay=spi0-1cs,<param>=<val>
4147 Params: cs0_pin GPIO pin for CS0 (default 8)
4148 no_miso Don't claim and use the MISO pin (9), freeing
4153 Info: Change the CS pins for SPI0
4154 Load: dtoverlay=spi0-2cs,<param>=<val>
4155 Params: cs0_pin GPIO pin for CS0 (default 8)
4156 cs1_pin GPIO pin for CS1 (default 7)
4157 no_miso Don't claim and use the MISO pin (9), freeing
4162 Info: This overlay has been renamed spi0-2cs, keeping spi0-cs as an
4163 alias for backwards compatibility.
4168 Info: This overlay has been deprecated and removed because it is no longer
4169 necessary and has been seen to prevent spi0 from working.
4174 Info: Enables spi1 with a single chip select (CS) line and associated spidev
4175 dev node. The gpio pin number for the CS line and spidev device node
4176 creation are configurable.
4177 N.B.: spi1 is not accessible on old Pis without a 40-pin header.
4178 Load: dtoverlay=spi1-1cs,<param>=<val>
4179 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
4180 cs0_spidev Set to 'off' to stop the creation of a
4181 userspace device node /dev/spidev1.0 (default
4182 is 'on' or enabled).
4186 Info: Enables spi1 with two chip select (CS) lines and associated spidev
4187 dev nodes. The gpio pin numbers for the CS lines and spidev device node
4188 creation are configurable.
4189 N.B.: spi1 is not accessible on old Pis without a 40-pin header.
4190 Load: dtoverlay=spi1-2cs,<param>=<val>
4191 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
4192 cs1_pin GPIO pin for CS1 (default 17 - BCM SPI1_CE1).
4193 cs0_spidev Set to 'off' to stop the creation of a
4194 userspace device node /dev/spidev1.0 (default
4195 is 'on' or enabled).
4196 cs1_spidev Set to 'off' to stop the creation of a
4197 userspace device node /dev/spidev1.1 (default
4198 is 'on' or enabled).
4202 Info: Enables spi1 with three chip select (CS) lines and associated spidev
4203 dev nodes. The gpio pin numbers for the CS lines and spidev device node
4204 creation are configurable.
4205 N.B.: spi1 is not accessible on old Pis without a 40-pin header.
4206 Load: dtoverlay=spi1-3cs,<param>=<val>
4207 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
4208 cs1_pin GPIO pin for CS1 (default 17 - BCM SPI1_CE1).
4209 cs2_pin GPIO pin for CS2 (default 16 - BCM SPI1_CE2).
4210 cs0_spidev Set to 'off' to stop the creation of a
4211 userspace device node /dev/spidev1.0 (default
4212 is 'on' or enabled).
4213 cs1_spidev Set to 'off' to stop the creation of a
4214 userspace device node /dev/spidev1.1 (default
4215 is 'on' or enabled).
4216 cs2_spidev Set to 'off' to stop the creation of a
4217 userspace device node /dev/spidev1.2 (default
4218 is 'on' or enabled).
4222 Info: Enables spi2 on GPIOs 40-42 with a single chip select (CS) line and
4223 associated spidev dev node. The gpio pin number for the CS line and
4224 spidev device node creation are configurable. spi2-2cs-pi5 is
4225 substituted on a Pi 5.
4226 N.B.: spi2 is only accessible with the Compute Module or Pi 5.
4227 Load: dtoverlay=spi2-1cs,<param>=<val>
4228 Params: cs0_pin GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
4229 cs0_spidev Set to 'off' to stop the creation of a
4230 userspace device node /dev/spidev2.0 (default
4231 is 'on' or enabled).
4235 Info: Enables spi2 on GPIOs 1-3 with a single chip select (CS) line and
4236 associated spidev dev node. The gpio pin number for the CS line and
4237 spidev device node creation are configurable. Pi 5 only.
4238 Load: dtoverlay=spi2-1cs-pi5,<param>=<val>
4239 Params: cs0_pin GPIO pin for CS0 (default 0).
4240 cs0_spidev Set to 'off' to stop the creation of a
4241 userspace device node /dev/spidev2.0 (default
4242 is 'on' or enabled).
4246 Info: Enables spi2 on GPIOs 40-42 with two chip select (CS) lines and
4247 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4248 spidev device node creation are configurable. spi2-2cs-pi5 is
4249 substituted on a Pi 5.
4250 N.B.: spi2 is only accessible with the Compute Module or Pi 5.
4251 Load: dtoverlay=spi2-2cs,<param>=<val>
4252 Params: cs0_pin GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
4253 cs1_pin GPIO pin for CS1 (default 44 - BCM SPI2_CE1).
4254 cs0_spidev Set to 'off' to stop the creation of a
4255 userspace device node /dev/spidev2.0 (default
4256 is 'on' or enabled).
4257 cs1_spidev Set to 'off' to stop the creation of a
4258 userspace device node /dev/spidev2.1 (default
4259 is 'on' or enabled).
4263 Info: Enables spi2 on GPIOs 1-3 with two chip select (CS) lines and
4264 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4265 spidev device node creation are configurable. Pi 5 only.
4266 Load: dtoverlay=spi2-2cs-pi5,<param>=<val>
4267 Params: cs0_pin GPIO pin for CS0 (default 0).
4268 cs1_pin GPIO pin for CS1 (default 24).
4269 cs0_spidev Set to 'off' to stop the creation of a
4270 userspace device node /dev/spidev2.0 (default
4271 is 'on' or enabled).
4272 cs1_spidev Set to 'off' to stop the creation of a
4273 userspace device node /dev/spidev2.1 (default
4274 is 'on' or enabled).
4278 Info: Enables spi2 on GPIOs 40-42 with three chip select (CS) lines and
4279 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4280 spidev device node creation are configurable.
4281 N.B.: spi2 is only accessible with the Compute Module or Pi 5.
4282 Load: dtoverlay=spi2-3cs,<param>=<val>
4283 Params: cs0_pin GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
4284 cs1_pin GPIO pin for CS1 (default 44 - BCM SPI2_CE1).
4285 cs2_pin GPIO pin for CS2 (default 45 - BCM SPI2_CE2).
4286 cs0_spidev Set to 'off' to stop the creation of a
4287 userspace device node /dev/spidev2.0 (default
4288 is 'on' or enabled).
4289 cs1_spidev Set to 'off' to stop the creation of a
4290 userspace device node /dev/spidev2.1 (default
4291 is 'on' or enabled).
4292 cs2_spidev Set to 'off' to stop the creation of a
4293 userspace device node /dev/spidev2.2 (default
4294 is 'on' or enabled).
4298 Info: Enables spi3 on GPIOs 1-3 with a single chip select (CS) line and
4299 associated spidev dev node. The gpio pin number for the CS line and
4300 spidev device node creation are configurable. BCM2711 only,
4301 spi3-1cs-pi5 is substituted on Pi 5.
4302 Load: dtoverlay=spi3-1cs,<param>=<val>
4303 Params: cs0_pin GPIO pin for CS0 (default 0 - BCM SPI3_CE0).
4304 cs0_spidev Set to 'off' to prevent the creation of a
4305 userspace device node /dev/spidev3.0 (default
4306 is 'on' or enabled).
4310 Info: Enables spi3 on GPIOs 5-7 with a single chip select (CS) line and
4311 associated spidev dev node. The gpio pin number for the CS line and
4312 spidev device node creation are configurable. Pi 5 only.
4313 Load: dtoverlay=spi3-1cs-pi5,<param>=<val>
4314 Params: cs0_pin GPIO pin for CS0 (default 4).
4315 cs0_spidev Set to 'off' to prevent the creation of a
4316 userspace device node /dev/spidev3.0 (default
4317 is 'on' or enabled).
4321 Info: Enables spi3 on GPIO2 1-3 with two chip select (CS) lines and
4322 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4323 spidev device node creation are configurable. BCM2711 only,
4324 spi3-2cs-pi5 is substituted on Pi 5.
4325 Load: dtoverlay=spi3-2cs,<param>=<val>
4326 Params: cs0_pin GPIO pin for CS0 (default 0 - BCM SPI3_CE0).
4327 cs1_pin GPIO pin for CS1 (default 24 - BCM SPI3_CE1).
4328 cs0_spidev Set to 'off' to prevent the creation of a
4329 userspace device node /dev/spidev3.0 (default
4330 is 'on' or enabled).
4331 cs1_spidev Set to 'off' to prevent the creation of a
4332 userspace device node /dev/spidev3.1 (default
4333 is 'on' or enabled).
4337 Info: Enables spi3 on GPIOs 5-7 with two chip select (CS) lines and
4338 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4339 spidev device node creation are configurable. Pi 5 only.
4340 Load: dtoverlay=spi3-2cs-pi5,<param>=<val>
4341 Params: cs0_pin GPIO pin for CS0 (default 4).
4342 cs1_pin GPIO pin for CS1 (default 25).
4343 cs0_spidev Set to 'off' to prevent the creation of a
4344 userspace device node /dev/spidev3.0 (default
4345 is 'on' or enabled).
4346 cs1_spidev Set to 'off' to prevent the creation of a
4347 userspace device node /dev/spidev3.1 (default
4348 is 'on' or enabled).
4352 Info: Enables spi4 on GPIOs 5-7 with a single chip select (CS) line and
4353 associated spidev dev node. The gpio pin number for the CS line and
4354 spidev device node creation are configurable. BCM2711 only.
4355 Load: dtoverlay=spi4-1cs,<param>=<val>
4356 Params: cs0_pin GPIO pin for CS0 (default 4 - BCM SPI4_CE0).
4357 cs0_spidev Set to 'off' to prevent the creation of a
4358 userspace device node /dev/spidev4.0 (default
4359 is 'on' or enabled).
4363 Info: Enables spi4 on GPIOs 5-6 with two chip select (CS) lines and
4364 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4365 spidev device node creation are configurable. BCM2711 only.
4366 Load: dtoverlay=spi4-2cs,<param>=<val>
4367 Params: cs0_pin GPIO pin for CS0 (default 4 - BCM SPI4_CE0).
4368 cs1_pin GPIO pin for CS1 (default 25 - BCM SPI4_CE1).
4369 cs0_spidev Set to 'off' to prevent the creation of a
4370 userspace device node /dev/spidev4.0 (default
4371 is 'on' or enabled).
4372 cs1_spidev Set to 'off' to prevent the creation of a
4373 userspace device node /dev/spidev4.1 (default
4374 is 'on' or enabled).
4378 Info: Enables spi5 on GPIOs 13-15 with a single chip select (CS) line and
4379 associated spidev dev node. The gpio pin numbers for the CS lines and
4380 spidev device node creation are configurable. BCM2711 and Pi 5.
4381 Load: dtoverlay=spi5-1cs,<param>=<val>
4382 Params: cs0_pin GPIO pin for CS0 (default 12).
4383 cs0_spidev Set to 'off' to prevent the creation of a
4384 userspace device node /dev/spidev5.0 (default
4385 is 'on' or enabled).
4393 Info: Enables spi5 on GPIOs 13-15 with two chip select (CS) lines and
4394 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4395 spidev device node creation are configurable. BCM2711 and Pi 5.
4396 Load: dtoverlay=spi5-2cs,<param>=<val>
4397 Params: cs0_pin GPIO pin for CS0 (default 12).
4398 cs1_pin GPIO pin for CS1 (default 26).
4399 cs0_spidev Set to 'off' to prevent the creation of a
4400 userspace device node /dev/spidev5.0 (default
4401 is 'on' or enabled).
4402 cs1_spidev Set to 'off' to prevent the creation of a
4403 userspace device node /dev/spidev5.1 (default
4404 is 'on' or enabled).
4412 Info: Enables spi6 with a single chip select (CS) line and associated spidev
4413 dev node. The gpio pin number for the CS line and spidev device node
4414 creation are configurable. BCM2711 only.
4415 Load: dtoverlay=spi6-1cs,<param>=<val>
4416 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI6_CE0).
4417 cs0_spidev Set to 'off' to prevent the creation of a
4418 userspace device node /dev/spidev6.0 (default
4419 is 'on' or enabled).
4423 Info: Enables spi6 with two chip select (CS) lines and associated spidev
4424 dev nodes. The gpio pin numbers for the CS lines and spidev device node
4425 creation are configurable. BCM2711 only.
4426 Load: dtoverlay=spi6-2cs,<param>=<val>
4427 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI6_CE0).
4428 cs1_pin GPIO pin for CS1 (default 27 - BCM SPI6_CE1).
4429 cs0_spidev Set to 'off' to prevent the creation of a
4430 userspace device node /dev/spidev6.0 (default
4431 is 'on' or enabled).
4432 cs1_spidev Set to 'off' to prevent the creation of a
4433 userspace device node /dev/spidev6.1 (default
4434 is 'on' or enabled).
4438 Info: Overlay for activation of SSD1306 over I2C OLED display framebuffer.
4439 Load: dtoverlay=ssd1306,<param>=<val>
4440 Params: address Location in display memory of first character.
4442 width Width of display. (default=128)
4443 height Height of display. (default=64)
4444 offset virtual channel a. (default=0)
4445 normal Has no effect on displays tested. (default=not
4447 sequential Set this if every other scan line is missing.
4449 remapped Set this if display is garbled. (default=not
4451 inverted Set this if display is inverted and mirrored.
4455 Typical usage for 128x64 display: dtoverlay=ssd1306,inverted
4457 Typical usage for 128x32 display: dtoverlay=ssd1306,inverted,sequential
4459 i2c_baudrate=400000 will speed up the display.
4461 i2c_baudrate=1000000 seems to work even though it's not officially
4462 supported by the hardware, and is faster still.
4464 For more information refer to the device datasheet at:
4465 https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf
4469 Info: Overlay for SSD1306 OLED via SPI using fbtft staging driver.
4470 Load: dtoverlay=ssd1306-spi,<param>=<val>
4471 Params: speed SPI bus speed (default 10000000)
4472 rotate Display rotation (0, 90, 180 or 270; default 0)
4473 fps Delay between frame updates (default 25)
4474 debug Debug output level (0-7; default 0)
4475 dc_pin GPIO pin for D/C (default 24)
4476 reset_pin GPIO pin for RESET (default 25)
4477 height Display height (32 or 64; default 64)
4478 inverted Set this if display is inverted and mirrored.
4483 Info: Overlay for SSD1331 OLED via SPI using fbtft staging driver.
4484 Load: dtoverlay=ssd1331-spi,<param>=<val>
4485 Params: speed SPI bus speed (default 4500000)
4486 rotate Display rotation (0, 90, 180 or 270; default 0)
4487 fps Delay between frame updates (default 25)
4488 debug Debug output level (0-7; default 0)
4489 dc_pin GPIO pin for D/C (default 24)
4490 reset_pin GPIO pin for RESET (default 25)
4494 Info: Overlay for SSD1351 OLED via SPI using fbtft staging driver.
4495 Load: dtoverlay=ssd1351-spi,<param>=<val>
4496 Params: speed SPI bus speed (default 4500000)
4497 rotate Display rotation (0, 90, 180 or 270; default 0)
4498 fps Delay between frame updates (default 25)
4499 debug Debug output level (0-7; default 0)
4500 dc_pin GPIO pin for D/C (default 24)
4501 reset_pin GPIO pin for RESET (default 25)
4504 Name: superaudioboard
4505 Info: Configures the SuperAudioBoard sound card
4506 Load: dtoverlay=superaudioboard,<param>=<val>
4507 Params: gpiopin GPIO pin for codec reset
4511 Info: Configures the Semtech SX150X I2C GPIO expanders.
4512 Load: dtoverlay=sx150x,<param>=<val>
4513 Params: sx150<x>-<n>-<m> Enables SX150X device on I2C#<n> with slave
4514 address <m>. <x> may be 1-9. <n> may be 0 or 1.
4515 Permissible values of <m> (which is denoted in
4516 hex) depend on the device variant. For SX1501,
4517 SX1502, SX1504 and SX1505, <m> may be 20 or 21.
4518 For SX1503 and SX1506, <m> may be 20. For
4519 SX1507 and SX1509, <m> may be 3E, 3F, 70 or 71.
4520 For SX1508, <m> may be 20, 21, 22 or 23.
4522 sx150<x>-<n>-<m>-int-gpio
4523 Integer, enables interrupts on SX150X device on
4524 I2C#<n> with slave address <m>, specifies
4525 the GPIO pin to which NINT output of SX150X is
4530 Info: Toshiba TC358743 HDMI to CSI-2 bridge chip.
4531 Uses Unicam 1, which is the standard camera connector on most Pi
4533 Load: dtoverlay=tc358743,<param>=<val>
4534 Params: 4lane Use 4 lanes (only applicable to Compute Modules
4537 link-frequency Set the link frequency. Only values of 297000000
4538 (574Mbit/s) and 486000000 (972Mbit/s - default)
4539 are supported by the driver.
4540 media-controller Configure use of Media Controller API for
4541 configuring the sensor (default off)
4542 cam0 Adopt the default configuration for CAM0 on a
4543 Compute Module (CSI0, i2c_vc, and cam0_reg).
4546 Name: tc358743-audio
4547 Info: Used in combination with the tc358743-fast overlay to route the audio
4548 from the TC358743 over I2S to the Pi.
4549 Wiring is LRCK/WFS to GPIO 19, BCK/SCK to GPIO 18, and DATA/SD to GPIO
4551 Load: dtoverlay=tc358743-audio,<param>=<val>
4552 Params: card-name Override the default, "tc358743", card name.
4556 Info: 3.5" Color TFT Display by www.tinylcd.com
4557 Options: Touch, RTC, keypad
4558 Load: dtoverlay=tinylcd35,<param>=<val>
4559 Params: speed Display SPI bus speed
4561 rotate Display rotation {0,90,180,270}
4563 fps Delay between frame updates
4565 debug Debug output level {0-7}
4567 touch Enable touch panel
4569 touchgpio Touch controller IRQ GPIO
4571 xohms Touchpanel: Resistance of X-plate in ohms
4573 rtc-pcf PCF8563 Real Time Clock
4575 rtc-ds DS1307 Real Time Clock
4577 keypad Enable keypad
4580 Display with touchpanel, PCF8563 RTC and keypad:
4581 dtoverlay=tinylcd35,touch,rtc-pcf,keypad
4583 dtoverlay=tinylcd35,touch,touchgpio=3
4587 Info: Enables support for Infineon SLB9670 Trusted Platform Module add-on
4588 boards, which can be used as a secure key storage and hwrng,
4589 available as "Iridium SLB9670" by Infineon and "LetsTrust TPM" by pi3g.
4590 Load: dtoverlay=tpm-slb9670
4595 Info: Enables support for Infineon SLB9673 Trusted Platform Module add-on
4596 boards, which can be used as a secure key storage and hwrng
4597 via the I2C protocol.
4598 Load: dtoverlay=tpm-slb9673
4603 Info: Change the pin usage of uart0
4604 Load: dtoverlay=uart0,<param>=<val>
4605 Params: txd0_pin GPIO pin for TXD0 (14, 32 or 36 - default 14)
4607 rxd0_pin GPIO pin for RXD0 (15, 33 or 37 - default 15)
4609 pin_func Alternative pin function - 4(Alt0) for 14&15,
4610 7(Alt3) for 32&33, 6(Alt2) for 36&37
4614 Info: Enable uart 0 on GPIOs 14-15. Pi 5 only.
4615 Load: dtoverlay=uart0-pi5,<param>
4616 Params: ctsrts Enable CTS/RTS on GPIOs 16-17 (default off)
4620 Info: Change the pin usage of uart1
4621 Load: dtoverlay=uart1,<param>=<val>
4622 Params: txd1_pin GPIO pin for TXD1 (14, 32 or 40 - default 14)
4624 rxd1_pin GPIO pin for RXD1 (15, 33 or 41 - default 15)
4628 Info: Enable uart 1 on GPIOs 0-1. Pi 5 only.
4629 Load: dtoverlay=uart1-pi5,<param>
4630 Params: ctsrts Enable CTS/RTS on GPIOs 2-3 (default off)
4634 Info: Enable uart 2 on GPIOs 0-3. BCM2711 only.
4635 Load: dtoverlay=uart2,<param>
4636 Params: ctsrts Enable CTS/RTS on GPIOs 2-3 (default off)
4640 Info: Enable uart 2 on GPIOs 4-5. Pi 5 only.
4641 Load: dtoverlay=uart2-pi5,<param>
4642 Params: ctsrts Enable CTS/RTS on GPIOs 6-7 (default off)
4646 Info: Enable uart 3 on GPIOs 4-7. BCM2711 only.
4647 Load: dtoverlay=uart3,<param>
4648 Params: ctsrts Enable CTS/RTS on GPIOs 6-7 (default off)
4652 Info: Enable uart 3 on GPIOs 8-9. Pi 5 only.
4653 Load: dtoverlay=uart3-pi5,<param>
4654 Params: ctsrts Enable CTS/RTS on GPIOs 10-11 (default off)
4658 Info: Enable uart 4 on GPIOs 8-11. BCM2711 only.
4659 Load: dtoverlay=uart4,<param>
4660 Params: ctsrts Enable CTS/RTS on GPIOs 10-11 (default off)
4664 Info: Enable uart 4 on GPIOs 12-13. Pi 5 only.
4665 Load: dtoverlay=uart4-pi5,<param>
4666 Params: ctsrts Enable CTS/RTS on GPIOs 14-15 (default off)
4670 Info: Enable uart 5 on GPIOs 12-15. BCM2711 only.
4671 Load: dtoverlay=uart5,<param>
4672 Params: ctsrts Enable CTS/RTS on GPIOs 14-15 (default off)
4676 Info: Configures the NW Digital Radio UDRC Hat
4677 Load: dtoverlay=udrc,<param>=<val>
4678 Params: alsaname Name of the ALSA audio device (default "udrc")
4681 Name: ugreen-dabboard
4682 Info: Configures the ugreen-dabboard I2S overlay
4683 This is a simple overlay based on the simple-audio-card and the dmic
4684 codec. It has the speciality that it is configured to use the codec
4685 as a master I2S device. It works for example with the Si468x DAB
4686 receiver on the uGreen DABBoard.
4687 Load: dtoverlay=ugreen-dabboard,<param>=<val>
4688 Params: card-name Override the default, "dabboard", card name.
4692 Info: Allow usage of downstream .dtb with upstream kernel. Comprises the
4693 vc4-kms-v3d and dwc2 overlays.
4694 Load: dtoverlay=upstream
4698 Name: upstream-aux-interrupt
4699 Info: This overlay has been deprecated and removed because it is no longer
4705 Info: Allow usage of downstream .dtb with upstream kernel on Pi 4. Comprises
4706 the vc4-kms-v3d-pi4 and dwc2 overlays.
4707 Load: dtoverlay=upstream-pi4
4712 Info: Enable Eric Anholt's DRM VC4 V3D driver on top of the dispmanx
4714 Load: dtoverlay=vc4-fkms-v3d,<param>
4715 Params: cma-512 CMA is 512MB (needs 1GB)
4716 cma-448 CMA is 448MB (needs 1GB)
4717 cma-384 CMA is 384MB (needs 1GB)
4718 cma-320 CMA is 320MB (needs 1GB)
4719 cma-256 CMA is 256MB (needs 1GB)
4720 cma-192 CMA is 192MB (needs 1GB)
4721 cma-128 CMA is 128MB
4724 cma-size CMA size in bytes, 4MB aligned
4725 cma-default Use upstream's default value
4728 Name: vc4-fkms-v3d-pi4
4729 Info: Enable Eric Anholt's DRM VC4 V3D driver on top of the dispmanx
4731 Load: dtoverlay=vc4-fkms-v3d-pi4,<param>
4732 Params: cma-512 CMA is 512MB (needs 1GB)
4733 cma-448 CMA is 448MB (needs 1GB)
4734 cma-384 CMA is 384MB (needs 1GB)
4735 cma-320 CMA is 320MB (needs 1GB)
4736 cma-256 CMA is 256MB (needs 1GB)
4737 cma-192 CMA is 192MB (needs 1GB)
4738 cma-128 CMA is 128MB
4741 cma-size CMA size in bytes, 4MB aligned
4742 cma-default Use upstream's default value
4745 Name: vc4-kms-dpi-at056tn53v1
4746 Info: This overlay is now deprecated - see vc4-kms-dpi-panel,at056tn53v1
4750 Name: vc4-kms-dpi-generic
4751 Info: Enable a generic DPI display under KMS. Default timings are for the
4752 Adafruit Kippah with 800x480 panel and RGB666 (GPIOs 0-21)
4753 Requires vc4-kms-v3d to be loaded.
4754 Load: dtoverlay=vc4-kms-dpi-generic,<param>=<val>
4755 Params: clock-frequency Display clock frequency (Hz)
4756 hactive Horizontal active pixels
4757 hfp Horizontal front porch
4758 hsync Horizontal sync pulse width
4759 hbp Horizontal back porch
4760 vactive Vertical active lines
4761 vfp Vertical front porch
4762 vsync Vertical sync pulse width
4763 vbp Vertical back porch
4764 hsync-invert Horizontal sync active low
4765 vsync-invert Vertical sync active low
4766 de-invert Data Enable active low
4767 pixclk-invert Negative edge pixel clock
4768 width-mm Define the screen width in mm
4769 height-mm Define the screen height in mm
4770 rgb565 Change to RGB565 output on GPIOs 0-19
4771 rgb565-padhi Change to RGB565 output on GPIOs 0-8, 12-17, and
4773 bgr666 Change to BGR666 output on GPIOs 0-21.
4774 bgr666-padhi Change to BGR666 output on GPIOs 0-9, 12-17, and
4776 rgb666-padhi Change to RGB666 output on GPIOs 0-9, 12-17, and
4778 bgr888 Change to BGR888 output on GPIOs 0-27
4779 rgb888 Change to RGB888 output on GPIOs 0-27
4780 bus-format Override the bus format for a MEDIA_BUS_FMT_*
4781 value. NB also overridden by rgbXXX overrides.
4782 backlight-gpio Defines a GPIO to be used for backlight control
4784 backlight-pwm Defines a PWM channel to be used for backlight
4785 control (default of none). NB Disables audio
4786 headphone output as that also uses PWM.
4787 backlight-pwm-chan Choose channel on &pwm node for backlight
4790 backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See
4791 pwm-2chan for valid options.
4792 (default 18 - note this can only work with
4794 backlight-pwm-func Pin function of GPIO used for the PWM
4796 See pwm-2chan for valid options.
4798 backlight-def-brightness
4799 Set the default brightness. Normal range 1-16.
4801 rotate Display rotation {0,90,180,270} (default 0)
4804 Name: vc4-kms-dpi-hyperpixel2r
4805 Info: Enable the KMS drivers for the Pimoroni HyperPixel2 Round DPI display.
4806 Requires vc4-kms-v3d to be loaded.
4807 Load: dtoverlay=vc4-kms-dpi-hyperpixel2r,<param>=<val>
4808 Params: disable-touch Disables the touch controller
4809 touchscreen-inverted-x Inverts X direction of touch controller
4810 touchscreen-inverted-y Inverts Y direction of touch controller
4811 touchscreen-swapped-x-y Swaps X & Y axes of touch controller
4812 rotate Display rotation {0,90,180,270} (default 0)
4815 Name: vc4-kms-dpi-hyperpixel4
4816 Info: Enable the KMS drivers for the Pimoroni HyperPixel4 DPI display.
4817 Requires vc4-kms-v3d to be loaded.
4818 Load: dtoverlay=vc4-kms-dpi-hyperpixel4,<param>=<val>
4819 Params: disable-touch Disables the touch controller
4820 touchscreen-inverted-x Inverts X direction of touch controller
4821 touchscreen-inverted-y Inverts Y direction of touch controller
4822 touchscreen-swapped-x-y Swaps X & Y axes of touch controller
4823 rotate Display rotation {0,90,180,270} (default 0)
4826 Name: vc4-kms-dpi-hyperpixel4sq
4827 Info: Enable the KMS drivers for the Pimoroni HyperPixel4 Square DPI display.
4828 Requires vc4-kms-v3d to be loaded.
4829 Load: dtoverlay=vc4-kms-dpi-hyperpixel4sq,<param>=<val>
4830 Params: disable-touch Disables the touch controller
4831 touchscreen-inverted-x Inverts X direction of touch controller
4832 touchscreen-inverted-y Inverts Y direction of touch controller
4833 touchscreen-swapped-x-y Swaps X & Y axes of touch controller
4834 rotate Display rotation {0,90,180,270} (default 0)
4837 Name: vc4-kms-dpi-panel
4838 Info: Enable a preconfigured KMS DPI panel.
4839 Requires vc4-kms-v3d to be loaded.
4840 Load: dtoverlay=vc4-kms-dpi-panel,<param>=<val>
4841 Params: at056tn53v1 Enable an Innolux 5.6in VGA TFT
4842 kippah-7inch Enable an Adafruit Kippah with 7inch panel.
4843 mzp280 Enable a Geekworm MZP280 panel.
4844 backlight-gpio Defines a GPIO to be used for backlight control
4846 backlight-pwm Defines a PWM channel to be used for backlight
4847 control (default of none). NB Disables audio
4848 headphone output as that also uses PWM.
4849 backlight-pwm-chan Choose channel on &pwm node for backlight
4852 backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See
4853 pwm-2chan for valid options.
4854 (default 18 - note this can only work with
4856 backlight-pwm-func Pin function of GPIO used for the PWM
4858 See pwm-2chan for valid options.
4860 backlight-def-brightness
4861 Set the default brightness. Normal range 1-16.
4863 rotate Display rotation {0,90,180,270} (default 0)
4866 Name: vc4-kms-dsi-7inch
4867 Info: Enable the Raspberry Pi DSI 7" screen.
4868 Includes the edt-ft5406 for the touchscreen element.
4869 Requires vc4-kms-v3d to be loaded.
4870 Load: dtoverlay=vc4-kms-dsi-7inch,<param>=<val>
4871 Params: sizex Touchscreen size x (default 800)
4872 sizey Touchscreen size y (default 480)
4873 invx Touchscreen inverted x axis
4874 invy Touchscreen inverted y axis
4875 swapxy Touchscreen swapped x y axis
4876 disable_touch Disables the touch screen overlay driver
4877 dsi0 Use DSI0 and i2c_csi_dsi0 (rather than
4878 the default DSI1 and i2c_csi_dsi).
4881 Name: vc4-kms-dsi-generic
4882 Info: Enable a generic DSI display under KMS.
4883 Default timings are for a 840x480 RGB888 panel.
4884 Requires vc4-kms-v3d to be loaded.
4885 Load: dtoverlay=vc4-kms-dsi-generic,<param>=<val>
4886 Params: clock-frequency Display clock frequency (Hz)
4887 hactive Horizontal active pixels
4888 hfp Horizontal front porch
4889 hsync Horizontal sync pulse width
4890 hbp Horizontal back porch
4891 vactive Vertical active lines
4892 vfp Vertical front porch
4893 vsync Vertical sync pulse width
4894 vbp Vertical back porch
4895 width-mm Define the screen width in mm
4896 height-mm Define the screen height in mm
4897 rgb565 Change to RGB565 output
4898 rgb666 Change to RGB666 output
4899 rgb666p Change to RGB666 output with pixel packing
4900 rgb888 Change to RGB888 output, this is the default
4901 one-lane Use one DSI lane for data transmission
4903 two-lane Use two DSI lanes for data transmission
4904 three-lane Use three DSI lanes for data transmission
4905 Only supported on Pi5 and CM
4906 four-lane Use four DSI lanes for data transmission
4907 Only supported on Pi5 and CM
4908 dsi0 Switch DSI port to DSI0
4909 Only supported on Pi5 and CM
4912 Name: vc4-kms-dsi-lt070me05000
4913 Info: Enable a JDI LT070ME05000 DSI display on DSI1.
4914 Note that this is a 4 lane DSI device, so it will only work on a Compute
4916 Requires vc4-kms-v3d to be loaded.
4917 Load: dtoverlay=vc4-kms-dsi-lt070me05000,<param>
4918 Params: reset GPIO for the reset signal (default 17)
4919 enable GPIO for the enable signal (default 4)
4920 dcdc-en GPIO for the DC-DC converter enable (default 5)
4923 Name: vc4-kms-dsi-lt070me05000-v2
4924 Info: Enable a JDI LT070ME05000 DSI display on DSI1 using Harlab's V2
4926 Note that this is a 4 lane DSI device, so it will only work on a Compute
4928 Requires vc4-kms-v3d to be loaded.
4929 Load: dtoverlay=vc4-kms-dsi-lt070me05000-v2
4933 Name: vc4-kms-dsi-waveshare-panel
4934 Info: Enable a Waveshare DSI touchscreen
4935 Includes the Goodix driver for the touchscreen element.
4936 The default is for the display to be using the I2C0 option for control.
4937 Use the i2c1 override if using the I2C1 wiring with jumper wires from
4938 GPIOs 2&3 (pins 3&5).
4939 invx/invy/swapxy should be used with caution as the panel specifier will
4940 set the default inversions for that panel. Always use them after the
4941 panel specifier, and be aware that you may need to set them as =0, not
4943 Requires vc4-kms-v3d to be loaded.
4944 Load: dtoverlay=vc4-kms-dsi-waveshare-panel,<param>=<val>
4945 Params: 2_8_inch 2.8" 480x640
4946 3_4_inch 3.4" 800x800 round
4947 4_0_inch 4.0" 480x800
4948 7_0_inchC 7.0" C 1024x600
4949 7_9_inch 7.9" 400x1280
4950 8_0_inch 8.0" 1280x800
4951 10_1_inch 10.1" 1280x800
4952 11_9_inch 11.9" 320x1480
4953 i2c1 Use i2c-1 with jumper wires from GPIOs 2&3
4954 disable_touch Disable the touch controller
4955 rotation Set the panel orientation property
4956 invx Touchscreen inverted x axis
4957 invy Touchscreen inverted y axis
4958 swapxy Touchscreen swapped x y axis
4959 dsi0 Use DSI0 and i2c_csi_dsi0 (rather than
4960 the default DSI1 and i2c_csi_dsi).
4963 Name: vc4-kms-kippah-7inch
4964 Info: This overlay is now deprecated - see vc4-kms-dpi-panel,kippah-7inch
4969 Info: Enable Eric Anholt's DRM VC4 HDMI/HVS/V3D driver.
4970 Load: dtoverlay=vc4-kms-v3d,<param>
4971 Params: cma-512 CMA is 512MB (needs 1GB)
4972 cma-448 CMA is 448MB (needs 1GB)
4973 cma-384 CMA is 384MB (needs 1GB)
4974 cma-320 CMA is 320MB (needs 1GB)
4975 cma-256 CMA is 256MB (needs 1GB)
4976 cma-192 CMA is 192MB (needs 1GB)
4977 cma-128 CMA is 128MB
4980 cma-size CMA size in bytes, 4MB aligned
4981 cma-default Use upstream's default value
4982 audio Enable or disable audio over HDMI (default "on")
4983 noaudio Disable all HDMI audio (default "off")
4984 composite Enable the composite output (default "off")
4985 N.B. Disables all other outputs on a Pi 4.
4986 nohdmi Disable HDMI output
4989 Name: vc4-kms-v3d-pi4
4990 Info: Enable Eric Anholt's DRM VC4 HDMI/HVS/V3D driver for Pi4.
4991 Load: dtoverlay=vc4-kms-v3d-pi4,<param>
4992 Params: cma-512 CMA is 512MB
4993 cma-448 CMA is 448MB
4994 cma-384 CMA is 384MB
4995 cma-320 CMA is 320MB
4996 cma-256 CMA is 256MB
4997 cma-192 CMA is 192MB
4998 cma-128 CMA is 128MB
5001 cma-size CMA size in bytes, 4MB aligned
5002 cma-default Use upstream's default value
5003 audio Enable or disable audio over HDMI0 (default
5005 audio1 Enable or disable audio over HDMI1 (default
5007 noaudio Disable all HDMI audio (default "off")
5008 composite Enable the composite output (disables all other
5010 nohdmi Disable both HDMI 0 & 1 outputs
5011 nohdmi0 Disable HDMI 0 output
5012 nohdmi1 Disable HDMI 1 output
5015 Name: vc4-kms-v3d-pi5
5016 Info: See vc4-kms-v3d-pi4 (this is the Pi 5 version)
5019 Name: vc4-kms-vga666
5020 Info: Enable the VGA666 (resistor ladder ADC) for the vc4-kms-v3d driver.
5021 Requires vc4-kms-v3d to be loaded.
5022 Load: dtoverlay=vc4-kms-vga666,<param>
5023 Params: ddc Enables GPIOs 0&1 as the I2C to read the EDID
5024 from the display. NB These are NOT 5V tolerant
5025 GPIOs, therefore level shifters are required.
5029 Info: Overlay for the Fen Logic VGA666 board
5030 This uses GPIOs 2-21 (so no I2C), and activates the output 2-3 seconds
5031 after the kernel has started.
5032 NOT for use with vc4-kms-v3d.
5033 Load: dtoverlay=vga666
5038 Info: Overlay to enable a VIA VL805 USB3 controller on CM4 carriers
5039 Will be loaded automatically by up-to-date firmware if "VL805=1" is
5040 set in the EEPROM config.
5041 Load: dtoverlay=vl805
5046 Info: Configures the w1-gpio Onewire interface module.
5047 Use this overlay if you *don't* need a GPIO to drive an external pullup.
5048 Load: dtoverlay=w1-gpio,<param>=<val>
5049 Params: gpiopin GPIO for I/O (default "4")
5050 pullup Now enabled by default (ignored)
5054 Info: See w1-gpio (this is the Pi 5 version)
5057 Name: w1-gpio-pullup
5058 Info: Configures the w1-gpio Onewire interface module.
5059 Use this overlay if you *do* need a GPIO to drive an external pullup.
5060 Load: dtoverlay=w1-gpio-pullup,<param>=<val>
5061 Params: gpiopin GPIO for I/O (default "4")
5062 extpullup GPIO for external pullup (default "5")
5063 pullup Now enabled by default (ignored)
5066 Name: w1-gpio-pullup-pi5
5067 Info: See w1-gpio-pullup (this is the Pi 5 version)
5071 Info: Overlay for the Wiznet W5500 Ethernet Controller on SPI0
5072 Load: dtoverlay=w5500,<param>=<val>
5073 Params: int_pin GPIO used for INT (default 25)
5075 speed SPI bus speed (default 30000000)
5077 cs SPI bus Chip Select (default 0)
5080 Name: watterott-display
5081 Info: Watterott RPi-Display - 2.8" Touch Display
5082 Linux has 2 drivers that support this display and this overlay supports
5086 fbtft/fb_ili9341: dtoverlay=watterott-display
5087 drm/mi0283qt: dtoverlay=watterott-display,drm,backlight-pwm,rotate=180
5089 Some notable differences with the DRM driver compared to fbtft:
5090 - The display is turned on when it's first used and not on driver load
5091 as with fbtft. So if nothing uses the display it stays off.
5092 - Can run with a higher SPI clock increasing framerate. This is possible
5093 since the driver avoids messing up the controller configuration due to
5094 transmission errors by running config commands at 10MHz and only pixel
5095 data at full speed (occasional pixel glitch might occur).
5096 - PWM backlight is supported.
5098 Load: dtoverlay=watterott-display,<param>=<val>
5099 Params: speed Display SPI bus speed
5100 rotate Display rotation {0,90,180,270}
5101 fps Delay between frame updates (fbtft only)
5102 debug Debug output level {0-7} (fbtft only)
5103 xohms Touchpanel sensitivity (X-plate resistance)
5104 swapxy Swap x and y axis
5105 backlight Change backlight GPIO pin {e.g. 12, 18}
5107 drm Use DRM/KMS driver mi0283qt instead of fbtft.
5108 Set the SPI clock to 70MHz.
5109 This has to be the first parameter.
5110 backlight-pwm Use pwm for backlight (drm only). NB: Disables
5111 audio headphone output as that also uses PWM.
5114 Name: waveshare-can-fd-hat-mode-a
5115 Info: Overlay for the Waveshare 2-Channel Isolated CAN FD Expansion HAT
5116 for Raspberry Pi, Multi Protections. Use this overlay when the
5117 HAT is configured in Mode A (Default), with can0 on spi0.0
5119 https://www.waveshare.com/2-ch-can-fd-hat.htm
5120 Load: dtoverlay=waveshare-can-fd-hat-mode-a
5124 Name: waveshare-can-fd-hat-mode-b
5125 Info: Overlay for the Waveshare 2-Channel Isolated CAN FD Expansion HAT
5126 for Raspberry Pi, Multi Protections. Use this overlay when the
5127 HAT is configured in Mode B (requires hardware modification), with
5128 can0 on spi0.0 and can1 on spi0.1.
5129 https://www.waveshare.com/2-ch-can-fd-hat.htm
5130 Load: dtoverlay=waveshare-can-fd-hat-mode-b
5135 Info: Configures the wittypi RTC module.
5136 Load: dtoverlay=wittypi,<param>=<val>
5137 Params: led_gpio GPIO for LED (default "17")
5138 led_trigger Choose which activity the LED tracks (default
5142 Name: wm8960-soundcard
5143 Info: Overlay for the Waveshare wm8960 soundcard
5144 Load: dtoverlay=wm8960-soundcard,<param>=<val>
5145 Params: alsaname Changes the card name in ALSA
5146 compatible Changes the codec compatibility
5152 If you are experiencing problems that you think are DT-related, enable DT
5153 diagnostic output by adding this to /boot/config.txt:
5157 and rebooting. Then run:
5161 and look for relevant messages.
5166 This is only meant to be a quick introduction to the subject of Device Tree on
5167 Raspberry Pi. There is a more complete explanation here:
5169 http://www.raspberrypi.org/documentation/configuration/device-tree.md