1 /* 2 * AirSpy SDR driver 3 * 4 * Copyright (C) 2014 Antti Palosaari <crope@iki.fi> 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2 of the License, or 9 * (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 */ 16 17 #include <linux/module.h> 18 #include <linux/slab.h> 19 #include <linux/usb.h> 20 #include <media/v4l2-device.h> 21 #include <media/v4l2-ioctl.h> 22 #include <media/v4l2-ctrls.h> 23 #include <media/v4l2-event.h> 24 #include <media/videobuf2-v4l2.h> 25 #include <media/videobuf2-vmalloc.h> 26 27 /* AirSpy USB API commands (from AirSpy Library) */ 28 enum { 29 CMD_INVALID = 0x00, 30 CMD_RECEIVER_MODE = 0x01, 31 CMD_SI5351C_WRITE = 0x02, 32 CMD_SI5351C_READ = 0x03, 33 CMD_R820T_WRITE = 0x04, 34 CMD_R820T_READ = 0x05, 35 CMD_SPIFLASH_ERASE = 0x06, 36 CMD_SPIFLASH_WRITE = 0x07, 37 CMD_SPIFLASH_READ = 0x08, 38 CMD_BOARD_ID_READ = 0x09, 39 CMD_VERSION_STRING_READ = 0x0a, 40 CMD_BOARD_PARTID_SERIALNO_READ = 0x0b, 41 CMD_SET_SAMPLE_RATE = 0x0c, 42 CMD_SET_FREQ = 0x0d, 43 CMD_SET_LNA_GAIN = 0x0e, 44 CMD_SET_MIXER_GAIN = 0x0f, 45 CMD_SET_VGA_GAIN = 0x10, 46 CMD_SET_LNA_AGC = 0x11, 47 CMD_SET_MIXER_AGC = 0x12, 48 CMD_SET_PACKING = 0x13, 49 }; 50 51 /* 52 * bEndpointAddress 0x81 EP 1 IN 53 * Transfer Type Bulk 54 * wMaxPacketSize 0x0200 1x 512 bytes 55 */ 56 #define MAX_BULK_BUFS (6) 57 #define BULK_BUFFER_SIZE (128 * 512) 58 59 static const struct v4l2_frequency_band bands[] = { 60 { 61 .tuner = 0, 62 .type = V4L2_TUNER_ADC, 63 .index = 0, 64 .capability = V4L2_TUNER_CAP_1HZ | V4L2_TUNER_CAP_FREQ_BANDS, 65 .rangelow = 20000000, 66 .rangehigh = 20000000, 67 }, 68 }; 69 70 static const struct v4l2_frequency_band bands_rf[] = { 71 { 72 .tuner = 1, 73 .type = V4L2_TUNER_RF, 74 .index = 0, 75 .capability = V4L2_TUNER_CAP_1HZ | V4L2_TUNER_CAP_FREQ_BANDS, 76 .rangelow = 24000000, 77 .rangehigh = 1750000000, 78 }, 79 }; 80 81 /* stream formats */ 82 struct airspy_format { 83 char *name; 84 u32 pixelformat; 85 u32 buffersize; 86 }; 87 88 /* format descriptions for capture and preview */ 89 static struct airspy_format formats[] = { 90 { 91 .name = "Real U12LE", 92 .pixelformat = V4L2_SDR_FMT_RU12LE, 93 .buffersize = BULK_BUFFER_SIZE, 94 }, 95 }; 96 97 static const unsigned int NUM_FORMATS = ARRAY_SIZE(formats); 98 99 /* intermediate buffers with raw data from the USB device */ 100 struct airspy_frame_buf { 101 /* common v4l buffer stuff -- must be first */ 102 struct vb2_v4l2_buffer vb; 103 struct list_head list; 104 }; 105 106 struct airspy { 107 #define POWER_ON 1 108 #define USB_STATE_URB_BUF 2 109 unsigned long flags; 110 111 struct device *dev; 112 struct usb_device *udev; 113 struct video_device vdev; 114 struct v4l2_device v4l2_dev; 115 116 /* videobuf2 queue and queued buffers list */ 117 struct vb2_queue vb_queue; 118 struct list_head queued_bufs; 119 spinlock_t queued_bufs_lock; /* Protects queued_bufs */ 120 unsigned sequence; /* Buffer sequence counter */ 121 unsigned int vb_full; /* vb is full and packets dropped */ 122 123 /* Note if taking both locks v4l2_lock must always be locked first! */ 124 struct mutex v4l2_lock; /* Protects everything else */ 125 struct mutex vb_queue_lock; /* Protects vb_queue and capt_file */ 126 127 struct urb *urb_list[MAX_BULK_BUFS]; 128 int buf_num; 129 unsigned long buf_size; 130 u8 *buf_list[MAX_BULK_BUFS]; 131 dma_addr_t dma_addr[MAX_BULK_BUFS]; 132 int urbs_initialized; 133 int urbs_submitted; 134 135 /* USB control message buffer */ 136 #define BUF_SIZE 128 137 u8 buf[BUF_SIZE]; 138 139 /* Current configuration */ 140 unsigned int f_adc; 141 unsigned int f_rf; 142 u32 pixelformat; 143 u32 buffersize; 144 145 /* Controls */ 146 struct v4l2_ctrl_handler hdl; 147 struct v4l2_ctrl *lna_gain_auto; 148 struct v4l2_ctrl *lna_gain; 149 struct v4l2_ctrl *mixer_gain_auto; 150 struct v4l2_ctrl *mixer_gain; 151 struct v4l2_ctrl *if_gain; 152 153 /* Sample rate calc */ 154 unsigned long jiffies_next; 155 unsigned int sample; 156 unsigned int sample_measured; 157 }; 158 159 #define airspy_dbg_usb_control_msg(_dev, _r, _t, _v, _i, _b, _l) { \ 160 char *_direction; \ 161 if (_t & USB_DIR_IN) \ 162 _direction = "<<<"; \ 163 else \ 164 _direction = ">>>"; \ 165 dev_dbg(_dev, "%02x %02x %02x %02x %02x %02x %02x %02x %s %*ph\n", \ 166 _t, _r, _v & 0xff, _v >> 8, _i & 0xff, _i >> 8, \ 167 _l & 0xff, _l >> 8, _direction, _l, _b); \ 168 } 169 170 /* execute firmware command */ 171 static int airspy_ctrl_msg(struct airspy *s, u8 request, u16 value, u16 index, 172 u8 *data, u16 size) 173 { 174 int ret; 175 unsigned int pipe; 176 u8 requesttype; 177 178 switch (request) { 179 case CMD_RECEIVER_MODE: 180 case CMD_SET_FREQ: 181 pipe = usb_sndctrlpipe(s->udev, 0); 182 requesttype = (USB_TYPE_VENDOR | USB_DIR_OUT); 183 break; 184 case CMD_BOARD_ID_READ: 185 case CMD_VERSION_STRING_READ: 186 case CMD_BOARD_PARTID_SERIALNO_READ: 187 case CMD_SET_LNA_GAIN: 188 case CMD_SET_MIXER_GAIN: 189 case CMD_SET_VGA_GAIN: 190 case CMD_SET_LNA_AGC: 191 case CMD_SET_MIXER_AGC: 192 pipe = usb_rcvctrlpipe(s->udev, 0); 193 requesttype = (USB_TYPE_VENDOR | USB_DIR_IN); 194 break; 195 default: 196 dev_err(s->dev, "Unknown command %02x\n", request); 197 ret = -EINVAL; 198 goto err; 199 } 200 201 /* write request */ 202 if (!(requesttype & USB_DIR_IN)) 203 memcpy(s->buf, data, size); 204 205 ret = usb_control_msg(s->udev, pipe, request, requesttype, value, 206 index, s->buf, size, 1000); 207 airspy_dbg_usb_control_msg(s->dev, request, requesttype, value, 208 index, s->buf, size); 209 if (ret < 0) { 210 dev_err(s->dev, "usb_control_msg() failed %d request %02x\n", 211 ret, request); 212 goto err; 213 } 214 215 /* read request */ 216 if (requesttype & USB_DIR_IN) 217 memcpy(data, s->buf, size); 218 219 return 0; 220 err: 221 return ret; 222 } 223 224 /* Private functions */ 225 static struct airspy_frame_buf *airspy_get_next_fill_buf(struct airspy *s) 226 { 227 unsigned long flags; 228 struct airspy_frame_buf *buf = NULL; 229 230 spin_lock_irqsave(&s->queued_bufs_lock, flags); 231 if (list_empty(&s->queued_bufs)) 232 goto leave; 233 234 buf = list_entry(s->queued_bufs.next, 235 struct airspy_frame_buf, list); 236 list_del(&buf->list); 237 leave: 238 spin_unlock_irqrestore(&s->queued_bufs_lock, flags); 239 return buf; 240 } 241 242 static unsigned int airspy_convert_stream(struct airspy *s, 243 void *dst, void *src, unsigned int src_len) 244 { 245 unsigned int dst_len; 246 247 if (s->pixelformat == V4L2_SDR_FMT_RU12LE) { 248 memcpy(dst, src, src_len); 249 dst_len = src_len; 250 } else { 251 dst_len = 0; 252 } 253 254 /* calculate sample rate and output it in 10 seconds intervals */ 255 if (unlikely(time_is_before_jiffies(s->jiffies_next))) { 256 #define MSECS 10000UL 257 unsigned int msecs = jiffies_to_msecs(jiffies - 258 s->jiffies_next + msecs_to_jiffies(MSECS)); 259 unsigned int samples = s->sample - s->sample_measured; 260 261 s->jiffies_next = jiffies + msecs_to_jiffies(MSECS); 262 s->sample_measured = s->sample; 263 dev_dbg(s->dev, "slen=%u samples=%u msecs=%u sample rate=%lu\n", 264 src_len, samples, msecs, 265 samples * 1000UL / msecs); 266 } 267 268 /* total number of samples */ 269 s->sample += src_len / 2; 270 271 return dst_len; 272 } 273 274 /* 275 * This gets called for the bulk stream pipe. This is done in interrupt 276 * time, so it has to be fast, not crash, and not stall. Neat. 277 */ 278 static void airspy_urb_complete(struct urb *urb) 279 { 280 struct airspy *s = urb->context; 281 struct airspy_frame_buf *fbuf; 282 283 dev_dbg_ratelimited(s->dev, "status=%d length=%d/%d errors=%d\n", 284 urb->status, urb->actual_length, 285 urb->transfer_buffer_length, urb->error_count); 286 287 switch (urb->status) { 288 case 0: /* success */ 289 case -ETIMEDOUT: /* NAK */ 290 break; 291 case -ECONNRESET: /* kill */ 292 case -ENOENT: 293 case -ESHUTDOWN: 294 return; 295 default: /* error */ 296 dev_err_ratelimited(s->dev, "URB failed %d\n", urb->status); 297 break; 298 } 299 300 if (likely(urb->actual_length > 0)) { 301 void *ptr; 302 unsigned int len; 303 /* get free framebuffer */ 304 fbuf = airspy_get_next_fill_buf(s); 305 if (unlikely(fbuf == NULL)) { 306 s->vb_full++; 307 dev_notice_ratelimited(s->dev, 308 "videobuf is full, %d packets dropped\n", 309 s->vb_full); 310 goto skip; 311 } 312 313 /* fill framebuffer */ 314 ptr = vb2_plane_vaddr(&fbuf->vb.vb2_buf, 0); 315 len = airspy_convert_stream(s, ptr, urb->transfer_buffer, 316 urb->actual_length); 317 vb2_set_plane_payload(&fbuf->vb.vb2_buf, 0, len); 318 fbuf->vb.vb2_buf.timestamp = ktime_get_ns(); 319 fbuf->vb.sequence = s->sequence++; 320 vb2_buffer_done(&fbuf->vb.vb2_buf, VB2_BUF_STATE_DONE); 321 } 322 skip: 323 usb_submit_urb(urb, GFP_ATOMIC); 324 } 325 326 static int airspy_kill_urbs(struct airspy *s) 327 { 328 int i; 329 330 for (i = s->urbs_submitted - 1; i >= 0; i--) { 331 dev_dbg(s->dev, "kill urb=%d\n", i); 332 /* stop the URB */ 333 usb_kill_urb(s->urb_list[i]); 334 } 335 s->urbs_submitted = 0; 336 337 return 0; 338 } 339 340 static int airspy_submit_urbs(struct airspy *s) 341 { 342 int i, ret; 343 344 for (i = 0; i < s->urbs_initialized; i++) { 345 dev_dbg(s->dev, "submit urb=%d\n", i); 346 ret = usb_submit_urb(s->urb_list[i], GFP_ATOMIC); 347 if (ret) { 348 dev_err(s->dev, "Could not submit URB no. %d - get them all back\n", 349 i); 350 airspy_kill_urbs(s); 351 return ret; 352 } 353 s->urbs_submitted++; 354 } 355 356 return 0; 357 } 358 359 static int airspy_free_stream_bufs(struct airspy *s) 360 { 361 if (test_bit(USB_STATE_URB_BUF, &s->flags)) { 362 while (s->buf_num) { 363 s->buf_num--; 364 dev_dbg(s->dev, "free buf=%d\n", s->buf_num); 365 usb_free_coherent(s->udev, s->buf_size, 366 s->buf_list[s->buf_num], 367 s->dma_addr[s->buf_num]); 368 } 369 } 370 clear_bit(USB_STATE_URB_BUF, &s->flags); 371 372 return 0; 373 } 374 375 static int airspy_alloc_stream_bufs(struct airspy *s) 376 { 377 s->buf_num = 0; 378 s->buf_size = BULK_BUFFER_SIZE; 379 380 dev_dbg(s->dev, "all in all I will use %u bytes for streaming\n", 381 MAX_BULK_BUFS * BULK_BUFFER_SIZE); 382 383 for (s->buf_num = 0; s->buf_num < MAX_BULK_BUFS; s->buf_num++) { 384 s->buf_list[s->buf_num] = usb_alloc_coherent(s->udev, 385 BULK_BUFFER_SIZE, GFP_ATOMIC, 386 &s->dma_addr[s->buf_num]); 387 if (!s->buf_list[s->buf_num]) { 388 dev_dbg(s->dev, "alloc buf=%d failed\n", s->buf_num); 389 airspy_free_stream_bufs(s); 390 return -ENOMEM; 391 } 392 393 dev_dbg(s->dev, "alloc buf=%d %p (dma %llu)\n", s->buf_num, 394 s->buf_list[s->buf_num], 395 (long long)s->dma_addr[s->buf_num]); 396 set_bit(USB_STATE_URB_BUF, &s->flags); 397 } 398 399 return 0; 400 } 401 402 static int airspy_free_urbs(struct airspy *s) 403 { 404 int i; 405 406 airspy_kill_urbs(s); 407 408 for (i = s->urbs_initialized - 1; i >= 0; i--) { 409 if (s->urb_list[i]) { 410 dev_dbg(s->dev, "free urb=%d\n", i); 411 /* free the URBs */ 412 usb_free_urb(s->urb_list[i]); 413 } 414 } 415 s->urbs_initialized = 0; 416 417 return 0; 418 } 419 420 static int airspy_alloc_urbs(struct airspy *s) 421 { 422 int i, j; 423 424 /* allocate the URBs */ 425 for (i = 0; i < MAX_BULK_BUFS; i++) { 426 dev_dbg(s->dev, "alloc urb=%d\n", i); 427 s->urb_list[i] = usb_alloc_urb(0, GFP_ATOMIC); 428 if (!s->urb_list[i]) { 429 dev_dbg(s->dev, "failed\n"); 430 for (j = 0; j < i; j++) 431 usb_free_urb(s->urb_list[j]); 432 return -ENOMEM; 433 } 434 usb_fill_bulk_urb(s->urb_list[i], 435 s->udev, 436 usb_rcvbulkpipe(s->udev, 0x81), 437 s->buf_list[i], 438 BULK_BUFFER_SIZE, 439 airspy_urb_complete, s); 440 441 s->urb_list[i]->transfer_flags = URB_NO_TRANSFER_DMA_MAP; 442 s->urb_list[i]->transfer_dma = s->dma_addr[i]; 443 s->urbs_initialized++; 444 } 445 446 return 0; 447 } 448 449 /* Must be called with vb_queue_lock hold */ 450 static void airspy_cleanup_queued_bufs(struct airspy *s) 451 { 452 unsigned long flags; 453 454 dev_dbg(s->dev, "\n"); 455 456 spin_lock_irqsave(&s->queued_bufs_lock, flags); 457 while (!list_empty(&s->queued_bufs)) { 458 struct airspy_frame_buf *buf; 459 460 buf = list_entry(s->queued_bufs.next, 461 struct airspy_frame_buf, list); 462 list_del(&buf->list); 463 vb2_buffer_done(&buf->vb.vb2_buf, VB2_BUF_STATE_ERROR); 464 } 465 spin_unlock_irqrestore(&s->queued_bufs_lock, flags); 466 } 467 468 /* The user yanked out the cable... */ 469 static void airspy_disconnect(struct usb_interface *intf) 470 { 471 struct v4l2_device *v = usb_get_intfdata(intf); 472 struct airspy *s = container_of(v, struct airspy, v4l2_dev); 473 474 dev_dbg(s->dev, "\n"); 475 476 mutex_lock(&s->vb_queue_lock); 477 mutex_lock(&s->v4l2_lock); 478 /* No need to keep the urbs around after disconnection */ 479 s->udev = NULL; 480 v4l2_device_disconnect(&s->v4l2_dev); 481 video_unregister_device(&s->vdev); 482 mutex_unlock(&s->v4l2_lock); 483 mutex_unlock(&s->vb_queue_lock); 484 485 v4l2_device_put(&s->v4l2_dev); 486 } 487 488 /* Videobuf2 operations */ 489 static int airspy_queue_setup(struct vb2_queue *vq, 490 unsigned int *nbuffers, 491 unsigned int *nplanes, unsigned int sizes[], void *alloc_ctxs[]) 492 { 493 struct airspy *s = vb2_get_drv_priv(vq); 494 495 dev_dbg(s->dev, "nbuffers=%d\n", *nbuffers); 496 497 /* Need at least 8 buffers */ 498 if (vq->num_buffers + *nbuffers < 8) 499 *nbuffers = 8 - vq->num_buffers; 500 *nplanes = 1; 501 sizes[0] = PAGE_ALIGN(s->buffersize); 502 503 dev_dbg(s->dev, "nbuffers=%d sizes[0]=%d\n", *nbuffers, sizes[0]); 504 return 0; 505 } 506 507 static void airspy_buf_queue(struct vb2_buffer *vb) 508 { 509 struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb); 510 struct airspy *s = vb2_get_drv_priv(vb->vb2_queue); 511 struct airspy_frame_buf *buf = 512 container_of(vbuf, struct airspy_frame_buf, vb); 513 unsigned long flags; 514 515 /* Check the device has not disconnected between prep and queuing */ 516 if (unlikely(!s->udev)) { 517 vb2_buffer_done(&buf->vb.vb2_buf, VB2_BUF_STATE_ERROR); 518 return; 519 } 520 521 spin_lock_irqsave(&s->queued_bufs_lock, flags); 522 list_add_tail(&buf->list, &s->queued_bufs); 523 spin_unlock_irqrestore(&s->queued_bufs_lock, flags); 524 } 525 526 static int airspy_start_streaming(struct vb2_queue *vq, unsigned int count) 527 { 528 struct airspy *s = vb2_get_drv_priv(vq); 529 int ret; 530 531 dev_dbg(s->dev, "\n"); 532 533 if (!s->udev) 534 return -ENODEV; 535 536 mutex_lock(&s->v4l2_lock); 537 538 s->sequence = 0; 539 540 set_bit(POWER_ON, &s->flags); 541 542 ret = airspy_alloc_stream_bufs(s); 543 if (ret) 544 goto err_clear_bit; 545 546 ret = airspy_alloc_urbs(s); 547 if (ret) 548 goto err_free_stream_bufs; 549 550 ret = airspy_submit_urbs(s); 551 if (ret) 552 goto err_free_urbs; 553 554 /* start hardware streaming */ 555 ret = airspy_ctrl_msg(s, CMD_RECEIVER_MODE, 1, 0, NULL, 0); 556 if (ret) 557 goto err_kill_urbs; 558 559 goto exit_mutex_unlock; 560 561 err_kill_urbs: 562 airspy_kill_urbs(s); 563 err_free_urbs: 564 airspy_free_urbs(s); 565 err_free_stream_bufs: 566 airspy_free_stream_bufs(s); 567 err_clear_bit: 568 clear_bit(POWER_ON, &s->flags); 569 570 /* return all queued buffers to vb2 */ 571 { 572 struct airspy_frame_buf *buf, *tmp; 573 574 list_for_each_entry_safe(buf, tmp, &s->queued_bufs, list) { 575 list_del(&buf->list); 576 vb2_buffer_done(&buf->vb.vb2_buf, 577 VB2_BUF_STATE_QUEUED); 578 } 579 } 580 581 exit_mutex_unlock: 582 mutex_unlock(&s->v4l2_lock); 583 584 return ret; 585 } 586 587 static void airspy_stop_streaming(struct vb2_queue *vq) 588 { 589 struct airspy *s = vb2_get_drv_priv(vq); 590 591 dev_dbg(s->dev, "\n"); 592 593 mutex_lock(&s->v4l2_lock); 594 595 /* stop hardware streaming */ 596 airspy_ctrl_msg(s, CMD_RECEIVER_MODE, 0, 0, NULL, 0); 597 598 airspy_kill_urbs(s); 599 airspy_free_urbs(s); 600 airspy_free_stream_bufs(s); 601 602 airspy_cleanup_queued_bufs(s); 603 604 clear_bit(POWER_ON, &s->flags); 605 606 mutex_unlock(&s->v4l2_lock); 607 } 608 609 static struct vb2_ops airspy_vb2_ops = { 610 .queue_setup = airspy_queue_setup, 611 .buf_queue = airspy_buf_queue, 612 .start_streaming = airspy_start_streaming, 613 .stop_streaming = airspy_stop_streaming, 614 .wait_prepare = vb2_ops_wait_prepare, 615 .wait_finish = vb2_ops_wait_finish, 616 }; 617 618 static int airspy_querycap(struct file *file, void *fh, 619 struct v4l2_capability *cap) 620 { 621 struct airspy *s = video_drvdata(file); 622 623 strlcpy(cap->driver, KBUILD_MODNAME, sizeof(cap->driver)); 624 strlcpy(cap->card, s->vdev.name, sizeof(cap->card)); 625 usb_make_path(s->udev, cap->bus_info, sizeof(cap->bus_info)); 626 cap->device_caps = V4L2_CAP_SDR_CAPTURE | V4L2_CAP_STREAMING | 627 V4L2_CAP_READWRITE | V4L2_CAP_TUNER; 628 cap->capabilities = cap->device_caps | V4L2_CAP_DEVICE_CAPS; 629 630 return 0; 631 } 632 633 static int airspy_enum_fmt_sdr_cap(struct file *file, void *priv, 634 struct v4l2_fmtdesc *f) 635 { 636 if (f->index >= NUM_FORMATS) 637 return -EINVAL; 638 639 strlcpy(f->description, formats[f->index].name, sizeof(f->description)); 640 f->pixelformat = formats[f->index].pixelformat; 641 642 return 0; 643 } 644 645 static int airspy_g_fmt_sdr_cap(struct file *file, void *priv, 646 struct v4l2_format *f) 647 { 648 struct airspy *s = video_drvdata(file); 649 650 f->fmt.sdr.pixelformat = s->pixelformat; 651 f->fmt.sdr.buffersize = s->buffersize; 652 memset(f->fmt.sdr.reserved, 0, sizeof(f->fmt.sdr.reserved)); 653 654 return 0; 655 } 656 657 static int airspy_s_fmt_sdr_cap(struct file *file, void *priv, 658 struct v4l2_format *f) 659 { 660 struct airspy *s = video_drvdata(file); 661 struct vb2_queue *q = &s->vb_queue; 662 int i; 663 664 if (vb2_is_busy(q)) 665 return -EBUSY; 666 667 memset(f->fmt.sdr.reserved, 0, sizeof(f->fmt.sdr.reserved)); 668 for (i = 0; i < NUM_FORMATS; i++) { 669 if (formats[i].pixelformat == f->fmt.sdr.pixelformat) { 670 s->pixelformat = formats[i].pixelformat; 671 s->buffersize = formats[i].buffersize; 672 f->fmt.sdr.buffersize = formats[i].buffersize; 673 return 0; 674 } 675 } 676 677 s->pixelformat = formats[0].pixelformat; 678 s->buffersize = formats[0].buffersize; 679 f->fmt.sdr.pixelformat = formats[0].pixelformat; 680 f->fmt.sdr.buffersize = formats[0].buffersize; 681 682 return 0; 683 } 684 685 static int airspy_try_fmt_sdr_cap(struct file *file, void *priv, 686 struct v4l2_format *f) 687 { 688 int i; 689 690 memset(f->fmt.sdr.reserved, 0, sizeof(f->fmt.sdr.reserved)); 691 for (i = 0; i < NUM_FORMATS; i++) { 692 if (formats[i].pixelformat == f->fmt.sdr.pixelformat) { 693 f->fmt.sdr.buffersize = formats[i].buffersize; 694 return 0; 695 } 696 } 697 698 f->fmt.sdr.pixelformat = formats[0].pixelformat; 699 f->fmt.sdr.buffersize = formats[0].buffersize; 700 701 return 0; 702 } 703 704 static int airspy_s_tuner(struct file *file, void *priv, 705 const struct v4l2_tuner *v) 706 { 707 int ret; 708 709 if (v->index == 0) 710 ret = 0; 711 else if (v->index == 1) 712 ret = 0; 713 else 714 ret = -EINVAL; 715 716 return ret; 717 } 718 719 static int airspy_g_tuner(struct file *file, void *priv, struct v4l2_tuner *v) 720 { 721 int ret; 722 723 if (v->index == 0) { 724 strlcpy(v->name, "AirSpy ADC", sizeof(v->name)); 725 v->type = V4L2_TUNER_ADC; 726 v->capability = V4L2_TUNER_CAP_1HZ | V4L2_TUNER_CAP_FREQ_BANDS; 727 v->rangelow = bands[0].rangelow; 728 v->rangehigh = bands[0].rangehigh; 729 ret = 0; 730 } else if (v->index == 1) { 731 strlcpy(v->name, "AirSpy RF", sizeof(v->name)); 732 v->type = V4L2_TUNER_RF; 733 v->capability = V4L2_TUNER_CAP_1HZ | V4L2_TUNER_CAP_FREQ_BANDS; 734 v->rangelow = bands_rf[0].rangelow; 735 v->rangehigh = bands_rf[0].rangehigh; 736 ret = 0; 737 } else { 738 ret = -EINVAL; 739 } 740 741 return ret; 742 } 743 744 static int airspy_g_frequency(struct file *file, void *priv, 745 struct v4l2_frequency *f) 746 { 747 struct airspy *s = video_drvdata(file); 748 int ret; 749 750 if (f->tuner == 0) { 751 f->type = V4L2_TUNER_ADC; 752 f->frequency = s->f_adc; 753 dev_dbg(s->dev, "ADC frequency=%u Hz\n", s->f_adc); 754 ret = 0; 755 } else if (f->tuner == 1) { 756 f->type = V4L2_TUNER_RF; 757 f->frequency = s->f_rf; 758 dev_dbg(s->dev, "RF frequency=%u Hz\n", s->f_rf); 759 ret = 0; 760 } else { 761 ret = -EINVAL; 762 } 763 764 return ret; 765 } 766 767 static int airspy_s_frequency(struct file *file, void *priv, 768 const struct v4l2_frequency *f) 769 { 770 struct airspy *s = video_drvdata(file); 771 int ret; 772 u8 buf[4]; 773 774 if (f->tuner == 0) { 775 s->f_adc = clamp_t(unsigned int, f->frequency, 776 bands[0].rangelow, 777 bands[0].rangehigh); 778 dev_dbg(s->dev, "ADC frequency=%u Hz\n", s->f_adc); 779 ret = 0; 780 } else if (f->tuner == 1) { 781 s->f_rf = clamp_t(unsigned int, f->frequency, 782 bands_rf[0].rangelow, 783 bands_rf[0].rangehigh); 784 dev_dbg(s->dev, "RF frequency=%u Hz\n", s->f_rf); 785 buf[0] = (s->f_rf >> 0) & 0xff; 786 buf[1] = (s->f_rf >> 8) & 0xff; 787 buf[2] = (s->f_rf >> 16) & 0xff; 788 buf[3] = (s->f_rf >> 24) & 0xff; 789 ret = airspy_ctrl_msg(s, CMD_SET_FREQ, 0, 0, buf, 4); 790 } else { 791 ret = -EINVAL; 792 } 793 794 return ret; 795 } 796 797 static int airspy_enum_freq_bands(struct file *file, void *priv, 798 struct v4l2_frequency_band *band) 799 { 800 int ret; 801 802 if (band->tuner == 0) { 803 if (band->index >= ARRAY_SIZE(bands)) { 804 ret = -EINVAL; 805 } else { 806 *band = bands[band->index]; 807 ret = 0; 808 } 809 } else if (band->tuner == 1) { 810 if (band->index >= ARRAY_SIZE(bands_rf)) { 811 ret = -EINVAL; 812 } else { 813 *band = bands_rf[band->index]; 814 ret = 0; 815 } 816 } else { 817 ret = -EINVAL; 818 } 819 820 return ret; 821 } 822 823 static const struct v4l2_ioctl_ops airspy_ioctl_ops = { 824 .vidioc_querycap = airspy_querycap, 825 826 .vidioc_enum_fmt_sdr_cap = airspy_enum_fmt_sdr_cap, 827 .vidioc_g_fmt_sdr_cap = airspy_g_fmt_sdr_cap, 828 .vidioc_s_fmt_sdr_cap = airspy_s_fmt_sdr_cap, 829 .vidioc_try_fmt_sdr_cap = airspy_try_fmt_sdr_cap, 830 831 .vidioc_reqbufs = vb2_ioctl_reqbufs, 832 .vidioc_create_bufs = vb2_ioctl_create_bufs, 833 .vidioc_prepare_buf = vb2_ioctl_prepare_buf, 834 .vidioc_querybuf = vb2_ioctl_querybuf, 835 .vidioc_qbuf = vb2_ioctl_qbuf, 836 .vidioc_dqbuf = vb2_ioctl_dqbuf, 837 838 .vidioc_streamon = vb2_ioctl_streamon, 839 .vidioc_streamoff = vb2_ioctl_streamoff, 840 841 .vidioc_g_tuner = airspy_g_tuner, 842 .vidioc_s_tuner = airspy_s_tuner, 843 844 .vidioc_g_frequency = airspy_g_frequency, 845 .vidioc_s_frequency = airspy_s_frequency, 846 .vidioc_enum_freq_bands = airspy_enum_freq_bands, 847 848 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event, 849 .vidioc_unsubscribe_event = v4l2_event_unsubscribe, 850 .vidioc_log_status = v4l2_ctrl_log_status, 851 }; 852 853 static const struct v4l2_file_operations airspy_fops = { 854 .owner = THIS_MODULE, 855 .open = v4l2_fh_open, 856 .release = vb2_fop_release, 857 .read = vb2_fop_read, 858 .poll = vb2_fop_poll, 859 .mmap = vb2_fop_mmap, 860 .unlocked_ioctl = video_ioctl2, 861 }; 862 863 static struct video_device airspy_template = { 864 .name = "AirSpy SDR", 865 .release = video_device_release_empty, 866 .fops = &airspy_fops, 867 .ioctl_ops = &airspy_ioctl_ops, 868 }; 869 870 static void airspy_video_release(struct v4l2_device *v) 871 { 872 struct airspy *s = container_of(v, struct airspy, v4l2_dev); 873 874 v4l2_ctrl_handler_free(&s->hdl); 875 v4l2_device_unregister(&s->v4l2_dev); 876 kfree(s); 877 } 878 879 static int airspy_set_lna_gain(struct airspy *s) 880 { 881 int ret; 882 u8 u8tmp; 883 884 dev_dbg(s->dev, "lna auto=%d->%d val=%d->%d\n", 885 s->lna_gain_auto->cur.val, s->lna_gain_auto->val, 886 s->lna_gain->cur.val, s->lna_gain->val); 887 888 ret = airspy_ctrl_msg(s, CMD_SET_LNA_AGC, 0, s->lna_gain_auto->val, 889 &u8tmp, 1); 890 if (ret) 891 goto err; 892 893 if (s->lna_gain_auto->val == false) { 894 ret = airspy_ctrl_msg(s, CMD_SET_LNA_GAIN, 0, s->lna_gain->val, 895 &u8tmp, 1); 896 if (ret) 897 goto err; 898 } 899 err: 900 if (ret) 901 dev_dbg(s->dev, "failed=%d\n", ret); 902 903 return ret; 904 } 905 906 static int airspy_set_mixer_gain(struct airspy *s) 907 { 908 int ret; 909 u8 u8tmp; 910 911 dev_dbg(s->dev, "mixer auto=%d->%d val=%d->%d\n", 912 s->mixer_gain_auto->cur.val, s->mixer_gain_auto->val, 913 s->mixer_gain->cur.val, s->mixer_gain->val); 914 915 ret = airspy_ctrl_msg(s, CMD_SET_MIXER_AGC, 0, s->mixer_gain_auto->val, 916 &u8tmp, 1); 917 if (ret) 918 goto err; 919 920 if (s->mixer_gain_auto->val == false) { 921 ret = airspy_ctrl_msg(s, CMD_SET_MIXER_GAIN, 0, 922 s->mixer_gain->val, &u8tmp, 1); 923 if (ret) 924 goto err; 925 } 926 err: 927 if (ret) 928 dev_dbg(s->dev, "failed=%d\n", ret); 929 930 return ret; 931 } 932 933 static int airspy_set_if_gain(struct airspy *s) 934 { 935 int ret; 936 u8 u8tmp; 937 938 dev_dbg(s->dev, "val=%d->%d\n", s->if_gain->cur.val, s->if_gain->val); 939 940 ret = airspy_ctrl_msg(s, CMD_SET_VGA_GAIN, 0, s->if_gain->val, 941 &u8tmp, 1); 942 if (ret) 943 dev_dbg(s->dev, "failed=%d\n", ret); 944 945 return ret; 946 } 947 948 static int airspy_s_ctrl(struct v4l2_ctrl *ctrl) 949 { 950 struct airspy *s = container_of(ctrl->handler, struct airspy, hdl); 951 int ret; 952 953 switch (ctrl->id) { 954 case V4L2_CID_RF_TUNER_LNA_GAIN_AUTO: 955 case V4L2_CID_RF_TUNER_LNA_GAIN: 956 ret = airspy_set_lna_gain(s); 957 break; 958 case V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO: 959 case V4L2_CID_RF_TUNER_MIXER_GAIN: 960 ret = airspy_set_mixer_gain(s); 961 break; 962 case V4L2_CID_RF_TUNER_IF_GAIN: 963 ret = airspy_set_if_gain(s); 964 break; 965 default: 966 dev_dbg(s->dev, "unknown ctrl: id=%d name=%s\n", 967 ctrl->id, ctrl->name); 968 ret = -EINVAL; 969 } 970 971 return ret; 972 } 973 974 static const struct v4l2_ctrl_ops airspy_ctrl_ops = { 975 .s_ctrl = airspy_s_ctrl, 976 }; 977 978 static int airspy_probe(struct usb_interface *intf, 979 const struct usb_device_id *id) 980 { 981 struct airspy *s; 982 int ret; 983 u8 u8tmp, buf[BUF_SIZE]; 984 985 s = kzalloc(sizeof(struct airspy), GFP_KERNEL); 986 if (s == NULL) { 987 dev_err(&intf->dev, "Could not allocate memory for state\n"); 988 return -ENOMEM; 989 } 990 991 mutex_init(&s->v4l2_lock); 992 mutex_init(&s->vb_queue_lock); 993 spin_lock_init(&s->queued_bufs_lock); 994 INIT_LIST_HEAD(&s->queued_bufs); 995 s->dev = &intf->dev; 996 s->udev = interface_to_usbdev(intf); 997 s->f_adc = bands[0].rangelow; 998 s->f_rf = bands_rf[0].rangelow; 999 s->pixelformat = formats[0].pixelformat; 1000 s->buffersize = formats[0].buffersize; 1001 1002 /* Detect device */ 1003 ret = airspy_ctrl_msg(s, CMD_BOARD_ID_READ, 0, 0, &u8tmp, 1); 1004 if (ret == 0) 1005 ret = airspy_ctrl_msg(s, CMD_VERSION_STRING_READ, 0, 0, 1006 buf, BUF_SIZE); 1007 if (ret) { 1008 dev_err(s->dev, "Could not detect board\n"); 1009 goto err_free_mem; 1010 } 1011 1012 buf[BUF_SIZE - 1] = '\0'; 1013 1014 dev_info(s->dev, "Board ID: %02x\n", u8tmp); 1015 dev_info(s->dev, "Firmware version: %s\n", buf); 1016 1017 /* Init videobuf2 queue structure */ 1018 s->vb_queue.type = V4L2_BUF_TYPE_SDR_CAPTURE; 1019 s->vb_queue.io_modes = VB2_MMAP | VB2_USERPTR | VB2_READ; 1020 s->vb_queue.drv_priv = s; 1021 s->vb_queue.buf_struct_size = sizeof(struct airspy_frame_buf); 1022 s->vb_queue.ops = &airspy_vb2_ops; 1023 s->vb_queue.mem_ops = &vb2_vmalloc_memops; 1024 s->vb_queue.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC; 1025 ret = vb2_queue_init(&s->vb_queue); 1026 if (ret) { 1027 dev_err(s->dev, "Could not initialize vb2 queue\n"); 1028 goto err_free_mem; 1029 } 1030 1031 /* Init video_device structure */ 1032 s->vdev = airspy_template; 1033 s->vdev.queue = &s->vb_queue; 1034 s->vdev.queue->lock = &s->vb_queue_lock; 1035 video_set_drvdata(&s->vdev, s); 1036 1037 /* Register the v4l2_device structure */ 1038 s->v4l2_dev.release = airspy_video_release; 1039 ret = v4l2_device_register(&intf->dev, &s->v4l2_dev); 1040 if (ret) { 1041 dev_err(s->dev, "Failed to register v4l2-device (%d)\n", ret); 1042 goto err_free_mem; 1043 } 1044 1045 /* Register controls */ 1046 v4l2_ctrl_handler_init(&s->hdl, 5); 1047 s->lna_gain_auto = v4l2_ctrl_new_std(&s->hdl, &airspy_ctrl_ops, 1048 V4L2_CID_RF_TUNER_LNA_GAIN_AUTO, 0, 1, 1, 0); 1049 s->lna_gain = v4l2_ctrl_new_std(&s->hdl, &airspy_ctrl_ops, 1050 V4L2_CID_RF_TUNER_LNA_GAIN, 0, 14, 1, 8); 1051 v4l2_ctrl_auto_cluster(2, &s->lna_gain_auto, 0, false); 1052 s->mixer_gain_auto = v4l2_ctrl_new_std(&s->hdl, &airspy_ctrl_ops, 1053 V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO, 0, 1, 1, 0); 1054 s->mixer_gain = v4l2_ctrl_new_std(&s->hdl, &airspy_ctrl_ops, 1055 V4L2_CID_RF_TUNER_MIXER_GAIN, 0, 15, 1, 8); 1056 v4l2_ctrl_auto_cluster(2, &s->mixer_gain_auto, 0, false); 1057 s->if_gain = v4l2_ctrl_new_std(&s->hdl, &airspy_ctrl_ops, 1058 V4L2_CID_RF_TUNER_IF_GAIN, 0, 15, 1, 0); 1059 if (s->hdl.error) { 1060 ret = s->hdl.error; 1061 dev_err(s->dev, "Could not initialize controls\n"); 1062 goto err_free_controls; 1063 } 1064 1065 v4l2_ctrl_handler_setup(&s->hdl); 1066 1067 s->v4l2_dev.ctrl_handler = &s->hdl; 1068 s->vdev.v4l2_dev = &s->v4l2_dev; 1069 s->vdev.lock = &s->v4l2_lock; 1070 1071 ret = video_register_device(&s->vdev, VFL_TYPE_SDR, -1); 1072 if (ret) { 1073 dev_err(s->dev, "Failed to register as video device (%d)\n", 1074 ret); 1075 goto err_unregister_v4l2_dev; 1076 } 1077 dev_info(s->dev, "Registered as %s\n", 1078 video_device_node_name(&s->vdev)); 1079 dev_notice(s->dev, "SDR API is still slightly experimental and functionality changes may follow\n"); 1080 return 0; 1081 1082 err_free_controls: 1083 v4l2_ctrl_handler_free(&s->hdl); 1084 err_unregister_v4l2_dev: 1085 v4l2_device_unregister(&s->v4l2_dev); 1086 err_free_mem: 1087 kfree(s); 1088 return ret; 1089 } 1090 1091 /* USB device ID list */ 1092 static struct usb_device_id airspy_id_table[] = { 1093 { USB_DEVICE(0x1d50, 0x60a1) }, /* AirSpy */ 1094 { } 1095 }; 1096 MODULE_DEVICE_TABLE(usb, airspy_id_table); 1097 1098 /* USB subsystem interface */ 1099 static struct usb_driver airspy_driver = { 1100 .name = KBUILD_MODNAME, 1101 .probe = airspy_probe, 1102 .disconnect = airspy_disconnect, 1103 .id_table = airspy_id_table, 1104 }; 1105 1106 module_usb_driver(airspy_driver); 1107 1108 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>"); 1109 MODULE_DESCRIPTION("AirSpy SDR"); 1110 MODULE_LICENSE("GPL"); 1111