xref: /linux/drivers/gpio/gpio-wm8994.c (revision b4ada0618eed0fbd1b1630f73deb048c592b06a1)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * gpiolib support for Wolfson WM8994
4  *
5  * Copyright 2009 Wolfson Microelectronics PLC.
6  *
7  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8  *
9  */
10 
11 #include <linux/cleanup.h>
12 #include <linux/kernel.h>
13 #include <linux/slab.h>
14 #include <linux/module.h>
15 #include <linux/gpio/driver.h>
16 #include <linux/mfd/core.h>
17 #include <linux/platform_device.h>
18 #include <linux/seq_file.h>
19 #include <linux/regmap.h>
20 
21 #include <linux/mfd/wm8994/core.h>
22 #include <linux/mfd/wm8994/pdata.h>
23 #include <linux/mfd/wm8994/gpio.h>
24 #include <linux/mfd/wm8994/registers.h>
25 
26 struct wm8994_gpio {
27 	struct wm8994 *wm8994;
28 	struct gpio_chip gpio_chip;
29 };
30 
31 static int wm8994_gpio_request(struct gpio_chip *chip, unsigned offset)
32 {
33 	struct wm8994_gpio *wm8994_gpio = gpiochip_get_data(chip);
34 	struct wm8994 *wm8994 = wm8994_gpio->wm8994;
35 
36 	switch (wm8994->type) {
37 	case WM8958:
38 		switch (offset) {
39 		case 1:
40 		case 2:
41 		case 3:
42 		case 4:
43 		case 6:
44 			return -EINVAL;
45 		}
46 		break;
47 	default:
48 		break;
49 	}
50 
51 	return 0;
52 }
53 
54 static int wm8994_gpio_direction_in(struct gpio_chip *chip, unsigned offset)
55 {
56 	struct wm8994_gpio *wm8994_gpio = gpiochip_get_data(chip);
57 	struct wm8994 *wm8994 = wm8994_gpio->wm8994;
58 
59 	return wm8994_set_bits(wm8994, WM8994_GPIO_1 + offset,
60 			       WM8994_GPN_DIR, WM8994_GPN_DIR);
61 }
62 
63 static int wm8994_gpio_get(struct gpio_chip *chip, unsigned offset)
64 {
65 	struct wm8994_gpio *wm8994_gpio = gpiochip_get_data(chip);
66 	struct wm8994 *wm8994 = wm8994_gpio->wm8994;
67 	int ret;
68 
69 	ret = wm8994_reg_read(wm8994, WM8994_GPIO_1 + offset);
70 	if (ret < 0)
71 		return ret;
72 
73 	if (ret & WM8994_GPN_LVL)
74 		return 1;
75 	else
76 		return 0;
77 }
78 
79 static int wm8994_gpio_direction_out(struct gpio_chip *chip,
80 				     unsigned offset, int value)
81 {
82 	struct wm8994_gpio *wm8994_gpio = gpiochip_get_data(chip);
83 	struct wm8994 *wm8994 = wm8994_gpio->wm8994;
84 
85 	if (value)
86 		value = WM8994_GPN_LVL;
87 
88 	return wm8994_set_bits(wm8994, WM8994_GPIO_1 + offset,
89 			       WM8994_GPN_DIR | WM8994_GPN_LVL, value);
90 }
91 
92 static int wm8994_gpio_set(struct gpio_chip *chip, unsigned int offset,
93 			   int value)
94 {
95 	struct wm8994_gpio *wm8994_gpio = gpiochip_get_data(chip);
96 	struct wm8994 *wm8994 = wm8994_gpio->wm8994;
97 
98 	if (value)
99 		value = WM8994_GPN_LVL;
100 
101 	return wm8994_set_bits(wm8994, WM8994_GPIO_1 + offset, WM8994_GPN_LVL,
102 			       value);
103 }
104 
105 static int wm8994_gpio_set_config(struct gpio_chip *chip, unsigned int offset,
106 				  unsigned long config)
107 {
108 	struct wm8994_gpio *wm8994_gpio = gpiochip_get_data(chip);
109 	struct wm8994 *wm8994 = wm8994_gpio->wm8994;
110 
111 	switch (pinconf_to_config_param(config)) {
112 	case PIN_CONFIG_DRIVE_OPEN_DRAIN:
113 		return wm8994_set_bits(wm8994, WM8994_GPIO_1 + offset,
114 				       WM8994_GPN_OP_CFG_MASK,
115 				       WM8994_GPN_OP_CFG);
116 	case PIN_CONFIG_DRIVE_PUSH_PULL:
117 		return wm8994_set_bits(wm8994, WM8994_GPIO_1 + offset,
118 				       WM8994_GPN_OP_CFG_MASK, 0);
119 	default:
120 		break;
121 	}
122 
123 	return -ENOTSUPP;
124 }
125 
126 static int wm8994_gpio_to_irq(struct gpio_chip *chip, unsigned offset)
127 {
128 	struct wm8994_gpio *wm8994_gpio = gpiochip_get_data(chip);
129 	struct wm8994 *wm8994 = wm8994_gpio->wm8994;
130 
131 	return regmap_irq_get_virq(wm8994->irq_data, offset);
132 }
133 
134 
135 #ifdef CONFIG_DEBUG_FS
136 static const char *wm8994_gpio_fn(u16 fn)
137 {
138 	switch (fn) {
139 	case WM8994_GP_FN_PIN_SPECIFIC:
140 		return "pin-specific";
141 	case WM8994_GP_FN_GPIO:
142 		return "GPIO";
143 	case WM8994_GP_FN_SDOUT:
144 		return "SDOUT";
145 	case WM8994_GP_FN_IRQ:
146 		return "IRQ";
147 	case WM8994_GP_FN_TEMPERATURE:
148 		return "Temperature";
149 	case WM8994_GP_FN_MICBIAS1_DET:
150 		return "MICBIAS1 detect";
151 	case WM8994_GP_FN_MICBIAS1_SHORT:
152 		return "MICBIAS1 short";
153 	case WM8994_GP_FN_MICBIAS2_DET:
154 		return "MICBIAS2 detect";
155 	case WM8994_GP_FN_MICBIAS2_SHORT:
156 		return "MICBIAS2 short";
157 	case WM8994_GP_FN_FLL1_LOCK:
158 		return "FLL1 lock";
159 	case WM8994_GP_FN_FLL2_LOCK:
160 		return "FLL2 lock";
161 	case WM8994_GP_FN_SRC1_LOCK:
162 		return "SRC1 lock";
163 	case WM8994_GP_FN_SRC2_LOCK:
164 		return "SRC2 lock";
165 	case WM8994_GP_FN_DRC1_ACT:
166 		return "DRC1 activity";
167 	case WM8994_GP_FN_DRC2_ACT:
168 		return "DRC2 activity";
169 	case WM8994_GP_FN_DRC3_ACT:
170 		return "DRC3 activity";
171 	case WM8994_GP_FN_WSEQ_STATUS:
172 		return "Write sequencer";
173 	case WM8994_GP_FN_FIFO_ERROR:
174 		return "FIFO error";
175 	case WM8994_GP_FN_OPCLK:
176 		return "OPCLK";
177 	case WM8994_GP_FN_THW:
178 		return "Thermal warning";
179 	case WM8994_GP_FN_DCS_DONE:
180 		return "DC servo";
181 	case WM8994_GP_FN_FLL1_OUT:
182 		return "FLL1 output";
183 	case WM8994_GP_FN_FLL2_OUT:
184 		return "FLL1 output";
185 	default:
186 		return "Unknown";
187 	}
188 }
189 
190 static void wm8994_gpio_dbg_show(struct seq_file *s, struct gpio_chip *chip)
191 {
192 	struct wm8994_gpio *wm8994_gpio = gpiochip_get_data(chip);
193 	struct wm8994 *wm8994 = wm8994_gpio->wm8994;
194 	int i;
195 
196 	for (i = 0; i < chip->ngpio; i++) {
197 		int gpio = i + chip->base;
198 		int reg;
199 
200 		/* We report the GPIO even if it's not requested since
201 		 * we're also reporting things like alternate
202 		 * functions which apply even when the GPIO is not in
203 		 * use as a GPIO.
204 		 */
205 		char *label __free(kfree) = gpiochip_dup_line_label(chip, i);
206 		if (IS_ERR(label)) {
207 			dev_err(wm8994->dev, "Failed to duplicate label\n");
208 			continue;
209 		}
210 
211 		seq_printf(s, " gpio-%-3d (%-20.20s) ", gpio,
212 			   label ?: "Unrequested");
213 
214 		reg = wm8994_reg_read(wm8994, WM8994_GPIO_1 + i);
215 		if (reg < 0) {
216 			dev_err(wm8994->dev,
217 				"GPIO control %d read failed: %d\n",
218 				gpio, reg);
219 			seq_printf(s, "\n");
220 			continue;
221 		}
222 
223 		if (reg & WM8994_GPN_DIR)
224 			seq_printf(s, "in ");
225 		else
226 			seq_printf(s, "out ");
227 
228 		if (reg & WM8994_GPN_PU)
229 			seq_printf(s, "pull up ");
230 
231 		if (reg & WM8994_GPN_PD)
232 			seq_printf(s, "pull down ");
233 
234 		if (reg & WM8994_GPN_POL)
235 			seq_printf(s, "inverted ");
236 		else
237 			seq_printf(s, "noninverted ");
238 
239 		if (reg & WM8994_GPN_OP_CFG)
240 			seq_printf(s, "open drain ");
241 		else
242 			seq_printf(s, "push-pull ");
243 
244 		seq_printf(s, "%s (%x)\n",
245 			   wm8994_gpio_fn(reg & WM8994_GPN_FN_MASK), reg);
246 	}
247 }
248 #else
249 #define wm8994_gpio_dbg_show NULL
250 #endif
251 
252 static const struct gpio_chip template_chip = {
253 	.label			= "wm8994",
254 	.owner			= THIS_MODULE,
255 	.request		= wm8994_gpio_request,
256 	.direction_input	= wm8994_gpio_direction_in,
257 	.get			= wm8994_gpio_get,
258 	.direction_output	= wm8994_gpio_direction_out,
259 	.set			= wm8994_gpio_set,
260 	.set_config		= wm8994_gpio_set_config,
261 	.to_irq			= wm8994_gpio_to_irq,
262 	.dbg_show		= wm8994_gpio_dbg_show,
263 	.can_sleep		= true,
264 };
265 
266 static int wm8994_gpio_probe(struct platform_device *pdev)
267 {
268 	struct wm8994 *wm8994 = dev_get_drvdata(pdev->dev.parent);
269 	struct wm8994_pdata *pdata = dev_get_platdata(wm8994->dev);
270 	struct wm8994_gpio *wm8994_gpio;
271 
272 	wm8994_gpio = devm_kzalloc(&pdev->dev, sizeof(*wm8994_gpio),
273 				   GFP_KERNEL);
274 	if (wm8994_gpio == NULL)
275 		return -ENOMEM;
276 
277 	wm8994_gpio->wm8994 = wm8994;
278 	wm8994_gpio->gpio_chip = template_chip;
279 	wm8994_gpio->gpio_chip.ngpio = WM8994_GPIO_MAX;
280 	wm8994_gpio->gpio_chip.parent = &pdev->dev;
281 	if (pdata && pdata->gpio_base)
282 		wm8994_gpio->gpio_chip.base = pdata->gpio_base;
283 	else
284 		wm8994_gpio->gpio_chip.base = -1;
285 
286 	return devm_gpiochip_add_data(&pdev->dev, &wm8994_gpio->gpio_chip, wm8994_gpio);
287 }
288 
289 static struct platform_driver wm8994_gpio_driver = {
290 	.driver.name	= "wm8994-gpio",
291 	.probe		= wm8994_gpio_probe,
292 };
293 
294 static int __init wm8994_gpio_init(void)
295 {
296 	return platform_driver_register(&wm8994_gpio_driver);
297 }
298 subsys_initcall(wm8994_gpio_init);
299 
300 static void __exit wm8994_gpio_exit(void)
301 {
302 	platform_driver_unregister(&wm8994_gpio_driver);
303 }
304 module_exit(wm8994_gpio_exit);
305 
306 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
307 MODULE_DESCRIPTION("GPIO interface for WM8994");
308 MODULE_LICENSE("GPL");
309 MODULE_ALIAS("platform:wm8994-gpio");
310