2 * Zoran ZR36016 basic configuration functions
4 * Copyright (C) 2001 Wolfgang Scherr <scherr@net4you.at>
6 * $Id: zr36016.c,v 1.1.2.14 2003/08/20 19:46:55 rbultje Exp $
8 * ------------------------------------------------------------------------
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.
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.
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.
24 * ------------------------------------------------------------------------
27 #define ZR016_VERSION "v0.7"
29 #include <linux/version.h>
30 #include <linux/module.h>
31 #include <linux/init.h>
32 #include <linux/slab.h>
33 #include <linux/delay.h>
35 #include <linux/types.h>
36 #include <linux/wait.h>
38 /* includes for structures and defines regarding video
39 #include<linux/videodev.h> */
41 /* I/O commands, error codes */
46 #include<linux/videodev.h>
48 /* headerfile of this module */
52 #include"videocodec.h"
54 /* it doesn't make sense to have more than 20 or so,
55 just to prevent some unwanted loops */
58 /* amount of chips attached via this driver */
59 static int zr36016_codecs = 0;
61 /* debugging is available via module parameter */
64 module_param(debug, int, 0);
65 MODULE_PARM_DESC(debug, "Debug level (0-4)");
67 #define dprintk(num, format, args...) \
70 printk(format, ##args); \
73 /* =========================================================================
74 Local hardware I/O functions:
76 read/write via codec layer (registers are located in the master device)
77 ========================================================================= */
79 /* read and write functions */
81 zr36016_read (struct zr36016 *ptr,
86 // just in case something is wrong...
87 if (ptr->codec->master_data->readreg)
89 (ptr->codec->master_data->
90 readreg(ptr->codec, reg)) & 0xFF;
93 KERN_ERR "%s: invalid I/O setup, nothing read!\n",
96 dprintk(4, "%s: reading from 0x%04x: %02x\n", ptr->name, reg,
103 zr36016_write (struct zr36016 *ptr,
107 dprintk(4, "%s: writing 0x%02x to 0x%04x\n", ptr->name, value,
110 // just in case something is wrong...
111 if (ptr->codec->master_data->writereg) {
112 ptr->codec->master_data->writereg(ptr->codec, reg, value);
116 "%s: invalid I/O setup, nothing written!\n",
120 /* indirect read and write functions */
121 /* the 016 supports auto-addr-increment, but
122 * writing it all time cost not much and is safer... */
124 zr36016_readi (struct zr36016 *ptr,
129 // just in case something is wrong...
130 if ((ptr->codec->master_data->writereg) &&
131 (ptr->codec->master_data->readreg)) {
132 ptr->codec->master_data->writereg(ptr->codec, ZR016_IADDR, reg & 0x0F); // ADDR
133 value = (ptr->codec->master_data->readreg(ptr->codec, ZR016_IDATA)) & 0xFF; // DATA
137 "%s: invalid I/O setup, nothing read (i)!\n",
140 dprintk(4, "%s: reading indirect from 0x%04x: %02x\n", ptr->name,
146 zr36016_writei (struct zr36016 *ptr,
150 dprintk(4, "%s: writing indirect 0x%02x to 0x%04x\n", ptr->name,
153 // just in case something is wrong...
154 if (ptr->codec->master_data->writereg) {
155 ptr->codec->master_data->writereg(ptr->codec, ZR016_IADDR, reg & 0x0F); // ADDR
156 ptr->codec->master_data->writereg(ptr->codec, ZR016_IDATA, value & 0x0FF); // DATA
160 "%s: invalid I/O setup, nothing written (i)!\n",
164 /* =========================================================================
165 Local helper function:
168 ========================================================================= */
170 /* version kept in datastructure */
172 zr36016_read_version (struct zr36016 *ptr)
174 ptr->version = zr36016_read(ptr, 0) >> 4;
178 /* =========================================================================
179 Local helper function:
181 basic test of "connectivity", writes/reads to/from PAX-Lo register
182 ========================================================================= */
185 zr36016_basic_test (struct zr36016 *ptr)
189 zr36016_writei(ptr, ZR016I_PAX_LO, 0x55);
190 dprintk(1, KERN_INFO "%s: registers: ", ptr->name);
191 for (i = 0; i <= 0x0b; i++)
192 dprintk(1, "%02x ", zr36016_readi(ptr, i));
195 // for testing just write 0, then the default value to a register and read
196 // it back in both cases
197 zr36016_writei(ptr, ZR016I_PAX_LO, 0x00);
198 if (zr36016_readi(ptr, ZR016I_PAX_LO) != 0x0) {
201 "%s: attach failed, can't connect to vfe processor!\n",
205 zr36016_writei(ptr, ZR016I_PAX_LO, 0x0d0);
206 if (zr36016_readi(ptr, ZR016I_PAX_LO) != 0x0d0) {
209 "%s: attach failed, can't connect to vfe processor!\n",
213 // we allow version numbers from 0-3, should be enough, though
214 zr36016_read_version(ptr);
215 if (ptr->version & 0x0c) {
218 "%s: attach failed, suspicious version %d found...\n",
219 ptr->name, ptr->version);
223 return 0; /* looks good! */
226 /* =========================================================================
227 Local helper function:
229 simple loop for pushing the init datasets - NO USE --
230 ========================================================================= */
233 static int zr36016_pushit (struct zr36016 *ptr,
240 dprintk(4, "%s: write data block to 0x%04x (len=%d)\n",
241 ptr->name, startreg,len);
243 zr36016_writei(ptr, startreg++, data[i++]);
250 /* =========================================================================
251 Basic datasets & init:
254 ========================================================================= */
256 // needed offset values PAL NTSC SECAM
257 static const int zr016_xoff[] = { 20, 20, 20 };
258 static const int zr016_yoff[] = { 8, 9, 7 };
261 zr36016_init (struct zr36016 *ptr)
263 // stop any processing
264 zr36016_write(ptr, ZR016_GOSTOP, 0);
266 // mode setup (yuv422 in and out, compression/expansuon due to mode)
267 zr36016_write(ptr, ZR016_MODE,
268 ZR016_YUV422 | ZR016_YUV422_YUV422 |
269 (ptr->mode == CODEC_DO_COMPRESSION ?
270 ZR016_COMPRESSION : ZR016_EXPANSION));
273 zr36016_writei(ptr, ZR016I_SETUP1,
274 (ptr->xdec ? (ZR016_HRFL | ZR016_HORZ) : 0) |
275 (ptr->ydec ? ZR016_VERT : 0) | ZR016_CNTI);
276 zr36016_writei(ptr, ZR016I_SETUP2, ZR016_CCIR);
279 // (no extra offset for now, norm defines offset, default width height)
280 zr36016_writei(ptr, ZR016I_PAX_HI, ptr->width >> 8);
281 zr36016_writei(ptr, ZR016I_PAX_LO, ptr->width & 0xFF);
282 zr36016_writei(ptr, ZR016I_PAY_HI, ptr->height >> 8);
283 zr36016_writei(ptr, ZR016I_PAY_LO, ptr->height & 0xFF);
284 zr36016_writei(ptr, ZR016I_NAX_HI, ptr->xoff >> 8);
285 zr36016_writei(ptr, ZR016I_NAX_LO, ptr->xoff & 0xFF);
286 zr36016_writei(ptr, ZR016I_NAY_HI, ptr->yoff >> 8);
287 zr36016_writei(ptr, ZR016I_NAY_LO, ptr->yoff & 0xFF);
289 /* shall we continue now, please? */
290 zr36016_write(ptr, ZR016_GOSTOP, 1);
293 /* =========================================================================
296 this functions are accessed by the master via the API structure
297 ========================================================================= */
299 /* set compression/expansion mode and launches codec -
300 this should be the last call from the master before starting processing */
302 zr36016_set_mode (struct videocodec *codec,
305 struct zr36016 *ptr = (struct zr36016 *) codec->data;
307 dprintk(2, "%s: set_mode %d call\n", ptr->name, mode);
309 if ((mode != CODEC_DO_EXPANSION) && (mode != CODEC_DO_COMPRESSION))
318 /* set picture size */
320 zr36016_set_video (struct videocodec *codec,
322 struct vfe_settings *cap,
323 struct vfe_polarity *pol)
325 struct zr36016 *ptr = (struct zr36016 *) codec->data;
327 dprintk(2, "%s: set_video %d.%d, %d/%d-%dx%d (0x%x) call\n",
328 ptr->name, norm->HStart, norm->VStart,
329 cap->x, cap->y, cap->width, cap->height,
332 /* if () return -EINVAL;
333 * trust the master driver that it knows what it does - so
334 * we allow invalid startx/y for now ... */
335 ptr->width = cap->width;
336 ptr->height = cap->height;
337 /* (Ronald) This is ugly. zoran_device.c, line 387
338 * already mentions what happens if HStart is even
339 * (blue faces, etc., cr/cb inversed). There's probably
340 * some good reason why HStart is 0 instead of 1, so I'm
341 * leaving it to this for now, but really... This can be
342 * done a lot simpler */
343 ptr->xoff = (norm->HStart ? norm->HStart : 1) + cap->x;
344 /* Something to note here (I don't understand it), setting
345 * VStart too high will cause the codec to 'not work'. I
346 * really don't get it. values of 16 (VStart) already break
347 * it here. Just '0' seems to work. More testing needed! */
348 ptr->yoff = norm->VStart + cap->y;
349 /* (Ronald) dzjeeh, can't this thing do hor_decimation = 4? */
350 ptr->xdec = ((cap->decimation & 0xff) == 1) ? 0 : 1;
351 ptr->ydec = (((cap->decimation >> 8) & 0xff) == 1) ? 0 : 1;
356 /* additional control functions */
358 zr36016_control (struct videocodec *codec,
363 struct zr36016 *ptr = (struct zr36016 *) codec->data;
364 int *ival = (int *) data;
366 dprintk(2, "%s: control %d call with %d byte\n", ptr->name, type,
370 case CODEC_G_STATUS: /* get last status - we don't know it ... */
371 if (size != sizeof(int))
376 case CODEC_G_CODEC_MODE:
377 if (size != sizeof(int))
382 case CODEC_S_CODEC_MODE:
383 if (size != sizeof(int))
387 /* not needed, do nothing */
395 /* not available, give an error */
405 /* =========================================================================
406 Exit and unregister function:
408 Deinitializes Zoran's JPEG processor
409 ========================================================================= */
412 zr36016_unset (struct videocodec *codec)
414 struct zr36016 *ptr = codec->data;
417 /* do wee need some codec deinit here, too ???? */
419 dprintk(1, "%s: finished codec #%d\n", ptr->name,
431 /* =========================================================================
432 Setup and registry function:
434 Initializes Zoran's JPEG processor
436 Also sets pixel size, average code size, mode (compr./decompr.)
437 (the given size is determined by the processor with the video interface)
438 ========================================================================= */
441 zr36016_setup (struct videocodec *codec)
446 dprintk(2, "zr36016: initializing VFE subsystem #%d.\n",
449 if (zr36016_codecs == MAX_CODECS) {
451 KERN_ERR "zr36016: Can't attach more codecs!\n");
455 codec->data = ptr = kmalloc(sizeof(struct zr36016), GFP_KERNEL);
457 dprintk(1, KERN_ERR "zr36016: Can't get enough memory!\n");
460 memset(ptr, 0, sizeof(struct zr36016));
462 snprintf(ptr->name, sizeof(ptr->name), "zr36016[%d]",
464 ptr->num = zr36016_codecs++;
468 res = zr36016_basic_test(ptr);
470 zr36016_unset(codec);
474 ptr->mode = CODEC_DO_COMPRESSION;
481 dprintk(1, KERN_INFO "%s: codec v%d attached and running\n",
482 ptr->name, ptr->version);
487 static const struct videocodec zr36016_codec = {
488 .owner = THIS_MODULE,
490 .magic = 0L, // magic not used
492 CODEC_FLAG_HARDWARE | CODEC_FLAG_VFE | CODEC_FLAG_ENCODER |
494 .type = CODEC_TYPE_ZR36016,
495 .setup = zr36016_setup, // functionality
496 .unset = zr36016_unset,
497 .set_mode = zr36016_set_mode,
498 .set_video = zr36016_set_video,
499 .control = zr36016_control,
500 // others are not used
503 /* =========================================================================
504 HOOK IN DRIVER AS KERNEL MODULE
505 ========================================================================= */
508 zr36016_init_module (void)
510 //dprintk(1, "ZR36016 driver %s\n",ZR016_VERSION);
512 return videocodec_register(&zr36016_codec);
516 zr36016_cleanup_module (void)
518 if (zr36016_codecs) {
520 "zr36016: something's wrong - %d codecs left somehow.\n",
523 videocodec_unregister(&zr36016_codec);
526 module_init(zr36016_init_module);
527 module_exit(zr36016_cleanup_module);
529 MODULE_AUTHOR("Wolfgang Scherr <scherr@net4you.at>");
530 MODULE_DESCRIPTION("Driver module for ZR36016 video frontends "
532 MODULE_LICENSE("GPL");