gpio-mockup.c 9.47 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
#define GPIO_MOCKUP_NAME	"gpio-mockup"
30
#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
38
#define gpio_mockup_err(...)	pr_err(GPIO_MOCKUP_NAME ": " __VA_ARGS__)

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

/*
 * 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)
 */
49
50
struct gpio_mockup_line_status {
	int dir;
51
	int value;
52
53
};

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

struct gpio_mockup_dbgfs_private {
	struct gpio_mockup_chip *chip;
	struct gpio_desc *desc;
	int offset;
65
66
};

67
68
69
70
struct gpio_mockup_platform_data {
	int base;
	int ngpio;
	int index;
71
	bool named_lines;
72
73
};

74
static int gpio_mockup_ranges[GPIO_MOCKUP_MAX_RANGES];
75
76
77
static int gpio_mockup_params_nr;
module_param_array(gpio_mockup_ranges, int, &gpio_mockup_params_nr, 0400);

78
79
80
81
static bool gpio_mockup_named_lines;
module_param_named(gpio_mockup_named_lines,
		   gpio_mockup_named_lines, bool, 0400);

82
static struct dentry *gpio_mockup_dbg_dir;
83

84
static int gpio_mockup_get(struct gpio_chip *gc, unsigned int offset)
85
{
86
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);
87

88
	return chip->lines[offset].value;
89
90
}

91
92
static void gpio_mockup_set(struct gpio_chip *gc,
			    unsigned int offset, int value)
93
{
94
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);
95

96
	chip->lines[offset].value = !!value;
97
98
}

99
100
101
102
103
104
105
106
107
108
static void gpio_mockup_set_multiple(struct gpio_chip *gc,
				     unsigned long *mask, unsigned long *bits)
{
	unsigned int bit;

	for_each_set_bit(bit, mask, gc->ngpio)
		gpio_mockup_set(gc, bit, test_bit(bit, bits));

}

109
110
static int gpio_mockup_dirout(struct gpio_chip *gc,
			      unsigned int offset, int value)
111
{
112
113
114
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

	gpio_mockup_set(gc, offset, value);
115
	chip->lines[offset].dir = GPIO_MOCKUP_DIR_OUT;
116
117
118
119

	return 0;
}

120
static int gpio_mockup_dirin(struct gpio_chip *gc, unsigned int offset)
121
{
122
123
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

124
	chip->lines[offset].dir = GPIO_MOCKUP_DIR_IN;
125
126
127
128

	return 0;
}

129
static int gpio_mockup_get_direction(struct gpio_chip *gc, unsigned int offset)
130
{
131
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);
132

133
	return chip->lines[offset].dir;
134
135
}

136
static int gpio_mockup_to_irq(struct gpio_chip *gc, unsigned int offset)
137
138
139
{
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

140
	return irq_sim_irqnum(&chip->irqsim, offset);
141
142
}

143
144
145
146
147
148
149
150
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;
151
	int rv, val;
152

153
154
155
156
157
158
	rv = kstrtoint_from_user(usr_buf, size, 0, &val);
	if (rv)
		return rv;
	if (val != 0 && val != 1)
		return -EINVAL;

159
160
161
162
	sfile = file->private_data;
	priv = sfile->private;
	desc = priv->desc;
	chip = priv->chip;
163

164
165
	gpiod_set_value_cansleep(desc, val);
	irq_sim_fire(&chip->irqsim, priv->offset);
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

	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;
186
	struct dentry *evfile, *link;
187
	struct gpio_chip *gc;
188
	const char *devname;
189
190
191
192
	char *name;
	int i;

	gc = &chip->gc;
193
	devname = dev_name(&gc->gpiodev->dev);
194

195
	chip->dbg_dir = debugfs_create_dir(devname, gpio_mockup_dbg_dir);
196
	if (IS_ERR_OR_NULL(chip->dbg_dir))
197
198
		goto err;

199
	link = debugfs_create_symlink(gc->label, gpio_mockup_dbg_dir, devname);
200
	if (IS_ERR_OR_NULL(link))
201
202
		goto err;

203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
	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);
218
		if (IS_ERR_OR_NULL(evfile))
219
220
221
222
223
224
			goto err;
	}

	return;

err:
225
	dev_err(dev, "error creating debugfs event files\n");
226
227
}

228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
static int gpio_mockup_name_lines(struct device *dev,
				  struct gpio_mockup_chip *chip)
{
	struct gpio_chip *gc = &chip->gc;
	char **names;
	int i;

	names = devm_kcalloc(dev, gc->ngpio, sizeof(char *), GFP_KERNEL);
	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;
}

251
static int gpio_mockup_probe(struct platform_device *pdev)
252
{
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
	struct gpio_mockup_platform_data *pdata;
	struct gpio_mockup_chip *chip;
	struct gpio_chip *gc;
	int rv, base, ngpio;
	struct device *dev;
	char *name;

	dev = &pdev->dev;
	pdata = dev_get_platdata(dev);
	base = pdata->base;
	ngpio = pdata->ngpio;

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

	name = devm_kasprintf(dev, GFP_KERNEL, "%s-%c",
			      pdev->name, pdata->index);
	if (!name)
		return -ENOMEM;
273

274
	gc = &chip->gc;
275
276
277
278
279
280
281
	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;
282
	gc->set_multiple = gpio_mockup_set_multiple;
283
284
285
	gc->direction_output = gpio_mockup_dirout;
	gc->direction_input = gpio_mockup_dirin;
	gc->get_direction = gpio_mockup_get_direction;
286
	gc->to_irq = gpio_mockup_to_irq;
287

288
289
	chip->lines = devm_kcalloc(dev, gc->ngpio,
				   sizeof(*chip->lines), GFP_KERNEL);
290
291
	if (!chip->lines)
		return -ENOMEM;
292

293
	if (pdata->named_lines) {
294
295
296
		rv = gpio_mockup_name_lines(dev, chip);
		if (rv)
			return rv;
297
298
	}

299
	rv = devm_irq_sim_init(dev, &chip->irqsim, gc->ngpio);
300
	if (rv < 0)
301
		return rv;
302

303
304
305
	rv = devm_gpiochip_add_data(dev, &chip->gc, chip);
	if (rv)
		return rv;
306
307
308
309
310

	if (gpio_mockup_dbg_dir)
		gpio_mockup_debugfs_setup(dev, chip);

	return 0;
311
312
}

313
static struct platform_driver gpio_mockup_driver = {
314
	.driver = {
315
		.name = GPIO_MOCKUP_NAME,
316
	},
317
	.probe = gpio_mockup_probe,
318
319
};

320
321
322
323
324
325
326
327
328
329
330
331
332
333
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);
	}
}
334
335

static int __init gpio_mockup_init(void)
336
{
337
338
339
	int i, num_chips, err = 0, index = 'A';
	struct gpio_mockup_platform_data pdata;
	struct platform_device *pdev;
340

341
342
343
	if ((gpio_mockup_params_nr < 2) ||
	    (gpio_mockup_params_nr % 2) ||
	    (gpio_mockup_params_nr > GPIO_MOCKUP_MAX_RANGES))
344
345
		return -EINVAL;

346
347
348
	/* Each chip is described by two values. */
	num_chips = gpio_mockup_params_nr / 2;

349
350
351
352
353
354
355
356
357
	/*
	 * The second value in the <base GPIO - number of GPIOS> pair must
	 * always be greater than 0.
	 */
	for (i = 0; i < num_chips; i++) {
		if (gpio_mockup_ranges[i * 2 + 1] < 0)
			return -EINVAL;
	}

358
	gpio_mockup_dbg_dir = debugfs_create_dir("gpio-mockup-event", NULL);
359
	if (IS_ERR_OR_NULL(gpio_mockup_dbg_dir))
360
		gpio_mockup_err("error creating debugfs directory\n");
361

362
	err = platform_driver_register(&gpio_mockup_driver);
363
	if (err) {
364
		gpio_mockup_err("error registering platform driver\n");
365
366
367
		return err;
	}

368
369
370
371
372
373
	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;
374
		pdata.named_lines = gpio_mockup_named_lines;
375
376
377
378
379
380

		pdev = platform_device_register_resndata(NULL,
							 GPIO_MOCKUP_NAME,
							 i, NULL, 0, &pdata,
							 sizeof(pdata));
		if (!pdev) {
381
			gpio_mockup_err("error registering device");
382
383
384
385
386
387
			platform_driver_unregister(&gpio_mockup_driver);
			gpio_mockup_unregister_pdevs();
			return -ENOMEM;
		}

		gpio_mockup_pdevs[i] = pdev;
388
389
390
391
392
	}

	return 0;
}

393
static void __exit gpio_mockup_exit(void)
394
{
395
	debugfs_remove_recursive(gpio_mockup_dbg_dir);
396
	platform_driver_unregister(&gpio_mockup_driver);
397
	gpio_mockup_unregister_pdevs();
398
399
}

400
401
module_init(gpio_mockup_init);
module_exit(gpio_mockup_exit);
402
403
404

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