tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/******************************************************************************
2 * mtouchusb.c -- Driver for Microtouch (Now 3M) USB Touchscreens
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation; either version 2 of the
7 * License, or (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 *
18 * Based upon original work by Radoslaw Garbacz (usb-support@ite.pl)
19 * (http://freshmeat.net/projects/3mtouchscreendriver)
20 *
21 * History
22 *
23 * 0.3 & 0.4 2002 (TEJ) tejohnson@yahoo.com
24 * Updated to 2.4.18, then 2.4.19
25 * Old version still relied on stealing a minor
26 *
27 * 0.5 02/26/2004 (TEJ) tejohnson@yahoo.com
28 * Complete rewrite using Linux Input in 2.6.3
29 * Unfortunately no calibration support at this time
30 *
31 * 1.4 04/25/2004 (TEJ) tejohnson@yahoo.com
32 * Changed reset from standard USB dev reset to vendor reset
33 * Changed data sent to host from compensated to raw coordinates
34 * Eliminated vendor/product module params
35 * Performed multiple successful tests with an EXII-5010UC
36 *
37 * 1.5 02/27/2005 ddstreet@ieee.org
38 * Added module parameter to select raw or hw-calibrated coordinate reporting
39 *
40 *****************************************************************************/
41
42#include <linux/config.h>
43
44#ifdef CONFIG_USB_DEBUG
45 #define DEBUG
46#else
47 #undef DEBUG
48#endif
49
50#include <linux/kernel.h>
51#include <linux/slab.h>
52#include <linux/input.h>
53#include <linux/module.h>
54#include <linux/init.h>
55#include <linux/usb.h>
56
57#define MTOUCHUSB_MIN_XC 0x0
58#define MTOUCHUSB_MAX_RAW_XC 0x4000
59#define MTOUCHUSB_MAX_CALIB_XC 0xffff
60#define MTOUCHUSB_XC_FUZZ 0x0
61#define MTOUCHUSB_XC_FLAT 0x0
62#define MTOUCHUSB_MIN_YC 0x0
63#define MTOUCHUSB_MAX_RAW_YC 0x4000
64#define MTOUCHUSB_MAX_CALIB_YC 0xffff
65#define MTOUCHUSB_YC_FUZZ 0x0
66#define MTOUCHUSB_YC_FLAT 0x0
67
68#define MTOUCHUSB_ASYNC_REPORT 1
69#define MTOUCHUSB_RESET 7
70#define MTOUCHUSB_REPORT_DATA_SIZE 11
71#define MTOUCHUSB_REQ_CTRLLR_ID 10
72
73#define MTOUCHUSB_GET_RAW_XC(data) (data[8]<<8 | data[7])
74#define MTOUCHUSB_GET_CALIB_XC(data) (data[4]<<8 | data[3])
75#define MTOUCHUSB_GET_RAW_YC(data) (data[10]<<8 | data[9])
76#define MTOUCHUSB_GET_CALIB_YC(data) (data[6]<<8 | data[5])
77#define MTOUCHUSB_GET_XC(data) (raw_coordinates ? \
78 MTOUCHUSB_GET_RAW_XC(data) : \
79 MTOUCHUSB_GET_CALIB_XC(data))
80#define MTOUCHUSB_GET_YC(data) (raw_coordinates ? \
81 MTOUCHUSB_GET_RAW_YC(data) : \
82 MTOUCHUSB_GET_CALIB_YC(data))
83#define MTOUCHUSB_GET_TOUCHED(data) ((data[2] & 0x40) ? 1:0)
84
85#define DRIVER_VERSION "v1.5"
86#define DRIVER_AUTHOR "Todd E. Johnson, tejohnson@yahoo.com"
87#define DRIVER_DESC "3M USB Touchscreen Driver"
88#define DRIVER_LICENSE "GPL"
89
90static int raw_coordinates = 1;
91
92module_param(raw_coordinates, bool, S_IRUGO | S_IWUSR);
93MODULE_PARM_DESC(raw_coordinates, "report raw coordinate values (y, default) or hardware-calibrated coordinate values (n)");
94
95struct mtouch_usb {
96 unsigned char *data;
97 dma_addr_t data_dma;
98 struct urb *irq;
99 struct usb_device *udev;
100 struct input_dev input;
101 char name[128];
102 char phys[64];
103};
104
105static struct usb_device_id mtouchusb_devices[] = {
106 { USB_DEVICE(0x0596, 0x0001) },
107 { }
108};
109
110static void mtouchusb_irq(struct urb *urb, struct pt_regs *regs)
111{
112 struct mtouch_usb *mtouch = urb->context;
113 int retval;
114
115 switch (urb->status) {
116 case 0:
117 /* success */
118 break;
119 case -ETIMEDOUT:
120 /* this urb is timing out */
121 dbg("%s - urb timed out - was the device unplugged?",
122 __FUNCTION__);
123 return;
124 case -ECONNRESET:
125 case -ENOENT:
126 case -ESHUTDOWN:
127 /* this urb is terminated, clean up */
128 dbg("%s - urb shutting down with status: %d",
129 __FUNCTION__, urb->status);
130 return;
131 default:
132 dbg("%s - nonzero urb status received: %d",
133 __FUNCTION__, urb->status);
134 goto exit;
135 }
136
137 input_regs(&mtouch->input, regs);
138 input_report_key(&mtouch->input, BTN_TOUCH,
139 MTOUCHUSB_GET_TOUCHED(mtouch->data));
140 input_report_abs(&mtouch->input, ABS_X, MTOUCHUSB_GET_XC(mtouch->data));
141 input_report_abs(&mtouch->input, ABS_Y,
142 (raw_coordinates ? MTOUCHUSB_MAX_RAW_YC : MTOUCHUSB_MAX_CALIB_YC)
143 - MTOUCHUSB_GET_YC(mtouch->data));
144 input_sync(&mtouch->input);
145
146exit:
147 retval = usb_submit_urb(urb, GFP_ATOMIC);
148 if (retval)
149 err("%s - usb_submit_urb failed with result: %d",
150 __FUNCTION__, retval);
151}
152
153static int mtouchusb_open(struct input_dev *input)
154{
155 struct mtouch_usb *mtouch = input->private;
156
157 mtouch->irq->dev = mtouch->udev;
158
159 if (usb_submit_urb(mtouch->irq, GFP_ATOMIC))
160 return -EIO;
161
162 return 0;
163}
164
165static void mtouchusb_close(struct input_dev *input)
166{
167 struct mtouch_usb *mtouch = input->private;
168
169 usb_kill_urb(mtouch->irq);
170}
171
172static int mtouchusb_alloc_buffers(struct usb_device *udev, struct mtouch_usb *mtouch)
173{
174 dbg("%s - called", __FUNCTION__);
175
176 mtouch->data = usb_buffer_alloc(udev, MTOUCHUSB_REPORT_DATA_SIZE,
177 SLAB_ATOMIC, &mtouch->data_dma);
178
179 if (!mtouch->data)
180 return -1;
181
182 return 0;
183}
184
185static void mtouchusb_free_buffers(struct usb_device *udev, struct mtouch_usb *mtouch)
186{
187 dbg("%s - called", __FUNCTION__);
188
189 if (mtouch->data)
190 usb_buffer_free(udev, MTOUCHUSB_REPORT_DATA_SIZE,
191 mtouch->data, mtouch->data_dma);
192}
193
194static int mtouchusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
195{
196 struct mtouch_usb *mtouch;
197 struct usb_host_interface *interface;
198 struct usb_endpoint_descriptor *endpoint;
199 struct usb_device *udev = interface_to_usbdev(intf);
200 char path[64];
201 int nRet;
202
203 dbg("%s - called", __FUNCTION__);
204
205 dbg("%s - setting interface", __FUNCTION__);
206 interface = intf->cur_altsetting;
207
208 dbg("%s - setting endpoint", __FUNCTION__);
209 endpoint = &interface->endpoint[0].desc;
210
211 if (!(mtouch = kmalloc(sizeof(struct mtouch_usb), GFP_KERNEL))) {
212 err("%s - Out of memory.", __FUNCTION__);
213 return -ENOMEM;
214 }
215
216 memset(mtouch, 0, sizeof(struct mtouch_usb));
217 mtouch->udev = udev;
218
219 dbg("%s - allocating buffers", __FUNCTION__);
220 if (mtouchusb_alloc_buffers(udev, mtouch)) {
221 mtouchusb_free_buffers(udev, mtouch);
222 kfree(mtouch);
223 return -ENOMEM;
224 }
225
226 mtouch->input.private = mtouch;
227 mtouch->input.open = mtouchusb_open;
228 mtouch->input.close = mtouchusb_close;
229
230 usb_make_path(udev, path, 64);
231 sprintf(mtouch->phys, "%s/input0", path);
232
233 mtouch->input.name = mtouch->name;
234 mtouch->input.phys = mtouch->phys;
235 mtouch->input.id.bustype = BUS_USB;
236 mtouch->input.id.vendor = le16_to_cpu(udev->descriptor.idVendor);
237 mtouch->input.id.product = le16_to_cpu(udev->descriptor.idProduct);
238 mtouch->input.id.version = le16_to_cpu(udev->descriptor.bcdDevice);
239 mtouch->input.dev = &intf->dev;
240
241 mtouch->input.evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
242 mtouch->input.absbit[0] = BIT(ABS_X) | BIT(ABS_Y);
243 mtouch->input.keybit[LONG(BTN_TOUCH)] = BIT(BTN_TOUCH);
244
245 /* Used to Scale Compensated Data and Flip Y */
246 mtouch->input.absmin[ABS_X] = MTOUCHUSB_MIN_XC;
247 mtouch->input.absmax[ABS_X] = raw_coordinates ?
248 MTOUCHUSB_MAX_RAW_XC : MTOUCHUSB_MAX_CALIB_XC;
249 mtouch->input.absfuzz[ABS_X] = MTOUCHUSB_XC_FUZZ;
250 mtouch->input.absflat[ABS_X] = MTOUCHUSB_XC_FLAT;
251 mtouch->input.absmin[ABS_Y] = MTOUCHUSB_MIN_YC;
252 mtouch->input.absmax[ABS_Y] = raw_coordinates ?
253 MTOUCHUSB_MAX_RAW_YC : MTOUCHUSB_MAX_CALIB_YC;
254 mtouch->input.absfuzz[ABS_Y] = MTOUCHUSB_YC_FUZZ;
255 mtouch->input.absflat[ABS_Y] = MTOUCHUSB_YC_FLAT;
256
257 if (udev->manufacturer)
258 strcat(mtouch->name, udev->manufacturer);
259 if (udev->product)
260 sprintf(mtouch->name, "%s %s", mtouch->name, udev->product);
261
262 if (!strlen(mtouch->name))
263 sprintf(mtouch->name, "USB Touchscreen %04x:%04x",
264 mtouch->input.id.vendor, mtouch->input.id.product);
265
266 nRet = usb_control_msg(mtouch->udev, usb_rcvctrlpipe(udev, 0),
267 MTOUCHUSB_RESET,
268 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
269 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
270 dbg("%s - usb_control_msg - MTOUCHUSB_RESET - bytes|err: %d",
271 __FUNCTION__, nRet);
272
273 dbg("%s - usb_alloc_urb: mtouch->irq", __FUNCTION__);
274 mtouch->irq = usb_alloc_urb(0, GFP_KERNEL);
275 if (!mtouch->irq) {
276 dbg("%s - usb_alloc_urb failed: mtouch->irq", __FUNCTION__);
277 mtouchusb_free_buffers(udev, mtouch);
278 kfree(mtouch);
279 return -ENOMEM;
280 }
281
282 dbg("%s - usb_fill_int_urb", __FUNCTION__);
283 usb_fill_int_urb(mtouch->irq, mtouch->udev,
284 usb_rcvintpipe(mtouch->udev, 0x81),
285 mtouch->data, MTOUCHUSB_REPORT_DATA_SIZE,
286 mtouchusb_irq, mtouch, endpoint->bInterval);
287
288 dbg("%s - input_register_device", __FUNCTION__);
289 input_register_device(&mtouch->input);
290
291 nRet = usb_control_msg(mtouch->udev, usb_rcvctrlpipe(udev, 0),
292 MTOUCHUSB_ASYNC_REPORT,
293 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
294 1, 1, NULL, 0, USB_CTRL_SET_TIMEOUT);
295 dbg("%s - usb_control_msg - MTOUCHUSB_ASYNC_REPORT - bytes|err: %d",
296 __FUNCTION__, nRet);
297
298 printk(KERN_INFO "input: %s on %s\n", mtouch->name, path);
299 usb_set_intfdata(intf, mtouch);
300
301 return 0;
302}
303
304static void mtouchusb_disconnect(struct usb_interface *intf)
305{
306 struct mtouch_usb *mtouch = usb_get_intfdata(intf);
307
308 dbg("%s - called", __FUNCTION__);
309 usb_set_intfdata(intf, NULL);
310 if (mtouch) {
311 dbg("%s - mtouch is initialized, cleaning up", __FUNCTION__);
312 usb_kill_urb(mtouch->irq);
313 input_unregister_device(&mtouch->input);
314 usb_free_urb(mtouch->irq);
315 mtouchusb_free_buffers(interface_to_usbdev(intf), mtouch);
316 kfree(mtouch);
317 }
318}
319
320MODULE_DEVICE_TABLE(usb, mtouchusb_devices);
321
322static struct usb_driver mtouchusb_driver = {
323 .owner = THIS_MODULE,
324 .name = "mtouchusb",
325 .probe = mtouchusb_probe,
326 .disconnect = mtouchusb_disconnect,
327 .id_table = mtouchusb_devices,
328};
329
330static int __init mtouchusb_init(void)
331{
332 dbg("%s - called", __FUNCTION__);
333 return usb_register(&mtouchusb_driver);
334}
335
336static void __exit mtouchusb_cleanup(void)
337{
338 dbg("%s - called", __FUNCTION__);
339 usb_deregister(&mtouchusb_driver);
340}
341
342module_init(mtouchusb_init);
343module_exit(mtouchusb_cleanup);
344
345MODULE_AUTHOR(DRIVER_AUTHOR);
346MODULE_DESCRIPTION(DRIVER_DESC);
347MODULE_LICENSE("GPL");