ADMV1014

ADMV1014 24 GHz to 44 GHz, Wideband, Microwave Downconverter Linux Driver.

Supported Devices

Evaluation Boards

Description

This is a Linux industrial I/O (Linux Industrial I/O Subsystem) subsystem driver, targeting serial interface Microwave converters. The industrial I/O subsystem provides a unified framework for drivers for many different types of converters and sensors using a number of different physical interfaces (i2c, spi, etc). See Linux Industrial I/O Subsystem for more information.

Source Code

Status

Source

Mainlined?

git

WIP

Files

Function

File

driver

drivers/iio/frequency/admv1014.c

Documentation

Documentation/ABI/testing/sysfs-bus-iio

Unlike PCI or USB devices, SPI devices are not enumerated at the hardware level. Instead, the software must know which devices are connected on each SPI bus segment, and what slave selects these devices are using. For this reason, the kernel code must instantiate SPI devices explicitly. The most common method is to declare the SPI devices by bus number.

This method is appropriate when the SPI bus is a system bus, as in many embedded systems, wherein each SPI bus has a number which is known in advance. It is thus possible to pre-declare the SPI devices that inhabit this bus. This is done with an array of struct spi_board_info, which is registered by calling spi_register_board_info().

For more information see: Overview of Linux kernel SPI support

properties

compatible:

  • enum:

  • adi,admv1014

reg:

  • maxItems: 1

spi-max-frequency:

  • minimum: 1000000

clocks:

  • description: Definition of the external clock (see clock/clock-bindings.txt)

  • minItems: 1

clock-names:

  • description: Must be lo_in

  • maxItems: 1

clock-output-names:

  • maxItems: 1

clock-scales:

  • description: The Common Clock Framework max rate is limited by MAX of unsigned long. For ADMV1014 device this is a deficiency. If specified, this property allows arbitrary scales. The first element in the array should be the multiplier and the second element should be the divider.

  • $ref: /schemas/types.yaml#/definitions/uint32-array

  • minimum: 1

vcm-supply:

  • description: analog voltage regulator (see regulator/regulator.txt)

adi,parity-en:

  • description: Enable Parity for Write execution.

  • type: boolean

adi,ibias-pd:

  • description: Power Down the Rx IBIAS.

  • type: boolean

adi,if-amp-pd:

  • description: Power Down the IF Amp.

  • type: boolean

adi,quad-bg-pd:

  • description: Power Down the Quadrupler Band Gap.

  • type: boolean

adi,bb-amp-pd:

  • description: Power Down the Baseband Amp.

  • type: boolean

adi,quad-ibias-pd:

  • description: Power Down the Quadrupler Bias Current.

  • type: boolean

adi,det-en:

  • description: Digital Rx Detector Enable.

  • type: boolean

adi,bg-pd:

  • description: Power Down the Rx BG.

  • type: boolean

adi,p1db-comp:

  • description: Turn on bits to optimize P1dB.

  • $ref: /schemas/types.yaml#/definitions/uint32

  • enum: [0, 3]

adi,quad-se-mode:

  • description: Switch Differential/SE Modes.

  • $ref: /schemas/types.yaml#/definitions/uint32

  • enum: [6, 9, 12]

adi,det-prog:

  • description: Digital Rx Detector Program.

  • $ref: /schemas/types.yaml#/definitions/uint32

  • enum: [1, 2, 4, 8, 16, 32, 64]

adi,adi,bb-amp-gain-ctrl:

  • description: Baseband Amp Gain control.

  • $ref: /schemas/types.yaml#/definitions/uint32

  • enum: [0, 1, 2, 3]

‘#address-cells’:

  • const: 1

‘#size-cells’:

  • const: 0

‘#clock-cells’:

  • const: 0

required:

  • compatible

  • reg

  • clocks

  • clock-names

  • vcm-supply

Example

spi {
      #address-cells = <1>;
      #size-cells = <0>;
      admv1014@0{
        compatible = "adi,admv1014";
        reg = <0>;
        spi-max-frequency = <1000000>;
        clocks = <&admv1014_lo>;
        clock-names = "lo_in";
        clock-scales = <1 5>;
        vcm-supply = <&vcm>;
        adi,quad-se-mode = <12>;
        adi,parity-en;
        adi,det-en;
        adi,p1db-comp = <3>;
        adi,det-prog = <0>;
        adi,bb-amp-gain-ctrl = <0>;
      };
    };

Adding Linux driver support

Configure kernel with make menuconfig (alternatively use make xconfig or make qconfig)

Note

The ADMV1014 Driver depends on CONFIG_SPI

Linux Kernel Configuration
    Device Drivers  --->
        <*>     Industrial I/O support --->
            --- Industrial I/O support
                Frequency  --->
                    <*> Analog Devices ADMV1014 Microwave Downconverter

Hardware configuration

Each and every IIO device, typically a hardware chip, has a device folder under /sys/bus/iio/devices/iio:deviceX. Where X is the IIO index of the device. Under every of these directory folders reside a set of files, depending on the characteristics and features of the hardware device in question. These files are consistently generalized and documented in the IIO ABI documentation. In order to determine which IIO deviceX corresponds to which hardware device, the user can read the name file /sys/bus/iio/devices/iio:deviceX/name. In case the sequence in which the iio device drivers are loaded/registered is constant, the numbering is constant and may be known in advance.

root:/> cd /sys/bus/iio/devices/
root:/sys/bus/iio/devices> ls
iio:device0
root:/sys/bus/iio/devices> iio:device0

root:/> ls -l
-r--r--r-- 1 root root 4096 May  6 12:20 dev
-r--r--r-- 1 root root 4096 May  6 12:20 name
-rw-r--r-- 1 root root 4096 May  6 13:00 out_altvoltage0_i_hardwaregain
-rw-r--r-- 1 root root 4096 May  6 13:00 out_altvoltage0_q_hardwaregain
-rw-r--r-- 1 root root 4096 May  6 13:01 out_altvoltage0_i_offset
-rw-r--r-- 1 root root 4096 May  6 13:01 out_altvoltage0_q_offset
-rw-r--r-- 1 root root 4096 May  6 13:01 out_altvoltage0_i_phase
-rw-r--r-- 1 root root 4096 May  6 13:01 out_altvoltage0_q_phase
lrwxrwxrwx 1 root root    0 May  6 12:20 subsystem -> ../../../../../../../../bus/iio
-rw-r--r-- 1 root root 4096 May  6 12:20 uevent

Show device name

root:/> cd /sys/bus/iio/devices/iio\:device0/
root:/> cat name
admv1014

Set ChannelY Gain

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_Z_hardwaregain

Gain factor. If shared across all channels, <type>_hardwaregain is used.

root:/> cat out_altvoltage0_i_hardwaregain
0 0

root:/> echo 1.1 > out_altvoltage0_i_hardwaregain
root:/> cat out_altvoltage0_hardwaregain
1 1

Set ChannelY Offset value

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_Z_offset

Offset value. If shared across all channels, <type>_offset is used.

root:/> cat out_altvoltage0_i_offset
0

root:/> echo 1 > out_altvoltage0_i_offset
root:/> cat out_altvoltage0_offset
1

Set ChannelY Phase value

/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_Z_phase

Phase value. If shared across all channels, <type>_phase is used.

root:/> cat out_altvoltage0_i_phase
0

root:/> echo 1 > out_altvoltage0_i_phase
root:/> cat out_altvoltage0_phase
1

More Information