analog-axis

Vendor: Generic or vendor-independent

Note

An implementation of a driver matching this compatible is available in drivers/input/input_analog_axis.c.

Description

ADC based analog axis input device

Implement an input device generating absolute axis events by periodically
reading from some ADC channels.

Example configuration:

#include <zephyr/dt-bindings/input/input-event-codes.h>

analog_axis {
        compatible = "analog-axis";
        poll-period-ms = <15>;
        axis-x {
                io-channels = <&adc 0>;
                in-deadzone = <50>;
                in-min = <100>;
                in-max = <800>;
                zephyr,axis = <INPUT_ABS_X>;
        };
};

Properties

Top level properties

These property descriptions apply to “analog-axis” nodes themselves. This page also describes child node properties in the following sections.

Node specific properties

Properties not inherited from the base binding file.

Name	Type	Details
poll-period-ms	int	How often to get new ADC samples for the various configured axes in milliseconds. Defaults to 15ms if unspecified. Default value: 15

Deprecated node specific properties

Deprecated properties not inherited from the base binding file.

(None)

Base properties

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 “analog-axis” compatible.

Name	Type	Details
status	string	indicates the operational status of a device Legal values: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss' See Important properties for more information.
compatible	string-array	compatible strings This property is required. See Important properties for more information.
reg	array	register space See Important properties for more information.
reg-names	string-array	name of each register space
interrupts	array	interrupts for device See Important properties for more information.
interrupts-extended	compound	extended interrupt specifier for device
interrupt-names	string-array	name of each interrupt
interrupt-parent	phandle	phandle to interrupt controller node
label	string	Human readable string describing the device (used as device_get_binding() argument) See Important properties for more information. This property is deprecated.
clocks	phandle-array	Clock gate information
clock-names	string-array	name of each clock
#address-cells	int	number of address cells in reg property
#size-cells	int	number of size cells in reg property
dmas	phandle-array	DMA channels specifiers
dma-names	string-array	Provided names of DMA channel specifiers
io-channels	phandle-array	IO channels specifiers
io-channel-names	string-array	Provided names of IO channel specifiers
mboxes	phandle-array	mailbox / IPM channels specifiers
mbox-names	string-array	Provided names of mailbox / IPM channel specifiers
power-domains	phandle-array	Power domain specifiers
power-domain-names	string-array	Provided names of power domain specifiers
#power-domain-cells	int	Number of cells in power-domains property
zephyr,deferred-init	boolean	Do not initialize device automatically on boot. Device should be manually initialized using device_init().
wakeup-source	boolean	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.
zephyr,pm-device-runtime-auto	boolean	Automatically configure the device for runtime power management after the init function runs.
zephyr,disabling-power-states	phandles	List of power states that will disable this device power.

Child node properties

Name	Type	Details
io-channels	phandle-array	ADC IO channel to use. This property is required.
out-min	int	Minimum value to output on input events. Defaults to 0 if unspecified.
out-max	int	Maximum value to output on input events. Defaults to 255 if unspecified. Default value: 255
in-deadzone	int	Deadzone for the input center value. If specified input values between the center of the range plus or minus this value will be reported as center. Defaults to 0, no deadzone.
in-min	int	Input value that corresponds to the minimum output value. This property is required.
in-max	int	Input value that corresponds to the maximum output value. This property is required.
zephyr,axis	int	The input code for the axis to report for the device, typically any of INPUT_ABS_*. This property is required.
invert-input	boolean	If set, invert the raw ADC value before processing it. Useful for differential channels.
invert-output	boolean	If set, invert the output value.