dtoverlays: Add option for PoE HAT to use Linux I2C instead of FW.
[platform/kernel/linux-rpi.git] / arch / arm / boot / dts / overlays / README
1 Introduction
2 ============
3
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.
10
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:
14
15     device_tree=
16
17 to your config.txt, which should cause your Pi to revert to the old way of
18 doing things after a reboot.
19
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:
25
26     dtparam=i2c=on,i2s=on,spi=on
27
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
31 needed.
32
33 Configuring additional, optional hardware is done using Device Tree overlays
34 (see below).
35
36 GPIO numbering uses the hardware pin numbering scheme (aka BCM scheme) and
37 not the physical pin numbers.
38
39 raspi-config
40 ============
41
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.
46
47 Modules
48 =======
49
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).
55
56 Using Overlays
57 ==============
58
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:
64
65     modprobe i2c-bcm2835
66     modprobe rtc-ds1307
67     echo ds1307 0x68 > /sys/class/i2c-adapter/i2c-1/new_device
68
69 With DT enabled, this becomes a line in config.txt:
70
71     dtoverlay=i2c-rtc,ds1307
72
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
76 parameter:
77
78     dtoverlay=i2c-rtc,ds1307,addr=0x68
79
80 Parameters usually have default values, although certain parameters are
81 mandatory. See the list of overlays below for a description of the parameters
82 and their defaults.
83
84 Making new Overlays based on existing Overlays
85 ==============================================
86
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.
91
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
95
96     # a realtime clock on i2c
97     dtoverlay=i2c-rtc,pcf85063
98
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.
102
103 A new overlay can be generated by using ovmerge utility.
104 https://github.com/raspberrypi/utils/blob/master/ovmerge/ovmerge
105
106 To generate an overlay for the above configuration we pass the configuration
107 to ovmerge and add the -c flag.
108
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
113
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.
117
118     dtoverlay=merged
119
120 It does the same as the original configuration but without parameters.
121
122 The Overlay and Parameter Reference
123 ===================================
124
125 N.B. When editing this file, please preserve the indentation levels to make it
126 simple to parse programmatically. NO HARD TABS.
127
128
129 Name:   <The base DTB>
130 Info:   Configures the base Raspberry Pi hardware
131 Load:   <loaded automatically>
132 Params:
133         ant1                    Select antenna 1 (default). CM4 only.
134
135         ant2                    Select antenna 2. CM4 only.
136
137         noant                   Disable both antennas. CM4 only.
138
139         audio                   Set to "on" to enable the onboard ALSA audio
140                                 interface (default "off")
141
142         axiperf                 Set to "on" to enable the AXI bus performance
143                                 monitors.
144                                 See /sys/kernel/debug/raspberrypi_axi_monitor
145                                 for the results.
146
147         cam0_reg                Enables CAM 0 regulator. CM1 & 3 only.
148
149         cam0_reg_gpio           Set GPIO for CAM 0 regulator. Default 30.
150                                 CM1 & 3 only.
151
152         cam1_reg                Enables CAM 1 regulator. CM1 & 3 only.
153
154         cam1_reg_gpio           Set GPIO for CAM 1 regulator. Default 2.
155                                 CM1 & 3 only.
156
157         eee                     Enable Energy Efficient Ethernet support for
158                                 compatible devices (default "on"). See also
159                                 "tx_lpi_timer". Pi3B+ only.
160
161         eth_downshift_after     Set the number of auto-negotiation failures
162                                 after which the 1000Mbps modes are disabled.
163                                 Legal values are 2, 3, 4, 5 and 0, where
164                                 0 means never downshift (default 2). Pi3B+ only.
165
166         eth_led0                Set mode of LED0 - amber on Pi3B+ (default "1"),
167                                 green on Pi4 (default "0").
168                                 The legal values are:
169
170                                 Pi3B+
171
172                                 0=link/activity          1=link1000/activity
173                                 2=link100/activity       3=link10/activity
174                                 4=link100/1000/activity  5=link10/1000/activity
175                                 6=link10/100/activity    14=off    15=on
176
177                                 Pi4
178
179                                 0=Speed/Activity         1=Speed
180                                 2=Flash activity         3=FDX
181                                 4=Off                    5=On
182                                 6=Alt                    7=Speed/Flash
183                                 8=Link                   9=Activity
184
185         eth_led1                Set mode of LED1 - green on Pi3B+ (default "6"),
186                                 amber on Pi4 (default "8"). See eth_led0 for
187                                 legal values.
188
189         eth_max_speed           Set the maximum speed a link is allowed
190                                 to negotiate. Legal values are 10, 100 and
191                                 1000 (default 1000). Pi3B+ only.
192
193         i2c_arm                 Set to "on" to enable the ARM's i2c interface
194                                 (default "off")
195
196         i2c_vc                  Set to "on" to enable the i2c interface
197                                 usually reserved for the VideoCore processor
198                                 (default "off")
199
200         i2c                     An alias for i2c_arm
201
202         i2c_arm_baudrate        Set the baudrate of the ARM's i2c interface
203                                 (default "100000")
204
205         i2c_vc_baudrate         Set the baudrate of the VideoCore i2c interface
206                                 (default "100000")
207
208         i2c_baudrate            An alias for i2c_arm_baudrate
209
210         i2s                     Set to "on" to enable the i2s interface
211                                 (default "off")
212
213         krnbt                   Set to "on" to enable autoprobing of Bluetooth
214                                 driver without need of hciattach/btattach
215                                 (default "off")
216
217         krnbt_baudrate          Set the baudrate of the PL011 UART when used
218                                 with krnbt=on
219
220         spi                     Set to "on" to enable the spi interfaces
221                                 (default "off")
222
223         spi_dma4                Use to enable 40-bit DMA on spi interfaces
224                                 (the assigned value doesn't matter)
225                                 (2711 only)
226
227         random                  Set to "on" to enable the hardware random
228                                 number generator (default "on")
229
230         sd_overclock            Clock (in MHz) to use when the MMC framework
231                                 requests 50MHz
232
233         sd_poll_once            Looks for a card once after booting. Useful
234                                 for network booting scenarios to avoid the
235                                 overhead of continuous polling. N.B. Using
236                                 this option restricts the system to using a
237                                 single card per boot (or none at all).
238                                 (default off)
239
240         sd_force_pio            Disable DMA support for SD driver (default off)
241
242         sd_pio_limit            Number of blocks above which to use DMA for
243                                 SD card (default 1)
244
245         sd_debug                Enable debug output from SD driver (default off)
246
247         sdio_overclock          Clock (in MHz) to use when the MMC framework
248                                 requests 50MHz for the SDIO/WLAN interface.
249
250         tx_lpi_timer            Set the delay in microseconds between going idle
251                                 and entering the low power state (default 600).
252                                 Requires EEE to be enabled - see "eee".
253
254         uart0                   Set to "off" to disable uart0 (default "on")
255
256         uart1                   Set to "on" or "off" to enable or disable uart1
257                                 (default varies)
258
259         watchdog                Set to "on" to enable the hardware watchdog
260                                 (default "off")
261
262         act_led_trigger         Choose which activity the LED tracks.
263                                 Use "heartbeat" for a nice load indicator.
264                                 (default "mmc")
265
266         act_led_activelow       Set to "on" to invert the sense of the LED
267                                 (default "off")
268                                 N.B. For Pi 3B, 3B+, 3A+ and 4B, use the act-led
269                                 overlay.
270
271         act_led_gpio            Set which GPIO to use for the activity LED
272                                 (in case you want to connect it to an external
273                                 device)
274                                 (default "16" on a non-Plus board, "47" on a
275                                 Plus or Pi 2)
276                                 N.B. For Pi 3B, 3B+, 3A+ and 4B, use the act-led
277                                 overlay.
278
279         pwr_led_trigger
280         pwr_led_activelow
281         pwr_led_gpio
282                                 As for act_led_*, but using the PWR LED.
283                                 Not available on Model A/B boards.
284
285         N.B. It is recommended to only enable those interfaces that are needed.
286         Leaving all interfaces enabled can lead to unwanted behaviour (i2c_vc
287         interfering with Pi Camera, I2S and SPI hogging GPIO pins, etc.)
288         Note also that i2c, i2c_arm and i2c_vc are aliases for the physical
289         interfaces i2c0 and i2c1. Use of the numeric variants is still possible
290         but deprecated because the ARM/VC assignments differ between board
291         revisions. The same board-specific mapping applies to i2c_baudrate,
292         and the other i2c baudrate parameters.
293
294
295 Name:   act-led
296 Info:   Pi 3B, 3B+, 3A+ and 4B use a GPIO expander to drive the LEDs which can
297         only be accessed from the VPU. There is a special driver for this with a
298         separate DT node, which has the unfortunate consequence of breaking the
299         act_led_gpio and act_led_activelow dtparams.
300         This overlay changes the GPIO controller back to the standard one and
301         restores the dtparams.
302 Load:   dtoverlay=act-led,<param>=<val>
303 Params: activelow               Set to "on" to invert the sense of the LED
304                                 (default "off")
305
306         gpio                    Set which GPIO to use for the activity LED
307                                 (in case you want to connect it to an external
308                                 device)
309                                 REQUIRED
310
311
312 Name:   adafruit-st7735r
313 Info:   Overlay for the SPI-connected Adafruit 1.8" 160x128 or 128x128 displays,
314         based on the ST7735R chip.
315         This overlay uses the newer DRM/KMS "Tiny" driver.
316 Load:   dtoverlay=adafruit-st7735r,<param>=<val>
317 Params: 128x128                 Select the 128x128 driver (default 160x128)
318         rotate                  Display rotation {0,90,180,270} (default 90)
319         speed                   SPI bus speed in Hz (default 4000000)
320         dc_pin                  GPIO pin for D/C (default 24)
321         reset_pin               GPIO pin for RESET (default 25)
322         led_pin                 GPIO used to control backlight (default 18)
323
324
325 Name:   adafruit18
326 Info:   Overlay for the SPI-connected Adafruit 1.8" display (based on the
327         ST7735R chip). It includes support for the "green tab" version.
328         This overlay uses the older fbtft driver.
329 Load:   dtoverlay=adafruit18,<param>=<val>
330 Params: green                   Use the adafruit18_green variant.
331         rotate                  Display rotation {0,90,180,270}
332         speed                   SPI bus speed in Hz (default 4000000)
333         fps                     Display frame rate in Hz
334         bgr                     Enable BGR mode (default off)
335         debug                   Debug output level {0-7}
336         dc_pin                  GPIO pin for D/C (default 24)
337         reset_pin               GPIO pin for RESET (default 25)
338         led_pin                 GPIO used to control backlight (default 18)
339
340
341 Name:   adau1977-adc
342 Info:   Overlay for activation of ADAU1977 ADC codec over I2C for control
343         and I2S for data.
344 Load:   dtoverlay=adau1977-adc
345 Params: <None>
346
347
348 Name:   adau7002-simple
349 Info:   Overlay for the activation of ADAU7002 stereo PDM to I2S converter.
350 Load:   dtoverlay=adau7002-simple,<param>=<val>
351 Params: card-name               Override the default, "adau7002", card name.
352
353
354 Name:   ads1015
355 Info:   Overlay for activation of Texas Instruments ADS1015 ADC over I2C
356 Load:   dtoverlay=ads1015,<param>=<val>
357 Params: addr                    I2C bus address of device. Set based on how the
358                                 addr pin is wired. (default=0x48 assumes addr
359                                 is pulled to GND)
360         cha_enable              Enable virtual channel a. (default=true)
361         cha_cfg                 Set the configuration for virtual channel a.
362                                 (default=4 configures this channel for the
363                                 voltage at A0 with respect to GND)
364         cha_datarate            Set the datarate (samples/sec) for this channel.
365                                 (default=4 sets 1600 sps)
366         cha_gain                Set the gain of the Programmable Gain
367                                 Amplifier for this channel. (default=2 sets the
368                                 full scale of the channel to 2.048 Volts)
369
370         Channel (ch) parameters can be set for each enabled channel.
371         A maximum of 4 channels can be enabled (letters a thru d).
372         For more information refer to the device datasheet at:
373         http://www.ti.com/lit/ds/symlink/ads1015.pdf
374
375
376 Name:   ads1115
377 Info:   Texas Instruments ADS1115 ADC
378 Load:   dtoverlay=ads1115,<param>[=<val>]
379 Params: addr                    I2C bus address of device. Set based on how the
380                                 addr pin is wired. (default=0x48 assumes addr
381                                 is pulled to GND)
382         cha_enable              Enable virtual channel a.
383         cha_cfg                 Set the configuration for virtual channel a.
384                                 (default=4 configures this channel for the
385                                 voltage at A0 with respect to GND)
386         cha_datarate            Set the datarate (samples/sec) for this channel.
387                                 (default=7 sets 860 sps)
388         cha_gain                Set the gain of the Programmable Gain
389                                 Amplifier for this channel. (Default 1 sets the
390                                 full scale of the channel to 4.096 Volts)
391
392         Channel parameters can be set for each enabled channel.
393         A maximum of 4 channels can be enabled (letters a thru d).
394         For more information refer to the device datasheet at:
395         http://www.ti.com/lit/ds/symlink/ads1115.pdf
396
397
398 Name:   ads7846
399 Info:   ADS7846 Touch controller
400 Load:   dtoverlay=ads7846,<param>=<val>
401 Params: cs                      SPI bus Chip Select (default 1)
402         speed                   SPI bus speed (default 2MHz, max 3.25MHz)
403         penirq                  GPIO used for PENIRQ. REQUIRED
404         penirq_pull             Set GPIO pull (default 0=none, 2=pullup)
405         swapxy                  Swap x and y axis
406         xmin                    Minimum value on the X axis (default 0)
407         ymin                    Minimum value on the Y axis (default 0)
408         xmax                    Maximum value on the X axis (default 4095)
409         ymax                    Maximum value on the Y axis (default 4095)
410         pmin                    Minimum reported pressure value (default 0)
411         pmax                    Maximum reported pressure value (default 65535)
412         xohms                   Touchpanel sensitivity (X-plate resistance)
413                                 (default 400)
414
415         penirq is required and usually xohms (60-100) has to be set as well.
416         Apart from that, pmax (255) and swapxy are also common.
417         The rest of the calibration can be done with xinput-calibrator.
418         See: github.com/notro/fbtft/wiki/FBTFT-on-Raspian
419         Device Tree binding document:
420         www.kernel.org/doc/Documentation/devicetree/bindings/input/ads7846.txt
421
422
423 Name:   adv7282m
424 Info:   Analog Devices ADV7282M analogue video to CSI2 bridge.
425         Uses Unicam1, which is the standard camera connector on most Pi
426         variants.
427 Load:   dtoverlay=adv7282m,<param>=<val>
428 Params: addr                    Overrides the I2C address (default 0x21)
429         media-controller        Configure use of Media Controller API for
430                                 configuring the sensor (default off)
431
432
433 Name:   adv728x-m
434 Info:   Analog Devices ADV728[0|1|2]-M analogue video to CSI2 bridges.
435         This is a wrapper for adv7282m, and defaults to ADV7282M.
436 Load:   dtoverlay=adv728x-m,<param>=<val>
437 Params: addr                    Overrides the I2C address (default 0x21)
438         adv7280m                Select ADV7280-M.
439         adv7281m                Select ADV7281-M.
440         adv7281ma               Select ADV7281-MA.
441         media-controller        Configure use of Media Controller API for
442                                 configuring the sensor (default off)
443
444
445 Name:   akkordion-iqdacplus
446 Info:   Configures the Digital Dreamtime Akkordion Music Player (based on the
447         OEM IQAudIO DAC+ or DAC Zero module).
448 Load:   dtoverlay=akkordion-iqdacplus,<param>=<val>
449 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
450                                 Digital volume control. Enable with
451                                 dtoverlay=akkordion-iqdacplus,24db_digital_gain
452                                 (The default behaviour is that the Digital
453                                 volume control is limited to a maximum of
454                                 0dB. ie. it can attenuate but not provide
455                                 gain. For most users, this will be desired
456                                 as it will prevent clipping. By appending
457                                 the 24db_digital_gain parameter, the Digital
458                                 volume control will allow up to 24dB of
459                                 gain. If this parameter is enabled, it is the
460                                 responsibility of the user to ensure that
461                                 the Digital volume control is set to a value
462                                 that does not result in clipping/distortion!)
463
464
465 Name:   allo-boss-dac-pcm512x-audio
466 Info:   Configures the Allo Boss DAC audio cards.
467 Load:   dtoverlay=allo-boss-dac-pcm512x-audio,<param>
468 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
469                                 Digital volume control. Enable with
470                                 "dtoverlay=allo-boss-dac-pcm512x-audio,
471                                 24db_digital_gain"
472                                 (The default behaviour is that the Digital
473                                 volume control is limited to a maximum of
474                                 0dB. ie. it can attenuate but not provide
475                                 gain. For most users, this will be desired
476                                 as it will prevent clipping. By appending
477                                 the 24db_digital_gain parameter, the Digital
478                                 volume control will allow up to 24dB of
479                                 gain. If this parameter is enabled, it is the
480                                 responsibility of the user to ensure that
481                                 the Digital volume control is set to a value
482                                 that does not result in clipping/distortion!)
483         slave                   Force Boss DAC into slave mode, using Pi a
484                                 master for bit clock and frame clock. Enable
485                                 with "dtoverlay=allo-boss-dac-pcm512x-audio,
486                                 slave"
487
488
489 Name:   allo-boss2-dac-audio
490 Info:   Configures the Allo Boss2 DAC audio card
491 Load:   dtoverlay=allo-boss2-dac-audio
492 Params: <None>
493
494
495 Name:   allo-digione
496 Info:   Configures the Allo Digione audio card
497 Load:   dtoverlay=allo-digione
498 Params: <None>
499
500
501 Name:   allo-katana-dac-audio
502 Info:   Configures the Allo Katana DAC audio card
503 Load:   dtoverlay=allo-katana-dac-audio
504 Params: <None>
505
506
507 Name:   allo-piano-dac-pcm512x-audio
508 Info:   Configures the Allo Piano DAC (2.0/2.1) audio cards.
509         (NB. This initial support is for 2.0 channel audio ONLY! ie. stereo.
510         The subwoofer outputs on the Piano 2.1 are not currently supported!)
511 Load:   dtoverlay=allo-piano-dac-pcm512x-audio,<param>
512 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
513                                 Digital volume control.
514                                 (The default behaviour is that the Digital
515                                 volume control is limited to a maximum of
516                                 0dB. ie. it can attenuate but not provide
517                                 gain. For most users, this will be desired
518                                 as it will prevent clipping. By appending
519                                 the 24db_digital_gain parameter, the Digital
520                                 volume control will allow up to 24dB of
521                                 gain. If this parameter is enabled, it is the
522                                 responsibility of the user to ensure that
523                                 the Digital volume control is set to a value
524                                 that does not result in clipping/distortion!)
525
526
527 Name:   allo-piano-dac-plus-pcm512x-audio
528 Info:   Configures the Allo Piano DAC (2.1) audio cards.
529 Load:   dtoverlay=allo-piano-dac-plus-pcm512x-audio,<param>
530 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
531                                 Digital volume control.
532                                 (The default behaviour is that the Digital
533                                 volume control is limited to a maximum of
534                                 0dB. ie. it can attenuate but not provide
535                                 gain. For most users, this will be desired
536                                 as it will prevent clipping. By appending
537                                 the 24db_digital_gain parameter, the Digital
538                                 volume control will allow up to 24dB of
539                                 gain. If this parameter is enabled, it is the
540                                 responsibility of the user to ensure that
541                                 the Digital volume control is set to a value
542                                 that does not result in clipping/distortion!)
543         glb_mclk                This option is only with Kali board. If enabled,
544                                 MCLK for Kali is used and PLL is disabled for
545                                 better voice quality. (default Off)
546
547
548 Name:   anyspi
549 Info:   Universal device tree overlay for SPI devices
550
551         Just specify the SPI address and device name ("compatible" property).
552         This overlay lacks any device-specific parameter support!
553
554         For devices on spi1 or spi2, the interfaces should be enabled
555         with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
556
557         Examples:
558         1. SPI NOR flash on spi0.1, maximum SPI clock frequency 45MHz:
559             dtoverlay=anyspi:spi0-1,dev="jedec,spi-nor",speed=45000000
560         2. MCP3204 ADC on spi1.2, maximum SPI clock frequency 500kHz:
561             dtoverlay=anyspi:spi1-2,dev="microchip,mcp3204"
562 Load:   dtoverlay=anyspi,<param>=<val>
563 Params: spi<n>-<m>              Configure device at spi<n>, cs<m>
564                                 (boolean, required)
565         dev                     Set device name to search compatible module
566                                 (string, required)
567         speed                   Set SPI clock frequency in Hz
568                                 (integer, optional, default 500000)
569
570
571 Name:   apds9960
572 Info:   Configures the AVAGO APDS9960 digital proximity, ambient light, RGB and
573         gesture sensor
574 Load:   dtoverlay=apds9960,<param>=<val>
575 Params: gpiopin                 GPIO used for INT (default 4)
576         noints                  Disable the interrupt GPIO line.
577
578
579 Name:   applepi-dac
580 Info:   Configures the Orchard Audio ApplePi-DAC audio card
581 Load:   dtoverlay=applepi-dac
582 Params: <None>
583
584
585 Name:   at86rf233
586 Info:   Configures the Atmel AT86RF233 802.15.4 low-power WPAN transceiver,
587         connected to spi0.0
588 Load:   dtoverlay=at86rf233,<param>=<val>
589 Params: interrupt               GPIO used for INT (default 23)
590         reset                   GPIO used for Reset (default 24)
591         sleep                   GPIO used for Sleep (default 25)
592         speed                   SPI bus speed in Hz (default 3000000)
593         trim                    Fine tuning of the internal capacitance
594                                 arrays (0=+0pF, 15=+4.5pF, default 15)
595
596
597 Name:   audioinjector-addons
598 Info:   Configures the audioinjector.net audio add on soundcards
599 Load:   dtoverlay=audioinjector-addons,<param>=<val>
600 Params: non-stop-clocks         Keeps the clocks running even when the stream
601                                 is paused or stopped (default off)
602
603
604 Name:   audioinjector-isolated-soundcard
605 Info:   Configures the audioinjector.net isolated soundcard
606 Load:   dtoverlay=audioinjector-isolated-soundcard
607 Params: <None>
608
609
610 Name:   audioinjector-ultra
611 Info:   Configures the audioinjector.net ultra soundcard
612 Load:   dtoverlay=audioinjector-ultra
613 Params: <None>
614
615
616 Name:   audioinjector-wm8731-audio
617 Info:   Configures the audioinjector.net audio add on soundcard
618 Load:   dtoverlay=audioinjector-wm8731-audio
619 Params: <None>
620
621
622 Name:   audiosense-pi
623 Info:   Configures the audiosense-pi add on soundcard
624         For more information refer to
625         https://gitlab.com/kakar0t/audiosense-pi
626 Load:   dtoverlay=audiosense-pi
627 Params: <None>
628
629
630 Name:   audremap
631 Info:   Switches PWM sound output to GPIOs on the 40-pin header
632 Load:   dtoverlay=audremap,<param>=<val>
633 Params: swap_lr                 Reverse the channel allocation, which will also
634                                 swap the audio jack outputs (default off)
635         enable_jack             Don't switch off the audio jack output
636                                 (default off)
637         pins_12_13              Select GPIOs 12 & 13 (default)
638         pins_18_19              Select GPIOs 18 & 19
639
640
641 Name:   balena-fin
642 Info:   Overlay that enables WLAN, Bluetooth and the GPIO expander on the
643         balenaFin carrier board for the Raspberry Pi Compute Module 3/3+ Lite.
644 Load:   dtoverlay=balena-fin
645 Params: <None>
646
647
648 Name:   bmp085_i2c-sensor
649 Info:   This overlay is now deprecated - see i2c-sensor
650 Load:   <Deprecated>
651
652
653 Name:   cap1106
654 Info:   Enables the ability to use the cap1106 touch sensor as a keyboard
655 Load:   dtoverlay=cap1106,<param>=<val>
656 Params: int_pin                 GPIO pin for interrupt signal (default 23)
657
658
659 Name:   chipdip-dac
660 Info:   Configures Chip Dip audio cards.
661 Load:   dtoverlay=chipdip-dac
662 Params: <None>
663
664
665 Name:   cma
666 Info:   Set custom CMA sizes, only use if you know what you are doing, might
667         clash with other overlays like vc4-fkms-v3d and vc4-kms-v3d.
668 Load:   dtoverlay=cma,<param>=<val>
669 Params: cma-512                 CMA is 512MB (needs 1GB)
670         cma-448                 CMA is 448MB (needs 1GB)
671         cma-384                 CMA is 384MB (needs 1GB)
672         cma-320                 CMA is 320MB (needs 1GB)
673         cma-256                 CMA is 256MB (needs 1GB)
674         cma-192                 CMA is 192MB (needs 1GB)
675         cma-128                 CMA is 128MB
676         cma-96                  CMA is 96MB
677         cma-64                  CMA is 64MB
678         cma-size                CMA size in bytes, 4MB aligned
679         cma-default             Use upstream's default value
680
681
682 Name:   cutiepi-panel
683 Info:   8" TFT LCD display and touch panel used by cutiepi.io
684 Load:   dtoverlay=cutiepi-panel
685 Params: <None>
686
687
688 Name:   dht11
689 Info:   Overlay for the DHT11/DHT21/DHT22 humidity/temperature sensors
690         Also sometimes found with the part number(s) AM230x.
691 Load:   dtoverlay=dht11,<param>=<val>
692 Params: gpiopin                 GPIO connected to the sensor's DATA output.
693                                 (default 4)
694
695
696 Name:   dionaudio-loco
697 Info:   Configures the Dion Audio LOCO DAC-AMP
698 Load:   dtoverlay=dionaudio-loco
699 Params: <None>
700
701
702 Name:   dionaudio-loco-v2
703 Info:   Configures the Dion Audio LOCO-V2 DAC-AMP
704 Load:   dtoverlay=dionaudio-loco-v2,<param>=<val>
705 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
706                                 Digital volume control. Enable with
707                                 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
708                                 (The default behaviour is that the Digital
709                                 volume control is limited to a maximum of
710                                 0dB. ie. it can attenuate but not provide
711                                 gain. For most users, this will be desired
712                                 as it will prevent clipping. By appending
713                                 the 24dB_digital_gain parameter, the Digital
714                                 volume control will allow up to 24dB of
715                                 gain. If this parameter is enabled, it is the
716                                 responsibility of the user to ensure that
717                                 the Digital volume control is set to a value
718                                 that does not result in clipping/distortion!)
719
720
721 Name:   disable-bt
722 Info:   Disable onboard Bluetooth on Pi 3B, 3B+, 3A+, 4B and Zero W, restoring
723         UART0/ttyAMA0 over GPIOs 14 & 15.
724         N.B. To disable the systemd service that initialises the modem so it
725         doesn't use the UART, use 'sudo systemctl disable hciuart'.
726 Load:   dtoverlay=disable-bt
727 Params: <None>
728
729
730 Name:   disable-wifi
731 Info:   Disable onboard WLAN on Pi 3B, 3B+, 3A+, 4B and Zero W.
732 Load:   dtoverlay=disable-wifi
733 Params: <None>
734
735
736 Name:   dpi18
737 Info:   Overlay for a generic 18-bit DPI display
738         This uses GPIOs 0-21 (so no I2C, uart etc.), and activates the output
739         2-3 seconds after the kernel has started.
740 Load:   dtoverlay=dpi18
741 Params: <None>
742
743
744 Name:   dpi18cpadhi
745 Info:   Overlay for a generic 18-bit DPI display (in 'mode 6' connection scheme)
746         This uses GPIOs 0-9,12-17,20-25 (so no I2C, uart etc.), and activates
747         the output 3-3 seconds after the kernel has started.
748 Load:   dtoverlay=dpi18cpadhi
749 Params: <None>
750
751
752 Name:   dpi24
753 Info:   Overlay for a generic 24-bit DPI display
754         This uses GPIOs 0-27 (so no I2C, uart etc.), and activates the output
755         2-3 seconds after the kernel has started.
756 Load:   dtoverlay=dpi24
757 Params: <None>
758
759
760 Name:   draws
761 Info:   Configures the NW Digital Radio DRAWS Hat
762
763         The board includes an ADC to measure various board values and also
764         provides two analog user inputs on the expansion header.  The ADC
765         can be configured for various sample rates and gain values to adjust
766         the input range.  Tables describing the two parameters follow.
767
768         ADC Gain Values:
769             0 = +/- 6.144V
770             1 = +/- 4.096V
771             2 = +/- 2.048V
772             3 = +/- 1.024V
773             4 = +/- 0.512V
774             5 = +/- 0.256V
775             6 = +/- 0.256V
776             7 = +/- 0.256V
777
778         ADC Datarate Values:
779             0 = 128sps
780             1 = 250sps
781             2 = 490sps
782             3 = 920sps
783             4 = 1600sps (default)
784             5 = 2400sps
785             6 = 3300sps
786             7 = 3300sps
787 Load:   dtoverlay=draws,<param>=<val>
788 Params: draws_adc_ch4_gain      Sets the full scale resolution of the ADCs
789                                 input voltage sensor (default 1)
790
791         draws_adc_ch4_datarate  Sets the datarate of the ADCs input voltage
792                                 sensor
793
794         draws_adc_ch5_gain      Sets the full scale resolution of the ADCs
795                                 5V rail voltage sensor (default 1)
796
797         draws_adc_ch5_datarate  Sets the datarate of the ADCs 4V rail voltage
798                                 sensor
799
800         draws_adc_ch6_gain      Sets the full scale resolution of the ADCs
801                                 AIN2 input (default 2)
802
803         draws_adc_ch6_datarate  Sets the datarate of the ADCs AIN2 input
804
805         draws_adc_ch7_gain      Sets the full scale resolution of the ADCs
806                                 AIN3 input (default 2)
807
808         draws_adc_ch7_datarate  Sets the datarate of the ADCs AIN3 input
809
810         alsaname                Name of the ALSA audio device (default "draws")
811
812
813 Name:   dwc-otg
814 Info:   Selects the dwc_otg USB controller driver which has fiq support. This
815         is the default on all except the Pi Zero which defaults to dwc2.
816 Load:   dtoverlay=dwc-otg
817 Params: <None>
818
819
820 Name:   dwc2
821 Info:   Selects the dwc2 USB controller driver
822 Load:   dtoverlay=dwc2,<param>=<val>
823 Params: dr_mode                 Dual role mode: "host", "peripheral" or "otg"
824
825         g-rx-fifo-size          Size of rx fifo size in gadget mode
826
827         g-np-tx-fifo-size       Size of non-periodic tx fifo size in gadget
828                                 mode
829
830
831 [ The ds1307-rtc overlay has been deleted. See i2c-rtc. ]
832
833
834 Name:   edt-ft5406
835 Info:   Overlay for the EDT FT5406 touchscreen on the CSI/DSI I2C interface.
836         This works with the Raspberry Pi 7" touchscreen when not being polled
837         by the firmware.
838         You MUST use either "disable_touchscreen=1" or "ignore_lcd=1" in
839         config.txt to stop the firmware polling the touchscreen.
840 Load:   dtoverlay=edt-ft5406,<param>=<val>
841 Params: sizex                   Touchscreen size x (default 800)
842         sizey                   Touchscreen size y (default 480)
843         invx                    Touchscreen inverted x axis
844         invy                    Touchscreen inverted y axis
845         swapxy                  Touchscreen swapped x y axis
846
847
848 Name:   enc28j60
849 Info:   Overlay for the Microchip ENC28J60 Ethernet Controller on SPI0
850 Load:   dtoverlay=enc28j60,<param>=<val>
851 Params: int_pin                 GPIO used for INT (default 25)
852
853         speed                   SPI bus speed (default 12000000)
854
855
856 Name:   enc28j60-spi2
857 Info:   Overlay for the Microchip ENC28J60 Ethernet Controller on SPI2
858 Load:   dtoverlay=enc28j60-spi2,<param>=<val>
859 Params: int_pin                 GPIO used for INT (default 39)
860
861         speed                   SPI bus speed (default 12000000)
862
863
864 Name:   exc3000
865 Info:   Enables I2C connected EETI EXC3000 multiple touch controller using
866         GPIO 4 (pin 7 on GPIO header) for interrupt.
867 Load:   dtoverlay=exc3000,<param>=<val>
868 Params: interrupt               GPIO used for interrupt (default 4)
869         sizex                   Touchscreen size x (default 4096)
870         sizey                   Touchscreen size y (default 4096)
871         invx                    Touchscreen inverted x axis
872         invy                    Touchscreen inverted y axis
873         swapxy                  Touchscreen swapped x y axis
874
875
876 Name:   fbtft
877 Info:   Overlay for SPI-connected displays using the fbtft drivers.
878
879         This overlay seeks to replace the functionality provided by fbtft_device
880         which is now gone from the kernel.
881
882         Most displays from fbtft_device have been ported over.
883         Example:
884           dtoverlay=fbtft,spi0-0,rpi-display,reset_pin=23,dc_pin=24,led_pin=18,rotate=270
885
886         It is also possible to specify the controller (this will use the default
887         init sequence in the driver).
888         Example:
889           dtoverlay=fbtft,spi0-0,ili9341,bgr,reset_pin=23,dc_pin=24,led_pin=18,rotate=270
890
891         For devices on spi1 or spi2, the interfaces should be enabled
892         with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
893
894         The following features of fbtft_device have not been ported over:
895         - parallel bus is not supported
896         - the init property which overrides the controller initialization
897           sequence is not supported as a parameter due to memory limitations in
898           the bootloader responsible for applying the overlay.
899
900         See https://github.com/notro/fbtft/wiki/FBTFT-RPI-overlays for how to
901         create an overlay.
902
903 Load:   dtoverlay=fbtft,<param>=<val>
904 Params:
905         spi<n>-<m>              Configure device at spi<n>, cs<m>
906                                 (boolean, required)
907         speed                   SPI bus speed in Hz (default 32000000)
908         cpha                    Shifted clock phase (CPHA) mode
909         cpol                    Inverse clock polarity (CPOL) mode
910
911         adafruit18              Adafruit 1.8
912         adafruit22              Adafruit 2.2 (old)
913         adafruit22a             Adafruit 2.2
914         adafruit28              Adafruit 2.8
915         adafruit13m             Adafruit 1.3 OLED
916         admatec_c-berry28       C-Berry28
917         dogs102                 EA DOGS102
918         er_tftm050_2            ER-TFTM070-2
919         er_tftm070_5            ER-TFTM070-5
920         ew24ha0                 EW24HA0
921         ew24ha0_9bit            EW24HA0 in 9-bit mode
922         freetronicsoled128      Freetronics OLED128
923         hy28a                   HY28A
924         hy28b                   HY28B
925         itdb28_spi              ITDB02-2.8 with SPI interface circuit
926         mi0283qt-2              Watterott MI0283QT-2
927         mi0283qt-9a             Watterott MI0283QT-9A
928         nokia3310               Nokia 3310
929         nokia3310a              Nokia 3310a
930         nokia5110               Nokia 5110
931         piscreen                PiScreen
932         pitft                   Adafruit PiTFT 2.8
933         pioled                  ILSoft OLED
934         rpi-display             Watterott rpi-display
935         sainsmart18             Sainsmart 1.8
936         sainsmart32_spi         Sainsmart 3.2 with SPI interfce circuit
937         tinylcd35               TinyLCD 3.5
938         tm022hdh26              Tianma TM022HDH26
939         tontec35_9481           Tontect 3.5 with ILI9481 controller
940         tontec35_9486           Tontect 3.5 with ILI9486 controller
941         waveshare32b            Waveshare 3.2
942         waveshare22             Waveshare 2.2
943
944         bd663474                BD663474 display controller
945         hx8340bn                HX8340BN display controller
946         hx8347d                 HX8347D display controller
947         hx8353d                 HX8353D display controller
948         hx8357d                 HX8357D display controller
949         ili9163                 ILI9163 display controller
950         ili9320                 ILI9320 display controller
951         ili9325                 ILI9325 display controller
952         ili9340                 ILI9340 display controller
953         ili9341                 ILI9341 display controller
954         ili9481                 ILI9481 display controller
955         ili9486                 ILI9486 display controller
956         pcd8544                 PCD8544 display controller
957         ra8875                  RA8875 display controller
958         s6d02a1                 S6D02A1 display controller
959         s6d1121                 S6D1121 display controller
960         seps525                 SEPS525 display controller
961         sh1106                  SH1106 display controller
962         ssd1289                 SSD1289 display controller
963         ssd1305                 SSD1305 display controller
964         ssd1306                 SSD1306 display controller
965         ssd1325                 SSD1325 display controller
966         ssd1331                 SSD1331 display controller
967         ssd1351                 SSD1351 display controller
968         st7735r                 ST7735R display controller
969         st7789v                 ST7789V display controller
970         tls8204                 TLS8204 display controller
971         uc1611                  UC1611 display controller
972         uc1701                  UC1701 display controller
973         upd161704               UPD161704 display controller
974
975         width                   Display width in pixels
976         height                  Display height in pixels
977         regwidth                Display controller register width (default is
978                                 driver specific)
979         buswidth                Display bus interface width (default 8)
980         debug                   Debug output level {0-7}
981         rotate                  Display rotation {0, 90, 180, 270} (counter
982                                 clockwise). Not supported by all drivers.
983         bgr                     Enable BGR mode (default off). Use if Red and
984                                 Blue are swapped. Not supported by all drivers.
985         fps                     Frames per second (default 30). In effect this
986                                 states how long the driver will wait after video
987                                 memory has been changed until display update
988                                 transfer is started.
989         txbuflen                Length of the FBTFT transmit buffer
990                                 (default 4096)
991         startbyte               Sets the Start byte used by fb_ili9320,
992                                 fb_ili9325 and fb_hx8347d. Common value is 0x70.
993         gamma                   String representation of Gamma Curve(s). Driver
994                                 specific. Not supported by all drivers.
995         reset_pin               GPIO pin for RESET
996         dc_pin                  GPIO pin for D/C
997         led_pin                 GPIO pin for LED backlight
998
999
1000 Name:   fe-pi-audio
1001 Info:   Configures the Fe-Pi Audio Sound Card
1002 Load:   dtoverlay=fe-pi-audio
1003 Params: <None>
1004
1005
1006 Name:   fsm-demo
1007 Info:   A demonstration of the gpio-fsm driver. The GPIOs are chosen to work
1008         nicely with a "traffic-light" display of red, amber and green LEDs on
1009         GPIOs 7, 8 and 25 respectively.
1010 Load:   dtoverlay=fsm-demo,<param>=<val>
1011 Params: fsm_debug               Enable debug logging (default off)
1012
1013
1014 Name:   ghost-amp
1015 Info:   An overlay for the Ghost amplifier.
1016 Load:   dtoverlay=ghost-amp,<param>=<val>
1017 Params: fsm_debug               Enable debug logging of the GPIO FSM (default
1018                                 off)
1019
1020
1021 Name:   goodix
1022 Info:   Enables I2C connected Goodix gt9271 multiple touch controller using
1023         GPIOs 4 and 17 (pins 7 and 11 on GPIO header) for interrupt and reset.
1024 Load:   dtoverlay=goodix,<param>=<val>
1025 Params: interrupt               GPIO used for interrupt (default 4)
1026         reset                   GPIO used for reset (default 17)
1027
1028
1029 Name:   googlevoicehat-soundcard
1030 Info:   Configures the Google voiceHAT soundcard
1031 Load:   dtoverlay=googlevoicehat-soundcard
1032 Params: <None>
1033
1034
1035 Name:   gpio-fan
1036 Info:   Configure a GPIO pin to control a cooling fan.
1037 Load:   dtoverlay=gpio-fan,<param>=<val>
1038 Params: gpiopin                 GPIO used to control the fan (default 12)
1039         temp                    Temperature at which the fan switches on, in
1040                                 millicelcius (default 55000)
1041
1042
1043 Name:   gpio-ir
1044 Info:   Use GPIO pin as rc-core style infrared receiver input. The rc-core-
1045         based gpio_ir_recv driver maps received keys directly to a
1046         /dev/input/event* device, all decoding is done by the kernel - LIRC is
1047         not required! The key mapping and other decoding parameters can be
1048         configured by "ir-keytable" tool.
1049 Load:   dtoverlay=gpio-ir,<param>=<val>
1050 Params: gpio_pin                Input pin number. Default is 18.
1051
1052         gpio_pull               Desired pull-up/down state (off, down, up)
1053                                 Default is "up".
1054
1055         invert                  "1" = invert the input (active-low signalling).
1056                                 "0" = non-inverted input (active-high
1057                                 signalling). Default is "1".
1058
1059         rc-map-name             Default rc keymap (can also be changed by
1060                                 ir-keytable), defaults to "rc-rc6-mce"
1061
1062
1063 Name:   gpio-ir-tx
1064 Info:   Use GPIO pin as bit-banged infrared transmitter output.
1065         This is an alternative to "pwm-ir-tx". gpio-ir-tx doesn't require
1066         a PWM so it can be used together with onboard analog audio.
1067 Load:   dtoverlay=gpio-ir-tx,<param>=<val>
1068 Params: gpio_pin                Output GPIO (default 18)
1069
1070         invert                  "1" = invert the output (make it active-low).
1071                                 Default is "0" (active-high).
1072
1073
1074 Name:   gpio-key
1075 Info:   This is a generic overlay for activating GPIO keypresses using
1076         the gpio-keys library and this dtoverlay. Multiple keys can be
1077         set up using multiple calls to the overlay for configuring
1078         additional buttons or joysticks. You can see available keycodes
1079         at https://github.com/torvalds/linux/blob/v4.12/include/uapi/
1080         linux/input-event-codes.h#L64
1081 Load:   dtoverlay=gpio-key,<param>=<val>
1082 Params: gpio                    GPIO pin to trigger on (default 3)
1083         active_low              When this is 1 (active low), a falling
1084                                 edge generates a key down event and a
1085                                 rising edge generates a key up event.
1086                                 When this is 0 (active high), this is
1087                                 reversed. The default is 1 (active low)
1088         gpio_pull               Desired pull-up/down state (off, down, up)
1089                                 Default is "up". Note that the default pin
1090                                 (GPIO3) has an external pullup
1091         label                   Set a label for the key
1092         keycode                 Set the key code for the button
1093
1094
1095
1096 Name:   gpio-led
1097 Info:   This is a generic overlay for activating LEDs (or any other component)
1098         by a GPIO pin. Multiple LEDs can be set up using multiple calls to the
1099         overlay. While there are many existing methods to activate LEDs on the
1100         RPi, this method offers some advantages:
1101         1) Does not require any userspace programs.
1102         2) LEDs can be connected to the kernel's led-trigger framework,
1103            and drive the LED based on triggers such as cpu load, heartbeat,
1104            kernel panic, key input, timers and others.
1105         3) LED can be tied to the input state of another GPIO pin.
1106         4) The LED is setup early during the kernel boot process (useful
1107            for cpu/heartbeat/panic triggers).
1108
1109         Typical electrical connection is:
1110            RPI-GPIO.19  ->  LED  -> 300ohm resister  -> RPI-GND
1111         The GPIO pin number can be changed with the 'gpio=' parameter.
1112
1113         To control an LED from userspace, write a 0 or 1 value:
1114            echo 1 > /sys/class/leds/myled1/brightness
1115         The 'myled1' name can be changed with the 'label=' parameter.
1116
1117         To connect the LED to a kernel trigger from userspace:
1118            echo cpu > /sys/class/leds/myled1/trigger
1119            echo heartbeat > /sys/class/leds/myled1/trigger
1120            echo none > /sys/class/leds/myled1/trigger
1121         To connect the LED to GPIO.26 pin (physical pin 37):
1122            echo gpio > /sys/class/leds/myled1/trigger
1123            echo 26 > /sys/class/leds/myled1/gpio
1124         Available triggers:
1125            cat /sys/class/leds/myled1/trigger
1126
1127         More information about the Linux kernel LED/Trigger system:
1128            https://www.kernel.org/doc/Documentation/leds/leds-class.rst
1129            https://www.kernel.org/doc/Documentation/leds/ledtrig-oneshot.rst
1130 Load:   dtoverlay=gpio-led,<param>=<val>
1131 Params: gpio                    GPIO pin connected to the LED (default 19)
1132         label                   The label for this LED. It will appear under
1133                                 /sys/class/leds/<label> . Default 'myled1'.
1134         trigger                 Set the led-trigger to connect to this LED.
1135                                 default 'none' (LED is user-controlled).
1136                                 Some possible triggers:
1137                                  cpu - CPU load (all CPUs)
1138                                  cpu0 - CPU load of first CPU.
1139                                  mmc - disk activity (all disks)
1140                                  panic - turn on on kernel panic
1141                                  heartbeat - indicate system health
1142                                  gpio - connect to a GPIO input pin (note:
1143                                         currently the GPIO PIN can not be set
1144                                         using overlay parameters, must be
1145                                         done in userspace, see examples above.
1146         active_low              Set to 1 to turn invert the LED control
1147                                 (writing 0 to /sys/class/leds/XXX/brightness
1148                                 will turn on the GPIO/LED). Default '0'.
1149
1150
1151 Name:   gpio-no-bank0-irq
1152 Info:   Use this overlay to disable GPIO interrupts for GPIOs in bank 0 (0-27),
1153         which can be useful for UIO drivers.
1154         N.B. Using this overlay will trigger a kernel WARN during booting, but
1155         this can safely be ignored - the system should work as expected.
1156 Load:   dtoverlay=gpio-no-bank0-irq
1157 Params: <None>
1158
1159
1160 Name:   gpio-no-irq
1161 Info:   Use this overlay to disable all GPIO interrupts, which can be useful
1162         for user-space GPIO edge detection systems.
1163 Load:   dtoverlay=gpio-no-irq
1164 Params: <None>
1165
1166
1167 Name:   gpio-poweroff
1168 Info:   Drives a GPIO high or low on poweroff (including halt). Using this
1169         overlay interferes with the normal power-down sequence, preventing the
1170         kernel from resetting the SoC (a necessary step in a normal power-off
1171         or reboot). This also disables the ability to trigger a boot by driving
1172         GPIO3 low.
1173
1174         The GPIO starts in an inactive state. At poweroff time it is driven
1175         active for 100ms, then inactive for 100ms, then active again. It is
1176         safe to remove the power at any point after the initial activation of
1177         the GPIO.
1178
1179         Users of this overlay are required to provide an external mechanism to
1180         switch off the power supply when signalled - failure to do so results
1181         in a kernel BUG, increased power consumption and undefined behaviour.
1182 Load:   dtoverlay=gpio-poweroff,<param>=<val>
1183 Params: gpiopin                 GPIO for signalling (default 26)
1184
1185         active_low              Set if the power control device requires a
1186                                 high->low transition to trigger a power-down.
1187                                 Note that this will require the support of a
1188                                 custom dt-blob.bin to prevent a power-down
1189                                 during the boot process, and that a reboot
1190                                 will also cause the pin to go low.
1191         input                   Set if the gpio pin should be configured as
1192                                 an input.
1193         export                  Set to export the configured pin to sysfs
1194         active_delay_ms         Initial GPIO active period (default 100)
1195         inactive_delay_ms       Subsequent GPIO inactive period (default 100)
1196         timeout_ms              Specify (in ms) how long the kernel waits for
1197                                 power-down before issuing a WARN (default 3000).
1198
1199
1200 Name:   gpio-shutdown
1201 Info:   Initiates a shutdown when GPIO pin changes. The given GPIO pin
1202         is configured as an input key that generates KEY_POWER events.
1203
1204         This event is handled by systemd-logind by initiating a
1205         shutdown. Systemd versions older than 225 need an udev rule
1206         enable listening to the input device:
1207
1208                 ACTION!="REMOVE", SUBSYSTEM=="input", KERNEL=="event*", \
1209                         SUBSYSTEMS=="platform", DRIVERS=="gpio-keys", \
1210                         ATTRS{keys}=="116", TAG+="power-switch"
1211
1212         Alternatively this event can be handled also on systems without
1213         systemd, just by traditional SysV init daemon. KEY_POWER event
1214         (keycode 116) needs to be mapped to KeyboardSignal on console
1215         and then kb::kbrequest inittab action which is triggered by
1216         KeyboardSignal from console can be configured to issue system
1217         shutdown. Steps for this configuration are:
1218
1219             Add following lines to the /etc/console-setup/remap.inc file:
1220
1221                 # Key Power as special keypress
1222                 keycode 116 = KeyboardSignal
1223
1224             Then add following lines to /etc/inittab file:
1225
1226                 # Action on special keypress (Key Power)
1227                 kb::kbrequest:/sbin/shutdown -t1 -a -h -P now
1228
1229             And finally reload configuration by calling following commands:
1230
1231                 # dpkg-reconfigure console-setup
1232                 # service console-setup reload
1233                 # init q
1234
1235         This overlay only handles shutdown. After shutdown, the system
1236         can be powered up again by driving GPIO3 low. The default
1237         configuration uses GPIO3 with a pullup, so if you connect a
1238         button between GPIO3 and GND (pin 5 and 6 on the 40-pin header),
1239         you get a shutdown and power-up button. Please note that
1240         Raspberry Pi 1 Model B rev 1 uses GPIO1 instead of GPIO3.
1241 Load:   dtoverlay=gpio-shutdown,<param>=<val>
1242 Params: gpio_pin                GPIO pin to trigger on (default 3)
1243                                 For Raspberry Pi 1 Model B rev 1 set this
1244                                 explicitly to value 1, e.g.:
1245
1246                                     dtoverlay=gpio-shutdown,gpio_pin=1
1247
1248         active_low              When this is 1 (active low), a falling
1249                                 edge generates a key down event and a
1250                                 rising edge generates a key up event.
1251                                 When this is 0 (active high), this is
1252                                 reversed. The default is 1 (active low).
1253
1254         gpio_pull               Desired pull-up/down state (off, down, up)
1255                                 Default is "up".
1256
1257                                 Note that the default pin (GPIO3) has an
1258                                 external pullup. Same applies for GPIO1
1259                                 on Raspberry Pi 1 Model B rev 1.
1260
1261         debounce                Specify the debounce interval in milliseconds
1262                                 (default 100)
1263
1264
1265 Name:   hd44780-lcd
1266 Info:   Configures an HD44780 compatible LCD display. Uses 4 gpio pins for
1267         data, 2 gpio pins for enable and register select and 1 optional pin
1268         for enabling/disabling the backlight display.
1269 Load:   dtoverlay=hd44780-lcd,<param>=<val>
1270 Params: pin_d4                  GPIO pin for data pin D4 (default 6)
1271
1272         pin_d5                  GPIO pin for data pin D5 (default 13)
1273
1274         pin_d6                  GPIO pin for data pin D6 (default 19)
1275
1276         pin_d7                  GPIO pin for data pin D7 (default 26)
1277
1278         pin_en                  GPIO pin for "Enable" (default 21)
1279
1280         pin_rs                  GPIO pin for "Register Select" (default 20)
1281
1282         pin_bl                  Optional pin for enabling/disabling the
1283                                 display backlight. (default disabled)
1284
1285         display_height          Height of the display in characters
1286
1287         display_width           Width of the display in characters
1288
1289
1290 Name:   hdmi-backlight-hwhack-gpio
1291 Info:   Devicetree overlay for GPIO based backlight on/off capability.
1292         Use this if you have one of those HDMI displays whose backlight cannot
1293         be controlled via DPMS over HDMI and plan to do a little soldering to
1294         use an RPi gpio pin for on/off switching. See:
1295         https://www.waveshare.com/wiki/7inch_HDMI_LCD_(C)#Backlight_Control
1296 Load:   dtoverlay=hdmi-backlight-hwhack-gpio,<param>=<val>
1297 Params: gpio_pin                GPIO pin used (default 17)
1298         active_low              Set this to 1 if the display backlight is
1299                                 switched on when the wire goes low.
1300                                 Leave the default (value 0) if the backlight
1301                                 expects a high to switch it on.
1302
1303
1304 Name:   hifiberry-amp
1305 Info:   Configures the HifiBerry Amp and Amp+ audio cards
1306 Load:   dtoverlay=hifiberry-amp
1307 Params: <None>
1308
1309
1310 Name:   hifiberry-amp100
1311 Info:   Configures the HifiBerry AMP100 audio card
1312 Load:   dtoverlay=hifiberry-amp100,<param>=<val>
1313 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
1314                                 Digital volume control. Enable with
1315                                 "dtoverlay=hifiberry-amp100,24db_digital_gain"
1316                                 (The default behaviour is that the Digital
1317                                 volume control is limited to a maximum of
1318                                 0dB. ie. it can attenuate but not provide
1319                                 gain. For most users, this will be desired
1320                                 as it will prevent clipping. By appending
1321                                 the 24dB_digital_gain parameter, the Digital
1322                                 volume control will allow up to 24dB of
1323                                 gain. If this parameter is enabled, it is the
1324                                 responsibility of the user to ensure that
1325                                 the Digital volume control is set to a value
1326                                 that does not result in clipping/distortion!)
1327         slave                   Force DAC+ Pro into slave mode, using Pi as
1328                                 master for bit clock and frame clock.
1329         leds_off                If set to 'true' the onboard indicator LEDs
1330                                 are switched off at all times.
1331         auto_mute               If set to 'true' the amplifier is automatically
1332                                 muted when the DAC is not playing.
1333         mute_ext_ctl            The amplifier's HW mute control is enabled
1334                                 in ALSA mixer and set to <val>.
1335                                 Will be overwritten by ALSA user settings.
1336
1337
1338 Name:   hifiberry-dac
1339 Info:   Configures the HifiBerry DAC audio cards
1340 Load:   dtoverlay=hifiberry-dac
1341 Params: <None>
1342
1343
1344 Name:   hifiberry-dacplus
1345 Info:   Configures the HifiBerry DAC+ audio card
1346 Load:   dtoverlay=hifiberry-dacplus,<param>=<val>
1347 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
1348                                 Digital volume control. Enable with
1349                                 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
1350                                 (The default behaviour is that the Digital
1351                                 volume control is limited to a maximum of
1352                                 0dB. ie. it can attenuate but not provide
1353                                 gain. For most users, this will be desired
1354                                 as it will prevent clipping. By appending
1355                                 the 24dB_digital_gain parameter, the Digital
1356                                 volume control will allow up to 24dB of
1357                                 gain. If this parameter is enabled, it is the
1358                                 responsibility of the user to ensure that
1359                                 the Digital volume control is set to a value
1360                                 that does not result in clipping/distortion!)
1361         slave                   Force DAC+ Pro into slave mode, using Pi as
1362                                 master for bit clock and frame clock.
1363         leds_off                If set to 'true' the onboard indicator LEDs
1364                                 are switched off at all times.
1365
1366
1367 Name:   hifiberry-dacplusadc
1368 Info:   Configures the HifiBerry DAC+ADC audio card
1369 Load:   dtoverlay=hifiberry-dacplusadc,<param>=<val>
1370 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
1371                                 Digital volume control. Enable with
1372                                 "dtoverlay=hifiberry-dacplus,24db_digital_gain"
1373                                 (The default behaviour is that the Digital
1374                                 volume control is limited to a maximum of
1375                                 0dB. ie. it can attenuate but not provide
1376                                 gain. For most users, this will be desired
1377                                 as it will prevent clipping. By appending
1378                                 the 24dB_digital_gain parameter, the Digital
1379                                 volume control will allow up to 24dB of
1380                                 gain. If this parameter is enabled, it is the
1381                                 responsibility of the user to ensure that
1382                                 the Digital volume control is set to a value
1383                                 that does not result in clipping/distortion!)
1384         slave                   Force DAC+ Pro into slave mode, using Pi as
1385                                 master for bit clock and frame clock.
1386         leds_off                If set to 'true' the onboard indicator LEDs
1387                                 are switched off at all times.
1388
1389
1390 Name:   hifiberry-dacplusadcpro
1391 Info:   Configures the HifiBerry DAC+ADC PRO audio card
1392 Load:   dtoverlay=hifiberry-dacplusadcpro,<param>=<val>
1393 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
1394                                 Digital volume control. Enable with
1395                                 "dtoverlay=hifiberry-dacplusadcpro,24db_digital_gain"
1396                                 (The default behaviour is that the Digital
1397                                 volume control is limited to a maximum of
1398                                 0dB. ie. it can attenuate but not provide
1399                                 gain. For most users, this will be desired
1400                                 as it will prevent clipping. By appending
1401                                 the 24dB_digital_gain parameter, the Digital
1402                                 volume control will allow up to 24dB of
1403                                 gain. If this parameter is enabled, it is the
1404                                 responsibility of the user to ensure that
1405                                 the Digital volume control is set to a value
1406                                 that does not result in clipping/distortion!)
1407         slave                   Force DAC+ADC Pro into slave mode, using Pi as
1408                                 master for bit clock and frame clock.
1409         leds_off                If set to 'true' the onboard indicator LEDs
1410                                 are switched off at all times.
1411
1412
1413 Name:   hifiberry-dacplusdsp
1414 Info:   Configures the HifiBerry DAC+DSP audio card
1415 Load:   dtoverlay=hifiberry-dacplusdsp
1416 Params: <None>
1417
1418
1419 Name:   hifiberry-dacplushd
1420 Info:   Configures the HifiBerry DAC+ HD audio card
1421 Load:   dtoverlay=hifiberry-dacplushd
1422 Params: <None>
1423
1424
1425 Name:   hifiberry-digi
1426 Info:   Configures the HifiBerry Digi and Digi+ audio card
1427 Load:   dtoverlay=hifiberry-digi
1428 Params: <None>
1429
1430
1431 Name:   hifiberry-digi-pro
1432 Info:   Configures the HifiBerry Digi+ Pro audio card
1433 Load:   dtoverlay=hifiberry-digi-pro
1434 Params: <None>
1435
1436
1437 Name:   highperi
1438 Info:   Enables "High Peripheral" mode
1439 Load:   dtoverlay=highperi
1440 Params: <None>
1441
1442
1443 Name:   hy28a
1444 Info:   HY28A - 2.8" TFT LCD Display Module by HAOYU Electronics
1445         Default values match Texy's display shield
1446 Load:   dtoverlay=hy28a,<param>=<val>
1447 Params: speed                   Display SPI bus speed
1448
1449         rotate                  Display rotation {0,90,180,270}
1450
1451         fps                     Delay between frame updates
1452
1453         debug                   Debug output level {0-7}
1454
1455         xohms                   Touchpanel sensitivity (X-plate resistance)
1456
1457         resetgpio               GPIO used to reset controller
1458
1459         ledgpio                 GPIO used to control backlight
1460
1461
1462 Name:   hy28b
1463 Info:   HY28B - 2.8" TFT LCD Display Module by HAOYU Electronics
1464         Default values match Texy's display shield
1465 Load:   dtoverlay=hy28b,<param>=<val>
1466 Params: speed                   Display SPI bus speed
1467
1468         rotate                  Display rotation {0,90,180,270}
1469
1470         fps                     Delay between frame updates
1471
1472         debug                   Debug output level {0-7}
1473
1474         xohms                   Touchpanel sensitivity (X-plate resistance)
1475
1476         resetgpio               GPIO used to reset controller
1477
1478         ledgpio                 GPIO used to control backlight
1479
1480
1481 Name:   hy28b-2017
1482 Info:   HY28B 2017 version - 2.8" TFT LCD Display Module by HAOYU Electronics
1483         Default values match Texy's display shield
1484 Load:   dtoverlay=hy28b-2017,<param>=<val>
1485 Params: speed                   Display SPI bus speed
1486
1487         rotate                  Display rotation {0,90,180,270}
1488
1489         fps                     Delay between frame updates
1490
1491         debug                   Debug output level {0-7}
1492
1493         xohms                   Touchpanel sensitivity (X-plate resistance)
1494
1495         resetgpio               GPIO used to reset controller
1496
1497         ledgpio                 GPIO used to control backlight
1498
1499
1500 Name:   i-sabre-q2m
1501 Info:   Configures the Audiophonics I-SABRE Q2M DAC
1502 Load:   dtoverlay=i-sabre-q2m
1503 Params: <None>
1504
1505
1506 Name:   i2c-bcm2708
1507 Info:   Fall back to the i2c_bcm2708 driver for the i2c_arm bus.
1508 Load:   dtoverlay=i2c-bcm2708
1509 Params: <None>
1510
1511
1512 Name:   i2c-gpio
1513 Info:   Adds support for software i2c controller on gpio pins
1514 Load:   dtoverlay=i2c-gpio,<param>=<val>
1515 Params: i2c_gpio_sda            GPIO used for I2C data (default "23")
1516
1517         i2c_gpio_scl            GPIO used for I2C clock (default "24")
1518
1519         i2c_gpio_delay_us       Clock delay in microseconds
1520                                 (default "2" = ~100kHz)
1521
1522         bus                     Set to a unique, non-zero value if wanting
1523                                 multiple i2c-gpio busses. If set, will be used
1524                                 as the preferred bus number (/dev/i2c-<n>). If
1525                                 not set, the default value is 0, but the bus
1526                                 number will be dynamically assigned - probably
1527                                 3.
1528
1529
1530 Name:   i2c-mux
1531 Info:   Adds support for a number of I2C bus multiplexers on i2c_arm
1532 Load:   dtoverlay=i2c-mux,<param>=<val>
1533 Params: pca9542                 Select the NXP PCA9542 device
1534
1535         pca9545                 Select the NXP PCA9545 device
1536
1537         pca9548                 Select the NXP PCA9548 device
1538
1539         addr                    Change I2C address of the device (default 0x70)
1540
1541
1542 [ The i2c-mux-pca9548a overlay has been deleted. See i2c-mux. ]
1543
1544
1545 Name:   i2c-pwm-pca9685a
1546 Info:   Adds support for an NXP PCA9685A I2C PWM controller on i2c_arm
1547 Load:   dtoverlay=i2c-pwm-pca9685a,<param>=<val>
1548 Params: addr                    I2C address of PCA9685A (default 0x40)
1549
1550
1551 Name:   i2c-rtc
1552 Info:   Adds support for a number of I2C Real Time Clock devices
1553 Load:   dtoverlay=i2c-rtc,<param>=<val>
1554 Params: abx80x                  Select one of the ABx80x family:
1555                                   AB0801, AB0803, AB0804, AB0805,
1556                                   AB1801, AB1803, AB1804, AB1805
1557
1558         bq32000                 Select the TI BQ32000 device
1559
1560         ds1307                  Select the DS1307 device
1561
1562         ds1339                  Select the DS1339 device
1563
1564         ds1340                  Select the DS1340 device
1565
1566         ds3231                  Select the DS3231 device
1567
1568         m41t62                  Select the M41T62 device
1569
1570         mcp7940x                Select the MCP7940x device
1571
1572         mcp7941x                Select the MCP7941x device
1573
1574         pcf2127                 Select the PCF2127 device
1575
1576         pcf2129                 Select the PCF2129 device
1577
1578         pcf85063                Select the PCF85063 device
1579
1580         pcf85063a               Select the PCF85063A device
1581
1582         pcf8523                 Select the PCF8523 device
1583
1584         pcf85363                Select the PCF85363 device
1585
1586         pcf8563                 Select the PCF8563 device
1587
1588         rv1805                  Select the Micro Crystal RV1805 device
1589
1590         rv3028                  Select the Micro Crystal RV3028 device
1591
1592         sd3078                  Select the ZXW Shenzhen whwave SD3078 device
1593
1594         s35390a                 Select the ABLIC S35390A device
1595
1596         i2c0                    Choose the I2C0 bus on GPIOs 0&1
1597
1598         i2c_csi_dsi             Choose the I2C0 bus on GPIOs 44&45
1599
1600         addr                    Sets the address for the RTC. Note that the
1601                                 device must be configured to use the specified
1602                                 address.
1603
1604         trickle-diode-disable   Do not use the internal trickle charger diode
1605                                 (BQ32000 only)
1606
1607         trickle-diode-type      Diode type for trickle charge - "standard" or
1608                                 "schottky" (ABx80x and RV1805 only)
1609
1610         trickle-resistor-ohms   Resistor value for trickle charge (DS1339,
1611                                 ABx80x, RV1805, RV3028)
1612
1613         wakeup-source           Specify that the RTC can be used as a wakeup
1614                                 source
1615
1616         backup-switchover-mode  Backup power supply switch mode. Must be 0 for
1617                                 off or 1 for Vdd < VBackup (RV3028 only)
1618
1619
1620 Name:   i2c-rtc-gpio
1621 Info:   Adds support for a number of I2C Real Time Clock devices
1622         using the software i2c controller
1623 Load:   dtoverlay=i2c-rtc-gpio,<param>=<val>
1624 Params: abx80x                  Select one of the ABx80x family:
1625                                   AB0801, AB0803, AB0804, AB0805,
1626                                   AB1801, AB1803, AB1804, AB1805
1627
1628         bq32000                 Select the TI BQ32000 device
1629
1630         ds1307                  Select the DS1307 device
1631
1632         ds1339                  Select the DS1339 device
1633
1634         ds1340                  Select the DS1340 device
1635
1636         ds3231                  Select the DS3231 device
1637
1638         m41t62                  Select the M41T62 device
1639
1640         mcp7940x                Select the MCP7940x device
1641
1642         mcp7941x                Select the MCP7941x device
1643
1644         pcf2127                 Select the PCF2127 device
1645
1646         pcf2129                 Select the PCF2129 device
1647
1648         pcf85063                Select the PCF85063 device
1649
1650         pcf85063a               Select the PCF85063A device
1651
1652         pcf8523                 Select the PCF8523 device
1653
1654         pcf85363                Select the PCF85363 device
1655
1656         pcf8563                 Select the PCF8563 device
1657
1658         rv1805                  Select the Micro Crystal RV1805 device
1659
1660         rv3028                  Select the Micro Crystal RV3028 device
1661
1662         sd3078                  Select the ZXW Shenzhen whwave SD3078 device
1663
1664         s35390a                 Select the ABLIC S35390A device
1665
1666         addr                    Sets the address for the RTC. Note that the
1667                                 device must be configured to use the specified
1668                                 address.
1669
1670         trickle-diode-disable   Do not use the internal trickle charger diode
1671                                 (BQ32000 only)
1672
1673         trickle-diode-type      Diode type for trickle charge - "standard" or
1674                                 "schottky" (ABx80x and RV1805 only)
1675
1676         trickle-resistor-ohms   Resistor value for trickle charge (DS1339,
1677                                 ABx80x, RV1805, RV3028)
1678
1679         wakeup-source           Specify that the RTC can be used as a wakeup
1680                                 source
1681
1682         backup-switchover-mode  Backup power supply switch mode. Must be 0 for
1683                                 off or 1 for Vdd < VBackup (RV3028 only)
1684
1685         i2c_gpio_sda            GPIO used for I2C data (default "23")
1686
1687         i2c_gpio_scl            GPIO used for I2C clock (default "24")
1688
1689         i2c_gpio_delay_us       Clock delay in microseconds
1690                                 (default "2" = ~100kHz)
1691
1692
1693 Name:   i2c-sensor
1694 Info:   Adds support for a number of I2C barometric pressure, temperature,
1695         light level and chemical sensors on i2c_arm
1696 Load:   dtoverlay=i2c-sensor,<param>=<val>
1697 Params: addr                    Set the address for the BH1750, BME280, BME680,
1698                                 BMP280, CCS811, DS1621, HDC100X, LM75, SHT3x or
1699                                 TMP102
1700
1701         bh1750                  Select the Rohm BH1750 ambient light sensor
1702                                 Valid addresses 0x23 or 0x5c, default 0x23
1703
1704         bme280                  Select the Bosch Sensortronic BME280
1705                                 Valid addresses 0x76-0x77, default 0x76
1706
1707         bme680                  Select the Bosch Sensortronic BME680
1708                                 Valid addresses 0x76-0x77, default 0x76
1709
1710         bmp085                  Select the Bosch Sensortronic BMP085
1711
1712         bmp180                  Select the Bosch Sensortronic BMP180
1713
1714         bmp280                  Select the Bosch Sensortronic BMP280
1715                                 Valid addresses 0x76-0x77, default 0x76
1716
1717         ccs811                  Select the AMS CCS811 digital gas sensor
1718                                 Valid addresses 0x5a-0x5b, default 0x5b
1719
1720         ds1621                  Select the Dallas Semiconductors DS1621 temp
1721                                 sensor. Valid addresses 0x48-0x4f, default 0x48
1722
1723         hdc100x                 Select the Texas Instruments HDC100x temp sensor
1724                                 Valid addresses 0x40-0x43, default 0x40
1725
1726         htu21                   Select the HTU21 temperature and humidity sensor
1727
1728         lm75                    Select the Maxim LM75 temperature sensor
1729                                 Valid addresses 0x48-0x4f, default 0x4f
1730
1731         lm75addr                Deprecated - use addr parameter instead
1732
1733         max17040                Select the Maxim Integrated MAX17040 battery
1734                                 monitor
1735
1736         sht3x                   Select the Sensiron SHT3x temperature and
1737                                 humidity sensor. Valid addresses 0x44-0x45,
1738                                 default 0x44
1739
1740         si7020                  Select the Silicon Labs Si7013/20/21 humidity/
1741                                 temperature sensor
1742
1743         sps30                   Select the Sensirion SPS30 particulate matter
1744                                 sensor. Fixed address 0x69.
1745
1746         sgp30                   Select the Sensirion SGP30 VOC sensor.
1747                                 Fixed address 0x58.
1748
1749         tmp102                  Select the Texas Instruments TMP102 temp sensor
1750                                 Valid addresses 0x48-0x4b, default 0x48
1751
1752         tsl4531                 Select the AMS TSL4531 digital ambient light
1753                                 sensor
1754
1755         veml6070                Select the Vishay VEML6070 ultraviolet light
1756                                 sensor
1757
1758
1759 Name:   i2c0
1760 Info:   Change i2c0 pin usage. Not all pin combinations are usable on all
1761         platforms - platforms other then Compute Modules can only use this
1762         to disable transaction combining.
1763         Do NOT use in conjunction with dtparam=i2c_vc=on. From the 5.4 kernel
1764         onwards the base DT includes the use of i2c_mux_pinctrl to expose two
1765         muxings of BSC0 - GPIOs 0&1, and whichever combination is used for the
1766         camera and display connectors. This overlay disables that mux and
1767         configures /dev/i2c0 to point at whichever set of pins is requested.
1768         dtparam=i2c_vc=on will try and enable the mux, so combining the two
1769         will cause conflicts.
1770 Load:   dtoverlay=i2c0,<param>=<val>
1771 Params: pins_0_1                Use pins 0 and 1 (default)
1772         pins_28_29              Use pins 28 and 29
1773         pins_44_45              Use pins 44 and 45
1774         pins_46_47              Use pins 46 and 47
1775         combine                 Allow transactions to be combined (default
1776                                 "yes")
1777
1778
1779 Name:   i2c0-bcm2708
1780 Info:   Deprecated, legacy version of i2c0.
1781 Load:   <Deprecated>
1782
1783
1784 Name:   i2c1
1785 Info:   Change i2c1 pin usage. Not all pin combinations are usable on all
1786         platforms - platforms other then Compute Modules can only use this
1787         to disable transaction combining.
1788 Load:   dtoverlay=i2c1,<param>=<val>
1789 Params: pins_2_3                Use pins 2 and 3 (default)
1790         pins_44_45              Use pins 44 and 45
1791         combine                 Allow transactions to be combined (default
1792                                 "yes")
1793
1794
1795 Name:   i2c1-bcm2708
1796 Info:   Deprecated, legacy version of i2c1.
1797 Load:   <Deprecated>
1798
1799
1800 Name:   i2c3
1801 Info:   Enable the i2c3 bus. BCM2711 only.
1802 Load:   dtoverlay=i2c3,<param>
1803 Params: pins_2_3                Use GPIOs 2 and 3
1804         pins_4_5                Use GPIOs 4 and 5 (default)
1805         baudrate                Set the baudrate for the interface (default
1806                                 "100000")
1807
1808
1809 Name:   i2c4
1810 Info:   Enable the i2c4 bus. BCM2711 only.
1811 Load:   dtoverlay=i2c4,<param>
1812 Params: pins_6_7                Use GPIOs 6 and 7
1813         pins_8_9                Use GPIOs 8 and 9 (default)
1814         baudrate                Set the baudrate for the interface (default
1815                                 "100000")
1816
1817
1818 Name:   i2c5
1819 Info:   Enable the i2c5 bus. BCM2711 only.
1820 Load:   dtoverlay=i2c5,<param>
1821 Params: pins_10_11              Use GPIOs 10 and 11
1822         pins_12_13              Use GPIOs 12 and 13 (default)
1823         baudrate                Set the baudrate for the interface (default
1824                                 "100000")
1825
1826
1827 Name:   i2c6
1828 Info:   Enable the i2c6 bus. BCM2711 only.
1829 Load:   dtoverlay=i2c6,<param>
1830 Params: pins_0_1                Use GPIOs 0 and 1
1831         pins_22_23              Use GPIOs 22 and 23 (default)
1832         baudrate                Set the baudrate for the interface (default
1833                                 "100000")
1834
1835
1836 Name:   i2s-gpio28-31
1837 Info:   move I2S function block to GPIO 28 to 31
1838 Load:   dtoverlay=i2s-gpio28-31
1839 Params: <None>
1840
1841
1842 Name:   ilitek251x
1843 Info:   Enables I2C connected Ilitek 251x multiple touch controller using
1844         GPIO 4 (pin 7 on GPIO header) for interrupt.
1845 Load:   dtoverlay=ilitek251x,<param>=<val>
1846 Params: interrupt               GPIO used for interrupt (default 4)
1847         sizex                   Touchscreen size x, horizontal resolution of
1848                                 touchscreen (in pixels)
1849         sizey                   Touchscreen size y, vertical resolution of
1850                                 touchscreen (in pixels)
1851
1852
1853 Name:   imx219
1854 Info:   Sony IMX219 camera module.
1855         Uses Unicam 1, which is the standard camera connector on most Pi
1856         variants.
1857 Load:   dtoverlay=imx219,<param>=<val>
1858 Params: rotation                Mounting rotation of the camera sensor (0 or
1859                                 180, default 180)
1860         orientation             Sensor orientation (0 = front, 1 = rear,
1861                                 2 = external, default external)
1862         media-controller        Configure use of Media Controller API for
1863                                 configuring the sensor (default on)
1864         cam0                    Adopt the default configuration for CAM0 on a
1865                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
1866
1867
1868 Name:   imx290
1869 Info:   Sony IMX290 camera module.
1870         Uses Unicam 1, which is the standard camera connector on most Pi
1871         variants. NB This currently uses 4 CSI2 data lanes and therefore will
1872         only work on a CM.
1873 Load:   dtoverlay=imx290,<param>
1874 Params: 4lane                   Enable 4 CSI2 lanes. This requires a Compute
1875                                 Module (1, 3, or 4).
1876         clock-frequency         Sets the clock frequency to match that used on
1877                                 the board.
1878                                 Modules from Vision Components use 37.125MHz
1879                                 (the default), whilst those from Innomaker use
1880                                 74.25MHz.
1881         mono                    Denote that the module is a mono sensor.
1882         orientation             Sensor orientation (0 = front, 1 = rear,
1883                                 2 = external, default external)
1884         rotation                Mounting rotation of the camera sensor (0 or
1885                                 180, default 0)
1886         media-controller        Configure use of Media Controller API for
1887                                 configuring the sensor (default on)
1888         cam0                    Adopt the default configuration for CAM0 on a
1889                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
1890
1891
1892 Name:   imx378
1893 Info:   Sony IMX378 camera module.
1894         Uses Unicam 1, which is the standard camera connector on most Pi
1895         variants.
1896 Load:   dtoverlay=imx378,<param>=<val>
1897 Params: rotation                Mounting rotation of the camera sensor (0 or
1898                                 180, default 180)
1899         orientation             Sensor orientation (0 = front, 1 = rear,
1900                                 2 = external, default external)
1901         media-controller        Configure use of Media Controller API for
1902                                 configuring the sensor (default on)
1903         cam0                    Adopt the default configuration for CAM0 on a
1904                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
1905
1906
1907 Name:   imx477
1908 Info:   Sony IMX477 camera module.
1909         Uses Unicam 1, which is the standard camera connector on most Pi
1910         variants.
1911 Load:   dtoverlay=imx477,<param>=<val>
1912 Params: rotation                Mounting rotation of the camera sensor (0 or
1913                                 180, default 180)
1914         orientation             Sensor orientation (0 = front, 1 = rear,
1915                                 2 = external, default external)
1916         media-controller        Configure use of Media Controller API for
1917                                 configuring the sensor (default on)
1918         cam0                    Adopt the default configuration for CAM0 on a
1919                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
1920
1921
1922 Name:   imx519
1923 Info:   Sony IMX519 camera module.
1924         Uses Unicam 1, which is the standard camera connector on most Pi
1925         variants.
1926 Load:   dtoverlay=imx519,<param>=<val>
1927 Params: rotation                Mounting rotation of the camera sensor (0 or
1928                                 180, default 0)
1929         orientation             Sensor orientation (0 = front, 1 = rear,
1930                                 2 = external, default external)
1931         media-controller        Configure use of Media Controller API for
1932                                 configuring the sensor (default on)
1933         cam0                    Adopt the default configuration for CAM0 on a
1934                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
1935
1936
1937 Name:   iqaudio-codec
1938 Info:   Configures the IQaudio Codec audio card
1939 Load:   dtoverlay=iqaudio-codec
1940 Params: <None>
1941
1942
1943 Name:   iqaudio-dac
1944 Info:   Configures the IQaudio DAC audio card
1945 Load:   dtoverlay=iqaudio-dac,<param>
1946 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
1947                                 Digital volume control. Enable with
1948                                 "dtoverlay=iqaudio-dac,24db_digital_gain"
1949                                 (The default behaviour is that the Digital
1950                                 volume control is limited to a maximum of
1951                                 0dB. ie. it can attenuate but not provide
1952                                 gain. For most users, this will be desired
1953                                 as it will prevent clipping. By appending
1954                                 the 24db_digital_gain parameter, the Digital
1955                                 volume control will allow up to 24dB of
1956                                 gain. If this parameter is enabled, it is the
1957                                 responsibility of the user to ensure that
1958                                 the Digital volume control is set to a value
1959                                 that does not result in clipping/distortion!)
1960
1961
1962 Name:   iqaudio-dacplus
1963 Info:   Configures the IQaudio DAC+ audio card
1964 Load:   dtoverlay=iqaudio-dacplus,<param>=<val>
1965 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
1966                                 Digital volume control. Enable with
1967                                 "dtoverlay=iqaudio-dacplus,24db_digital_gain"
1968                                 (The default behaviour is that the Digital
1969                                 volume control is limited to a maximum of
1970                                 0dB. ie. it can attenuate but not provide
1971                                 gain. For most users, this will be desired
1972                                 as it will prevent clipping. By appending
1973                                 the 24db_digital_gain parameter, the Digital
1974                                 volume control will allow up to 24dB of
1975                                 gain. If this parameter is enabled, it is the
1976                                 responsibility of the user to ensure that
1977                                 the Digital volume control is set to a value
1978                                 that does not result in clipping/distortion!)
1979         auto_mute_amp           If specified, unmute/mute the IQaudIO amp when
1980                                 starting/stopping audio playback.
1981         unmute_amp              If specified, unmute the IQaudIO amp once when
1982                                 the DAC driver module loads.
1983
1984
1985 Name:   iqaudio-digi-wm8804-audio
1986 Info:   Configures the IQAudIO Digi WM8804 audio card
1987 Load:   dtoverlay=iqaudio-digi-wm8804-audio,<param>=<val>
1988 Params: card_name               Override the default, "IQAudIODigi", card name.
1989         dai_name                Override the default, "IQAudIO Digi", dai name.
1990         dai_stream_name         Override the default, "IQAudIO Digi HiFi",
1991                                 dai stream name.
1992
1993
1994 Name:   iqs550
1995 Info:   Enables I2C connected Azoteq IQS550 trackpad/touchscreen controller
1996         using GPIO 4 (pin 7 on GPIO header) for interrupt.
1997 Load:   dtoverlay=iqs550,<param>=<val>
1998 Params: interrupt               GPIO used for interrupt (default 4)
1999         reset                   GPIO used for reset (optional)
2000         sizex                   Touchscreen size x (default 800)
2001         sizey                   Touchscreen size y (default 480)
2002         invx                    Touchscreen inverted x axis
2003         invy                    Touchscreen inverted y axis
2004         swapxy                  Touchscreen swapped x y axis
2005
2006
2007 Name:   irs1125
2008 Info:   Infineon irs1125 TOF camera module.
2009         Uses Unicam 1, which is the standard camera connector on most Pi
2010         variants.
2011 Load:   dtoverlay=irs1125,<param>=<val>
2012 Params: media-controller        Configure use of Media Controller API for
2013                                 configuring the sensor (default off)
2014         cam0                    Adopt the default configuration for CAM0 on a
2015                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
2016
2017
2018 Name:   jedec-spi-nor
2019 Info:   Adds support for JEDEC-compliant SPI NOR flash devices.  (Note: The
2020         "jedec,spi-nor" kernel driver was formerly known as "m25p80".)
2021 Load:   dtoverlay=jedec-spi-nor,<param>=<val>
2022 Params: flash-spi<n>-<m>        Enables flash device on SPI<n>, CS#<m>.
2023         flash-fastr-spi<n>-<m>  Enables flash device with fast read capability
2024                                 on SPI<n>, CS#<m>.
2025
2026
2027 Name:   justboom-both
2028 Info:   Simultaneous usage of an justboom-dac and justboom-digi based
2029         card
2030 Load:   dtoverlay=justboom-both,<param>=<val>
2031 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
2032                                 Digital volume control. Enable with
2033                                 "dtoverlay=justboom-dac,24db_digital_gain"
2034                                 (The default behaviour is that the Digital
2035                                 volume control is limited to a maximum of
2036                                 0dB. ie. it can attenuate but not provide
2037                                 gain. For most users, this will be desired
2038                                 as it will prevent clipping. By appending
2039                                 the 24dB_digital_gain parameter, the Digital
2040                                 volume control will allow up to 24dB of
2041                                 gain. If this parameter is enabled, it is the
2042                                 responsibility of the user to ensure that
2043                                 the Digital volume control is set to a value
2044                                 that does not result in clipping/distortion!)
2045
2046
2047 Name:   justboom-dac
2048 Info:   Configures the JustBoom DAC HAT, Amp HAT, DAC Zero and Amp Zero audio
2049         cards
2050 Load:   dtoverlay=justboom-dac,<param>=<val>
2051 Params: 24db_digital_gain       Allow gain to be applied via the PCM512x codec
2052                                 Digital volume control. Enable with
2053                                 "dtoverlay=justboom-dac,24db_digital_gain"
2054                                 (The default behaviour is that the Digital
2055                                 volume control is limited to a maximum of
2056                                 0dB. ie. it can attenuate but not provide
2057                                 gain. For most users, this will be desired
2058                                 as it will prevent clipping. By appending
2059                                 the 24dB_digital_gain parameter, the Digital
2060                                 volume control will allow up to 24dB of
2061                                 gain. If this parameter is enabled, it is the
2062                                 responsibility of the user to ensure that
2063                                 the Digital volume control is set to a value
2064                                 that does not result in clipping/distortion!)
2065
2066
2067 Name:   justboom-digi
2068 Info:   Configures the JustBoom Digi HAT and Digi Zero audio cards
2069 Load:   dtoverlay=justboom-digi
2070 Params: <None>
2071
2072
2073 Name:   lirc-rpi
2074 Info:   This overlay has been deprecated and removed - see gpio-ir
2075 Load:   <Deprecated>
2076
2077
2078 Name:   ltc294x
2079 Info:   Adds support for the ltc294x family of battery gauges
2080 Load:   dtoverlay=ltc294x,<param>=<val>
2081 Params: ltc2941                 Select the ltc2941 device
2082
2083         ltc2942                 Select the ltc2942 device
2084
2085         ltc2943                 Select the ltc2943 device
2086
2087         ltc2944                 Select the ltc2944 device
2088
2089         resistor-sense          The sense resistor value in milli-ohms.
2090                                 Can be a 32-bit negative value when the battery
2091                                 has been connected to the wrong end of the
2092                                 resistor.
2093
2094         prescaler-exponent      Range and accuracy of the gauge. The value is
2095                                 programmed into the chip only if it differs
2096                                 from the current setting.
2097                                 For LTC2941 only:
2098                                 - Default value is 128
2099                                 - the exponent is in the range 0-7 (default 7)
2100                                 See the datasheet for more information.
2101
2102
2103 Name:   max98357a
2104 Info:   Configures the Maxim MAX98357A I2S DAC
2105 Load:   dtoverlay=max98357a,<param>=<val>
2106 Params: no-sdmode               Driver does not manage the state of the DAC's
2107                                 SD_MODE pin (i.e. chip is always on).
2108         sdmode-pin              integer, GPIO pin connected to the SD_MODE input
2109                                 of the DAC (default GPIO4 if parameter omitted).
2110
2111
2112 Name:   maxtherm
2113 Info:   Configure a MAX6675, MAX31855 or MAX31856 thermocouple as an IIO device.
2114
2115         For devices on spi1 or spi2, the interfaces should be enabled
2116         with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2117         The overlay expects to disable the relevant spidev node, so also using
2118         e.g. cs0_spidev=off is unnecessary.
2119
2120         Example:
2121         MAX31855 on /dev/spidev0.0
2122             dtoverlay=maxtherm,spi0-0,max31855
2123         MAX31856 using a type J thermocouple on /dev/spidev2.1
2124             dtoverlay=spi2-2cs
2125             dtoverlay=maxtherm,spi2-1,max31856,type_j
2126
2127 Load:   dtoverlay=maxtherm,<param>=<val>
2128 Params: spi<n>-<m>              Configure device at spi<n>, cs<m>
2129                                 (boolean, required)
2130         max6675                 Enable support for the MAX6675 (default)
2131         max31855                Enable support for the MAX31855
2132         max31855e               Enable support for the MAX31855E
2133         max31855j               Enable support for the MAX31855J
2134         max31855k               Enable support for the MAX31855K
2135         max31855n               Enable support for the MAX31855N
2136         max31855r               Enable support for the MAX31855R
2137         max31855s               Enable support for the MAX31855S
2138         max31855t               Enable support for the MAX31855T
2139         max31856                Enable support for the MAX31856 (with type K)
2140         type_b                  Select a type B sensor for max31856
2141         type_e                  Select a type E sensor for max31856
2142         type_j                  Select a type J sensor for max31856
2143         type_k                  Select a type K sensor for max31856
2144         type_n                  Select a type N sensor for max31856
2145         type_r                  Select a type R sensor for max31856
2146         type_s                  Select a type S sensor for max31856
2147         type_t                  Select a type T sensor for max31856
2148
2149
2150 Name:   mbed-dac
2151 Info:   Configures the mbed AudioCODEC (TLV320AIC23B)
2152 Load:   dtoverlay=mbed-dac
2153 Params: <None>
2154
2155
2156 Name:   mcp23017
2157 Info:   Configures the MCP23017 I2C GPIO expander
2158 Load:   dtoverlay=mcp23017,<param>=<val>
2159 Params: gpiopin                 Gpio pin connected to the INTA output of the
2160                                 MCP23017 (default: 4)
2161
2162         addr                    I2C address of the MCP23017 (default: 0x20)
2163
2164         mcp23008                Configure an MCP23008 instead.
2165         noints                  Disable the interrupt GPIO line.
2166
2167
2168 Name:   mcp23s17
2169 Info:   Configures the MCP23S08/17 SPI GPIO expanders.
2170         If devices are present on SPI1 or SPI2, those interfaces must be enabled
2171         with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2172         If interrupts are enabled for a device on a given CS# on a SPI bus, that
2173         device must be the only one present on that SPI bus/CS#.
2174 Load:   dtoverlay=mcp23s17,<param>=<val>
2175 Params: s08-spi<n>-<m>-present  4-bit integer, bitmap indicating MCP23S08
2176                                 devices present on SPI<n>, CS#<m>
2177
2178         s17-spi<n>-<m>-present  8-bit integer, bitmap indicating MCP23S17
2179                                 devices present on SPI<n>, CS#<m>
2180
2181         s08-spi<n>-<m>-int-gpio integer, enables interrupts on a single
2182                                 MCP23S08 device on SPI<n>, CS#<m>, specifies
2183                                 the GPIO pin to which INT output of MCP23S08
2184                                 is connected.
2185
2186         s17-spi<n>-<m>-int-gpio integer, enables mirrored interrupts on a
2187                                 single MCP23S17 device on SPI<n>, CS#<m>,
2188                                 specifies the GPIO pin to which either INTA
2189                                 or INTB output of MCP23S17 is connected.
2190
2191
2192 Name:   mcp2515
2193 Info:   Configures the MCP2515 CAN controller on spi0/1/2
2194         For devices on spi1 or spi2, the interfaces should be enabled
2195         with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2196 Load:   dtoverlay=mcp2515,<param>=<val>
2197 Params: spi<n>-<m>              Configure device at spi<n>, cs<m>
2198                                 (boolean, required)
2199
2200         oscillator              Clock frequency for the CAN controller (Hz)
2201
2202         speed                   Maximum SPI frequence (Hz)
2203
2204         interrupt               GPIO for interrupt signal
2205
2206
2207 Name:   mcp2515-can0
2208 Info:   Configures the MCP2515 CAN controller on spi0.0
2209 Load:   dtoverlay=mcp2515-can0,<param>=<val>
2210 Params: oscillator              Clock frequency for the CAN controller (Hz)
2211
2212         spimaxfrequency         Maximum SPI frequence (Hz)
2213
2214         interrupt               GPIO for interrupt signal
2215
2216
2217 Name:   mcp2515-can1
2218 Info:   Configures the MCP2515 CAN controller on spi0.1
2219 Load:   dtoverlay=mcp2515-can1,<param>=<val>
2220 Params: oscillator              Clock frequency for the CAN controller (Hz)
2221
2222         spimaxfrequency         Maximum SPI frequence (Hz)
2223
2224         interrupt               GPIO for interrupt signal
2225
2226
2227 Name:   mcp251xfd
2228 Info:   Configures the MCP251XFD CAN controller family
2229         For devices on spi1 or spi2, the interfaces should be enabled
2230         with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2231 Load:   dtoverlay=mcp251xfd,<param>=<val>
2232 Params: spi<n>-<m>              Configure device at spi<n>, cs<m>
2233                                 (boolean, required)
2234
2235         oscillator              Clock frequency for the CAN controller (Hz)
2236
2237         speed                   Maximum SPI frequence (Hz)
2238
2239         interrupt               GPIO for interrupt signal
2240
2241         rx_interrupt            GPIO for RX interrupt signal (nINT1) (optional)
2242
2243         xceiver_enable          GPIO for CAN transceiver enable (optional)
2244
2245         xceiver_active_high     specifiy if CAN transceiver enable pin is
2246                                 active high (optional, default: active low)
2247
2248
2249 Name:   mcp3008
2250 Info:   Configures MCP3008 A/D converters
2251         For devices on spi1 or spi2, the interfaces should be enabled
2252         with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2253 Load:   dtoverlay=mcp3008,<param>[=<val>]
2254 Params: spi<n>-<m>-present      boolean, configure device at spi<n>, cs<m>
2255         spi<n>-<m>-speed        integer, set the spi bus speed for this device
2256
2257
2258 Name:   mcp3202
2259 Info:   Configures MCP3202 A/D converters
2260         For devices on spi1 or spi2, the interfaces should be enabled
2261         with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays.
2262 Load:   dtoverlay=mcp3202,<param>[=<val>]
2263 Params: spi<n>-<m>-present      boolean, configure device at spi<n>, cs<m>
2264         spi<n>-<m>-speed        integer, set the spi bus speed for this device
2265
2266
2267 Name:   mcp342x
2268 Info:   Overlay for activation of Microchip MCP3421-3428 ADCs over I2C
2269 Load:   dtoverlay=mcp342x,<param>=<val>
2270 Params: addr                    I2C bus address of device, for devices with
2271                                 addresses that are configurable, e.g. by
2272                                 hardware links (default=0x68)
2273         mcp3421                 The device is an MCP3421
2274         mcp3422                 The device is an MCP3422
2275         mcp3423                 The device is an MCP3423
2276         mcp3424                 The device is an MCP3424
2277         mcp3425                 The device is an MCP3425
2278         mcp3426                 The device is an MCP3426
2279         mcp3427                 The device is an MCP3427
2280         mcp3428                 The device is an MCP3428
2281
2282
2283 Name:   media-center
2284 Info:   Media Center HAT - 2.83" Touch Display + extras by Pi Supply
2285 Load:   dtoverlay=media-center,<param>=<val>
2286 Params: speed                   Display SPI bus speed
2287         rotate                  Display rotation {0,90,180,270}
2288         fps                     Delay between frame updates
2289         xohms                   Touchpanel sensitivity (X-plate resistance)
2290         swapxy                  Swap x and y axis
2291         backlight               Change backlight GPIO pin {e.g. 12, 18}
2292         gpio_out_pin            GPIO for output (default "17")
2293         gpio_in_pin             GPIO for input (default "18")
2294         gpio_in_pull            Pull up/down/off on the input pin
2295                                 (default "down")
2296         sense                   Override the IR receive auto-detection logic:
2297                                  "0" = force active-high
2298                                  "1" = force active-low
2299                                  "-1" = use auto-detection
2300                                 (default "-1")
2301         softcarrier             Turn the software carrier "on" or "off"
2302                                 (default "on")
2303         invert                  "on" = invert the output pin (default "off")
2304         debug                   "on" = enable additional debug messages
2305                                 (default "off")
2306
2307
2308 Name:   merus-amp
2309 Info:   Configures the merus-amp audio card
2310 Load:   dtoverlay=merus-amp
2311 Params: <None>
2312
2313
2314 Name:   midi-uart0
2315 Info:   Configures UART0 (ttyAMA0) so that a requested 38.4kbaud actually gets
2316         31.25kbaud, the frequency required for MIDI
2317 Load:   dtoverlay=midi-uart0
2318 Params: <None>
2319
2320
2321 Name:   midi-uart1
2322 Info:   Configures UART1 (ttyS0) so that a requested 38.4kbaud actually gets
2323         31.25kbaud, the frequency required for MIDI
2324 Load:   dtoverlay=midi-uart1
2325 Params: <None>
2326
2327
2328 Name:   midi-uart2
2329 Info:   Configures UART2 (ttyAMA1) so that a requested 38.4kbaud actually gets
2330         31.25kbaud, the frequency required for MIDI
2331 Load:   dtoverlay=midi-uart2
2332 Params: <None>
2333
2334
2335 Name:   midi-uart3
2336 Info:   Configures UART3 (ttyAMA2) so that a requested 38.4kbaud actually gets
2337         31.25kbaud, the frequency required for MIDI
2338 Load:   dtoverlay=midi-uart3
2339 Params: <None>
2340
2341
2342 Name:   midi-uart4
2343 Info:   Configures UART4 (ttyAMA3) so that a requested 38.4kbaud actually gets
2344         31.25kbaud, the frequency required for MIDI
2345 Load:   dtoverlay=midi-uart4
2346 Params: <None>
2347
2348
2349 Name:   midi-uart5
2350 Info:   Configures UART5 (ttyAMA4) so that a requested 38.4kbaud actually gets
2351         31.25kbaud, the frequency required for MIDI
2352 Load:   dtoverlay=midi-uart5
2353 Params: <None>
2354
2355
2356 Name:   minipitft13
2357 Info:   Overlay for AdaFruit Mini Pi 1.3" TFT via SPI using fbtft driver.
2358 Load:   dtoverlay=minipitft13,<param>=<val>
2359 Params: speed                   SPI bus speed (default 32000000)
2360         rotate                  Display rotation (0, 90, 180 or 270; default 0)
2361         width                   Display width (default 240)
2362         height                  Display height (default 240)
2363         fps                     Delay between frame updates (default 25)
2364         debug                   Debug output level (0-7; default 0)
2365
2366
2367 Name:   miniuart-bt
2368 Info:   Switch the onboard Bluetooth function on Pi 3B, 3B+, 3A+, 4B and Zero W
2369         to use the mini-UART (ttyS0) and restore UART0/ttyAMA0 over GPIOs 14 &
2370         15. Note that this may reduce the maximum usable baudrate.
2371         N.B. It is also necessary to edit /lib/systemd/system/hciuart.service
2372         and replace ttyAMA0 with ttyS0, unless using Raspbian or another
2373         distribution with udev rules that create /dev/serial0 and /dev/serial1,
2374         in which case use /dev/serial1 instead because it will always be
2375         correct. Furthermore, you must also set core_freq and core_freq_min to
2376         the same value in config.txt or the miniuart will not work.
2377 Load:   dtoverlay=miniuart-bt,<param>=<val>
2378 Params: krnbt                   Set to "on" to enable autoprobing of Bluetooth
2379                                 driver without need of hciattach/btattach
2380
2381
2382 Name:   mlx90640
2383 Info:   Overlay for i2c connected mlx90640 thermal camera
2384 Load:   dtoverlay=mlx90640
2385 Params: <None>
2386
2387
2388 Name:   mmc
2389 Info:   Selects the bcm2835-mmc SD/MMC driver, optionally with overclock
2390 Load:   dtoverlay=mmc,<param>=<val>
2391 Params: overclock_50            Clock (in MHz) to use when the MMC framework
2392                                 requests 50MHz
2393
2394
2395 Name:   mpu6050
2396 Info:   Overlay for i2c connected mpu6050 imu
2397 Load:   dtoverlay=mpu6050,<param>=<val>
2398 Params: interrupt               GPIO pin for interrupt (default 4)
2399         addr                    I2C address of the device (default 0x68)
2400
2401
2402 Name:   mz61581
2403 Info:   MZ61581 display by Tontec
2404 Load:   dtoverlay=mz61581,<param>=<val>
2405 Params: speed                   Display SPI bus speed
2406
2407         rotate                  Display rotation {0,90,180,270}
2408
2409         fps                     Delay between frame updates
2410
2411         txbuflen                Transmit buffer length (default 32768)
2412
2413         debug                   Debug output level {0-7}
2414
2415         xohms                   Touchpanel sensitivity (X-plate resistance)
2416
2417
2418 Name:   ov5647
2419 Info:   Omnivision OV5647 camera module.
2420         Uses Unicam 1, which is the standard camera connector on most Pi
2421         variants.
2422 Load:   dtoverlay=ov5647,<param>=<val>
2423 Params: rotation                Mounting rotation of the camera sensor (0 or
2424                                 180, default 0)
2425         orientation             Sensor orientation (0 = front, 1 = rear,
2426                                 2 = external, default external)
2427         media-controller        Configure use of Media Controller API for
2428                                 configuring the sensor (default on)
2429         cam0                    Adopt the default configuration for CAM0 on a
2430                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
2431
2432
2433 Name:   ov7251
2434 Info:   Omnivision OV7251 camera module.
2435         Uses Unicam 1, which is the standard camera connector on most Pi
2436         variants.
2437 Load:   dtoverlay=ov7251,<param>=<val>
2438 Params: rotation                Mounting rotation of the camera sensor (0 or
2439                                 180, default 0)
2440         orientation             Sensor orientation (0 = front, 1 = rear,
2441                                 2 = external, default external)
2442         media-controller        Configure use of Media Controller API for
2443                                 configuring the sensor (default off)
2444         cam0                    Adopt the default configuration for CAM0 on a
2445                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
2446
2447
2448 Name:   ov9281
2449 Info:   Omnivision OV9281 camera module.
2450         Uses Unicam 1, which is the standard camera connector on most Pi
2451         variants.
2452 Load:   dtoverlay=ov9281,<param>=<val>
2453 Params: rotation                Mounting rotation of the camera sensor (0 or
2454                                 180, default 0)
2455         orientation             Sensor orientation (0 = front, 1 = rear,
2456                                 2 = external, default external)
2457         media-controller        Configure use of Media Controller API for
2458                                 configuring the sensor (default on)
2459         cam0                    Adopt the default configuration for CAM0 on a
2460                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
2461
2462
2463 Name:   papirus
2464 Info:   PaPiRus ePaper Screen by Pi Supply (both HAT and pHAT)
2465 Load:   dtoverlay=papirus,<param>=<val>
2466 Params: panel                   Display panel (required):
2467                                 1.44": e1144cs021
2468                                 2.0":  e2200cs021
2469                                 2.7":  e2271cs021
2470
2471         speed                   Display SPI bus speed
2472
2473
2474 Name:   pca953x
2475 Info:   TI PCA953x family of I2C GPIO expanders. Default is for NXP PCA9534.
2476 Load:   dtoverlay=pca953x,<param>=<val>
2477 Params: addr                    I2C address of expander. Default 0x20.
2478         pca6416                 Select the NXP PCA6416 (16 bit)
2479         pca9505                 Select the NXP PCA9505 (40 bit)
2480         pca9535                 Select the NXP PCA9535 (16 bit)
2481         pca9536                 Select the NXP PCA9536 or TI PCA9536 (4 bit)
2482         pca9537                 Select the NXP PCA9537 (4 bit)
2483         pca9538                 Select the NXP PCA9538 (8 bit)
2484         pca9539                 Select the NXP PCA9539 (16 bit)
2485         pca9554                 Select the NXP PCA9554 (8 bit)
2486         pca9555                 Select the NXP PCA9555 (16 bit)
2487         pca9556                 Select the NXP PCA9556 (8 bit)
2488         pca9557                 Select the NXP PCA9557 (8 bit)
2489         pca9574                 Select the NXP PCA9574 (8 bit)
2490         pca9575                 Select the NXP PCA9575 (16 bit)
2491         pca9698                 Select the NXP PCA9698 (40 bit)
2492         pca16416                Select the NXP PCA16416 (16 bit)
2493         pca16524                Select the NXP PCA16524 (24 bit)
2494         pca19555a               Select the NXP PCA19555A (16 bit)
2495         max7310                 Select the Maxim MAX7310 (8 bit)
2496         max7312                 Select the Maxim MAX7312 (16 bit)
2497         max7313                 Select the Maxim MAX7313 (16 bit)
2498         max7315                 Select the Maxim MAX7315 (8 bit)
2499         pca6107                 Select the TI PCA6107 (8 bit)
2500         tca6408                 Select the TI TCA6408 (8 bit)
2501         tca6416                 Select the TI TCA6416 (16 bit)
2502         tca6424                 Select the TI TCA6424 (24 bit)
2503         tca9539                 Select the TI TCA9539 (16 bit)
2504         tca9554                 Select the TI TCA9554 (8 bit)
2505         cat9554                 Select the Onnn CAT9554 (8 bit)
2506         pca9654                 Select the Onnn PCA9654 (8 bit)
2507         xra1202                 Select the Exar XRA1202 (8 bit)
2508
2509
2510 Name:   pcie-32bit-dma
2511 Info:   Force PCIe config to support 32bit DMA addresses at the expense of
2512         having to bounce buffers.
2513 Load:   dtoverlay=pcie-32bit-dma
2514 Params: <None>
2515
2516
2517 [ The pcf2127-rtc overlay has been deleted. See i2c-rtc. ]
2518
2519
2520 [ The pcf8523-rtc overlay has been deleted. See i2c-rtc. ]
2521
2522
2523 [ The pcf8563-rtc overlay has been deleted. See i2c-rtc. ]
2524
2525
2526 Name:   pi3-act-led
2527 Info:   This overlay has been renamed act-led, keeping pi3-act-led as an alias
2528         for backwards compatibility.
2529 Load:   <Deprecated>
2530
2531
2532 Name:   pi3-disable-bt
2533 Info:   This overlay has been renamed disable-bt, keeping pi3-disable-bt as an
2534         alias for backwards compatibility.
2535 Load:   <Deprecated>
2536
2537
2538 Name:   pi3-disable-wifi
2539 Info:   This overlay has been renamed disable-wifi, keeping pi3-disable-wifi as
2540         an alias for backwards compatibility.
2541 Load:   <Deprecated>
2542
2543
2544 Name:   pi3-miniuart-bt
2545 Info:   This overlay has been renamed miniuart-bt, keeping pi3-miniuart-bt as
2546         an alias for backwards compatibility.
2547 Load:   <Deprecated>
2548
2549
2550 Name:   pibell
2551 Info:   Configures the pibell audio card.
2552 Load:   dtoverlay=pibell,<param>=<val>
2553 Params: alsaname                Set the name as it appears in ALSA (default
2554                                 "PiBell")
2555
2556
2557 Name:   pifacedigital
2558 Info:   Configures the PiFace Digital mcp23s17 GPIO port expander.
2559 Load:   dtoverlay=pifacedigital,<param>=<val>
2560 Params: spi-present-mask        8-bit integer, bitmap indicating MCP23S17 SPI0
2561                                 CS0 address. PiFace Digital supports addresses
2562                                 0-3, which can be configured with JP1 and JP2.
2563
2564
2565 Name:   pifi-40
2566 Info:   Configures the PiFi 40W stereo amplifier
2567 Load:   dtoverlay=pifi-40
2568 Params: <None>
2569
2570
2571 Name:   pifi-dac-hd
2572 Info:   Configures the PiFi DAC HD
2573 Load:   dtoverlay=pifi-dac-hd
2574 Params: <None>
2575
2576
2577 Name:   pifi-dac-zero
2578 Info:   Configures the PiFi DAC Zero
2579 Load:   dtoverlay=pifi-dac-zero
2580 Params: <None>
2581
2582
2583 Name:   pifi-mini-210
2584 Info:   Configures the PiFi Mini stereo amplifier
2585 Load:   dtoverlay=pifi-mini-210
2586 Params: <None>
2587
2588
2589 Name:   piglow
2590 Info:   Configures the PiGlow by pimoroni.com
2591 Load:   dtoverlay=piglow
2592 Params: <None>
2593
2594
2595 Name:   piscreen
2596 Info:   PiScreen display by OzzMaker.com
2597 Load:   dtoverlay=piscreen,<param>=<val>
2598 Params: speed                   Display SPI bus speed
2599
2600         rotate                  Display rotation {0,90,180,270}
2601
2602         fps                     Delay between frame updates
2603
2604         debug                   Debug output level {0-7}
2605
2606         xohms                   Touchpanel sensitivity (X-plate resistance)
2607
2608
2609 Name:   piscreen2r
2610 Info:   PiScreen 2 with resistive TP display by OzzMaker.com
2611 Load:   dtoverlay=piscreen2r,<param>=<val>
2612 Params: speed                   Display SPI bus speed
2613
2614         rotate                  Display rotation {0,90,180,270}
2615
2616         fps                     Delay between frame updates
2617
2618         debug                   Debug output level {0-7}
2619
2620         xohms                   Touchpanel sensitivity (X-plate resistance)
2621
2622
2623 Name:   pisound
2624 Info:   Configures the Blokas Labs pisound card
2625 Load:   dtoverlay=pisound
2626 Params: <None>
2627
2628
2629 Name:   pitft22
2630 Info:   Adafruit PiTFT 2.2" screen
2631 Load:   dtoverlay=pitft22,<param>=<val>
2632 Params: speed                   Display SPI bus speed
2633
2634         rotate                  Display rotation {0,90,180,270}
2635
2636         fps                     Delay between frame updates
2637
2638         debug                   Debug output level {0-7}
2639
2640
2641 Name:   pitft28-capacitive
2642 Info:   Adafruit PiTFT 2.8" capacitive touch screen
2643 Load:   dtoverlay=pitft28-capacitive,<param>=<val>
2644 Params: speed                   Display SPI bus speed
2645
2646         rotate                  Display rotation {0,90,180,270}
2647
2648         fps                     Delay between frame updates
2649
2650         debug                   Debug output level {0-7}
2651
2652         touch-sizex             Touchscreen size x (default 240)
2653
2654         touch-sizey             Touchscreen size y (default 320)
2655
2656         touch-invx              Touchscreen inverted x axis
2657
2658         touch-invy              Touchscreen inverted y axis
2659
2660         touch-swapxy            Touchscreen swapped x y axis
2661
2662
2663 Name:   pitft28-resistive
2664 Info:   Adafruit PiTFT 2.8" resistive touch screen
2665 Load:   dtoverlay=pitft28-resistive,<param>=<val>
2666 Params: speed                   Display SPI bus speed
2667
2668         rotate                  Display rotation {0,90,180,270}
2669
2670         fps                     Delay between frame updates
2671
2672         debug                   Debug output level {0-7}
2673
2674
2675 Name:   pitft35-resistive
2676 Info:   Adafruit PiTFT 3.5" resistive touch screen
2677 Load:   dtoverlay=pitft35-resistive,<param>=<val>
2678 Params: speed                   Display SPI bus speed
2679
2680         rotate                  Display rotation {0,90,180,270}
2681
2682         fps                     Delay between frame updates
2683
2684         debug                   Debug output level {0-7}
2685
2686
2687 Name:   pps-gpio
2688 Info:   Configures the pps-gpio (pulse-per-second time signal via GPIO).
2689 Load:   dtoverlay=pps-gpio,<param>=<val>
2690 Params: gpiopin                 Input GPIO (default "18")
2691         assert_falling_edge     When present, assert is indicated by a falling
2692                                 edge, rather than by a rising edge (default
2693                                 off)
2694         capture_clear           Generate clear events on the trailing edge
2695                                 (default off)
2696
2697
2698 Name:   pwm
2699 Info:   Configures a single PWM channel
2700         Legal pin,function combinations for each channel:
2701           PWM0: 12,4(Alt0) 18,2(Alt5) 40,4(Alt0)            52,5(Alt1)
2702           PWM1: 13,4(Alt0) 19,2(Alt5) 41,4(Alt0) 45,4(Alt0) 53,5(Alt1)
2703         N.B.:
2704           1) Pin 18 is the only one available on all platforms, and
2705              it is the one used by the I2S audio interface.
2706              Pins 12 and 13 might be better choices on an A+, B+ or Pi2.
2707           2) The onboard analogue audio output uses both PWM channels.
2708           3) So be careful mixing audio and PWM.
2709           4) Currently the clock must have been enabled and configured
2710              by other means.
2711 Load:   dtoverlay=pwm,<param>=<val>
2712 Params: pin                     Output pin (default 18) - see table
2713         func                    Pin function (default 2 = Alt5) - see above
2714         clock                   PWM clock frequency (informational)
2715
2716
2717 Name:   pwm-2chan
2718 Info:   Configures both PWM channels
2719         Legal pin,function combinations for each channel:
2720           PWM0: 12,4(Alt0) 18,2(Alt5) 40,4(Alt0)            52,5(Alt1)
2721           PWM1: 13,4(Alt0) 19,2(Alt5) 41,4(Alt0) 45,4(Alt0) 53,5(Alt1)
2722         N.B.:
2723           1) Pin 18 is the only one available on all platforms, and
2724              it is the one used by the I2S audio interface.
2725              Pins 12 and 13 might be better choices on an A+, B+ or Pi2.
2726           2) The onboard analogue audio output uses both PWM channels.
2727           3) So be careful mixing audio and PWM.
2728           4) Currently the clock must have been enabled and configured
2729              by other means.
2730 Load:   dtoverlay=pwm-2chan,<param>=<val>
2731 Params: pin                     Output pin (default 18) - see table
2732         pin2                    Output pin for other channel (default 19)
2733         func                    Pin function (default 2 = Alt5) - see above
2734         func2                   Function for pin2 (default 2 = Alt5)
2735         clock                   PWM clock frequency (informational)
2736
2737
2738 Name:   pwm-ir-tx
2739 Info:   Use GPIO pin as pwm-assisted infrared transmitter output.
2740         This is an alternative to "gpio-ir-tx". pwm-ir-tx makes use
2741         of PWM0 to reduce the CPU load during transmission compared to
2742         gpio-ir-tx which uses bit-banging.
2743         Legal pin,function combinations are:
2744           12,4(Alt0) 18,2(Alt5) 40,4(Alt0) 52,5(Alt1)
2745 Load:   dtoverlay=pwm-ir-tx,<param>=<val>
2746 Params: gpio_pin                Output GPIO (default 18)
2747
2748         func                    Pin function (default 2 = Alt5)
2749
2750
2751 Name:   qca7000
2752 Info:   in-tech's Evaluation Board for PLC Stamp micro
2753         This uses spi0 and a separate GPIO interrupt to connect the QCA7000.
2754 Load:   dtoverlay=qca7000,<param>=<val>
2755 Params: int_pin                 GPIO pin for interrupt signal (default 23)
2756
2757         speed                   SPI bus speed (default 12 MHz)
2758
2759
2760 Name:   qca7000-uart0
2761 Info:   in-tech's Evaluation Board for PLC Stamp micro (UART)
2762         This uses uart0/ttyAMA0 over GPIOs 14 & 15 to connect the QCA7000.
2763         But it requires disabling of onboard Bluetooth on
2764         Pi 3B, 3B+, 3A+, 4B and Zero W.
2765 Load:   dtoverlay=qca7000-uart0,<param>=<val>
2766 Params: baudrate                Set the baudrate for the UART (default
2767                                 "115200")
2768
2769
2770 Name:   rotary-encoder
2771 Info:   Overlay for GPIO connected rotary encoder.
2772 Load:   dtoverlay=rotary-encoder,<param>=<val>
2773 Params: pin_a                   GPIO connected to rotary encoder channel A
2774                                 (default 4).
2775         pin_b                   GPIO connected to rotary encoder channel B
2776                                 (default 17).
2777         relative_axis           register a relative axis rather than an
2778                                 absolute one. Relative axis will only
2779                                 generate +1/-1 events on the input device,
2780                                 hence no steps need to be passed.
2781         linux_axis              the input subsystem axis to map to this
2782                                 rotary encoder. Defaults to 0 (ABS_X / REL_X)
2783         rollover                Automatic rollover when the rotary value
2784                                 becomes greater than the specified steps or
2785                                 smaller than 0. For absolute axis only.
2786         steps-per-period        Number of steps (stable states) per period.
2787                                 The values have the following meaning:
2788                                 1: Full-period mode (default)
2789                                 2: Half-period mode
2790                                 4: Quarter-period mode
2791         steps                   Number of steps in a full turnaround of the
2792                                 encoder. Only relevant for absolute axis.
2793                                 Defaults to 24 which is a typical value for
2794                                 such devices.
2795         wakeup                  Boolean, rotary encoder can wake up the
2796                                 system.
2797         encoding                String, the method used to encode steps.
2798                                 Supported are "gray" (the default and more
2799                                 common) and "binary".
2800
2801
2802 Name:   rpi-backlight
2803 Info:   Raspberry Pi official display backlight driver
2804 Load:   dtoverlay=rpi-backlight
2805 Params: <None>
2806
2807
2808 Name:   rpi-cirrus-wm5102
2809 Info:   Configures the Cirrus Logic Audio Card
2810 Load:   dtoverlay=rpi-cirrus-wm5102
2811 Params: <None>
2812
2813
2814 Name:   rpi-dac
2815 Info:   Configures the RPi DAC audio card
2816 Load:   dtoverlay=rpi-dac
2817 Params: <None>
2818
2819
2820 Name:   rpi-display
2821 Info:   RPi-Display - 2.8" Touch Display by Watterott
2822 Load:   dtoverlay=rpi-display,<param>=<val>
2823 Params: speed                   Display SPI bus speed
2824         rotate                  Display rotation {0,90,180,270}
2825         fps                     Delay between frame updates
2826         debug                   Debug output level {0-7}
2827         xohms                   Touchpanel sensitivity (X-plate resistance)
2828         swapxy                  Swap x and y axis
2829         backlight               Change backlight GPIO pin {e.g. 12, 18}
2830
2831
2832 Name:   rpi-ft5406
2833 Info:   Official Raspberry Pi display touchscreen
2834 Load:   dtoverlay=rpi-ft5406,<param>=<val>
2835 Params: touchscreen-size-x      Touchscreen X resolution (default 800)
2836         touchscreen-size-y      Touchscreen Y resolution (default 600);
2837         touchscreen-inverted-x  Invert touchscreen X coordinates (default 0);
2838         touchscreen-inverted-y  Invert touchscreen Y coordinates (default 0);
2839         touchscreen-swapped-x-y Swap X and Y cordinates (default 0);
2840
2841
2842 Name:   rpi-poe
2843 Info:   Raspberry Pi PoE HAT fan
2844 Load:   dtoverlay=rpi-poe,<param>[=<val>]
2845 Params: poe_fan_temp0           Temperature (in millicelcius) at which the fan
2846                                 turns on (default 40000)
2847         poe_fan_temp0_hyst      Temperature delta (in millicelcius) at which
2848                                 the fan turns off (default 2000)
2849         poe_fan_temp1           Temperature (in millicelcius) at which the fan
2850                                 speeds up (default 45000)
2851         poe_fan_temp1_hyst      Temperature delta (in millicelcius) at which
2852                                 the fan slows down (default 2000)
2853         poe_fan_temp2           Temperature (in millicelcius) at which the fan
2854                                 speeds up (default 50000)
2855         poe_fan_temp2_hyst      Temperature delta (in millicelcius) at which
2856                                 the fan slows down (default 2000)
2857         poe_fan_temp3           Temperature (in millicelcius) at which the fan
2858                                 speeds up (default 55000)
2859         poe_fan_temp3_hyst      Temperature delta (in millicelcius) at which
2860                                 the fan slows down (default 5000)
2861         i2c                     Control the fan via Linux I2C drivers instead of
2862                                 the firmware.
2863
2864
2865 Name:   rpi-poe-plus
2866 Info:   Raspberry Pi PoE+ HAT fan
2867 Load:   dtoverlay=rpi-poe-plus,<param>[=<val>]
2868 Params: poe_fan_temp0           Temperature (in millicelcius) at which the fan
2869                                 turns on (default 40000)
2870         poe_fan_temp0_hyst      Temperature delta (in millicelcius) at which
2871                                 the fan turns off (default 2000)
2872         poe_fan_temp1           Temperature (in millicelcius) at which the fan
2873                                 speeds up (default 45000)
2874         poe_fan_temp1_hyst      Temperature delta (in millicelcius) at which
2875                                 the fan slows down (default 2000)
2876         poe_fan_temp2           Temperature (in millicelcius) at which the fan
2877                                 speeds up (default 50000)
2878         poe_fan_temp2_hyst      Temperature delta (in millicelcius) at which
2879                                 the fan slows down (default 2000)
2880         poe_fan_temp3           Temperature (in millicelcius) at which the fan
2881                                 speeds up (default 55000)
2882         poe_fan_temp3_hyst      Temperature delta (in millicelcius) at which
2883                                 the fan slows down (default 5000)
2884         i2c                     Control the fan via Linux I2C drivers instead of
2885                                 the firmware.
2886
2887
2888 Name:   rpi-proto
2889 Info:   Configures the RPi Proto audio card
2890 Load:   dtoverlay=rpi-proto
2891 Params: <None>
2892
2893
2894 Name:   rpi-sense
2895 Info:   Raspberry Pi Sense HAT
2896 Load:   dtoverlay=rpi-sense
2897 Params: <None>
2898
2899
2900 Name:   rpi-tv
2901 Info:   Raspberry Pi TV HAT
2902 Load:   dtoverlay=rpi-tv
2903 Params: <None>
2904
2905
2906 Name:   rpivid-v4l2
2907 Info:   Load the V4L2 stateless video decoder driver for the HEVC block,
2908         disabling the memory mapped devices in the process.
2909 Load:   dtoverlay=rpivid-v4l2
2910 Params: <None>
2911
2912
2913 Name:   rra-digidac1-wm8741-audio
2914 Info:   Configures the Red Rocks Audio DigiDAC1 soundcard
2915 Load:   dtoverlay=rra-digidac1-wm8741-audio
2916 Params: <None>
2917
2918
2919 Name:   sainsmart18
2920 Info:   Overlay for the SPI-connected Sainsmart 1.8" display (based on the
2921         ST7735R chip).
2922 Load:   dtoverlay=sainsmart18,<param>=<val>
2923 Params: rotate                  Display rotation {0,90,180,270}
2924         speed                   SPI bus speed in Hz (default 4000000)
2925         fps                     Display frame rate in Hz
2926         bgr                     Enable BGR mode (default off)
2927         debug                   Debug output level {0-7}
2928         dc_pin                  GPIO pin for D/C (default 24)
2929         reset_pin               GPIO pin for RESET (default 25)
2930
2931
2932 Name:   sc16is750-i2c
2933 Info:   Overlay for the NXP SC16IS750 UART with I2C Interface
2934         Enables the chip on I2C1 at 0x48 (or the "addr" parameter value). To
2935         select another address, please refer to table 10 in reference manual.
2936 Load:   dtoverlay=sc16is750-i2c,<param>=<val>
2937 Params: int_pin                 GPIO used for IRQ (default 24)
2938         addr                    Address (default 0x48)
2939         xtal                    On-board crystal frequency (default 14745600)
2940
2941
2942 Name:   sc16is752-i2c
2943 Info:   Overlay for the NXP SC16IS752 dual UART with I2C Interface
2944         Enables the chip on I2C1 at 0x48 (or the "addr" parameter value). To
2945         select another address, please refer to table 10 in reference manual.
2946 Load:   dtoverlay=sc16is752-i2c,<param>=<val>
2947 Params: int_pin                 GPIO used for IRQ (default 24)
2948         addr                    Address (default 0x48)
2949         xtal                    On-board crystal frequency (default 14745600)
2950
2951
2952 Name:   sc16is752-spi0
2953 Info:   Overlay for the NXP SC16IS752 Dual UART with SPI Interface
2954         Enables the chip on SPI0.
2955 Load:   dtoverlay=sc16is752-spi0,<param>=<val>
2956 Params: int_pin                 GPIO used for IRQ (default 24)
2957         xtal                    On-board crystal frequency (default 14745600)
2958
2959
2960 Name:   sc16is752-spi1
2961 Info:   Overlay for the NXP SC16IS752 Dual UART with SPI Interface
2962         Enables the chip on SPI1.
2963         N.B.: spi1 is only accessible on devices with a 40pin header, eg:
2964               A+, B+, Zero and PI2 B; as well as the Compute Module.
2965
2966 Load:   dtoverlay=sc16is752-spi1,<param>=<val>
2967 Params: int_pin                 GPIO used for IRQ (default 24)
2968         xtal                    On-board crystal frequency (default 14745600)
2969
2970
2971 Name:   sdhost
2972 Info:   Selects the bcm2835-sdhost SD/MMC driver, optionally with overclock.
2973         N.B. This overlay is designed for situations where the mmc driver is
2974         the default, so it disables the other (mmc) interface - this will kill
2975         WLAN on a Pi3. If this isn't what you want, either use the sdtweak
2976         overlay or the new sd_* dtparams of the base DTBs.
2977 Load:   dtoverlay=sdhost,<param>=<val>
2978 Params: overclock_50            Clock (in MHz) to use when the MMC framework
2979                                 requests 50MHz
2980
2981         force_pio               Disable DMA support (default off)
2982
2983         pio_limit               Number of blocks above which to use DMA
2984                                 (default 1)
2985
2986         debug                   Enable debug output (default off)
2987
2988
2989 Name:   sdio
2990 Info:   Selects the bcm2835-sdhost SD/MMC driver, optionally with overclock,
2991         and enables SDIO via GPIOs 22-27. An example of use in 1-bit mode is
2992         "dtoverlay=sdio,bus_width=1,gpios_22_25"
2993 Load:   dtoverlay=sdio,<param>=<val>
2994 Params: sdio_overclock          SDIO Clock (in MHz) to use when the MMC
2995                                 framework requests 50MHz
2996
2997         poll_once               Disable SDIO-device polling every second
2998                                 (default on: polling once at boot-time)
2999
3000         bus_width               Set the SDIO host bus width (default 4 bits)
3001
3002         gpios_22_25             Select GPIOs 22-25 for 1-bit mode. Must be used
3003                                 with bus_width=1. This replaces the sdio-1bit
3004                                 overlay, which is now deprecated.
3005
3006         gpios_34_37             Select GPIOs 34-37 for 1-bit mode. Must be used
3007                                 with bus_width=1.
3008
3009         gpios_34_39             Select GPIOs 34-39 for 4-bit mode. Must be used
3010                                 with bus_width=4 (the default).
3011
3012
3013 Name:   sdio-1bit
3014 Info:   This overlay is now deprecated. Use
3015         "dtoverlay=sdio,bus_width=1,gpios_22_25" instead.
3016 Load:   <Deprecated>
3017
3018
3019 Name:   sdtweak
3020 Info:   This overlay is now deprecated. Use the sd_* dtparams in the
3021         base DTB, e.g. "dtoverlay=sdtweak,poll_once" becomes
3022         "dtparam=sd_poll_once".
3023 Load:   <Deprecated>
3024
3025
3026 Name:   seeed-can-fd-hat-v1
3027 Info:   Overlay for Seeed Studio CAN BUS FD HAT with two CAN FD
3028         channels without RTC. Use this overlay if your HAT has no
3029         battery holder.
3030         https://www.seeedstudio.com/2-Channel-CAN-BUS-FD-Shield-for-Raspberry-Pi-p-4072.html
3031 Load:   dtoverlay=seeed-can-fd-hat-v1
3032 Params: <None>
3033
3034
3035 Name:   seeed-can-fd-hat-v2
3036 Info:   Overlay for Seeed Studio CAN BUS FD HAT with two CAN FD
3037         channels and an RTC. Use this overlay if your HAT has a
3038         battery holder.
3039         https://www.seeedstudio.com/CAN-BUS-FD-HAT-for-Raspberry-Pi-p-4742.html
3040 Load:   dtoverlay=seeed-can-fd-hat-v2
3041 Params: <None>
3042
3043
3044 Name:   sh1106-spi
3045 Info:   Overlay for SH1106 OLED via SPI using fbtft staging driver.
3046 Load:   dtoverlay=sh1106-spi,<param>=<val>
3047 Params: speed                   SPI bus speed (default 4000000)
3048         rotate                  Display rotation (0, 90, 180 or 270; default 0)
3049         fps                     Delay between frame updates (default 25)
3050         debug                   Debug output level (0-7; default 0)
3051         dc_pin                  GPIO pin for D/C (default 24)
3052         reset_pin               GPIO pin for RESET (default 25)
3053         height                  Display height (32 or 64; default 64)
3054
3055
3056 Name:   si446x-spi0
3057 Info:   Overlay for Si446x UHF Transceiver via SPI using si446x driver.
3058         The driver is currently out-of-tree at
3059         https://github.com/sunipkmukherjee/silabs.git
3060 Load:   dtoverlay=si446x-spi0,<param>=<val>
3061 Params: speed                   SPI bus speed (default 4000000)
3062         int_pin                 GPIO pin for interrupts (default 17)
3063         reset_pin               GPIO pin for RESET (default 27)
3064
3065
3066 Name:   smi
3067 Info:   Enables the Secondary Memory Interface peripheral. Uses GPIOs 2-25!
3068 Load:   dtoverlay=smi
3069 Params: <None>
3070
3071
3072 Name:   smi-dev
3073 Info:   Enables the userspace interface for the SMI driver
3074 Load:   dtoverlay=smi-dev
3075 Params: <None>
3076
3077
3078 Name:   smi-nand
3079 Info:   Enables access to NAND flash via the SMI interface
3080 Load:   dtoverlay=smi-nand
3081 Params: <None>
3082
3083
3084 Name:   spi-gpio35-39
3085 Info:   Move SPI function block to GPIO 35 to 39
3086 Load:   dtoverlay=spi-gpio35-39
3087 Params: <None>
3088
3089
3090 Name:   spi-gpio40-45
3091 Info:   Move SPI function block to GPIOs 40 to 45
3092 Load:   dtoverlay=spi-gpio40-45
3093 Params: <None>
3094
3095
3096 Name:   spi-rtc
3097 Info:   Adds support for a number of SPI Real Time Clock devices
3098 Load:   dtoverlay=spi-rtc,<param>=<val>
3099 Params: ds3232                  Select the DS3232 device
3100         ds3234                  Select the DS3234 device
3101         pcf2123                 Select the PCF2123 device
3102
3103         spi0_0                  Use spi0.0 (default)
3104         spi0_1                  Use spi0.1
3105         spi1_0                  Use spi1.0
3106         spi1_1                  Use spi1.1
3107         spi2_0                  Use spi2.0
3108         spi2_1                  Use spi2.1
3109         cs_high                 This device requires an active-high CS
3110
3111
3112 Name:   spi0-1cs
3113 Info:   Only use one CS pin for SPI0
3114 Load:   dtoverlay=spi0-1cs,<param>=<val>
3115 Params: cs0_pin                 GPIO pin for CS0 (default 8)
3116         no_miso                 Don't claim and use the MISO pin (9), freeing
3117                                 it for other uses.
3118
3119
3120 Name:   spi0-2cs
3121 Info:   Change the CS pins for SPI0
3122 Load:   dtoverlay=spi0-2cs,<param>=<val>
3123 Params: cs0_pin                 GPIO pin for CS0 (default 8)
3124         cs1_pin                 GPIO pin for CS1 (default 7)
3125         no_miso                 Don't claim and use the MISO pin (9), freeing
3126                                 it for other uses.
3127
3128
3129 Name:   spi0-cs
3130 Info:   This overlay has been renamed spi0-2cs, keeping spi0-cs as an
3131         alias for backwards compatibility.
3132 Load:   <Deprecated>
3133
3134
3135 Name:   spi0-hw-cs
3136 Info:   This overlay has been deprecated and removed because it is no longer
3137         necessary and has been seen to prevent spi0 from working.
3138 Load:   <Deprecated>
3139
3140
3141 Name:   spi1-1cs
3142 Info:   Enables spi1 with a single chip select (CS) line and associated spidev
3143         dev node. The gpio pin number for the CS line and spidev device node
3144         creation are configurable.
3145         N.B.: spi1 is only accessible on devices with a 40pin header, eg:
3146               A+, B+, Zero and PI2 B; as well as the Compute Module.
3147 Load:   dtoverlay=spi1-1cs,<param>=<val>
3148 Params: cs0_pin                 GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
3149         cs0_spidev              Set to 'disabled' to stop the creation of a
3150                                 userspace device node /dev/spidev1.0 (default
3151                                 is 'okay' or enabled).
3152
3153
3154 Name:   spi1-2cs
3155 Info:   Enables spi1 with two chip select (CS) lines and associated spidev
3156         dev nodes. The gpio pin numbers for the CS lines and spidev device node
3157         creation are configurable.
3158         N.B.: spi1 is only accessible on devices with a 40pin header, eg:
3159               A+, B+, Zero and PI2 B; as well as the Compute Module.
3160 Load:   dtoverlay=spi1-2cs,<param>=<val>
3161 Params: cs0_pin                 GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
3162         cs1_pin                 GPIO pin for CS1 (default 17 - BCM SPI1_CE1).
3163         cs0_spidev              Set to 'disabled' to stop the creation of a
3164                                 userspace device node /dev/spidev1.0 (default
3165                                 is 'okay' or enabled).
3166         cs1_spidev              Set to 'disabled' to stop the creation of a
3167                                 userspace device node /dev/spidev1.1 (default
3168                                 is 'okay' or enabled).
3169
3170
3171 Name:   spi1-3cs
3172 Info:   Enables spi1 with three chip select (CS) lines and associated spidev
3173         dev nodes. The gpio pin numbers for the CS lines and spidev device node
3174         creation are configurable.
3175         N.B.: spi1 is only accessible on devices with a 40pin header, eg:
3176               A+, B+, Zero and PI2 B; as well as the Compute Module.
3177 Load:   dtoverlay=spi1-3cs,<param>=<val>
3178 Params: cs0_pin                 GPIO pin for CS0 (default 18 - BCM SPI1_CE0).
3179         cs1_pin                 GPIO pin for CS1 (default 17 - BCM SPI1_CE1).
3180         cs2_pin                 GPIO pin for CS2 (default 16 - BCM SPI1_CE2).
3181         cs0_spidev              Set to 'disabled' to stop the creation of a
3182                                 userspace device node /dev/spidev1.0 (default
3183                                 is 'okay' or enabled).
3184         cs1_spidev              Set to 'disabled' to stop the creation of a
3185                                 userspace device node /dev/spidev1.1 (default
3186                                 is 'okay' or enabled).
3187         cs2_spidev              Set to 'disabled' to stop the creation of a
3188                                 userspace device node /dev/spidev1.2 (default
3189                                 is 'okay' or enabled).
3190
3191
3192 Name:   spi2-1cs
3193 Info:   Enables spi2 with a single chip select (CS) line and associated spidev
3194         dev node. The gpio pin number for the CS line and spidev device node
3195         creation are configurable.
3196         N.B.: spi2 is only accessible with the Compute Module.
3197 Load:   dtoverlay=spi2-1cs,<param>=<val>
3198 Params: cs0_pin                 GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
3199         cs0_spidev              Set to 'disabled' to stop the creation of a
3200                                 userspace device node /dev/spidev2.0 (default
3201                                 is 'okay' or enabled).
3202
3203
3204 Name:   spi2-2cs
3205 Info:   Enables spi2 with two chip select (CS) lines and associated spidev
3206         dev nodes. The gpio pin numbers for the CS lines and spidev device node
3207         creation are configurable.
3208         N.B.: spi2 is only accessible with the Compute Module.
3209 Load:   dtoverlay=spi2-2cs,<param>=<val>
3210 Params: cs0_pin                 GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
3211         cs1_pin                 GPIO pin for CS1 (default 44 - BCM SPI2_CE1).
3212         cs0_spidev              Set to 'disabled' to stop the creation of a
3213                                 userspace device node /dev/spidev2.0 (default
3214                                 is 'okay' or enabled).
3215         cs1_spidev              Set to 'disabled' to stop the creation of a
3216                                 userspace device node /dev/spidev2.1 (default
3217                                 is 'okay' or enabled).
3218
3219
3220 Name:   spi2-3cs
3221 Info:   Enables spi2 with three chip select (CS) lines and associated spidev
3222         dev nodes. The gpio pin numbers for the CS lines and spidev device node
3223         creation are configurable.
3224         N.B.: spi2 is only accessible with the Compute Module.
3225 Load:   dtoverlay=spi2-3cs,<param>=<val>
3226 Params: cs0_pin                 GPIO pin for CS0 (default 43 - BCM SPI2_CE0).
3227         cs1_pin                 GPIO pin for CS1 (default 44 - BCM SPI2_CE1).
3228         cs2_pin                 GPIO pin for CS2 (default 45 - BCM SPI2_CE2).
3229         cs0_spidev              Set to 'disabled' to stop the creation of a
3230                                 userspace device node /dev/spidev2.0 (default
3231                                 is 'okay' or enabled).
3232         cs1_spidev              Set to 'disabled' to stop the creation of a
3233                                 userspace device node /dev/spidev2.1 (default
3234                                 is 'okay' or enabled).
3235         cs2_spidev              Set to 'disabled' to stop the creation of a
3236                                 userspace device node /dev/spidev2.2 (default
3237                                 is 'okay' or enabled).
3238
3239
3240 Name:   spi3-1cs
3241 Info:   Enables spi3 with a single chip select (CS) line and associated spidev
3242         dev node. The gpio pin number for the CS line and spidev device node
3243         creation are configurable. BCM2711 only.
3244 Load:   dtoverlay=spi3-1cs,<param>=<val>
3245 Params: cs0_pin                 GPIO pin for CS0 (default 0 - BCM SPI3_CE0).
3246         cs0_spidev              Set to 'off' to prevent the creation of a
3247                                 userspace device node /dev/spidev3.0 (default
3248                                 is 'on' or enabled).
3249
3250
3251 Name:   spi3-2cs
3252 Info:   Enables spi3 with two chip select (CS) lines and associated spidev
3253         dev nodes. The gpio pin numbers for the CS lines and spidev device node
3254         creation are configurable. BCM2711 only.
3255 Load:   dtoverlay=spi3-2cs,<param>=<val>
3256 Params: cs0_pin                 GPIO pin for CS0 (default 0 - BCM SPI3_CE0).
3257         cs1_pin                 GPIO pin for CS1 (default 24 - BCM SPI3_CE1).
3258         cs0_spidev              Set to 'off' to prevent the creation of a
3259                                 userspace device node /dev/spidev3.0 (default
3260                                 is 'on' or enabled).
3261         cs1_spidev              Set to 'off' to prevent the creation of a
3262                                 userspace device node /dev/spidev3.1 (default
3263                                 is 'on' or enabled).
3264
3265
3266 Name:   spi4-1cs
3267 Info:   Enables spi4 with a single chip select (CS) line and associated spidev
3268         dev node. The gpio pin number for the CS line and spidev device node
3269         creation are configurable. BCM2711 only.
3270 Load:   dtoverlay=spi4-1cs,<param>=<val>
3271 Params: cs0_pin                 GPIO pin for CS0 (default 4 - BCM SPI4_CE0).
3272         cs0_spidev              Set to 'off' to prevent the creation of a
3273                                 userspace device node /dev/spidev4.0 (default
3274                                 is 'on' or enabled).
3275
3276
3277 Name:   spi4-2cs
3278 Info:   Enables spi4 with two chip select (CS) lines and associated spidev
3279         dev nodes. The gpio pin numbers for the CS lines and spidev device node
3280         creation are configurable. BCM2711 only.
3281 Load:   dtoverlay=spi4-2cs,<param>=<val>
3282 Params: cs0_pin                 GPIO pin for CS0 (default 4 - BCM SPI4_CE0).
3283         cs1_pin                 GPIO pin for CS1 (default 25 - BCM SPI4_CE1).
3284         cs0_spidev              Set to 'off' to prevent the creation of a
3285                                 userspace device node /dev/spidev4.0 (default
3286                                 is 'on' or enabled).
3287         cs1_spidev              Set to 'off' to prevent the creation of a
3288                                 userspace device node /dev/spidev4.1 (default
3289                                 is 'on' or enabled).
3290
3291
3292 Name:   spi5-1cs
3293 Info:   Enables spi5 with a single chip select (CS) line and associated spidev
3294         dev node. The gpio pin numbers for the CS lines and spidev device node
3295         creation are configurable. BCM2711 only.
3296 Load:   dtoverlay=spi5-1cs,<param>=<val>
3297 Params: cs0_pin                 GPIO pin for CS0 (default 12 - BCM SPI5_CE0).
3298         cs0_spidev              Set to 'off' to prevent the creation of a
3299                                 userspace device node /dev/spidev5.0 (default
3300                                 is 'on' or enabled).
3301
3302
3303 Name:   spi5-2cs
3304 Info:   Enables spi5 with two chip select (CS) lines and associated spidev
3305         dev nodes. The gpio pin numbers for the CS lines and spidev device node
3306         creation are configurable. BCM2711 only.
3307 Load:   dtoverlay=spi5-2cs,<param>=<val>
3308 Params: cs0_pin                 GPIO pin for CS0 (default 12 - BCM SPI5_CE0).
3309         cs1_pin                 GPIO pin for CS1 (default 26 - BCM SPI5_CE1).
3310         cs0_spidev              Set to 'off' to prevent the creation of a
3311                                 userspace device node /dev/spidev5.0 (default
3312                                 is 'on' or enabled).
3313         cs1_spidev              Set to 'off' to prevent the creation of a
3314                                 userspace device node /dev/spidev5.1 (default
3315                                 is 'on' or enabled).
3316
3317
3318 Name:   spi6-1cs
3319 Info:   Enables spi6 with a single chip select (CS) line and associated spidev
3320         dev node. The gpio pin number for the CS line and spidev device node
3321         creation are configurable. BCM2711 only.
3322 Load:   dtoverlay=spi6-1cs,<param>=<val>
3323 Params: cs0_pin                 GPIO pin for CS0 (default 18 - BCM SPI6_CE0).
3324         cs0_spidev              Set to 'off' to prevent the creation of a
3325                                 userspace device node /dev/spidev6.0 (default
3326                                 is 'on' or enabled).
3327
3328
3329 Name:   spi6-2cs
3330 Info:   Enables spi6 with two chip select (CS) lines and associated spidev
3331         dev nodes. The gpio pin numbers for the CS lines and spidev device node
3332         creation are configurable. BCM2711 only.
3333 Load:   dtoverlay=spi6-2cs,<param>=<val>
3334 Params: cs0_pin                 GPIO pin for CS0 (default 18 - BCM SPI6_CE0).
3335         cs1_pin                 GPIO pin for CS1 (default 27 - BCM SPI6_CE1).
3336         cs0_spidev              Set to 'off' to prevent the creation of a
3337                                 userspace device node /dev/spidev6.0 (default
3338                                 is 'on' or enabled).
3339         cs1_spidev              Set to 'off' to prevent the creation of a
3340                                 userspace device node /dev/spidev6.1 (default
3341                                 is 'on' or enabled).
3342
3343
3344 Name:   ssd1306
3345 Info:   Overlay for activation of SSD1306 over I2C OLED display framebuffer.
3346 Load:   dtoverlay=ssd1306,<param>=<val>
3347 Params: address                 Location in display memory of first character.
3348                                 (default=0)
3349         width                   Width of display. (default=128)
3350         height                  Height of display. (default=64)
3351         offset                  virtual channel a. (default=0)
3352         normal                  Has no effect on displays tested. (default=not
3353                                 set)
3354         sequential              Set this if every other scan line is missing.
3355                                 (default=not set)
3356         remapped                Set this if display is garbled. (default=not
3357                                 set)
3358         inverted                Set this if display is inverted and mirrored.
3359                                 (default=not set)
3360
3361         Examples:
3362         Typical usage for 128x64 display: dtoverlay=ssd1306,inverted
3363
3364         Typical usage for 128x32 display: dtoverlay=ssd1306,inverted,sequential
3365
3366         i2c_baudrate=400000 will speed up the display.
3367
3368         i2c_baudrate=1000000 seems to work even though it's not officially
3369         supported by the hardware, and is faster still.
3370
3371         For more information refer to the device datasheet at:
3372         https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf
3373
3374
3375 Name:   ssd1306-spi
3376 Info:   Overlay for SSD1306 OLED via SPI using fbtft staging driver.
3377 Load:   dtoverlay=ssd1306-spi,<param>=<val>
3378 Params: speed                   SPI bus speed (default 10000000)
3379         rotate                  Display rotation (0, 90, 180 or 270; default 0)
3380         fps                     Delay between frame updates (default 25)
3381         debug                   Debug output level (0-7; default 0)
3382         dc_pin                  GPIO pin for D/C (default 24)
3383         reset_pin               GPIO pin for RESET (default 25)
3384         height                  Display height (32 or 64; default 64)
3385
3386
3387 Name:   ssd1331-spi
3388 Info:   Overlay for SSD1331 OLED via SPI using fbtft staging driver.
3389 Load:   dtoverlay=ssd1331-spi,<param>=<val>
3390 Params: speed                   SPI bus speed (default 4500000)
3391         rotate                  Display rotation (0, 90, 180 or 270; default 0)
3392         fps                     Delay between frame updates (default 25)
3393         debug                   Debug output level (0-7; default 0)
3394         dc_pin                  GPIO pin for D/C (default 24)
3395         reset_pin               GPIO pin for RESET (default 25)
3396
3397
3398 Name:   ssd1351-spi
3399 Info:   Overlay for SSD1351 OLED via SPI using fbtft staging driver.
3400 Load:   dtoverlay=ssd1351-spi,<param>=<val>
3401 Params: speed                   SPI bus speed (default 4500000)
3402         rotate                  Display rotation (0, 90, 180 or 270; default 0)
3403         fps                     Delay between frame updates (default 25)
3404         debug                   Debug output level (0-7; default 0)
3405         dc_pin                  GPIO pin for D/C (default 24)
3406         reset_pin               GPIO pin for RESET (default 25)
3407
3408
3409 Name:   superaudioboard
3410 Info:   Configures the SuperAudioBoard sound card
3411 Load:   dtoverlay=superaudioboard,<param>=<val>
3412 Params: gpiopin                 GPIO pin for codec reset
3413
3414
3415 Name:   sx150x
3416 Info:   Configures the Semtech SX150X I2C GPIO expanders.
3417 Load:   dtoverlay=sx150x,<param>=<val>
3418 Params: sx150<x>-<n>-<m>        Enables SX150X device on I2C#<n> with slave
3419                                 address <m>. <x> may be 1-9. <n> may be 0 or 1.
3420                                 Permissible values of <m> (which is denoted in
3421                                 hex) depend on the device variant. For SX1501,
3422                                 SX1502, SX1504 and SX1505, <m> may be 20 or 21.
3423                                 For SX1503 and SX1506, <m> may be 20. For
3424                                 SX1507 and SX1509, <m> may be 3E, 3F, 70 or 71.
3425                                 For SX1508, <m> may be 20, 21, 22 or 23.
3426
3427         sx150<x>-<n>-<m>-int-gpio
3428                                 Integer, enables interrupts on SX150X device on
3429                                 I2C#<n> with slave address <m>, specifies
3430                                 the GPIO pin to which NINT output of SX150X is
3431                                 connected.
3432
3433
3434 Name:   tc358743
3435 Info:   Toshiba TC358743 HDMI to CSI-2 bridge chip.
3436         Uses Unicam 1, which is the standard camera connector on most Pi
3437         variants.
3438 Load:   dtoverlay=tc358743,<param>=<val>
3439 Params: 4lane                   Use 4 lanes (only applicable to Compute Modules
3440                                 CAM1 connector).
3441
3442         link-frequency          Set the link frequency. Only values of 297000000
3443                                 (574Mbit/s) and 486000000 (972Mbit/s - default)
3444                                 are supported by the driver.
3445         media-controller        Configure use of Media Controller API for
3446                                 configuring the sensor (default off)
3447         cam0                    Adopt the default configuration for CAM0 on a
3448                                 Compute Module (CSI0, i2c_vc, and cam0_reg).
3449
3450
3451 Name:   tc358743-audio
3452 Info:   Used in combination with the tc358743-fast overlay to route the audio
3453         from the TC358743 over I2S to the Pi.
3454         Wiring is LRCK/WFS to GPIO 19, BCK/SCK to GPIO 18, and DATA/SD to GPIO
3455         20.
3456 Load:   dtoverlay=tc358743-audio,<param>=<val>
3457 Params: card-name               Override the default, "tc358743", card name.
3458
3459
3460 Name:   tinylcd35
3461 Info:   3.5" Color TFT Display by www.tinylcd.com
3462         Options: Touch, RTC, keypad
3463 Load:   dtoverlay=tinylcd35,<param>=<val>
3464 Params: speed                   Display SPI bus speed
3465
3466         rotate                  Display rotation {0,90,180,270}
3467
3468         fps                     Delay between frame updates
3469
3470         debug                   Debug output level {0-7}
3471
3472         touch                   Enable touch panel
3473
3474         touchgpio               Touch controller IRQ GPIO
3475
3476         xohms                   Touchpanel: Resistance of X-plate in ohms
3477
3478         rtc-pcf                 PCF8563 Real Time Clock
3479
3480         rtc-ds                  DS1307 Real Time Clock
3481
3482         keypad                  Enable keypad
3483
3484         Examples:
3485             Display with touchpanel, PCF8563 RTC and keypad:
3486                 dtoverlay=tinylcd35,touch,rtc-pcf,keypad
3487             Old touch display:
3488                 dtoverlay=tinylcd35,touch,touchgpio=3
3489
3490
3491 Name:   tpm-slb9670
3492 Info:   Enables support for Infineon SLB9670 Trusted Platform Module add-on
3493         boards, which can be used as a secure key storage and hwrng,
3494         available as "Iridium SLB9670" by Infineon and "LetsTrust TPM" by pi3g.
3495 Load:   dtoverlay=tpm-slb9670
3496 Params: <None>
3497
3498
3499 Name:   uart0
3500 Info:   Change the pin usage of uart0
3501 Load:   dtoverlay=uart0,<param>=<val>
3502 Params: txd0_pin                GPIO pin for TXD0 (14, 32 or 36 - default 14)
3503
3504         rxd0_pin                GPIO pin for RXD0 (15, 33 or 37 - default 15)
3505
3506         pin_func                Alternative pin function - 4(Alt0) for 14&15,
3507                                 7(Alt3) for 32&33, 6(Alt2) for 36&37
3508
3509
3510 Name:   uart1
3511 Info:   Change the pin usage of uart1
3512 Load:   dtoverlay=uart1,<param>=<val>
3513 Params: txd1_pin                GPIO pin for TXD1 (14, 32 or 40 - default 14)
3514
3515         rxd1_pin                GPIO pin for RXD1 (15, 33 or 41 - default 15)
3516
3517
3518 Name:   uart2
3519 Info:   Enable uart 2 on GPIOs 0-3. BCM2711 only.
3520 Load:   dtoverlay=uart2,<param>
3521 Params: ctsrts                  Enable CTS/RTS on GPIOs 2-3 (default off)
3522
3523
3524 Name:   uart3
3525 Info:   Enable uart 3 on GPIOs 4-7. BCM2711 only.
3526 Load:   dtoverlay=uart3,<param>
3527 Params: ctsrts                  Enable CTS/RTS on GPIOs 6-7 (default off)
3528
3529
3530 Name:   uart4
3531 Info:   Enable uart 4 on GPIOs 8-11. BCM2711 only.
3532 Load:   dtoverlay=uart4,<param>
3533 Params: ctsrts                  Enable CTS/RTS on GPIOs 10-11 (default off)
3534
3535
3536 Name:   uart5
3537 Info:   Enable uart 5 on GPIOs 12-15. BCM2711 only.
3538 Load:   dtoverlay=uart5,<param>
3539 Params: ctsrts                  Enable CTS/RTS on GPIOs 14-15 (default off)
3540
3541
3542 Name:   udrc
3543 Info:   Configures the NW Digital Radio UDRC Hat
3544 Load:   dtoverlay=udrc,<param>=<val>
3545 Params: alsaname                Name of the ALSA audio device (default "udrc")
3546
3547
3548 Name:   ugreen-dabboard
3549 Info:   Configures the ugreen-dabboard I2S overlay
3550         This is a simple overlay based on the simple-audio-card and the dmic
3551         codec. It has the speciality that it is configured to use the codec
3552         as a master I2S device. It works for example with the Si468x DAB
3553         receiver on the uGreen DABBoard.
3554 Load:   dtoverlay=ugreen-dabboard,<param>=<val>
3555 Params: card-name               Override the default, "dabboard", card name.
3556
3557
3558 Name:   upstream
3559 Info:   Allow usage of downstream .dtb with upstream kernel. Comprises the
3560         vc4-kms-v3d and dwc2 overlays.
3561 Load:   dtoverlay=upstream
3562 Params: <None>
3563
3564
3565 Name:   upstream-aux-interrupt
3566 Info:   This overlay has been deprecated and removed because it is no longer
3567         necessary.
3568 Load:   <Deprecated>
3569
3570
3571 Name:   upstream-pi4
3572 Info:   Allow usage of downstream .dtb with upstream kernel on Pi 4. Comprises
3573         the vc4-kms-v3d-pi4 and dwc2 overlays.
3574 Load:   dtoverlay=upstream-pi4
3575 Params: <None>
3576
3577
3578 Name:   vc4-fkms-v3d
3579 Info:   Enable Eric Anholt's DRM VC4 V3D driver on top of the dispmanx
3580         display stack.
3581 Load:   dtoverlay=vc4-fkms-v3d,<param>
3582 Params: cma-512                 CMA is 512MB (needs 1GB)
3583         cma-448                 CMA is 448MB (needs 1GB)
3584         cma-384                 CMA is 384MB (needs 1GB)
3585         cma-320                 CMA is 320MB (needs 1GB)
3586         cma-256                 CMA is 256MB (needs 1GB)
3587         cma-192                 CMA is 192MB (needs 1GB)
3588         cma-128                 CMA is 128MB
3589         cma-96                  CMA is 96MB
3590         cma-64                  CMA is 64MB
3591         cma-size                CMA size in bytes, 4MB aligned
3592         cma-default             Use upstream's default value
3593
3594
3595 Name:   vc4-fkms-v3d-pi4
3596 Info:   Enable Eric Anholt's DRM VC4 V3D driver on top of the dispmanx
3597         display stack.
3598 Load:   dtoverlay=vc4-fkms-v3d-pi4,<param>
3599 Params: cma-512                 CMA is 512MB (needs 1GB)
3600         cma-448                 CMA is 448MB (needs 1GB)
3601         cma-384                 CMA is 384MB (needs 1GB)
3602         cma-320                 CMA is 320MB (needs 1GB)
3603         cma-256                 CMA is 256MB (needs 1GB)
3604         cma-192                 CMA is 192MB (needs 1GB)
3605         cma-128                 CMA is 128MB
3606         cma-96                  CMA is 96MB
3607         cma-64                  CMA is 64MB
3608         cma-size                CMA size in bytes, 4MB aligned
3609         cma-default             Use upstream's default value
3610
3611
3612 Name:   vc4-kms-dpi-at056tn53v1
3613 Info:   Enable an Innolux 5.6in VGA TFT connected to DPI interface under KMS.
3614         Requires vc4-kms-v3d to be loaded.
3615 Load:   dtoverlay=vc4-kms-dpi-at056tn53v1
3616 Params: <None>
3617
3618
3619 Name:   vc4-kms-dpi-generic
3620 Info:   Enable a generic DPI display under KMS. Default timings are for the
3621         Adafruit Kippah with 800x480 panel and RGB666 (GPIOs 0-21)
3622         Requires vc4-kms-v3d to be loaded.
3623 Load:   dtoverlay=vc4-kms-dpi-generic,<param>=<val>
3624 Params: clock-frequency         Display clock frequency (Hz)
3625         hactive                 Horizontal active pixels
3626         hfp                     Horizontal front porch
3627         hsync                   Horizontal sync pulse width
3628         hbp                     Horizontal back porch
3629         vactive                 Vertical active lines
3630         vfp                     Vertical front porch
3631         vsync                   Vertical sync pulse width
3632         vbp                     Vertical back porch
3633         hsync-invert            Horizontal sync active low
3634         vsync-invert            Vertical sync active low
3635         de-invert               Data Enable active low
3636         pixclk-invert           Negative edge pixel clock
3637         width-mm                Define the screen width in mm
3638         height-mm               Define the screen height in mm
3639         rgb565                  Change to RGB565 output on GPIOs 0-19
3640         rgb666-padhi            Change to RGB666 output on GPIOs 0-9, 12-17, and
3641                                 20-25
3642         rgb888                  Change to RGB888 output on GPIOs 0-27
3643         bus-format              Override the bus format for a MEDIA_BUS_FMT_*
3644                                 value. NB also overridden by rgbXXX overrides.
3645         backlight-gpio          Defines a GPIO to be used for backlight control
3646                                 (default of none).
3647
3648
3649 Name:   vc4-kms-dsi-7inch
3650 Info:   Enable the Raspberry Pi DSI 7" screen.
3651         Includes the edt-ft5406 for the touchscreen element.
3652         Requires vc4-kms-v3d to be loaded.
3653 Load:   dtoverlay=vc4-kms-dsi-7inch,<param>=<val>
3654 Params: sizex                   Touchscreen size x (default 800)
3655         sizey                   Touchscreen size y (default 480)
3656         invx                    Touchscreen inverted x axis
3657         invy                    Touchscreen inverted y axis
3658         swapxy                  Touchscreen swapped x y axis
3659         disable_touch           Disables the touch screen overlay driver
3660
3661
3662 Name:   vc4-kms-dsi-lt070me05000
3663 Info:   Enable a JDI LT070ME05000 DSI display on DSI1.
3664         Note that this is a 4 lane DSI device, so it will only work on a Compute
3665         Module.
3666         Requires vc4-kms-v3d to be loaded.
3667 Load:   dtoverlay=vc4-kms-dsi-lt070me05000,<param>
3668 Params: reset                   GPIO for the reset signal (default 17)
3669         enable                  GPIO for the enable signal (default 4)
3670         dcdc-en                 GPIO for the DC-DC converter enable (default 5)
3671
3672
3673 Name:   vc4-kms-dsi-lt070me05000-v2
3674 Info:   Enable a JDI LT070ME05000 DSI display on DSI1 using Harlab's V2
3675         interface board.
3676         Note that this is a 4 lane DSI device, so it will only work on a Compute
3677         Module.
3678         Requires vc4-kms-v3d to be loaded.
3679 Load:   dtoverlay=vc4-kms-dsi-lt070me05000-v2
3680 Params: <None>
3681
3682
3683 Name:   vc4-kms-kippah-7inch
3684 Info:   Enable the Adafruit DPI Kippah with the 7" Ontat panel attached.
3685         Requires vc4-kms-v3d to be loaded.
3686 Load:   dtoverlay=vc4-kms-kippah-7inch
3687 Params: <None>
3688
3689
3690 Name:   vc4-kms-v3d
3691 Info:   Enable Eric Anholt's DRM VC4 HDMI/HVS/V3D driver.
3692 Load:   dtoverlay=vc4-kms-v3d,<param>
3693 Params: cma-512                 CMA is 512MB (needs 1GB)
3694         cma-448                 CMA is 448MB (needs 1GB)
3695         cma-384                 CMA is 384MB (needs 1GB)
3696         cma-320                 CMA is 320MB (needs 1GB)
3697         cma-256                 CMA is 256MB (needs 1GB)
3698         cma-192                 CMA is 192MB (needs 1GB)
3699         cma-128                 CMA is 128MB
3700         cma-96                  CMA is 96MB
3701         cma-64                  CMA is 64MB
3702         cma-size                CMA size in bytes, 4MB aligned
3703         cma-default             Use upstream's default value
3704         audio                   Enable or disable audio over HDMI (default "on")
3705         noaudio                 Disable all HDMI audio (default "off")
3706         composite               Enable the composite output (default "off")
3707                                 N.B. Disables all other outputs on a Pi 4.
3708
3709
3710 Name:   vc4-kms-v3d-pi4
3711 Info:   Enable Eric Anholt's DRM VC4 HDMI/HVS/V3D driver for Pi4.
3712 Load:   dtoverlay=vc4-kms-v3d-pi4,<param>
3713 Params: cma-512                 CMA is 512MB
3714         cma-448                 CMA is 448MB
3715         cma-384                 CMA is 384MB
3716         cma-320                 CMA is 320MB
3717         cma-256                 CMA is 256MB
3718         cma-192                 CMA is 192MB
3719         cma-128                 CMA is 128MB
3720         cma-96                  CMA is 96MB
3721         cma-64                  CMA is 64MB
3722         cma-size                CMA size in bytes, 4MB aligned
3723         cma-default             Use upstream's default value
3724         audio                   Enable or disable audio over HDMI0 (default
3725                                 "on")
3726         audio1                  Enable or disable audio over HDMI1 (default
3727                                 "on")
3728         noaudio                 Disable all HDMI audio (default "off")
3729         composite               Enable the composite output (disables all other
3730                                 outputs)
3731
3732
3733 Name:   vc4-kms-vga666
3734 Info:   Enable the VGA666 (resistor ladder ADC) for the vc4-kms-v3d driver.
3735         Requires vc4-kms-v3d to be loaded.
3736 Load:   dtoverlay=vc4-kms-vga666,<param>
3737 Params: ddc                     Enables GPIOs 0&1 as the I2C to read the EDID
3738                                 from the display. NB These are NOT 5V tolerant
3739                                 GPIOs, therefore level shifters are required.
3740
3741
3742 Name:   vga666
3743 Info:   Overlay for the Fen Logic VGA666 board
3744         This uses GPIOs 2-21 (so no I2C), and activates the output 2-3 seconds
3745         after the kernel has started.
3746         NOT for use with vc4-kms-v3d.
3747 Load:   dtoverlay=vga666
3748 Params: <None>
3749
3750
3751 Name:   vl805
3752 Info:   Overlay to enable a VIA VL805 USB3 controller on CM4 carriers
3753         Will be loaded automatically by up-to-date firmware if "VL805=1" is
3754         set in the EEPROM config.
3755 Load:   dtoverlay=vl805
3756 Params: <None>
3757
3758
3759 Name:   w1-gpio
3760 Info:   Configures the w1-gpio Onewire interface module.
3761         Use this overlay if you *don't* need a GPIO to drive an external pullup.
3762 Load:   dtoverlay=w1-gpio,<param>=<val>
3763 Params: gpiopin                 GPIO for I/O (default "4")
3764         pullup                  Now enabled by default (ignored)
3765
3766
3767 Name:   w1-gpio-pullup
3768 Info:   Configures the w1-gpio Onewire interface module.
3769         Use this overlay if you *do* need a GPIO to drive an external pullup.
3770 Load:   dtoverlay=w1-gpio-pullup,<param>=<val>
3771 Params: gpiopin                 GPIO for I/O (default "4")
3772         extpullup               GPIO for external pullup (default "5")
3773         pullup                  Now enabled by default (ignored)
3774
3775
3776 Name:   w5500
3777 Info:   Overlay for the Wiznet W5500 Ethernet Controller on SPI0
3778 Load:   dtoverlay=w5500,<param>=<val>
3779 Params: int_pin                 GPIO used for INT (default 25)
3780
3781         speed                   SPI bus speed (default 30000000)
3782
3783         cs                      SPI bus Chip Select (default 0)
3784
3785
3786 Name:   wittypi
3787 Info:   Configures the wittypi RTC module.
3788 Load:   dtoverlay=wittypi,<param>=<val>
3789 Params: led_gpio                GPIO for LED (default "17")
3790         led_trigger             Choose which activity the LED tracks (default
3791                                 "default-on")
3792
3793
3794 Name:   wm8960-soundcard
3795 Info:   Overlay for the Waveshare wm8960 soundcard
3796 Load:   dtoverlay=wm8960-soundcard,<param>=<val>
3797 Params: alsaname                Changes the card name in ALSA
3798         compatible              Changes the codec compatibility
3799
3800
3801 Troubleshooting
3802 ===============
3803
3804 If you are experiencing problems that you think are DT-related, enable DT
3805 diagnostic output by adding this to /boot/config.txt:
3806
3807     dtdebug=on
3808
3809 and rebooting. Then run:
3810
3811     sudo vcdbg log msg
3812
3813 and look for relevant messages.
3814
3815 Further reading
3816 ===============
3817
3818 This is only meant to be a quick introduction to the subject of Device Tree on
3819 Raspberry Pi. There is a more complete explanation here:
3820
3821 http://www.raspberrypi.org/documentation/configuration/device-tree.md