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