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