]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | |
093cf723 | 35 | * Performed multiple successful tests with an EXII-5010UC |
1da177e4 LT |
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 | ||
1da177e4 LT |
42 | #include <linux/kernel.h> |
43 | #include <linux/slab.h> | |
1da177e4 LT |
44 | #include <linux/module.h> |
45 | #include <linux/init.h> | |
ae0dadcf | 46 | #include <linux/usb/input.h> |
1da177e4 LT |
47 | |
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 | |
58 | ||
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 | |
63 | ||
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) | |
75 | ||
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" | |
80 | ||
81 | static int raw_coordinates = 1; | |
82 | ||
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)"); | |
85 | ||
86 | struct mtouch_usb { | |
8baf9ed4 DT |
87 | unsigned char *data; |
88 | dma_addr_t data_dma; | |
89 | struct urb *irq; | |
90 | struct usb_device *udev; | |
c5b7c7c3 | 91 | struct input_dev *input; |
8baf9ed4 DT |
92 | char name[128]; |
93 | char phys[64]; | |
1da177e4 LT |
94 | }; |
95 | ||
8baf9ed4 DT |
96 | static struct usb_device_id mtouchusb_devices[] = { |
97 | { USB_DEVICE(0x0596, 0x0001) }, | |
98 | { } | |
1da177e4 LT |
99 | }; |
100 | ||
7d12e780 | 101 | static void mtouchusb_irq(struct urb *urb) |
1da177e4 | 102 | { |
8baf9ed4 DT |
103 | struct mtouch_usb *mtouch = urb->context; |
104 | int retval; | |
105 | ||
106 | switch (urb->status) { | |
107 | case 0: | |
108 | /* success */ | |
109 | break; | |
38e2bfc9 | 110 | case -ETIME: |
8baf9ed4 DT |
111 | /* this urb is timing out */ |
112 | dbg("%s - urb timed out - was the device unplugged?", | |
113 | __FUNCTION__); | |
114 | return; | |
115 | case -ECONNRESET: | |
116 | case -ENOENT: | |
117 | case -ESHUTDOWN: | |
118 | /* this urb is terminated, clean up */ | |
119 | dbg("%s - urb shutting down with status: %d", | |
120 | __FUNCTION__, urb->status); | |
121 | return; | |
122 | default: | |
123 | dbg("%s - nonzero urb status received: %d", | |
124 | __FUNCTION__, urb->status); | |
125 | goto exit; | |
126 | } | |
127 | ||
c5b7c7c3 | 128 | input_report_key(mtouch->input, BTN_TOUCH, |
8baf9ed4 | 129 | MTOUCHUSB_GET_TOUCHED(mtouch->data)); |
c5b7c7c3 DT |
130 | input_report_abs(mtouch->input, ABS_X, MTOUCHUSB_GET_XC(mtouch->data)); |
131 | input_report_abs(mtouch->input, ABS_Y, | |
1da177e4 | 132 | (raw_coordinates ? MTOUCHUSB_MAX_RAW_YC : MTOUCHUSB_MAX_CALIB_YC) |
8baf9ed4 | 133 | - MTOUCHUSB_GET_YC(mtouch->data)); |
c5b7c7c3 | 134 | input_sync(mtouch->input); |
1da177e4 LT |
135 | |
136 | exit: | |
8baf9ed4 DT |
137 | retval = usb_submit_urb(urb, GFP_ATOMIC); |
138 | if (retval) | |
139 | err("%s - usb_submit_urb failed with result: %d", | |
140 | __FUNCTION__, retval); | |
1da177e4 LT |
141 | } |
142 | ||
8baf9ed4 | 143 | static int mtouchusb_open(struct input_dev *input) |
1da177e4 | 144 | { |
8baf9ed4 | 145 | struct mtouch_usb *mtouch = input->private; |
1da177e4 | 146 | |
8baf9ed4 | 147 | mtouch->irq->dev = mtouch->udev; |
1da177e4 | 148 | |
65cde54b | 149 | if (usb_submit_urb(mtouch->irq, GFP_ATOMIC)) |
8baf9ed4 | 150 | return -EIO; |
1da177e4 | 151 | |
8baf9ed4 | 152 | return 0; |
1da177e4 LT |
153 | } |
154 | ||
8baf9ed4 | 155 | static void mtouchusb_close(struct input_dev *input) |
1da177e4 | 156 | { |
8baf9ed4 | 157 | struct mtouch_usb *mtouch = input->private; |
1da177e4 | 158 | |
65cde54b | 159 | usb_kill_urb(mtouch->irq); |
1da177e4 LT |
160 | } |
161 | ||
162 | static int mtouchusb_alloc_buffers(struct usb_device *udev, struct mtouch_usb *mtouch) | |
163 | { | |
8baf9ed4 | 164 | dbg("%s - called", __FUNCTION__); |
1da177e4 | 165 | |
8baf9ed4 | 166 | mtouch->data = usb_buffer_alloc(udev, MTOUCHUSB_REPORT_DATA_SIZE, |
54e6ecb2 | 167 | GFP_ATOMIC, &mtouch->data_dma); |
1da177e4 | 168 | |
8baf9ed4 DT |
169 | if (!mtouch->data) |
170 | return -1; | |
1da177e4 | 171 | |
8baf9ed4 | 172 | return 0; |
1da177e4 LT |
173 | } |
174 | ||
175 | static void mtouchusb_free_buffers(struct usb_device *udev, struct mtouch_usb *mtouch) | |
176 | { | |
8baf9ed4 | 177 | dbg("%s - called", __FUNCTION__); |
1da177e4 | 178 | |
8baf9ed4 DT |
179 | if (mtouch->data) |
180 | usb_buffer_free(udev, MTOUCHUSB_REPORT_DATA_SIZE, | |
181 | mtouch->data, mtouch->data_dma); | |
1da177e4 LT |
182 | } |
183 | ||
184 | static int mtouchusb_probe(struct usb_interface *intf, const struct usb_device_id *id) | |
185 | { | |
8baf9ed4 | 186 | struct mtouch_usb *mtouch; |
c5b7c7c3 | 187 | struct input_dev *input_dev; |
8baf9ed4 DT |
188 | struct usb_host_interface *interface; |
189 | struct usb_endpoint_descriptor *endpoint; | |
190 | struct usb_device *udev = interface_to_usbdev(intf); | |
8baf9ed4 DT |
191 | int nRet; |
192 | ||
193 | dbg("%s - called", __FUNCTION__); | |
194 | ||
195 | dbg("%s - setting interface", __FUNCTION__); | |
196 | interface = intf->cur_altsetting; | |
197 | ||
198 | dbg("%s - setting endpoint", __FUNCTION__); | |
199 | endpoint = &interface->endpoint[0].desc; | |
200 | ||
c5b7c7c3 DT |
201 | mtouch = kzalloc(sizeof(struct mtouch_usb), GFP_KERNEL); |
202 | input_dev = input_allocate_device(); | |
203 | if (!mtouch || !input_dev) { | |
8baf9ed4 | 204 | err("%s - Out of memory.", __FUNCTION__); |
c5b7c7c3 | 205 | goto fail1; |
8baf9ed4 DT |
206 | } |
207 | ||
8baf9ed4 | 208 | dbg("%s - allocating buffers", __FUNCTION__); |
c5b7c7c3 DT |
209 | if (mtouchusb_alloc_buffers(udev, mtouch)) |
210 | goto fail2; | |
8baf9ed4 | 211 | |
c5b7c7c3 DT |
212 | mtouch->udev = udev; |
213 | mtouch->input = input_dev; | |
1da177e4 LT |
214 | |
215 | if (udev->manufacturer) | |
c5b7c7c3 DT |
216 | strlcpy(mtouch->name, udev->manufacturer, sizeof(mtouch->name)); |
217 | ||
218 | if (udev->product) { | |
219 | if (udev->manufacturer) | |
220 | strlcat(mtouch->name, " ", sizeof(mtouch->name)); | |
221 | strlcat(mtouch->name, udev->product, sizeof(mtouch->name)); | |
222 | } | |
1da177e4 | 223 | |
8baf9ed4 | 224 | if (!strlen(mtouch->name)) |
c5b7c7c3 DT |
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)); | |
229 | ||
230 | usb_make_path(udev, mtouch->phys, sizeof(mtouch->phys)); | |
231 | strlcpy(mtouch->phys, "/input0", sizeof(mtouch->phys)); | |
232 | ||
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; | |
238 | ||
239 | input_dev->open = mtouchusb_open; | |
240 | input_dev->close = mtouchusb_close; | |
241 | ||
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); | |
8baf9ed4 DT |
250 | |
251 | nRet = usb_control_msg(mtouch->udev, usb_rcvctrlpipe(udev, 0), | |
252 | MTOUCHUSB_RESET, | |
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", | |
256 | __FUNCTION__, nRet); | |
257 | ||
258 | dbg("%s - usb_alloc_urb: mtouch->irq", __FUNCTION__); | |
259 | mtouch->irq = usb_alloc_urb(0, GFP_KERNEL); | |
260 | if (!mtouch->irq) { | |
261 | dbg("%s - usb_alloc_urb failed: mtouch->irq", __FUNCTION__); | |
c5b7c7c3 | 262 | goto fail2; |
8baf9ed4 DT |
263 | } |
264 | ||
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); | |
270 | ||
271 | dbg("%s - input_register_device", __FUNCTION__); | |
c5b7c7c3 | 272 | input_register_device(mtouch->input); |
8baf9ed4 DT |
273 | |
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", | |
279 | __FUNCTION__, nRet); | |
280 | ||
8baf9ed4 | 281 | usb_set_intfdata(intf, mtouch); |
8baf9ed4 | 282 | return 0; |
c5b7c7c3 DT |
283 | |
284 | fail2: mtouchusb_free_buffers(udev, mtouch); | |
285 | fail1: input_free_device(input_dev); | |
286 | kfree(mtouch); | |
287 | return -ENOMEM; | |
1da177e4 LT |
288 | } |
289 | ||
290 | static void mtouchusb_disconnect(struct usb_interface *intf) | |
291 | { | |
8baf9ed4 DT |
292 | struct mtouch_usb *mtouch = usb_get_intfdata(intf); |
293 | ||
294 | dbg("%s - called", __FUNCTION__); | |
295 | usb_set_intfdata(intf, NULL); | |
296 | if (mtouch) { | |
297 | dbg("%s - mtouch is initialized, cleaning up", __FUNCTION__); | |
298 | usb_kill_urb(mtouch->irq); | |
c5b7c7c3 | 299 | input_unregister_device(mtouch->input); |
8baf9ed4 DT |
300 | usb_free_urb(mtouch->irq); |
301 | mtouchusb_free_buffers(interface_to_usbdev(intf), mtouch); | |
302 | kfree(mtouch); | |
303 | } | |
1da177e4 LT |
304 | } |
305 | ||
8baf9ed4 | 306 | MODULE_DEVICE_TABLE(usb, mtouchusb_devices); |
1da177e4 LT |
307 | |
308 | static struct usb_driver mtouchusb_driver = { | |
8baf9ed4 DT |
309 | .name = "mtouchusb", |
310 | .probe = mtouchusb_probe, | |
311 | .disconnect = mtouchusb_disconnect, | |
312 | .id_table = mtouchusb_devices, | |
1da177e4 LT |
313 | }; |
314 | ||
8baf9ed4 DT |
315 | static int __init mtouchusb_init(void) |
316 | { | |
317 | dbg("%s - called", __FUNCTION__); | |
318 | return usb_register(&mtouchusb_driver); | |
1da177e4 LT |
319 | } |
320 | ||
8baf9ed4 DT |
321 | static void __exit mtouchusb_cleanup(void) |
322 | { | |
323 | dbg("%s - called", __FUNCTION__); | |
324 | usb_deregister(&mtouchusb_driver); | |
1da177e4 LT |
325 | } |
326 | ||
327 | module_init(mtouchusb_init); | |
328 | module_exit(mtouchusb_cleanup); | |
329 | ||
8baf9ed4 DT |
330 | MODULE_AUTHOR(DRIVER_AUTHOR); |
331 | MODULE_DESCRIPTION(DRIVER_DESC); | |
1da177e4 | 332 | MODULE_LICENSE("GPL"); |