PAW3212 driver

The PAW3212 driver implements a PAW3212 motion sensor driver that is compatible with Zephyr’s Sensors.

The sensor driver supports the following features:

  • Motion data readouts for X and Y axes

  • SENSOR_TRIG_DATA_READY trigger

  • Configuring attributes of the PAW3212 sensor

Note

The PAW3212 driver is similar to PMW3360 driver, but it allows customizing motion data length instead of CPI and downshift values, as detailed in Kconfig configuration. Also, this sensor does not support burst mode.

Configuration

To use the sensor, you must provide a valid hardware configuration of the sensor in the Devicetree Specification (DTS) and enable and configure the driver in Kconfig.

Devicetree Specification configuration

The following code snippet shows an example DTS configuration:

&spi0 {
        compatible = "nordic,nrf-spim";
        status = "okay";
        sck-pin = <10>;
        mosi-pin = <12>;
        miso-pin = <12>;
        cs-gpios = <&gpio0 15 0>;

        paw3212@0 {
                compatible = "pixart,paw3212";
                reg = <0>;
                irq-gpios = <&gpio0 14 0>;
                spi-max-frequency = <2000000>;
                label = "PAW3212";
        };
};

The PAW3212 sensor node must meet the following requirements:

  • It must be a child node of a SPI node.

  • It must be compatible with pixart,paw3212.

Moreover, you must configure the following parameters:

  • Pins used by the SPI that are common for all devices connected to the bus:

    • mosi-pin - MOSI

    • miso-pin - MISO

    • sck-pin - SCK

  • Chip select (CS) pin for the PAW3212 motion sensor. GPIOs used as chip select for the devices connected to the SPI are defined as cs-gpios. The @0 in paw3212@0 refers to the position of the chip select pin of the motion sensor in the array.

  • Parameters inherited from the spi-device binding that are defined for every SPI device:

    • reg - The slave ID number the device has on a bus.

    • label - Name of the device. Used to get device binding with device_get_binding().

    • spi-max-frequency - Used for setting the bus clock frequency.

  • Pin to which the motion sensor IRQ line is connected (irq-gpios).

See Devicetree Guide for more detailed information about the DTS data structure.

Note

The motion sensor driver implementation does not benefit from the SPI context lock. The operation related to the PAW3212 motion sensor can be interrupted by data exchange with another sensor connected over the same SPI interface. If other sensors use the same SPI interface, you must ensure that SPI operations are not preempted.

Kconfig configuration

Use the following Kconfig options to configure the PAW3212 motion sensor:

See Kconfig - Tips and Best Practices for information about Kconfig.

Sensor API calls

Read the following sections for information about the Sensors calls supported by the motion sensor.

Note

Driver initialization is performed asynchronously using a delayed work that resubmits itself. This is done to prevent delaying system start.

The sensor returns -EBUSY if the sensor API is used before the asynchronous initialization is completed.

Motion data reading

Use the following operations to read the motion data:

  • Fetch motion data using SENSOR_CHAN_ALL. Fetching sensor channels separately is not supported.

  • Read data for motion in the X and Y axes using SENSOR_CHAN_POS_DX and SENSOR_CHAN_POS_DY, respectively.

Sensor trigger

The sensor supports SENSOR_TRIG_DATA_READY trigger for SENSOR_CHAN_ALL. The trigger handler is called when motion is detected.

Sensor attributes

The sensor supports a custom set of attributes that are not part of generic sensor attributes defined by Zephyr’s Sensors API. The attribues are defined as private to the motion sensor in the sensor’s header file. See API documentation for details.

API documentation

Header file: include/sensor/paw3212.h
Source file: drivers/sensor/paw3212/paw3212.c
group paw3212

PAW3212 motion sensor driver.

Enums

enum paw3212_attribute

Sensor specific attributes of PAW3212.

Values:

enumerator PAW3212_ATTR_CPI

Sensor CPI for both X and Y axes.

enumerator PAW3212_ATTR_SLEEP_ENABLE

Enable or disable sleep modes.

enumerator PAW3212_ATTR_SLEEP1_TIMEOUT

Entering time from Run mode to Sleep1 mode [ms].

enumerator PAW3212_ATTR_SLEEP2_TIMEOUT

Entering time from Run mode to Sleep2 mode [ms].

enumerator PAW3212_ATTR_SLEEP3_TIMEOUT

Entering time from Run mode to Sleep3 mode [ms].

enumerator PAW3212_ATTR_SLEEP1_SAMPLE_TIME

Sampling frequency time during Sleep1 mode [ms].

enumerator PAW3212_ATTR_SLEEP2_SAMPLE_TIME

Sampling frequency time during Sleep2 mode [ms].

enumerator PAW3212_ATTR_SLEEP3_SAMPLE_TIME

Sampling frequency time during Sleep3 mode [ms].