drivers/media/video/zoran/zoran.h

   1 /*
   2  * zoran - Iomega Buz driver
   3  *
   4  * Copyright (C) 1999 Rainer Johanni <Rainer@Johanni.de>
   5  *
   6  * based on
   7  *
   8  * zoran.0.0.3 Copyright (C) 1998 Dave Perks <dperks@ibm.net>
   9  *
  10  * and
  11  *
  12  * bttv - Bt848 frame grabber driver
  13  * Copyright (C) 1996,97,98 Ralph  Metzler (rjkm@thp.uni-koeln.de)
  14  *                        & Marcus Metzler (mocm@thp.uni-koeln.de)
  15  *
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 2 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  29  */
  30
  31 #ifndef _BUZ_H_
  32 #define _BUZ_H_
  33
  34 struct zoran_requestbuffers {
  35         unsigned long count;    /* Number of buffers for MJPEG grabbing */
  36         unsigned long size;     /* Size PER BUFFER in bytes */
  37 };
  38
  39 struct zoran_sync {
  40         unsigned long frame;    /* number of buffer that has been free'd */
  41         unsigned long length;   /* number of code bytes in buffer (capture only) */
  42         unsigned long seq;      /* frame sequence number */
  43         struct timeval timestamp;       /* timestamp */
  44 };
  45
  46 struct zoran_status {
  47         int input;              /* Input channel, has to be set prior to BUZIOC_G_STATUS */
  48         int signal;             /* Returned: 1 if valid video signal detected */
  49         int norm;               /* Returned: VIDEO_MODE_PAL or VIDEO_MODE_NTSC */
  50         int color;              /* Returned: 1 if color signal detected */
  51 };
  52
  53 struct zoran_params {
  54
  55         /* The following parameters can only be queried */
  56
  57         int major_version;      /* Major version number of driver */
  58         int minor_version;      /* Minor version number of driver */
  59
  60         /* Main control parameters */
  61
  62         int input;              /* Input channel: 0 = Composite, 1 = S-VHS */
  63         int norm;               /* Norm: VIDEO_MODE_PAL or VIDEO_MODE_NTSC */
  64         int decimation;         /* decimation of captured video,
  65                                  * enlargement of video played back.
  66                                  * Valid values are 1, 2, 4 or 0.
  67                                  * 0 is a special value where the user
  68                                  * has full control over video scaling */
  69
  70         /* The following parameters only have to be set if decimation==0,
  71          * for other values of decimation they provide the data how the image is captured */
  72
  73         int HorDcm;             /* Horizontal decimation: 1, 2 or 4 */
  74         int VerDcm;             /* Vertical decimation: 1 or 2 */
  75         int TmpDcm;             /* Temporal decimation: 1 or 2,
  76                                  * if TmpDcm==2 in capture every second frame is dropped,
  77                                  * in playback every frame is played twice */
  78         int field_per_buff;     /* Number of fields per buffer: 1 or 2 */
  79         int img_x;              /* start of image in x direction */
  80         int img_y;              /* start of image in y direction */
  81         int img_width;          /* image width BEFORE decimation,
  82                                  * must be a multiple of HorDcm*16 */
  83         int img_height;         /* image height BEFORE decimation,
  84                                  * must be a multiple of VerDcm*8 */
  85
  86         /* --- End of parameters for decimation==0 only --- */
  87
  88         /* JPEG control parameters */
  89
  90         int quality;            /* Measure for quality of compressed images.
  91                                  * Scales linearly with the size of the compressed images.
  92                                  * Must be beetween 0 and 100, 100 is a compression
  93                                  * ratio of 1:4 */
  94
  95         int odd_even;           /* Which field should come first ??? */
  96
  97         int APPn;               /* Number of APP segment to be written, must be 0..15 */
  98         int APP_len;            /* Length of data in JPEG APPn segment */
  99         char APP_data[60];      /* Data in the JPEG APPn segment. */
 100
 101         int COM_len;            /* Length of data in JPEG COM segment */
 102         char COM_data[60];      /* Data in JPEG COM segment */
 103
 104         unsigned long jpeg_markers;     /* Which markers should go into the JPEG output.
 105                                          * Unless you exactly know what you do, leave them untouched.
 106                                          * Inluding less markers will make the resulting code
 107                                          * smaller, but there will be fewer aplications
 108                                          * which can read it.
 109                                          * The presence of the APP and COM marker is
 110                                          * influenced by APP0_len and COM_len ONLY! */
 111 #define JPEG_MARKER_DHT (1<<3)  /* Define Huffman Tables */
 112 #define JPEG_MARKER_DQT (1<<4)  /* Define Quantization Tables */
 113 #define JPEG_MARKER_DRI (1<<5)  /* Define Restart Interval */
 114 #define JPEG_MARKER_COM (1<<6)  /* Comment segment */
 115 #define JPEG_MARKER_APP (1<<7)  /* App segment, driver will allways use APP0 */
 116
 117         int VFIFO_FB;           /* Flag for enabling Video Fifo Feedback.
 118                                  * If this flag is turned on and JPEG decompressing
 119                                  * is going to the screen, the decompress process
 120                                  * is stopped every time the Video Fifo is full.
 121                                  * This enables a smooth decompress to the screen
 122                                  * but the video output signal will get scrambled */
 123
 124         /* Misc */
 125
 126         char reserved[312];     /* Makes 512 bytes for this structure */
 127 };
 128
 129 /*
 130 Private IOCTL to set up for displaying MJPEG
 131 */
 132 #define BUZIOC_G_PARAMS       _IOR ('v', BASE_VIDIOCPRIVATE+0,  struct zoran_params)
 133 #define BUZIOC_S_PARAMS       _IOWR('v', BASE_VIDIOCPRIVATE+1,  struct zoran_params)
 134 #define BUZIOC_REQBUFS        _IOWR('v', BASE_VIDIOCPRIVATE+2,  struct zoran_requestbuffers)
 135 #define BUZIOC_QBUF_CAPT      _IOW ('v', BASE_VIDIOCPRIVATE+3,  int)
 136 #define BUZIOC_QBUF_PLAY      _IOW ('v', BASE_VIDIOCPRIVATE+4,  int)
 137 #define BUZIOC_SYNC           _IOR ('v', BASE_VIDIOCPRIVATE+5,  struct zoran_sync)
 138 #define BUZIOC_G_STATUS       _IOWR('v', BASE_VIDIOCPRIVATE+6,  struct zoran_status)
 139
 140
 141 #ifdef __KERNEL__
 142
 143 #define MAJOR_VERSION 0         /* driver major version */
 144 #define MINOR_VERSION 9         /* driver minor version */
 145 #define RELEASE_VERSION 5       /* release version */
 146
 147 #define ZORAN_NAME    "ZORAN"   /* name of the device */
 148
 149 #define ZR_DEVNAME(zr) ((zr)->name)
 150
 151 #define   BUZ_MAX_WIDTH   (zr->timing->Wa)
 152 #define   BUZ_MAX_HEIGHT  (zr->timing->Ha)
 153 #define   BUZ_MIN_WIDTH    32   /* never display less than 32 pixels */
 154 #define   BUZ_MIN_HEIGHT   24   /* never display less than 24 rows */
 155
 156 #define BUZ_NUM_STAT_COM    4
 157 #define BUZ_MASK_STAT_COM   3
 158
 159 #define BUZ_MAX_FRAME     256   /* Must be a power of 2 */
 160 #define BUZ_MASK_FRAME    255   /* Must be BUZ_MAX_FRAME-1 */
 161
 162 #define BUZ_MAX_INPUT       16
 163
 164 #if VIDEO_MAX_FRAME <= 32
 165 #   define   V4L_MAX_FRAME   32
 166 #elif VIDEO_MAX_FRAME <= 64
 167 #   define   V4L_MAX_FRAME   64
 168 #else
 169 #   error   "Too many video frame buffers to handle"
 170 #endif
 171 #define   V4L_MASK_FRAME   (V4L_MAX_FRAME - 1)
 172
 173 #include "zr36057.h"
 174
 175 enum card_type {
 176         UNKNOWN = -1,
 177
 178         /* Pinnacle/Miro */
 179         DC10_old,               /* DC30 like */
 180         DC10_new,               /* DC10plus like */
 181         DC10plus,
 182         DC30,
 183         DC30plus,
 184
 185         /* Linux Media Labs */
 186         LML33,
 187         LML33R10,
 188
 189         /* Iomega */
 190         BUZ,
 191
 192         /* AverMedia */
 193         AVS6EYES,
 194
 195         /* total number of cards */
 196         NUM_CARDS
 197 };
 198
 199 enum zoran_codec_mode {
 200         BUZ_MODE_IDLE,          /* nothing going on */
 201         BUZ_MODE_MOTION_COMPRESS,       /* grabbing frames */
 202         BUZ_MODE_MOTION_DECOMPRESS,     /* playing frames */
 203         BUZ_MODE_STILL_COMPRESS,        /* still frame conversion */
 204         BUZ_MODE_STILL_DECOMPRESS       /* still frame conversion */
 205 };
 206
 207 enum zoran_buffer_state {
 208         BUZ_STATE_USER,         /* buffer is owned by application */
 209         BUZ_STATE_PEND,         /* buffer is queued in pend[] ready to feed to I/O */
 210         BUZ_STATE_DMA,          /* buffer is queued in dma[] for I/O */
 211         BUZ_STATE_DONE          /* buffer is ready to return to application */
 212 };
 213
 214 enum zoran_map_mode {
 215         ZORAN_MAP_MODE_RAW,
 216         ZORAN_MAP_MODE_JPG_REC,
 217 #define ZORAN_MAP_MODE_JPG ZORAN_MAP_MODE_JPG_REC
 218         ZORAN_MAP_MODE_JPG_PLAY,
 219 };
 220
 221 enum gpio_type {
 222         ZR_GPIO_JPEG_SLEEP = 0,
 223         ZR_GPIO_JPEG_RESET,
 224         ZR_GPIO_JPEG_FRAME,
 225         ZR_GPIO_VID_DIR,
 226         ZR_GPIO_VID_EN,
 227         ZR_GPIO_VID_RESET,
 228         ZR_GPIO_CLK_SEL1,
 229         ZR_GPIO_CLK_SEL2,
 230         ZR_GPIO_MAX,
 231 };
 232
 233 enum gpcs_type {
 234         GPCS_JPEG_RESET = 0,
 235         GPCS_JPEG_START,
 236         GPCS_MAX,
 237 };
 238
 239 struct zoran_format {
 240         char *name;
 241         __u32 fourcc;
 242         int colorspace;
 243         int depth;
 244         __u32 flags;
 245         __u32 vfespfr;
 246 };
 247 /* flags */
 248 #define ZORAN_FORMAT_COMPRESSED 1<<0
 249 #define ZORAN_FORMAT_OVERLAY    1<<1
 250 #define ZORAN_FORMAT_CAPTURE    1<<2
 251 #define ZORAN_FORMAT_PLAYBACK   1<<3
 252
 253 /* overlay-settings */
 254 struct zoran_overlay_settings {
 255         int is_set;
 256         int x, y, width, height;        /* position */
 257         int clipcount;          /* position and number of clips */
 258         const struct zoran_format *format;      /* overlay format */
 259 };
 260
 261 /* v4l-capture settings */
 262 struct zoran_v4l_settings {
 263         int width, height, bytesperline;        /* capture size */
 264         const struct zoran_format *format;      /* capture format */
 265 };
 266
 267 /* jpg-capture/-playback settings */
 268 struct zoran_jpg_settings {
 269         int decimation;         /* this bit is used to set everything to default */
 270         int HorDcm, VerDcm, TmpDcm;     /* capture decimation settings (TmpDcm=1 means both fields) */
 271         int field_per_buff, odd_even;   /* field-settings (odd_even=1 (+TmpDcm=1) means top-field-first) */
 272         int img_x, img_y, img_width, img_height;        /* crop settings (subframe capture) */
 273         struct v4l2_jpegcompression jpg_comp;   /* JPEG-specific capture settings */
 274 };
 275
 276 struct zoran_mapping {
 277         struct file *file;
 278         int count;
 279 };
 280
 281 struct zoran_jpg_buffer {
 282         struct zoran_mapping *map;
 283         __le32 *frag_tab;               /* addresses of frag table */
 284         u32 frag_tab_bus;       /* same value cached to save time in ISR */
 285         enum zoran_buffer_state state;  /* non-zero if corresponding buffer is in use in grab queue */
 286         struct zoran_sync bs;   /* DONE: info to return to application */
 287 };
 288
 289 struct zoran_v4l_buffer {
 290         struct zoran_mapping *map;
 291         char *fbuffer;          /* virtual  address of frame buffer */
 292         unsigned long fbuffer_phys;     /* physical address of frame buffer */
 293         unsigned long fbuffer_bus;      /* bus      address of frame buffer */
 294         enum zoran_buffer_state state;  /* state: unused/pending/done */
 295         struct zoran_sync bs;   /* DONE: info to return to application */
 296 };
 297
 298 enum zoran_lock_activity {
 299         ZORAN_FREE,             /* free for use */
 300         ZORAN_ACTIVE,           /* active but unlocked */
 301         ZORAN_LOCKED,           /* locked */
 302 };
 303
 304 /* buffer collections */
 305 struct zoran_jpg_struct {
 306         enum zoran_lock_activity active;        /* feature currently in use? */
 307         struct zoran_jpg_buffer buffer[BUZ_MAX_FRAME];  /* buffers */
 308         int num_buffers, buffer_size;
 309         u8 allocated;           /* Flag if buffers are allocated  */
 310         u8 need_contiguous;     /* Flag if contiguous buffers are needed */
 311 };
 312
 313 struct zoran_v4l_struct {
 314         enum zoran_lock_activity active;        /* feature currently in use? */
 315         struct zoran_v4l_buffer buffer[VIDEO_MAX_FRAME];        /* buffers */
 316         int num_buffers, buffer_size;
 317         u8 allocated;           /* Flag if buffers are allocated  */
 318 };
 319
 320 struct zoran;
 321
 322 /* zoran_fh contains per-open() settings */
 323 struct zoran_fh {
 324         struct zoran *zr;
 325
 326         enum zoran_map_mode map_mode;   /* Flag which bufferset will map by next mmap() */
 327
 328         struct zoran_overlay_settings overlay_settings;
 329         u32 *overlay_mask;      /* overlay mask */
 330         enum zoran_lock_activity overlay_active;        /* feature currently in use? */
 331
 332         struct zoran_v4l_settings v4l_settings; /* structure with a lot of things to play with */
 333         struct zoran_v4l_struct v4l_buffers;    /* V4L buffers' info */
 334
 335         struct zoran_jpg_settings jpg_settings; /* structure with a lot of things to play with */
 336         struct zoran_jpg_struct jpg_buffers;    /* MJPEG buffers' info */
 337 };
 338
 339 struct card_info {
 340         enum card_type type;
 341         char name[32];
 342         u16 i2c_decoder, i2c_encoder;                   /* I2C types */
 343         u16 video_vfe, video_codec;                     /* videocodec types */
 344         u16 audio_chip;                                 /* audio type */
 345
 346         int inputs;             /* number of video inputs */
 347         struct input {
 348                 int muxsel;
 349                 char name[32];
 350         } input[BUZ_MAX_INPUT];
 351
 352         v4l2_std_id norms;
 353         struct tvnorm *tvn[3];  /* supported TV norms */
 354
 355         u32 jpeg_int;           /* JPEG interrupt */
 356         u32 vsync_int;          /* VSYNC interrupt */
 357         s8 gpio[ZR_GPIO_MAX];
 358         u8 gpcs[GPCS_MAX];
 359
 360         struct vfe_polarity vfe_pol;
 361         u8 gpio_pol[ZR_GPIO_MAX];
 362
 363         /* is the /GWS line conected? */
 364         u8 gws_not_connected;
 365
 366         /* avs6eyes mux setting */
 367         u8 input_mux;
 368
 369         void (*init) (struct zoran * zr);
 370 };
 371
 372 struct zoran {
 373         struct video_device *video_dev;
 374
 375         struct i2c_adapter i2c_adapter; /* */
 376         struct i2c_algo_bit_data i2c_algo;      /* */
 377         u32 i2cbr;
 378
 379         struct i2c_client *decoder;     /* video decoder i2c client */
 380         struct i2c_client *encoder;     /* video encoder i2c client */
 381
 382         struct videocodec *codec;       /* video codec */
 383         struct videocodec *vfe; /* video front end */
 384
 385         struct mutex resource_lock;     /* prevent evil stuff */
 386
 387         u8 initialized;         /* flag if zoran has been correctly initalized */
 388         int user;               /* number of current users */
 389         struct card_info card;
 390         struct tvnorm *timing;
 391
 392         unsigned short id;      /* number of this device */
 393         char name[32];          /* name of this device */
 394         struct pci_dev *pci_dev;        /* PCI device */
 395         unsigned char revision; /* revision of zr36057 */
 396         unsigned char __iomem *zr36057_mem;/* pointer to mapped IO memory */
 397
 398         spinlock_t spinlock;    /* Spinlock */
 399
 400         /* Video for Linux parameters */
 401         int input;      /* card's norm and input - norm=VIDEO_MODE_* */
 402         v4l2_std_id norm;
 403         struct video_buffer buffer;     /* Current buffer params */
 404         struct zoran_overlay_settings overlay_settings;
 405         u32 *overlay_mask;      /* overlay mask */
 406         enum zoran_lock_activity overlay_active;        /* feature currently in use? */
 407
 408         wait_queue_head_t v4l_capq;
 409
 410         int v4l_overlay_active; /* Overlay grab is activated */
 411         int v4l_memgrab_active; /* Memory grab is activated */
 412
 413         int v4l_grab_frame;     /* Frame number being currently grabbed */
 414 #define NO_GRAB_ACTIVE (-1)
 415         unsigned long v4l_grab_seq;     /* Number of frames grabbed */
 416         struct zoran_v4l_settings v4l_settings; /* structure with a lot of things to play with */
 417
 418         /* V4L grab queue of frames pending */
 419         unsigned long v4l_pend_head;
 420         unsigned long v4l_pend_tail;
 421         unsigned long v4l_sync_tail;
 422         int v4l_pend[V4L_MAX_FRAME];
 423         struct zoran_v4l_struct v4l_buffers;    /* V4L buffers' info */
 424
 425         /* Buz MJPEG parameters */
 426         enum zoran_codec_mode codec_mode;       /* status of codec */
 427         struct zoran_jpg_settings jpg_settings; /* structure with a lot of things to play with */
 428
 429         wait_queue_head_t jpg_capq;     /* wait here for grab to finish */
 430
 431         /* grab queue counts/indices, mask with BUZ_MASK_STAT_COM before using as index */
 432         /* (dma_head - dma_tail) is number active in DMA, must be <= BUZ_NUM_STAT_COM */
 433         /* (value & BUZ_MASK_STAT_COM) corresponds to index in stat_com table */
 434         unsigned long jpg_que_head;     /* Index where to put next buffer which is queued */
 435         unsigned long jpg_dma_head;     /* Index of next buffer which goes into stat_com  */
 436         unsigned long jpg_dma_tail;     /* Index of last buffer in stat_com               */
 437         unsigned long jpg_que_tail;     /* Index of last buffer in queue                  */
 438         unsigned long jpg_seq_num;      /* count of frames since grab/play started        */
 439         unsigned long jpg_err_seq;      /* last seq_num before error                      */
 440         unsigned long jpg_err_shift;
 441         unsigned long jpg_queued_num;   /* count of frames queued since grab/play started */
 442
 443         /* zr36057's code buffer table */
 444         __le32 *stat_com;               /* stat_com[i] is indexed by dma_head/tail & BUZ_MASK_STAT_COM */
 445
 446         /* (value & BUZ_MASK_FRAME) corresponds to index in pend[] queue */
 447         int jpg_pend[BUZ_MAX_FRAME];
 448
 449         /* array indexed by frame number */
 450         struct zoran_jpg_struct jpg_buffers;    /* MJPEG buffers' info */
 451
 452         /* Additional stuff for testing */
 453 #ifdef CONFIG_PROC_FS
 454         struct proc_dir_entry *zoran_proc;
 455 #else
 456         void *zoran_proc;
 457 #endif
 458         int testing;
 459         int jpeg_error;
 460         int intr_counter_GIRQ1;
 461         int intr_counter_GIRQ0;
 462         int intr_counter_CodRepIRQ;
 463         int intr_counter_JPEGRepIRQ;
 464         int field_counter;
 465         int IRQ1_in;
 466         int IRQ1_out;
 467         int JPEG_in;
 468         int JPEG_out;
 469         int JPEG_0;
 470         int JPEG_1;
 471         int END_event_missed;
 472         int JPEG_missed;
 473         int JPEG_error;
 474         int num_errors;
 475         int JPEG_max_missed;
 476         int JPEG_min_missed;
 477
 478         u32 last_isr;
 479         unsigned long frame_num;
 480
 481         wait_queue_head_t test_q;
 482 };
 483
 484 /* There was something called _ALPHA_BUZ that used the PCI address instead of
 485  * the kernel iomapped address for btread/btwrite.  */
 486 #define btwrite(dat,adr)    writel((dat), zr->zr36057_mem+(adr))
 487 #define btread(adr)         readl(zr->zr36057_mem+(adr))
 488
 489 #define btand(dat,adr)      btwrite((dat) & btread(adr), adr)
 490 #define btor(dat,adr)       btwrite((dat) | btread(adr), adr)
 491 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
 492
 493 #endif                          /* __kernel__ */
 494
 495 #endif