1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Driver for the NVIDIA Tegra pinmux 4 * 5 * Copyright (c) 2011, NVIDIA CORPORATION. All rights reserved. 6 */ 7 8 #ifndef __PINMUX_TEGRA_H__ 9 #define __PINMUX_TEGRA_H__ 10 11 struct tegra_pingroup_config { 12 bool is_sfsel; 13 }; 14 15 struct tegra_pmx { 16 struct device *dev; 17 struct pinctrl_dev *pctl; 18 19 const struct tegra_pinctrl_soc_data *soc; 20 struct tegra_function *functions; 21 const char **group_pins; 22 23 struct pinctrl_gpio_range gpio_range; 24 struct pinctrl_desc desc; 25 int nbanks; 26 void __iomem **regs; 27 u32 *backup_regs; 28 /* Array of size soc->ngroups */ 29 struct tegra_pingroup_config *pingroup_configs; 30 }; 31 32 enum tegra_pinconf_param { 33 /* argument: tegra_pinconf_pull */ 34 TEGRA_PINCONF_PARAM_PULL, 35 /* argument: tegra_pinconf_tristate */ 36 TEGRA_PINCONF_PARAM_TRISTATE, 37 /* argument: Boolean */ 38 TEGRA_PINCONF_PARAM_ENABLE_INPUT, 39 /* argument: Boolean */ 40 TEGRA_PINCONF_PARAM_OPEN_DRAIN, 41 /* argument: Boolean */ 42 TEGRA_PINCONF_PARAM_LOCK, 43 /* argument: Boolean */ 44 TEGRA_PINCONF_PARAM_IORESET, 45 /* argument: Boolean */ 46 TEGRA_PINCONF_PARAM_RCV_SEL, 47 /* argument: Boolean */ 48 TEGRA_PINCONF_PARAM_HIGH_SPEED_MODE, 49 /* argument: Boolean */ 50 TEGRA_PINCONF_PARAM_SCHMITT, 51 /* argument: Boolean */ 52 TEGRA_PINCONF_PARAM_LOW_POWER_MODE, 53 /* argument: Integer, range is HW-dependant */ 54 TEGRA_PINCONF_PARAM_DRIVE_DOWN_STRENGTH, 55 /* argument: Integer, range is HW-dependant */ 56 TEGRA_PINCONF_PARAM_DRIVE_UP_STRENGTH, 57 /* argument: Integer, range is HW-dependant */ 58 TEGRA_PINCONF_PARAM_SLEW_RATE_FALLING, 59 /* argument: Integer, range is HW-dependant */ 60 TEGRA_PINCONF_PARAM_SLEW_RATE_RISING, 61 /* argument: Integer, range is HW-dependant */ 62 TEGRA_PINCONF_PARAM_DRIVE_TYPE, 63 }; 64 65 enum tegra_pinconf_pull { 66 TEGRA_PINCONFIG_PULL_NONE, 67 TEGRA_PINCONFIG_PULL_DOWN, 68 TEGRA_PINCONFIG_PULL_UP, 69 }; 70 71 enum tegra_pinconf_tristate { 72 TEGRA_PINCONFIG_DRIVEN, 73 TEGRA_PINCONFIG_TRISTATE, 74 }; 75 76 #define TEGRA_PINCONF_PACK(_param_, _arg_) ((_param_) << 16 | (_arg_)) 77 #define TEGRA_PINCONF_UNPACK_PARAM(_conf_) ((_conf_) >> 16) 78 #define TEGRA_PINCONF_UNPACK_ARG(_conf_) ((_conf_) & 0xffff) 79 80 /** 81 * struct tegra_function - Tegra pinctrl mux function 82 * @name: The name of the function, exported to pinctrl core. 83 * @groups: An array of pin groups that may select this function. 84 * @ngroups: The number of entries in @groups. 85 */ 86 struct tegra_function { 87 const char *name; 88 const char **groups; 89 unsigned ngroups; 90 }; 91 92 /** 93 * struct tegra_pingroup - Tegra pin group 94 * @name The name of the pin group. 95 * @pins An array of pin IDs included in this pin group. 96 * @npins The number of entries in @pins. 97 * @funcs The mux functions which can be muxed onto this group. 98 * @mux_reg: Mux register offset. 99 * This register contains the mux, einput, odrain, lock, 100 * ioreset, rcv_sel parameters. 101 * @mux_bank: Mux register bank. 102 * @mux_bit: Mux register bit. 103 * @pupd_reg: Pull-up/down register offset. 104 * @pupd_bank: Pull-up/down register bank. 105 * @pupd_bit: Pull-up/down register bit. 106 * @tri_reg: Tri-state register offset. 107 * @tri_bank: Tri-state register bank. 108 * @tri_bit: Tri-state register bit. 109 * @einput_bit: Enable-input register bit. 110 * @odrain_bit: Open-drain register bit. 111 * @lock_bit: Lock register bit. 112 * @ioreset_bit: IO reset register bit. 113 * @rcv_sel_bit: Receiver select bit. 114 * @drv_reg: Drive fields register offset. 115 * This register contains hsm, schmitt, lpmd, drvdn, 116 * drvup, slwr, slwf, and drvtype parameters. 117 * @drv_bank: Drive fields register bank. 118 * @hsm_bit: High Speed Mode register bit. 119 * @sfsel_bit: GPIO/SFIO selection register bit. 120 * @schmitt_bit: Schmitt register bit. 121 * @lpmd_bit: Low Power Mode register bit. 122 * @drvdn_bit: Drive Down register bit. 123 * @drvdn_width: Drive Down field width. 124 * @drvup_bit: Drive Up register bit. 125 * @drvup_width: Drive Up field width. 126 * @slwr_bit: Slew Rising register bit. 127 * @slwr_width: Slew Rising field width. 128 * @slwf_bit: Slew Falling register bit. 129 * @slwf_width: Slew Falling field width. 130 * @lpdr_bit: Base driver enabling bit. 131 * @drvtype_bit: Drive type register bit. 132 * @parked_bitmask: Parked register mask. 0 if unsupported. 133 * 134 * -1 in a *_reg field means that feature is unsupported for this group. 135 * *_bank and *_reg values are irrelevant when *_reg is -1. 136 * When *_reg is valid, *_bit may be -1 to indicate an unsupported feature. 137 * 138 * A representation of a group of pins (possibly just one pin) in the Tegra 139 * pin controller. Each group allows some parameter or parameters to be 140 * configured. The most common is mux function selection. Many others exist 141 * such as pull-up/down, tri-state, etc. Tegra's pin controller is complex; 142 * certain groups may only support configuring certain parameters, hence 143 * each parameter is optional. 144 */ 145 struct tegra_pingroup { 146 const char *name; 147 const unsigned *pins; 148 u8 npins; 149 u8 funcs[4]; 150 s32 mux_reg; 151 s32 pupd_reg; 152 s32 tri_reg; 153 s32 drv_reg; 154 u32 mux_bank:2; 155 u32 pupd_bank:2; 156 u32 tri_bank:2; 157 u32 drv_bank:2; 158 s32 mux_bit:6; 159 s32 pupd_bit:6; 160 s32 tri_bit:6; 161 s32 einput_bit:6; 162 s32 odrain_bit:6; 163 s32 lock_bit:6; 164 s32 ioreset_bit:6; 165 s32 rcv_sel_bit:6; 166 s32 hsm_bit:6; 167 s32 sfsel_bit:6; 168 s32 schmitt_bit:6; 169 s32 lpmd_bit:6; 170 s32 drvdn_bit:6; 171 s32 drvup_bit:6; 172 s32 slwr_bit:6; 173 s32 slwf_bit:6; 174 s32 lpdr_bit:6; 175 s32 drvtype_bit:6; 176 s32 drvdn_width:6; 177 s32 drvup_width:6; 178 s32 slwr_width:6; 179 s32 slwf_width:6; 180 u32 parked_bitmask; 181 }; 182 183 /** 184 * struct tegra_pinctrl_soc_data - Tegra pin controller driver configuration 185 * @ngpios: The number of GPIO pins the pin controller HW affects. 186 * @pins: An array describing all pins the pin controller affects. 187 * All pins which are also GPIOs must be listed first within the 188 * array, and be numbered identically to the GPIO controller's 189 * numbering. 190 * @npins: The numbmer of entries in @pins. 191 * @functions: An array describing all mux functions the SoC supports. 192 * @nfunctions: The numbmer of entries in @functions. 193 * @groups: An array describing all pin groups the pin SoC supports. 194 * @ngroups: The numbmer of entries in @groups. 195 */ 196 struct tegra_pinctrl_soc_data { 197 unsigned ngpios; 198 const char *gpio_compatible; 199 const struct pinctrl_pin_desc *pins; 200 unsigned npins; 201 const char * const *functions; 202 unsigned nfunctions; 203 const struct tegra_pingroup *groups; 204 unsigned ngroups; 205 bool hsm_in_mux; 206 bool schmitt_in_mux; 207 bool drvtype_in_mux; 208 bool sfsel_in_mux; 209 }; 210 211 extern const struct dev_pm_ops tegra_pinctrl_pm; 212 213 int tegra_pinctrl_probe(struct platform_device *pdev, 214 const struct tegra_pinctrl_soc_data *soc_data); 215 #endif 216