drivers/media/dvb-frontends/cx24120.c

   1 /*
   2     Conexant cx24120/cx24118 - DVBS/S2 Satellite demod/tuner driver
   3
   4     Copyright (C) 2008 Patrick Boettcher <pb@linuxtv.org>
   5     Copyright (C) 2009 Sergey Tyurin <forum.free-x.de>
   6     Updated 2012 by Jannis Achstetter <jannis_achstetter@web.de>
   7     Copyright (C) 2015 Jemma Denson <jdenson@gmail.com>
   8         April 2015
   9             Refactored & simplified driver
  10             Updated to work with delivery system supplied by DVBv5
  11             Add frequency, fec & pilot to get_frontend
  12
  13         Cards supported: Technisat Skystar S2
  14
  15     This program is free software; you can redistribute it and/or modify
  16     it under the terms of the GNU General Public License as published by
  17     the Free Software Foundation; either version 2 of the License, or
  18     (at your option) any later version.
  19
  20     This program is distributed in the hope that it will be useful,
  21     but WITHOUT ANY WARRANTY; without even the implied warranty of
  22     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23     GNU General Public License for more details.
  24 */
  25
  26 #include <linux/slab.h>
  27 #include <linux/kernel.h>
  28 #include <linux/module.h>
  29 #include <linux/moduleparam.h>
  30 #include <linux/init.h>
  31 #include <linux/firmware.h>
  32 #include "dvb_frontend.h"
  33 #include "cx24120.h"
  34
  35 #define CX24120_SEARCH_RANGE_KHZ 5000
  36 #define CX24120_FIRMWARE "dvb-fe-cx24120-1.20.58.2.fw"
  37
  38 /* cx24120 i2c registers  */
  39 #define CX24120_REG_CMD_START   0x00            /* write cmd_id */
  40 #define CX24120_REG_CMD_ARGS    0x01            /* write command arguments */
  41 #define CX24120_REG_CMD_END     0x1f            /* write 0x01 for end */
  42
  43 #define CX24120_REG_MAILBOX     0x33
  44 #define CX24120_REG_FREQ3       0x34            /* frequency */
  45 #define CX24120_REG_FREQ2       0x35
  46 #define CX24120_REG_FREQ1       0x36
  47
  48 #define CX24120_REG_FECMODE     0x39            /* FEC status */
  49 #define CX24120_REG_STATUS      0x3a            /* Tuner status */
  50 #define CX24120_REG_SIGSTR_H    0x3a            /* Signal strength high */
  51 #define CX24120_REG_SIGSTR_L    0x3b            /* Signal strength low byte */
  52 #define CX24120_REG_QUALITY_H   0x40            /* SNR high byte */
  53 #define CX24120_REG_QUALITY_L   0x41            /* SNR low byte */
  54
  55 #define CX24120_REG_BER_HH      0x47            /* BER high byte of high word */
  56 #define CX24120_REG_BER_HL      0x48            /* BER low byte of high word */
  57 #define CX24120_REG_BER_LH      0x49            /* BER high byte of low word */
  58 #define CX24120_REG_BER_LL      0x4a            /* BER low byte of low word */
  59
  60 #define CX24120_REG_UCB_H       0x50            /* UCB high byte */
  61 #define CX24120_REG_UCB_L       0x51            /* UCB low byte  */
  62
  63 #define CX24120_REG_CLKDIV      0xe6
  64 #define CX24120_REG_RATEDIV     0xf0
  65
  66 #define CX24120_REG_REVISION    0xff            /* Chip revision (ro) */
  67
  68 /* Command messages */
  69 enum command_message_id {
  70         CMD_VCO_SET             = 0x10,         /* cmd.len = 12; */
  71         CMD_TUNEREQUEST         = 0x11,         /* cmd.len = 15; */
  72
  73         CMD_MPEG_ONOFF          = 0x13,         /* cmd.len = 4; */
  74         CMD_MPEG_INIT           = 0x14,         /* cmd.len = 7; */
  75         CMD_BANDWIDTH           = 0x15,         /* cmd.len = 12; */
  76         CMD_CLOCK_READ          = 0x16,         /* read clock */
  77         CMD_CLOCK_SET           = 0x17,         /* cmd.len = 10; */
  78
  79         CMD_DISEQC_MSG1         = 0x20,         /* cmd.len = 11; */
  80         CMD_DISEQC_MSG2         = 0x21,         /* cmd.len = d->msg_len + 6; */
  81         CMD_SETVOLTAGE          = 0x22,         /* cmd.len = 2; */
  82         CMD_SETTONE             = 0x23,         /* cmd.len = 4; */
  83         CMD_DISEQC_BURST        = 0x24,         /* cmd.len not used !!! */
  84
  85         CMD_READ_SNR            = 0x1a,         /* Read signal strength */
  86         CMD_START_TUNER         = 0x1b,         /* ??? */
  87
  88         CMD_FWVERSION           = 0x35,
  89
  90         CMD_TUNER_INIT          = 0x3c,         /* cmd.len = 0x03; */
  91 };
  92
  93 #define CX24120_MAX_CMD_LEN     30
  94
  95 /* pilot mask */
  96 #define CX24120_PILOT_OFF       0x00
  97 #define CX24120_PILOT_ON        0x40
  98 #define CX24120_PILOT_AUTO      0x80
  99
 100 /* signal status */
 101 #define CX24120_HAS_SIGNAL      0x01
 102 #define CX24120_HAS_CARRIER     0x02
 103 #define CX24120_HAS_VITERBI     0x04
 104 #define CX24120_HAS_LOCK        0x08
 105 #define CX24120_HAS_UNK1        0x10
 106 #define CX24120_HAS_UNK2        0x20
 107 #define CX24120_STATUS_MASK     0x0f
 108 #define CX24120_SIGNAL_MASK     0xc0
 109
 110 #define info(args...) pr_info("cx24120: " args)
 111 #define err(args...)  pr_err("cx24120: ### ERROR: " args)
 112
 113 /* The Demod/Tuner can't easily provide these, we cache them */
 114 struct cx24120_tuning {
 115         u32 frequency;
 116         u32 symbol_rate;
 117         fe_spectral_inversion_t inversion;
 118         fe_code_rate_t fec;
 119
 120         fe_delivery_system_t delsys;
 121         fe_modulation_t modulation;
 122         fe_pilot_t pilot;
 123
 124         /* Demod values */
 125         u8 fec_val;
 126         u8 fec_mask;
 127         u8 clkdiv;
 128         u8 ratediv;
 129         u8 inversion_val;
 130         u8 pilot_val;
 131 };
 132
 133 /* Private state */
 134 struct cx24120_state {
 135         struct i2c_adapter *i2c;
 136         const struct cx24120_config *config;
 137         struct dvb_frontend frontend;
 138
 139         u8 cold_init;
 140         u8 mpeg_enabled;
 141         u8 need_clock_set;
 142
 143         /* current and next tuning parameters */
 144         struct cx24120_tuning dcur;
 145         struct cx24120_tuning dnxt;
 146 };
 147
 148 /* Command message to firmware */
 149 struct cx24120_cmd {
 150         u8 id;
 151         u8 len;
 152         u8 arg[CX24120_MAX_CMD_LEN];
 153 };
 154
 155 /* Read single register */
 156 static int cx24120_readreg(struct cx24120_state *state, u8 reg)
 157 {
 158         int ret;
 159         u8 buf = 0;
 160         struct i2c_msg msg[] = {
 161                 {       .addr = state->config->i2c_addr,
 162                         .flags = 0,
 163                         .len = 1,
 164                         .buf = &reg
 165                 }, {
 166                         .addr = state->config->i2c_addr,
 167                         .flags = I2C_M_RD,
 168                         .len = 1,
 169                         .buf = &buf
 170                 }
 171         };
 172
 173         ret = i2c_transfer(state->i2c, msg, 2);
 174         if (ret != 2) {
 175                 err("Read error: reg=0x%02x, ret=%i)\n", reg, ret);
 176                 return ret;
 177         }
 178
 179         dev_dbg(&state->i2c->dev, "%s: reg=0x%02x; data=0x%02x\n",
 180                 __func__, reg, buf);
 181
 182         return buf;
 183 }
 184
 185 /* Write single register */
 186 static int cx24120_writereg(struct cx24120_state *state, u8 reg, u8 data)
 187 {
 188         u8 buf[] = { reg, data };
 189         struct i2c_msg msg = {
 190                 .addr = state->config->i2c_addr,
 191                 .flags = 0,
 192                 .buf = buf,
 193                 .len = 2
 194         };
 195         int ret;
 196
 197         ret = i2c_transfer(state->i2c, &msg, 1);
 198         if (ret != 1) {
 199                 err("Write error: i2c_write error(err == %i, 0x%02x: 0x%02x)\n",
 200                     ret, reg, data);
 201                 return ret;
 202         }
 203
 204         dev_dbg(&state->i2c->dev, "%s: reg=0x%02x; data=0x%02x\n",
 205                 __func__, reg, data);
 206
 207         return 0;
 208 }
 209
 210 /* Write multiple registers in chunks of i2c_wr_max-sized buffers */
 211 static int cx24120_writeregs(struct cx24120_state *state,
 212                              u8 reg, const u8 *values, u16 len, u8 incr)
 213 {
 214         int ret;
 215         u16 max = state->config->i2c_wr_max > 0 ?
 216                                 state->config->i2c_wr_max :
 217                                 len;
 218
 219         struct i2c_msg msg = {
 220                 .addr = state->config->i2c_addr,
 221                 .flags = 0,
 222         };
 223
 224         msg.buf = kmalloc(max + 1, GFP_KERNEL);
 225         if (!msg.buf)
 226                 return -ENOMEM;
 227
 228         while (len) {
 229                 msg.buf[0] = reg;
 230                 msg.len = len > max ? max : len;
 231                 memcpy(&msg.buf[1], values, msg.len);
 232
 233                 len    -= msg.len;      /* data length revers counter */
 234                 values += msg.len;      /* incr data pointer */
 235
 236                 if (incr)
 237                         reg += msg.len;
 238                 msg.len++;              /* don't forget the addr byte */
 239
 240                 ret = i2c_transfer(state->i2c, &msg, 1);
 241                 if (ret != 1) {
 242                         err("i2c_write error(err == %i, 0x%02x)\n", ret, reg);
 243                         goto out;
 244                 }
 245
 246                 dev_dbg(&state->i2c->dev,
 247                         "%s: reg=0x%02x; data=%*ph\n",
 248                         __func__, reg, msg.len - 1, msg.buf + 1);
 249         }
 250
 251         ret = 0;
 252
 253 out:
 254         kfree(msg.buf);
 255         return ret;
 256 }
 257
 258 static struct dvb_frontend_ops cx24120_ops;
 259
 260 struct dvb_frontend *cx24120_attach(const struct cx24120_config *config,
 261                                     struct i2c_adapter *i2c)
 262 {
 263         struct cx24120_state *state;
 264         int demod_rev;
 265
 266         info("Conexant cx24120/cx24118 - DVBS/S2 Satellite demod/tuner\n");
 267         state = kzalloc(sizeof(*state), GFP_KERNEL);
 268         if (!state) {
 269                 err("Unable to allocate memory for cx24120_state\n");
 270                 goto error;
 271         }
 272
 273         /* setup the state */
 274         state->config = config;
 275         state->i2c = i2c;
 276
 277         /* check if the demod is present and has proper type */
 278         demod_rev = cx24120_readreg(state, CX24120_REG_REVISION);
 279         switch (demod_rev) {
 280         case 0x07:
 281                 info("Demod cx24120 rev. 0x07 detected.\n");
 282                 break;
 283         case 0x05:
 284                 info("Demod cx24120 rev. 0x05 detected.\n");
 285                 break;
 286         default:
 287                 err("Unsupported demod revision: 0x%x detected.\n", demod_rev);
 288                 goto error;
 289         }
 290
 291         /* create dvb_frontend */
 292         state->cold_init = 0;
 293         memcpy(&state->frontend.ops, &cx24120_ops,
 294                sizeof(struct dvb_frontend_ops));
 295         state->frontend.demodulator_priv = state;
 296
 297         info("Conexant cx24120/cx24118 attached.\n");
 298         return &state->frontend;
 299
 300 error:
 301         kfree(state);
 302         return NULL;
 303 }
 304 EXPORT_SYMBOL(cx24120_attach);
 305
 306 static int cx24120_test_rom(struct cx24120_state *state)
 307 {
 308         int err, ret;
 309
 310         err = cx24120_readreg(state, 0xfd);
 311         if (err & 4) {
 312                 ret = cx24120_readreg(state, 0xdf) & 0xfe;
 313                 err = cx24120_writereg(state, 0xdf, ret);
 314         }
 315         return err;
 316 }
 317
 318 static int cx24120_read_snr(struct dvb_frontend *fe, u16 *snr)
 319 {
 320         struct cx24120_state *state = fe->demodulator_priv;
 321
 322         *snr =  (cx24120_readreg(state, CX24120_REG_QUALITY_H) << 8) |
 323                 (cx24120_readreg(state, CX24120_REG_QUALITY_L));
 324         dev_dbg(&state->i2c->dev, "%s: read SNR index = %d\n", __func__, *snr);
 325
 326         return 0;
 327 }
 328
 329 static int cx24120_read_ber(struct dvb_frontend *fe, u32 *ber)
 330 {
 331         struct cx24120_state *state = fe->demodulator_priv;
 332
 333         *ber =  (cx24120_readreg(state, CX24120_REG_BER_HH) << 24)      |
 334                 (cx24120_readreg(state, CX24120_REG_BER_HL) << 16)      |
 335                 (cx24120_readreg(state, CX24120_REG_BER_LH) <<  8)      |
 336                  cx24120_readreg(state, CX24120_REG_BER_LL);
 337         dev_dbg(&state->i2c->dev, "%s: read BER index = %d\n", __func__, *ber);
 338
 339         return 0;
 340 }
 341
 342 static int cx24120_msg_mpeg_output_global_config(struct cx24120_state *state,
 343                                                  u8 flag);
 344
 345 /* Check if we're running a command that needs to disable mpeg out */
 346 static void cx24120_check_cmd(struct cx24120_state *state, u8 id)
 347 {
 348         switch (id) {
 349         case CMD_TUNEREQUEST:
 350         case CMD_CLOCK_READ:
 351         case CMD_DISEQC_MSG1:
 352         case CMD_DISEQC_MSG2:
 353         case CMD_SETVOLTAGE:
 354         case CMD_SETTONE:
 355         case CMD_DISEQC_BURST:
 356                 cx24120_msg_mpeg_output_global_config(state, 0);
 357                 /* Old driver would do a msleep(100) here */
 358         default:
 359                 return;
 360         }
 361 }
 362
 363 /* Send a message to the firmware */
 364 static int cx24120_message_send(struct cx24120_state *state,
 365                                 struct cx24120_cmd *cmd)
 366 {
 367         int ret, ficus;
 368
 369         if (state->mpeg_enabled) {
 370                 /* Disable mpeg out on certain commands */
 371                 cx24120_check_cmd(state, cmd->id);
 372         }
 373
 374         ret = cx24120_writereg(state, CX24120_REG_CMD_START, cmd->id);
 375         ret = cx24120_writeregs(state, CX24120_REG_CMD_ARGS, &cmd->arg[0],
 376                                 cmd->len, 1);
 377         ret = cx24120_writereg(state, CX24120_REG_CMD_END, 0x01);
 378
 379         ficus = 1000;
 380         while (cx24120_readreg(state, CX24120_REG_CMD_END)) {
 381                 msleep(20);
 382                 ficus -= 20;
 383                 if (ficus == 0) {
 384                         err("Error sending message to firmware\n");
 385                         return -EREMOTEIO;
 386                 }
 387         }
 388         dev_dbg(&state->i2c->dev, "%s: Successfully send message 0x%02x\n",
 389                 __func__, cmd->id);
 390
 391         return 0;
 392 }
 393
 394 /* Send a message and fill arg[] with the results */
 395 static int cx24120_message_sendrcv(struct cx24120_state *state,
 396                                    struct cx24120_cmd *cmd, u8 numreg)
 397 {
 398         int ret, i;
 399
 400         if (numreg > CX24120_MAX_CMD_LEN) {
 401                 err("Too many registers to read. cmd->reg = %d", numreg);
 402                 return -EREMOTEIO;
 403         }
 404
 405         ret = cx24120_message_send(state, cmd);
 406         if (ret != 0)
 407                 return ret;
 408
 409         if (!numreg)
 410                 return 0;
 411
 412         /* Read numreg registers starting from register cmd->len */
 413         for (i = 0; i < numreg; i++)
 414                 cmd->arg[i] = cx24120_readreg(state, (cmd->len + i + 1));
 415
 416         return 0;
 417 }
 418
 419 static int cx24120_read_signal_strength(struct dvb_frontend *fe,
 420                                         u16 *signal_strength)
 421 {
 422         struct cx24120_state *state = fe->demodulator_priv;
 423         struct cx24120_cmd cmd;
 424         int ret, sigstr_h, sigstr_l;
 425
 426         cmd.id = CMD_READ_SNR;
 427         cmd.len = 1;
 428         cmd.arg[0] = 0x00;
 429
 430         ret = cx24120_message_send(state, &cmd);
 431         if (ret != 0) {
 432                 err("error reading signal strength\n");
 433                 return -EREMOTEIO;
 434         }
 435
 436         /* raw */
 437         sigstr_h = (cx24120_readreg(state, CX24120_REG_SIGSTR_H) >> 6) << 8;
 438         sigstr_l = cx24120_readreg(state, CX24120_REG_SIGSTR_L);
 439         dev_dbg(&state->i2c->dev, "%s: Signal strength from firmware= 0x%x\n",
 440                 __func__, (sigstr_h | sigstr_l));
 441
 442         /* cooked */
 443         *signal_strength = ((sigstr_h | sigstr_l)  << 5) & 0x0000ffff;
 444         dev_dbg(&state->i2c->dev, "%s: Signal strength= 0x%x\n",
 445                 __func__, *signal_strength);
 446
 447         return 0;
 448 }
 449
 450 static int cx24120_msg_mpeg_output_global_config(struct cx24120_state *state,
 451                                                  u8 enable)
 452 {
 453         struct cx24120_cmd cmd;
 454         int ret;
 455
 456         cmd.id = CMD_MPEG_ONOFF;
 457         cmd.len = 4;
 458         cmd.arg[0] = 0x01;
 459         cmd.arg[1] = 0x00;
 460         cmd.arg[2] = enable ? 0 : (u8)(-1);
 461         cmd.arg[3] = 0x01;
 462
 463         ret = cx24120_message_send(state, &cmd);
 464         if (ret != 0) {
 465                 dev_dbg(&state->i2c->dev,
 466                         "%s: Failed to set MPEG output to %s\n",
 467                         __func__, enable ? "enabled" : "disabled");
 468                 return ret;
 469         }
 470
 471         state->mpeg_enabled = enable;
 472         dev_dbg(&state->i2c->dev, "%s: MPEG output %s\n",
 473                 __func__, enable ? "enabled" : "disabled");
 474
 475         return 0;
 476 }
 477
 478 static int cx24120_msg_mpeg_output_config(struct cx24120_state *state, u8 seq)
 479 {
 480         struct cx24120_cmd cmd;
 481         struct cx24120_initial_mpeg_config i =
 482                         state->config->initial_mpeg_config;
 483
 484         cmd.id = CMD_MPEG_INIT;
 485         cmd.len = 7;
 486         cmd.arg[0] = seq; /* sequental number - can be 0,1,2 */
 487         cmd.arg[1] = ((i.x1 & 0x01) << 1) | ((i.x1 >> 1) & 0x01);
 488         cmd.arg[2] = 0x05;
 489         cmd.arg[3] = 0x02;
 490         cmd.arg[4] = ((i.x2 >> 1) & 0x01);
 491         cmd.arg[5] = (i.x2 & 0xf0) | (i.x3 & 0x0f);
 492         cmd.arg[6] = 0x10;
 493
 494         return cx24120_message_send(state, &cmd);
 495 }
 496
 497 static int cx24120_diseqc_send_burst(struct dvb_frontend *fe,
 498                                      fe_sec_mini_cmd_t burst)
 499 {
 500         struct cx24120_state *state = fe->demodulator_priv;
 501         struct cx24120_cmd cmd;
 502
 503         /* Yes, cmd.len is set to zero. The old driver
 504          * didn't specify any len, but also had a
 505          * memset 0 before every use of the cmd struct
 506          * which would have set it to zero.
 507          * This quite probably needs looking into.
 508          */
 509         cmd.id = CMD_DISEQC_BURST;
 510         cmd.len = 0;
 511         cmd.arg[0] = 0x00;
 512         if (burst)
 513                 cmd.arg[1] = 0x01;
 514
 515         dev_dbg(&state->i2c->dev, "%s: burst sent.\n", __func__);
 516
 517         return cx24120_message_send(state, &cmd);
 518 }
 519
 520 static int cx24120_set_tone(struct dvb_frontend *fe, fe_sec_tone_mode_t tone)
 521 {
 522         struct cx24120_state *state = fe->demodulator_priv;
 523         struct cx24120_cmd cmd;
 524
 525         dev_dbg(&state->i2c->dev, "%s(%d)\n", __func__, tone);
 526
 527         if ((tone != SEC_TONE_ON) && (tone != SEC_TONE_OFF)) {
 528                 err("Invalid tone=%d\n", tone);
 529                 return -EINVAL;
 530         }
 531
 532         cmd.id = CMD_SETTONE;
 533         cmd.len = 4;
 534         cmd.arg[0] = 0x00;
 535         cmd.arg[1] = 0x00;
 536         cmd.arg[2] = 0x00;
 537         cmd.arg[3] = (tone == SEC_TONE_ON) ? 0x01 : 0x00;
 538
 539         return cx24120_message_send(state, &cmd);
 540 }
 541
 542 static int cx24120_set_voltage(struct dvb_frontend *fe,
 543                                fe_sec_voltage_t voltage)
 544 {
 545         struct cx24120_state *state = fe->demodulator_priv;
 546         struct cx24120_cmd cmd;
 547
 548         dev_dbg(&state->i2c->dev, "%s(%d)\n", __func__, voltage);
 549
 550         cmd.id = CMD_SETVOLTAGE;
 551         cmd.len = 2;
 552         cmd.arg[0] = 0x00;
 553         cmd.arg[1] = (voltage == SEC_VOLTAGE_18) ? 0x01 : 0x00;
 554
 555         return cx24120_message_send(state, &cmd);
 556 }
 557
 558 static int cx24120_send_diseqc_msg(struct dvb_frontend *fe,
 559                                    struct dvb_diseqc_master_cmd *d)
 560 {
 561         struct cx24120_state *state = fe->demodulator_priv;
 562         struct cx24120_cmd cmd;
 563         int back_count;
 564
 565         dev_dbg(&state->i2c->dev, "%s()\n", __func__);
 566
 567         cmd.id = CMD_DISEQC_MSG1;
 568         cmd.len = 11;
 569         cmd.arg[0] = 0x00;
 570         cmd.arg[1] = 0x00;
 571         cmd.arg[2] = 0x03;
 572         cmd.arg[3] = 0x16;
 573         cmd.arg[4] = 0x28;
 574         cmd.arg[5] = 0x01;
 575         cmd.arg[6] = 0x01;
 576         cmd.arg[7] = 0x14;
 577         cmd.arg[8] = 0x19;
 578         cmd.arg[9] = 0x14;
 579         cmd.arg[10] = 0x1e;
 580
 581         if (cx24120_message_send(state, &cmd)) {
 582                 err("send 1st message(0x%x) failed\n", cmd.id);
 583                 return -EREMOTEIO;
 584         }
 585
 586         cmd.id = CMD_DISEQC_MSG2;
 587         cmd.len = d->msg_len + 6;
 588         cmd.arg[0] = 0x00;
 589         cmd.arg[1] = 0x01;
 590         cmd.arg[2] = 0x02;
 591         cmd.arg[3] = 0x00;
 592         cmd.arg[4] = 0x00;
 593         cmd.arg[5] = d->msg_len;
 594
 595         memcpy(&cmd.arg[6], &d->msg, d->msg_len);
 596
 597         if (cx24120_message_send(state, &cmd)) {
 598                 err("send 2nd message(0x%x) failed\n", cmd.id);
 599                 return -EREMOTEIO;
 600         }
 601
 602         back_count = 500;
 603         do {
 604                 if (!(cx24120_readreg(state, 0x93) & 0x01)) {
 605                         dev_dbg(&state->i2c->dev,
 606                                 "%s: diseqc sequence sent success\n",
 607                                 __func__);
 608                         return 0;
 609                 }
 610                 msleep(20);
 611                 back_count -= 20;
 612         } while (back_count);
 613
 614         err("Too long waiting for diseqc.\n");
 615         return -ETIMEDOUT;
 616 }
 617
 618 static void cx24120_set_clock_ratios(struct dvb_frontend *fe);
 619
 620 /* Read current tuning status */
 621 static int cx24120_read_status(struct dvb_frontend *fe, fe_status_t *status)
 622 {
 623         struct cx24120_state *state = fe->demodulator_priv;
 624         int lock;
 625
 626         lock = cx24120_readreg(state, CX24120_REG_STATUS);
 627
 628         dev_dbg(&state->i2c->dev, "%s() status = 0x%02x\n",
 629                 __func__, lock);
 630
 631         *status = 0;
 632
 633         if (lock & CX24120_HAS_SIGNAL)
 634                 *status = FE_HAS_SIGNAL;
 635         if (lock & CX24120_HAS_CARRIER)
 636                 *status |= FE_HAS_CARRIER;
 637         if (lock & CX24120_HAS_VITERBI)
 638                 *status |= FE_HAS_VITERBI | FE_HAS_SYNC;
 639         if (lock & CX24120_HAS_LOCK)
 640                 *status |= FE_HAS_LOCK;
 641
 642         /* TODO: is FE_HAS_SYNC in the right place?
 643          * Other cx241xx drivers have this slightly
 644          * different */
 645
 646         /* Set the clock once tuned in */
 647         if (state->need_clock_set && *status & FE_HAS_LOCK) {
 648                 /* Set clock ratios */
 649                 cx24120_set_clock_ratios(fe);
 650
 651                 /* Old driver would do a msleep(200) here */
 652
 653                 /* Renable mpeg output */
 654                 if (!state->mpeg_enabled)
 655                         cx24120_msg_mpeg_output_global_config(state, 1);
 656
 657                 state->need_clock_set = 0;
 658         }
 659
 660         return 0;
 661 }
 662
 663 /* FEC & modulation lookup table
 664  * Used for decoding the REG_FECMODE register
 665  * once tuned in.
 666  */
 667 static struct cx24120_modfec {
 668         fe_delivery_system_t delsys;
 669         fe_modulation_t mod;
 670         fe_code_rate_t fec;
 671         u8 val;
 672 } modfec_lookup_table[] = {
 673         /*delsys     mod    fec       val */
 674         { SYS_DVBS,  QPSK,  FEC_1_2,  0x01 },
 675         { SYS_DVBS,  QPSK,  FEC_2_3,  0x02 },
 676         { SYS_DVBS,  QPSK,  FEC_3_4,  0x03 },
 677         { SYS_DVBS,  QPSK,  FEC_4_5,  0x04 },
 678         { SYS_DVBS,  QPSK,  FEC_5_6,  0x05 },
 679         { SYS_DVBS,  QPSK,  FEC_6_7,  0x06 },
 680         { SYS_DVBS,  QPSK,  FEC_7_8,  0x07 },
 681
 682         { SYS_DVBS2, QPSK,  FEC_1_2,  0x04 },
 683         { SYS_DVBS2, QPSK,  FEC_3_5,  0x05 },
 684         { SYS_DVBS2, QPSK,  FEC_2_3,  0x06 },
 685         { SYS_DVBS2, QPSK,  FEC_3_4,  0x07 },
 686         { SYS_DVBS2, QPSK,  FEC_4_5,  0x08 },
 687         { SYS_DVBS2, QPSK,  FEC_5_6,  0x09 },
 688         { SYS_DVBS2, QPSK,  FEC_8_9,  0x0a },
 689         { SYS_DVBS2, QPSK,  FEC_9_10, 0x0b },
 690
 691         { SYS_DVBS2, PSK_8, FEC_3_5,  0x0c },
 692         { SYS_DVBS2, PSK_8, FEC_2_3,  0x0d },
 693         { SYS_DVBS2, PSK_8, FEC_3_4,  0x0e },
 694         { SYS_DVBS2, PSK_8, FEC_5_6,  0x0f },
 695         { SYS_DVBS2, PSK_8, FEC_8_9,  0x10 },
 696         { SYS_DVBS2, PSK_8, FEC_9_10, 0x11 },
 697 };
 698
 699 /* Retrieve current fec, modulation & pilot values */
 700 static int cx24120_get_fec(struct dvb_frontend *fe)
 701 {
 702         struct dtv_frontend_properties *c = &fe->dtv_property_cache;
 703         struct cx24120_state *state = fe->demodulator_priv;
 704         int idx;
 705         int ret;
 706         int fec;
 707
 708         dev_dbg(&state->i2c->dev, "%s()\n", __func__);
 709
 710         ret = cx24120_readreg(state, CX24120_REG_FECMODE);
 711         fec = ret & 0x3f; /* Lower 6 bits */
 712
 713         dev_dbg(&state->i2c->dev, "%s: Get FEC: %d\n", __func__, fec);
 714
 715         for (idx = 0; idx < ARRAY_SIZE(modfec_lookup_table); idx++) {
 716                 if (modfec_lookup_table[idx].delsys != state->dcur.delsys)
 717                         continue;
 718                 if (modfec_lookup_table[idx].val != fec)
 719                         continue;
 720
 721                 break; /* found */
 722         }
 723
 724         if (idx >= ARRAY_SIZE(modfec_lookup_table)) {
 725                 dev_dbg(&state->i2c->dev, "%s: Couldn't find fec!\n",
 726                         __func__);
 727                 return -EINVAL;
 728         }
 729
 730         /* save values back to cache */
 731         c->modulation = modfec_lookup_table[idx].mod;
 732         c->fec_inner = modfec_lookup_table[idx].fec;
 733         c->pilot = (ret & 0x80) ? PILOT_ON : PILOT_OFF;
 734
 735         dev_dbg(&state->i2c->dev,
 736                 "%s: mod(%d), fec(%d), pilot(%d)\n",
 737                 __func__,
 738                 c->modulation, c->fec_inner, c->pilot);
 739
 740         return 0;
 741 }
 742
 743 /* Clock ratios lookup table
 744  *
 745  * Values obtained from much larger table in old driver
 746  * which had numerous entries which would never match.
 747  *
 748  * There's probably some way of calculating these but I
 749  * can't determine the pattern
 750 */
 751 static struct cx24120_clock_ratios_table {
 752         fe_delivery_system_t delsys;
 753         fe_pilot_t pilot;
 754         fe_modulation_t mod;
 755         fe_code_rate_t fec;
 756         u32 m_rat;
 757         u32 n_rat;
 758         u32 rate;
 759 } clock_ratios_table[] = {
 760         /*delsys     pilot      mod    fec       m_rat    n_rat   rate */
 761         { SYS_DVBS2, PILOT_OFF, QPSK,  FEC_1_2,  273088,  254505, 274 },
 762         { SYS_DVBS2, PILOT_OFF, QPSK,  FEC_3_5,  17272,   13395,  330 },
 763         { SYS_DVBS2, PILOT_OFF, QPSK,  FEC_2_3,  24344,   16967,  367 },
 764         { SYS_DVBS2, PILOT_OFF, QPSK,  FEC_3_4,  410788,  254505, 413 },
 765         { SYS_DVBS2, PILOT_OFF, QPSK,  FEC_4_5,  438328,  254505, 440 },
 766         { SYS_DVBS2, PILOT_OFF, QPSK,  FEC_5_6,  30464,   16967,  459 },
 767         { SYS_DVBS2, PILOT_OFF, QPSK,  FEC_8_9,  487832,  254505, 490 },
 768         { SYS_DVBS2, PILOT_OFF, QPSK,  FEC_9_10, 493952,  254505, 496 },
 769         { SYS_DVBS2, PILOT_OFF, PSK_8, FEC_3_5,  328168,  169905, 494 },
 770         { SYS_DVBS2, PILOT_OFF, PSK_8, FEC_2_3,  24344,   11327,  550 },
 771         { SYS_DVBS2, PILOT_OFF, PSK_8, FEC_3_4,  410788,  169905, 618 },
 772         { SYS_DVBS2, PILOT_OFF, PSK_8, FEC_5_6,  30464,   11327,  688 },
 773         { SYS_DVBS2, PILOT_OFF, PSK_8, FEC_8_9,  487832,  169905, 735 },
 774         { SYS_DVBS2, PILOT_OFF, PSK_8, FEC_9_10, 493952,  169905, 744 },
 775         { SYS_DVBS2, PILOT_ON,  QPSK,  FEC_1_2,  273088,  260709, 268 },
 776         { SYS_DVBS2, PILOT_ON,  QPSK,  FEC_3_5,  328168,  260709, 322 },
 777         { SYS_DVBS2, PILOT_ON,  QPSK,  FEC_2_3,  121720,  86903,  358 },
 778         { SYS_DVBS2, PILOT_ON,  QPSK,  FEC_3_4,  410788,  260709, 403 },
 779         { SYS_DVBS2, PILOT_ON,  QPSK,  FEC_4_5,  438328,  260709, 430 },
 780         { SYS_DVBS2, PILOT_ON,  QPSK,  FEC_5_6,  152320,  86903,  448 },
 781         { SYS_DVBS2, PILOT_ON,  QPSK,  FEC_8_9,  487832,  260709, 479 },
 782         { SYS_DVBS2, PILOT_ON,  QPSK,  FEC_9_10, 493952,  260709, 485 },
 783         { SYS_DVBS2, PILOT_ON,  PSK_8, FEC_3_5,  328168,  173853, 483 },
 784         { SYS_DVBS2, PILOT_ON,  PSK_8, FEC_2_3,  121720,  57951,  537 },
 785         { SYS_DVBS2, PILOT_ON,  PSK_8, FEC_3_4,  410788,  173853, 604 },
 786         { SYS_DVBS2, PILOT_ON,  PSK_8, FEC_5_6,  152320,  57951,  672 },
 787         { SYS_DVBS2, PILOT_ON,  PSK_8, FEC_8_9,  487832,  173853, 718 },
 788         { SYS_DVBS2, PILOT_ON,  PSK_8, FEC_9_10, 493952,  173853, 727 },
 789         { SYS_DVBS,  PILOT_OFF, QPSK,  FEC_1_2,  152592,  152592, 256 },
 790         { SYS_DVBS,  PILOT_OFF, QPSK,  FEC_2_3,  305184,  228888, 341 },
 791         { SYS_DVBS,  PILOT_OFF, QPSK,  FEC_3_4,  457776,  305184, 384 },
 792         { SYS_DVBS,  PILOT_OFF, QPSK,  FEC_5_6,  762960,  457776, 427 },
 793         { SYS_DVBS,  PILOT_OFF, QPSK,  FEC_7_8,  1068144, 610368, 448 },
 794 };
 795
 796 /* Set clock ratio from lookup table */
 797 static void cx24120_set_clock_ratios(struct dvb_frontend *fe)
 798 {
 799         struct dtv_frontend_properties *c = &fe->dtv_property_cache;
 800         struct cx24120_state *state = fe->demodulator_priv;
 801         struct cx24120_cmd cmd;
 802         int ret, idx;
 803
 804         /* Find fec, modulation, pilot */
 805         ret = cx24120_get_fec(fe);
 806         if (ret != 0)
 807                 return;
 808
 809         /* Find the clock ratios in the lookup table */
 810         for (idx = 0; idx < ARRAY_SIZE(clock_ratios_table); idx++) {
 811                 if (clock_ratios_table[idx].delsys != state->dcur.delsys)
 812                         continue;
 813                 if (clock_ratios_table[idx].mod != c->modulation)
 814                         continue;
 815                 if (clock_ratios_table[idx].fec != c->fec_inner)
 816                         continue;
 817                 if (clock_ratios_table[idx].pilot != c->pilot)
 818                         continue;
 819
 820                 break;          /* found */
 821         }
 822
 823         if (idx >= ARRAY_SIZE(clock_ratios_table)) {
 824                 info("Clock ratio not found - data reception in danger\n");
 825                 return;
 826         }
 827
 828         /* Read current values? */
 829         cmd.id = CMD_CLOCK_READ;
 830         cmd.len = 1;
 831         cmd.arg[0] = 0x00;
 832         ret = cx24120_message_sendrcv(state, &cmd, 6);
 833         if (ret != 0)
 834                 return;
 835         /* in cmd[0]-[5] - result */
 836
 837         dev_dbg(&state->i2c->dev,
 838                 "%s: m=%d, n=%d; idx: %d m=%d, n=%d, rate=%d\n",
 839                 __func__,
 840                 cmd.arg[2] | (cmd.arg[1] << 8) | (cmd.arg[0] << 16),
 841                 cmd.arg[5] | (cmd.arg[4] << 8) | (cmd.arg[3] << 16),
 842                 idx,
 843                 clock_ratios_table[idx].m_rat,
 844                 clock_ratios_table[idx].n_rat,
 845                 clock_ratios_table[idx].rate);
 846
 847         /* Set the clock */
 848         cmd.id = CMD_CLOCK_SET;
 849         cmd.len = 10;
 850         cmd.arg[0] = 0;
 851         cmd.arg[1] = 0x10;
 852         cmd.arg[2] = (clock_ratios_table[idx].m_rat >> 16) & 0xff;
 853         cmd.arg[3] = (clock_ratios_table[idx].m_rat >>  8) & 0xff;
 854         cmd.arg[4] = (clock_ratios_table[idx].m_rat >>  0) & 0xff;
 855         cmd.arg[5] = (clock_ratios_table[idx].n_rat >> 16) & 0xff;
 856         cmd.arg[6] = (clock_ratios_table[idx].n_rat >>  8) & 0xff;
 857         cmd.arg[7] = (clock_ratios_table[idx].n_rat >>  0) & 0xff;
 858         cmd.arg[8] = (clock_ratios_table[idx].rate >> 8) & 0xff;
 859         cmd.arg[9] = (clock_ratios_table[idx].rate >> 0) & 0xff;
 860
 861         cx24120_message_send(state, &cmd);
 862 }
 863
 864 /* Set inversion value */
 865 static int cx24120_set_inversion(struct cx24120_state *state,
 866                                  fe_spectral_inversion_t inversion)
 867 {
 868         dev_dbg(&state->i2c->dev, "%s(%d)\n", __func__, inversion);
 869
 870         switch (inversion) {
 871         case INVERSION_OFF:
 872                 state->dnxt.inversion_val = 0x00;
 873                 break;
 874         case INVERSION_ON:
 875                 state->dnxt.inversion_val = 0x04;
 876                 break;
 877         case INVERSION_AUTO:
 878                 state->dnxt.inversion_val = 0x0c;
 879                 break;
 880         default:
 881                 return -EINVAL;
 882         }
 883
 884         state->dnxt.inversion = inversion;
 885
 886         return 0;
 887 }
 888
 889 /*
 890  * FEC lookup table for tuning Some DVB-S2 val's have been found by
 891  * trial and error. Sofar it seems to match up with the contents of
 892  * the REG_FECMODE after tuning The rest will probably be the same but
 893  * would need testing.  Anything not in the table will run with
 894  * FEC_AUTO and take a while longer to tune in ( c.500ms instead of
 895  * 30ms )
 896  */
 897 static struct cx24120_modfec_table {
 898         fe_delivery_system_t delsys;
 899         fe_modulation_t mod;
 900         fe_code_rate_t fec;
 901         u8 val;
 902 } modfec_table[] = {
 903 /*delsys        mod     fec      val */
 904         { SYS_DVBS,  QPSK,  FEC_1_2, 0x2e },
 905         { SYS_DVBS,  QPSK,  FEC_2_3, 0x2f },
 906         { SYS_DVBS,  QPSK,  FEC_3_4, 0x30 },
 907         { SYS_DVBS,  QPSK,  FEC_5_6, 0x31 },
 908         { SYS_DVBS,  QPSK,  FEC_6_7, 0x32 },
 909         { SYS_DVBS,  QPSK,  FEC_7_8, 0x33 },
 910
 911         { SYS_DVBS2, QPSK,  FEC_3_4, 0x07 },
 912
 913         { SYS_DVBS2, PSK_8, FEC_2_3, 0x0d },
 914         { SYS_DVBS2, PSK_8, FEC_3_4, 0x0e },
 915 };
 916
 917 /* Set fec_val & fec_mask values from delsys, modulation & fec */
 918 static int cx24120_set_fec(struct cx24120_state *state, fe_modulation_t mod,
 919                            fe_code_rate_t fec)
 920 {
 921         int idx;
 922
 923         dev_dbg(&state->i2c->dev, "%s(0x%02x,0x%02x)\n", __func__, mod, fec);
 924
 925         state->dnxt.fec = fec;
 926
 927         /* Lookup fec_val from modfec table */
 928         for (idx = 0; idx < ARRAY_SIZE(modfec_table); idx++) {
 929                 if (modfec_table[idx].delsys != state->dnxt.delsys)
 930                         continue;
 931                 if (modfec_table[idx].mod != mod)
 932                         continue;
 933                 if (modfec_table[idx].fec != fec)
 934                         continue;
 935
 936                 /* found */
 937                 state->dnxt.fec_mask = 0x00;
 938                 state->dnxt.fec_val = modfec_table[idx].val;
 939                 return 0;
 940         }
 941
 942         if (state->dnxt.delsys == SYS_DVBS2) {
 943                 /* DVBS2 auto is 0x00/0x00 */
 944                 state->dnxt.fec_mask = 0x00;
 945                 state->dnxt.fec_val  = 0x00;
 946         } else {
 947                 /* Set DVB-S to auto */
 948                 state->dnxt.fec_val  = 0x2e;
 949                 state->dnxt.fec_mask = 0xac;
 950         }
 951
 952         return 0;
 953 }
 954
 955 /* Set pilot */
 956 static int cx24120_set_pilot(struct cx24120_state *state, fe_pilot_t pilot)
 957 {
 958         dev_dbg(&state->i2c->dev, "%s(%d)\n", __func__, pilot);
 959
 960         /* Pilot only valid in DVBS2 */
 961         if (state->dnxt.delsys != SYS_DVBS2) {
 962                 state->dnxt.pilot_val = CX24120_PILOT_OFF;
 963                 return 0;
 964         }
 965
 966         switch (pilot) {
 967         case PILOT_OFF:
 968                 state->dnxt.pilot_val = CX24120_PILOT_OFF;
 969                 break;
 970         case PILOT_ON:
 971                 state->dnxt.pilot_val = CX24120_PILOT_ON;
 972                 break;
 973         case PILOT_AUTO:
 974         default:
 975                 state->dnxt.pilot_val = CX24120_PILOT_AUTO;
 976         }
 977
 978         return 0;
 979 }
 980
 981 /* Set symbol rate */
 982 static int cx24120_set_symbolrate(struct cx24120_state *state, u32 rate)
 983 {
 984         dev_dbg(&state->i2c->dev, "%s(%d)\n",
 985                 __func__, rate);
 986
 987         state->dnxt.symbol_rate = rate;
 988
 989         /* Check symbol rate */
 990         if (rate  > 31000000) {
 991                 state->dnxt.clkdiv  = (-(rate < 31000001) & 3) + 2;
 992                 state->dnxt.ratediv = (-(rate < 31000001) & 6) + 4;
 993         } else {
 994                 state->dnxt.clkdiv  = 3;
 995                 state->dnxt.ratediv = 6;
 996         }
 997
 998         return 0;
 999 }
1000
1001 /* Overwrite the current tuning params, we are about to tune */
1002 static void cx24120_clone_params(struct dvb_frontend *fe)
1003 {
1004         struct cx24120_state *state = fe->demodulator_priv;
1005
1006         state->dcur = state->dnxt;
1007 }
1008
1009 static int cx24120_set_frontend(struct dvb_frontend *fe)
1010 {
1011         struct dtv_frontend_properties *c = &fe->dtv_property_cache;
1012         struct cx24120_state *state = fe->demodulator_priv;
1013         struct cx24120_cmd cmd;
1014         int ret;
1015
1016         switch (c->delivery_system) {
1017         case SYS_DVBS2:
1018                 dev_dbg(&state->i2c->dev, "%s() DVB-S2\n",
1019                         __func__);
1020                 break;
1021         case SYS_DVBS:
1022                 dev_dbg(&state->i2c->dev, "%s() DVB-S\n",
1023                         __func__);
1024                 break;
1025         default:
1026                 dev_dbg(&state->i2c->dev,
1027                         "%s() Delivery system(%d) not supported\n",
1028                         __func__, c->delivery_system);
1029                 ret = -EINVAL;
1030                 break;
1031         }
1032
1033         state->dnxt.delsys = c->delivery_system;
1034         state->dnxt.modulation = c->modulation;
1035         state->dnxt.frequency = c->frequency;
1036         state->dnxt.pilot = c->pilot;
1037
1038         ret = cx24120_set_inversion(state, c->inversion);
1039         if (ret !=  0)
1040                 return ret;
1041
1042         ret = cx24120_set_fec(state, c->modulation, c->fec_inner);
1043         if (ret !=  0)
1044                 return ret;
1045
1046         ret = cx24120_set_pilot(state, c->pilot);
1047         if (ret != 0)
1048                 return ret;
1049
1050         ret = cx24120_set_symbolrate(state, c->symbol_rate);
1051         if (ret !=  0)
1052                 return ret;
1053
1054         /* discard the 'current' tuning parameters and prepare to tune */
1055         cx24120_clone_params(fe);
1056
1057         dev_dbg(&state->i2c->dev,
1058                 "%s: delsys      = %d\n", __func__, state->dcur.delsys);
1059         dev_dbg(&state->i2c->dev,
1060                 "%s: modulation  = %d\n", __func__, state->dcur.modulation);
1061         dev_dbg(&state->i2c->dev,
1062                 "%s: frequency   = %d\n", __func__, state->dcur.frequency);
1063         dev_dbg(&state->i2c->dev,
1064                 "%s: pilot       = %d (val = 0x%02x)\n", __func__,
1065                 state->dcur.pilot, state->dcur.pilot_val);
1066         dev_dbg(&state->i2c->dev,
1067                 "%s: symbol_rate = %d (clkdiv/ratediv = 0x%02x/0x%02x)\n",
1068                  __func__, state->dcur.symbol_rate,
1069                  state->dcur.clkdiv, state->dcur.ratediv);
1070         dev_dbg(&state->i2c->dev,
1071                 "%s: FEC         = %d (mask/val = 0x%02x/0x%02x)\n", __func__,
1072                 state->dcur.fec, state->dcur.fec_mask, state->dcur.fec_val);
1073         dev_dbg(&state->i2c->dev,
1074                 "%s: Inversion   = %d (val = 0x%02x)\n", __func__,
1075                 state->dcur.inversion, state->dcur.inversion_val);
1076
1077         /* Flag that clock needs to be set after tune */
1078         state->need_clock_set = 1;
1079
1080         /* Tune in */
1081         cmd.id = CMD_TUNEREQUEST;
1082         cmd.len = 15;
1083         cmd.arg[0] = 0;
1084         cmd.arg[1]  = (state->dcur.frequency & 0xff0000) >> 16;
1085         cmd.arg[2]  = (state->dcur.frequency & 0x00ff00) >> 8;
1086         cmd.arg[3]  = (state->dcur.frequency & 0x0000ff);
1087         cmd.arg[4]  = ((state->dcur.symbol_rate / 1000) & 0xff00) >> 8;
1088         cmd.arg[5]  = ((state->dcur.symbol_rate / 1000) & 0x00ff);
1089         cmd.arg[6]  = state->dcur.inversion;
1090         cmd.arg[7]  = state->dcur.fec_val | state->dcur.pilot_val;
1091         cmd.arg[8]  = CX24120_SEARCH_RANGE_KHZ >> 8;
1092         cmd.arg[9]  = CX24120_SEARCH_RANGE_KHZ & 0xff;
1093         cmd.arg[10] = 0;                /* maybe rolloff? */
1094         cmd.arg[11] = state->dcur.fec_mask;
1095         cmd.arg[12] = state->dcur.ratediv;
1096         cmd.arg[13] = state->dcur.clkdiv;
1097         cmd.arg[14] = 0;
1098
1099         /* Send tune command */
1100         ret = cx24120_message_send(state, &cmd);
1101         if (ret != 0)
1102                 return ret;
1103
1104         /* Write symbol rate values */
1105         ret = cx24120_writereg(state, CX24120_REG_CLKDIV, state->dcur.clkdiv);
1106         ret = cx24120_readreg(state, CX24120_REG_RATEDIV);
1107         ret &= 0xfffffff0;
1108         ret |= state->dcur.ratediv;
1109         ret = cx24120_writereg(state, CX24120_REG_RATEDIV, ret);
1110
1111         return 0;
1112 }
1113
1114 /* Calculate vco from config */
1115 static u64 cx24120_calculate_vco(struct cx24120_state *state)
1116 {
1117         u32 vco;
1118         u64 inv_vco, res, xxyyzz;
1119         u32 xtal_khz = state->config->xtal_khz;
1120
1121         xxyyzz = 0x400000000ULL;
1122         vco = xtal_khz * 10 * 4;
1123         inv_vco = xxyyzz / vco;
1124         res = xxyyzz % vco;
1125
1126         if (inv_vco > xtal_khz * 10 * 2)
1127                 ++inv_vco;
1128
1129         dev_dbg(&state->i2c->dev,
1130                 "%s: xtal=%d, vco=%d, inv_vco=%lld, res=%lld\n",
1131                 __func__, xtal_khz, vco, inv_vco, res);
1132
1133         return inv_vco;
1134 }
1135
1136 int cx24120_init(struct dvb_frontend *fe)
1137 {
1138         const struct firmware *fw;
1139         struct cx24120_state *state = fe->demodulator_priv;
1140         struct cx24120_cmd cmd;
1141         u8 ret, ret_EA, reg1;
1142         u64 inv_vco;
1143         int reset_result;
1144
1145         int i;
1146         unsigned char vers[4];
1147
1148         if (state->cold_init)
1149                 return 0;
1150
1151         /* ???? */
1152         ret = cx24120_writereg(state, 0xea, 0x00);
1153         ret = cx24120_test_rom(state);
1154         ret = cx24120_readreg(state, 0xfb) & 0xfe;
1155         ret = cx24120_writereg(state, 0xfb, ret);
1156         ret = cx24120_readreg(state, 0xfc) & 0xfe;
1157         ret = cx24120_writereg(state, 0xfc, ret);
1158         ret = cx24120_writereg(state, 0xc3, 0x04);
1159         ret = cx24120_writereg(state, 0xc4, 0x04);
1160         ret = cx24120_writereg(state, 0xce, 0x00);
1161         ret = cx24120_writereg(state, 0xcf, 0x00);
1162         ret_EA = cx24120_readreg(state, 0xea) & 0xfe;
1163         ret = cx24120_writereg(state, 0xea, ret_EA);
1164         ret = cx24120_writereg(state, 0xeb, 0x0c);
1165         ret = cx24120_writereg(state, 0xec, 0x06);
1166         ret = cx24120_writereg(state, 0xed, 0x05);
1167         ret = cx24120_writereg(state, 0xee, 0x03);
1168         ret = cx24120_writereg(state, 0xef, 0x05);
1169         ret = cx24120_writereg(state, 0xf3, 0x03);
1170         ret = cx24120_writereg(state, 0xf4, 0x44);
1171
1172         for (reg1 = 0xf0; reg1 < 0xf3; reg1++) {
1173                 cx24120_writereg(state, reg1, 0x04);
1174                 cx24120_writereg(state, reg1 - 10, 0x02);
1175         }
1176
1177         ret = cx24120_writereg(state, 0xea, (ret_EA | 0x01));
1178         for (reg1 = 0xc5; reg1 < 0xcb; reg1 += 2) {
1179                 ret = cx24120_writereg(state, reg1, 0x00);
1180                 ret = cx24120_writereg(state, reg1 + 1, 0x00);
1181         }
1182
1183         ret = cx24120_writereg(state, 0xe4, 0x03);
1184         ret = cx24120_writereg(state, 0xeb, 0x0a);
1185
1186         dev_dbg(&state->i2c->dev,
1187                 "%s: Requesting firmware (%s) to download...\n",
1188                 __func__, CX24120_FIRMWARE);
1189
1190         ret = state->config->request_firmware(fe, &fw, CX24120_FIRMWARE);
1191         if (ret) {
1192                 err("Could not load firmware (%s): %d\n", CX24120_FIRMWARE,
1193                     ret);
1194                 return ret;
1195         }
1196
1197         dev_dbg(&state->i2c->dev,
1198                 "%s: Firmware found, size %d bytes (%02x %02x .. %02x %02x)\n",
1199                 __func__,
1200                 (int)fw->size,                  /* firmware_size in bytes */
1201                 fw->data[0],                    /* fw 1st byte */
1202                 fw->data[1],                    /* fw 2d byte */
1203                 fw->data[fw->size - 2],         /* fw before last byte */
1204                 fw->data[fw->size - 1]);        /* fw last byte */
1205
1206         ret = cx24120_test_rom(state);
1207         ret = cx24120_readreg(state, 0xfb) & 0xfe;
1208         ret = cx24120_writereg(state, 0xfb, ret);
1209         ret = cx24120_writereg(state, 0xe0, 0x76);
1210         ret = cx24120_writereg(state, 0xf7, 0x81);
1211         ret = cx24120_writereg(state, 0xf8, 0x00);
1212         ret = cx24120_writereg(state, 0xf9, 0x00);
1213         ret = cx24120_writeregs(state, 0xfa, fw->data, (fw->size - 1), 0x00);
1214         ret = cx24120_writereg(state, 0xf7, 0xc0);
1215         ret = cx24120_writereg(state, 0xe0, 0x00);
1216         ret = (fw->size - 2) & 0x00ff;
1217         ret = cx24120_writereg(state, 0xf8, ret);
1218         ret = ((fw->size - 2) >> 8) & 0x00ff;
1219         ret = cx24120_writereg(state, 0xf9, ret);
1220         ret = cx24120_writereg(state, 0xf7, 0x00);
1221         ret = cx24120_writereg(state, 0xdc, 0x00);
1222         ret = cx24120_writereg(state, 0xdc, 0x07);
1223         msleep(500);
1224
1225         /* Check final byte matches final byte of firmware */
1226         ret = cx24120_readreg(state, 0xe1);
1227         if (ret == fw->data[fw->size - 1]) {
1228                 dev_dbg(&state->i2c->dev,
1229                         "%s: Firmware uploaded successfully\n",
1230                         __func__);
1231                 reset_result = 0;
1232         } else {
1233                 err("Firmware upload failed. Last byte returned=0x%x\n", ret);
1234                 reset_result = -EREMOTEIO;
1235         }
1236         ret = cx24120_writereg(state, 0xdc, 0x00);
1237         release_firmware(fw);
1238         if (reset_result != 0)
1239                 return reset_result;
1240
1241         /* Start tuner */
1242         cmd.id = CMD_START_TUNER;
1243         cmd.len = 3;
1244         cmd.arg[0] = 0x00;
1245         cmd.arg[1] = 0x00;
1246         cmd.arg[2] = 0x00;
1247
1248         if (cx24120_message_send(state, &cmd) != 0) {
1249                 err("Error tuner start! :(\n");
1250                 return -EREMOTEIO;
1251         }
1252
1253         /* Set VCO */
1254         inv_vco = cx24120_calculate_vco(state);
1255
1256         cmd.id = CMD_VCO_SET;
1257         cmd.len = 12;
1258         cmd.arg[0] = 0x06;
1259         cmd.arg[1] = 0x2b;
1260         cmd.arg[2] = 0xd8;
1261         cmd.arg[3] = (inv_vco >> 8) & 0xff;
1262         cmd.arg[4] = (inv_vco) & 0xff;
1263         cmd.arg[5] = 0x03;
1264         cmd.arg[6] = 0x9d;
1265         cmd.arg[7] = 0xfc;
1266         cmd.arg[8] = 0x06;
1267         cmd.arg[9] = 0x03;
1268         cmd.arg[10] = 0x27;
1269         cmd.arg[11] = 0x7f;
1270
1271         if (cx24120_message_send(state, &cmd)) {
1272                 err("Error set VCO! :(\n");
1273                 return -EREMOTEIO;
1274         }
1275
1276         /* set bandwidth */
1277         cmd.id = CMD_BANDWIDTH;
1278         cmd.len = 12;
1279         cmd.arg[0] = 0x00;
1280         cmd.arg[1] = 0x00;
1281         cmd.arg[2] = 0x00;
1282         cmd.arg[3] = 0x00;
1283         cmd.arg[4] = 0x05;
1284         cmd.arg[5] = 0x02;
1285         cmd.arg[6] = 0x02;
1286         cmd.arg[7] = 0x00;
1287         cmd.arg[8] = 0x05;
1288         cmd.arg[9] = 0x02;
1289         cmd.arg[10] = 0x02;
1290         cmd.arg[11] = 0x00;
1291
1292         if (cx24120_message_send(state, &cmd)) {
1293                 err("Error set bandwidth!\n");
1294                 return -EREMOTEIO;
1295         }
1296
1297         ret = cx24120_readreg(state, 0xba);
1298         if (ret > 3) {
1299                 dev_dbg(&state->i2c->dev, "%s: Reset-readreg 0xba: %x\n",
1300                         __func__, ret);
1301                 err("Error initialising tuner!\n");
1302                 return -EREMOTEIO;
1303         }
1304
1305         dev_dbg(&state->i2c->dev, "%s: Tuner initialised correctly.\n",
1306                 __func__);
1307
1308         /* Initialise mpeg outputs */
1309         ret = cx24120_writereg(state, 0xeb, 0x0a);
1310         if (cx24120_msg_mpeg_output_global_config(state, 0) ||
1311             cx24120_msg_mpeg_output_config(state, 0) ||
1312             cx24120_msg_mpeg_output_config(state, 1) ||
1313             cx24120_msg_mpeg_output_config(state, 2)) {
1314                 err("Error initialising mpeg output. :(\n");
1315                 return -EREMOTEIO;
1316         }
1317
1318         /* ???? */
1319         cmd.id = CMD_TUNER_INIT;
1320         cmd.len = 3;
1321         cmd.arg[0] = 0x00;
1322         cmd.arg[1] = 0x10;
1323         cmd.arg[2] = 0x10;
1324         if (cx24120_message_send(state, &cmd)) {
1325                 err("Error sending final init message. :(\n");
1326                 return -EREMOTEIO;
1327         }
1328
1329         /* Firmware CMD 35: Get firmware version */
1330         cmd.id = CMD_FWVERSION;
1331         cmd.len = 1;
1332         for (i = 0; i < 4; i++) {
1333                 cmd.arg[0] = i;
1334                 ret = cx24120_message_send(state, &cmd);
1335                 if (ret != 0)
1336                         return ret;
1337                 vers[i] = cx24120_readreg(state, CX24120_REG_MAILBOX);
1338         }
1339         info("FW version %i.%i.%i.%i\n", vers[0], vers[1], vers[2], vers[3]);
1340
1341         state->cold_init = 1;
1342         return 0;
1343 }
1344
1345 static int cx24120_tune(struct dvb_frontend *fe, bool re_tune,
1346                         unsigned int mode_flags, unsigned int *delay,
1347                         fe_status_t *status)
1348 {
1349         struct cx24120_state *state = fe->demodulator_priv;
1350         int ret;
1351
1352         dev_dbg(&state->i2c->dev, "%s(%d)\n", __func__, re_tune);
1353
1354         /* TODO: Do we need to set delay? */
1355
1356         if (re_tune) {
1357                 ret = cx24120_set_frontend(fe);
1358                 if (ret)
1359                         return ret;
1360         }
1361
1362         return cx24120_read_status(fe, status);
1363 }
1364
1365 static int cx24120_get_algo(struct dvb_frontend *fe)
1366 {
1367         return DVBFE_ALGO_HW;
1368 }
1369
1370 static int cx24120_sleep(struct dvb_frontend *fe)
1371 {
1372         return 0;
1373 }
1374
1375 static int cx24120_get_frontend(struct dvb_frontend *fe)
1376 {
1377         struct dtv_frontend_properties *c = &fe->dtv_property_cache;
1378         struct cx24120_state *state = fe->demodulator_priv;
1379         u8 freq1, freq2, freq3;
1380         fe_status_t status;
1381
1382         dev_dbg(&state->i2c->dev, "%s()", __func__);
1383
1384         /* don't return empty data if we're not tuned in */
1385         cx24120_read_status(fe, &status);
1386         if ((status & FE_HAS_LOCK) == 0)
1387                 return 0;
1388
1389         /* Get frequency */
1390         freq1 = cx24120_readreg(state, CX24120_REG_FREQ1);
1391         freq2 = cx24120_readreg(state, CX24120_REG_FREQ2);
1392         freq3 = cx24120_readreg(state, CX24120_REG_FREQ3);
1393         c->frequency = (freq3 << 16) | (freq2 << 8) | freq1;
1394         dev_dbg(&state->i2c->dev, "%s frequency = %d\n", __func__,
1395                 c->frequency);
1396
1397         /* Get modulation, fec, pilot */
1398         cx24120_get_fec(fe);
1399
1400         return 0;
1401 }
1402
1403 static void cx24120_release(struct dvb_frontend *fe)
1404 {
1405         struct cx24120_state *state = fe->demodulator_priv;
1406
1407         dev_dbg(&state->i2c->dev, "%s: Clear state structure\n", __func__);
1408         kfree(state);
1409 }
1410
1411 static int cx24120_read_ucblocks(struct dvb_frontend *fe, u32 *ucblocks)
1412 {
1413         struct cx24120_state *state = fe->demodulator_priv;
1414
1415         *ucblocks = (cx24120_readreg(state, CX24120_REG_UCB_H) << 8) |
1416                      cx24120_readreg(state, CX24120_REG_UCB_L);
1417
1418         dev_dbg(&state->i2c->dev, "%s: Blocks = %d\n", __func__, *ucblocks);
1419         return 0;
1420 }
1421
1422 static struct dvb_frontend_ops cx24120_ops = {
1423         .delsys = { SYS_DVBS, SYS_DVBS2 },
1424         .info = {
1425                 .name = "Conexant CX24120/CX24118",
1426                 .frequency_min = 950000,
1427                 .frequency_max = 2150000,
1428                 .frequency_stepsize = 1011, /* kHz for QPSK frontends */
1429                 .frequency_tolerance = 5000,
1430                 .symbol_rate_min = 1000000,
1431                 .symbol_rate_max = 45000000,
1432                 .caps = FE_CAN_INVERSION_AUTO |
1433                         FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
1434                         FE_CAN_FEC_4_5 | FE_CAN_FEC_5_6 | FE_CAN_FEC_6_7 |
1435                         FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
1436                         FE_CAN_2G_MODULATION |
1437                         FE_CAN_QPSK | FE_CAN_RECOVER
1438         },
1439         .release =                      cx24120_release,
1440
1441         .init =                         cx24120_init,
1442         .sleep =                        cx24120_sleep,
1443
1444         .tune =                         cx24120_tune,
1445         .get_frontend_algo =            cx24120_get_algo,
1446         .set_frontend =                 cx24120_set_frontend,
1447
1448         .get_frontend =                 cx24120_get_frontend,
1449         .read_status =                  cx24120_read_status,
1450         .read_ber =                     cx24120_read_ber,
1451         .read_signal_strength =         cx24120_read_signal_strength,
1452         .read_snr =                     cx24120_read_snr,
1453         .read_ucblocks =                cx24120_read_ucblocks,
1454
1455         .diseqc_send_master_cmd =       cx24120_send_diseqc_msg,
1456
1457         .diseqc_send_burst =            cx24120_diseqc_send_burst,
1458         .set_tone =                     cx24120_set_tone,
1459         .set_voltage =                  cx24120_set_voltage,
1460 };
1461
1462 MODULE_DESCRIPTION("DVB Frontend module for Conexant CX24120/CX24118 hardware");
1463 MODULE_AUTHOR("Jemma Denson");
1464 MODULE_LICENSE("GPL");