2 * Mirics MSi3101 SDR Dongle driver
4 * Copyright (C) 2013 Antti Palosaari <crope@iki.fi>
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.
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.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/init.h>
24 #include <linux/slab.h>
25 #include <linux/input.h>
26 #include <linux/videodev2.h>
27 #include <media/v4l2-device.h>
28 #include <media/v4l2-ioctl.h>
29 #include <media/v4l2-ctrls.h>
30 #include <media/v4l2-event.h>
31 #include <linux/usb.h>
32 #include <linux/mutex.h>
33 #include <media/videobuf2-vmalloc.h>
42 /* 60 – 120 MHz band, lna 24dB, mixer 19dB */
43 static const struct msi3101_gain msi3101_gain_lut_120[] = {
149 /* 120 – 245 MHz band, lna 24dB, mixer 19dB */
150 static const struct msi3101_gain msi3101_gain_lut_245[] = {
256 /* 420 – 1000 MHz band, lna 7dB, mixer 19dB */
257 static const struct msi3101_gain msi3101_gain_lut_1000[] = {
349 * bAlternateSetting 1
351 * bEndpointAddress 0x81 EP 1 IN
353 * Transfer Type Isochronous
354 * wMaxPacketSize 0x1400 3x 1024 bytes
357 #define MAX_ISO_BUFS (8)
358 #define ISO_FRAMES_PER_DESC (8)
359 #define ISO_MAX_FRAME_SIZE (3 * 1024)
360 #define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE)
362 #define MAX_ISOC_ERRORS 20
364 #define MSI3101_CID_SAMPLING_MODE ((V4L2_CID_USER_BASE | 0xf000) + 0)
365 #define MSI3101_CID_SAMPLING_RATE ((V4L2_CID_USER_BASE | 0xf000) + 1)
366 #define MSI3101_CID_SAMPLING_RESOLUTION ((V4L2_CID_USER_BASE | 0xf000) + 2)
367 #define MSI3101_CID_TUNER_RF ((V4L2_CID_USER_BASE | 0xf000) + 10)
368 #define MSI3101_CID_TUNER_BW ((V4L2_CID_USER_BASE | 0xf000) + 11)
369 #define MSI3101_CID_TUNER_IF ((V4L2_CID_USER_BASE | 0xf000) + 12)
370 #define MSI3101_CID_TUNER_GAIN ((V4L2_CID_USER_BASE | 0xf000) + 13)
372 /* intermediate buffers with raw data from the USB device */
373 struct msi3101_frame_buf {
374 struct vb2_buffer vb; /* common v4l buffer stuff -- must be first */
375 struct list_head list;
376 void *data; /* raw data from USB device */
377 int filled; /* number of bytes filled to *data */
380 struct msi3101_state {
381 struct video_device vdev;
382 struct v4l2_device v4l2_dev;
384 /* videobuf2 queue and queued buffers list */
385 struct vb2_queue vb_queue;
386 struct list_head queued_bufs;
387 spinlock_t queued_bufs_lock; /* Protects queued_bufs */
389 /* Note if taking both locks v4l2_lock must always be locked first! */
390 struct mutex v4l2_lock; /* Protects everything else */
391 struct mutex vb_queue_lock; /* Protects vb_queue and capt_file */
393 /* Pointer to our usb_device, will be NULL after unplug */
394 struct usb_device *udev; /* Both mutexes most be hold when setting! */
396 unsigned int isoc_errors; /* number of contiguous ISOC errors */
397 unsigned int vb_full; /* vb is full and packets dropped */
399 struct urb *urbs[MAX_ISO_BUFS];
402 struct v4l2_ctrl_handler ctrl_handler;
403 struct v4l2_ctrl *ctrl_sampling_rate;
404 struct v4l2_ctrl *ctrl_tuner_rf;
405 struct v4l2_ctrl *ctrl_tuner_bw;
406 struct v4l2_ctrl *ctrl_tuner_if;
407 struct v4l2_ctrl *ctrl_tuner_gain;
409 u32 next_sample; /* for track lost packets */
410 u32 sample; /* for sample rate calc */
411 unsigned long jiffies;
412 unsigned int sample_ctrl_bit[4];
415 /* Private functions */
416 static struct msi3101_frame_buf *msi3101_get_next_fill_buf(
417 struct msi3101_state *s)
419 unsigned long flags = 0;
420 struct msi3101_frame_buf *buf = NULL;
422 spin_lock_irqsave(&s->queued_bufs_lock, flags);
423 if (list_empty(&s->queued_bufs))
426 buf = list_entry(s->queued_bufs.next, struct msi3101_frame_buf, list);
427 list_del(&buf->list);
429 spin_unlock_irqrestore(&s->queued_bufs_lock, flags);
434 * +===========================================================================
435 * | 00-1023 | USB packet
436 * +===========================================================================
437 * | 00- 03 | sequence number of first sample in that USB packet
438 * +---------------------------------------------------------------------------
440 * +---------------------------------------------------------------------------
441 * | 16- 175 | samples
442 * +---------------------------------------------------------------------------
443 * | 176- 179 | control bits for previous samples
444 * +---------------------------------------------------------------------------
445 * | 180- 339 | samples
446 * +---------------------------------------------------------------------------
447 * | 340- 343 | control bits for previous samples
448 * +---------------------------------------------------------------------------
449 * | 344- 503 | samples
450 * +---------------------------------------------------------------------------
451 * | 504- 507 | control bits for previous samples
452 * +---------------------------------------------------------------------------
453 * | 508- 667 | samples
454 * +---------------------------------------------------------------------------
455 * | 668- 671 | control bits for previous samples
456 * +---------------------------------------------------------------------------
457 * | 672- 831 | samples
458 * +---------------------------------------------------------------------------
459 * | 832- 835 | control bits for previous samples
460 * +---------------------------------------------------------------------------
461 * | 836- 995 | samples
462 * +---------------------------------------------------------------------------
463 * | 996- 999 | control bits for previous samples
464 * +---------------------------------------------------------------------------
465 * | 1000-1023 | garbage
466 * +---------------------------------------------------------------------------
468 * Bytes 4 - 7 could have some meaning?
470 * Control bits for previous samples is 32-bit field, containing 16 x 2-bit
471 * numbers. This results one 2-bit number for 8 samples. It is likely used for
472 * for bit shifting sample by given bits, increasing actual sampling resolution.
473 * Number 2 (0b10) was never seen.
475 * 6 * 16 * 2 * 4 = 768 samples. 768 * 4 = 3072 bytes
479 * Converts signed 10-bit integer into 32-bit IEEE floating point
481 * Will be exact from 0 to 2^24. Above that, we round towards zero
482 * as the fractional bits will not fit in a float. (It would be better to
483 * round towards even as the fpu does, but that is slower.)
485 #define I2F_FRAC_BITS 23
486 #define I2F_MASK ((1 << I2F_FRAC_BITS) - 1)
487 static u32 msi3101_convert_sample(struct msi3101_state *s, u16 x, int shift)
489 u32 msb, exponent, fraction, sign;
490 s->sample_ctrl_bit[shift]++;
492 /* Zero is special */
496 /* Convert 10-bit two's complement to 13-bit */
498 x |= ~0U << 10; /* set all the rest bits to one */
501 x &= 0xfff; /* result is 12 bit ... + sign */
508 /* Get location of the most significant bit */
512 * Use a rotate instead of a shift because that works both leftwards
513 * and rightwards due to the mod(32) behaviour. This means we don't
514 * need to check to see if we are above 2^24 or not.
516 fraction = ror32(x, (msb - I2F_FRAC_BITS) & 0x1f) & I2F_MASK;
517 exponent = (127 + msb) << I2F_FRAC_BITS;
519 return (fraction + exponent) | sign;
522 #define MSI3101_CONVERT_IN_URB_HANDLER
523 #define MSI3101_EXTENSIVE_DEBUG
524 static int msi3101_convert_stream(struct msi3101_state *s, u32 *dst,
525 u8 *src, unsigned int src_len)
527 int i, j, k, l, i_max, dst_len = 0;
530 #ifdef MSI3101_EXTENSIVE_DEBUG
533 /* There could be 1-3 1024 bytes URB frames */
534 i_max = src_len / 1024;
535 for (i = 0; i < i_max; i++) {
536 #ifdef MSI3101_EXTENSIVE_DEBUG
537 sample_num[i] = src[3] << 24 | src[2] << 16 | src[1] << 8 | src[0] << 0;
538 if (i == 0 && s->next_sample != sample_num[0]) {
539 dev_dbg(&s->udev->dev,
540 "%d samples lost, %d %08x:%08x\n",
541 sample_num[0] - s->next_sample,
542 src_len, s->next_sample, sample_num[0]);
546 * Dump all unknown 'garbage' data - maybe we will discover
547 * someday if there is something rational...
549 dev_dbg_ratelimited(&s->udev->dev,
550 "%*ph %*ph\n", 12, &src[4], 24, &src[1000]);
551 memset(&src[4], 0, 12);
552 memset(&src[1000], 0, 24);
555 for (j = 0; j < 6; j++) {
556 bits = src[160 + 3] << 24 | src[160 + 2] << 16 | src[160 + 1] << 8 | src[160 + 0] << 0;
557 for (k = 0; k < 16; k++) {
558 for (l = 0; l < 10; l += 5) {
559 sample[0] = (src[l + 0] & 0xff) >> 0 | (src[l + 1] & 0x03) << 8;
560 sample[1] = (src[l + 1] & 0xfc) >> 2 | (src[l + 2] & 0x0f) << 6;
561 sample[2] = (src[l + 2] & 0xf0) >> 4 | (src[l + 3] & 0x3f) << 4;
562 sample[3] = (src[l + 3] & 0xc0) >> 6 | (src[l + 4] & 0xff) << 2;
564 *dst++ = msi3101_convert_sample(s, sample[0], (bits >> (2 * k)) & 0x3);
565 *dst++ = msi3101_convert_sample(s, sample[1], (bits >> (2 * k)) & 0x3);
566 *dst++ = msi3101_convert_sample(s, sample[2], (bits >> (2 * k)) & 0x3);
567 *dst++ = msi3101_convert_sample(s, sample[3], (bits >> (2 * k)) & 0x3);
569 /* 4 x 32bit float samples */
574 #ifdef MSI3101_EXTENSIVE_DEBUG
575 dev_dbg_ratelimited(&s->udev->dev,
576 "sample control bits %08x\n", bits);
583 #ifdef MSI3101_EXTENSIVE_DEBUG
584 /* calculate samping rate and output it in 10 seconds intervals */
585 if ((s->jiffies + msecs_to_jiffies(10000)) <= jiffies) {
586 unsigned long jiffies_now = jiffies;
587 unsigned long msecs = jiffies_to_msecs(jiffies_now) - jiffies_to_msecs(s->jiffies);
588 unsigned int samples = sample_num[i_max - 1] - s->sample;
589 s->jiffies = jiffies_now;
590 s->sample = sample_num[i_max - 1];
591 dev_dbg(&s->udev->dev,
592 "slen=%d samples=%u msecs=%lu sampling rate=%lu bits=%d.%d.%d.%d\n",
593 src_len, samples, msecs,
594 samples * 1000UL / msecs,
595 s->sample_ctrl_bit[0], s->sample_ctrl_bit[1],
596 s->sample_ctrl_bit[2], s->sample_ctrl_bit[3]);
599 /* next sample (sample = sample + i * 384) */
600 s->next_sample = sample_num[i_max - 1] + 384;
606 * This gets called for the Isochronous pipe (stream). This is done in interrupt
607 * time, so it has to be fast, not crash, and not stall. Neat.
609 static void msi3101_isoc_handler(struct urb *urb)
611 struct msi3101_state *s = (struct msi3101_state *)urb->context;
612 int i, flen, fstatus;
613 unsigned char *iso_buf = NULL;
614 struct msi3101_frame_buf *fbuf;
616 if (urb->status == -ENOENT || urb->status == -ECONNRESET ||
617 urb->status == -ESHUTDOWN) {
618 dev_dbg(&s->udev->dev, "URB (%p) unlinked %ssynchronuously\n",
619 urb, urb->status == -ENOENT ? "" : "a");
623 if (urb->status != 0) {
624 dev_dbg(&s->udev->dev,
625 "msi3101_isoc_handler() called with status %d\n",
627 /* Give up after a number of contiguous errors */
628 if (++s->isoc_errors > MAX_ISOC_ERRORS)
629 dev_dbg(&s->udev->dev,
630 "Too many ISOC errors, bailing out\n");
633 /* Reset ISOC error counter. We did get here, after all. */
638 for (i = 0; i < urb->number_of_packets; i++) {
639 /* Check frame error */
640 fstatus = urb->iso_frame_desc[i].status;
642 dev_dbg(&s->udev->dev,
643 "frame=%d/%d has error %d skipping\n",
644 i, urb->number_of_packets, fstatus);
648 /* Check if that frame contains data */
649 flen = urb->iso_frame_desc[i].actual_length;
653 iso_buf = urb->transfer_buffer + urb->iso_frame_desc[i].offset;
655 /* Get free framebuffer */
656 fbuf = msi3101_get_next_fill_buf(s);
659 dev_dbg_ratelimited(&s->udev->dev,
660 "videobuf is full, %d packets dropped\n",
665 /* fill framebuffer */
666 #ifdef MSI3101_CONVERT_IN_URB_HANDLER
667 vb2_set_plane_payload(&fbuf->vb, 0,
668 msi3101_convert_stream(s,
669 vb2_plane_vaddr(&fbuf->vb, 0), iso_buf, flen));
671 memcpy(fbuf->data, iso_buf, flen);
674 vb2_buffer_done(&fbuf->vb, VB2_BUF_STATE_DONE);
680 i = usb_submit_urb(urb, GFP_ATOMIC);
682 dev_dbg(&s->udev->dev,
683 "Error (%d) re-submitting urb in msi3101_isoc_handler\n",
687 static void msi3101_iso_stop(struct msi3101_state *s)
690 dev_dbg(&s->udev->dev, "%s:\n", __func__);
692 /* Unlinking ISOC buffers one by one */
693 for (i = 0; i < MAX_ISO_BUFS; i++) {
695 dev_dbg(&s->udev->dev, "Unlinking URB %p\n",
697 usb_kill_urb(s->urbs[i]);
702 static void msi3101_iso_free(struct msi3101_state *s)
705 dev_dbg(&s->udev->dev, "%s:\n", __func__);
707 /* Freeing ISOC buffers one by one */
708 for (i = 0; i < MAX_ISO_BUFS; i++) {
710 dev_dbg(&s->udev->dev, "Freeing URB\n");
711 if (s->urbs[i]->transfer_buffer) {
712 usb_free_coherent(s->udev,
713 s->urbs[i]->transfer_buffer_length,
714 s->urbs[i]->transfer_buffer,
715 s->urbs[i]->transfer_dma);
717 usb_free_urb(s->urbs[i]);
723 /* Both v4l2_lock and vb_queue_lock should be locked when calling this */
724 static void msi3101_isoc_cleanup(struct msi3101_state *s)
726 dev_dbg(&s->udev->dev, "%s:\n", __func__);
732 /* Both v4l2_lock and vb_queue_lock should be locked when calling this */
733 static int msi3101_isoc_init(struct msi3101_state *s)
735 struct usb_device *udev;
738 dev_dbg(&s->udev->dev, "%s:\n", __func__);
743 ret = usb_set_interface(s->udev, 0, 1);
747 /* Allocate and init Isochronuous urbs */
748 for (i = 0; i < MAX_ISO_BUFS; i++) {
749 urb = usb_alloc_urb(ISO_FRAMES_PER_DESC, GFP_KERNEL);
751 dev_err(&s->udev->dev,
752 "Failed to allocate urb %d\n", i);
753 msi3101_isoc_cleanup(s);
757 dev_dbg(&s->udev->dev, "Allocated URB at 0x%p\n", urb);
761 urb->pipe = usb_rcvisocpipe(udev, 0x81);
762 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
763 urb->transfer_buffer = usb_alloc_coherent(udev, ISO_BUFFER_SIZE,
764 GFP_KERNEL, &urb->transfer_dma);
765 if (urb->transfer_buffer == NULL) {
766 dev_err(&s->udev->dev,
767 "Failed to allocate urb buffer %d\n",
769 msi3101_isoc_cleanup(s);
772 urb->transfer_buffer_length = ISO_BUFFER_SIZE;
773 urb->complete = msi3101_isoc_handler;
775 urb->start_frame = 0;
776 urb->number_of_packets = ISO_FRAMES_PER_DESC;
777 for (j = 0; j < ISO_FRAMES_PER_DESC; j++) {
778 urb->iso_frame_desc[j].offset = j * ISO_MAX_FRAME_SIZE;
779 urb->iso_frame_desc[j].length = ISO_MAX_FRAME_SIZE;
784 for (i = 0; i < MAX_ISO_BUFS; i++) {
785 ret = usb_submit_urb(s->urbs[i], GFP_KERNEL);
787 dev_err(&s->udev->dev,
788 "isoc_init() submit_urb %d failed with error %d\n",
790 msi3101_isoc_cleanup(s);
793 dev_dbg(&s->udev->dev, "URB 0x%p submitted.\n", s->urbs[i]);
800 /* Must be called with vb_queue_lock hold */
801 static void msi3101_cleanup_queued_bufs(struct msi3101_state *s)
803 unsigned long flags = 0;
804 dev_dbg(&s->udev->dev, "%s:\n", __func__);
806 spin_lock_irqsave(&s->queued_bufs_lock, flags);
807 while (!list_empty(&s->queued_bufs)) {
808 struct msi3101_frame_buf *buf;
810 buf = list_entry(s->queued_bufs.next, struct msi3101_frame_buf,
812 list_del(&buf->list);
813 vb2_buffer_done(&buf->vb, VB2_BUF_STATE_ERROR);
815 spin_unlock_irqrestore(&s->queued_bufs_lock, flags);
818 /* The user yanked out the cable... */
819 static void msi3101_disconnect(struct usb_interface *intf)
821 struct v4l2_device *v = usb_get_intfdata(intf);
822 struct msi3101_state *s =
823 container_of(v, struct msi3101_state, v4l2_dev);
824 dev_dbg(&s->udev->dev, "%s:\n", __func__);
826 mutex_lock(&s->vb_queue_lock);
827 mutex_lock(&s->v4l2_lock);
828 /* No need to keep the urbs around after disconnection */
831 v4l2_device_disconnect(&s->v4l2_dev);
832 video_unregister_device(&s->vdev);
833 mutex_unlock(&s->v4l2_lock);
834 mutex_unlock(&s->vb_queue_lock);
836 v4l2_device_put(&s->v4l2_dev);
839 static int msi3101_querycap(struct file *file, void *fh,
840 struct v4l2_capability *cap)
842 struct msi3101_state *s = video_drvdata(file);
843 dev_dbg(&s->udev->dev, "%s:\n", __func__);
845 strlcpy(cap->driver, KBUILD_MODNAME, sizeof(cap->driver));
846 strlcpy(cap->card, s->vdev.name, sizeof(cap->card));
847 usb_make_path(s->udev, cap->bus_info, sizeof(cap->bus_info));
848 cap->device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_STREAMING |
850 cap->device_caps = V4L2_CAP_TUNER;
851 cap->capabilities = cap->device_caps | V4L2_CAP_DEVICE_CAPS;
856 /* Videobuf2 operations */
857 static int msi3101_queue_setup(struct vb2_queue *vq,
858 const struct v4l2_format *fmt, unsigned int *nbuffers,
859 unsigned int *nplanes, unsigned int sizes[], void *alloc_ctxs[])
861 struct msi3101_state *s = vb2_get_drv_priv(vq);
862 dev_dbg(&s->udev->dev, "%s: *nbuffers=%d\n", __func__, *nbuffers);
864 /* Absolute min and max number of buffers available for mmap() */
867 sizes[0] = PAGE_ALIGN(3 * 3072); /* 3 * 768 * 4 */
868 dev_dbg(&s->udev->dev, "%s: nbuffers=%d sizes[0]=%d\n",
869 __func__, *nbuffers, sizes[0]);
873 static int msi3101_buf_init(struct vb2_buffer *vb)
875 struct msi3101_state *s = vb2_get_drv_priv(vb->vb2_queue);
876 struct msi3101_frame_buf *fbuf =
877 container_of(vb, struct msi3101_frame_buf, vb);
878 dev_dbg(&s->udev->dev, "%s:\n", __func__);
880 fbuf->data = vzalloc(ISO_MAX_FRAME_SIZE);
881 if (fbuf->data == NULL)
887 static int msi3101_buf_prepare(struct vb2_buffer *vb)
889 struct msi3101_state *s = vb2_get_drv_priv(vb->vb2_queue);
891 /* Don't allow queing new buffers after device disconnection */
898 #ifdef MSI3101_CONVERT_IN_URB_HANDLER
899 static int msi3101_buf_finish(struct vb2_buffer *vb)
904 static int msi3101_buf_finish(struct vb2_buffer *vb)
906 struct msi3101_state *s = vb2_get_drv_priv(vb->vb2_queue);
907 struct msi3101_frame_buf *fbuf =
908 container_of(vb, struct msi3101_frame_buf, vb);
910 u32 *dst = vb2_plane_vaddr(&fbuf->vb, 0);
911 ret = msi3101_convert_stream(s, dst, fbuf->data, fbuf->filled);
912 vb2_set_plane_payload(&fbuf->vb, 0, ret);
917 static void msi3101_buf_cleanup(struct vb2_buffer *vb)
919 struct msi3101_state *s = vb2_get_drv_priv(vb->vb2_queue);
920 struct msi3101_frame_buf *buf =
921 container_of(vb, struct msi3101_frame_buf, vb);
922 dev_dbg(&s->udev->dev, "%s:\n", __func__);
926 static void msi3101_buf_queue(struct vb2_buffer *vb)
928 struct msi3101_state *s = vb2_get_drv_priv(vb->vb2_queue);
929 struct msi3101_frame_buf *buf =
930 container_of(vb, struct msi3101_frame_buf, vb);
931 unsigned long flags = 0;
933 /* Check the device has not disconnected between prep and queuing */
935 vb2_buffer_done(&buf->vb, VB2_BUF_STATE_ERROR);
939 spin_lock_irqsave(&s->queued_bufs_lock, flags);
940 list_add_tail(&buf->list, &s->queued_bufs);
941 spin_unlock_irqrestore(&s->queued_bufs_lock, flags);
944 #define CMD_WREG 0x41
945 #define CMD_START_STREAMING 0x43
946 #define CMD_STOP_STREAMING 0x45
947 #define CMD_READ_UNKNOW 0x48
949 #define msi3101_dbg_usb_control_msg(udev, r, t, v, _i, b, l) { \
951 if (t == (USB_TYPE_VENDOR | USB_DIR_OUT)) \
955 dev_dbg(&udev->dev, "%s: %02x %02x %02x %02x %02x %02x %02x %02x " \
956 "%s %*ph\n", __func__, t, r, v & 0xff, v >> 8, \
957 _i & 0xff, _i >> 8, l & 0xff, l >> 8, direction, l, b); \
960 static int msi3101_ctrl_msg(struct msi3101_state *s, u8 cmd, u32 data)
964 u8 requesttype = USB_DIR_OUT | USB_TYPE_VENDOR;
965 u16 value = (data >> 0) & 0xffff;
966 u16 index = (data >> 16) & 0xffff;
968 msi3101_dbg_usb_control_msg(s->udev,
969 request, requesttype, value, index, NULL, 0);
971 ret = usb_control_msg(s->udev, usb_sndctrlpipe(s->udev, 0),
972 request, requesttype, value, index, NULL, 0, 2000);
975 dev_err(&s->udev->dev, "%s: failed %d, cmd %02x, data %04x\n",
976 __func__, ret, cmd, data);
981 static int msi3101_tuner_write(struct msi3101_state *s, u32 data)
983 return msi3101_ctrl_msg(s, CMD_WREG, data << 8 | 0x09);
986 #define F_REF 24000000
988 static int msi3101_set_usb_adc(struct msi3101_state *s)
990 int ret, div_n, div_m, div_r_out, f_sr, f_vco;
993 * Synthesizer config is just a educated guess...
995 * [7:0] 0x03, register address
998 * [12:10] output divider
1001 * [15] increase sr by max fract
1017 * VCO 202000000 - 720000000++
1020 f_sr = s->ctrl_sampling_rate->val64;
1023 for (div_r_out = 4; div_r_out < 16; div_r_out += 2) {
1024 f_vco = f_sr * div_r_out * 12;
1025 dev_dbg(&s->udev->dev, "%s: div_r_out=%d f_vco=%d\n",
1026 __func__, div_r_out, f_vco);
1027 if (f_vco >= 202000000)
1031 div_n = f_vco / (F_REF * DIV_R_IN);
1032 div_m = f_vco % (F_REF * DIV_R_IN);
1034 reg3 |= div_n << 16;
1035 reg3 |= (div_r_out / 2 - 1) << 10;
1036 reg4 = 0x0ffffful * div_m / F_REF;
1038 if (reg4 >= 0x0ffffful) {
1039 dev_dbg(&s->udev->dev,
1040 "%s: extending fractional part value %08x\n",
1046 reg4 = (reg4 << 8) | 0x04;
1048 dev_dbg(&s->udev->dev,
1049 "%s: f_sr=%d f_vco=%d div_n=%d div_m=%d div_r_out=%d reg4=%08x\n",
1050 __func__, f_sr, f_vco, div_n, div_m, div_r_out, reg4);
1052 ret = msi3101_ctrl_msg(s, CMD_WREG, 0x00608008);
1056 ret = msi3101_ctrl_msg(s, CMD_WREG, 0x00000c05);
1060 ret = msi3101_ctrl_msg(s, CMD_WREG, 0x00020000);
1064 ret = msi3101_ctrl_msg(s, CMD_WREG, 0x00480102);
1068 ret = msi3101_ctrl_msg(s, CMD_WREG, 0x00f38008);
1072 ret = msi3101_ctrl_msg(s, CMD_WREG, 0x0000a507);
1076 ret = msi3101_ctrl_msg(s, CMD_WREG, reg4);
1080 ret = msi3101_ctrl_msg(s, CMD_WREG, reg3);
1087 static int msi3101_set_tuner(struct msi3101_state *s)
1090 u32 reg, synthstep, thresh, n, frac;
1093 const struct msi3101_gain *gain_lut;
1094 static const struct {
1099 { 30000000, 0x01, 16}, /* AM_MODE1 */
1100 {108000000, 0x02, 32}, /* VHF_MODE */
1101 {240000000, 0x04, 16}, /* B3_MODE */
1102 {960000000, 0x08, 4}, /* B45_MODE */
1103 {167500000, 0x10, 2}, /* BL_MODE */
1105 static const struct {
1109 { 0, 0x03}, /* Zero IF */
1110 { 450000, 0x02}, /* 450 kHz IF */
1111 {1620000, 0x01}, /* 1.62 MHz IF */
1112 {2048000, 0x00}, /* 2.048 MHz IF */
1114 static const struct {
1117 } bandwidth_lut[] = {
1118 { 200000, 0x00}, /* 200 kHz */
1119 { 300000, 0x01}, /* 300 kHz */
1120 { 600000, 0x02}, /* 600 kHz */
1121 {1536000, 0x03}, /* 1.536 MHz */
1122 {5000000, 0x04}, /* 5 MHz */
1123 {6000000, 0x05}, /* 6 MHz */
1124 {7000000, 0x06}, /* 7 MHz */
1125 {8000000, 0x07}, /* 8 MHz */
1128 unsigned int rf_freq = s->ctrl_tuner_rf->val64;
1132 * 200000, 300000, 600000, 1536000, 5000000, 6000000, 7000000, 8000000
1134 int bandwidth = s->ctrl_tuner_bw->val;
1137 * intermediate frequency (Hz)
1138 * 0, 450000, 1620000, 2048000
1140 int if_freq = s->ctrl_tuner_if->val;
1143 * gain reduction (dB)
1144 * 0 - 102 below 420 MHz
1145 * 0 - 85 above 420 MHz
1147 int gain = s->ctrl_tuner_gain->val;
1149 dev_dbg(&s->udev->dev,
1150 "%s: rf_freq=%d bandwidth=%d if_freq=%d gain=%d\n",
1151 __func__, rf_freq, bandwidth, if_freq, gain);
1155 for (i = 0; i < ARRAY_SIZE(band_lut); i++) {
1156 if (rf_freq <= band_lut[i].rf) {
1157 mode = band_lut[i].mode;
1158 lo_div = band_lut[i].lo_div;
1163 if (i == ARRAY_SIZE(band_lut))
1166 for (i = 0; i < ARRAY_SIZE(if_freq_lut); i++) {
1167 if (if_freq == if_freq_lut[i].freq) {
1168 if_freq = if_freq_lut[i].val;
1173 if (i == ARRAY_SIZE(if_freq_lut))
1176 for (i = 0; i < ARRAY_SIZE(bandwidth_lut); i++) {
1177 if (bandwidth == bandwidth_lut[i].freq) {
1178 bandwidth = bandwidth_lut[i].val;
1183 if (i == ARRAY_SIZE(bandwidth_lut))
1187 #define FREF1 24000000
1188 fsynth = (rf_freq + 0) * lo_div;
1189 synthstep = FSTEP * lo_div;
1190 thresh = (FREF1 * 4) / synthstep;
1191 n = fsynth / (FREF1 * 4);
1192 frac = thresh * (fsynth % (FREF1 * 4)) / (FREF1 * 4);
1194 if (thresh > 4095 || n > 63 || frac > 4095) {
1195 dev_dbg(&s->udev->dev,
1196 "%s: synth setup failed rf=%d thresh=%d n=%d frac=%d\n",
1197 __func__, rf_freq, thresh, n, frac);
1202 ret = msi3101_tuner_write(s, 0x00000e);
1203 ret = msi3101_tuner_write(s, 0x000003);
1208 reg |= if_freq << 12;
1209 reg |= bandwidth << 14;
1212 ret = msi3101_tuner_write(s, reg);
1220 ret = msi3101_tuner_write(s, reg);
1227 ret = msi3101_tuner_write(s, reg);
1231 if (rf_freq < 120000000) {
1232 gain_lut = msi3101_gain_lut_120;
1233 len = ARRAY_SIZE(msi3101_gain_lut_120);
1234 } else if (rf_freq < 245000000) {
1235 gain_lut = msi3101_gain_lut_245;
1236 len = ARRAY_SIZE(msi3101_gain_lut_120);
1238 gain_lut = msi3101_gain_lut_1000;
1239 len = ARRAY_SIZE(msi3101_gain_lut_1000);
1242 for (i = 0; i < len; i++) {
1243 if (gain_lut[i].tot >= gain)
1250 dev_dbg(&s->udev->dev,
1251 "%s: gain tot=%d baseband=%d lna=%d mixer=%d\n",
1252 __func__, gain_lut[i].tot, gain_lut[i].baseband,
1253 gain_lut[i].lna, gain_lut[i].mixer);
1256 reg |= gain_lut[i].baseband << 4;
1258 reg |= gain_lut[i].mixer << 12;
1259 reg |= gain_lut[i].lna << 13;
1262 ret = msi3101_tuner_write(s, reg);
1269 ret = msi3101_tuner_write(s, reg);
1275 dev_dbg(&s->udev->dev, "%s: failed %d\n", __func__, ret);
1279 static int msi3101_start_streaming(struct vb2_queue *vq, unsigned int count)
1281 struct msi3101_state *s = vb2_get_drv_priv(vq);
1283 dev_dbg(&s->udev->dev, "%s:\n", __func__);
1288 if (mutex_lock_interruptible(&s->v4l2_lock))
1289 return -ERESTARTSYS;
1291 ret = msi3101_set_usb_adc(s);
1293 ret = msi3101_isoc_init(s);
1295 msi3101_cleanup_queued_bufs(s);
1297 ret = msi3101_ctrl_msg(s, CMD_START_STREAMING, 0);
1299 mutex_unlock(&s->v4l2_lock);
1304 static int msi3101_stop_streaming(struct vb2_queue *vq)
1306 struct msi3101_state *s = vb2_get_drv_priv(vq);
1307 dev_dbg(&s->udev->dev, "%s:\n", __func__);
1309 if (mutex_lock_interruptible(&s->v4l2_lock))
1310 return -ERESTARTSYS;
1313 msi3101_isoc_cleanup(s);
1315 msi3101_cleanup_queued_bufs(s);
1317 /* according to tests, at least 700us delay is required */
1319 msi3101_ctrl_msg(s, CMD_STOP_STREAMING, 0);
1321 mutex_unlock(&s->v4l2_lock);
1326 static struct vb2_ops msi3101_vb2_ops = {
1327 .queue_setup = msi3101_queue_setup,
1328 .buf_init = msi3101_buf_init,
1329 .buf_prepare = msi3101_buf_prepare,
1330 .buf_finish = msi3101_buf_finish,
1331 .buf_cleanup = msi3101_buf_cleanup,
1332 .buf_queue = msi3101_buf_queue,
1333 .start_streaming = msi3101_start_streaming,
1334 .stop_streaming = msi3101_stop_streaming,
1335 .wait_prepare = vb2_ops_wait_prepare,
1336 .wait_finish = vb2_ops_wait_finish,
1339 static int msi3101_enum_input(struct file *file, void *fh, struct v4l2_input *i)
1344 strlcpy(i->name, "SDR data", sizeof(i->name));
1345 i->type = V4L2_INPUT_TYPE_CAMERA;
1350 static int msi3101_g_input(struct file *file, void *fh, unsigned int *i)
1357 static int msi3101_s_input(struct file *file, void *fh, unsigned int i)
1359 return i ? -EINVAL : 0;
1362 static int vidioc_s_tuner(struct file *file, void *priv,
1363 const struct v4l2_tuner *v)
1365 struct msi3101_state *s = video_drvdata(file);
1366 dev_dbg(&s->udev->dev, "%s:\n", __func__);
1371 static int vidioc_g_tuner(struct file *file, void *priv, struct v4l2_tuner *v)
1373 struct msi3101_state *s = video_drvdata(file);
1374 dev_dbg(&s->udev->dev, "%s:\n", __func__);
1376 strcpy(v->name, "SDR RX");
1377 v->capability = V4L2_TUNER_CAP_LOW;
1382 static int vidioc_s_frequency(struct file *file, void *priv,
1383 const struct v4l2_frequency *f)
1385 struct msi3101_state *s = video_drvdata(file);
1386 dev_dbg(&s->udev->dev, "%s: frequency=%u Hz (%d)\n",
1387 __func__, f->frequency * 625U / 10U, f->frequency);
1389 return v4l2_ctrl_s_ctrl_int64(s->ctrl_tuner_rf,
1390 f->frequency * 625U / 10U);
1393 const struct v4l2_ioctl_ops msi3101_ioctl_ops = {
1394 .vidioc_querycap = msi3101_querycap,
1396 .vidioc_enum_input = msi3101_enum_input,
1397 .vidioc_g_input = msi3101_g_input,
1398 .vidioc_s_input = msi3101_s_input,
1400 .vidioc_reqbufs = vb2_ioctl_reqbufs,
1401 .vidioc_create_bufs = vb2_ioctl_create_bufs,
1402 .vidioc_prepare_buf = vb2_ioctl_prepare_buf,
1403 .vidioc_querybuf = vb2_ioctl_querybuf,
1404 .vidioc_qbuf = vb2_ioctl_qbuf,
1405 .vidioc_dqbuf = vb2_ioctl_dqbuf,
1407 .vidioc_streamon = vb2_ioctl_streamon,
1408 .vidioc_streamoff = vb2_ioctl_streamoff,
1410 .vidioc_g_tuner = vidioc_g_tuner,
1411 .vidioc_s_tuner = vidioc_s_tuner,
1412 .vidioc_s_frequency = vidioc_s_frequency,
1414 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
1415 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
1416 .vidioc_log_status = v4l2_ctrl_log_status,
1419 static const struct v4l2_file_operations msi3101_fops = {
1420 .owner = THIS_MODULE,
1421 .open = v4l2_fh_open,
1422 .release = vb2_fop_release,
1423 .read = vb2_fop_read,
1424 .poll = vb2_fop_poll,
1425 .mmap = vb2_fop_mmap,
1426 .unlocked_ioctl = video_ioctl2,
1429 static struct video_device msi3101_template = {
1430 .name = "Mirics MSi3101 SDR Dongle",
1431 .release = video_device_release_empty,
1432 .fops = &msi3101_fops,
1433 .ioctl_ops = &msi3101_ioctl_ops,
1436 static int msi3101_s_ctrl(struct v4l2_ctrl *ctrl)
1438 struct msi3101_state *s =
1439 container_of(ctrl->handler, struct msi3101_state,
1442 dev_dbg(&s->udev->dev,
1443 "%s: id=%d name=%s val=%d min=%d max=%d step=%d\n",
1444 __func__, ctrl->id, ctrl->name, ctrl->val,
1445 ctrl->minimum, ctrl->maximum, ctrl->step);
1448 case MSI3101_CID_SAMPLING_MODE:
1449 case MSI3101_CID_SAMPLING_RATE:
1450 case MSI3101_CID_SAMPLING_RESOLUTION:
1453 case MSI3101_CID_TUNER_RF:
1454 case MSI3101_CID_TUNER_BW:
1455 case MSI3101_CID_TUNER_IF:
1456 case MSI3101_CID_TUNER_GAIN:
1457 ret = msi3101_set_tuner(s);
1466 static const struct v4l2_ctrl_ops msi3101_ctrl_ops = {
1467 .s_ctrl = msi3101_s_ctrl,
1470 static void msi3101_video_release(struct v4l2_device *v)
1472 struct msi3101_state *s =
1473 container_of(v, struct msi3101_state, v4l2_dev);
1475 v4l2_ctrl_handler_free(&s->ctrl_handler);
1476 v4l2_device_unregister(&s->v4l2_dev);
1480 static int msi3101_probe(struct usb_interface *intf,
1481 const struct usb_device_id *id)
1483 struct usb_device *udev = interface_to_usbdev(intf);
1484 struct msi3101_state *s = NULL;
1486 static const char * const ctrl_sampling_mode_qmenu_strings[] = {
1487 "Quadrature Sampling",
1490 static const struct v4l2_ctrl_config ctrl_sampling_mode = {
1491 .ops = &msi3101_ctrl_ops,
1492 .id = MSI3101_CID_SAMPLING_MODE,
1493 .type = V4L2_CTRL_TYPE_MENU,
1494 .flags = V4L2_CTRL_FLAG_INACTIVE,
1495 .name = "Sampling Mode",
1496 .qmenu = ctrl_sampling_mode_qmenu_strings,
1498 static const struct v4l2_ctrl_config ctrl_sampling_rate = {
1499 .ops = &msi3101_ctrl_ops,
1500 .id = MSI3101_CID_SAMPLING_RATE,
1501 .type = V4L2_CTRL_TYPE_INTEGER64,
1502 .name = "Sampling Rate",
1508 static const struct v4l2_ctrl_config ctrl_sampling_resolution = {
1509 .ops = &msi3101_ctrl_ops,
1510 .id = MSI3101_CID_SAMPLING_RESOLUTION,
1511 .type = V4L2_CTRL_TYPE_INTEGER,
1512 .flags = V4L2_CTRL_FLAG_INACTIVE,
1513 .name = "Sampling Resolution",
1519 static const struct v4l2_ctrl_config ctrl_tuner_rf = {
1520 .ops = &msi3101_ctrl_ops,
1521 .id = MSI3101_CID_TUNER_RF,
1522 .type = V4L2_CTRL_TYPE_INTEGER64,
1529 static const struct v4l2_ctrl_config ctrl_tuner_bw = {
1530 .ops = &msi3101_ctrl_ops,
1531 .id = MSI3101_CID_TUNER_BW,
1532 .type = V4L2_CTRL_TYPE_INTEGER,
1539 static const struct v4l2_ctrl_config ctrl_tuner_if = {
1540 .ops = &msi3101_ctrl_ops,
1541 .id = MSI3101_CID_TUNER_IF,
1542 .type = V4L2_CTRL_TYPE_INTEGER,
1543 .flags = V4L2_CTRL_FLAG_INACTIVE,
1550 static const struct v4l2_ctrl_config ctrl_tuner_gain = {
1551 .ops = &msi3101_ctrl_ops,
1552 .id = MSI3101_CID_TUNER_GAIN,
1553 .type = V4L2_CTRL_TYPE_INTEGER,
1554 .name = "Tuner Gain",
1561 s = kzalloc(sizeof(struct msi3101_state), GFP_KERNEL);
1563 pr_err("Could not allocate memory for msi3101_state\n");
1567 mutex_init(&s->v4l2_lock);
1568 mutex_init(&s->vb_queue_lock);
1569 spin_lock_init(&s->queued_bufs_lock);
1570 INIT_LIST_HEAD(&s->queued_bufs);
1574 /* Init videobuf2 queue structure */
1575 s->vb_queue.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1576 s->vb_queue.io_modes = VB2_MMAP | VB2_USERPTR | VB2_READ;
1577 s->vb_queue.drv_priv = s;
1578 s->vb_queue.buf_struct_size = sizeof(struct msi3101_frame_buf);
1579 s->vb_queue.ops = &msi3101_vb2_ops;
1580 s->vb_queue.mem_ops = &vb2_vmalloc_memops;
1581 s->vb_queue.timestamp_type = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
1582 ret = vb2_queue_init(&s->vb_queue);
1584 dev_err(&s->udev->dev, "Could not initialize vb2 queue\n");
1588 /* Init video_device structure */
1589 s->vdev = msi3101_template;
1590 s->vdev.queue = &s->vb_queue;
1591 s->vdev.queue->lock = &s->vb_queue_lock;
1592 set_bit(V4L2_FL_USE_FH_PRIO, &s->vdev.flags);
1593 video_set_drvdata(&s->vdev, s);
1595 /* Register controls */
1596 v4l2_ctrl_handler_init(&s->ctrl_handler, 7);
1597 v4l2_ctrl_new_custom(&s->ctrl_handler, &ctrl_sampling_mode, NULL);
1598 s->ctrl_sampling_rate = v4l2_ctrl_new_custom(&s->ctrl_handler, &ctrl_sampling_rate, NULL);
1599 v4l2_ctrl_new_custom(&s->ctrl_handler, &ctrl_sampling_resolution, NULL);
1600 s->ctrl_tuner_rf = v4l2_ctrl_new_custom(&s->ctrl_handler, &ctrl_tuner_rf, NULL);
1601 s->ctrl_tuner_bw = v4l2_ctrl_new_custom(&s->ctrl_handler, &ctrl_tuner_bw, NULL);
1602 s->ctrl_tuner_if = v4l2_ctrl_new_custom(&s->ctrl_handler, &ctrl_tuner_if, NULL);
1603 s->ctrl_tuner_gain = v4l2_ctrl_new_custom(&s->ctrl_handler, &ctrl_tuner_gain, NULL);
1604 if (s->ctrl_handler.error) {
1605 ret = s->ctrl_handler.error;
1606 dev_err(&s->udev->dev, "Could not initialize controls\n");
1607 goto err_free_controls;
1610 /* Register the v4l2_device structure */
1611 s->v4l2_dev.release = msi3101_video_release;
1612 ret = v4l2_device_register(&intf->dev, &s->v4l2_dev);
1614 dev_err(&s->udev->dev,
1615 "Failed to register v4l2-device (%d)\n", ret);
1616 goto err_free_controls;
1619 s->v4l2_dev.ctrl_handler = &s->ctrl_handler;
1620 s->vdev.v4l2_dev = &s->v4l2_dev;
1621 s->vdev.lock = &s->v4l2_lock;
1623 ret = video_register_device(&s->vdev, VFL_TYPE_GRABBER, -1);
1625 dev_err(&s->udev->dev,
1626 "Failed to register as video device (%d)\n",
1628 goto err_unregister_v4l2_dev;
1630 dev_info(&s->udev->dev, "Registered as %s\n",
1631 video_device_node_name(&s->vdev));
1635 err_unregister_v4l2_dev:
1636 v4l2_device_unregister(&s->v4l2_dev);
1638 v4l2_ctrl_handler_free(&s->ctrl_handler);
1644 /* USB device ID list */
1645 static struct usb_device_id msi3101_id_table[] = {
1646 { USB_DEVICE(0x1df7, 0x2500) },
1647 { USB_DEVICE(0x2040, 0xd300) }, /* Hauppauge WinTV 133559 LF */
1650 MODULE_DEVICE_TABLE(usb, msi3101_id_table);
1652 /* USB subsystem interface */
1653 static struct usb_driver msi3101_driver = {
1654 .name = KBUILD_MODNAME,
1655 .probe = msi3101_probe,
1656 .disconnect = msi3101_disconnect,
1657 .id_table = msi3101_id_table,
1660 module_usb_driver(msi3101_driver);
1662 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
1663 MODULE_DESCRIPTION("Mirics MSi3101 SDR Dongle");
1664 MODULE_LICENSE("GPL");