drivers/media/video/em28xx/em28xx.h

   1 /*
   2    em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
   3
   4    Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
   5                       Ludovico Cavedon <cavedon@sssup.it>
   6                       Mauro Carvalho Chehab <mchehab@infradead.org>
   7
   8    Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23  */
  24
  25 #ifndef _EM28XX_H
  26 #define _EM28XX_H
  27
  28 #include <linux/videodev2.h>
  29 #include <media/videobuf-vmalloc.h>
  30
  31 #include <linux/i2c.h>
  32 #include <linux/mutex.h>
  33 #include <media/ir-kbd-i2c.h>
  34
  35 /* maximum number of em28xx boards */
  36 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
  37
  38 /* maximum number of frames that can be queued */
  39 #define EM28XX_NUM_FRAMES 5
  40 /* number of frames that get used for v4l2_read() */
  41 #define EM28XX_NUM_READ_FRAMES 2
  42
  43 /* number of buffers for isoc transfers */
  44 #define EM28XX_NUM_BUFS 5
  45
  46 /* number of packets for each buffer
  47    windows requests only 40 packets .. so we better do the same
  48    this is what I found out for all alternate numbers there!
  49  */
  50 #define EM28XX_NUM_PACKETS 40
  51
  52 /* default alternate; 0 means choose the best */
  53 #define EM28XX_PINOUT 0
  54
  55 #define EM28XX_INTERLACED_DEFAULT 1
  56
  57 /*
  58 #define (use usbview if you want to get the other alternate number infos)
  59 #define
  60 #define alternate number 2
  61 #define                         Endpoint Address: 82
  62                         Direction: in
  63                         Attribute: 1
  64                         Type: Isoc
  65                         Max Packet Size: 1448
  66                         Interval: 125us
  67
  68   alternate number 7
  69
  70                         Endpoint Address: 82
  71                         Direction: in
  72                         Attribute: 1
  73                         Type: Isoc
  74                         Max Packet Size: 3072
  75                         Interval: 125us
  76 */
  77
  78 /* time to wait when stopping the isoc transfer */
  79 #define EM28XX_URB_TIMEOUT       msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
  80
  81 /* time in msecs to wait for i2c writes to finish */
  82 #define EM2800_I2C_WRITE_TIMEOUT 20
  83
  84 enum em28xx_stream_state {
  85         STREAM_OFF,
  86         STREAM_INTERRUPT,
  87         STREAM_ON,
  88 };
  89
  90 struct em28xx_usb_isoc_ctl {
  91                 /* max packet size of isoc transaction */
  92         int                             max_pkt_size;
  93
  94                 /* number of allocated urbs */
  95         int                             num_bufs;
  96
  97                 /* urb for isoc transfers */
  98         struct urb                      **urb;
  99
 100                 /* transfer buffers for isoc transfer */
 101         char                            **transfer_buffer;
 102
 103                 /* Last buffer command and region */
 104         u8                              cmd;
 105         int                             pos, size, pktsize;
 106
 107                 /* Last field: ODD or EVEN? */
 108         int                             field;
 109
 110                 /* Stores incomplete commands */
 111         u32                             tmp_buf;
 112         int                             tmp_buf_len;
 113
 114                 /* Stores already requested buffers */
 115         struct em28xx_buffer            *buf;
 116
 117                 /* Stores the number of received fields */
 118         int                             nfields;
 119 };
 120
 121 struct em28xx_fmt {
 122         char  *name;
 123         u32   fourcc;          /* v4l2 format id */
 124 };
 125
 126 /* buffer for one video frame */
 127 struct em28xx_buffer {
 128         /* common v4l buffer stuff -- must be first */
 129         struct videobuf_buffer vb;
 130
 131         struct em28xx_fmt *fmt;
 132
 133         struct list_head frame;
 134         int top_field;
 135         int receiving;
 136 };
 137
 138 struct em28xx_dmaqueue {
 139         struct list_head       active;
 140         struct list_head       queued;
 141
 142         wait_queue_head_t          wq;
 143
 144         /* Counters to control buffer fill */
 145         int                        pos;
 146 };
 147
 148 /* io methods */
 149 enum em28xx_io_method {
 150         IO_NONE,
 151         IO_READ,
 152         IO_MMAP,
 153 };
 154
 155 /* inputs */
 156
 157 #define MAX_EM28XX_INPUT 4
 158 enum enum28xx_itype {
 159         EM28XX_VMUX_COMPOSITE1 = 1,
 160         EM28XX_VMUX_COMPOSITE2,
 161         EM28XX_VMUX_COMPOSITE3,
 162         EM28XX_VMUX_COMPOSITE4,
 163         EM28XX_VMUX_SVIDEO,
 164         EM28XX_VMUX_TELEVISION,
 165         EM28XX_VMUX_CABLE,
 166         EM28XX_VMUX_DVB,
 167         EM28XX_VMUX_DEBUG,
 168         EM28XX_RADIO,
 169 };
 170
 171 enum em28xx_amux {
 172         EM28XX_AMUX_VIDEO,
 173         EM28XX_AMUX_LINE_IN,
 174         EM28XX_AMUX_AC97_VIDEO,
 175         EM28XX_AMUX_AC97_LINE_IN,
 176 };
 177
 178 struct em28xx_input {
 179         enum enum28xx_itype type;
 180         unsigned int vmux;
 181         enum em28xx_amux amux;
 182 };
 183
 184 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
 185
 186 enum em28xx_decoder {
 187         EM28XX_TVP5150,
 188         EM28XX_SAA7113,
 189         EM28XX_SAA7114
 190 };
 191
 192 struct em28xx_board {
 193         char *name;
 194         int vchannels;
 195         int tuner_type;
 196
 197         /* i2c flags */
 198         unsigned int tda9887_conf;
 199
 200         unsigned int is_em2800:1;
 201         unsigned int has_msp34xx:1;
 202         unsigned int mts_firmware:1;
 203         unsigned int has_12mhz_i2s:1;
 204         unsigned int max_range_640_480:1;
 205
 206         unsigned int analog_gpio;
 207
 208         enum em28xx_decoder decoder;
 209
 210         struct em28xx_input       input[MAX_EM28XX_INPUT];
 211         struct em28xx_input       radio;
 212 };
 213
 214 struct em28xx_eeprom {
 215         u32 id;                 /* 0x9567eb1a */
 216         u16 vendor_ID;
 217         u16 product_ID;
 218
 219         u16 chip_conf;
 220
 221         u16 board_conf;
 222
 223         u16 string1, string2, string3;
 224
 225         u8 string_idx_table;
 226 };
 227
 228 /* device states */
 229 enum em28xx_dev_state {
 230         DEV_INITIALIZED = 0x01,
 231         DEV_DISCONNECTED = 0x02,
 232         DEV_MISCONFIGURED = 0x04,
 233 };
 234
 235 #define EM28XX_AUDIO_BUFS 5
 236 #define EM28XX_NUM_AUDIO_PACKETS 64
 237 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
 238 #define EM28XX_CAPTURE_STREAM_EN 1
 239 #define EM28XX_AUDIO   0x10
 240
 241 struct em28xx_audio {
 242         char name[50];
 243         char *transfer_buffer[EM28XX_AUDIO_BUFS];
 244         struct urb *urb[EM28XX_AUDIO_BUFS];
 245         struct usb_device *udev;
 246         unsigned int capture_transfer_done;
 247         struct snd_pcm_substream   *capture_pcm_substream;
 248
 249         unsigned int hwptr_done_capture;
 250         struct snd_card            *sndcard;
 251
 252         int users, shutdown;
 253         enum em28xx_stream_state capture_stream;
 254         spinlock_t slock;
 255 };
 256
 257 /* main device struct */
 258 struct em28xx {
 259         /* generic device properties */
 260         char name[30];          /* name (including minor) of the device */
 261         int model;              /* index in the device_data struct */
 262         int devno;              /* marks the number of this device */
 263         unsigned int analog_gpio;
 264         unsigned int is_em2800:1;
 265         unsigned int has_msp34xx:1;
 266         unsigned int has_tda9887:1;
 267         unsigned int stream_on:1;       /* Locks streams */
 268         unsigned int has_audio_class:1;
 269         unsigned int has_12mhz_i2s:1;
 270         unsigned int max_range_640_480:1;
 271
 272         int video_inputs;       /* number of video inputs */
 273         struct list_head        devlist;
 274
 275         u32 i2s_speed;          /* I2S speed for audio digital stream */
 276
 277         enum em28xx_decoder decoder;
 278
 279         int tuner_type;         /* type of the tuner */
 280         int tuner_addr;         /* tuner address */
 281         int tda9887_conf;
 282         /* i2c i/o */
 283         struct i2c_adapter i2c_adap;
 284         struct i2c_client i2c_client;
 285         /* video for linux */
 286         int users;              /* user count for exclusive use */
 287         struct video_device *vdev;      /* video for linux device struct */
 288         v4l2_std_id norm;       /* selected tv norm */
 289         int ctl_freq;           /* selected frequency */
 290         unsigned int ctl_input; /* selected input */
 291         unsigned int ctl_ainput;        /* slected audio input */
 292         int mute;
 293         int volume;
 294         /* frame properties */
 295         int width;              /* current frame width */
 296         int height;             /* current frame height */
 297         int frame_size;         /* current frame size */
 298         int field_size;         /* current field size */
 299         int bytesperline;
 300         int hscale;             /* horizontal scale factor (see datasheet) */
 301         int vscale;             /* vertical scale factor (see datasheet) */
 302         int interlaced;         /* 1=interlace fileds, 0=just top fileds */
 303         unsigned int video_bytesread;   /* Number of bytes read */
 304
 305         unsigned long hash;     /* eeprom hash - for boards with generic ID */
 306         unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
 307
 308         struct em28xx_audio *adev;
 309
 310         /* states */
 311         enum em28xx_dev_state state;
 312         enum em28xx_io_method io;
 313
 314         struct work_struct         request_module_wk;
 315
 316         /* locks */
 317         struct mutex lock;
 318         /* spinlock_t queue_lock; */
 319         struct list_head inqueue, outqueue;
 320         wait_queue_head_t open, wait_frame, wait_stream;
 321         struct video_device *vbi_dev;
 322         struct video_device *radio_dev;
 323
 324         unsigned char eedata[256];
 325
 326         /* Isoc control struct */
 327         struct em28xx_dmaqueue vidq;
 328         struct em28xx_usb_isoc_ctl isoc_ctl;
 329         spinlock_t slock;
 330
 331         /* usb transfer */
 332         struct usb_device *udev;        /* the usb device */
 333         int alt;                /* alternate */
 334         int max_pkt_size;       /* max packet size of isoc transaction */
 335         int num_alt;            /* Number of alternative settings */
 336         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 337         struct urb *urb[EM28XX_NUM_BUFS];       /* urb for isoc transfers */
 338         char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
 339         /* helper funcs that call usb_control_msg */
 340         int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
 341                                   int len);
 342         int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
 343         int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
 344                                         char *buf, int len);
 345         int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
 346                                       char *buf, int len);
 347         int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
 348 };
 349
 350 struct em28xx_fh {
 351         struct em28xx *dev;
 352         unsigned int  stream_on:1;      /* Locks streams */
 353         int           radio;
 354
 355         unsigned int                 width, height;
 356         struct videobuf_queue        vb_vidq;
 357         struct em28xx_fmt            *fmt;
 358
 359         enum v4l2_buf_type           type;
 360 };
 361
 362 struct em28xx_ops {
 363         struct list_head next;
 364         char *name;
 365         int id;
 366         int (*init)(struct em28xx *);
 367         int (*fini)(struct em28xx *);
 368 };
 369
 370 /* Provided by em28xx-i2c.c */
 371
 372 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
 373 void em28xx_do_i2c_scan(struct em28xx *dev);
 374 int em28xx_i2c_register(struct em28xx *dev);
 375 int em28xx_i2c_unregister(struct em28xx *dev);
 376
 377 /* Provided by em28xx-core.c */
 378
 379 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
 380 void em28xx_queue_unusedframes(struct em28xx *dev);
 381 void em28xx_release_buffers(struct em28xx *dev);
 382
 383 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
 384                             char *buf, int len);
 385 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
 386 int em28xx_read_reg(struct em28xx *dev, u16 reg);
 387 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
 388                           int len);
 389 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
 390 int em28xx_audio_analog_set(struct em28xx *dev);
 391
 392 int em28xx_colorlevels_set_default(struct em28xx *dev);
 393 int em28xx_capture_start(struct em28xx *dev, int start);
 394 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
 395 int em28xx_resolution_set(struct em28xx *dev);
 396 int em28xx_set_alternate(struct em28xx *dev);
 397
 398 /* Provided by em28xx-video.c */
 399 int em28xx_register_extension(struct em28xx_ops *dev);
 400 void em28xx_unregister_extension(struct em28xx_ops *dev);
 401
 402 /* Provided by em28xx-cards.c */
 403 extern int em2800_variant_detect(struct usb_device* udev,int model);
 404 extern void em28xx_pre_card_setup(struct em28xx *dev);
 405 extern void em28xx_card_setup(struct em28xx *dev);
 406 extern struct em28xx_board em28xx_boards[];
 407 extern struct usb_device_id em28xx_id_table[];
 408 extern const unsigned int em28xx_bcount;
 409 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
 410
 411 /* Provided by em28xx-input.c */
 412 /* TODO: Check if the standard get_key handlers on ir-common can be used */
 413 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 414 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 415 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
 416                                      u32 *ir_raw);
 417
 418 /* em2800 registers */
 419 #define EM2800_AUDIOSRC_REG 0x08
 420
 421 /* em28xx registers */
 422 #define I2C_CLK_REG     0x06
 423 #define CHIPID_REG      0x0a
 424 #define USBSUSP_REG     0x0c    /* */
 425
 426 #define AUDIOSRC_REG    0x0e
 427 #define XCLK_REG        0x0f
 428
 429 #define VINMODE_REG     0x10
 430 #define VINCTRL_REG     0x11
 431 #define VINENABLE_REG   0x12    /* */
 432
 433 #define GAMMA_REG       0x14
 434 #define RGAIN_REG       0x15
 435 #define GGAIN_REG       0x16
 436 #define BGAIN_REG       0x17
 437 #define ROFFSET_REG     0x18
 438 #define GOFFSET_REG     0x19
 439 #define BOFFSET_REG     0x1a
 440
 441 #define OFLOW_REG       0x1b
 442 #define HSTART_REG      0x1c
 443 #define VSTART_REG      0x1d
 444 #define CWIDTH_REG      0x1e
 445 #define CHEIGHT_REG     0x1f
 446
 447 #define YGAIN_REG       0x20
 448 #define YOFFSET_REG     0x21
 449 #define UVGAIN_REG      0x22
 450 #define UOFFSET_REG     0x23
 451 #define VOFFSET_REG     0x24
 452 #define SHARPNESS_REG   0x25
 453
 454 #define COMPR_REG       0x26
 455 #define OUTFMT_REG      0x27
 456
 457 #define XMIN_REG        0x28
 458 #define XMAX_REG        0x29
 459 #define YMIN_REG        0x2a
 460 #define YMAX_REG        0x2b
 461
 462 #define HSCALELOW_REG   0x30
 463 #define HSCALEHIGH_REG  0x31
 464 #define VSCALELOW_REG   0x32
 465 #define VSCALEHIGH_REG  0x33
 466
 467 #define AC97LSB_REG     0x40
 468 #define AC97MSB_REG     0x41
 469 #define AC97ADDR_REG    0x42
 470 #define AC97BUSY_REG    0x43
 471
 472 /* em202 registers */
 473 #define MASTER_AC97     0x02
 474 #define LINE_IN_AC97    0x10
 475 #define VIDEO_AC97      0x14
 476
 477 /* register settings */
 478 #define EM2800_AUDIO_SRC_TUNER  0x0d
 479 #define EM2800_AUDIO_SRC_LINE   0x0c
 480 #define EM28XX_AUDIO_SRC_TUNER  0xc0
 481 #define EM28XX_AUDIO_SRC_LINE   0x80
 482
 483 /* printk macros */
 484
 485 #define em28xx_err(fmt, arg...) do {\
 486         printk(KERN_ERR fmt , ##arg); } while (0)
 487
 488 #define em28xx_errdev(fmt, arg...) do {\
 489         printk(KERN_ERR "%s: "fmt,\
 490                         dev->name , ##arg); } while (0)
 491
 492 #define em28xx_info(fmt, arg...) do {\
 493         printk(KERN_INFO "%s: "fmt,\
 494                         dev->name , ##arg); } while (0)
 495 #define em28xx_warn(fmt, arg...) do {\
 496         printk(KERN_WARNING "%s: "fmt,\
 497                         dev->name , ##arg); } while (0)
 498
 499 inline static int em28xx_compression_disable(struct em28xx *dev)
 500 {
 501         /* side effect of disabling scaler and mixer */
 502         return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
 503 }
 504
 505 inline static int em28xx_contrast_get(struct em28xx *dev)
 506 {
 507         return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
 508 }
 509
 510 inline static int em28xx_brightness_get(struct em28xx *dev)
 511 {
 512         return em28xx_read_reg(dev, YOFFSET_REG);
 513 }
 514
 515 inline static int em28xx_saturation_get(struct em28xx *dev)
 516 {
 517         return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
 518 }
 519
 520 inline static int em28xx_u_balance_get(struct em28xx *dev)
 521 {
 522         return em28xx_read_reg(dev, UOFFSET_REG);
 523 }
 524
 525 inline static int em28xx_v_balance_get(struct em28xx *dev)
 526 {
 527         return em28xx_read_reg(dev, VOFFSET_REG);
 528 }
 529
 530 inline static int em28xx_gamma_get(struct em28xx *dev)
 531 {
 532         return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
 533 }
 534
 535 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
 536 {
 537         u8 tmp = (u8) val;
 538         return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
 539 }
 540
 541 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
 542 {
 543         u8 tmp = (u8) val;
 544         return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
 545 }
 546
 547 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
 548 {
 549         u8 tmp = (u8) val;
 550         return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
 551 }
 552
 553 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
 554 {
 555         u8 tmp = (u8) val;
 556         return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
 557 }
 558
 559 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
 560 {
 561         u8 tmp = (u8) val;
 562         return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
 563 }
 564
 565 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
 566 {
 567         u8 tmp = (u8) val;
 568         return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
 569 }
 570
 571 /*FIXME: maxw should be dependent of alt mode */
 572 inline static unsigned int norm_maxw(struct em28xx *dev)
 573 {
 574         if (dev->max_range_640_480)
 575                 return 640;
 576         else
 577                 return 720;
 578 }
 579
 580 inline static unsigned int norm_maxh(struct em28xx *dev)
 581 {
 582         if (dev->max_range_640_480)
 583                 return 480;
 584         else
 585                 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
 586 }
 587 #endif