gpio-mockup.c 9.74 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/*
 * GPIO Testing Device Driver
 *
 * Copyright (C) 2014  Kamlakant Patel <kamlakant.patel@broadcom.com>
 * Copyright (C) 2015-2016  Bamvor Jian Zhang <bamvor.zhangjian@linaro.org>
 *
 * 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>
17
#include <linux/gpio/consumer.h>
18
#include <linux/platform_device.h>
19
#include <linux/slab.h>
20
21
22
#include <linux/interrupt.h>
#include <linux/irq.h>
#include <linux/irq_work.h>
23
24
25
26
#include <linux/debugfs.h>
#include <linux/uaccess.h>

#include "gpiolib.h"
27

28
29
#define GPIO_MOCKUP_NAME	"gpio-mockup"
#define	GPIO_MOCKUP_MAX_GC	10
30

31
enum {
32
33
	GPIO_MOCKUP_DIR_OUT = 0,
	GPIO_MOCKUP_DIR_IN = 1,
34
35
36
37
38
39
40
};

/*
 * 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)
 */
41
42
struct gpio_mockup_line_status {
	int dir;
43
	bool value;
44
	bool irq_enabled;
45
46
};

47
48
49
50
51
struct gpio_mockup_irq_context {
	struct irq_work work;
	int irq;
};

52
struct gpio_mockup_chip {
53
	struct gpio_chip gc;
54
	struct gpio_mockup_line_status *lines;
55
	struct gpio_mockup_irq_context irq_ctx;
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
static int gpio_mockup_ranges[GPIO_MOCKUP_MAX_GC << 1];
66
67
68
static int gpio_mockup_params_nr;
module_param_array(gpio_mockup_ranges, int, &gpio_mockup_params_nr, 0400);

69
70
71
72
static bool gpio_mockup_named_lines;
module_param_named(gpio_mockup_named_lines,
		   gpio_mockup_named_lines, bool, 0400);

73
static const char gpio_mockup_name_start = 'A';
74
static struct dentry *gpio_mockup_dbg_dir;
75

76
static int gpio_mockup_get(struct gpio_chip *gc, unsigned int offset)
77
{
78
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);
79

80
	return chip->lines[offset].value;
81
82
}

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

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

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

	gpio_mockup_set(gc, offset, value);
97
	chip->lines[offset].dir = GPIO_MOCKUP_DIR_OUT;
98
99
100
101

	return 0;
}

102
static int gpio_mockup_dirin(struct gpio_chip *gc, unsigned int offset)
103
{
104
105
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

106
	chip->lines[offset].dir = GPIO_MOCKUP_DIR_IN;
107
108
109
110

	return 0;
}

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

115
	return chip->lines[offset].dir;
116
117
}

118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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_kzalloc(dev, sizeof(char *) * gc->ngpio, 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;
}

141
142
143
144
145
static int gpio_mockup_to_irq(struct gpio_chip *chip, unsigned int offset)
{
	return chip->irq_base + offset;
}

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
static void gpio_mockup_irqmask(struct irq_data *data)
{
	struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

	chip->lines[data->irq - gc->irq_base].irq_enabled = false;
}

static void gpio_mockup_irqunmask(struct irq_data *data)
{
	struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
	struct gpio_mockup_chip *chip = gpiochip_get_data(gc);

	chip->lines[data->irq - gc->irq_base].irq_enabled = true;
}
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

static struct irq_chip gpio_mockup_irqchip = {
	.name		= GPIO_MOCKUP_NAME,
	.irq_mask	= gpio_mockup_irqmask,
	.irq_unmask	= gpio_mockup_irqunmask,
};

static void gpio_mockup_handle_irq(struct irq_work *work)
{
	struct gpio_mockup_irq_context *irq_ctx;

	irq_ctx = container_of(work, struct gpio_mockup_irq_context, work);
	handle_simple_irq(irq_to_desc(irq_ctx->irq));
}

static int gpio_mockup_irqchip_setup(struct device *dev,
				     struct gpio_mockup_chip *chip)
{
	struct gpio_chip *gc = &chip->gc;
	int irq_base, i;

182
	irq_base = devm_irq_alloc_descs(dev, -1, 0, gc->ngpio, 0);
183
184
185
186
187
188
189
190
	if (irq_base < 0)
		return irq_base;

	gc->irq_base = irq_base;
	gc->irqchip = &gpio_mockup_irqchip;

	for (i = 0; i < gc->ngpio; i++) {
		irq_set_chip(irq_base + i, gc->irqchip);
191
		irq_set_chip_data(irq_base + i, gc);
192
193
194
195
196
197
198
199
200
201
		irq_set_handler(irq_base + i, &handle_simple_irq);
		irq_modify_status(irq_base + i,
				  IRQ_NOREQUEST | IRQ_NOAUTOEN, IRQ_NOPROBE);
	}

	init_irq_work(&chip->irq_ctx.work, gpio_mockup_handle_irq);

	return 0;
}

202
203
204
205
206
207
208
209
210
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;
	struct gpio_chip *gc;
211
	int rv, val;
212
213
214
215
216
217
218

	sfile = file->private_data;
	priv = sfile->private;
	desc = priv->desc;
	chip = priv->chip;
	gc = &chip->gc;

219
220
221
222
223
224
	rv = kstrtoint_from_user(usr_buf, size, 0, &val);
	if (rv)
		return rv;
	if (val != 0 && val != 1)
		return -EINVAL;

225
226
227
	if (!chip->lines[priv->offset].irq_enabled)
		return size;

228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
	gpiod_set_value_cansleep(desc, val);
	priv->chip->irq_ctx.irq = gc->irq_base + priv->offset;
	irq_work_queue(&priv->chip->irq_ctx.work);

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

287
288
static int gpio_mockup_add(struct device *dev,
			   struct gpio_mockup_chip *chip,
289
290
			   const char *name, int base, int ngpio)
{
291
	struct gpio_chip *gc = &chip->gc;
292
	int ret;
293

294
295
296
297
298
299
300
301
302
303
	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;
304
	gc->to_irq = gpio_mockup_to_irq;
305
306

	chip->lines = devm_kzalloc(dev, sizeof(*chip->lines) * gc->ngpio,
307
				   GFP_KERNEL);
308
309
	if (!chip->lines)
		return -ENOMEM;
310

311
312
313
314
315
316
	if (gpio_mockup_named_lines) {
		ret = gpio_mockup_name_lines(dev, chip);
		if (ret)
			return ret;
	}

317
318
319
320
	ret = gpio_mockup_irqchip_setup(dev, chip);
	if (ret)
		return ret;

321
322
323
324
325
326
327
328
	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;
329
330
}

331
static int gpio_mockup_probe(struct platform_device *pdev)
332
{
333
	struct gpio_mockup_chip *chips;
334
335
	struct device *dev = &pdev->dev;
	int ret, i, base, ngpio;
336
	char *chip_name;
337
338
339
340

	if (gpio_mockup_params_nr < 2)
		return -EINVAL;

341
342
343
344
	chips = devm_kzalloc(dev,
			     sizeof(*chips) * (gpio_mockup_params_nr >> 1),
			     GFP_KERNEL);
	if (!chips)
345
346
		return -ENOMEM;

347
	platform_set_drvdata(pdev, chips);
348
349
350

	for (i = 0; i < gpio_mockup_params_nr >> 1; i++) {
		base = gpio_mockup_ranges[i * 2];
351

352
353
354
355
356
357
		if (base == -1)
			ngpio = gpio_mockup_ranges[i * 2 + 1];
		else
			ngpio = gpio_mockup_ranges[i * 2 + 1] - base;

		if (ngpio >= 0) {
358
			chip_name = devm_kasprintf(dev, GFP_KERNEL,
359
360
						   "%s-%c", GPIO_MOCKUP_NAME,
						   gpio_mockup_name_start + i);
361
362
363
			if (!chip_name)
				return -ENOMEM;

364
			ret = gpio_mockup_add(dev, &chips[i],
365
366
367
368
					      chip_name, base, ngpio);
		} else {
			ret = -1;
		}
369

370
		if (ret) {
371
372
			dev_err(dev, "gpio<%d..%d> add failed\n",
				base, base < 0 ? ngpio : base + ngpio);
373
374
375
376
377
378
379
380

			return ret;
		}
	}

	return 0;
}

381
static struct platform_driver gpio_mockup_driver = {
382
	.driver = {
383
		.name = GPIO_MOCKUP_NAME,
384
	},
385
	.probe = gpio_mockup_probe,
386
387
388
389
390
391
392
};

static struct platform_device *pdev;
static int __init mock_device_init(void)
{
	int err;

393
394
395
396
397
	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);

398
	pdev = platform_device_alloc(GPIO_MOCKUP_NAME, -1);
399
400
401
402
403
404
405
406
407
	if (!pdev)
		return -ENOMEM;

	err = platform_device_add(pdev);
	if (err) {
		platform_device_put(pdev);
		return err;
	}

408
	err = platform_driver_register(&gpio_mockup_driver);
409
410
411
412
413
414
415
416
417
418
	if (err) {
		platform_device_unregister(pdev);
		return err;
	}

	return 0;
}

static void __exit mock_device_exit(void)
{
419
	debugfs_remove_recursive(gpio_mockup_dbg_dir);
420
	platform_driver_unregister(&gpio_mockup_driver);
421
422
423
424
425
426
427
428
429
430
	platform_device_unregister(pdev);
}

module_init(mock_device_init);
module_exit(mock_device_exit);

MODULE_AUTHOR("Kamlakant Patel <kamlakant.patel@broadcom.com>");
MODULE_AUTHOR("Bamvor Jian Zhang <bamvor.zhangjian@linaro.org>");
MODULE_DESCRIPTION("GPIO Testing driver");
MODULE_LICENSE("GPL v2");