1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (c) 2014 MediaTek Inc.
4 * Author: Hongzhou.Yang <hongzhou.yang@mediatek.com>
7 #ifndef __PINCTRL_MTK_COMMON_H
8 #define __PINCTRL_MTK_COMMON_H
10 #include <linux/pinctrl/pinctrl.h>
11 #include <linux/regmap.h>
12 #include <linux/pinctrl/pinconf-generic.h>
16 #define NO_EINT_SUPPORT 255
17 #define MT_EDGE_SENSITIVE 0
18 #define MT_LEVEL_SENSITIVE 1
19 #define EINT_DBNC_SET_DBNC_BITS 4
20 #define EINT_DBNC_RST_BIT (0x1 << 1)
21 #define EINT_DBNC_SET_EN (0x1 << 0)
23 #define MTK_PINCTRL_NOT_SUPPORT (0xffff)
25 struct mtk_desc_function {
30 struct mtk_desc_eint {
31 unsigned char eintmux;
32 unsigned char eintnum;
36 struct pinctrl_pin_desc pin;
37 const struct mtk_desc_eint eint;
38 const struct mtk_desc_function *functions;
41 #define MTK_PIN(_pin, _pad, _chip, _eint, ...) \
45 .functions = (struct mtk_desc_function[]){ \
49 #define MTK_EINT_FUNCTION(_eintmux, _eintnum) \
51 .eintmux = _eintmux, \
52 .eintnum = _eintnum, \
55 #define MTK_FUNCTION(_val, _name) \
61 #define SET_ADDR(x, y) (x + (y->devdata->port_align))
62 #define CLR_ADDR(x, y) (x + (y->devdata->port_align << 1))
64 struct mtk_pinctrl_group {
71 * struct mtk_drv_group_desc - Provide driving group data.
72 * @max_drv: The maximum current of this group.
73 * @min_drv: The minimum current of this group.
74 * @low_bit: The lowest bit of this group.
75 * @high_bit: The highest bit of this group.
76 * @step: The step current of this group.
78 struct mtk_drv_group_desc {
79 unsigned char min_drv;
80 unsigned char max_drv;
81 unsigned char low_bit;
82 unsigned char high_bit;
86 #define MTK_DRV_GRP(_min, _max, _low, _high, _step) \
96 * struct mtk_pin_drv_grp - Provide each pin driving info.
97 * @pin: The pin number.
98 * @offset: The offset of driving register for this pin.
99 * @bit: The bit of driving register for this pin.
100 * @grp: The group for this pin belongs to.
102 struct mtk_pin_drv_grp {
104 unsigned short offset;
109 #define MTK_PIN_DRV_GRP(_pin, _offset, _bit, _grp) \
118 * struct mtk_pin_spec_pupd_set_samereg
119 * - For special pins' pull up/down setting which resides in same register
120 * @pin: The pin number.
121 * @offset: The offset of special pull up/down setting register.
122 * @pupd_bit: The pull up/down bit in this register.
123 * @r0_bit: The r0 bit of pull resistor.
124 * @r1_bit: The r1 bit of pull resistor.
126 struct mtk_pin_spec_pupd_set_samereg {
128 unsigned short offset;
129 unsigned char pupd_bit;
130 unsigned char r1_bit;
131 unsigned char r0_bit;
134 #define MTK_PIN_PUPD_SPEC_SR(_pin, _offset, _pupd, _r1, _r0) \
144 * struct mtk_pin_ies_set - For special pins' ies and smt setting.
145 * @start: The start pin number of those special pins.
146 * @end: The end pin number of those special pins.
147 * @offset: The offset of special setting register.
148 * @bit: The bit of special setting register.
150 struct mtk_pin_ies_smt_set {
151 unsigned short start;
153 unsigned short offset;
157 #define MTK_PIN_IES_SMT_SPEC(_start, _end, _offset, _bit) \
165 struct mtk_eint_offsets {
170 unsigned int mask_set;
171 unsigned int mask_clr;
173 unsigned int sens_set;
174 unsigned int sens_clr;
176 unsigned int soft_set;
177 unsigned int soft_clr;
179 unsigned int pol_set;
180 unsigned int pol_clr;
182 unsigned int dbnc_ctrl;
183 unsigned int dbnc_set;
184 unsigned int dbnc_clr;
190 * struct mtk_pinctrl_devdata - Provide HW GPIO related data.
191 * @pins: An array describing all pins the pin controller affects.
192 * @npins: The number of entries in @pins.
194 * @grp_desc: The driving group info.
195 * @pin_drv_grp: The driving group for all pins.
196 * @spec_ies: Special pin setting for input enable
197 * @n_spec_ies: Number of entries in spec_ies
198 * @spec_pupd: Special pull up/down setting
199 * @n_spec_pupd: Number of entries in spec_pupd
200 * @spec_smt: Special pin setting for schmitt
201 * @n_spec_smt: Number of entries in spec_smt
202 * @spec_pull_set: Each SoC may have special pins for pull up/down setting,
203 * these pins' pull setting are very different, they have separate pull
204 * up/down bit, R0 and R1 resistor bit, so they need special pull setting.
205 * If special setting is success, this should return 0, otherwise it should
206 * return non-zero value.
207 * @spec_ies_smt_set: Some pins are irregular, their input enable and smt
208 * control register are discontinuous, but they are mapping together. That
209 * means when user set smt, input enable is set at the same time. So they
210 * also need special control. If special control is success, this should
211 * return 0, otherwise return non-zero value.
212 * @spec_pinmux_set: In some cases, there are two pinmux functions share
213 * the same value in the same segment of pinmux control register. If user
214 * want to use one of the two functions, they need an extra bit setting to
215 * select the right one.
216 * @spec_dir_set: In very few SoCs, direction control registers are not
217 * arranged continuously, they may be cut to parts. So they need special
220 * @dir_offset: The direction register offset.
221 * @pullen_offset: The pull-up/pull-down enable register offset.
222 * @pinmux_offset: The pinmux register offset.
224 * @type1_start: Some chips have two base addresses for pull select register,
225 * that means some pins use the first address and others use the second. This
226 * member record the start of pin number to use the second address.
227 * @type1_end: The end of pin number to use the second address.
229 * @port_shf: The shift between two registers.
230 * @port_mask: The mask of register.
231 * @port_align: Provide clear register and set register step.
233 struct mtk_pinctrl_devdata {
234 const struct mtk_desc_pin *pins;
236 const struct mtk_drv_group_desc *grp_desc;
237 unsigned int n_grp_cls;
238 const struct mtk_pin_drv_grp *pin_drv_grp;
239 unsigned int n_pin_drv_grps;
240 const struct mtk_pin_ies_smt_set *spec_ies;
241 unsigned int n_spec_ies;
242 const struct mtk_pin_spec_pupd_set_samereg *spec_pupd;
243 unsigned int n_spec_pupd;
244 const struct mtk_pin_ies_smt_set *spec_smt;
245 unsigned int n_spec_smt;
246 int (*spec_pull_set)(struct regmap *regmap,
247 const struct mtk_pinctrl_devdata *devdata,
248 unsigned int pin, bool isup, unsigned int r1r0);
249 int (*spec_ies_smt_set)(struct regmap *reg,
250 const struct mtk_pinctrl_devdata *devdata,
251 unsigned int pin, int value, enum pin_config_param arg);
252 void (*spec_pinmux_set)(struct regmap *reg, unsigned int pin,
254 void (*spec_dir_set)(unsigned int *reg_addr, unsigned int pin);
255 unsigned int dir_offset;
256 unsigned int ies_offset;
257 unsigned int smt_offset;
258 unsigned int pullen_offset;
259 unsigned int pullsel_offset;
260 unsigned int drv_offset;
261 unsigned int dout_offset;
262 unsigned int din_offset;
263 unsigned int pinmux_offset;
264 unsigned short type1_start;
265 unsigned short type1_end;
266 unsigned char port_shf;
267 unsigned char port_mask;
268 unsigned char port_align;
269 struct mtk_eint_hw eint_hw;
270 struct mtk_eint_regs *eint_regs;
271 unsigned int mode_mask;
272 unsigned int mode_per_reg;
273 unsigned int mode_shf;
277 struct regmap *regmap1;
278 struct regmap *regmap2;
279 struct pinctrl_desc pctl_desc;
281 struct gpio_chip *chip;
282 struct mtk_pinctrl_group *groups;
284 const char **grp_names;
285 struct pinctrl_dev *pctl_dev;
286 const struct mtk_pinctrl_devdata *devdata;
287 struct mtk_eint *eint;
290 int mtk_pctrl_init(struct platform_device *pdev,
291 const struct mtk_pinctrl_devdata *data,
292 struct regmap *regmap);
294 int mtk_pctrl_common_probe(struct platform_device *pdev);
296 int mtk_pctrl_spec_pull_set_samereg(struct regmap *regmap,
297 const struct mtk_pinctrl_devdata *devdata,
298 unsigned int pin, bool isup, unsigned int r1r0);
300 int mtk_pconf_spec_set_ies_smt_range(struct regmap *regmap,
301 const struct mtk_pinctrl_devdata *devdata,
302 unsigned int pin, int value, enum pin_config_param arg);
304 extern const struct dev_pm_ops mtk_eint_pm_ops;
306 #endif /* __PINCTRL_MTK_COMMON_H */