include/dm/pinctrl.h

   1 /*
   2  * Copyright (C) 2015  Masahiro Yamada <yamada.masahiro@socionext.com>
   3  *
   4  * SPDX-License-Identifier:     GPL-2.0+
   5  */
   6
   7 #ifndef __PINCTRL_H
   8 #define __PINCTRL_H
   9
  10 /**
  11  * struct pinconf_param - pin config parameters
  12  *
  13  * @property: property name in DT nodes
  14  * @param: ID for this config parameter
  15  * @default_value: default value for this config parameter used in case
  16  *      no value is specified in DT nodes
  17  */
  18 struct pinconf_param {
  19         const char * const property;
  20         unsigned int param;
  21         u32 default_value;
  22 };
  23
  24 /**
  25  * struct pinctrl_ops - pin control operations, to be implemented by
  26  * pin controller drivers.
  27  *
  28  * The @set_state is the only mandatory operation.  You can implement your
  29  * pinctrl driver with its own @set_state.  In this case, the other callbacks
  30  * are not required.  Otherwise, generic pinctrl framework is also available;
  31  * use pinctrl_generic_set_state for @set_state, and implement other operations
  32  * depending on your necessity.
  33  *
  34  * @get_pins_count: return number of selectable named pins available
  35  *      in this driver.  (necessary to parse "pins" property in DTS)
  36  * @get_pin_name: return the pin name of the pin selector,
  37  *      called by the core to figure out which pin it shall do
  38  *      operations to.  (necessary to parse "pins" property in DTS)
  39  * @get_groups_count: return number of selectable named groups available
  40  *      in this driver.  (necessary to parse "groups" property in DTS)
  41  * @get_group_name: return the group name of the group selector,
  42  *      called by the core to figure out which pin group it shall do
  43  *      operations to.  (necessary to parse "groups" property in DTS)
  44  * @get_functions_count: return number of selectable named functions available
  45  *      in this driver.  (necessary for pin-muxing)
  46  * @get_function_name: return the function name of the muxing selector,
  47  *      called by the core to figure out which mux setting it shall map a
  48  *      certain device to.  (necessary for pin-muxing)
  49  * @pinmux_set: enable a certain muxing function with a certain pin.
  50  *      The @func_selector selects a certain function whereas @pin_selector
  51  *      selects a certain pin to be used. On simple controllers one of them
  52  *      may be ignored.  (necessary for pin-muxing against a single pin)
  53  * @pinmux_group_set: enable a certain muxing function with a certain pin
  54  *      group.  The @func_selector selects a certain function whereas
  55  *      @group_selector selects a certain set of pins to be used. On simple
  56  *      controllers one of them may be ignored.
  57  *      (necessary for pin-muxing against a pin group)
  58  * @pinconf_num_params: number of driver-specific parameters to be parsed
  59  *      from device trees  (necessary for pin-configuration)
  60  * @pinconf_params: list of driver_specific parameters to be parsed from
  61  *      device trees  (necessary for pin-configuration)
  62  * @pinconf_set: configure an individual pin with a given parameter.
  63  *      (necessary for pin-configuration against a single pin)
  64  * @pinconf_group_set: configure all pins in a group with a given parameter.
  65  *      (necessary for pin-configuration against a pin group)
  66  * @set_state: do pinctrl operations specified by @config, a pseudo device
  67  *      pointing a config node. (necessary for pinctrl_full)
  68  * @set_state_simple: do needed pinctrl operations for a peripherl @periph.
  69  *      (necessary for pinctrl_simple)
  70  */
  71 struct pinctrl_ops {
  72         int (*get_pins_count)(struct udevice *dev);
  73         const char *(*get_pin_name)(struct udevice *dev, unsigned selector);
  74         int (*get_groups_count)(struct udevice *dev);
  75         const char *(*get_group_name)(struct udevice *dev, unsigned selector);
  76         int (*get_functions_count)(struct udevice *dev);
  77         const char *(*get_function_name)(struct udevice *dev,
  78                                          unsigned selector);
  79         int (*pinmux_set)(struct udevice *dev, unsigned pin_selector,
  80                           unsigned func_selector);
  81         int (*pinmux_group_set)(struct udevice *dev, unsigned group_selector,
  82                                 unsigned func_selector);
  83         unsigned int pinconf_num_params;
  84         const struct pinconf_param *pinconf_params;
  85         int (*pinconf_set)(struct udevice *dev, unsigned pin_selector,
  86                            unsigned param, unsigned argument);
  87         int (*pinconf_group_set)(struct udevice *dev, unsigned group_selector,
  88                                  unsigned param, unsigned argument);
  89         int (*set_state)(struct udevice *dev, struct udevice *config);
  90         int (*set_state_simple)(struct udevice *dev, struct udevice *periph);
  91 };
  92
  93 #define pinctrl_get_ops(dev)    ((struct pinctrl_ops *)(dev)->driver->ops)
  94
  95 /**
  96  * Generic pin configuration paramters
  97  *
  98  * @PIN_CONFIG_BIAS_DISABLE: disable any pin bias on the pin, a
  99  *      transition from say pull-up to pull-down implies that you disable
 100  *      pull-up in the process, this setting disables all biasing.
 101  * @PIN_CONFIG_BIAS_HIGH_IMPEDANCE: the pin will be set to a high impedance
 102  *      mode, also know as "third-state" (tristate) or "high-Z" or "floating".
 103  *      On output pins this effectively disconnects the pin, which is useful
 104  *      if for example some other pin is going to drive the signal connected
 105  *      to it for a while. Pins used for input are usually always high
 106  *      impedance.
 107  * @PIN_CONFIG_BIAS_BUS_HOLD: the pin will be set to weakly latch so that it
 108  *      weakly drives the last value on a tristate bus, also known as a "bus
 109  *      holder", "bus keeper" or "repeater". This allows another device on the
 110  *      bus to change the value by driving the bus high or low and switching to
 111  *      tristate. The argument is ignored.
 112  * @PIN_CONFIG_BIAS_PULL_UP: the pin will be pulled up (usually with high
 113  *      impedance to VDD). If the argument is != 0 pull-up is enabled,
 114  *      if it is 0, pull-up is total, i.e. the pin is connected to VDD.
 115  * @PIN_CONFIG_BIAS_PULL_DOWN: the pin will be pulled down (usually with high
 116  *      impedance to GROUND). If the argument is != 0 pull-down is enabled,
 117  *      if it is 0, pull-down is total, i.e. the pin is connected to GROUND.
 118  * @PIN_CONFIG_BIAS_PULL_PIN_DEFAULT: the pin will be pulled up or down based
 119  *      on embedded knowledge of the controller hardware, like current mux
 120  *      function. The pull direction and possibly strength too will normally
 121  *      be decided completely inside the hardware block and not be readable
 122  *      from the kernel side.
 123  *      If the argument is != 0 pull up/down is enabled, if it is 0, the
 124  *      configuration is ignored. The proper way to disable it is to use
 125  *      @PIN_CONFIG_BIAS_DISABLE.
 126  * @PIN_CONFIG_DRIVE_PUSH_PULL: the pin will be driven actively high and
 127  *      low, this is the most typical case and is typically achieved with two
 128  *      active transistors on the output. Setting this config will enable
 129  *      push-pull mode, the argument is ignored.
 130  * @PIN_CONFIG_DRIVE_OPEN_DRAIN: the pin will be driven with open drain (open
 131  *      collector) which means it is usually wired with other output ports
 132  *      which are then pulled up with an external resistor. Setting this
 133  *      config will enable open drain mode, the argument is ignored.
 134  * @PIN_CONFIG_DRIVE_OPEN_SOURCE: the pin will be driven with open source
 135  *      (open emitter). Setting this config will enable open source mode, the
 136  *      argument is ignored.
 137  * @PIN_CONFIG_DRIVE_STRENGTH: the pin will sink or source at most the current
 138  *      passed as argument. The argument is in mA.
 139  * @PIN_CONFIG_INPUT_ENABLE: enable the pin's input.  Note that this does not
 140  *      affect the pin's ability to drive output.  1 enables input, 0 disables
 141  *      input.
 142  * @PIN_CONFIG_INPUT_SCHMITT_ENABLE: control schmitt-trigger mode on the pin.
 143  *      If the argument != 0, schmitt-trigger mode is enabled. If it's 0,
 144  *      schmitt-trigger mode is disabled.
 145  * @PIN_CONFIG_INPUT_SCHMITT: this will configure an input pin to run in
 146  *      schmitt-trigger mode. If the schmitt-trigger has adjustable hysteresis,
 147  *      the threshold value is given on a custom format as argument when
 148  *      setting pins to this mode.
 149  * @PIN_CONFIG_INPUT_DEBOUNCE: this will configure the pin to debounce mode,
 150  *      which means it will wait for signals to settle when reading inputs. The
 151  *      argument gives the debounce time in usecs. Setting the
 152  *      argument to zero turns debouncing off.
 153  * @PIN_CONFIG_POWER_SOURCE: if the pin can select between different power
 154  *      supplies, the argument to this parameter (on a custom format) tells
 155  *      the driver which alternative power source to use.
 156  * @PIN_CONFIG_SLEW_RATE: if the pin can select slew rate, the argument to
 157  *      this parameter (on a custom format) tells the driver which alternative
 158  *      slew rate to use.
 159  * @PIN_CONFIG_LOW_POWER_MODE: this will configure the pin for low power
 160  *      operation, if several modes of operation are supported these can be
 161  *      passed in the argument on a custom form, else just use argument 1
 162  *      to indicate low power mode, argument 0 turns low power mode off.
 163  * @PIN_CONFIG_OUTPUT: this will configure the pin as an output. Use argument
 164  *      1 to indicate high level, argument 0 to indicate low level. (Please
 165  *      see Documentation/pinctrl.txt, section "GPIO mode pitfalls" for a
 166  *      discussion around this parameter.)
 167  * @PIN_CONFIG_END: this is the last enumerator for pin configurations, if
 168  *      you need to pass in custom configurations to the pin controller, use
 169  *      PIN_CONFIG_END+1 as the base offset.
 170  */
 171 #define PIN_CONFIG_BIAS_DISABLE                 0
 172 #define PIN_CONFIG_BIAS_HIGH_IMPEDANCE          1
 173 #define PIN_CONFIG_BIAS_BUS_HOLD                2
 174 #define PIN_CONFIG_BIAS_PULL_UP                 3
 175 #define PIN_CONFIG_BIAS_PULL_DOWN               4
 176 #define PIN_CONFIG_BIAS_PULL_PIN_DEFAULT        5
 177 #define PIN_CONFIG_DRIVE_PUSH_PULL              6
 178 #define PIN_CONFIG_DRIVE_OPEN_DRAIN             7
 179 #define PIN_CONFIG_DRIVE_OPEN_SOURCE            8
 180 #define PIN_CONFIG_DRIVE_STRENGTH               9
 181 #define PIN_CONFIG_INPUT_ENABLE                 10
 182 #define PIN_CONFIG_INPUT_SCHMITT_ENABLE         11
 183 #define PIN_CONFIG_INPUT_SCHMITT                12
 184 #define PIN_CONFIG_INPUT_DEBOUNCE               13
 185 #define PIN_CONFIG_POWER_SOURCE                 14
 186 #define PIN_CONFIG_SLEW_RATE                    15
 187 #define PIN_CONFIG_LOW_POWER_MODE               16
 188 #define PIN_CONFIG_OUTPUT                       17
 189 #define PIN_CONFIG_END                          0x7FFF
 190
 191 #if CONFIG_IS_ENABLED(PINCTRL_GENERIC)
 192 /**
 193  * pinctrl_generic_set_state() - generic set_state operation
 194  * Parse the DT node of @config and its children and handle generic properties
 195  * such as "pins", "groups", "functions", and pin configuration parameters.
 196  *
 197  * @pctldev: pinctrl device
 198  * @config: config device (pseudo device), pointing a config node in DTS
 199  * @return: 0 on success, or negative error code on failure
 200  */
 201 int pinctrl_generic_set_state(struct udevice *pctldev, struct udevice *config);
 202 #else
 203 static inline int pinctrl_generic_set_state(struct udevice *pctldev,
 204                                             struct udevice *config)
 205 {
 206         return -EINVAL;
 207 }
 208 #endif
 209
 210 #if CONFIG_IS_ENABLED(PINCTRL)
 211 /**
 212  * pinctrl_select_state() - set a device to a given state
 213  *
 214  * @dev: peripheral device
 215  * @statename: state name, like "default"
 216  * @return: 0 on success, or negative error code on failure
 217  */
 218 int pinctrl_select_state(struct udevice *dev, const char *statename);
 219 #else
 220 static inline int pinctrl_select_state(struct udevice *dev,
 221                                        const char *statename)
 222 {
 223         return -EINVAL;
 224 }
 225 #endif
 226
 227 #endif /* __PINCTRL_H */