opencores-kbd.c revision 5a0e3ad6af8660be21ca98a971cd00f331318c05
1422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero/*
2422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero * OpenCores Keyboard Controller Driver
3422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero * http://www.opencores.org/project,keyboardcontroller
4422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero *
5422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero * Copyright 2007-2009 HV Sistemas S.L.
6422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero *
7422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero * Licensed under the GPL-2 or later.
8422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero */
9422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
10422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero#include <linux/input.h>
11422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero#include <linux/interrupt.h>
12422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero#include <linux/io.h>
13422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero#include <linux/ioport.h>
14422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero#include <linux/kernel.h>
15422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero#include <linux/module.h>
16422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero#include <linux/platform_device.h>
175a0e3ad6af8660be21ca98a971cd00f331318c05Tejun Heo#include <linux/slab.h>
18422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
19422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrerostruct opencores_kbd {
20422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	struct input_dev *input;
21422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	struct resource *addr_res;
22422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	void __iomem *addr;
23422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	int irq;
24422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	unsigned short keycodes[128];
25422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero};
26422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
27422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrerostatic irqreturn_t opencores_kbd_isr(int irq, void *dev_id)
28422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero{
29422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	struct opencores_kbd *opencores_kbd = dev_id;
30422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	struct input_dev *input = opencores_kbd->input;
31422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	unsigned char c;
32422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
33422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	c = readb(opencores_kbd->addr);
34422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input_report_key(input, c & 0x7f, c & 0x80 ? 0 : 1);
35422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input_sync(input);
36422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
37422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	return IRQ_HANDLED;
38422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero}
39422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
40422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrerostatic int __devinit opencores_kbd_probe(struct platform_device *pdev)
41422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero{
42422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	struct input_dev *input;
43422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	struct opencores_kbd *opencores_kbd;
44422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	struct resource *res;
45422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	int irq, i, error;
46422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
47422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
48422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	if (!res) {
49422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		dev_err(&pdev->dev, "missing board memory resource\n");
50422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		return -EINVAL;
51422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	}
52422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
53422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	irq = platform_get_irq(pdev, 0);
54422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	if (irq < 0) {
55422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		dev_err(&pdev->dev, "missing board IRQ resource\n");
56422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		return -EINVAL;
57422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	}
58422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
59422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	opencores_kbd = kzalloc(sizeof(*opencores_kbd), GFP_KERNEL);
60422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input = input_allocate_device();
61422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	if (!opencores_kbd || !input) {
62422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		dev_err(&pdev->dev, "failed to allocate device structures\n");
63422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		error = -ENOMEM;
64422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		goto err_free_mem;
65422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	}
66422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
67422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	opencores_kbd->addr_res = res;
68422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	res = request_mem_region(res->start, resource_size(res), pdev->name);
69422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	if (!res) {
70422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		dev_err(&pdev->dev, "failed to request I/O memory\n");
71422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		error = -EBUSY;
72422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		goto err_free_mem;
73422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	}
74422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
75422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	opencores_kbd->addr = ioremap(res->start, resource_size(res));
76422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	if (!opencores_kbd->addr) {
77422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		dev_err(&pdev->dev, "failed to remap I/O memory\n");
78422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		error = -ENXIO;
79422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		goto err_rel_mem;
80422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	}
81422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
82422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	opencores_kbd->input = input;
83422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	opencores_kbd->irq = irq;
84422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
85422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->name = pdev->name;
86422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->phys = "opencores-kbd/input0";
87422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->dev.parent = &pdev->dev;
88422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
89422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input_set_drvdata(input, opencores_kbd);
90422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
91422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->id.bustype = BUS_HOST;
92422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->id.vendor = 0x0001;
93422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->id.product = 0x0001;
94422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->id.version = 0x0100;
95422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
96422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->keycode = opencores_kbd->keycodes;
97422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->keycodesize = sizeof(opencores_kbd->keycodes[0]);
98422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input->keycodemax = ARRAY_SIZE(opencores_kbd->keycodes);
99422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
100422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	__set_bit(EV_KEY, input->evbit);
101422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
102422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	for (i = 0; i < ARRAY_SIZE(opencores_kbd->keycodes); i++) {
103422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		/*
104422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		 * OpenCores controller happens to have scancodes match
105422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		 * our KEY_* definitions.
106422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		 */
107422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		opencores_kbd->keycodes[i] = i;
108422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		__set_bit(opencores_kbd->keycodes[i], input->keybit);
109422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	}
110422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	__clear_bit(KEY_RESERVED, input->keybit);
111422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
112422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	error = request_irq(irq, &opencores_kbd_isr,
113422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero			    IRQF_TRIGGER_RISING, pdev->name, opencores_kbd);
114422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	if (error) {
115422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		dev_err(&pdev->dev, "unable to claim irq %d\n", irq);
116422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		goto err_unmap_mem;
117422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	}
118422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
119422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	error = input_register_device(input);
120422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	if (error) {
121422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		dev_err(&pdev->dev, "unable to register input device\n");
122422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		goto err_free_irq;
123422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	}
124422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
125422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	platform_set_drvdata(pdev, opencores_kbd);
126422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
127422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	return 0;
128422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
129422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero err_free_irq:
130422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	free_irq(irq, opencores_kbd);
131422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero err_unmap_mem:
132422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	iounmap(opencores_kbd->addr);
133422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero err_rel_mem:
134422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	release_mem_region(res->start, resource_size(res));
135422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero err_free_mem:
136422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input_free_device(input);
137422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	kfree(opencores_kbd);
138422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
139422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	return error;
140422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero}
141422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
142422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrerostatic int __devexit opencores_kbd_remove(struct platform_device *pdev)
143422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero{
144422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	struct opencores_kbd *opencores_kbd = platform_get_drvdata(pdev);
145422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
146422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	free_irq(opencores_kbd->irq, opencores_kbd);
147422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
148422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	iounmap(opencores_kbd->addr);
149422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	release_mem_region(opencores_kbd->addr_res->start,
150422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		resource_size(opencores_kbd->addr_res));
151422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	input_unregister_device(opencores_kbd->input);
152422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	kfree(opencores_kbd);
153422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
154422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	platform_set_drvdata(pdev, NULL);
155422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
156422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	return 0;
157422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero}
158422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
159422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrerostatic struct platform_driver opencores_kbd_device_driver = {
160422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	.probe    = opencores_kbd_probe,
161422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	.remove   = __devexit_p(opencores_kbd_remove),
162422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	.driver   = {
163422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero		.name = "opencores-kbd",
164422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	},
165422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero};
166422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
167422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrerostatic int __init opencores_kbd_init(void)
168422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero{
169422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	return platform_driver_register(&opencores_kbd_device_driver);
170422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero}
171422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herreromodule_init(opencores_kbd_init);
172422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
173422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrerostatic void __exit opencores_kbd_exit(void)
174422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero{
175422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero	platform_driver_unregister(&opencores_kbd_device_driver);
176422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero}
177422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herreromodule_exit(opencores_kbd_exit);
178422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier Herrero
179422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier HerreroMODULE_LICENSE("GPL");
180422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier HerreroMODULE_AUTHOR("Javier Herrero <jherrero@hvsistemas.es>");
181422b552debae59b4bebc0ea5fbb9c809d3dfd057Javier HerreroMODULE_DESCRIPTION("Keyboard driver for OpenCores Keyboard Controller");
182