blob: 380233bd6a393c3522655922297849fa346f3f7a [file] [log] [blame]
Matthew Dharm34008db2005-07-28 14:49:01 -07001/*
2 * Support for the Maxtor OneTouch USB hard drive's button
3 *
4 * Current development and maintenance by:
5 * Copyright (c) 2005 Nick Sillik <n.sillik@temple.edu>
6 *
7 * Initial work by:
Dmitry Torokhov88789672005-09-15 02:01:43 -05008 * Copyright (c) 2003 Erik Thyren <erth7411@student.uu.se>
Matthew Dharm34008db2005-07-28 14:49:01 -07009 *
10 * Based on usbmouse.c (Vojtech Pavlik) and xpad.c (Marko Friedemann)
11 *
12 */
13
14/*
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
19 *
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 *
29 */
30
Matthew Dharm34008db2005-07-28 14:49:01 -070031#include <linux/kernel.h>
32#include <linux/input.h>
33#include <linux/init.h>
34#include <linux/slab.h>
35#include <linux/module.h>
David Brownellae0dadc2006-06-13 10:04:34 -070036#include <linux/usb/input.h>
Matthew Dharm34008db2005-07-28 14:49:01 -070037#include "usb.h"
Matthew Dharm34008db2005-07-28 14:49:01 -070038#include "debug.h"
39
Maciej Grela4246b062009-02-28 12:39:20 -080040MODULE_DESCRIPTION("Maxtor USB OneTouch hard drive button driver");
41MODULE_AUTHOR("Nick Sillik <n.sillik@temple.edu>");
42MODULE_LICENSE("GPL");
43
Alan Stern9cfb95e2009-02-12 14:48:33 -050044#define ONETOUCH_PKT_LEN 0x02
45#define ONETOUCH_BUTTON KEY_PROG1
46
47static int onetouch_connect_input(struct us_data *ss);
Adrian Bunk43c1e982008-04-28 18:39:37 +030048static void onetouch_release_input(void *onetouch_);
Matthew Dharm34008db2005-07-28 14:49:01 -070049
50struct usb_onetouch {
51 char name[128];
52 char phys[64];
Dmitry Torokhov88789672005-09-15 02:01:43 -050053 struct input_dev *dev; /* input device interface */
Matthew Dharm34008db2005-07-28 14:49:01 -070054 struct usb_device *udev; /* usb device */
55
56 struct urb *irq; /* urb for interrupt in report */
57 unsigned char *data; /* input data */
58 dma_addr_t data_dma;
Matthew Dharm7931e1c2005-12-04 21:56:51 -080059 unsigned int is_open:1;
Matthew Dharm34008db2005-07-28 14:49:01 -070060};
61
Alan Stern9cfb95e2009-02-12 14:48:33 -050062
63/*
64 * The table of devices
65 */
66#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
67 vendorName, productName, useProtocol, useTransport, \
68 initFunction, flags) \
69{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
70 .driver_info = (flags)|(USB_US_TYPE_STOR<<24) }
71
72struct usb_device_id onetouch_usb_ids[] = {
73# include "unusual_onetouch.h"
74 { } /* Terminating entry */
75};
76MODULE_DEVICE_TABLE(usb, onetouch_usb_ids);
77
78#undef UNUSUAL_DEV
79
80/*
81 * The flags table
82 */
83#define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
84 vendor_name, product_name, use_protocol, use_transport, \
85 init_function, Flags) \
86{ \
87 .vendorName = vendor_name, \
88 .productName = product_name, \
89 .useProtocol = use_protocol, \
90 .useTransport = use_transport, \
91 .initFunction = init_function, \
92}
93
94static struct us_unusual_dev onetouch_unusual_dev_list[] = {
95# include "unusual_onetouch.h"
96 { } /* Terminating entry */
97};
98
99#undef UNUSUAL_DEV
100
101
David Howells7d12e782006-10-05 14:55:46 +0100102static void usb_onetouch_irq(struct urb *urb)
Matthew Dharm34008db2005-07-28 14:49:01 -0700103{
104 struct usb_onetouch *onetouch = urb->context;
105 signed char *data = onetouch->data;
Dmitry Torokhov88789672005-09-15 02:01:43 -0500106 struct input_dev *dev = onetouch->dev;
Greg Kroah-Hartman62e5a332007-07-18 10:58:02 -0700107 int status = urb->status;
108 int retval;
Matthew Dharm34008db2005-07-28 14:49:01 -0700109
Greg Kroah-Hartman62e5a332007-07-18 10:58:02 -0700110 switch (status) {
Matthew Dharm34008db2005-07-28 14:49:01 -0700111 case 0: /* success */
112 break;
113 case -ECONNRESET: /* unlink */
114 case -ENOENT:
115 case -ESHUTDOWN:
116 return;
117 /* -EPIPE: should clear the halt */
118 default: /* error */
119 goto resubmit;
120 }
121
Dmitry Torokhov88789672005-09-15 02:01:43 -0500122 input_report_key(dev, ONETOUCH_BUTTON, data[0] & 0x02);
Matthew Dharm34008db2005-07-28 14:49:01 -0700123 input_sync(dev);
Dmitry Torokhov88789672005-09-15 02:01:43 -0500124
Matthew Dharm34008db2005-07-28 14:49:01 -0700125resubmit:
Greg Kroah-Hartman62e5a332007-07-18 10:58:02 -0700126 retval = usb_submit_urb (urb, GFP_ATOMIC);
127 if (retval)
Greg Kroah-Hartman802f3892008-08-14 09:37:34 -0700128 dev_err(&dev->dev, "can't resubmit intr, %s-%s/input0, "
129 "retval %d\n", onetouch->udev->bus->bus_name,
Greg Kroah-Hartman62e5a332007-07-18 10:58:02 -0700130 onetouch->udev->devpath, retval);
Matthew Dharm34008db2005-07-28 14:49:01 -0700131}
132
133static int usb_onetouch_open(struct input_dev *dev)
134{
Dmitry Torokhov09b70022007-05-08 00:31:30 -0400135 struct usb_onetouch *onetouch = input_get_drvdata(dev);
Matthew Dharm34008db2005-07-28 14:49:01 -0700136
Matthew Dharm7931e1c2005-12-04 21:56:51 -0800137 onetouch->is_open = 1;
Matthew Dharm34008db2005-07-28 14:49:01 -0700138 onetouch->irq->dev = onetouch->udev;
139 if (usb_submit_urb(onetouch->irq, GFP_KERNEL)) {
Greg Kroah-Hartman802f3892008-08-14 09:37:34 -0700140 dev_err(&dev->dev, "usb_submit_urb failed\n");
Matthew Dharm34008db2005-07-28 14:49:01 -0700141 return -EIO;
142 }
143
144 return 0;
145}
146
147static void usb_onetouch_close(struct input_dev *dev)
148{
Dmitry Torokhov09b70022007-05-08 00:31:30 -0400149 struct usb_onetouch *onetouch = input_get_drvdata(dev);
Matthew Dharm34008db2005-07-28 14:49:01 -0700150
151 usb_kill_urb(onetouch->irq);
Matthew Dharm7931e1c2005-12-04 21:56:51 -0800152 onetouch->is_open = 0;
Matthew Dharm34008db2005-07-28 14:49:01 -0700153}
154
Matthew Dharm7931e1c2005-12-04 21:56:51 -0800155#ifdef CONFIG_PM
156static void usb_onetouch_pm_hook(struct us_data *us, int action)
157{
158 struct usb_onetouch *onetouch = (struct usb_onetouch *) us->extra;
159
160 if (onetouch->is_open) {
161 switch (action) {
162 case US_SUSPEND:
163 usb_kill_urb(onetouch->irq);
164 break;
165 case US_RESUME:
166 if (usb_submit_urb(onetouch->irq, GFP_KERNEL) != 0)
Greg Kroah-Hartman802f3892008-08-14 09:37:34 -0700167 dev_err(&onetouch->irq->dev->dev,
168 "usb_submit_urb failed\n");
Matthew Dharm7931e1c2005-12-04 21:56:51 -0800169 break;
170 default:
171 break;
172 }
173 }
174}
175#endif /* CONFIG_PM */
176
Alan Stern9cfb95e2009-02-12 14:48:33 -0500177static int onetouch_connect_input(struct us_data *ss)
Matthew Dharm34008db2005-07-28 14:49:01 -0700178{
179 struct usb_device *udev = ss->pusb_dev;
180 struct usb_host_interface *interface;
181 struct usb_endpoint_descriptor *endpoint;
182 struct usb_onetouch *onetouch;
Dmitry Torokhov88789672005-09-15 02:01:43 -0500183 struct input_dev *input_dev;
Matthew Dharm34008db2005-07-28 14:49:01 -0700184 int pipe, maxp;
Dmitry Torokhov17efe152006-08-01 22:45:28 -0400185 int error = -ENOMEM;
Matthew Dharm34008db2005-07-28 14:49:01 -0700186
187 interface = ss->pusb_intf->cur_altsetting;
188
Nick Sillikd6450e12005-08-17 13:37:34 -0400189 if (interface->desc.bNumEndpoints != 3)
Matthew Dharm34008db2005-07-28 14:49:01 -0700190 return -ENODEV;
Nick Sillikd6450e12005-08-17 13:37:34 -0400191
192 endpoint = &interface->endpoint[2].desc;
Luiz Fernando N. Capitulino66722a12006-10-26 13:02:55 -0300193 if (!usb_endpoint_is_int_in(endpoint))
Matthew Dharm34008db2005-07-28 14:49:01 -0700194 return -ENODEV;
195
196 pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
197 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
198
Dmitry Torokhov88789672005-09-15 02:01:43 -0500199 onetouch = kzalloc(sizeof(struct usb_onetouch), GFP_KERNEL);
200 input_dev = input_allocate_device();
201 if (!onetouch || !input_dev)
202 goto fail1;
Matthew Dharm34008db2005-07-28 14:49:01 -0700203
Nick Sillikd6450e12005-08-17 13:37:34 -0400204 onetouch->data = usb_buffer_alloc(udev, ONETOUCH_PKT_LEN,
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800205 GFP_ATOMIC, &onetouch->data_dma);
Dmitry Torokhov88789672005-09-15 02:01:43 -0500206 if (!onetouch->data)
207 goto fail1;
Matthew Dharm34008db2005-07-28 14:49:01 -0700208
209 onetouch->irq = usb_alloc_urb(0, GFP_KERNEL);
Dmitry Torokhov88789672005-09-15 02:01:43 -0500210 if (!onetouch->irq)
211 goto fail2;
Matthew Dharm34008db2005-07-28 14:49:01 -0700212
213 onetouch->udev = udev;
Dmitry Torokhov88789672005-09-15 02:01:43 -0500214 onetouch->dev = input_dev;
Matthew Dharm34008db2005-07-28 14:49:01 -0700215
216 if (udev->manufacturer)
Dmitry Torokhov88789672005-09-15 02:01:43 -0500217 strlcpy(onetouch->name, udev->manufacturer,
218 sizeof(onetouch->name));
219 if (udev->product) {
220 if (udev->manufacturer)
221 strlcat(onetouch->name, " ", sizeof(onetouch->name));
222 strlcat(onetouch->name, udev->product, sizeof(onetouch->name));
223 }
224
Matthew Dharm34008db2005-07-28 14:49:01 -0700225 if (!strlen(onetouch->name))
Dmitry Torokhov88789672005-09-15 02:01:43 -0500226 snprintf(onetouch->name, sizeof(onetouch->name),
227 "Maxtor Onetouch %04x:%04x",
228 le16_to_cpu(udev->descriptor.idVendor),
229 le16_to_cpu(udev->descriptor.idProduct));
230
231 usb_make_path(udev, onetouch->phys, sizeof(onetouch->phys));
232 strlcat(onetouch->phys, "/input0", sizeof(onetouch->phys));
233
234 input_dev->name = onetouch->name;
235 input_dev->phys = onetouch->phys;
236 usb_to_input_id(udev, &input_dev->id);
Dmitry Torokhov09b70022007-05-08 00:31:30 -0400237 input_dev->dev.parent = &udev->dev;
Dmitry Torokhov88789672005-09-15 02:01:43 -0500238
239 set_bit(EV_KEY, input_dev->evbit);
240 set_bit(ONETOUCH_BUTTON, input_dev->keybit);
241 clear_bit(0, input_dev->keybit);
242
Dmitry Torokhov09b70022007-05-08 00:31:30 -0400243 input_set_drvdata(input_dev, onetouch);
244
Dmitry Torokhov88789672005-09-15 02:01:43 -0500245 input_dev->open = usb_onetouch_open;
246 input_dev->close = usb_onetouch_close;
Matthew Dharm34008db2005-07-28 14:49:01 -0700247
248 usb_fill_int_urb(onetouch->irq, udev, pipe, onetouch->data,
249 (maxp > 8 ? 8 : maxp),
250 usb_onetouch_irq, onetouch, endpoint->bInterval);
251 onetouch->irq->transfer_dma = onetouch->data_dma;
252 onetouch->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
253
254 ss->extra_destructor = onetouch_release_input;
255 ss->extra = onetouch;
Matthew Dharm7931e1c2005-12-04 21:56:51 -0800256#ifdef CONFIG_PM
257 ss->suspend_resume_hook = usb_onetouch_pm_hook;
258#endif
Matthew Dharm34008db2005-07-28 14:49:01 -0700259
Dmitry Torokhov17efe152006-08-01 22:45:28 -0400260 error = input_register_device(onetouch->dev);
261 if (error)
262 goto fail3;
Matthew Dharm34008db2005-07-28 14:49:01 -0700263
264 return 0;
Dmitry Torokhov88789672005-09-15 02:01:43 -0500265
Dmitry Torokhov17efe152006-08-01 22:45:28 -0400266 fail3: usb_free_urb(onetouch->irq);
Dmitry Torokhov88789672005-09-15 02:01:43 -0500267 fail2: usb_buffer_free(udev, ONETOUCH_PKT_LEN,
268 onetouch->data, onetouch->data_dma);
269 fail1: kfree(onetouch);
270 input_free_device(input_dev);
Dmitry Torokhov17efe152006-08-01 22:45:28 -0400271 return error;
Matthew Dharm34008db2005-07-28 14:49:01 -0700272}
273
Adrian Bunk43c1e982008-04-28 18:39:37 +0300274static void onetouch_release_input(void *onetouch_)
Matthew Dharm34008db2005-07-28 14:49:01 -0700275{
276 struct usb_onetouch *onetouch = (struct usb_onetouch *) onetouch_;
277
278 if (onetouch) {
279 usb_kill_urb(onetouch->irq);
Dmitry Torokhov88789672005-09-15 02:01:43 -0500280 input_unregister_device(onetouch->dev);
Matthew Dharm34008db2005-07-28 14:49:01 -0700281 usb_free_urb(onetouch->irq);
282 usb_buffer_free(onetouch->udev, ONETOUCH_PKT_LEN,
283 onetouch->data, onetouch->data_dma);
Matthew Dharm34008db2005-07-28 14:49:01 -0700284 }
285}
Alan Stern9cfb95e2009-02-12 14:48:33 -0500286
287static int onetouch_probe(struct usb_interface *intf,
288 const struct usb_device_id *id)
289{
290 struct us_data *us;
291 int result;
292
293 result = usb_stor_probe1(&us, intf, id,
294 (id - onetouch_usb_ids) + onetouch_unusual_dev_list);
295 if (result)
296 return result;
297
298 /* Use default transport and protocol */
299
300 result = usb_stor_probe2(us);
301 return result;
302}
303
304static struct usb_driver onetouch_driver = {
305 .name = "ums-onetouch",
306 .probe = onetouch_probe,
307 .disconnect = usb_stor_disconnect,
308 .suspend = usb_stor_suspend,
309 .resume = usb_stor_resume,
310 .reset_resume = usb_stor_reset_resume,
311 .pre_reset = usb_stor_pre_reset,
312 .post_reset = usb_stor_post_reset,
313 .id_table = onetouch_usb_ids,
314 .soft_unbind = 1,
315};
316
317static int __init onetouch_init(void)
318{
319 return usb_register(&onetouch_driver);
320}
321
322static void __exit onetouch_exit(void)
323{
324 usb_deregister(&onetouch_driver);
325}
326
327module_init(onetouch_init);
328module_exit(onetouch_exit);