1 /* 2 * pin-controller/pin-mux/pin-config/gpio-driver for Samsung's SoC's. 3 * 4 * Copyright (c) 2012 Samsung Electronics Co., Ltd. 5 * http://www.samsung.com 6 * Copyright (c) 2012 Linaro Ltd 7 * http://www.linaro.org 8 * 9 * Author: Thomas Abraham <thomas.ab@samsung.com> 10 * 11 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of the GNU General Public License as published by 13 * the Free Software Foundation; either version 2 of the License, or 14 * (at your option) any later version. 15 */ 16 17 #ifndef __PINCTRL_SAMSUNG_H 18 #define __PINCTRL_SAMSUNG_H 19 20 #include <linux/pinctrl/pinctrl.h> 21 #include <linux/pinctrl/pinmux.h> 22 #include <linux/pinctrl/pinconf.h> 23 #include <linux/pinctrl/consumer.h> 24 #include <linux/pinctrl/machine.h> 25 26 #include <linux/gpio.h> 27 28 /* pinmux function number for pin as gpio output line */ 29 #define FUNC_INPUT 0x0 30 #define FUNC_OUTPUT 0x1 31 32 /** 33 * enum pincfg_type - possible pin configuration types supported. 34 * @PINCFG_TYPE_FUNC: Function configuration. 35 * @PINCFG_TYPE_DAT: Pin value configuration. 36 * @PINCFG_TYPE_PUD: Pull up/down configuration. 37 * @PINCFG_TYPE_DRV: Drive strength configuration. 38 * @PINCFG_TYPE_CON_PDN: Pin function in power down mode. 39 * @PINCFG_TYPE_PUD_PDN: Pull up/down configuration in power down mode. 40 */ 41 enum pincfg_type { 42 PINCFG_TYPE_FUNC, 43 PINCFG_TYPE_DAT, 44 PINCFG_TYPE_PUD, 45 PINCFG_TYPE_DRV, 46 PINCFG_TYPE_CON_PDN, 47 PINCFG_TYPE_PUD_PDN, 48 49 PINCFG_TYPE_NUM 50 }; 51 52 /* 53 * pin configuration (pull up/down and drive strength) type and its value are 54 * packed together into a 16-bits. The upper 8-bits represent the configuration 55 * type and the lower 8-bits hold the value of the configuration type. 56 */ 57 #define PINCFG_TYPE_MASK 0xFF 58 #define PINCFG_VALUE_SHIFT 8 59 #define PINCFG_VALUE_MASK (0xFF << PINCFG_VALUE_SHIFT) 60 #define PINCFG_PACK(type, value) (((value) << PINCFG_VALUE_SHIFT) | type) 61 #define PINCFG_UNPACK_TYPE(cfg) ((cfg) & PINCFG_TYPE_MASK) 62 #define PINCFG_UNPACK_VALUE(cfg) (((cfg) & PINCFG_VALUE_MASK) >> \ 63 PINCFG_VALUE_SHIFT) 64 /** 65 * enum eint_type - possible external interrupt types. 66 * @EINT_TYPE_NONE: bank does not support external interrupts 67 * @EINT_TYPE_GPIO: bank supportes external gpio interrupts 68 * @EINT_TYPE_WKUP: bank supportes external wakeup interrupts 69 * @EINT_TYPE_WKUP_MUX: bank supports multiplexed external wakeup interrupts 70 * 71 * Samsung GPIO controller groups all the available pins into banks. The pins 72 * in a pin bank can support external gpio interrupts or external wakeup 73 * interrupts or no interrupts at all. From a software perspective, the only 74 * difference between external gpio and external wakeup interrupts is that 75 * the wakeup interrupts can additionally wakeup the system if it is in 76 * suspended state. 77 */ 78 enum eint_type { 79 EINT_TYPE_NONE, 80 EINT_TYPE_GPIO, 81 EINT_TYPE_WKUP, 82 EINT_TYPE_WKUP_MUX, 83 }; 84 85 /* maximum length of a pin in pin descriptor (example: "gpa0-0") */ 86 #define PIN_NAME_LENGTH 10 87 88 #define PIN_GROUP(n, p, f) \ 89 { \ 90 .name = n, \ 91 .pins = p, \ 92 .num_pins = ARRAY_SIZE(p), \ 93 .func = f \ 94 } 95 96 #define PMX_FUNC(n, g) \ 97 { \ 98 .name = n, \ 99 .groups = g, \ 100 .num_groups = ARRAY_SIZE(g), \ 101 } 102 103 struct samsung_pinctrl_drv_data; 104 105 /** 106 * struct samsung_pin_bank_type: pin bank type description 107 * @fld_width: widths of configuration bitfields (0 if unavailable) 108 * @reg_offset: offsets of configuration registers (don't care of width is 0) 109 */ 110 struct samsung_pin_bank_type { 111 u8 fld_width[PINCFG_TYPE_NUM]; 112 u8 reg_offset[PINCFG_TYPE_NUM]; 113 }; 114 115 /** 116 * struct samsung_pin_bank_data: represent a controller pin-bank (init data). 117 * @type: type of the bank (register offsets and bitfield widths) 118 * @pctl_offset: starting offset of the pin-bank registers. 119 * @pctl_res_idx: index of base address for pin-bank registers. 120 * @nr_pins: number of pins included in this bank. 121 * @eint_func: function to set in CON register to configure pin as EINT. 122 * @eint_type: type of the external interrupt supported by the bank. 123 * @eint_mask: bit mask of pins which support EINT function. 124 * @eint_offset: SoC-specific EINT register or interrupt offset of bank. 125 * @name: name to be prefixed for each pin in this pin bank. 126 */ 127 struct samsung_pin_bank_data { 128 const struct samsung_pin_bank_type *type; 129 u32 pctl_offset; 130 u8 pctl_res_idx; 131 u8 nr_pins; 132 u8 eint_func; 133 enum eint_type eint_type; 134 u32 eint_mask; 135 u32 eint_offset; 136 const char *name; 137 }; 138 139 /** 140 * struct samsung_pin_bank: represent a controller pin-bank. 141 * @type: type of the bank (register offsets and bitfield widths) 142 * @pctl_base: base address of the pin-bank registers 143 * @pctl_offset: starting offset of the pin-bank registers. 144 * @nr_pins: number of pins included in this bank. 145 * @eint_base: base address of the pin-bank EINT registers. 146 * @eint_func: function to set in CON register to configure pin as EINT. 147 * @eint_type: type of the external interrupt supported by the bank. 148 * @eint_mask: bit mask of pins which support EINT function. 149 * @eint_offset: SoC-specific EINT register or interrupt offset of bank. 150 * @name: name to be prefixed for each pin in this pin bank. 151 * @pin_base: starting pin number of the bank. 152 * @soc_priv: per-bank private data for SoC-specific code. 153 * @of_node: OF node of the bank. 154 * @drvdata: link to controller driver data 155 * @irq_domain: IRQ domain of the bank. 156 * @gpio_chip: GPIO chip of the bank. 157 * @grange: linux gpio pin range supported by this bank. 158 * @irq_chip: link to irq chip for external gpio and wakeup interrupts. 159 * @slock: spinlock protecting bank registers 160 * @pm_save: saved register values during suspend 161 */ 162 struct samsung_pin_bank { 163 const struct samsung_pin_bank_type *type; 164 void __iomem *pctl_base; 165 u32 pctl_offset; 166 u8 nr_pins; 167 void __iomem *eint_base; 168 u8 eint_func; 169 enum eint_type eint_type; 170 u32 eint_mask; 171 u32 eint_offset; 172 const char *name; 173 174 u32 pin_base; 175 void *soc_priv; 176 struct device_node *of_node; 177 struct samsung_pinctrl_drv_data *drvdata; 178 struct irq_domain *irq_domain; 179 struct gpio_chip gpio_chip; 180 struct pinctrl_gpio_range grange; 181 struct exynos_irq_chip *irq_chip; 182 spinlock_t slock; 183 184 u32 pm_save[PINCFG_TYPE_NUM + 1]; /* +1 to handle double CON registers*/ 185 }; 186 187 /** 188 * struct samsung_retention_data: runtime pin-bank retention control data. 189 * @regs: array of PMU registers to control pad retention. 190 * @nr_regs: number of registers in @regs array. 191 * @value: value to store to registers to turn off retention. 192 * @refcnt: atomic counter if retention control affects more than one bank. 193 * @priv: retention control code private data 194 * @enable: platform specific callback to enter retention mode. 195 * @disable: platform specific callback to exit retention mode. 196 **/ 197 struct samsung_retention_ctrl { 198 const u32 *regs; 199 int nr_regs; 200 u32 value; 201 atomic_t *refcnt; 202 void *priv; 203 void (*enable)(struct samsung_pinctrl_drv_data *); 204 void (*disable)(struct samsung_pinctrl_drv_data *); 205 }; 206 207 /** 208 * struct samsung_retention_data: represent a pin-bank retention control data. 209 * @regs: array of PMU registers to control pad retention. 210 * @nr_regs: number of registers in @regs array. 211 * @value: value to store to registers to turn off retention. 212 * @refcnt: atomic counter if retention control affects more than one bank. 213 * @init: platform specific callback to initialize retention control. 214 **/ 215 struct samsung_retention_data { 216 const u32 *regs; 217 int nr_regs; 218 u32 value; 219 atomic_t *refcnt; 220 struct samsung_retention_ctrl *(*init)(struct samsung_pinctrl_drv_data *, 221 const struct samsung_retention_data *); 222 }; 223 224 /** 225 * struct samsung_pin_ctrl: represent a pin controller. 226 * @pin_banks: list of pin banks included in this controller. 227 * @nr_banks: number of pin banks. 228 * @nr_ext_resources: number of the extra base address for pin banks. 229 * @retention_data: configuration data for retention control. 230 * @eint_gpio_init: platform specific callback to setup the external gpio 231 * interrupts for the controller. 232 * @eint_wkup_init: platform specific callback to setup the external wakeup 233 * interrupts for the controller. 234 */ 235 struct samsung_pin_ctrl { 236 const struct samsung_pin_bank_data *pin_banks; 237 u32 nr_banks; 238 int nr_ext_resources; 239 const struct samsung_retention_data *retention_data; 240 241 int (*eint_gpio_init)(struct samsung_pinctrl_drv_data *); 242 int (*eint_wkup_init)(struct samsung_pinctrl_drv_data *); 243 void (*suspend)(struct samsung_pinctrl_drv_data *); 244 void (*resume)(struct samsung_pinctrl_drv_data *); 245 }; 246 247 /** 248 * struct samsung_pinctrl_drv_data: wrapper for holding driver data together. 249 * @node: global list node 250 * @dev: device instance representing the controller. 251 * @irq: interrpt number used by the controller to notify gpio interrupts. 252 * @ctrl: pin controller instance managed by the driver. 253 * @pctl: pin controller descriptor registered with the pinctrl subsystem. 254 * @pctl_dev: cookie representing pinctrl device instance. 255 * @pin_groups: list of pin groups available to the driver. 256 * @nr_groups: number of such pin groups. 257 * @pmx_functions: list of pin functions available to the driver. 258 * @nr_function: number of such pin functions. 259 * @pin_base: starting system wide pin number. 260 * @nr_pins: number of pins supported by the controller. 261 * @retention_ctrl: retention control runtime data. 262 */ 263 struct samsung_pinctrl_drv_data { 264 struct list_head node; 265 struct device *dev; 266 int irq; 267 268 struct pinctrl_desc pctl; 269 struct pinctrl_dev *pctl_dev; 270 271 const struct samsung_pin_group *pin_groups; 272 unsigned int nr_groups; 273 const struct samsung_pmx_func *pmx_functions; 274 unsigned int nr_functions; 275 276 struct samsung_pin_bank *pin_banks; 277 u32 nr_banks; 278 unsigned int pin_base; 279 unsigned int nr_pins; 280 281 struct samsung_retention_ctrl *retention_ctrl; 282 283 void (*suspend)(struct samsung_pinctrl_drv_data *); 284 void (*resume)(struct samsung_pinctrl_drv_data *); 285 }; 286 287 /** 288 * struct samsung_pin_group: represent group of pins of a pinmux function. 289 * @name: name of the pin group, used to lookup the group. 290 * @pins: the pins included in this group. 291 * @num_pins: number of pins included in this group. 292 * @func: the function number to be programmed when selected. 293 */ 294 struct samsung_pin_group { 295 const char *name; 296 const unsigned int *pins; 297 u8 num_pins; 298 u8 func; 299 }; 300 301 /** 302 * struct samsung_pmx_func: represent a pin function. 303 * @name: name of the pin function, used to lookup the function. 304 * @groups: one or more names of pin groups that provide this function. 305 * @num_groups: number of groups included in @groups. 306 */ 307 struct samsung_pmx_func { 308 const char *name; 309 const char **groups; 310 u8 num_groups; 311 u32 val; 312 }; 313 314 /* list of all exported SoC specific data */ 315 extern const struct samsung_pin_ctrl exynos3250_pin_ctrl[]; 316 extern const struct samsung_pin_ctrl exynos4210_pin_ctrl[]; 317 extern const struct samsung_pin_ctrl exynos4x12_pin_ctrl[]; 318 extern const struct samsung_pin_ctrl exynos5250_pin_ctrl[]; 319 extern const struct samsung_pin_ctrl exynos5260_pin_ctrl[]; 320 extern const struct samsung_pin_ctrl exynos5410_pin_ctrl[]; 321 extern const struct samsung_pin_ctrl exynos5420_pin_ctrl[]; 322 extern const struct samsung_pin_ctrl exynos5433_pin_ctrl[]; 323 extern const struct samsung_pin_ctrl exynos7_pin_ctrl[]; 324 extern const struct samsung_pin_ctrl s3c64xx_pin_ctrl[]; 325 extern const struct samsung_pin_ctrl s3c2412_pin_ctrl[]; 326 extern const struct samsung_pin_ctrl s3c2416_pin_ctrl[]; 327 extern const struct samsung_pin_ctrl s3c2440_pin_ctrl[]; 328 extern const struct samsung_pin_ctrl s3c2450_pin_ctrl[]; 329 extern const struct samsung_pin_ctrl s5pv210_pin_ctrl[]; 330 331 #endif /* __PINCTRL_SAMSUNG_H */ 332