: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:: alif,clock-mux
.. _dtbinding_alif_clock_mux:

alif,clock-mux
##############

.. sidebar:: Overview

   :Name: ``alif,clock-mux``
   :Vendor: :ref:`Alif Semiconductor <dt_vendor_alif>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=alif,clock-mux>` using
               this compatible

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



.. code-block:: none

   Alif clock source multiplexer

   Describes which input a clock multiplexer is switched to. The node has no
   register of its own; it records the selection so that consumers of the
   multiplexer output can resolve its rate. The selection must match the state
   the hardware is actually in, unless a driver programs the multiplexer from
   it.

   The first user is the S32K_CLK multiplexer, which selects between the LFRC
   and the LFXO oscillator. It is configured outside zephyr and for example,
   a board whose S32K_CLK runs from the LFXO records that with:

       &clk_s32k {
               clocks = <&clk_lfxo>;
       };

Properties
**********

.. 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 "alif,clock-mux" compatible.

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

         * - Name
           - Type
           - Details

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                The input the multiplexer is switched to.


             This property is **required**.

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