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 <linux/i2c.h>
  30 #include <linux/mutex.h>
  31 #include <media/ir-kbd-i2c.h>
  32
  33 /* Boards supported by driver */
  34
  35 #define EM2800_BOARD_UNKNOWN                    0
  36 #define EM2820_BOARD_UNKNOWN                    1
  37 #define EM2820_BOARD_TERRATEC_CINERGY_250       2
  38 #define EM2820_BOARD_PINNACLE_USB_2             3
  39 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2      4
  40 #define EM2820_BOARD_MSI_VOX_USB_2              5
  41 #define EM2800_BOARD_TERRATEC_CINERGY_200       6
  42 #define EM2800_BOARD_LEADTEK_WINFAST_USBII      7
  43 #define EM2800_BOARD_KWORLD_USB2800             8
  44 #define EM2820_BOARD_PINNACLE_DVC_90            9
  45 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900    10
  46 #define EM2880_BOARD_TERRATEC_HYBRID_XS         11
  47 #define EM2820_BOARD_KWORLD_PVRTV2800RF         12
  48 #define EM2880_BOARD_TERRATEC_PRODIGY_XS        13
  49 #define EM2820_BOARD_PROLINK_PLAYTV_USB2        14
  50 #define EM2800_BOARD_VGEAR_POCKETTV             15
  51 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_950    16
  52
  53 #define UNSET -1
  54
  55 /* maximum number of em28xx boards */
  56 #define EM28XX_MAXBOARDS 1 /*FIXME: should be bigger */
  57
  58 /* maximum number of frames that can be queued */
  59 #define EM28XX_NUM_FRAMES 5
  60 /* number of frames that get used for v4l2_read() */
  61 #define EM28XX_NUM_READ_FRAMES 2
  62
  63 /* number of buffers for isoc transfers */
  64 #define EM28XX_NUM_BUFS 5
  65
  66 /* number of packets for each buffer
  67    windows requests only 40 packets .. so we better do the same
  68    this is what I found out for all alternate numbers there!
  69  */
  70 #define EM28XX_NUM_PACKETS 40
  71
  72 /* default alternate; 0 means choose the best */
  73 #define EM28XX_PINOUT 0
  74
  75 #define EM28XX_INTERLACED_DEFAULT 1
  76
  77 /*
  78 #define (use usbview if you want to get the other alternate number infos)
  79 #define
  80 #define alternate number 2
  81 #define                         Endpoint Address: 82
  82                         Direction: in
  83                         Attribute: 1
  84                         Type: Isoc
  85                         Max Packet Size: 1448
  86                         Interval: 125us
  87
  88   alternate number 7
  89
  90                         Endpoint Address: 82
  91                         Direction: in
  92                         Attribute: 1
  93                         Type: Isoc
  94                         Max Packet Size: 3072
  95                         Interval: 125us
  96 */
  97
  98 /* time to wait when stopping the isoc transfer */
  99 #define EM28XX_URB_TIMEOUT       msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
 100
 101 /* time in msecs to wait for i2c writes to finish */
 102 #define EM2800_I2C_WRITE_TIMEOUT 20
 103
 104 /* the various frame states */
 105 enum em28xx_frame_state {
 106         F_UNUSED = 0,
 107         F_QUEUED,
 108         F_GRABBING,
 109         F_DONE,
 110         F_ERROR,
 111 };
 112
 113 /* stream states */
 114 enum em28xx_stream_state {
 115         STREAM_OFF,
 116         STREAM_INTERRUPT,
 117         STREAM_ON,
 118 };
 119
 120 /* frames */
 121 struct em28xx_frame_t {
 122         void *bufmem;
 123         struct v4l2_buffer buf;
 124         enum em28xx_frame_state state;
 125         struct list_head frame;
 126         unsigned long vma_use_count;
 127         int top_field;
 128         int fieldbytesused;
 129 };
 130
 131 /* io methods */
 132 enum em28xx_io_method {
 133         IO_NONE,
 134         IO_READ,
 135         IO_MMAP,
 136 };
 137
 138 /* inputs */
 139
 140 #define MAX_EM28XX_INPUT 4
 141 enum enum28xx_itype {
 142         EM28XX_VMUX_COMPOSITE1 = 1,
 143         EM28XX_VMUX_COMPOSITE2,
 144         EM28XX_VMUX_COMPOSITE3,
 145         EM28XX_VMUX_COMPOSITE4,
 146         EM28XX_VMUX_SVIDEO,
 147         EM28XX_VMUX_TELEVISION,
 148         EM28XX_VMUX_CABLE,
 149         EM28XX_VMUX_DVB,
 150         EM28XX_VMUX_DEBUG,
 151         EM28XX_RADIO,
 152 };
 153
 154 struct em28xx_input {
 155         enum enum28xx_itype type;
 156         unsigned int vmux;
 157         unsigned int amux;
 158 };
 159
 160 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
 161
 162 enum em28xx_decoder {
 163         EM28XX_TVP5150,
 164         EM28XX_SAA7113,
 165         EM28XX_SAA7114
 166 };
 167
 168 struct em28xx_board {
 169         char *name;
 170         int vchannels;
 171         int tuner_type;
 172
 173         /* i2c flags */
 174         unsigned int is_em2800;
 175         unsigned int tda9887_conf;
 176
 177         unsigned int has_tuner:1;
 178         unsigned int has_msp34xx:1;
 179         unsigned int mts_firmware:1;
 180
 181         enum em28xx_decoder decoder;
 182
 183         struct em28xx_input       input[MAX_EM28XX_INPUT];
 184 };
 185
 186 struct em28xx_eeprom {
 187         u32 id;                 /* 0x9567eb1a */
 188         u16 vendor_ID;
 189         u16 product_ID;
 190
 191         u16 chip_conf;
 192
 193         u16 board_conf;
 194
 195         u16 string1, string2, string3;
 196
 197         u8 string_idx_table;
 198 };
 199
 200 /* device states */
 201 enum em28xx_dev_state {
 202         DEV_INITIALIZED = 0x01,
 203         DEV_DISCONNECTED = 0x02,
 204         DEV_MISCONFIGURED = 0x04,
 205 };
 206
 207 /* main device struct */
 208 struct em28xx {
 209         /* generic device properties */
 210         char name[30];          /* name (including minor) of the device */
 211         int model;              /* index in the device_data struct */
 212         int devno;              /* marks the number of this device */
 213         unsigned int is_em2800;
 214         int video_inputs;       /* number of video inputs */
 215         struct list_head        devlist;
 216         unsigned int has_tuner:1;
 217         unsigned int has_msp34xx:1;
 218         unsigned int has_tda9887:1;
 219
 220         unsigned int stream_on:1;       /* Locks streams */
 221
 222         u32 i2s_speed;          /* I2S speed for audio digital stream */
 223
 224         enum em28xx_decoder decoder;
 225
 226         int tuner_type;         /* type of the tuner */
 227         int tuner_addr;         /* tuner address */
 228         int tda9887_conf;
 229         /* i2c i/o */
 230         struct i2c_adapter i2c_adap;
 231         struct i2c_client i2c_client;
 232         /* video for linux */
 233         int users;              /* user count for exclusive use */
 234         struct video_device *vdev;      /* video for linux device struct */
 235         v4l2_std_id norm;       /* selected tv norm */
 236         int ctl_freq;           /* selected frequency */
 237         unsigned int ctl_input; /* selected input */
 238         unsigned int ctl_ainput;        /* slected audio input */
 239         int mute;
 240         int volume;
 241         /* frame properties */
 242         struct em28xx_frame_t frame[EM28XX_NUM_FRAMES]; /* list of frames */
 243         int num_frames;         /* number of frames currently in use */
 244         unsigned int frame_count;       /* total number of transfered frames */
 245         struct em28xx_frame_t *frame_current;   /* the frame that is being filled */
 246         int width;              /* current frame width */
 247         int height;             /* current frame height */
 248         int frame_size;         /* current frame size */
 249         int field_size;         /* current field size */
 250         int bytesperline;
 251         int hscale;             /* horizontal scale factor (see datasheet) */
 252         int vscale;             /* vertical scale factor (see datasheet) */
 253         int interlaced;         /* 1=interlace fileds, 0=just top fileds */
 254         int type;
 255         unsigned int video_bytesread;   /* Number of bytes read */
 256
 257         unsigned long hash;     /* eeprom hash - for boards with generic ID */
 258         unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
 259
 260         /* states */
 261         enum em28xx_dev_state state;
 262         enum em28xx_stream_state stream;
 263         enum em28xx_io_method io;
 264
 265         /* locks */
 266         struct mutex lock;
 267         spinlock_t queue_lock;
 268         struct list_head inqueue, outqueue;
 269         wait_queue_head_t open, wait_frame, wait_stream;
 270         struct video_device *vbi_dev;
 271
 272         unsigned char eedata[256];
 273
 274         /* usb transfer */
 275         struct usb_device *udev;        /* the usb device */
 276         int alt;                /* alternate */
 277         int max_pkt_size;       /* max packet size of isoc transaction */
 278         int num_alt;            /* Number of alternative settings */
 279         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 280         struct urb *urb[EM28XX_NUM_BUFS];       /* urb for isoc transfers */
 281         char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
 282         /* helper funcs that call usb_control_msg */
 283         int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
 284                                   int len);
 285         int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
 286         int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
 287                                         char *buf, int len);
 288         int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
 289                                       char *buf, int len);
 290         int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
 291 };
 292
 293 struct em28xx_fh {
 294         struct em28xx *dev;
 295         unsigned int  stream_on:1;      /* Locks streams */
 296 };
 297
 298 /* Provided by em28xx-i2c.c */
 299
 300 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
 301 void em28xx_do_i2c_scan(struct em28xx *dev);
 302 int em28xx_i2c_register(struct em28xx *dev);
 303 int em28xx_i2c_unregister(struct em28xx *dev);
 304
 305 /* Provided by em28xx-input.c */
 306
 307 void em28xx_set_ir(struct em28xx * dev,struct IR_i2c *ir);
 308
 309 /* Provided by em28xx-core.c */
 310
 311 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
 312 void em28xx_queue_unusedframes(struct em28xx *dev);
 313 void em28xx_release_buffers(struct em28xx *dev);
 314
 315 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
 316                             char *buf, int len);
 317 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
 318 int em28xx_read_reg(struct em28xx *dev, u16 reg);
 319 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
 320                           int len);
 321 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
 322 int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
 323                           u8 bitmask);
 324 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u8 * val);
 325 int em28xx_audio_analog_set(struct em28xx *dev);
 326 int em28xx_colorlevels_set_default(struct em28xx *dev);
 327 int em28xx_capture_start(struct em28xx *dev, int start);
 328 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
 329 int em28xx_resolution_set(struct em28xx *dev);
 330 int em28xx_init_isoc(struct em28xx *dev);
 331 void em28xx_uninit_isoc(struct em28xx *dev);
 332 int em28xx_set_alternate(struct em28xx *dev);
 333
 334 /* Provided by em28xx-cards.c */
 335 extern int em2800_variant_detect(struct usb_device* udev,int model);
 336 extern void em28xx_pre_card_setup(struct em28xx *dev);
 337 extern void em28xx_card_setup(struct em28xx *dev);
 338 extern struct em28xx_board em28xx_boards[];
 339 extern struct usb_device_id em28xx_id_table[];
 340 extern const unsigned int em28xx_bcount;
 341
 342 /* em2800 registers */
 343 #define EM2800_AUDIOSRC_REG 0x08
 344
 345 /* em28xx registers */
 346 #define CHIPID_REG      0x0a
 347 #define USBSUSP_REG     0x0c    /* */
 348
 349 #define AUDIOSRC_REG    0x0e
 350 #define XCLK_REG        0x0f
 351
 352 #define VINMODE_REG     0x10
 353 #define VINCTRL_REG     0x11
 354 #define VINENABLE_REG   0x12    /* */
 355
 356 #define GAMMA_REG       0x14
 357 #define RGAIN_REG       0x15
 358 #define GGAIN_REG       0x16
 359 #define BGAIN_REG       0x17
 360 #define ROFFSET_REG     0x18
 361 #define GOFFSET_REG     0x19
 362 #define BOFFSET_REG     0x1a
 363
 364 #define OFLOW_REG       0x1b
 365 #define HSTART_REG      0x1c
 366 #define VSTART_REG      0x1d
 367 #define CWIDTH_REG      0x1e
 368 #define CHEIGHT_REG     0x1f
 369
 370 #define YGAIN_REG       0x20
 371 #define YOFFSET_REG     0x21
 372 #define UVGAIN_REG      0x22
 373 #define UOFFSET_REG     0x23
 374 #define VOFFSET_REG     0x24
 375 #define SHARPNESS_REG   0x25
 376
 377 #define COMPR_REG       0x26
 378 #define OUTFMT_REG      0x27
 379
 380 #define XMIN_REG        0x28
 381 #define XMAX_REG        0x29
 382 #define YMIN_REG        0x2a
 383 #define YMAX_REG        0x2b
 384
 385 #define HSCALELOW_REG   0x30
 386 #define HSCALEHIGH_REG  0x31
 387 #define VSCALELOW_REG   0x32
 388 #define VSCALEHIGH_REG  0x33
 389
 390 #define AC97LSB_REG     0x40
 391 #define AC97MSB_REG     0x41
 392 #define AC97ADDR_REG    0x42
 393 #define AC97BUSY_REG    0x43
 394
 395 /* em202 registers */
 396 #define MASTER_AC97     0x02
 397 #define VIDEO_AC97      0x14
 398
 399 /* register settings */
 400 #define EM2800_AUDIO_SRC_TUNER  0x0d
 401 #define EM2800_AUDIO_SRC_LINE   0x0c
 402 #define EM28XX_AUDIO_SRC_TUNER  0xc0
 403 #define EM28XX_AUDIO_SRC_LINE   0x80
 404
 405 /* printk macros */
 406
 407 #define em28xx_err(fmt, arg...) do {\
 408         printk(KERN_ERR fmt , ##arg); } while (0)
 409
 410 #define em28xx_errdev(fmt, arg...) do {\
 411         printk(KERN_ERR "%s: "fmt,\
 412                         dev->name , ##arg); } while (0)
 413
 414 #define em28xx_info(fmt, arg...) do {\
 415         printk(KERN_INFO "%s: "fmt,\
 416                         dev->name , ##arg); } while (0)
 417 #define em28xx_warn(fmt, arg...) do {\
 418         printk(KERN_WARNING "%s: "fmt,\
 419                         dev->name , ##arg); } while (0)
 420
 421 inline static int em28xx_audio_source(struct em28xx *dev, int input)
 422 {
 423         if(dev->is_em2800){
 424                 u8 tmp = EM2800_AUDIO_SRC_TUNER;
 425                 if(input == EM28XX_AUDIO_SRC_LINE)
 426                         tmp = EM2800_AUDIO_SRC_LINE;
 427                 em28xx_write_regs(dev, EM2800_AUDIOSRC_REG, &tmp, 1);
 428         }
 429         return em28xx_write_reg_bits(dev, AUDIOSRC_REG, input, 0xc0);
 430 }
 431
 432 inline static int em28xx_audio_usb_mute(struct em28xx *dev, int mute)
 433 {
 434         return em28xx_write_reg_bits(dev, XCLK_REG, mute ? 0x00 : 0x80, 0x80);
 435 }
 436
 437 inline static int em28xx_audio_analog_setup(struct em28xx *dev)
 438 {
 439         /* unmute video mixer with default volume level */
 440         return em28xx_write_ac97(dev, VIDEO_AC97, "\x08\x08");
 441 }
 442
 443 inline static int em28xx_compression_disable(struct em28xx *dev)
 444 {
 445         /* side effect of disabling scaler and mixer */
 446         return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
 447 }
 448
 449 inline static int em28xx_contrast_get(struct em28xx *dev)
 450 {
 451         return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
 452 }
 453
 454 inline static int em28xx_brightness_get(struct em28xx *dev)
 455 {
 456         return em28xx_read_reg(dev, YOFFSET_REG);
 457 }
 458
 459 inline static int em28xx_saturation_get(struct em28xx *dev)
 460 {
 461         return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
 462 }
 463
 464 inline static int em28xx_u_balance_get(struct em28xx *dev)
 465 {
 466         return em28xx_read_reg(dev, UOFFSET_REG);
 467 }
 468
 469 inline static int em28xx_v_balance_get(struct em28xx *dev)
 470 {
 471         return em28xx_read_reg(dev, VOFFSET_REG);
 472 }
 473
 474 inline static int em28xx_gamma_get(struct em28xx *dev)
 475 {
 476         return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
 477 }
 478
 479 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
 480 {
 481         u8 tmp = (u8) val;
 482         return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
 483 }
 484
 485 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
 486 {
 487         u8 tmp = (u8) val;
 488         return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
 489 }
 490
 491 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
 492 {
 493         u8 tmp = (u8) val;
 494         return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
 495 }
 496
 497 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
 498 {
 499         u8 tmp = (u8) val;
 500         return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
 501 }
 502
 503 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
 504 {
 505         u8 tmp = (u8) val;
 506         return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
 507 }
 508
 509 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
 510 {
 511         u8 tmp = (u8) val;
 512         return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
 513 }
 514
 515 /*FIXME: maxw should be dependent of alt mode */
 516 inline static unsigned int norm_maxw(struct em28xx *dev)
 517 {
 518         switch (dev->model) {
 519         case EM2820_BOARD_MSI_VOX_USB_2:
 520                 return 640;
 521         default:
 522                 return 720;
 523         }
 524 }
 525
 526 inline static unsigned int norm_maxh(struct em28xx *dev)
 527 {
 528         switch (dev->model) {
 529         case EM2820_BOARD_MSI_VOX_USB_2:
 530                 return 480;
 531         default:
 532                 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
 533         }
 534 }
 535 #endif