drivers/media/video/em28xx/em28xx.h

   1 /*
   2    em2820-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 _EM2820_H
  26 #define _EM2820_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
  44 #define UNSET -1
  45
  46 /* maximum number of em28xx boards */
  47 #define EM2820_MAXBOARDS 1 /*FIXME: should be bigger */
  48
  49 /* maximum number of frames that can be queued */
  50 #define EM2820_NUM_FRAMES 5
  51 /* number of frames that get used for v4l2_read() */
  52 #define EM2820_NUM_READ_FRAMES 2
  53
  54 /* number of buffers for isoc transfers */
  55 #define EM2820_NUM_BUFS 5
  56
  57 /* number of packets for each buffer
  58    windows requests only 40 packets .. so we better do the same
  59    this is what I found out for all alternate numbers there!
  60  */
  61 #define EM2820_NUM_PACKETS 40
  62
  63 /* default alternate; 0 means choose the best */
  64 #define EM2820_PINOUT 0
  65 #define EM2820_MAX_ALT 7
  66
  67 #define EM2820_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 EM2820_URB_TIMEOUT       msecs_to_jiffies(EM2820_NUM_BUFS * EM2820_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 em2820_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 em2820_stream_state {
 107         STREAM_OFF,
 108         STREAM_INTERRUPT,
 109         STREAM_ON,
 110 };
 111
 112 /* frames */
 113 struct em2820_frame_t {
 114         void *bufmem;
 115         struct v4l2_buffer buf;
 116         enum em2820_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 em2820_io_method {
 125         IO_NONE,
 126         IO_READ,
 127         IO_MMAP,
 128 };
 129
 130 /* inputs */
 131
 132 #define MAX_EM2820_INPUT 4
 133 enum enum2820_itype {
 134         EM2820_VMUX_COMPOSITE1 = 1,
 135         EM2820_VMUX_COMPOSITE2,
 136         EM2820_VMUX_COMPOSITE3,
 137         EM2820_VMUX_COMPOSITE4,
 138         EM2820_VMUX_SVIDEO,
 139         EM2820_VMUX_TELEVISION,
 140         EM2820_VMUX_CABLE,
 141         EM2820_VMUX_DVB,
 142         EM2820_VMUX_DEBUG,
 143         EM2820_RADIO,
 144 };
 145
 146 struct em2820_input {
 147         enum enum2820_itype type;
 148         unsigned int vmux;
 149         unsigned int amux;
 150 };
 151
 152 #define INPUT(nr) (&em2820_boards[dev->model].input[nr])
 153
 154 enum em2820_decoder {
 155         EM2820_TVP5150,
 156         EM2820_SAA7113,
 157         EM2820_SAA7114
 158 };
 159
 160 struct em2820_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 em2820_decoder decoder;
 174
 175         struct em2820_input       input[MAX_EM2820_INPUT];
 176 };
 177
 178 struct em2820_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 em2820_dev_state {
 194         DEV_INITIALIZED = 0x01,
 195         DEV_DISCONNECTED = 0x02,
 196         DEV_MISCONFIGURED = 0x04,
 197 };
 198
 199 /* tvnorms */
 200 struct em2820_tvnorm {
 201         char *name;
 202         v4l2_std_id id;
 203         /* mode for saa7113h */
 204         int mode;
 205 };
 206
 207 /* main device struct */
 208 struct em2820 {
 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         unsigned int has_tuner:1;
 215         unsigned int has_msp34xx:1;
 216         unsigned int has_tda9887:1;
 217
 218         enum em2820_decoder decoder;
 219
 220         int tuner_type;         /* type of the tuner */
 221         int tuner_addr;         /* tuner address */
 222         int tda9887_conf;
 223         /* i2c i/o */
 224         struct i2c_adapter i2c_adap;
 225         struct i2c_client i2c_client;
 226         /* video for linux */
 227         int users;              /* user count for exclusive use */
 228         struct video_device *vdev;      /* video for linux device struct */
 229         struct video_picture vpic;      /* picture settings only used to init saa7113h */
 230         struct em2820_tvnorm *tvnorm;   /* selected tv norm */
 231         int ctl_freq;           /* selected frequency */
 232         unsigned int ctl_input; /* selected input */
 233         unsigned int ctl_ainput;        /* slected audio input */
 234         int mute;
 235         int volume;
 236         /* frame properties */
 237         struct em2820_frame_t frame[EM2820_NUM_FRAMES]; /* list of frames */
 238         int num_frames;         /* number of frames currently in use */
 239         unsigned int frame_count;       /* total number of transfered frames */
 240         struct em2820_frame_t *frame_current;   /* the frame that is being filled */
 241         int width;              /* current frame width */
 242         int height;             /* current frame height */
 243         int frame_size;         /* current frame size */
 244         int field_size;         /* current field size */
 245         int bytesperline;
 246         int hscale;             /* horizontal scale factor (see datasheet) */
 247         int vscale;             /* vertical scale factor (see datasheet) */
 248         int interlaced;         /* 1=interlace fileds, 0=just top fileds */
 249         int type;
 250
 251         /* states */
 252         enum em2820_dev_state state;
 253         enum em2820_stream_state stream;
 254         enum em2820_io_method io;
 255         /* locks */
 256         struct semaphore lock, fileop_lock;
 257         spinlock_t queue_lock;
 258         struct list_head inqueue, outqueue;
 259         wait_queue_head_t open, wait_frame, wait_stream;
 260         struct video_device *vbi_dev;
 261
 262         unsigned char eedata[256];
 263
 264         /* usb transfer */
 265         struct usb_device *udev;        /* the usb device */
 266         int alt;                /* alternate */
 267         int max_pkt_size;       /* max packet size of isoc transaction */
 268         unsigned int alt_max_pkt_size[EM2820_MAX_ALT + 1];      /* array of wMaxPacketSize */
 269         struct urb *urb[EM2820_NUM_BUFS];       /* urb for isoc transfers */
 270         char *transfer_buffer[EM2820_NUM_BUFS]; /* transfer buffers for isoc transfer */
 271         /* helper funcs that call usb_control_msg */
 272         int (*em2820_write_regs) (struct em2820 * dev, u16 reg, char *buf,
 273                                   int len);
 274         int (*em2820_read_reg) (struct em2820 * dev, u16 reg);
 275         int (*em2820_read_reg_req_len) (struct em2820 * dev, u8 req, u16 reg,
 276                                         char *buf, int len);
 277         int (*em2820_write_regs_req) (struct em2820 * dev, u8 req, u16 reg,
 278                                       char *buf, int len);
 279         int (*em2820_read_reg_req) (struct em2820 * dev, u8 req, u16 reg);
 280 };
 281
 282 /* Provided by em2820-i2c.c */
 283
 284 void em2820_i2c_call_clients(struct em2820 *dev, unsigned int cmd, void *arg);
 285 int em2820_i2c_register(struct em2820 *dev);
 286 int em2820_i2c_unregister(struct em2820 *dev);
 287
 288 /* Provided by em2820-input.c */
 289
 290 void em2820_set_ir(struct em2820 * dev,struct IR_i2c *ir);
 291
 292 /* Provided by em2820-core.c */
 293
 294 void em2820_print_ioctl(char *name, unsigned int cmd);
 295
 296 u32 em2820_request_buffers(struct em2820 *dev, u32 count);
 297 void em2820_queue_unusedframes(struct em2820 *dev);
 298 void em2820_release_buffers(struct em2820 *dev);
 299
 300 int em2820_read_reg_req_len(struct em2820 *dev, u8 req, u16 reg,
 301                             char *buf, int len);
 302 int em2820_read_reg_req(struct em2820 *dev, u8 req, u16 reg);
 303 int em2820_read_reg(struct em2820 *dev, u16 reg);
 304 int em2820_write_regs_req(struct em2820 *dev, u8 req, u16 reg, char *buf,
 305                           int len);
 306 int em2820_write_regs(struct em2820 *dev, u16 reg, char *buf, int len);
 307 int em2820_write_reg_bits(struct em2820 *dev, u16 reg, u8 val,
 308                           u8 bitmask);
 309 int em2820_write_ac97(struct em2820 *dev, u8 reg, u8 * val);
 310 int em2820_audio_analog_set(struct em2820 *dev);
 311 int em2820_colorlevels_set_default(struct em2820 *dev);
 312 int em2820_capture_start(struct em2820 *dev, int start);
 313 int em2820_outfmt_set_yuv422(struct em2820 *dev);
 314 int em2820_accumulator_set(struct em2820 *dev, u8 xmin, u8 xmax, u8 ymin,
 315                            u8 ymax);
 316 int em2820_capture_area_set(struct em2820 *dev, u8 hstart, u8 vstart,
 317                             u16 width, u16 height);
 318 int em2820_scaler_set(struct em2820 *dev, u16 h, u16 v);
 319 int em2820_resolution_set(struct em2820 *dev);
 320 void em2820_isocIrq(struct urb *urb, struct pt_regs *regs);
 321 int em2820_init_isoc(struct em2820 *dev);
 322 void em2820_uninit_isoc(struct em2820 *dev);
 323 int em2820_set_alternate(struct em2820 *dev);
 324
 325 /* Provided by em2820-cards.c */
 326 extern int em2800_variant_detect(struct usb_device* udev,int model);
 327 extern void em2820_card_setup(struct em2820 *dev);
 328 extern struct em2820_board em2820_boards[];
 329 extern struct usb_device_id em2820_id_table[];
 330 extern const unsigned int em2820_bcount;
 331
 332 /* em2820 registers */
 333 #define CHIPID_REG      0x0a
 334 #define USBSUSP_REG     0x0c    /* */
 335
 336 #define AUDIOSRC_REG    0x0e
 337 #define XCLK_REG        0x0f
 338
 339 #define VINMODE_REG     0x10
 340 #define VINCTRL_REG     0x11
 341 #define VINENABLE_REG   0x12    /* */
 342
 343 #define GAMMA_REG       0x14
 344 #define RGAIN_REG       0x15
 345 #define GGAIN_REG       0x16
 346 #define BGAIN_REG       0x17
 347 #define ROFFSET_REG     0x18
 348 #define GOFFSET_REG     0x19
 349 #define BOFFSET_REG     0x1a
 350
 351 #define OFLOW_REG       0x1b
 352 #define HSTART_REG      0x1c
 353 #define VSTART_REG      0x1d
 354 #define CWIDTH_REG      0x1e
 355 #define CHEIGHT_REG     0x1f
 356
 357 #define YGAIN_REG       0x20
 358 #define YOFFSET_REG     0x21
 359 #define UVGAIN_REG      0x22
 360 #define UOFFSET_REG     0x23
 361 #define VOFFSET_REG     0x24
 362 #define SHARPNESS_REG   0x25
 363
 364 #define COMPR_REG       0x26
 365 #define OUTFMT_REG      0x27
 366
 367 #define XMIN_REG        0x28
 368 #define XMAX_REG        0x29
 369 #define YMIN_REG        0x2a
 370 #define YMAX_REG        0x2b
 371
 372 #define HSCALELOW_REG   0x30
 373 #define HSCALEHIGH_REG  0x31
 374 #define VSCALELOW_REG   0x32
 375 #define VSCALEHIGH_REG  0x33
 376
 377 #define AC97LSB_REG     0x40
 378 #define AC97MSB_REG     0x41
 379 #define AC97ADDR_REG    0x42
 380 #define AC97BUSY_REG    0x43
 381
 382 /* em202 registers */
 383 #define MASTER_AC97     0x02
 384 #define VIDEO_AC97      0x14
 385
 386 /* register settings */
 387 #define EM2820_AUDIO_SRC_TUNER  0xc0
 388 #define EM2820_AUDIO_SRC_LINE   0x80
 389
 390 /* printk macros */
 391
 392 #define em2820_err(fmt, arg...) do {\
 393         printk(KERN_ERR fmt , ##arg); } while (0)
 394
 395 #define em2820_errdev(fmt, arg...) do {\
 396         printk(KERN_ERR "%s: "fmt,\
 397                         dev->name , ##arg); } while (0)
 398
 399 #define em2820_info(fmt, arg...) do {\
 400         printk(KERN_INFO "%s: "fmt,\
 401                         dev->name , ##arg); } while (0)
 402 #define em2820_warn(fmt, arg...) do {\
 403         printk(KERN_WARNING "%s: "fmt,\
 404                         dev->name , ##arg); } while (0)
 405
 406 inline static int em2820_audio_source(struct em2820 *dev, int input)
 407 {
 408         return em2820_write_reg_bits(dev, AUDIOSRC_REG, input, 0xc0);
 409 }
 410
 411 inline static int em2820_audio_usb_mute(struct em2820 *dev, int mute)
 412 {
 413         return em2820_write_reg_bits(dev, XCLK_REG, mute ? 0x00 : 0x80, 0x80);
 414 }
 415
 416 inline static int em2820_audio_analog_setup(struct em2820 *dev)
 417 {
 418         /* unmute video mixer with default volume level */
 419         return em2820_write_ac97(dev, VIDEO_AC97, "\x08\x08");
 420 }
 421
 422 inline static int em2820_compression_disable(struct em2820 *dev)
 423 {
 424         /* side effect of disabling scaler and mixer */
 425         return em2820_write_regs(dev, COMPR_REG, "\x00", 1);
 426 }
 427
 428 inline static int em2820_contrast_get(struct em2820 *dev)
 429 {
 430         return em2820_read_reg(dev, YGAIN_REG) & 0x1f;
 431 }
 432
 433 inline static int em2820_brightness_get(struct em2820 *dev)
 434 {
 435         return em2820_read_reg(dev, YOFFSET_REG);
 436 }
 437
 438 inline static int em2820_saturation_get(struct em2820 *dev)
 439 {
 440         return em2820_read_reg(dev, UVGAIN_REG) & 0x1f;
 441 }
 442
 443 inline static int em2820_u_balance_get(struct em2820 *dev)
 444 {
 445         return em2820_read_reg(dev, UOFFSET_REG);
 446 }
 447
 448 inline static int em2820_v_balance_get(struct em2820 *dev)
 449 {
 450         return em2820_read_reg(dev, VOFFSET_REG);
 451 }
 452
 453 inline static int em2820_gamma_get(struct em2820 *dev)
 454 {
 455         return em2820_read_reg(dev, GAMMA_REG) & 0x3f;
 456 }
 457
 458 inline static int em2820_contrast_set(struct em2820 *dev, s32 val)
 459 {
 460         u8 tmp = (u8) val;
 461         return em2820_write_regs(dev, YGAIN_REG, &tmp, 1);
 462 }
 463
 464 inline static int em2820_brightness_set(struct em2820 *dev, s32 val)
 465 {
 466         u8 tmp = (u8) val;
 467         return em2820_write_regs(dev, YOFFSET_REG, &tmp, 1);
 468 }
 469
 470 inline static int em2820_saturation_set(struct em2820 *dev, s32 val)
 471 {
 472         u8 tmp = (u8) val;
 473         return em2820_write_regs(dev, UVGAIN_REG, &tmp, 1);
 474 }
 475
 476 inline static int em2820_u_balance_set(struct em2820 *dev, s32 val)
 477 {
 478         u8 tmp = (u8) val;
 479         return em2820_write_regs(dev, UOFFSET_REG, &tmp, 1);
 480 }
 481
 482 inline static int em2820_v_balance_set(struct em2820 *dev, s32 val)
 483 {
 484         u8 tmp = (u8) val;
 485         return em2820_write_regs(dev, VOFFSET_REG, &tmp, 1);
 486 }
 487
 488 inline static int em2820_gamma_set(struct em2820 *dev, s32 val)
 489 {
 490         u8 tmp = (u8) val;
 491         return em2820_write_regs(dev, GAMMA_REG, &tmp, 1);
 492 }
 493
 494 /*FIXME: maxw should be dependent of alt mode */
 495 #define norm_maxw(dev) 720
 496 inline static unsigned int norm_maxh(struct em2820 *dev)
 497 {
 498         return (dev->tvnorm->id & V4L2_STD_625_50) ? 576 : 480;
 499 }
 500
 501 #endif