: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:: silabs,gecko-pinctrl
.. _dtbinding_silabs_gecko_pinctrl:

silabs,gecko-pinctrl
####################

Vendor: :ref:`Silicon Laboratories <dt_vendor_silabs>`

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



.. code-block:: none

   The Silabs pin controller is a singleton node responsible for controlling
   pin function selection and pin properties. For example, you can use this
   node to route UART0 RX to pin P0.1 and enable the pull-up resistor on the
   pin.

   The node has the 'pinctrl' node label set in your SoC's devicetree,
   so you can modify it like this:

     &pinctrl {
             /* your modifications go here */
     };

   All device pin configurations should be placed in child nodes of the
   'pinctrl' node, as shown in this example:

     /* You can put this in places like a board-pinctrl.dtsi file in
      * your board directory, or a devicetree overlay in your application.
      */
     &pinctrl {
       /* configuration for usart0 device, default state */
       usart0_default: usart0_default {
         /* group 1 ('group1' name is arbitrary) */
         group1 {
           /* configure P0.1 as UART_TX and P0.2 as UART_RTS */
           psels = <GECKO_PSEL(UART_TX, A, 1)>, <GECKO_PSEL(UART_RTS, A, 2)>;
         };
         /* group 2 */
         group2 {
           /* configure P0.3 as UART_RX and P0.4 as UART_CTS */
           psels = <GECKO_PSEL(UART_RX, A, 3)>, <GECKO_PSEL(UART_CTS, A, 4)>;
         };
       };
     };

   The 'usart0_default' child node encodes the pin configurations for a
   particular state of a device; in this case, the default (that is, active)
   state. You would specify the low-power configuration for the same device
   in a separate child node.

   As shown, pin configurations are organized in groups within each child node.
   Each group can specify a list of pin function selections in the 'psels'
   property. The GECKO_PSEL macro is used to specify a pin function selection.
   Available pin functions can be found in the
   include/dt-bindings/pinctrl/gecko-pinctrl.h header file.

   To link this pin configuration with a device, use a pinctrl-N property
   for some number N, like this example you could place in your board's DTS
   file:

      #include "board-pinctrl.dtsi"

      &usart0 {
            pinctrl-0 = <&usart0_default>;
            pinctrl-names = "default";
      };

Properties
**********

Top level properties
====================


These property descriptions apply to "silabs,gecko-pinctrl"
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.

      (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 "silabs,gecko-pinctrl" compatible.

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

         * - Name
           - Type
           - Details

         * - ``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``
           - ``array``
           - .. code-block:: none

                register space


             See :ref:`zephyr:dt-important-props` for more information.

         * - ``reg-names``
           - ``string-array``
           - .. code-block:: none

                name of each register space


         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                interrupts for device


             See :ref:`zephyr:dt-important-props` for more information.

         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                extended interrupt specifier for device


         * - ``interrupt-names``
           - ``string-array``
           - .. code-block:: none

                name of each interrupt


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

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

                Clock gate information


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






Child node properties
=====================

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

   * - Name
     - Type
     - Details

   * - ``bias-disable``
     - ``boolean``
     - .. code-block:: none

          disable any pin bias


   * - ``bias-high-impedance``
     - ``boolean``
     - .. code-block:: none

          high impedance mode ("third-state", "floating")


   * - ``bias-bus-hold``
     - ``boolean``
     - .. code-block:: none

          latch weakly


   * - ``bias-pull-up``
     - ``boolean``
     - .. code-block:: none

          enable pull-up resistor


   * - ``bias-pull-down``
     - ``boolean``
     - .. code-block:: none

          enable pull-down resistor


   * - ``bias-pull-pin-default``
     - ``boolean``
     - .. code-block:: none

          use pin's default pull state


   * - ``drive-push-pull``
     - ``boolean``
     - .. code-block:: none

          drive actively high and low


   * - ``drive-open-drain``
     - ``boolean``
     - .. code-block:: none

          drive with open drain (hardware AND)


   * - ``drive-open-source``
     - ``boolean``
     - .. code-block:: none

          drive with open source (hardware OR)


   * - ``drive-strength``
     - ``int``
     - .. code-block:: none

          maximum sink or source current in mA


   * - ``drive-strength-microamp``
     - ``int``
     - .. code-block:: none

          maximum sink or source current in μA


   * - ``input-enable``
     - ``boolean``
     - .. code-block:: none

          enable input on pin (e.g. enable an input buffer, no effect on output)



   * - ``input-disable``
     - ``boolean``
     - .. code-block:: none

          disable input on pin (e.g. disable an input buffer, no effect on output)



   * - ``input-schmitt-enable``
     - ``boolean``
     - .. code-block:: none

          enable schmitt-trigger mode


   * - ``input-schmitt-disable``
     - ``boolean``
     - .. code-block:: none

          disable schmitt-trigger mode


   * - ``input-debounce``
     - ``int``
     - .. code-block:: none

          Takes the debounce time in μsec, as argument or 0 to disable debouncing



   * - ``power-source``
     - ``int``
     - .. code-block:: none

          select between different power supplies


   * - ``low-power-enable``
     - ``boolean``
     - .. code-block:: none

          enable low power mode


   * - ``low-power-disable``
     - ``boolean``
     - .. code-block:: none

          disable low power mode


   * - ``output-disable``
     - ``boolean``
     - .. code-block:: none

          disable output on a pin (e.g. disable an output buffer)


   * - ``output-enable``
     - ``boolean``
     - .. code-block:: none

          enable output on a pin without actively driving it (e.g. enable an output
          buffer)



   * - ``output-low``
     - ``boolean``
     - .. code-block:: none

          set the pin to output mode with low level


   * - ``output-high``
     - ``boolean``
     - .. code-block:: none

          set the pin to output mode with high level


   * - ``sleep-hardware-state``
     - ``boolean``
     - .. code-block:: none

          indicate this is sleep related state which will be programmed into
          the registers for the sleep state



   * - ``slew-rate``
     - ``int``
     - .. code-block:: none

          set the slew rate


   * - ``skew-delay``
     - ``int``
     - .. code-block:: none

          This affects the expected clock skew on input pins and the delay
          before latching a value to an output pin. Typically indicates how
            many double-inverters are used to delay the signal.



Grandchild node properties
==========================

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

   * - Name
     - Type
     - Details

   * - ``psels``
     - ``array``
     - .. code-block:: none

          An array of pins sharing the same group properties. The pins should
          be defined using the GECKO_PSEL utility macro that encodes the port,
          pin and function.



       This property is **required**.