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 4 /*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_msp34xx:1;
 165         unsigned int mts_firmware:1;
 166         unsigned int has_12mhz_i2s:1;
 167         unsigned int max_range_640_480:1;
 168
 169         unsigned int analog_gpio;
 170
 171         enum em28xx_decoder decoder;
 172
 173         struct em28xx_input       input[MAX_EM28XX_INPUT];
 174         struct em28xx_input       radio;
 175 };
 176
 177 struct em28xx_eeprom {
 178         u32 id;                 /* 0x9567eb1a */
 179         u16 vendor_ID;
 180         u16 product_ID;
 181
 182         u16 chip_conf;
 183
 184         u16 board_conf;
 185
 186         u16 string1, string2, string3;
 187
 188         u8 string_idx_table;
 189 };
 190
 191 /* device states */
 192 enum em28xx_dev_state {
 193         DEV_INITIALIZED = 0x01,
 194         DEV_DISCONNECTED = 0x02,
 195         DEV_MISCONFIGURED = 0x04,
 196 };
 197
 198 #define EM28XX_AUDIO_BUFS 5
 199 #define EM28XX_NUM_AUDIO_PACKETS 64
 200 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
 201 #define EM28XX_CAPTURE_STREAM_EN 1
 202 #define EM28XX_AUDIO   0x10
 203
 204 struct em28xx_audio {
 205         char name[50];
 206         char *transfer_buffer[EM28XX_AUDIO_BUFS];
 207         struct urb *urb[EM28XX_AUDIO_BUFS];
 208         struct usb_device *udev;
 209         unsigned int capture_transfer_done;
 210         struct snd_pcm_substream   *capture_pcm_substream;
 211
 212         unsigned int hwptr_done_capture;
 213         struct snd_card            *sndcard;
 214
 215         int users, shutdown;
 216         enum em28xx_stream_state capture_stream;
 217         spinlock_t slock;
 218 };
 219
 220 /* main device struct */
 221 struct em28xx {
 222         /* generic device properties */
 223         char name[30];          /* name (including minor) of the device */
 224         int model;              /* index in the device_data struct */
 225         int devno;              /* marks the number of this device */
 226         unsigned int analog_gpio;
 227         unsigned int is_em2800:1;
 228         unsigned int has_msp34xx:1;
 229         unsigned int has_tda9887:1;
 230         unsigned int stream_on:1;       /* Locks streams */
 231         unsigned int has_audio_class:1;
 232         unsigned int has_12mhz_i2s:1;
 233         unsigned int max_range_640_480:1;
 234
 235         int video_inputs;       /* number of video inputs */
 236         struct list_head        devlist;
 237
 238         u32 i2s_speed;          /* I2S speed for audio digital stream */
 239
 240         enum em28xx_decoder decoder;
 241
 242         int tuner_type;         /* type of the tuner */
 243         int tuner_addr;         /* tuner address */
 244         int tda9887_conf;
 245         /* i2c i/o */
 246         struct i2c_adapter i2c_adap;
 247         struct i2c_client i2c_client;
 248         /* video for linux */
 249         int users;              /* user count for exclusive use */
 250         struct video_device *vdev;      /* video for linux device struct */
 251         v4l2_std_id norm;       /* selected tv norm */
 252         int ctl_freq;           /* selected frequency */
 253         unsigned int ctl_input; /* selected input */
 254         unsigned int ctl_ainput;        /* slected audio input */
 255         int mute;
 256         int volume;
 257         /* frame properties */
 258         struct em28xx_frame_t frame[EM28XX_NUM_FRAMES]; /* list of frames */
 259         int num_frames;         /* number of frames currently in use */
 260         unsigned int frame_count;       /* total number of transfered frames */
 261         struct em28xx_frame_t *frame_current;   /* the frame that is being filled */
 262         int width;              /* current frame width */
 263         int height;             /* current frame height */
 264         int frame_size;         /* current frame size */
 265         int field_size;         /* current field size */
 266         int bytesperline;
 267         int hscale;             /* horizontal scale factor (see datasheet) */
 268         int vscale;             /* vertical scale factor (see datasheet) */
 269         int interlaced;         /* 1=interlace fileds, 0=just top fileds */
 270         int type;
 271         unsigned int video_bytesread;   /* Number of bytes read */
 272
 273         unsigned long hash;     /* eeprom hash - for boards with generic ID */
 274         unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
 275
 276         struct em28xx_audio *adev;
 277
 278         /* states */
 279         enum em28xx_dev_state state;
 280         enum em28xx_stream_state stream;
 281         enum em28xx_io_method io;
 282
 283         struct work_struct         request_module_wk;
 284
 285         /* locks */
 286         struct mutex lock;
 287         spinlock_t queue_lock;
 288         struct list_head inqueue, outqueue;
 289         wait_queue_head_t open, wait_frame, wait_stream;
 290         struct video_device *vbi_dev;
 291         struct video_device *radio_dev;
 292
 293         unsigned char eedata[256];
 294
 295         /* usb transfer */
 296         struct usb_device *udev;        /* the usb device */
 297         int alt;                /* alternate */
 298         int max_pkt_size;       /* max packet size of isoc transaction */
 299         int num_alt;            /* Number of alternative settings */
 300         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 301         struct urb *urb[EM28XX_NUM_BUFS];       /* urb for isoc transfers */
 302         char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
 303         /* helper funcs that call usb_control_msg */
 304         int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
 305                                   int len);
 306         int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
 307         int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
 308                                         char *buf, int len);
 309         int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
 310                                       char *buf, int len);
 311         int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
 312 };
 313
 314 struct em28xx_fh {
 315         struct em28xx *dev;
 316         unsigned int  stream_on:1;      /* Locks streams */
 317         int           radio;
 318 };
 319
 320 struct em28xx_ops {
 321         struct list_head next;
 322         char *name;
 323         int id;
 324         int (*init)(struct em28xx *);
 325         int (*fini)(struct em28xx *);
 326 };
 327
 328 /* Provided by em28xx-i2c.c */
 329
 330 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
 331 void em28xx_do_i2c_scan(struct em28xx *dev);
 332 int em28xx_i2c_register(struct em28xx *dev);
 333 int em28xx_i2c_unregister(struct em28xx *dev);
 334
 335 /* Provided by em28xx-core.c */
 336
 337 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
 338 void em28xx_queue_unusedframes(struct em28xx *dev);
 339 void em28xx_release_buffers(struct em28xx *dev);
 340
 341 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
 342                             char *buf, int len);
 343 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
 344 int em28xx_read_reg(struct em28xx *dev, u16 reg);
 345 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
 346                           int len);
 347 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
 348 int em28xx_audio_analog_set(struct em28xx *dev);
 349
 350 int em28xx_colorlevels_set_default(struct em28xx *dev);
 351 int em28xx_capture_start(struct em28xx *dev, int start);
 352 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
 353 int em28xx_resolution_set(struct em28xx *dev);
 354 int em28xx_init_isoc(struct em28xx *dev);
 355 void em28xx_uninit_isoc(struct em28xx *dev);
 356 int em28xx_set_alternate(struct em28xx *dev);
 357
 358 /* Provided by em28xx-video.c */
 359 int em28xx_register_extension(struct em28xx_ops *dev);
 360 void em28xx_unregister_extension(struct em28xx_ops *dev);
 361
 362 /* Provided by em28xx-cards.c */
 363 extern int em2800_variant_detect(struct usb_device* udev,int model);
 364 extern void em28xx_pre_card_setup(struct em28xx *dev);
 365 extern void em28xx_card_setup(struct em28xx *dev);
 366 extern struct em28xx_board em28xx_boards[];
 367 extern struct usb_device_id em28xx_id_table[];
 368 extern const unsigned int em28xx_bcount;
 369 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
 370
 371 /* Provided by em28xx-input.c */
 372 /* TODO: Check if the standard get_key handlers on ir-common can be used */
 373 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 374 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
 375 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
 376                                      u32 *ir_raw);
 377
 378 /* em2800 registers */
 379 #define EM2800_AUDIOSRC_REG 0x08
 380
 381 /* em28xx registers */
 382 #define I2C_CLK_REG     0x06
 383 #define CHIPID_REG      0x0a
 384 #define USBSUSP_REG     0x0c    /* */
 385
 386 #define AUDIOSRC_REG    0x0e
 387 #define XCLK_REG        0x0f
 388
 389 #define VINMODE_REG     0x10
 390 #define VINCTRL_REG     0x11
 391 #define VINENABLE_REG   0x12    /* */
 392
 393 #define GAMMA_REG       0x14
 394 #define RGAIN_REG       0x15
 395 #define GGAIN_REG       0x16
 396 #define BGAIN_REG       0x17
 397 #define ROFFSET_REG     0x18
 398 #define GOFFSET_REG     0x19
 399 #define BOFFSET_REG     0x1a
 400
 401 #define OFLOW_REG       0x1b
 402 #define HSTART_REG      0x1c
 403 #define VSTART_REG      0x1d
 404 #define CWIDTH_REG      0x1e
 405 #define CHEIGHT_REG     0x1f
 406
 407 #define YGAIN_REG       0x20
 408 #define YOFFSET_REG     0x21
 409 #define UVGAIN_REG      0x22
 410 #define UOFFSET_REG     0x23
 411 #define VOFFSET_REG     0x24
 412 #define SHARPNESS_REG   0x25
 413
 414 #define COMPR_REG       0x26
 415 #define OUTFMT_REG      0x27
 416
 417 #define XMIN_REG        0x28
 418 #define XMAX_REG        0x29
 419 #define YMIN_REG        0x2a
 420 #define YMAX_REG        0x2b
 421
 422 #define HSCALELOW_REG   0x30
 423 #define HSCALEHIGH_REG  0x31
 424 #define VSCALELOW_REG   0x32
 425 #define VSCALEHIGH_REG  0x33
 426
 427 #define AC97LSB_REG     0x40
 428 #define AC97MSB_REG     0x41
 429 #define AC97ADDR_REG    0x42
 430 #define AC97BUSY_REG    0x43
 431
 432 /* em202 registers */
 433 #define MASTER_AC97     0x02
 434 #define LINE_IN_AC97    0x10
 435 #define VIDEO_AC97      0x14
 436
 437 /* register settings */
 438 #define EM2800_AUDIO_SRC_TUNER  0x0d
 439 #define EM2800_AUDIO_SRC_LINE   0x0c
 440 #define EM28XX_AUDIO_SRC_TUNER  0xc0
 441 #define EM28XX_AUDIO_SRC_LINE   0x80
 442
 443 /* printk macros */
 444
 445 #define em28xx_err(fmt, arg...) do {\
 446         printk(KERN_ERR fmt , ##arg); } while (0)
 447
 448 #define em28xx_errdev(fmt, arg...) do {\
 449         printk(KERN_ERR "%s: "fmt,\
 450                         dev->name , ##arg); } while (0)
 451
 452 #define em28xx_info(fmt, arg...) do {\
 453         printk(KERN_INFO "%s: "fmt,\
 454                         dev->name , ##arg); } while (0)
 455 #define em28xx_warn(fmt, arg...) do {\
 456         printk(KERN_WARNING "%s: "fmt,\
 457                         dev->name , ##arg); } while (0)
 458
 459 inline static int em28xx_compression_disable(struct em28xx *dev)
 460 {
 461         /* side effect of disabling scaler and mixer */
 462         return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
 463 }
 464
 465 inline static int em28xx_contrast_get(struct em28xx *dev)
 466 {
 467         return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
 468 }
 469
 470 inline static int em28xx_brightness_get(struct em28xx *dev)
 471 {
 472         return em28xx_read_reg(dev, YOFFSET_REG);
 473 }
 474
 475 inline static int em28xx_saturation_get(struct em28xx *dev)
 476 {
 477         return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
 478 }
 479
 480 inline static int em28xx_u_balance_get(struct em28xx *dev)
 481 {
 482         return em28xx_read_reg(dev, UOFFSET_REG);
 483 }
 484
 485 inline static int em28xx_v_balance_get(struct em28xx *dev)
 486 {
 487         return em28xx_read_reg(dev, VOFFSET_REG);
 488 }
 489
 490 inline static int em28xx_gamma_get(struct em28xx *dev)
 491 {
 492         return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
 493 }
 494
 495 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
 496 {
 497         u8 tmp = (u8) val;
 498         return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
 499 }
 500
 501 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
 502 {
 503         u8 tmp = (u8) val;
 504         return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
 505 }
 506
 507 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
 508 {
 509         u8 tmp = (u8) val;
 510         return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
 511 }
 512
 513 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
 514 {
 515         u8 tmp = (u8) val;
 516         return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
 517 }
 518
 519 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
 520 {
 521         u8 tmp = (u8) val;
 522         return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
 523 }
 524
 525 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
 526 {
 527         u8 tmp = (u8) val;
 528         return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
 529 }
 530
 531 /*FIXME: maxw should be dependent of alt mode */
 532 inline static unsigned int norm_maxw(struct em28xx *dev)
 533 {
 534         if (dev->max_range_640_480)
 535                 return 640;
 536         else
 537                 return 720;
 538 }
 539
 540 inline static unsigned int norm_maxh(struct em28xx *dev)
 541 {
 542         if (dev->max_range_640_480)
 543                 return 480;
 544         else
 545                 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
 546 }
 547 #endif