1/* SPDX-License-Identifier: GPL-2.0 */ 2/* 3 * Copyright (C) 2018 MediaTek Inc. 4 * 5 * Author: Sean Wang <sean.wang@mediatek.com> 6 * 7 */ 8 9#ifndef __PINCTRL_MTK_COMMON_V2_H 10#define __PINCTRL_MTK_COMMON_V2_H 11 12#include <linux/gpio/driver.h> 13 14#define MTK_INPUT 0 15#define MTK_OUTPUT 1 16#define MTK_DISABLE 0 17#define MTK_ENABLE 1 18#define MTK_PULLDOWN 0 19#define MTK_PULLUP 1 20 21#define EINT_NA U16_MAX 22#define NO_EINT_SUPPORT EINT_NA 23 24#define PIN_FIELD_CALC(_s_pin, _e_pin, _i_base, _s_addr, _x_addrs, \ 25 _s_bit, _x_bits, _sz_reg, _fixed) { \ 26 .s_pin = _s_pin, \ 27 .e_pin = _e_pin, \ 28 .i_base = _i_base, \ 29 .s_addr = _s_addr, \ 30 .x_addrs = _x_addrs, \ 31 .s_bit = _s_bit, \ 32 .x_bits = _x_bits, \ 33 .sz_reg = _sz_reg, \ 34 .fixed = _fixed, \ 35 } 36 37#define PIN_FIELD(_s_pin, _e_pin, _s_addr, _x_addrs, _s_bit, _x_bits) \ 38 PIN_FIELD_CALC(_s_pin, _e_pin, 0, _s_addr, _x_addrs, _s_bit, \ 39 _x_bits, 32, 0) 40 41#define PINS_FIELD(_s_pin, _e_pin, _s_addr, _x_addrs, _s_bit, _x_bits) \ 42 PIN_FIELD_CALC(_s_pin, _e_pin, 0, _s_addr, _x_addrs, _s_bit, \ 43 _x_bits, 32, 1) 44 45/* List these attributes which could be modified for the pin */ 46enum { 47 PINCTRL_PIN_REG_MODE, 48 PINCTRL_PIN_REG_DIR, 49 PINCTRL_PIN_REG_DI, 50 PINCTRL_PIN_REG_DO, 51 PINCTRL_PIN_REG_SR, 52 PINCTRL_PIN_REG_SMT, 53 PINCTRL_PIN_REG_PD, 54 PINCTRL_PIN_REG_PU, 55 PINCTRL_PIN_REG_E4, 56 PINCTRL_PIN_REG_E8, 57 PINCTRL_PIN_REG_TDSEL, 58 PINCTRL_PIN_REG_RDSEL, 59 PINCTRL_PIN_REG_DRV, 60 PINCTRL_PIN_REG_PUPD, 61 PINCTRL_PIN_REG_R0, 62 PINCTRL_PIN_REG_R1, 63 PINCTRL_PIN_REG_IES, 64 PINCTRL_PIN_REG_PULLEN, 65 PINCTRL_PIN_REG_PULLSEL, 66 PINCTRL_PIN_REG_DRV_EN, 67 PINCTRL_PIN_REG_DRV_E0, 68 PINCTRL_PIN_REG_DRV_E1, 69 PINCTRL_PIN_REG_MAX, 70}; 71 72/* Group the pins by the driving current */ 73enum { 74 DRV_FIXED, 75 DRV_GRP0, 76 DRV_GRP1, 77 DRV_GRP2, 78 DRV_GRP3, 79 DRV_GRP4, 80 DRV_GRP_MAX, 81}; 82 83static const char * const mtk_default_register_base_names[] __maybe_unused = { 84 "base", 85}; 86 87/* struct mtk_pin_field - the structure that holds the information of the field 88 * used to describe the attribute for the pin 89 * @base: the index pointing to the entry in base address list 90 * @offset: the register offset relative to the base address 91 * @mask: the mask used to filter out the field from the register 92 * @bitpos: the start bit relative to the register 93 * @next: the indication that the field would be extended to the 94 next register 95 */ 96struct mtk_pin_field { 97 u8 index; 98 u32 offset; 99 u32 mask; 100 u8 bitpos; 101 u8 next; 102}; 103 104/* struct mtk_pin_field_calc - the structure that holds the range providing 105 * the guide used to look up the relevant field 106 * @s_pin: the start pin within the range 107 * @e_pin: the end pin within the range 108 * @i_base: the index pointing to the entry in base address list 109 * @s_addr: the start address for the range 110 * @x_addrs: the address distance between two consecutive registers 111 * within the range 112 * @s_bit: the start bit for the first register within the range 113 * @x_bits: the bit distance between two consecutive pins within 114 * the range 115 * @sz_reg: the size of bits in a register 116 * @fixed: the consecutive pins share the same bits with the 1st 117 * pin 118 */ 119struct mtk_pin_field_calc { 120 u16 s_pin; 121 u16 e_pin; 122 u8 i_base; 123 u32 s_addr; 124 u8 x_addrs; 125 u8 s_bit; 126 u8 x_bits; 127 u8 sz_reg; 128 u8 fixed; 129}; 130 131/* struct mtk_pin_reg_calc - the structure that holds all ranges used to 132 * determine which register the pin would make use of 133 * for certain pin attribute. 134 * @range: the start address for the range 135 * @nranges: the number of items in the range 136 */ 137struct mtk_pin_reg_calc { 138 const struct mtk_pin_field_calc *range; 139 unsigned int nranges; 140}; 141 142/** 143 * struct mtk_func_desc - the structure that providing information 144 * all the funcs for this pin 145 * @name: the name of function 146 * @muxval: the mux to the function 147 */ 148struct mtk_func_desc { 149 const char *name; 150 u8 muxval; 151}; 152 153/** 154 * struct mtk_eint_desc - the structure that providing information 155 * for eint data per pin 156 * @eint_m: the eint mux for this pin 157 * @eitn_n: the eint number for this pin 158 */ 159struct mtk_eint_desc { 160 u16 eint_m; 161 u16 eint_n; 162}; 163 164/** 165 * struct mtk_pin_desc - the structure that providing information 166 * for each pin of chips 167 * @number: unique pin number from the global pin number space 168 * @name: name for this pin 169 * @eint: the eint data for this pin 170 * @drv_n: the index with the driving group 171 * @funcs: all available functions for this pins (only used in 172 * those drivers compatible to pinctrl-mtk-common.c-like 173 * ones) 174 */ 175struct mtk_pin_desc { 176 unsigned int number; 177 const char *name; 178 struct mtk_eint_desc eint; 179 u8 drv_n; 180 struct mtk_func_desc *funcs; 181}; 182 183struct mtk_pinctrl_group { 184 const char *name; 185 unsigned long config; 186 unsigned pin; 187}; 188 189struct mtk_pinctrl; 190 191/* struct mtk_pin_soc - the structure that holds SoC-specific data */ 192struct mtk_pin_soc { 193 const struct mtk_pin_reg_calc *reg_cal; 194 const struct mtk_pin_desc *pins; 195 unsigned int npins; 196 const struct group_desc *grps; 197 unsigned int ngrps; 198 const struct function_desc *funcs; 199 unsigned int nfuncs; 200 const struct mtk_eint_regs *eint_regs; 201 const struct mtk_eint_hw *eint_hw; 202 203 /* Specific parameters per SoC */ 204 u8 gpio_m; 205 bool ies_present; 206 const char * const *base_names; 207 unsigned int nbase_names; 208 209 /* Specific pinconfig operations */ 210 int (*bias_disable_set)(struct mtk_pinctrl *hw, 211 const struct mtk_pin_desc *desc); 212 int (*bias_disable_get)(struct mtk_pinctrl *hw, 213 const struct mtk_pin_desc *desc, int *res); 214 int (*bias_set)(struct mtk_pinctrl *hw, 215 const struct mtk_pin_desc *desc, bool pullup); 216 int (*bias_get)(struct mtk_pinctrl *hw, 217 const struct mtk_pin_desc *desc, bool pullup, int *res); 218 219 int (*bias_set_combo)(struct mtk_pinctrl *hw, 220 const struct mtk_pin_desc *desc, u32 pullup, u32 arg); 221 int (*bias_get_combo)(struct mtk_pinctrl *hw, 222 const struct mtk_pin_desc *desc, u32 *pullup, u32 *arg); 223 224 int (*drive_set)(struct mtk_pinctrl *hw, 225 const struct mtk_pin_desc *desc, u32 arg); 226 int (*drive_get)(struct mtk_pinctrl *hw, 227 const struct mtk_pin_desc *desc, int *val); 228 229 int (*adv_pull_set)(struct mtk_pinctrl *hw, 230 const struct mtk_pin_desc *desc, bool pullup, 231 u32 arg); 232 int (*adv_pull_get)(struct mtk_pinctrl *hw, 233 const struct mtk_pin_desc *desc, bool pullup, 234 u32 *val); 235 int (*adv_drive_set)(struct mtk_pinctrl *hw, 236 const struct mtk_pin_desc *desc, u32 arg); 237 int (*adv_drive_get)(struct mtk_pinctrl *hw, 238 const struct mtk_pin_desc *desc, u32 *val); 239 240 /* Specific driver data */ 241 void *driver_data; 242}; 243 244struct mtk_pinctrl { 245 struct pinctrl_dev *pctrl; 246 void __iomem **base; 247 u8 nbase; 248 struct device *dev; 249 struct gpio_chip chip; 250 const struct mtk_pin_soc *soc; 251 struct mtk_eint *eint; 252 struct mtk_pinctrl_group *groups; 253 const char **grp_names; 254}; 255 256void mtk_rmw(struct mtk_pinctrl *pctl, u8 i, u32 reg, u32 mask, u32 set); 257 258int mtk_hw_set_value(struct mtk_pinctrl *hw, const struct mtk_pin_desc *desc, 259 int field, int value); 260int mtk_hw_get_value(struct mtk_pinctrl *hw, const struct mtk_pin_desc *desc, 261 int field, int *value); 262 263int mtk_build_eint(struct mtk_pinctrl *hw, struct platform_device *pdev); 264 265int mtk_pinconf_bias_disable_set(struct mtk_pinctrl *hw, 266 const struct mtk_pin_desc *desc); 267int mtk_pinconf_bias_disable_get(struct mtk_pinctrl *hw, 268 const struct mtk_pin_desc *desc, int *res); 269int mtk_pinconf_bias_set(struct mtk_pinctrl *hw, 270 const struct mtk_pin_desc *desc, bool pullup); 271int mtk_pinconf_bias_get(struct mtk_pinctrl *hw, 272 const struct mtk_pin_desc *desc, bool pullup, 273 int *res); 274 275int mtk_pinconf_bias_disable_set_rev1(struct mtk_pinctrl *hw, 276 const struct mtk_pin_desc *desc); 277int mtk_pinconf_bias_disable_get_rev1(struct mtk_pinctrl *hw, 278 const struct mtk_pin_desc *desc, 279 int *res); 280int mtk_pinconf_bias_set_rev1(struct mtk_pinctrl *hw, 281 const struct mtk_pin_desc *desc, bool pullup); 282int mtk_pinconf_bias_get_rev1(struct mtk_pinctrl *hw, 283 const struct mtk_pin_desc *desc, bool pullup, 284 int *res); 285int mtk_pinconf_bias_set_combo(struct mtk_pinctrl *hw, 286 const struct mtk_pin_desc *desc, 287 u32 pullup, u32 enable); 288int mtk_pinconf_bias_get_combo(struct mtk_pinctrl *hw, 289 const struct mtk_pin_desc *desc, 290 u32 *pullup, u32 *enable); 291 292int mtk_pinconf_drive_set(struct mtk_pinctrl *hw, 293 const struct mtk_pin_desc *desc, u32 arg); 294int mtk_pinconf_drive_get(struct mtk_pinctrl *hw, 295 const struct mtk_pin_desc *desc, int *val); 296 297int mtk_pinconf_drive_set_rev1(struct mtk_pinctrl *hw, 298 const struct mtk_pin_desc *desc, u32 arg); 299int mtk_pinconf_drive_get_rev1(struct mtk_pinctrl *hw, 300 const struct mtk_pin_desc *desc, int *val); 301 302int mtk_pinconf_drive_set_raw(struct mtk_pinctrl *hw, 303 const struct mtk_pin_desc *desc, u32 arg); 304int mtk_pinconf_drive_get_raw(struct mtk_pinctrl *hw, 305 const struct mtk_pin_desc *desc, int *val); 306 307int mtk_pinconf_adv_pull_set(struct mtk_pinctrl *hw, 308 const struct mtk_pin_desc *desc, bool pullup, 309 u32 arg); 310int mtk_pinconf_adv_pull_get(struct mtk_pinctrl *hw, 311 const struct mtk_pin_desc *desc, bool pullup, 312 u32 *val); 313int mtk_pinconf_adv_drive_set(struct mtk_pinctrl *hw, 314 const struct mtk_pin_desc *desc, u32 arg); 315int mtk_pinconf_adv_drive_get(struct mtk_pinctrl *hw, 316 const struct mtk_pin_desc *desc, u32 *val); 317 318bool mtk_is_virt_gpio(struct mtk_pinctrl *hw, unsigned int gpio_n); 319#endif /* __PINCTRL_MTK_COMMON_V2_H */ 320