cdns,xspi-nor

Description

These nodes are “mspi” bus nodes.

Cadence xSPI (dual, quad, octal SPI) Flash controller with MSPI interface

Properties

Properties not inherited from the base binding file.

Name

Type

Details

clock-frequency

int

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

This property is required.

read-buffer-size

int

 
Amount of address bits of the internal peripheral SRAM bus that are used
for indirects reads. The other address bits are used for indirect write
operations. The amount of available bits is dependent on the SRAM depth
configuration used inside the peripheral and the resulting amount of bytes
depends on the bus width, which may be specified in the SoC datasheet.

It is recommended to look at the SoC datasheet/TRM and set this to half of
the maximum of the "SRAM Partition Configuration Register" value (which is
also its reset value), leading to half of the locations being used for
indirect reads and the other half for indirect writes

This property is required.

cdns,nss-delay-ns

int

 
Amount of nanoseconds between the CS pin is deasserted between
transactions after startup.

This property is required.

cdns,btwn-delay-ns

int

 
Amount of nanoseconds no peripheral is selected during switching device
after startup.

This property is required.

cdns,after-delay-ns

int

 
Amount of nanoseconds the CS pin is continued being held after the last
bit was transferred.

This property is required.

cdns,init-delay-ns

int

 
Amount of nanoseconds between setting n_ss_out low and sending the first
bit of the transmission.

This property is required.

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.

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.