STM32 HSE clock binding

: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:: st,stm32-hse-clock
.. _dtbinding_st_stm32_hse_clock:

st,stm32-hse-clock
##################

Vendor: :ref:`STMicroelectronics <dt_vendor_st>`

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



.. code-block:: none

   STM32 HSE Clock

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

         * - ``#clock-cells``
           - ``int``
           - .. code-block:: none

                Number of items to expect in a Clock specifier


             This property is **required**.

         * - ``clock-frequency``
           - ``int``
           - .. code-block:: none

                output clock frequency (Hz)


             This property is **required**.

         * - ``hse-bypass``
           - ``boolean``
           - .. code-block:: none

                HSE crystal oscillator bypass
                Set to the property to by-pass the oscillator with an external clock.



         * - ``css-enabled``
           - ``boolean``
           - .. code-block:: none

                HSE clock security system enabled
                Set the property to enable the clock security system (CSS) for the HSE clock.

                If a failure is detected on the HSE clock, the HSE oscillator is automatically disabled,
                a clock failure event is sent to timers, and a non-maskable interrupt is generated to
                inform the software about the failure, allowing the MCU to perform rescue operations.
                See the MCU reference manual for details.

                The interaction of CSS and low-power modes is unclear from the documentation.
                For at least some devices Zephyr will reconfigure the clocks on resuming from low-power
                modes; this will include re-enabling CSS. However it is important that you verify
                this for your own hardware.





   .. 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 "st,stm32-hse-clock" compatible.

      (None)