zephyr,mipi-dbi-spi

Vendor: Zephyr-specific binding

Note

An implementation of a driver matching this compatible is available in drivers/mipi_dbi/mipi_dbi_spi.c.

Description

These nodes are “mipi-dbi” bus nodes.

MIPI-DBI Mode C compatible SPI controller. This driver emulates MIPI DBI
mode C using a SPI controller and GPIO pins

Properties

Node specific properties

Properties not inherited from the base binding file.

Name

Type

Details

spi-dev

phandle

 
SPI device to use for data transfers with MIPI DBI commands. This SPI
device should be connected to the MIPI DBI display.

This property is required.

dc-gpios

phandle-array

 
Data/command gpio pin. Required when using 4 wire SPI mode (Mode C1).
Set to low when sending a command, or high when sending data.

reset-gpios

phandle-array

 
Reset GPIO pin. Set high to reset the display

xfr-min-bits

int

 
On rare types of SPI interfaces, discrete shift registers can be found whose task is to convert the serial SPI bit stream to the parallel MCU interface with clock and bit accuracy. Typically, these are 16 bits wide.
Use the macros, not the actual enum value. Here is the concordance list (see dt-bindings/mipi_dbi/mipi_dbi.h) 8     MIPI_DBI_SPI_XFR_8BIT 16     MIPI_DBI_SPI_XFR_16BIT

Default value: 8

Legal values: 8, 16

write-only

boolean

 
Only writes to display controller, do not perform reads.
If all controllers are write-only, read functions will be
optimized out for size.
It can also be used as an alternative to half duplex when
only one data line is connected.

clock-frequency

int

 
Clock frequency of the SCL signal of the MBI-DBI peripheral, in Hz

pinctrl-0

phandles

 
Pin configuration/s for the first state. Content is specific to the
selected pin controller driver implementation.

pinctrl-1

phandles

 
Pin configuration/s for the second state. See pinctrl-0.

pinctrl-2

phandles

 
Pin configuration/s for the third state. See pinctrl-0.

pinctrl-3

phandles

 
Pin configuration/s for the fourth state. See pinctrl-0.

pinctrl-4

phandles

 
Pin configuration/s for the fifth state. See pinctrl-0.

pinctrl-names

string-array

 
Names for the provided states. The number of names needs to match the
number of states.

Deprecated node specific properties

Deprecated properties not inherited from the base binding file.

(None)

Base properties

Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “zephyr,mipi-dbi-spi” compatible.

Name

Type

Details

#address-cells

int

 
number of address cells in reg property

This property is required.

Constant value: 1

#size-cells

int

 
number of size cells in reg property

This property is required.

status

string

 
indicates the operational status of a device

Legal values: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss'

See Important properties for more information.

compatible

string-array

 
compatible strings

This property is required.

See Important properties for more information.

reg

array

 
register space

See Important properties for more information.

reg-names

string-array

 
name of each register space

interrupts

array

 
interrupts for device

See Important properties for more information.

interrupts-extended

compound

 
extended interrupt specifier for device

interrupt-names

string-array

 
name of each interrupt

interrupt-parent

phandle

 
phandle to interrupt controller node

label

string

 
Human readable string describing the device (used as device_get_binding() argument)

See Important properties for more information.

This property is deprecated.

clocks

phandle-array

 
Clock gate information

clock-names

string-array

 
name of each clock

dmas

phandle-array

 
DMA channels specifiers

dma-names

string-array

 
Provided names of DMA channel specifiers

io-channels

phandle-array

 
IO channels specifiers

io-channel-names

string-array

 
Provided names of IO channel specifiers

mboxes

phandle-array

 
mailbox / IPM channels specifiers

mbox-names

string-array

 
Provided names of mailbox / IPM channel specifiers

power-domains

phandle-array

 
Power domain specifiers

power-domain-names

string-array

 
Provided names of power domain specifiers

#power-domain-cells

int

 
Number of cells in power-domains property

zephyr,deferred-init

boolean

 
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().

wakeup-source

boolean

 
Property to identify that a device can be used as wake up source.

When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.

Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.

zephyr,pm-device-runtime-auto

boolean

 
Automatically configure the device for runtime power management after the
init function runs.

zephyr,disabling-power-states

phandles

 
List of power states that will disable this device power.