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 em28xx_regdbg("req=%02x, reg=%02x ", req, reg);
76 ret = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0), req,
77 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
78 0x0000, reg, buf, len, HZ);
81 printk(ret < 0 ? " failed!\n" : "%02x values: ", ret);
82 for (byte = 0; byte < len; byte++) {
83 printk(" %02x", (unsigned char)buf[byte]);
92 * em28xx_read_reg_req()
93 * reads data from the usb device specifying bRequest
95 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg)
100 if (dev->state & DEV_DISCONNECTED)
103 em28xx_regdbg("req=%02x, reg=%02x:", req, reg);
105 ret = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0), req,
106 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
107 0x0000, reg, &val, 1, HZ);
110 printk(ret < 0 ? " failed!\n" :
111 "%02x\n", (unsigned char) val);
119 int em28xx_read_reg(struct em28xx *dev, u16 reg)
121 return em28xx_read_reg_req(dev, USB_REQ_GET_STATUS, reg);
125 * em28xx_write_regs_req()
126 * sends data to the usb device, specifying bRequest
128 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
133 /*usb_control_msg seems to expect a kmalloced buffer */
136 if (dev->state & DEV_DISCONNECTED)
139 bufs = kmalloc(len, GFP_KERNEL);
141 em28xx_regdbg("req=%02x reg=%02x:", req, reg);
145 for (i = 0; i < len; ++i)
146 printk (" %02x", (unsigned char)buf[i]);
152 memcpy(bufs, buf, len);
153 ret = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0), req,
154 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
155 0x0000, reg, bufs, len, HZ);
156 msleep(5); /* FIXME: magic number */
161 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len)
163 return em28xx_write_regs_req(dev, USB_REQ_GET_STATUS, reg, buf, len);
167 * em28xx_write_reg_bits()
168 * sets only some bits (specified by bitmask) of a register, by first reading
171 static int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
176 if ((oldval = em28xx_read_reg(dev, reg)) < 0)
178 newval = (((u8) oldval) & ~bitmask) | (val & bitmask);
179 return em28xx_write_regs(dev, reg, &newval, 1);
183 * em28xx_write_ac97()
184 * write a 16 bit value to the specified AC97 address (LSB first!)
186 static int em28xx_write_ac97(struct em28xx *dev, u8 reg, u8 *val)
189 u8 addr = reg & 0x7f;
190 if ((ret = em28xx_write_regs(dev, AC97LSB_REG, val, 2)) < 0)
192 if ((ret = em28xx_write_regs(dev, AC97ADDR_REG, &addr, 1)) < 0)
195 /* Wait up to 50 ms for AC97 command to complete */
196 for (i = 0; i < 10; i++) {
197 if ((ret = em28xx_read_reg(dev, AC97BUSY_REG)) < 0)
203 em28xx_warn ("AC97 command still being executed: not handled properly!\n");
207 static int em28xx_set_audio_source(struct em28xx *dev)
209 static char *enable = "\x08\x08";
210 static char *disable = "\x08\x88";
211 char *video = enable, *line = disable;
215 if (dev->is_em2800) {
217 input = EM2800_AUDIO_SRC_LINE;
219 input = EM2800_AUDIO_SRC_TUNER;
221 ret = em28xx_write_regs(dev, EM2800_AUDIOSRC_REG, &input, 1);
226 if (dev->has_msp34xx)
227 input = EM28XX_AUDIO_SRC_TUNER;
229 switch (dev->ctl_ainput) {
230 case EM28XX_AMUX_VIDEO:
231 input = EM28XX_AUDIO_SRC_TUNER;
233 case EM28XX_AMUX_LINE_IN:
234 input = EM28XX_AUDIO_SRC_LINE;
236 case EM28XX_AMUX_AC97_VIDEO:
237 input = EM28XX_AUDIO_SRC_LINE;
239 case EM28XX_AMUX_AC97_LINE_IN:
240 input = EM28XX_AUDIO_SRC_LINE;
247 ret = em28xx_write_reg_bits(dev, AUDIOSRC_REG, input, 0xc0);
252 /* Sets AC97 mixer registers
253 This is seems to be needed, even for non-ac97 configs
255 ret = em28xx_write_ac97(dev, VIDEO_AC97, video);
259 ret = em28xx_write_ac97(dev, LINE_IN_AC97, line);
264 int em28xx_audio_analog_set(struct em28xx *dev)
267 char s[2] = { 0x00, 0x00 };
270 s[0] |= 0x1f - dev->volume;
271 s[1] |= 0x1f - dev->volume;
275 ret = em28xx_write_ac97(dev, MASTER_AC97, s);
280 if (dev->has_12mhz_i2s)
286 ret = em28xx_write_reg_bits(dev, XCLK_REG, xclk, 0xa7);
291 /* Selects the proper audio input */
292 ret = em28xx_set_audio_source(dev);
297 ret = em28xx_write_ac97(dev, MASTER_AC97, s);
301 EXPORT_SYMBOL_GPL(em28xx_audio_analog_set);
303 int em28xx_colorlevels_set_default(struct em28xx *dev)
305 em28xx_write_regs(dev, YGAIN_REG, "\x10", 1); /* contrast */
306 em28xx_write_regs(dev, YOFFSET_REG, "\x00", 1); /* brightness */
307 em28xx_write_regs(dev, UVGAIN_REG, "\x10", 1); /* saturation */
308 em28xx_write_regs(dev, UOFFSET_REG, "\x00", 1);
309 em28xx_write_regs(dev, VOFFSET_REG, "\x00", 1);
310 em28xx_write_regs(dev, SHARPNESS_REG, "\x00", 1);
312 em28xx_write_regs(dev, GAMMA_REG, "\x20", 1);
313 em28xx_write_regs(dev, RGAIN_REG, "\x20", 1);
314 em28xx_write_regs(dev, GGAIN_REG, "\x20", 1);
315 em28xx_write_regs(dev, BGAIN_REG, "\x20", 1);
316 em28xx_write_regs(dev, ROFFSET_REG, "\x00", 1);
317 em28xx_write_regs(dev, GOFFSET_REG, "\x00", 1);
318 return em28xx_write_regs(dev, BOFFSET_REG, "\x00", 1);
321 int em28xx_capture_start(struct em28xx *dev, int start)
324 /* FIXME: which is the best order? */
325 /* video registers are sampled by VREF */
326 rc = em28xx_write_reg_bits(dev, USBSUSP_REG,
327 start ? 0x10 : 0x00, 0x10);
332 /* disable video capture */
333 rc = em28xx_write_regs(dev, VINENABLE_REG, "\x27", 1);
337 /* enable video capture */
338 rc = em28xx_write_regs_req(dev, 0x00, 0x48, "\x00", 1);
340 if (dev->mode == EM28XX_ANALOG_MODE)
341 rc = em28xx_write_regs(dev, VINENABLE_REG,"\x67", 1);
343 rc = em28xx_write_regs(dev, VINENABLE_REG,"\x37", 1);
350 int em28xx_outfmt_set_yuv422(struct em28xx *dev)
352 em28xx_write_regs(dev, OUTFMT_REG, "\x34", 1);
353 em28xx_write_regs(dev, VINMODE_REG, "\x10", 1);
354 return em28xx_write_regs(dev, VINCTRL_REG, "\x11", 1);
357 static int em28xx_accumulator_set(struct em28xx *dev, u8 xmin, u8 xmax,
360 em28xx_coredbg("em28xx Scale: (%d,%d)-(%d,%d)\n", xmin, ymin, xmax, ymax);
362 em28xx_write_regs(dev, XMIN_REG, &xmin, 1);
363 em28xx_write_regs(dev, XMAX_REG, &xmax, 1);
364 em28xx_write_regs(dev, YMIN_REG, &ymin, 1);
365 return em28xx_write_regs(dev, YMAX_REG, &ymax, 1);
368 static int em28xx_capture_area_set(struct em28xx *dev, u8 hstart, u8 vstart,
369 u16 width, u16 height)
373 u8 overflow = (height >> 7 & 0x02) | (width >> 8 & 0x01);
375 em28xx_coredbg("em28xx Area Set: (%d,%d)\n", (width | (overflow & 2) << 7),
376 (height | (overflow & 1) << 8));
378 em28xx_write_regs(dev, HSTART_REG, &hstart, 1);
379 em28xx_write_regs(dev, VSTART_REG, &vstart, 1);
380 em28xx_write_regs(dev, CWIDTH_REG, &cwidth, 1);
381 em28xx_write_regs(dev, CHEIGHT_REG, &cheight, 1);
382 return em28xx_write_regs(dev, OFLOW_REG, &overflow, 1);
385 static int em28xx_scaler_set(struct em28xx *dev, u16 h, u16 v)
388 /* the em2800 scaler only supports scaling down to 50% */
390 mode = (v ? 0x20 : 0x00) | (h ? 0x10 : 0x00);
395 em28xx_write_regs(dev, HSCALELOW_REG, (char *)buf, 2);
398 em28xx_write_regs(dev, VSCALELOW_REG, (char *)buf, 2);
399 /* it seems that both H and V scalers must be active to work correctly */
400 mode = (h || v)? 0x30: 0x00;
402 return em28xx_write_reg_bits(dev, COMPR_REG, mode, 0x30);
405 /* FIXME: this only function read values from dev */
406 int em28xx_resolution_set(struct em28xx *dev)
409 width = norm_maxw(dev);
410 height = norm_maxh(dev) >> 1;
412 em28xx_outfmt_set_yuv422(dev);
413 em28xx_accumulator_set(dev, 1, (width - 4) >> 2, 1, (height - 4) >> 2);
414 em28xx_capture_area_set(dev, 0, 0, width >> 2, height >> 2);
415 return em28xx_scaler_set(dev, dev->hscale, dev->vscale);
418 int em28xx_set_alternate(struct em28xx *dev)
420 int errCode, prev_alt = dev->alt;
422 unsigned int min_pkt_size = dev->width * 2 + 4;
424 /* When image size is bigger than a certain value,
425 the frame size should be increased, otherwise, only
426 green screen will be received.
428 if (dev->width * 2 * dev->height > 720 * 240 * 2)
431 for (i = 0; i < dev->num_alt; i++) {
432 /* stop when the selected alt setting offers enough bandwidth */
433 if (dev->alt_max_pkt_size[i] >= min_pkt_size) {
436 /* otherwise make sure that we end up with the maximum bandwidth
437 because the min_pkt_size equation might be wrong...
439 } else if (dev->alt_max_pkt_size[i] >
440 dev->alt_max_pkt_size[dev->alt])
444 if (dev->alt != prev_alt) {
445 em28xx_coredbg("minimum isoc packet size: %u (alt=%d)\n",
446 min_pkt_size, dev->alt);
447 dev->max_pkt_size = dev->alt_max_pkt_size[dev->alt];
448 em28xx_coredbg("setting alternate %d with wMaxPacketSize=%u\n",
449 dev->alt, dev->max_pkt_size);
450 errCode = usb_set_interface(dev->udev, 0, dev->alt);
452 em28xx_errdev ("cannot change alternate number to %d (error=%i)\n",
460 /* ------------------------------------------------------------------
462 ------------------------------------------------------------------*/
465 * IRQ callback, called by URB callback
467 static void em28xx_irq_callback(struct urb *urb)
469 struct em28xx_dmaqueue *dma_q = urb->context;
470 struct em28xx *dev = container_of(dma_q, struct em28xx, vidq);
473 /* Copy data from URB */
474 spin_lock(&dev->slock);
475 rc = dev->isoc_ctl.isoc_copy(dev, urb);
476 spin_unlock(&dev->slock);
478 /* Reset urb buffers */
479 for (i = 0; i < urb->number_of_packets; i++) {
480 urb->iso_frame_desc[i].status = 0;
481 urb->iso_frame_desc[i].actual_length = 0;
485 urb->status = usb_submit_urb(urb, GFP_ATOMIC);
487 em28xx_err("urb resubmit failed (error=%i)\n",
493 * Stop and Deallocate URBs
495 void em28xx_uninit_isoc(struct em28xx *dev)
500 em28xx_isocdbg("em28xx: called em28xx_uninit_isoc\n");
502 dev->isoc_ctl.nfields = -1;
503 for (i = 0; i < dev->isoc_ctl.num_bufs; i++) {
504 urb = dev->isoc_ctl.urb[i];
508 if (dev->isoc_ctl.transfer_buffer[i]) {
509 usb_buffer_free(dev->udev,
510 urb->transfer_buffer_length,
511 dev->isoc_ctl.transfer_buffer[i],
515 dev->isoc_ctl.urb[i] = NULL;
517 dev->isoc_ctl.transfer_buffer[i] = NULL;
520 kfree(dev->isoc_ctl.urb);
521 kfree(dev->isoc_ctl.transfer_buffer);
523 dev->isoc_ctl.urb = NULL;
524 dev->isoc_ctl.transfer_buffer = NULL;
525 dev->isoc_ctl.num_bufs = 0;
527 em28xx_capture_start(dev, 0);
529 EXPORT_SYMBOL_GPL(em28xx_uninit_isoc);
532 * Allocate URBs and start IRQ
534 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
535 int num_bufs, int max_pkt_size,
536 int (*isoc_copy) (struct em28xx *dev, struct urb *urb),
539 struct em28xx_dmaqueue *dma_q = &dev->vidq;
546 em28xx_isocdbg("em28xx: called em28xx_prepare_isoc\n");
548 /* De-allocates all pending stuff */
549 em28xx_uninit_isoc(dev);
551 dev->isoc_ctl.isoc_copy = isoc_copy;
552 dev->isoc_ctl.num_bufs = num_bufs;
554 dev->isoc_ctl.urb = kzalloc(sizeof(void *)*num_bufs, GFP_KERNEL);
555 if (!dev->isoc_ctl.urb) {
556 em28xx_errdev("cannot alloc memory for usb buffers\n");
560 dev->isoc_ctl.transfer_buffer = kzalloc(sizeof(void *)*num_bufs,
562 if (!dev->isoc_ctl.urb) {
563 em28xx_errdev("cannot allocate memory for usbtransfer\n");
564 kfree(dev->isoc_ctl.urb);
568 dev->isoc_ctl.max_pkt_size = max_pkt_size;
569 dev->isoc_ctl.buf = NULL;
571 sb_size = max_packets * dev->isoc_ctl.max_pkt_size;
573 /* allocate urbs and transfer buffers */
574 for (i = 0; i < dev->isoc_ctl.num_bufs; i++) {
575 urb = usb_alloc_urb(max_packets, GFP_KERNEL);
577 em28xx_err("cannot alloc isoc_ctl.urb %i\n", i);
578 em28xx_uninit_isoc(dev);
581 dev->isoc_ctl.urb[i] = urb;
583 dev->isoc_ctl.transfer_buffer[i] = usb_buffer_alloc(dev->udev,
584 sb_size, GFP_KERNEL, &urb->transfer_dma);
585 if (!dev->isoc_ctl.transfer_buffer[i]) {
586 em28xx_err("unable to allocate %i bytes for transfer"
589 in_interrupt()?" while in int":"");
590 em28xx_uninit_isoc(dev);
593 memset(dev->isoc_ctl.transfer_buffer[i], 0, sb_size);
595 /* FIXME: this is a hack - should be
596 'desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK'
597 should also be using 'desc.bInterval'
599 pipe = usb_rcvisocpipe(dev->udev, cap_type == EM28XX_ANALOG_CAPTURE ? 0x82 : 0x84);
600 usb_fill_int_urb(urb, dev->udev, pipe,
601 dev->isoc_ctl.transfer_buffer[i], sb_size,
602 em28xx_irq_callback, dma_q, 1);
604 urb->number_of_packets = max_packets;
605 urb->transfer_flags = URB_ISO_ASAP;
608 for (j = 0; j < max_packets; j++) {
609 urb->iso_frame_desc[j].offset = k;
610 urb->iso_frame_desc[j].length =
611 dev->isoc_ctl.max_pkt_size;
612 k += dev->isoc_ctl.max_pkt_size;
616 init_waitqueue_head(&dma_q->wq);
618 em28xx_capture_start(dev, cap_type);
620 /* submit urbs and enables IRQ */
621 for (i = 0; i < dev->isoc_ctl.num_bufs; i++) {
622 rc = usb_submit_urb(dev->isoc_ctl.urb[i], GFP_ATOMIC);
624 em28xx_err("submit of urb %i failed (error=%i)\n", i,
626 em28xx_uninit_isoc(dev);
633 EXPORT_SYMBOL_GPL(em28xx_init_isoc);