4 This directory contains Device Tree overlays. Device Tree makes it possible
5 to support many hardware configurations with a single kernel and without the
6 need to explicitly load or blacklist kernel modules. Note that this isn't a
7 "pure" Device Tree configuration (c.f. MACH_BCM2835) - some on-board devices
8 are still configured by the board support code, but the intention is to
9 eventually reach that goal.
11 On Raspberry Pi, Device Tree usage is controlled from /boot/config.txt. By
12 default, the Raspberry Pi kernel boots with device tree enabled. You can
13 completely disable DT usage (for now) by adding:
17 to your config.txt, which should cause your Pi to revert to the old way of
18 doing things after a reboot.
20 In /boot you will find a .dtb for each base platform. This describes the
21 hardware that is part of the Raspberry Pi board. The loader (start.elf and its
22 siblings) selects the .dtb file appropriate for the platform by name, and reads
23 it into memory. At this point, all of the optional interfaces (i2c, i2s, spi)
24 are disabled, but they can be enabled using Device Tree parameters:
26 dtparam=i2c=on,i2s=on,spi=on
28 However, this shouldn't be necessary in many use cases because loading an
29 overlay that requires one of those interfaces will cause it to be enabled
30 automatically, and it is advisable to only enable interfaces if they are
33 Configuring additional, optional hardware is done using Device Tree overlays
36 GPIO numbering uses the hardware pin numbering scheme (aka BCM scheme) and
37 not the physical pin numbers.
42 The Advanced Options section of the raspi-config utility can enable and disable
43 Device Tree use, as well as toggling the I2C and SPI interfaces. Note that it
44 is possible to both enable an interface and blacklist the driver, if for some
45 reason you should want to defer the loading.
50 As well as describing the hardware, Device Tree also gives enough information
51 to allow suitable driver modules to be located and loaded, with the corollary
52 that unneeded modules are not loaded. As a result it should be possible to
53 remove lines from /etc/modules, and /etc/modprobe.d/raspi-blacklist.conf can
54 have its contents deleted (or commented out).
59 Overlays are loaded using the "dtoverlay" config.txt setting. As an example,
60 consider I2C Real Time Clock drivers. In the pre-DT world these would be loaded
61 by writing a magic string comprising a device identifier and an I2C address to
62 a special file in /sys/class/i2c-adapter, having first loaded the driver for
63 the I2C interface and the RTC device - something like this:
67 echo ds1307 0x68 > /sys/class/i2c-adapter/i2c-1/new_device
69 With DT enabled, this becomes a line in config.txt:
71 dtoverlay=i2c-rtc,ds1307
73 This causes the file /boot/overlays/i2c-rtc.dtbo to be loaded and a "node"
74 describing the DS1307 I2C device to be added to the Device Tree for the Pi. By
75 default it usees address 0x68, but this can be modified with an additional DT
78 dtoverlay=i2c-rtc,ds1307,addr=0x68
80 Parameters usually have default values, although certain parameters are
81 mandatory. See the list of overlays below for a description of the parameters
84 Making new Overlays based on existing Overlays
85 ==============================================
87 Recent overlays have been designed in a more general way, so that they can be
88 adapted to hardware by changing their parameters. When you have additional
89 hardware with more than one device of a kind, you end up using the same overlay
90 multiple times with other parameters, e.g.
92 # 2 CAN FD interfaces on spi but with different pins
93 dtoverlay=mcp251xfd,spi0-0,interrupt=25
94 dtoverlay=mcp251xfd,spi0-1,interrupt=24
96 # a realtime clock on i2c
97 dtoverlay=i2c-rtc,pcf85063
99 While this approach does work, it requires knowledge about the hardware design.
100 It is more feasible to simplify things for the end user by providing a single
101 overlay as it is done the traditional way.
103 A new overlay can be generated by using ovmerge utility.
104 https://github.com/raspberrypi/utils/blob/master/ovmerge/ovmerge
106 To generate an overlay for the above configuration we pass the configuration
107 to ovmerge and add the -c flag.
109 ovmerge -c mcp251xfd-overlay.dts,spi0-0,interrupt=25 \
110 mcp251xfd-overlay.dts,spi0-1,interrupt=24 \
111 i2c-rtc-overlay.dts,pcf85063 \
112 >> merged-overlay.dts
114 The -c option writes the command above as a comment into the overlay as
115 a marker that this overlay is generated and how it was generated.
116 After compiling the overlay it can be loaded in a single line.
120 It does the same as the original configuration but without parameters.
122 The Overlay and Parameter Reference
123 ===================================
125 N.B. When editing this file, please preserve the indentation levels to make it
126 simple to parse programmatically. NO HARD TABS.
130 Info: Configures the base Raspberry Pi hardware
131 Load: <loaded automatically>
133 ant1 Select antenna 1 (default). CM4 only.
135 ant2 Select antenna 2. CM4 only.
137 noant Disable both antennas. CM4 only.
139 audio Set to "on" to enable the onboard ALSA audio
140 interface (default "off")
142 axiperf Set to "on" to enable the AXI bus performance
144 See /sys/kernel/debug/raspberrypi_axi_monitor
147 bdaddr Set an alternative Bluetooth address (BDADDR).
148 The value should be a 6-byte hexadecimal value,
149 with or without colon separators, written least-
150 significant-byte first. For example,
151 bdaddr=06:05:04:03:02:01
152 will set the BDADDR to 01:02:03:04:05:06.
154 button_debounce Set the debounce delay (in ms) on the power/
155 shutdown button (default 50ms)
157 cam0_reg Enables CAM 0 regulator.
158 Only required on CM1 & 3.
160 cam0_reg_gpio Set GPIO for CAM 0 regulator.
161 Default 31 on CM1, 3, and 4S.
162 Default of GPIO expander 5 on CM4, but override
163 switches to normal GPIO.
165 cam1_reg Enables CAM 1 regulator.
166 Only required on CM1 & 3.
168 cam1_reg_gpio Set GPIO for CAM 1 regulator.
169 Default 3 on CM1, 3, and 4S.
170 Default of GPIO expander 5 on CM4, but override
171 switches to normal GPIO.
173 cooling_fan Enables the Pi 5 cooling fan (enabled
174 automatically by the firmware)
176 drm_fb0_rp1_dpi Assign /dev/fb0 to the RP1 DPI output
178 drm_fb0_rp1_dsi0 Assign /dev/fb0 to the RP1 DSI0 output
180 drm_fb0_rp1_dsi1 Assign /dev/fb0 to the RP1 DSI1 output
182 drm_fb0_vc4 Assign /dev/fb0 to the vc4 outputs
184 drm_fb1_rp1_dpi Assign /dev/fb1 to the RP1 DPI output
186 drm_fb1_rp1_dsi0 Assign /dev/fb1 to the RP1 DSI0 output
188 drm_fb1_rp1_dsi1 Assign /dev/fb1 to the RP1 DSI1 output
190 drm_fb1_vc4 Assign /dev/fb1 to the vc4 outputs
192 drm_fb2_rp1_dpi Assign /dev/fb2 to the RP1 DPI output
194 drm_fb2_rp1_dsi0 Assign /dev/fb2 to the RP1 DSI0 output
196 drm_fb2_rp1_dsi1 Assign /dev/fb2 to the RP1 DSI1 output
198 drm_fb2_vc4 Assign /dev/fb2 to the vc4 outputs
200 eee Enable Energy Efficient Ethernet support for
201 compatible devices (default "on"). See also
202 "tx_lpi_timer". Pi3B+ only.
204 eth_downshift_after Set the number of auto-negotiation failures
205 after which the 1000Mbps modes are disabled.
206 Legal values are 2, 3, 4, 5 and 0, where
207 0 means never downshift (default 2). Pi3B+ only.
209 eth_led0 Set mode of LED0 - amber on Pi3B+ (default "1"),
210 green on Pi4 (default "0").
211 The legal values are:
215 0=link/activity 1=link1000/activity
216 2=link100/activity 3=link10/activity
217 4=link100/1000/activity 5=link10/1000/activity
218 6=link10/100/activity 14=off 15=on
222 0=Speed/Activity 1=Speed
223 2=Flash activity 3=FDX
228 eth_led1 Set mode of LED1 - green on Pi3B+ (default "6"),
229 amber on Pi4 (default "8"). See eth_led0 for
232 eth_max_speed Set the maximum speed a link is allowed
233 to negotiate. Legal values are 10, 100 and
234 1000 (default 1000). Pi3B+ only.
236 hdmi Set to "off" to disable the HDMI interface
239 i2c An alias for i2c_arm
241 i2c_arm Set to "on" to enable the ARM's i2c interface
244 i2c_arm_baudrate Set the baudrate of the ARM's i2c interface
247 i2c_baudrate An alias for i2c_arm_baudrate
249 i2c_csi_dsi Set to "on" to enable the i2c_csi_dsi interface
251 i2c_csi_dsi0 Set to "on" to enable the i2c_csi_dsi0 interface
253 i2c_csi_dsi1 Set to "on" to enable the i2c_csi_dsi1 interface
255 i2c_vc Set to "on" to enable the i2c interface
256 usually reserved for the VideoCore processor
259 i2c_vc_baudrate Set the baudrate of the VideoCore i2c interface
262 i2s Set to "on" to enable the i2s interface
265 i2s_dma4 Use to enable 40-bit DMA on the i2s interface
266 (the assigned value doesn't matter)
269 krnbt Set to "off" to disable autoprobing of Bluetooth
270 driver without need of hciattach/btattach
273 krnbt_baudrate Set the baudrate of the PL011 UART when used
276 nvme Alias for "pciex1" (2712 only)
278 pcie Set to "off" to disable the PCIe interface
280 (2711 only, but not applicable on CM4S)
281 N.B. USB-A ports on 4B are subsequently disabled
283 pciex1 Set to "on" to enable the external PCIe link
284 (2712 only, default "off")
286 pciex1_gen Sets the PCIe "GEN"/speed for the external PCIe
287 link (2712 only, default "2")
289 pciex1_no_l0s Set to "on" to disable ASPM L0s on the external
290 PCIe link for devices that have broken
291 implementations (2712 only, default "off")
293 spi Set to "on" to enable the spi interfaces
296 spi_dma4 Use to enable 40-bit DMA on spi interfaces
297 (the assigned value doesn't matter)
300 random Set to "on" to enable the hardware random
301 number generator (default "on")
303 rtc_bbat_vchg Set the RTC backup battery charging voltage in
304 microvolts. If set to 0 or not specified, the
305 trickle charger is disabled.
306 (2712 only, default "0")
308 sd Set to "off" to disable the SD card (or eMMC on
309 non-lite SKU of CM4).
312 sd_overclock Clock (in MHz) to use when the MMC framework
315 sd_poll_once Looks for a card once after booting. Useful
316 for network booting scenarios to avoid the
317 overhead of continuous polling. N.B. Using
318 this option restricts the system to using a
319 single card per boot (or none at all).
322 sd_force_pio Disable DMA support for SD driver (default off)
324 sd_pio_limit Number of blocks above which to use DMA for
327 sd_debug Enable debug output from SD driver (default off)
329 sdio_overclock Clock (in MHz) to use when the MMC framework
330 requests 50MHz for the SDIO/WLAN interface.
332 suspend Make the power button trigger a suspend rather
333 than a power-off (2712 only, default "off")
335 tx_lpi_timer Set the delay in microseconds between going idle
336 and entering the low power state (default 600).
337 Requires EEE to be enabled - see "eee".
339 uart0 Set to "off" to disable uart0 (default "on")
341 uart0_console Move the kernel boot console to UART0 on pins
342 6, 8 and 10 of the 40-way header (2712 only,
345 uart1 Set to "on" or "off" to enable or disable uart1
348 watchdog Set to "on" to enable the hardware watchdog
351 wifiaddr Set an alternative WiFi MAC address.
352 The value should be a 6-byte hexadecimal value,
353 with or without colon separators, written in the
354 natural (big-endian) order.
356 act_led_trigger Choose which activity the LED tracks.
357 Use "heartbeat" for a nice load indicator.
360 act_led_activelow Set to "on" to invert the sense of the LED
362 N.B. For Pi 3B, 3B+, 3A+ and 4B, use the act-led
365 act_led_gpio Set which GPIO to use for the activity LED
366 (in case you want to connect it to an external
368 (default "16" on a non-Plus board, "47" on a
370 N.B. For Pi 3B, 3B+, 3A+ and 4B, use the act-led
376 As for act_led_*, but using the PWR LED.
377 Not available on Model A/B boards.
379 N.B. It is recommended to only enable those interfaces that are needed.
380 Leaving all interfaces enabled can lead to unwanted behaviour (i2c_vc
381 interfering with Pi Camera, I2S and SPI hogging GPIO pins, etc.)
382 Note also that i2c, i2c_arm and i2c_vc are aliases for the physical
383 interfaces i2c0 and i2c1. Use of the numeric variants is still possible
384 but deprecated because the ARM/VC assignments differ between board
385 revisions. The same board-specific mapping applies to i2c_baudrate,
386 and the other i2c baudrate parameters.
390 Info: Pi 3B, 3B+, 3A+ and 4B use a GPIO expander to drive the LEDs which can
391 only be accessed from the VPU. There is a special driver for this with a
392 separate DT node, which has the unfortunate consequence of breaking the
393 act_led_gpio and act_led_activelow dtparams.
394 This overlay changes the GPIO controller back to the standard one and
395 restores the dtparams.
396 Load: dtoverlay=act-led,<param>=<val>
397 Params: activelow Set to "on" to invert the sense of the LED
400 gpio Set which GPIO to use for the activity LED
401 (in case you want to connect it to an external
406 Name: adafruit-st7735r
407 Info: Overlay for the SPI-connected Adafruit 1.8" 160x128 or 128x128 displays,
408 based on the ST7735R chip.
409 This overlay uses the newer DRM/KMS "Tiny" driver.
410 Load: dtoverlay=adafruit-st7735r,<param>=<val>
411 Params: 128x128 Select the 128x128 driver (default 160x128)
412 rotate Display rotation {0,90,180,270} (default 90)
413 speed SPI bus speed in Hz (default 4000000)
414 dc_pin GPIO pin for D/C (default 24)
415 reset_pin GPIO pin for RESET (default 25)
416 led_pin GPIO used to control backlight (default 18)
420 Info: Overlay for the SPI-connected Adafruit 1.8" display (based on the
421 ST7735R chip). It includes support for the "green tab" version.
422 This overlay uses the older fbtft driver.
423 Load: dtoverlay=adafruit18,<param>=<val>
424 Params: green Use the adafruit18_green variant.
425 rotate Display rotation {0,90,180,270}
426 speed SPI bus speed in Hz (default 4000000)
427 fps Display frame rate in Hz
428 bgr Enable BGR mode (default off)
429 debug Debug output level {0-7}
430 dc_pin GPIO pin for D/C (default 24)
431 reset_pin GPIO pin for RESET (default 25)
432 led_pin GPIO used to control backlight (default 18)
436 Info: Overlay for activation of ADAU1977 ADC codec over I2C for control
438 Load: dtoverlay=adau1977-adc
442 Name: adau7002-simple
443 Info: Overlay for the activation of ADAU7002 stereo PDM to I2S converter.
444 Load: dtoverlay=adau7002-simple,<param>=<val>
445 Params: card-name Override the default, "adau7002", card name.
449 Info: Overlay for activation of Texas Instruments ADS1015 ADC over I2C
450 Load: dtoverlay=ads1015,<param>=<val>
451 Params: addr I2C bus address of device. Set based on how the
452 addr pin is wired. (default=0x48 assumes addr
454 cha_enable Enable virtual channel a. (default=true)
455 cha_cfg Set the configuration for virtual channel a.
456 (default=4 configures this channel for the
457 voltage at A0 with respect to GND)
458 cha_datarate Set the datarate (samples/sec) for this channel.
459 (default=4 sets 1600 sps)
460 cha_gain Set the gain of the Programmable Gain
461 Amplifier for this channel. (default=2 sets the
462 full scale of the channel to 2.048 Volts)
464 Channel (ch) parameters can be set for each enabled channel.
465 A maximum of 4 channels can be enabled (letters a thru d).
466 For more information refer to the device datasheet at:
467 http://www.ti.com/lit/ds/symlink/ads1015.pdf
471 Info: Texas Instruments ADS1115 ADC
472 Load: dtoverlay=ads1115,<param>[=<val>]
473 Params: addr I2C bus address of device. Set based on how the
474 addr pin is wired. (default=0x48 assumes addr
476 cha_enable Enable virtual channel a.
477 cha_cfg Set the configuration for virtual channel a.
478 (default=4 configures this channel for the
479 voltage at A0 with respect to GND)
480 cha_datarate Set the datarate (samples/sec) for this channel.
481 (default=7 sets 860 sps)
482 cha_gain Set the gain of the Programmable Gain
483 Amplifier for this channel. (Default 1 sets the
484 full scale of the channel to 4.096 Volts)
486 Channel parameters can be set for each enabled channel.
487 A maximum of 4 channels can be enabled (letters a thru d).
488 For more information refer to the device datasheet at:
489 http://www.ti.com/lit/ds/symlink/ads1115.pdf
493 Info: ADS7846 Touch controller
494 Load: dtoverlay=ads7846,<param>=<val>
495 Params: cs SPI bus Chip Select (default 1)
496 speed SPI bus speed (default 2MHz, max 3.25MHz)
497 penirq GPIO used for PENIRQ. REQUIRED
498 penirq_pull Set GPIO pull (default 0=none, 2=pullup)
499 swapxy Swap x and y axis
500 xmin Minimum value on the X axis (default 0)
501 ymin Minimum value on the Y axis (default 0)
502 xmax Maximum value on the X axis (default 4095)
503 ymax Maximum value on the Y axis (default 4095)
504 pmin Minimum reported pressure value (default 0)
505 pmax Maximum reported pressure value (default 65535)
506 xohms Touchpanel sensitivity (X-plate resistance)
509 penirq is required and usually xohms (60-100) has to be set as well.
510 Apart from that, pmax (255) and swapxy are also common.
511 The rest of the calibration can be done with xinput-calibrator.
512 See: github.com/notro/fbtft/wiki/FBTFT-on-Raspian
513 Device Tree binding document:
514 www.kernel.org/doc/Documentation/devicetree/bindings/input/ads7846.txt
518 Info: Analog Devices ADV7282M analogue video to CSI2 bridge.
519 Uses Unicam1, which is the standard camera connector on most Pi
521 Load: dtoverlay=adv7282m,<param>=<val>
522 Params: addr Overrides the I2C address (default 0x21)
523 media-controller Configure use of Media Controller API for
524 configuring the sensor (default off)
528 Info: Analog Devices ADV728[0|1|2]-M analogue video to CSI2 bridges.
529 This is a wrapper for adv7282m, and defaults to ADV7282M.
530 Load: dtoverlay=adv728x-m,<param>=<val>
531 Params: addr Overrides the I2C address (default 0x21)
532 adv7280m Select ADV7280-M.
533 adv7281m Select ADV7281-M.
534 adv7281ma Select ADV7281-MA.
535 media-controller Configure use of Media Controller API for
536 configuring the sensor (default off)
539 Name: akkordion-iqdacplus
540 Info: Configures the Digital Dreamtime Akkordion Music Player (based on the
541 OEM IQAudIO DAC+ or DAC Zero module).
542 Load: dtoverlay=akkordion-iqdacplus,<param>=<val>
543 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
544 Digital volume control. Enable with
545 dtoverlay=akkordion-iqdacplus,24db_digital_gain
546 (The default behaviour is that the Digital
547 volume control is limited to a maximum of
548 0dB. ie. it can attenuate but not provide
549 gain. For most users, this will be desired
550 as it will prevent clipping. By appending
551 the 24db_digital_gain parameter, the Digital
552 volume control will allow up to 24dB of
553 gain. If this parameter is enabled, it is the
554 responsibility of the user to ensure that
555 the Digital volume control is set to a value
556 that does not result in clipping/distortion!)
559 Name: allo-boss-dac-pcm512x-audio
560 Info: Configures the Allo Boss DAC audio cards.
561 Load: dtoverlay=allo-boss-dac-pcm512x-audio,<param>
562 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
563 Digital volume control. Enable with
564 "dtoverlay=allo-boss-dac-pcm512x-audio,
566 (The default behaviour is that the Digital
567 volume control is limited to a maximum of
568 0dB. ie. it can attenuate but not provide
569 gain. For most users, this will be desired
570 as it will prevent clipping. By appending
571 the 24db_digital_gain parameter, the Digital
572 volume control will allow up to 24dB of
573 gain. If this parameter is enabled, it is the
574 responsibility of the user to ensure that
575 the Digital volume control is set to a value
576 that does not result in clipping/distortion!)
577 slave Force Boss DAC into slave mode, using Pi a
578 master for bit clock and frame clock. Enable
579 with "dtoverlay=allo-boss-dac-pcm512x-audio,
583 Name: allo-boss2-dac-audio
584 Info: Configures the Allo Boss2 DAC audio card
585 Load: dtoverlay=allo-boss2-dac-audio
590 Info: Configures the Allo Digione audio card
591 Load: dtoverlay=allo-digione
595 Name: allo-katana-dac-audio
596 Info: Configures the Allo Katana DAC audio card
597 Load: dtoverlay=allo-katana-dac-audio
601 Name: allo-piano-dac-pcm512x-audio
602 Info: Configures the Allo Piano DAC (2.0/2.1) audio cards.
603 (NB. This initial support is for 2.0 channel audio ONLY! ie. stereo.
604 The subwoofer outputs on the Piano 2.1 are not currently supported!)
605 Load: dtoverlay=allo-piano-dac-pcm512x-audio,<param>
606 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
607 Digital volume control.
608 (The default behaviour is that the Digital
609 volume control is limited to a maximum of
610 0dB. ie. it can attenuate but not provide
611 gain. For most users, this will be desired
612 as it will prevent clipping. By appending
613 the 24db_digital_gain parameter, the Digital
614 volume control will allow up to 24dB of
615 gain. If this parameter is enabled, it is the
616 responsibility of the user to ensure that
617 the Digital volume control is set to a value
618 that does not result in clipping/distortion!)
621 Name: allo-piano-dac-plus-pcm512x-audio
622 Info: Configures the Allo Piano DAC (2.1) audio cards.
623 Load: dtoverlay=allo-piano-dac-plus-pcm512x-audio,<param>
624 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
625 Digital volume control.
626 (The default behaviour is that the Digital
627 volume control is limited to a maximum of
628 0dB. ie. it can attenuate but not provide
629 gain. For most users, this will be desired
630 as it will prevent clipping. By appending
631 the 24db_digital_gain parameter, the Digital
632 volume control will allow up to 24dB of
633 gain. If this parameter is enabled, it is the
634 responsibility of the user to ensure that
635 the Digital volume control is set to a value
636 that does not result in clipping/distortion!)
637 glb_mclk This option is only with Kali board. If enabled,
638 MCLK for Kali is used and PLL is disabled for
639 better voice quality. (default Off)
643 Info: Universal device tree overlay for SPI devices
645 Just specify the SPI address and device name ("compatible" property).
646 This overlay lacks any device-specific parameter support!
648 For devices on spi1 or spi2, the interfaces should be enabled
649 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
652 1. SPI NOR flash on spi0.1, maximum SPI clock frequency 45MHz:
653 dtoverlay=anyspi:spi0-1,dev="jedec,spi-nor",speed=45000000
654 2. MCP3204 ADC on spi1.2, maximum SPI clock frequency 500kHz:
655 dtoverlay=anyspi:spi1-2,dev="microchip,mcp3204"
656 Load: dtoverlay=anyspi,<param>=<val>
657 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
659 dev Set device name to search compatible module
661 speed Set SPI clock frequency in Hz
662 (integer, optional, default 500000)
666 Info: Configures the AVAGO APDS9960 digital proximity, ambient light, RGB and
668 Load: dtoverlay=apds9960,<param>=<val>
669 Params: gpiopin GPIO used for INT (default 4)
670 noints Disable the interrupt GPIO line.
674 Info: Configures the Orchard Audio ApplePi-DAC audio card
675 Load: dtoverlay=applepi-dac
680 Info: Arducam 64MP camera module.
681 Uses Unicam 1, which is the standard camera connector on most Pi
683 Load: dtoverlay=arducam-64mp,<param>=<val>
684 Params: rotation Mounting rotation of the camera sensor (0 or
686 orientation Sensor orientation (0 = front, 1 = rear,
687 2 = external, default external)
688 media-controller Configure use of Media Controller API for
689 configuring the sensor (default on)
690 cam0 Adopt the default configuration for CAM0 on a
691 Compute Module (CSI0, i2c_vc, and cam0_reg).
692 vcm Select lens driver state. Default is enabled,
693 but vcm=off will disable.
696 Name: arducam-pivariety
697 Info: Arducam Pivariety camera module.
698 Uses Unicam 1, which is the standard camera connector on most Pi
700 Load: dtoverlay=arducam-pivariety,<param>=<val>
701 Params: rotation Mounting rotation of the camera sensor (0 or
703 orientation Sensor orientation (0 = front, 1 = rear,
704 2 = external, default external)
705 media-controller Configure use of Media Controller API for
706 configuring the sensor (default on)
707 cam0 Adopt the default configuration for CAM0 on a
708 Compute Module (CSI0, i2c_vc, and cam0_reg).
712 Info: Configures the Atmel AT86RF233 802.15.4 low-power WPAN transceiver,
714 Load: dtoverlay=at86rf233,<param>=<val>
715 Params: interrupt GPIO used for INT (default 23)
716 reset GPIO used for Reset (default 24)
717 sleep GPIO used for Sleep (default 25)
718 speed SPI bus speed in Hz (default 3000000)
719 trim Fine tuning of the internal capacitance
720 arrays (0=+0pF, 15=+4.5pF, default 15)
723 Name: audioinjector-addons
724 Info: Configures the audioinjector.net audio add on soundcards
725 Load: dtoverlay=audioinjector-addons,<param>=<val>
726 Params: non-stop-clocks Keeps the clocks running even when the stream
727 is paused or stopped (default off)
730 Name: audioinjector-bare-i2s
731 Info: Configures the audioinjector.net audio bare i2s soundcard
732 Load: dtoverlay=audioinjector-bare-i2s
736 Name: audioinjector-isolated-soundcard
737 Info: Configures the audioinjector.net isolated soundcard
738 Load: dtoverlay=audioinjector-isolated-soundcard
742 Name: audioinjector-ultra
743 Info: Configures the audioinjector.net ultra soundcard
744 Load: dtoverlay=audioinjector-ultra
748 Name: audioinjector-wm8731-audio
749 Info: Configures the audioinjector.net audio add on soundcard
750 Load: dtoverlay=audioinjector-wm8731-audio
755 Info: Configures the audiosense-pi add on soundcard
756 For more information refer to
757 https://gitlab.com/kakar0t/audiosense-pi
758 Load: dtoverlay=audiosense-pi
763 Info: Switches PWM sound output to GPIOs on the 40-pin header
764 Load: dtoverlay=audremap,<param>=<val>
765 Params: swap_lr Reverse the channel allocation, which will also
766 swap the audio jack outputs (default off)
767 enable_jack Don't switch off the audio jack output. Does
768 nothing on BCM2711 (default off)
769 pins_12_13 Select GPIOs 12 & 13 (default)
770 pins_18_19 Select GPIOs 18 & 19
771 pins_40_41 Select GPIOs 40 & 41 (not available on CM4, used
773 pins_40_45 Select GPIOs 40 & 45 (don't use on BCM2711 - the
774 pins are on different controllers)
778 Info: Overlay that enables WLAN, Bluetooth and the GPIO expander on the
779 balenaFin carrier board for the Raspberry Pi Compute Module 3/3+ Lite.
780 Load: dtoverlay=balena-fin
784 Name: bmp085_i2c-sensor
785 Info: This overlay is now deprecated - see i2c-sensor
789 Name: camera-mux-2port
790 Info: Configures a 2 port camera multiplexer
791 Note that currently ALL IMX290 modules share a common clock, therefore
792 all modules will need to have the same clock frequency.
793 Load: dtoverlay=camera-mux-2port,<param>=<val>
794 Params: cam0-arducam-64mp Select Arducam64MP for camera on port 0
795 cam0-imx219 Select IMX219 for camera on port 0
796 cam0-imx258 Select IMX258 for camera on port 0
797 cam0-imx290 Select IMX290 for camera on port 0
798 cam0-imx477 Select IMX477 for camera on port 0
799 cam0-imx519 Select IMX519 for camera on port 0
800 cam0-imx708 Select IMX708 for camera on port 0
801 cam0-ov2311 Select OV2311 for camera on port 0
802 cam0-ov5647 Select OV5647 for camera on port 0
803 cam0-ov7251 Select OV7251 for camera on port 0
804 cam0-ov9281 Select OV9281 for camera on port 0
805 cam0-imx290-clk-freq Set clock frequency for an IMX290 on port 0
806 cam1-arducam-64mp Select Arducam64MP for camera on port 1
807 cam1-imx219 Select IMX219 for camera on port 1
808 cam1-imx258 Select IMX258 for camera on port 1
809 cam1-imx290 Select IMX290 for camera on port 1
810 cam1-imx477 Select IMX477 for camera on port 1
811 cam1-imx519 Select IMX519 for camera on port 1
812 cam1-imx708 Select IMX708 for camera on port 1
813 cam1-ov2311 Select OV2311 for camera on port 1
814 cam1-ov5647 Select OV5647 for camera on port 1
815 cam1-ov7251 Select OV7251 for camera on port 1
816 cam1-ov9281 Select OV9281 for camera on port 1
817 cam1-imx290-clk-freq Set clock frequency for an IMX290 on port 1
820 Name: camera-mux-4port
821 Info: Configures a 4 port camera multiplexer
822 Note that currently ALL IMX290 modules share a common clock, therefore
823 all modules will need to have the same clock frequency.
824 Load: dtoverlay=camera-mux-4port,<param>=<val>
825 Params: cam0-arducam-64mp Select Arducam64MP for camera on port 0
826 cam0-imx219 Select IMX219 for camera on port 0
827 cam0-imx258 Select IMX258 for camera on port 0
828 cam0-imx290 Select IMX290 for camera on port 0
829 cam0-imx477 Select IMX477 for camera on port 0
830 cam0-imx519 Select IMX519 for camera on port 0
831 cam0-imx708 Select IMX708 for camera on port 0
832 cam0-ov2311 Select OV2311 for camera on port 0
833 cam0-ov5647 Select OV5647 for camera on port 0
834 cam0-ov7251 Select OV7251 for camera on port 0
835 cam0-ov9281 Select OV9281 for camera on port 0
836 cam0-imx290-clk-freq Set clock frequency for an IMX290 on port 0
837 cam1-arducam-64mp Select Arducam64MP for camera on port 1
838 cam1-imx219 Select IMX219 for camera on port 1
839 cam1-imx258 Select IMX258 for camera on port 1
840 cam1-imx290 Select IMX290 for camera on port 1
841 cam1-imx477 Select IMX477 for camera on port 1
842 cam1-imx519 Select IMX519 for camera on port 1
843 cam1-imx708 Select IMX708 for camera on port 1
844 cam1-ov2311 Select OV2311 for camera on port 1
845 cam1-ov5647 Select OV5647 for camera on port 1
846 cam1-ov7251 Select OV7251 for camera on port 1
847 cam1-ov9281 Select OV9281 for camera on port 1
848 cam1-imx290-clk-freq Set clock frequency for an IMX290 on port 1
849 cam2-arducam-64mp Select Arducam64MP for camera on port 2
850 cam2-imx219 Select IMX219 for camera on port 2
851 cam2-imx258 Select IMX258 for camera on port 2
852 cam2-imx290 Select IMX290 for camera on port 2
853 cam2-imx477 Select IMX477 for camera on port 2
854 cam2-imx519 Select IMX519 for camera on port 2
855 cam2-imx708 Select IMX708 for camera on port 2
856 cam2-ov2311 Select OV2311 for camera on port 2
857 cam2-ov5647 Select OV5647 for camera on port 2
858 cam2-ov7251 Select OV7251 for camera on port 2
859 cam2-ov9281 Select OV9281 for camera on port 2
860 cam2-imx290-clk-freq Set clock frequency for an IMX290 on port 2
861 cam3-arducam-64mp Select Arducam64MP for camera on port 3
862 cam3-imx219 Select IMX219 for camera on port 3
863 cam3-imx258 Select IMX258 for camera on port 3
864 cam3-imx290 Select IMX290 for camera on port 3
865 cam3-imx477 Select IMX477 for camera on port 3
866 cam3-imx519 Select IMX519 for camera on port 3
867 cam3-imx708 Select IMX708 for camera on port 3
868 cam3-ov2311 Select OV2311 for camera on port 3
869 cam3-ov5647 Select OV5647 for camera on port 3
870 cam3-ov7251 Select OV7251 for camera on port 3
871 cam3-ov9281 Select OV9281 for camera on port 3
872 cam3-imx290-clk-freq Set clock frequency for an IMX290 on port 3
876 Info: Enables the ability to use the cap1106 touch sensor as a keyboard
877 Load: dtoverlay=cap1106,<param>=<val>
878 Params: int_pin GPIO pin for interrupt signal (default 23)
882 Info: Configures Chip Dip audio cards.
883 Load: dtoverlay=chipdip-dac
888 Info: Configures the Cirrus Logic Audio Card
889 Load: dtoverlay=cirrus-wm5102
894 Info: Largely for Compute Modules 1&3 where the original instructions for
895 adding a camera used GPIOs 0&1 for CAM1 and 28&29 for CAM0, whilst all
896 other platforms use 28&29 (or 44&45) for CAM1.
897 The default assignment through using this overlay is for
898 i2c0 to use 28&29, and i2c10 (aka i2c_csi_dsi) to use 28&29, but the
899 overrides allow this to be changed.
900 Load: dtoverlay=cm-swap-i2c0,<param>=<val>
901 Params: i2c0-gpio0 Use GPIOs 0&1 for i2c0
902 i2c0-gpio28 Use GPIOs 28&29 for i2c0 (default)
903 i2c0-gpio44 Use GPIOs 44&45 for i2c0
904 i2c10-gpio0 Use GPIOs 0&1 for i2c0 (default)
905 i2c10-gpio28 Use GPIOs 28&29 for i2c0
906 i2c10-gpio44 Use GPIOs 44&45 for i2c0
910 Info: Set custom CMA sizes, only use if you know what you are doing, might
911 clash with other overlays like vc4-fkms-v3d and vc4-kms-v3d.
912 Load: dtoverlay=cma,<param>=<val>
913 Params: cma-512 CMA is 512MB (needs 1GB)
914 cma-448 CMA is 448MB (needs 1GB)
915 cma-384 CMA is 384MB (needs 1GB)
916 cma-320 CMA is 320MB (needs 1GB)
917 cma-256 CMA is 256MB (needs 1GB)
918 cma-192 CMA is 192MB (needs 1GB)
922 cma-size CMA size in bytes, 4MB aligned
923 cma-default Use upstream's default value
926 Name: crystalfontz-cfa050_pi_m
927 Info: Configures the Crystalfontz CFA050-PI-M series of Raspberry Pi CM4
928 based modules using the CFA7201280A0_050Tx 7" TFT LCD displays,
929 with or without capacitive touch screen.
930 Requires use of vc4-kms-v3d.
931 Load: dtoverlay=crystalfontz-cfa050_pi_m,<param>=<val>
932 Params: captouch Enable capacitive touch display
936 Info: 8" TFT LCD display and touch panel used by cutiepi.io
937 Load: dtoverlay=cutiepi-panel
942 Info: Configures the dacberry400 add on soundcard
943 Load: dtoverlay=dacberry400
948 Info: Overlay for the DHT11/DHT21/DHT22 humidity/temperature sensors
949 Also sometimes found with the part number(s) AM230x.
950 Load: dtoverlay=dht11,<param>=<val>
951 Params: gpiopin GPIO connected to the sensor's DATA output.
956 Info: Configures the Dion Audio KIWI STREAMER
957 Load: dtoverlay=dionaudio-kiwi
962 Info: Configures the Dion Audio LOCO DAC-AMP
963 Load: dtoverlay=dionaudio-loco
967 Name: dionaudio-loco-v2
968 Info: Configures the Dion Audio LOCO-V2 DAC-AMP
969 Load: dtoverlay=dionaudio-loco-v2,<param>=<val>
970 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
971 Digital volume control. Enable with
972 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
973 (The default behaviour is that the Digital
974 volume control is limited to a maximum of
975 0dB. ie. it can attenuate but not provide
976 gain. For most users, this will be desired
977 as it will prevent clipping. By appending
978 the 24dB_digital_gain parameter, the Digital
979 volume control will allow up to 24dB of
980 gain. If this parameter is enabled, it is the
981 responsibility of the user to ensure that
982 the Digital volume control is set to a value
983 that does not result in clipping/distortion!)
987 Info: Disable onboard Bluetooth on Bluetooth-capable Raspberry Pis. On Pis
988 prior to Pi 5 this restores UART0/ttyAMA0 over GPIOs 14 & 15.
989 Load: dtoverlay=disable-bt
998 Info: Disable EMMC2 controller on BCM2711.
999 The allows the onboard EMMC storage on Compute Module 4 to be disabled
1000 e.g. if a fault has occurred.
1001 Load: dtoverlay=disable-emmc2
1006 Info: Disable onboard WLAN on WiFi-capable Raspberry Pis.
1007 Load: dtoverlay=disable-wifi
1011 Name: disable-wifi-pi5
1012 Info: See disable-wifi
1016 Info: Overlay for a generic 18-bit DPI display
1017 This uses GPIOs 0-21 (so no I2C, uart etc.), and activates the output
1018 2-3 seconds after the kernel has started.
1019 Load: dtoverlay=dpi18
1024 Info: Overlay for a generic 18-bit DPI display (in 'mode 6' connection scheme)
1025 This uses GPIOs 0-9,12-17,20-25 (so no I2C, uart etc.), and activates
1026 the output 3-3 seconds after the kernel has started.
1027 Load: dtoverlay=dpi18cpadhi
1032 Info: Overlay for a generic 24-bit DPI display
1033 This uses GPIOs 0-27 (so no I2C, uart etc.), and activates the output
1034 2-3 seconds after the kernel has started.
1035 Load: dtoverlay=dpi24
1040 Info: Configures the NW Digital Radio DRAWS Hat
1042 The board includes an ADC to measure various board values and also
1043 provides two analog user inputs on the expansion header. The ADC
1044 can be configured for various sample rates and gain values to adjust
1045 the input range. Tables describing the two parameters follow.
1057 ADC Datarate Values:
1062 4 = 1600sps (default)
1066 Load: dtoverlay=draws,<param>=<val>
1067 Params: draws_adc_ch4_gain Sets the full scale resolution of the ADCs
1068 input voltage sensor (default 1)
1070 draws_adc_ch4_datarate Sets the datarate of the ADCs input voltage
1073 draws_adc_ch5_gain Sets the full scale resolution of the ADCs
1074 5V rail voltage sensor (default 1)
1076 draws_adc_ch5_datarate Sets the datarate of the ADCs 4V rail voltage
1079 draws_adc_ch6_gain Sets the full scale resolution of the ADCs
1080 AIN2 input (default 2)
1082 draws_adc_ch6_datarate Sets the datarate of the ADCs AIN2 input
1084 draws_adc_ch7_gain Sets the full scale resolution of the ADCs
1085 AIN3 input (default 2)
1087 draws_adc_ch7_datarate Sets the datarate of the ADCs AIN3 input
1089 alsaname Name of the ALSA audio device (default "draws")
1093 Info: Selects the dwc_otg USB controller driver which has fiq support. This
1094 is the default on all except the Pi Zero which defaults to dwc2.
1095 Load: dtoverlay=dwc-otg
1100 Info: Selects the dwc2 USB controller driver
1101 Load: dtoverlay=dwc2,<param>=<val>
1102 Params: dr_mode Dual role mode: "host", "peripheral" or "otg"
1104 g-rx-fifo-size Size of rx fifo size in gadget mode
1106 g-np-tx-fifo-size Size of non-periodic tx fifo size in gadget
1110 [ The ds1307-rtc overlay has been deleted. See i2c-rtc. ]
1114 Info: Overlay for the EDT FT5406 touchscreen.
1115 This works with the Raspberry Pi 7" touchscreen when not being polled
1117 By default the overlay uses the i2c_csi_dsi I2C interface, but this
1119 You MUST use either "disable_touchscreen=1" or "ignore_lcd=1" in
1120 config.txt to stop the firmware polling the touchscreen.
1121 Load: dtoverlay=edt-ft5406,<param>=<val>
1122 Params: sizex Touchscreen size x (default 800)
1123 sizey Touchscreen size y (default 480)
1124 invx Touchscreen inverted x axis
1125 invy Touchscreen inverted y axis
1126 swapxy Touchscreen swapped x y axis
1127 i2c0 Choose the I2C0 bus on GPIOs 0&1
1128 i2c1 Choose the I2C1 bus on GPIOs 2&3
1129 i2c3 Choose the I2C3 bus (configure with the i2c3
1130 overlay - BCM2711 only)
1131 i2c4 Choose the I2C4 bus (configure with the i2c4
1132 overlay - BCM2711 only)
1133 i2c5 Choose the I2C5 bus (configure with the i2c5
1134 overlay - BCM2711 only)
1135 i2c6 Choose the I2C6 bus (configure with the i2c6
1136 overlay - BCM2711 only)
1137 addr Sets the address for the touch controller. Note
1138 that the device must be configured to use the
1143 Info: Overlay for the Microchip ENC28J60 Ethernet Controller on SPI0
1144 Load: dtoverlay=enc28j60,<param>=<val>
1145 Params: int_pin GPIO used for INT (default 25)
1147 speed SPI bus speed (default 12000000)
1151 Info: Overlay for the Microchip ENC28J60 Ethernet Controller on SPI2
1152 Load: dtoverlay=enc28j60-spi2,<param>=<val>
1153 Params: int_pin GPIO used for INT (default 39)
1155 speed SPI bus speed (default 12000000)
1159 Info: Enables I2C connected EETI EXC3000 multiple touch controller using
1160 GPIO 4 (pin 7 on GPIO header) for interrupt.
1161 Load: dtoverlay=exc3000,<param>=<val>
1162 Params: interrupt GPIO used for interrupt (default 4)
1163 sizex Touchscreen size x (default 4096)
1164 sizey Touchscreen size y (default 4096)
1165 invx Touchscreen inverted x axis
1166 invy Touchscreen inverted y axis
1167 swapxy Touchscreen swapped x y axis
1171 Info: Overlay for SPI-connected displays using the fbtft drivers.
1173 This overlay seeks to replace the functionality provided by fbtft_device
1174 which is now gone from the kernel.
1176 Most displays from fbtft_device have been ported over.
1178 dtoverlay=fbtft,spi0-0,rpi-display,reset_pin=23,dc_pin=24,led_pin=18,rotate=270
1180 It is also possible to specify the controller (this will use the default
1181 init sequence in the driver).
1183 dtoverlay=fbtft,spi0-0,ili9341,bgr,reset_pin=23,dc_pin=24,led_pin=18,rotate=270
1185 For devices on spi1 or spi2, the interfaces should be enabled
1186 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
1188 The following features of fbtft_device have not been ported over:
1189 - parallel bus is not supported
1190 - the init property which overrides the controller initialization
1191 sequence is not supported as a parameter due to memory limitations in
1192 the bootloader responsible for applying the overlay.
1194 See https://github.com/notro/fbtft/wiki/FBTFT-RPI-overlays for how to
1197 Load: dtoverlay=fbtft,<param>=<val>
1199 spi<n>-<m> Configure device at spi<n>, cs<m>
1201 speed SPI bus speed in Hz (default 32000000)
1202 cpha Shifted clock phase (CPHA) mode
1203 cpol Inverse clock polarity (CPOL) mode
1205 adafruit18 Adafruit 1.8
1206 adafruit22 Adafruit 2.2 (old)
1207 adafruit22a Adafruit 2.2
1208 adafruit28 Adafruit 2.8
1209 adafruit13m Adafruit 1.3 OLED
1210 admatec_c-berry28 C-Berry28
1212 er_tftm050_2 ER-TFTM070-2
1213 er_tftm070_5 ER-TFTM070-5
1215 ew24ha0_9bit EW24HA0 in 9-bit mode
1216 freetronicsoled128 Freetronics OLED128
1219 itdb28_spi ITDB02-2.8 with SPI interface circuit
1220 mi0283qt-2 Watterott MI0283QT-2
1221 mi0283qt-9a Watterott MI0283QT-9A
1222 nokia3310 Nokia 3310
1223 nokia3310a Nokia 3310a
1224 nokia5110 Nokia 5110
1226 pitft Adafruit PiTFT 2.8
1228 rpi-display Watterott rpi-display
1229 sainsmart18 Sainsmart 1.8
1230 sainsmart32_spi Sainsmart 3.2 with SPI interfce circuit
1231 tinylcd35 TinyLCD 3.5
1232 tm022hdh26 Tianma TM022HDH26
1233 tontec35_9481 Tontect 3.5 with ILI9481 controller
1234 tontec35_9486 Tontect 3.5 with ILI9486 controller
1235 waveshare32b Waveshare 3.2
1236 waveshare22 Waveshare 2.2
1238 bd663474 BD663474 display controller
1239 hx8340bn HX8340BN display controller
1240 hx8347d HX8347D display controller
1241 hx8353d HX8353D display controller
1242 hx8357d HX8357D display controller
1243 ili9163 ILI9163 display controller
1244 ili9320 ILI9320 display controller
1245 ili9325 ILI9325 display controller
1246 ili9340 ILI9340 display controller
1247 ili9341 ILI9341 display controller
1248 ili9481 ILI9481 display controller
1249 ili9486 ILI9486 display controller
1250 pcd8544 PCD8544 display controller
1251 ra8875 RA8875 display controller
1252 s6d02a1 S6D02A1 display controller
1253 s6d1121 S6D1121 display controller
1254 seps525 SEPS525 display controller
1255 sh1106 SH1106 display controller
1256 ssd1289 SSD1289 display controller
1257 ssd1305 SSD1305 display controller
1258 ssd1306 SSD1306 display controller
1259 ssd1325 SSD1325 display controller
1260 ssd1331 SSD1331 display controller
1261 ssd1351 SSD1351 display controller
1262 st7735r ST7735R display controller
1263 st7789v ST7789V display controller
1264 tls8204 TLS8204 display controller
1265 uc1611 UC1611 display controller
1266 uc1701 UC1701 display controller
1267 upd161704 UPD161704 display controller
1269 width Display width in pixels
1270 height Display height in pixels
1271 regwidth Display controller register width (default is
1273 buswidth Display bus interface width (default 8)
1274 debug Debug output level {0-7}
1275 rotate Display rotation {0, 90, 180, 270} (counter
1276 clockwise). Not supported by all drivers.
1277 bgr Enable BGR mode (default off). Use if Red and
1278 Blue are swapped. Not supported by all drivers.
1279 fps Frames per second (default 30). In effect this
1280 states how long the driver will wait after video
1281 memory has been changed until display update
1282 transfer is started.
1283 txbuflen Length of the FBTFT transmit buffer
1285 startbyte Sets the Start byte used by fb_ili9320,
1286 fb_ili9325 and fb_hx8347d. Common value is 0x70.
1287 gamma String representation of Gamma Curve(s). Driver
1288 specific. Not supported by all drivers.
1289 reset_pin GPIO pin for RESET
1290 dc_pin GPIO pin for D/C
1291 led_pin GPIO pin for LED backlight
1295 Info: Configures the Fe-Pi Audio Sound Card
1296 Load: dtoverlay=fe-pi-audio
1301 Info: A demonstration of the gpio-fsm driver. The GPIOs are chosen to work
1302 nicely with a "traffic-light" display of red, amber and green LEDs on
1303 GPIOs 7, 8 and 25 respectively.
1304 Load: dtoverlay=fsm-demo,<param>=<val>
1305 Params: fsm_debug Enable debug logging (default off)
1309 Info: Enables GalaxyCore's GC9A01 single chip driver based displays on
1310 SPI0 as fb1, using GPIOs DC=25, RST=27 and BL=18 (physical
1311 GPIO header pins 22, 13 and 12 respectively) in addition to the
1312 SPI0 pins DIN=10, CLK=11 and CS=8 (physical GPIO header pins 19,
1313 23 and 24 respectively).
1314 Load: dtoverlay=gc9a01,<param>=<val>
1315 Params: speed Display SPI bus speed
1317 rotate Display rotation {0,90,180,270}
1319 width Width of the display
1321 height Height of the display
1323 fps Delay between frame updates
1325 debug Debug output level {0-7}
1329 Info: An overlay for the Ghost amplifier.
1330 Load: dtoverlay=ghost-amp,<param>=<val>
1331 Params: fsm_debug Enable debug logging of the GPIO FSM (default
1336 Info: Enables I2C connected Goodix gt9271 multiple touch controller using
1337 GPIOs 4 and 17 (pins 7 and 11 on GPIO header) for interrupt and reset.
1338 Load: dtoverlay=goodix,<param>=<val>
1339 Params: interrupt GPIO used for interrupt (default 4)
1340 reset GPIO used for reset (default 17)
1343 Name: googlevoicehat-soundcard
1344 Info: Configures the Google voiceHAT soundcard
1345 Load: dtoverlay=googlevoicehat-soundcard
1350 Info: This is a generic overlay for detecting charger with GPIO.
1351 Load: dtoverlay=gpio-charger,<param>=<val>
1352 Params: gpio GPIO pin to trigger on (default 4)
1353 active_low When this is 1 (active low), a falling
1354 edge generates a charging event and a
1355 rising edge generates a discharging event.
1356 When this is 0 (active high), this is
1357 reversed. The default is 0 (active high)
1358 gpio_pull Desired pull-up/down state (off, down, up)
1360 type Set a charger type for the pin. (Default: mains)
1364 Info: Configure a GPIO pin to control a cooling fan.
1365 Load: dtoverlay=gpio-fan,<param>=<val>
1366 Params: gpiopin GPIO used to control the fan (default 12)
1367 temp Temperature at which the fan switches on, in
1368 millicelcius (default 55000)
1369 hyst Temperature delta (in millicelcius) below
1370 temp at which the fan will drop to minrpm
1375 Info: Activate a "hog" for a GPIO - request that the kernel configures it as
1376 an output, driven low or high as indicated by the presence or absence
1377 of the active_low parameter. Note that a hogged GPIO is not available
1378 to other drivers or for gpioset/gpioget.
1379 Load: dtoverlay=gpio-hog,<param>=<val>
1380 Params: gpio GPIO pin to hog (default 26)
1381 active_low If set, the hog drives the GPIO low (defaults
1382 to off - the GPIO is driven high)
1386 Info: Use GPIO pin as rc-core style infrared receiver input. The rc-core-
1387 based gpio_ir_recv driver maps received keys directly to a
1388 /dev/input/event* device, all decoding is done by the kernel - LIRC is
1389 not required! The key mapping and other decoding parameters can be
1390 configured by "ir-keytable" tool.
1391 Load: dtoverlay=gpio-ir,<param>=<val>
1392 Params: gpio_pin Input pin number. Default is 18.
1394 gpio_pull Desired pull-up/down state (off, down, up)
1397 invert "1" = invert the input (active-low signalling).
1398 "0" = non-inverted input (active-high
1399 signalling). Default is "1".
1401 rc-map-name Default rc keymap (can also be changed by
1402 ir-keytable), defaults to "rc-rc6-mce"
1406 Info: Use GPIO pin as bit-banged infrared transmitter output.
1407 This is an alternative to "pwm-ir-tx". gpio-ir-tx doesn't require
1408 a PWM so it can be used together with onboard analog audio.
1409 Load: dtoverlay=gpio-ir-tx,<param>=<val>
1410 Params: gpio_pin Output GPIO (default 18)
1412 invert "1" = invert the output (make it active-low).
1413 Default is "0" (active-high).
1417 Info: This is a generic overlay for activating GPIO keypresses using
1418 the gpio-keys library and this dtoverlay. Multiple keys can be
1419 set up using multiple calls to the overlay for configuring
1420 additional buttons or joysticks. You can see available keycodes
1421 at https://github.com/torvalds/linux/blob/v4.12/include/uapi/
1422 linux/input-event-codes.h#L64
1423 Load: dtoverlay=gpio-key,<param>=<val>
1424 Params: gpio GPIO pin to trigger on (default 3)
1425 active_low When this is 1 (active low), a falling
1426 edge generates a key down event and a
1427 rising edge generates a key up event.
1428 When this is 0 (active high), this is
1429 reversed. The default is 1 (active low)
1430 gpio_pull Desired pull-up/down state (off, down, up)
1431 Default is "up". Note that the default pin
1432 (GPIO3) has an external pullup
1433 label Set a label for the key
1434 keycode Set the key code for the button
1439 Info: This is a generic overlay for activating LEDs (or any other component)
1440 by a GPIO pin. Multiple LEDs can be set up using multiple calls to the
1441 overlay. While there are many existing methods to activate LEDs on the
1442 RPi, this method offers some advantages:
1443 1) Does not require any userspace programs.
1444 2) LEDs can be connected to the kernel's led-trigger framework,
1445 and drive the LED based on triggers such as cpu load, heartbeat,
1446 kernel panic, key input, timers and others.
1447 3) LED can be tied to the input state of another GPIO pin.
1448 4) The LED is setup early during the kernel boot process (useful
1449 for cpu/heartbeat/panic triggers).
1451 Typical electrical connection is:
1452 RPI-GPIO.19 -> LED -> 300ohm resister -> RPI-GND
1453 The GPIO pin number can be changed with the 'gpio=' parameter.
1455 To control an LED from userspace, write a 0 or 1 value:
1456 echo 1 > /sys/class/leds/myled1/brightness
1457 The 'myled1' name can be changed with the 'label=' parameter.
1459 To connect the LED to a kernel trigger from userspace:
1460 echo cpu > /sys/class/leds/myled1/trigger
1461 echo heartbeat > /sys/class/leds/myled1/trigger
1462 echo none > /sys/class/leds/myled1/trigger
1463 To connect the LED to GPIO.26 pin (physical pin 37):
1464 echo gpio > /sys/class/leds/myled1/trigger
1465 echo 26 > /sys/class/leds/myled1/gpio
1467 cat /sys/class/leds/myled1/trigger
1469 More information about the Linux kernel LED/Trigger system:
1470 https://www.kernel.org/doc/Documentation/leds/leds-class.rst
1471 https://www.kernel.org/doc/Documentation/leds/ledtrig-oneshot.rst
1472 Load: dtoverlay=gpio-led,<param>=<val>
1473 Params: gpio GPIO pin connected to the LED (default 19)
1474 label The label for this LED. It will appear under
1475 /sys/class/leds/<label> . Default 'myled1'.
1476 trigger Set the led-trigger to connect to this LED.
1477 default 'none' (LED is user-controlled).
1478 Some possible triggers:
1479 cpu - CPU load (all CPUs)
1480 cpu0 - CPU load of first CPU.
1481 mmc - disk activity (all disks)
1482 panic - turn on on kernel panic
1483 heartbeat - indicate system health
1484 gpio - connect to a GPIO input pin (note:
1485 currently the GPIO PIN can not be set
1486 using overlay parameters, must be
1487 done in userspace, see examples above.
1488 active_low Set to 1 to turn invert the LED control
1489 (writing 0 to /sys/class/leds/XXX/brightness
1490 will turn on the GPIO/LED). Default '0'.
1493 Name: gpio-no-bank0-irq
1494 Info: Use this overlay to disable GPIO interrupts for GPIOs in bank 0 (0-27),
1495 which can be useful for UIO drivers.
1496 N.B. Using this overlay will trigger a kernel WARN during booting, but
1497 this can safely be ignored - the system should work as expected.
1498 Load: dtoverlay=gpio-no-bank0-irq
1503 Info: Use this overlay to disable all GPIO interrupts, which can be useful
1504 for user-space GPIO edge detection systems.
1505 Load: dtoverlay=gpio-no-irq
1510 Info: Drives a GPIO high or low on poweroff (including halt). Using this
1511 overlay interferes with the normal power-down sequence, preventing the
1512 kernel from resetting the SoC (a necessary step in a normal power-off
1513 or reboot). This also disables the ability to trigger a boot by driving
1516 The GPIO starts in an inactive state. At poweroff time it is driven
1517 active for 100ms, then inactive for 100ms, then active again. It is
1518 safe to remove the power at any point after the initial activation of
1521 Users of this overlay are required to provide an external mechanism to
1522 switch off the power supply when signalled - failure to do so results
1523 in a kernel BUG, increased power consumption and undefined behaviour.
1524 Load: dtoverlay=gpio-poweroff,<param>=<val>
1525 Params: gpiopin GPIO for signalling (default 26)
1527 active_low Set if the power control device requires a
1528 high->low transition to trigger a power-down.
1529 Note that this will require the support of a
1530 custom dt-blob.bin to prevent a power-down
1531 during the boot process, and that a reboot
1532 will also cause the pin to go low.
1533 input Set if the gpio pin should be configured as
1535 export Set to export the configured pin to sysfs
1536 active_delay_ms Initial GPIO active period (default 100)
1537 inactive_delay_ms Subsequent GPIO inactive period (default 100)
1538 timeout_ms Specify (in ms) how long the kernel waits for
1539 power-down before issuing a WARN (default 3000).
1543 Info: Initiates a shutdown when GPIO pin changes. The given GPIO pin
1544 is configured as an input key that generates KEY_POWER events.
1546 This event is handled by systemd-logind by initiating a
1547 shutdown. Systemd versions older than 225 need an udev rule
1548 enable listening to the input device:
1550 ACTION!="REMOVE", SUBSYSTEM=="input", KERNEL=="event*", \
1551 SUBSYSTEMS=="platform", DRIVERS=="gpio-keys", \
1552 ATTRS{keys}=="116", TAG+="power-switch"
1554 Alternatively this event can be handled also on systems without
1555 systemd, just by traditional SysV init daemon. KEY_POWER event
1556 (keycode 116) needs to be mapped to KeyboardSignal on console
1557 and then kb::kbrequest inittab action which is triggered by
1558 KeyboardSignal from console can be configured to issue system
1559 shutdown. Steps for this configuration are:
1561 Add following lines to the /etc/console-setup/remap.inc file:
1563 # Key Power as special keypress
1564 keycode 116 = KeyboardSignal
1566 Then add following lines to /etc/inittab file:
1568 # Action on special keypress (Key Power)
1569 kb::kbrequest:/sbin/shutdown -t1 -a -h -P now
1571 And finally reload configuration by calling following commands:
1573 # dpkg-reconfigure console-setup
1574 # service console-setup reload
1577 This overlay only handles shutdown. After shutdown, the system
1578 can be powered up again by driving GPIO3 low. The default
1579 configuration uses GPIO3 with a pullup, so if you connect a
1580 button between GPIO3 and GND (pin 5 and 6 on the 40-pin header),
1581 you get a shutdown and power-up button. Please note that
1582 Raspberry Pi 1 Model B rev 1 uses GPIO1 instead of GPIO3.
1583 Load: dtoverlay=gpio-shutdown,<param>=<val>
1584 Params: gpio_pin GPIO pin to trigger on (default 3)
1585 For Raspberry Pi 1 Model B rev 1 set this
1586 explicitly to value 1, e.g.:
1588 dtoverlay=gpio-shutdown,gpio_pin=1
1590 active_low When this is 1 (active low), a falling
1591 edge generates a key down event and a
1592 rising edge generates a key up event.
1593 When this is 0 (active high), this is
1594 reversed. The default is 1 (active low).
1596 gpio_pull Desired pull-up/down state (off, down, up)
1599 Note that the default pin (GPIO3) has an
1600 external pullup. Same applies for GPIO1
1601 on Raspberry Pi 1 Model B rev 1.
1603 debounce Specify the debounce interval in milliseconds
1608 Info: Configures an HD44780 compatible LCD display. Uses 4 gpio pins for
1609 data, 2 gpio pins for enable and register select and 1 optional pin
1610 for enabling/disabling the backlight display.
1611 Load: dtoverlay=hd44780-lcd,<param>=<val>
1612 Params: pin_d4 GPIO pin for data pin D4 (default 6)
1614 pin_d5 GPIO pin for data pin D5 (default 13)
1616 pin_d6 GPIO pin for data pin D6 (default 19)
1618 pin_d7 GPIO pin for data pin D7 (default 26)
1620 pin_en GPIO pin for "Enable" (default 21)
1622 pin_rs GPIO pin for "Register Select" (default 20)
1624 pin_bl Optional pin for enabling/disabling the
1625 display backlight. (default disabled)
1627 display_height Height of the display in characters
1629 display_width Width of the display in characters
1632 Name: hdmi-backlight-hwhack-gpio
1633 Info: Devicetree overlay for GPIO based backlight on/off capability.
1634 Use this if you have one of those HDMI displays whose backlight cannot
1635 be controlled via DPMS over HDMI and plan to do a little soldering to
1636 use an RPi gpio pin for on/off switching. See:
1637 https://www.waveshare.com/wiki/7inch_HDMI_LCD_(C)#Backlight_Control
1638 Load: dtoverlay=hdmi-backlight-hwhack-gpio,<param>=<val>
1639 Params: gpio_pin GPIO pin used (default 17)
1640 active_low Set this to 1 if the display backlight is
1641 switched on when the wire goes low.
1642 Leave the default (value 0) if the backlight
1643 expects a high to switch it on.
1647 Info: Configures the HifiBerry Amp and Amp+ audio cards
1648 Load: dtoverlay=hifiberry-amp
1652 Name: hifiberry-amp100
1653 Info: Configures the HifiBerry AMP100 audio card
1654 Load: dtoverlay=hifiberry-amp100,<param>=<val>
1655 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1656 Digital volume control. Enable with
1657 "dtoverlay=hifiberry-amp100,24db_digital_gain"
1658 (The default behaviour is that the Digital
1659 volume control is limited to a maximum of
1660 0dB. ie. it can attenuate but not provide
1661 gain. For most users, this will be desired
1662 as it will prevent clipping. By appending
1663 the 24dB_digital_gain parameter, the Digital
1664 volume control will allow up to 24dB of
1665 gain. If this parameter is enabled, it is the
1666 responsibility of the user to ensure that
1667 the Digital volume control is set to a value
1668 that does not result in clipping/distortion!)
1669 slave Force DAC+ Pro into slave mode, using Pi as
1670 master for bit clock and frame clock.
1671 leds_off If set to 'true' the onboard indicator LEDs
1672 are switched off at all times.
1673 auto_mute If set to 'true' the amplifier is automatically
1674 muted when the DAC is not playing.
1675 mute_ext_ctl The amplifier's HW mute control is enabled
1676 in ALSA mixer and set to <val>.
1677 Will be overwritten by ALSA user settings.
1680 Name: hifiberry-amp3
1681 Info: Configures the HifiBerry Amp3 audio card
1682 Load: dtoverlay=hifiberry-amp3
1687 Info: Configures the HifiBerry DAC audio cards
1688 Load: dtoverlay=hifiberry-dac
1692 Name: hifiberry-dacplus
1693 Info: Configures the HifiBerry DAC+ audio card
1694 Load: dtoverlay=hifiberry-dacplus,<param>=<val>
1695 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1696 Digital volume control. Enable with
1697 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
1698 (The default behaviour is that the Digital
1699 volume control is limited to a maximum of
1700 0dB. ie. it can attenuate but not provide
1701 gain. For most users, this will be desired
1702 as it will prevent clipping. By appending
1703 the 24dB_digital_gain parameter, the Digital
1704 volume control will allow up to 24dB of
1705 gain. If this parameter is enabled, it is the
1706 responsibility of the user to ensure that
1707 the Digital volume control is set to a value
1708 that does not result in clipping/distortion!)
1709 slave Force DAC+ Pro into slave mode, using Pi as
1710 master for bit clock and frame clock.
1711 leds_off If set to 'true' the onboard indicator LEDs
1712 are switched off at all times.
1715 Name: hifiberry-dacplusadc
1716 Info: Configures the HifiBerry DAC+ADC audio card
1717 Load: dtoverlay=hifiberry-dacplusadc,<param>=<val>
1718 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1719 Digital volume control. Enable with
1720 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
1721 (The default behaviour is that the Digital
1722 volume control is limited to a maximum of
1723 0dB. ie. it can attenuate but not provide
1724 gain. For most users, this will be desired
1725 as it will prevent clipping. By appending
1726 the 24dB_digital_gain parameter, the Digital
1727 volume control will allow up to 24dB of
1728 gain. If this parameter is enabled, it is the
1729 responsibility of the user to ensure that
1730 the Digital volume control is set to a value
1731 that does not result in clipping/distortion!)
1732 slave Force DAC+ Pro into slave mode, using Pi as
1733 master for bit clock and frame clock.
1734 leds_off If set to 'true' the onboard indicator LEDs
1735 are switched off at all times.
1738 Name: hifiberry-dacplusadcpro
1739 Info: Configures the HifiBerry DAC+ADC PRO audio card
1740 Load: dtoverlay=hifiberry-dacplusadcpro,<param>=<val>
1741 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
1742 Digital volume control. Enable with
1743 "dtoverlay=hifiberry-dacplusadcpro,24db_digital_gain"
1744 (The default behaviour is that the Digital
1745 volume control is limited to a maximum of
1746 0dB. ie. it can attenuate but not provide
1747 gain. For most users, this will be desired
1748 as it will prevent clipping. By appending
1749 the 24dB_digital_gain parameter, the Digital
1750 volume control will allow up to 24dB of
1751 gain. If this parameter is enabled, it is the
1752 responsibility of the user to ensure that
1753 the Digital volume control is set to a value
1754 that does not result in clipping/distortion!)
1755 slave Force DAC+ADC Pro into slave mode, using Pi as
1756 master for bit clock and frame clock.
1757 leds_off If set to 'true' the onboard indicator LEDs
1758 are switched off at all times.
1761 Name: hifiberry-dacplusdsp
1762 Info: Configures the HifiBerry DAC+DSP audio card
1763 Load: dtoverlay=hifiberry-dacplusdsp
1767 Name: hifiberry-dacplushd
1768 Info: Configures the HifiBerry DAC+ HD audio card
1769 Load: dtoverlay=hifiberry-dacplushd
1773 Name: hifiberry-digi
1774 Info: Configures the HifiBerry Digi and Digi+ audio card
1775 Load: dtoverlay=hifiberry-digi
1779 Name: hifiberry-digi-pro
1780 Info: Configures the HifiBerry Digi+ Pro and Digi2 Pro audio card
1781 Load: dtoverlay=hifiberry-digi-pro
1786 Info: Enables "High Peripheral" mode
1787 Load: dtoverlay=highperi
1792 Info: HY28A - 2.8" TFT LCD Display Module by HAOYU Electronics
1793 Default values match Texy's display shield
1794 Load: dtoverlay=hy28a,<param>=<val>
1795 Params: speed Display SPI bus speed
1797 rotate Display rotation {0,90,180,270}
1799 fps Delay between frame updates
1801 debug Debug output level {0-7}
1803 xohms Touchpanel sensitivity (X-plate resistance)
1805 resetgpio GPIO used to reset controller
1807 ledgpio GPIO used to control backlight
1811 Info: HY28B - 2.8" TFT LCD Display Module by HAOYU Electronics
1812 Default values match Texy's display shield
1813 Load: dtoverlay=hy28b,<param>=<val>
1814 Params: speed Display SPI bus speed
1816 rotate Display rotation {0,90,180,270}
1818 fps Delay between frame updates
1820 debug Debug output level {0-7}
1822 xohms Touchpanel sensitivity (X-plate resistance)
1824 resetgpio GPIO used to reset controller
1826 ledgpio GPIO used to control backlight
1830 Info: HY28B 2017 version - 2.8" TFT LCD Display Module by HAOYU Electronics
1831 Default values match Texy's display shield
1832 Load: dtoverlay=hy28b-2017,<param>=<val>
1833 Params: speed Display SPI bus speed
1835 rotate Display rotation {0,90,180,270}
1837 fps Delay between frame updates
1839 debug Debug output level {0-7}
1841 xohms Touchpanel sensitivity (X-plate resistance)
1843 resetgpio GPIO used to reset controller
1845 ledgpio GPIO used to control backlight
1849 Info: Configures the Audiophonics I-SABRE Q2M DAC
1850 Load: dtoverlay=i-sabre-q2m
1855 Info: Fall back to the i2c_bcm2708 driver for the i2c_arm bus.
1856 Load: dtoverlay=i2c-bcm2708
1861 Info: Adds support for a number of I2C fan controllers
1862 Load: dtoverlay=i2c-fan,<param>=<val>
1863 Params: addr Sets the address for the fan controller. Note
1864 that the device must be configured to use the
1867 i2c0 Choose the I2C0 bus on GPIOs 0&1
1869 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
1871 i2c3 Choose the I2C3 bus (configure with the i2c3
1872 overlay - BCM2711 only)
1874 i2c4 Choose the I2C4 bus (configure with the i2c4
1875 overlay - BCM2711 only)
1877 i2c5 Choose the I2C5 bus (configure with the i2c5
1878 overlay - BCM2711 only)
1880 i2c6 Choose the I2C6 bus (configure with the i2c6
1881 overlay - BCM2711 only)
1883 minpwm PWM setting for the fan when the SoC is below
1884 mintemp (range 0-255. default 0)
1885 maxpwm PWM setting for the fan when the SoC is above
1886 maxtemp (range 0-255. default 255)
1887 midtemp Temperature (in millicelcius) at which the fan
1888 begins to speed up (default 50000)
1890 midtemp_hyst Temperature delta (in millicelcius) below
1891 mintemp at which the fan will drop to minrpm
1894 maxtemp Temperature (in millicelcius) at which the fan
1895 will be held at maxrpm (default 70000)
1897 maxtemp_hyst Temperature delta (in millicelcius) below
1898 maxtemp at which the fan begins to slow down
1901 emc2301 Select the Microchip EMC230x controller family
1902 - EMC2301, EMC2302, EMC2303, EMC2305.
1906 Info: Adds support for software i2c controller on gpio pins
1907 Load: dtoverlay=i2c-gpio,<param>=<val>
1908 Params: i2c_gpio_sda GPIO used for I2C data (default "23")
1910 i2c_gpio_scl GPIO used for I2C clock (default "24")
1912 i2c_gpio_delay_us Clock delay in microseconds
1913 (default "2" = ~100kHz)
1915 bus Set to a unique, non-zero value if wanting
1916 multiple i2c-gpio busses. If set, will be used
1917 as the preferred bus number (/dev/i2c-<n>). If
1918 not set, the default value is 0, but the bus
1919 number will be dynamically assigned - probably
1924 Info: Adds support for a number of I2C bus multiplexers on i2c_arm
1925 Load: dtoverlay=i2c-mux,<param>=<val>
1926 Params: pca9542 Select the NXP PCA9542 device
1928 pca9545 Select the NXP PCA9545 device
1930 pca9548 Select the NXP PCA9548 device
1932 addr Change I2C address of the device (default 0x70)
1934 i2c0 Choose the I2C0 bus on GPIOs 0&1
1936 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
1938 i2c3 Choose the I2C3 bus (configure with the i2c3
1939 overlay - BCM2711 only)
1941 i2c4 Choose the I2C3 bus (configure with the i2c3
1942 overlay - BCM2711 only)
1944 i2c5 Choose the I2C5 bus (configure with the i2c4
1945 overlay - BCM2711 only)
1947 i2c6 Choose the I2C6 bus (configure with the i2c6
1948 overlay - BCM2711 only)
1951 [ The i2c-mux-pca9548a overlay has been deleted. See i2c-mux. ]
1954 Name: i2c-pwm-pca9685a
1955 Info: Adds support for an NXP PCA9685A I2C PWM controller on i2c_arm
1956 Load: dtoverlay=i2c-pwm-pca9685a,<param>=<val>
1957 Params: addr I2C address of PCA9685A (default 0x40)
1958 i2c0 Choose the I2C0 bus on GPIOs 0&1
1959 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
1960 i2c3 Choose the I2C3 bus (configure with the i2c3
1961 overlay - BCM2711 only)
1962 i2c4 Choose the I2C3 bus (configure with the i2c3
1963 overlay - BCM2711 only)
1964 i2c5 Choose the I2C5 bus (configure with the i2c4
1965 overlay - BCM2711 only)
1966 i2c6 Choose the I2C6 bus (configure with the i2c6
1967 overlay - BCM2711 only)
1971 Info: Adds support for a number of I2C Real Time Clock devices
1972 Load: dtoverlay=i2c-rtc,<param>=<val>
1973 Params: abx80x Select one of the ABx80x family:
1974 AB0801, AB0803, AB0804, AB0805,
1975 AB1801, AB1803, AB1804, AB1805
1977 bq32000 Select the TI BQ32000 device
1979 ds1307 Select the DS1307 device
1981 ds1339 Select the DS1339 device
1983 ds1340 Select the DS1340 device
1985 ds3231 Select the DS3231 device
1987 m41t62 Select the M41T62 device
1989 mcp7940x Select the MCP7940x device
1991 mcp7941x Select the MCP7941x device
1993 pcf2127 Select the PCF2127 device
1995 pcf2129 Select the PCF2129 device
1997 pcf85063 Select the PCF85063 device
1999 pcf85063a Select the PCF85063A device
2001 pcf8523 Select the PCF8523 device
2003 pcf85363 Select the PCF85363 device
2005 pcf8563 Select the PCF8563 device
2007 rv1805 Select the Micro Crystal RV1805 device
2009 rv3028 Select the Micro Crystal RV3028 device
2011 rv3032 Select the Micro Crystal RV3032 device
2013 rv8803 Select the Micro Crystal RV8803 device
2015 sd3078 Select the ZXW Shenzhen whwave SD3078 device
2017 s35390a Select the ABLIC S35390A device
2019 i2c0 Choose the I2C0 bus on GPIOs 0&1
2021 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2023 i2c3 Choose the I2C3 bus (configure with the i2c3
2024 overlay - BCM2711 only)
2026 i2c4 Choose the I2C3 bus (configure with the i2c3
2027 overlay - BCM2711 only)
2029 i2c5 Choose the I2C5 bus (configure with the i2c4
2030 overlay - BCM2711 only)
2032 i2c6 Choose the I2C6 bus (configure with the i2c6
2033 overlay - BCM2711 only)
2035 addr Sets the address for the RTC. Note that the
2036 device must be configured to use the specified
2039 trickle-diode-disable Do not use the internal trickle charger diode
2042 trickle-diode-type Diode type for trickle charge - "standard" or
2043 "schottky" (ABx80x and RV1805 only)
2045 trickle-resistor-ohms Resistor value for trickle charge (DS1339,
2046 ABx80x, BQ32000, RV1805, RV3028, RV3032)
2048 trickle-voltage-mv Charge pump voltage for trickle charge (RV3032)
2050 wakeup-source Specify that the RTC can be used as a wakeup
2053 backup-switchover-mode Backup power supply switch mode. Must be 0 for
2054 off or 1 for Vdd < VBackup (RV3028, RV3032)
2058 Info: Adds support for a number of I2C Real Time Clock devices
2059 using the software i2c controller
2060 Load: dtoverlay=i2c-rtc-gpio,<param>=<val>
2061 Params: abx80x Select one of the ABx80x family:
2062 AB0801, AB0803, AB0804, AB0805,
2063 AB1801, AB1803, AB1804, AB1805
2065 bq32000 Select the TI BQ32000 device
2067 ds1307 Select the DS1307 device
2069 ds1339 Select the DS1339 device
2071 ds1340 Select the DS1340 device
2073 ds3231 Select the DS3231 device
2075 m41t62 Select the M41T62 device
2077 mcp7940x Select the MCP7940x device
2079 mcp7941x Select the MCP7941x device
2081 pcf2127 Select the PCF2127 device
2083 pcf2129 Select the PCF2129 device
2085 pcf85063 Select the PCF85063 device
2087 pcf85063a Select the PCF85063A device
2089 pcf8523 Select the PCF8523 device
2091 pcf85363 Select the PCF85363 device
2093 pcf8563 Select the PCF8563 device
2095 rv1805 Select the Micro Crystal RV1805 device
2097 rv3028 Select the Micro Crystal RV3028 device
2099 rv3032 Select the Micro Crystal RV3032 device
2101 rv8803 Select the Micro Crystal RV8803 device
2103 sd3078 Select the ZXW Shenzhen whwave SD3078 device
2105 s35390a Select the ABLIC S35390A device
2107 addr Sets the address for the RTC. Note that the
2108 device must be configured to use the specified
2111 trickle-diode-disable Do not use the internal trickle charger diode
2114 trickle-diode-type Diode type for trickle charge - "standard" or
2115 "schottky" (ABx80x and RV1805 only)
2117 trickle-resistor-ohms Resistor value for trickle charge (DS1339,
2118 ABx80x, BQ32000, RV1805, RV3028, RV3032)
2120 trickle-voltage-mv Charge pump voltage for trickle charge (RV3032)
2122 wakeup-source Specify that the RTC can be used as a wakeup
2125 backup-switchover-mode Backup power supply switch mode. Must be 0 for
2126 off or 1 for Vdd < VBackup (RV3028, RV3032)
2128 i2c_gpio_sda GPIO used for I2C data (default "23")
2130 i2c_gpio_scl GPIO used for I2C clock (default "24")
2132 i2c_gpio_delay_us Clock delay in microseconds
2133 (default "2" = ~100kHz)
2137 Info: Adds support for a number of I2C barometric pressure, temperature,
2138 light level and chemical sensors on i2c_arm
2139 Load: dtoverlay=i2c-sensor,<param>=<val>
2140 Params: addr Set the address for the BH1750, BME280, BME680,
2141 BMP280, BMP380, CCS811, DS1621, HDC100X, JC42,
2142 LM75, MCP980x, MPU6050, MPU9250, MS5637, MS5803,
2143 MS5805, MS5837, MS8607, SHT3x or TMP102
2145 aht10 Select the Aosong AHT10 temperature and humidity
2148 bh1750 Select the Rohm BH1750 ambient light sensor
2149 Valid addresses 0x23 or 0x5c, default 0x23
2151 bme280 Select the Bosch Sensortronic BME280
2152 Valid addresses 0x76-0x77, default 0x76
2154 bme680 Select the Bosch Sensortronic BME680
2155 Valid addresses 0x76-0x77, default 0x76
2157 bmp085 Select the Bosch Sensortronic BMP085
2159 bmp180 Select the Bosch Sensortronic BMP180
2161 bmp280 Select the Bosch Sensortronic BMP280
2162 Valid addresses 0x76-0x77, default 0x76
2164 bmp380 Select the Bosch Sensortronic BMP380
2165 Valid addresses 0x76-0x77, default 0x76
2167 bno055 Select the Bosch Sensortronic BNO055 IMU
2168 Valid address 0x28-0x29, default 0x29
2170 ccs811 Select the AMS CCS811 digital gas sensor
2171 Valid addresses 0x5a-0x5b, default 0x5b
2173 ds1621 Select the Dallas Semiconductors DS1621 temp
2174 sensor. Valid addresses 0x48-0x4f, default 0x48
2176 hdc100x Select the Texas Instruments HDC100x temp sensor
2177 Valid addresses 0x40-0x43, default 0x40
2179 htu21 Select the HTU21 temperature and humidity sensor
2181 int_pin Set the GPIO to use for interrupts (max30102,
2182 mpu6050 and mpu9250 only)
2184 jc42 Select any of the many JEDEC JC42.4-compliant
2185 temperature sensors, including:
2186 ADT7408, AT30TS00, CAT34TS02, CAT6095,
2187 MAX6604, MCP9804, MCP9805, MCP9808,
2188 MCP98242, MCP98243, MCP98244, MCP9843,
2189 SE97, SE98, STTS424(E), STTS2002, STTS3000,
2190 TSE2002, TSE2004, TS3000, and TS3001.
2191 The default address is 0x18.
2193 lm75 Select the Maxim LM75 temperature sensor
2194 Valid addresses 0x48-0x4f, default 0x4f
2196 lm75addr Deprecated - use addr parameter instead
2198 max17040 Select the Maxim Integrated MAX17040 battery
2201 max30102 Select the Maxim Integrated MAX30102 heart-rate
2202 and blood-oxygen sensor
2204 mcp980x Select the Maxim MCP980x range of temperature
2205 sensors (i.e. MCP9800, MCP9801, MCP9802 and
2206 MCP9803). N.B. For MCP9804, MCP9805 and MCP9808,
2207 use the "jc42" option.
2208 Valid addresses are 0x18-0x1f (default 0x18)
2210 mpu6050 Select the InvenSense MPU6050 IMU. Valid
2211 valid addresses are 0x68 and 0x69 (default 0x68)
2213 mpu9250 Select the InvenSense MPU9250 IMU. Valid
2214 valid addresses are 0x68 and 0x69 (default 0x68)
2216 ms5637 Select the Measurement Specialities MS5637
2217 pressure and temperature sensor.
2219 ms5803 Select the Measurement Specialities MS5803
2220 pressure and temperature sensor.
2222 ms5805 Select the Measurement Specialities MS5805
2223 pressure and temperature sensor.
2225 ms5837 Select the Measurement Specialities MS5837
2226 pressure and temperature sensor.
2228 ms8607 Select the Measurement Specialities MS8607
2229 pressure and temperature sensor.
2231 no_timeout Disable the SMBUS timeout. N.B. Only supported
2232 by some jc42 devices - using with an
2233 incompatible device can stop it from being
2236 reset_pin GPIO to be used to reset the device (bno055
2237 only, disabled by default)
2239 sht3x Select the Sensirion SHT3x temperature and
2240 humidity sensors. Valid addresses 0x44-0x45,
2243 sht4x Select the Sensirion SHT4x temperature and
2244 humidity sensors. Valid addresses 0x44-0x45,
2247 si7020 Select the Silicon Labs Si7013/20/21 humidity/
2250 sps30 Select the Sensirion SPS30 particulate matter
2251 sensor. Fixed address 0x69.
2253 sgp30 Select the Sensirion SGP30 VOC sensor.
2256 tmp102 Select the Texas Instruments TMP102 temp sensor
2257 Valid addresses 0x48-0x4b, default 0x48
2259 tsl4531 Select the AMS TSL4531 digital ambient light
2262 veml6070 Select the Vishay VEML6070 ultraviolet light
2265 i2c0 Choose the I2C0 bus on GPIOs 0&1
2267 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2269 i2c3 Choose the I2C3 bus (configure with the i2c3
2270 overlay - BCM2711 only)
2272 i2c4 Choose the I2C3 bus (configure with the i2c3
2273 overlay - BCM2711 only)
2275 i2c5 Choose the I2C5 bus (configure with the i2c4
2276 overlay - BCM2711 only)
2278 i2c6 Choose the I2C6 bus (configure with the i2c6
2279 overlay - BCM2711 only)
2283 Info: Change i2c0 pin usage. Not all pin combinations are usable on all
2284 platforms - platforms other then Compute Modules can only use this
2285 to disable transaction combining.
2286 Do NOT use in conjunction with dtparam=i2c_vc=on. From the 5.4 kernel
2287 onwards the base DT includes the use of i2c_mux_pinctrl to expose two
2288 muxings of BSC0 - GPIOs 0&1, and whichever combination is used for the
2289 camera and display connectors. This overlay disables that mux and
2290 configures /dev/i2c0 to point at whichever set of pins is requested.
2291 dtparam=i2c_vc=on will try and enable the mux, so combining the two
2292 will cause conflicts.
2293 Load: dtoverlay=i2c0,<param>=<val>
2294 Params: pins_0_1 Use pins 0 and 1 (default)
2295 pins_28_29 Use pins 28 and 29
2296 pins_44_45 Use pins 44 and 45
2297 pins_46_47 Use pins 46 and 47
2298 combine Allow transactions to be combined (default
2303 Info: Deprecated, legacy version of i2c0.
2308 Info: Enable i2c0 (Pi 5 only)
2309 Load: dtoverlay=i2c0-pi5,<param>=<val>
2310 Params: pins_0_1 Use GPIOs 0 and 1 (default)
2311 pins_8_9 Use GPIOs 8 and 9
2312 baudrate Set the baudrate for the interface (default
2317 Info: Change i2c1 pin usage. Not all pin combinations are usable on all
2318 platforms - platforms other then Compute Modules can only use this
2319 to disable transaction combining.
2320 Load: dtoverlay=i2c1,<param>=<val>
2321 Params: pins_2_3 Use pins 2 and 3 (default)
2322 pins_44_45 Use pins 44 and 45
2323 combine Allow transactions to be combined (default
2328 Info: Deprecated, legacy version of i2c1.
2333 Info: Enable i2c1 (Pi 5 only)
2334 Load: dtoverlay=i2c1-pi5,<param>=<val>
2335 Params: pins_2_3 Use GPIOs 2 and 3 (default)
2336 pins_10_11 Use GPIOs 10 and 11
2337 baudrate Set the baudrate for the interface (default
2342 Info: Enable i2c2 (Pi 5 only)
2343 Load: dtoverlay=i2c2-pi5,<param>=<val>
2344 Params: pins_4_5 Use GPIOs 4 and 5 (default)
2345 pins_12_13 Use GPIOs 12 and 13
2346 baudrate Set the baudrate for the interface (default
2351 Info: Enable the i2c3 bus. BCM2711 only.
2352 Load: dtoverlay=i2c3,<param>
2353 Params: pins_2_3 Use GPIOs 2 and 3
2354 pins_4_5 Use GPIOs 4 and 5 (default)
2355 baudrate Set the baudrate for the interface (default
2360 Info: Enable i2c3 (Pi 5 only)
2361 Load: dtoverlay=i2c3-pi5,<param>=<val>
2362 Params: pins_6_7 Use GPIOs 6 and 7 (default)
2363 pins_14_15 Use GPIOs 14 and 15
2364 pins_22_23 Use GPIOs 22 and 23
2365 baudrate Set the baudrate for the interface (default
2370 Info: Enable the i2c4 bus. BCM2711 only.
2371 Load: dtoverlay=i2c4,<param>
2372 Params: pins_6_7 Use GPIOs 6 and 7
2373 pins_8_9 Use GPIOs 8 and 9 (default)
2374 baudrate Set the baudrate for the interface (default
2379 Info: Enable the i2c5 bus. BCM2711 only.
2380 Load: dtoverlay=i2c5,<param>
2381 Params: pins_10_11 Use GPIOs 10 and 11
2382 pins_12_13 Use GPIOs 12 and 13 (default)
2383 baudrate Set the baudrate for the interface (default
2388 Info: Enable the i2c6 bus. BCM2711 only.
2389 Load: dtoverlay=i2c6,<param>
2390 Params: pins_0_1 Use GPIOs 0 and 1
2391 pins_22_23 Use GPIOs 22 and 23 (default)
2392 baudrate Set the baudrate for the interface (default
2397 Info: Configures any passive I2S DAC soundcard.
2398 Load: dtoverlay=i2s-dac
2403 Info: move I2S function block to GPIO 28 to 31
2404 Load: dtoverlay=i2s-gpio28-31
2409 Info: Enables I2C connected Ilitek 251x multiple touch controller using
2410 GPIO 4 (pin 7 on GPIO header) for interrupt.
2411 Load: dtoverlay=ilitek251x,<param>=<val>
2412 Params: interrupt GPIO used for interrupt (default 4)
2413 sizex Touchscreen size x, horizontal resolution of
2414 touchscreen (in pixels)
2415 sizey Touchscreen size y, vertical resolution of
2416 touchscreen (in pixels)
2420 Info: Sony IMX219 camera module.
2421 Uses Unicam 1, which is the standard camera connector on most Pi
2423 Load: dtoverlay=imx219,<param>=<val>
2424 Params: rotation Mounting rotation of the camera sensor (0 or
2426 orientation Sensor orientation (0 = front, 1 = rear,
2427 2 = external, default external)
2428 media-controller Configure use of Media Controller API for
2429 configuring the sensor (default on)
2430 cam0 Adopt the default configuration for CAM0 on a
2431 Compute Module (CSI0, i2c_vc, and cam0_reg).
2432 vcm Configure a VCM focus drive on the sensor.
2436 Info: Sony IMX258 camera module.
2437 Uses Unicam 1, which is the standard camera connector on most Pi
2439 Load: dtoverlay=imx258,<param>=<val>
2440 Params: rotation Mounting rotation of the camera sensor (0 or
2442 orientation Sensor orientation (0 = front, 1 = rear,
2443 2 = external, default external)
2444 media-controller Configure use of Media Controller API for
2445 configuring the sensor (default on)
2446 cam0 Adopt the default configuration for CAM0 on a
2447 Compute Module (CSI0, i2c_vc, and cam0_reg).
2448 vcm Configure a VCM focus drive on the sensor.
2449 4lane Enable 4 CSI2 lanes. This requires a Compute
2450 Module (1, 3, or 4).
2454 Info: Sony IMX290 camera module.
2455 Uses Unicam 1, which is the standard camera connector on most Pi
2457 Load: dtoverlay=imx290,<param>
2458 Params: 4lane Enable 4 CSI2 lanes. This requires a Compute
2459 Module (1, 3, or 4).
2460 clock-frequency Sets the clock frequency to match that used on
2462 Modules from Vision Components use 37.125MHz
2463 (the default), whilst those from Innomaker use
2465 mono Denote that the module is a mono sensor.
2466 orientation Sensor orientation (0 = front, 1 = rear,
2467 2 = external, default external)
2468 rotation Mounting rotation of the camera sensor (0 or
2470 media-controller Configure use of Media Controller API for
2471 configuring the sensor (default on)
2472 cam0 Adopt the default configuration for CAM0 on a
2473 Compute Module (CSI0, i2c_vc, and cam0_reg).
2477 Info: Sony IMX296 camera module.
2478 Uses Unicam 1, which is the standard camera connector on most Pi
2480 Load: dtoverlay=imx296,<param>=<val>
2481 Params: rotation Mounting rotation of the camera sensor (0 or
2483 orientation Sensor orientation (0 = front, 1 = rear,
2484 2 = external, default external)
2485 media-controller Configure use of Media Controller API for
2486 configuring the sensor (default on)
2487 cam0 Adopt the default configuration for CAM0 on a
2488 Compute Module (CSI0, i2c_vc, and cam0_reg).
2489 clock-frequency Sets the clock frequency to match that used on
2490 the board, which should be one of 54000000
2491 (the default), 37125000 or 74250000.
2495 Info: Sony IMX327 camera module.
2496 Uses Unicam 1, which is the standard camera connector on most Pi
2498 Load: dtoverlay=imx327,<param>
2499 Params: 4lane Enable 4 CSI2 lanes. This requires a Compute
2500 Module (1, 3, or 4).
2501 clock-frequency Sets the clock frequency to match that used on
2503 Modules from Vision Components use 37.125MHz
2504 (the default), whilst those from Innomaker use
2506 mono Denote that the module is a mono sensor.
2507 orientation Sensor orientation (0 = front, 1 = rear,
2508 2 = external, default external)
2509 rotation Mounting rotation of the camera sensor (0 or
2511 media-controller Configure use of Media Controller API for
2512 configuring the sensor (default on)
2513 cam0 Adopt the default configuration for CAM0 on a
2514 Compute Module (CSI0, i2c_vc, and cam0_reg).
2518 Info: Sony IMX378 camera module.
2519 Uses Unicam 1, which is the standard camera connector on most Pi
2521 Load: dtoverlay=imx378,<param>=<val>
2522 Params: rotation Mounting rotation of the camera sensor (0 or
2524 orientation Sensor orientation (0 = front, 1 = rear,
2525 2 = external, default external)
2526 media-controller Configure use of Media Controller API for
2527 configuring the sensor (default on)
2528 cam0 Adopt the default configuration for CAM0 on a
2529 Compute Module (CSI0, i2c_vc, and cam0_reg).
2533 Info: Sony IMX462 camera module.
2534 Uses Unicam 1, which is the standard camera connector on most Pi
2536 Load: dtoverlay=imx462,<param>
2537 Params: 4lane Enable 4 CSI2 lanes. This requires a Compute
2538 Module (1, 3, or 4).
2539 clock-frequency Sets the clock frequency to match that used on
2541 Modules from Vision Components use 37.125MHz
2542 (the default), whilst those from Innomaker use
2544 mono Denote that the module is a mono sensor.
2545 orientation Sensor orientation (0 = front, 1 = rear,
2546 2 = external, default external)
2547 rotation Mounting rotation of the camera sensor (0 or
2549 media-controller Configure use of Media Controller API for
2550 configuring the sensor (default on)
2551 cam0 Adopt the default configuration for CAM0 on a
2552 Compute Module (CSI0, i2c_vc, and cam0_reg).
2556 Info: Sony IMX477 camera module.
2557 Uses Unicam 1, which is the standard camera connector on most Pi
2559 Load: dtoverlay=imx477,<param>=<val>
2560 Params: rotation Mounting rotation of the camera sensor (0 or
2562 orientation Sensor orientation (0 = front, 1 = rear,
2563 2 = external, default external)
2564 media-controller Configure use of Media Controller API for
2565 configuring the sensor (default on)
2566 cam0 Adopt the default configuration for CAM0 on a
2567 Compute Module (CSI0, i2c_vc, and cam0_reg).
2571 Info: Sony IMX519 camera module.
2572 Uses Unicam 1, which is the standard camera connector on most Pi
2574 Load: dtoverlay=imx519,<param>=<val>
2575 Params: rotation Mounting rotation of the camera sensor (0 or
2577 orientation Sensor orientation (0 = front, 1 = rear,
2578 2 = external, default external)
2579 media-controller Configure use of Media Controller API for
2580 configuring the sensor (default on)
2581 cam0 Adopt the default configuration for CAM0 on a
2582 Compute Module (CSI0, i2c_vc, and cam0_reg).
2583 vcm Select lens driver state. Default is enabled,
2584 but vcm=off will disable.
2588 Info: Sony IMX708 camera module.
2589 Uses Unicam 1, which is the standard camera connector on most Pi
2591 Load: dtoverlay=imx708,<param>=<val>
2592 Params: rotation Mounting rotation of the camera sensor (0 or
2594 orientation Sensor orientation (0 = front, 1 = rear,
2595 2 = external, default external)
2596 vcm Select lens driver state. Default is enabled,
2597 but vcm=off will disable.
2598 media-controller Configure use of Media Controller API for
2599 configuring the sensor (default on)
2600 cam0 Adopt the default configuration for CAM0 on a
2601 Compute Module (CSI0, i2c_vc, and cam0_reg).
2602 link-frequency Allowable link frequency values to use in Hz:
2603 450000000 (default), 447000000, 453000000.
2607 Info: Configures the IQaudio Codec audio card
2608 Load: dtoverlay=iqaudio-codec
2613 Info: Configures the IQaudio DAC audio card
2614 Load: dtoverlay=iqaudio-dac,<param>
2615 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2616 Digital volume control. Enable with
2617 "dtoverlay=iqaudio-dac,24db_digital_gain"
2618 (The default behaviour is that the Digital
2619 volume control is limited to a maximum of
2620 0dB. ie. it can attenuate but not provide
2621 gain. For most users, this will be desired
2622 as it will prevent clipping. By appending
2623 the 24db_digital_gain parameter, the Digital
2624 volume control will allow up to 24dB of
2625 gain. If this parameter is enabled, it is the
2626 responsibility of the user to ensure that
2627 the Digital volume control is set to a value
2628 that does not result in clipping/distortion!)
2631 Name: iqaudio-dacplus
2632 Info: Configures the IQaudio DAC+ audio card
2633 Load: dtoverlay=iqaudio-dacplus,<param>=<val>
2634 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2635 Digital volume control. Enable with
2636 "dtoverlay=iqaudio-dacplus,24db_digital_gain"
2637 (The default behaviour is that the Digital
2638 volume control is limited to a maximum of
2639 0dB. ie. it can attenuate but not provide
2640 gain. For most users, this will be desired
2641 as it will prevent clipping. By appending
2642 the 24db_digital_gain parameter, the Digital
2643 volume control will allow up to 24dB of
2644 gain. If this parameter is enabled, it is the
2645 responsibility of the user to ensure that
2646 the Digital volume control is set to a value
2647 that does not result in clipping/distortion!)
2648 auto_mute_amp If specified, unmute/mute the IQaudIO amp when
2649 starting/stopping audio playback.
2650 unmute_amp If specified, unmute the IQaudIO amp once when
2651 the DAC driver module loads.
2654 Name: iqaudio-digi-wm8804-audio
2655 Info: Configures the IQAudIO Digi WM8804 audio card
2656 Load: dtoverlay=iqaudio-digi-wm8804-audio,<param>=<val>
2657 Params: card_name Override the default, "IQAudIODigi", card name.
2658 dai_name Override the default, "IQAudIO Digi", dai name.
2659 dai_stream_name Override the default, "IQAudIO Digi HiFi",
2664 Info: Enables I2C connected Azoteq IQS550 trackpad/touchscreen controller
2665 using GPIO 4 (pin 7 on GPIO header) for interrupt.
2666 Load: dtoverlay=iqs550,<param>=<val>
2667 Params: interrupt GPIO used for interrupt (default 4)
2668 reset GPIO used for reset (optional)
2669 sizex Touchscreen size x (default 800)
2670 sizey Touchscreen size y (default 480)
2671 invx Touchscreen inverted x axis
2672 invy Touchscreen inverted y axis
2673 swapxy Touchscreen swapped x y axis
2677 Info: Infineon irs1125 TOF camera module.
2678 Uses Unicam 1, which is the standard camera connector on most Pi
2680 Load: dtoverlay=irs1125,<param>=<val>
2681 Params: media-controller Configure use of Media Controller API for
2682 configuring the sensor (default off)
2683 cam0 Adopt the default configuration for CAM0 on a
2684 Compute Module (CSI0, i2c_vc, and cam0_reg).
2688 Info: Adds support for JEDEC-compliant SPI NOR flash devices. (Note: The
2689 "jedec,spi-nor" kernel driver was formerly known as "m25p80".)
2690 Load: dtoverlay=jedec-spi-nor,<param>=<val>
2691 Params: spi<n>-<m> Enable flash device on SPI<n>, CS#<m>
2692 fastr Add fast read capability to the flash device
2693 speed Maximum SPI frequency (Hz)
2694 flash-spi<n>-<m> Same as spi<n>-<m> (deprecated)
2695 flash-fastr-spi<n>-<m> Same as spi<n>->m>,fastr (deprecated)
2699 Info: Simultaneous usage of an justboom-dac and justboom-digi based
2701 Load: dtoverlay=justboom-both,<param>=<val>
2702 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2703 Digital volume control. Enable with
2704 "dtoverlay=justboom-dac,24db_digital_gain"
2705 (The default behaviour is that the Digital
2706 volume control is limited to a maximum of
2707 0dB. ie. it can attenuate but not provide
2708 gain. For most users, this will be desired
2709 as it will prevent clipping. By appending
2710 the 24dB_digital_gain parameter, the Digital
2711 volume control will allow up to 24dB of
2712 gain. If this parameter is enabled, it is the
2713 responsibility of the user to ensure that
2714 the Digital volume control is set to a value
2715 that does not result in clipping/distortion!)
2719 Info: Configures the JustBoom DAC HAT, Amp HAT, DAC Zero and Amp Zero audio
2721 Load: dtoverlay=justboom-dac,<param>=<val>
2722 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
2723 Digital volume control. Enable with
2724 "dtoverlay=justboom-dac,24db_digital_gain"
2725 (The default behaviour is that the Digital
2726 volume control is limited to a maximum of
2727 0dB. ie. it can attenuate but not provide
2728 gain. For most users, this will be desired
2729 as it will prevent clipping. By appending
2730 the 24dB_digital_gain parameter, the Digital
2731 volume control will allow up to 24dB of
2732 gain. If this parameter is enabled, it is the
2733 responsibility of the user to ensure that
2734 the Digital volume control is set to a value
2735 that does not result in clipping/distortion!)
2739 Info: Configures the JustBoom Digi HAT and Digi Zero audio cards
2740 Load: dtoverlay=justboom-digi
2745 Info: This overlay has been deprecated and removed - see gpio-ir
2750 Info: Adds support for the ltc294x family of battery gauges
2751 Load: dtoverlay=ltc294x,<param>=<val>
2752 Params: ltc2941 Select the ltc2941 device
2754 ltc2942 Select the ltc2942 device
2756 ltc2943 Select the ltc2943 device
2758 ltc2944 Select the ltc2944 device
2760 resistor-sense The sense resistor value in milli-ohms.
2761 Can be a 32-bit negative value when the battery
2762 has been connected to the wrong end of the
2765 prescaler-exponent Range and accuracy of the gauge. The value is
2766 programmed into the chip only if it differs
2767 from the current setting.
2769 - Default value is 128
2770 - the exponent is in the range 0-7 (default 7)
2771 See the datasheet for more information.
2775 Info: Configures the Maxim MAX98357A I2S DAC
2776 Load: dtoverlay=max98357a,<param>=<val>
2777 Params: no-sdmode Driver does not manage the state of the DAC's
2778 SD_MODE pin (i.e. chip is always on).
2779 sdmode-pin integer, GPIO pin connected to the SD_MODE input
2780 of the DAC (default GPIO4 if parameter omitted).
2784 Info: Configure a MAX6675, MAX31855 or MAX31856 thermocouple as an IIO device.
2786 For devices on spi1 or spi2, the interfaces should be enabled
2787 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2788 The overlay expects to disable the relevant spidev node, so also using
2789 e.g. cs0_spidev=off is unnecessary.
2792 MAX31855 on /dev/spidev0.0
2793 dtoverlay=maxtherm,spi0-0,max31855
2794 MAX31856 using a type J thermocouple on /dev/spidev2.1
2796 dtoverlay=maxtherm,spi2-1,max31856,type_j
2798 Load: dtoverlay=maxtherm,<param>=<val>
2799 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
2801 max6675 Enable support for the MAX6675 (default)
2802 max31855 Enable support for the MAX31855
2803 max31855e Enable support for the MAX31855E
2804 max31855j Enable support for the MAX31855J
2805 max31855k Enable support for the MAX31855K
2806 max31855n Enable support for the MAX31855N
2807 max31855r Enable support for the MAX31855R
2808 max31855s Enable support for the MAX31855S
2809 max31855t Enable support for the MAX31855T
2810 max31856 Enable support for the MAX31856 (with type K)
2811 type_b Select a type B sensor for max31856
2812 type_e Select a type E sensor for max31856
2813 type_j Select a type J sensor for max31856
2814 type_k Select a type K sensor for max31856
2815 type_n Select a type N sensor for max31856
2816 type_r Select a type R sensor for max31856
2817 type_s Select a type S sensor for max31856
2818 type_t Select a type T sensor for max31856
2822 Info: Configures the mbed AudioCODEC (TLV320AIC23B)
2823 Load: dtoverlay=mbed-dac
2828 Info: Configures the MCP23017 I2C GPIO expander
2829 Load: dtoverlay=mcp23017,<param>=<val>
2830 Params: gpiopin Gpio pin connected to the INTA output of the
2831 MCP23017 (default: 4)
2833 addr I2C address of the MCP23017 (default: 0x20)
2835 mcp23008 Configure an MCP23008 instead.
2836 noints Disable the interrupt GPIO line.
2837 i2c0 Choose the I2C0 bus on GPIOs 0&1
2838 i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45
2839 i2c3 Choose the I2C3 bus (configure with the i2c3
2840 overlay - BCM2711 only)
2841 i2c4 Choose the I2C4 bus (configure with the i2c4
2842 overlay - BCM2711 only)
2843 i2c5 Choose the I2C5 bus (configure with the i2c5
2844 overlay - BCM2711 only)
2845 i2c6 Choose the I2C6 bus (configure with the i2c6
2846 overlay - BCM2711 only)
2850 Info: Configures the MCP23S08/17 SPI GPIO expanders.
2851 If devices are present on SPI1 or SPI2, those interfaces must be enabled
2852 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2853 If interrupts are enabled for a device on a given CS# on a SPI bus, that
2854 device must be the only one present on that SPI bus/CS#.
2855 Load: dtoverlay=mcp23s17,<param>=<val>
2856 Params: s08-spi<n>-<m>-present 4-bit integer, bitmap indicating MCP23S08
2857 devices present on SPI<n>, CS#<m>
2859 s17-spi<n>-<m>-present 8-bit integer, bitmap indicating MCP23S17
2860 devices present on SPI<n>, CS#<m>
2862 s08-spi<n>-<m>-int-gpio integer, enables interrupts on a single
2863 MCP23S08 device on SPI<n>, CS#<m>, specifies
2864 the GPIO pin to which INT output of MCP23S08
2867 s17-spi<n>-<m>-int-gpio integer, enables mirrored interrupts on a
2868 single MCP23S17 device on SPI<n>, CS#<m>,
2869 specifies the GPIO pin to which either INTA
2870 or INTB output of MCP23S17 is connected.
2874 Info: Configures the MCP2515 CAN controller on spi0/1/2
2875 For devices on spi1 or spi2, the interfaces should be enabled
2876 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2877 Load: dtoverlay=mcp2515,<param>=<val>
2878 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
2881 oscillator Clock frequency for the CAN controller (Hz)
2883 speed Maximum SPI frequence (Hz)
2885 interrupt GPIO for interrupt signal
2889 Info: Configures the MCP2515 CAN controller on spi0.0
2890 Load: dtoverlay=mcp2515-can0,<param>=<val>
2891 Params: oscillator Clock frequency for the CAN controller (Hz)
2893 spimaxfrequency Maximum SPI frequence (Hz)
2895 interrupt GPIO for interrupt signal
2899 Info: Configures the MCP2515 CAN controller on spi0.1
2900 Load: dtoverlay=mcp2515-can1,<param>=<val>
2901 Params: oscillator Clock frequency for the CAN controller (Hz)
2903 spimaxfrequency Maximum SPI frequence (Hz)
2905 interrupt GPIO for interrupt signal
2909 Info: Configures the MCP251XFD CAN controller family
2910 For devices on spi1 or spi2, the interfaces should be enabled
2911 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2912 Load: dtoverlay=mcp251xfd,<param>=<val>
2913 Params: spi<n>-<m> Configure device at spi<n>, cs<m>
2916 oscillator Clock frequency for the CAN controller (Hz)
2918 speed Maximum SPI frequence (Hz)
2920 interrupt GPIO for interrupt signal
2922 rx_interrupt GPIO for RX interrupt signal (nINT1) (optional)
2924 xceiver_enable GPIO for CAN transceiver enable (optional)
2926 xceiver_active_high specifiy if CAN transceiver enable pin is
2927 active high (optional, default: active low)
2931 Info: Configures MCP3008 A/D converters
2932 For devices on spi1 or spi2, the interfaces should be enabled
2933 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2934 Load: dtoverlay=mcp3008,<param>[=<val>]
2935 Params: spi<n>-<m>-present boolean, configure device at spi<n>, cs<m>
2936 spi<n>-<m>-speed integer, set the spi bus speed for this device
2940 Info: Configures MCP3202 A/D converters
2941 For devices on spi1 or spi2, the interfaces should be enabled
2942 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2943 Load: dtoverlay=mcp3202,<param>[=<val>]
2944 Params: spi<n>-<m>-present boolean, configure device at spi<n>, cs<m>
2945 spi<n>-<m>-speed integer, set the spi bus speed for this device
2949 Info: Overlay for activation of Microchip MCP3421-3428 ADCs over I2C
2950 Load: dtoverlay=mcp342x,<param>=<val>
2951 Params: addr I2C bus address of device, for devices with
2952 addresses that are configurable, e.g. by
2953 hardware links (default=0x68)
2954 mcp3421 The device is an MCP3421
2955 mcp3422 The device is an MCP3422
2956 mcp3423 The device is an MCP3423
2957 mcp3424 The device is an MCP3424
2958 mcp3425 The device is an MCP3425
2959 mcp3426 The device is an MCP3426
2960 mcp3427 The device is an MCP3427
2961 mcp3428 The device is an MCP3428
2965 Info: Media Center HAT - 2.83" Touch Display + extras by Pi Supply
2966 Load: dtoverlay=media-center,<param>=<val>
2967 Params: speed Display SPI bus speed
2968 rotate Display rotation {0,90,180,270}
2969 fps Delay between frame updates
2970 xohms Touchpanel sensitivity (X-plate resistance)
2971 swapxy Swap x and y axis
2972 backlight Change backlight GPIO pin {e.g. 12, 18}
2973 debug "on" = enable additional debug messages
2978 Info: Configures the merus-amp audio card
2979 Load: dtoverlay=merus-amp
2984 Info: Configures UART0 (ttyAMA0) so that a requested 38.4kbaud actually gets
2985 31.25kbaud, the frequency required for MIDI
2986 Load: dtoverlay=midi-uart0
2990 Name: midi-uart0-pi5
2991 Info: See midi-uart0 (this is the Pi 5 version)
2995 Info: Configures UART1 (ttyS0) so that a requested 38.4kbaud actually gets
2996 31.25kbaud, the frequency required for MIDI
2997 Load: dtoverlay=midi-uart1
3001 Name: midi-uart1-pi5
3002 Info: See midi-uart1 (this is the Pi 5 version)
3006 Info: Configures UART2 (ttyAMA2) so that a requested 38.4kbaud actually gets
3007 31.25kbaud, the frequency required for MIDI
3008 Load: dtoverlay=midi-uart2
3012 Name: midi-uart2-pi5
3013 Info: See midi-uart2 (this is the Pi 5 version)
3017 Info: Configures UART3 (ttyAMA3) so that a requested 38.4kbaud actually gets
3018 31.25kbaud, the frequency required for MIDI
3019 Load: dtoverlay=midi-uart3
3023 Name: midi-uart3-pi5
3024 Info: See midi-uart3 (this is the Pi 5 version)
3028 Info: Configures UART4 (ttyAMA4) so that a requested 38.4kbaud actually gets
3029 31.25kbaud, the frequency required for MIDI
3030 Load: dtoverlay=midi-uart4
3034 Name: midi-uart4-pi5
3035 Info: See midi-uart4 (this is the Pi 5 version)
3039 Info: Configures UART5 (ttyAMA5) so that a requested 38.4kbaud actually gets
3040 31.25kbaud, the frequency required for MIDI
3041 Load: dtoverlay=midi-uart5
3046 Info: Overlay for AdaFruit Mini Pi 1.3" TFT via SPI using fbtft driver.
3047 Load: dtoverlay=minipitft13,<param>=<val>
3048 Params: speed SPI bus speed (default 32000000)
3049 rotate Display rotation (0, 90, 180 or 270; default 0)
3050 width Display width (default 240)
3051 height Display height (default 240)
3052 fps Delay between frame updates (default 25)
3053 debug Debug output level (0-7; default 0)
3057 Info: Switch the onboard Bluetooth function of a BT-equipped Raspberry Pi
3058 to use the mini-UART (ttyS0) and restore UART0/ttyAMA0 over GPIOs 14 &
3059 15. Note that this option uses a lower baudrate, and should only be used
3060 with low-bandwidth peripherals.
3061 Load: dtoverlay=miniuart-bt,<param>=<val>
3062 Params: krnbt Set to "off" to disable autoprobing of Bluetooth
3063 driver without need of hciattach/btattach
3067 Info: Overlay for SPI-connected MIPI DBI displays using the panel-mipi-dbi
3068 driver. The driver will load a file /lib/firmware/panel.bin containing
3069 the initialisation commands.
3072 dtoverlay=mipi-dbi-spi,spi0-0,speed=70000000
3073 dtparam=width=320,height=240
3074 dtparam=reset-gpio=23,dc-gpio=24
3075 dtparam=backlight-gpio=18
3077 Compared to fbtft panel-mipi-dbi runs pixel data at spi-max-frequency
3078 and init commands at 10MHz. This makes it possible to push the envelope
3079 without messing up the controller configuration due to command
3080 transmission errors.
3082 For devices on spi1 or spi2, the interfaces should be enabled
3083 with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
3085 See https://github.com/notro/panel-mipi-dbi/wiki for more info.
3087 Load: dtoverlay=mipi-dbi-spi,<param>=<val>
3089 compatible Set the compatible string to load a different
3090 firmware file. Both the panel compatible value
3091 used to load the firmware file and the value
3092 used to load the driver has to be set having a
3093 NUL (\0) separator between them.
3095 dtparam=compatible=mypanel\0panel-mipi-dbi-spi
3096 spi<n>-<m> Configure device at spi<n>, cs<m>
3098 speed SPI bus speed in Hz (default 32000000)
3099 cpha Shifted SPI clock phase (CPHA) mode
3100 cpol Inverse SPI clock polarity (CPOL) mode
3101 write-only Controller is not readable
3102 (ie. MISO is not wired up).
3104 width Panel width in pixels (required)
3105 height Panel height in pixels (required)
3106 width-mm Panel width in mm
3107 height-mm Panel height in mm
3108 x-offset Panel x-offset in controller RAM
3109 y-offset Panel y-offset in controller RAM
3111 clock-frequency Panel clock frequency in Hz
3112 (optional, just informational).
3114 reset-gpio GPIO pin to be used for RESET
3115 dc-gpio GPIO pin to be used for D/C
3117 backlight-gpio GPIO pin to be used for backlight control
3119 backlight-pwm PWM channel to be used for backlight control
3120 (default of none). NB Disables audio headphone
3121 output as that also uses PWM.
3122 backlight-pwm-chan Choose channel on &pwm node for backlight
3123 control (default 0).
3124 backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See
3125 pwm-2chan for valid options (default 18).
3126 backlight-pwm-func Pin function of GPIO used for the PWM backlight.
3127 See pwm-2chan for valid options (default 2).
3128 backlight-def-brightness
3129 Set the default brightness. Normal range 1-16.
3134 Info: Overlay for i2c connected mlx90640 thermal camera
3135 Load: dtoverlay=mlx90640
3140 Info: Selects the bcm2835-mmc SD/MMC driver, optionally with overclock
3141 Load: dtoverlay=mmc,<param>=<val>
3142 Params: overclock_50 Clock (in MHz) to use when the MMC framework
3147 Info: This overlay has been deprecated - use "dtoverlay=i2c-sensor,mpu6050"
3148 instead. Note that "int_pin" is the new name for the "interrupt"
3154 Info: MZ61581 display by Tontec
3155 Load: dtoverlay=mz61581,<param>=<val>
3156 Params: speed Display SPI bus speed
3158 rotate Display rotation {0,90,180,270}
3160 fps Delay between frame updates
3162 txbuflen Transmit buffer length (default 32768)
3164 debug Debug output level {0-7}
3166 xohms Touchpanel sensitivity (X-plate resistance)
3170 Info: Omnivision OV2311 camera module.
3171 Uses Unicam 1, which is the standard camera connector on most Pi
3173 Load: dtoverlay=ov2311,<param>=<val>
3174 Params: rotation Mounting rotation of the camera sensor (0 or
3176 orientation Sensor orientation (0 = front, 1 = rear,
3177 2 = external, default external)
3178 media-controller Configure use of Media Controller API for
3179 configuring the sensor (default on)
3180 cam0 Adopt the default configuration for CAM0 on a
3181 Compute Module (CSI0, i2c_vc, and cam0_reg).
3185 Info: Omnivision OV5647 camera module.
3186 Uses Unicam 1, which is the standard camera connector on most Pi
3188 Load: dtoverlay=ov5647,<param>=<val>
3189 Params: rotation Mounting rotation of the camera sensor (0 or
3191 orientation Sensor orientation (0 = front, 1 = rear,
3192 2 = external, default external)
3193 media-controller Configure use of Media Controller API for
3194 configuring the sensor (default on)
3195 cam0 Adopt the default configuration for CAM0 on a
3196 Compute Module (CSI0, i2c_vc, and cam0_reg).
3197 vcm Configure a VCM focus drive on the sensor.
3201 Info: Omnivision OV7251 camera module.
3202 Uses Unicam 1, which is the standard camera connector on most Pi
3204 Load: dtoverlay=ov7251,<param>=<val>
3205 Params: rotation Mounting rotation of the camera sensor (0 or
3207 orientation Sensor orientation (0 = front, 1 = rear,
3208 2 = external, default external)
3209 media-controller Configure use of Media Controller API for
3210 configuring the sensor (default off)
3211 cam0 Adopt the default configuration for CAM0 on a
3212 Compute Module (CSI0, i2c_vc, and cam0_reg).
3216 Info: Omnivision OV9281 camera module.
3217 Uses Unicam 1, which is the standard camera connector on most Pi
3219 Load: dtoverlay=ov9281,<param>=<val>
3220 Params: rotation Mounting rotation of the camera sensor (0 or
3222 orientation Sensor orientation (0 = front, 1 = rear,
3223 2 = external, default external)
3224 media-controller Configure use of Media Controller API for
3225 configuring the sensor (default on)
3226 cam0 Adopt the default configuration for CAM0 on a
3227 Compute Module (CSI0, i2c_vc, and cam0_reg).
3231 Info: PaPiRus ePaper Screen by Pi Supply (both HAT and pHAT)
3232 Load: dtoverlay=papirus,<param>=<val>
3233 Params: panel Display panel (required):
3238 speed Display SPI bus speed
3242 Info: TI PCA953x family of I2C GPIO expanders. Default is for NXP PCA9534.
3243 Load: dtoverlay=pca953x,<param>=<val>
3244 Params: addr I2C address of expander. Default 0x20.
3245 pca6416 Select the NXP PCA6416 (16 bit)
3246 pca9505 Select the NXP PCA9505 (40 bit)
3247 pca9535 Select the NXP PCA9535 (16 bit)
3248 pca9536 Select the NXP PCA9536 or TI PCA9536 (4 bit)
3249 pca9537 Select the NXP PCA9537 (4 bit)
3250 pca9538 Select the NXP PCA9538 (8 bit)
3251 pca9539 Select the NXP PCA9539 (16 bit)
3252 pca9554 Select the NXP PCA9554 (8 bit)
3253 pca9555 Select the NXP PCA9555 (16 bit)
3254 pca9556 Select the NXP PCA9556 (8 bit)
3255 pca9557 Select the NXP PCA9557 (8 bit)
3256 pca9574 Select the NXP PCA9574 (8 bit)
3257 pca9575 Select the NXP PCA9575 (16 bit)
3258 pca9698 Select the NXP PCA9698 (40 bit)
3259 pcal6416 Select the NXP PCAL6416 (16 bit)
3260 pcal6524 Select the NXP PCAL6524 (24 bit)
3261 pcal9555a Select the NXP PCAL9555A (16 bit)
3262 max7310 Select the Maxim MAX7310 (8 bit)
3263 max7312 Select the Maxim MAX7312 (16 bit)
3264 max7313 Select the Maxim MAX7313 (16 bit)
3265 max7315 Select the Maxim MAX7315 (8 bit)
3266 pca6107 Select the TI PCA6107 (8 bit)
3267 tca6408 Select the TI TCA6408 (8 bit)
3268 tca6416 Select the TI TCA6416 (16 bit)
3269 tca6424 Select the TI TCA6424 (24 bit)
3270 tca9539 Select the TI TCA9539 (16 bit)
3271 tca9554 Select the TI TCA9554 (8 bit)
3272 cat9554 Select the Onnn CAT9554 (8 bit)
3273 pca9654 Select the Onnn PCA9654 (8 bit)
3274 xra1202 Select the Exar XRA1202 (8 bit)
3278 Info: NXP PCF857x family of I2C GPIO expanders.
3279 Load: dtoverlay=pcf857x,<param>=<val>
3280 Params: addr I2C address of expander. Default
3281 depends on model selected.
3282 pcf8574 Select the NXP PCF8574 (8 bit)
3283 pcf8574a Select the NXP PCF8574A (8 bit)
3284 pcf8575 Select the NXP PCF8575 (16 bit)
3285 pca8574 Select the NXP PCA8574 (8 bit)
3288 Name: pcie-32bit-dma
3289 Info: Force PCIe config to support 32bit DMA addresses at the expense of
3290 having to bounce buffers.
3291 Load: dtoverlay=pcie-32bit-dma
3295 [ The pcf2127-rtc overlay has been deleted. See i2c-rtc. ]
3298 [ The pcf8523-rtc overlay has been deleted. See i2c-rtc. ]
3301 [ The pcf8563-rtc overlay has been deleted. See i2c-rtc. ]
3305 Info: This overlay has been renamed act-led, keeping pi3-act-led as an alias
3306 for backwards compatibility.
3310 Name: pi3-disable-bt
3311 Info: This overlay has been renamed disable-bt, keeping pi3-disable-bt as an
3312 alias for backwards compatibility.
3316 Name: pi3-disable-wifi
3317 Info: This overlay has been renamed disable-wifi, keeping pi3-disable-wifi as
3318 an alias for backwards compatibility.
3322 Name: pi3-miniuart-bt
3323 Info: This overlay has been renamed miniuart-bt, keeping pi3-miniuart-bt as
3324 an alias for backwards compatibility.
3329 Info: Configures the pibell audio card.
3330 Load: dtoverlay=pibell,<param>=<val>
3331 Params: alsaname Set the name as it appears in ALSA (default
3336 Info: Configures the PiFace Digital mcp23s17 GPIO port expander.
3337 Load: dtoverlay=pifacedigital,<param>=<val>
3338 Params: spi-present-mask 8-bit integer, bitmap indicating MCP23S17 SPI0
3339 CS0 address. PiFace Digital supports addresses
3340 0-3, which can be configured with JP1 and JP2.
3344 Info: Configures the PiFi 40W stereo amplifier
3345 Load: dtoverlay=pifi-40
3350 Info: Configures the PiFi DAC HD
3351 Load: dtoverlay=pifi-dac-hd
3356 Info: Configures the PiFi DAC Zero
3357 Load: dtoverlay=pifi-dac-zero
3362 Info: Configures the PiFi Mini stereo amplifier
3363 Load: dtoverlay=pifi-mini-210
3368 Info: Configures the PiGlow by pimoroni.com
3369 Load: dtoverlay=piglow
3374 Info: PiScreen display by OzzMaker.com
3375 Load: dtoverlay=piscreen,<param>=<val>
3376 Params: speed Display SPI bus speed
3378 rotate Display rotation {0,90,180,270}
3380 fps Delay between frame updates
3382 debug Debug output level {0-7}
3384 xohms Touchpanel sensitivity (X-plate resistance)
3386 drm Select the DRM/KMS driver instead of the FBTFT
3391 Info: PiScreen 2 with resistive TP display by OzzMaker.com
3392 Load: dtoverlay=piscreen2r,<param>=<val>
3393 Params: speed Display SPI bus speed
3395 rotate Display rotation {0,90,180,270}
3397 fps Delay between frame updates
3399 debug Debug output level {0-7}
3401 xohms Touchpanel sensitivity (X-plate resistance)
3405 Info: Configures the Blokas Labs pisound card
3406 Load: dtoverlay=pisound
3411 Info: Adafruit PiTFT 2.2" screen
3412 Load: dtoverlay=pitft22,<param>=<val>
3413 Params: speed Display SPI bus speed
3415 rotate Display rotation {0,90,180,270}
3417 fps Delay between frame updates
3419 debug Debug output level {0-7}
3422 Name: pitft28-capacitive
3423 Info: Adafruit PiTFT 2.8" capacitive touch screen
3424 Load: dtoverlay=pitft28-capacitive,<param>=<val>
3425 Params: speed Display SPI bus speed
3427 rotate Display rotation {0,90,180,270}
3429 fps Delay between frame updates
3431 debug Debug output level {0-7}
3433 touch-sizex Touchscreen size x (default 240)
3435 touch-sizey Touchscreen size y (default 320)
3437 touch-invx Touchscreen inverted x axis
3439 touch-invy Touchscreen inverted y axis
3441 touch-swapxy Touchscreen swapped x y axis
3444 Name: pitft28-resistive
3445 Info: Adafruit PiTFT 2.8" resistive touch screen
3446 Load: dtoverlay=pitft28-resistive,<param>=<val>
3447 Params: speed Display SPI bus speed
3449 rotate Display rotation {0,90,180,270}
3451 fps Delay between frame updates
3453 debug Debug output level {0-7}
3455 drm Force the use of the mi0283qt DRM driver (by
3456 default the ili9340 framebuffer driver will
3457 be used in preference if available)
3460 Name: pitft35-resistive
3461 Info: Adafruit PiTFT 3.5" resistive touch screen
3462 Load: dtoverlay=pitft35-resistive,<param>=<val>
3463 Params: speed Display SPI bus speed
3465 rotate Display rotation {0,90,180,270}
3467 fps Delay between frame updates
3469 debug Debug output level {0-7}
3471 drm Force the use of the hx8357d DRM driver (by
3472 default the fb_hx8357d framebuffer driver will
3473 be used in preference if available)
3477 Info: Configures the pps-gpio (pulse-per-second time signal via GPIO).
3478 Load: dtoverlay=pps-gpio,<param>=<val>
3479 Params: gpiopin Input GPIO (default "18")
3480 assert_falling_edge When present, assert is indicated by a falling
3481 edge, rather than by a rising edge (default
3483 capture_clear Generate clear events on the trailing edge
3485 pull Desired pull-up/down state (off, down, up)
3490 Info: Configures the PROTO Audio Codec card
3491 Load: dtoverlay=proto-codec
3496 Info: Configures a single PWM channel
3497 Legal pin,function combinations for each channel:
3498 PWM0: 12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
3499 PWM1: 13,4(Alt0) 19,2(Alt5) 41,4(Alt0) 45,4(Alt0) 53,5(Alt1)
3501 1) Pin 18 is the only one available on all platforms, and
3502 it is the one used by the I2S audio interface.
3503 Pins 12 and 13 might be better choices on an A+, B+ or Pi2.
3504 2) The onboard analogue audio output uses both PWM channels.
3505 3) So be careful mixing audio and PWM.
3506 4) Currently the clock must have been enabled and configured
3508 Load: dtoverlay=pwm,<param>=<val>
3509 Params: pin Output pin (default 18) - see table
3510 func Pin function (default 2 = Alt5) - see above
3511 clock PWM clock frequency (informational)
3515 Info: Configures both PWM channels
3516 Legal pin,function combinations for each channel:
3517 PWM0: 12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
3518 PWM1: 13,4(Alt0) 19,2(Alt5) 41,4(Alt0) 45,4(Alt0) 53,5(Alt1)
3520 1) Pin 18 is the only one available on all platforms, and
3521 it is the one used by the I2S audio interface.
3522 Pins 12 and 13 might be better choices on an A+, B+ or Pi2.
3523 2) The onboard analogue audio output uses both PWM channels.
3524 3) So be careful mixing audio and PWM.
3525 4) Currently the clock must have been enabled and configured
3527 Load: dtoverlay=pwm-2chan,<param>=<val>
3528 Params: pin Output pin (default 18) - see table
3529 pin2 Output pin for other channel (default 19)
3530 func Pin function (default 2 = Alt5) - see above
3531 func2 Function for pin2 (default 2 = Alt5)
3532 clock PWM clock frequency (informational)
3536 Info: Use GPIO pin as pwm-assisted infrared transmitter output.
3537 This is an alternative to "gpio-ir-tx". pwm-ir-tx makes use
3538 of PWM0 to reduce the CPU load during transmission compared to
3539 gpio-ir-tx which uses bit-banging.
3540 Legal pin,function combinations are:
3541 12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
3542 Load: dtoverlay=pwm-ir-tx,<param>=<val>
3543 Params: gpio_pin Output GPIO (default 18)
3545 func Pin function (default 2 = Alt5)
3549 Info: Configures one or two PWM channel on PWM1 (BCM2711 only)
3551 1) The onboard analogue audio output uses both PWM channels.
3552 2) So be careful mixing audio and PWM.
3553 Note that even when only one pin is enabled, both channels are available
3554 from the PWM driver, so be careful to use the correct one.
3555 Load: dtoverlay=pwm1,<param>=<val>
3556 Params: clock PWM clock frequency (informational)
3557 pins_40 Enable channel 0 (PWM1_0) on GPIO 40
3558 pins_41 Enable channel 1 (PWM1_1) on GPIO 41
3559 pins_40_41 Enable channels 0 (PWM1_0) and 1 (PW1_1) on
3560 GPIOs 40 and 41 (default)
3561 pull_up Enable pull-ups on the PWM pins (default)
3562 pull_down Enable pull-downs on the PWM pins
3563 pull_off Disable pulls on the PWM pins
3567 Info: in-tech's Evaluation Board for PLC Stamp micro
3568 This uses spi0 and a separate GPIO interrupt to connect the QCA7000.
3569 Load: dtoverlay=qca7000,<param>=<val>
3570 Params: int_pin GPIO pin for interrupt signal (default 23)
3572 speed SPI bus speed (default 12 MHz)
3576 Info: in-tech's Evaluation Board for PLC Stamp micro (UART)
3577 This uses uart0/ttyAMA0 over GPIOs 14 & 15 to connect the QCA7000.
3578 But it requires disabling of onboard Bluetooth on
3579 Pi 3B, 3B+, 3A+, 4B and Zero W.
3580 Load: dtoverlay=qca7000-uart0,<param>=<val>
3581 Params: baudrate Set the baudrate for the UART (default
3586 Info: Enable the preservation of crash logs across a reboot. With
3587 systemd-pstore enabled (as it is on Raspberry Pi OS) the crash logs
3588 are moved to /var/lib/systemd/pstore/ on reboot.
3589 Load: dtoverlay=ramoops,<param>=<val>
3590 Params: base-addr Where to place the capture buffer (default
3592 total-size How much memory to allocate altogether (in
3593 bytes - default 64kB)
3594 record-size How much space to use for each capture, i.e.
3595 total-size / record-size = number of captures
3597 console-size Size of non-panic dmesg captures (default 0)
3601 Info: The version of the ramoops overlay for the Pi 4 family. It should be
3602 loaded automatically if dtoverlay=ramoops is specified on a Pi 4.
3603 Load: dtoverlay=ramoops-pi4,<param>=<val>
3604 Params: base-addr Where to place the capture buffer (default
3606 total-size How much memory to allocate altogether (in
3607 bytes - default 64kB)
3608 record-size How much space to use for each capture, i.e.
3609 total-size / record-size = number of captures
3611 console-size Size of non-panic dmesg captures (default 0)
3614 Name: rotary-encoder
3615 Info: Overlay for GPIO connected rotary encoder.
3616 Load: dtoverlay=rotary-encoder,<param>=<val>
3617 Params: pin_a GPIO connected to rotary encoder channel A
3619 pin_b GPIO connected to rotary encoder channel B
3621 relative_axis register a relative axis rather than an
3622 absolute one. Relative axis will only
3623 generate +1/-1 events on the input device,
3624 hence no steps need to be passed.
3625 linux_axis the input subsystem axis to map to this
3626 rotary encoder. Defaults to 0 (ABS_X / REL_X)
3627 rollover Automatic rollover when the rotary value
3628 becomes greater than the specified steps or
3629 smaller than 0. For absolute axis only.
3630 steps-per-period Number of steps (stable states) per period.
3631 The values have the following meaning:
3632 1: Full-period mode (default)
3634 4: Quarter-period mode
3635 steps Number of steps in a full turnaround of the
3636 encoder. Only relevant for absolute axis.
3637 Defaults to 24 which is a typical value for
3639 wakeup Boolean, rotary encoder can wake up the
3641 encoding String, the method used to encode steps.
3642 Supported are "gray" (the default and more
3643 common) and "binary".
3647 Info: Raspberry Pi official display backlight driver
3648 Load: dtoverlay=rpi-backlight
3652 Name: rpi-cirrus-wm5102
3653 Info: This overlay has been renamed to cirrus-wm5102
3658 Info: Configures the Raspberry Pi Codec Zero sound card
3659 Load: dtoverlay=rpi-codeczero
3664 Info: This overlay has been renamed to i2s-dac.
3669 Info: Configures the Raspberry Pi DAC+ card
3670 Load: dtoverlay=rpi-dacplus,<param>=<val>
3671 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
3672 digital volume control. Enable by adding
3673 "dtparam=24db_digital_gain" to config.txt
3674 before any "dtoverlay" lines.
3675 The default behaviour is that the digital
3676 volume control is limited to a maximum of
3677 0dB. ie. it can attenuate but not provide
3678 gain. For most users, this will be desired
3679 as it will prevent clipping. By appending
3680 the 24db_digital_gain parameter, the digital
3681 volume control will allow up to 24dB of
3682 gain. If this parameter is enabled, it is the
3683 responsibility of the user to ensure that
3684 the digital volume control is set to a value
3685 that does not result in clipping/distortion!
3689 Info: Configures the Raspberry Pi DAC Pro sound card
3690 Load: dtoverlay=rpi-dacpro,<param>=<val>
3691 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
3692 digital volume control. Enable by adding
3693 "dtparam=24db_digital_gain" to config.txt
3694 before any "dtoverlay" lines.
3695 The default behaviour is that the digital
3696 volume control is limited to a maximum of
3697 0dB. ie. it can attenuate but not provide
3698 gain. For most users, this will be desired
3699 as it will prevent clipping. By appending
3700 the 24db_digital_gain parameter, the digital
3701 volume control will allow up to 24dB of
3702 gain. If this parameter is enabled, it is the
3703 responsibility of the user to ensure that
3704 the digital volume control is set to a value
3705 that does not result in clipping/distortion!
3708 Name: rpi-digiampplus
3709 Info: Configures the Raspberry Pi DigiAMP+ sound card
3710 Load: dtoverlay=rpi-digiampplus,<param>=<val>
3711 Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec
3712 digital volume control. Enable by adding
3713 "dtparam=24db_digital_gain" to config.txt
3714 before any "dtoverlay" lines.
3715 The default behaviour is that the digital
3716 volume control is limited to a maximum of
3717 0dB. ie. it can attenuate but not provide
3718 gain. For most users, this will be desired
3719 as it will prevent clipping. By appending
3720 the 24db_digital_gain parameter, the digital
3721 volume control will allow up to 24dB of
3722 gain. If this parameter is enabled, it is the
3723 responsibility of the user to ensure that
3724 the digital volume control is set to a value
3725 that does not result in clipping/distortion!
3726 auto_mute_amp If specified, unmute/mute the DigiAMP+ when
3727 starting/stopping audio playback (default "on").
3728 unmute_amp If specified, unmute the DigiAMP+ amp once when
3729 the DAC driver module loads (default "off").
3733 Info: This overlay has been renamed to watterott-display
3738 Info: Official Raspberry Pi display touchscreen
3739 Load: dtoverlay=rpi-ft5406,<param>=<val>
3740 Params: touchscreen-size-x Touchscreen X resolution (default 800)
3741 touchscreen-size-y Touchscreen Y resolution (default 600);
3742 touchscreen-inverted-x Invert touchscreen X coordinates (default 0);
3743 touchscreen-inverted-y Invert touchscreen Y coordinates (default 0);
3744 touchscreen-swapped-x-y Swap X and Y cordinates (default 0);
3748 Info: Raspberry Pi PoE HAT fan
3749 Load: dtoverlay=rpi-poe,<param>[=<val>]
3750 Params: poe_fan_temp0 Temperature (in millicelcius) at which the fan
3751 turns on (default 40000)
3752 poe_fan_temp0_hyst Temperature delta (in millicelcius) at which
3753 the fan turns off (default 2000)
3754 poe_fan_temp1 Temperature (in millicelcius) at which the fan
3755 speeds up (default 45000)
3756 poe_fan_temp1_hyst Temperature delta (in millicelcius) at which
3757 the fan slows down (default 2000)
3758 poe_fan_temp2 Temperature (in millicelcius) at which the fan
3759 speeds up (default 50000)
3760 poe_fan_temp2_hyst Temperature delta (in millicelcius) at which
3761 the fan slows down (default 2000)
3762 poe_fan_temp3 Temperature (in millicelcius) at which the fan
3763 speeds up (default 55000)
3764 poe_fan_temp3_hyst Temperature delta (in millicelcius) at which
3765 the fan slows down (default 5000)
3766 i2c Control the fan via Linux I2C drivers instead of
3771 Info: Raspberry Pi PoE+ HAT fan
3772 Load: dtoverlay=rpi-poe-plus,<param>[=<val>]
3773 Params: poe_fan_temp0 Temperature (in millicelcius) at which the fan
3774 turns on (default 40000)
3775 poe_fan_temp0_hyst Temperature delta (in millicelcius) at which
3776 the fan turns off (default 2000)
3777 poe_fan_temp1 Temperature (in millicelcius) at which the fan
3778 speeds up (default 45000)
3779 poe_fan_temp1_hyst Temperature delta (in millicelcius) at which
3780 the fan slows down (default 2000)
3781 poe_fan_temp2 Temperature (in millicelcius) at which the fan
3782 speeds up (default 50000)
3783 poe_fan_temp2_hyst Temperature delta (in millicelcius) at which
3784 the fan slows down (default 2000)
3785 poe_fan_temp3 Temperature (in millicelcius) at which the fan
3786 speeds up (default 55000)
3787 poe_fan_temp3_hyst Temperature delta (in millicelcius) at which
3788 the fan slows down (default 5000)
3789 i2c Control the fan via Linux I2C drivers instead of
3794 Info: This overlay has been renamed to proto-codec.
3799 Info: Raspberry Pi Sense HAT
3800 Load: dtoverlay=rpi-sense
3805 Info: Raspberry Pi Sense HAT v2
3806 Load: dtoverlay=rpi-sense-v2
3811 Info: Raspberry Pi TV HAT
3812 Load: dtoverlay=rpi-tv
3817 Info: This overlay has been deprecated and deleted as the V4L2 stateless
3818 video decoder driver is enabled by default.
3822 Name: rra-digidac1-wm8741-audio
3823 Info: Configures the Red Rocks Audio DigiDAC1 soundcard
3824 Load: dtoverlay=rra-digidac1-wm8741-audio
3829 Info: Overlay for the SPI-connected Sainsmart 1.8" display (based on the
3831 Load: dtoverlay=sainsmart18,<param>=<val>
3832 Params: rotate Display rotation {0,90,180,270}
3833 speed SPI bus speed in Hz (default 4000000)
3834 fps Display frame rate in Hz
3835 bgr Enable BGR mode (default off)
3836 debug Debug output level {0-7}
3837 dc_pin GPIO pin for D/C (default 24)
3838 reset_pin GPIO pin for RESET (default 25)
3842 Info: Overlay for the NXP SC16IS750 UART with I2C Interface
3843 Enables the chip on I2C1 at 0x48 (or the "addr" parameter value). To
3844 select another address, please refer to table 10 in reference manual.
3845 Load: dtoverlay=sc16is750-i2c,<param>=<val>
3846 Params: int_pin GPIO used for IRQ (default 24)
3847 addr Address (default 0x48)
3848 xtal On-board crystal frequency (default 14745600)
3852 Info: Overlay for the NXP SC16IS752 dual UART with I2C Interface
3853 Enables the chip on I2C1 at 0x48 (or the "addr" parameter value). To
3854 select another address, please refer to table 10 in reference manual.
3855 Load: dtoverlay=sc16is752-i2c,<param>=<val>
3856 Params: int_pin GPIO used for IRQ (default 24)
3857 addr Address (default 0x48)
3858 xtal On-board crystal frequency (default 14745600)
3861 Name: sc16is752-spi0
3862 Info: Overlay for the NXP SC16IS752 Dual UART with SPI Interface
3863 Enables the chip on SPI0.
3864 Load: dtoverlay=sc16is752-spi0,<param>=<val>
3865 Params: int_pin GPIO used for IRQ (default 24)
3866 xtal On-board crystal frequency (default 14745600)
3869 Name: sc16is752-spi1
3870 Info: Overlay for the NXP SC16IS752 Dual UART with SPI Interface
3871 Enables the chip on SPI1.
3872 N.B.: spi1 is only accessible on devices with a 40pin header, eg:
3873 A+, B+, Zero and PI2 B; as well as the Compute Module.
3875 Load: dtoverlay=sc16is752-spi1,<param>=<val>
3876 Params: int_pin GPIO used for IRQ (default 24)
3877 xtal On-board crystal frequency (default 14745600)
3881 Info: Selects the bcm2835-sdhost SD/MMC driver, optionally with overclock.
3882 N.B. This overlay is designed for situations where the mmc driver is
3883 the default, so it disables the other (mmc) interface - this will kill
3884 WLAN on a Pi3. If this isn't what you want, either use the sdtweak
3885 overlay or the new sd_* dtparams of the base DTBs.
3886 Load: dtoverlay=sdhost,<param>=<val>
3887 Params: overclock_50 Clock (in MHz) to use when the MMC framework
3890 force_pio Disable DMA support (default off)
3892 pio_limit Number of blocks above which to use DMA
3895 debug Enable debug output (default off)
3899 Info: Selects the bcm2835-sdhost SD/MMC driver, optionally with overclock,
3900 and enables SDIO via GPIOs 22-27. An example of use in 1-bit mode is
3901 "dtoverlay=sdio,bus_width=1,gpios_22_25"
3902 Load: dtoverlay=sdio,<param>=<val>
3903 Params: sdio_overclock SDIO Clock (in MHz) to use when the MMC
3904 framework requests 50MHz
3906 poll_once Disable SDIO-device polling every second
3907 (default on: polling once at boot-time)
3909 bus_width Set the SDIO host bus width (default 4 bits)
3911 gpios_22_25 Select GPIOs 22-25 for 1-bit mode. Must be used
3912 with bus_width=1. This replaces the sdio-1bit
3913 overlay, which is now deprecated.
3915 gpios_34_37 Select GPIOs 34-37 for 1-bit mode. Must be used
3918 gpios_34_39 Select GPIOs 34-39 for 4-bit mode. Must be used
3919 with bus_width=4 (the default).
3923 Info: This overlay is now deprecated. Use
3924 "dtoverlay=sdio,bus_width=1,gpios_22_25" instead.
3929 Info: This overlay is now deprecated. Use the sd_* dtparams in the
3930 base DTB, e.g. "dtoverlay=sdtweak,poll_once" becomes
3931 "dtparam=sd_poll_once".
3935 Name: seeed-can-fd-hat-v1
3936 Info: Overlay for Seeed Studio CAN BUS FD HAT with two CAN FD
3937 channels without RTC. Use this overlay if your HAT has no
3939 https://www.seeedstudio.com/2-Channel-CAN-BUS-FD-Shield-for-Raspberry-Pi-p-4072.html
3940 Load: dtoverlay=seeed-can-fd-hat-v1
3944 Name: seeed-can-fd-hat-v2
3945 Info: Overlay for Seeed Studio CAN BUS FD HAT with two CAN FD
3946 channels and an RTC. Use this overlay if your HAT has a
3948 https://www.seeedstudio.com/CAN-BUS-FD-HAT-for-Raspberry-Pi-p-4742.html
3949 Load: dtoverlay=seeed-can-fd-hat-v2
3954 Info: Overlay for SH1106 OLED via SPI using fbtft staging driver.
3955 Load: dtoverlay=sh1106-spi,<param>=<val>
3956 Params: speed SPI bus speed (default 4000000)
3957 rotate Display rotation (0, 90, 180 or 270; default 0)
3958 fps Delay between frame updates (default 25)
3959 debug Debug output level (0-7; default 0)
3960 dc_pin GPIO pin for D/C (default 24)
3961 reset_pin GPIO pin for RESET (default 25)
3962 height Display height (32 or 64; default 64)
3966 Info: Overlay for Si446x UHF Transceiver via SPI using si446x driver.
3967 The driver is currently out-of-tree at
3968 https://github.com/sunipkmukherjee/silabs.git
3969 Load: dtoverlay=si446x-spi0,<param>=<val>
3970 Params: speed SPI bus speed (default 4000000)
3971 int_pin GPIO pin for interrupts (default 17)
3972 reset_pin GPIO pin for RESET (default 27)
3976 Info: Enables the Secondary Memory Interface peripheral. Uses GPIOs 2-25!
3982 Info: Enables the userspace interface for the SMI driver
3983 Load: dtoverlay=smi-dev
3988 Info: Enables access to NAND flash via the SMI interface
3989 Load: dtoverlay=smi-nand
3994 Info: Move SPI function block to GPIO 35 to 39
3995 Load: dtoverlay=spi-gpio35-39
4000 Info: Move SPI function block to GPIOs 40 to 45
4001 Load: dtoverlay=spi-gpio40-45
4006 Info: Adds support for a number of SPI Real Time Clock devices
4007 Load: dtoverlay=spi-rtc,<param>=<val>
4008 Params: ds3232 Select the DS3232 device
4009 ds3234 Select the DS3234 device
4010 pcf2123 Select the PCF2123 device
4012 spi0_0 Use spi0.0 (default)
4018 cs_high This device requires an active-high CS
4022 Info: Don't claim any CS pins for SPI0. Requires a device with its chip
4023 select permanently enabled, but frees a GPIO for e.g. a DPI display.
4024 Load: dtoverlay=spi0-0cs,<param>=<val>
4025 Params: no_miso Don't claim and use the MISO pin (9), freeing
4030 Info: Only use one CS pin for SPI0
4031 Load: dtoverlay=spi0-1cs,<param>=<val>
4032 Params: cs0_pin GPIO pin for CS0 (default 8)
4033 no_miso Don't claim and use the MISO pin (9), freeing
4038 Info: Change the CS pins for SPI0
4039 Load: dtoverlay=spi0-2cs,<param>=<val>
4040 Params: cs0_pin GPIO pin for CS0 (default 8)
4041 cs1_pin GPIO pin for CS1 (default 7)
4042 no_miso Don't claim and use the MISO pin (9), freeing
4047 Info: This overlay has been renamed spi0-2cs, keeping spi0-cs as an
4048 alias for backwards compatibility.
4053 Info: This overlay has been deprecated and removed because it is no longer
4054 necessary and has been seen to prevent spi0 from working.
4059 Info: Enables spi1 with a single chip select (CS) line and associated spidev
4060 dev node. The gpio pin number for the CS line and spidev device node
4061 creation are configurable.
4062 N.B.: spi1 is not accessible on old Pis without a 40-pin header.
4063 Load: dtoverlay=spi1-1cs,<param>=<val>
4064 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
4065 cs0_spidev Set to 'off' to stop the creation of a
4066 userspace device node /dev/spidev1.0 (default
4067 is 'on' or enabled).
4071 Info: Enables spi1 with two chip select (CS) lines and associated spidev
4072 dev nodes. The gpio pin numbers for the CS lines and spidev device node
4073 creation are configurable.
4074 N.B.: spi1 is not accessible on old Pis without a 40-pin header.
4075 Load: dtoverlay=spi1-2cs,<param>=<val>
4076 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
4077 cs1_pin GPIO pin for CS1 (default 17 - BCM SPI1_CE1).
4078 cs0_spidev Set to 'off' to stop the creation of a
4079 userspace device node /dev/spidev1.0 (default
4080 is 'on' or enabled).
4081 cs1_spidev Set to 'off' to stop the creation of a
4082 userspace device node /dev/spidev1.1 (default
4083 is 'on' or enabled).
4087 Info: Enables spi1 with three chip select (CS) lines and associated spidev
4088 dev nodes. The gpio pin numbers for the CS lines and spidev device node
4089 creation are configurable.
4090 N.B.: spi1 is not accessible on old Pis without a 40-pin header.
4091 Load: dtoverlay=spi1-3cs,<param>=<val>
4092 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
4093 cs1_pin GPIO pin for CS1 (default 17 - BCM SPI1_CE1).
4094 cs2_pin GPIO pin for CS2 (default 16 - BCM SPI1_CE2).
4095 cs0_spidev Set to 'off' to stop the creation of a
4096 userspace device node /dev/spidev1.0 (default
4097 is 'on' or enabled).
4098 cs1_spidev Set to 'off' to stop the creation of a
4099 userspace device node /dev/spidev1.1 (default
4100 is 'on' or enabled).
4101 cs2_spidev Set to 'off' to stop the creation of a
4102 userspace device node /dev/spidev1.2 (default
4103 is 'on' or enabled).
4107 Info: Enables spi2 on GPIOs 40-42 with a single chip select (CS) line and
4108 associated spidev dev node. The gpio pin number for the CS line and
4109 spidev device node creation are configurable. spi2-2cs-pi5 is
4110 substituted on a Pi 5.
4111 N.B.: spi2 is only accessible with the Compute Module or Pi 5.
4112 Load: dtoverlay=spi2-1cs,<param>=<val>
4113 Params: cs0_pin GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
4114 cs0_spidev Set to 'off' to stop the creation of a
4115 userspace device node /dev/spidev2.0 (default
4116 is 'on' or enabled).
4120 Info: Enables spi2 on GPIOs 1-3 with a single chip select (CS) line and
4121 associated spidev dev node. The gpio pin number for the CS line and
4122 spidev device node creation are configurable. Pi 5 only.
4123 Load: dtoverlay=spi2-1cs-pi5,<param>=<val>
4124 Params: cs0_pin GPIO pin for CS0 (default 0).
4125 cs0_spidev Set to 'off' to stop the creation of a
4126 userspace device node /dev/spidev2.0 (default
4127 is 'on' or enabled).
4131 Info: Enables spi2 on GPIOs 40-42 with two chip select (CS) lines and
4132 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4133 spidev device node creation are configurable. spi2-2cs-pi5 is
4134 substituted on a Pi 5.
4135 N.B.: spi2 is only accessible with the Compute Module or Pi 5.
4136 Load: dtoverlay=spi2-2cs,<param>=<val>
4137 Params: cs0_pin GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
4138 cs1_pin GPIO pin for CS1 (default 44 - BCM SPI2_CE1).
4139 cs0_spidev Set to 'off' to stop the creation of a
4140 userspace device node /dev/spidev2.0 (default
4141 is 'on' or enabled).
4142 cs1_spidev Set to 'off' to stop the creation of a
4143 userspace device node /dev/spidev2.1 (default
4144 is 'on' or enabled).
4148 Info: Enables spi2 on GPIOs 1-3 with two chip select (CS) lines and
4149 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4150 spidev device node creation are configurable. Pi 5 only.
4151 Load: dtoverlay=spi2-2cs-pi5,<param>=<val>
4152 Params: cs0_pin GPIO pin for CS0 (default 0).
4153 cs1_pin GPIO pin for CS1 (default 24).
4154 cs0_spidev Set to 'off' to stop the creation of a
4155 userspace device node /dev/spidev2.0 (default
4156 is 'on' or enabled).
4157 cs1_spidev Set to 'off' to stop the creation of a
4158 userspace device node /dev/spidev2.1 (default
4159 is 'on' or enabled).
4163 Info: Enables spi2 on GPIOs 40-42 with three chip select (CS) lines and
4164 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4165 spidev device node creation are configurable.
4166 N.B.: spi2 is only accessible with the Compute Module or Pi 5.
4167 Load: dtoverlay=spi2-3cs,<param>=<val>
4168 Params: cs0_pin GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
4169 cs1_pin GPIO pin for CS1 (default 44 - BCM SPI2_CE1).
4170 cs2_pin GPIO pin for CS2 (default 45 - BCM SPI2_CE2).
4171 cs0_spidev Set to 'off' to stop the creation of a
4172 userspace device node /dev/spidev2.0 (default
4173 is 'on' or enabled).
4174 cs1_spidev Set to 'off' to stop the creation of a
4175 userspace device node /dev/spidev2.1 (default
4176 is 'on' or enabled).
4177 cs2_spidev Set to 'off' to stop the creation of a
4178 userspace device node /dev/spidev2.2 (default
4179 is 'on' or enabled).
4183 Info: Enables spi3 on GPIOs 1-3 with a single chip select (CS) line and
4184 associated spidev dev node. The gpio pin number for the CS line and
4185 spidev device node creation are configurable. BCM2711 only,
4186 spi3-1cs-pi5 is substituted on Pi 5.
4187 Load: dtoverlay=spi3-1cs,<param>=<val>
4188 Params: cs0_pin GPIO pin for CS0 (default 0 - BCM SPI3_CE0).
4189 cs0_spidev Set to 'off' to prevent the creation of a
4190 userspace device node /dev/spidev3.0 (default
4191 is 'on' or enabled).
4195 Info: Enables spi3 on GPIOs 5-7 with a single chip select (CS) line and
4196 associated spidev dev node. The gpio pin number for the CS line and
4197 spidev device node creation are configurable. Pi 5 only.
4198 Load: dtoverlay=spi3-1cs-pi5,<param>=<val>
4199 Params: cs0_pin GPIO pin for CS0 (default 4).
4200 cs0_spidev Set to 'off' to prevent the creation of a
4201 userspace device node /dev/spidev3.0 (default
4202 is 'on' or enabled).
4206 Info: Enables spi3 on GPIO2 1-3 with two chip select (CS) lines and
4207 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4208 spidev device node creation are configurable. BCM2711 only,
4209 spi3-2cs-pi5 is substituted on Pi 5.
4210 Load: dtoverlay=spi3-2cs,<param>=<val>
4211 Params: cs0_pin GPIO pin for CS0 (default 0 - BCM SPI3_CE0).
4212 cs1_pin GPIO pin for CS1 (default 24 - BCM SPI3_CE1).
4213 cs0_spidev Set to 'off' to prevent the creation of a
4214 userspace device node /dev/spidev3.0 (default
4215 is 'on' or enabled).
4216 cs1_spidev Set to 'off' to prevent the creation of a
4217 userspace device node /dev/spidev3.1 (default
4218 is 'on' or enabled).
4222 Info: Enables spi3 on GPIOs 5-7 with two chip select (CS) lines and
4223 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4224 spidev device node creation are configurable. Pi 5 only.
4225 Load: dtoverlay=spi3-2cs-pi5,<param>=<val>
4226 Params: cs0_pin GPIO pin for CS0 (default 4).
4227 cs1_pin GPIO pin for CS1 (default 25).
4228 cs0_spidev Set to 'off' to prevent the creation of a
4229 userspace device node /dev/spidev3.0 (default
4230 is 'on' or enabled).
4231 cs1_spidev Set to 'off' to prevent the creation of a
4232 userspace device node /dev/spidev3.1 (default
4233 is 'on' or enabled).
4237 Info: Enables spi4 on GPIOs 5-7 with a single chip select (CS) line and
4238 associated spidev dev node. The gpio pin number for the CS line and
4239 spidev device node creation are configurable. BCM2711 only.
4240 Load: dtoverlay=spi4-1cs,<param>=<val>
4241 Params: cs0_pin GPIO pin for CS0 (default 4 - BCM SPI4_CE0).
4242 cs0_spidev Set to 'off' to prevent the creation of a
4243 userspace device node /dev/spidev4.0 (default
4244 is 'on' or enabled).
4248 Info: Enables spi4 on GPIOs 5-6 with two chip select (CS) lines and
4249 associated spidev dev nodes. The gpio pin numbers for the CS lines and
4250 spidev device node creation are configurable. BCM2711 only.
4251 Load: dtoverlay=spi4-2cs,<param>=<val>
4252 Params: cs0_pin GPIO pin for CS0 (default 4 - BCM SPI4_CE0).
4253 cs1_pin GPIO pin for CS1 (default 25 - BCM SPI4_CE1).
4254 cs0_spidev Set to 'off' to prevent the creation of a
4255 userspace device node /dev/spidev4.0 (default
4256 is 'on' or enabled).
4257 cs1_spidev Set to 'off' to prevent the creation of a
4258 userspace device node /dev/spidev4.1 (default
4259 is 'on' or enabled).
4263 Info: Enables spi5 on GPIOs 13-15 with a single chip select (CS) line and
4264 associated spidev dev node. The gpio pin numbers for the CS lines and
4265 spidev device node creation are configurable. BCM2711 and Pi 5.
4266 Load: dtoverlay=spi5-1cs,<param>=<val>
4267 Params: cs0_pin GPIO pin for CS0 (default 12).
4268 cs0_spidev Set to 'off' to prevent the creation of a
4269 userspace device node /dev/spidev5.0 (default
4270 is 'on' or enabled).
4278 Info: Enables spi5 on GPIOs 13-15 with two 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. BCM2711 and Pi 5.
4281 Load: dtoverlay=spi5-2cs,<param>=<val>
4282 Params: cs0_pin GPIO pin for CS0 (default 12).
4283 cs1_pin GPIO pin for CS1 (default 26).
4284 cs0_spidev Set to 'off' to prevent the creation of a
4285 userspace device node /dev/spidev5.0 (default
4286 is 'on' or enabled).
4287 cs1_spidev Set to 'off' to prevent the creation of a
4288 userspace device node /dev/spidev5.1 (default
4289 is 'on' or enabled).
4297 Info: Enables spi6 with a single chip select (CS) line and associated spidev
4298 dev node. The gpio pin number for the CS line and spidev device node
4299 creation are configurable. BCM2711 only.
4300 Load: dtoverlay=spi6-1cs,<param>=<val>
4301 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI6_CE0).
4302 cs0_spidev Set to 'off' to prevent the creation of a
4303 userspace device node /dev/spidev6.0 (default
4304 is 'on' or enabled).
4308 Info: Enables spi6 with two chip select (CS) lines and associated spidev
4309 dev nodes. The gpio pin numbers for the CS lines and spidev device node
4310 creation are configurable. BCM2711 only.
4311 Load: dtoverlay=spi6-2cs,<param>=<val>
4312 Params: cs0_pin GPIO pin for CS0 (default 18 - BCM SPI6_CE0).
4313 cs1_pin GPIO pin for CS1 (default 27 - BCM SPI6_CE1).
4314 cs0_spidev Set to 'off' to prevent the creation of a
4315 userspace device node /dev/spidev6.0 (default
4316 is 'on' or enabled).
4317 cs1_spidev Set to 'off' to prevent the creation of a
4318 userspace device node /dev/spidev6.1 (default
4319 is 'on' or enabled).
4323 Info: Overlay for activation of SSD1306 over I2C OLED display framebuffer.
4324 Load: dtoverlay=ssd1306,<param>=<val>
4325 Params: address Location in display memory of first character.
4327 width Width of display. (default=128)
4328 height Height of display. (default=64)
4329 offset virtual channel a. (default=0)
4330 normal Has no effect on displays tested. (default=not
4332 sequential Set this if every other scan line is missing.
4334 remapped Set this if display is garbled. (default=not
4336 inverted Set this if display is inverted and mirrored.
4340 Typical usage for 128x64 display: dtoverlay=ssd1306,inverted
4342 Typical usage for 128x32 display: dtoverlay=ssd1306,inverted,sequential
4344 i2c_baudrate=400000 will speed up the display.
4346 i2c_baudrate=1000000 seems to work even though it's not officially
4347 supported by the hardware, and is faster still.
4349 For more information refer to the device datasheet at:
4350 https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf
4354 Info: Overlay for SSD1306 OLED via SPI using fbtft staging driver.
4355 Load: dtoverlay=ssd1306-spi,<param>=<val>
4356 Params: speed SPI bus speed (default 10000000)
4357 rotate Display rotation (0, 90, 180 or 270; default 0)
4358 fps Delay between frame updates (default 25)
4359 debug Debug output level (0-7; default 0)
4360 dc_pin GPIO pin for D/C (default 24)
4361 reset_pin GPIO pin for RESET (default 25)
4362 height Display height (32 or 64; default 64)
4363 inverted Set this if display is inverted and mirrored.
4368 Info: Overlay for SSD1331 OLED via SPI using fbtft staging driver.
4369 Load: dtoverlay=ssd1331-spi,<param>=<val>
4370 Params: speed SPI bus speed (default 4500000)
4371 rotate Display rotation (0, 90, 180 or 270; default 0)
4372 fps Delay between frame updates (default 25)
4373 debug Debug output level (0-7; default 0)
4374 dc_pin GPIO pin for D/C (default 24)
4375 reset_pin GPIO pin for RESET (default 25)
4379 Info: Overlay for SSD1351 OLED via SPI using fbtft staging driver.
4380 Load: dtoverlay=ssd1351-spi,<param>=<val>
4381 Params: speed SPI bus speed (default 4500000)
4382 rotate Display rotation (0, 90, 180 or 270; default 0)
4383 fps Delay between frame updates (default 25)
4384 debug Debug output level (0-7; default 0)
4385 dc_pin GPIO pin for D/C (default 24)
4386 reset_pin GPIO pin for RESET (default 25)
4389 Name: superaudioboard
4390 Info: Configures the SuperAudioBoard sound card
4391 Load: dtoverlay=superaudioboard,<param>=<val>
4392 Params: gpiopin GPIO pin for codec reset
4396 Info: Configures the Semtech SX150X I2C GPIO expanders.
4397 Load: dtoverlay=sx150x,<param>=<val>
4398 Params: sx150<x>-<n>-<m> Enables SX150X device on I2C#<n> with slave
4399 address <m>. <x> may be 1-9. <n> may be 0 or 1.
4400 Permissible values of <m> (which is denoted in
4401 hex) depend on the device variant. For SX1501,
4402 SX1502, SX1504 and SX1505, <m> may be 20 or 21.
4403 For SX1503 and SX1506, <m> may be 20. For
4404 SX1507 and SX1509, <m> may be 3E, 3F, 70 or 71.
4405 For SX1508, <m> may be 20, 21, 22 or 23.
4407 sx150<x>-<n>-<m>-int-gpio
4408 Integer, enables interrupts on SX150X device on
4409 I2C#<n> with slave address <m>, specifies
4410 the GPIO pin to which NINT output of SX150X is
4415 Info: Toshiba TC358743 HDMI to CSI-2 bridge chip.
4416 Uses Unicam 1, which is the standard camera connector on most Pi
4418 Load: dtoverlay=tc358743,<param>=<val>
4419 Params: 4lane Use 4 lanes (only applicable to Compute Modules
4422 link-frequency Set the link frequency. Only values of 297000000
4423 (574Mbit/s) and 486000000 (972Mbit/s - default)
4424 are supported by the driver.
4425 media-controller Configure use of Media Controller API for
4426 configuring the sensor (default off)
4427 cam0 Adopt the default configuration for CAM0 on a
4428 Compute Module (CSI0, i2c_vc, and cam0_reg).
4431 Name: tc358743-audio
4432 Info: Used in combination with the tc358743-fast overlay to route the audio
4433 from the TC358743 over I2S to the Pi.
4434 Wiring is LRCK/WFS to GPIO 19, BCK/SCK to GPIO 18, and DATA/SD to GPIO
4436 Load: dtoverlay=tc358743-audio,<param>=<val>
4437 Params: card-name Override the default, "tc358743", card name.
4441 Info: 3.5" Color TFT Display by www.tinylcd.com
4442 Options: Touch, RTC, keypad
4443 Load: dtoverlay=tinylcd35,<param>=<val>
4444 Params: speed Display SPI bus speed
4446 rotate Display rotation {0,90,180,270}
4448 fps Delay between frame updates
4450 debug Debug output level {0-7}
4452 touch Enable touch panel
4454 touchgpio Touch controller IRQ GPIO
4456 xohms Touchpanel: Resistance of X-plate in ohms
4458 rtc-pcf PCF8563 Real Time Clock
4460 rtc-ds DS1307 Real Time Clock
4462 keypad Enable keypad
4465 Display with touchpanel, PCF8563 RTC and keypad:
4466 dtoverlay=tinylcd35,touch,rtc-pcf,keypad
4468 dtoverlay=tinylcd35,touch,touchgpio=3
4472 Info: Enables support for Infineon SLB9670 Trusted Platform Module add-on
4473 boards, which can be used as a secure key storage and hwrng,
4474 available as "Iridium SLB9670" by Infineon and "LetsTrust TPM" by pi3g.
4475 Load: dtoverlay=tpm-slb9670
4480 Info: Enables support for Infineon SLB9673 Trusted Platform Module add-on
4481 boards, which can be used as a secure key storage and hwrng
4482 via the I2C protocol.
4483 Load: dtoverlay=tpm-slb9673
4488 Info: Change the pin usage of uart0
4489 Load: dtoverlay=uart0,<param>=<val>
4490 Params: txd0_pin GPIO pin for TXD0 (14, 32 or 36 - default 14)
4492 rxd0_pin GPIO pin for RXD0 (15, 33 or 37 - default 15)
4494 pin_func Alternative pin function - 4(Alt0) for 14&15,
4495 7(Alt3) for 32&33, 6(Alt2) for 36&37
4499 Info: Enable uart 0 on GPIOs 14-15. Pi 5 only.
4500 Load: dtoverlay=uart0-pi5,<param>
4501 Params: ctsrts Enable CTS/RTS on GPIOs 16-17 (default off)
4505 Info: Change the pin usage of uart1
4506 Load: dtoverlay=uart1,<param>=<val>
4507 Params: txd1_pin GPIO pin for TXD1 (14, 32 or 40 - default 14)
4509 rxd1_pin GPIO pin for RXD1 (15, 33 or 41 - default 15)
4513 Info: Enable uart 1 on GPIOs 0-1. Pi 5 only.
4514 Load: dtoverlay=uart1-pi5,<param>
4515 Params: ctsrts Enable CTS/RTS on GPIOs 2-3 (default off)
4519 Info: Enable uart 2 on GPIOs 0-3. BCM2711 only.
4520 Load: dtoverlay=uart2,<param>
4521 Params: ctsrts Enable CTS/RTS on GPIOs 2-3 (default off)
4525 Info: Enable uart 2 on GPIOs 4-5. Pi 5 only.
4526 Load: dtoverlay=uart2-pi5,<param>
4527 Params: ctsrts Enable CTS/RTS on GPIOs 6-7 (default off)
4531 Info: Enable uart 3 on GPIOs 4-7. BCM2711 only.
4532 Load: dtoverlay=uart3,<param>
4533 Params: ctsrts Enable CTS/RTS on GPIOs 6-7 (default off)
4537 Info: Enable uart 3 on GPIOs 8-9. Pi 5 only.
4538 Load: dtoverlay=uart3-pi5,<param>
4539 Params: ctsrts Enable CTS/RTS on GPIOs 10-11 (default off)
4543 Info: Enable uart 4 on GPIOs 8-11. BCM2711 only.
4544 Load: dtoverlay=uart4,<param>
4545 Params: ctsrts Enable CTS/RTS on GPIOs 10-11 (default off)
4549 Info: Enable uart 4 on GPIOs 12-13. Pi 5 only.
4550 Load: dtoverlay=uart4-pi5,<param>
4551 Params: ctsrts Enable CTS/RTS on GPIOs 14-15 (default off)
4555 Info: Enable uart 5 on GPIOs 12-15. BCM2711 only.
4556 Load: dtoverlay=uart5,<param>
4557 Params: ctsrts Enable CTS/RTS on GPIOs 14-15 (default off)
4561 Info: Configures the NW Digital Radio UDRC Hat
4562 Load: dtoverlay=udrc,<param>=<val>
4563 Params: alsaname Name of the ALSA audio device (default "udrc")
4566 Name: ugreen-dabboard
4567 Info: Configures the ugreen-dabboard I2S overlay
4568 This is a simple overlay based on the simple-audio-card and the dmic
4569 codec. It has the speciality that it is configured to use the codec
4570 as a master I2S device. It works for example with the Si468x DAB
4571 receiver on the uGreen DABBoard.
4572 Load: dtoverlay=ugreen-dabboard,<param>=<val>
4573 Params: card-name Override the default, "dabboard", card name.
4577 Info: Allow usage of downstream .dtb with upstream kernel. Comprises the
4578 vc4-kms-v3d and dwc2 overlays.
4579 Load: dtoverlay=upstream
4583 Name: upstream-aux-interrupt
4584 Info: This overlay has been deprecated and removed because it is no longer
4590 Info: Allow usage of downstream .dtb with upstream kernel on Pi 4. Comprises
4591 the vc4-kms-v3d-pi4 and dwc2 overlays.
4592 Load: dtoverlay=upstream-pi4
4597 Info: Enable Eric Anholt's DRM VC4 V3D driver on top of the dispmanx
4599 Load: dtoverlay=vc4-fkms-v3d,<param>
4600 Params: cma-512 CMA is 512MB (needs 1GB)
4601 cma-448 CMA is 448MB (needs 1GB)
4602 cma-384 CMA is 384MB (needs 1GB)
4603 cma-320 CMA is 320MB (needs 1GB)
4604 cma-256 CMA is 256MB (needs 1GB)
4605 cma-192 CMA is 192MB (needs 1GB)
4606 cma-128 CMA is 128MB
4609 cma-size CMA size in bytes, 4MB aligned
4610 cma-default Use upstream's default value
4613 Name: vc4-fkms-v3d-pi4
4614 Info: Enable Eric Anholt's DRM VC4 V3D driver on top of the dispmanx
4616 Load: dtoverlay=vc4-fkms-v3d-pi4,<param>
4617 Params: cma-512 CMA is 512MB (needs 1GB)
4618 cma-448 CMA is 448MB (needs 1GB)
4619 cma-384 CMA is 384MB (needs 1GB)
4620 cma-320 CMA is 320MB (needs 1GB)
4621 cma-256 CMA is 256MB (needs 1GB)
4622 cma-192 CMA is 192MB (needs 1GB)
4623 cma-128 CMA is 128MB
4626 cma-size CMA size in bytes, 4MB aligned
4627 cma-default Use upstream's default value
4630 Name: vc4-kms-dpi-at056tn53v1
4631 Info: This overlay is now deprecated - see vc4-kms-dpi-panel,at056tn53v1
4635 Name: vc4-kms-dpi-generic
4636 Info: Enable a generic DPI display under KMS. Default timings are for the
4637 Adafruit Kippah with 800x480 panel and RGB666 (GPIOs 0-21)
4638 Requires vc4-kms-v3d to be loaded.
4639 Load: dtoverlay=vc4-kms-dpi-generic,<param>=<val>
4640 Params: clock-frequency Display clock frequency (Hz)
4641 hactive Horizontal active pixels
4642 hfp Horizontal front porch
4643 hsync Horizontal sync pulse width
4644 hbp Horizontal back porch
4645 vactive Vertical active lines
4646 vfp Vertical front porch
4647 vsync Vertical sync pulse width
4648 vbp Vertical back porch
4649 hsync-invert Horizontal sync active low
4650 vsync-invert Vertical sync active low
4651 de-invert Data Enable active low
4652 pixclk-invert Negative edge pixel clock
4653 width-mm Define the screen width in mm
4654 height-mm Define the screen height in mm
4655 rgb565 Change to RGB565 output on GPIOs 0-19
4656 rgb565-padhi Change to RGB565 output on GPIOs 0-8, 12-17, and
4658 bgr666 Change to BGR666 output on GPIOs 0-21.
4659 bgr666-padhi Change to BGR666 output on GPIOs 0-9, 12-17, and
4661 rgb666-padhi Change to RGB666 output on GPIOs 0-9, 12-17, and
4663 bgr888 Change to BGR888 output on GPIOs 0-27
4664 rgb888 Change to RGB888 output on GPIOs 0-27
4665 bus-format Override the bus format for a MEDIA_BUS_FMT_*
4666 value. NB also overridden by rgbXXX overrides.
4667 backlight-gpio Defines a GPIO to be used for backlight control
4669 backlight-pwm Defines a PWM channel to be used for backlight
4670 control (default of none). NB Disables audio
4671 headphone output as that also uses PWM.
4672 backlight-pwm-chan Choose channel on &pwm node for backlight
4675 backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See
4676 pwm-2chan for valid options.
4677 (default 18 - note this can only work with
4679 backlight-pwm-func Pin function of GPIO used for the PWM
4681 See pwm-2chan for valid options.
4683 backlight-def-brightness
4684 Set the default brightness. Normal range 1-16.
4686 rotate Display rotation {0,90,180,270} (default 0)
4689 Name: vc4-kms-dpi-hyperpixel2r
4690 Info: Enable the KMS drivers for the Pimoroni HyperPixel2 Round DPI display.
4691 Requires vc4-kms-v3d to be loaded.
4692 Load: dtoverlay=vc4-kms-dpi-hyperpixel2r,<param>=<val>
4693 Params: disable-touch Disables the touch controller
4694 touchscreen-inverted-x Inverts X direction of touch controller
4695 touchscreen-inverted-y Inverts Y direction of touch controller
4696 touchscreen-swapped-x-y Swaps X & Y axes of touch controller
4697 rotate Display rotation {0,90,180,270} (default 0)
4700 Name: vc4-kms-dpi-hyperpixel4
4701 Info: Enable the KMS drivers for the Pimoroni HyperPixel4 DPI display.
4702 Requires vc4-kms-v3d to be loaded.
4703 Load: dtoverlay=vc4-kms-dpi-hyperpixel4,<param>=<val>
4704 Params: disable-touch Disables the touch controller
4705 touchscreen-inverted-x Inverts X direction of touch controller
4706 touchscreen-inverted-y Inverts Y direction of touch controller
4707 touchscreen-swapped-x-y Swaps X & Y axes of touch controller
4708 rotate Display rotation {0,90,180,270} (default 0)
4711 Name: vc4-kms-dpi-hyperpixel4sq
4712 Info: Enable the KMS drivers for the Pimoroni HyperPixel4 Square DPI display.
4713 Requires vc4-kms-v3d to be loaded.
4714 Load: dtoverlay=vc4-kms-dpi-hyperpixel4sq,<param>=<val>
4715 Params: disable-touch Disables the touch controller
4716 touchscreen-inverted-x Inverts X direction of touch controller
4717 touchscreen-inverted-y Inverts Y direction of touch controller
4718 touchscreen-swapped-x-y Swaps X & Y axes of touch controller
4719 rotate Display rotation {0,90,180,270} (default 0)
4722 Name: vc4-kms-dpi-panel
4723 Info: Enable a preconfigured KMS DPI panel.
4724 Requires vc4-kms-v3d to be loaded.
4725 Load: dtoverlay=vc4-kms-dpi-panel,<param>=<val>
4726 Params: at056tn53v1 Enable an Innolux 5.6in VGA TFT
4727 kippah-7inch Enable an Adafruit Kippah with 7inch panel.
4728 mzp280 Enable a Geekworm MZP280 panel.
4729 backlight-gpio Defines a GPIO to be used for backlight control
4731 backlight-pwm Defines a PWM channel to be used for backlight
4732 control (default of none). NB Disables audio
4733 headphone output as that also uses PWM.
4734 backlight-pwm-chan Choose channel on &pwm node for backlight
4737 backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See
4738 pwm-2chan for valid options.
4739 (default 18 - note this can only work with
4741 backlight-pwm-func Pin function of GPIO used for the PWM
4743 See pwm-2chan for valid options.
4745 backlight-def-brightness
4746 Set the default brightness. Normal range 1-16.
4748 rotate Display rotation {0,90,180,270} (default 0)
4751 Name: vc4-kms-dsi-7inch
4752 Info: Enable the Raspberry Pi DSI 7" screen.
4753 Includes the edt-ft5406 for the touchscreen element.
4754 Requires vc4-kms-v3d to be loaded.
4755 Load: dtoverlay=vc4-kms-dsi-7inch,<param>=<val>
4756 Params: sizex Touchscreen size x (default 800)
4757 sizey Touchscreen size y (default 480)
4758 invx Touchscreen inverted x axis
4759 invy Touchscreen inverted y axis
4760 swapxy Touchscreen swapped x y axis
4761 disable_touch Disables the touch screen overlay driver
4762 dsi0 Use DSI0 and i2c_csi_dsi0 (rather than
4763 the default DSI1 and i2c_csi_dsi).
4766 Name: vc4-kms-dsi-lt070me05000
4767 Info: Enable a JDI LT070ME05000 DSI display on DSI1.
4768 Note that this is a 4 lane DSI device, so it will only work on a Compute
4770 Requires vc4-kms-v3d to be loaded.
4771 Load: dtoverlay=vc4-kms-dsi-lt070me05000,<param>
4772 Params: reset GPIO for the reset signal (default 17)
4773 enable GPIO for the enable signal (default 4)
4774 dcdc-en GPIO for the DC-DC converter enable (default 5)
4777 Name: vc4-kms-dsi-lt070me05000-v2
4778 Info: Enable a JDI LT070ME05000 DSI display on DSI1 using Harlab's V2
4780 Note that this is a 4 lane DSI device, so it will only work on a Compute
4782 Requires vc4-kms-v3d to be loaded.
4783 Load: dtoverlay=vc4-kms-dsi-lt070me05000-v2
4787 Name: vc4-kms-dsi-waveshare-panel
4788 Info: Enable a Waveshare DSI touchscreen
4789 Includes the Goodix driver for the touchscreen element.
4790 The default is for the display to be using the I2C0 option for control.
4791 Use the i2c1 override if using the I2C1 wiring with jumper wires from
4792 GPIOs 2&3 (pins 3&5).
4793 invx/invy/swapxy should be used with caution as the panel specifier will
4794 set the default inversions for that panel. Always use them after the
4795 panel specifier, and be aware that you may need to set them as =0, not
4797 Requires vc4-kms-v3d to be loaded.
4798 Load: dtoverlay=vc4-kms-dsi-waveshare-panel,<param>=<val>
4799 Params: 2_8_inch 2.8" 480x640
4800 3_4_inch 3.4" 800x800 round
4801 4_0_inch 4.0" 480x800
4802 7_0_inchC 7.0" C 1024x600
4803 7_9_inch 7.9" 400x1280
4804 8_0_inch 8.0" 1280x800
4805 10_1_inch 10.1" 1280x800
4806 11_9_inch 11.9" 320x1480
4807 i2c1 Use i2c-1 with jumper wires from GPIOs 2&3
4808 disable_touch Disable the touch controller
4809 rotation Set the panel orientation property
4810 invx Touchscreen inverted x axis
4811 invy Touchscreen inverted y axis
4812 swapxy Touchscreen swapped x y axis
4813 dsi0 Use DSI0 and i2c_csi_dsi0 (rather than
4814 the default DSI1 and i2c_csi_dsi).
4817 Name: vc4-kms-kippah-7inch
4818 Info: This overlay is now deprecated - see vc4-kms-dpi-panel,kippah-7inch
4823 Info: Enable Eric Anholt's DRM VC4 HDMI/HVS/V3D driver.
4824 Load: dtoverlay=vc4-kms-v3d,<param>
4825 Params: cma-512 CMA is 512MB (needs 1GB)
4826 cma-448 CMA is 448MB (needs 1GB)
4827 cma-384 CMA is 384MB (needs 1GB)
4828 cma-320 CMA is 320MB (needs 1GB)
4829 cma-256 CMA is 256MB (needs 1GB)
4830 cma-192 CMA is 192MB (needs 1GB)
4831 cma-128 CMA is 128MB
4834 cma-size CMA size in bytes, 4MB aligned
4835 cma-default Use upstream's default value
4836 audio Enable or disable audio over HDMI (default "on")
4837 noaudio Disable all HDMI audio (default "off")
4838 composite Enable the composite output (default "off")
4839 N.B. Disables all other outputs on a Pi 4.
4840 nohdmi Disable HDMI output
4843 Name: vc4-kms-v3d-pi4
4844 Info: Enable Eric Anholt's DRM VC4 HDMI/HVS/V3D driver for Pi4.
4845 Load: dtoverlay=vc4-kms-v3d-pi4,<param>
4846 Params: cma-512 CMA is 512MB
4847 cma-448 CMA is 448MB
4848 cma-384 CMA is 384MB
4849 cma-320 CMA is 320MB
4850 cma-256 CMA is 256MB
4851 cma-192 CMA is 192MB
4852 cma-128 CMA is 128MB
4855 cma-size CMA size in bytes, 4MB aligned
4856 cma-default Use upstream's default value
4857 audio Enable or disable audio over HDMI0 (default
4859 audio1 Enable or disable audio over HDMI1 (default
4861 noaudio Disable all HDMI audio (default "off")
4862 composite Enable the composite output (disables all other
4864 nohdmi Disable both HDMI 0 & 1 outputs
4865 nohdmi0 Disable HDMI 0 output
4866 nohdmi1 Disable HDMI 1 output
4869 Name: vc4-kms-v3d-pi5
4870 Info: See vc4-kms-v3d-pi4 (this is the Pi 5 version)
4873 Name: vc4-kms-vga666
4874 Info: Enable the VGA666 (resistor ladder ADC) for the vc4-kms-v3d driver.
4875 Requires vc4-kms-v3d to be loaded.
4876 Load: dtoverlay=vc4-kms-vga666,<param>
4877 Params: ddc Enables GPIOs 0&1 as the I2C to read the EDID
4878 from the display. NB These are NOT 5V tolerant
4879 GPIOs, therefore level shifters are required.
4883 Info: Overlay for the Fen Logic VGA666 board
4884 This uses GPIOs 2-21 (so no I2C), and activates the output 2-3 seconds
4885 after the kernel has started.
4886 NOT for use with vc4-kms-v3d.
4887 Load: dtoverlay=vga666
4892 Info: Overlay to enable a VIA VL805 USB3 controller on CM4 carriers
4893 Will be loaded automatically by up-to-date firmware if "VL805=1" is
4894 set in the EEPROM config.
4895 Load: dtoverlay=vl805
4900 Info: Configures the w1-gpio Onewire interface module.
4901 Use this overlay if you *don't* need a GPIO to drive an external pullup.
4902 Load: dtoverlay=w1-gpio,<param>=<val>
4903 Params: gpiopin GPIO for I/O (default "4")
4904 pullup Now enabled by default (ignored)
4907 Name: w1-gpio-pullup
4908 Info: Configures the w1-gpio Onewire interface module.
4909 Use this overlay if you *do* need a GPIO to drive an external pullup.
4910 Load: dtoverlay=w1-gpio-pullup,<param>=<val>
4911 Params: gpiopin GPIO for I/O (default "4")
4912 extpullup GPIO for external pullup (default "5")
4913 pullup Now enabled by default (ignored)
4917 Info: Overlay for the Wiznet W5500 Ethernet Controller on SPI0
4918 Load: dtoverlay=w5500,<param>=<val>
4919 Params: int_pin GPIO used for INT (default 25)
4921 speed SPI bus speed (default 30000000)
4923 cs SPI bus Chip Select (default 0)
4926 Name: watterott-display
4927 Info: Watterott RPi-Display - 2.8" Touch Display
4928 Linux has 2 drivers that support this display and this overlay supports
4932 fbtft/fb_ili9341: dtoverlay=watterott-display
4933 drm/mi0283qt: dtoverlay=watterott-display,drm,backlight-pwm,rotate=180
4935 Some notable differences with the DRM driver compared to fbtft:
4936 - The display is turned on when it's first used and not on driver load
4937 as with fbtft. So if nothing uses the display it stays off.
4938 - Can run with a higher SPI clock increasing framerate. This is possible
4939 since the driver avoids messing up the controller configuration due to
4940 transmission errors by running config commands at 10MHz and only pixel
4941 data at full speed (occasional pixel glitch might occur).
4942 - PWM backlight is supported.
4944 Load: dtoverlay=watterott-display,<param>=<val>
4945 Params: speed Display SPI bus speed
4946 rotate Display rotation {0,90,180,270}
4947 fps Delay between frame updates (fbtft only)
4948 debug Debug output level {0-7} (fbtft only)
4949 xohms Touchpanel sensitivity (X-plate resistance)
4950 swapxy Swap x and y axis
4951 backlight Change backlight GPIO pin {e.g. 12, 18}
4953 drm Use DRM/KMS driver mi0283qt instead of fbtft.
4954 Set the SPI clock to 70MHz.
4955 This has to be the first parameter.
4956 backlight-pwm Use pwm for backlight (drm only). NB: Disables
4957 audio headphone output as that also uses PWM.
4960 Name: waveshare-can-fd-hat-mode-a
4961 Info: Overlay for the Waveshare 2-Channel Isolated CAN FD Expansion HAT
4962 for Raspberry Pi, Multi Protections. Use this overlay when the
4963 HAT is configured in Mode A (Default), with can0 on spi0.0
4965 https://www.waveshare.com/2-ch-can-fd-hat.htm
4966 Load: dtoverlay=waveshare-can-fd-hat-mode-a
4970 Name: waveshare-can-fd-hat-mode-b
4971 Info: Overlay for the Waveshare 2-Channel Isolated CAN FD Expansion HAT
4972 for Raspberry Pi, Multi Protections. Use this overlay when the
4973 HAT is configured in Mode B (requires hardware modification), with
4974 can0 on spi0.0 and can1 on spi0.1.
4975 https://www.waveshare.com/2-ch-can-fd-hat.htm
4976 Load: dtoverlay=waveshare-can-fd-hat-mode-b
4981 Info: Configures the wittypi RTC module.
4982 Load: dtoverlay=wittypi,<param>=<val>
4983 Params: led_gpio GPIO for LED (default "17")
4984 led_trigger Choose which activity the LED tracks (default
4988 Name: wm8960-soundcard
4989 Info: Overlay for the Waveshare wm8960 soundcard
4990 Load: dtoverlay=wm8960-soundcard,<param>=<val>
4991 Params: alsaname Changes the card name in ALSA
4992 compatible Changes the codec compatibility
4998 If you are experiencing problems that you think are DT-related, enable DT
4999 diagnostic output by adding this to /boot/config.txt:
5003 and rebooting. Then run:
5007 and look for relevant messages.
5012 This is only meant to be a quick introduction to the subject of Device Tree on
5013 Raspberry Pi. There is a more complete explanation here:
5015 http://www.raspberrypi.org/documentation/configuration/device-tree.md