:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: infineon,autanalog-ptcomp-comp
.. _dtbinding_infineon_autanalog_ptcomp_comp:

infineon,autanalog-ptcomp-comp
##############################

.. sidebar:: Overview

   :Name: ``infineon,autanalog-ptcomp-comp``
   :Vendor: :ref:`Infineon Technologies <dt_vendor_infineon>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=infineon,autanalog-ptcomp-comp>` using
               this compatible
   :Driver: :zephyr_file:`drivers/comparator/comparator_infineon_autanalog_ptcomp.c`

Description
***********



.. code-block:: none

   Infineon AutAnalog PTComp comparator.

   Each node represents one of the two comparators (Comp0 or Comp1) within
   a PTComp block. The comparator compares the voltage on the non-inverting
   input to the voltage on the inverting input and produces a digital output.

   Input routing is configured via positive-mux and negative-mux properties
   using the cy_en_autanalog_ptcomp_comp_mux_t values:
     0  = CTB0 Pin 1            8  = CTB0 OA0 output
     1  = CTB0 Pin 4            9  = CTB0 OA1 output
     2  = CTB0 Pin 6           10  = CTB1 OA0 output
     3  = CTB0 Pin 7           11  = CTB1 OA1 output
     4  = CTB1 Pin 1           12  = DAC0 (VREF0)
     5  = CTB1 Pin 4           13  = DAC1 (VREF1)
     6  = CTB1 Pin 6           14  = PRB OUT0 (VREF2)
     7  = CTB1 Pin 7           15  = PRB OUT1 (VREF3)
     16-23 = SAR/PTC GPIO Pin 0-7

   The parent node must have compatible "infineon,autanalog-ptcomp".

Examples
********

.. code-block:: dts

   /*
    * Use constants from <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.
    */
   ptcomp0: ptcomp@0 {
       compatible = "infineon,autanalog-ptcomp";
       status = "okay";

       comp0: comp@0 {
           compatible = "infineon,autanalog-ptcomp-comp";
           reg = <0>;
           power-mode = <IFX_AUTANALOG_PTCOMP_PWR_NORMAL>;
           interrupt-mode = <IFX_AUTANALOG_PTCOMP_INT_EDGE_RISING>;
           positive-mux = <IFX_AUTANALOG_PTCOMP_MUX_GPIO2>;
           negative-mux = <IFX_AUTANALOG_PTCOMP_MUX_PRB_OUT0>;
       };
   };



----

.. code-block:: dts

   /*
    * Advanced mode: 2 dynamic mux config slots on comp@0.
    * Each child node is one slot with named properties.
    */
   ptcomp0: ptcomp@0 {
       compatible = "infineon,autanalog-ptcomp";
       status = "okay";

       comp0: comp@0 {
           compatible = "infineon,autanalog-ptcomp-comp";
           reg = <0>;
           power-mode = <IFX_AUTANALOG_PTCOMP_PWR_NORMAL>;
           interrupt-mode = <IFX_AUTANALOG_PTCOMP_INT_EDGE_RISING>;
           positive-mux = <IFX_AUTANALOG_PTCOMP_MUX_GPIO2>;
           negative-mux = <IFX_AUTANALOG_PTCOMP_MUX_PRB_OUT0>;

           dyn-cfg-0 {
               positive-mux = <IFX_AUTANALOG_PTCOMP_MUX_GPIO2>;
               negative-mux = <IFX_AUTANALOG_PTCOMP_MUX_PRB_OUT0>;
           };

           dyn-cfg-1 {
               positive-mux = <IFX_AUTANALOG_PTCOMP_MUX_GPIO2>;
               negative-mux = <IFX_AUTANALOG_PTCOMP_MUX_DAC0>;
           };
       };
   };


Properties
**********

Top level properties
====================


These property descriptions apply to "infineon,autanalog-ptcomp-comp"
nodes themselves. This page also describes child node
properties in the following sections.

.. 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

         * - ``power-mode``
           - ``int``
           - .. code-block:: none

                Comparator power mode.
                Use IFX_AUTANALOG_PTCOMP_PWR_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.
                  IFX_AUTANALOG_PTCOMP_PWR_OFF    (0) - Off
                  IFX_AUTANALOG_PTCOMP_PWR_ULP    (1) - Ultra-low power (< 300nA, 7us)
                  IFX_AUTANALOG_PTCOMP_PWR_LP     (2) - Low power (< 10uA, 1us)
                  IFX_AUTANALOG_PTCOMP_PWR_NORMAL (3) - Normal (< 150uA, 0.1us)



             This property is **required**.

             Legal values: ``0``, ``1``, ``2``, ``3``

         * - ``hysteresis``
           - ``boolean``
           - .. code-block:: none

                Enable 30mV input hysteresis for the comparator.



         * - ``interrupt-mode``
           - ``int``
           - .. code-block:: none

                Edge detection mode for comparator interrupts.
                Use IFX_AUTANALOG_PTCOMP_INT_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.
                  IFX_AUTANALOG_PTCOMP_INT_DISABLED     (0) - Disabled
                  IFX_AUTANALOG_PTCOMP_INT_EDGE_RISING  (1) - Rising edge
                  IFX_AUTANALOG_PTCOMP_INT_EDGE_FALLING (2) - Falling edge
                  IFX_AUTANALOG_PTCOMP_INT_EDGE_BOTH    (3) - Both edges



         * - ``positive-mux``
           - ``int``
           - .. code-block:: none

                Non-inverting (positive) input mux selector.
                Use IFX_AUTANALOG_PTCOMP_MUX_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>, values 0-23.



             This property is **required**.

         * - ``negative-mux``
           - ``int``
           - .. code-block:: none

                Inverting (negative) input mux selector.
                Use IFX_AUTANALOG_PTCOMP_MUX_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>, values 0-23.



             This property is **required**.

         * - ``pp-input-source``
           - ``int``
           - .. code-block:: none

                Post-processing input source.
                Use IFX_AUTANALOG_PTCOMP_PP_SRC_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.
                  IFX_AUTANALOG_PTCOMP_PP_SRC_DISABLED (0)
                  IFX_AUTANALOG_PTCOMP_PP_SRC_COMP0    (1)
                  IFX_AUTANALOG_PTCOMP_PP_SRC_COMP1    (2)



             Legal values: ``0``, ``1``, ``2``

         * - ``pp-input-type``
           - ``int``
           - .. code-block:: none

                Post-processing edge/level sensing type.
                Use IFX_AUTANALOG_PTCOMP_PP_TYPE_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.
                  IFX_AUTANALOG_PTCOMP_PP_TYPE_LEVEL        (0)
                  IFX_AUTANALOG_PTCOMP_PP_TYPE_EDGE_RISING  (1)
                  IFX_AUTANALOG_PTCOMP_PP_TYPE_EDGE_FALLING (2)
                  IFX_AUTANALOG_PTCOMP_PP_TYPE_EDGE_BOTH    (3)



             Legal values: ``0``, ``1``, ``2``, ``3``

         * - ``pp-count-mode``
           - ``int``
           - .. code-block:: none

                Post-processing counter mode.
                Use IFX_AUTANALOG_PTCOMP_PP_MODE_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.
                  IFX_AUTANALOG_PTCOMP_PP_MODE_DIRECT (0) - Count events, reset on condition
                  IFX_AUTANALOG_PTCOMP_PP_MODE_FRAME  (1) - Count events within a frame period
                  IFX_AUTANALOG_PTCOMP_PP_MODE_WINDOW (2) - Sliding window counter



             Legal values: ``0``, ``1``, ``2``

         * - ``pp-data-function``
           - ``int``
           - .. code-block:: none

                Post-processing LUT boolean function combining both comp outputs.
                Use IFX_AUTANALOG_PTCOMP_PP_FUNC_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>, values 0-13.



         * - ``pp-window-size``
           - ``int``
           - .. code-block:: none

                Post-processing window size for WINDOW mode.
                Use IFX_AUTANALOG_PTCOMP_PP_WIN_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.
                  IFX_AUTANALOG_PTCOMP_PP_WIN_2   (0)
                  IFX_AUTANALOG_PTCOMP_PP_WIN_4   (1)
                  IFX_AUTANALOG_PTCOMP_PP_WIN_8   (2)
                  IFX_AUTANALOG_PTCOMP_PP_WIN_16  (3)
                  IFX_AUTANALOG_PTCOMP_PP_WIN_32  (4)
                  IFX_AUTANALOG_PTCOMP_PP_WIN_64  (5)
                  IFX_AUTANALOG_PTCOMP_PP_WIN_128 (6)



             Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``

         * - ``pp-period``
           - ``int``
           - .. code-block:: none

                Post-processing frame period in clock cycles (FRAME mode).



         * - ``pp-limit-condition``
           - ``int``
           - .. code-block:: none

                Post-processing counter limit condition.
                Use IFX_AUTANALOG_PTCOMP_PP_COND_* constants from
                <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.
                  IFX_AUTANALOG_PTCOMP_PP_COND_BELOW   (0) - Below threshold-low
                  IFX_AUTANALOG_PTCOMP_PP_COND_INSIDE  (1) - Between low and high
                  IFX_AUTANALOG_PTCOMP_PP_COND_ABOVE   (2) - Above threshold-high
                  IFX_AUTANALOG_PTCOMP_PP_COND_OUTSIDE (3) - Below low or above high



             Legal values: ``0``, ``1``, ``2``, ``3``

         * - ``pp-threshold-low``
           - ``int``
           - .. code-block:: none

                Post-processing low threshold for counter range detection.



         * - ``pp-threshold-high``
           - ``int``
           - .. code-block:: none

                Post-processing high threshold for counter range detection.





   .. 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 "infineon,autanalog-ptcomp-comp" compatible.

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

         * - Name
           - Type
           - Details

         * - ``reg``
           - ``array``
           - .. code-block:: none

                Comparator index within the PTComp block (0 or 1).



             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"



         * - ``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 <u32> 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 <u32> 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.



         * - ``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.






Child node properties
=====================

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

   * - Name
     - Type
     - Details

   * - ``positive-mux``
     - ``int``
     - .. code-block:: none

          Non-inverting (positive) input mux selector.
          Use IFX_AUTANALOG_PTCOMP_MUX_* constants from
          <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.



   * - ``negative-mux``
     - ``int``
     - .. code-block:: none

          Inverting (negative) input mux selector.
          Use IFX_AUTANALOG_PTCOMP_MUX_* constants from
          <dt-bindings/comparator/infineon-autanalog-ptcomp.h>.