Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Support for the Maxtor OneTouch USB hard drive's button
4 *
5 * Current development and maintenance by:
6 * Copyright (c) 2005 Nick Sillik <n.sillik@temple.edu>
7 *
8 * Initial work by:
9 * Copyright (c) 2003 Erik Thyren <erth7411@student.uu.se>
10 *
11 * Based on usbmouse.c (Vojtech Pavlik) and xpad.c (Marko Friedemann)
12 *
13 */
14#include <linux/kernel.h>
15#include <linux/input.h>
16#include <linux/slab.h>
17#include <linux/module.h>
18#include <linux/usb/input.h>
19#include "usb.h"
20#include "debug.h"
21#include "scsiglue.h"
22
23#define DRV_NAME "ums-onetouch"
24
25MODULE_DESCRIPTION("Maxtor USB OneTouch hard drive button driver");
26MODULE_AUTHOR("Nick Sillik <n.sillik@temple.edu>");
27MODULE_LICENSE("GPL");
28MODULE_IMPORT_NS(USB_STORAGE);
29
30#define ONETOUCH_PKT_LEN 0x02
31#define ONETOUCH_BUTTON KEY_PROG1
32
33static int onetouch_connect_input(struct us_data *ss);
34static void onetouch_release_input(void *onetouch_);
35
36struct usb_onetouch {
37 char name[128];
38 char phys[64];
39 struct input_dev *dev; /* input device interface */
40 struct usb_device *udev; /* usb device */
41
42 struct urb *irq; /* urb for interrupt in report */
43 unsigned char *data; /* input data */
44 dma_addr_t data_dma;
45 unsigned int is_open:1;
46};
47
48
49/*
50 * The table of devices
51 */
52#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
53 vendorName, productName, useProtocol, useTransport, \
54 initFunction, flags) \
55{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
56 .driver_info = (flags) }
57
58static struct usb_device_id onetouch_usb_ids[] = {
59# include "unusual_onetouch.h"
60 { } /* Terminating entry */
61};
62MODULE_DEVICE_TABLE(usb, onetouch_usb_ids);
63
64#undef UNUSUAL_DEV
65
66/*
67 * The flags table
68 */
69#define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
70 vendor_name, product_name, use_protocol, use_transport, \
71 init_function, Flags) \
72{ \
73 .vendorName = vendor_name, \
74 .productName = product_name, \
75 .useProtocol = use_protocol, \
76 .useTransport = use_transport, \
77 .initFunction = init_function, \
78}
79
80static struct us_unusual_dev onetouch_unusual_dev_list[] = {
81# include "unusual_onetouch.h"
82 { } /* Terminating entry */
83};
84
85#undef UNUSUAL_DEV
86
87
88static void usb_onetouch_irq(struct urb *urb)
89{
90 struct usb_onetouch *onetouch = urb->context;
91 signed char *data = onetouch->data;
92 struct input_dev *dev = onetouch->dev;
93 int status = urb->status;
94 int retval;
95
96 switch (status) {
97 case 0: /* success */
98 break;
99 case -ECONNRESET: /* unlink */
100 case -ENOENT:
101 case -ESHUTDOWN:
102 return;
103 /* -EPIPE: should clear the halt */
104 default: /* error */
105 goto resubmit;
106 }
107
108 input_report_key(dev, ONETOUCH_BUTTON, data[0] & 0x02);
109 input_sync(dev);
110
111resubmit:
112 retval = usb_submit_urb (urb, GFP_ATOMIC);
113 if (retval)
114 dev_err(&dev->dev, "can't resubmit intr, %s-%s/input0, "
115 "retval %d\n", onetouch->udev->bus->bus_name,
116 onetouch->udev->devpath, retval);
117}
118
119static int usb_onetouch_open(struct input_dev *dev)
120{
121 struct usb_onetouch *onetouch = input_get_drvdata(dev);
122
123 onetouch->is_open = 1;
124 onetouch->irq->dev = onetouch->udev;
125 if (usb_submit_urb(onetouch->irq, GFP_KERNEL)) {
126 dev_err(&dev->dev, "usb_submit_urb failed\n");
127 return -EIO;
128 }
129
130 return 0;
131}
132
133static void usb_onetouch_close(struct input_dev *dev)
134{
135 struct usb_onetouch *onetouch = input_get_drvdata(dev);
136
137 usb_kill_urb(onetouch->irq);
138 onetouch->is_open = 0;
139}
140
141#ifdef CONFIG_PM
142static void usb_onetouch_pm_hook(struct us_data *us, int action)
143{
144 struct usb_onetouch *onetouch = (struct usb_onetouch *) us->extra;
145
146 if (onetouch->is_open) {
147 switch (action) {
148 case US_SUSPEND:
149 usb_kill_urb(onetouch->irq);
150 break;
151 case US_RESUME:
152 if (usb_submit_urb(onetouch->irq, GFP_NOIO) != 0)
153 dev_err(&onetouch->irq->dev->dev,
154 "usb_submit_urb failed\n");
155 break;
156 default:
157 break;
158 }
159 }
160}
161#endif /* CONFIG_PM */
162
163static int onetouch_connect_input(struct us_data *ss)
164{
165 struct usb_device *udev = ss->pusb_dev;
166 struct usb_host_interface *interface;
167 struct usb_endpoint_descriptor *endpoint;
168 struct usb_onetouch *onetouch;
169 struct input_dev *input_dev;
170 int pipe, maxp;
171 int error = -ENOMEM;
172
173 interface = ss->pusb_intf->cur_altsetting;
174
175 if (interface->desc.bNumEndpoints != 3)
176 return -ENODEV;
177
178 endpoint = &interface->endpoint[2].desc;
179 if (!usb_endpoint_is_int_in(endpoint))
180 return -ENODEV;
181
182 pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
183 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
184 maxp = min(maxp, ONETOUCH_PKT_LEN);
185
186 onetouch = kzalloc(sizeof(struct usb_onetouch), GFP_KERNEL);
187 input_dev = input_allocate_device();
188 if (!onetouch || !input_dev)
189 goto fail1;
190
191 onetouch->data = usb_alloc_coherent(udev, ONETOUCH_PKT_LEN,
192 GFP_KERNEL, &onetouch->data_dma);
193 if (!onetouch->data)
194 goto fail1;
195
196 onetouch->irq = usb_alloc_urb(0, GFP_KERNEL);
197 if (!onetouch->irq)
198 goto fail2;
199
200 onetouch->udev = udev;
201 onetouch->dev = input_dev;
202
203 if (udev->manufacturer)
204 strlcpy(onetouch->name, udev->manufacturer,
205 sizeof(onetouch->name));
206 if (udev->product) {
207 if (udev->manufacturer)
208 strlcat(onetouch->name, " ", sizeof(onetouch->name));
209 strlcat(onetouch->name, udev->product, sizeof(onetouch->name));
210 }
211
212 if (!strlen(onetouch->name))
213 snprintf(onetouch->name, sizeof(onetouch->name),
214 "Maxtor Onetouch %04x:%04x",
215 le16_to_cpu(udev->descriptor.idVendor),
216 le16_to_cpu(udev->descriptor.idProduct));
217
218 usb_make_path(udev, onetouch->phys, sizeof(onetouch->phys));
219 strlcat(onetouch->phys, "/input0", sizeof(onetouch->phys));
220
221 input_dev->name = onetouch->name;
222 input_dev->phys = onetouch->phys;
223 usb_to_input_id(udev, &input_dev->id);
224 input_dev->dev.parent = &udev->dev;
225
226 set_bit(EV_KEY, input_dev->evbit);
227 set_bit(ONETOUCH_BUTTON, input_dev->keybit);
228 clear_bit(0, input_dev->keybit);
229
230 input_set_drvdata(input_dev, onetouch);
231
232 input_dev->open = usb_onetouch_open;
233 input_dev->close = usb_onetouch_close;
234
235 usb_fill_int_urb(onetouch->irq, udev, pipe, onetouch->data, maxp,
236 usb_onetouch_irq, onetouch, endpoint->bInterval);
237 onetouch->irq->transfer_dma = onetouch->data_dma;
238 onetouch->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
239
240 ss->extra_destructor = onetouch_release_input;
241 ss->extra = onetouch;
242#ifdef CONFIG_PM
243 ss->suspend_resume_hook = usb_onetouch_pm_hook;
244#endif
245
246 error = input_register_device(onetouch->dev);
247 if (error)
248 goto fail3;
249
250 return 0;
251
252 fail3: usb_free_urb(onetouch->irq);
253 fail2: usb_free_coherent(udev, ONETOUCH_PKT_LEN,
254 onetouch->data, onetouch->data_dma);
255 fail1: kfree(onetouch);
256 input_free_device(input_dev);
257 return error;
258}
259
260static void onetouch_release_input(void *onetouch_)
261{
262 struct usb_onetouch *onetouch = (struct usb_onetouch *) onetouch_;
263
264 if (onetouch) {
265 usb_kill_urb(onetouch->irq);
266 input_unregister_device(onetouch->dev);
267 usb_free_urb(onetouch->irq);
268 usb_free_coherent(onetouch->udev, ONETOUCH_PKT_LEN,
269 onetouch->data, onetouch->data_dma);
270 }
271}
272
273static struct scsi_host_template onetouch_host_template;
274
275static int onetouch_probe(struct usb_interface *intf,
276 const struct usb_device_id *id)
277{
278 struct us_data *us;
279 int result;
280
281 result = usb_stor_probe1(&us, intf, id,
282 (id - onetouch_usb_ids) + onetouch_unusual_dev_list,
283 &onetouch_host_template);
284 if (result)
285 return result;
286
287 /* Use default transport and protocol */
288
289 result = usb_stor_probe2(us);
290 return result;
291}
292
293static struct usb_driver onetouch_driver = {
294 .name = DRV_NAME,
295 .probe = onetouch_probe,
296 .disconnect = usb_stor_disconnect,
297 .suspend = usb_stor_suspend,
298 .resume = usb_stor_resume,
299 .reset_resume = usb_stor_reset_resume,
300 .pre_reset = usb_stor_pre_reset,
301 .post_reset = usb_stor_post_reset,
302 .id_table = onetouch_usb_ids,
303 .soft_unbind = 1,
304 .no_dynamic_id = 1,
305};
306
307module_usb_stor_driver(onetouch_driver, onetouch_host_template, DRV_NAME);
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 "debug.h"
39
40MODULE_DESCRIPTION("Maxtor USB OneTouch hard drive button driver");
41MODULE_AUTHOR("Nick Sillik <n.sillik@temple.edu>");
42MODULE_LICENSE("GPL");
43
44#define ONETOUCH_PKT_LEN 0x02
45#define ONETOUCH_BUTTON KEY_PROG1
46
47static int onetouch_connect_input(struct us_data *ss);
48static void onetouch_release_input(void *onetouch_);
49
50struct usb_onetouch {
51 char name[128];
52 char phys[64];
53 struct input_dev *dev; /* input device interface */
54 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;
59 unsigned int is_open:1;
60};
61
62
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
102static void usb_onetouch_irq(struct urb *urb)
103{
104 struct usb_onetouch *onetouch = urb->context;
105 signed char *data = onetouch->data;
106 struct input_dev *dev = onetouch->dev;
107 int status = urb->status;
108 int retval;
109
110 switch (status) {
111 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
122 input_report_key(dev, ONETOUCH_BUTTON, data[0] & 0x02);
123 input_sync(dev);
124
125resubmit:
126 retval = usb_submit_urb (urb, GFP_ATOMIC);
127 if (retval)
128 dev_err(&dev->dev, "can't resubmit intr, %s-%s/input0, "
129 "retval %d\n", onetouch->udev->bus->bus_name,
130 onetouch->udev->devpath, retval);
131}
132
133static int usb_onetouch_open(struct input_dev *dev)
134{
135 struct usb_onetouch *onetouch = input_get_drvdata(dev);
136
137 onetouch->is_open = 1;
138 onetouch->irq->dev = onetouch->udev;
139 if (usb_submit_urb(onetouch->irq, GFP_KERNEL)) {
140 dev_err(&dev->dev, "usb_submit_urb failed\n");
141 return -EIO;
142 }
143
144 return 0;
145}
146
147static void usb_onetouch_close(struct input_dev *dev)
148{
149 struct usb_onetouch *onetouch = input_get_drvdata(dev);
150
151 usb_kill_urb(onetouch->irq);
152 onetouch->is_open = 0;
153}
154
155#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_NOIO) != 0)
167 dev_err(&onetouch->irq->dev->dev,
168 "usb_submit_urb failed\n");
169 break;
170 default:
171 break;
172 }
173 }
174}
175#endif /* CONFIG_PM */
176
177static int onetouch_connect_input(struct us_data *ss)
178{
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;
183 struct input_dev *input_dev;
184 int pipe, maxp;
185 int error = -ENOMEM;
186
187 interface = ss->pusb_intf->cur_altsetting;
188
189 if (interface->desc.bNumEndpoints != 3)
190 return -ENODEV;
191
192 endpoint = &interface->endpoint[2].desc;
193 if (!usb_endpoint_is_int_in(endpoint))
194 return -ENODEV;
195
196 pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
197 maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
198
199 onetouch = kzalloc(sizeof(struct usb_onetouch), GFP_KERNEL);
200 input_dev = input_allocate_device();
201 if (!onetouch || !input_dev)
202 goto fail1;
203
204 onetouch->data = usb_alloc_coherent(udev, ONETOUCH_PKT_LEN,
205 GFP_KERNEL, &onetouch->data_dma);
206 if (!onetouch->data)
207 goto fail1;
208
209 onetouch->irq = usb_alloc_urb(0, GFP_KERNEL);
210 if (!onetouch->irq)
211 goto fail2;
212
213 onetouch->udev = udev;
214 onetouch->dev = input_dev;
215
216 if (udev->manufacturer)
217 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
225 if (!strlen(onetouch->name))
226 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);
237 input_dev->dev.parent = &udev->dev;
238
239 set_bit(EV_KEY, input_dev->evbit);
240 set_bit(ONETOUCH_BUTTON, input_dev->keybit);
241 clear_bit(0, input_dev->keybit);
242
243 input_set_drvdata(input_dev, onetouch);
244
245 input_dev->open = usb_onetouch_open;
246 input_dev->close = usb_onetouch_close;
247
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;
256#ifdef CONFIG_PM
257 ss->suspend_resume_hook = usb_onetouch_pm_hook;
258#endif
259
260 error = input_register_device(onetouch->dev);
261 if (error)
262 goto fail3;
263
264 return 0;
265
266 fail3: usb_free_urb(onetouch->irq);
267 fail2: usb_free_coherent(udev, ONETOUCH_PKT_LEN,
268 onetouch->data, onetouch->data_dma);
269 fail1: kfree(onetouch);
270 input_free_device(input_dev);
271 return error;
272}
273
274static void onetouch_release_input(void *onetouch_)
275{
276 struct usb_onetouch *onetouch = (struct usb_onetouch *) onetouch_;
277
278 if (onetouch) {
279 usb_kill_urb(onetouch->irq);
280 input_unregister_device(onetouch->dev);
281 usb_free_urb(onetouch->irq);
282 usb_free_coherent(onetouch->udev, ONETOUCH_PKT_LEN,
283 onetouch->data, onetouch->data_dma);
284 }
285}
286
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);