1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Silicon Labs Si2168 DVB-T/T2/C demodulator driver
5 * Copyright (C) 2014 Antti Palosaari <crope@iki.fi>
8 #include <linux/delay.h>
10 #include "si2168_priv.h"
12 static const struct dvb_frontend_ops si2168_ops
;
14 /* execute firmware command */
15 static int si2168_cmd_execute(struct i2c_client
*client
, struct si2168_cmd
*cmd
)
17 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
19 unsigned long timeout
;
21 mutex_lock(&dev
->i2c_mutex
);
24 /* write cmd and args for firmware */
25 ret
= i2c_master_send(client
, cmd
->args
, cmd
->wlen
);
27 goto err_mutex_unlock
;
28 } else if (ret
!= cmd
->wlen
) {
30 goto err_mutex_unlock
;
35 /* wait cmd execution terminate */
37 timeout
= jiffies
+ msecs_to_jiffies(TIMEOUT
);
38 while (!time_after(jiffies
, timeout
)) {
39 ret
= i2c_master_recv(client
, cmd
->args
, cmd
->rlen
);
41 goto err_mutex_unlock
;
42 } else if (ret
!= cmd
->rlen
) {
44 goto err_mutex_unlock
;
48 if ((cmd
->args
[0] >> 7) & 0x01)
52 dev_dbg(&client
->dev
, "cmd execution took %d ms\n",
53 jiffies_to_msecs(jiffies
) -
54 (jiffies_to_msecs(timeout
) - TIMEOUT
));
57 if ((cmd
->args
[0] >> 6) & 0x01) {
59 goto err_mutex_unlock
;
62 if (!((cmd
->args
[0] >> 7) & 0x01)) {
64 goto err_mutex_unlock
;
68 mutex_unlock(&dev
->i2c_mutex
);
71 mutex_unlock(&dev
->i2c_mutex
);
72 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
76 static int si2168_ts_bus_ctrl(struct dvb_frontend
*fe
, int acquire
)
78 struct i2c_client
*client
= fe
->demodulator_priv
;
79 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
80 struct si2168_cmd cmd
;
83 dev_dbg(&client
->dev
, "%s acquire: %d\n", __func__
, acquire
);
85 /* set TS_MODE property */
86 memcpy(cmd
.args
, "\x14\x00\x01\x10\x10\x00", 6);
88 cmd
.args
[4] |= dev
->ts_mode
;
90 cmd
.args
[4] |= SI2168_TS_TRISTATE
;
91 if (dev
->ts_clock_gapped
)
95 ret
= si2168_cmd_execute(client
, &cmd
);
100 static int si2168_read_status(struct dvb_frontend
*fe
, enum fe_status
*status
)
102 struct i2c_client
*client
= fe
->demodulator_priv
;
103 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
104 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
106 unsigned int utmp
, utmp1
, utmp2
;
107 struct si2168_cmd cmd
;
116 switch (c
->delivery_system
) {
118 memcpy(cmd
.args
, "\xa0\x01", 2);
122 case SYS_DVBC_ANNEX_A
:
123 memcpy(cmd
.args
, "\x90\x01", 2);
128 memcpy(cmd
.args
, "\x50\x01", 2);
137 ret
= si2168_cmd_execute(client
, &cmd
);
141 switch ((cmd
.args
[2] >> 1) & 0x03) {
143 *status
= FE_HAS_SIGNAL
| FE_HAS_CARRIER
;
146 *status
= FE_HAS_SIGNAL
| FE_HAS_CARRIER
| FE_HAS_VITERBI
|
147 FE_HAS_SYNC
| FE_HAS_LOCK
;
151 dev
->fe_status
= *status
;
153 if (*status
& FE_HAS_LOCK
) {
155 c
->cnr
.stat
[0].scale
= FE_SCALE_DECIBEL
;
156 c
->cnr
.stat
[0].svalue
= cmd
.args
[3] * 1000 / 4;
159 c
->cnr
.stat
[0].scale
= FE_SCALE_NOT_AVAILABLE
;
162 dev_dbg(&client
->dev
, "status=%02x args=%*ph\n",
163 *status
, cmd
.rlen
, cmd
.args
);
166 if (*status
& FE_HAS_VITERBI
) {
167 memcpy(cmd
.args
, "\x82\x00", 2);
170 ret
= si2168_cmd_execute(client
, &cmd
);
175 * Firmware returns [0, 255] mantissa and [0, 8] exponent.
176 * Convert to DVB API: mantissa * 10^(8 - exponent) / 10^8
178 utmp
= clamp(8 - cmd
.args
[1], 0, 8);
179 for (i
= 0, utmp1
= 1; i
< utmp
; i
++)
182 utmp1
= cmd
.args
[2] * utmp1
;
183 utmp2
= 100000000; /* 10^8 */
185 dev_dbg(&client
->dev
,
186 "post_bit_error=%u post_bit_count=%u ber=%u*10^-%u\n",
187 utmp1
, utmp2
, cmd
.args
[2], cmd
.args
[1]);
189 c
->post_bit_error
.stat
[0].scale
= FE_SCALE_COUNTER
;
190 c
->post_bit_error
.stat
[0].uvalue
+= utmp1
;
191 c
->post_bit_count
.stat
[0].scale
= FE_SCALE_COUNTER
;
192 c
->post_bit_count
.stat
[0].uvalue
+= utmp2
;
194 c
->post_bit_error
.stat
[0].scale
= FE_SCALE_NOT_AVAILABLE
;
195 c
->post_bit_count
.stat
[0].scale
= FE_SCALE_NOT_AVAILABLE
;
199 if (*status
& FE_HAS_SYNC
) {
200 memcpy(cmd
.args
, "\x84\x01", 2);
203 ret
= si2168_cmd_execute(client
, &cmd
);
207 utmp1
= cmd
.args
[2] << 8 | cmd
.args
[1] << 0;
208 dev_dbg(&client
->dev
, "block_error=%u\n", utmp1
);
210 /* Sometimes firmware returns bogus value */
214 c
->block_error
.stat
[0].scale
= FE_SCALE_COUNTER
;
215 c
->block_error
.stat
[0].uvalue
+= utmp1
;
217 c
->block_error
.stat
[0].scale
= FE_SCALE_NOT_AVAILABLE
;
222 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
226 static int si2168_set_frontend(struct dvb_frontend
*fe
)
228 struct i2c_client
*client
= fe
->demodulator_priv
;
229 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
230 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
232 struct si2168_cmd cmd
;
233 u8 bandwidth
, delivery_system
;
235 dev_dbg(&client
->dev
,
236 "delivery_system=%u modulation=%u frequency=%u bandwidth_hz=%u symbol_rate=%u inversion=%u stream_id=%u\n",
237 c
->delivery_system
, c
->modulation
, c
->frequency
,
238 c
->bandwidth_hz
, c
->symbol_rate
, c
->inversion
,
246 switch (c
->delivery_system
) {
248 delivery_system
= 0x20;
250 case SYS_DVBC_ANNEX_A
:
251 delivery_system
= 0x30;
254 delivery_system
= 0x70;
261 if (c
->bandwidth_hz
== 0) {
264 } else if (c
->bandwidth_hz
<= 2000000)
266 else if (c
->bandwidth_hz
<= 5000000)
268 else if (c
->bandwidth_hz
<= 6000000)
270 else if (c
->bandwidth_hz
<= 7000000)
272 else if (c
->bandwidth_hz
<= 8000000)
274 else if (c
->bandwidth_hz
<= 9000000)
276 else if (c
->bandwidth_hz
<= 10000000)
282 if (fe
->ops
.tuner_ops
.set_params
) {
283 ret
= fe
->ops
.tuner_ops
.set_params(fe
);
288 memcpy(cmd
.args
, "\x88\x02\x02\x02\x02", 5);
291 ret
= si2168_cmd_execute(client
, &cmd
);
295 /* that has no big effect */
296 if (c
->delivery_system
== SYS_DVBT
)
297 memcpy(cmd
.args
, "\x89\x21\x06\x11\xff\x98", 6);
298 else if (c
->delivery_system
== SYS_DVBC_ANNEX_A
)
299 memcpy(cmd
.args
, "\x89\x21\x06\x11\x89\xf0", 6);
300 else if (c
->delivery_system
== SYS_DVBT2
)
301 memcpy(cmd
.args
, "\x89\x21\x06\x11\x89\x20", 6);
304 ret
= si2168_cmd_execute(client
, &cmd
);
308 if (c
->delivery_system
== SYS_DVBT2
) {
311 cmd
.args
[1] = c
->stream_id
& 0xff;
312 cmd
.args
[2] = c
->stream_id
== NO_STREAM_ID_FILTER
? 0 : 1;
315 ret
= si2168_cmd_execute(client
, &cmd
);
320 memcpy(cmd
.args
, "\x51\x03", 2);
323 ret
= si2168_cmd_execute(client
, &cmd
);
327 memcpy(cmd
.args
, "\x12\x08\x04", 3);
330 ret
= si2168_cmd_execute(client
, &cmd
);
334 memcpy(cmd
.args
, "\x14\x00\x0c\x10\x12\x00", 6);
337 ret
= si2168_cmd_execute(client
, &cmd
);
341 memcpy(cmd
.args
, "\x14\x00\x06\x10\x24\x00", 6);
344 ret
= si2168_cmd_execute(client
, &cmd
);
348 memcpy(cmd
.args
, "\x14\x00\x07\x10\x00\x24", 6);
351 ret
= si2168_cmd_execute(client
, &cmd
);
355 memcpy(cmd
.args
, "\x14\x00\x0a\x10\x00\x00", 6);
356 cmd
.args
[4] = delivery_system
| bandwidth
;
357 if (dev
->spectral_inversion
)
361 ret
= si2168_cmd_execute(client
, &cmd
);
365 /* set DVB-C symbol rate */
366 if (c
->delivery_system
== SYS_DVBC_ANNEX_A
) {
367 memcpy(cmd
.args
, "\x14\x00\x02\x11", 4);
368 cmd
.args
[4] = ((c
->symbol_rate
/ 1000) >> 0) & 0xff;
369 cmd
.args
[5] = ((c
->symbol_rate
/ 1000) >> 8) & 0xff;
372 ret
= si2168_cmd_execute(client
, &cmd
);
377 memcpy(cmd
.args
, "\x14\x00\x0f\x10\x10\x00", 6);
380 ret
= si2168_cmd_execute(client
, &cmd
);
384 memcpy(cmd
.args
, "\x14\x00\x09\x10\xe3\x08", 6);
385 cmd
.args
[5] |= dev
->ts_clock_inv
? 0x00 : 0x10;
388 ret
= si2168_cmd_execute(client
, &cmd
);
392 memcpy(cmd
.args
, "\x14\x00\x08\x10\xd7\x05", 6);
393 cmd
.args
[5] |= dev
->ts_clock_inv
? 0x00 : 0x10;
396 ret
= si2168_cmd_execute(client
, &cmd
);
400 memcpy(cmd
.args
, "\x14\x00\x01\x12\x00\x00", 6);
403 ret
= si2168_cmd_execute(client
, &cmd
);
407 memcpy(cmd
.args
, "\x14\x00\x01\x03\x0c\x00", 6);
410 ret
= si2168_cmd_execute(client
, &cmd
);
414 memcpy(cmd
.args
, "\x85", 1);
417 ret
= si2168_cmd_execute(client
, &cmd
);
421 dev
->delivery_system
= c
->delivery_system
;
424 ret
= si2168_ts_bus_ctrl(fe
, 1);
430 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
434 static int si2168_init(struct dvb_frontend
*fe
)
436 struct i2c_client
*client
= fe
->demodulator_priv
;
437 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
438 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
439 int ret
, len
, remaining
;
440 const struct firmware
*fw
;
441 struct si2168_cmd cmd
;
443 dev_dbg(&client
->dev
, "\n");
446 memcpy(cmd
.args
, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
449 ret
= si2168_cmd_execute(client
, &cmd
);
455 memcpy(cmd
.args
, "\xc0\x06\x08\x0f\x00\x20\x21\x01", 8);
458 ret
= si2168_cmd_execute(client
, &cmd
);
463 memcpy(cmd
.args
, "\x85", 1);
466 ret
= si2168_cmd_execute(client
, &cmd
);
474 memcpy(cmd
.args
, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
477 ret
= si2168_cmd_execute(client
, &cmd
);
481 /* request the firmware, this will block and timeout */
482 ret
= request_firmware(&fw
, dev
->firmware_name
, &client
->dev
);
484 /* fallback mechanism to handle old name for Si2168 B40 fw */
485 if (dev
->chip_id
== SI2168_CHIP_ID_B40
) {
486 dev
->firmware_name
= SI2168_B40_FIRMWARE_FALLBACK
;
487 ret
= request_firmware(&fw
, dev
->firmware_name
,
492 dev_notice(&client
->dev
,
493 "please install firmware file '%s'\n",
494 SI2168_B40_FIRMWARE
);
496 dev_err(&client
->dev
,
497 "firmware file '%s' not found\n",
499 goto err_release_firmware
;
503 dev_info(&client
->dev
, "downloading firmware from file '%s'\n",
506 if ((fw
->size
% 17 == 0) && (fw
->data
[0] > 5)) {
507 /* firmware is in the new format */
508 for (remaining
= fw
->size
; remaining
> 0; remaining
-= 17) {
509 len
= fw
->data
[fw
->size
- remaining
];
510 if (len
> SI2168_ARGLEN
) {
514 memcpy(cmd
.args
, &fw
->data
[(fw
->size
- remaining
) + 1], len
);
517 ret
= si2168_cmd_execute(client
, &cmd
);
521 } else if (fw
->size
% 8 == 0) {
522 /* firmware is in the old format */
523 for (remaining
= fw
->size
; remaining
> 0; remaining
-= 8) {
525 memcpy(cmd
.args
, &fw
->data
[fw
->size
- remaining
], len
);
528 ret
= si2168_cmd_execute(client
, &cmd
);
533 /* bad or unknown firmware format */
538 dev_err(&client
->dev
, "firmware download failed %d\n", ret
);
539 goto err_release_firmware
;
542 release_firmware(fw
);
544 memcpy(cmd
.args
, "\x01\x01", 2);
547 ret
= si2168_cmd_execute(client
, &cmd
);
551 /* query firmware version */
552 memcpy(cmd
.args
, "\x11", 1);
555 ret
= si2168_cmd_execute(client
, &cmd
);
559 dev
->version
= (cmd
.args
[9] + '@') << 24 | (cmd
.args
[6] - '0') << 16 |
560 (cmd
.args
[7] - '0') << 8 | (cmd
.args
[8]) << 0;
561 dev_info(&client
->dev
, "firmware version: %c %d.%d.%d\n",
562 dev
->version
>> 24 & 0xff, dev
->version
>> 16 & 0xff,
563 dev
->version
>> 8 & 0xff, dev
->version
>> 0 & 0xff);
566 ret
= si2168_ts_bus_ctrl(fe
, 1);
572 /* Init stats here to indicate which stats are supported */
574 c
->cnr
.stat
[0].scale
= FE_SCALE_NOT_AVAILABLE
;
575 c
->post_bit_error
.len
= 1;
576 c
->post_bit_error
.stat
[0].scale
= FE_SCALE_NOT_AVAILABLE
;
577 c
->post_bit_count
.len
= 1;
578 c
->post_bit_count
.stat
[0].scale
= FE_SCALE_NOT_AVAILABLE
;
579 c
->block_error
.len
= 1;
580 c
->block_error
.stat
[0].scale
= FE_SCALE_NOT_AVAILABLE
;
585 err_release_firmware
:
586 release_firmware(fw
);
588 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
592 static int si2168_sleep(struct dvb_frontend
*fe
)
594 struct i2c_client
*client
= fe
->demodulator_priv
;
595 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
597 struct si2168_cmd cmd
;
599 dev_dbg(&client
->dev
, "\n");
603 /* tri-state data bus */
604 ret
= si2168_ts_bus_ctrl(fe
, 0);
608 /* Firmware later than B 4.0-11 loses warm state during sleep */
609 if (dev
->version
> ('B' << 24 | 4 << 16 | 0 << 8 | 11 << 0))
612 memcpy(cmd
.args
, "\x13", 1);
615 ret
= si2168_cmd_execute(client
, &cmd
);
621 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
625 static int si2168_get_tune_settings(struct dvb_frontend
*fe
,
626 struct dvb_frontend_tune_settings
*s
)
628 s
->min_delay_ms
= 900;
633 static int si2168_select(struct i2c_mux_core
*muxc
, u32 chan
)
635 struct i2c_client
*client
= i2c_mux_priv(muxc
);
637 struct si2168_cmd cmd
;
640 memcpy(cmd
.args
, "\xc0\x0d\x01", 3);
643 ret
= si2168_cmd_execute(client
, &cmd
);
649 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
653 static int si2168_deselect(struct i2c_mux_core
*muxc
, u32 chan
)
655 struct i2c_client
*client
= i2c_mux_priv(muxc
);
657 struct si2168_cmd cmd
;
660 memcpy(cmd
.args
, "\xc0\x0d\x00", 3);
663 ret
= si2168_cmd_execute(client
, &cmd
);
669 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
673 static const struct dvb_frontend_ops si2168_ops
= {
674 .delsys
= {SYS_DVBT
, SYS_DVBT2
, SYS_DVBC_ANNEX_A
},
676 .name
= "Silicon Labs Si2168",
677 .frequency_min_hz
= 48 * MHz
,
678 .frequency_max_hz
= 870 * MHz
,
679 .frequency_stepsize_hz
= 62500,
680 .symbol_rate_min
= 1000000,
681 .symbol_rate_max
= 7200000,
682 .caps
= FE_CAN_FEC_1_2
|
695 FE_CAN_TRANSMISSION_MODE_AUTO
|
696 FE_CAN_GUARD_INTERVAL_AUTO
|
697 FE_CAN_HIERARCHY_AUTO
|
699 FE_CAN_2G_MODULATION
|
703 .get_tune_settings
= si2168_get_tune_settings
,
706 .sleep
= si2168_sleep
,
708 .set_frontend
= si2168_set_frontend
,
710 .read_status
= si2168_read_status
,
713 static int si2168_probe(struct i2c_client
*client
,
714 const struct i2c_device_id
*id
)
716 struct si2168_config
*config
= client
->dev
.platform_data
;
717 struct si2168_dev
*dev
;
719 struct si2168_cmd cmd
;
721 dev_dbg(&client
->dev
, "\n");
723 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
729 i2c_set_clientdata(client
, dev
);
730 mutex_init(&dev
->i2c_mutex
);
733 memcpy(cmd
.args
, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
736 ret
= si2168_cmd_execute(client
, &cmd
);
741 memcpy(cmd
.args
, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
744 ret
= si2168_cmd_execute(client
, &cmd
);
748 /* Query chip revision */
749 memcpy(cmd
.args
, "\x02", 1);
752 ret
= si2168_cmd_execute(client
, &cmd
);
756 dev
->chip_id
= cmd
.args
[1] << 24 | cmd
.args
[2] << 16 |
757 cmd
.args
[3] << 8 | cmd
.args
[4] << 0;
759 switch (dev
->chip_id
) {
760 case SI2168_CHIP_ID_A20
:
761 dev
->firmware_name
= SI2168_A20_FIRMWARE
;
763 case SI2168_CHIP_ID_A30
:
764 dev
->firmware_name
= SI2168_A30_FIRMWARE
;
766 case SI2168_CHIP_ID_B40
:
767 dev
->firmware_name
= SI2168_B40_FIRMWARE
;
769 case SI2168_CHIP_ID_D60
:
770 dev
->firmware_name
= SI2168_D60_FIRMWARE
;
773 dev_dbg(&client
->dev
, "unknown chip version Si21%d-%c%c%c\n",
774 cmd
.args
[2], cmd
.args
[1], cmd
.args
[3], cmd
.args
[4]);
779 dev
->version
= (cmd
.args
[1]) << 24 | (cmd
.args
[3] - '0') << 16 |
780 (cmd
.args
[4] - '0') << 8 | (cmd
.args
[5]) << 0;
782 /* create mux i2c adapter for tuner */
783 dev
->muxc
= i2c_mux_alloc(client
->adapter
, &client
->dev
,
784 1, 0, I2C_MUX_LOCKED
,
785 si2168_select
, si2168_deselect
);
790 dev
->muxc
->priv
= client
;
791 ret
= i2c_mux_add_adapter(dev
->muxc
, 0, 0, 0);
795 /* create dvb_frontend */
796 memcpy(&dev
->fe
.ops
, &si2168_ops
, sizeof(struct dvb_frontend_ops
));
797 dev
->fe
.demodulator_priv
= client
;
798 *config
->i2c_adapter
= dev
->muxc
->adapter
[0];
799 *config
->fe
= &dev
->fe
;
800 dev
->ts_mode
= config
->ts_mode
;
801 dev
->ts_clock_inv
= config
->ts_clock_inv
;
802 dev
->ts_clock_gapped
= config
->ts_clock_gapped
;
803 dev
->spectral_inversion
= config
->spectral_inversion
;
805 dev_info(&client
->dev
, "Silicon Labs Si2168-%c%d%d successfully identified\n",
806 dev
->version
>> 24 & 0xff, dev
->version
>> 16 & 0xff,
807 dev
->version
>> 8 & 0xff);
808 dev_info(&client
->dev
, "firmware version: %c %d.%d.%d\n",
809 dev
->version
>> 24 & 0xff, dev
->version
>> 16 & 0xff,
810 dev
->version
>> 8 & 0xff, dev
->version
>> 0 & 0xff);
816 dev_warn(&client
->dev
, "probe failed = %d\n", ret
);
820 static int si2168_remove(struct i2c_client
*client
)
822 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
824 dev_dbg(&client
->dev
, "\n");
826 i2c_mux_del_adapters(dev
->muxc
);
828 dev
->fe
.ops
.release
= NULL
;
829 dev
->fe
.demodulator_priv
= NULL
;
836 static const struct i2c_device_id si2168_id_table
[] = {
840 MODULE_DEVICE_TABLE(i2c
, si2168_id_table
);
842 static struct i2c_driver si2168_driver
= {
845 .suppress_bind_attrs
= true,
847 .probe
= si2168_probe
,
848 .remove
= si2168_remove
,
849 .id_table
= si2168_id_table
,
852 module_i2c_driver(si2168_driver
);
854 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
855 MODULE_DESCRIPTION("Silicon Labs Si2168 DVB-T/T2/C demodulator driver");
856 MODULE_LICENSE("GPL");
857 MODULE_FIRMWARE(SI2168_A20_FIRMWARE
);
858 MODULE_FIRMWARE(SI2168_A30_FIRMWARE
);
859 MODULE_FIRMWARE(SI2168_B40_FIRMWARE
);
860 MODULE_FIRMWARE(SI2168_D60_FIRMWARE
);