:orphan:
.. raw:: html
.. dtcompatible:: nordic,nrf-comp
.. _dtbinding_nordic_nrf_comp:
nordic,nrf-comp
###############
Vendor: :ref:`Nordic Semiconductor `
.. note::
An implementation of a driver matching this compatible is available in
:zephyr_file:`drivers/comparator/comparator_nrf_comp.c`.
Description
***********
.. code-block:: none
Nordic nRF COMP (analog COMParator)
This comparator has varying configurations which require varying
properties be set in the devicetree.
The following example displays the minimum node layout:
comp: comp@deadbeef {
compatible = "nordic,nrf-comp";
reg = <0xdeadbeef 0x1000>;
interrupts = <0 NRF_DEFAULT_IRQ_PRIORITY>;
status = "disabled";
};
Enabling the comparator node requires setting the default
configuration of the comparator.
The following example displays enabling the comparator in
single-ended mode, selecting an internal reference:
&comp {
status = "okay";
main-mode = "SE";
psel = "AIN0";
refsel = "INT_1V2";
sp-mode = "NORMAL";
th-up = <36>;
th-down = <30>;
isource = "OFF";
};
To select an external reference, select the "AREF"
reference and add the external reference:
&comp {
...
refsel = "AREF";
extrefsel = "AIN1";
...
};
The following example displays enabling the comparator
in differential mode:
&comp {
status = "okay";
main-mode = "DIFF";
psel = "AIN0";
extrefsel = "AIN1";
sp-mode = "NORMAL";
hyst = "50MV";
isource = "OFF";
};
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
* - ``main-mode``
- ``string``
- Legal values: ``'SE'``, ``'DIFF'``
* - ``psel``
- ``string``
- Legal values: ``'AIN0'``, ``'AIN1'``, ``'AIN2'``, ``'AIN3'``, ``'AIN4'``, ``'AIN5'``, ``'AIN6'``, ``'AIN7'``, ``'VDD_DIV2'``, ``'VDDH_DIV5'``
* - ``extrefsel``
- ``string``
- Legal values: ``'AIN0'``, ``'AIN1'``, ``'AIN2'``, ``'AIN3'``, ``'AIN4'``, ``'AIN5'``, ``'AIN6'``, ``'AIN7'``
* - ``refsel``
- ``string``
- Legal values: ``'INT_1V2'``, ``'INT_1V8'``, ``'INT_2V4'``, ``'AVDDAO1V8'``, ``'VDD'``, ``'AREF'``
* - ``enable-hyst``
- ``boolean``
-
* - ``sp-mode``
- ``string``
- Legal values: ``'LOW'``, ``'NORMAL'``, ``'HIGH'``
* - ``th-up``
- ``int``
-
* - ``th-down``
- ``int``
-
* - ``isource``
- ``string``
- Legal values: ``'DISABLED'``, ``'2UA5'``, ``'5UA'``, ``'10UA'``
.. 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 "nordic,nrf-comp" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``status``
- ``string``
- .. code-block:: none
indicates the operational status of a device
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
register space
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
name of each register space
* - ``interrupts``
- ``array``
- .. code-block:: none
interrupts for device
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
extended interrupt specifier for device
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
name of each interrupt
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
phandle to interrupt controller node
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device (used as device_get_binding() argument)
See :ref:`zephyr:dt-important-props` for more information.
This property is **deprecated**.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
* - ``clock-names``
- ``string-array``
- .. code-block:: none
name of each clock
* - ``#address-cells``
- ``int``
- .. code-block:: none
number of address cells in reg property
* - ``#size-cells``
- ``int``
- .. code-block:: none
number of size cells in reg property
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channels specifiers
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Provided names of DMA channel specifiers
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channels specifiers
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Provided names of IO channel specifiers
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
mailbox / IPM channels specifiers
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Provided names of mailbox / IPM channel specifiers
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Provided names of power domain specifiers
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains 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.