silabs,dbus-pinctrl

Note

An implementation of a driver matching this compatible is available in drivers/pinctrl/pinctrl_silabs_dbus.c.

Description

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 USART0 RX to pin PA1 and enable the pull-up resistor on the
pin. This pin controller is used for devices that use DBUS (Digital Bus)
for alternate function configuration, including Series 2 devices.

The pinctrl settings are referenced in a device tree peripheral node. For
example when configuring a USART:

  &usart0 {
    compatible = "silabs,gecko-usart";
    pinctrl-0 = <&usart0_default>;
    pinctrl-names = "default";
  }

pinctrl-0 is a phandle that stores the pin settings for the peripheral, in
this example &usart0_default. This phandle is defined as a child node of the
'pinctrl' node, typically in a board-pinctrl.dtsi file in the board
directory or a device tree overlay in the application:

  &pinctrl {
    /* Configuration for USART0 peripheral, default state */
    usart0_default: usart0_default {
      /* Group of output pins with shared properties (name is arbitrary) */
      group0 {
        /* Configure PA8 as USART0 TX in GPIO DBUS */
        pins = <USART0_TX_PA8>;
        /* Configure GPIO to push-pull mode */
        drive-push-pull;
        /* Set DOUT high */
        output-high;
      };
      /* Group of input pins with shared properties (name is arbitrary) */
      group1 {
        /* Configure PA9 as USART0 RX in GPIO DBUS */
        pins = <USART0_RX_PA9>;
        /* Configure GPIO to input mode */
        input-enable;
        /* Enable input glitch filter */
        silabs,input-filter;
      };
    };
  };

The 'usart0_default' child node encodes the pin configurations for a
particular state of the device, the default (active) state.

Pin configurations are organized in groups within each child node. Each
group can specify a list of pin function selections in the `pins` property,
that all will be configured with the same GPIO mode as given by the rest
of the properties on the group.

The possible pin properties are as follows:

- input-disable: Configure GPIO to disabled mode. Setting this property is
                 optional, as pins are disabled by default. If the "Input
                 disabled with pull-up" mode is desired, the property must
                 be set in combination with bias-pull-up.
- input-enable: Configure GPIO to input mode.
- drive-push-pull: Configure GPIO to push-pull mode.
- drive-open-drain: Configure GPIO to open-drain (wired-AND) mode.
- drive-open-source: Configure GPIO to open-source (wired-OR) mode.

Only one of the above properties must be set at a time, as they are mutually
exclusive. Additional properties may be combined with the above ones:

- bias-pull-down: Enable pull-down resistor. Allowed in input-enable and
                  drive-open-source modes.
- bias-pull-up: Enable pull-up resistor. Allowed in input-disable,
                input-enable and drive-open-drain modes.
- output-high: Drive GPIO high. Allowed in drive-push-pull mode.
- output-low: Drive GPIO low. Allowed in drive-push-pull mode. Setting
              this property is optional, leaving it out has the same effect.
- silabs,input-filter: Enable input glitch filter. Allowed in input-enable
                       and drive-open-drain modes.
- silabs,alternate-port-control: Use alternate port control settings.
                                 Allowed in drive-push-pull and
                                 drive-open-drain modes.

Properties

Top level properties

These property descriptions apply to “silabs,dbus-pinctrl” nodes themselves. This page also describes child node properties in the following sections.

Properties not inherited from the base binding file.

(None)

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,dbus-pinctrl” compatible.

Name	Type	Details
`status`	`string`	indicates the operational status of a device Legal values: `'ok'`, `'okay'`, `'disabled'`, `'reserved'`, `'fail'`, `'fail-sss'` See Important properties for more information.
`compatible`	`string-array`	compatible strings This property is required. See Important properties for more information.
`reg`	`array`	register space See Important properties for more information.
`reg-names`	`string-array`	name of each register space
`interrupts`	`array`	interrupts for device See Important properties for more information.
`interrupts-extended`	`compound`	extended interrupt specifier for device
`interrupt-names`	`string-array`	name of each interrupt
`interrupt-parent`	`phandle`	phandle to interrupt controller node
`label`	`string`	No description provided for this label See Important properties for more information.
`clocks`	`phandle-array`	Clock gate information
`clock-names`	`string-array`	name of each clock
`#address-cells`	`int`	number of address cells in reg property
`#size-cells`	`int`	number of size cells in reg property
`dmas`	`phandle-array`	DMA channels specifiers
`dma-names`	`string-array`	Provided names of DMA channel specifiers
`io-channels`	`phandle-array`	IO channels specifiers
`io-channel-names`	`string-array`	Provided names of IO channel specifiers
`mboxes`	`phandle-array`	mailbox / IPM channels specifiers
`mbox-names`	`string-array`	Provided names of mailbox / IPM channel specifiers
`power-domains`	`phandle-array`	Power domain specifiers
`power-domain-names`	`string-array`	Provided names of power domain specifiers
`#power-domain-cells`	`int`	Number of cells in power-domains property
`zephyr,deferred-init`	`boolean`	Do not initialize device automatically on boot. Device should be manually initialized using device_init().
`wakeup-source`	`boolean`	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`	Automatically configure the device for runtime power management after the init function runs.
`zephyr,disabling-power-states`	`phandles`	List of power states that will disable this device power.

Grandchild node properties

Name	Type	Details
`pins`	`array`	An array of pins sharing the same group properties. The pins should be defined using the <peripheral>_<signal>_<pin> macros available from the SoC DeviceTree files. This property is required.
`silabs,input-filter`	`boolean`	Enable input glitch filter on this pin. May be used in input-enable and drive-open-drain modes.
`silabs,alternate-port-control`	`boolean`	Use Alternate Port Control settings for Slew Rate and Input Disable for this pin. May be used in drive-push-pull and drive-open-drain modes.
`bias-pull-up`	`boolean`	enable pull-up resistor
`bias-pull-down`	`boolean`	enable pull-down resistor
`drive-push-pull`	`boolean`	drive actively high and low
`drive-open-drain`	`boolean`	drive with open drain (hardware AND)
`drive-open-source`	`boolean`	drive with open source (hardware OR)
`input-enable`	`boolean`	enable input on pin (e.g. enable an input buffer, no effect on output)
`input-disable`	`boolean`	disable input on pin (e.g. disable an input buffer, no effect on output)
`output-low`	`boolean`	set the pin to output mode with low level
`output-high`	`boolean`	set the pin to output mode with high level