adi,adgm3121 (on spi bus)

Description

Analog Devices ADGM3121 DPDT MEMS switch (DC-24GHz), SPI control mode,
exposed as a MUX controller.

The four MEMS switches (SW1..SW4) are modeled as a single control line
whose state is a 4-bit switch bitmask: bit i selects SW(i+1), 1 = closed.
mux_control_disconnect() opens all four switches (mask = 0).

Examples

&spi1 {
        adgm3121: adgm3121@0 {
                compatible = "adi,adgm3121";
                reg = <0>;
                spi-max-frequency = <10000000>;
                #mux-control-cells = <0>;
                #mux-state-cells = <1>;
        };
};

consumer {
        mux-controls = <&adgm3121>;        /* runtime switch mask */
        mux-states   = <&adgm3121 0x5>;    /* static: SW1 + SW3 closed */
};

Properties

Properties not inherited from the base binding file.

Name

Type

Details

#mux-control-cells

int

Number of cells in a "mux-controls" specifier. These cells form the
addressing portion only (which output line) and do NOT include the
target state value. Drivers receive the addressing cells in the
"cells" field of struct mux_control.

This property is required.

Constant value: 0

#mux-state-cells

int

Number of cells in a "mux-states" specifier. Equals
#mux-control-cells + 1: the trailing cell carries the default state
value. Backends may name the trailing cell whatever best describes
the hardware (e.g. "state" for a generic mux, "input" for an
XBAR, "source" for a TRGMUX).

This property is required.

Constant value: 1

spi-max-frequency

int

Maximum clock frequency of device's SPI interface in Hz

This property is required.

duplex

int

Duplex mode, full or half. By default it's always full duplex thus 0
as this is, by far, the most common mode.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
  0    SPI_FULL_DUPLEX
  2048 SPI_HALF_DUPLEX

Default value: 0

Legal values: 0, 2048

frame-format

int

Motorola or TI frame format. By default it's always Motorola's,
thus 0 as this is, by far, the most common format.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
  0     SPI_FRAME_FORMAT_MOTOROLA
  32768 SPI_FRAME_FORMAT_TI

Default value: 0

Legal values: 0, 32768

spi-cpol

boolean

SPI clock polarity which indicates the clock idle state.
If it is used, the clock idle state is logic high; otherwise, low.

spi-cpha

boolean

SPI clock phase that indicates on which edge data is sampled.
If it is used, data is sampled on the second edge; otherwise, on the first edge.

spi-lsb-first

boolean

The device requires least significant bit first data mode.

spi-hold-cs

boolean

In some cases, it is necessary for the master to manage SPI chip select
under software control, so that multiple spi transactions can be performed
without releasing it. A typical use case is variable length SPI packets
where the first spi transaction reads the length and the second spi transaction
reads length bytes.

spi-cs-high

boolean

The device requires the chip select to be active high.

spi-interframe-delay-ns

int

Delay in nanoseconds between SPI words.
Default of 0 is special value which will assume to mean half of the SCK period.

Default value: 0

spi-cs-setup-delay-ns

int

Delay in nanoseconds to be introduced by the controller after CS is asserted.
Also known as enable lead time.

spi-cs-hold-delay-ns

int

Delay in nanoseconds to be introduced by the controller before the CS is de-asserted.
 Also known as enable lag time.

supply-gpios

phandle-array

GPIO specifier that controls power to the device.

This property should be provided when the device has a dedicated
switch that controls power to the device.  The supply state is
entirely the responsibility of the device driver.

Contrast with vin-supply.

vin-supply

phandle

Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.

This property should be provided when device power is supplied
by a shared regulator.  The supply state is dependent on the
request status of all devices fed by the regulator.

Contrast with supply-gpios.  If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.

Specifier cell names

  • mux-state cells: switches