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=%d\n",
159 c
->delivery_system
, c
->modulation
,
160 c
->frequency
, c
->bandwidth_hz
, c
->symbol_rate
,
161 c
->inversion
, c
->stream_id
);
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
= NULL
;
351 const unsigned int i2c_wr_max
= 8;
352 struct si2168_cmd cmd
;
353 unsigned int chip_id
;
355 dev_dbg(&client
->dev
, "\n");
358 memcpy(cmd
.args
, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
361 ret
= si2168_cmd_execute(client
, &cmd
);
365 if (dev
->fw_loaded
) {
367 memcpy(cmd
.args
, "\xc0\x06\x08\x0f\x00\x20\x21\x01", 8);
370 ret
= si2168_cmd_execute(client
, &cmd
);
374 memcpy(cmd
.args
, "\x85", 1);
377 ret
= si2168_cmd_execute(client
, &cmd
);
385 memcpy(cmd
.args
, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
388 ret
= si2168_cmd_execute(client
, &cmd
);
392 /* query chip revision */
393 memcpy(cmd
.args
, "\x02", 1);
396 ret
= si2168_cmd_execute(client
, &cmd
);
400 chip_id
= cmd
.args
[1] << 24 | cmd
.args
[2] << 16 | cmd
.args
[3] << 8 |
403 #define SI2168_A20 ('A' << 24 | 68 << 16 | '2' << 8 | '0' << 0)
404 #define SI2168_A30 ('A' << 24 | 68 << 16 | '3' << 8 | '0' << 0)
405 #define SI2168_B40 ('B' << 24 | 68 << 16 | '4' << 8 | '0' << 0)
409 fw_file
= SI2168_A20_FIRMWARE
;
412 fw_file
= SI2168_A30_FIRMWARE
;
415 fw_file
= SI2168_B40_FIRMWARE
;
418 dev_err(&client
->dev
,
419 "unknown chip version Si21%d-%c%c%c\n",
420 cmd
.args
[2], cmd
.args
[1],
421 cmd
.args
[3], cmd
.args
[4]);
426 /* cold state - try to download firmware */
427 dev_info(&client
->dev
, "found a '%s' in cold state\n",
428 si2168_ops
.info
.name
);
430 /* request the firmware, this will block and timeout */
431 ret
= request_firmware(&fw
, fw_file
, &client
->dev
);
433 /* fallback mechanism to handle old name for Si2168 B40 fw */
434 if (chip_id
== SI2168_B40
) {
435 fw_file
= SI2168_B40_FIRMWARE_FALLBACK
;
436 ret
= request_firmware(&fw
, fw_file
, &client
->dev
);
440 dev_notice(&client
->dev
,
441 "please install firmware file '%s'\n",
442 SI2168_B40_FIRMWARE
);
444 dev_err(&client
->dev
,
445 "firmware file '%s' not found\n",
447 goto err_release_firmware
;
451 dev_info(&client
->dev
, "downloading firmware from file '%s'\n",
454 if ((fw
->size
% 17 == 0) && (fw
->data
[0] > 5)) {
455 /* firmware is in the new format */
456 for (remaining
= fw
->size
; remaining
> 0; remaining
-= 17) {
457 len
= fw
->data
[fw
->size
- remaining
];
458 memcpy(cmd
.args
, &fw
->data
[(fw
->size
- remaining
) + 1], len
);
461 ret
= si2168_cmd_execute(client
, &cmd
);
463 dev_err(&client
->dev
,
464 "firmware download failed=%d\n",
466 goto err_release_firmware
;
470 /* firmware is in the old format */
471 for (remaining
= fw
->size
; remaining
> 0; remaining
-= i2c_wr_max
) {
473 if (len
> i2c_wr_max
)
476 memcpy(cmd
.args
, &fw
->data
[fw
->size
- remaining
], len
);
479 ret
= si2168_cmd_execute(client
, &cmd
);
481 dev_err(&client
->dev
,
482 "firmware download failed=%d\n",
484 goto err_release_firmware
;
489 release_firmware(fw
);
492 memcpy(cmd
.args
, "\x01\x01", 2);
495 ret
= si2168_cmd_execute(client
, &cmd
);
499 /* query firmware version */
500 memcpy(cmd
.args
, "\x11", 1);
503 ret
= si2168_cmd_execute(client
, &cmd
);
507 dev_info(&client
->dev
, "firmware version: %c.%c.%d\n",
508 cmd
.args
[6], cmd
.args
[7], cmd
.args
[8]);
511 memcpy(cmd
.args
, "\x14\x00\x01\x10\x10\x00", 6);
512 cmd
.args
[4] |= dev
->ts_mode
;
515 ret
= si2168_cmd_execute(client
, &cmd
);
519 dev
->fw_loaded
= true;
521 dev_info(&client
->dev
, "found a '%s' in warm state\n",
522 si2168_ops
.info
.name
);
527 err_release_firmware
:
528 release_firmware(fw
);
530 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
534 static int si2168_sleep(struct dvb_frontend
*fe
)
536 struct i2c_client
*client
= fe
->demodulator_priv
;
537 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
539 struct si2168_cmd cmd
;
541 dev_dbg(&client
->dev
, "\n");
545 memcpy(cmd
.args
, "\x13", 1);
548 ret
= si2168_cmd_execute(client
, &cmd
);
554 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
558 static int si2168_get_tune_settings(struct dvb_frontend
*fe
,
559 struct dvb_frontend_tune_settings
*s
)
561 s
->min_delay_ms
= 900;
568 * We must use unlocked i2c_transfer() here because I2C lock is already taken
571 static int si2168_select(struct i2c_adapter
*adap
, void *mux_priv
, u32 chan
)
573 struct i2c_client
*client
= mux_priv
;
574 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
576 struct i2c_msg gate_open_msg
= {
577 .addr
= client
->addr
,
580 .buf
= "\xc0\x0d\x01",
583 mutex_lock(&dev
->i2c_mutex
);
585 /* open tuner I2C gate */
586 ret
= __i2c_transfer(client
->adapter
, &gate_open_msg
, 1);
588 dev_warn(&client
->dev
, "i2c write failed=%d\n", ret
);
598 static int si2168_deselect(struct i2c_adapter
*adap
, void *mux_priv
, u32 chan
)
600 struct i2c_client
*client
= mux_priv
;
601 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
603 struct i2c_msg gate_close_msg
= {
604 .addr
= client
->addr
,
607 .buf
= "\xc0\x0d\x00",
610 /* close tuner I2C gate */
611 ret
= __i2c_transfer(client
->adapter
, &gate_close_msg
, 1);
613 dev_warn(&client
->dev
, "i2c write failed=%d\n", ret
);
620 mutex_unlock(&dev
->i2c_mutex
);
625 static const struct dvb_frontend_ops si2168_ops
= {
626 .delsys
= {SYS_DVBT
, SYS_DVBT2
, SYS_DVBC_ANNEX_A
},
628 .name
= "Silicon Labs Si2168",
629 .symbol_rate_min
= 1000000,
630 .symbol_rate_max
= 7200000,
631 .caps
= FE_CAN_FEC_1_2
|
644 FE_CAN_TRANSMISSION_MODE_AUTO
|
645 FE_CAN_GUARD_INTERVAL_AUTO
|
646 FE_CAN_HIERARCHY_AUTO
|
648 FE_CAN_2G_MODULATION
|
652 .get_tune_settings
= si2168_get_tune_settings
,
655 .sleep
= si2168_sleep
,
657 .set_frontend
= si2168_set_frontend
,
659 .read_status
= si2168_read_status
,
662 static int si2168_probe(struct i2c_client
*client
,
663 const struct i2c_device_id
*id
)
665 struct si2168_config
*config
= client
->dev
.platform_data
;
666 struct si2168_dev
*dev
;
669 dev_dbg(&client
->dev
, "\n");
671 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
674 dev_err(&client
->dev
, "kzalloc() failed\n");
678 mutex_init(&dev
->i2c_mutex
);
680 /* create mux i2c adapter for tuner */
681 dev
->adapter
= i2c_add_mux_adapter(client
->adapter
, &client
->dev
,
682 client
, 0, 0, 0, si2168_select
, si2168_deselect
);
683 if (dev
->adapter
== NULL
) {
688 /* create dvb_frontend */
689 memcpy(&dev
->fe
.ops
, &si2168_ops
, sizeof(struct dvb_frontend_ops
));
690 dev
->fe
.demodulator_priv
= client
;
691 *config
->i2c_adapter
= dev
->adapter
;
692 *config
->fe
= &dev
->fe
;
693 dev
->ts_mode
= config
->ts_mode
;
694 dev
->ts_clock_inv
= config
->ts_clock_inv
;
695 dev
->fw_loaded
= false;
697 i2c_set_clientdata(client
, dev
);
699 dev_info(&client
->dev
, "Silicon Labs Si2168 successfully attached\n");
703 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
707 static int si2168_remove(struct i2c_client
*client
)
709 struct si2168_dev
*dev
= i2c_get_clientdata(client
);
711 dev_dbg(&client
->dev
, "\n");
713 i2c_del_mux_adapter(dev
->adapter
);
715 dev
->fe
.ops
.release
= NULL
;
716 dev
->fe
.demodulator_priv
= NULL
;
723 static const struct i2c_device_id si2168_id_table
[] = {
727 MODULE_DEVICE_TABLE(i2c
, si2168_id_table
);
729 static struct i2c_driver si2168_driver
= {
731 .owner
= THIS_MODULE
,
734 .probe
= si2168_probe
,
735 .remove
= si2168_remove
,
736 .id_table
= si2168_id_table
,
739 module_i2c_driver(si2168_driver
);
741 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
742 MODULE_DESCRIPTION("Silicon Labs Si2168 DVB-T/T2/C demodulator driver");
743 MODULE_LICENSE("GPL");
744 MODULE_FIRMWARE(SI2168_A20_FIRMWARE
);
745 MODULE_FIRMWARE(SI2168_A30_FIRMWARE
);
746 MODULE_FIRMWARE(SI2168_B40_FIRMWARE
);