drivers/media/video/em28xx/em28xx.h

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