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