MSPI Devicetree related macros

MSPI Devicetree related macros . More...

Macros
#define	MSPI_DEVICE_CONFIG_DT(mspi_dev)
	Structure initializer for struct mspi_dev_cfg from devicetree.
#define	MSPI_DEVICE_CONFIG_DT_INST(inst)
	Structure initializer for struct mspi_dev_cfg from devicetree instance.
#define	MSPI_XIP_CONFIG_DT_NO_CHECK(mspi_dev)
	Structure initializer for struct mspi_xip_cfg from devicetree.
#define	MSPI_XIP_CONFIG_DT(mspi_dev)
	Structure initializer for struct mspi_xip_cfg from devicetree.
#define	MSPI_XIP_CONFIG_DT_INST(inst)
	Structure initializer for struct mspi_xip_cfg from devicetree instance.
#define	MSPI_SCRAMBLE_CONFIG_DT_NO_CHECK(mspi_dev)
	Structure initializer for struct mspi_scramble_cfg from devicetree.
#define	MSPI_SCRAMBLE_CONFIG_DT(mspi_dev)
	Structure initializer for struct mspi_scramble_cfg from devicetree.
#define	MSPI_SCRAMBLE_CONFIG_DT_INST(inst)
	Structure initializer for struct mspi_scramble_cfg from devicetree instance.
#define	MSPI_DEVICE_ID_DT(mspi_dev)
	Structure initializer for struct mspi_dev_id from devicetree.
#define	MSPI_DEVICE_ID_DT_INST(inst)
	Structure initializer for struct mspi_dev_id from devicetree instance.
#define	MSPI_DEV_CE_GPIOS_DT_SPEC_GET(mspi_dev)
	Get a struct gpio_dt_spec for a MSPI device's chip enable pin.
#define	MSPI_DEV_CE_GPIOS_DT_SPEC_INST_GET(inst)
	Get a struct gpio_dt_spec for a MSPI device's chip enable pin.
#define	MSPI_CE_GPIOS_DT_SPEC_GET(node_id)
	Get an array of struct gpio_dt_spec from devicetree for a MSPI controller.
#define	MSPI_CE_GPIOS_DT_SPEC_INST_GET(inst)
	Get an array of struct gpio_dt_spec for a MSPI controller.
#define	MSPI_CE_CONTROL_INIT(node_id, delay_)
	Initialize and get a pointer to a mspi_ce_control from a devicetree node identifier.
#define	MSPI_CE_CONTROL_INIT_INST(inst, delay_)
	Get a pointer to a mspi_ce_control from a devicetree node.

Detailed Description

MSPI Devicetree related macros .

Macro Definition Documentation

MSPI_CE_CONTROL_INIT

#define MSPI_CE_CONTROL_INIT	(		node_id,
			delay_ )

#include <zephyr/drivers/mspi/devicetree.h>

Value:

        {                                                                                         \
                .gpio = MSPI_DEV_CE_GPIOS_DT_SPEC_GET(node_id), .delay = (delay_),                \
        }

Initialize and get a pointer to a mspi_ce_control from a devicetree node identifier.

This helper is useful for initializing a device on a MSPI bus. It initializes a struct mspi_ce_control and returns a pointer to it. Here, node_id is a node identifier for a MSPI device, not a MSPI controller.

Example devicetree fragment:

mspi@abcd0001 {
        ce-gpios = <&gpio0 1 GPIO_ACTIVE_LOW>;
        mspidev: mspi-device@0 { ... };
};

Example usage:

struct mspi_ce_control ctrl =
        MSPI_CE_CONTROL_INIT(DT_NODELABEL(mspidev), 2);

This example is equivalent to:

struct mspi_ce_control ctrl = {
        .gpio = MSPI_DEV_CE_GPIOS_DT_SPEC_GET(DT_NODELABEL(mspidev)),
        .delay = 2,
};

Parameters

node_id	Devicetree node identifier for a device on a MSPI bus
delay_	The delay field to set in the mspi_ce_control

Returns

a pointer to the mspi_ce_control structure

MSPI_CE_CONTROL_INIT_INST

#define MSPI_CE_CONTROL_INIT_INST	(		inst,
			delay_ )

#include <zephyr/drivers/mspi/devicetree.h>

Value:

MSPI_CE_CONTROL_INIT(DT_DRV_INST(inst), delay_)

Get a pointer to a mspi_ce_control from a devicetree node.

This is equivalent to MSPI_CE_CONTROL_INIT(DT_DRV_INST(inst), delay).

Therefore, DT_DRV_COMPAT must already be defined before using this macro.

Parameters

inst	Devicetree node instance number
delay_	The delay field to set in the mspi_ce_control

Returns

a pointer to the mspi_ce_control structure

MSPI_CE_GPIOS_DT_SPEC_GET

#define MSPI_CE_GPIOS_DT_SPEC_GET

(

node_id

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

{                                                                                                 \
        COND_CODE_1(DT_NODE_HAS_PROP(node_id, ce_gpios),                                          \
                (DT_FOREACH_PROP_ELEM_SEP(node_id, ce_gpios, GPIO_DT_SPEC_GET_BY_IDX, (,))),      \
                ())                                                                               \
}

Get an array of struct gpio_dt_spec from devicetree for a MSPI controller.

This helper macro check whether ce_gpios binding exist first before calling GPIO_DT_SPEC_GET_BY_IDX and expand to an array of gpio_dt_spec.

Parameters

node_id

Devicetree node identifier for the MSPI controller

Returns

an array of gpio_dt_spec struct corresponding with mspi_dev's chip enables

MSPI_CE_GPIOS_DT_SPEC_INST_GET

#define MSPI_CE_GPIOS_DT_SPEC_INST_GET

(

inst

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

                MSPI_CE_GPIOS_DT_SPEC_GET(DT_DRV_INST(inst))

Get an array of struct gpio_dt_spec for a MSPI controller.

This is equivalent to MSPI_CE_GPIOS_DT_SPEC_GET(DT_DRV_INST(inst)).

Parameters

inst	Devicetree instance number

Returns

an array of gpio_dt_spec struct corresponding with mspi_dev's chip enables

MSPI_DEV_CE_GPIOS_DT_SPEC_GET

#define MSPI_DEV_CE_GPIOS_DT_SPEC_GET

(

mspi_dev

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

                GPIO_DT_SPEC_GET_BY_IDX_OR(DT_BUS(mspi_dev), ce_gpios,                            \
                                           DT_REG_ADDR_RAW(mspi_dev), {})

Get a struct gpio_dt_spec for a MSPI device's chip enable pin.

Example devicetree fragment:

gpio1: gpio@abcd0001 { ... };
 
gpio2: gpio@abcd0002 { ... };
 
mspi@abcd0003 {
        compatible = "ambiq,mspi";
        ce-gpios = <&gpio1 10 GPIO_ACTIVE_LOW>,
                   <&gpio2 20 GPIO_ACTIVE_LOW>;
 
        a: mspi-dev-a@0 {
                reg = <0>;
        };
 
        b: mspi-dev-b@1 {
                reg = <1>;
        };
};

Example usage:

MSPI_DEV_CE_GPIOS_DT_SPEC_GET(DT_NODELABEL(a)) \
      // { DEVICE_DT_GET(DT_NODELABEL(gpio1)), 10, GPIO_ACTIVE_LOW }
MSPI_DEV_CE_GPIOS_DT_SPEC_GET(DT_NODELABEL(b)) \
      // { DEVICE_DT_GET(DT_NODELABEL(gpio2)), 20, GPIO_ACTIVE_LOW }

Parameters

mspi_dev

a MSPI device node identifier

Returns

gpio_dt_spec struct corresponding with mspi_dev's chip enable

MSPI_DEV_CE_GPIOS_DT_SPEC_INST_GET

#define MSPI_DEV_CE_GPIOS_DT_SPEC_INST_GET

(

inst

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

                MSPI_DEV_CE_GPIOS_DT_SPEC_GET(DT_DRV_INST(inst))

Get a struct gpio_dt_spec for a MSPI device's chip enable pin.

This is equivalent to MSPI_DEV_CE_GPIOS_DT_SPEC_GET(DT_DRV_INST(inst)).

Parameters

inst	Devicetree instance number

Returns

gpio_dt_spec struct corresponding with mspi_dev's chip enable

MSPI_DEVICE_CONFIG_DT

#define MSPI_DEVICE_CONFIG_DT

(

mspi_dev

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

        {                                                                                         \
                .ce_num               = DT_PROP_OR(mspi_dev, mspi_hardware_ce_num, 0),            \
                .freq                 = DT_PROP(mspi_dev, mspi_max_frequency),                    \
                .io_mode              = DT_ENUM_IDX_OR(mspi_dev, mspi_io_mode,                    \
                                                MSPI_IO_MODE_SINGLE),                             \
                .data_rate            = DT_ENUM_IDX_OR(mspi_dev, mspi_data_rate,                  \
                                                MSPI_DATA_RATE_SINGLE),                           \
                .cpp                  = DT_ENUM_IDX_OR(mspi_dev, mspi_cpp_mode, MSPI_CPP_MODE_0), \
                .endian               = DT_ENUM_IDX_OR(mspi_dev, mspi_endian,                     \
                                                MSPI_XFER_LITTLE_ENDIAN),                         \
                .ce_polarity          = DT_ENUM_IDX_OR(mspi_dev, mspi_ce_polarity,                \
                                                MSPI_CE_ACTIVE_LOW),                              \
                .dqs_enable           = DT_PROP(mspi_dev, mspi_dqs_enable),                       \
                .rx_dummy             = DT_PROP_OR(mspi_dev, rx_dummy, 0),                        \
                .tx_dummy             = DT_PROP_OR(mspi_dev, tx_dummy, 0),                        \
                .read_cmd             = DT_PROP_OR(mspi_dev, read_command, 0),                    \
                .write_cmd            = DT_PROP_OR(mspi_dev, write_command, 0),                   \
                .cmd_length           = DT_ENUM_IDX_OR(mspi_dev, command_length, 0),              \
                .addr_length          = DT_ENUM_IDX_OR(mspi_dev, address_length, 0),              \
                .mem_boundary         = COND_CODE_1(DT_NODE_HAS_PROP(mspi_dev, ce_break_config),  \
                                                (DT_PROP_BY_IDX(mspi_dev, ce_break_config, 0)),   \
                                                (0)),                                             \
                .time_to_break        = COND_CODE_1(DT_NODE_HAS_PROP(mspi_dev, ce_break_config),  \
                                                (DT_PROP_BY_IDX(mspi_dev, ce_break_config, 1)),   \
                                                (0)),                                             \
        }

Structure initializer for struct mspi_dev_cfg from devicetree.

This helper macro expands to a static initializer for a struct mspi_dev_cfg by reading the relevant data from the devicetree.

Parameters

mspi_dev

Devicetree node identifier for the MSPI device whose struct mspi_dev_cfg to create an initializer for

MSPI_DEVICE_CONFIG_DT_INST

#define MSPI_DEVICE_CONFIG_DT_INST

(

inst

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

MSPI_DEVICE_CONFIG_DT(DT_DRV_INST(inst))

Structure initializer for struct mspi_dev_cfg from devicetree instance.

This is equivalent to MSPI_DEVICE_CONFIG_DT(DT_DRV_INST(inst)).

Parameters

inst	Devicetree instance number

MSPI_DEVICE_ID_DT

#define MSPI_DEVICE_ID_DT

(

mspi_dev

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

        {                                                                                         \
                .ce                   = MSPI_DEV_CE_GPIOS_DT_SPEC_GET(mspi_dev),                  \
                .dev_idx              = DT_REG_ADDR(mspi_dev),                                    \
        }

Structure initializer for struct mspi_dev_id from devicetree.

This helper macro expands to a static initializer for a struct mspi_dev_id by reading the relevant data from the devicetree.

Parameters

mspi_dev

Devicetree node identifier for the MSPI device whose struct mspi_dev_id to create an initializer for

MSPI_DEVICE_ID_DT_INST

#define MSPI_DEVICE_ID_DT_INST

(

inst

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

MSPI_DEVICE_ID_DT(DT_DRV_INST(inst))

Structure initializer for struct mspi_dev_id from devicetree instance.

This is equivalent to MSPI_DEVICE_ID_DT(DT_DRV_INST(inst)).

Parameters

inst	Devicetree instance number

MSPI_SCRAMBLE_CONFIG_DT

#define MSPI_SCRAMBLE_CONFIG_DT

(

mspi_dev

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

                COND_CODE_1(DT_NODE_HAS_PROP(mspi_dev, scramble_config),                          \
                        (MSPI_SCRAMBLE_CONFIG_DT_NO_CHECK(mspi_dev)),                             \
                        ({}))

Structure initializer for struct mspi_scramble_cfg from devicetree.

This helper macro check whether scramble_config binding exist first before calling MSPI_SCRAMBLE_CONFIG_DT_NO_CHECK.

Parameters

mspi_dev

Devicetree node identifier for the MSPI device whose struct mspi_scramble_cfg to create an initializer for

MSPI_SCRAMBLE_CONFIG_DT_INST

#define MSPI_SCRAMBLE_CONFIG_DT_INST

(

inst

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

MSPI_SCRAMBLE_CONFIG_DT(DT_DRV_INST(inst))

Structure initializer for struct mspi_scramble_cfg from devicetree instance.

This is equivalent to MSPI_SCRAMBLE_CONFIG_DT(DT_DRV_INST(inst)).

Parameters

inst	Devicetree instance number

MSPI_SCRAMBLE_CONFIG_DT_NO_CHECK

#define MSPI_SCRAMBLE_CONFIG_DT_NO_CHECK

(

mspi_dev

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

        {                                                                                         \
                .enable               = DT_PROP_BY_IDX(mspi_dev, scramble_config, 0),             \
                .address_offset       = DT_PROP_BY_IDX(mspi_dev, scramble_config, 1),             \
                .size                 = DT_PROP_BY_IDX(mspi_dev, scramble_config, 2),             \
        }

Structure initializer for struct mspi_scramble_cfg from devicetree.

This helper macro expands to a static initializer for a struct mspi_scramble_cfg by reading the relevant data from the devicetree.

Parameters

mspi_dev

Devicetree node identifier for the MSPI device whose struct mspi_scramble_cfg to create an initializer for

MSPI_XIP_CONFIG_DT

#define MSPI_XIP_CONFIG_DT

(

mspi_dev

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

                COND_CODE_1(DT_NODE_HAS_PROP(mspi_dev, xip_config),                               \
                        (MSPI_XIP_CONFIG_DT_NO_CHECK(mspi_dev)),                                  \
                        ({}))

Structure initializer for struct mspi_xip_cfg from devicetree.

This helper macro check whether xip_config binding exist first before calling MSPI_XIP_CONFIG_DT_NO_CHECK.

Parameters

mspi_dev

Devicetree node identifier for the MSPI device whose struct mspi_xip_cfg to create an initializer for

MSPI_XIP_CONFIG_DT_INST

#define MSPI_XIP_CONFIG_DT_INST

(

inst

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

MSPI_XIP_CONFIG_DT(DT_DRV_INST(inst))

Structure initializer for struct mspi_xip_cfg from devicetree instance.

This is equivalent to MSPI_XIP_CONFIG_DT(DT_DRV_INST(inst)).

Parameters

inst	Devicetree instance number

MSPI_XIP_CONFIG_DT_NO_CHECK

#define MSPI_XIP_CONFIG_DT_NO_CHECK

(

mspi_dev

)

#include <zephyr/drivers/mspi/devicetree.h>

Value:

        {                                                                                         \
                .enable               = DT_PROP_BY_IDX(mspi_dev, xip_config, 0),                  \
                .address_offset       = DT_PROP_BY_IDX(mspi_dev, xip_config, 1),                  \
                .size                 = DT_PROP_BY_IDX(mspi_dev, xip_config, 2),                  \
                .permission           = DT_PROP_BY_IDX(mspi_dev, xip_config, 3),                  \
        }

Structure initializer for struct mspi_xip_cfg from devicetree.

This helper macro expands to a static initializer for a struct mspi_xip_cfg by reading the relevant data from the devicetree.

Parameters

mspi_dev

Devicetree node identifier for the MSPI device whose struct mspi_xip_cfg to create an initializer for