2 * Panasonic MN88473 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 "mn88473_priv.h"
19 static int mn88473_get_tune_settings(struct dvb_frontend *fe,
20 struct dvb_frontend_tune_settings *s)
22 s->min_delay_ms = 1000;
26 static int mn88473_set_frontend(struct dvb_frontend *fe)
28 struct i2c_client *client = fe->demodulator_priv;
29 struct mn88473_dev *dev = i2c_get_clientdata(client);
30 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
34 u8 delivery_system_val, if_val[3], *conf_val_ptr;
35 u8 reg_bank2_2d_val, reg_bank0_d2_val;
38 "delivery_system=%u modulation=%u frequency=%u bandwidth_hz=%u symbol_rate=%u inversion=%d stream_id=%d\n",
39 c->delivery_system, c->modulation, c->frequency,
40 c->bandwidth_hz, c->symbol_rate, c->inversion, c->stream_id);
47 switch (c->delivery_system) {
49 delivery_system_val = 0x02;
50 reg_bank2_2d_val = 0x23;
51 reg_bank0_d2_val = 0x2a;
54 delivery_system_val = 0x03;
55 reg_bank2_2d_val = 0x3b;
56 reg_bank0_d2_val = 0x29;
58 case SYS_DVBC_ANNEX_A:
59 delivery_system_val = 0x04;
60 reg_bank2_2d_val = 0x3b;
61 reg_bank0_d2_val = 0x29;
68 switch (c->delivery_system) {
71 switch (c->bandwidth_hz) {
73 conf_val_ptr = "\xe9\x55\x55\x1c\x29\x1c\x29";
76 conf_val_ptr = "\xc8\x00\x00\x17\x0a\x17\x0a";
79 conf_val_ptr = "\xaf\x00\x00\x11\xec\x11\xec";
86 case SYS_DVBC_ANNEX_A:
87 conf_val_ptr = "\x10\xab\x0d\xae\x1d\x9d";
94 if (fe->ops.tuner_ops.set_params) {
95 ret = fe->ops.tuner_ops.set_params(fe);
100 if (fe->ops.tuner_ops.get_if_frequency) {
101 ret = fe->ops.tuner_ops.get_if_frequency(fe, &if_frequency);
105 dev_dbg(&client->dev, "get_if_frequency=%u\n", if_frequency);
111 /* Calculate IF registers */
112 uitmp = DIV_ROUND_CLOSEST_ULL((u64) if_frequency * 0x1000000, dev->clk);
113 if_val[0] = (uitmp >> 16) & 0xff;
114 if_val[1] = (uitmp >> 8) & 0xff;
115 if_val[2] = (uitmp >> 0) & 0xff;
117 ret = regmap_write(dev->regmap[2], 0x05, 0x00);
120 ret = regmap_write(dev->regmap[2], 0xfb, 0x13);
123 ret = regmap_write(dev->regmap[2], 0xef, 0x13);
126 ret = regmap_write(dev->regmap[2], 0xf9, 0x13);
129 ret = regmap_write(dev->regmap[2], 0x00, 0x18);
132 ret = regmap_write(dev->regmap[2], 0x01, 0x01);
135 ret = regmap_write(dev->regmap[2], 0x02, 0x21);
138 ret = regmap_write(dev->regmap[2], 0x03, delivery_system_val);
141 ret = regmap_write(dev->regmap[2], 0x0b, 0x00);
145 for (i = 0; i < sizeof(if_val); i++) {
146 ret = regmap_write(dev->regmap[2], 0x10 + i, if_val[i]);
151 switch (c->delivery_system) {
154 for (i = 0; i < 7; i++) {
155 ret = regmap_write(dev->regmap[2], 0x13 + i,
161 case SYS_DVBC_ANNEX_A:
162 ret = regmap_bulk_write(dev->regmap[1], 0x10, conf_val_ptr, 6);
170 ret = regmap_write(dev->regmap[2], 0x2d, reg_bank2_2d_val);
173 ret = regmap_write(dev->regmap[2], 0x2e, 0x00);
176 ret = regmap_write(dev->regmap[2], 0x56, 0x0d);
179 ret = regmap_bulk_write(dev->regmap[0], 0x01,
180 "\xba\x13\x80\xba\x91\xdd\xe7\x28", 8);
183 ret = regmap_write(dev->regmap[0], 0x0a, 0x1a);
186 ret = regmap_write(dev->regmap[0], 0x13, 0x1f);
189 ret = regmap_write(dev->regmap[0], 0x19, 0x03);
192 ret = regmap_write(dev->regmap[0], 0x1d, 0xb0);
195 ret = regmap_write(dev->regmap[0], 0x2a, 0x72);
198 ret = regmap_write(dev->regmap[0], 0x2d, 0x00);
201 ret = regmap_write(dev->regmap[0], 0x3c, 0x00);
204 ret = regmap_write(dev->regmap[0], 0x3f, 0xf8);
207 ret = regmap_bulk_write(dev->regmap[0], 0x40, "\xf4\x08", 2);
210 ret = regmap_write(dev->regmap[0], 0xd2, reg_bank0_d2_val);
213 ret = regmap_write(dev->regmap[0], 0xd4, 0x55);
216 ret = regmap_write(dev->regmap[1], 0xbe, 0x08);
219 ret = regmap_write(dev->regmap[0], 0xb2, 0x37);
222 ret = regmap_write(dev->regmap[0], 0xd7, 0x04);
227 if (c->delivery_system == SYS_DVBT2) {
228 ret = regmap_write(dev->regmap[2], 0x36,
229 (c->stream_id == NO_STREAM_ID_FILTER) ? 0 :
236 ret = regmap_write(dev->regmap[2], 0xf8, 0x9f);
242 dev_dbg(&client->dev, "failed=%d\n", ret);
246 static int mn88473_read_status(struct dvb_frontend *fe, enum fe_status *status)
248 struct i2c_client *client = fe->demodulator_priv;
249 struct mn88473_dev *dev = i2c_get_clientdata(client);
250 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
252 unsigned int utmp, utmp1, utmp2;
261 switch (c->delivery_system) {
263 ret = regmap_read(dev->regmap[0], 0x62, &utmp);
267 if (!(utmp & 0xa0)) {
268 if ((utmp & 0x0f) >= 0x09)
269 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER |
270 FE_HAS_VITERBI | FE_HAS_SYNC |
272 else if ((utmp & 0x0f) >= 0x03)
273 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER;
279 ret = regmap_read(dev->regmap[2], 0x8b, &utmp);
283 if (!(utmp & 0x40)) {
284 if ((utmp & 0x0f) >= 0x0d)
285 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER |
286 FE_HAS_VITERBI | FE_HAS_SYNC |
288 else if ((utmp & 0x0f) >= 0x0a)
289 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER |
291 else if ((utmp & 0x0f) >= 0x07)
292 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER;
297 case SYS_DVBC_ANNEX_A:
298 ret = regmap_read(dev->regmap[1], 0x85, &utmp);
302 if (!(utmp & 0x40)) {
303 ret = regmap_read(dev->regmap[1], 0x89, &utmp);
308 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER |
309 FE_HAS_VITERBI | FE_HAS_SYNC |
320 /* Signal strength */
321 if (*status & FE_HAS_SIGNAL) {
322 for (i = 0; i < 2; i++) {
323 ret = regmap_bulk_read(dev->regmap[2], 0x86 + i,
329 /* AGCRD[15:6] gives us a 10bit value ([5:0] are always 0) */
330 utmp1 = buf[0] << 8 | buf[1] << 0 | buf[0] >> 2;
331 dev_dbg(&client->dev, "strength=%u\n", utmp1);
333 c->strength.stat[0].scale = FE_SCALE_RELATIVE;
334 c->strength.stat[0].uvalue = utmp1;
336 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
340 if (*status & FE_HAS_VITERBI && c->delivery_system == SYS_DVBT) {
342 ret = regmap_bulk_read(dev->regmap[0], 0x8f, buf, 2);
346 utmp = buf[0] << 8 | buf[1] << 0;
348 /* CNR[dB]: 10 * (log10(65536 / value) + 0.2) */
349 /* log10(65536) = 80807124, 0.2 = 3355443 */
350 stmp = div_u64(((u64)80807124 - intlog10(utmp)
351 + 3355443) * 10000, 1 << 24);
352 dev_dbg(&client->dev, "cnr=%d value=%u\n", stmp, utmp);
357 c->cnr.stat[0].svalue = stmp;
358 c->cnr.stat[0].scale = FE_SCALE_DECIBEL;
359 } else if (*status & FE_HAS_VITERBI &&
360 c->delivery_system == SYS_DVBT2) {
362 for (i = 0; i < 3; i++) {
363 ret = regmap_bulk_read(dev->regmap[2], 0xb7 + i,
369 utmp = buf[1] << 8 | buf[2] << 0;
370 utmp1 = (buf[0] >> 2) & 0x01; /* 0=SISO, 1=MISO */
373 /* CNR[dB]: 10 * (log10(16384 / value) - 0.6) */
374 /* log10(16384) = 70706234, 0.6 = 10066330 */
375 stmp = div_u64(((u64)70706234 - intlog10(utmp)
376 - 10066330) * 10000, 1 << 24);
377 dev_dbg(&client->dev, "cnr=%d value=%u MISO\n",
380 /* CNR[dB]: 10 * (log10(65536 / value) + 0.2) */
381 /* log10(65536) = 80807124, 0.2 = 3355443 */
382 stmp = div_u64(((u64)80807124 - intlog10(utmp)
383 + 3355443) * 10000, 1 << 24);
384 dev_dbg(&client->dev, "cnr=%d value=%u SISO\n",
391 c->cnr.stat[0].svalue = stmp;
392 c->cnr.stat[0].scale = FE_SCALE_DECIBEL;
393 } else if (*status & FE_HAS_VITERBI &&
394 c->delivery_system == SYS_DVBC_ANNEX_A) {
396 ret = regmap_bulk_read(dev->regmap[1], 0xa1, buf, 4);
400 utmp1 = buf[0] << 8 | buf[1] << 0; /* signal */
401 utmp2 = buf[2] << 8 | buf[3] << 0; /* noise */
402 if (utmp1 && utmp2) {
403 /* CNR[dB]: 10 * log10(8 * (signal / noise)) */
404 /* log10(8) = 15151336 */
405 stmp = div_u64(((u64)15151336 + intlog10(utmp1)
406 - intlog10(utmp2)) * 10000, 1 << 24);
407 dev_dbg(&client->dev, "cnr=%d signal=%u noise=%u\n",
413 c->cnr.stat[0].svalue = stmp;
414 c->cnr.stat[0].scale = FE_SCALE_DECIBEL;
416 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
420 if (*status & FE_HAS_LOCK && (c->delivery_system == SYS_DVBT ||
421 c->delivery_system == SYS_DVBC_ANNEX_A)) {
422 /* DVB-T & DVB-C BER */
423 ret = regmap_bulk_read(dev->regmap[0], 0x92, buf, 5);
427 utmp1 = buf[0] << 16 | buf[1] << 8 | buf[2] << 0;
428 utmp2 = buf[3] << 8 | buf[4] << 0;
429 utmp2 = utmp2 * 8 * 204;
430 dev_dbg(&client->dev, "post_bit_error=%u post_bit_count=%u\n",
433 c->post_bit_error.stat[0].scale = FE_SCALE_COUNTER;
434 c->post_bit_error.stat[0].uvalue += utmp1;
435 c->post_bit_count.stat[0].scale = FE_SCALE_COUNTER;
436 c->post_bit_count.stat[0].uvalue += utmp2;
438 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
439 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
443 if (*status & FE_HAS_LOCK) {
444 ret = regmap_bulk_read(dev->regmap[0], 0xdd, buf, 4);
448 utmp1 = buf[0] << 8 | buf[1] << 0;
449 utmp2 = buf[2] << 8 | buf[3] << 0;
450 dev_dbg(&client->dev, "block_error=%u block_count=%u\n",
453 c->block_error.stat[0].scale = FE_SCALE_COUNTER;
454 c->block_error.stat[0].uvalue += utmp1;
455 c->block_count.stat[0].scale = FE_SCALE_COUNTER;
456 c->block_count.stat[0].uvalue += utmp2;
458 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
459 c->block_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
464 dev_dbg(&client->dev, "failed=%d\n", ret);
468 static int mn88473_init(struct dvb_frontend *fe)
470 struct i2c_client *client = fe->demodulator_priv;
471 struct mn88473_dev *dev = i2c_get_clientdata(client);
472 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
473 int ret, len, remain;
475 const struct firmware *fw;
476 const char *name = MN88473_FIRMWARE;
478 dev_dbg(&client->dev, "\n");
480 /* Check if firmware is already running */
481 ret = regmap_read(dev->regmap[0], 0xf5, &uitmp);
488 /* Request the firmware, this will block and timeout */
489 ret = request_firmware(&fw, name, &client->dev);
491 dev_err(&client->dev, "firmware file '%s' not found\n", name);
495 dev_info(&client->dev, "downloading firmware from file '%s'\n", name);
497 ret = regmap_write(dev->regmap[0], 0xf5, 0x03);
499 goto err_release_firmware;
501 for (remain = fw->size; remain > 0; remain -= (dev->i2c_wr_max - 1)) {
502 len = min(dev->i2c_wr_max - 1, remain);
503 ret = regmap_bulk_write(dev->regmap[0], 0xf6,
504 &fw->data[fw->size - remain], len);
506 dev_err(&client->dev, "firmware download failed %d\n",
508 goto err_release_firmware;
512 release_firmware(fw);
514 /* Parity check of firmware */
515 ret = regmap_read(dev->regmap[0], 0xf8, &uitmp);
520 dev_err(&client->dev, "firmware parity check failed\n");
525 ret = regmap_write(dev->regmap[0], 0xf5, 0x00);
530 ret = regmap_write(dev->regmap[2], 0x09, 0x08);
533 ret = regmap_write(dev->regmap[2], 0x08, 0x1d);
539 /* init stats here to indicate which stats are supported */
541 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
543 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
544 c->post_bit_error.len = 1;
545 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
546 c->post_bit_count.len = 1;
547 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
548 c->block_error.len = 1;
549 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
550 c->block_count.len = 1;
551 c->block_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
554 err_release_firmware:
555 release_firmware(fw);
557 dev_dbg(&client->dev, "failed=%d\n", ret);
561 static int mn88473_sleep(struct dvb_frontend *fe)
563 struct i2c_client *client = fe->demodulator_priv;
564 struct mn88473_dev *dev = i2c_get_clientdata(client);
567 dev_dbg(&client->dev, "\n");
571 ret = regmap_write(dev->regmap[2], 0x05, 0x3e);
577 dev_dbg(&client->dev, "failed=%d\n", ret);
581 static const struct dvb_frontend_ops mn88473_ops = {
582 .delsys = {SYS_DVBT, SYS_DVBT2, SYS_DVBC_ANNEX_A},
584 .name = "Panasonic MN88473",
585 .symbol_rate_min = 1000000,
586 .symbol_rate_max = 7200000,
587 .caps = FE_CAN_FEC_1_2 |
600 FE_CAN_TRANSMISSION_MODE_AUTO |
601 FE_CAN_GUARD_INTERVAL_AUTO |
602 FE_CAN_HIERARCHY_AUTO |
604 FE_CAN_2G_MODULATION |
608 .get_tune_settings = mn88473_get_tune_settings,
610 .init = mn88473_init,
611 .sleep = mn88473_sleep,
613 .set_frontend = mn88473_set_frontend,
615 .read_status = mn88473_read_status,
618 static int mn88473_probe(struct i2c_client *client,
619 const struct i2c_device_id *id)
621 struct mn88473_config *config = client->dev.platform_data;
622 struct mn88473_dev *dev;
625 static const struct regmap_config regmap_config = {
630 dev_dbg(&client->dev, "\n");
632 /* Caller really need to provide pointer for frontend we create */
633 if (config->fe == NULL) {
634 dev_err(&client->dev, "frontend pointer not defined\n");
639 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
645 if (config->i2c_wr_max)
646 dev->i2c_wr_max = config->i2c_wr_max;
648 dev->i2c_wr_max = ~0;
651 dev->clk = config->xtal;
654 dev->client[0] = client;
655 dev->regmap[0] = regmap_init_i2c(dev->client[0], ®map_config);
656 if (IS_ERR(dev->regmap[0])) {
657 ret = PTR_ERR(dev->regmap[0]);
662 * Chip has three I2C addresses for different register banks. Used
663 * addresses are 0x18, 0x1a and 0x1c. We register two dummy clients,
664 * 0x1a and 0x1c, in order to get own I2C client for each register bank.
666 * Also, register bank 2 do not support sequential I/O. Only single
667 * register write or read is allowed to that bank.
669 dev->client[1] = i2c_new_dummy(client->adapter, 0x1a);
670 if (dev->client[1] == NULL) {
672 dev_err(&client->dev, "I2C registration failed\n");
674 goto err_regmap_0_regmap_exit;
676 dev->regmap[1] = regmap_init_i2c(dev->client[1], ®map_config);
677 if (IS_ERR(dev->regmap[1])) {
678 ret = PTR_ERR(dev->regmap[1]);
679 goto err_client_1_i2c_unregister_device;
681 i2c_set_clientdata(dev->client[1], dev);
683 dev->client[2] = i2c_new_dummy(client->adapter, 0x1c);
684 if (dev->client[2] == NULL) {
686 dev_err(&client->dev, "2nd I2C registration failed\n");
688 goto err_regmap_1_regmap_exit;
690 dev->regmap[2] = regmap_init_i2c(dev->client[2], ®map_config);
691 if (IS_ERR(dev->regmap[2])) {
692 ret = PTR_ERR(dev->regmap[2]);
693 goto err_client_2_i2c_unregister_device;
695 i2c_set_clientdata(dev->client[2], dev);
697 /* Check demod answers with correct chip id */
698 ret = regmap_read(dev->regmap[2], 0xff, &uitmp);
700 goto err_regmap_2_regmap_exit;
702 dev_dbg(&client->dev, "chip id=%02x\n", uitmp);
706 goto err_regmap_2_regmap_exit;
709 /* Sleep because chip is active by default */
710 ret = regmap_write(dev->regmap[2], 0x05, 0x3e);
712 goto err_regmap_2_regmap_exit;
714 /* Create dvb frontend */
715 memcpy(&dev->frontend.ops, &mn88473_ops, sizeof(dev->frontend.ops));
716 dev->frontend.demodulator_priv = client;
717 *config->fe = &dev->frontend;
718 i2c_set_clientdata(client, dev);
720 dev_info(&client->dev, "Panasonic MN88473 successfully identified\n");
723 err_regmap_2_regmap_exit:
724 regmap_exit(dev->regmap[2]);
725 err_client_2_i2c_unregister_device:
726 i2c_unregister_device(dev->client[2]);
727 err_regmap_1_regmap_exit:
728 regmap_exit(dev->regmap[1]);
729 err_client_1_i2c_unregister_device:
730 i2c_unregister_device(dev->client[1]);
731 err_regmap_0_regmap_exit:
732 regmap_exit(dev->regmap[0]);
736 dev_dbg(&client->dev, "failed=%d\n", ret);
740 static int mn88473_remove(struct i2c_client *client)
742 struct mn88473_dev *dev = i2c_get_clientdata(client);
744 dev_dbg(&client->dev, "\n");
746 regmap_exit(dev->regmap[2]);
747 i2c_unregister_device(dev->client[2]);
749 regmap_exit(dev->regmap[1]);
750 i2c_unregister_device(dev->client[1]);
752 regmap_exit(dev->regmap[0]);
759 static const struct i2c_device_id mn88473_id_table[] = {
763 MODULE_DEVICE_TABLE(i2c, mn88473_id_table);
765 static struct i2c_driver mn88473_driver = {
768 .suppress_bind_attrs = true,
770 .probe = mn88473_probe,
771 .remove = mn88473_remove,
772 .id_table = mn88473_id_table,
775 module_i2c_driver(mn88473_driver);
777 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
778 MODULE_DESCRIPTION("Panasonic MN88473 DVB-T/T2/C demodulator driver");
779 MODULE_LICENSE("GPL");
780 MODULE_FIRMWARE(MN88473_FIRMWARE);