:orphan: .. raw:: html .. dtcompatible:: adsemi,tsm12 .. _dtbinding_adsemi_tsm12: adsemi,tsm12 (on i2c bus) ######################### .. sidebar:: Overview :Name: ``adsemi,tsm12`` :Vendor: :ref:`AD Semiconductor Co., Ltd. ` :Used in: :zephyr:board-catalog:`List of boards <#compatibles=adsemi,tsm12>` using this compatible :Driver: :zephyr_file:`drivers/input/input_tsm12.c` Description *********** .. code-block:: none AD Semiconductor TSM12 12-channel capacitive touch sensor Also covers the register- and pin-compatible Si12T from Nanjing Zhongke Microelectronics. Each channel with an entry in input-codes reports an INPUT_EV_KEY event, pressed as soon as the sensor detects a touch of any strength. Examples ******** .. code-block:: dts #include #include &i2c0 { touch@68 { compatible = "adsemi,tsm12"; reg = <0x68>; int-gpios = <&gpio0 4 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>; input-codes = ; threshold-windows = "narrow", "narrow", "narrow"; }; }; Properties ********** .. tabs:: .. group-tab:: Node specific properties Properties not inherited from the base binding file. .. list-table:: :widths: 1 1 4 :header-rows: 1 * - Name - Type - Details * - ``int-gpios`` - ``phandle-array`` - .. code-block:: none Interrupt line (open drain, active low), asserted when a channel detects a touch. The sensor is polled when this property is absent. * - ``input-codes`` - ``array`` - .. code-block:: none Input event key codes (INPUT_KEY_* or INPUT_BTN_*), one per channel starting from channel 1. Channels without an entry are disabled. This property is **required**. Length range: ``1`` to ``12`` * - ``threshold-midpoints`` - ``array`` - .. code-block:: none Middle touch threshold of each channel (ChxM[2:0]), one entry per channel starting from channel 1; entries beyond input-codes are ignored. Higher values raise the threshold and make the channel less sensitive. The default corresponds to the reset value of the register field. Default value: ``[3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3]`` Maximum value: ``7`` Length range: ``1`` to ``12`` * - ``threshold-windows`` - ``string-array`` - .. code-block:: none Spacing of the light and hard touch thresholds around the middle threshold (ChxHL), one entry per channel starting from channel 1; entries beyond input-codes are ignored. A touch is reported from the light touch threshold on. The default corresponds to the reset value of the register field. - "narrow": 20% below and above the middle threshold. - "wide": 30% below and above the middle threshold, which reports lighter touches. Example thresholds (capacitance change) with "narrow": Midpoint | Light touch | Middle | Hard touch ---------|-------------|--------|----------- 0 | 0.40% | 0.50% | 0.60% 3 | 0.95% | 1.20% | 1.45% 7 | 2.85% | 3.55% | 4.30% Default value: ``[wide, wide, wide, wide, wide, wide, wide, wide, wide, wide, wide, wide]`` Legal values: ``narrow``, ``wide`` Length range: ``1`` to ``12`` * - ``supply-gpios`` - ``phandle-array`` - .. code-block:: none 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. * - ``vin-supply`` - ``phandle`` - .. code-block:: none 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. .. group-tab:: Deprecated node specific properties Deprecated properties not inherited from the base binding file. (None) .. group-tab:: 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 "adsemi,tsm12" compatible. .. list-table:: :widths: 1 1 4 :header-rows: 1 * - Name - Type - Details * - ``reg`` - ``array`` - .. code-block:: none device address on i2c bus This property is **required**. See :ref:`zephyr:dt-important-props` for more information. * - ``status`` - ``string`` - .. code-block:: none 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: ``okay``, ``disabled``, ``reserved``, ``fail``, ``fail-sss`` See :ref:`zephyr:dt-important-props` for more information. * - ``compatible`` - ``string-array`` - .. code-block:: none 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 :ref:`zephyr:dt-important-props` for more information. * - ``reg-names`` - ``string-array`` - .. code-block:: none 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" * - ``ranges`` - ``compound`` - .. code-block:: none 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. * - ``interrupts`` - ``array`` - .. code-block:: none 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 :ref:`zephyr:dt-important-props` for more information. * - ``interrupts-extended`` - ``compound`` - .. code-block:: none 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. * - ``interrupt-names`` - ``string-array`` - .. code-block:: none 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. * - ``interrupt-parent`` - ``phandle`` - .. code-block:: none 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. * - ``label`` - ``string`` - .. code-block:: none 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 :ref:`zephyr:dt-important-props` for more information. * - ``clocks`` - ``phandle-array`` - .. code-block:: none 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 * - ``clock-names`` - ``string-array`` - .. code-block:: none Optional names given to each clock provider in the "clocks" property. * - ``#address-cells`` - ``int`` - .. code-block:: none This property encodes the number of 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. * - ``#size-cells`` - ``int`` - .. code-block:: none This property encodes the number of 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. * - ``dma-coherent`` - ``boolean`` - .. code-block:: none Indicates that the device is capable of coherent DMA operations. For details, see "2.3.10 dma-coherent" in Devicetree Specification v0.4. * - ``dmas`` - ``phandle-array`` - .. code-block:: none DMA channel specifiers relevant to the device. * - ``dma-names`` - ``string-array`` - .. code-block:: none Optional names given to the DMA channel specifiers in the "dmas" property. * - ``dma-ranges`` - ``compound`` - .. code-block:: none 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-channels`` - ``phandle-array`` - .. code-block:: none IO channel specifiers relevant to the device. * - ``io-channel-names`` - ``string-array`` - .. code-block:: none Optional names given to the IO channel specifiers in the "io-channels" property. * - ``mboxes`` - ``phandle-array`` - .. code-block:: none Mailbox / IPM channel specifiers relevant to the device. * - ``mbox-names`` - ``string-array`` - .. code-block:: none Optional names given to the mbox specifiers in the "mboxes" property. * - ``power-domains`` - ``phandle-array`` - .. code-block:: none Power domain specifiers relevant to the device. * - ``power-domain-names`` - ``string-array`` - .. code-block:: none Optional names given to the power domain specifiers in the "power-domains" property. * - ``#power-domain-cells`` - ``int`` - .. code-block:: none Number of cells in power-domains property * - ``hwlocks`` - ``phandle-array`` - .. code-block:: none HW spinlock id relevant to the device. * - ``hwlock-names`` - ``string-array`` - .. code-block:: none Optional names given to the hwlock specifiers in the "hwlocks" property. * - ``zephyr,deferred-init`` - ``boolean`` - .. code-block:: none Do not initialize device automatically on boot. Device should be manually initialized using device_init(). * - ``wakeup-source`` - ``boolean`` - .. code-block:: none 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`` - .. code-block:: none Automatically configure the device for runtime power management after the init function runs. * - ``zephyr,disabling-power-states`` - ``phandles`` - .. code-block:: none List of power states that will disable this device power.