1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Surface2.0/SUR40/PixelSense input driver 4 * 5 * Copyright (c) 2014 by Florian 'floe' Echtler <floe@butterbrot.org> 6 * 7 * Derived from the USB Skeleton driver 1.1, 8 * Copyright (c) 2003 Greg Kroah-Hartman (greg@kroah.com) 9 * 10 * and from the Apple USB BCM5974 multitouch driver, 11 * Copyright (c) 2008 Henrik Rydberg (rydberg@euromail.se) 12 * 13 * and from the generic hid-multitouch driver, 14 * Copyright (c) 2010-2012 Stephane Chatty <chatty@enac.fr> 15 * 16 * and from the v4l2-pci-skeleton driver, 17 * Copyright (c) Copyright 2014 Cisco Systems, Inc. 18 */ 19 20 #include <linux/kernel.h> 21 #include <linux/errno.h> 22 #include <linux/delay.h> 23 #include <linux/init.h> 24 #include <linux/slab.h> 25 #include <linux/module.h> 26 #include <linux/completion.h> 27 #include <linux/uaccess.h> 28 #include <linux/usb.h> 29 #include <linux/printk.h> 30 #include <linux/input.h> 31 #include <linux/input/mt.h> 32 #include <linux/usb/input.h> 33 #include <linux/videodev2.h> 34 #include <media/v4l2-device.h> 35 #include <media/v4l2-dev.h> 36 #include <media/v4l2-ioctl.h> 37 #include <media/v4l2-ctrls.h> 38 #include <media/videobuf2-v4l2.h> 39 #include <media/videobuf2-dma-sg.h> 40 41 /* read 512 bytes from endpoint 0x86 -> get header + blobs */ 42 struct sur40_header { 43 44 __le16 type; /* always 0x0001 */ 45 __le16 count; /* count of blobs (if 0: continue prev. packet) */ 46 47 __le32 packet_id; /* unique ID for all packets in one frame */ 48 49 __le32 timestamp; /* milliseconds (inc. by 16 or 17 each frame) */ 50 __le32 unknown; /* "epoch?" always 02/03 00 00 00 */ 51 52 } __packed; 53 54 struct sur40_blob { 55 56 __le16 blob_id; 57 58 u8 action; /* 0x02 = enter/exit, 0x03 = update (?) */ 59 u8 type; /* bitmask (0x01 blob, 0x02 touch, 0x04 tag) */ 60 61 __le16 bb_pos_x; /* upper left corner of bounding box */ 62 __le16 bb_pos_y; 63 64 __le16 bb_size_x; /* size of bounding box */ 65 __le16 bb_size_y; 66 67 __le16 pos_x; /* finger tip position */ 68 __le16 pos_y; 69 70 __le16 ctr_x; /* centroid position */ 71 __le16 ctr_y; 72 73 __le16 axis_x; /* somehow related to major/minor axis, mostly: */ 74 __le16 axis_y; /* axis_x == bb_size_y && axis_y == bb_size_x */ 75 76 __le32 angle; /* orientation in radians relative to x axis - 77 actually an IEEE754 float, don't use in kernel */ 78 79 __le32 area; /* size in pixels/pressure (?) */ 80 81 u8 padding[24]; 82 83 __le32 tag_id; /* valid when type == 0x04 (SUR40_TAG) */ 84 __le32 unknown; 85 86 } __packed; 87 88 /* combined header/blob data */ 89 struct sur40_data { 90 struct sur40_header header; 91 struct sur40_blob blobs[]; 92 } __packed; 93 94 /* read 512 bytes from endpoint 0x82 -> get header below 95 * continue reading 16k blocks until header.size bytes read */ 96 struct sur40_image_header { 97 __le32 magic; /* "SUBF" */ 98 __le32 packet_id; 99 __le32 size; /* always 0x0007e900 = 960x540 */ 100 __le32 timestamp; /* milliseconds (increases by 16 or 17 each frame) */ 101 __le32 unknown; /* "epoch?" always 02/03 00 00 00 */ 102 } __packed; 103 104 /* version information */ 105 #define DRIVER_SHORT "sur40" 106 #define DRIVER_LONG "Samsung SUR40" 107 #define DRIVER_AUTHOR "Florian 'floe' Echtler <floe@butterbrot.org>" 108 #define DRIVER_DESC "Surface2.0/SUR40/PixelSense input driver" 109 110 /* vendor and device IDs */ 111 #define ID_MICROSOFT 0x045e 112 #define ID_SUR40 0x0775 113 114 /* sensor resolution */ 115 #define SENSOR_RES_X 1920 116 #define SENSOR_RES_Y 1080 117 118 /* touch data endpoint */ 119 #define TOUCH_ENDPOINT 0x86 120 121 /* video data endpoint */ 122 #define VIDEO_ENDPOINT 0x82 123 124 /* video header fields */ 125 #define VIDEO_HEADER_MAGIC 0x46425553 126 #define VIDEO_PACKET_SIZE 16384 127 128 /* polling interval (ms) */ 129 #define POLL_INTERVAL 1 130 131 /* maximum number of contacts FIXME: this is a guess? */ 132 #define MAX_CONTACTS 64 133 134 /* control commands */ 135 #define SUR40_GET_VERSION 0xb0 /* 12 bytes string */ 136 #define SUR40_ACCEL_CAPS 0xb3 /* 5 bytes */ 137 #define SUR40_SENSOR_CAPS 0xc1 /* 24 bytes */ 138 139 #define SUR40_POKE 0xc5 /* poke register byte */ 140 #define SUR40_PEEK 0xc4 /* 48 bytes registers */ 141 142 #define SUR40_GET_STATE 0xc5 /* 4 bytes state (?) */ 143 #define SUR40_GET_SENSORS 0xb1 /* 8 bytes sensors */ 144 145 #define SUR40_BLOB 0x01 146 #define SUR40_TOUCH 0x02 147 #define SUR40_TAG 0x04 148 149 /* video controls */ 150 #define SUR40_BRIGHTNESS_MAX 0xff 151 #define SUR40_BRIGHTNESS_MIN 0x00 152 #define SUR40_BRIGHTNESS_DEF 0xff 153 154 #define SUR40_CONTRAST_MAX 0x0f 155 #define SUR40_CONTRAST_MIN 0x00 156 #define SUR40_CONTRAST_DEF 0x0a 157 158 #define SUR40_GAIN_MAX 0x09 159 #define SUR40_GAIN_MIN 0x00 160 #define SUR40_GAIN_DEF 0x08 161 162 #define SUR40_BACKLIGHT_MAX 0x01 163 #define SUR40_BACKLIGHT_MIN 0x00 164 #define SUR40_BACKLIGHT_DEF 0x01 165 166 #define sur40_str(s) #s 167 #define SUR40_PARAM_RANGE(lo, hi) " (range " sur40_str(lo) "-" sur40_str(hi) ")" 168 169 /* module parameters */ 170 static uint brightness = SUR40_BRIGHTNESS_DEF; 171 module_param(brightness, uint, 0644); 172 MODULE_PARM_DESC(brightness, "set initial brightness" 173 SUR40_PARAM_RANGE(SUR40_BRIGHTNESS_MIN, SUR40_BRIGHTNESS_MAX)); 174 static uint contrast = SUR40_CONTRAST_DEF; 175 module_param(contrast, uint, 0644); 176 MODULE_PARM_DESC(contrast, "set initial contrast" 177 SUR40_PARAM_RANGE(SUR40_CONTRAST_MIN, SUR40_CONTRAST_MAX)); 178 static uint gain = SUR40_GAIN_DEF; 179 module_param(gain, uint, 0644); 180 MODULE_PARM_DESC(gain, "set initial gain" 181 SUR40_PARAM_RANGE(SUR40_GAIN_MIN, SUR40_GAIN_MAX)); 182 183 static const struct v4l2_pix_format sur40_pix_format[] = { 184 { 185 .pixelformat = V4L2_TCH_FMT_TU08, 186 .width = SENSOR_RES_X / 2, 187 .height = SENSOR_RES_Y / 2, 188 .field = V4L2_FIELD_NONE, 189 .colorspace = V4L2_COLORSPACE_RAW, 190 .bytesperline = SENSOR_RES_X / 2, 191 .sizeimage = (SENSOR_RES_X/2) * (SENSOR_RES_Y/2), 192 }, 193 { 194 .pixelformat = V4L2_PIX_FMT_GREY, 195 .width = SENSOR_RES_X / 2, 196 .height = SENSOR_RES_Y / 2, 197 .field = V4L2_FIELD_NONE, 198 .colorspace = V4L2_COLORSPACE_RAW, 199 .bytesperline = SENSOR_RES_X / 2, 200 .sizeimage = (SENSOR_RES_X/2) * (SENSOR_RES_Y/2), 201 } 202 }; 203 204 /* master device state */ 205 struct sur40_state { 206 207 struct usb_device *usbdev; 208 struct device *dev; 209 struct input_dev *input; 210 211 struct v4l2_device v4l2; 212 struct video_device vdev; 213 struct mutex lock; 214 struct v4l2_pix_format pix_fmt; 215 struct v4l2_ctrl_handler hdl; 216 217 struct vb2_queue queue; 218 struct list_head buf_list; 219 spinlock_t qlock; 220 int sequence; 221 222 struct sur40_data *bulk_in_buffer; 223 size_t bulk_in_size; 224 u8 bulk_in_epaddr; 225 u8 vsvideo; 226 227 char phys[64]; 228 }; 229 230 struct sur40_buffer { 231 struct vb2_v4l2_buffer vb; 232 struct list_head list; 233 }; 234 235 /* forward declarations */ 236 static const struct video_device sur40_video_device; 237 static const struct vb2_queue sur40_queue; 238 static void sur40_process_video(struct sur40_state *sur40); 239 static int sur40_s_ctrl(struct v4l2_ctrl *ctrl); 240 241 static const struct v4l2_ctrl_ops sur40_ctrl_ops = { 242 .s_ctrl = sur40_s_ctrl, 243 }; 244 245 /* 246 * Note: an earlier, non-public version of this driver used USB_RECIP_ENDPOINT 247 * here by mistake which is very likely to have corrupted the firmware EEPROM 248 * on two separate SUR40 devices. Thanks to Alan Stern who spotted this bug. 249 * Should you ever run into a similar problem, the background story to this 250 * incident and instructions on how to fix the corrupted EEPROM are available 251 * at https://floe.butterbrot.org/matrix/hacking/surface/brick.html 252 */ 253 254 /* command wrapper */ 255 static int sur40_command(struct sur40_state *dev, 256 u8 command, u16 index, void *buffer, u16 size) 257 { 258 return usb_control_msg(dev->usbdev, usb_rcvctrlpipe(dev->usbdev, 0), 259 command, 260 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN, 261 0x00, index, buffer, size, 1000); 262 } 263 264 /* poke a byte in the panel register space */ 265 static int sur40_poke(struct sur40_state *dev, u8 offset, u8 value) 266 { 267 int result; 268 u8 index = 0x96; // 0xae for permanent write 269 270 result = usb_control_msg(dev->usbdev, usb_sndctrlpipe(dev->usbdev, 0), 271 SUR40_POKE, USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT, 272 0x32, index, NULL, 0, 1000); 273 if (result < 0) 274 goto error; 275 msleep(5); 276 277 result = usb_control_msg(dev->usbdev, usb_sndctrlpipe(dev->usbdev, 0), 278 SUR40_POKE, USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT, 279 0x72, offset, NULL, 0, 1000); 280 if (result < 0) 281 goto error; 282 msleep(5); 283 284 result = usb_control_msg(dev->usbdev, usb_sndctrlpipe(dev->usbdev, 0), 285 SUR40_POKE, USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT, 286 0xb2, value, NULL, 0, 1000); 287 if (result < 0) 288 goto error; 289 msleep(5); 290 291 error: 292 return result; 293 } 294 295 static int sur40_set_preprocessor(struct sur40_state *dev, u8 value) 296 { 297 u8 setting_07[2] = { 0x01, 0x00 }; 298 u8 setting_17[2] = { 0x85, 0x80 }; 299 int result; 300 301 if (value > 1) 302 return -ERANGE; 303 304 result = usb_control_msg(dev->usbdev, usb_sndctrlpipe(dev->usbdev, 0), 305 SUR40_POKE, USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT, 306 0x07, setting_07[value], NULL, 0, 1000); 307 if (result < 0) 308 goto error; 309 msleep(5); 310 311 result = usb_control_msg(dev->usbdev, usb_sndctrlpipe(dev->usbdev, 0), 312 SUR40_POKE, USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT, 313 0x17, setting_17[value], NULL, 0, 1000); 314 if (result < 0) 315 goto error; 316 msleep(5); 317 318 error: 319 return result; 320 } 321 322 static void sur40_set_vsvideo(struct sur40_state *handle, u8 value) 323 { 324 int i; 325 326 for (i = 0; i < 4; i++) 327 sur40_poke(handle, 0x1c+i, value); 328 handle->vsvideo = value; 329 } 330 331 static void sur40_set_irlevel(struct sur40_state *handle, u8 value) 332 { 333 int i; 334 335 for (i = 0; i < 8; i++) 336 sur40_poke(handle, 0x08+(2*i), value); 337 } 338 339 /* Initialization routine, called from sur40_open */ 340 static int sur40_init(struct sur40_state *dev) 341 { 342 int result; 343 u8 *buffer; 344 345 buffer = kmalloc(24, GFP_KERNEL); 346 if (!buffer) { 347 result = -ENOMEM; 348 goto error; 349 } 350 351 /* stupidly replay the original MS driver init sequence */ 352 result = sur40_command(dev, SUR40_GET_VERSION, 0x00, buffer, 12); 353 if (result < 0) 354 goto error; 355 356 result = sur40_command(dev, SUR40_GET_VERSION, 0x01, buffer, 12); 357 if (result < 0) 358 goto error; 359 360 result = sur40_command(dev, SUR40_GET_VERSION, 0x02, buffer, 12); 361 if (result < 0) 362 goto error; 363 364 result = sur40_command(dev, SUR40_SENSOR_CAPS, 0x00, buffer, 24); 365 if (result < 0) 366 goto error; 367 368 result = sur40_command(dev, SUR40_ACCEL_CAPS, 0x00, buffer, 5); 369 if (result < 0) 370 goto error; 371 372 result = sur40_command(dev, SUR40_GET_VERSION, 0x03, buffer, 12); 373 if (result < 0) 374 goto error; 375 376 result = 0; 377 378 /* 379 * Discard the result buffer - no known data inside except 380 * some version strings, maybe extract these sometime... 381 */ 382 error: 383 kfree(buffer); 384 return result; 385 } 386 387 /* 388 * Callback routines from input_dev 389 */ 390 391 /* Enable the device, polling will now start. */ 392 static int sur40_open(struct input_dev *input) 393 { 394 struct sur40_state *sur40 = input_get_drvdata(input); 395 396 dev_dbg(sur40->dev, "open\n"); 397 return sur40_init(sur40); 398 } 399 400 /* Disable device, polling has stopped. */ 401 static void sur40_close(struct input_dev *input) 402 { 403 struct sur40_state *sur40 = input_get_drvdata(input); 404 405 dev_dbg(sur40->dev, "close\n"); 406 /* 407 * There is no known way to stop the device, so we simply 408 * stop polling. 409 */ 410 } 411 412 /* 413 * This function is called when a whole contact has been processed, 414 * so that it can assign it to a slot and store the data there. 415 */ 416 static void sur40_report_blob(struct sur40_blob *blob, struct input_dev *input) 417 { 418 int wide, major, minor; 419 int bb_size_x, bb_size_y, pos_x, pos_y, ctr_x, ctr_y, slotnum; 420 421 if (blob->type != SUR40_TOUCH) 422 return; 423 424 slotnum = input_mt_get_slot_by_key(input, blob->blob_id); 425 if (slotnum < 0 || slotnum >= MAX_CONTACTS) 426 return; 427 428 bb_size_x = le16_to_cpu(blob->bb_size_x); 429 bb_size_y = le16_to_cpu(blob->bb_size_y); 430 431 pos_x = le16_to_cpu(blob->pos_x); 432 pos_y = le16_to_cpu(blob->pos_y); 433 434 ctr_x = le16_to_cpu(blob->ctr_x); 435 ctr_y = le16_to_cpu(blob->ctr_y); 436 437 input_mt_slot(input, slotnum); 438 input_mt_report_slot_state(input, MT_TOOL_FINGER, 1); 439 wide = (bb_size_x > bb_size_y); 440 major = max(bb_size_x, bb_size_y); 441 minor = min(bb_size_x, bb_size_y); 442 443 input_report_abs(input, ABS_MT_POSITION_X, pos_x); 444 input_report_abs(input, ABS_MT_POSITION_Y, pos_y); 445 input_report_abs(input, ABS_MT_TOOL_X, ctr_x); 446 input_report_abs(input, ABS_MT_TOOL_Y, ctr_y); 447 448 /* TODO: use a better orientation measure */ 449 input_report_abs(input, ABS_MT_ORIENTATION, wide); 450 input_report_abs(input, ABS_MT_TOUCH_MAJOR, major); 451 input_report_abs(input, ABS_MT_TOUCH_MINOR, minor); 452 } 453 454 /* core function: poll for new input data */ 455 static void sur40_poll(struct input_dev *input) 456 { 457 struct sur40_state *sur40 = input_get_drvdata(input); 458 int result, bulk_read, need_blobs, packet_blobs, i; 459 u32 uninitialized_var(packet_id); 460 461 struct sur40_header *header = &sur40->bulk_in_buffer->header; 462 struct sur40_blob *inblob = &sur40->bulk_in_buffer->blobs[0]; 463 464 dev_dbg(sur40->dev, "poll\n"); 465 466 need_blobs = -1; 467 468 do { 469 470 /* perform a blocking bulk read to get data from the device */ 471 result = usb_bulk_msg(sur40->usbdev, 472 usb_rcvbulkpipe(sur40->usbdev, sur40->bulk_in_epaddr), 473 sur40->bulk_in_buffer, sur40->bulk_in_size, 474 &bulk_read, 1000); 475 476 dev_dbg(sur40->dev, "received %d bytes\n", bulk_read); 477 478 if (result < 0) { 479 dev_err(sur40->dev, "error in usb_bulk_read\n"); 480 return; 481 } 482 483 result = bulk_read - sizeof(struct sur40_header); 484 485 if (result % sizeof(struct sur40_blob) != 0) { 486 dev_err(sur40->dev, "transfer size mismatch\n"); 487 return; 488 } 489 490 /* first packet? */ 491 if (need_blobs == -1) { 492 need_blobs = le16_to_cpu(header->count); 493 dev_dbg(sur40->dev, "need %d blobs\n", need_blobs); 494 packet_id = le32_to_cpu(header->packet_id); 495 } 496 497 /* 498 * Sanity check. when video data is also being retrieved, the 499 * packet ID will usually increase in the middle of a series 500 * instead of at the end. However, the data is still consistent, 501 * so the packet ID is probably just valid for the first packet 502 * in a series. 503 504 if (packet_id != le32_to_cpu(header->packet_id)) 505 dev_dbg(sur40->dev, "packet ID mismatch\n"); 506 */ 507 508 packet_blobs = result / sizeof(struct sur40_blob); 509 dev_dbg(sur40->dev, "received %d blobs\n", packet_blobs); 510 511 /* packets always contain at least 4 blobs, even if empty */ 512 if (packet_blobs > need_blobs) 513 packet_blobs = need_blobs; 514 515 for (i = 0; i < packet_blobs; i++) { 516 need_blobs--; 517 dev_dbg(sur40->dev, "processing blob\n"); 518 sur40_report_blob(&(inblob[i]), input); 519 } 520 521 } while (need_blobs > 0); 522 523 input_mt_sync_frame(input); 524 input_sync(input); 525 526 sur40_process_video(sur40); 527 } 528 529 /* deal with video data */ 530 static void sur40_process_video(struct sur40_state *sur40) 531 { 532 533 struct sur40_image_header *img = (void *)(sur40->bulk_in_buffer); 534 struct sur40_buffer *new_buf; 535 struct usb_sg_request sgr; 536 struct sg_table *sgt; 537 int result, bulk_read; 538 539 if (!vb2_start_streaming_called(&sur40->queue)) 540 return; 541 542 /* get a new buffer from the list */ 543 spin_lock(&sur40->qlock); 544 if (list_empty(&sur40->buf_list)) { 545 dev_dbg(sur40->dev, "buffer queue empty\n"); 546 spin_unlock(&sur40->qlock); 547 return; 548 } 549 new_buf = list_entry(sur40->buf_list.next, struct sur40_buffer, list); 550 list_del(&new_buf->list); 551 spin_unlock(&sur40->qlock); 552 553 dev_dbg(sur40->dev, "buffer acquired\n"); 554 555 /* retrieve data via bulk read */ 556 result = usb_bulk_msg(sur40->usbdev, 557 usb_rcvbulkpipe(sur40->usbdev, VIDEO_ENDPOINT), 558 sur40->bulk_in_buffer, sur40->bulk_in_size, 559 &bulk_read, 1000); 560 561 if (result < 0) { 562 dev_err(sur40->dev, "error in usb_bulk_read\n"); 563 goto err_poll; 564 } 565 566 if (bulk_read != sizeof(struct sur40_image_header)) { 567 dev_err(sur40->dev, "received %d bytes (%zd expected)\n", 568 bulk_read, sizeof(struct sur40_image_header)); 569 goto err_poll; 570 } 571 572 if (le32_to_cpu(img->magic) != VIDEO_HEADER_MAGIC) { 573 dev_err(sur40->dev, "image magic mismatch\n"); 574 goto err_poll; 575 } 576 577 if (le32_to_cpu(img->size) != sur40->pix_fmt.sizeimage) { 578 dev_err(sur40->dev, "image size mismatch\n"); 579 goto err_poll; 580 } 581 582 dev_dbg(sur40->dev, "header acquired\n"); 583 584 sgt = vb2_dma_sg_plane_desc(&new_buf->vb.vb2_buf, 0); 585 586 result = usb_sg_init(&sgr, sur40->usbdev, 587 usb_rcvbulkpipe(sur40->usbdev, VIDEO_ENDPOINT), 0, 588 sgt->sgl, sgt->nents, sur40->pix_fmt.sizeimage, 0); 589 if (result < 0) { 590 dev_err(sur40->dev, "error %d in usb_sg_init\n", result); 591 goto err_poll; 592 } 593 594 usb_sg_wait(&sgr); 595 if (sgr.status < 0) { 596 dev_err(sur40->dev, "error %d in usb_sg_wait\n", sgr.status); 597 goto err_poll; 598 } 599 600 dev_dbg(sur40->dev, "image acquired\n"); 601 602 /* return error if streaming was stopped in the meantime */ 603 if (sur40->sequence == -1) 604 return; 605 606 /* mark as finished */ 607 new_buf->vb.vb2_buf.timestamp = ktime_get_ns(); 608 new_buf->vb.sequence = sur40->sequence++; 609 new_buf->vb.field = V4L2_FIELD_NONE; 610 vb2_buffer_done(&new_buf->vb.vb2_buf, VB2_BUF_STATE_DONE); 611 dev_dbg(sur40->dev, "buffer marked done\n"); 612 return; 613 614 err_poll: 615 vb2_buffer_done(&new_buf->vb.vb2_buf, VB2_BUF_STATE_ERROR); 616 } 617 618 /* Initialize input device parameters. */ 619 static int sur40_input_setup_events(struct input_dev *input_dev) 620 { 621 int error; 622 623 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 624 0, SENSOR_RES_X, 0, 0); 625 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 626 0, SENSOR_RES_Y, 0, 0); 627 628 input_set_abs_params(input_dev, ABS_MT_TOOL_X, 629 0, SENSOR_RES_X, 0, 0); 630 input_set_abs_params(input_dev, ABS_MT_TOOL_Y, 631 0, SENSOR_RES_Y, 0, 0); 632 633 /* max value unknown, but major/minor axis 634 * can never be larger than screen */ 635 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR, 636 0, SENSOR_RES_X, 0, 0); 637 input_set_abs_params(input_dev, ABS_MT_TOUCH_MINOR, 638 0, SENSOR_RES_Y, 0, 0); 639 640 input_set_abs_params(input_dev, ABS_MT_ORIENTATION, 0, 1, 0, 0); 641 642 error = input_mt_init_slots(input_dev, MAX_CONTACTS, 643 INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED); 644 if (error) { 645 dev_err(input_dev->dev.parent, "failed to set up slots\n"); 646 return error; 647 } 648 649 return 0; 650 } 651 652 /* Check candidate USB interface. */ 653 static int sur40_probe(struct usb_interface *interface, 654 const struct usb_device_id *id) 655 { 656 struct usb_device *usbdev = interface_to_usbdev(interface); 657 struct sur40_state *sur40; 658 struct usb_host_interface *iface_desc; 659 struct usb_endpoint_descriptor *endpoint; 660 struct input_dev *input; 661 int error; 662 663 /* Check if we really have the right interface. */ 664 iface_desc = interface->cur_altsetting; 665 if (iface_desc->desc.bInterfaceClass != 0xFF) 666 return -ENODEV; 667 668 if (iface_desc->desc.bNumEndpoints < 5) 669 return -ENODEV; 670 671 /* Use endpoint #4 (0x86). */ 672 endpoint = &iface_desc->endpoint[4].desc; 673 if (endpoint->bEndpointAddress != TOUCH_ENDPOINT) 674 return -ENODEV; 675 676 /* Allocate memory for our device state and initialize it. */ 677 sur40 = kzalloc(sizeof(struct sur40_state), GFP_KERNEL); 678 if (!sur40) 679 return -ENOMEM; 680 681 input = input_allocate_device(); 682 if (!input) { 683 error = -ENOMEM; 684 goto err_free_dev; 685 } 686 687 /* initialize locks/lists */ 688 INIT_LIST_HEAD(&sur40->buf_list); 689 spin_lock_init(&sur40->qlock); 690 mutex_init(&sur40->lock); 691 692 /* Set up regular input device structure */ 693 input->name = DRIVER_LONG; 694 usb_to_input_id(usbdev, &input->id); 695 usb_make_path(usbdev, sur40->phys, sizeof(sur40->phys)); 696 strlcat(sur40->phys, "/input0", sizeof(sur40->phys)); 697 input->phys = sur40->phys; 698 input->dev.parent = &interface->dev; 699 700 input->open = sur40_open; 701 input->close = sur40_close; 702 703 error = sur40_input_setup_events(input); 704 if (error) 705 goto err_free_input; 706 707 input_set_drvdata(input, sur40); 708 error = input_setup_polling(input, sur40_poll); 709 if (error) { 710 dev_err(&interface->dev, "failed to set up polling"); 711 goto err_free_input; 712 } 713 714 input_set_poll_interval(input, POLL_INTERVAL); 715 716 sur40->usbdev = usbdev; 717 sur40->dev = &interface->dev; 718 sur40->input = input; 719 720 /* use the bulk-in endpoint tested above */ 721 sur40->bulk_in_size = usb_endpoint_maxp(endpoint); 722 sur40->bulk_in_epaddr = endpoint->bEndpointAddress; 723 sur40->bulk_in_buffer = kmalloc(sur40->bulk_in_size, GFP_KERNEL); 724 if (!sur40->bulk_in_buffer) { 725 dev_err(&interface->dev, "Unable to allocate input buffer."); 726 error = -ENOMEM; 727 goto err_free_input; 728 } 729 730 /* register the polled input device */ 731 error = input_register_device(input); 732 if (error) { 733 dev_err(&interface->dev, 734 "Unable to register polled input device."); 735 goto err_free_buffer; 736 } 737 738 /* register the video master device */ 739 snprintf(sur40->v4l2.name, sizeof(sur40->v4l2.name), "%s", DRIVER_LONG); 740 error = v4l2_device_register(sur40->dev, &sur40->v4l2); 741 if (error) { 742 dev_err(&interface->dev, 743 "Unable to register video master device."); 744 goto err_unreg_v4l2; 745 } 746 747 /* initialize the lock and subdevice */ 748 sur40->queue = sur40_queue; 749 sur40->queue.drv_priv = sur40; 750 sur40->queue.lock = &sur40->lock; 751 sur40->queue.dev = sur40->dev; 752 753 /* initialize the queue */ 754 error = vb2_queue_init(&sur40->queue); 755 if (error) 756 goto err_unreg_v4l2; 757 758 sur40->pix_fmt = sur40_pix_format[0]; 759 sur40->vdev = sur40_video_device; 760 sur40->vdev.v4l2_dev = &sur40->v4l2; 761 sur40->vdev.lock = &sur40->lock; 762 sur40->vdev.queue = &sur40->queue; 763 video_set_drvdata(&sur40->vdev, sur40); 764 765 /* initialize the control handler for 4 controls */ 766 v4l2_ctrl_handler_init(&sur40->hdl, 4); 767 sur40->v4l2.ctrl_handler = &sur40->hdl; 768 sur40->vsvideo = (SUR40_CONTRAST_DEF << 4) | SUR40_GAIN_DEF; 769 770 v4l2_ctrl_new_std(&sur40->hdl, &sur40_ctrl_ops, V4L2_CID_BRIGHTNESS, 771 SUR40_BRIGHTNESS_MIN, SUR40_BRIGHTNESS_MAX, 1, clamp(brightness, 772 (uint)SUR40_BRIGHTNESS_MIN, (uint)SUR40_BRIGHTNESS_MAX)); 773 774 v4l2_ctrl_new_std(&sur40->hdl, &sur40_ctrl_ops, V4L2_CID_CONTRAST, 775 SUR40_CONTRAST_MIN, SUR40_CONTRAST_MAX, 1, clamp(contrast, 776 (uint)SUR40_CONTRAST_MIN, (uint)SUR40_CONTRAST_MAX)); 777 778 v4l2_ctrl_new_std(&sur40->hdl, &sur40_ctrl_ops, V4L2_CID_GAIN, 779 SUR40_GAIN_MIN, SUR40_GAIN_MAX, 1, clamp(gain, 780 (uint)SUR40_GAIN_MIN, (uint)SUR40_GAIN_MAX)); 781 782 v4l2_ctrl_new_std(&sur40->hdl, &sur40_ctrl_ops, 783 V4L2_CID_BACKLIGHT_COMPENSATION, SUR40_BACKLIGHT_MIN, 784 SUR40_BACKLIGHT_MAX, 1, SUR40_BACKLIGHT_DEF); 785 786 v4l2_ctrl_handler_setup(&sur40->hdl); 787 788 if (sur40->hdl.error) { 789 dev_err(&interface->dev, 790 "Unable to register video controls."); 791 v4l2_ctrl_handler_free(&sur40->hdl); 792 goto err_unreg_v4l2; 793 } 794 795 error = video_register_device(&sur40->vdev, VFL_TYPE_TOUCH, -1); 796 if (error) { 797 dev_err(&interface->dev, 798 "Unable to register video subdevice."); 799 goto err_unreg_video; 800 } 801 802 /* we can register the device now, as it is ready */ 803 usb_set_intfdata(interface, sur40); 804 dev_dbg(&interface->dev, "%s is now attached\n", DRIVER_DESC); 805 806 return 0; 807 808 err_unreg_video: 809 video_unregister_device(&sur40->vdev); 810 err_unreg_v4l2: 811 v4l2_device_unregister(&sur40->v4l2); 812 err_free_buffer: 813 kfree(sur40->bulk_in_buffer); 814 err_free_input: 815 input_free_device(input); 816 err_free_dev: 817 kfree(sur40); 818 819 return error; 820 } 821 822 /* Unregister device & clean up. */ 823 static void sur40_disconnect(struct usb_interface *interface) 824 { 825 struct sur40_state *sur40 = usb_get_intfdata(interface); 826 827 v4l2_ctrl_handler_free(&sur40->hdl); 828 video_unregister_device(&sur40->vdev); 829 v4l2_device_unregister(&sur40->v4l2); 830 831 input_unregister_device(sur40->input); 832 kfree(sur40->bulk_in_buffer); 833 kfree(sur40); 834 835 usb_set_intfdata(interface, NULL); 836 dev_dbg(&interface->dev, "%s is now disconnected\n", DRIVER_DESC); 837 } 838 839 /* 840 * Setup the constraints of the queue: besides setting the number of planes 841 * per buffer and the size and allocation context of each plane, it also 842 * checks if sufficient buffers have been allocated. Usually 3 is a good 843 * minimum number: many DMA engines need a minimum of 2 buffers in the 844 * queue and you need to have another available for userspace processing. 845 */ 846 static int sur40_queue_setup(struct vb2_queue *q, 847 unsigned int *nbuffers, unsigned int *nplanes, 848 unsigned int sizes[], struct device *alloc_devs[]) 849 { 850 struct sur40_state *sur40 = vb2_get_drv_priv(q); 851 852 if (q->num_buffers + *nbuffers < 3) 853 *nbuffers = 3 - q->num_buffers; 854 855 if (*nplanes) 856 return sizes[0] < sur40->pix_fmt.sizeimage ? -EINVAL : 0; 857 858 *nplanes = 1; 859 sizes[0] = sur40->pix_fmt.sizeimage; 860 861 return 0; 862 } 863 864 /* 865 * Prepare the buffer for queueing to the DMA engine: check and set the 866 * payload size. 867 */ 868 static int sur40_buffer_prepare(struct vb2_buffer *vb) 869 { 870 struct sur40_state *sur40 = vb2_get_drv_priv(vb->vb2_queue); 871 unsigned long size = sur40->pix_fmt.sizeimage; 872 873 if (vb2_plane_size(vb, 0) < size) { 874 dev_err(&sur40->usbdev->dev, "buffer too small (%lu < %lu)\n", 875 vb2_plane_size(vb, 0), size); 876 return -EINVAL; 877 } 878 879 vb2_set_plane_payload(vb, 0, size); 880 return 0; 881 } 882 883 /* 884 * Queue this buffer to the DMA engine. 885 */ 886 static void sur40_buffer_queue(struct vb2_buffer *vb) 887 { 888 struct sur40_state *sur40 = vb2_get_drv_priv(vb->vb2_queue); 889 struct sur40_buffer *buf = (struct sur40_buffer *)vb; 890 891 spin_lock(&sur40->qlock); 892 list_add_tail(&buf->list, &sur40->buf_list); 893 spin_unlock(&sur40->qlock); 894 } 895 896 static void return_all_buffers(struct sur40_state *sur40, 897 enum vb2_buffer_state state) 898 { 899 struct sur40_buffer *buf, *node; 900 901 spin_lock(&sur40->qlock); 902 list_for_each_entry_safe(buf, node, &sur40->buf_list, list) { 903 vb2_buffer_done(&buf->vb.vb2_buf, state); 904 list_del(&buf->list); 905 } 906 spin_unlock(&sur40->qlock); 907 } 908 909 /* 910 * Start streaming. First check if the minimum number of buffers have been 911 * queued. If not, then return -ENOBUFS and the vb2 framework will call 912 * this function again the next time a buffer has been queued until enough 913 * buffers are available to actually start the DMA engine. 914 */ 915 static int sur40_start_streaming(struct vb2_queue *vq, unsigned int count) 916 { 917 struct sur40_state *sur40 = vb2_get_drv_priv(vq); 918 919 sur40->sequence = 0; 920 return 0; 921 } 922 923 /* 924 * Stop the DMA engine. Any remaining buffers in the DMA queue are dequeued 925 * and passed on to the vb2 framework marked as STATE_ERROR. 926 */ 927 static void sur40_stop_streaming(struct vb2_queue *vq) 928 { 929 struct sur40_state *sur40 = vb2_get_drv_priv(vq); 930 vb2_wait_for_all_buffers(vq); 931 sur40->sequence = -1; 932 933 /* Release all active buffers */ 934 return_all_buffers(sur40, VB2_BUF_STATE_ERROR); 935 } 936 937 /* V4L ioctl */ 938 static int sur40_vidioc_querycap(struct file *file, void *priv, 939 struct v4l2_capability *cap) 940 { 941 struct sur40_state *sur40 = video_drvdata(file); 942 943 strlcpy(cap->driver, DRIVER_SHORT, sizeof(cap->driver)); 944 strlcpy(cap->card, DRIVER_LONG, sizeof(cap->card)); 945 usb_make_path(sur40->usbdev, cap->bus_info, sizeof(cap->bus_info)); 946 return 0; 947 } 948 949 static int sur40_vidioc_enum_input(struct file *file, void *priv, 950 struct v4l2_input *i) 951 { 952 if (i->index != 0) 953 return -EINVAL; 954 i->type = V4L2_INPUT_TYPE_TOUCH; 955 i->std = V4L2_STD_UNKNOWN; 956 strlcpy(i->name, "In-Cell Sensor", sizeof(i->name)); 957 i->capabilities = 0; 958 return 0; 959 } 960 961 static int sur40_vidioc_s_input(struct file *file, void *priv, unsigned int i) 962 { 963 return (i == 0) ? 0 : -EINVAL; 964 } 965 966 static int sur40_vidioc_g_input(struct file *file, void *priv, unsigned int *i) 967 { 968 *i = 0; 969 return 0; 970 } 971 972 static int sur40_vidioc_try_fmt(struct file *file, void *priv, 973 struct v4l2_format *f) 974 { 975 switch (f->fmt.pix.pixelformat) { 976 case V4L2_PIX_FMT_GREY: 977 f->fmt.pix = sur40_pix_format[1]; 978 break; 979 980 default: 981 f->fmt.pix = sur40_pix_format[0]; 982 break; 983 } 984 985 return 0; 986 } 987 988 static int sur40_vidioc_s_fmt(struct file *file, void *priv, 989 struct v4l2_format *f) 990 { 991 struct sur40_state *sur40 = video_drvdata(file); 992 993 switch (f->fmt.pix.pixelformat) { 994 case V4L2_PIX_FMT_GREY: 995 sur40->pix_fmt = sur40_pix_format[1]; 996 break; 997 998 default: 999 sur40->pix_fmt = sur40_pix_format[0]; 1000 break; 1001 } 1002 1003 f->fmt.pix = sur40->pix_fmt; 1004 return 0; 1005 } 1006 1007 static int sur40_vidioc_g_fmt(struct file *file, void *priv, 1008 struct v4l2_format *f) 1009 { 1010 struct sur40_state *sur40 = video_drvdata(file); 1011 1012 f->fmt.pix = sur40->pix_fmt; 1013 return 0; 1014 } 1015 1016 static int sur40_s_ctrl(struct v4l2_ctrl *ctrl) 1017 { 1018 struct sur40_state *sur40 = container_of(ctrl->handler, 1019 struct sur40_state, hdl); 1020 u8 value = sur40->vsvideo; 1021 1022 switch (ctrl->id) { 1023 case V4L2_CID_BRIGHTNESS: 1024 sur40_set_irlevel(sur40, ctrl->val); 1025 break; 1026 case V4L2_CID_CONTRAST: 1027 value = (value & 0x0f) | (ctrl->val << 4); 1028 sur40_set_vsvideo(sur40, value); 1029 break; 1030 case V4L2_CID_GAIN: 1031 value = (value & 0xf0) | (ctrl->val); 1032 sur40_set_vsvideo(sur40, value); 1033 break; 1034 case V4L2_CID_BACKLIGHT_COMPENSATION: 1035 sur40_set_preprocessor(sur40, ctrl->val); 1036 break; 1037 } 1038 return 0; 1039 } 1040 1041 static int sur40_ioctl_parm(struct file *file, void *priv, 1042 struct v4l2_streamparm *p) 1043 { 1044 if (p->type != V4L2_BUF_TYPE_VIDEO_CAPTURE) 1045 return -EINVAL; 1046 1047 p->parm.capture.capability = V4L2_CAP_TIMEPERFRAME; 1048 p->parm.capture.timeperframe.numerator = 1; 1049 p->parm.capture.timeperframe.denominator = 60; 1050 p->parm.capture.readbuffers = 3; 1051 return 0; 1052 } 1053 1054 static int sur40_vidioc_enum_fmt(struct file *file, void *priv, 1055 struct v4l2_fmtdesc *f) 1056 { 1057 if (f->index >= ARRAY_SIZE(sur40_pix_format)) 1058 return -EINVAL; 1059 1060 f->pixelformat = sur40_pix_format[f->index].pixelformat; 1061 f->flags = 0; 1062 return 0; 1063 } 1064 1065 static int sur40_vidioc_enum_framesizes(struct file *file, void *priv, 1066 struct v4l2_frmsizeenum *f) 1067 { 1068 struct sur40_state *sur40 = video_drvdata(file); 1069 1070 if ((f->index != 0) || ((f->pixel_format != V4L2_TCH_FMT_TU08) 1071 && (f->pixel_format != V4L2_PIX_FMT_GREY))) 1072 return -EINVAL; 1073 1074 f->type = V4L2_FRMSIZE_TYPE_DISCRETE; 1075 f->discrete.width = sur40->pix_fmt.width; 1076 f->discrete.height = sur40->pix_fmt.height; 1077 return 0; 1078 } 1079 1080 static int sur40_vidioc_enum_frameintervals(struct file *file, void *priv, 1081 struct v4l2_frmivalenum *f) 1082 { 1083 struct sur40_state *sur40 = video_drvdata(file); 1084 1085 if ((f->index > 0) || ((f->pixel_format != V4L2_TCH_FMT_TU08) 1086 && (f->pixel_format != V4L2_PIX_FMT_GREY)) 1087 || (f->width != sur40->pix_fmt.width) 1088 || (f->height != sur40->pix_fmt.height)) 1089 return -EINVAL; 1090 1091 f->type = V4L2_FRMIVAL_TYPE_DISCRETE; 1092 f->discrete.denominator = 60; 1093 f->discrete.numerator = 1; 1094 return 0; 1095 } 1096 1097 1098 static const struct usb_device_id sur40_table[] = { 1099 { USB_DEVICE(ID_MICROSOFT, ID_SUR40) }, /* Samsung SUR40 */ 1100 { } /* terminating null entry */ 1101 }; 1102 MODULE_DEVICE_TABLE(usb, sur40_table); 1103 1104 /* V4L2 structures */ 1105 static const struct vb2_ops sur40_queue_ops = { 1106 .queue_setup = sur40_queue_setup, 1107 .buf_prepare = sur40_buffer_prepare, 1108 .buf_queue = sur40_buffer_queue, 1109 .start_streaming = sur40_start_streaming, 1110 .stop_streaming = sur40_stop_streaming, 1111 .wait_prepare = vb2_ops_wait_prepare, 1112 .wait_finish = vb2_ops_wait_finish, 1113 }; 1114 1115 static const struct vb2_queue sur40_queue = { 1116 .type = V4L2_BUF_TYPE_VIDEO_CAPTURE, 1117 /* 1118 * VB2_USERPTR in currently not enabled: passing a user pointer to 1119 * dma-sg will result in segment sizes that are not a multiple of 1120 * 512 bytes, which is required by the host controller. 1121 */ 1122 .io_modes = VB2_MMAP | VB2_READ | VB2_DMABUF, 1123 .buf_struct_size = sizeof(struct sur40_buffer), 1124 .ops = &sur40_queue_ops, 1125 .mem_ops = &vb2_dma_sg_memops, 1126 .timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC, 1127 .min_buffers_needed = 3, 1128 }; 1129 1130 static const struct v4l2_file_operations sur40_video_fops = { 1131 .owner = THIS_MODULE, 1132 .open = v4l2_fh_open, 1133 .release = vb2_fop_release, 1134 .unlocked_ioctl = video_ioctl2, 1135 .read = vb2_fop_read, 1136 .mmap = vb2_fop_mmap, 1137 .poll = vb2_fop_poll, 1138 }; 1139 1140 static const struct v4l2_ioctl_ops sur40_video_ioctl_ops = { 1141 1142 .vidioc_querycap = sur40_vidioc_querycap, 1143 1144 .vidioc_enum_fmt_vid_cap = sur40_vidioc_enum_fmt, 1145 .vidioc_try_fmt_vid_cap = sur40_vidioc_try_fmt, 1146 .vidioc_s_fmt_vid_cap = sur40_vidioc_s_fmt, 1147 .vidioc_g_fmt_vid_cap = sur40_vidioc_g_fmt, 1148 1149 .vidioc_enum_framesizes = sur40_vidioc_enum_framesizes, 1150 .vidioc_enum_frameintervals = sur40_vidioc_enum_frameintervals, 1151 1152 .vidioc_g_parm = sur40_ioctl_parm, 1153 .vidioc_s_parm = sur40_ioctl_parm, 1154 1155 .vidioc_enum_input = sur40_vidioc_enum_input, 1156 .vidioc_g_input = sur40_vidioc_g_input, 1157 .vidioc_s_input = sur40_vidioc_s_input, 1158 1159 .vidioc_reqbufs = vb2_ioctl_reqbufs, 1160 .vidioc_create_bufs = vb2_ioctl_create_bufs, 1161 .vidioc_querybuf = vb2_ioctl_querybuf, 1162 .vidioc_qbuf = vb2_ioctl_qbuf, 1163 .vidioc_dqbuf = vb2_ioctl_dqbuf, 1164 .vidioc_expbuf = vb2_ioctl_expbuf, 1165 1166 .vidioc_streamon = vb2_ioctl_streamon, 1167 .vidioc_streamoff = vb2_ioctl_streamoff, 1168 }; 1169 1170 static const struct video_device sur40_video_device = { 1171 .name = DRIVER_LONG, 1172 .fops = &sur40_video_fops, 1173 .ioctl_ops = &sur40_video_ioctl_ops, 1174 .release = video_device_release_empty, 1175 .device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH | 1176 V4L2_CAP_READWRITE | V4L2_CAP_STREAMING, 1177 }; 1178 1179 /* USB-specific object needed to register this driver with the USB subsystem. */ 1180 static struct usb_driver sur40_driver = { 1181 .name = DRIVER_SHORT, 1182 .probe = sur40_probe, 1183 .disconnect = sur40_disconnect, 1184 .id_table = sur40_table, 1185 }; 1186 1187 module_usb_driver(sur40_driver); 1188 1189 MODULE_AUTHOR(DRIVER_AUTHOR); 1190 MODULE_DESCRIPTION(DRIVER_DESC); 1191 MODULE_LICENSE("GPL"); 1192