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 |
|---|---|---|
|
|
Number of items to expect in a Clock specifier
This property is required. Constant value: |
|
|
SYNC pin; held asserted it freezes all output dividers. Driver parks it
high at init. Optional.
|
|
|
VCXO / OSCIN frequency in Hz (the PLL2 reference).
This property is required. |
|
|
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.
|
|
|
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.
|
|
|
PLL1 REFA R divider (0-1023, 0 and 1 divide by 1). Defaults to the
reset value.
Default value: |
|
|
PLL1 REFB R divider (0-1023, 0 and 1 divide by 1). Defaults to the
reset value.
Default value: |
|
|
PLL1 feedback (N) divider (0-1023, 0 and 1 divide by 1). Defaults to
the reset value.
Default value: |
|
|
PLL1 charge pump current in nA (500 nA steps, max 63500). Defaults to
the reset value.
Default value: |
|
|
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: Legal values: |
|
|
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: Legal values: |
|
|
Enable PLL1 internal zero-delay mode.
|
|
|
Route OSCIN into the PLL1 feedback path.
|
|
|
Enable the PLL1 REFA differential receiver.
|
|
|
Enable the PLL1 REFB differential receiver.
|
|
|
Enable the zero-delay input differential receiver.
|
|
|
Enable the OSCIN differential receiver.
|
|
|
Enable the REFA CMOS negative-input receiver.
|
|
|
Enable the REFB CMOS negative-input receiver.
|
|
|
Enable the zero-delay-input CMOS negative-input receiver.
|
|
|
Enable the OSCIN CMOS negative-input receiver.
|
|
|
PLL2 charge pump current in nA (3500 nA steps, max 892500).
This property is required. |
|
|
Enable the PLL2 reference frequency doubler. Only valid on the explicit
divider path; the derive path forces it off.
|
|
|
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.
|
|
|
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.
|
|
|
EXPLICIT PATH. PLL2 feedback N-divider A counter (0-3). NDIV = 4*B + A.
|
|
|
EXPLICIT PATH. PLL2 feedback N-divider B counter (0-63).
|
|
|
EXPLICIT PATH. PLL2 VCO output M1 divider (3-5), feeding VCO1.
|
|
|
EXPLICIT PATH. PLL2 VCO output M2 divider (3-5), feeding VCO2. 0 leaves
M2 (VCO2) powered down.
|
|
|
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: Legal values: |
|
|
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: Legal values: |
|
|
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: Legal values: |
|
|
Bypass the PLL2 loop filter Rzero.
|
|
|
Maximum clock frequency of device's SPI interface in Hz
This property is required. |
|
|
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: Legal values: |
|
|
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: Legal values: |
|
|
SPI clock polarity which indicates the clock idle state.
If it is used, the clock idle state is logic high; otherwise, low.
|
|
|
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.
|
|
|
The device requires least significant bit first data mode.
|
|
|
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.
|
|
|
The device requires the chip select to be active high.
|
|
|
Delay in nanoseconds between SPI words.
Default of 0 is special value which will assume to mean half of the SCK period.
Default value: |
|
|
Delay in nanoseconds to be introduced by the controller after CS is asserted.
Also known as enable lead time.
|
|
|
Delay in nanoseconds to be introduced by the controller before the CS is de-asserted.
Also known as enable lag time.
|
|
|
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.
|
|
|
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.
|
Deprecated properties not inherited from the base binding file.
(None)
Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “adi,ad9523-1” compatible.
Name |
Type |
Details |
|---|---|---|
|
|
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
This property is required. See Important properties for more information. |
|
|
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: See Important properties for more information. |
|
|
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is required. See Important properties for more information. |
|
|
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
|
|
|
Information used to define a mapping (or translation) between the address
space of a bus (the "child address space") and the address space of the
bus node's parent (the "parent address space").
The "ranges" property is typically empty, or a sequence of triplets
(child bus address, parent bus address, length).
If the "ranges" property is empty, it specifies that the parent and child
address spaces are identical and no address translation is required.
If the "ranges" property is not present in a bus node, it is assumed that
no mapping exists between children of the node and the parent address space.
For details, see "2.3.8 ranges" in Devicetree Specification v0.4.
|
|
|
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
See Important properties for more information. |
|
|
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
|
|
|
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
|
|
|
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
|
|
|
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See Important properties for more information. |
|
|
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
|
|
|
Optional names given to each clock provider in the "clocks" property.
|
|
|
This property encodes the number of <u32> cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
|
|
|
This property encodes the number of <u32> cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
|
|
|
Indicates that the device is capable of coherent DMA operations.
For details, see "2.3.10 dma-coherent" in Devicetree Specification v0.4.
|
|
|
DMA channel specifiers relevant to the device.
|
|
|
Optional names given to the DMA channel specifiers in the "dmas" property.
|
|
|
The dma-ranges provides a means of defining a mapping or translation between the
physical address space of the bus and the physical address space of the parent of the bus.
For details, see "2.3.9 dma-ranges" in Devicetree Specification v0.4.
|
|
|
IO channel specifiers relevant to the device.
|
|
|
Optional names given to the IO channel specifiers in the "io-channels" property.
|
|
|
Mailbox / IPM channel specifiers relevant to the device.
|
|
|
Optional names given to the mbox specifiers in the "mboxes" property.
|
|
|
Power domain specifiers relevant to the device.
|
|
|
Optional names given to the power domain specifiers in the "power-domains" property.
|
|
|
Number of cells in power-domains property
|
|
|
HW spinlock id relevant to the device.
|
|
|
Optional names given to the hwlock specifiers in the "hwlocks" property.
|
|
|
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
|
|
|
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
|
|
|
Automatically configure the device for runtime power management after the
init function runs.
|
|
|
List of power states that will disable this device power.
|
Child node properties
Name |
Type |
Details |
|---|---|---|
|
|
Output number, 0-13.
This property is required. See Important properties for more information. |
|
|
Output divide ratio (1-1024) applied to this output's VCO source
frequency.
This property is required. |
|
|
Output driver mode (register field DRIVER_MODE, 0-15). 0 tristates the
output (reset value), non-zero selects a logic-level family.
Default value: |
|
|
Output divider phase offset in half periods of the divider input
clock (0-63). Defaults to no offset.
Default value: |
|
|
Descriptive name for this output, used in the driver's log lines.
Prefer the net name from the board schematic, e.g. "ADC_CLK".
|
|
|
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.
|
|
|
Program this output but leave its distribution stage powered down.
|
|
|
This output ignores chip-level SYNC events.
|
|
|
Run this output's distribution stage in low-power mode.
|
|
|
Invert this output's divider output.
|
Specifier cell names
clock cells: output