This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down list at the bottom of the left panel and select the desired version.

ambiq,mspi-controller

Vendor: Ambiq Micro, Inc.

Description

These nodes are “mspi” bus nodes.

Ambiq MSPI controller

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.

op-mode

string

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

Legal values: 'MSPI_CONTROLLER', 'MSPI_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.

This property is required.

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.

ambiq,pwrcfg

phandle-array

Power configuration

This property is required.

cmdq-buffer-location

string

Define the DMA command queue buffer location section

cmdq-buffer-size

int

Define the DMA command queue buffer size in (4-byte) words