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