1 /******************************************************************************
2 * mtouchusb.c -- Driver for Microtouch (Now 3M) USB Touchscreens
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.
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.
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.
18 * Based upon original work by Radoslaw Garbacz (usb-support@ite.pl)
19 * (http://freshmeat.net/projects/3mtouchscreendriver)
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
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
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
37 * 1.5 02/27/2005 ddstreet@ieee.org
38 * Added module parameter to select raw or hw-calibrated coordinate reporting
40 *****************************************************************************/
42 #include <linux/config.h>
44 #ifdef CONFIG_USB_DEBUG
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 #include <linux/usb_input.h>
58 #define MTOUCHUSB_MIN_XC 0x0
59 #define MTOUCHUSB_MAX_RAW_XC 0x4000
60 #define MTOUCHUSB_MAX_CALIB_XC 0xffff
61 #define MTOUCHUSB_XC_FUZZ 0x0
62 #define MTOUCHUSB_XC_FLAT 0x0
63 #define MTOUCHUSB_MIN_YC 0x0
64 #define MTOUCHUSB_MAX_RAW_YC 0x4000
65 #define MTOUCHUSB_MAX_CALIB_YC 0xffff
66 #define MTOUCHUSB_YC_FUZZ 0x0
67 #define MTOUCHUSB_YC_FLAT 0x0
69 #define MTOUCHUSB_ASYNC_REPORT 1
70 #define MTOUCHUSB_RESET 7
71 #define MTOUCHUSB_REPORT_DATA_SIZE 11
72 #define MTOUCHUSB_REQ_CTRLLR_ID 10
74 #define MTOUCHUSB_GET_RAW_XC(data) (data[8]<<8 | data[7])
75 #define MTOUCHUSB_GET_CALIB_XC(data) (data[4]<<8 | data[3])
76 #define MTOUCHUSB_GET_RAW_YC(data) (data[10]<<8 | data[9])
77 #define MTOUCHUSB_GET_CALIB_YC(data) (data[6]<<8 | data[5])
78 #define MTOUCHUSB_GET_XC(data) (raw_coordinates ? \
79 MTOUCHUSB_GET_RAW_XC(data) : \
80 MTOUCHUSB_GET_CALIB_XC(data))
81 #define MTOUCHUSB_GET_YC(data) (raw_coordinates ? \
82 MTOUCHUSB_GET_RAW_YC(data) : \
83 MTOUCHUSB_GET_CALIB_YC(data))
84 #define MTOUCHUSB_GET_TOUCHED(data) ((data[2] & 0x40) ? 1:0)
86 #define DRIVER_VERSION "v1.5"
87 #define DRIVER_AUTHOR "Todd E. Johnson, tejohnson@yahoo.com"
88 #define DRIVER_DESC "3M USB Touchscreen Driver"
89 #define DRIVER_LICENSE "GPL"
91 static int raw_coordinates = 1;
93 module_param(raw_coordinates, bool, S_IRUGO | S_IWUSR);
94 MODULE_PARM_DESC(raw_coordinates, "report raw coordinate values (y, default) or hardware-calibrated coordinate values (n)");
100 struct usb_device *udev;
101 struct input_dev *input;
106 static struct usb_device_id mtouchusb_devices[] = {
107 { USB_DEVICE(0x0596, 0x0001) },
111 static void mtouchusb_irq(struct urb *urb, struct pt_regs *regs)
113 struct mtouch_usb *mtouch = urb->context;
116 switch (urb->status) {
121 /* this urb is timing out */
122 dbg("%s - urb timed out - was the device unplugged?",
128 /* this urb is terminated, clean up */
129 dbg("%s - urb shutting down with status: %d",
130 __FUNCTION__, urb->status);
133 dbg("%s - nonzero urb status received: %d",
134 __FUNCTION__, urb->status);
138 input_regs(mtouch->input, regs);
139 input_report_key(mtouch->input, BTN_TOUCH,
140 MTOUCHUSB_GET_TOUCHED(mtouch->data));
141 input_report_abs(mtouch->input, ABS_X, MTOUCHUSB_GET_XC(mtouch->data));
142 input_report_abs(mtouch->input, ABS_Y,
143 (raw_coordinates ? MTOUCHUSB_MAX_RAW_YC : MTOUCHUSB_MAX_CALIB_YC)
144 - MTOUCHUSB_GET_YC(mtouch->data));
145 input_sync(mtouch->input);
148 retval = usb_submit_urb(urb, GFP_ATOMIC);
150 err("%s - usb_submit_urb failed with result: %d",
151 __FUNCTION__, retval);
154 static int mtouchusb_open(struct input_dev *input)
156 struct mtouch_usb *mtouch = input->private;
158 mtouch->irq->dev = mtouch->udev;
160 if (usb_submit_urb(mtouch->irq, GFP_ATOMIC))
166 static void mtouchusb_close(struct input_dev *input)
168 struct mtouch_usb *mtouch = input->private;
170 usb_kill_urb(mtouch->irq);
173 static int mtouchusb_alloc_buffers(struct usb_device *udev, struct mtouch_usb *mtouch)
175 dbg("%s - called", __FUNCTION__);
177 mtouch->data = usb_buffer_alloc(udev, MTOUCHUSB_REPORT_DATA_SIZE,
178 SLAB_ATOMIC, &mtouch->data_dma);
186 static void mtouchusb_free_buffers(struct usb_device *udev, struct mtouch_usb *mtouch)
188 dbg("%s - called", __FUNCTION__);
191 usb_buffer_free(udev, MTOUCHUSB_REPORT_DATA_SIZE,
192 mtouch->data, mtouch->data_dma);
195 static int mtouchusb_probe(struct usb_interface *intf, const struct usb_device_id *id)
197 struct mtouch_usb *mtouch;
198 struct input_dev *input_dev;
199 struct usb_host_interface *interface;
200 struct usb_endpoint_descriptor *endpoint;
201 struct usb_device *udev = interface_to_usbdev(intf);
204 dbg("%s - called", __FUNCTION__);
206 dbg("%s - setting interface", __FUNCTION__);
207 interface = intf->cur_altsetting;
209 dbg("%s - setting endpoint", __FUNCTION__);
210 endpoint = &interface->endpoint[0].desc;
212 mtouch = kzalloc(sizeof(struct mtouch_usb), GFP_KERNEL);
213 input_dev = input_allocate_device();
214 if (!mtouch || !input_dev) {
215 err("%s - Out of memory.", __FUNCTION__);
219 dbg("%s - allocating buffers", __FUNCTION__);
220 if (mtouchusb_alloc_buffers(udev, mtouch))
224 mtouch->input = input_dev;
226 if (udev->manufacturer)
227 strlcpy(mtouch->name, udev->manufacturer, sizeof(mtouch->name));
230 if (udev->manufacturer)
231 strlcat(mtouch->name, " ", sizeof(mtouch->name));
232 strlcat(mtouch->name, udev->product, sizeof(mtouch->name));
235 if (!strlen(mtouch->name))
236 snprintf(mtouch->name, sizeof(mtouch->name),
237 "USB Touchscreen %04x:%04x",
238 le16_to_cpu(udev->descriptor.idVendor),
239 le16_to_cpu(udev->descriptor.idProduct));
241 usb_make_path(udev, mtouch->phys, sizeof(mtouch->phys));
242 strlcpy(mtouch->phys, "/input0", sizeof(mtouch->phys));
244 input_dev->name = mtouch->name;
245 input_dev->phys = mtouch->phys;
246 usb_to_input_id(udev, &input_dev->id);
247 input_dev->cdev.dev = &intf->dev;
248 input_dev->private = mtouch;
250 input_dev->open = mtouchusb_open;
251 input_dev->close = mtouchusb_close;
253 input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
254 input_dev->keybit[LONG(BTN_TOUCH)] = BIT(BTN_TOUCH);
255 input_set_abs_params(input_dev, ABS_X, MTOUCHUSB_MIN_XC,
256 raw_coordinates ? MTOUCHUSB_MAX_RAW_XC : MTOUCHUSB_MAX_CALIB_XC,
257 MTOUCHUSB_XC_FUZZ, MTOUCHUSB_XC_FLAT);
258 input_set_abs_params(input_dev, ABS_Y, MTOUCHUSB_MIN_YC,
259 raw_coordinates ? MTOUCHUSB_MAX_RAW_YC : MTOUCHUSB_MAX_CALIB_YC,
260 MTOUCHUSB_YC_FUZZ, MTOUCHUSB_YC_FLAT);
262 nRet = usb_control_msg(mtouch->udev, usb_rcvctrlpipe(udev, 0),
264 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
265 1, 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
266 dbg("%s - usb_control_msg - MTOUCHUSB_RESET - bytes|err: %d",
269 dbg("%s - usb_alloc_urb: mtouch->irq", __FUNCTION__);
270 mtouch->irq = usb_alloc_urb(0, GFP_KERNEL);
272 dbg("%s - usb_alloc_urb failed: mtouch->irq", __FUNCTION__);
276 dbg("%s - usb_fill_int_urb", __FUNCTION__);
277 usb_fill_int_urb(mtouch->irq, mtouch->udev,
278 usb_rcvintpipe(mtouch->udev, 0x81),
279 mtouch->data, MTOUCHUSB_REPORT_DATA_SIZE,
280 mtouchusb_irq, mtouch, endpoint->bInterval);
282 dbg("%s - input_register_device", __FUNCTION__);
283 input_register_device(mtouch->input);
285 nRet = usb_control_msg(mtouch->udev, usb_rcvctrlpipe(udev, 0),
286 MTOUCHUSB_ASYNC_REPORT,
287 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
288 1, 1, NULL, 0, USB_CTRL_SET_TIMEOUT);
289 dbg("%s - usb_control_msg - MTOUCHUSB_ASYNC_REPORT - bytes|err: %d",
292 usb_set_intfdata(intf, mtouch);
295 fail2: mtouchusb_free_buffers(udev, mtouch);
296 fail1: input_free_device(input_dev);
301 static void mtouchusb_disconnect(struct usb_interface *intf)
303 struct mtouch_usb *mtouch = usb_get_intfdata(intf);
305 dbg("%s - called", __FUNCTION__);
306 usb_set_intfdata(intf, NULL);
308 dbg("%s - mtouch is initialized, cleaning up", __FUNCTION__);
309 usb_kill_urb(mtouch->irq);
310 input_unregister_device(mtouch->input);
311 usb_free_urb(mtouch->irq);
312 mtouchusb_free_buffers(interface_to_usbdev(intf), mtouch);
317 MODULE_DEVICE_TABLE(usb, mtouchusb_devices);
319 static struct usb_driver mtouchusb_driver = {
320 .owner = THIS_MODULE,
322 .probe = mtouchusb_probe,
323 .disconnect = mtouchusb_disconnect,
324 .id_table = mtouchusb_devices,
327 static int __init mtouchusb_init(void)
329 dbg("%s - called", __FUNCTION__);
330 return usb_register(&mtouchusb_driver);
333 static void __exit mtouchusb_cleanup(void)
335 dbg("%s - called", __FUNCTION__);
336 usb_deregister(&mtouchusb_driver);
339 module_init(mtouchusb_init);
340 module_exit(mtouchusb_cleanup);
342 MODULE_AUTHOR(DRIVER_AUTHOR);
343 MODULE_DESCRIPTION(DRIVER_DESC);
344 MODULE_LICENSE("GPL");