Input: pegasus_notetaker - handle usb control msg errors
[deliverable/linux.git] / drivers / input / tablet / pegasus_notetaker.c
CommitLineData
1afca2b6
MK
1/*
2 * Pegasus Mobile Notetaker Pen input tablet driver
3 *
4 * Copyright (c) 2016 Martin Kepplinger <martink@posteo.de>
5 */
6
7/*
8 * request packet (control endpoint):
9 * |-------------------------------------|
10 * | Report ID | Nr of bytes | command |
11 * | (1 byte) | (1 byte) | (n bytes) |
12 * |-------------------------------------|
13 * | 0x02 | n | |
14 * |-------------------------------------|
15 *
16 * data packet after set xy mode command, 0x80 0xb5 0x02 0x01
17 * and pen is in range:
18 *
19 * byte byte name value (bits)
20 * --------------------------------------------
21 * 0 status 0 1 0 0 0 0 X X
22 * 1 color 0 0 0 0 H 0 S T
23 * 2 X low
24 * 3 X high
25 * 4 Y low
26 * 5 Y high
27 *
28 * X X battery state:
29 * no state reported 0x00
30 * battery low 0x01
31 * battery good 0x02
32 *
33 * H Hovering
34 * S Switch 1 (pen button)
35 * T Tip
36 */
37
38#include <linux/kernel.h>
39#include <linux/module.h>
40#include <linux/input.h>
41#include <linux/usb/input.h>
42#include <linux/slab.h>
43
44/* USB HID defines */
45#define USB_REQ_GET_REPORT 0x01
46#define USB_REQ_SET_REPORT 0x09
47
48#define USB_VENDOR_ID_PEGASUSTECH 0x0e20
49#define USB_DEVICE_ID_PEGASUS_NOTETAKER_EN100 0x0101
50
51/* device specific defines */
52#define NOTETAKER_REPORT_ID 0x02
53#define NOTETAKER_SET_CMD 0x80
54#define NOTETAKER_SET_MODE 0xb5
55
56#define NOTETAKER_LED_MOUSE 0x02
57#define PEN_MODE_XY 0x01
58
59#define SPECIAL_COMMAND 0x80
60#define BUTTON_PRESSED 0xb5
61#define COMMAND_VERSION 0xa9
62
63/* in xy data packet */
64#define BATTERY_NO_REPORT 0x40
65#define BATTERY_LOW 0x41
66#define BATTERY_GOOD 0x42
67#define PEN_BUTTON_PRESSED BIT(1)
68#define PEN_TIP BIT(0)
69
70struct pegasus {
71 unsigned char *data;
72 u8 data_len;
73 dma_addr_t data_dma;
74 struct input_dev *dev;
75 struct usb_device *usbdev;
76 struct usb_interface *intf;
77 struct urb *irq;
78 char name[128];
79 char phys[64];
80 struct work_struct init;
81};
82
168c1398 83static int pegasus_control_msg(struct pegasus *pegasus, u8 *data, int len)
1afca2b6
MK
84{
85 const int sizeof_buf = len + 2;
86 int result;
168c1398 87 int error;
1afca2b6
MK
88 u8 *cmd_buf;
89
90 cmd_buf = kmalloc(sizeof_buf, GFP_KERNEL);
91 if (!cmd_buf)
168c1398 92 return -ENOMEM;
1afca2b6
MK
93
94 cmd_buf[0] = NOTETAKER_REPORT_ID;
95 cmd_buf[1] = len;
96 memcpy(cmd_buf + 2, data, len);
97
98 result = usb_control_msg(pegasus->usbdev,
99 usb_sndctrlpipe(pegasus->usbdev, 0),
100 USB_REQ_SET_REPORT,
101 USB_TYPE_VENDOR | USB_DIR_OUT,
102 0, 0, cmd_buf, sizeof_buf,
103 USB_CTRL_SET_TIMEOUT);
104
1afca2b6 105 kfree(cmd_buf);
168c1398
MK
106
107 if (unlikely(result != sizeof_buf)) {
108 error = result < 0 ? result : -EIO;
109 dev_err(&pegasus->usbdev->dev, "control msg error: %d\n",
110 error);
111 return error;
112 }
113
114 return 0;
1afca2b6
MK
115}
116
168c1398 117static int pegasus_set_mode(struct pegasus *pegasus, u8 mode, u8 led)
1afca2b6
MK
118{
119 u8 cmd[] = { NOTETAKER_SET_CMD, NOTETAKER_SET_MODE, led, mode };
120
168c1398 121 return pegasus_control_msg(pegasus, cmd, sizeof(cmd));
1afca2b6
MK
122}
123
124static void pegasus_parse_packet(struct pegasus *pegasus)
125{
126 unsigned char *data = pegasus->data;
127 struct input_dev *dev = pegasus->dev;
128 u16 x, y;
129
130 switch (data[0]) {
131 case SPECIAL_COMMAND:
132 /* device button pressed */
133 if (data[1] == BUTTON_PRESSED)
134 schedule_work(&pegasus->init);
135
136 break;
137
138 /* xy data */
139 case BATTERY_LOW:
140 dev_warn_once(&dev->dev, "Pen battery low\n");
141 /* fall through */
142
143 case BATTERY_NO_REPORT:
144 case BATTERY_GOOD:
145 x = le16_to_cpup((__le16 *)&data[2]);
146 y = le16_to_cpup((__le16 *)&data[4]);
147
148 /* pen-up event */
149 if (x == 0 && y == 0)
150 break;
151
152 input_report_key(dev, BTN_TOUCH, data[1] & PEN_TIP);
153 input_report_key(dev, BTN_RIGHT, data[1] & PEN_BUTTON_PRESSED);
154 input_report_key(dev, BTN_TOOL_PEN, 1);
155 input_report_abs(dev, ABS_X, (s16)x);
156 input_report_abs(dev, ABS_Y, y);
157
158 input_sync(dev);
159 break;
160
161 default:
162 dev_warn_once(&pegasus->usbdev->dev,
163 "unknown answer from device\n");
164 }
165}
166
167static void pegasus_irq(struct urb *urb)
168{
169 struct pegasus *pegasus = urb->context;
170 struct usb_device *dev = pegasus->usbdev;
171 int retval;
172
173 switch (urb->status) {
174 case 0:
175 pegasus_parse_packet(pegasus);
176 usb_mark_last_busy(pegasus->usbdev);
177 break;
178
179 case -ECONNRESET:
180 case -ENOENT:
181 case -ESHUTDOWN:
182 dev_err(&dev->dev, "%s - urb shutting down with status: %d",
183 __func__, urb->status);
184 return;
185
186 default:
187 dev_err(&dev->dev, "%s - nonzero urb status received: %d",
188 __func__, urb->status);
189 break;
190 }
191
192 retval = usb_submit_urb(urb, GFP_ATOMIC);
193 if (retval)
194 dev_err(&dev->dev, "%s - usb_submit_urb failed with result %d",
195 __func__, retval);
196}
197
198static void pegasus_init(struct work_struct *work)
199{
200 struct pegasus *pegasus = container_of(work, struct pegasus, init);
168c1398 201 int error;
1afca2b6 202
168c1398
MK
203 error = pegasus_set_mode(pegasus, PEN_MODE_XY, NOTETAKER_LED_MOUSE);
204 if (error)
205 dev_err(&pegasus->usbdev->dev, "pegasus_set_mode error: %d\n",
206 error);
1afca2b6
MK
207}
208
209static int pegasus_open(struct input_dev *dev)
210{
211 struct pegasus *pegasus = input_get_drvdata(dev);
212 int retval;
213
214 retval = usb_autopm_get_interface(pegasus->intf);
215 if (retval)
216 return retval;
217
218 pegasus->irq->dev = pegasus->usbdev;
219 if (usb_submit_urb(pegasus->irq, GFP_KERNEL))
220 retval = -EIO;
221
168c1398 222 retval = pegasus_set_mode(pegasus, PEN_MODE_XY, NOTETAKER_LED_MOUSE);
1afca2b6
MK
223
224 usb_autopm_put_interface(pegasus->intf);
225
226 return retval;
227}
228
229static void pegasus_close(struct input_dev *dev)
230{
231 struct pegasus *pegasus = input_get_drvdata(dev);
232 int autopm_error;
233
234 autopm_error = usb_autopm_get_interface(pegasus->intf);
235 usb_kill_urb(pegasus->irq);
236 cancel_work_sync(&pegasus->init);
237
238 if (!autopm_error)
239 usb_autopm_put_interface(pegasus->intf);
240}
241
242static int pegasus_probe(struct usb_interface *intf,
243 const struct usb_device_id *id)
244{
245 struct usb_device *dev = interface_to_usbdev(intf);
246 struct usb_endpoint_descriptor *endpoint;
247 struct pegasus *pegasus;
248 struct input_dev *input_dev;
249 int error;
250 int pipe;
251
252 /* We control interface 0 */
253 if (intf->cur_altsetting->desc.bInterfaceNumber >= 1)
254 return -ENODEV;
255
256 /* Sanity check that the device has an endpoint */
257 if (intf->altsetting[0].desc.bNumEndpoints < 1) {
258 dev_err(&intf->dev, "Invalid number of endpoints\n");
259 return -EINVAL;
260 }
261
262 endpoint = &intf->cur_altsetting->endpoint[0].desc;
263
264 pegasus = kzalloc(sizeof(*pegasus), GFP_KERNEL);
265 input_dev = input_allocate_device();
266 if (!pegasus || !input_dev) {
267 error = -ENOMEM;
268 goto err_free_mem;
269 }
270
271 pegasus->usbdev = dev;
272 pegasus->dev = input_dev;
273 pegasus->intf = intf;
274
275 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
276 pegasus->data_len = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
277
278 pegasus->data = usb_alloc_coherent(dev, pegasus->data_len, GFP_KERNEL,
279 &pegasus->data_dma);
280 if (!pegasus->data) {
281 error = -ENOMEM;
282 goto err_free_mem;
283 }
284
285 pegasus->irq = usb_alloc_urb(0, GFP_KERNEL);
286 if (!pegasus->irq) {
287 error = -ENOMEM;
288 goto err_free_dma;
289 }
290
291 usb_fill_int_urb(pegasus->irq, dev, pipe,
292 pegasus->data, pegasus->data_len,
293 pegasus_irq, pegasus, endpoint->bInterval);
294
295 pegasus->irq->transfer_dma = pegasus->data_dma;
296 pegasus->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
297
298 if (dev->manufacturer)
299 strlcpy(pegasus->name, dev->manufacturer,
300 sizeof(pegasus->name));
301
302 if (dev->product) {
303 if (dev->manufacturer)
304 strlcat(pegasus->name, " ", sizeof(pegasus->name));
305 strlcat(pegasus->name, dev->product, sizeof(pegasus->name));
306 }
307
308 if (!strlen(pegasus->name))
309 snprintf(pegasus->name, sizeof(pegasus->name),
310 "USB Pegasus Device %04x:%04x",
311 le16_to_cpu(dev->descriptor.idVendor),
312 le16_to_cpu(dev->descriptor.idProduct));
313
314 usb_make_path(dev, pegasus->phys, sizeof(pegasus->phys));
315 strlcat(pegasus->phys, "/input0", sizeof(pegasus->phys));
316
317 INIT_WORK(&pegasus->init, pegasus_init);
318
319 usb_set_intfdata(intf, pegasus);
320
321 input_dev->name = pegasus->name;
322 input_dev->phys = pegasus->phys;
323 usb_to_input_id(dev, &input_dev->id);
324 input_dev->dev.parent = &intf->dev;
325
326 input_set_drvdata(input_dev, pegasus);
327
328 input_dev->open = pegasus_open;
329 input_dev->close = pegasus_close;
330
331 __set_bit(EV_ABS, input_dev->evbit);
332 __set_bit(EV_KEY, input_dev->evbit);
333
334 __set_bit(ABS_X, input_dev->absbit);
335 __set_bit(ABS_Y, input_dev->absbit);
336
337 __set_bit(BTN_TOUCH, input_dev->keybit);
338 __set_bit(BTN_RIGHT, input_dev->keybit);
339 __set_bit(BTN_TOOL_PEN, input_dev->keybit);
340
341 __set_bit(INPUT_PROP_DIRECT, input_dev->propbit);
342 __set_bit(INPUT_PROP_POINTER, input_dev->propbit);
343
344 input_set_abs_params(input_dev, ABS_X, -1500, 1500, 8, 0);
345 input_set_abs_params(input_dev, ABS_Y, 1600, 3000, 8, 0);
346
347 error = input_register_device(pegasus->dev);
348 if (error)
349 goto err_free_urb;
350
351 return 0;
352
353err_free_urb:
354 usb_free_urb(pegasus->irq);
355err_free_dma:
356 usb_free_coherent(dev, pegasus->data_len,
357 pegasus->data, pegasus->data_dma);
358err_free_mem:
359 input_free_device(input_dev);
360 kfree(pegasus);
361 usb_set_intfdata(intf, NULL);
362
363 return error;
364}
365
366static void pegasus_disconnect(struct usb_interface *intf)
367{
368 struct pegasus *pegasus = usb_get_intfdata(intf);
369
370 input_unregister_device(pegasus->dev);
371
372 usb_free_urb(pegasus->irq);
373 usb_free_coherent(interface_to_usbdev(intf),
374 pegasus->data_len, pegasus->data,
375 pegasus->data_dma);
376
377 kfree(pegasus);
378 usb_set_intfdata(intf, NULL);
379}
380
381static int pegasus_suspend(struct usb_interface *intf, pm_message_t message)
382{
383 struct pegasus *pegasus = usb_get_intfdata(intf);
384
385 mutex_lock(&pegasus->dev->mutex);
386 usb_kill_urb(pegasus->irq);
387 mutex_unlock(&pegasus->dev->mutex);
388
389 return 0;
390}
391
392static int pegasus_resume(struct usb_interface *intf)
393{
394 struct pegasus *pegasus = usb_get_intfdata(intf);
395 int retval = 0;
396
397 mutex_lock(&pegasus->dev->mutex);
398 if (pegasus->dev->users && usb_submit_urb(pegasus->irq, GFP_NOIO) < 0)
399 retval = -EIO;
400 mutex_unlock(&pegasus->dev->mutex);
401
402 return retval;
403}
404
405static int pegasus_reset_resume(struct usb_interface *intf)
406{
407 return pegasus_resume(intf);
408}
409
410static const struct usb_device_id pegasus_ids[] = {
411 { USB_DEVICE(USB_VENDOR_ID_PEGASUSTECH,
412 USB_DEVICE_ID_PEGASUS_NOTETAKER_EN100) },
413 { }
414};
415MODULE_DEVICE_TABLE(usb, pegasus_ids);
416
417static struct usb_driver pegasus_driver = {
418 .name = "pegasus_notetaker",
419 .probe = pegasus_probe,
420 .disconnect = pegasus_disconnect,
421 .suspend = pegasus_suspend,
422 .resume = pegasus_resume,
423 .reset_resume = pegasus_reset_resume,
424 .id_table = pegasus_ids,
425 .supports_autosuspend = 1,
426};
427
428module_usb_driver(pegasus_driver);
429
430MODULE_AUTHOR("Martin Kepplinger <martink@posteo.de>");
431MODULE_DESCRIPTION("Pegasus Mobile Notetaker Pen tablet driver");
432MODULE_LICENSE("GPL");
This page took 0.210728 seconds and 5 git commands to generate.