: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:: silabs,vdac
.. _dtbinding_silabs_vdac:

silabs,vdac
###########

Vendor: :ref:`Silicon Laboratories <dt_vendor_silabs>`

.. note::

   An implementation of a driver matching this compatible is available in
   :zephyr_file:`drivers/dac/dac_silabs_vdac.c`.

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



.. code-block:: none

   Silicon Labs Series 2 VDAC (Voltage Digital-to-Analog Converter)


   The VDAC has two channels, a resolution of 12-bit and a configurable output
   range from 0V to 2.5V.

   The minimal default configuration for the Silabs VDAC node is as follows:

     #include <zephyr/dt-bindings/dac/silabs-vdac.h>

     &vdac0 {
       status = "okay";
       voltage-reference = "2.5V";
       channel@0 {
         reg = <0>;
         main-output;
       };
     };

   Using the main output is the preferred way for any DAC output. Defines like
   `VDAC0_CH0_MAIN_OUT_PIN` exists in em_device.h to get the dedicated pin for
   your device.

   It is also possible to use the auxiliary output to route the output to other
   peripherals like the IADC or the ACMP, or to the analog bus to output on any GPIO.
   Note that the analog bus multiplexer adds significant impedance, and this option
   may not be suitable for certain loads or dynamic conditions.

   To connect the analog bus to a GPIO, the `pinctrl` driver must be configured to
   allocate an analog bus corresponding to the port and pin of each GPIO input selected.
   The following is an example of how that can be configured:

     #include <zephyr/dt-bindings/pinctrl/silabs/xg24-pinctrl.h>
     #include <zephyr/dt-bindings/dac/silabs-vdac.h>

     &pinctrl {
       vdac0_default: vdac0_default {
         group0 {
           silabs,analog-bus = <ABUS_CDODD0_VDAC0CH0>;
         };
         group1 {
           silabs,analog-bus = <ABUS_CDEVEN1_VDAC0CH1>;
         };
     };

     &vdac0 {
       pinctrl-0 = <&vdac0_default>;
       pinctrl-names = "default";
       status = "okay";
       voltage-reference = "1.25V";
       channel@0 {
         reg = <0>;
         aux-output = <VDAC_OUTPUT_PC1>;
       };
       channel@1 {
         reg = <1>;
         aux-output = <VDAC_OUTPUT_PC2>;
       };
     };

   In the above example, note that the device specific bindings for pinctrl
   were included. This header defines the set of analog bus allocations possible
   for xg24 parts, and similar headers exist for other parts.

Properties
**********

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


These property descriptions apply to "silabs,vdac"
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

         * - ``voltage-reference``
           - ``string``
           - .. code-block:: none

                Reference voltage to use.
                The default corresponds to the reset value of the register field.



             Default value: ``1.25V``

             Legal values: ``'1.25V'``, ``'2.5V'``, ``'AVDD'``, ``'VREFP'``

         * - ``warmup-cycles``
           - ``int``
           - .. code-block:: none

                Number of prescaled CLK_VDAC + 1 for the DAC to warmup.
                This determines how many clock cycles are needed for the DAC to stabilize
                before it can be used for conversions.
                The default corresponds to the reset value of the register field.



         * - ``refresh-period-cycles``
           - ``int``
           - .. code-block:: none

                Channel refresh period configuration.
                Determines how often the DAC channels are refreshed to maintain accuracy.
                The default corresponds to the reset value of the register field.



             Default value: ``2``

             Legal values: ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, ``256``

         * - ``#io-channel-cells``
           - ``int``
           - This property is **required**.

             Constant value: ``1``

         * - ``pinctrl-0``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the first state. Content is specific to the
                selected pin controller driver implementation.



         * - ``pinctrl-1``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the second state. See pinctrl-0.



         * - ``pinctrl-2``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the third state. See pinctrl-0.



         * - ``pinctrl-3``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fourth state. See pinctrl-0.



         * - ``pinctrl-4``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fifth state. See pinctrl-0.



         * - ``pinctrl-names``
           - ``string-array``
           - .. code-block:: none

                Names for the provided states. The number of names needs to match the
                number of states.





   .. 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 "silabs,vdac" compatible.

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

         * - Name
           - Type
           - Details

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



             Constant value: ``1``

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



         * - ``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: ``'ok'``, ``'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``
           - ``array``
           - .. code-block:: none

                Information used to address the device. The value is specific to
                the device (i.e. is different depending on the compatible
                property).

                The "reg" property is typically a sequence of (address, length) pairs.
                Each pair is called a "register block". Values are
                conventionally written in hex.

                For details, see "2.3.6 reg" in Devicetree Specification v0.4.



             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.



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



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

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

          Channel identifier.



       This property is **required**.

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

       See :ref:`zephyr:dt-important-props` for more information.

   * - ``main-output``
     - ``boolean``
     - .. code-block:: none

          Connects the channel to the dedicated output pin.



   * - ``aux-output``
     - ``int``
     - .. code-block:: none

          Connects the low-power channel to the auxiliary outputs.
          Connects the channel to the specified output pin on the analog bus.



   * - ``short-output``
     - ``boolean``
     - .. code-block:: none

          Short-circuits the main and auxiliary outputs.
          Set to use high-power mode with auxiliary outputs.



   * - ``low-power-mode``
     - ``boolean``
     - .. code-block:: none

          Sets the power mode of the main output to low instead of high.



   * - ``high-capacitance-load``
     - ``boolean``
     - .. code-block:: none

          Enables high-capacitance load mode for the DAC channel.
          Only usable without low-power-mode.



   * - ``sample-off-mode``
     - ``boolean``
     - .. code-block:: none

          Enables sample-off mode for the DAC channel.
          If enabled, the output is only driven for a limited time per conversion.



   * - ``output-hold-cycles``
     - ``int``
     - .. code-block:: none

          Time in DAC clock cycles that the output is held for the DAC channel.
          Only usable with sample-off-mode.
          The default corresponds to the reset value of the register field.



   * - ``refresh-timer``
     - ``boolean``
     - .. code-block:: none

          Enables the refresh timer.



Specifier cell names
********************

- io-channel cells: output