Documentation/devicetree/bindings/pinctrl/renesas,pfc-pinctrl.txt

   1 * Renesas Pin Function Controller (GPIO and Pin Mux/Config)
   2
   3 The Pin Function Controller (PFC) is a Pin Mux/Config controller. On SH73A0,
   4 R8A73A4 and R8A7740 it also acts as a GPIO controller.
   5
   6
   7 Pin Control
   8 -----------
   9
  10 Required Properties:
  11
  12   - compatible: should be one of the following.
  13     - "renesas,pfc-emev2": for EMEV2 (EMMA Mobile EV2) compatible pin-controller.
  14     - "renesas,pfc-r8a73a4": for R8A73A4 (R-Mobile APE6) compatible pin-controller.
  15     - "renesas,pfc-r8a7740": for R8A7740 (R-Mobile A1) compatible pin-controller.
  16     - "renesas,pfc-r8a7743": for R8A7743 (RZ/G1M) compatible pin-controller.
  17     - "renesas,pfc-r8a7744": for R8A7744 (RZ/G1N) compatible pin-controller.
  18     - "renesas,pfc-r8a7745": for R8A7745 (RZ/G1E) compatible pin-controller.
  19     - "renesas,pfc-r8a77470": for R8A77470 (RZ/G1C) compatible pin-controller.
  20     - "renesas,pfc-r8a774a1": for R8A774A1 (RZ/G2M) compatible pin-controller.
  21     - "renesas,pfc-r8a774b1": for R8A774B1 (RZ/G2N) compatible pin-controller.
  22     - "renesas,pfc-r8a774c0": for R8A774C0 (RZ/G2E) compatible pin-controller.
  23     - "renesas,pfc-r8a7778": for R8A7778 (R-Car M1) compatible pin-controller.
  24     - "renesas,pfc-r8a7779": for R8A7779 (R-Car H1) compatible pin-controller.
  25     - "renesas,pfc-r8a7790": for R8A7790 (R-Car H2) compatible pin-controller.
  26     - "renesas,pfc-r8a7791": for R8A7791 (R-Car M2-W) compatible pin-controller.
  27     - "renesas,pfc-r8a7792": for R8A7792 (R-Car V2H) compatible pin-controller.
  28     - "renesas,pfc-r8a7793": for R8A7793 (R-Car M2-N) compatible pin-controller.
  29     - "renesas,pfc-r8a7794": for R8A7794 (R-Car E2) compatible pin-controller.
  30     - "renesas,pfc-r8a7795": for R8A7795 (R-Car H3) compatible pin-controller.
  31     - "renesas,pfc-r8a7796": for R8A77960 (R-Car M3-W) compatible pin-controller.
  32     - "renesas,pfc-r8a77961": for R8A77961 (R-Car M3-W+) compatible pin-controller.
  33     - "renesas,pfc-r8a77965": for R8A77965 (R-Car M3-N) compatible pin-controller.
  34     - "renesas,pfc-r8a77970": for R8A77970 (R-Car V3M) compatible pin-controller.
  35     - "renesas,pfc-r8a77980": for R8A77980 (R-Car V3H) compatible pin-controller.
  36     - "renesas,pfc-r8a77990": for R8A77990 (R-Car E3) compatible pin-controller.
  37     - "renesas,pfc-r8a77995": for R8A77995 (R-Car D3) compatible pin-controller.
  38     - "renesas,pfc-sh73a0": for SH73A0 (SH-Mobile AG5) compatible pin-controller.
  39
  40   - reg: Base address and length of each memory resource used by the pin
  41     controller hardware module.
  42
  43 Optional properties:
  44
  45   - #gpio-range-cells: Mandatory when the PFC doesn't handle GPIO, forbidden
  46     otherwise. Should be 3.
  47
  48   - interrupts-extended: Specify the interrupts associated with external
  49     IRQ pins. This property is mandatory when the PFC handles GPIOs and
  50     forbidden otherwise. When specified, it must contain one interrupt per
  51     external IRQ, sorted by external IRQ number.
  52
  53 The PFC node also acts as a container for pin configuration nodes. Please refer
  54 to pinctrl-bindings.txt in this directory for the definition of the term "pin
  55 configuration node" and for the common pinctrl bindings used by client devices.
  56
  57 Each pin configuration node represents a desired configuration for a pin, a
  58 pin group, or a list of pins or pin groups. The configuration can include the
  59 function to select on those pin(s) and pin configuration parameters (such as
  60 pull-up and pull-down).
  61
  62 Pin configuration nodes contain pin configuration properties, either directly
  63 or grouped in child subnodes. Both pin muxing and configuration parameters can
  64 be grouped in that way and referenced as a single pin configuration node by
  65 client devices.
  66
  67 A configuration node or subnode must reference at least one pin (through the
  68 pins or pin groups properties) and contain at least a function or one
  69 configuration parameter. When the function is present only pin groups can be
  70 used to reference pins.
  71
  72 All pin configuration nodes and subnodes names are ignored. All of those nodes
  73 are parsed through phandles and processed purely based on their content.
  74
  75 Pin Configuration Node Properties:
  76
  77 - pins : An array of strings, each string containing the name of a pin.
  78 - groups : An array of strings, each string containing the name of a pin
  79   group.
  80
  81 - function: A string containing the name of the function to mux to the pin
  82   group(s) specified by the groups property.
  83
  84   Valid values for pin, group and function names can be found in the group and
  85   function arrays of the PFC data file corresponding to the SoC
  86   (drivers/pinctrl/sh-pfc/pfc-*.c)
  87
  88 The pin configuration parameters use the generic pinconf bindings defined in
  89 pinctrl-bindings.txt in this directory. The supported parameters are
  90 bias-disable, bias-pull-up, bias-pull-down, drive-strength and power-source. For
  91 pins that have a configurable I/O voltage, the power-source value should be the
  92 nominal I/O voltage in millivolts.
  93
  94
  95 GPIO
  96 ----
  97
  98 On SH73A0, R8A73A4 and R8A7740 the PFC node is also a GPIO controller node.
  99
 100 Required Properties:
 101
 102   - gpio-controller: Marks the device node as a gpio controller.
 103
 104   - #gpio-cells: Should be 2. The first cell is the GPIO number and the second
 105     cell specifies GPIO flags, as defined in <dt-bindings/gpio/gpio.h>. Only the
 106     GPIO_ACTIVE_HIGH and GPIO_ACTIVE_LOW flags are supported.
 107
 108 The syntax of the gpio specifier used by client nodes should be the following
 109 with values derived from the SoC user manual.
 110
 111   <[phandle of the gpio controller node]
 112    [pin number within the gpio controller]
 113    [flags]>
 114
 115 On other mach-shmobile platforms GPIO is handled by the gpio-rcar driver.
 116 Please refer to Documentation/devicetree/bindings/gpio/renesas,gpio-rcar.txt
 117 for documentation of the GPIO device tree bindings on those platforms.
 118
 119
 120 Examples
 121 --------
 122
 123 Example 1: SH73A0 (SH-Mobile AG5) pin controller node
 124
 125         pfc: pin-controller@e6050000 {
 126                 compatible = "renesas,pfc-sh73a0";
 127                 reg = <0xe6050000 0x8000>,
 128                       <0xe605801c 0x1c>;
 129                 gpio-controller;
 130                 #gpio-cells = <2>;
 131                 interrupts-extended =
 132                         <&irqpin0 0 0>, <&irqpin0 1 0>, <&irqpin0 2 0>, <&irqpin0 3 0>,
 133                         <&irqpin0 4 0>, <&irqpin0 5 0>, <&irqpin0 6 0>, <&irqpin0 7 0>,
 134                         <&irqpin1 0 0>, <&irqpin1 1 0>, <&irqpin1 2 0>, <&irqpin1 3 0>,
 135                         <&irqpin1 4 0>, <&irqpin1 5 0>, <&irqpin1 6 0>, <&irqpin1 7 0>,
 136                         <&irqpin2 0 0>, <&irqpin2 1 0>, <&irqpin2 2 0>, <&irqpin2 3 0>,
 137                         <&irqpin2 4 0>, <&irqpin2 5 0>, <&irqpin2 6 0>, <&irqpin2 7 0>,
 138                         <&irqpin3 0 0>, <&irqpin3 1 0>, <&irqpin3 2 0>, <&irqpin3 3 0>,
 139                         <&irqpin3 4 0>, <&irqpin3 5 0>, <&irqpin3 6 0>, <&irqpin3 7 0>;
 140         };
 141
 142 Example 2: A GPIO LED node that references a GPIO
 143
 144         #include <dt-bindings/gpio/gpio.h>
 145
 146         leds {
 147                 compatible = "gpio-leds";
 148                 led1 {
 149                         gpios = <&pfc 20 GPIO_ACTIVE_LOW>;
 150                 };
 151         };
 152
 153 Example 3: KZM-A9-GT (SH-Mobile AG5) default pin state hog and pin control maps
 154            for the MMCIF and SCIFA4 devices
 155
 156         &pfc {
 157                 pinctrl-0 = <&scifa4_pins>;
 158                 pinctrl-names = "default";
 159
 160                 mmcif_pins: mmcif {
 161                         mux {
 162                                 groups = "mmc0_data8_0", "mmc0_ctrl_0";
 163                                 function = "mmc0";
 164                         };
 165                         cfg {
 166                                 groups = "mmc0_data8_0";
 167                                 pins = "PORT279";
 168                                 bias-pull-up;
 169                         };
 170                 };
 171
 172                 scifa4_pins: scifa4 {
 173                         groups = "scifa4_data", "scifa4_ctrl";
 174                         function = "scifa4";
 175                 };
 176         };
 177
 178 Example 4: KZM-A9-GT (SH-Mobile AG5) default pin state for the MMCIF device
 179
 180         &mmcif {
 181                 pinctrl-0 = <&mmcif_pins>;
 182                 pinctrl-names = "default";
 183
 184                 bus-width = <8>;
 185                 vmmc-supply = <&reg_1p8v>;
 186         };