1 // SPDX-License-Identifier: GPL-2.0
3 * The Virtual DTV test driver serves as a reference DVB driver and helps
4 * validate the existing APIs in the media subsystem. It can also aid
5 * developers working on userspace applications.
7 * When this module is loaded, it will attempt to modprobe 'dvb_vidtv_tuner'
8 * and 'dvb_vidtv_demod'.
10 * Copyright (C) 2020 Daniel W. S. Almeida
13 #include <linux/dev_printk.h>
14 #include <linux/moduleparam.h>
15 #include <linux/mutex.h>
16 #include <linux/platform_device.h>
17 #include <linux/time.h>
18 #include <linux/types.h>
19 #include <linux/workqueue.h>
20 #include <media/dvbdev.h>
21 #include <media/media-device.h>
23 #include "vidtv_bridge.h"
24 #include "vidtv_common.h"
25 #include "vidtv_demod.h"
26 #include "vidtv_mux.h"
28 #include "vidtv_tuner.h"
30 #define MUX_BUF_MIN_SZ 90164
31 #define MUX_BUF_MAX_SZ (MUX_BUF_MIN_SZ * 10)
32 #define TUNER_DEFAULT_ADDR 0x68
33 #define DEMOD_DEFAULT_ADDR 0x60
34 #define VIDTV_DEFAULT_NETWORK_ID 0xff44
35 #define VIDTV_DEFAULT_NETWORK_NAME "LinuxTV.org"
36 #define VIDTV_DEFAULT_TS_ID 0x4081
39 * The LNBf fake parameters here are the ranges used by an
40 * Universal (extended) European LNBf, which is likely the most common LNBf
41 * found on Satellite digital TV system nowadays.
43 #define LNB_CUT_FREQUENCY 11700000 /* high IF frequency */
44 #define LNB_LOW_FREQ 9750000 /* low IF frequency */
45 #define LNB_HIGH_FREQ 10600000 /* transition frequency */
47 static unsigned int drop_tslock_prob_on_low_snr;
48 module_param(drop_tslock_prob_on_low_snr, uint, 0);
49 MODULE_PARM_DESC(drop_tslock_prob_on_low_snr,
50 "Probability of losing the TS lock if the signal quality is bad");
52 static unsigned int recover_tslock_prob_on_good_snr;
53 module_param(recover_tslock_prob_on_good_snr, uint, 0);
54 MODULE_PARM_DESC(recover_tslock_prob_on_good_snr,
55 "Probability recovering the TS lock when the signal improves");
57 static unsigned int mock_power_up_delay_msec;
58 module_param(mock_power_up_delay_msec, uint, 0);
59 MODULE_PARM_DESC(mock_power_up_delay_msec, "Simulate a power up delay");
61 static unsigned int mock_tune_delay_msec;
62 module_param(mock_tune_delay_msec, uint, 0);
63 MODULE_PARM_DESC(mock_tune_delay_msec, "Simulate a tune delay");
65 static unsigned int vidtv_valid_dvb_t_freqs[NUM_VALID_TUNER_FREQS] = {
69 module_param_array(vidtv_valid_dvb_t_freqs, uint, NULL, 0);
70 MODULE_PARM_DESC(vidtv_valid_dvb_t_freqs,
71 "Valid DVB-T frequencies to simulate, in Hz");
73 static unsigned int vidtv_valid_dvb_c_freqs[NUM_VALID_TUNER_FREQS] = {
77 module_param_array(vidtv_valid_dvb_c_freqs, uint, NULL, 0);
78 MODULE_PARM_DESC(vidtv_valid_dvb_c_freqs,
79 "Valid DVB-C frequencies to simulate, in Hz");
81 static unsigned int vidtv_valid_dvb_s_freqs[NUM_VALID_TUNER_FREQS] = {
84 module_param_array(vidtv_valid_dvb_s_freqs, uint, NULL, 0);
85 MODULE_PARM_DESC(vidtv_valid_dvb_s_freqs,
86 "Valid DVB-S/S2 frequencies to simulate at Ku-Band, in kHz");
88 static unsigned int max_frequency_shift_hz;
89 module_param(max_frequency_shift_hz, uint, 0);
90 MODULE_PARM_DESC(max_frequency_shift_hz,
91 "Maximum shift in HZ allowed when tuning in a channel");
93 DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nums);
96 * Influences the signal acquisition time. See ISO/IEC 13818-1 : 2000. p. 113.
98 static unsigned int si_period_msec = 40;
99 module_param(si_period_msec, uint, 0);
100 MODULE_PARM_DESC(si_period_msec, "How often to send SI packets. Default: 40ms");
102 static unsigned int pcr_period_msec = 40;
103 module_param(pcr_period_msec, uint, 0);
104 MODULE_PARM_DESC(pcr_period_msec,
105 "How often to send PCR packets. Default: 40ms");
107 static unsigned int mux_rate_kbytes_sec = 4096;
108 module_param(mux_rate_kbytes_sec, uint, 0);
109 MODULE_PARM_DESC(mux_rate_kbytes_sec, "Mux rate: will pad stream if below");
111 static unsigned int pcr_pid = 0x200;
112 module_param(pcr_pid, uint, 0);
113 MODULE_PARM_DESC(pcr_pid, "PCR PID for all channels: defaults to 0x200");
115 static unsigned int mux_buf_sz_pkts;
116 module_param(mux_buf_sz_pkts, uint, 0);
117 MODULE_PARM_DESC(mux_buf_sz_pkts,
118 "Size for the internal mux buffer in multiples of 188 bytes");
120 static u32 vidtv_bridge_mux_buf_sz_for_mux_rate(void)
122 u32 max_elapsed_time_msecs = VIDTV_MAX_SLEEP_USECS / USEC_PER_MSEC;
123 u32 mux_buf_sz = mux_buf_sz_pkts * TS_PACKET_LEN;
126 nbytes_expected = mux_rate_kbytes_sec;
127 nbytes_expected *= max_elapsed_time_msecs;
129 mux_buf_sz = roundup(nbytes_expected, TS_PACKET_LEN);
130 mux_buf_sz += mux_buf_sz / 10;
132 if (mux_buf_sz < MUX_BUF_MIN_SZ)
133 mux_buf_sz = MUX_BUF_MIN_SZ;
135 if (mux_buf_sz > MUX_BUF_MAX_SZ)
136 mux_buf_sz = MUX_BUF_MAX_SZ;
141 static bool vidtv_bridge_check_demod_lock(struct vidtv_dvb *dvb, u32 n)
143 enum fe_status status;
145 dvb->fe[n]->ops.read_status(dvb->fe[n], &status);
147 return status == (FE_HAS_SIGNAL |
155 * called on a separate thread by the mux when new packets become available
157 static void vidtv_bridge_on_new_pkts_avail(void *priv, u8 *buf, u32 npkts)
159 struct vidtv_dvb *dvb = priv;
161 /* drop packets if we lose the lock */
162 if (vidtv_bridge_check_demod_lock(dvb, 0))
163 dvb_dmx_swfilter_packets(&dvb->demux, buf, npkts);
166 static int vidtv_start_streaming(struct vidtv_dvb *dvb)
168 struct vidtv_mux_init_args mux_args = {
169 .mux_rate_kbytes_sec = mux_rate_kbytes_sec,
170 .on_new_packets_available_cb = vidtv_bridge_on_new_pkts_avail,
171 .pcr_period_usecs = pcr_period_msec * USEC_PER_MSEC,
172 .si_period_usecs = si_period_msec * USEC_PER_MSEC,
174 .transport_stream_id = VIDTV_DEFAULT_TS_ID,
175 .network_id = VIDTV_DEFAULT_NETWORK_ID,
176 .network_name = VIDTV_DEFAULT_NETWORK_NAME,
179 struct device *dev = &dvb->pdev->dev;
182 if (dvb->streaming) {
183 dev_warn_ratelimited(dev, "Already streaming. Skipping.\n");
188 mux_buf_sz = mux_buf_sz_pkts;
190 mux_buf_sz = vidtv_bridge_mux_buf_sz_for_mux_rate();
192 mux_args.mux_buf_sz = mux_buf_sz;
194 dvb->streaming = true;
195 dvb->mux = vidtv_mux_init(dvb->fe[0], dev, &mux_args);
198 vidtv_mux_start_thread(dvb->mux);
200 dev_dbg_ratelimited(dev, "Started streaming\n");
204 static int vidtv_stop_streaming(struct vidtv_dvb *dvb)
206 struct device *dev = &dvb->pdev->dev;
208 dvb->streaming = false;
209 vidtv_mux_stop_thread(dvb->mux);
210 vidtv_mux_destroy(dvb->mux);
213 dev_dbg_ratelimited(dev, "Stopped streaming\n");
217 static int vidtv_start_feed(struct dvb_demux_feed *feed)
219 struct dvb_demux *demux = feed->demux;
220 struct vidtv_dvb *dvb = demux->priv;
224 if (!demux->dmx.frontend)
227 mutex_lock(&dvb->feed_lock);
232 if (dvb->nfeeds == 1) {
233 ret = vidtv_start_streaming(dvb);
238 mutex_unlock(&dvb->feed_lock);
242 static int vidtv_stop_feed(struct dvb_demux_feed *feed)
244 struct dvb_demux *demux = feed->demux;
245 struct vidtv_dvb *dvb = demux->priv;
248 mutex_lock(&dvb->feed_lock);
252 err = vidtv_stop_streaming(dvb);
254 mutex_unlock(&dvb->feed_lock);
258 static struct dvb_frontend *vidtv_get_frontend_ptr(struct i2c_client *c)
260 struct vidtv_demod_state *state = i2c_get_clientdata(c);
262 /* the demod will set this when its probe function runs */
263 return &state->frontend;
266 static int vidtv_master_xfer(struct i2c_adapter *i2c_adap,
267 struct i2c_msg msgs[],
271 * Right now, this virtual driver doesn't really send or receive
272 * messages from I2C. A real driver will require an implementation
278 static u32 vidtv_i2c_func(struct i2c_adapter *adapter)
283 static const struct i2c_algorithm vidtv_i2c_algorithm = {
284 .master_xfer = vidtv_master_xfer,
285 .functionality = vidtv_i2c_func,
288 static int vidtv_bridge_i2c_register_adap(struct vidtv_dvb *dvb)
290 struct i2c_adapter *i2c_adapter = &dvb->i2c_adapter;
292 strscpy(i2c_adapter->name, "vidtv_i2c", sizeof(i2c_adapter->name));
293 i2c_adapter->owner = THIS_MODULE;
294 i2c_adapter->algo = &vidtv_i2c_algorithm;
295 i2c_adapter->algo_data = NULL;
296 i2c_adapter->timeout = 500;
297 i2c_adapter->retries = 3;
298 i2c_adapter->dev.parent = &dvb->pdev->dev;
300 i2c_set_adapdata(i2c_adapter, dvb);
301 return i2c_add_adapter(&dvb->i2c_adapter);
304 static int vidtv_bridge_register_adap(struct vidtv_dvb *dvb)
308 ret = dvb_register_adapter(&dvb->adapter,
311 &dvb->i2c_adapter.dev,
317 static int vidtv_bridge_dmx_init(struct vidtv_dvb *dvb)
319 dvb->demux.dmx.capabilities = DMX_TS_FILTERING |
320 DMX_SECTION_FILTERING;
322 dvb->demux.priv = dvb;
323 dvb->demux.filternum = 256;
324 dvb->demux.feednum = 256;
325 dvb->demux.start_feed = vidtv_start_feed;
326 dvb->demux.stop_feed = vidtv_stop_feed;
328 return dvb_dmx_init(&dvb->demux);
331 static int vidtv_bridge_dmxdev_init(struct vidtv_dvb *dvb)
333 dvb->dmx_dev.filternum = 256;
334 dvb->dmx_dev.demux = &dvb->demux.dmx;
335 dvb->dmx_dev.capabilities = 0;
337 return dvb_dmxdev_init(&dvb->dmx_dev, &dvb->adapter);
340 static int vidtv_bridge_probe_demod(struct vidtv_dvb *dvb, u32 n)
342 struct vidtv_demod_config cfg = {
343 .drop_tslock_prob_on_low_snr = drop_tslock_prob_on_low_snr,
344 .recover_tslock_prob_on_good_snr = recover_tslock_prob_on_good_snr,
346 dvb->i2c_client_demod[n] = dvb_module_probe("dvb_vidtv_demod",
352 /* driver will not work anyways so bail out */
353 if (!dvb->i2c_client_demod[n])
356 /* retrieve a ptr to the frontend state */
357 dvb->fe[n] = vidtv_get_frontend_ptr(dvb->i2c_client_demod[n]);
362 static int vidtv_bridge_probe_tuner(struct vidtv_dvb *dvb, u32 n)
364 struct vidtv_tuner_config cfg = {
366 .mock_power_up_delay_msec = mock_power_up_delay_msec,
367 .mock_tune_delay_msec = mock_tune_delay_msec,
372 /* TODO: check if the frequencies are at a valid range */
374 memcpy(cfg.vidtv_valid_dvb_t_freqs,
375 vidtv_valid_dvb_t_freqs,
376 sizeof(vidtv_valid_dvb_t_freqs));
378 memcpy(cfg.vidtv_valid_dvb_c_freqs,
379 vidtv_valid_dvb_c_freqs,
380 sizeof(vidtv_valid_dvb_c_freqs));
383 * Convert Satellite frequencies from Ku-band in kHZ into S-band
386 for (i = 0; i < ARRAY_SIZE(vidtv_valid_dvb_s_freqs); i++) {
387 freq = vidtv_valid_dvb_s_freqs[i];
389 if (freq < LNB_CUT_FREQUENCY)
390 freq = abs(freq - LNB_LOW_FREQ);
392 freq = abs(freq - LNB_HIGH_FREQ);
394 cfg.vidtv_valid_dvb_s_freqs[i] = freq;
397 cfg.max_frequency_shift_hz = max_frequency_shift_hz;
399 dvb->i2c_client_tuner[n] = dvb_module_probe("dvb_vidtv_tuner",
405 return (dvb->i2c_client_tuner[n]) ? 0 : -ENODEV;
408 static int vidtv_bridge_dvb_init(struct vidtv_dvb *dvb)
412 ret = vidtv_bridge_i2c_register_adap(dvb);
416 ret = vidtv_bridge_register_adap(dvb);
419 dvb_register_media_controller(&dvb->adapter, &dvb->mdev);
421 for (i = 0; i < NUM_FE; ++i) {
422 ret = vidtv_bridge_probe_demod(dvb, i);
424 goto fail_demod_probe;
426 ret = vidtv_bridge_probe_tuner(dvb, i);
428 goto fail_tuner_probe;
430 ret = dvb_register_frontend(&dvb->adapter, dvb->fe[i]);
435 ret = vidtv_bridge_dmx_init(dvb);
439 ret = vidtv_bridge_dmxdev_init(dvb);
443 for (j = 0; j < NUM_FE; ++j) {
444 ret = dvb->demux.dmx.connect_frontend(&dvb->demux.dmx,
450 * The source of the demux is a frontend connected
453 dvb->dmx_fe[j].source = DMX_FRONTEND_0;
459 for (j = j - 1; j >= 0; --j)
460 dvb->demux.dmx.remove_frontend(&dvb->demux.dmx,
463 dvb_dmxdev_release(&dvb->dmx_dev);
465 dvb_dmx_release(&dvb->demux);
467 for (j = i; j >= 0; --j)
468 dvb_unregister_frontend(dvb->fe[j]);
470 for (j = i; j >= 0; --j)
471 if (dvb->i2c_client_tuner[j])
472 dvb_module_release(dvb->i2c_client_tuner[j]);
475 for (j = i; j >= 0; --j)
476 if (dvb->i2c_client_demod[j])
477 dvb_module_release(dvb->i2c_client_demod[j]);
480 dvb_unregister_adapter(&dvb->adapter);
483 i2c_del_adapter(&dvb->i2c_adapter);
488 static int vidtv_bridge_probe(struct platform_device *pdev)
490 struct vidtv_dvb *dvb;
493 dvb = kzalloc(sizeof(*dvb), GFP_KERNEL);
499 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
500 dvb->mdev.dev = &pdev->dev;
502 strscpy(dvb->mdev.model, "vidtv", sizeof(dvb->mdev.model));
503 strscpy(dvb->mdev.bus_info, "platform:vidtv", sizeof(dvb->mdev.bus_info));
505 media_device_init(&dvb->mdev);
508 ret = vidtv_bridge_dvb_init(dvb);
512 mutex_init(&dvb->feed_lock);
514 platform_set_drvdata(pdev, dvb);
516 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
517 ret = media_device_register(&dvb->mdev);
519 dev_err(dvb->mdev.dev,
520 "media device register failed (err=%d)\n", ret);
521 goto err_media_device_register;
523 #endif /* CONFIG_MEDIA_CONTROLLER_DVB */
525 dev_info(&pdev->dev, "Successfully initialized vidtv!\n");
528 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
529 err_media_device_register:
530 media_device_cleanup(&dvb->mdev);
531 #endif /* CONFIG_MEDIA_CONTROLLER_DVB */
537 static int vidtv_bridge_remove(struct platform_device *pdev)
539 struct vidtv_dvb *dvb;
542 dvb = platform_get_drvdata(pdev);
544 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
545 media_device_unregister(&dvb->mdev);
546 media_device_cleanup(&dvb->mdev);
547 #endif /* CONFIG_MEDIA_CONTROLLER_DVB */
549 mutex_destroy(&dvb->feed_lock);
551 for (i = 0; i < NUM_FE; ++i) {
552 dvb_unregister_frontend(dvb->fe[i]);
553 dvb_module_release(dvb->i2c_client_tuner[i]);
554 dvb_module_release(dvb->i2c_client_demod[i]);
557 dvb_dmxdev_release(&dvb->dmx_dev);
558 dvb_dmx_release(&dvb->demux);
559 dvb_unregister_adapter(&dvb->adapter);
560 dev_info(&pdev->dev, "Successfully removed vidtv\n");
565 static void vidtv_bridge_dev_release(struct device *dev)
567 struct vidtv_dvb *dvb;
569 dvb = dev_get_drvdata(dev);
573 static struct platform_device vidtv_bridge_dev = {
574 .name = VIDTV_PDEV_NAME,
575 .dev.release = vidtv_bridge_dev_release,
578 static struct platform_driver vidtv_bridge_driver = {
580 .name = VIDTV_PDEV_NAME,
582 .probe = vidtv_bridge_probe,
583 .remove = vidtv_bridge_remove,
586 static void __exit vidtv_bridge_exit(void)
588 platform_driver_unregister(&vidtv_bridge_driver);
589 platform_device_unregister(&vidtv_bridge_dev);
592 static int __init vidtv_bridge_init(void)
596 ret = platform_device_register(&vidtv_bridge_dev);
600 ret = platform_driver_register(&vidtv_bridge_driver);
602 platform_device_unregister(&vidtv_bridge_dev);
607 module_init(vidtv_bridge_init);
608 module_exit(vidtv_bridge_exit);
610 MODULE_DESCRIPTION("Virtual Digital TV Test Driver");
611 MODULE_AUTHOR("Daniel W. S. Almeida");
612 MODULE_LICENSE("GPL");
613 MODULE_ALIAS("vidtv");
614 MODULE_ALIAS("dvb_vidtv");