1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2005-2006 Micronas USA Inc.
6 #include <linux/module.h>
7 #include <linux/delay.h>
8 #include <linux/sched.h>
9 #include <linux/spinlock.h>
10 #include <linux/unistd.h>
11 #include <linux/time.h>
13 #include <linux/vmalloc.h>
14 #include <linux/device.h>
15 #include <linux/i2c.h>
16 #include <linux/firmware.h>
17 #include <linux/mutex.h>
18 #include <linux/uaccess.h>
19 #include <linux/slab.h>
20 #include <linux/videodev2.h>
21 #include <media/tuner.h>
22 #include <media/v4l2-common.h>
23 #include <media/v4l2-event.h>
25 #include "go7007-priv.h"
28 * Wait for an interrupt to be delivered from the GO7007SB and return
29 * the associated value and data.
31 * Must be called with the hw_lock held.
33 int go7007_read_interrupt(struct go7007
*go
, u16
*value
, u16
*data
)
35 go
->interrupt_available
= 0;
36 go
->hpi_ops
->read_interrupt(go
);
37 if (wait_event_timeout(go
->interrupt_waitq
,
38 go
->interrupt_available
, 5*HZ
) < 0) {
39 v4l2_err(&go
->v4l2_dev
, "timeout waiting for read interrupt\n");
42 if (!go
->interrupt_available
)
44 go
->interrupt_available
= 0;
45 *value
= go
->interrupt_value
& 0xfffe;
46 *data
= go
->interrupt_data
;
49 EXPORT_SYMBOL(go7007_read_interrupt
);
52 * Read a register/address on the GO7007SB.
54 * Must be called with the hw_lock held.
56 int go7007_read_addr(struct go7007
*go
, u16 addr
, u16
*data
)
61 if (go7007_write_interrupt(go
, 0x0010, addr
) < 0)
64 if (go7007_read_interrupt(go
, &value
, data
) == 0 &&
70 EXPORT_SYMBOL(go7007_read_addr
);
73 * Send the boot firmware to the encoder, which just wakes it up and lets
74 * us talk to the GPIO pins and on-board I2C adapter.
76 * Must be called with the hw_lock held.
78 static int go7007_load_encoder(struct go7007
*go
)
80 const struct firmware
*fw_entry
;
81 char fw_name
[] = "go7007/go7007fw.bin";
84 u16 intr_val
, intr_data
;
86 if (go
->boot_fw
== NULL
) {
87 if (request_firmware(&fw_entry
, fw_name
, go
->dev
)) {
88 v4l2_err(go
, "unable to load firmware from file \"%s\"\n", fw_name
);
91 if (fw_entry
->size
< 16 || memcmp(fw_entry
->data
, "WISGO7007FW", 11)) {
92 v4l2_err(go
, "file \"%s\" does not appear to be go7007 firmware\n", fw_name
);
93 release_firmware(fw_entry
);
96 fw_len
= fw_entry
->size
- 16;
97 bounce
= kmemdup(fw_entry
->data
+ 16, fw_len
, GFP_KERNEL
);
99 v4l2_err(go
, "unable to allocate %d bytes for firmware transfer\n", fw_len
);
100 release_firmware(fw_entry
);
103 release_firmware(fw_entry
);
104 go
->boot_fw_len
= fw_len
;
105 go
->boot_fw
= bounce
;
107 if (go7007_interface_reset(go
) < 0 ||
108 go7007_send_firmware(go
, go
->boot_fw
, go
->boot_fw_len
) < 0 ||
109 go7007_read_interrupt(go
, &intr_val
, &intr_data
) < 0 ||
110 (intr_val
& ~0x1) != 0x5a5a) {
111 v4l2_err(go
, "error transferring firmware\n");
117 MODULE_FIRMWARE("go7007/go7007fw.bin");
120 * Boot the encoder and register the I2C adapter if requested. Do the
121 * minimum initialization necessary, since the board-specific code may
122 * still need to probe the board ID.
124 * Must NOT be called with the hw_lock held.
126 int go7007_boot_encoder(struct go7007
*go
, int init_i2c
)
130 mutex_lock(&go
->hw_lock
);
131 ret
= go7007_load_encoder(go
);
132 mutex_unlock(&go
->hw_lock
);
137 if (go7007_i2c_init(go
) < 0)
139 go
->i2c_adapter_online
= 1;
142 EXPORT_SYMBOL(go7007_boot_encoder
);
145 * Configure any hardware-related registers in the GO7007, such as GPIO
146 * pins and bus parameters, which are board-specific. This assumes
147 * the boot firmware has already been downloaded.
149 * Must be called with the hw_lock held.
151 static int go7007_init_encoder(struct go7007
*go
)
153 if (go
->board_info
->audio_flags
& GO7007_AUDIO_I2S_MASTER
) {
154 go7007_write_addr(go
, 0x1000, 0x0811);
155 go7007_write_addr(go
, 0x1000, 0x0c11);
157 switch (go
->board_id
) {
158 case GO7007_BOARDID_MATRIX_REV
:
159 /* Set GPIO pin 0 to be an output (audio clock control) */
160 go7007_write_addr(go
, 0x3c82, 0x0001);
161 go7007_write_addr(go
, 0x3c80, 0x00fe);
163 case GO7007_BOARDID_ADLINK_MPG24
:
164 /* set GPIO5 to be an output, currently low */
165 go7007_write_addr(go
, 0x3c82, 0x0000);
166 go7007_write_addr(go
, 0x3c80, 0x00df);
168 case GO7007_BOARDID_ADS_USBAV_709
:
169 /* GPIO pin 0: audio clock control */
170 /* pin 2: TW9906 reset */
171 /* pin 3: capture LED */
172 go7007_write_addr(go
, 0x3c82, 0x000d);
173 go7007_write_addr(go
, 0x3c80, 0x00f2);
180 * Send the boot firmware to the GO7007 and configure the registers. This
181 * is the only way to stop the encoder once it has started streaming video.
183 * Must be called with the hw_lock held.
185 int go7007_reset_encoder(struct go7007
*go
)
187 if (go7007_load_encoder(go
) < 0)
189 return go7007_init_encoder(go
);
193 * Attempt to instantiate an I2C client by ID, probably loading a module.
195 static int init_i2c_module(struct i2c_adapter
*adapter
, const struct go_i2c
*const i2c
)
197 struct go7007
*go
= i2c_get_adapdata(adapter
);
198 struct v4l2_device
*v4l2_dev
= &go
->v4l2_dev
;
199 struct v4l2_subdev
*sd
;
200 struct i2c_board_info info
;
202 memset(&info
, 0, sizeof(info
));
203 strscpy(info
.type
, i2c
->type
, sizeof(info
.type
));
204 info
.addr
= i2c
->addr
;
205 info
.flags
= i2c
->flags
;
207 sd
= v4l2_i2c_new_subdev_board(v4l2_dev
, adapter
, &info
, NULL
);
216 pr_info("go7007: probing for module i2c:%s failed\n", i2c
->type
);
221 * Detach and unregister the encoder. The go7007 struct won't be freed
222 * until v4l2 finishes releasing its resources and all associated fds are
223 * closed by applications.
225 static void go7007_remove(struct v4l2_device
*v4l2_dev
)
227 struct go7007
*go
= container_of(v4l2_dev
, struct go7007
, v4l2_dev
);
229 v4l2_device_unregister(v4l2_dev
);
230 if (go
->hpi_ops
->release
)
231 go
->hpi_ops
->release(go
);
232 if (go
->i2c_adapter_online
) {
233 i2c_del_adapter(&go
->i2c_adapter
);
234 go
->i2c_adapter_online
= 0;
238 go7007_v4l2_remove(go
);
243 * Finalize the GO7007 hardware setup, register the on-board I2C adapter
244 * (if used on this board), load the I2C client driver for the sensor
245 * (SAA7115 or whatever) and other devices, and register the ALSA and V4L2
248 * Must NOT be called with the hw_lock held.
250 int go7007_register_encoder(struct go7007
*go
, unsigned num_i2c_devs
)
254 dev_info(go
->dev
, "go7007: registering new %s\n", go
->name
);
256 go
->v4l2_dev
.release
= go7007_remove
;
257 ret
= v4l2_device_register(go
->dev
, &go
->v4l2_dev
);
261 mutex_lock(&go
->hw_lock
);
262 ret
= go7007_init_encoder(go
);
263 mutex_unlock(&go
->hw_lock
);
267 ret
= go7007_v4l2_ctrl_init(go
);
271 if (!go
->i2c_adapter_online
&&
272 go
->board_info
->flags
& GO7007_BOARD_USE_ONBOARD_I2C
) {
273 ret
= go7007_i2c_init(go
);
276 go
->i2c_adapter_online
= 1;
278 if (go
->i2c_adapter_online
) {
279 if (go
->board_id
== GO7007_BOARDID_ADS_USBAV_709
) {
280 /* Reset the TW9906 */
281 go7007_write_addr(go
, 0x3c82, 0x0009);
283 go7007_write_addr(go
, 0x3c82, 0x000d);
285 for (i
= 0; i
< num_i2c_devs
; ++i
)
286 init_i2c_module(&go
->i2c_adapter
, &go
->board_info
->i2c_devs
[i
]);
288 if (go
->tuner_type
>= 0) {
289 struct tuner_setup setup
= {
291 .type
= go
->tuner_type
,
292 .mode_mask
= T_ANALOG_TV
,
295 v4l2_device_call_all(&go
->v4l2_dev
, 0, tuner
,
296 s_type_addr
, &setup
);
298 if (go
->board_id
== GO7007_BOARDID_ADLINK_MPG24
)
299 v4l2_subdev_call(go
->sd_video
, video
, s_routing
,
300 0, 0, go
->channel_number
+ 1);
303 ret
= go7007_v4l2_init(go
);
307 if (go
->board_info
->flags
& GO7007_BOARD_HAS_AUDIO
) {
308 go
->audio_enabled
= 1;
313 EXPORT_SYMBOL(go7007_register_encoder
);
316 * Send the encode firmware to the encoder, which will cause it
317 * to immediately start delivering the video and audio streams.
319 * Must be called with the hw_lock held.
321 int go7007_start_encoder(struct go7007
*go
)
324 int fw_len
, rv
= 0, i
, x
, y
;
325 u16 intr_val
, intr_data
;
327 go
->modet_enable
= 0;
328 for (i
= 0; i
< 4; i
++)
329 go
->modet
[i
].enable
= 0;
331 switch (v4l2_ctrl_g_ctrl(go
->modet_mode
)) {
332 case V4L2_DETECT_MD_MODE_GLOBAL
:
333 memset(go
->modet_map
, 0, sizeof(go
->modet_map
));
334 go
->modet
[0].enable
= 1;
335 go
->modet_enable
= 1;
337 case V4L2_DETECT_MD_MODE_REGION_GRID
:
338 for (y
= 0; y
< go
->height
/ 16; y
++) {
339 for (x
= 0; x
< go
->width
/ 16; x
++) {
340 int idx
= y
* go
->width
/ 16 + x
;
342 go
->modet
[go
->modet_map
[idx
]].enable
= 1;
345 go
->modet_enable
= 1;
350 go
->modet_enable
= 0;
352 if (go7007_construct_fw_image(go
, &fw
, &fw_len
) < 0)
355 if (go7007_send_firmware(go
, fw
, fw_len
) < 0 ||
356 go7007_read_interrupt(go
, &intr_val
, &intr_data
) < 0) {
357 v4l2_err(&go
->v4l2_dev
, "error transferring firmware\n");
362 go
->state
= STATE_DATA
;
363 go
->parse_length
= 0;
365 if (go7007_stream_start(go
) < 0) {
366 v4l2_err(&go
->v4l2_dev
, "error starting stream transfer\n");
377 * Store a byte in the current video buffer, if there is one.
379 static inline void store_byte(struct go7007_buffer
*vb
, u8 byte
)
381 if (vb
&& vb
->vb
.vb2_buf
.planes
[0].bytesused
< GO7007_BUF_SIZE
) {
382 u8
*ptr
= vb2_plane_vaddr(&vb
->vb
.vb2_buf
, 0);
384 ptr
[vb
->vb
.vb2_buf
.planes
[0].bytesused
++] = byte
;
388 static void go7007_set_motion_regions(struct go7007
*go
, struct go7007_buffer
*vb
,
391 if (motion_regions
!= go
->modet_event_status
) {
392 struct v4l2_event ev
= {
393 .type
= V4L2_EVENT_MOTION_DET
,
395 .flags
= V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ
,
396 .frame_sequence
= vb
->vb
.sequence
,
397 .region_mask
= motion_regions
,
401 v4l2_event_queue(&go
->vdev
, &ev
);
402 go
->modet_event_status
= motion_regions
;
407 * Determine regions with motion and send a motion detection event
408 * in case of changes.
410 static void go7007_motion_regions(struct go7007
*go
, struct go7007_buffer
*vb
)
412 u32
*bytesused
= &vb
->vb
.vb2_buf
.planes
[0].bytesused
;
413 unsigned motion
[4] = { 0, 0, 0, 0 };
414 u32 motion_regions
= 0;
415 unsigned stride
= (go
->width
+ 7) >> 3;
419 for (i
= 0; i
< 216; ++i
)
420 store_byte(vb
, go
->active_map
[i
]);
421 for (y
= 0; y
< go
->height
/ 16; y
++) {
422 for (x
= 0; x
< go
->width
/ 16; x
++) {
423 if (!(go
->active_map
[y
* stride
+ (x
>> 3)] & (1 << (x
& 7))))
425 motion
[go
->modet_map
[y
* (go
->width
/ 16) + x
]]++;
428 motion_regions
= ((motion
[0] > 0) << 0) |
429 ((motion
[1] > 0) << 1) |
430 ((motion
[2] > 0) << 2) |
431 ((motion
[3] > 0) << 3);
433 go7007_set_motion_regions(go
, vb
, motion_regions
);
437 * Deliver the last video buffer and get a new one to start writing to.
439 static struct go7007_buffer
*frame_boundary(struct go7007
*go
, struct go7007_buffer
*vb
)
442 struct go7007_buffer
*vb_tmp
= NULL
;
446 spin_lock_irqsave(&go
->spinlock
, flags
);
447 if (!list_empty(&go
->vidq_active
))
448 vb
= go
->active_buf
=
449 list_first_entry(&go
->vidq_active
, struct go7007_buffer
, list
);
450 spin_unlock_irqrestore(&go
->spinlock
, flags
);
454 bytesused
= &vb
->vb
.vb2_buf
.planes
[0].bytesused
;
456 vb
->vb
.sequence
= go
->next_seq
++;
457 if (vb
->modet_active
&& *bytesused
+ 216 < GO7007_BUF_SIZE
)
458 go7007_motion_regions(go
, vb
);
460 go7007_set_motion_regions(go
, vb
, 0);
462 vb
->vb
.vb2_buf
.timestamp
= ktime_get_ns();
464 spin_lock_irqsave(&go
->spinlock
, flags
);
466 if (list_empty(&go
->vidq_active
))
469 vb
= list_first_entry(&go
->vidq_active
,
470 struct go7007_buffer
, list
);
472 spin_unlock_irqrestore(&go
->spinlock
, flags
);
473 vb2_buffer_done(&vb_tmp
->vb
.vb2_buf
, VB2_BUF_STATE_DONE
);
477 static void write_bitmap_word(struct go7007
*go
)
479 int x
, y
, i
, stride
= ((go
->width
>> 4) + 7) >> 3;
481 for (i
= 0; i
< 16; ++i
) {
482 y
= (((go
->parse_length
- 1) << 3) + i
) / (go
->width
>> 4);
483 x
= (((go
->parse_length
- 1) << 3) + i
) % (go
->width
>> 4);
484 if (stride
* y
+ (x
>> 3) < sizeof(go
->active_map
))
485 go
->active_map
[stride
* y
+ (x
>> 3)] |=
486 (go
->modet_word
& 1) << (x
& 0x7);
487 go
->modet_word
>>= 1;
492 * Parse a chunk of the video stream into frames. The frames are not
493 * delimited by the hardware, so we have to parse the frame boundaries
494 * based on the type of video stream we're receiving.
496 void go7007_parse_video_stream(struct go7007
*go
, u8
*buf
, int length
)
498 struct go7007_buffer
*vb
= go
->active_buf
;
499 int i
, seq_start_code
= -1, gop_start_code
= -1, frame_start_code
= -1;
501 switch (go
->format
) {
502 case V4L2_PIX_FMT_MPEG4
:
503 seq_start_code
= 0xB0;
504 gop_start_code
= 0xB3;
505 frame_start_code
= 0xB6;
507 case V4L2_PIX_FMT_MPEG1
:
508 case V4L2_PIX_FMT_MPEG2
:
509 seq_start_code
= 0xB3;
510 gop_start_code
= 0xB8;
511 frame_start_code
= 0x00;
515 for (i
= 0; i
< length
; ++i
) {
516 if (vb
&& vb
->vb
.vb2_buf
.planes
[0].bytesused
>=
517 GO7007_BUF_SIZE
- 3) {
518 v4l2_info(&go
->v4l2_dev
, "dropping oversized frame\n");
519 vb
->vb
.vb2_buf
.planes
[0].bytesused
= 0;
520 vb
->frame_offset
= 0;
521 vb
->modet_active
= 0;
522 vb
= go
->active_buf
= NULL
;
529 go
->state
= STATE_00
;
532 go
->state
= STATE_FF
;
535 store_byte(vb
, buf
[i
]);
542 go
->state
= STATE_00_00
;
545 store_byte(vb
, 0x00);
546 go
->state
= STATE_FF
;
549 store_byte(vb
, 0x00);
550 store_byte(vb
, buf
[i
]);
551 go
->state
= STATE_DATA
;
558 store_byte(vb
, 0x00);
559 /* go->state remains STATE_00_00 */
562 go
->state
= STATE_00_00_01
;
565 store_byte(vb
, 0x00);
566 store_byte(vb
, 0x00);
567 go
->state
= STATE_FF
;
570 store_byte(vb
, 0x00);
571 store_byte(vb
, 0x00);
572 store_byte(vb
, buf
[i
]);
573 go
->state
= STATE_DATA
;
578 if (buf
[i
] == 0xF8 && go
->modet_enable
== 0) {
579 /* MODET start code, but MODET not enabled */
580 store_byte(vb
, 0x00);
581 store_byte(vb
, 0x00);
582 store_byte(vb
, 0x01);
583 store_byte(vb
, 0xF8);
584 go
->state
= STATE_DATA
;
587 /* If this is the start of a new MPEG frame,
588 * get a new buffer */
589 if ((go
->format
== V4L2_PIX_FMT_MPEG1
||
590 go
->format
== V4L2_PIX_FMT_MPEG2
||
591 go
->format
== V4L2_PIX_FMT_MPEG4
) &&
592 (buf
[i
] == seq_start_code
||
593 buf
[i
] == gop_start_code
||
594 buf
[i
] == frame_start_code
)) {
595 if (vb
== NULL
|| go
->seen_frame
)
596 vb
= frame_boundary(go
, vb
);
597 go
->seen_frame
= buf
[i
] == frame_start_code
;
598 if (vb
&& go
->seen_frame
)
600 vb
->vb
.vb2_buf
.planes
[0].bytesused
;
602 /* Handle any special chunk types, or just write the
603 * start code to the (potentially new) buffer */
605 case 0xF5: /* timestamp */
606 go
->parse_length
= 12;
607 go
->state
= STATE_UNPARSED
;
610 go
->state
= STATE_VBI_LEN_A
;
612 case 0xF8: /* MD map */
613 go
->parse_length
= 0;
614 memset(go
->active_map
, 0,
615 sizeof(go
->active_map
));
616 go
->state
= STATE_MODET_MAP
;
618 case 0xFF: /* Potential JPEG start code */
619 store_byte(vb
, 0x00);
620 store_byte(vb
, 0x00);
621 store_byte(vb
, 0x01);
622 go
->state
= STATE_FF
;
625 store_byte(vb
, 0x00);
626 store_byte(vb
, 0x00);
627 store_byte(vb
, 0x01);
628 store_byte(vb
, buf
[i
]);
629 go
->state
= STATE_DATA
;
636 store_byte(vb
, 0xFF);
637 go
->state
= STATE_00
;
640 store_byte(vb
, 0xFF);
641 /* go->state remains STATE_FF */
644 if (go
->format
== V4L2_PIX_FMT_MJPEG
)
645 vb
= frame_boundary(go
, vb
);
648 store_byte(vb
, 0xFF);
649 store_byte(vb
, buf
[i
]);
650 go
->state
= STATE_DATA
;
654 case STATE_VBI_LEN_A
:
655 go
->parse_length
= buf
[i
] << 8;
656 go
->state
= STATE_VBI_LEN_B
;
658 case STATE_VBI_LEN_B
:
659 go
->parse_length
|= buf
[i
];
660 if (go
->parse_length
> 0)
661 go
->state
= STATE_UNPARSED
;
663 go
->state
= STATE_DATA
;
665 case STATE_MODET_MAP
:
666 if (go
->parse_length
< 204) {
667 if (go
->parse_length
& 1) {
668 go
->modet_word
|= buf
[i
];
669 write_bitmap_word(go
);
671 go
->modet_word
= buf
[i
] << 8;
672 } else if (go
->parse_length
== 207 && vb
) {
673 vb
->modet_active
= buf
[i
];
675 if (++go
->parse_length
== 208)
676 go
->state
= STATE_DATA
;
679 if (--go
->parse_length
== 0)
680 go
->state
= STATE_DATA
;
685 EXPORT_SYMBOL(go7007_parse_video_stream
);
688 * Allocate a new go7007 struct. Used by the hardware-specific probe.
690 struct go7007
*go7007_alloc(const struct go7007_board_info
*board
,
696 go
= kzalloc(sizeof(struct go7007
), GFP_KERNEL
);
700 go
->board_info
= board
;
703 go
->channel_number
= 0;
705 mutex_init(&go
->hw_lock
);
706 init_waitqueue_head(&go
->frame_waitq
);
707 spin_lock_init(&go
->spinlock
);
708 go
->status
= STATUS_INIT
;
709 memset(&go
->i2c_adapter
, 0, sizeof(go
->i2c_adapter
));
710 go
->i2c_adapter_online
= 0;
711 go
->interrupt_available
= 0;
712 init_waitqueue_head(&go
->interrupt_waitq
);
714 go7007_update_board(go
);
715 go
->encoder_h_halve
= 0;
716 go
->encoder_v_halve
= 0;
717 go
->encoder_subsample
= 0;
718 go
->format
= V4L2_PIX_FMT_MJPEG
;
719 go
->bitrate
= 1500000;
722 go
->aspect_ratio
= GO7007_RATIO_1_1
;
726 go
->repeat_seqhead
= 0;
727 go
->seq_header_enable
= 0;
728 go
->gop_header_enable
= 0;
730 go
->interlace_coding
= 0;
731 for (i
= 0; i
< 4; ++i
)
732 go
->modet
[i
].enable
= 0;
733 for (i
= 0; i
< 1624; ++i
)
734 go
->modet_map
[i
] = 0;
735 go
->audio_deliver
= NULL
;
736 go
->audio_enabled
= 0;
740 EXPORT_SYMBOL(go7007_alloc
);
742 void go7007_update_board(struct go7007
*go
)
744 const struct go7007_board_info
*board
= go
->board_info
;
746 if (board
->sensor_flags
& GO7007_SENSOR_TV
) {
747 go
->standard
= GO7007_STD_NTSC
;
748 go
->std
= V4L2_STD_NTSC_M
;
751 go
->sensor_framerate
= 30000;
753 go
->standard
= GO7007_STD_OTHER
;
754 go
->width
= board
->sensor_width
;
755 go
->height
= board
->sensor_height
;
756 go
->sensor_framerate
= board
->sensor_framerate
;
758 go
->encoder_v_offset
= board
->sensor_v_offset
;
759 go
->encoder_h_offset
= board
->sensor_h_offset
;
761 EXPORT_SYMBOL(go7007_update_board
);
763 MODULE_LICENSE("GPL v2");