:orphan:
.. raw:: html
.. dtcompatible:: nxp,mcxw7x-clock
.. _dtbinding_nxp_mcxw7x_clock:
nxp,mcxw7x-clock
################
.. sidebar:: Overview
:Name: ``nxp,mcxw7x-clock``
:Vendor: :ref:`NXP Semiconductors N.V. `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=nxp,mcxw7x-clock>` using
this compatible
:Driver: :zephyr_file:`drivers/clock_control/clock_control_nxp_mcxw7x.c`
Description
***********
.. code-block:: none
NXP MCXW7X series clock controller
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
* - ``osc32k-mode``
- ``int``
- .. code-block:: none
32 kHz clock source selection.
0: Disable 32 kHz crystal oscillator.
1: Enable 32 kHz crystal oscillator.
3: Bypass 32 kHz oscillator (use external clock input).
This property is **required**.
Legal values: ``0``, ``1``, ``3``
* - ``osc32k-xtal-cap``
- ``int``
- .. code-block:: none
internal capacitance value for 32 kHz OSC XTAL.
0: The internal capacitance for XTAL pin is 0pF.
1: The internal capacitance for XTAL pin is 2pF.
2: The internal capacitance for XTAL pin is 4pF.
3: The internal capacitance for XTAL pin is 6pF.
4: The internal capacitance for XTAL pin is 8pF.
5: The internal capacitance for XTAL pin is 10pF.
6: The internal capacitance for XTAL pin is 12pF.
7: The internal capacitance for XTAL pin is 14pF.
8: The internal capacitance for XTAL pin is 16pF.
9: The internal capacitance for XTAL pin is 18pF.
10: The internal capacitance for XTAL pin is 20pF.
11: The internal capacitance for XTAL pin is 22pF.
12: The internal capacitance for XTAL pin is 24pF.
13: The internal capacitance for XTAL pin is 26pF.
14: The internal capacitance for XTAL pin is 28pF.
15: The internal capacitance for XTAL pin is 30pF.
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``
* - ``osc32k-extal-cap``
- ``int``
- .. code-block:: none
internal capacitance value for 32 kHz OSC EXTAL.
0: The internal capacitance for EXTAL pin is 0pF.
1: The internal capacitance for EXTAL pin is 2pF.
2: The internal capacitance for EXTAL pin is 4pF.
3: The internal capacitance for EXTAL pin is 6pF.
4: The internal capacitance for EXTAL pin is 8pF.
5: The internal capacitance for EXTAL pin is 10pF.
6: The internal capacitance for EXTAL pin is 12pF.
7: The internal capacitance for EXTAL pin is 14pF.
8: The internal capacitance for EXTAL pin is 16pF.
9: The internal capacitance for EXTAL pin is 18pF.
10: The internal capacitance for EXTAL pin is 20pF.
11: The internal capacitance for EXTAL pin is 22pF.
12: The internal capacitance for EXTAL pin is 24pF.
13: The internal capacitance for EXTAL pin is 26pF.
14: The internal capacitance for EXTAL pin is 28pF.
15: The internal capacitance for EXTAL pin is 30pF.
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``
* - ``firc-mode``
- ``int``
- .. code-block:: none
FIRC (Fast Internal Reference Clock) mode selection.
0: FIRC is disabled.
1: FIRC is enabled in normal mode.
2: FIRC is enabled in low power mode.
This property is **required**.
Legal values: ``0``, ``1``, ``2``
* - ``firc-range``
- ``int``
- .. code-block:: none
FIRC frequency range selection.
This property is **required**.
* - ``enable-sirc-in-lp-mode``
- ``boolean``
- .. code-block:: none
Enable/disable SIRC(FRO 6M) in low power mode.
* - ``sys-clk-src``
- ``int``
- .. code-block:: none
System clock source selection.
This property is **required**.
* - ``sys-clk-div-bus``
- ``int``
- .. code-block:: none
System clock divider for bus clock.
Valid range: 1 to 16.
This property is **required**.
* - ``sys-clk-div-slow``
- ``int``
- .. code-block:: none
System clock divider for slow clock.
Valid range: 1 to 16.
This property is **required**.
* - ``sys-clk-div-core``
- ``int``
- .. code-block:: none
System clock divider for core clock.
Valid range: 1 to 16.
This property is **required**.
* - ``enable-sosc``
- ``boolean``
- .. code-block:: none
Enable/disable SOSC (System Oscillator).
* - ``sosc-freq``
- ``int``
- .. code-block:: none
SOSC (System Oscillator) frequency in Hz.
This property is **required**.
* - ``core-clock-frequency``
- ``int``
- .. code-block:: none
Expected core clock frequency in Hz after clock configuration.
Used to configure voltage levels before clock setup (e.g., 96 MHz
requires raising core voltage) and to verify the clock configuration
is correct at init time.
This property is **required**.
* - ``#clock-cells``
- ``int``
- .. code-block:: none
Number of items to expect in a Clock specifier
This property is **required**.
Constant value: ``1``
.. 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 "nxp,mcxw7x-clock" 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 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 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.
* - ``dma-coherent``
- ``boolean``
- .. code-block:: none
Indicates that the device is capable of coherent DMA operations.
For details, see "2.3.10 dma-coherent" 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.
Specifier cell names
********************
- clock cells: name