adi,ad9523-1 (on spi bus)

Description

Analog Devices AD9523-1 dual-PLL clock generator / SYSREF distributor.

Each used output is described by a child node. Outputs without a child node
are parked tristate and powered down by the driver. The node needs
#address-cells = <1> and #size-cells = <0> for the child nodes.

Properties

Top level properties

These property descriptions apply to “adi,ad9523-1” nodes themselves. This page also describes child node properties in the following sections.

Properties not inherited from the base binding file.

Name

Type

Details

#clock-cells

int

Number of items to expect in a Clock specifier

This property is required.

Constant value: 1

sync-gpios

phandle-array

SYNC pin; held asserted it freezes all output dividers. Driver parks it
high at init. Optional.

adi,vcxo-freq

int

VCXO / OSCIN frequency in Hz (the PLL2 reference).

This property is required.

adi,spi-3wire-enable

boolean

The SPI bus is 3-wire (bidirectional SDIO, no separate SDO). The driver
leaves SDO_ACTIVE clear so the chip returns readback data on SDIO. Must
match the board wiring: on a 3-wire board a 4-wire config makes every
register readback return zero.

Reads are full-duplex transfers, so SDIO must reach the controller's
MISO input. Half-duplex controllers are not supported.

adi,pll1-bypass-enable

boolean

Bypass PLL1 (single-loop mode): the VCXO drives PLL2 directly. PLL1 lock
has no meaning in this mode and the driver does not evaluate it.

adi,refa-r-divider

int

PLL1 REFA R divider (0-1023, 0 and 1 divide by 1). Defaults to the
reset value.

Default value: 0

adi,refb-r-divider

int

PLL1 REFB R divider (0-1023, 0 and 1 divide by 1). Defaults to the
reset value.

Default value: 0

adi,pll1-feedback-divider

int

PLL1 feedback (N) divider (0-1023, 0 and 1 divide by 1). Defaults to
the reset value.

Default value: 0

adi,pll1-charge-pump-current-na

int

PLL1 charge pump current in nA (500 nA steps, max 63500). Defaults to
the reset value.

Default value: 6000

adi,pll1-loopfilter-rzero

int

PLL1 loop filter RZERO code: 0 = 883k, 1 = 677k, 2 = 341k, 3 = 135k,
4-7 = 10k, 8 = external. Defaults to the reset value.

Default value: 0

Legal values: 0, 1, 2, 3, 4, 5, 6, 7, 8

adi,ref-mode

int

PLL1 reference selection mode: 0 = stay on REFB, 1 = revert to REFA,
2 = REFA, 3 = REFB, 4 = REF_SEL pin. Defaults to the reset value.

Default value: 0

Legal values: 0, 1, 2, 3, 4

adi,zero-delay-mode-internal-enable

boolean

Enable PLL1 internal zero-delay mode.

adi,osc-in-feedback-enable

boolean

Route OSCIN into the PLL1 feedback path.

adi,refa-diff-rcv-enable

boolean

Enable the PLL1 REFA differential receiver.

adi,refb-diff-rcv-enable

boolean

Enable the PLL1 REFB differential receiver.

adi,zd-in-diff-enable

boolean

Enable the zero-delay input differential receiver.

adi,osc-in-diff-enable

boolean

Enable the OSCIN differential receiver.

adi,refa-cmos-neg-inp-enable

boolean

Enable the REFA CMOS negative-input receiver.

adi,refb-cmos-neg-inp-enable

boolean

Enable the REFB CMOS negative-input receiver.

adi,zd-in-cmos-neg-inp-enable

boolean

Enable the zero-delay-input CMOS negative-input receiver.

adi,osc-in-cmos-neg-inp-enable

boolean

Enable the OSCIN CMOS negative-input receiver.

adi,pll2-charge-pump-current-na

int

PLL2 charge pump current in nA (3500 nA steps, max 892500).

This property is required.

adi,pll2-freq-doubler-enable

boolean

Enable the PLL2 reference frequency doubler. Only valid on the explicit
divider path; the derive path forces it off.

adi,pll2-m1-freq

int

DERIVE PATH. Target VCO1 output frequency in Hz. When set, the driver
solves r2/ndiv(a,b)/m1 (doubler off, M2 off) to reach VCO1 = this value
with the VCO inside the AD9523-1 2.94-3.1 GHz band, and the explicit
adi,pll2-* dividers below must be absent. Not verified on hardware.

adi,pll2-r2-div

int

EXPLICIT PATH. PLL2 R2 divider (1-31). Set this and the other explicit
adi,pll2-* dividers, or set adi,pll2-m1-freq instead -- never both.

adi,pll2-ndiv-a-cnt

int

EXPLICIT PATH. PLL2 feedback N-divider A counter (0-3). NDIV = 4*B + A.

adi,pll2-ndiv-b-cnt

int

EXPLICIT PATH. PLL2 feedback N-divider B counter (0-63).

adi,pll2-vco-div-m1

int

EXPLICIT PATH. PLL2 VCO output M1 divider (3-5), feeding VCO1.

adi,pll2-vco-div-m2

int

EXPLICIT PATH. PLL2 VCO output M2 divider (3-5), feeding VCO2. 0 leaves
M2 (VCO2) powered down.

adi,rpole2

int

PLL2 loop filter pole 2 resistor code: 0 = 900, 1 = 450, 2 = 300,
3 = 225 ohm. The default is the register reset value.

Default value: 0

Legal values: 0, 1, 2, 3

adi,rzero

int

PLL2 loop filter zero resistor code: 0 = 3250, 1 = 2750, 2 = 2250,
3 = 2100, 4 = 3000, 5 = 2500, 6 = 2000, 7 = 1850 ohm. The default is the
register reset value.

Default value: 0

Legal values: 0, 1, 2, 3, 4, 5, 6, 7

adi,cpole1

int

PLL2 loop filter pole 1 capacitor code: 0 = 0, 1 = 8, 2 = 16, 3 = 24,
4 = 24, 5 = 32, 6 = 40, 7 = 48 pF. The default is the register reset
value.

Default value: 0

Legal values: 0, 1, 2, 3, 4, 5, 6, 7

adi,rzero-bypass-enable

boolean

Bypass the PLL2 loop filter Rzero.

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 controller 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.

Child node properties

Name

Type

Details

reg

array

Output number, 0-13.

This property is required.

See Important properties for more information.

adi,channel-divider

int

Output divide ratio (1-1024) applied to this output's VCO source
frequency.

This property is required.

adi,driver-mode

int

Output driver mode (register field DRIVER_MODE, 0-15). 0 tristates the
output (reset value), non-zero selects a logic-level family.

Default value: 0

adi,divider-phase

int

Output divider phase offset in half periods of the divider input
clock (0-63). Defaults to no offset.

Default value: 0

adi,extended-name

string

Descriptive name for this output, used in the driver's log lines.
Prefer the net name from the board schematic, e.g. "ADC_CLK".

adi,use-alt-clock-src

boolean

Route this output from the alternate VCO source (VCXO for outputs 0-3,
VCO2/M2 for outputs 4-9) rather than the default VCO1/M1.

adi,output-dis

boolean

Program this output but leave its distribution stage powered down.

adi,sync-ignore-enable

boolean

This output ignores chip-level SYNC events.

adi,low-power-mode-enable

boolean

Run this output's distribution stage in low-power mode.

adi,divider-output-invert-enable

boolean

Invert this output's divider output.

Specifier cell names

  • clock cells: output