st,stm32-ospi-controller

Description

These nodes are “mspi” bus nodes.

STM32 OSPI controller

Properties

Properties not inherited from the base binding file.

Name

Type

Details

pinctrl-0

phandles

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

This property is required.

pinctrl-names

string-array

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

This property is required.

st,dlyb-bypass

boolean

 
Enables Delay Block (DLYB) Bypass.

st,ssht-enable

boolean

 
Enables Sample Shifting half-cycle.

It is recommended to be enabled in STR mode and disabled in DTR mode.

st,io-low-port

string

 
Specifies which port of the OCTOSPI IO Manager is used for the IO[3:0] pins.

If absent, then `IOPORT_<n>_LOW` is used where `n` is the OSPI
instance number.

Note: You might need to enable the OCTOSPI I/O manager clock to use the
      property. Please refer to Reference Manual.
      The clock can be enabled in the devicetree.

Legal values: 'IOPORT_NONE', 'IOPORT_1_LOW', 'IOPORT_1_HIGH', 'IOPORT_2_LOW', 'IOPORT_2_HIGH'

st,io-high-port

string

 
Specifies which port of the OCTOSPI IO Manager is used for the IO[7:4] pins.

If absent, then `IOPORT_<n>_HIGH` is used where `n` is the OSPI
instance number.

Can be set to `IOPORT_NONE` for Single SPI, Dual SPI and Quad SPI.

Note: You might need to enable the OCTOSPI I/O manager clock to use the
      property. Please refer to Reference Manual.
      The clock can be enabled in the devicetree.

Legal values: 'IOPORT_NONE', 'IOPORT_1_LOW', 'IOPORT_1_HIGH', 'IOPORT_2_LOW', 'IOPORT_2_HIGH'

st,clk-port

int

 
Specifies which port of the OCTOSPI IO Manager is used for the clk pin.

If absent, then n is used where `n` is the OSPI
instance number.

Note: You might need to enable the OCTOSPI I/O manager clock to use the
      property. Please refer to Reference Manual.
      The clock can be enabled in the devicetree.

Legal values: 1, 2

st,dqs-port

int

 
Specifies which port of the OCTOSPI IO Manager is used for the dqs pin.

If absent, then n is used where `n` is the OSPI
instance number.

Note: You might need to enable the OCTOSPI I/O manager clock to use the
      property. Please refer to Reference Manual.
      The clock can be enabled in the devicetree.

Legal values: 1, 2

st,ncs-port

int

 
Specifies which port of the OCTOSPI IO Manager is used for the ncs pin.

If absent, then n is used where `n` is the OSPI
instance number.

Note: You might need to enable the OCTOSPI I/O manager clock to use the
      property. Please refer to Reference Manual.
      The clock can be enabled in the devicetree.

Legal values: 1, 2

clock-frequency

int

 
Clock frequency the MSPI peripheral is being driven at, in Hz.

This property is required.

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.

op-mode

string

 
Indicate MSPI controller or peripheral mode of the controller.
The controller driver may use this during initialization.

Legal values: 'MSPI_OP_MODE_CONTROLLER', 'MSPI_OP_MODE_PERIPHERAL'

duplex

string

 
Indicate MSPI Duplex mode, full or half.
The controller driver may check this setting against its
capabilities.

Legal values: 'MSPI_HALF_DUPLEX', 'MSPI_FULL_DUPLEX'

dqs-support

boolean

 
Indicate whether the hardware supports DQS.
The controller driver may check this setting against its
capabilities.

software-multiperipheral

boolean

 
Indicate whether the controller driver enables support for
software managed multi peripheral feature.
At the minimum, the controller driver should use it to allow
or disallow calling mspi_dev_config with MSPI_DEVICE_CONFIG_NONE.

ce-gpios

phandle-array

 
An array of chip select GPIOs to use. Each element
in the array specifies a GPIO. The index in the array
corresponds to the child node that the CE gpio controls.

Example:

  mspi@... {
          ce-gpios = <&gpio0 23 GPIO_ACTIVE_LOW>,
                        <&gpio1 10 GPIO_ACTIVE_LOW>,
                        ...;

          mspi-device@0 {
                  reg = <0>;
                  ...
          };
          mspi-device@1 {
                  reg = <1>;
                  ...
          };
          ...
  };

The child node "mspi-device@0" specifies a mspi device with
chip select controller gpio0, pin 23, and devicetree
GPIO flags GPIO_ACTIVE_LOW. Similarly, "mspi-device@1" has CE GPIO
controller gpio1, pin 10, and flags GPIO_ACTIVE_LOW. Additional
devices can be configured in the same way.

If unsure about the flags cell, GPIO_ACTIVE_LOW is generally a safe
choice for a typical "CEn" pin. GPIO_ACTIVE_HIGH may be used if
intervening hardware inverts the signal to the peripheral device or
the line itself is active high.

Regardless of whether the CE pin may need software control or MSPI
controller has dedicated CE pin, this field should be defined to
help manage multiple devices on the same MSPI controller.

packet-data-limit

int

 
Specifies the maximum length of data that the controller can transfer
in a single packet. Transceive requests made to the controller must be
split into multiple packets if a single one would exceed this value.
If not specified, no limit is imposed.