2 em28xx-core.c - driver for Empia EM2800/EM2820/2840 USB video capture devices
4 Copyright (C) 2005 Ludovico Cavedon <cavedon@sssup.it>
5 Markus Rechberger <mrechberger@gmail.com>
6 Mauro Carvalho Chehab <mchehab@infradead.org>
7 Sascha Sommer <saschasommer@freenet.de>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <linux/init.h>
25 #include <linux/list.h>
26 #include <linux/module.h>
27 #include <linux/usb.h>
28 #include <linux/vmalloc.h>
32 /* #define ENABLE_DEBUG_ISOC_FRAMES */
34 static unsigned int core_debug;
35 module_param(core_debug,int,0644);
36 MODULE_PARM_DESC(core_debug,"enable debug messages [core]");
38 #define em28xx_coredbg(fmt, arg...) do {\
40 printk(KERN_INFO "%s %s :"fmt, \
41 dev->name, __func__ , ##arg); } while (0)
43 static unsigned int reg_debug;
44 module_param(reg_debug,int,0644);
45 MODULE_PARM_DESC(reg_debug,"enable debug messages [URB reg]");
47 #define em28xx_regdbg(fmt, arg...) do {\
49 printk(KERN_INFO "%s %s :"fmt, \
50 dev->name, __func__ , ##arg); } while (0)
52 static int alt = EM28XX_PINOUT;
53 module_param(alt, int, 0644);
54 MODULE_PARM_DESC(alt, "alternate setting to use for video endpoint");
57 #define em28xx_isocdbg(fmt, arg...) do {\
59 printk(KERN_INFO "%s %s :"fmt, \
60 dev->name, __func__ , ##arg); } while (0)
63 * em28xx_read_reg_req()
64 * reads data from the usb device specifying bRequest
66 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
71 if (dev->state & DEV_DISCONNECTED)
74 if (len > URB_MAX_CTRL_SIZE)
77 em28xx_regdbg("req=%02x, reg=%02x ", req, reg);
79 ret = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0), req,
80 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
81 0x0000, reg, dev->urb_buf, len, HZ);
89 memcpy(buf, dev->urb_buf, len);
92 printk("%02x values: ", ret);
93 for (byte = 0; byte < len; byte++)
94 printk(" %02x", (unsigned char)buf[byte]);
102 * em28xx_read_reg_req()
103 * reads data from the usb device specifying bRequest
105 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg)
110 if (dev->state & DEV_DISCONNECTED)
113 em28xx_regdbg("req=%02x, reg=%02x:", req, reg);
115 ret = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0), req,
116 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
117 0x0000, reg, dev->urb_buf, 1, HZ);
119 printk(" failed!\n");
123 val = dev->urb_buf[0];
126 printk("%02x\n", (unsigned char) val);
131 int em28xx_read_reg(struct em28xx *dev, u16 reg)
133 return em28xx_read_reg_req(dev, USB_REQ_GET_STATUS, reg);
137 * em28xx_write_regs_req()
138 * sends data to the usb device, specifying bRequest
140 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
145 if (dev->state & DEV_DISCONNECTED)
148 if ((len < 1) || (len > URB_MAX_CTRL_SIZE))
151 em28xx_regdbg("req=%02x reg=%02x:", req, reg);
154 for (i = 0; i < len; ++i)
155 printk(" %02x", (unsigned char)buf[i]);
159 memcpy(dev->urb_buf, buf, len);
160 ret = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0), req,
161 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
162 0x0000, reg, dev->urb_buf, len, HZ);
164 if (dev->wait_after_write)
165 msleep(dev->wait_after_write);
170 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len)
174 rc = em28xx_write_regs_req(dev, USB_REQ_GET_STATUS, reg, buf, len);
176 /* Stores GPO/GPIO values at the cache, if changed
177 Only write values should be stored, since input on a GPIO
178 register will return the input bits.
179 Not sure what happens on reading GPO register.
182 if (reg == EM2880_R04_GPO)
183 dev->reg_gpo = buf[0];
184 else if (reg == EM28XX_R08_GPIO)
185 dev->reg_gpio = buf[0];
192 * em28xx_write_reg_bits()
193 * sets only some bits (specified by bitmask) of a register, by first reading
196 static int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
202 /* Uses cache for gpo/gpio registers */
203 if (reg == EM2880_R04_GPO)
204 oldval = dev->reg_gpo;
205 else if (reg == EM28XX_R08_GPIO)
206 oldval = dev->reg_gpio;
208 oldval = em28xx_read_reg(dev, reg);
213 newval = (((u8) oldval) & ~bitmask) | (val & bitmask);
215 return em28xx_write_regs(dev, reg, &newval, 1);
219 * em28xx_write_ac97()
220 * write a 16 bit value to the specified AC97 address (LSB first!)
222 static int em28xx_write_ac97(struct em28xx *dev, u8 reg, u8 *val)
225 u8 addr = reg & 0x7f;
227 ret = em28xx_write_regs(dev, EM28XX_R40_AC97LSB, val, 2);
231 ret = em28xx_write_regs(dev, EM28XX_R42_AC97ADDR, &addr, 1);
235 /* Wait up to 50 ms for AC97 command to complete */
236 for (i = 0; i < 10; i++) {
237 ret = em28xx_read_reg(dev, EM28XX_R43_AC97BUSY);
245 em28xx_warn("AC97 command still being executed: not handled properly!\n");
249 static int em28xx_set_audio_source(struct em28xx *dev)
251 static char *enable = "\x08\x08";
252 static char *disable = "\x08\x88";
253 char *video = enable, *line = disable;
257 if (dev->is_em2800) {
259 input = EM2800_AUDIO_SRC_LINE;
261 input = EM2800_AUDIO_SRC_TUNER;
263 ret = em28xx_write_regs(dev, EM2800_R08_AUDIOSRC, &input, 1);
268 if (dev->has_msp34xx)
269 input = EM28XX_AUDIO_SRC_TUNER;
271 switch (dev->ctl_ainput) {
272 case EM28XX_AMUX_VIDEO:
273 input = EM28XX_AUDIO_SRC_TUNER;
275 case EM28XX_AMUX_LINE_IN:
276 input = EM28XX_AUDIO_SRC_LINE;
280 case EM28XX_AMUX_AC97_VIDEO:
281 input = EM28XX_AUDIO_SRC_LINE;
283 case EM28XX_AMUX_AC97_LINE_IN:
284 input = EM28XX_AUDIO_SRC_LINE;
291 ret = em28xx_write_reg_bits(dev, EM28XX_R0E_AUDIOSRC, input, 0xc0);
296 /* Sets AC97 mixer registers
297 This is seems to be needed, even for non-ac97 configs
299 ret = em28xx_write_ac97(dev, EM28XX_R14_VIDEO_AC97, video);
303 ret = em28xx_write_ac97(dev, EM28XX_R10_LINE_IN_AC97, line);
308 int em28xx_audio_analog_set(struct em28xx *dev)
311 char s[2] = { 0x00, 0x00 };
314 s[0] |= 0x1f - dev->volume;
315 s[1] |= 0x1f - dev->volume;
319 ret = em28xx_write_ac97(dev, EM28XX_R02_MASTER_AC97, s);
324 if (dev->has_12mhz_i2s)
330 ret = em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, xclk, 0xa7);
335 /* Selects the proper audio input */
336 ret = em28xx_set_audio_source(dev);
341 ret = em28xx_write_ac97(dev, EM28XX_R02_MASTER_AC97, s);
345 EXPORT_SYMBOL_GPL(em28xx_audio_analog_set);
347 int em28xx_colorlevels_set_default(struct em28xx *dev)
349 em28xx_write_regs(dev, EM28XX_R20_YGAIN, "\x10", 1); /* contrast */
350 em28xx_write_regs(dev, EM28XX_R21_YOFFSET, "\x00", 1); /* brightness */
351 em28xx_write_regs(dev, EM28XX_R22_UVGAIN, "\x10", 1); /* saturation */
352 em28xx_write_regs(dev, EM28XX_R23_UOFFSET, "\x00", 1);
353 em28xx_write_regs(dev, EM28XX_R24_VOFFSET, "\x00", 1);
354 em28xx_write_regs(dev, EM28XX_R25_SHARPNESS, "\x00", 1);
356 em28xx_write_regs(dev, EM28XX_R14_GAMMA, "\x20", 1);
357 em28xx_write_regs(dev, EM28XX_R15_RGAIN, "\x20", 1);
358 em28xx_write_regs(dev, EM28XX_R16_GGAIN, "\x20", 1);
359 em28xx_write_regs(dev, EM28XX_R17_BGAIN, "\x20", 1);
360 em28xx_write_regs(dev, EM28XX_R18_ROFFSET, "\x00", 1);
361 em28xx_write_regs(dev, EM28XX_R19_GOFFSET, "\x00", 1);
362 return em28xx_write_regs(dev, EM28XX_R1A_BOFFSET, "\x00", 1);
365 int em28xx_capture_start(struct em28xx *dev, int start)
368 /* FIXME: which is the best order? */
369 /* video registers are sampled by VREF */
370 rc = em28xx_write_reg_bits(dev, EM28XX_R0C_USBSUSP,
371 start ? 0x10 : 0x00, 0x10);
376 /* disable video capture */
377 rc = em28xx_write_regs(dev, EM28XX_R12_VINENABLE, "\x27", 1);
381 /* enable video capture */
382 rc = em28xx_write_regs_req(dev, 0x00, 0x48, "\x00", 1);
384 if (dev->mode == EM28XX_ANALOG_MODE)
385 rc = em28xx_write_regs(dev, EM28XX_R12_VINENABLE, "\x67", 1);
387 rc = em28xx_write_regs(dev, EM28XX_R12_VINENABLE, "\x37", 1);
394 int em28xx_outfmt_set_yuv422(struct em28xx *dev)
396 em28xx_write_regs(dev, EM28XX_R27_OUTFMT, "\x34", 1);
397 em28xx_write_regs(dev, EM28XX_R10_VINMODE, "\x10", 1);
398 return em28xx_write_regs(dev, EM28XX_R11_VINCTRL, "\x11", 1);
401 static int em28xx_accumulator_set(struct em28xx *dev, u8 xmin, u8 xmax,
404 em28xx_coredbg("em28xx Scale: (%d,%d)-(%d,%d)\n",
405 xmin, ymin, xmax, ymax);
407 em28xx_write_regs(dev, EM28XX_R28_XMIN, &xmin, 1);
408 em28xx_write_regs(dev, EM28XX_R29_XMAX, &xmax, 1);
409 em28xx_write_regs(dev, EM28XX_R2A_YMIN, &ymin, 1);
410 return em28xx_write_regs(dev, EM28XX_R2B_YMAX, &ymax, 1);
413 static int em28xx_capture_area_set(struct em28xx *dev, u8 hstart, u8 vstart,
414 u16 width, u16 height)
418 u8 overflow = (height >> 7 & 0x02) | (width >> 8 & 0x01);
420 em28xx_coredbg("em28xx Area Set: (%d,%d)\n",
421 (width | (overflow & 2) << 7),
422 (height | (overflow & 1) << 8));
424 em28xx_write_regs(dev, EM28XX_R1C_HSTART, &hstart, 1);
425 em28xx_write_regs(dev, EM28XX_R1D_VSTART, &vstart, 1);
426 em28xx_write_regs(dev, EM28XX_R1E_CWIDTH, &cwidth, 1);
427 em28xx_write_regs(dev, EM28XX_R1F_CHEIGHT, &cheight, 1);
428 return em28xx_write_regs(dev, EM28XX_R1B_OFLOW, &overflow, 1);
431 static int em28xx_scaler_set(struct em28xx *dev, u16 h, u16 v)
434 /* the em2800 scaler only supports scaling down to 50% */
436 mode = (v ? 0x20 : 0x00) | (h ? 0x10 : 0x00);
441 em28xx_write_regs(dev, EM28XX_R30_HSCALELOW, (char *)buf, 2);
444 em28xx_write_regs(dev, EM28XX_R32_VSCALELOW, (char *)buf, 2);
445 /* it seems that both H and V scalers must be active
447 mode = (h || v)? 0x30: 0x00;
449 return em28xx_write_reg_bits(dev, EM28XX_R26_COMPR, mode, 0x30);
452 /* FIXME: this only function read values from dev */
453 int em28xx_resolution_set(struct em28xx *dev)
456 width = norm_maxw(dev);
457 height = norm_maxh(dev) >> 1;
459 em28xx_outfmt_set_yuv422(dev);
460 em28xx_accumulator_set(dev, 1, (width - 4) >> 2, 1, (height - 4) >> 2);
461 em28xx_capture_area_set(dev, 0, 0, width >> 2, height >> 2);
462 return em28xx_scaler_set(dev, dev->hscale, dev->vscale);
465 int em28xx_set_alternate(struct em28xx *dev)
467 int errCode, prev_alt = dev->alt;
469 unsigned int min_pkt_size = dev->width * 2 + 4;
471 /* When image size is bigger than a certain value,
472 the frame size should be increased, otherwise, only
473 green screen will be received.
475 if (dev->width * 2 * dev->height > 720 * 240 * 2)
478 for (i = 0; i < dev->num_alt; i++) {
479 /* stop when the selected alt setting offers enough bandwidth */
480 if (dev->alt_max_pkt_size[i] >= min_pkt_size) {
483 /* otherwise make sure that we end up with the maximum bandwidth
484 because the min_pkt_size equation might be wrong...
486 } else if (dev->alt_max_pkt_size[i] >
487 dev->alt_max_pkt_size[dev->alt])
491 if (dev->alt != prev_alt) {
492 em28xx_coredbg("minimum isoc packet size: %u (alt=%d)\n",
493 min_pkt_size, dev->alt);
494 dev->max_pkt_size = dev->alt_max_pkt_size[dev->alt];
495 em28xx_coredbg("setting alternate %d with wMaxPacketSize=%u\n",
496 dev->alt, dev->max_pkt_size);
497 errCode = usb_set_interface(dev->udev, 0, dev->alt);
499 em28xx_errdev("cannot change alternate number to %d (error=%i)\n",
507 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio)
514 dev->em28xx_write_regs_req(dev, 0x00, 0x48, "\x00", 1);
515 if (dev->mode == EM28XX_ANALOG_MODE)
516 dev->em28xx_write_regs_req(dev, 0x00, 0x12, "\x67", 1);
518 dev->em28xx_write_regs_req(dev, 0x00, 0x12, "\x37", 1);
521 /* Send GPIO reset sequences specified at board entry */
522 while (gpio->sleep >= 0) {
523 if (gpio->reg >= 0) {
524 rc = em28xx_write_reg_bits(dev,
539 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode)
541 if (dev->mode == set_mode)
544 if (set_mode == EM28XX_MODE_UNDEFINED) {
545 dev->mode = set_mode;
549 dev->mode = set_mode;
551 if (dev->mode == EM28XX_DIGITAL_MODE)
552 return em28xx_gpio_set(dev, dev->digital_gpio);
554 return em28xx_gpio_set(dev, dev->analog_gpio);
556 EXPORT_SYMBOL_GPL(em28xx_set_mode);
558 /* ------------------------------------------------------------------
560 ------------------------------------------------------------------*/
563 * IRQ callback, called by URB callback
565 static void em28xx_irq_callback(struct urb *urb)
567 struct em28xx_dmaqueue *dma_q = urb->context;
568 struct em28xx *dev = container_of(dma_q, struct em28xx, vidq);
571 /* Copy data from URB */
572 spin_lock(&dev->slock);
573 rc = dev->isoc_ctl.isoc_copy(dev, urb);
574 spin_unlock(&dev->slock);
576 /* Reset urb buffers */
577 for (i = 0; i < urb->number_of_packets; i++) {
578 urb->iso_frame_desc[i].status = 0;
579 urb->iso_frame_desc[i].actual_length = 0;
583 urb->status = usb_submit_urb(urb, GFP_ATOMIC);
585 em28xx_isocdbg("urb resubmit failed (error=%i)\n",
591 * Stop and Deallocate URBs
593 void em28xx_uninit_isoc(struct em28xx *dev)
598 em28xx_isocdbg("em28xx: called em28xx_uninit_isoc\n");
600 dev->isoc_ctl.nfields = -1;
601 for (i = 0; i < dev->isoc_ctl.num_bufs; i++) {
602 urb = dev->isoc_ctl.urb[i];
606 if (dev->isoc_ctl.transfer_buffer[i]) {
607 usb_buffer_free(dev->udev,
608 urb->transfer_buffer_length,
609 dev->isoc_ctl.transfer_buffer[i],
613 dev->isoc_ctl.urb[i] = NULL;
615 dev->isoc_ctl.transfer_buffer[i] = NULL;
618 kfree(dev->isoc_ctl.urb);
619 kfree(dev->isoc_ctl.transfer_buffer);
621 dev->isoc_ctl.urb = NULL;
622 dev->isoc_ctl.transfer_buffer = NULL;
623 dev->isoc_ctl.num_bufs = 0;
625 em28xx_capture_start(dev, 0);
627 EXPORT_SYMBOL_GPL(em28xx_uninit_isoc);
630 * Allocate URBs and start IRQ
632 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
633 int num_bufs, int max_pkt_size,
634 int (*isoc_copy) (struct em28xx *dev, struct urb *urb))
636 struct em28xx_dmaqueue *dma_q = &dev->vidq;
643 em28xx_isocdbg("em28xx: called em28xx_prepare_isoc\n");
645 /* De-allocates all pending stuff */
646 em28xx_uninit_isoc(dev);
648 dev->isoc_ctl.isoc_copy = isoc_copy;
649 dev->isoc_ctl.num_bufs = num_bufs;
651 dev->isoc_ctl.urb = kzalloc(sizeof(void *)*num_bufs, GFP_KERNEL);
652 if (!dev->isoc_ctl.urb) {
653 em28xx_errdev("cannot alloc memory for usb buffers\n");
657 dev->isoc_ctl.transfer_buffer = kzalloc(sizeof(void *)*num_bufs,
659 if (!dev->isoc_ctl.transfer_buffer) {
660 em28xx_errdev("cannot allocate memory for usbtransfer\n");
661 kfree(dev->isoc_ctl.urb);
665 dev->isoc_ctl.max_pkt_size = max_pkt_size;
666 dev->isoc_ctl.buf = NULL;
668 sb_size = max_packets * dev->isoc_ctl.max_pkt_size;
670 /* allocate urbs and transfer buffers */
671 for (i = 0; i < dev->isoc_ctl.num_bufs; i++) {
672 urb = usb_alloc_urb(max_packets, GFP_KERNEL);
674 em28xx_err("cannot alloc isoc_ctl.urb %i\n", i);
675 em28xx_uninit_isoc(dev);
678 dev->isoc_ctl.urb[i] = urb;
680 dev->isoc_ctl.transfer_buffer[i] = usb_buffer_alloc(dev->udev,
681 sb_size, GFP_KERNEL, &urb->transfer_dma);
682 if (!dev->isoc_ctl.transfer_buffer[i]) {
683 em28xx_err("unable to allocate %i bytes for transfer"
686 in_interrupt()?" while in int":"");
687 em28xx_uninit_isoc(dev);
690 memset(dev->isoc_ctl.transfer_buffer[i], 0, sb_size);
692 /* FIXME: this is a hack - should be
693 'desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK'
694 should also be using 'desc.bInterval'
696 pipe = usb_rcvisocpipe(dev->udev,
697 dev->mode == EM28XX_ANALOG_MODE ? 0x82 : 0x84);
699 usb_fill_int_urb(urb, dev->udev, pipe,
700 dev->isoc_ctl.transfer_buffer[i], sb_size,
701 em28xx_irq_callback, dma_q, 1);
703 urb->number_of_packets = max_packets;
704 urb->transfer_flags = URB_ISO_ASAP;
707 for (j = 0; j < max_packets; j++) {
708 urb->iso_frame_desc[j].offset = k;
709 urb->iso_frame_desc[j].length =
710 dev->isoc_ctl.max_pkt_size;
711 k += dev->isoc_ctl.max_pkt_size;
715 init_waitqueue_head(&dma_q->wq);
717 em28xx_capture_start(dev, 1);
719 /* submit urbs and enables IRQ */
720 for (i = 0; i < dev->isoc_ctl.num_bufs; i++) {
721 rc = usb_submit_urb(dev->isoc_ctl.urb[i], GFP_ATOMIC);
723 em28xx_err("submit of urb %i failed (error=%i)\n", i,
725 em28xx_uninit_isoc(dev);
732 EXPORT_SYMBOL_GPL(em28xx_init_isoc);