:orphan:
.. raw:: html
.. dtcompatible:: nxp,s32-emios
.. _dtbinding_nxp_s32_emios:
nxp,s32-emios
#############
Vendor: :ref:`NXP Semiconductors `
Description
***********
.. code-block:: none
NXP S32 Enhanced Modular IO SubSystem (eMIOS) node for S32 SoCs.
eMIOS provides independent unified channels (UCs), some of channels
have internal counter that either can be used independently or used
as a reference timebase (master bus) for other channels.
Properties
**********
Top level properties
====================
These property descriptions apply to "nxp,s32-emios"
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
* - ``clock-divider``
- ``int``
- .. code-block:: none
Clock divider value for the global prescaler. Could be in range [1 ... 256]
This property is **required**.
* - ``internal-cnt``
- ``int``
- .. code-block:: none
A mask for channels that have internal counter, lsb is channel 0.
This property is **required**.
.. 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,s32-emios" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``array``
- .. code-block:: none
register space
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts``
- ``array``
- .. code-block:: none
interrupts for device
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
name of each interrupt
This property is **required**.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
This property is **required**.
* - ``status``
- ``string``
- .. code-block:: none
indicates the operational status of a device
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
name of each register space
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
extended interrupt specifier for device
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
phandle to interrupt controller node
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device (used as device_get_binding() argument)
See :ref:`zephyr:dt-important-props` for more information.
This property is **deprecated**.
* - ``clock-names``
- ``string-array``
- .. code-block:: none
name of each clock
* - ``#address-cells``
- ``int``
- .. code-block:: none
number of address cells in reg property
* - ``#size-cells``
- ``int``
- .. code-block:: none
number of size cells in reg property
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channels specifiers
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Provided names of DMA channel specifiers
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channels specifiers
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Provided names of IO channel specifiers
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
mailbox / IPM channels specifiers
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Provided names of mailbox / IPM channel specifiers
* - ``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.
* - ``power-domain``
- ``phandle``
- .. code-block:: none
Power domain the device belongs to.
The device will be notified when the power domain it belongs to is either
suspended or resumed.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
Grandchild node properties
==========================
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``channel``
- ``int``
- .. code-block:: none
Channel identifier for the master bus.
This property is **required**.
* - ``channel-mask``
- ``int``
- .. code-block:: none
A channel mask for channels that by hardware design can use this master bus
as timebase for the operation, lsb is channel 0. The mask bit for this master bus
must always 0 because a master bus should not do other thing than a base timer.
This property is **required**.
* - ``prescaler``
- ``int``
- .. code-block:: none
Clock divider value for internal UC prescaler.
Clock for internal counter = (eMIOS clock / global prescaler) / internal prescaler.
This property is **required**.
Legal values: ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``, ``16``
* - ``bus-type``
- ``string``
- .. code-block:: none
Master bus type.
This property is **required**.
Legal values: ``'BUS_A'``, ``'BUS_B'``, ``'BUS_C'``, ``'BUS_D'``, ``'BUS_E'``, ``'BUS_F'``
* - ``mode``
- ``string``
- .. code-block:: none
Master bus mode.
This property is **required**.
Legal values: ``'MCB_UP_COUNTER'``, ``'MCB_UP_DOWN_COUNTER'``
* - ``period``
- ``int``
- .. code-block:: none
Default period (in ticks) for master bus at boot time. This determines PWM period
for channels use this bus as reference timebase. Could be in range [2 ... 65535]
This property is **required**.
* - ``freeze``
- ``boolean``
- .. code-block:: none
Freeze internal counter when the chip enters Debug mode.