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 #define MAX_KMALLOC_MEM (128*1024)
 174
 175 #include "zr36057.h"
 176
 177 enum card_type {
 178         UNKNOWN = -1,
 179
 180         /* Pinnacle/Miro */
 181         DC10_old,               /* DC30 like */
 182         DC10_new,               /* DC10plus like */
 183         DC10plus,
 184         DC30,
 185         DC30plus,
 186
 187         /* Linux Media Labs */
 188         LML33,
 189         LML33R10,
 190
 191         /* Iomega */
 192         BUZ,
 193
 194         /* AverMedia */
 195         AVS6EYES,
 196
 197         /* total number of cards */
 198         NUM_CARDS
 199 };
 200
 201 enum zoran_codec_mode {
 202         BUZ_MODE_IDLE,          /* nothing going on */
 203         BUZ_MODE_MOTION_COMPRESS,       /* grabbing frames */
 204         BUZ_MODE_MOTION_DECOMPRESS,     /* playing frames */
 205         BUZ_MODE_STILL_COMPRESS,        /* still frame conversion */
 206         BUZ_MODE_STILL_DECOMPRESS       /* still frame conversion */
 207 };
 208
 209 enum zoran_buffer_state {
 210         BUZ_STATE_USER,         /* buffer is owned by application */
 211         BUZ_STATE_PEND,         /* buffer is queued in pend[] ready to feed to I/O */
 212         BUZ_STATE_DMA,          /* buffer is queued in dma[] for I/O */
 213         BUZ_STATE_DONE          /* buffer is ready to return to application */
 214 };
 215
 216 enum zoran_map_mode {
 217         ZORAN_MAP_MODE_RAW,
 218         ZORAN_MAP_MODE_JPG_REC,
 219 #define ZORAN_MAP_MODE_JPG ZORAN_MAP_MODE_JPG_REC
 220         ZORAN_MAP_MODE_JPG_PLAY,
 221 };
 222
 223 enum gpio_type {
 224         ZR_GPIO_JPEG_SLEEP = 0,
 225         ZR_GPIO_JPEG_RESET,
 226         ZR_GPIO_JPEG_FRAME,
 227         ZR_GPIO_VID_DIR,
 228         ZR_GPIO_VID_EN,
 229         ZR_GPIO_VID_RESET,
 230         ZR_GPIO_CLK_SEL1,
 231         ZR_GPIO_CLK_SEL2,
 232         ZR_GPIO_MAX,
 233 };
 234
 235 enum gpcs_type {
 236         GPCS_JPEG_RESET = 0,
 237         GPCS_JPEG_START,
 238         GPCS_MAX,
 239 };
 240
 241 struct zoran_format {
 242         char *name;
 243 #ifdef CONFIG_VIDEO_V4L1_COMPAT
 244         int palette;
 245 #endif
 246         __u32 fourcc;
 247         int colorspace;
 248         int depth;
 249         __u32 flags;
 250         __u32 vfespfr;
 251 };
 252 /* flags */
 253 #define ZORAN_FORMAT_COMPRESSED 1<<0
 254 #define ZORAN_FORMAT_OVERLAY    1<<1
 255 #define ZORAN_FORMAT_CAPTURE    1<<2
 256 #define ZORAN_FORMAT_PLAYBACK   1<<3
 257
 258 /* overlay-settings */
 259 struct zoran_overlay_settings {
 260         int is_set;
 261         int x, y, width, height;        /* position */
 262         int clipcount;          /* position and number of clips */
 263         const struct zoran_format *format;      /* overlay format */
 264 };
 265
 266 /* v4l-capture settings */
 267 struct zoran_v4l_settings {
 268         int width, height, bytesperline;        /* capture size */
 269         const struct zoran_format *format;      /* capture format */
 270 };
 271
 272 /* jpg-capture/-playback settings */
 273 struct zoran_jpg_settings {
 274         int decimation;         /* this bit is used to set everything to default */
 275         int HorDcm, VerDcm, TmpDcm;     /* capture decimation settings (TmpDcm=1 means both fields) */
 276         int field_per_buff, odd_even;   /* field-settings (odd_even=1 (+TmpDcm=1) means top-field-first) */
 277         int img_x, img_y, img_width, img_height;        /* crop settings (subframe capture) */
 278         struct v4l2_jpegcompression jpg_comp;   /* JPEG-specific capture settings */
 279 };
 280
 281 struct zoran_mapping {
 282         struct file *file;
 283         int count;
 284 };
 285
 286 struct zoran_jpg_buffer {
 287         struct zoran_mapping *map;
 288         __le32 *frag_tab;               /* addresses of frag table */
 289         u32 frag_tab_bus;       /* same value cached to save time in ISR */
 290         enum zoran_buffer_state state;  /* non-zero if corresponding buffer is in use in grab queue */
 291         struct zoran_sync bs;   /* DONE: info to return to application */
 292 };
 293
 294 struct zoran_v4l_buffer {
 295         struct zoran_mapping *map;
 296         char *fbuffer;          /* virtual  address of frame buffer */
 297         unsigned long fbuffer_phys;     /* physical address of frame buffer */
 298         unsigned long fbuffer_bus;      /* bus      address of frame buffer */
 299         enum zoran_buffer_state state;  /* state: unused/pending/done */
 300         struct zoran_sync bs;   /* DONE: info to return to application */
 301 };
 302
 303 enum zoran_lock_activity {
 304         ZORAN_FREE,             /* free for use */
 305         ZORAN_ACTIVE,           /* active but unlocked */
 306         ZORAN_LOCKED,           /* locked */
 307 };
 308
 309 /* buffer collections */
 310 struct zoran_jpg_struct {
 311         enum zoran_lock_activity active;        /* feature currently in use? */
 312         struct zoran_jpg_buffer buffer[BUZ_MAX_FRAME];  /* buffers */
 313         int num_buffers, buffer_size;
 314         u8 allocated;           /* Flag if buffers are allocated  */
 315         u8 ready_to_be_freed;   /* hack - see zoran_driver.c */
 316         u8 need_contiguous;     /* Flag if contiguous buffers are needed */
 317 };
 318
 319 struct zoran_v4l_struct {
 320         enum zoran_lock_activity active;        /* feature currently in use? */
 321         struct zoran_v4l_buffer buffer[VIDEO_MAX_FRAME];        /* buffers */
 322         int num_buffers, buffer_size;
 323         u8 allocated;           /* Flag if buffers are allocated  */
 324         u8 ready_to_be_freed;   /* hack - see zoran_driver.c */
 325 };
 326
 327 struct zoran;
 328
 329 /* zoran_fh contains per-open() settings */
 330 struct zoran_fh {
 331         struct zoran *zr;
 332
 333         enum zoran_map_mode map_mode;   /* Flag which bufferset will map by next mmap() */
 334
 335         struct zoran_overlay_settings overlay_settings;
 336         u32 *overlay_mask;      /* overlay mask */
 337         enum zoran_lock_activity overlay_active;        /* feature currently in use? */
 338
 339         struct zoran_v4l_settings v4l_settings; /* structure with a lot of things to play with */
 340         struct zoran_v4l_struct v4l_buffers;    /* V4L buffers' info */
 341
 342         struct zoran_jpg_settings jpg_settings; /* structure with a lot of things to play with */
 343         struct zoran_jpg_struct jpg_buffers;    /* MJPEG buffers' info */
 344 };
 345
 346 struct card_info {
 347         enum card_type type;
 348         char name[32];
 349         u16 i2c_decoder, i2c_encoder;                   /* I2C types */
 350         u16 video_vfe, video_codec;                     /* videocodec types */
 351         u16 audio_chip;                                 /* audio type */
 352
 353         int inputs;             /* number of video inputs */
 354         struct input {
 355                 int muxsel;
 356                 char name[32];
 357         } input[BUZ_MAX_INPUT];
 358
 359         int norms;
 360         struct tvnorm *tvn[3];  /* supported TV norms */
 361
 362         u32 jpeg_int;           /* JPEG interrupt */
 363         u32 vsync_int;          /* VSYNC interrupt */
 364         s8 gpio[ZR_GPIO_MAX];
 365         u8 gpcs[GPCS_MAX];
 366
 367         struct vfe_polarity vfe_pol;
 368         u8 gpio_pol[ZR_GPIO_MAX];
 369
 370         /* is the /GWS line conected? */
 371         u8 gws_not_connected;
 372
 373         /* avs6eyes mux setting */
 374         u8 input_mux;
 375
 376         void (*init) (struct zoran * zr);
 377 };
 378
 379 struct zoran {
 380         struct video_device *video_dev;
 381
 382         struct i2c_adapter i2c_adapter; /* */
 383         struct i2c_algo_bit_data i2c_algo;      /* */
 384         u32 i2cbr;
 385
 386         struct i2c_client *decoder;     /* video decoder i2c client */
 387         struct i2c_client *encoder;     /* video encoder i2c client */
 388
 389         struct videocodec *codec;       /* video codec */
 390         struct videocodec *vfe; /* video front end */
 391
 392         struct mutex resource_lock;     /* prevent evil stuff */
 393
 394         u8 initialized;         /* flag if zoran has been correctly initalized */
 395         int user;               /* number of current users */
 396         struct card_info card;
 397         struct tvnorm *timing;
 398
 399         unsigned short id;      /* number of this device */
 400         char name[32];          /* name of this device */
 401         struct pci_dev *pci_dev;        /* PCI device */
 402         unsigned char revision; /* revision of zr36057 */
 403         unsigned char __iomem *zr36057_mem;/* pointer to mapped IO memory */
 404
 405         spinlock_t spinlock;    /* Spinlock */
 406
 407         /* Video for Linux parameters */
 408         int input, norm;        /* card's norm and input - norm=VIDEO_MODE_* */
 409         int hue, saturation, contrast, brightness;      /* Current picture params */
 410         struct video_buffer buffer;     /* Current buffer params */
 411         struct zoran_overlay_settings overlay_settings;
 412         u32 *overlay_mask;      /* overlay mask */
 413         enum zoran_lock_activity overlay_active;        /* feature currently in use? */
 414
 415         wait_queue_head_t v4l_capq;
 416
 417         int v4l_overlay_active; /* Overlay grab is activated */
 418         int v4l_memgrab_active; /* Memory grab is activated */
 419
 420         int v4l_grab_frame;     /* Frame number being currently grabbed */
 421 #define NO_GRAB_ACTIVE (-1)
 422         unsigned long v4l_grab_seq;     /* Number of frames grabbed */
 423         struct zoran_v4l_settings v4l_settings; /* structure with a lot of things to play with */
 424
 425         /* V4L grab queue of frames pending */
 426         unsigned long v4l_pend_head;
 427         unsigned long v4l_pend_tail;
 428         unsigned long v4l_sync_tail;
 429         int v4l_pend[V4L_MAX_FRAME];
 430         struct zoran_v4l_struct v4l_buffers;    /* V4L buffers' info */
 431
 432         /* Buz MJPEG parameters */
 433         enum zoran_codec_mode codec_mode;       /* status of codec */
 434         struct zoran_jpg_settings jpg_settings; /* structure with a lot of things to play with */
 435
 436         wait_queue_head_t jpg_capq;     /* wait here for grab to finish */
 437
 438         /* grab queue counts/indices, mask with BUZ_MASK_STAT_COM before using as index */
 439         /* (dma_head - dma_tail) is number active in DMA, must be <= BUZ_NUM_STAT_COM */
 440         /* (value & BUZ_MASK_STAT_COM) corresponds to index in stat_com table */
 441         unsigned long jpg_que_head;     /* Index where to put next buffer which is queued */
 442         unsigned long jpg_dma_head;     /* Index of next buffer which goes into stat_com  */
 443         unsigned long jpg_dma_tail;     /* Index of last buffer in stat_com               */
 444         unsigned long jpg_que_tail;     /* Index of last buffer in queue                  */
 445         unsigned long jpg_seq_num;      /* count of frames since grab/play started        */
 446         unsigned long jpg_err_seq;      /* last seq_num before error                      */
 447         unsigned long jpg_err_shift;
 448         unsigned long jpg_queued_num;   /* count of frames queued since grab/play started */
 449
 450         /* zr36057's code buffer table */
 451         __le32 *stat_com;               /* stat_com[i] is indexed by dma_head/tail & BUZ_MASK_STAT_COM */
 452
 453         /* (value & BUZ_MASK_FRAME) corresponds to index in pend[] queue */
 454         int jpg_pend[BUZ_MAX_FRAME];
 455
 456         /* array indexed by frame number */
 457         struct zoran_jpg_struct jpg_buffers;    /* MJPEG buffers' info */
 458
 459         /* Additional stuff for testing */
 460 #ifdef CONFIG_PROC_FS
 461         struct proc_dir_entry *zoran_proc;
 462 #else
 463         void *zoran_proc;
 464 #endif
 465         int testing;
 466         int jpeg_error;
 467         int intr_counter_GIRQ1;
 468         int intr_counter_GIRQ0;
 469         int intr_counter_CodRepIRQ;
 470         int intr_counter_JPEGRepIRQ;
 471         int field_counter;
 472         int IRQ1_in;
 473         int IRQ1_out;
 474         int JPEG_in;
 475         int JPEG_out;
 476         int JPEG_0;
 477         int JPEG_1;
 478         int END_event_missed;
 479         int JPEG_missed;
 480         int JPEG_error;
 481         int num_errors;
 482         int JPEG_max_missed;
 483         int JPEG_min_missed;
 484
 485         u32 last_isr;
 486         unsigned long frame_num;
 487
 488         wait_queue_head_t test_q;
 489 };
 490
 491 /* There was something called _ALPHA_BUZ that used the PCI address instead of
 492  * the kernel iomapped address for btread/btwrite.  */
 493 #define btwrite(dat,adr)    writel((dat), zr->zr36057_mem+(adr))
 494 #define btread(adr)         readl(zr->zr36057_mem+(adr))
 495
 496 #define btand(dat,adr)      btwrite((dat) & btread(adr), adr)
 497 #define btor(dat,adr)       btwrite((dat) | btread(adr), adr)
 498 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
 499
 500 #endif                          /* __kernel__ */
 501
 502 #endif