gpio-mockup.c 9.06 KB
Newer Older
1
2
3
4
5
/*
 * GPIO Testing Device Driver
 *
 * Copyright (C) 2014  Kamlakant Patel <kamlakant.patel@broadcom.com>
 * Copyright (C) 2015-2016  Bamvor Jian Zhang <bamvor.zhangjian@linaro.org>
6
 * Copyright (C) 2017 Bartosz Golaszewski <brgl@bgdev.pl>
7
8
9
10
11
12
13
14
15
16
17
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 *
 */

#include <linux/init.h>
#include <linux/module.h>
#include <linux/gpio/driver.h>
18
#include <linux/gpio/consumer.h>
19
#include <linux/platform_device.h>
20
#include <linux/slab.h>
21
22
#include <linux/interrupt.h>
#include <linux/irq.h>
23
#include <linux/irq_sim.h>
24
25
26
27
#include <linux/debugfs.h>
#include <linux/uaccess.h>

#include "gpiolib.h"
28

29
30
#define GPIO_MOCKUP_NAME	"gpio-mockup"
#define	GPIO_MOCKUP_MAX_GC	10
31
32
33
34
35
/*
 * We're storing two values per chip: the GPIO base and the number
 * of GPIO lines.
 */
#define GPIO_MOCKUP_MAX_RANGES	(GPIO_MOCKUP_MAX_GC * 2)
36

37
enum {
38
39
	GPIO_MOCKUP_DIR_OUT = 0,
	GPIO_MOCKUP_DIR_IN = 1,
40
41
42
43
44
45
46
};

/*
 * struct gpio_pin_status - structure describing a GPIO status
 * @dir:       Configures direction of gpio as "in" or "out", 0=in, 1=out
 * @value:     Configures status of the gpio as 0(low) or 1(high)
 */
47
48
struct gpio_mockup_line_status {
	int dir;
49
	bool value;
50
51
};

52
struct gpio_mockup_chip {
53
	struct gpio_chip gc;
54
	struct gpio_mockup_line_status *lines;
55
	struct irq_sim irqsim;
56
57
58
59
60
61
62
	struct dentry *dbg_dir;
};

struct gpio_mockup_dbgfs_private {
	struct gpio_mockup_chip *chip;
	struct gpio_desc *desc;
	int offset;
63
64
};

65
66
67
68
69
70
struct gpio_mockup_platform_data {
	int base;
	int ngpio;
	int index;
};

71
static int gpio_mockup_ranges[GPIO_MOCKUP_MAX_RANGES];
72
73
74
static int gpio_mockup_params_nr;
module_param_array(gpio_mockup_ranges, int, &gpio_mockup_params_nr, 0400);

75
76
77
78
static bool gpio_mockup_named_lines;
module_param_named(gpio_mockup_named_lines,
		   gpio_mockup_named_lines, bool, 0400);

79
static struct dentry *gpio_mockup_dbg_dir;
80

81
static int gpio_mockup_get(struct gpio_chip *gc, unsigned int offset)
82
{
83
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);
84

85
	return chip->lines[offset].value;
86
87
}

88
static void gpio_mockup_set(struct gpio_chip *gc, unsigned int offset,
89
90
			    int value)
{
91
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);
92

93
	chip->lines[offset].value = !!value;
94
95
}

96
static int gpio_mockup_dirout(struct gpio_chip *gc, unsigned int offset,
97
98
			      int value)
{
99
100
101
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

	gpio_mockup_set(gc, offset, value);
102
	chip->lines[offset].dir = GPIO_MOCKUP_DIR_OUT;
103
104
105
106

	return 0;
}

107
static int gpio_mockup_dirin(struct gpio_chip *gc, unsigned int offset)
108
{
109
110
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

111
	chip->lines[offset].dir = GPIO_MOCKUP_DIR_IN;
112
113
114
115

	return 0;
}

116
static int gpio_mockup_get_direction(struct gpio_chip *gc, unsigned int offset)
117
{
118
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);
119

120
	return chip->lines[offset].dir;
121
122
}

123
124
125
126
127
128
129
static int gpio_mockup_name_lines(struct device *dev,
				  struct gpio_mockup_chip *chip)
{
	struct gpio_chip *gc = &chip->gc;
	char **names;
	int i;

130
	names = devm_kcalloc(dev, gc->ngpio, sizeof(char *), GFP_KERNEL);
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
	if (!names)
		return -ENOMEM;

	for (i = 0; i < gc->ngpio; i++) {
		names[i] = devm_kasprintf(dev, GFP_KERNEL,
					  "%s-%d", gc->label, i);
		if (!names[i])
			return -ENOMEM;
	}

	gc->names = (const char *const *)names;

	return 0;
}

146
static int gpio_mockup_to_irq(struct gpio_chip *gc, unsigned int offset)
147
148
149
{
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

150
	return irq_sim_irqnum(&chip->irqsim, offset);
151
152
}

153
154
155
156
157
158
159
160
static ssize_t gpio_mockup_event_write(struct file *file,
				       const char __user *usr_buf,
				       size_t size, loff_t *ppos)
{
	struct gpio_mockup_dbgfs_private *priv;
	struct gpio_mockup_chip *chip;
	struct seq_file *sfile;
	struct gpio_desc *desc;
161
	int rv, val;
162

163
164
165
166
167
168
	rv = kstrtoint_from_user(usr_buf, size, 0, &val);
	if (rv)
		return rv;
	if (val != 0 && val != 1)
		return -EINVAL;

169
170
171
172
	sfile = file->private_data;
	priv = sfile->private;
	desc = priv->desc;
	chip = priv->chip;
173

174
175
	gpiod_set_value_cansleep(desc, val);
	irq_sim_fire(&chip->irqsim, priv->offset);
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231

	return size;
}

static int gpio_mockup_event_open(struct inode *inode, struct file *file)
{
	return single_open(file, NULL, inode->i_private);
}

static const struct file_operations gpio_mockup_event_ops = {
	.owner = THIS_MODULE,
	.open = gpio_mockup_event_open,
	.write = gpio_mockup_event_write,
	.llseek = no_llseek,
};

static void gpio_mockup_debugfs_setup(struct device *dev,
				      struct gpio_mockup_chip *chip)
{
	struct gpio_mockup_dbgfs_private *priv;
	struct dentry *evfile;
	struct gpio_chip *gc;
	char *name;
	int i;

	gc = &chip->gc;

	chip->dbg_dir = debugfs_create_dir(gc->label, gpio_mockup_dbg_dir);
	if (!chip->dbg_dir)
		goto err;

	for (i = 0; i < gc->ngpio; i++) {
		name = devm_kasprintf(dev, GFP_KERNEL, "%d", i);
		if (!name)
			goto err;

		priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
		if (!priv)
			goto err;

		priv->chip = chip;
		priv->offset = i;
		priv->desc = &gc->gpiodev->descs[i];

		evfile = debugfs_create_file(name, 0200, chip->dbg_dir, priv,
					     &gpio_mockup_event_ops);
		if (!evfile)
			goto err;
	}

	return;

err:
	dev_err(dev, "error creating debugfs directory\n");
}

232
233
static int gpio_mockup_add(struct device *dev,
			   struct gpio_mockup_chip *chip,
234
235
			   const char *name, int base, int ngpio)
{
236
	struct gpio_chip *gc = &chip->gc;
237
	int ret;
238

239
240
241
242
243
244
245
246
247
248
	gc->base = base;
	gc->ngpio = ngpio;
	gc->label = name;
	gc->owner = THIS_MODULE;
	gc->parent = dev;
	gc->get = gpio_mockup_get;
	gc->set = gpio_mockup_set;
	gc->direction_output = gpio_mockup_dirout;
	gc->direction_input = gpio_mockup_dirin;
	gc->get_direction = gpio_mockup_get_direction;
249
	gc->to_irq = gpio_mockup_to_irq;
250

251
252
	chip->lines = devm_kcalloc(dev, gc->ngpio,
				   sizeof(*chip->lines), GFP_KERNEL);
253
254
	if (!chip->lines)
		return -ENOMEM;
255

256
257
258
259
260
261
	if (gpio_mockup_named_lines) {
		ret = gpio_mockup_name_lines(dev, chip);
		if (ret)
			return ret;
	}

262
	ret = devm_irq_sim_init(dev, &chip->irqsim, gc->ngpio);
263
264
265
	if (ret)
		return ret;

266
267
268
269
270
271
272
273
	ret = devm_gpiochip_add_data(dev, &chip->gc, chip);
	if (ret)
		return ret;

	if (gpio_mockup_dbg_dir)
		gpio_mockup_debugfs_setup(dev, chip);

	return 0;
274
275
}

276
static int gpio_mockup_probe(struct platform_device *pdev)
277
{
278
279
280
281
282
	struct gpio_mockup_platform_data *pdata;
	struct gpio_mockup_chip *chip;
	int rv, base, ngpio;
	struct device *dev;
	char *name;
283

284
285
286
287
	dev = &pdev->dev;
	pdata = dev_get_platdata(dev);
	base = pdata->base;
	ngpio = pdata->ngpio;
288

289
290
	chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
	if (!chip)
291
292
		return -ENOMEM;

293
294
295
296
	name = devm_kasprintf(dev, GFP_KERNEL, "%s-%c",
			      pdev->name, pdata->index);
	if (!name)
		return -ENOMEM;
297

298
299
300
301
302
303
	rv = gpio_mockup_add(dev, chip, name, base, ngpio);
	if (rv) {
		dev_err(dev,
			"adding gpiochip failed (base: %d, ngpio: %d)\n",
			base, base < 0 ? ngpio : base + ngpio);
		return rv;
304
305
306
307
308
	}

	return 0;
}

309
static struct platform_driver gpio_mockup_driver = {
310
	.driver = {
311
		.name = GPIO_MOCKUP_NAME,
312
	},
313
	.probe = gpio_mockup_probe,
314
315
};

316
317
318
319
320
321
322
323
324
325
326
327
328
329
static struct platform_device *gpio_mockup_pdevs[GPIO_MOCKUP_MAX_GC];

static void gpio_mockup_unregister_pdevs(void)
{
	struct platform_device *pdev;
	int i;

	for (i = 0; i < GPIO_MOCKUP_MAX_GC; i++) {
		pdev = gpio_mockup_pdevs[i];

		if (pdev)
			platform_device_unregister(pdev);
	}
}
330
331

static int __init gpio_mockup_init(void)
332
{
333
334
335
	int i, num_chips, err = 0, index = 'A';
	struct gpio_mockup_platform_data pdata;
	struct platform_device *pdev;
336

337
338
339
	if ((gpio_mockup_params_nr < 2) ||
	    (gpio_mockup_params_nr % 2) ||
	    (gpio_mockup_params_nr > GPIO_MOCKUP_MAX_RANGES))
340
341
		return -EINVAL;

342
343
344
	/* Each chip is described by two values. */
	num_chips = gpio_mockup_params_nr / 2;

345
346
347
348
349
	gpio_mockup_dbg_dir = debugfs_create_dir("gpio-mockup-event", NULL);
	if (!gpio_mockup_dbg_dir)
		pr_err("%s: error creating debugfs directory\n",
		       GPIO_MOCKUP_NAME);

350
	err = platform_driver_register(&gpio_mockup_driver);
351
	if (err) {
352
353
		pr_err("%s: error registering platform driver\n",
		       GPIO_MOCKUP_NAME);
354
355
356
		return err;
	}

357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
	for (i = 0; i < num_chips; i++) {
		pdata.index = index++;
		pdata.base = gpio_mockup_ranges[i * 2];
		pdata.ngpio = pdata.base < 0
				? gpio_mockup_ranges[i * 2 + 1]
				: gpio_mockup_ranges[i * 2 + 1] - pdata.base;

		pdev = platform_device_register_resndata(NULL,
							 GPIO_MOCKUP_NAME,
							 i, NULL, 0, &pdata,
							 sizeof(pdata));
		if (!pdev) {
			pr_err("%s: error registering device",
			       GPIO_MOCKUP_NAME);
			platform_driver_unregister(&gpio_mockup_driver);
			gpio_mockup_unregister_pdevs();
			return -ENOMEM;
		}

		gpio_mockup_pdevs[i] = pdev;
377
378
379
380
381
	}

	return 0;
}

382
static void __exit gpio_mockup_exit(void)
383
{
384
	debugfs_remove_recursive(gpio_mockup_dbg_dir);
385
	platform_driver_unregister(&gpio_mockup_driver);
386
	gpio_mockup_unregister_pdevs();
387
388
}

389
390
module_init(gpio_mockup_init);
module_exit(gpio_mockup_exit);
391
392
393

MODULE_AUTHOR("Kamlakant Patel <kamlakant.patel@broadcom.com>");
MODULE_AUTHOR("Bamvor Jian Zhang <bamvor.zhangjian@linaro.org>");
394
MODULE_AUTHOR("Bartosz Golaszewski <brgl@bgdev.pl>");
395
396
MODULE_DESCRIPTION("GPIO Testing driver");
MODULE_LICENSE("GPL v2");