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.
14 #include <linux/module.h>
15 #include <linux/delay.h>
16 #include <linux/sched.h>
17 #include <linux/spinlock.h>
18 #include <linux/unistd.h>
19 #include <linux/time.h>
21 #include <linux/vmalloc.h>
22 #include <linux/device.h>
23 #include <linux/i2c.h>
24 #include <linux/firmware.h>
25 #include <linux/mutex.h>
26 #include <linux/uaccess.h>
27 #include <linux/slab.h>
28 #include <linux/videodev2.h>
29 #include <media/tuner.h>
30 #include <media/v4l2-common.h>
31 #include <media/v4l2-event.h>
33 #include "go7007-priv.h"
36 * Wait for an interrupt to be delivered from the GO7007SB and return
37 * the associated value and data.
39 * Must be called with the hw_lock held.
41 int go7007_read_interrupt(struct go7007
*go
, u16
*value
, u16
*data
)
43 go
->interrupt_available
= 0;
44 go
->hpi_ops
->read_interrupt(go
);
45 if (wait_event_timeout(go
->interrupt_waitq
,
46 go
->interrupt_available
, 5*HZ
) < 0) {
47 v4l2_err(&go
->v4l2_dev
, "timeout waiting for read interrupt\n");
50 if (!go
->interrupt_available
)
52 go
->interrupt_available
= 0;
53 *value
= go
->interrupt_value
& 0xfffe;
54 *data
= go
->interrupt_data
;
57 EXPORT_SYMBOL(go7007_read_interrupt
);
60 * Read a register/address on the GO7007SB.
62 * Must be called with the hw_lock held.
64 int go7007_read_addr(struct go7007
*go
, u16 addr
, u16
*data
)
69 if (go7007_write_interrupt(go
, 0x0010, addr
) < 0)
72 if (go7007_read_interrupt(go
, &value
, data
) == 0 &&
78 EXPORT_SYMBOL(go7007_read_addr
);
81 * Send the boot firmware to the encoder, which just wakes it up and lets
82 * us talk to the GPIO pins and on-board I2C adapter.
84 * Must be called with the hw_lock held.
86 static int go7007_load_encoder(struct go7007
*go
)
88 const struct firmware
*fw_entry
;
89 char fw_name
[] = "go7007/go7007fw.bin";
92 u16 intr_val
, intr_data
;
94 if (go
->boot_fw
== NULL
) {
95 if (request_firmware(&fw_entry
, fw_name
, go
->dev
)) {
96 v4l2_err(go
, "unable to load firmware from file \"%s\"\n", fw_name
);
99 if (fw_entry
->size
< 16 || memcmp(fw_entry
->data
, "WISGO7007FW", 11)) {
100 v4l2_err(go
, "file \"%s\" does not appear to be go7007 firmware\n", fw_name
);
101 release_firmware(fw_entry
);
104 fw_len
= fw_entry
->size
- 16;
105 bounce
= kmemdup(fw_entry
->data
+ 16, fw_len
, GFP_KERNEL
);
106 if (bounce
== NULL
) {
107 v4l2_err(go
, "unable to allocate %d bytes for firmware transfer\n", fw_len
);
108 release_firmware(fw_entry
);
111 release_firmware(fw_entry
);
112 go
->boot_fw_len
= fw_len
;
113 go
->boot_fw
= bounce
;
115 if (go7007_interface_reset(go
) < 0 ||
116 go7007_send_firmware(go
, go
->boot_fw
, go
->boot_fw_len
) < 0 ||
117 go7007_read_interrupt(go
, &intr_val
, &intr_data
) < 0 ||
118 (intr_val
& ~0x1) != 0x5a5a) {
119 v4l2_err(go
, "error transferring firmware\n");
125 MODULE_FIRMWARE("go7007/go7007fw.bin");
128 * Boot the encoder and register the I2C adapter if requested. Do the
129 * minimum initialization necessary, since the board-specific code may
130 * still need to probe the board ID.
132 * Must NOT be called with the hw_lock held.
134 int go7007_boot_encoder(struct go7007
*go
, int init_i2c
)
138 mutex_lock(&go
->hw_lock
);
139 ret
= go7007_load_encoder(go
);
140 mutex_unlock(&go
->hw_lock
);
145 if (go7007_i2c_init(go
) < 0)
147 go
->i2c_adapter_online
= 1;
150 EXPORT_SYMBOL(go7007_boot_encoder
);
153 * Configure any hardware-related registers in the GO7007, such as GPIO
154 * pins and bus parameters, which are board-specific. This assumes
155 * the boot firmware has already been downloaded.
157 * Must be called with the hw_lock held.
159 static int go7007_init_encoder(struct go7007
*go
)
161 if (go
->board_info
->audio_flags
& GO7007_AUDIO_I2S_MASTER
) {
162 go7007_write_addr(go
, 0x1000, 0x0811);
163 go7007_write_addr(go
, 0x1000, 0x0c11);
165 switch (go
->board_id
) {
166 case GO7007_BOARDID_MATRIX_REV
:
167 /* Set GPIO pin 0 to be an output (audio clock control) */
168 go7007_write_addr(go
, 0x3c82, 0x0001);
169 go7007_write_addr(go
, 0x3c80, 0x00fe);
171 case GO7007_BOARDID_ADLINK_MPG24
:
172 /* set GPIO5 to be an output, currently low */
173 go7007_write_addr(go
, 0x3c82, 0x0000);
174 go7007_write_addr(go
, 0x3c80, 0x00df);
176 case GO7007_BOARDID_ADS_USBAV_709
:
177 /* GPIO pin 0: audio clock control */
178 /* pin 2: TW9906 reset */
179 /* pin 3: capture LED */
180 go7007_write_addr(go
, 0x3c82, 0x000d);
181 go7007_write_addr(go
, 0x3c80, 0x00f2);
188 * Send the boot firmware to the GO7007 and configure the registers. This
189 * is the only way to stop the encoder once it has started streaming video.
191 * Must be called with the hw_lock held.
193 int go7007_reset_encoder(struct go7007
*go
)
195 if (go7007_load_encoder(go
) < 0)
197 return go7007_init_encoder(go
);
201 * Attempt to instantiate an I2C client by ID, probably loading a module.
203 static int init_i2c_module(struct i2c_adapter
*adapter
, const struct go_i2c
*const i2c
)
205 struct go7007
*go
= i2c_get_adapdata(adapter
);
206 struct v4l2_device
*v4l2_dev
= &go
->v4l2_dev
;
207 struct v4l2_subdev
*sd
;
208 struct i2c_board_info info
;
210 memset(&info
, 0, sizeof(info
));
211 strlcpy(info
.type
, i2c
->type
, sizeof(info
.type
));
212 info
.addr
= i2c
->addr
;
213 info
.flags
= i2c
->flags
;
215 sd
= v4l2_i2c_new_subdev_board(v4l2_dev
, adapter
, &info
, NULL
);
224 pr_info("go7007: probing for module i2c:%s failed\n", i2c
->type
);
229 * Detach and unregister the encoder. The go7007 struct won't be freed
230 * until v4l2 finishes releasing its resources and all associated fds are
231 * closed by applications.
233 static void go7007_remove(struct v4l2_device
*v4l2_dev
)
235 struct go7007
*go
= container_of(v4l2_dev
, struct go7007
, v4l2_dev
);
237 v4l2_device_unregister(v4l2_dev
);
238 if (go
->hpi_ops
->release
)
239 go
->hpi_ops
->release(go
);
240 if (go
->i2c_adapter_online
) {
241 i2c_del_adapter(&go
->i2c_adapter
);
242 go
->i2c_adapter_online
= 0;
246 go7007_v4l2_remove(go
);
251 * Finalize the GO7007 hardware setup, register the on-board I2C adapter
252 * (if used on this board), load the I2C client driver for the sensor
253 * (SAA7115 or whatever) and other devices, and register the ALSA and V4L2
256 * Must NOT be called with the hw_lock held.
258 int go7007_register_encoder(struct go7007
*go
, unsigned num_i2c_devs
)
262 dev_info(go
->dev
, "go7007: registering new %s\n", go
->name
);
264 go
->v4l2_dev
.release
= go7007_remove
;
265 ret
= v4l2_device_register(go
->dev
, &go
->v4l2_dev
);
269 mutex_lock(&go
->hw_lock
);
270 ret
= go7007_init_encoder(go
);
271 mutex_unlock(&go
->hw_lock
);
275 ret
= go7007_v4l2_ctrl_init(go
);
279 if (!go
->i2c_adapter_online
&&
280 go
->board_info
->flags
& GO7007_BOARD_USE_ONBOARD_I2C
) {
281 ret
= go7007_i2c_init(go
);
284 go
->i2c_adapter_online
= 1;
286 if (go
->i2c_adapter_online
) {
287 if (go
->board_id
== GO7007_BOARDID_ADS_USBAV_709
) {
288 /* Reset the TW9906 */
289 go7007_write_addr(go
, 0x3c82, 0x0009);
291 go7007_write_addr(go
, 0x3c82, 0x000d);
293 for (i
= 0; i
< num_i2c_devs
; ++i
)
294 init_i2c_module(&go
->i2c_adapter
, &go
->board_info
->i2c_devs
[i
]);
296 if (go
->tuner_type
>= 0) {
297 struct tuner_setup setup
= {
299 .type
= go
->tuner_type
,
300 .mode_mask
= T_ANALOG_TV
,
303 v4l2_device_call_all(&go
->v4l2_dev
, 0, tuner
,
304 s_type_addr
, &setup
);
306 if (go
->board_id
== GO7007_BOARDID_ADLINK_MPG24
)
307 v4l2_subdev_call(go
->sd_video
, video
, s_routing
,
308 0, 0, go
->channel_number
+ 1);
311 ret
= go7007_v4l2_init(go
);
315 if (go
->board_info
->flags
& GO7007_BOARD_HAS_AUDIO
) {
316 go
->audio_enabled
= 1;
321 EXPORT_SYMBOL(go7007_register_encoder
);
324 * Send the encode firmware to the encoder, which will cause it
325 * to immediately start delivering the video and audio streams.
327 * Must be called with the hw_lock held.
329 int go7007_start_encoder(struct go7007
*go
)
332 int fw_len
, rv
= 0, i
, x
, y
;
333 u16 intr_val
, intr_data
;
335 go
->modet_enable
= 0;
336 for (i
= 0; i
< 4; i
++)
337 go
->modet
[i
].enable
= 0;
339 switch (v4l2_ctrl_g_ctrl(go
->modet_mode
)) {
340 case V4L2_DETECT_MD_MODE_GLOBAL
:
341 memset(go
->modet_map
, 0, sizeof(go
->modet_map
));
342 go
->modet
[0].enable
= 1;
343 go
->modet_enable
= 1;
345 case V4L2_DETECT_MD_MODE_REGION_GRID
:
346 for (y
= 0; y
< go
->height
/ 16; y
++) {
347 for (x
= 0; x
< go
->width
/ 16; x
++) {
348 int idx
= y
* go
->width
/ 16 + x
;
350 go
->modet
[go
->modet_map
[idx
]].enable
= 1;
353 go
->modet_enable
= 1;
358 go
->modet_enable
= 0;
360 if (go7007_construct_fw_image(go
, &fw
, &fw_len
) < 0)
363 if (go7007_send_firmware(go
, fw
, fw_len
) < 0 ||
364 go7007_read_interrupt(go
, &intr_val
, &intr_data
) < 0) {
365 v4l2_err(&go
->v4l2_dev
, "error transferring firmware\n");
370 go
->state
= STATE_DATA
;
371 go
->parse_length
= 0;
373 if (go7007_stream_start(go
) < 0) {
374 v4l2_err(&go
->v4l2_dev
, "error starting stream transfer\n");
385 * Store a byte in the current video buffer, if there is one.
387 static inline void store_byte(struct go7007_buffer
*vb
, u8 byte
)
389 if (vb
&& vb
->vb
.vb2_buf
.planes
[0].bytesused
< GO7007_BUF_SIZE
) {
390 u8
*ptr
= vb2_plane_vaddr(&vb
->vb
.vb2_buf
, 0);
392 ptr
[vb
->vb
.vb2_buf
.planes
[0].bytesused
++] = byte
;
396 static void go7007_set_motion_regions(struct go7007
*go
, struct go7007_buffer
*vb
,
399 if (motion_regions
!= go
->modet_event_status
) {
400 struct v4l2_event ev
= {
401 .type
= V4L2_EVENT_MOTION_DET
,
403 .flags
= V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ
,
404 .frame_sequence
= vb
->vb
.sequence
,
405 .region_mask
= motion_regions
,
409 v4l2_event_queue(&go
->vdev
, &ev
);
410 go
->modet_event_status
= motion_regions
;
415 * Determine regions with motion and send a motion detection event
416 * in case of changes.
418 static void go7007_motion_regions(struct go7007
*go
, struct go7007_buffer
*vb
)
420 u32
*bytesused
= &vb
->vb
.vb2_buf
.planes
[0].bytesused
;
421 unsigned motion
[4] = { 0, 0, 0, 0 };
422 u32 motion_regions
= 0;
423 unsigned stride
= (go
->width
+ 7) >> 3;
427 for (i
= 0; i
< 216; ++i
)
428 store_byte(vb
, go
->active_map
[i
]);
429 for (y
= 0; y
< go
->height
/ 16; y
++) {
430 for (x
= 0; x
< go
->width
/ 16; x
++) {
431 if (!(go
->active_map
[y
* stride
+ (x
>> 3)] & (1 << (x
& 7))))
433 motion
[go
->modet_map
[y
* (go
->width
/ 16) + x
]]++;
436 motion_regions
= ((motion
[0] > 0) << 0) |
437 ((motion
[1] > 0) << 1) |
438 ((motion
[2] > 0) << 2) |
439 ((motion
[3] > 0) << 3);
441 go7007_set_motion_regions(go
, vb
, motion_regions
);
445 * Deliver the last video buffer and get a new one to start writing to.
447 static struct go7007_buffer
*frame_boundary(struct go7007
*go
, struct go7007_buffer
*vb
)
450 struct go7007_buffer
*vb_tmp
= NULL
;
454 spin_lock_irqsave(&go
->spinlock
, flags
);
455 if (!list_empty(&go
->vidq_active
))
456 vb
= go
->active_buf
=
457 list_first_entry(&go
->vidq_active
, struct go7007_buffer
, list
);
458 spin_unlock_irqrestore(&go
->spinlock
, flags
);
462 bytesused
= &vb
->vb
.vb2_buf
.planes
[0].bytesused
;
464 vb
->vb
.sequence
= go
->next_seq
++;
465 if (vb
->modet_active
&& *bytesused
+ 216 < GO7007_BUF_SIZE
)
466 go7007_motion_regions(go
, vb
);
468 go7007_set_motion_regions(go
, vb
, 0);
470 vb
->vb
.vb2_buf
.timestamp
= ktime_get_ns();
472 spin_lock_irqsave(&go
->spinlock
, flags
);
474 if (list_empty(&go
->vidq_active
))
477 vb
= list_first_entry(&go
->vidq_active
,
478 struct go7007_buffer
, list
);
480 spin_unlock_irqrestore(&go
->spinlock
, flags
);
481 vb2_buffer_done(&vb_tmp
->vb
.vb2_buf
, VB2_BUF_STATE_DONE
);
485 static void write_bitmap_word(struct go7007
*go
)
487 int x
, y
, i
, stride
= ((go
->width
>> 4) + 7) >> 3;
489 for (i
= 0; i
< 16; ++i
) {
490 y
= (((go
->parse_length
- 1) << 3) + i
) / (go
->width
>> 4);
491 x
= (((go
->parse_length
- 1) << 3) + i
) % (go
->width
>> 4);
492 if (stride
* y
+ (x
>> 3) < sizeof(go
->active_map
))
493 go
->active_map
[stride
* y
+ (x
>> 3)] |=
494 (go
->modet_word
& 1) << (x
& 0x7);
495 go
->modet_word
>>= 1;
500 * Parse a chunk of the video stream into frames. The frames are not
501 * delimited by the hardware, so we have to parse the frame boundaries
502 * based on the type of video stream we're receiving.
504 void go7007_parse_video_stream(struct go7007
*go
, u8
*buf
, int length
)
506 struct go7007_buffer
*vb
= go
->active_buf
;
507 int i
, seq_start_code
= -1, gop_start_code
= -1, frame_start_code
= -1;
509 switch (go
->format
) {
510 case V4L2_PIX_FMT_MPEG4
:
511 seq_start_code
= 0xB0;
512 gop_start_code
= 0xB3;
513 frame_start_code
= 0xB6;
515 case V4L2_PIX_FMT_MPEG1
:
516 case V4L2_PIX_FMT_MPEG2
:
517 seq_start_code
= 0xB3;
518 gop_start_code
= 0xB8;
519 frame_start_code
= 0x00;
523 for (i
= 0; i
< length
; ++i
) {
524 if (vb
&& vb
->vb
.vb2_buf
.planes
[0].bytesused
>=
525 GO7007_BUF_SIZE
- 3) {
526 v4l2_info(&go
->v4l2_dev
, "dropping oversized frame\n");
527 vb
->vb
.vb2_buf
.planes
[0].bytesused
= 0;
528 vb
->frame_offset
= 0;
529 vb
->modet_active
= 0;
530 vb
= go
->active_buf
= NULL
;
537 go
->state
= STATE_00
;
540 go
->state
= STATE_FF
;
543 store_byte(vb
, buf
[i
]);
550 go
->state
= STATE_00_00
;
553 store_byte(vb
, 0x00);
554 go
->state
= STATE_FF
;
557 store_byte(vb
, 0x00);
558 store_byte(vb
, buf
[i
]);
559 go
->state
= STATE_DATA
;
566 store_byte(vb
, 0x00);
567 /* go->state remains STATE_00_00 */
570 go
->state
= STATE_00_00_01
;
573 store_byte(vb
, 0x00);
574 store_byte(vb
, 0x00);
575 go
->state
= STATE_FF
;
578 store_byte(vb
, 0x00);
579 store_byte(vb
, 0x00);
580 store_byte(vb
, buf
[i
]);
581 go
->state
= STATE_DATA
;
586 if (buf
[i
] == 0xF8 && go
->modet_enable
== 0) {
587 /* MODET start code, but MODET not enabled */
588 store_byte(vb
, 0x00);
589 store_byte(vb
, 0x00);
590 store_byte(vb
, 0x01);
591 store_byte(vb
, 0xF8);
592 go
->state
= STATE_DATA
;
595 /* If this is the start of a new MPEG frame,
596 * get a new buffer */
597 if ((go
->format
== V4L2_PIX_FMT_MPEG1
||
598 go
->format
== V4L2_PIX_FMT_MPEG2
||
599 go
->format
== V4L2_PIX_FMT_MPEG4
) &&
600 (buf
[i
] == seq_start_code
||
601 buf
[i
] == gop_start_code
||
602 buf
[i
] == frame_start_code
)) {
603 if (vb
== NULL
|| go
->seen_frame
)
604 vb
= frame_boundary(go
, vb
);
605 go
->seen_frame
= buf
[i
] == frame_start_code
;
606 if (vb
&& go
->seen_frame
)
608 vb
->vb
.vb2_buf
.planes
[0].bytesused
;
610 /* Handle any special chunk types, or just write the
611 * start code to the (potentially new) buffer */
613 case 0xF5: /* timestamp */
614 go
->parse_length
= 12;
615 go
->state
= STATE_UNPARSED
;
618 go
->state
= STATE_VBI_LEN_A
;
620 case 0xF8: /* MD map */
621 go
->parse_length
= 0;
622 memset(go
->active_map
, 0,
623 sizeof(go
->active_map
));
624 go
->state
= STATE_MODET_MAP
;
626 case 0xFF: /* Potential JPEG start code */
627 store_byte(vb
, 0x00);
628 store_byte(vb
, 0x00);
629 store_byte(vb
, 0x01);
630 go
->state
= STATE_FF
;
633 store_byte(vb
, 0x00);
634 store_byte(vb
, 0x00);
635 store_byte(vb
, 0x01);
636 store_byte(vb
, buf
[i
]);
637 go
->state
= STATE_DATA
;
644 store_byte(vb
, 0xFF);
645 go
->state
= STATE_00
;
648 store_byte(vb
, 0xFF);
649 /* go->state remains STATE_FF */
652 if (go
->format
== V4L2_PIX_FMT_MJPEG
)
653 vb
= frame_boundary(go
, vb
);
656 store_byte(vb
, 0xFF);
657 store_byte(vb
, buf
[i
]);
658 go
->state
= STATE_DATA
;
662 case STATE_VBI_LEN_A
:
663 go
->parse_length
= buf
[i
] << 8;
664 go
->state
= STATE_VBI_LEN_B
;
666 case STATE_VBI_LEN_B
:
667 go
->parse_length
|= buf
[i
];
668 if (go
->parse_length
> 0)
669 go
->state
= STATE_UNPARSED
;
671 go
->state
= STATE_DATA
;
673 case STATE_MODET_MAP
:
674 if (go
->parse_length
< 204) {
675 if (go
->parse_length
& 1) {
676 go
->modet_word
|= buf
[i
];
677 write_bitmap_word(go
);
679 go
->modet_word
= buf
[i
] << 8;
680 } else if (go
->parse_length
== 207 && vb
) {
681 vb
->modet_active
= buf
[i
];
683 if (++go
->parse_length
== 208)
684 go
->state
= STATE_DATA
;
687 if (--go
->parse_length
== 0)
688 go
->state
= STATE_DATA
;
693 EXPORT_SYMBOL(go7007_parse_video_stream
);
696 * Allocate a new go7007 struct. Used by the hardware-specific probe.
698 struct go7007
*go7007_alloc(const struct go7007_board_info
*board
,
704 go
= kzalloc(sizeof(struct go7007
), GFP_KERNEL
);
708 go
->board_info
= board
;
711 go
->channel_number
= 0;
713 mutex_init(&go
->hw_lock
);
714 init_waitqueue_head(&go
->frame_waitq
);
715 spin_lock_init(&go
->spinlock
);
716 go
->status
= STATUS_INIT
;
717 memset(&go
->i2c_adapter
, 0, sizeof(go
->i2c_adapter
));
718 go
->i2c_adapter_online
= 0;
719 go
->interrupt_available
= 0;
720 init_waitqueue_head(&go
->interrupt_waitq
);
722 go7007_update_board(go
);
723 go
->encoder_h_halve
= 0;
724 go
->encoder_v_halve
= 0;
725 go
->encoder_subsample
= 0;
726 go
->format
= V4L2_PIX_FMT_MJPEG
;
727 go
->bitrate
= 1500000;
730 go
->aspect_ratio
= GO7007_RATIO_1_1
;
734 go
->repeat_seqhead
= 0;
735 go
->seq_header_enable
= 0;
736 go
->gop_header_enable
= 0;
738 go
->interlace_coding
= 0;
739 for (i
= 0; i
< 4; ++i
)
740 go
->modet
[i
].enable
= 0;
741 for (i
= 0; i
< 1624; ++i
)
742 go
->modet_map
[i
] = 0;
743 go
->audio_deliver
= NULL
;
744 go
->audio_enabled
= 0;
748 EXPORT_SYMBOL(go7007_alloc
);
750 void go7007_update_board(struct go7007
*go
)
752 const struct go7007_board_info
*board
= go
->board_info
;
754 if (board
->sensor_flags
& GO7007_SENSOR_TV
) {
755 go
->standard
= GO7007_STD_NTSC
;
756 go
->std
= V4L2_STD_NTSC_M
;
759 go
->sensor_framerate
= 30000;
761 go
->standard
= GO7007_STD_OTHER
;
762 go
->width
= board
->sensor_width
;
763 go
->height
= board
->sensor_height
;
764 go
->sensor_framerate
= board
->sensor_framerate
;
766 go
->encoder_v_offset
= board
->sensor_v_offset
;
767 go
->encoder_h_offset
= board
->sensor_h_offset
;
769 EXPORT_SYMBOL(go7007_update_board
);
771 MODULE_LICENSE("GPL v2");