gpio-mockup.c 8.78 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
	bool 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
static void gpio_mockup_set(struct gpio_chip *gc, unsigned int offset,
92
93
			    int value)
{
94
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);
95

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

99
static int gpio_mockup_dirout(struct gpio_chip *gc, unsigned int offset,
100
101
			      int value)
{
102
103
104
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

	gpio_mockup_set(gc, offset, value);
105
	chip->lines[offset].dir = GPIO_MOCKUP_DIR_OUT;
106
107
108
109

	return 0;
}

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

114
	chip->lines[offset].dir = GPIO_MOCKUP_DIR_IN;
115
116
117
118

	return 0;
}

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

123
	return chip->lines[offset].dir;
124
125
}

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

133
	names = devm_kcalloc(dev, gc->ngpio, sizeof(char *), GFP_KERNEL);
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
	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;
}

149
static int gpio_mockup_to_irq(struct gpio_chip *gc, unsigned int offset)
150
151
152
{
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

153
	return irq_sim_irqnum(&chip->irqsim, offset);
154
155
}

156
157
158
159
160
161
162
163
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;
164
	int rv, val;
165

166
167
168
169
170
171
	rv = kstrtoint_from_user(usr_buf, size, 0, &val);
	if (rv)
		return rv;
	if (val != 0 && val != 1)
		return -EINVAL;

172
173
174
175
	sfile = file->private_data;
	priv = sfile->private;
	desc = priv->desc;
	chip = priv->chip;
176

177
178
	gpiod_set_value_cansleep(desc, val);
	irq_sim_fire(&chip->irqsim, priv->offset);
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
232
233
234

	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");
}

235
static int gpio_mockup_probe(struct platform_device *pdev)
236
{
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
	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;
257

258
	gc = &chip->gc;
259
260
261
262
263
264
265
266
267
268
	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;
269
	gc->to_irq = gpio_mockup_to_irq;
270

271
272
	chip->lines = devm_kcalloc(dev, gc->ngpio,
				   sizeof(*chip->lines), GFP_KERNEL);
273
274
	if (!chip->lines)
		return -ENOMEM;
275

276
	if (pdata->named_lines) {
277
278
279
		rv = gpio_mockup_name_lines(dev, chip);
		if (rv)
			return rv;
280
281
	}

282
283
284
	rv = devm_irq_sim_init(dev, &chip->irqsim, gc->ngpio);
	if (rv)
		return rv;
285

286
287
288
	rv = devm_gpiochip_add_data(dev, &chip->gc, chip);
	if (rv)
		return rv;
289
290
291
292
293

	if (gpio_mockup_dbg_dir)
		gpio_mockup_debugfs_setup(dev, chip);

	return 0;
294
295
}

296
static struct platform_driver gpio_mockup_driver = {
297
	.driver = {
298
		.name = GPIO_MOCKUP_NAME,
299
	},
300
	.probe = gpio_mockup_probe,
301
302
};

303
304
305
306
307
308
309
310
311
312
313
314
315
316
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);
	}
}
317
318

static int __init gpio_mockup_init(void)
319
{
320
321
322
	int i, num_chips, err = 0, index = 'A';
	struct gpio_mockup_platform_data pdata;
	struct platform_device *pdev;
323

324
325
326
	if ((gpio_mockup_params_nr < 2) ||
	    (gpio_mockup_params_nr % 2) ||
	    (gpio_mockup_params_nr > GPIO_MOCKUP_MAX_RANGES))
327
328
		return -EINVAL;

329
330
331
	/* Each chip is described by two values. */
	num_chips = gpio_mockup_params_nr / 2;

332
333
	gpio_mockup_dbg_dir = debugfs_create_dir("gpio-mockup-event", NULL);
	if (!gpio_mockup_dbg_dir)
334
		gpio_mockup_err("error creating debugfs directory\n");
335

336
	err = platform_driver_register(&gpio_mockup_driver);
337
	if (err) {
338
		gpio_mockup_err("error registering platform driver\n");
339
340
341
		return err;
	}

342
343
344
345
346
347
	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;
348
		pdata.named_lines = gpio_mockup_named_lines;
349
350
351
352
353
354

		pdev = platform_device_register_resndata(NULL,
							 GPIO_MOCKUP_NAME,
							 i, NULL, 0, &pdata,
							 sizeof(pdata));
		if (!pdev) {
355
			gpio_mockup_err("error registering device");
356
357
358
359
360
361
			platform_driver_unregister(&gpio_mockup_driver);
			gpio_mockup_unregister_pdevs();
			return -ENOMEM;
		}

		gpio_mockup_pdevs[i] = pdev;
362
363
364
365
366
	}

	return 0;
}

367
static void __exit gpio_mockup_exit(void)
368
{
369
	debugfs_remove_recursive(gpio_mockup_dbg_dir);
370
	platform_driver_unregister(&gpio_mockup_driver);
371
	gpio_mockup_unregister_pdevs();
372
373
}

374
375
module_init(gpio_mockup_init);
module_exit(gpio_mockup_exit);
376
377
378

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