2 * Silicon Labs Si2168 DVB-T/T2/C demodulator driver
4 * Copyright (C) 2014 Antti Palosaari <crope@iki.fi>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 #include "si2168_priv.h"
19 static const struct dvb_frontend_ops si2168_ops
;
21 /* execute firmware command */
22 static int si2168_cmd_execute(struct i2c_client
*client
, struct si2168_cmd
*cmd
)
24 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
26 unsigned long timeout
;
28 mutex_lock(&dev
->i2c_mutex
);
31 /* write cmd and args for firmware */
32 ret
= i2c_master_send(client
, cmd
->args
, cmd
->wlen
);
34 goto err_mutex_unlock
;
35 } else if (ret
!= cmd
->wlen
) {
37 goto err_mutex_unlock
;
42 /* wait cmd execution terminate */
44 timeout
= jiffies
+ msecs_to_jiffies(TIMEOUT
);
45 while (!time_after(jiffies
, timeout
)) {
46 ret
= i2c_master_recv(client
, cmd
->args
, cmd
->rlen
);
48 goto err_mutex_unlock
;
49 } else if (ret
!= cmd
->rlen
) {
51 goto err_mutex_unlock
;
55 if ((cmd
->args
[0] >> 7) & 0x01)
59 dev_dbg(&client
->dev
, "cmd execution took %d ms\n",
60 jiffies_to_msecs(jiffies
) -
61 (jiffies_to_msecs(timeout
) - TIMEOUT
));
63 if (!((cmd
->args
[0] >> 7) & 0x01)) {
65 goto err_mutex_unlock
;
69 mutex_unlock(&dev
->i2c_mutex
);
73 mutex_unlock(&dev
->i2c_mutex
);
74 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
78 static int si2168_read_status(struct dvb_frontend
*fe
, fe_status_t
*status
)
80 struct i2c_client
*client
= fe
->demodulator_priv
;
81 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
82 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
84 struct si2168_cmd cmd
;
93 switch (c
->delivery_system
) {
95 memcpy(cmd
.args
, "\xa0\x01", 2);
99 case SYS_DVBC_ANNEX_A
:
100 memcpy(cmd
.args
, "\x90\x01", 2);
105 memcpy(cmd
.args
, "\x50\x01", 2);
114 ret
= si2168_cmd_execute(client
, &cmd
);
118 switch ((cmd
.args
[2] >> 1) & 0x03) {
120 *status
= FE_HAS_SIGNAL
| FE_HAS_CARRIER
;
123 *status
= FE_HAS_SIGNAL
| FE_HAS_CARRIER
| FE_HAS_VITERBI
|
124 FE_HAS_SYNC
| FE_HAS_LOCK
;
128 dev
->fe_status
= *status
;
130 if (*status
& FE_HAS_LOCK
) {
132 c
->cnr
.stat
[0].scale
= FE_SCALE_DECIBEL
;
133 c
->cnr
.stat
[0].svalue
= cmd
.args
[3] * 1000 / 4;
136 c
->cnr
.stat
[0].scale
= FE_SCALE_NOT_AVAILABLE
;
139 dev_dbg(&client
->dev
, "status=%02x args=%*ph\n",
140 *status
, cmd
.rlen
, cmd
.args
);
144 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
148 static int si2168_set_frontend(struct dvb_frontend
*fe
)
150 struct i2c_client
*client
= fe
->demodulator_priv
;
151 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
152 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
154 struct si2168_cmd cmd
;
155 u8 bandwidth
, delivery_system
;
157 dev_dbg(&client
->dev
,
158 "delivery_system=%u modulation=%u frequency=%u bandwidth_hz=%u symbol_rate=%u inversion=%u stream_id=%u\n",
159 c
->delivery_system
, c
->modulation
, c
->frequency
,
160 c
->bandwidth_hz
, c
->symbol_rate
, c
->inversion
,
168 switch (c
->delivery_system
) {
170 delivery_system
= 0x20;
172 case SYS_DVBC_ANNEX_A
:
173 delivery_system
= 0x30;
176 delivery_system
= 0x70;
183 if (c
->bandwidth_hz
<= 5000000)
185 else if (c
->bandwidth_hz
<= 6000000)
187 else if (c
->bandwidth_hz
<= 7000000)
189 else if (c
->bandwidth_hz
<= 8000000)
191 else if (c
->bandwidth_hz
<= 9000000)
193 else if (c
->bandwidth_hz
<= 10000000)
199 if (fe
->ops
.tuner_ops
.set_params
) {
200 ret
= fe
->ops
.tuner_ops
.set_params(fe
);
205 memcpy(cmd
.args
, "\x88\x02\x02\x02\x02", 5);
208 ret
= si2168_cmd_execute(client
, &cmd
);
212 /* that has no big effect */
213 if (c
->delivery_system
== SYS_DVBT
)
214 memcpy(cmd
.args
, "\x89\x21\x06\x11\xff\x98", 6);
215 else if (c
->delivery_system
== SYS_DVBC_ANNEX_A
)
216 memcpy(cmd
.args
, "\x89\x21\x06\x11\x89\xf0", 6);
217 else if (c
->delivery_system
== SYS_DVBT2
)
218 memcpy(cmd
.args
, "\x89\x21\x06\x11\x89\x20", 6);
221 ret
= si2168_cmd_execute(client
, &cmd
);
225 if (c
->delivery_system
== SYS_DVBT2
) {
228 cmd
.args
[1] = c
->stream_id
& 0xff;
229 cmd
.args
[2] = c
->stream_id
== NO_STREAM_ID_FILTER
? 0 : 1;
232 ret
= si2168_cmd_execute(client
, &cmd
);
237 memcpy(cmd
.args
, "\x51\x03", 2);
240 ret
= si2168_cmd_execute(client
, &cmd
);
244 memcpy(cmd
.args
, "\x12\x08\x04", 3);
247 ret
= si2168_cmd_execute(client
, &cmd
);
251 memcpy(cmd
.args
, "\x14\x00\x0c\x10\x12\x00", 6);
254 ret
= si2168_cmd_execute(client
, &cmd
);
258 memcpy(cmd
.args
, "\x14\x00\x06\x10\x24\x00", 6);
261 ret
= si2168_cmd_execute(client
, &cmd
);
265 memcpy(cmd
.args
, "\x14\x00\x07\x10\x00\x24", 6);
268 ret
= si2168_cmd_execute(client
, &cmd
);
272 memcpy(cmd
.args
, "\x14\x00\x0a\x10\x00\x00", 6);
273 cmd
.args
[4] = delivery_system
| bandwidth
;
276 ret
= si2168_cmd_execute(client
, &cmd
);
280 /* set DVB-C symbol rate */
281 if (c
->delivery_system
== SYS_DVBC_ANNEX_A
) {
282 memcpy(cmd
.args
, "\x14\x00\x02\x11", 4);
283 cmd
.args
[4] = ((c
->symbol_rate
/ 1000) >> 0) & 0xff;
284 cmd
.args
[5] = ((c
->symbol_rate
/ 1000) >> 8) & 0xff;
287 ret
= si2168_cmd_execute(client
, &cmd
);
292 memcpy(cmd
.args
, "\x14\x00\x0f\x10\x10\x00", 6);
295 ret
= si2168_cmd_execute(client
, &cmd
);
299 memcpy(cmd
.args
, "\x14\x00\x09\x10\xe3\x08", 6);
300 cmd
.args
[5] |= dev
->ts_clock_inv
? 0x00 : 0x10;
303 ret
= si2168_cmd_execute(client
, &cmd
);
307 memcpy(cmd
.args
, "\x14\x00\x08\x10\xd7\x05", 6);
308 cmd
.args
[5] |= dev
->ts_clock_inv
? 0x00 : 0x10;
311 ret
= si2168_cmd_execute(client
, &cmd
);
315 memcpy(cmd
.args
, "\x14\x00\x01\x12\x00\x00", 6);
318 ret
= si2168_cmd_execute(client
, &cmd
);
322 memcpy(cmd
.args
, "\x14\x00\x01\x03\x0c\x00", 6);
325 ret
= si2168_cmd_execute(client
, &cmd
);
329 memcpy(cmd
.args
, "\x85", 1);
332 ret
= si2168_cmd_execute(client
, &cmd
);
336 dev
->delivery_system
= c
->delivery_system
;
340 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
344 static int si2168_init(struct dvb_frontend
*fe
)
346 struct i2c_client
*client
= fe
->demodulator_priv
;
347 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
348 int ret
, len
, remaining
;
349 const struct firmware
*fw
;
351 struct si2168_cmd cmd
;
352 unsigned int chip_id
;
354 dev_dbg(&client
->dev
, "\n");
357 memcpy(cmd
.args
, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
360 ret
= si2168_cmd_execute(client
, &cmd
);
364 if (dev
->fw_loaded
) {
366 memcpy(cmd
.args
, "\xc0\x06\x08\x0f\x00\x20\x21\x01", 8);
369 ret
= si2168_cmd_execute(client
, &cmd
);
373 memcpy(cmd
.args
, "\x85", 1);
376 ret
= si2168_cmd_execute(client
, &cmd
);
384 memcpy(cmd
.args
, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
387 ret
= si2168_cmd_execute(client
, &cmd
);
391 /* query chip revision */
392 memcpy(cmd
.args
, "\x02", 1);
395 ret
= si2168_cmd_execute(client
, &cmd
);
399 chip_id
= cmd
.args
[1] << 24 | cmd
.args
[2] << 16 | cmd
.args
[3] << 8 |
402 #define SI2168_A20 ('A' << 24 | 68 << 16 | '2' << 8 | '0' << 0)
403 #define SI2168_A30 ('A' << 24 | 68 << 16 | '3' << 8 | '0' << 0)
404 #define SI2168_B40 ('B' << 24 | 68 << 16 | '4' << 8 | '0' << 0)
408 fw_file
= SI2168_A20_FIRMWARE
;
411 fw_file
= SI2168_A30_FIRMWARE
;
414 fw_file
= SI2168_B40_FIRMWARE
;
417 dev_err(&client
->dev
, "unknown chip version Si21%d-%c%c%c\n",
418 cmd
.args
[2], cmd
.args
[1],
419 cmd
.args
[3], cmd
.args
[4]);
424 dev_info(&client
->dev
, "found a 'Silicon Labs Si21%d-%c%c%c'\n",
425 cmd
.args
[2], cmd
.args
[1], cmd
.args
[3], cmd
.args
[4]);
427 /* request the firmware, this will block and timeout */
428 ret
= request_firmware(&fw
, fw_file
, &client
->dev
);
430 /* fallback mechanism to handle old name for Si2168 B40 fw */
431 if (chip_id
== SI2168_B40
) {
432 fw_file
= SI2168_B40_FIRMWARE_FALLBACK
;
433 ret
= request_firmware(&fw
, fw_file
, &client
->dev
);
437 dev_notice(&client
->dev
,
438 "please install firmware file '%s'\n",
439 SI2168_B40_FIRMWARE
);
441 dev_err(&client
->dev
,
442 "firmware file '%s' not found\n",
444 goto err_release_firmware
;
448 dev_info(&client
->dev
, "downloading firmware from file '%s'\n",
451 if ((fw
->size
% 17 == 0) && (fw
->data
[0] > 5)) {
452 /* firmware is in the new format */
453 for (remaining
= fw
->size
; remaining
> 0; remaining
-= 17) {
454 len
= fw
->data
[fw
->size
- remaining
];
455 memcpy(cmd
.args
, &fw
->data
[(fw
->size
- remaining
) + 1], len
);
458 ret
= si2168_cmd_execute(client
, &cmd
);
462 } else if (fw
->size
% 8 == 0) {
463 /* firmware is in the old format */
464 for (remaining
= fw
->size
; remaining
> 0; remaining
-= 8) {
466 memcpy(cmd
.args
, &fw
->data
[fw
->size
- remaining
], len
);
469 ret
= si2168_cmd_execute(client
, &cmd
);
474 /* bad or unknown firmware format */
479 dev_err(&client
->dev
, "firmware download failed %d\n", ret
);
480 goto err_release_firmware
;
483 release_firmware(fw
);
485 memcpy(cmd
.args
, "\x01\x01", 2);
488 ret
= si2168_cmd_execute(client
, &cmd
);
492 /* query firmware version */
493 memcpy(cmd
.args
, "\x11", 1);
496 ret
= si2168_cmd_execute(client
, &cmd
);
500 dev_info(&client
->dev
, "firmware version: %c.%c.%d\n",
501 cmd
.args
[6], cmd
.args
[7], cmd
.args
[8]);
504 memcpy(cmd
.args
, "\x14\x00\x01\x10\x10\x00", 6);
505 cmd
.args
[4] |= dev
->ts_mode
;
508 ret
= si2168_cmd_execute(client
, &cmd
);
512 dev
->fw_loaded
= true;
518 err_release_firmware
:
519 release_firmware(fw
);
521 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
525 static int si2168_sleep(struct dvb_frontend
*fe
)
527 struct i2c_client
*client
= fe
->demodulator_priv
;
528 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
530 struct si2168_cmd cmd
;
532 dev_dbg(&client
->dev
, "\n");
536 memcpy(cmd
.args
, "\x13", 1);
539 ret
= si2168_cmd_execute(client
, &cmd
);
545 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
549 static int si2168_get_tune_settings(struct dvb_frontend
*fe
,
550 struct dvb_frontend_tune_settings
*s
)
552 s
->min_delay_ms
= 900;
559 * We must use unlocked i2c_transfer() here because I2C lock is already taken
562 static int si2168_select(struct i2c_adapter
*adap
, void *mux_priv
, u32 chan
)
564 struct i2c_client
*client
= mux_priv
;
565 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
567 struct i2c_msg gate_open_msg
= {
568 .addr
= client
->addr
,
571 .buf
= "\xc0\x0d\x01",
574 mutex_lock(&dev
->i2c_mutex
);
576 /* open tuner I2C gate */
577 ret
= __i2c_transfer(client
->adapter
, &gate_open_msg
, 1);
579 dev_warn(&client
->dev
, "i2c write failed=%d\n", ret
);
589 static int si2168_deselect(struct i2c_adapter
*adap
, void *mux_priv
, u32 chan
)
591 struct i2c_client
*client
= mux_priv
;
592 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
594 struct i2c_msg gate_close_msg
= {
595 .addr
= client
->addr
,
598 .buf
= "\xc0\x0d\x00",
601 /* close tuner I2C gate */
602 ret
= __i2c_transfer(client
->adapter
, &gate_close_msg
, 1);
604 dev_warn(&client
->dev
, "i2c write failed=%d\n", ret
);
611 mutex_unlock(&dev
->i2c_mutex
);
616 static const struct dvb_frontend_ops si2168_ops
= {
617 .delsys
= {SYS_DVBT
, SYS_DVBT2
, SYS_DVBC_ANNEX_A
},
619 .name
= "Silicon Labs Si2168",
620 .symbol_rate_min
= 1000000,
621 .symbol_rate_max
= 7200000,
622 .caps
= FE_CAN_FEC_1_2
|
635 FE_CAN_TRANSMISSION_MODE_AUTO
|
636 FE_CAN_GUARD_INTERVAL_AUTO
|
637 FE_CAN_HIERARCHY_AUTO
|
639 FE_CAN_2G_MODULATION
|
643 .get_tune_settings
= si2168_get_tune_settings
,
646 .sleep
= si2168_sleep
,
648 .set_frontend
= si2168_set_frontend
,
650 .read_status
= si2168_read_status
,
653 static int si2168_probe(struct i2c_client
*client
,
654 const struct i2c_device_id
*id
)
656 struct si2168_config
*config
= client
->dev
.platform_data
;
657 struct si2168_dev
*dev
;
660 dev_dbg(&client
->dev
, "\n");
662 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
665 dev_err(&client
->dev
, "kzalloc() failed\n");
669 mutex_init(&dev
->i2c_mutex
);
671 /* create mux i2c adapter for tuner */
672 dev
->adapter
= i2c_add_mux_adapter(client
->adapter
, &client
->dev
,
673 client
, 0, 0, 0, si2168_select
, si2168_deselect
);
674 if (dev
->adapter
== NULL
) {
679 /* create dvb_frontend */
680 memcpy(&dev
->fe
.ops
, &si2168_ops
, sizeof(struct dvb_frontend_ops
));
681 dev
->fe
.demodulator_priv
= client
;
682 *config
->i2c_adapter
= dev
->adapter
;
683 *config
->fe
= &dev
->fe
;
684 dev
->ts_mode
= config
->ts_mode
;
685 dev
->ts_clock_inv
= config
->ts_clock_inv
;
686 dev
->fw_loaded
= false;
688 i2c_set_clientdata(client
, dev
);
690 dev_info(&client
->dev
, "Silicon Labs Si2168 successfully attached\n");
695 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
699 static int si2168_remove(struct i2c_client
*client
)
701 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
703 dev_dbg(&client
->dev
, "\n");
705 i2c_del_mux_adapter(dev
->adapter
);
707 dev
->fe
.ops
.release
= NULL
;
708 dev
->fe
.demodulator_priv
= NULL
;
715 static const struct i2c_device_id si2168_id_table
[] = {
719 MODULE_DEVICE_TABLE(i2c
, si2168_id_table
);
721 static struct i2c_driver si2168_driver
= {
723 .owner
= THIS_MODULE
,
726 .probe
= si2168_probe
,
727 .remove
= si2168_remove
,
728 .id_table
= si2168_id_table
,
731 module_i2c_driver(si2168_driver
);
733 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
734 MODULE_DESCRIPTION("Silicon Labs Si2168 DVB-T/T2/C demodulator driver");
735 MODULE_LICENSE("GPL");
736 MODULE_FIRMWARE(SI2168_A20_FIRMWARE
);
737 MODULE_FIRMWARE(SI2168_A30_FIRMWARE
);
738 MODULE_FIRMWARE(SI2168_B40_FIRMWARE
);