xref: /linux/drivers/usb/storage/onetouch.c (revision 5e8d780d745c1619aba81fe7166c5a4b5cad2b84)
1 /*
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:
8  *	Copyright (c) 2003 Erik Thyren <erth7411@student.uu.se>
9  *
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 
31 #include <linux/config.h>
32 #include <linux/kernel.h>
33 #include <linux/input.h>
34 #include <linux/init.h>
35 #include <linux/slab.h>
36 #include <linux/module.h>
37 #include <linux/usb_ch9.h>
38 #include <linux/usb/input.h>
39 #include "usb.h"
40 #include "onetouch.h"
41 #include "debug.h"
42 
43 void onetouch_release_input(void *onetouch_);
44 
45 struct usb_onetouch {
46 	char name[128];
47 	char phys[64];
48 	struct input_dev *dev;	/* input device interface */
49 	struct usb_device *udev;	/* usb device */
50 
51 	struct urb *irq;	/* urb for interrupt in report */
52 	unsigned char *data;	/* input data */
53 	dma_addr_t data_dma;
54 	unsigned int is_open:1;
55 };
56 
57 static void usb_onetouch_irq(struct urb *urb, struct pt_regs *regs)
58 {
59 	struct usb_onetouch *onetouch = urb->context;
60 	signed char *data = onetouch->data;
61 	struct input_dev *dev = onetouch->dev;
62 	int status;
63 
64 	switch (urb->status) {
65 	case 0:			/* success */
66 		break;
67 	case -ECONNRESET:	/* unlink */
68 	case -ENOENT:
69 	case -ESHUTDOWN:
70 		return;
71 	/* -EPIPE:  should clear the halt */
72 	default:		/* error */
73 		goto resubmit;
74 	}
75 
76 	input_regs(dev, regs);
77 	input_report_key(dev, ONETOUCH_BUTTON, data[0] & 0x02);
78 	input_sync(dev);
79 
80 resubmit:
81 	status = usb_submit_urb (urb, SLAB_ATOMIC);
82 	if (status)
83 		err ("can't resubmit intr, %s-%s/input0, status %d",
84 			onetouch->udev->bus->bus_name,
85 			onetouch->udev->devpath, status);
86 }
87 
88 static int usb_onetouch_open(struct input_dev *dev)
89 {
90 	struct usb_onetouch *onetouch = dev->private;
91 
92 	onetouch->is_open = 1;
93 	onetouch->irq->dev = onetouch->udev;
94 	if (usb_submit_urb(onetouch->irq, GFP_KERNEL)) {
95 		err("usb_submit_urb failed");
96 		return -EIO;
97 	}
98 
99 	return 0;
100 }
101 
102 static void usb_onetouch_close(struct input_dev *dev)
103 {
104 	struct usb_onetouch *onetouch = dev->private;
105 
106 	usb_kill_urb(onetouch->irq);
107 	onetouch->is_open = 0;
108 }
109 
110 #ifdef CONFIG_PM
111 static void usb_onetouch_pm_hook(struct us_data *us, int action)
112 {
113 	struct usb_onetouch *onetouch = (struct usb_onetouch *) us->extra;
114 
115 	if (onetouch->is_open) {
116 		switch (action) {
117 		case US_SUSPEND:
118 			usb_kill_urb(onetouch->irq);
119 			break;
120 		case US_RESUME:
121 			if (usb_submit_urb(onetouch->irq, GFP_KERNEL) != 0)
122 				err("usb_submit_urb failed");
123 			break;
124 		default:
125 			break;
126 		}
127 	}
128 }
129 #endif /* CONFIG_PM */
130 
131 int onetouch_connect_input(struct us_data *ss)
132 {
133 	struct usb_device *udev = ss->pusb_dev;
134 	struct usb_host_interface *interface;
135 	struct usb_endpoint_descriptor *endpoint;
136 	struct usb_onetouch *onetouch;
137 	struct input_dev *input_dev;
138 	int pipe, maxp;
139 
140 	interface = ss->pusb_intf->cur_altsetting;
141 
142 	if (interface->desc.bNumEndpoints != 3)
143 		return -ENODEV;
144 
145 	endpoint = &interface->endpoint[2].desc;
146 	if (!(endpoint->bEndpointAddress & USB_DIR_IN))
147 		return -ENODEV;
148 	if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
149 			!= USB_ENDPOINT_XFER_INT)
150 		return -ENODEV;
151 
152 	pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
153 	maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
154 
155 	onetouch = kzalloc(sizeof(struct usb_onetouch), GFP_KERNEL);
156 	input_dev = input_allocate_device();
157 	if (!onetouch || !input_dev)
158 		goto fail1;
159 
160 	onetouch->data = usb_buffer_alloc(udev, ONETOUCH_PKT_LEN,
161 					  SLAB_ATOMIC, &onetouch->data_dma);
162 	if (!onetouch->data)
163 		goto fail1;
164 
165 	onetouch->irq = usb_alloc_urb(0, GFP_KERNEL);
166 	if (!onetouch->irq)
167 		goto fail2;
168 
169 	onetouch->udev = udev;
170 	onetouch->dev = input_dev;
171 
172 	if (udev->manufacturer)
173 		strlcpy(onetouch->name, udev->manufacturer,
174 			sizeof(onetouch->name));
175 	if (udev->product) {
176 		if (udev->manufacturer)
177 			strlcat(onetouch->name, " ", sizeof(onetouch->name));
178 		strlcat(onetouch->name, udev->product, sizeof(onetouch->name));
179 	}
180 
181 	if (!strlen(onetouch->name))
182 		snprintf(onetouch->name, sizeof(onetouch->name),
183 			 "Maxtor Onetouch %04x:%04x",
184 			 le16_to_cpu(udev->descriptor.idVendor),
185 			 le16_to_cpu(udev->descriptor.idProduct));
186 
187 	usb_make_path(udev, onetouch->phys, sizeof(onetouch->phys));
188 	strlcat(onetouch->phys, "/input0", sizeof(onetouch->phys));
189 
190 	input_dev->name = onetouch->name;
191 	input_dev->phys = onetouch->phys;
192 	usb_to_input_id(udev, &input_dev->id);
193 	input_dev->cdev.dev = &udev->dev;
194 
195 	set_bit(EV_KEY, input_dev->evbit);
196 	set_bit(ONETOUCH_BUTTON, input_dev->keybit);
197 	clear_bit(0, input_dev->keybit);
198 
199 	input_dev->private = onetouch;
200 	input_dev->open = usb_onetouch_open;
201 	input_dev->close = usb_onetouch_close;
202 
203 	usb_fill_int_urb(onetouch->irq, udev, pipe, onetouch->data,
204 			 (maxp > 8 ? 8 : maxp),
205 			 usb_onetouch_irq, onetouch, endpoint->bInterval);
206 	onetouch->irq->transfer_dma = onetouch->data_dma;
207 	onetouch->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
208 
209 	ss->extra_destructor = onetouch_release_input;
210 	ss->extra = onetouch;
211 #ifdef CONFIG_PM
212 	ss->suspend_resume_hook = usb_onetouch_pm_hook;
213 #endif
214 
215 	input_register_device(onetouch->dev);
216 
217 	return 0;
218 
219  fail2:	usb_buffer_free(udev, ONETOUCH_PKT_LEN,
220 			onetouch->data, onetouch->data_dma);
221  fail1:	kfree(onetouch);
222 	input_free_device(input_dev);
223 	return -ENOMEM;
224 }
225 
226 void onetouch_release_input(void *onetouch_)
227 {
228 	struct usb_onetouch *onetouch = (struct usb_onetouch *) onetouch_;
229 
230 	if (onetouch) {
231 		usb_kill_urb(onetouch->irq);
232 		input_unregister_device(onetouch->dev);
233 		usb_free_urb(onetouch->irq);
234 		usb_buffer_free(onetouch->udev, ONETOUCH_PKT_LEN,
235 				onetouch->data, onetouch->data_dma);
236 	}
237 }
238