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