Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 121 additions & 0 deletions Documentation/devicetree/bindings/iio/dac/adi,max22007.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/dac/adi,max22007.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Analog Devices MAX22007 DAC device driver

maintainers:
- Janani Sunil <janani.sunil@analog.com>

description:
The MAX22007 is a quad-channel, 12-bit digital-to-analog converter (DAC)
with integrated precision output amplifiers and current output capability.
Each channel can be independently configured for voltage or current output.
Datasheet available at https://www.analog.com/en/products/max22007.html

$ref: /schemas/spi/spi-peripheral-props.yaml#

properties:
compatible:
const: adi,max22007

reg:
maxItems: 1

spi-max-frequency:
maximum: 500000

'#address-cells':
const: 1

'#size-cells':
const: 0

vdd-supply:
description: Low-Voltage Power Supply from +2.7V to +5.5V.

hvdd-supply:
description:
Positive High-Voltage Power Supply from +8V to (HVSS +24V) for
the Output Channels.

hvss-supply:
description:
Negative High-Voltage Power Supply from -2V to 0V for the Output Channels.

adi,crc-disable:
type: boolean
description:
Disable CRC8 error checking for SPI communications. By default, CRC8 is
enabled for data integrity verification. Set this property to disable it.
Comment on lines +48 to +52
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see in the data sheet that SPI transfers can run with CRC disabled (set CRC_EN field to 0x0 within the configuration register (0x03) ). For max22007, CRC is a runtime configuration and has nothing to do with how hardware is set up. Drop this property.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The property here was added so that it enables the user to take a decision on the state of the CRC and not hardcoding it in the driver. Do you still suggest removing the CRC property and hardcoding it in the driver?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not about hardcoding, it's about hardware description. Devicetree is useful because it follows a specification that makes it easier to describe hardware such that the description is both readable to humans and compilable by machines. Some info clearly relates to the hardware, e.g. pins that have device-specific functionality, specific types of inputs/outputs to/from device pins (clocks, voltage/current supplies, GPIOs, ...), non-conventional hardware connections (e.g. controller CS connected to peripheral SDI), characteristics intrinsic to a design (e.g. max transfer clock frequency, chip address, etc.). Other info might not need to be encoded into the hardware description (note: in some platforms, the only way to update the hardware device tree is with a system reboot).
IMHO, the ideal for MAX22007 CRC would be to have some sort of CRC toggle device property. That way, the user would be able to enable/disable CRC at runtime, and there would be no need to have a CRC property in dt. Though I didn't find any documented ABI for that so it would have to be proposed. An alternative might be to always have CRC checking enabled on initial MAX22007 support.

That said, there is indeed some precedent for CRC dt properties.
regulator/nxp,pf0900.yaml (nxp,i2c-crc-enable)
net/adi,adin1110.yaml (adi,spi-crc)
mtd/qcom,nandc.yaml (qcom,cmd-crci and qcom,data-crci) (looks like CRC but not really sure)
qcom/qcom,gsbi.yaml (qcom,crci) (not sure it's about CRC either)
If you are confident that you do need a CRC dt prop for MAX22007, then please use adi,spi-crc (so we may at least try to keep only a few property names).


reset-gpios:
maxItems: 1
description:
GPIO used for hardware reset of the device.

patternProperties:
"^channel@[0-3]$":
allOf:
- $ref: /schemas/iio/dac/dac.yaml#
- type: object
description:
Represents the external channels which are connected to the DAC.
Channels not specified in the device tree will be powered off.

properties:
reg:
description: Channel number
maxItems: 1

output-range-microamp:
type: array
items:
type: integer
minItems: 2
maxItems: 2
description: Min and max output range in microamps.

unevaluatedProperties: false

required:
- compatible
- reg

anyOf:
- required: [channel@0]
- required: [channel@1]
- required: [channel@2]
- required: [channel@3]


unevaluatedProperties: false

examples:
- |
#include <dt-bindings/gpio/gpio.h>
spi {
#address-cells = <1>;
#size-cells = <0>;

dac@0 {
compatible = "adi,max22007";
reg = <0>;
spi-max-frequency = <500000>;
reset-gpios = <&gpio 19 GPIO_ACTIVE_LOW>;
#address-cells = <1>;
#size-cells = <0>;

channel@0 {
reg = <0>;
};

channel@1 {
reg = <1>;
output-range-microamp = <0 25000>;
};
};
};
...
1 change: 1 addition & 0 deletions Documentation/iio/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,4 @@ Industrial I/O Kernel Drivers
adxl380
bno055
ep93xx_adc
max22007
171 changes: 171 additions & 0 deletions Documentation/iio/max22007.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
.. SPDX-License-Identifier: GPL-2.0-only

===============
MAX22007 driver
===============

Device driver for Analog Devices Inc. MAX22007 quad-channel industrial DAC.
The module name is ``max22007``.

Supported devices
=================

* `MAX22007 <https://www.analog.com/en/products/max22007.html>`_

Wiring connections
==================

The MAX22007 uses a standard SPI interface.

Device Tree Configuration
=========================

The device supports both global and per-channel configuration through device tree.

Global Properties:
* ``adi,crc-disable``: Disable CRC8 error checking for SPI communications (optional, CRC enabled by default)
* ``reset-gpios``: GPIO pin for hardware reset (optional, falls back to software reset if not specified)
* ``vdd-supply``: Low-Voltage Power Supply from +2.7V to +5.5V (optional)
* ``hvdd-supply``: Positive High-Voltage Power Supply from +8V to (HVSS +24V) for the Output Channels (optional)
* ``hvss-supply``: Negative High-Voltage Power Supply from -2V to 0V for the Output Channels (optional)

Per-channel properties:
* ``output-range-microvolt``: Specify the channel output range in microvolts for voltage mode channels
* ``output-range-microamp``: Specify the channel output range in microamperes for current mode channels

Note: The driver operates in transparent mode (immediate register-to-output updates).
Channel mode is determined by the presence of output-range properties:
- If ``output-range-microamp`` is present, the channel operates in current mode
- Otherwise, the channel defaults to voltage mode

Device attributes
=================

The MAX22007 driver provides IIO DAC interfaces that vary based on the
configured channel mode. Each channel appears as a separate IIO device
attribute:

* ``out_voltage_raw`` (voltage mode channels)
* ``out_current_raw`` (current mode channels)
* ``out_voltage_scale`` / ``out_current_scale`` (channel scaling factors)
* ``out_voltage_powerdown`` / ``out_current_powerdown`` (channel power control)

The driver automatically configures the IIO channel type based on the configured
channel mode from device tree.

Power Mode Control
==================

Each channel provides standard IIO ``powerdown`` attributes for runtime power control:

* Write ``1`` to power down (disable) the channel output
* Write ``0`` to power up (enable) the channel output
* Read the attribute to get the current power state (1=powered down, 0=powered up)

This allows individual channels to be powered on/off independently for power
management and safety purposes.

Usage Examples
==============

Setting DAC output values:

.. code-block:: bash

# Set channel 0 (voltage mode) to raw value 655 (≈2V)
# Output is updated immediately in transparent mode
echo 655 > /sys/bus/iio/devices/iio:deviceX/out_voltage0_raw

# Set channel 1 (current mode)
# Output is updated immediately in transparent mode
echo 1024 > /sys/bus/iio/devices/iio:deviceX/out_current1_raw

Controlling channel power modes:

.. code-block:: bash

# Enable channel 0 (power up)
echo 0 > /sys/bus/iio/devices/iio:deviceX/out_voltage0_powerdown

# Disable channel 1 (power down)
echo 1 > /sys/bus/iio/devices/iio:deviceX/out_current1_powerdown

# Check current power state (0=powered up, 1=powered down)
cat /sys/bus/iio/devices/iio:deviceX/out_voltage0_powerdown

Reading channel values and scale factors:

.. code-block:: bash

# Read raw DAC value
cat /sys/bus/iio/devices/iio:deviceX/out_voltage0_raw

# Read scale factor (volts per LSB)
cat /sys/bus/iio/devices/iio:deviceX/out_voltage0_scale

Check available channels:

.. code-block:: bash

ls /sys/bus/iio/devices/iio:deviceX/out_*_raw

Scale Calculations
==================

The driver provides accurate scale factors based on the hardware configuration:

**Voltage Mode:**
- Scale = (5 × 2.5V) / 4096 = 0.003051757 V per LSB
- Range: 0V to 12.5V over 12-bit (0-4095)
- Formula: Output = Raw_Value × Scale

**Current Mode:**
- Scale = (2.5V / (2 × 50Ω)) / 4096 = 0.000006103515625 A per LSB
- Range: 0A to 0.025A over 12-bit (0-4095)
- Formula: Output = Raw_Value × Scale

Register Map
------------

The MAX22007 uses the following register mapping:

.. list-table::
:header-rows: 1

* - Address
- Register Name
- Description
* - 0x03
- CONFIG_REG
- Configuration register (CRC enable, DAC latch modes)
* - 0x04
- CONTROL_REG
- LDAC control register for runtime updates
* - 0x05
- CHANNEL_MODE_REG
- Channel mode and power control
* - 0x06
- SOFT_RESET_REG
- Software reset control
* - 0x07-0x0A
- DAC_CHANNEL_REG(0-3)
- DAC data registers for channels 0-3


Driver Architecture
===================

The driver implements the following key features:

* **CRC8 Error Checking**: All SPI communications use CRC8 for data integrity
* **Channel Configuration**: Supports per-channel mode and power configuration
* **Register Map**: Uses regmap for efficient register access and caching
* **IIO Integration**: Full integration with the Linux IIO subsystem

Not Implemented
===============

* Channel configuration (voltage/current mode) is set at device tree parsing
and cannot be changed dynamically
* The driver requires proper device tree configuration for optimal operation
* Simultaneous multi-channel LDAC updates (only single-channel updates supported)
1 change: 1 addition & 0 deletions arch/arm/boot/dts/overlays/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,7 @@ dtbo-$(CONFIG_ARCH_BCM2835) += \
rpi-ltc6952.dtbo \
rpi-max14830-i2c.dtbo \
rpi-max14830-spi.dtbo \
rpi-max22007.dtbo \
rpi-max31335.dtbo \
rpi-poe.dtbo \
rpi-poe-plus.dtbo \
Expand Down
52 changes: 52 additions & 0 deletions arch/arm/boot/dts/overlays/rpi-max22007-overlay.dts
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// SPDX-License-Identifier: GPL-2.0
/*
* Analog Devices MAX22007
*
* Copyright (C) 2025 Analog Devices Inc.
*/

/dts-v1/;
/plugin/;

#include <dt-bindings/gpio/gpio.h>

&spi0 {
status = "okay";

max22007: max22007@0 {
compatible = "adi,max22007";
reg = <0>;
spi-max-frequency = <500000>;
spi-cpha;
spi-cpol;
status = "okay";
reset-gpios = <&gpio 19 GPIO_ACTIVE_LOW>;
#address-cells = <1>;
#size-cells = <0>;

channel@0 {
reg = <0>;
};

channel@1 {
reg = <1>;
output-range-microamp = <0 25000>;
};

channel@2 {
reg = <2>;
};

channel@3 {
reg = <3>;
};
};

Check warning on line 43 in arch/arm/boot/dts/overlays/rpi-max22007-overlay.dts

View workflow job for this annotation

GitHub Actions / build_gcc_arm / build

(avoid_default_addr_size): /fragment@0/__overlay__/max22007@0: Relying on default #size-cells value

Check warning on line 43 in arch/arm/boot/dts/overlays/rpi-max22007-overlay.dts

View workflow job for this annotation

GitHub Actions / build_gcc_arm / build

(avoid_default_addr_size): /fragment@0/__overlay__/max22007@0: Relying on default #address-cells value
};

&spidev0 {
status = "disabled";
};

&spidev1 {
status = "disabled";
};
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The overlay is a different patch.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we keep it here until review and then move it later on? (please correct me if my understanding is wrong)

13 changes: 13 additions & 0 deletions drivers/iio/dac/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,19 @@ config MAX517
This driver can also be built as a module. If so, the module
will be called max517.

config MAX22007
tristate "Analog Devices MAX22007 DAC Driver"
depends on SPI
select REGMAP_SPI
select CRC8
help
Say Y here if you want to build a driver for Analog Devices MAX22007.

MAX22007 is a quad-channel, 12-bit, voltage-output digital to
analog converter (DAC) with SPI interface.

If compiled as a module, it will be called max22007.

config MAX5522
tristate "Maxim MAX5522 DAC driver"
depends on SPI_MASTER
Expand Down
1 change: 1 addition & 0 deletions drivers/iio/dac/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ obj-$(CONFIG_LTC2664) += ltc2664.o
obj-$(CONFIG_LTC2688) += ltc2688.o
obj-$(CONFIG_M62332) += m62332.o
obj-$(CONFIG_MAX517) += max517.o
obj-$(CONFIG_MAX22007) += max22007.o
obj-$(CONFIG_MAX5522) += max5522.o
obj-$(CONFIG_MAX5821) += max5821.o
obj-$(CONFIG_MCP4725) += mcp4725.o
Expand Down
Loading
Loading