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/kernel.h>
43 #include <linux/slab.h>
44 #include <linux/module.h>
45 #include <linux/init.h>
46 #include <linux/usb/input.h>
48 #define MTOUCHUSB_MIN_XC 0x0
49 #define MTOUCHUSB_MAX_RAW_XC 0x4000
50 #define MTOUCHUSB_MAX_CALIB_XC 0xffff
51 #define MTOUCHUSB_XC_FUZZ 0x0
52 #define MTOUCHUSB_XC_FLAT 0x0
53 #define MTOUCHUSB_MIN_YC 0x0
54 #define MTOUCHUSB_MAX_RAW_YC 0x4000
55 #define MTOUCHUSB_MAX_CALIB_YC 0xffff
56 #define MTOUCHUSB_YC_FUZZ 0x0
57 #define MTOUCHUSB_YC_FLAT 0x0
59 #define MTOUCHUSB_ASYNC_REPORT 1
60 #define MTOUCHUSB_RESET 7
61 #define MTOUCHUSB_REPORT_DATA_SIZE 11
62 #define MTOUCHUSB_REQ_CTRLLR_ID 10
64 #define MTOUCHUSB_GET_RAW_XC(data) (data[8]<<8 | data[7])
65 #define MTOUCHUSB_GET_CALIB_XC(data) (data[4]<<8 | data[3])
66 #define MTOUCHUSB_GET_RAW_YC(data) (data[10]<<8 | data[9])
67 #define MTOUCHUSB_GET_CALIB_YC(data) (data[6]<<8 | data[5])
68 #define MTOUCHUSB_GET_XC(data) (raw_coordinates ? \
69 MTOUCHUSB_GET_RAW_XC(data) : \
70 MTOUCHUSB_GET_CALIB_XC(data))
71 #define MTOUCHUSB_GET_YC(data) (raw_coordinates ? \
72 MTOUCHUSB_GET_RAW_YC(data) : \
73 MTOUCHUSB_GET_CALIB_YC(data))
74 #define MTOUCHUSB_GET_TOUCHED(data) ((data[2] & 0x40) ? 1:0)
76 #define DRIVER_VERSION "v1.5"
77 #define DRIVER_AUTHOR "Todd E. Johnson, tejohnson@yahoo.com"
78 #define DRIVER_DESC "3M USB Touchscreen Driver"
79 #define DRIVER_LICENSE "GPL"
81 static int raw_coordinates
= 1;
83 module_param(raw_coordinates
, bool, S_IRUGO
| S_IWUSR
);
84 MODULE_PARM_DESC(raw_coordinates
, "report raw coordinate values (y, default) or hardware-calibrated coordinate values (n)");
90 struct usb_device
*udev
;
91 struct input_dev
*input
;
96 static struct usb_device_id mtouchusb_devices
[] = {
97 { USB_DEVICE(0x0596, 0x0001) },
101 static void mtouchusb_irq(struct urb
*urb
)
103 struct mtouch_usb
*mtouch
= urb
->context
;
106 switch (urb
->status
) {
111 /* this urb is timing out */
112 dbg("%s - urb timed out - was the device unplugged?",
118 /* this urb is terminated, clean up */
119 dbg("%s - urb shutting down with status: %d",
120 __FUNCTION__
, urb
->status
);
123 dbg("%s - nonzero urb status received: %d",
124 __FUNCTION__
, urb
->status
);
128 input_report_key(mtouch
->input
, BTN_TOUCH
,
129 MTOUCHUSB_GET_TOUCHED(mtouch
->data
));
130 input_report_abs(mtouch
->input
, ABS_X
, MTOUCHUSB_GET_XC(mtouch
->data
));
131 input_report_abs(mtouch
->input
, ABS_Y
,
132 (raw_coordinates
? MTOUCHUSB_MAX_RAW_YC
: MTOUCHUSB_MAX_CALIB_YC
)
133 - MTOUCHUSB_GET_YC(mtouch
->data
));
134 input_sync(mtouch
->input
);
137 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
139 err("%s - usb_submit_urb failed with result: %d",
140 __FUNCTION__
, retval
);
143 static int mtouchusb_open(struct input_dev
*input
)
145 struct mtouch_usb
*mtouch
= input
->private;
147 mtouch
->irq
->dev
= mtouch
->udev
;
149 if (usb_submit_urb(mtouch
->irq
, GFP_ATOMIC
))
155 static void mtouchusb_close(struct input_dev
*input
)
157 struct mtouch_usb
*mtouch
= input
->private;
159 usb_kill_urb(mtouch
->irq
);
162 static int mtouchusb_alloc_buffers(struct usb_device
*udev
, struct mtouch_usb
*mtouch
)
164 dbg("%s - called", __FUNCTION__
);
166 mtouch
->data
= usb_buffer_alloc(udev
, MTOUCHUSB_REPORT_DATA_SIZE
,
167 GFP_ATOMIC
, &mtouch
->data_dma
);
175 static void mtouchusb_free_buffers(struct usb_device
*udev
, struct mtouch_usb
*mtouch
)
177 dbg("%s - called", __FUNCTION__
);
180 usb_buffer_free(udev
, MTOUCHUSB_REPORT_DATA_SIZE
,
181 mtouch
->data
, mtouch
->data_dma
);
184 static int mtouchusb_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
186 struct mtouch_usb
*mtouch
;
187 struct input_dev
*input_dev
;
188 struct usb_host_interface
*interface
;
189 struct usb_endpoint_descriptor
*endpoint
;
190 struct usb_device
*udev
= interface_to_usbdev(intf
);
193 dbg("%s - called", __FUNCTION__
);
195 dbg("%s - setting interface", __FUNCTION__
);
196 interface
= intf
->cur_altsetting
;
198 dbg("%s - setting endpoint", __FUNCTION__
);
199 endpoint
= &interface
->endpoint
[0].desc
;
201 mtouch
= kzalloc(sizeof(struct mtouch_usb
), GFP_KERNEL
);
202 input_dev
= input_allocate_device();
203 if (!mtouch
|| !input_dev
) {
204 err("%s - Out of memory.", __FUNCTION__
);
208 dbg("%s - allocating buffers", __FUNCTION__
);
209 if (mtouchusb_alloc_buffers(udev
, mtouch
))
213 mtouch
->input
= input_dev
;
215 if (udev
->manufacturer
)
216 strlcpy(mtouch
->name
, udev
->manufacturer
, sizeof(mtouch
->name
));
219 if (udev
->manufacturer
)
220 strlcat(mtouch
->name
, " ", sizeof(mtouch
->name
));
221 strlcat(mtouch
->name
, udev
->product
, sizeof(mtouch
->name
));
224 if (!strlen(mtouch
->name
))
225 snprintf(mtouch
->name
, sizeof(mtouch
->name
),
226 "USB Touchscreen %04x:%04x",
227 le16_to_cpu(udev
->descriptor
.idVendor
),
228 le16_to_cpu(udev
->descriptor
.idProduct
));
230 usb_make_path(udev
, mtouch
->phys
, sizeof(mtouch
->phys
));
231 strlcpy(mtouch
->phys
, "/input0", sizeof(mtouch
->phys
));
233 input_dev
->name
= mtouch
->name
;
234 input_dev
->phys
= mtouch
->phys
;
235 usb_to_input_id(udev
, &input_dev
->id
);
236 input_dev
->cdev
.dev
= &intf
->dev
;
237 input_dev
->private = mtouch
;
239 input_dev
->open
= mtouchusb_open
;
240 input_dev
->close
= mtouchusb_close
;
242 input_dev
->evbit
[0] = BIT(EV_KEY
) | BIT(EV_ABS
);
243 input_dev
->keybit
[LONG(BTN_TOUCH
)] = BIT(BTN_TOUCH
);
244 input_set_abs_params(input_dev
, ABS_X
, MTOUCHUSB_MIN_XC
,
245 raw_coordinates
? MTOUCHUSB_MAX_RAW_XC
: MTOUCHUSB_MAX_CALIB_XC
,
246 MTOUCHUSB_XC_FUZZ
, MTOUCHUSB_XC_FLAT
);
247 input_set_abs_params(input_dev
, ABS_Y
, MTOUCHUSB_MIN_YC
,
248 raw_coordinates
? MTOUCHUSB_MAX_RAW_YC
: MTOUCHUSB_MAX_CALIB_YC
,
249 MTOUCHUSB_YC_FUZZ
, MTOUCHUSB_YC_FLAT
);
251 nRet
= usb_control_msg(mtouch
->udev
, usb_rcvctrlpipe(udev
, 0),
253 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
254 1, 0, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
255 dbg("%s - usb_control_msg - MTOUCHUSB_RESET - bytes|err: %d",
258 dbg("%s - usb_alloc_urb: mtouch->irq", __FUNCTION__
);
259 mtouch
->irq
= usb_alloc_urb(0, GFP_KERNEL
);
261 dbg("%s - usb_alloc_urb failed: mtouch->irq", __FUNCTION__
);
265 dbg("%s - usb_fill_int_urb", __FUNCTION__
);
266 usb_fill_int_urb(mtouch
->irq
, mtouch
->udev
,
267 usb_rcvintpipe(mtouch
->udev
, 0x81),
268 mtouch
->data
, MTOUCHUSB_REPORT_DATA_SIZE
,
269 mtouchusb_irq
, mtouch
, endpoint
->bInterval
);
271 dbg("%s - input_register_device", __FUNCTION__
);
272 input_register_device(mtouch
->input
);
274 nRet
= usb_control_msg(mtouch
->udev
, usb_rcvctrlpipe(udev
, 0),
275 MTOUCHUSB_ASYNC_REPORT
,
276 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
277 1, 1, NULL
, 0, USB_CTRL_SET_TIMEOUT
);
278 dbg("%s - usb_control_msg - MTOUCHUSB_ASYNC_REPORT - bytes|err: %d",
281 usb_set_intfdata(intf
, mtouch
);
284 fail2
: mtouchusb_free_buffers(udev
, mtouch
);
285 fail1
: input_free_device(input_dev
);
290 static void mtouchusb_disconnect(struct usb_interface
*intf
)
292 struct mtouch_usb
*mtouch
= usb_get_intfdata(intf
);
294 dbg("%s - called", __FUNCTION__
);
295 usb_set_intfdata(intf
, NULL
);
297 dbg("%s - mtouch is initialized, cleaning up", __FUNCTION__
);
298 usb_kill_urb(mtouch
->irq
);
299 input_unregister_device(mtouch
->input
);
300 usb_free_urb(mtouch
->irq
);
301 mtouchusb_free_buffers(interface_to_usbdev(intf
), mtouch
);
306 MODULE_DEVICE_TABLE(usb
, mtouchusb_devices
);
308 static struct usb_driver mtouchusb_driver
= {
310 .probe
= mtouchusb_probe
,
311 .disconnect
= mtouchusb_disconnect
,
312 .id_table
= mtouchusb_devices
,
315 static int __init
mtouchusb_init(void)
317 dbg("%s - called", __FUNCTION__
);
318 return usb_register(&mtouchusb_driver
);
321 static void __exit
mtouchusb_cleanup(void)
323 dbg("%s - called", __FUNCTION__
);
324 usb_deregister(&mtouchusb_driver
);
327 module_init(mtouchusb_init
);
328 module_exit(mtouchusb_cleanup
);
330 MODULE_AUTHOR(DRIVER_AUTHOR
);
331 MODULE_DESCRIPTION(DRIVER_DESC
);
332 MODULE_LICENSE("GPL");