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