:orphan:
.. raw:: html
.. dtcompatible:: nxp,s32-psi5
.. _dtbinding_nxp_s32_psi5:
nxp,s32-psi5
############
Vendor: :ref:`NXP Semiconductors N.V. `
.. note::
An implementation of a driver matching this compatible is available in
:zephyr_file:`drivers/psi5/psi5_nxp_s32.c`.
Description
***********
.. code-block:: none
NXP S32 PSI5 (Peripheral Sensor Interface) Controller
Properties
**********
Top level properties
====================
These property descriptions apply to "nxp,s32-psi5"
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
* - ``pinctrl-0``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the first state. Content is specific to the
selected pin controller driver implementation.
This property is **required**.
* - ``pinctrl-names``
- ``string-array``
- .. code-block:: none
Names for the provided states. The number of names needs to match the
number of states.
This property is **required**.
* - ``pinctrl-1``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the second state. See pinctrl-0.
* - ``pinctrl-2``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the third state. See pinctrl-0.
* - ``pinctrl-3``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the fourth state. See pinctrl-0.
* - ``pinctrl-4``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the fifth state. See pinctrl-0.
.. 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-psi5" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``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.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``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: ``'ok'``, ``'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-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.
* - ``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
* - ``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
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about the channel interrupts.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``num-rx-buf``
- ``int``
- .. code-block:: none
Specifies the maximum number of receive buffers used for storing PSI5 messages.
The value can range from 1 to 32, determining how many messages can be stored in
the buffer at any given time.
This property is **required**.
* - ``reg``
- ``int``
- .. code-block:: none
Channel identifier.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``async-mode``
- ``boolean``
- .. code-block:: none
Determines the channel operation mode. When set to true, the channel operates in
asynchronous mode with only the receive function active. When set to false,
the channel operates in synchronous mode with both transmit and receive functions active.
* - ``period-sync-pulse-us``
- ``int``
- .. code-block:: none
Specifies the period of the internally generated synchronization pulses, measured in
microseconds (us). This value determines the length of each synchronization pulse used
in the system.
* - ``pulse-width-0-us``
- ``int``
- .. code-block:: none
Specifies the duration of the pulse width for a data bit value '0', measured in
microseconds (us).
* - ``pulse-width-1-us``
- ``int``
- .. code-block:: none
Specifies the duration of the pulse width for a data bit value '1', measured in
microseconds (us).
* - ``decoder-start-offset-us``
- ``int``
- .. code-block:: none
Specifies the duration for which the Manchester decoder remains inactive after the
falling edge of a synchronization pulse, measured in microseconds (us). This value
determines the delay before the decoder starts processing incoming signals again.
* - ``tx-frame``
- ``string``
- .. code-block:: none
Specifies the transmitter mode. Each mode defines the frame length and
the start condition for data transmission:
- short-31-1s: Short Frame (V1.3) with at least 31 consecutive '1' bits
as the start condition
- short-5-0s: Short Frame (V1.3) with at least 5 consecutive '0' bits
as the start condition
- long-31-1s: Long Frame (V1.3) with at least 31 consecutive '1' bits
as the start condition
- long-5-0s: Long Frame (V1.3) with at least 5 consecutive '0' bits
as the start condition
- x-long-31-1s: X-Long Frame (V1.3) with at least 31 consecutive '1' bits
as the start condition
- x-long-5-0s: X-Long Frame (V1.3) with at least 5 consecutive '0' bits
as the start condition
- xx-long: XX-Long (V2.0)
- non-standard: Non Standard Length
Legal values: ``'short-31-1s'``, ``'short-5-0s'``, ``'long-31-1s'``, ``'long-5-0s'``, ``'x-long-31-1s'``, ``'x-long-frame-5-0s'``, ``'xx-long-frame'``, ``'non-standard-frame'``
* - ``rx-bitrate-kbps``
- ``int``
- .. code-block:: none
Selects the receive message bitrate in kbps. This setting determines the speed at
which data is received.
This property is **required**.
Legal values: ``125``, ``189``
Grandchild node properties
==========================
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``int``
- .. code-block:: none
Channel RX slot identifier.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``duration-us``
- ``int``
- .. code-block:: none
Specifies the duration of a slot, starting from the rising edge of the
timing synchronization pulse and ending at the final slot.
This property is **required**.
* - ``start-offset-us``
- ``int``
- .. code-block:: none
Specifies the time offset at which the slot should start, measured from the
rising edge of the timing synchronization pulse.
This property is **required**.
* - ``data-length``
- ``int``
- .. code-block:: none
Specifies the number of bits in a slot, with valid lengths ranging from 8 to 28 bits.
This property is **required**.
* - ``data-msb-first``
- ``boolean``
- .. code-block:: none
Specifies the endianness type for data slot. Set to 1 when data is interpreted with the
Most Significant Bit (MSB) first.
* - ``has-smc``
- ``boolean``
- .. code-block:: none
Specifies whether data slot has Serial Messaging Channel (SMC) field. Set to 1 when
the bit (M0, M1) SMC is present in the Rx Message.
* - ``has-parity``
- ``boolean``
- .. code-block:: none
Specifies whether data slot has parity field. Set to 1 when the Parity field is
present in the Rx Message; otherwise, the CRC field is present.