:orphan: .. raw:: html .. dtcompatible:: ambiq,apollo4-pinctrl .. _dtbinding_ambiq_apollo4_pinctrl: ambiq,apollo4-pinctrl ##################### Vendor: :ref:`Ambiq Micro, Inc. ` Description *********** .. code-block:: none The Ambiq Apollo4 pin controller is a node responsible for controlling pin function selection and pin properties, such as routing a UART0 TX to pin 60 and enabling the pullup resistor on that 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. */ /* include pre-defined combinations for the SoC variant used by the board */ #include &pinctrl { uart0_default: uart0_default { group1 { pinmux = ; }; group2 { pinmux = ; input-enable; }; }; }; The 'uart0_default' child node encodes the pin configurations for a particular state of a device; in this case, the default (that is, active) state. As shown, pin configurations are organized in groups within each child node. Each group can specify a list of pin function selections in the 'pinmux' property. A group can also specify shared pin properties common to all the specified pins, such as the 'input-enable' property in group 2. Properties ********** Top level properties ==================== These property descriptions apply to "ambiq,apollo4-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 "ambiq,apollo4-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. Grandchild node properties ========================== .. list-table:: :widths: 1 1 4 :header-rows: 1 * - Name - Type - Details * - ``pinmux`` - ``array`` - .. code-block:: none An array of pins sharing the same group properties. Each element of the array is an integer constructed from the pin number and the alternative function of the pin. This property is **required**. * - ``drive-strength`` - ``string`` - .. code-block:: none The drive strength of a pin, relative to full-driver strength. The default value is 0.1, which is the reset value. Default value: ``0.1`` Legal values: ``'0.1'``, ``'0.5'``, ``'0.75'``, ``'1.0'`` * - ``slew-rate`` - ``string`` - .. code-block:: none Select slew rate for a pin. The default is slow, which is the reset value. Default value: ``slow`` Legal values: ``'slow'``, ``'fast'`` * - ``ambiq,pull-up-ohms`` - ``int`` - .. code-block:: none The pullup resistor value. The default value is 1500 ohms. Default value: ``1500`` Legal values: ``1500``, ``6000``, ``12000``, ``24000``, ``50000``, ``100000`` * - ``ambiq,iom-nce-module`` - ``int`` - .. code-block:: none IOM nCE module select. The default value is reset value. * - ``bias-high-impedance`` - ``boolean`` - .. code-block:: none high impedance mode ("third-state", "floating") * - ``bias-pull-up`` - ``boolean`` - .. code-block:: none enable pull-up resistor * - ``bias-pull-down`` - ``boolean`` - .. code-block:: none enable pull-down resistor * - ``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) * - ``input-enable`` - ``boolean`` - .. code-block:: none enable input on pin (e.g. enable an input buffer, no effect on output)