diff options
Diffstat (limited to 'drivers/media/usb/msi2500/msi2500.c')
| -rw-r--r-- | drivers/media/usb/msi2500/msi2500.c | 1309 |
1 files changed, 1309 insertions, 0 deletions
diff --git a/drivers/media/usb/msi2500/msi2500.c b/drivers/media/usb/msi2500/msi2500.c new file mode 100644 index 0000000000..9759996ee6 --- /dev/null +++ b/drivers/media/usb/msi2500/msi2500.c @@ -0,0 +1,1309 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * Mirics MSi2500 driver + * Mirics MSi3101 SDR Dongle driver + * + * Copyright (C) 2013 Antti Palosaari <crope@iki.fi> + * + * That driver is somehow based of pwc driver: + * (C) 1999-2004 Nemosoft Unv. + * (C) 2004-2006 Luc Saillard (luc@saillard.org) + * (C) 2011 Hans de Goede <hdegoede@redhat.com> + */ + +#include <linux/module.h> +#include <linux/slab.h> +#include <asm/div64.h> +#include <media/v4l2-device.h> +#include <media/v4l2-ioctl.h> +#include <media/v4l2-ctrls.h> +#include <media/v4l2-event.h> +#include <linux/usb.h> +#include <media/videobuf2-v4l2.h> +#include <media/videobuf2-vmalloc.h> +#include <linux/spi/spi.h> + +static bool msi2500_emulated_fmt; +module_param_named(emulated_formats, msi2500_emulated_fmt, bool, 0644); +MODULE_PARM_DESC(emulated_formats, "enable emulated formats (disappears in future)"); + +/* + * iConfiguration 0 + * bInterfaceNumber 0 + * bAlternateSetting 1 + * bNumEndpoints 1 + * bEndpointAddress 0x81 EP 1 IN + * bmAttributes 1 + * Transfer Type Isochronous + * wMaxPacketSize 0x1400 3x 1024 bytes + * bInterval 1 + */ +#define MAX_ISO_BUFS (8) +#define ISO_FRAMES_PER_DESC (8) +#define ISO_MAX_FRAME_SIZE (3 * 1024) +#define ISO_BUFFER_SIZE (ISO_FRAMES_PER_DESC * ISO_MAX_FRAME_SIZE) +#define MAX_ISOC_ERRORS 20 + +/* + * TODO: These formats should be moved to V4L2 API. Formats are currently + * disabled from formats[] table, not visible to userspace. + */ + /* signed 12-bit */ +#define MSI2500_PIX_FMT_SDR_S12 v4l2_fourcc('D', 'S', '1', '2') +/* Mirics MSi2500 format 384 */ +#define MSI2500_PIX_FMT_SDR_MSI2500_384 v4l2_fourcc('M', '3', '8', '4') + +static const struct v4l2_frequency_band bands[] = { + { + .tuner = 0, + .type = V4L2_TUNER_ADC, + .index = 0, + .capability = V4L2_TUNER_CAP_1HZ | V4L2_TUNER_CAP_FREQ_BANDS, + .rangelow = 1200000, + .rangehigh = 15000000, + }, +}; + +/* stream formats */ +struct msi2500_format { + u32 pixelformat; + u32 buffersize; +}; + +/* format descriptions for capture and preview */ +static struct msi2500_format formats[] = { + { + .pixelformat = V4L2_SDR_FMT_CS8, + .buffersize = 3 * 1008, +#if 0 + }, { + .pixelformat = MSI2500_PIX_FMT_SDR_MSI2500_384, + }, { + .pixelformat = MSI2500_PIX_FMT_SDR_S12, +#endif + }, { + .pixelformat = V4L2_SDR_FMT_CS14LE, + .buffersize = 3 * 1008, + }, { + .pixelformat = V4L2_SDR_FMT_CU8, + .buffersize = 3 * 1008, + }, { + .pixelformat = V4L2_SDR_FMT_CU16LE, + .buffersize = 3 * 1008, + }, +}; + +static const unsigned int NUM_FORMATS = ARRAY_SIZE(formats); + +/* intermediate buffers with raw data from the USB device */ +struct msi2500_frame_buf { + /* common v4l buffer stuff -- must be first */ + struct vb2_v4l2_buffer vb; + struct list_head list; +}; + +struct msi2500_dev { + struct device *dev; + struct video_device vdev; + struct v4l2_device v4l2_dev; + struct v4l2_subdev *v4l2_subdev; + struct spi_master *master; + + /* videobuf2 queue and queued buffers list */ + struct vb2_queue vb_queue; + struct list_head queued_bufs; + spinlock_t queued_bufs_lock; /* Protects queued_bufs */ + + /* Note if taking both locks v4l2_lock must always be locked first! */ + struct mutex v4l2_lock; /* Protects everything else */ + struct mutex vb_queue_lock; /* Protects vb_queue and capt_file */ + + /* Pointer to our usb_device, will be NULL after unplug */ + struct usb_device *udev; /* Both mutexes most be hold when setting! */ + + unsigned int f_adc; + u32 pixelformat; + u32 buffersize; + unsigned int num_formats; + + unsigned int isoc_errors; /* number of contiguous ISOC errors */ + unsigned int vb_full; /* vb is full and packets dropped */ + + struct urb *urbs[MAX_ISO_BUFS]; + + /* Controls */ + struct v4l2_ctrl_handler hdl; + + u32 next_sample; /* for track lost packets */ + u32 sample; /* for sample rate calc */ + unsigned long jiffies_next; +}; + +/* Private functions */ +static struct msi2500_frame_buf *msi2500_get_next_fill_buf( + struct msi2500_dev *dev) +{ + unsigned long flags; + struct msi2500_frame_buf *buf = NULL; + + spin_lock_irqsave(&dev->queued_bufs_lock, flags); + if (list_empty(&dev->queued_bufs)) + goto leave; + + buf = list_entry(dev->queued_bufs.next, struct msi2500_frame_buf, list); + list_del(&buf->list); +leave: + spin_unlock_irqrestore(&dev->queued_bufs_lock, flags); + return buf; +} + +/* + * +=========================================================================== + * | 00-1023 | USB packet type '504' + * +=========================================================================== + * | 00- 03 | sequence number of first sample in that USB packet + * +--------------------------------------------------------------------------- + * | 04- 15 | garbage + * +--------------------------------------------------------------------------- + * | 16-1023 | samples + * +--------------------------------------------------------------------------- + * signed 8-bit sample + * 504 * 2 = 1008 samples + * + * + * +=========================================================================== + * | 00-1023 | USB packet type '384' + * +=========================================================================== + * | 00- 03 | sequence number of first sample in that USB packet + * +--------------------------------------------------------------------------- + * | 04- 15 | garbage + * +--------------------------------------------------------------------------- + * | 16- 175 | samples + * +--------------------------------------------------------------------------- + * | 176- 179 | control bits for previous samples + * +--------------------------------------------------------------------------- + * | 180- 339 | samples + * +--------------------------------------------------------------------------- + * | 340- 343 | control bits for previous samples + * +--------------------------------------------------------------------------- + * | 344- 503 | samples + * +--------------------------------------------------------------------------- + * | 504- 507 | control bits for previous samples + * +--------------------------------------------------------------------------- + * | 508- 667 | samples + * +--------------------------------------------------------------------------- + * | 668- 671 | control bits for previous samples + * +--------------------------------------------------------------------------- + * | 672- 831 | samples + * +--------------------------------------------------------------------------- + * | 832- 835 | control bits for previous samples + * +--------------------------------------------------------------------------- + * | 836- 995 | samples + * +--------------------------------------------------------------------------- + * | 996- 999 | control bits for previous samples + * +--------------------------------------------------------------------------- + * | 1000-1023 | garbage + * +--------------------------------------------------------------------------- + * + * Bytes 4 - 7 could have some meaning? + * + * Control bits for previous samples is 32-bit field, containing 16 x 2-bit + * numbers. This results one 2-bit number for 8 samples. It is likely used for + * bit shifting sample by given bits, increasing actual sampling resolution. + * Number 2 (0b10) was never seen. + * + * 6 * 16 * 2 * 4 = 768 samples. 768 * 4 = 3072 bytes + * + * + * +=========================================================================== + * | 00-1023 | USB packet type '336' + * +=========================================================================== + * | 00- 03 | sequence number of first sample in that USB packet + * +--------------------------------------------------------------------------- + * | 04- 15 | garbage + * +--------------------------------------------------------------------------- + * | 16-1023 | samples + * +--------------------------------------------------------------------------- + * signed 12-bit sample + * + * + * +=========================================================================== + * | 00-1023 | USB packet type '252' + * +=========================================================================== + * | 00- 03 | sequence number of first sample in that USB packet + * +--------------------------------------------------------------------------- + * | 04- 15 | garbage + * +--------------------------------------------------------------------------- + * | 16-1023 | samples + * +--------------------------------------------------------------------------- + * signed 14-bit sample + */ + +static int msi2500_convert_stream(struct msi2500_dev *dev, u8 *dst, u8 *src, + unsigned int src_len) +{ + unsigned int i, j, transactions, dst_len = 0; + u32 sample[3]; + + /* There could be 1-3 1024 byte transactions per packet */ + transactions = src_len / 1024; + + for (i = 0; i < transactions; i++) { + sample[i] = src[3] << 24 | src[2] << 16 | src[1] << 8 | + src[0] << 0; + if (i == 0 && dev->next_sample != sample[0]) { + dev_dbg_ratelimited(dev->dev, + "%d samples lost, %d %08x:%08x\n", + sample[0] - dev->next_sample, + src_len, dev->next_sample, + sample[0]); + } + + /* + * Dump all unknown 'garbage' data - maybe we will discover + * someday if there is something rational... + */ + dev_dbg_ratelimited(dev->dev, "%*ph\n", 12, &src[4]); + + src += 16; /* skip header */ + + switch (dev->pixelformat) { + case V4L2_SDR_FMT_CU8: /* 504 x IQ samples */ + { + s8 *s8src = (s8 *)src; + u8 *u8dst = (u8 *)dst; + + for (j = 0; j < 1008; j++) + *u8dst++ = *s8src++ + 128; + + src += 1008; + dst += 1008; + dst_len += 1008; + dev->next_sample = sample[i] + 504; + break; + } + case V4L2_SDR_FMT_CU16LE: /* 252 x IQ samples */ + { + s16 *s16src = (s16 *)src; + u16 *u16dst = (u16 *)dst; + struct {signed int x:14; } se; /* sign extension */ + unsigned int utmp; + + for (j = 0; j < 1008; j += 2) { + /* sign extension from 14-bit to signed int */ + se.x = *s16src++; + /* from signed int to unsigned int */ + utmp = se.x + 8192; + /* from 14-bit to 16-bit */ + *u16dst++ = utmp << 2 | utmp >> 12; + } + + src += 1008; + dst += 1008; + dst_len += 1008; + dev->next_sample = sample[i] + 252; + break; + } + case MSI2500_PIX_FMT_SDR_MSI2500_384: /* 384 x IQ samples */ + /* Dump unknown 'garbage' data */ + dev_dbg_ratelimited(dev->dev, "%*ph\n", 24, &src[1000]); + memcpy(dst, src, 984); + src += 984 + 24; + dst += 984; + dst_len += 984; + dev->next_sample = sample[i] + 384; + break; + case V4L2_SDR_FMT_CS8: /* 504 x IQ samples */ + memcpy(dst, src, 1008); + src += 1008; + dst += 1008; + dst_len += 1008; + dev->next_sample = sample[i] + 504; + break; + case MSI2500_PIX_FMT_SDR_S12: /* 336 x IQ samples */ + memcpy(dst, src, 1008); + src += 1008; + dst += 1008; + dst_len += 1008; + dev->next_sample = sample[i] + 336; + break; + case V4L2_SDR_FMT_CS14LE: /* 252 x IQ samples */ + memcpy(dst, src, 1008); + src += 1008; + dst += 1008; + dst_len += 1008; + dev->next_sample = sample[i] + 252; + break; + default: + break; + } + } + + /* calculate sample rate and output it in 10 seconds intervals */ + if (unlikely(time_is_before_jiffies(dev->jiffies_next))) { + #define MSECS 10000UL + unsigned int msecs = jiffies_to_msecs(jiffies - + dev->jiffies_next + msecs_to_jiffies(MSECS)); + unsigned int samples = dev->next_sample - dev->sample; + + dev->jiffies_next = jiffies + msecs_to_jiffies(MSECS); + dev->sample = dev->next_sample; + dev_dbg(dev->dev, "size=%u samples=%u msecs=%u sample rate=%lu\n", + src_len, samples, msecs, + samples * 1000UL / msecs); + } + + return dst_len; +} + +/* + * This gets called for the Isochronous pipe (stream). This is done in interrupt + * time, so it has to be fast, not crash, and not stall. Neat. + */ +static void msi2500_isoc_handler(struct urb *urb) +{ + struct msi2500_dev *dev = (struct msi2500_dev *)urb->context; + int i, flen, fstatus; + unsigned char *iso_buf = NULL; + struct msi2500_frame_buf *fbuf; + + if (unlikely(urb->status == -ENOENT || + urb->status == -ECONNRESET || + urb->status == -ESHUTDOWN)) { + dev_dbg(dev->dev, "URB (%p) unlinked %ssynchronously\n", + urb, urb->status == -ENOENT ? "" : "a"); + return; + } + + if (unlikely(urb->status != 0)) { + dev_dbg(dev->dev, "called with status %d\n", urb->status); + /* Give up after a number of contiguous errors */ + if (++dev->isoc_errors > MAX_ISOC_ERRORS) + dev_dbg(dev->dev, "Too many ISOC errors, bailing out\n"); + goto handler_end; + } else { + /* Reset ISOC error counter. We did get here, after all. */ + dev->isoc_errors = 0; + } + + /* Compact data */ + for (i = 0; i < urb->number_of_packets; i++) { + void *ptr; + + /* Check frame error */ + fstatus = urb->iso_frame_desc[i].status; + if (unlikely(fstatus)) { + dev_dbg_ratelimited(dev->dev, + "frame=%d/%d has error %d skipping\n", + i, urb->number_of_packets, fstatus); + continue; + } + + /* Check if that frame contains data */ + flen = urb->iso_frame_desc[i].actual_length; + if (unlikely(flen == 0)) + continue; + + iso_buf = urb->transfer_buffer + urb->iso_frame_desc[i].offset; + + /* Get free framebuffer */ + fbuf = msi2500_get_next_fill_buf(dev); + if (unlikely(fbuf == NULL)) { + dev->vb_full++; + dev_dbg_ratelimited(dev->dev, + "video buffer is full, %d packets dropped\n", + dev->vb_full); + continue; + } + + /* fill framebuffer */ + ptr = vb2_plane_vaddr(&fbuf->vb.vb2_buf, 0); + flen = msi2500_convert_stream(dev, ptr, iso_buf, flen); + vb2_set_plane_payload(&fbuf->vb.vb2_buf, 0, flen); + vb2_buffer_done(&fbuf->vb.vb2_buf, VB2_BUF_STATE_DONE); + } + +handler_end: + i = usb_submit_urb(urb, GFP_ATOMIC); + if (unlikely(i != 0)) + dev_dbg(dev->dev, "Error (%d) re-submitting urb\n", i); +} + +static void msi2500_iso_stop(struct msi2500_dev *dev) +{ + int i; + + dev_dbg(dev->dev, "\n"); + + /* Unlinking ISOC buffers one by one */ + for (i = 0; i < MAX_ISO_BUFS; i++) { + if (dev->urbs[i]) { + dev_dbg(dev->dev, "Unlinking URB %p\n", dev->urbs[i]); + usb_kill_urb(dev->urbs[i]); + } + } +} + +static void msi2500_iso_free(struct msi2500_dev *dev) +{ + int i; + + dev_dbg(dev->dev, "\n"); + + /* Freeing ISOC buffers one by one */ + for (i = 0; i < MAX_ISO_BUFS; i++) { + if (dev->urbs[i]) { + dev_dbg(dev->dev, "Freeing URB\n"); + if (dev->urbs[i]->transfer_buffer) { + usb_free_coherent(dev->udev, + dev->urbs[i]->transfer_buffer_length, + dev->urbs[i]->transfer_buffer, + dev->urbs[i]->transfer_dma); + } + usb_free_urb(dev->urbs[i]); + dev->urbs[i] = NULL; + } + } +} + +/* Both v4l2_lock and vb_queue_lock should be locked when calling this */ +static void msi2500_isoc_cleanup(struct msi2500_dev *dev) +{ + dev_dbg(dev->dev, "\n"); + + msi2500_iso_stop(dev); + msi2500_iso_free(dev); +} + +/* Both v4l2_lock and vb_queue_lock should be locked when calling this */ +static int msi2500_isoc_init(struct msi2500_dev *dev) +{ + struct urb *urb; + int i, j, ret; + + dev_dbg(dev->dev, "\n"); + + dev->isoc_errors = 0; + + ret = usb_set_interface(dev->udev, 0, 1); + if (ret) + return ret; + + /* Allocate and init Isochronuous urbs */ + for (i = 0; i < MAX_ISO_BUFS; i++) { + urb = usb_alloc_urb(ISO_FRAMES_PER_DESC, GFP_KERNEL); + if (urb == NULL) { + msi2500_isoc_cleanup(dev); + return -ENOMEM; + } + dev->urbs[i] = urb; + dev_dbg(dev->dev, "Allocated URB at 0x%p\n", urb); + + urb->interval = 1; + urb->dev = dev->udev; + urb->pipe = usb_rcvisocpipe(dev->udev, 0x81); + urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP; + urb->transfer_buffer = usb_alloc_coherent(dev->udev, + ISO_BUFFER_SIZE, + GFP_KERNEL, &urb->transfer_dma); + if (urb->transfer_buffer == NULL) { + dev_err(dev->dev, + "Failed to allocate urb buffer %d\n", i); + msi2500_isoc_cleanup(dev); + return -ENOMEM; + } + urb->transfer_buffer_length = ISO_BUFFER_SIZE; + urb->complete = msi2500_isoc_handler; + urb->context = dev; + urb->start_frame = 0; + urb->number_of_packets = ISO_FRAMES_PER_DESC; + for (j = 0; j < ISO_FRAMES_PER_DESC; j++) { + urb->iso_frame_desc[j].offset = j * ISO_MAX_FRAME_SIZE; + urb->iso_frame_desc[j].length = ISO_MAX_FRAME_SIZE; + } + } + + /* link */ + for (i = 0; i < MAX_ISO_BUFS; i++) { + ret = usb_submit_urb(dev->urbs[i], GFP_KERNEL); + if (ret) { + dev_err(dev->dev, + "usb_submit_urb %d failed with error %d\n", + i, ret); + msi2500_isoc_cleanup(dev); + return ret; + } + dev_dbg(dev->dev, "URB 0x%p submitted.\n", dev->urbs[i]); + } + + /* All is done... */ + return 0; +} + +/* Must be called with vb_queue_lock hold */ +static void msi2500_cleanup_queued_bufs(struct msi2500_dev *dev) +{ + unsigned long flags; + + dev_dbg(dev->dev, "\n"); + + spin_lock_irqsave(&dev->queued_bufs_lock, flags); + while (!list_empty(&dev->queued_bufs)) { + struct msi2500_frame_buf *buf; + + buf = list_entry(dev->queued_bufs.next, + struct msi2500_frame_buf, list); + list_del(&buf->list); + vb2_buffer_done(&buf->vb.vb2_buf, VB2_BUF_STATE_ERROR); + } + spin_unlock_irqrestore(&dev->queued_bufs_lock, flags); +} + +/* The user yanked out the cable... */ +static void msi2500_disconnect(struct usb_interface *intf) +{ + struct v4l2_device *v = usb_get_intfdata(intf); + struct msi2500_dev *dev = + container_of(v, struct msi2500_dev, v4l2_dev); + + dev_dbg(dev->dev, "\n"); + + mutex_lock(&dev->vb_queue_lock); + mutex_lock(&dev->v4l2_lock); + /* No need to keep the urbs around after disconnection */ + dev->udev = NULL; + v4l2_device_disconnect(&dev->v4l2_dev); + video_unregister_device(&dev->vdev); + spi_unregister_master(dev->master); + mutex_unlock(&dev->v4l2_lock); + mutex_unlock(&dev->vb_queue_lock); + + v4l2_device_put(&dev->v4l2_dev); +} + +static int msi2500_querycap(struct file *file, void *fh, + struct v4l2_capability *cap) +{ + struct msi2500_dev *dev = video_drvdata(file); + + dev_dbg(dev->dev, "\n"); + + strscpy(cap->driver, KBUILD_MODNAME, sizeof(cap->driver)); + strscpy(cap->card, dev->vdev.name, sizeof(cap->card)); + usb_make_path(dev->udev, cap->bus_info, sizeof(cap->bus_info)); + return 0; +} + +/* Videobuf2 operations */ +static int msi2500_queue_setup(struct vb2_queue *vq, + unsigned int *nbuffers, + unsigned int *nplanes, unsigned int sizes[], + struct device *alloc_devs[]) +{ + struct msi2500_dev *dev = vb2_get_drv_priv(vq); + + dev_dbg(dev->dev, "nbuffers=%d\n", *nbuffers); + + /* Absolute min and max number of buffers available for mmap() */ + *nbuffers = clamp_t(unsigned int, *nbuffers, 8, 32); + *nplanes = 1; + sizes[0] = PAGE_ALIGN(dev->buffersize); + dev_dbg(dev->dev, "nbuffers=%d sizes[0]=%d\n", *nbuffers, sizes[0]); + return 0; +} + +static void msi2500_buf_queue(struct vb2_buffer *vb) +{ + struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb); + struct msi2500_dev *dev = vb2_get_drv_priv(vb->vb2_queue); + struct msi2500_frame_buf *buf = container_of(vbuf, + struct msi2500_frame_buf, + vb); + unsigned long flags; + + /* Check the device has not disconnected between prep and queuing */ + if (unlikely(!dev->udev)) { + vb2_buffer_done(&buf->vb.vb2_buf, VB2_BUF_STATE_ERROR); + return; + } + + spin_lock_irqsave(&dev->queued_bufs_lock, flags); + list_add_tail(&buf->list, &dev->queued_bufs); + spin_unlock_irqrestore(&dev->queued_bufs_lock, flags); +} + +#define CMD_WREG 0x41 +#define CMD_START_STREAMING 0x43 +#define CMD_STOP_STREAMING 0x45 +#define CMD_READ_UNKNOWN 0x48 + +#define msi2500_dbg_usb_control_msg(_dev, _r, _t, _v, _i, _b, _l) { \ + char *_direction; \ + if (_t & USB_DIR_IN) \ + _direction = "<<<"; \ + else \ + _direction = ">>>"; \ + dev_dbg(_dev, "%02x %02x %02x %02x %02x %02x %02x %02x %s %*ph\n", \ + _t, _r, _v & 0xff, _v >> 8, _i & 0xff, _i >> 8, \ + _l & 0xff, _l >> 8, _direction, _l, _b); \ +} + +static int msi2500_ctrl_msg(struct msi2500_dev *dev, u8 cmd, u32 data) +{ + int ret; + u8 request = cmd; + u8 requesttype = USB_DIR_OUT | USB_TYPE_VENDOR; + u16 value = (data >> 0) & 0xffff; + u16 index = (data >> 16) & 0xffff; + + msi2500_dbg_usb_control_msg(dev->dev, request, requesttype, + value, index, NULL, 0); + ret = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0), request, + requesttype, value, index, NULL, 0, 2000); + if (ret) + dev_err(dev->dev, "failed %d, cmd %02x, data %04x\n", + ret, cmd, data); + + return ret; +} + +static int msi2500_set_usb_adc(struct msi2500_dev *dev) +{ + int ret; + unsigned int f_vco, f_sr, div_n, k, k_cw, div_out; + u32 reg3, reg4, reg7; + struct v4l2_ctrl *bandwidth_auto; + struct v4l2_ctrl *bandwidth; + + f_sr = dev->f_adc; + + /* set tuner, subdev, filters according to sampling rate */ + bandwidth_auto = v4l2_ctrl_find(&dev->hdl, + V4L2_CID_RF_TUNER_BANDWIDTH_AUTO); + if (v4l2_ctrl_g_ctrl(bandwidth_auto)) { + bandwidth = v4l2_ctrl_find(&dev->hdl, + V4L2_CID_RF_TUNER_BANDWIDTH); + v4l2_ctrl_s_ctrl(bandwidth, dev->f_adc); + } + + /* select stream format */ + switch (dev->pixelformat) { + case V4L2_SDR_FMT_CU8: + reg7 = 0x000c9407; /* 504 */ + break; + case V4L2_SDR_FMT_CU16LE: + reg7 = 0x00009407; /* 252 */ + break; + case V4L2_SDR_FMT_CS8: + reg7 = 0x000c9407; /* 504 */ + break; + case MSI2500_PIX_FMT_SDR_MSI2500_384: + reg7 = 0x0000a507; /* 384 */ + break; + case MSI2500_PIX_FMT_SDR_S12: + reg7 = 0x00008507; /* 336 */ + break; + case V4L2_SDR_FMT_CS14LE: + reg7 = 0x00009407; /* 252 */ + break; + default: + reg7 = 0x000c9407; /* 504 */ + break; + } + + /* + * Fractional-N synthesizer + * + * +----------------------------------------+ + * v | + * Fref +----+ +-------+ +-----+ +------+ +---+ + * ------> | PD | --> | VCO | --> | /2 | ------> | /N.F | <-- | K | + * +----+ +-------+ +-----+ +------+ +---+ + * | + * | + * v + * +-------+ +-----+ Fout + * | /Rout | --> | /12 | ------> + * +-------+ +-----+ + */ + /* + * Synthesizer config is just a educated guess... + * + * [7:0] 0x03, register address + * [8] 1, power control + * [9] ?, power control + * [12:10] output divider + * [13] 0 ? + * [14] 0 ? + * [15] fractional MSB, bit 20 + * [16:19] N + * [23:20] ? + * [24:31] 0x01 + * + * output divider + * val div + * 0 - (invalid) + * 1 4 + * 2 6 + * 3 8 + * 4 10 + * 5 12 + * 6 14 + * 7 16 + * + * VCO 202000000 - 720000000++ + */ + + #define F_REF 24000000 + #define DIV_PRE_N 2 + #define DIV_LO_OUT 12 + reg3 = 0x01000303; + reg4 = 0x00000004; + + /* XXX: Filters? AGC? VCO band? */ + if (f_sr < 6000000) + reg3 |= 0x1 << 20; + else if (f_sr < 7000000) + reg3 |= 0x5 << 20; + else if (f_sr < 8500000) + reg3 |= 0x9 << 20; + else + reg3 |= 0xd << 20; + + for (div_out = 4; div_out < 16; div_out += 2) { + f_vco = f_sr * div_out * DIV_LO_OUT; + dev_dbg(dev->dev, "div_out=%u f_vco=%u\n", div_out, f_vco); + if (f_vco >= 202000000) + break; + } + + /* Calculate PLL integer and fractional control word. */ + div_n = div_u64_rem(f_vco, DIV_PRE_N * F_REF, &k); + k_cw = div_u64((u64) k * 0x200000, DIV_PRE_N * F_REF); + + reg3 |= div_n << 16; + reg3 |= (div_out / 2 - 1) << 10; + reg3 |= ((k_cw >> 20) & 0x000001) << 15; /* [20] */ + reg4 |= ((k_cw >> 0) & 0x0fffff) << 8; /* [19:0] */ + + dev_dbg(dev->dev, + "f_sr=%u f_vco=%u div_n=%u k=%u div_out=%u reg3=%08x reg4=%08x\n", + f_sr, f_vco, div_n, k, div_out, reg3, reg4); + + ret = msi2500_ctrl_msg(dev, CMD_WREG, 0x00608008); + if (ret) + goto err; + + ret = msi2500_ctrl_msg(dev, CMD_WREG, 0x00000c05); + if (ret) + goto err; + + ret = msi2500_ctrl_msg(dev, CMD_WREG, 0x00020000); + if (ret) + goto err; + + ret = msi2500_ctrl_msg(dev, CMD_WREG, 0x00480102); + if (ret) + goto err; + + ret = msi2500_ctrl_msg(dev, CMD_WREG, 0x00f38008); + if (ret) + goto err; + + ret = msi2500_ctrl_msg(dev, CMD_WREG, reg7); + if (ret) + goto err; + + ret = msi2500_ctrl_msg(dev, CMD_WREG, reg4); + if (ret) + goto err; + + ret = msi2500_ctrl_msg(dev, CMD_WREG, reg3); +err: + return ret; +} + +static int msi2500_start_streaming(struct vb2_queue *vq, unsigned int count) +{ + struct msi2500_dev *dev = vb2_get_drv_priv(vq); + int ret; + + dev_dbg(dev->dev, "\n"); + + if (!dev->udev) + return -ENODEV; + + if (mutex_lock_interruptible(&dev->v4l2_lock)) + return -ERESTARTSYS; + + /* wake-up tuner */ + v4l2_subdev_call(dev->v4l2_subdev, core, s_power, 1); + + ret = msi2500_set_usb_adc(dev); + + ret = msi2500_isoc_init(dev); + if (ret) + msi2500_cleanup_queued_bufs(dev); + + ret = msi2500_ctrl_msg(dev, CMD_START_STREAMING, 0); + + mutex_unlock(&dev->v4l2_lock); + + return ret; +} + +static void msi2500_stop_streaming(struct vb2_queue *vq) +{ + struct msi2500_dev *dev = vb2_get_drv_priv(vq); + + dev_dbg(dev->dev, "\n"); + + mutex_lock(&dev->v4l2_lock); + + if (dev->udev) + msi2500_isoc_cleanup(dev); + + msi2500_cleanup_queued_bufs(dev); + + /* according to tests, at least 700us delay is required */ + msleep(20); + if (dev->udev && !msi2500_ctrl_msg(dev, CMD_STOP_STREAMING, 0)) { + /* sleep USB IF / ADC */ + msi2500_ctrl_msg(dev, CMD_WREG, 0x01000003); + } + + /* sleep tuner */ + v4l2_subdev_call(dev->v4l2_subdev, core, s_power, 0); + + mutex_unlock(&dev->v4l2_lock); +} + +static const struct vb2_ops msi2500_vb2_ops = { + .queue_setup = msi2500_queue_setup, + .buf_queue = msi2500_buf_queue, + .start_streaming = msi2500_start_streaming, + .stop_streaming = msi2500_stop_streaming, + .wait_prepare = vb2_ops_wait_prepare, + .wait_finish = vb2_ops_wait_finish, +}; + +static int msi2500_enum_fmt_sdr_cap(struct file *file, void *priv, + struct v4l2_fmtdesc *f) +{ + struct msi2500_dev *dev = video_drvdata(file); + + dev_dbg(dev->dev, "index=%d\n", f->index); + + if (f->index >= dev->num_formats) + return -EINVAL; + + f->pixelformat = formats[f->index].pixelformat; + + return 0; +} + +static int msi2500_g_fmt_sdr_cap(struct file *file, void *priv, + struct v4l2_format *f) +{ + struct msi2500_dev *dev = video_drvdata(file); + + dev_dbg(dev->dev, "pixelformat fourcc %4.4s\n", + (char *)&dev->pixelformat); + + f->fmt.sdr.pixelformat = dev->pixelformat; + f->fmt.sdr.buffersize = dev->buffersize; + + return 0; +} + +static int msi2500_s_fmt_sdr_cap(struct file *file, void *priv, + struct v4l2_format *f) +{ + struct msi2500_dev *dev = video_drvdata(file); + struct vb2_queue *q = &dev->vb_queue; + int i; + + dev_dbg(dev->dev, "pixelformat fourcc %4.4s\n", + (char *)&f->fmt.sdr.pixelformat); + + if (vb2_is_busy(q)) + return -EBUSY; + + for (i = 0; i < dev->num_formats; i++) { + if (formats[i].pixelformat == f->fmt.sdr.pixelformat) { + dev->pixelformat = formats[i].pixelformat; + dev->buffersize = formats[i].buffersize; + f->fmt.sdr.buffersize = formats[i].buffersize; + return 0; + } + } + + dev->pixelformat = formats[0].pixelformat; + dev->buffersize = formats[0].buffersize; + f->fmt.sdr.pixelformat = formats[0].pixelformat; + f->fmt.sdr.buffersize = formats[0].buffersize; + + return 0; +} + +static int msi2500_try_fmt_sdr_cap(struct file *file, void *priv, + struct v4l2_format *f) +{ + struct msi2500_dev *dev = video_drvdata(file); + int i; + + dev_dbg(dev->dev, "pixelformat fourcc %4.4s\n", + (char *)&f->fmt.sdr.pixelformat); + + for (i = 0; i < dev->num_formats; i++) { + if (formats[i].pixelformat == f->fmt.sdr.pixelformat) { + f->fmt.sdr.buffersize = formats[i].buffersize; + return 0; + } + } + + f->fmt.sdr.pixelformat = formats[0].pixelformat; + f->fmt.sdr.buffersize = formats[0].buffersize; + + return 0; +} + +static int msi2500_s_tuner(struct file *file, void *priv, + const struct v4l2_tuner *v) +{ + struct msi2500_dev *dev = video_drvdata(file); + int ret; + + dev_dbg(dev->dev, "index=%d\n", v->index); + + if (v->index == 0) + ret = 0; + else if (v->index == 1) + ret = v4l2_subdev_call(dev->v4l2_subdev, tuner, s_tuner, v); + else + ret = -EINVAL; + + return ret; +} + +static int msi2500_g_tuner(struct file *file, void *priv, struct v4l2_tuner *v) +{ + struct msi2500_dev *dev = video_drvdata(file); + int ret; + + dev_dbg(dev->dev, "index=%d\n", v->index); + + if (v->index == 0) { + strscpy(v->name, "Mirics MSi2500", sizeof(v->name)); + v->type = V4L2_TUNER_ADC; + v->capability = V4L2_TUNER_CAP_1HZ | V4L2_TUNER_CAP_FREQ_BANDS; + v->rangelow = 1200000; + v->rangehigh = 15000000; + ret = 0; + } else if (v->index == 1) { + ret = v4l2_subdev_call(dev->v4l2_subdev, tuner, g_tuner, v); + } else { + ret = -EINVAL; + } + + return ret; +} + +static int msi2500_g_frequency(struct file *file, void *priv, + struct v4l2_frequency *f) +{ + struct msi2500_dev *dev = video_drvdata(file); + int ret = 0; + + dev_dbg(dev->dev, "tuner=%d type=%d\n", f->tuner, f->type); + + if (f->tuner == 0) { + f->frequency = dev->f_adc; + ret = 0; + } else if (f->tuner == 1) { + f->type = V4L2_TUNER_RF; + ret = v4l2_subdev_call(dev->v4l2_subdev, tuner, g_frequency, f); + } else { + ret = -EINVAL; + } + + return ret; +} + +static int msi2500_s_frequency(struct file *file, void *priv, + const struct v4l2_frequency *f) +{ + struct msi2500_dev *dev = video_drvdata(file); + int ret; + + dev_dbg(dev->dev, "tuner=%d type=%d frequency=%u\n", + f->tuner, f->type, f->frequency); + + if (f->tuner == 0) { + dev->f_adc = clamp_t(unsigned int, f->frequency, + bands[0].rangelow, + bands[0].rangehigh); + dev_dbg(dev->dev, "ADC frequency=%u Hz\n", dev->f_adc); + ret = msi2500_set_usb_adc(dev); + } else if (f->tuner == 1) { + ret = v4l2_subdev_call(dev->v4l2_subdev, tuner, s_frequency, f); + } else { + ret = -EINVAL; + } + + return ret; +} + +static int msi2500_enum_freq_bands(struct file *file, void *priv, + struct v4l2_frequency_band *band) +{ + struct msi2500_dev *dev = video_drvdata(file); + int ret; + + dev_dbg(dev->dev, "tuner=%d type=%d index=%d\n", + band->tuner, band->type, band->index); + + if (band->tuner == 0) { + if (band->index >= ARRAY_SIZE(bands)) { + ret = -EINVAL; + } else { + *band = bands[band->index]; + ret = 0; + } + } else if (band->tuner == 1) { + ret = v4l2_subdev_call(dev->v4l2_subdev, tuner, + enum_freq_bands, band); + } else { + ret = -EINVAL; + } + + return ret; +} + +static const struct v4l2_ioctl_ops msi2500_ioctl_ops = { + .vidioc_querycap = msi2500_querycap, + + .vidioc_enum_fmt_sdr_cap = msi2500_enum_fmt_sdr_cap, + .vidioc_g_fmt_sdr_cap = msi2500_g_fmt_sdr_cap, + .vidioc_s_fmt_sdr_cap = msi2500_s_fmt_sdr_cap, + .vidioc_try_fmt_sdr_cap = msi2500_try_fmt_sdr_cap, + + .vidioc_reqbufs = vb2_ioctl_reqbufs, + .vidioc_create_bufs = vb2_ioctl_create_bufs, + .vidioc_prepare_buf = vb2_ioctl_prepare_buf, + .vidioc_querybuf = vb2_ioctl_querybuf, + .vidioc_qbuf = vb2_ioctl_qbuf, + .vidioc_dqbuf = vb2_ioctl_dqbuf, + + .vidioc_streamon = vb2_ioctl_streamon, + .vidioc_streamoff = vb2_ioctl_streamoff, + + .vidioc_g_tuner = msi2500_g_tuner, + .vidioc_s_tuner = msi2500_s_tuner, + + .vidioc_g_frequency = msi2500_g_frequency, + .vidioc_s_frequency = msi2500_s_frequency, + .vidioc_enum_freq_bands = msi2500_enum_freq_bands, + + .vidioc_subscribe_event = v4l2_ctrl_subscribe_event, + .vidioc_unsubscribe_event = v4l2_event_unsubscribe, + .vidioc_log_status = v4l2_ctrl_log_status, +}; + +static const struct v4l2_file_operations msi2500_fops = { + .owner = THIS_MODULE, + .open = v4l2_fh_open, + .release = vb2_fop_release, + .read = vb2_fop_read, + .poll = vb2_fop_poll, + .mmap = vb2_fop_mmap, + .unlocked_ioctl = video_ioctl2, +}; + +static const struct video_device msi2500_template = { + .name = "Mirics MSi3101 SDR Dongle", + .release = video_device_release_empty, + .fops = &msi2500_fops, + .ioctl_ops = &msi2500_ioctl_ops, +}; + +static void msi2500_video_release(struct v4l2_device *v) +{ + struct msi2500_dev *dev = container_of(v, struct msi2500_dev, v4l2_dev); + + v4l2_ctrl_handler_free(&dev->hdl); + v4l2_device_unregister(&dev->v4l2_dev); + kfree(dev); +} + +static int msi2500_transfer_one_message(struct spi_master *master, + struct spi_message *m) +{ + struct msi2500_dev *dev = spi_master_get_devdata(master); + struct spi_transfer *t; + int ret = 0; + u32 data; + + list_for_each_entry(t, &m->transfers, transfer_list) { + dev_dbg(dev->dev, "msg=%*ph\n", t->len, t->tx_buf); + data = 0x09; /* reg 9 is SPI adapter */ + data |= ((u8 *)t->tx_buf)[0] << 8; + data |= ((u8 *)t->tx_buf)[1] << 16; + data |= ((u8 *)t->tx_buf)[2] << 24; + ret = msi2500_ctrl_msg(dev, CMD_WREG, data); + } + + m->status = ret; + spi_finalize_current_message(master); + return ret; +} + +static int msi2500_probe(struct usb_interface *intf, + const struct usb_device_id *id) +{ + struct msi2500_dev *dev; + struct v4l2_subdev *sd; + struct spi_master *master; + int ret; + static struct spi_board_info board_info = { + .modalias = "msi001", + .bus_num = 0, + .chip_select = 0, + .max_speed_hz = 12000000, + }; + + dev = kzalloc(sizeof(*dev), GFP_KERNEL); + if (!dev) { + ret = -ENOMEM; + goto err; + } + + mutex_init(&dev->v4l2_lock); + mutex_init(&dev->vb_queue_lock); + spin_lock_init(&dev->queued_bufs_lock); + INIT_LIST_HEAD(&dev->queued_bufs); + dev->dev = &intf->dev; + dev->udev = interface_to_usbdev(intf); + dev->f_adc = bands[0].rangelow; + dev->pixelformat = formats[0].pixelformat; + dev->buffersize = formats[0].buffersize; + dev->num_formats = NUM_FORMATS; + if (!msi2500_emulated_fmt) + dev->num_formats -= 2; + + /* Init videobuf2 queue structure */ + dev->vb_queue.type = V4L2_BUF_TYPE_SDR_CAPTURE; + dev->vb_queue.io_modes = VB2_MMAP | VB2_USERPTR | VB2_READ; + dev->vb_queue.drv_priv = dev; + dev->vb_queue.buf_struct_size = sizeof(struct msi2500_frame_buf); + dev->vb_queue.ops = &msi2500_vb2_ops; + dev->vb_queue.mem_ops = &vb2_vmalloc_memops; + dev->vb_queue.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC; + ret = vb2_queue_init(&dev->vb_queue); + if (ret) { + dev_err(dev->dev, "Could not initialize vb2 queue\n"); + goto err_free_mem; + } + + /* Init video_device structure */ + dev->vdev = msi2500_template; + dev->vdev.queue = &dev->vb_queue; + dev->vdev.queue->lock = &dev->vb_queue_lock; + video_set_drvdata(&dev->vdev, dev); + + /* Register the v4l2_device structure */ + dev->v4l2_dev.release = msi2500_video_release; + ret = v4l2_device_register(&intf->dev, &dev->v4l2_dev); + if (ret) { + dev_err(dev->dev, "Failed to register v4l2-device (%d)\n", ret); + goto err_free_mem; + } + + /* SPI master adapter */ + master = spi_alloc_master(dev->dev, 0); + if (master == NULL) { + ret = -ENOMEM; + goto err_unregister_v4l2_dev; + } + + dev->master = master; + master->bus_num = -1; + master->num_chipselect = 1; + master->transfer_one_message = msi2500_transfer_one_message; + spi_master_set_devdata(master, dev); + ret = spi_register_master(master); + if (ret) { + spi_master_put(master); + goto err_unregister_v4l2_dev; + } + + /* load v4l2 subdevice */ + sd = v4l2_spi_new_subdev(&dev->v4l2_dev, master, &board_info); + dev->v4l2_subdev = sd; + if (sd == NULL) { + dev_err(dev->dev, "cannot get v4l2 subdevice\n"); + ret = -ENODEV; + goto err_unregister_master; + } + + /* Register controls */ + v4l2_ctrl_handler_init(&dev->hdl, 0); + if (dev->hdl.error) { + ret = dev->hdl.error; + dev_err(dev->dev, "Could not initialize controls\n"); + goto err_free_controls; + } + + /* currently all controls are from subdev */ + v4l2_ctrl_add_handler(&dev->hdl, sd->ctrl_handler, NULL, true); + + dev->v4l2_dev.ctrl_handler = &dev->hdl; + dev->vdev.v4l2_dev = &dev->v4l2_dev; + dev->vdev.lock = &dev->v4l2_lock; + dev->vdev.device_caps = V4L2_CAP_SDR_CAPTURE | V4L2_CAP_STREAMING | + V4L2_CAP_READWRITE | V4L2_CAP_TUNER; + + ret = video_register_device(&dev->vdev, VFL_TYPE_SDR, -1); + if (ret) { + dev_err(dev->dev, + "Failed to register as video device (%d)\n", ret); + goto err_unregister_v4l2_dev; + } + dev_info(dev->dev, "Registered as %s\n", + video_device_node_name(&dev->vdev)); + dev_notice(dev->dev, + "SDR API is still slightly experimental and functionality changes may follow\n"); + return 0; +err_free_controls: + v4l2_ctrl_handler_free(&dev->hdl); +err_unregister_master: + spi_unregister_master(dev->master); +err_unregister_v4l2_dev: + v4l2_device_unregister(&dev->v4l2_dev); +err_free_mem: + kfree(dev); +err: + return ret; +} + +/* USB device ID list */ +static const struct usb_device_id msi2500_id_table[] = { + {USB_DEVICE(0x1df7, 0x2500)}, /* Mirics MSi3101 SDR Dongle */ + {USB_DEVICE(0x2040, 0xd300)}, /* Hauppauge WinTV 133559 LF */ + {} +}; +MODULE_DEVICE_TABLE(usb, msi2500_id_table); + +/* USB subsystem interface */ +static struct usb_driver msi2500_driver = { + .name = KBUILD_MODNAME, + .probe = msi2500_probe, + .disconnect = msi2500_disconnect, + .id_table = msi2500_id_table, +}; + +module_usb_driver(msi2500_driver); + +MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>"); +MODULE_DESCRIPTION("Mirics MSi3101 SDR Dongle"); +MODULE_LICENSE("GPL"); |