2 * HDIC HD29L2 DMB-TH demodulator driver
4 * Copyright (C) 2011 Metropolia University of Applied Sciences, Electria R&D
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include "hd29l2_priv.h"
25 /* write multiple registers */
26 static int hd29l2_wr_regs(struct hd29l2_priv *priv, u8 reg, u8 *val, int len)
30 struct i2c_msg msg[1] = {
32 .addr = priv->cfg.i2c_addr,
41 memcpy(&buf[2], val, len);
43 ret = i2c_transfer(priv->i2c, msg, 1);
47 dev_warn(&priv->i2c->dev,
48 "%s: i2c wr failed=%d reg=%02x len=%d\n",
49 KBUILD_MODNAME, ret, reg, len);
56 /* read multiple registers */
57 static int hd29l2_rd_regs(struct hd29l2_priv *priv, u8 reg, u8 *val, int len)
60 u8 buf[2] = { 0x00, reg };
61 struct i2c_msg msg[2] = {
63 .addr = priv->cfg.i2c_addr,
68 .addr = priv->cfg.i2c_addr,
75 ret = i2c_transfer(priv->i2c, msg, 2);
79 dev_warn(&priv->i2c->dev,
80 "%s: i2c rd failed=%d reg=%02x len=%d\n",
81 KBUILD_MODNAME, ret, reg, len);
88 /* write single register */
89 static int hd29l2_wr_reg(struct hd29l2_priv *priv, u8 reg, u8 val)
91 return hd29l2_wr_regs(priv, reg, &val, 1);
94 /* read single register */
95 static int hd29l2_rd_reg(struct hd29l2_priv *priv, u8 reg, u8 *val)
97 return hd29l2_rd_regs(priv, reg, val, 1);
100 /* write single register with mask */
101 static int hd29l2_wr_reg_mask(struct hd29l2_priv *priv, u8 reg, u8 val, u8 mask)
106 /* no need for read if whole reg is written */
108 ret = hd29l2_rd_regs(priv, reg, &tmp, 1);
117 return hd29l2_wr_regs(priv, reg, &val, 1);
120 /* read single register with mask */
121 int hd29l2_rd_reg_mask(struct hd29l2_priv *priv, u8 reg, u8 *val, u8 mask)
126 ret = hd29l2_rd_regs(priv, reg, &tmp, 1);
132 /* find position of the first bit */
133 for (i = 0; i < 8; i++) {
134 if ((mask >> i) & 0x01)
142 static int hd29l2_soft_reset(struct hd29l2_priv *priv)
147 ret = hd29l2_rd_reg(priv, 0x26, &tmp);
151 ret = hd29l2_wr_reg(priv, 0x26, 0x0d);
155 usleep_range(10000, 20000);
157 ret = hd29l2_wr_reg(priv, 0x26, tmp);
163 dev_dbg(&priv->i2c->dev, "%s: failed=%d\n", __func__, ret);
167 static int hd29l2_i2c_gate_ctrl(struct dvb_frontend *fe, int enable)
170 struct hd29l2_priv *priv = fe->demodulator_priv;
173 dev_dbg(&priv->i2c->dev, "%s: enable=%d\n", __func__, enable);
175 /* set tuner address for demod */
176 if (!priv->tuner_i2c_addr_programmed && enable) {
177 /* no need to set tuner address every time, once is enough */
178 ret = hd29l2_wr_reg(priv, 0x9d, priv->cfg.tuner_i2c_addr << 1);
182 priv->tuner_i2c_addr_programmed = true;
185 /* open / close gate */
186 ret = hd29l2_wr_reg(priv, 0x9f, enable);
190 /* wait demod ready */
191 for (i = 10; i; i--) {
192 ret = hd29l2_rd_reg(priv, 0x9e, &tmp);
199 usleep_range(5000, 10000);
202 dev_dbg(&priv->i2c->dev, "%s: loop=%d\n", __func__, i);
206 dev_dbg(&priv->i2c->dev, "%s: failed=%d\n", __func__, ret);
210 static int hd29l2_read_status(struct dvb_frontend *fe, fe_status_t *status)
213 struct hd29l2_priv *priv = fe->demodulator_priv;
218 ret = hd29l2_rd_reg(priv, 0x05, &buf[0]);
224 *status |= FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI |
225 FE_HAS_SYNC | FE_HAS_LOCK;
227 ret = hd29l2_rd_reg(priv, 0x0d, &buf[1]);
231 if ((buf[1] & 0xfe) == 0x78)
233 *status |= FE_HAS_SIGNAL | FE_HAS_CARRIER |
234 FE_HAS_VITERBI | FE_HAS_SYNC;
237 priv->fe_status = *status;
241 dev_dbg(&priv->i2c->dev, "%s: failed=%d\n", __func__, ret);
245 static int hd29l2_read_snr(struct dvb_frontend *fe, u16 *snr)
248 struct hd29l2_priv *priv = fe->demodulator_priv;
252 if (!(priv->fe_status & FE_HAS_LOCK)) {
258 ret = hd29l2_rd_regs(priv, 0x0b, buf, 2);
262 tmp = (buf[0] << 8) | buf[1];
264 /* report SNR in dB * 10 */
265 #define LOG10_20736_24 72422627 /* log10(20736) << 24 */
267 *snr = (LOG10_20736_24 - intlog10(tmp)) / ((1 << 24) / 100);
273 dev_dbg(&priv->i2c->dev, "%s: failed=%d\n", __func__, ret);
277 static int hd29l2_read_signal_strength(struct dvb_frontend *fe, u16 *strength)
280 struct hd29l2_priv *priv = fe->demodulator_priv;
286 ret = hd29l2_rd_regs(priv, 0xd5, buf, 2);
290 tmp = buf[0] << 8 | buf[1];
293 /* scale value to 0x0000-0xffff from 0x0000-0x0fff */
294 *strength = tmp * 0xffff / 0x0fff;
298 dev_dbg(&priv->i2c->dev, "%s: failed=%d\n", __func__, ret);
302 static int hd29l2_read_ber(struct dvb_frontend *fe, u32 *ber)
305 struct hd29l2_priv *priv = fe->demodulator_priv;
308 if (!(priv->fe_status & FE_HAS_SYNC)) {
314 ret = hd29l2_rd_regs(priv, 0xd9, buf, 2);
321 *ber = ((buf[0] & 0x0f) << 8) | buf[1];
325 dev_dbg(&priv->i2c->dev, "%s: failed=%d\n", __func__, ret);
329 static int hd29l2_read_ucblocks(struct dvb_frontend *fe, u32 *ucblocks)
331 /* no way to read? */
336 static enum dvbfe_search hd29l2_search(struct dvb_frontend *fe)
339 struct hd29l2_priv *priv = fe->demodulator_priv;
340 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
342 u8 modulation, carrier, guard_interval, interleave, code_rate;
347 dev_dbg(&priv->i2c->dev, "%s: delivery_system=%d frequency=%d " \
348 "bandwidth_hz=%d modulation=%d inversion=%d " \
349 "fec_inner=%d guard_interval=%d\n", __func__,
350 c->delivery_system, c->frequency, c->bandwidth_hz,
351 c->modulation, c->inversion, c->fec_inner,
354 /* as for now we detect always params automatically */
358 if (fe->ops.tuner_ops.set_params)
359 fe->ops.tuner_ops.set_params(fe);
361 /* get and program IF */
362 if (fe->ops.tuner_ops.get_if_frequency)
363 fe->ops.tuner_ops.get_if_frequency(fe, &if_freq);
370 /* calc IF control value */
373 num64 = div_u64(num64, HD29L2_XTAL);
377 tmp = 0xfc; /* tuner type normal */
381 tmp = 0xfe; /* tuner type Zero-IF */
384 buf[0] = ((if_ctl >> 0) & 0xff);
385 buf[1] = ((if_ctl >> 8) & 0xff);
386 buf[2] = ((if_ctl >> 16) & 0xff);
388 /* program IF control */
389 ret = hd29l2_wr_regs(priv, 0x14, buf, 3);
393 /* program tuner type */
394 ret = hd29l2_wr_reg(priv, 0xab, tmp);
398 dev_dbg(&priv->i2c->dev, "%s: if_freq=%d if_ctl=%x\n",
399 __func__, if_freq, if_ctl);
406 /* disable quick mode */
407 ret = hd29l2_wr_reg_mask(priv, 0xac, 0 << 7, 0x80);
411 ret = hd29l2_wr_reg_mask(priv, 0x82, 1 << 1, 0x02);
415 /* enable auto mode */
416 ret = hd29l2_wr_reg_mask(priv, 0x7d, 1 << 6, 0x40);
420 ret = hd29l2_wr_reg_mask(priv, 0x81, 1 << 3, 0x08);
425 ret = hd29l2_soft_reset(priv);
429 /* detect modulation */
430 for (i = 30; i; i--) {
433 ret = hd29l2_rd_reg(priv, 0x0d, &tmp);
437 if ((((tmp & 0xf0) >= 0x10) &&
438 ((tmp & 0x0f) == 0x08)) || (tmp >= 0x2c))
442 dev_dbg(&priv->i2c->dev, "%s: loop=%d\n", __func__, i);
445 /* detection failed */
446 return DVBFE_ALGO_SEARCH_FAILED;
448 /* read modulation */
449 ret = hd29l2_rd_reg_mask(priv, 0x7d, &modulation, 0x07);
457 modulation = HD29L2_QAM64;
458 carrier = HD29L2_CARRIER_MULTI;
459 guard_interval = HD29L2_PN945;
460 interleave = HD29L2_INTERLEAVER_420;
461 code_rate = HD29L2_CODE_RATE_08;
463 tmp = (code_rate << 3) | modulation;
464 ret = hd29l2_wr_reg_mask(priv, 0x7d, tmp, 0x5f);
468 tmp = (carrier << 2) | guard_interval;
469 ret = hd29l2_wr_reg_mask(priv, 0x81, tmp, 0x0f);
474 ret = hd29l2_wr_reg_mask(priv, 0x82, tmp, 0x03);
479 /* ensure modulation validy */
480 /* 0=QAM4_NR, 1=QAM4, 2=QAM16, 3=QAM32, 4=QAM64 */
481 if (modulation > (ARRAY_SIZE(reg_mod_vals_tab[0].val) - 1)) {
482 dev_dbg(&priv->i2c->dev, "%s: modulation=%d not valid\n",
483 __func__, modulation);
487 /* program registers according to modulation */
488 for (i = 0; i < ARRAY_SIZE(reg_mod_vals_tab); i++) {
489 ret = hd29l2_wr_reg(priv, reg_mod_vals_tab[i].reg,
490 reg_mod_vals_tab[i].val[modulation]);
495 /* read guard interval */
496 ret = hd29l2_rd_reg_mask(priv, 0x81, &guard_interval, 0x03);
500 /* read carrier mode */
501 ret = hd29l2_rd_reg_mask(priv, 0x81, &carrier, 0x04);
505 dev_dbg(&priv->i2c->dev,
506 "%s: modulation=%d guard_interval=%d carrier=%d\n",
507 __func__, modulation, guard_interval, carrier);
509 if ((carrier == HD29L2_CARRIER_MULTI) && (modulation == HD29L2_QAM64) &&
510 (guard_interval == HD29L2_PN945)) {
511 dev_dbg(&priv->i2c->dev, "%s: C=3780 && QAM64 && PN945\n",
514 ret = hd29l2_wr_reg(priv, 0x42, 0x33);
518 ret = hd29l2_wr_reg(priv, 0xdd, 0x01);
523 usleep_range(10000, 20000);
526 ret = hd29l2_soft_reset(priv);
530 /* wait demod lock */
531 for (i = 30; i; i--) {
535 ret = hd29l2_rd_reg_mask(priv, 0x05, &tmp, 0x01);
543 dev_dbg(&priv->i2c->dev, "%s: loop=%d\n", __func__, i);
546 return DVBFE_ALGO_SEARCH_AGAIN;
548 return DVBFE_ALGO_SEARCH_SUCCESS;
550 dev_dbg(&priv->i2c->dev, "%s: failed=%d\n", __func__, ret);
551 return DVBFE_ALGO_SEARCH_ERROR;
554 static int hd29l2_get_frontend_algo(struct dvb_frontend *fe)
556 return DVBFE_ALGO_CUSTOM;
559 static int hd29l2_get_frontend(struct dvb_frontend *fe)
562 struct hd29l2_priv *priv = fe->demodulator_priv;
563 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
566 char *str_constellation, *str_code_rate, *str_constellation_code_rate,
567 *str_guard_interval, *str_carrier, *str_guard_interval_carrier,
568 *str_interleave, *str_interleave_;
570 ret = hd29l2_rd_reg(priv, 0x7d, &buf[0]);
574 ret = hd29l2_rd_regs(priv, 0x81, &buf[1], 2);
578 /* constellation, 0x7d[2:0] */
579 switch ((buf[0] >> 0) & 0x07) {
581 str_constellation = "QAM4NR";
582 c->modulation = QAM_AUTO; /* FIXME */
585 str_constellation = "QAM4";
586 c->modulation = QPSK; /* FIXME */
589 str_constellation = "QAM16";
590 c->modulation = QAM_16;
593 str_constellation = "QAM32";
594 c->modulation = QAM_32;
597 str_constellation = "QAM64";
598 c->modulation = QAM_64;
601 str_constellation = "?";
604 /* LDPC code rate, 0x7d[4:3] */
605 switch ((buf[0] >> 3) & 0x03) {
607 str_code_rate = "0.4";
608 c->fec_inner = FEC_AUTO; /* FIXME */
611 str_code_rate = "0.6";
612 c->fec_inner = FEC_3_5;
615 str_code_rate = "0.8";
616 c->fec_inner = FEC_4_5;
622 /* constellation & code rate set, 0x7d[6] */
623 switch ((buf[0] >> 6) & 0x01) {
625 str_constellation_code_rate = "manual";
628 str_constellation_code_rate = "auto";
631 str_constellation_code_rate = "?";
634 /* frame header, 0x81[1:0] */
635 switch ((buf[1] >> 0) & 0x03) {
637 str_guard_interval = "PN945";
638 c->guard_interval = GUARD_INTERVAL_AUTO; /* FIXME */
641 str_guard_interval = "PN595";
642 c->guard_interval = GUARD_INTERVAL_AUTO; /* FIXME */
645 str_guard_interval = "PN420";
646 c->guard_interval = GUARD_INTERVAL_AUTO; /* FIXME */
649 str_guard_interval = "?";
652 /* carrier, 0x81[2] */
653 switch ((buf[1] >> 2) & 0x01) {
658 str_carrier = "C=3780";
664 /* frame header & carrier set, 0x81[3] */
665 switch ((buf[1] >> 3) & 0x01) {
667 str_guard_interval_carrier = "manual";
670 str_guard_interval_carrier = "auto";
673 str_guard_interval_carrier = "?";
676 /* interleave, 0x82[0] */
677 switch ((buf[2] >> 0) & 0x01) {
679 str_interleave = "M=720";
682 str_interleave = "M=240";
685 str_interleave = "?";
688 /* interleave set, 0x82[1] */
689 switch ((buf[2] >> 1) & 0x01) {
691 str_interleave_ = "manual";
694 str_interleave_ = "auto";
697 str_interleave_ = "?";
701 * We can read out current detected NCO and use that value next
702 * time instead of calculating new value from targed IF.
703 * I think it will not effect receiver sensitivity but gaining lock
704 * after tune could be easier...
706 ret = hd29l2_rd_regs(priv, 0xb1, &buf[0], 3);
710 if_ctl = (buf[0] << 16) | ((buf[1] - 7) << 8) | buf[2];
712 dev_dbg(&priv->i2c->dev, "%s: %s %s %s | %s %s %s | %s %s | NCO=%06x\n",
713 __func__, str_constellation, str_code_rate,
714 str_constellation_code_rate, str_guard_interval,
715 str_carrier, str_guard_interval_carrier, str_interleave,
716 str_interleave_, if_ctl);
719 dev_dbg(&priv->i2c->dev, "%s: failed=%d\n", __func__, ret);
723 static int hd29l2_init(struct dvb_frontend *fe)
726 struct hd29l2_priv *priv = fe->demodulator_priv;
728 static const struct reg_val tab[] = {
738 dev_dbg(&priv->i2c->dev, "%s:\n", __func__);
741 /* it is recommended to HW reset chip using RST_N pin */
743 ret = fe->callback(fe, DVB_FRONTEND_COMPONENT_DEMOD, 0, 0);
747 /* reprogramming needed because HW reset clears registers */
748 priv->tuner_i2c_addr_programmed = false;
752 for (i = 0; i < ARRAY_SIZE(tab); i++) {
753 ret = hd29l2_wr_reg(priv, tab[i].reg, tab[i].val);
759 ret = hd29l2_rd_reg(priv, 0x36, &tmp);
764 tmp |= priv->cfg.ts_mode;
765 ret = hd29l2_wr_reg(priv, 0x36, tmp);
769 ret = hd29l2_rd_reg(priv, 0x31, &tmp);
772 if (!(priv->cfg.ts_mode >> 7))
773 /* set b4 for serial TS */
776 ret = hd29l2_wr_reg(priv, 0x31, tmp);
782 dev_dbg(&priv->i2c->dev, "%s: failed=%d\n", __func__, ret);
786 static void hd29l2_release(struct dvb_frontend *fe)
788 struct hd29l2_priv *priv = fe->demodulator_priv;
792 static struct dvb_frontend_ops hd29l2_ops;
794 struct dvb_frontend *hd29l2_attach(const struct hd29l2_config *config,
795 struct i2c_adapter *i2c)
798 struct hd29l2_priv *priv = NULL;
801 /* allocate memory for the internal state */
802 priv = kzalloc(sizeof(struct hd29l2_priv), GFP_KERNEL);
806 /* setup the state */
808 memcpy(&priv->cfg, config, sizeof(struct hd29l2_config));
811 /* check if the demod is there */
812 ret = hd29l2_rd_reg(priv, 0x00, &tmp);
816 /* create dvb_frontend */
817 memcpy(&priv->fe.ops, &hd29l2_ops, sizeof(struct dvb_frontend_ops));
818 priv->fe.demodulator_priv = priv;
825 EXPORT_SYMBOL(hd29l2_attach);
827 static struct dvb_frontend_ops hd29l2_ops = {
828 .delsys = { SYS_DVBT },
830 .name = "HDIC HD29L2 DMB-TH",
831 .frequency_min = 474000000,
832 .frequency_max = 858000000,
833 .frequency_stepsize = 10000,
834 .caps = FE_CAN_FEC_AUTO |
840 FE_CAN_TRANSMISSION_MODE_AUTO |
841 FE_CAN_BANDWIDTH_AUTO |
842 FE_CAN_GUARD_INTERVAL_AUTO |
843 FE_CAN_HIERARCHY_AUTO |
847 .release = hd29l2_release,
851 .get_frontend_algo = hd29l2_get_frontend_algo,
852 .search = hd29l2_search,
853 .get_frontend = hd29l2_get_frontend,
855 .read_status = hd29l2_read_status,
856 .read_snr = hd29l2_read_snr,
857 .read_signal_strength = hd29l2_read_signal_strength,
858 .read_ber = hd29l2_read_ber,
859 .read_ucblocks = hd29l2_read_ucblocks,
861 .i2c_gate_ctrl = hd29l2_i2c_gate_ctrl,
865 MODULE_DESCRIPTION("HDIC HD29L2 DMB-TH demodulator driver");
866 MODULE_LICENSE("GPL");