renesas,rcar-pfc

Note

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

Description

Renesas R-Car Pin Function Controller node
This binding gives a base representation of the R-Car pins configuration.
The R-Car pin controller is a singleton node responsible for controlling
pin function selection and pin properties. For example, you can use this
node to route CAN0 TX A to pin 'RD', and enable pull-up resistor as well
as driving ability.

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

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

All device pin configurations should be placed in child nodes of the
'pfc' 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 pins and functions for the SoC used by the board */
  #include <dt-bindings/pinctrl/renesas/pinctrl-r8a77951.h>

  &pfc {
    /* configuration for can0 data a tx default state */
    can0_data_a_tx_default: can0_data_a_tx_default {
      /* configure PIN_RD as FUNC_CAN0_TX_A */
      pin = <PIN_RD FUNC_CAN0_TX_A>;
    };
    /* configuration for can0 data a rx default state */
    can0_data_a_rx_default: can0_data_a_rx_default {
      /* configure PIN_RD_WR as FUNC_CAN0_RX_A */
      pin = <PIN_RD_WR FUNC_CAN0_RX_A>;
    };
  };

The 'can0_data_a_tx_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.

A pin configuration can also specify pin properties such as the
'bias-pull-up' property. Here is a list of supported standard pin
properties:

- bias-disable
- bias-pull-down
- bias-pull-up
- drive-strength
- power-source

To link pin configurations 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"

  &can0 {
    pinctrl-0 = <&can0_data_a_tx_default &can0_data_a_rx_default>;
    pinctrl-1 = <&can0_data_a_tx_sleep &can0_data_a_rx_sleep>;
    pinctrl-names = "default", "sleep";
  };

Properties

Top level properties

These property descriptions apply to “renesas,rcar-pfc” 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 “renesas,rcar-pfc” compatible.

Name	Type	Details
`reg`	`array`	register space This property is required. See Important properties for more information.
`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-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.

Child node properties

Name	Type	Details
`pin`	`array`	The array is expected to have up to two elements. The first element is the pin the second optional element is the pin function. This property is required.
`drive-strength`	`int`	maximum sink or source current in mA Legal values: `3`, `6`, `9`, `12`, `15`, `18`, `21`, `24`
`bias-disable`	`boolean`	disable any pin bias
`bias-pull-up`	`boolean`	enable pull-up resistor
`bias-pull-down`	`boolean`	enable pull-down resistor
`power-source`	`int`	select between different power supplies