2 * Copyright (C) 2005-2006 Micronas USA Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License (Version 2) as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software Foundation,
15 * Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
18 #include <linux/module.h>
19 #include <linux/init.h>
20 #include <linux/delay.h>
21 #include <linux/sched.h>
22 #include <linux/spinlock.h>
23 #include <linux/unistd.h>
24 #include <linux/time.h>
26 #include <linux/vmalloc.h>
27 #include <linux/device.h>
28 #include <linux/i2c.h>
29 #include <linux/firmware.h>
30 #include <linux/mutex.h>
31 #include <linux/uaccess.h>
32 #include <linux/slab.h>
33 #include <asm/system.h>
34 #include <linux/videodev2.h>
35 #include <media/tuner.h>
36 #include <media/v4l2-common.h>
38 #include "go7007-priv.h"
42 * Wait for an interrupt to be delivered from the GO7007SB and return
43 * the associated value and data.
45 * Must be called with the hw_lock held.
47 int go7007_read_interrupt(struct go7007 *go, u16 *value, u16 *data)
49 go->interrupt_available = 0;
50 go->hpi_ops->read_interrupt(go);
51 if (wait_event_timeout(go->interrupt_waitq,
52 go->interrupt_available, 5*HZ) < 0) {
53 v4l2_err(&go->v4l2_dev, "timeout waiting for read interrupt\n");
56 if (!go->interrupt_available)
58 go->interrupt_available = 0;
59 *value = go->interrupt_value & 0xfffe;
60 *data = go->interrupt_data;
63 EXPORT_SYMBOL(go7007_read_interrupt);
66 * Read a register/address on the GO7007SB.
68 * Must be called with the hw_lock held.
70 int go7007_read_addr(struct go7007 *go, u16 addr, u16 *data)
75 if (go7007_write_interrupt(go, 0x0010, addr) < 0)
78 if (go7007_read_interrupt(go, &value, data) == 0 &&
84 EXPORT_SYMBOL(go7007_read_addr);
87 * Send the boot firmware to the encoder, which just wakes it up and lets
88 * us talk to the GPIO pins and on-board I2C adapter.
90 * Must be called with the hw_lock held.
92 static int go7007_load_encoder(struct go7007 *go)
94 const struct firmware *fw_entry;
95 char fw_name[] = "go7007fw.bin";
98 u16 intr_val, intr_data;
100 if (request_firmware(&fw_entry, fw_name, go->dev)) {
101 v4l2_err(go, "unable to load firmware from file "
102 "\"%s\"\n", fw_name);
105 if (fw_entry->size < 16 || memcmp(fw_entry->data, "WISGO7007FW", 11)) {
106 v4l2_err(go, "file \"%s\" does not appear to be "
107 "go7007 firmware\n", fw_name);
108 release_firmware(fw_entry);
111 fw_len = fw_entry->size - 16;
112 bounce = kmalloc(fw_len, GFP_KERNEL);
113 if (bounce == NULL) {
114 v4l2_err(go, "unable to allocate %d bytes for "
115 "firmware transfer\n", fw_len);
116 release_firmware(fw_entry);
119 memcpy(bounce, fw_entry->data + 16, fw_len);
120 release_firmware(fw_entry);
121 if (go7007_interface_reset(go) < 0 ||
122 go7007_send_firmware(go, bounce, fw_len) < 0 ||
123 go7007_read_interrupt(go, &intr_val, &intr_data) < 0 ||
124 (intr_val & ~0x1) != 0x5a5a) {
125 v4l2_err(go, "error transferring firmware\n");
132 MODULE_FIRMWARE("go7007fw.bin");
135 * Boot the encoder and register the I2C adapter if requested. Do the
136 * minimum initialization necessary, since the board-specific code may
137 * still need to probe the board ID.
139 * Must NOT be called with the hw_lock held.
141 int go7007_boot_encoder(struct go7007 *go, int init_i2c)
145 mutex_lock(&go->hw_lock);
146 ret = go7007_load_encoder(go);
147 mutex_unlock(&go->hw_lock);
152 if (go7007_i2c_init(go) < 0)
154 go->i2c_adapter_online = 1;
157 EXPORT_SYMBOL(go7007_boot_encoder);
160 * Configure any hardware-related registers in the GO7007, such as GPIO
161 * pins and bus parameters, which are board-specific. This assumes
162 * the boot firmware has already been downloaded.
164 * Must be called with the hw_lock held.
166 static int go7007_init_encoder(struct go7007 *go)
168 if (go->board_info->audio_flags & GO7007_AUDIO_I2S_MASTER) {
169 go7007_write_addr(go, 0x1000, 0x0811);
170 go7007_write_addr(go, 0x1000, 0x0c11);
172 if (go->board_id == GO7007_BOARDID_MATRIX_REV) {
173 /* Set GPIO pin 0 to be an output (audio clock control) */
174 go7007_write_addr(go, 0x3c82, 0x0001);
175 go7007_write_addr(go, 0x3c80, 0x00fe);
181 * Send the boot firmware to the GO7007 and configure the registers. This
182 * is the only way to stop the encoder once it has started streaming video.
184 * Must be called with the hw_lock held.
186 int go7007_reset_encoder(struct go7007 *go)
188 if (go7007_load_encoder(go) < 0)
190 return go7007_init_encoder(go);
194 * Attempt to instantiate an I2C client by ID, probably loading a module.
196 static int init_i2c_module(struct i2c_adapter *adapter, const char *type,
199 struct go7007 *go = i2c_get_adapdata(adapter);
200 struct v4l2_device *v4l2_dev = &go->v4l2_dev;
204 case I2C_DRIVERID_WIS_SAA7115:
205 modname = "wis-saa7115";
207 case I2C_DRIVERID_WIS_SAA7113:
208 modname = "wis-saa7113";
210 case I2C_DRIVERID_WIS_UDA1342:
211 modname = "wis-uda1342";
213 case I2C_DRIVERID_WIS_SONY_TUNER:
214 modname = "wis-sony-tuner";
216 case I2C_DRIVERID_WIS_TW9903:
217 modname = "wis-tw9903";
219 case I2C_DRIVERID_WIS_TW2804:
220 modname = "wis-tw2804";
222 case I2C_DRIVERID_WIS_OV7640:
223 modname = "wis-ov7640";
225 case I2C_DRIVERID_S2250:
233 if (v4l2_i2c_new_subdev(v4l2_dev, adapter, modname, type, addr, NULL))
238 "go7007: probing for module %s failed\n", modname);
241 "go7007: sensor %u seems to be unsupported!\n", id);
246 * Finalize the GO7007 hardware setup, register the on-board I2C adapter
247 * (if used on this board), load the I2C client driver for the sensor
248 * (SAA7115 or whatever) and other devices, and register the ALSA and V4L2
251 * Must NOT be called with the hw_lock held.
253 int go7007_register_encoder(struct go7007 *go)
257 printk(KERN_INFO "go7007: registering new %s\n", go->name);
259 mutex_lock(&go->hw_lock);
260 ret = go7007_init_encoder(go);
261 mutex_unlock(&go->hw_lock);
265 /* v4l2 init must happen before i2c subdevs */
266 ret = go7007_v4l2_init(go);
270 if (!go->i2c_adapter_online &&
271 go->board_info->flags & GO7007_BOARD_USE_ONBOARD_I2C) {
272 if (go7007_i2c_init(go) < 0)
274 go->i2c_adapter_online = 1;
276 if (go->i2c_adapter_online) {
277 for (i = 0; i < go->board_info->num_i2c_devs; ++i)
278 init_i2c_module(&go->i2c_adapter,
279 go->board_info->i2c_devs[i].type,
280 go->board_info->i2c_devs[i].id,
281 go->board_info->i2c_devs[i].addr);
282 if (go->board_id == GO7007_BOARDID_ADLINK_MPG24)
283 i2c_clients_command(&go->i2c_adapter,
284 DECODER_SET_CHANNEL, &go->channel_number);
286 if (go->board_info->flags & GO7007_BOARD_HAS_AUDIO) {
287 go->audio_enabled = 1;
292 EXPORT_SYMBOL(go7007_register_encoder);
295 * Send the encode firmware to the encoder, which will cause it
296 * to immediately start delivering the video and audio streams.
298 * Must be called with the hw_lock held.
300 int go7007_start_encoder(struct go7007 *go)
303 int fw_len, rv = 0, i;
304 u16 intr_val, intr_data;
306 go->modet_enable = 0;
308 for (i = 0; i < 4; ++i) {
309 if (go->modet[i].enable) {
310 go->modet_enable = 1;
313 go->modet[i].pixel_threshold = 32767;
314 go->modet[i].motion_threshold = 32767;
315 go->modet[i].mb_threshold = 32767;
318 if (go7007_construct_fw_image(go, &fw, &fw_len) < 0)
321 if (go7007_send_firmware(go, fw, fw_len) < 0 ||
322 go7007_read_interrupt(go, &intr_val, &intr_data) < 0) {
323 v4l2_err(&go->v4l2_dev, "error transferring firmware\n");
328 go->state = STATE_DATA;
329 go->parse_length = 0;
331 if (go7007_stream_start(go) < 0) {
332 v4l2_err(&go->v4l2_dev, "error starting stream transfer\n");
343 * Store a byte in the current video buffer, if there is one.
345 static inline void store_byte(struct go7007_buffer *gobuf, u8 byte)
347 if (gobuf != NULL && gobuf->bytesused < GO7007_BUF_SIZE) {
348 unsigned int pgidx = gobuf->offset >> PAGE_SHIFT;
349 unsigned int pgoff = gobuf->offset & ~PAGE_MASK;
351 *((u8 *)page_address(gobuf->pages[pgidx]) + pgoff) = byte;
358 * Deliver the last video buffer and get a new one to start writing to.
360 static void frame_boundary(struct go7007 *go)
362 struct go7007_buffer *gobuf;
365 if (go->active_buf) {
366 if (go->active_buf->modet_active) {
367 if (go->active_buf->bytesused + 216 < GO7007_BUF_SIZE) {
368 for (i = 0; i < 216; ++i)
369 store_byte(go->active_buf,
371 go->active_buf->bytesused -= 216;
373 go->active_buf->modet_active = 0;
375 go->active_buf->state = BUF_STATE_DONE;
376 wake_up_interruptible(&go->frame_waitq);
377 go->active_buf = NULL;
379 list_for_each_entry(gobuf, &go->stream, stream)
380 if (gobuf->state == BUF_STATE_QUEUED) {
381 gobuf->seq = go->next_seq;
382 do_gettimeofday(&gobuf->timestamp);
383 go->active_buf = gobuf;
389 static void write_bitmap_word(struct go7007 *go)
391 int x, y, i, stride = ((go->width >> 4) + 7) >> 3;
393 for (i = 0; i < 16; ++i) {
394 y = (((go->parse_length - 1) << 3) + i) / (go->width >> 4);
395 x = (((go->parse_length - 1) << 3) + i) % (go->width >> 4);
396 go->active_map[stride * y + (x >> 3)] |=
397 (go->modet_word & 1) << (x & 0x7);
398 go->modet_word >>= 1;
403 * Parse a chunk of the video stream into frames. The frames are not
404 * delimited by the hardware, so we have to parse the frame boundaries
405 * based on the type of video stream we're receiving.
407 void go7007_parse_video_stream(struct go7007 *go, u8 *buf, int length)
409 int i, seq_start_code = -1, frame_start_code = -1;
411 spin_lock(&go->spinlock);
413 switch (go->format) {
414 case GO7007_FORMAT_MPEG4:
415 seq_start_code = 0xB0;
416 frame_start_code = 0xB6;
418 case GO7007_FORMAT_MPEG1:
419 case GO7007_FORMAT_MPEG2:
420 seq_start_code = 0xB3;
421 frame_start_code = 0x00;
425 for (i = 0; i < length; ++i) {
426 if (go->active_buf != NULL &&
427 go->active_buf->bytesused >= GO7007_BUF_SIZE - 3) {
428 v4l2_info(&go->v4l2_dev, "dropping oversized frame\n");
429 go->active_buf->offset -= go->active_buf->bytesused;
430 go->active_buf->bytesused = 0;
431 go->active_buf->modet_active = 0;
432 go->active_buf = NULL;
439 go->state = STATE_00;
442 go->state = STATE_FF;
445 store_byte(go->active_buf, buf[i]);
452 go->state = STATE_00_00;
455 store_byte(go->active_buf, 0x00);
456 go->state = STATE_FF;
459 store_byte(go->active_buf, 0x00);
460 store_byte(go->active_buf, buf[i]);
461 go->state = STATE_DATA;
468 store_byte(go->active_buf, 0x00);
469 /* go->state remains STATE_00_00 */
472 go->state = STATE_00_00_01;
475 store_byte(go->active_buf, 0x00);
476 store_byte(go->active_buf, 0x00);
477 go->state = STATE_FF;
480 store_byte(go->active_buf, 0x00);
481 store_byte(go->active_buf, 0x00);
482 store_byte(go->active_buf, buf[i]);
483 go->state = STATE_DATA;
488 /* If this is the start of a new MPEG frame,
489 * get a new buffer */
490 if ((go->format == GO7007_FORMAT_MPEG1 ||
491 go->format == GO7007_FORMAT_MPEG2 ||
492 go->format == GO7007_FORMAT_MPEG4) &&
493 (buf[i] == seq_start_code ||
494 buf[i] == 0xB8 || /* GOP code */
495 buf[i] == frame_start_code)) {
496 if (go->active_buf == NULL || go->seen_frame)
498 if (buf[i] == frame_start_code) {
499 if (go->active_buf != NULL)
500 go->active_buf->frame_offset =
501 go->active_buf->offset;
507 /* Handle any special chunk types, or just write the
508 * start code to the (potentially new) buffer */
510 case 0xF5: /* timestamp */
511 go->parse_length = 12;
512 go->state = STATE_UNPARSED;
515 go->state = STATE_VBI_LEN_A;
517 case 0xF8: /* MD map */
518 go->parse_length = 0;
519 memset(go->active_map, 0,
520 sizeof(go->active_map));
521 go->state = STATE_MODET_MAP;
523 case 0xFF: /* Potential JPEG start code */
524 store_byte(go->active_buf, 0x00);
525 store_byte(go->active_buf, 0x00);
526 store_byte(go->active_buf, 0x01);
527 go->state = STATE_FF;
530 store_byte(go->active_buf, 0x00);
531 store_byte(go->active_buf, 0x00);
532 store_byte(go->active_buf, 0x01);
533 store_byte(go->active_buf, buf[i]);
534 go->state = STATE_DATA;
541 store_byte(go->active_buf, 0xFF);
542 go->state = STATE_00;
545 store_byte(go->active_buf, 0xFF);
546 /* go->state remains STATE_FF */
549 if (go->format == GO7007_FORMAT_MJPEG)
553 store_byte(go->active_buf, 0xFF);
554 store_byte(go->active_buf, buf[i]);
555 go->state = STATE_DATA;
559 case STATE_VBI_LEN_A:
560 go->parse_length = buf[i] << 8;
561 go->state = STATE_VBI_LEN_B;
563 case STATE_VBI_LEN_B:
564 go->parse_length |= buf[i];
565 if (go->parse_length > 0)
566 go->state = STATE_UNPARSED;
568 go->state = STATE_DATA;
570 case STATE_MODET_MAP:
571 if (go->parse_length < 204) {
572 if (go->parse_length & 1) {
573 go->modet_word |= buf[i];
574 write_bitmap_word(go);
576 go->modet_word = buf[i] << 8;
577 } else if (go->parse_length == 207 && go->active_buf) {
578 go->active_buf->modet_active = buf[i];
580 if (++go->parse_length == 208)
581 go->state = STATE_DATA;
584 if (--go->parse_length == 0)
585 go->state = STATE_DATA;
590 spin_unlock(&go->spinlock);
592 EXPORT_SYMBOL(go7007_parse_video_stream);
595 * Allocate a new go7007 struct. Used by the hardware-specific probe.
597 struct go7007 *go7007_alloc(struct go7007_board_info *board, struct device *dev)
602 go = kmalloc(sizeof(struct go7007), GFP_KERNEL);
606 go->board_info = board;
609 go->channel_number = 0;
611 mutex_init(&go->hw_lock);
612 init_waitqueue_head(&go->frame_waitq);
613 spin_lock_init(&go->spinlock);
614 go->video_dev = NULL;
616 go->status = STATUS_INIT;
617 memset(&go->i2c_adapter, 0, sizeof(go->i2c_adapter));
618 go->i2c_adapter_online = 0;
619 go->interrupt_available = 0;
620 init_waitqueue_head(&go->interrupt_waitq);
623 if (board->sensor_flags & GO7007_SENSOR_TV) {
624 go->standard = GO7007_STD_NTSC;
627 go->sensor_framerate = 30000;
629 go->standard = GO7007_STD_OTHER;
630 go->width = board->sensor_width;
631 go->height = board->sensor_height;
632 go->sensor_framerate = board->sensor_framerate;
634 go->encoder_v_offset = board->sensor_v_offset;
635 go->encoder_h_offset = board->sensor_h_offset;
636 go->encoder_h_halve = 0;
637 go->encoder_v_halve = 0;
638 go->encoder_subsample = 0;
640 go->format = GO7007_FORMAT_MJPEG;
641 go->bitrate = 1500000;
644 go->aspect_ratio = GO7007_RATIO_1_1;
648 go->repeat_seqhead = 0;
649 go->seq_header_enable = 0;
650 go->gop_header_enable = 0;
652 go->interlace_coding = 0;
653 for (i = 0; i < 4; ++i)
654 go->modet[i].enable = 0;;
655 for (i = 0; i < 1624; ++i)
656 go->modet_map[i] = 0;
657 go->audio_deliver = NULL;
658 go->audio_enabled = 0;
659 INIT_LIST_HEAD(&go->stream);
663 EXPORT_SYMBOL(go7007_alloc);
666 * Detach and unregister the encoder. The go7007 struct won't be freed
667 * until v4l2 finishes releasing its resources and all associated fds are
668 * closed by applications.
670 void go7007_remove(struct go7007 *go)
672 if (go->i2c_adapter_online) {
673 if (i2c_del_adapter(&go->i2c_adapter) == 0)
674 go->i2c_adapter_online = 0;
676 v4l2_err(&go->v4l2_dev,
677 "error removing I2C adapter!\n");
680 if (go->audio_enabled)
681 go7007_snd_remove(go);
682 go7007_v4l2_remove(go);
684 EXPORT_SYMBOL(go7007_remove);
686 MODULE_LICENSE("GPL v2");