: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:: microchip,sam-d5x-e5x-fdpll
.. _dtbinding_microchip_sam_d5x_e5x_fdpll:

microchip,sam-d5x-e5x-fdpll
###########################

.. sidebar:: Overview

   :Name: ``microchip,sam-d5x-e5x-fdpll``
   :Vendor: :ref:`Microchip Technology Inc. <dt_vendor_microchip>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=microchip,sam-d5x-e5x-fdpll>` using
               this compatible

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



.. code-block:: none

   SAM_D5x_E5x FDPLL clock

   Digital Phase Locked Loop (FDPLL), 96 MHz to 200 MHz output frequency from a 32 kHz to 3.2 MHz
   reference clock.

Properties
**********

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


These property descriptions apply to "microchip,sam-d5x-e5x-fdpll"
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.

      (None)

   .. 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 "microchip,sam-d5x-e5x-fdpll" compatible.

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

         * - Name
           - Type
           - Details

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



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



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

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

          Clock subsystem


       This property is **required**.

   * - ``fdpll-on-demand-en``
     - ``int``
     - .. code-block:: none

          0: The oscillator is always on
          1: The oscillator is running when a peripheral is requesting the oscillator to be used as a
          clock source. The oscillator is not running if no peripheral is requesting the clock source.
          Important: Initializing it with 1, along with clock enabled, can lead to indefinite wait
          for the clock to be on, if there is no peripheral request for the clock in the sequence of
          clock Initialization. If required, better to turn on the clock using API, instead of
          enabling both during startup.



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

   * - ``fdpll-run-in-standby-en``
     - ``int``
     - .. code-block:: none

          0: The DPLLn is not running in standby sleep mode if no peripheral requests the clock.
          1: The DPLLn is running in standby sleep mode.
          If ONDEMAND is one, the DPLLn will be running when a peripheral is requesting the clock. If
          ONDEMAND is false, the clock source will always be running in standby sleep mode.



       Default value: ``1``

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

   * - ``fdpll-en``
     - ``int``
     - .. code-block:: none

          Oscillator Enable



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

   * - ``fdpll-divider-ratio-int``
     - ``int``
     - .. code-block:: none

          Set the integer part of the frequency multiplier. (0 - 4095)



   * - ``fdpll-divider-ratio-frac``
     - ``int``
     - .. code-block:: none

          Set the fractional part of the frequency multiplier. (0 - 31)



   * - ``fdpll-xosc-clock-divider``
     - ``int``
     - .. code-block:: none

          Set the XOSC clock division factor (0 - 2047)



   * - ``fdpll-dco-en``
     - ``int``
     - .. code-block:: none

          DCO Filter Enable
          0: to disable, 1: to enable



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

   * - ``fdpll-dco-filter-select``
     - ``string``
     - .. code-block:: none

          Sigma-Delta DCO Filter Selection, Bandwidth Fn (MHz)



       Default value: ``3.21mhz``

       Legal values: ``'3.21mhz'``, ``'1.6mhz'``, ``'1.1mhz'``, ``'0.8mhz'``, ``'0.64mhz'``, ``'0.55mhz'``, ``'0.45mhz'``, ``'0.4mhz'``

   * - ``fdpll-lock-bypass-en``
     - ``int``
     - .. code-block:: none

          Lock Bypass
          0: to disable, 1: to enable



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

   * - ``fdpll-src``
     - ``string``
     - .. code-block:: none

          Reference source clock selection



       Default value: ``xosc0``

       Legal values: ``'gclk0'``, ``'gclk1'``, ``'gclk2'``, ``'gclk3'``, ``'gclk4'``, ``'gclk5'``, ``'gclk6'``, ``'gclk7'``, ``'gclk8'``, ``'gclk9'``, ``'gclk10'``, ``'gclk11'``, ``'xosc32k'``, ``'xosc0'``, ``'xosc1'``

   * - ``fdpll-wakeup-fast-en``
     - ``int``
     - .. code-block:: none

          Wake Up Fast
          0: to disable, 1: to enable



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

   * - ``fdpll-pi-filter-type``
     - ``string``
     - .. code-block:: none

          Proportional Integral Filter Selection



       Default value: ``92.7khz-0.76damp``

       Legal values: ``'92.7khz-0.76damp'``, ``'131khz-1.08damp'``, ``'46.4khz-0.38damp'``, ``'65.6khz-0.54damp'``, ``'131khz-0.56damp'``, ``'185khz-0.79damp'``, ``'65.6khz-0.28damp'``, ``'92.7khz-0.39damp'``, ``'46.4khz-1.49damp'``, ``'65.6khz-2.11damp'``, ``'23.2khz-0.75damp'``, ``'32.8khz-1.06damp'``, ``'65.6khz-1.07damp'``, ``'92.7khz-1.51damp'``, ``'32.8khz-0.53damp'``, ``'46.4khz-0.75damp'``