X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=arch%2Farm%2Fboot%2Fdts%2Foverlays%2FREADME;h=cfc61c1d0acc6303b69d76b4f79eb3fdc53114eb;hb=0233026961113958b30fc4691166de6af289b334;hp=cfc8bfbcbef86edeb22d828780820cdecb654043;hpb=ccd423338f2045a9e056c2fd65ee7765bd5edf02;p=platform%2Fkernel%2Flinux-rpi.git diff --git a/arch/arm/boot/dts/overlays/README b/arch/arm/boot/dts/overlays/README index cfc8bfb..cfc61c1 100644 --- a/arch/arm/boot/dts/overlays/README +++ b/arch/arm/boot/dts/overlays/README @@ -190,6 +190,9 @@ Params: to negotiate. Legal values are 10, 100 and 1000 (default 1000). Pi3B+ only. + hdmi Set to "off" to disable the HDMI interface + (default "on") + i2c_arm Set to "on" to enable the ARM's i2c interface (default "off") @@ -217,6 +220,11 @@ Params: krnbt_baudrate Set the baudrate of the PL011 UART when used with krnbt=on + pcie Set to "off" to disable the PCIe interface + (default "on") + (2711 only, but not applicable on CM4S) + N.B. USB-A ports on 4B are subsequently disabled + spi Set to "on" to enable the spi interfaces (default "off") @@ -227,6 +235,10 @@ Params: random Set to "on" to enable the hardware random number generator (default "on") + sd Set to "off" to disable the SD card (or eMMC on + non-lite SKU of CM4). + (default "on") + sd_overclock Clock (in MHz) to use when the MMC framework requests 50MHz @@ -582,6 +594,36 @@ Load: dtoverlay=applepi-dac Params: +Name: arducam-64mp +Info: Arducam 64MP camera module. + Uses Unicam 1, which is the standard camera connector on most Pi + variants. +Load: dtoverlay=arducam-64mp,= +Params: rotation Mounting rotation of the camera sensor (0 or + 180, default 0) + orientation Sensor orientation (0 = front, 1 = rear, + 2 = external, default external) + media-controller Configure use of Media Controller API for + configuring the sensor (default on) + cam0 Adopt the default configuration for CAM0 on a + Compute Module (CSI0, i2c_vc, and cam0_reg). + + +Name: arducam-pivariety +Info: Arducam Pivariety camera module. + Uses Unicam 1, which is the standard camera connector on most Pi + variants. +Load: dtoverlay=arducam-pivariety,= +Params: rotation Mounting rotation of the camera sensor (0 or + 180, default 0) + orientation Sensor orientation (0 = front, 1 = rear, + 2 = external, default external) + media-controller Configure use of Media Controller API for + configuring the sensor (default on) + cam0 Adopt the default configuration for CAM0 on a + Compute Module (CSI0, i2c_vc, and cam0_reg). + + Name: at86rf233 Info: Configures the Atmel AT86RF233 802.15.4 low-power WPAN transceiver, connected to spi0.0 @@ -601,6 +643,12 @@ Params: non-stop-clocks Keeps the clocks running even when the stream is paused or stopped (default off) +Name: audioinjector-bare-i2s +Info: Configures the audioinjector.net audio bare i2s soundcard +Load: dtoverlay=audioinjector-bare-i2s +Params: + + Name: audioinjector-isolated-soundcard Info: Configures the audioinjector.net isolated soundcard Load: dtoverlay=audioinjector-isolated-soundcard @@ -632,10 +680,13 @@ Info: Switches PWM sound output to GPIOs on the 40-pin header Load: dtoverlay=audremap,= Params: swap_lr Reverse the channel allocation, which will also swap the audio jack outputs (default off) - enable_jack Don't switch off the audio jack output - (default off) + enable_jack Don't switch off the audio jack output. Does + nothing on BCM2711 (default off) pins_12_13 Select GPIOs 12 & 13 (default) pins_18_19 Select GPIOs 18 & 19 + pins_40_41 Select GPIOs 40 & 41 + pins_40_45 Select GPIOs 40 & 45 (don't use on BCM2711 - the + pins are on different controllers) Name: balena-fin @@ -650,6 +701,80 @@ Info: This overlay is now deprecated - see i2c-sensor Load: +Name: camera-mux-2port +Info: Configures a 2 port camera multiplexer + Note that currently ALL IMX290 modules share a common clock, therefore + all modules will need to have the same clock frequency. +Load: dtoverlay=camera-mux-2port,= +Params: cam0-imx219 Select IMX219 for camera on port 0 + cam0-imx258 Select IMX258 for camera on port 0 + cam0-imx290 Select IMX290 for camera on port 0 + cam0-imx477 Select IMX477 for camera on port 0 + cam0-imx708 Select IMX708 for camera on port 0 + cam0-ov2311 Select OV2311 for camera on port 0 + cam0-ov5647 Select OV5647 for camera on port 0 + cam0-ov7251 Select OV7251 for camera on port 0 + cam0-ov9281 Select OV9281 for camera on port 0 + cam0-imx290-clk-freq Set clock frequency for an IMX290 on port 0 + cam1-imx219 Select IMX219 for camera on port 1 + cam1-imx258 Select IMX258 for camera on port 1 + cam1-imx290 Select IMX290 for camera on port 1 + cam1-imx477 Select IMX477 for camera on port 1 + cam1-imx708 Select IMX708 for camera on port 1 + cam1-ov2311 Select OV2311 for camera on port 1 + cam1-ov5647 Select OV5647 for camera on port 1 + cam1-ov7251 Select OV7251 for camera on port 1 + cam1-ov9281 Select OV9281 for camera on port 1 + cam1-imx290-clk-freq Set clock frequency for an IMX290 on port 1 + + +Name: camera-mux-4port +Info: Configures a 4 port camera multiplexer + Note that currently ALL IMX290 modules share a common clock, therefore + all modules will need to have the same clock frequency. +Load: dtoverlay=camera-mux-4port,= +Params: cam0-imx219 Select IMX219 for camera on port 0 + cam0-imx258 Select IMX258 for camera on port 0 + cam0-imx290 Select IMX290 for camera on port 0 + cam0-imx477 Select IMX477 for camera on port 0 + cam0-imx708 Select IMX708 for camera on port 0 + cam0-ov2311 Select OV2311 for camera on port 0 + cam0-ov5647 Select OV5647 for camera on port 0 + cam0-ov7251 Select OV7251 for camera on port 0 + cam0-ov9281 Select OV9281 for camera on port 0 + cam0-imx290-clk-freq Set clock frequency for an IMX290 on port 0 + cam1-imx219 Select IMX219 for camera on port 1 + cam1-imx258 Select IMX258 for camera on port 1 + cam1-imx290 Select IMX290 for camera on port 1 + cam1-imx477 Select IMX477 for camera on port 1 + cam1-imx708 Select IMX708 for camera on port 1 + cam1-ov2311 Select OV2311 for camera on port 1 + cam1-ov5647 Select OV5647 for camera on port 1 + cam1-ov7251 Select OV7251 for camera on port 1 + cam1-ov9281 Select OV9281 for camera on port 1 + cam1-imx290-clk-freq Set clock frequency for an IMX290 on port 1 + cam2-imx219 Select IMX219 for camera on port 2 + cam2-imx258 Select IMX258 for camera on port 2 + cam2-imx290 Select IMX290 for camera on port 2 + cam2-imx477 Select IMX477 for camera on port 2 + cam2-imx708 Select IMX708 for camera on port 2 + cam2-ov2311 Select OV2311 for camera on port 2 + cam2-ov5647 Select OV5647 for camera on port 2 + cam2-ov7251 Select OV7251 for camera on port 2 + cam2-ov9281 Select OV9281 for camera on port 2 + cam2-imx290-clk-freq Set clock frequency for an IMX290 on port 2 + cam3-imx219 Select IMX219 for camera on port 3 + cam3-imx258 Select IMX258 for camera on port 3 + cam3-imx290 Select IMX290 for camera on port 3 + cam3-imx477 Select IMX477 for camera on port 3 + cam3-imx708 Select IMX708 for camera on port 3 + cam3-ov2311 Select OV2311 for camera on port 3 + cam3-ov5647 Select OV5647 for camera on port 3 + cam3-ov7251 Select OV7251 for camera on port 3 + cam3-ov9281 Select OV9281 for camera on port 3 + cam3-imx290-clk-freq Set clock frequency for an IMX290 on port 3 + + Name: cap1106 Info: Enables the ability to use the cap1106 touch sensor as a keyboard Load: dtoverlay=cap1106,= @@ -662,6 +787,12 @@ Load: dtoverlay=chipdip-dac Params: +Name: cirrus-wm5102 +Info: Configures the Cirrus Logic Audio Card +Load: dtoverlay=cirrus-wm5102 +Params: + + Name: cma Info: Set custom CMA sizes, only use if you know what you are doing, might clash with other overlays like vc4-fkms-v3d and vc4-kms-v3d. @@ -685,6 +816,12 @@ Load: dtoverlay=cutiepi-panel Params: +Name: dacberry400 +Info: Configures the dacberry400 add on soundcard +Load: dtoverlay=dacberry400 +Params: + + Name: dht11 Info: Overlay for the DHT11/DHT21/DHT22 humidity/temperature sensors Also sometimes found with the part number(s) AM230x. @@ -693,6 +830,12 @@ Params: gpiopin GPIO connected to the sensor's DATA output. (default 4) +Name: dionaudio-kiwi +Info: Configures the Dion Audio KIWI STREAMER +Load: dtoverlay=dionaudio-kiwi +Params: + + Name: dionaudio-loco Info: Configures the Dion Audio LOCO DAC-AMP Load: dtoverlay=dionaudio-loco @@ -1011,6 +1154,26 @@ Load: dtoverlay=fsm-demo,= Params: fsm_debug Enable debug logging (default off) +Name: gc9a01 +Info: Enables GalaxyCore's GC9A01 single chip driver based displays on + SPI0 as fb1, using GPIOs DC=25, RST=27 and BL=18 (physical + GPIO header pins 22, 13 and 12 respectively) in addition to the + SPI0 pins DIN=10, CLK=11 and CS=8 (physical GPIO header pins 19, + 23 and 24 respectively). +Load: dtoverlay=gc9a01,= +Params: speed Display SPI bus speed + + rotate Display rotation {0,90,180,270} + + width Width of the display + + height Height of the display + + fps Delay between frame updates + + debug Debug output level {0-7} + + Name: ghost-amp Info: An overlay for the Ghost amplifier. Load: dtoverlay=ghost-amp,= @@ -1038,6 +1201,20 @@ Load: dtoverlay=gpio-fan,= Params: gpiopin GPIO used to control the fan (default 12) temp Temperature at which the fan switches on, in millicelcius (default 55000) + hyst Temperature delta (in millicelcius) below + temp at which the fan will drop to minrpm + (default 10000) + + +Name: gpio-hog +Info: Activate a "hog" for a GPIO - request that the kernel configures it as + an output, driven low or high as indicated by the presence or absence + of the active_low parameter. Note that a hogged GPIO is not available + to other drivers or for gpioset/gpioget. +Load: dtoverlay=gpio-hog,= +Params: gpio GPIO pin to hog (default 26) + active_low If set, the hog drives the GPIO low (defaults + to off - the GPIO is driven high) Name: gpio-ir @@ -1335,6 +1512,12 @@ Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec Will be overwritten by ALSA user settings. +Name: hifiberry-amp3 +Info: Configures the HifiBerry Amp3 audio card +Load: dtoverlay=hifiberry-amp3 +Params: + + Name: hifiberry-dac Info: Configures the HifiBerry DAC audio cards Load: dtoverlay=hifiberry-dac @@ -1509,6 +1692,51 @@ Load: dtoverlay=i2c-bcm2708 Params: +Name: i2c-fan +Info: Adds support for a number of I2C fan controllers +Load: dtoverlay=i2c-fan,= +Params: addr Sets the address for the fan controller. Note + that the device must be configured to use the + specified address. + + i2c0 Choose the I2C0 bus on GPIOs 0&1 + + i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45 + + i2c3 Choose the I2C3 bus (configure with the i2c3 + overlay - BCM2711 only) + + i2c4 Choose the I2C3 bus (configure with the i2c3 + overlay - BCM2711 only) + + i2c5 Choose the I2C5 bus (configure with the i2c4 + overlay - BCM2711 only) + + i2c6 Choose the I2C6 bus (configure with the i2c6 + overlay - BCM2711 only) + + minpwm PWM setting for the fan when the SoC is below + mintemp (range 0-255. default 0) + maxpwm PWM setting for the fan when the SoC is above + maxtemp (range 0-255. default 255) + midtemp Temperature (in millicelcius) at which the fan + begins to speed up (default 50000) + + midtemp_hyst Temperature delta (in millicelcius) below + mintemp at which the fan will drop to minrpm + (default 2000) + + maxtemp Temperature (in millicelcius) at which the fan + will be held at maxrpm (default 70000) + + maxtemp_hyst Temperature delta (in millicelcius) below + maxtemp at which the fan begins to slow down + (default 2000) + + emc2301 Select the Microchip EMC230x controller family + - EMC2301, EMC2302, EMC2303, EMC2305. + + Name: i2c-gpio Info: Adds support for software i2c controller on gpio pins Load: dtoverlay=i2c-gpio,= @@ -1589,6 +1817,10 @@ Params: abx80x Select one of the ABx80x family: rv3028 Select the Micro Crystal RV3028 device + rv3032 Select the Micro Crystal RV3032 device + + rv8803 Select the Micro Crystal RV8803 device + sd3078 Select the ZXW Shenzhen whwave SD3078 device s35390a Select the ABLIC S35390A device @@ -1597,6 +1829,18 @@ Params: abx80x Select one of the ABx80x family: i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45 + i2c3 Choose the I2C3 bus (configure with the i2c3 + overlay - BCM2711 only) + + i2c4 Choose the I2C3 bus (configure with the i2c3 + overlay - BCM2711 only) + + i2c5 Choose the I2C5 bus (configure with the i2c4 + overlay - BCM2711 only) + + i2c6 Choose the I2C6 bus (configure with the i2c6 + overlay - BCM2711 only) + addr Sets the address for the RTC. Note that the device must be configured to use the specified address. @@ -1659,6 +1903,10 @@ Params: abx80x Select one of the ABx80x family: rv3028 Select the Micro Crystal RV3028 device + rv3032 Select the Micro Crystal RV3032 device + + rv8803 Select the Micro Crystal RV8803 device + sd3078 Select the ZXW Shenzhen whwave SD3078 device s35390a Select the ABLIC S35390A device @@ -1698,6 +1946,9 @@ Params: addr Set the address for the BH1750, BME280, BME680, BMP280, CCS811, DS1621, HDC100X, LM75, SHT3x or TMP102 + aht10 Select the Aosong AHT10 temperature and humidity + sensor + bh1750 Select the Rohm BH1750 ambient light sensor Valid addresses 0x23 or 0x5c, default 0x23 @@ -1728,6 +1979,15 @@ Params: addr Set the address for the BH1750, BME280, BME680, int_pin Set the GPIO to use for interrupts (max30102 only) + jc42 Select any of the many JEDEC JC42.4-compliant + temperature sensors, including: + ADT7408, AT30TS00, CAT34TS02, CAT6095, + MAX6604, MCP9804, MCP9805, MCP9808, + MCP98242, MCP98243, MCP98244, MCP9843, + SE97, SE98, STTS424(E), STTS2002, STTS3000, + TSE2002, TSE2004, TS3000, and TS3001. + The default address is 0x18. + lm75 Select the Maxim LM75 temperature sensor Valid addresses 0x48-0x4f, default 0x4f @@ -1739,6 +1999,12 @@ Params: addr Set the address for the BH1750, BME280, BME680, max30102 Select the Maxim Integrated MAX30102 heart-rate and blood-oxygen sensor + mcp980x Select the Maxim MCP980x range of temperature + sensors (i.e. MCP9800, MCP9801, MCP9802 and + MCP9803). N.B. For MCP9804, MCP9805 and MCP9808, + use the "jc42" option. + Valid addresses are 0x18-0x1f (default 0x18) + sht3x Select the Sensiron SHT3x temperature and humidity sensor. Valid addresses 0x44-0x45, default 0x44 @@ -1761,6 +2027,22 @@ Params: addr Set the address for the BH1750, BME280, BME680, veml6070 Select the Vishay VEML6070 ultraviolet light sensor + i2c0 Choose the I2C0 bus on GPIOs 0&1 + + i2c_csi_dsi Choose the I2C0 bus on GPIOs 44&45 + + i2c3 Choose the I2C3 bus (configure with the i2c3 + overlay - BCM2711 only) + + i2c4 Choose the I2C3 bus (configure with the i2c3 + overlay - BCM2711 only) + + i2c5 Choose the I2C5 bus (configure with the i2c4 + overlay - BCM2711 only) + + i2c6 Choose the I2C6 bus (configure with the i2c6 + overlay - BCM2711 only) + Name: i2c0 Info: Change i2c0 pin usage. Not all pin combinations are usable on all @@ -1839,6 +2121,12 @@ Params: pins_0_1 Use GPIOs 0 and 1 "100000") +Name: i2s-dac +Info: Configures any passive I2S DAC soundcard. +Load: dtoverlay=i2s-dac +Params: + + Name: i2s-gpio28-31 Info: move I2S function block to GPIO 28 to 31 Load: dtoverlay=i2s-gpio28-31 @@ -1869,13 +2157,31 @@ Params: rotation Mounting rotation of the camera sensor (0 or configuring the sensor (default on) cam0 Adopt the default configuration for CAM0 on a Compute Module (CSI0, i2c_vc, and cam0_reg). + vcm Configure a VCM focus drive on the sensor. + + +Name: imx258 +Info: Sony IMX258 camera module. + Uses Unicam 1, which is the standard camera connector on most Pi + variants. +Load: dtoverlay=imx258,= +Params: rotation Mounting rotation of the camera sensor (0 or + 180, default 180) + orientation Sensor orientation (0 = front, 1 = rear, + 2 = external, default external) + media-controller Configure use of Media Controller API for + configuring the sensor (default on) + cam0 Adopt the default configuration for CAM0 on a + Compute Module (CSI0, i2c_vc, and cam0_reg). + vcm Configure a VCM focus drive on the sensor. + 4lane Enable 4 CSI2 lanes. This requires a Compute + Module (1, 3, or 4). Name: imx290 Info: Sony IMX290 camera module. Uses Unicam 1, which is the standard camera connector on most Pi - variants. NB This currently uses 4 CSI2 data lanes and therefore will - only work on a CM. + variants. Load: dtoverlay=imx290, Params: 4lane Enable 4 CSI2 lanes. This requires a Compute Module (1, 3, or 4). @@ -1895,6 +2201,47 @@ Params: 4lane Enable 4 CSI2 lanes. This requires a Compute Compute Module (CSI0, i2c_vc, and cam0_reg). +Name: imx296 +Info: Sony IMX296 camera module. + Uses Unicam 1, which is the standard camera connector on most Pi + variants. +Load: dtoverlay=imx296,= +Params: rotation Mounting rotation of the camera sensor (0 or + 180, default 180) + orientation Sensor orientation (0 = front, 1 = rear, + 2 = external, default external) + media-controller Configure use of Media Controller API for + configuring the sensor (default on) + cam0 Adopt the default configuration for CAM0 on a + Compute Module (CSI0, i2c_vc, and cam0_reg). + clock-frequency Sets the clock frequency to match that used on + the board, which should be one of 54000000 + (the default), 37125000 or 74250000. + + +Name: imx327 +Info: Sony IMX327 camera module. + Uses Unicam 1, which is the standard camera connector on most Pi + variants. +Load: dtoverlay=imx327, +Params: 4lane Enable 4 CSI2 lanes. This requires a Compute + Module (1, 3, or 4). + clock-frequency Sets the clock frequency to match that used on + the board. + Modules from Vision Components use 37.125MHz + (the default), whilst those from Innomaker use + 74.25MHz. + mono Denote that the module is a mono sensor. + orientation Sensor orientation (0 = front, 1 = rear, + 2 = external, default external) + rotation Mounting rotation of the camera sensor (0 or + 180, default 0) + media-controller Configure use of Media Controller API for + configuring the sensor (default on) + cam0 Adopt the default configuration for CAM0 on a + Compute Module (CSI0, i2c_vc, and cam0_reg). + + Name: imx378 Info: Sony IMX378 camera module. Uses Unicam 1, which is the standard camera connector on most Pi @@ -1910,6 +2257,29 @@ Params: rotation Mounting rotation of the camera sensor (0 or Compute Module (CSI0, i2c_vc, and cam0_reg). +Name: imx462 +Info: Sony IMX462 camera module. + Uses Unicam 1, which is the standard camera connector on most Pi + variants. +Load: dtoverlay=imx462, +Params: 4lane Enable 4 CSI2 lanes. This requires a Compute + Module (1, 3, or 4). + clock-frequency Sets the clock frequency to match that used on + the board. + Modules from Vision Components use 37.125MHz + (the default), whilst those from Innomaker use + 74.25MHz. + mono Denote that the module is a mono sensor. + orientation Sensor orientation (0 = front, 1 = rear, + 2 = external, default external) + rotation Mounting rotation of the camera sensor (0 or + 180, default 0) + media-controller Configure use of Media Controller API for + configuring the sensor (default on) + cam0 Adopt the default configuration for CAM0 on a + Compute Module (CSI0, i2c_vc, and cam0_reg). + + Name: imx477 Info: Sony IMX477 camera module. Uses Unicam 1, which is the standard camera connector on most Pi @@ -1940,6 +2310,21 @@ Params: rotation Mounting rotation of the camera sensor (0 or Compute Module (CSI0, i2c_vc, and cam0_reg). +Name: imx708 +Info: Sony IMX708 camera module. + Uses Unicam 1, which is the standard camera connector on most Pi + variants. +Load: dtoverlay=imx708,= +Params: rotation Mounting rotation of the camera sensor (0 or + 180, default 180) + vcm Select lens driver state. Default is enabled, + but vcm=off will disable. + media-controller Configure use of Media Controller API for + configuring the sensor (default on) + cam0 Adopt the default configuration for CAM0 on a + Compute Module (CSI0, i2c_vc, and cam0_reg). + + Name: iqaudio-codec Info: Configures the IQaudio Codec audio card Load: dtoverlay=iqaudio-codec @@ -2385,6 +2770,73 @@ Params: krnbt Set to "on" to enable autoprobing of Bluetooth driver without need of hciattach/btattach +Name: mipi-dbi-spi +Info: Overlay for SPI-connected MIPI DBI displays using the panel-mipi-dbi + driver. The driver will load a file /lib/firmware/panel.bin containing + the initialisation commands. + + Example: + dtoverlay=mipi-dbi-spi,spi0-0,speed=70000000 + dtparam=width=320,height=240 + dtparam=reset-gpio=23,dc-gpio=24 + dtparam=backlight-gpio=18 + + Compared to fbtft panel-mipi-dbi runs pixel data at spi-max-frequency + and init commands at 10MHz. This makes it possible to push the envelope + without messing up the controller configuration due to command + transmission errors. + + For devices on spi1 or spi2, the interfaces should be enabled + with one of the spi1-1/2/3cs and/or spi2-1/2/3cs overlays. + + See https://github.com/notro/panel-mipi-dbi/wiki for more info. + +Load: dtoverlay=mipi-dbi-spi,= +Params: + compatible Set the compatible string to load a different + firmware file. Both the panel compatible value + used to load the firmware file and the value + used to load the driver has to be set having a + NUL (\0) separator between them. + Example: + dtparam=compatible=mypanel\0panel-mipi-dbi-spi + spi- Configure device at spi, cs + (boolean, required) + speed SPI bus speed in Hz (default 32000000) + cpha Shifted SPI clock phase (CPHA) mode + cpol Inverse SPI clock polarity (CPOL) mode + write-only Controller is not readable + (ie. MISO is not wired up). + + width Panel width in pixels (required) + height Panel height in pixels (required) + width-mm Panel width in mm + height-mm Panel height in mm + x-offset Panel x-offset in controller RAM + y-offset Panel y-offset in controller RAM + + clock-frequency Panel clock frequency in Hz + (optional, just informational). + + reset-gpio GPIO pin to be used for RESET + dc-gpio GPIO pin to be used for D/C + + backlight-gpio GPIO pin to be used for backlight control + (default of none). + backlight-pwm PWM channel to be used for backlight control + (default of none). NB Disables audio headphone + output as that also uses PWM. + backlight-pwm-chan Choose channel on &pwm node for backlight + control (default 0). + backlight-pwm-gpio GPIO pin to be used for the PWM backlight. See + pwm-2chan for valid options (default 18). + backlight-pwm-func Pin function of GPIO used for the PWM backlight. + See pwm-2chan for valid options (default 2). + backlight-def-brightness + Set the default brightness. Normal range 1-16. + (default 16). + + Name: mlx90640 Info: Overlay for i2c connected mlx90640 thermal camera Load: dtoverlay=mlx90640 @@ -2421,6 +2873,21 @@ Params: speed Display SPI bus speed xohms Touchpanel sensitivity (X-plate resistance) +Name: ov2311 +Info: Omnivision OV2311 camera module. + Uses Unicam 1, which is the standard camera connector on most Pi + variants. +Load: dtoverlay=ov2311,= +Params: rotation Mounting rotation of the camera sensor (0 or + 180, default 0) + orientation Sensor orientation (0 = front, 1 = rear, + 2 = external, default external) + media-controller Configure use of Media Controller API for + configuring the sensor (default on) + cam0 Adopt the default configuration for CAM0 on a + Compute Module (CSI0, i2c_vc, and cam0_reg). + + Name: ov5647 Info: Omnivision OV5647 camera module. Uses Unicam 1, which is the standard camera connector on most Pi @@ -2434,6 +2901,7 @@ Params: rotation Mounting rotation of the camera sensor (0 or configuring the sensor (default on) cam0 Adopt the default configuration for CAM0 on a Compute Module (CSI0, i2c_vc, and cam0_reg). + vcm Configure a VCM focus drive on the sensor. Name: ov7251 @@ -2677,6 +3145,10 @@ Params: speed Display SPI bus speed debug Debug output level {0-7} + drm Force the use of the mi0283qt DRM driver (by + default the ili9340 framebuffer driver will + be used in preference if available) + Name: pitft35-resistive Info: Adafruit PiTFT 3.5" resistive touch screen @@ -2689,6 +3161,10 @@ Params: speed Display SPI bus speed debug Debug output level {0-7} + drm Force the use of the hx8357d DRM driver (by + default the fb_hx8357d framebuffer driver will + be used in preference if available) + Name: pps-gpio Info: Configures the pps-gpio (pulse-per-second time signal via GPIO). @@ -2699,6 +3175,14 @@ Params: gpiopin Input GPIO (default "18") off) capture_clear Generate clear events on the trailing edge (default off) + pull Desired pull-up/down state (off, down, up) + Default is "off". + + +Name: proto-codec +Info: Configures the PROTO Audio Codec card +Load: dtoverlay=proto-codec +Params: Name: pwm @@ -2754,6 +3238,24 @@ Params: gpio_pin Output GPIO (default 18) func Pin function (default 2 = Alt5) +Name: pwm1 +Info: Configures one or two PWM channel on PWM1 (BCM2711 only) + N.B.: + 1) The onboard analogue audio output uses both PWM channels. + 2) So be careful mixing audio and PWM. + Note that even when only one pin is enabled, both channels are available + from the PWM driver, so be careful to use the correct one. +Load: dtoverlay=pwm1,= +Params: clock PWM clock frequency (informational) + pins_40 Enable channel 0 (PWM1_0) on GPIO 40 + pins_41 Enable channel 1 (PWM1_1) on GPIO 41 + pins_40_41 Enable channels 0 (PWM1_0) and 1 (PW1_1) on + GPIOs 40 and 41 (default) + pull_up Enable pull-ups on the PWM pins (default) + pull_down Enable pull-downs on the PWM pins + pull_off Disable pulls on the PWM pins + + Name: qca7000 Info: in-tech's Evaluation Board for PLC Stamp micro This uses spi0 and a separate GPIO interrupt to connect the QCA7000. @@ -2773,6 +3275,35 @@ Params: baudrate Set the baudrate for the UART (default "115200") +Name: ramoops +Info: Enable the preservation of crash logs across a reboot. With + systemd-pstore enabled (as it is on Raspberry Pi OS) the crash logs + are moved to /var/lib/systemd/pstore/ on reboot. +Load: dtoverlay=ramoops,= +Params: base-addr Where to place the capture buffer (default + 0x0b000000) + total-size How much memory to allocate altogether (in + bytes - default 64kB) + record-size How much space to use for each capture, i.e. + total-size / record-size = number of captures + (default 16kB) + console-size Size of non-panic dmesg captures (default 0) + + +Name: ramoops-pi4 +Info: The version of the ramoops overlay for the Pi 4 family. It should be + loaded automatically if dtoverlay=ramoops is specified on a Pi 4. +Load: dtoverlay=ramoops-pi4,= +Params: base-addr Where to place the capture buffer (default + 0x0b000000) + total-size How much memory to allocate altogether (in + bytes - default 64kB) + record-size How much space to use for each capture, i.e. + total-size / record-size = number of captures + (default 16kB) + console-size Size of non-panic dmesg captures (default 0) + + Name: rotary-encoder Info: Overlay for GPIO connected rotary encoder. Load: dtoverlay=rotary-encoder,= @@ -2812,27 +3343,88 @@ Params: Name: rpi-cirrus-wm5102 -Info: Configures the Cirrus Logic Audio Card -Load: dtoverlay=rpi-cirrus-wm5102 +Info: This overlay has been renamed to cirrus-wm5102 +Load: + + +Name: rpi-codeczero +Info: Configures the Raspberry Pi Codec Zero sound card +Load: dtoverlay=rpi-codeczero Params: Name: rpi-dac -Info: Configures the RPi DAC audio card -Load: dtoverlay=rpi-dac -Params: +Info: This overlay has been renaamed to i2s-dac. +Load: + + +Name: rpi-dacplus +Info: Configures the Raspberry Pi DAC+ card +Load: dtoverlay=rpi-dacplus,= +Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec + digital volume control. Enable by adding + "dtparam=24db_digital_gain" to config.txt + before any "dtoverlay" lines. + The default behaviour is that the digital + volume control is limited to a maximum of + 0dB. ie. it can attenuate but not provide + gain. For most users, this will be desired + as it will prevent clipping. By appending + the 24db_digital_gain parameter, the digital + volume control will allow up to 24dB of + gain. If this parameter is enabled, it is the + responsibility of the user to ensure that + the digital volume control is set to a value + that does not result in clipping/distortion! + + +Name: rpi-dacpro +Info: Configures the Raspberry Pi DAC Pro sound card +Load: dtoverlay=rpi-dacpro,= +Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec + digital volume control. Enable by adding + "dtparam=24db_digital_gain" to config.txt + before any "dtoverlay" lines. + The default behaviour is that the digital + volume control is limited to a maximum of + 0dB. ie. it can attenuate but not provide + gain. For most users, this will be desired + as it will prevent clipping. By appending + the 24db_digital_gain parameter, the digital + volume control will allow up to 24dB of + gain. If this parameter is enabled, it is the + responsibility of the user to ensure that + the digital volume control is set to a value + that does not result in clipping/distortion! + + +Name: rpi-digiampplus +Info: Configures the Raspberry Pi DigiAMP+ sound card +Load: dtoverlay=rpi-digiampplus,= +Params: 24db_digital_gain Allow gain to be applied via the PCM512x codec + digital volume control. Enable by adding + "dtparam=24db_digital_gain" to config.txt + before any "dtoverlay" lines. + The default behaviour is that the digital + volume control is limited to a maximum of + 0dB. ie. it can attenuate but not provide + gain. For most users, this will be desired + as it will prevent clipping. By appending + the 24db_digital_gain parameter, the digital + volume control will allow up to 24dB of + gain. If this parameter is enabled, it is the + responsibility of the user to ensure that + the digital volume control is set to a value + that does not result in clipping/distortion! + auto_mute_amp If specified, unmute/mute the DigiAMP+ when + starting/stopping audio playback (default "on"). + unmute_amp If specified, unmute the DigiAMP+ amp once when + the DAC driver module loads (default "off"). Name: rpi-display -Info: RPi-Display - 2.8" Touch Display by Watterott -Load: dtoverlay=rpi-display,= -Params: speed Display SPI bus speed - rotate Display rotation {0,90,180,270} - fps Delay between frame updates - debug Debug output level {0-7} - xohms Touchpanel sensitivity (X-plate resistance) - swapxy Swap x and y axis - backlight Change backlight GPIO pin {e.g. 12, 18} +Info: This overlay has been renamed to watterott-display +Load: Name: rpi-ft5406 @@ -2892,9 +3484,8 @@ Params: poe_fan_temp0 Temperature (in millicelcius) at which the fan Name: rpi-proto -Info: Configures the RPi Proto audio card -Load: dtoverlay=rpi-proto -Params: +Info: This overlay has been renamaed to proto-codec. +Load: Name: rpi-sense @@ -2903,6 +3494,12 @@ Load: dtoverlay=rpi-sense Params: +Name: rpi-sense-v2 +Info: Raspberry Pi Sense HAT v2 +Load: dtoverlay=rpi-sense-v2 +Params: + + Name: rpi-tv Info: Raspberry Pi TV HAT Load: dtoverlay=rpi-tv @@ -2910,10 +3507,9 @@ Params: Name: rpivid-v4l2 -Info: Load the V4L2 stateless video decoder driver for the HEVC block, - disabling the memory mapped devices in the process. -Load: dtoverlay=rpivid-v4l2 -Params: +Info: This overlay has been deprecated and deleted as the V4L2 stateless + video decoder driver is enabled by default. +Load: Name: rra-digidac1-wm8741-audio @@ -3649,8 +4245,14 @@ Params: clock-frequency Display clock frequency (Hz) width-mm Define the screen width in mm height-mm Define the screen height in mm rgb565 Change to RGB565 output on GPIOs 0-19 + rgb565-padhi Change to RGB565 output on GPIOs 0-8, 12-17, and + 20-24 + bgr666 Change to BGR666 output on GPIOs 0-21. + bgr666-padhi Change to BGR666 output on GPIOs 0-9, 12-17, and + 20-25 rgb666-padhi Change to RGB666 output on GPIOs 0-9, 12-17, and 20-25 + bgr888 Change to BGR888 output on GPIOs 0-27 rgb888 Change to RGB888 output on GPIOs 0-27 bus-format Override the bus format for a MEDIA_BUS_FMT_* value. NB also overridden by rgbXXX overrides. @@ -3673,6 +4275,40 @@ Params: clock-frequency Display clock frequency (Hz) backlight-def-brightness Set the default brightness. Normal range 1-16. (default 16). + rotate Display rotation {0,90,180,270} (default 0) + + +Name: vc4-kms-dpi-hyperpixel2r +Info: Enable the KMS drivers for the Pimoroni HyperPixel2 Round DPI display. + Requires vc4-kms-v3d to be loaded. +Load: dtoverlay=vc4-kms-dpi-hyperpixel2r,= +Params: disable-touch Disables the touch controller + touchscreen-inverted-x Inverts X direction of touch controller + touchscreen-inverted-y Inverts Y direction of touch controller + touchscreen-swapped-x-y Swaps X & Y axes of touch controller + rotate Display rotation {0,90,180,270} (default 0) + + +Name: vc4-kms-dpi-hyperpixel4 +Info: Enable the KMS drivers for the Pimoroni HyperPixel4 DPI display. + Requires vc4-kms-v3d to be loaded. +Load: dtoverlay=vc4-kms-dpi-hyperpixel4,= +Params: disable-touch Disables the touch controller + touchscreen-inverted-x Inverts X direction of touch controller + touchscreen-inverted-y Inverts Y direction of touch controller + touchscreen-swapped-x-y Swaps X & Y axes of touch controller + rotate Display rotation {0,90,180,270} (default 0) + + +Name: vc4-kms-dpi-hyperpixel4sq +Info: Enable the KMS drivers for the Pimoroni HyperPixel4 Square DPI display. + Requires vc4-kms-v3d to be loaded. +Load: dtoverlay=vc4-kms-dpi-hyperpixel4sq,= +Params: disable-touch Disables the touch controller + touchscreen-inverted-x Inverts X direction of touch controller + touchscreen-inverted-y Inverts Y direction of touch controller + touchscreen-swapped-x-y Swaps X & Y axes of touch controller + rotate Display rotation {0,90,180,270} (default 0) Name: vc4-kms-dpi-panel @@ -3681,6 +4317,7 @@ Info: Enable a preconfigured KMS DPI panel. Load: dtoverlay=vc4-kms-dpi-panel,= Params: at056tn53v1 Enable an Innolux 5.6in VGA TFT kippah-7inch Enable an Adafruit Kippah with 7inch panel. + mzp280 Enable a Geekworm MZP280 panel. backlight-gpio Defines a GPIO to be used for backlight control (default of none). backlight-pwm Defines a PWM channel to be used for backlight @@ -3700,6 +4337,7 @@ Params: at056tn53v1 Enable an Innolux 5.6in VGA TFT backlight-def-brightness Set the default brightness. Normal range 1-16. (default 16). + rotate Display rotation {0,90,180,270} (default 0) Name: vc4-kms-dsi-7inch @@ -3759,6 +4397,7 @@ Params: cma-512 CMA is 512MB (needs 1GB) noaudio Disable all HDMI audio (default "off") composite Enable the composite output (default "off") N.B. Disables all other outputs on a Pi 4. + nohdmi Disable HDMI output Name: vc4-kms-v3d-pi4 @@ -3782,6 +4421,10 @@ Params: cma-512 CMA is 512MB noaudio Disable all HDMI audio (default "off") composite Enable the composite output (disables all other outputs) + nohdmi Disable both HDMI 0 & 1 outputs + nohdmi0 Disable HDMI 0 output + nohdmi1 Disable HDMI 1 output + Name: vc4-kms-vga666 @@ -3837,6 +4480,60 @@ Params: int_pin GPIO used for INT (default 25) cs SPI bus Chip Select (default 0) +Name: watterott-display +Info: Watterott RPi-Display - 2.8" Touch Display + Linux has 2 drivers that support this display and this overlay supports + both. + + Examples: + fbtft/fb_ili9341: dtoverlay=watterott-display + drm/mi0283qt: dtoverlay=watterott-display,drm,backlight-pwm,rotate=180 + + Some notable differences with the DRM driver compared to fbtft: + - The display is turned on when it's first used and not on driver load + as with fbtft. So if nothing uses the display it stays off. + - Can run with a higher SPI clock increasing framerate. This is possible + since the driver avoids messing up the controller configuration due to + transmission errors by running config commands at 10MHz and only pixel + data at full speed (occasional pixel glitch might occur). + - PWM backlight is supported. + +Load: dtoverlay=watterott-display,= +Params: speed Display SPI bus speed + rotate Display rotation {0,90,180,270} + fps Delay between frame updates (fbtft only) + debug Debug output level {0-7} (fbtft only) + xohms Touchpanel sensitivity (X-plate resistance) + swapxy Swap x and y axis + backlight Change backlight GPIO pin {e.g. 12, 18} + (fbtft only) + drm Use DRM/KMS driver mi0283qt instead of fbtft. + Set the SPI clock to 70MHz. + This has to be the first parameter. + backlight-pwm Use pwm for backlight (drm only). NB: Disables + audio headphone output as that also uses PWM. + + +Name: waveshare-can-fd-hat-mode-a +Info: Overlay for the Waveshare 2-Channel Isolated CAN FD Expansion HAT + for Raspberry Pi, Multi Protections. Use this overlay when the + HAT is configured in Mode A (Default), with can0 on spi0.0 + and can1 on spi1.0. + https://www.waveshare.com/2-ch-can-fd-hat.htm +Load: dtoverlay=waveshare-can-fd-hat-mode-a +Params: + + +Name: waveshare-can-fd-hat-mode-b +Info: Overlay for the Waveshare 2-Channel Isolated CAN FD Expansion HAT + for Raspberry Pi, Multi Protections. Use this overlay when the + HAT is configured in Mode B (requires hardware modification), with + can0 on spi0.0 and can1 on spi0.1. + https://www.waveshare.com/2-ch-can-fd-hat.htm +Load: dtoverlay=waveshare-can-fd-hat-mode-b +Params: + + Name: wittypi Info: Configures the wittypi RTC module. Load: dtoverlay=wittypi,=