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