drivers/media/dvb/frontends/nxt200x.c

   1 /*
   2  *    Support for NXT2002 and NXT2004 - VSB/QAM
   3  *
   4  *    Copyright (C) 2005 Kirk Lapray (kirk.lapray@gmail.com)
   5  *    based on nxt2002 by Taylor Jacob <rtjacob@earthlink.net>
   6  *    and nxt2004 by Jean-Francois Thibert (jeanfrancois@sagetv.com)
   7  *
   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.
  12  *
  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.
  17  *
  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.
  21  *
  22 */
  23
  24 /*
  25  *                      NOTES ABOUT THIS DRIVER
  26  *
  27  * This Linux driver supports:
  28  *   B2C2/BBTI Technisat Air2PC - ATSC (NXT2002)
  29  *   AverTVHD MCE A180 (NXT2004)
  30  *   ATI HDTV Wonder (NXT2004)
  31  *
  32  * This driver needs external firmware. Please use the command
  33  * "<kerneldir>/Documentation/dvb/get_dvb_firmware nxt2002" or
  34  * "<kerneldir>/Documentation/dvb/get_dvb_firmware nxt2004" to
  35  * download/extract the appropriate firmware, and then copy it to
  36  * /usr/lib/hotplug/firmware/ or /lib/firmware/
  37  * (depending on configuration of firmware hotplug).
  38  */
  39 #define NXT2002_DEFAULT_FIRMWARE "dvb-fe-nxt2002.fw"
  40 #define NXT2004_DEFAULT_FIRMWARE "dvb-fe-nxt2004.fw"
  41 #define CRC_CCIT_MASK 0x1021
  42
  43 #include <linux/kernel.h>
  44 #include <linux/init.h>
  45 #include <linux/module.h>
  46 #include <linux/moduleparam.h>
  47
  48 #include "dvb_frontend.h"
  49 #include "dvb-pll.h"
  50 #include "nxt200x.h"
  51
  52 struct nxt200x_state {
  53
  54         struct i2c_adapter* i2c;
  55         struct dvb_frontend_ops ops;
  56         const struct nxt200x_config* config;
  57         struct dvb_frontend frontend;
  58
  59         /* demodulator private data */
  60         nxt_chip_type demod_chip;
  61         u8 initialised:1;
  62 };
  63
  64 static int debug;
  65 #define dprintk(args...) \
  66         do { \
  67                 if (debug) printk(KERN_DEBUG "nxt200x: " args); \
  68         } while (0)
  69
  70 static int i2c_writebytes (struct nxt200x_state* state, u8 addr, u8 *buf, u8 len)
  71 {
  72         int err;
  73         struct i2c_msg msg = { .addr = addr, .flags = 0, .buf = buf, .len = len };
  74
  75         if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
  76                 printk (KERN_WARNING "nxt200x: %s: i2c write error (addr 0x%02x, err == %i)\n",
  77                         __FUNCTION__, addr, err);
  78                 return -EREMOTEIO;
  79         }
  80         return 0;
  81 }
  82
  83 static u8 i2c_readbytes (struct nxt200x_state* state, u8 addr, u8* buf, u8 len)
  84 {
  85         int err;
  86         struct i2c_msg msg = { .addr = addr, .flags = I2C_M_RD, .buf = buf, .len = len };
  87
  88         if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
  89                 printk (KERN_WARNING "nxt200x: %s: i2c read error (addr 0x%02x, err == %i)\n",
  90                         __FUNCTION__, addr, err);
  91                 return -EREMOTEIO;
  92         }
  93         return 0;
  94 }
  95
  96 static int nxt200x_writebytes (struct nxt200x_state* state, u8 reg, u8 *buf, u8 len)
  97 {
  98         u8 buf2 [len+1];
  99         int err;
 100         struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf2, .len = len + 1 };
 101
 102         buf2[0] = reg;
 103         memcpy(&buf2[1], buf, len);
 104
 105         if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
 106                 printk (KERN_WARNING "nxt200x: %s: i2c write error (addr 0x%02x, err == %i)\n",
 107                         __FUNCTION__, state->config->demod_address, err);
 108                 return -EREMOTEIO;
 109         }
 110         return 0;
 111 }
 112
 113 static u8 nxt200x_readbytes (struct nxt200x_state* state, u8 reg, u8* buf, u8 len)
 114 {
 115         u8 reg2 [] = { reg };
 116
 117         struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = reg2, .len = 1 },
 118                         { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = buf, .len = len } };
 119
 120         int err;
 121
 122         if ((err = i2c_transfer (state->i2c, msg, 2)) != 2) {
 123                 printk (KERN_WARNING "nxt200x: %s: i2c read error (addr 0x%02x, err == %i)\n",
 124                         __FUNCTION__, state->config->demod_address, err);
 125                 return -EREMOTEIO;
 126         }
 127         return 0;
 128 }
 129
 130 static u16 nxt200x_crc(u16 crc, u8 c)
 131 {
 132         u8 i;
 133         u16 input = (u16) c & 0xFF;
 134
 135         input<<=8;
 136         for(i=0; i<8; i++) {
 137                 if((crc^input) & 0x8000)
 138                         crc=(crc<<1)^CRC_CCIT_MASK;
 139                 else
 140                         crc<<=1;
 141                 input<<=1;
 142         }
 143         return crc;
 144 }
 145
 146 static int nxt200x_writereg_multibyte (struct nxt200x_state* state, u8 reg, u8* data, u8 len)
 147 {
 148         u8 attr, len2, buf;
 149         dprintk("%s\n", __FUNCTION__);
 150
 151         /* set mutli register register */
 152         nxt200x_writebytes(state, 0x35, &reg, 1);
 153
 154         /* send the actual data */
 155         nxt200x_writebytes(state, 0x36, data, len);
 156
 157         switch (state->demod_chip) {
 158                 case NXT2002:
 159                         len2 = len;
 160                         buf = 0x02;
 161                         break;
 162                 case NXT2004:
 163                         /* probably not right, but gives correct values */
 164                         attr = 0x02;
 165                         if (reg & 0x80) {
 166                                 attr = attr << 1;
 167                                 if (reg & 0x04)
 168                                         attr = attr >> 1;
 169                         }
 170                         /* set write bit */
 171                         len2 = ((attr << 4) | 0x10) | len;
 172                         buf = 0x80;
 173                         break;
 174                 default:
 175                         return -EINVAL;
 176                         break;
 177         }
 178
 179         /* set multi register length */
 180         nxt200x_writebytes(state, 0x34, &len2, 1);
 181
 182         /* toggle the multireg write bit */
 183         nxt200x_writebytes(state, 0x21, &buf, 1);
 184
 185         nxt200x_readbytes(state, 0x21, &buf, 1);
 186
 187         switch (state->demod_chip) {
 188                 case NXT2002:
 189                         if ((buf & 0x02) == 0)
 190                                 return 0;
 191                         break;
 192                 case NXT2004:
 193                         if (buf == 0)
 194                                 return 0;
 195                         break;
 196                 default:
 197                         return -EINVAL;
 198                         break;
 199         }
 200
 201         printk(KERN_WARNING "nxt200x: Error writing multireg register 0x%02X\n",reg);
 202
 203         return 0;
 204 }
 205
 206 static int nxt200x_readreg_multibyte (struct nxt200x_state* state, u8 reg, u8* data, u8 len)
 207 {
 208         int i;
 209         u8 buf, len2, attr;
 210         dprintk("%s\n", __FUNCTION__);
 211
 212         /* set mutli register register */
 213         nxt200x_writebytes(state, 0x35, &reg, 1);
 214
 215         switch (state->demod_chip) {
 216                 case NXT2002:
 217                         /* set multi register length */
 218                         len2 = len & 0x80;
 219                         nxt200x_writebytes(state, 0x34, &len2, 1);
 220
 221                         /* read the actual data */
 222                         nxt200x_readbytes(state, reg, data, len);
 223                         return 0;
 224                         break;
 225                 case NXT2004:
 226                         /* probably not right, but gives correct values */
 227                         attr = 0x02;
 228                         if (reg & 0x80) {
 229                                 attr = attr << 1;
 230                                 if (reg & 0x04)
 231                                         attr = attr >> 1;
 232                         }
 233
 234                         /* set multi register length */
 235                         len2 = (attr << 4) | len;
 236                         nxt200x_writebytes(state, 0x34, &len2, 1);
 237
 238                         /* toggle the multireg bit*/
 239                         buf = 0x80;
 240                         nxt200x_writebytes(state, 0x21, &buf, 1);
 241
 242                         /* read the actual data */
 243                         for(i = 0; i < len; i++) {
 244                                 nxt200x_readbytes(state, 0x36 + i, &data[i], 1);
 245                         }
 246                         return 0;
 247                         break;
 248                 default:
 249                         return -EINVAL;
 250                         break;
 251         }
 252 }
 253
 254 static void nxt200x_microcontroller_stop (struct nxt200x_state* state)
 255 {
 256         u8 buf, stopval, counter = 0;
 257         dprintk("%s\n", __FUNCTION__);
 258
 259         /* set correct stop value */
 260         switch (state->demod_chip) {
 261                 case NXT2002:
 262                         stopval = 0x40;
 263                         break;
 264                 case NXT2004:
 265                         stopval = 0x10;
 266                         break;
 267                 default:
 268                         stopval = 0;
 269                         break;
 270         }
 271
 272         buf = 0x80;
 273         nxt200x_writebytes(state, 0x22, &buf, 1);
 274
 275         while (counter < 20) {
 276                 nxt200x_readbytes(state, 0x31, &buf, 1);
 277                 if (buf & stopval)
 278                         return;
 279                 msleep(10);
 280                 counter++;
 281         }
 282
 283         printk(KERN_WARNING "nxt200x: Timeout waiting for nxt200x to stop. This is ok after firmware upload.\n");
 284         return;
 285 }
 286
 287 static void nxt200x_microcontroller_start (struct nxt200x_state* state)
 288 {
 289         u8 buf;
 290         dprintk("%s\n", __FUNCTION__);
 291
 292         buf = 0x00;
 293         nxt200x_writebytes(state, 0x22, &buf, 1);
 294 }
 295
 296 static void nxt2004_microcontroller_init (struct nxt200x_state* state)
 297 {
 298         u8 buf[9];
 299         u8 counter = 0;
 300         dprintk("%s\n", __FUNCTION__);
 301
 302         buf[0] = 0x00;
 303         nxt200x_writebytes(state, 0x2b, buf, 1);
 304         buf[0] = 0x70;
 305         nxt200x_writebytes(state, 0x34, buf, 1);
 306         buf[0] = 0x04;
 307         nxt200x_writebytes(state, 0x35, buf, 1);
 308         buf[0] = 0x01; buf[1] = 0x23; buf[2] = 0x45; buf[3] = 0x67; buf[4] = 0x89;
 309         buf[5] = 0xAB; buf[6] = 0xCD; buf[7] = 0xEF; buf[8] = 0xC0;
 310         nxt200x_writebytes(state, 0x36, buf, 9);
 311         buf[0] = 0x80;
 312         nxt200x_writebytes(state, 0x21, buf, 1);
 313
 314         while (counter < 20) {
 315                 nxt200x_readbytes(state, 0x21, buf, 1);
 316                 if (buf[0] == 0)
 317                         return;
 318                 msleep(10);
 319                 counter++;
 320         }
 321
 322         printk(KERN_WARNING "nxt200x: Timeout waiting for nxt2004 to init.\n");
 323
 324         return;
 325 }
 326
 327 static int nxt200x_writetuner (struct nxt200x_state* state, u8* data)
 328 {
 329         u8 buf, count = 0;
 330
 331         dprintk("%s\n", __FUNCTION__);
 332
 333         dprintk("Tuner Bytes: %02X %02X %02X %02X\n", data[0], data[1], data[2], data[3]);
 334
 335         /* if NXT2004, write directly to tuner. if NXT2002, write through NXT chip.
 336          * direct write is required for Philips TUV1236D and ALPS TDHU2 */
 337         switch (state->demod_chip) {
 338                 case NXT2004:
 339                         if (i2c_writebytes(state, state->config->pll_address, data, 4))
 340                                 printk(KERN_WARNING "nxt200x: error writing to tuner\n");
 341                         /* wait until we have a lock */
 342                         while (count < 20) {
 343                                 i2c_readbytes(state, state->config->pll_address, &buf, 1);
 344                                 if (buf & 0x40)
 345                                         return 0;
 346                                 msleep(100);
 347                                 count++;
 348                         }
 349                         printk("nxt2004: timeout waiting for tuner lock\n");
 350                         break;
 351                 case NXT2002:
 352                         /* set the i2c transfer speed to the tuner */
 353                         buf = 0x03;
 354                         nxt200x_writebytes(state, 0x20, &buf, 1);
 355
 356                         /* setup to transfer 4 bytes via i2c */
 357                         buf = 0x04;
 358                         nxt200x_writebytes(state, 0x34, &buf, 1);
 359
 360                         /* write actual tuner bytes */
 361                         nxt200x_writebytes(state, 0x36, data, 4);
 362
 363                         /* set tuner i2c address */
 364                         buf = state->config->pll_address;
 365                         nxt200x_writebytes(state, 0x35, &buf, 1);
 366
 367                         /* write UC Opmode to begin transfer */
 368                         buf = 0x80;
 369                         nxt200x_writebytes(state, 0x21, &buf, 1);
 370
 371                         while (count < 20) {
 372                                 nxt200x_readbytes(state, 0x21, &buf, 1);
 373                                 if ((buf & 0x80)== 0x00)
 374                                         return 0;
 375                                 msleep(100);
 376                                 count++;
 377                         }
 378                         printk("nxt2002: timeout error writing tuner\n");
 379                         break;
 380                 default:
 381                         return -EINVAL;
 382                         break;
 383         }
 384         return 0;
 385 }
 386
 387 static void nxt200x_agc_reset(struct nxt200x_state* state)
 388 {
 389         u8 buf;
 390         dprintk("%s\n", __FUNCTION__);
 391
 392         switch (state->demod_chip) {
 393                 case NXT2002:
 394                         buf = 0x08;
 395                         nxt200x_writebytes(state, 0x08, &buf, 1);
 396                         buf = 0x00;
 397                         nxt200x_writebytes(state, 0x08, &buf, 1);
 398                         break;
 399                 case NXT2004:
 400                         nxt200x_readreg_multibyte(state, 0x08, &buf, 1);
 401                         buf = 0x08;
 402                         nxt200x_writereg_multibyte(state, 0x08, &buf, 1);
 403                         buf = 0x00;
 404                         nxt200x_writereg_multibyte(state, 0x08, &buf, 1);
 405                         break;
 406                 default:
 407                         break;
 408         }
 409         return;
 410 }
 411
 412 static int nxt2002_load_firmware (struct dvb_frontend* fe, const struct firmware *fw)
 413 {
 414
 415         struct nxt200x_state* state = fe->demodulator_priv;
 416         u8 buf[3], written = 0, chunkpos = 0;
 417         u16 rambase, position, crc = 0;
 418
 419         dprintk("%s\n", __FUNCTION__);
 420         dprintk("Firmware is %zu bytes\n", fw->size);
 421
 422         /* Get the RAM base for this nxt2002 */
 423         nxt200x_readbytes(state, 0x10, buf, 1);
 424
 425         if (buf[0] & 0x10)
 426                 rambase = 0x1000;
 427         else
 428                 rambase = 0x0000;
 429
 430         dprintk("rambase on this nxt2002 is %04X\n", rambase);
 431
 432         /* Hold the micro in reset while loading firmware */
 433         buf[0] = 0x80;
 434         nxt200x_writebytes(state, 0x2B, buf, 1);
 435
 436         for (position = 0; position < fw->size; position++) {
 437                 if (written == 0) {
 438                         crc = 0;
 439                         chunkpos = 0x28;
 440                         buf[0] = ((rambase + position) >> 8);
 441                         buf[1] = (rambase + position) & 0xFF;
 442                         buf[2] = 0x81;
 443                         /* write starting address */
 444                         nxt200x_writebytes(state, 0x29, buf, 3);
 445                 }
 446                 written++;
 447                 chunkpos++;
 448
 449                 if ((written % 4) == 0)
 450                         nxt200x_writebytes(state, chunkpos, &fw->data[position-3], 4);
 451
 452                 crc = nxt200x_crc(crc, fw->data[position]);
 453
 454                 if ((written == 255) || (position+1 == fw->size)) {
 455                         /* write remaining bytes of firmware */
 456                         nxt200x_writebytes(state, chunkpos+4-(written %4),
 457                                 &fw->data[position-(written %4) + 1],
 458                                 written %4);
 459                         buf[0] = crc << 8;
 460                         buf[1] = crc & 0xFF;
 461
 462                         /* write crc */
 463                         nxt200x_writebytes(state, 0x2C, buf, 2);
 464
 465                         /* do a read to stop things */
 466                         nxt200x_readbytes(state, 0x2A, buf, 1);
 467
 468                         /* set transfer mode to complete */
 469                         buf[0] = 0x80;
 470                         nxt200x_writebytes(state, 0x2B, buf, 1);
 471
 472                         written = 0;
 473                 }
 474         }
 475
 476         return 0;
 477 };
 478
 479 static int nxt2004_load_firmware (struct dvb_frontend* fe, const struct firmware *fw)
 480 {
 481
 482         struct nxt200x_state* state = fe->demodulator_priv;
 483         u8 buf[3];
 484         u16 rambase, position, crc=0;
 485
 486         dprintk("%s\n", __FUNCTION__);
 487         dprintk("Firmware is %zu bytes\n", fw->size);
 488
 489         /* set rambase */
 490         rambase = 0x1000;
 491
 492         /* hold the micro in reset while loading firmware */
 493         buf[0] = 0x80;
 494         nxt200x_writebytes(state, 0x2B, buf,1);
 495
 496         /* calculate firmware CRC */
 497         for (position = 0; position < fw->size; position++) {
 498                 crc = nxt200x_crc(crc, fw->data[position]);
 499         }
 500
 501         buf[0] = rambase >> 8;
 502         buf[1] = rambase & 0xFF;
 503         buf[2] = 0x81;
 504         /* write starting address */
 505         nxt200x_writebytes(state,0x29,buf,3);
 506
 507         for (position = 0; position < fw->size;) {
 508                 nxt200x_writebytes(state, 0x2C, &fw->data[position],
 509                         fw->size-position > 255 ? 255 : fw->size-position);
 510                 position += (fw->size-position > 255 ? 255 : fw->size-position);
 511         }
 512         buf[0] = crc >> 8;
 513         buf[1] = crc & 0xFF;
 514
 515         dprintk("firmware crc is 0x%02X 0x%02X\n", buf[0], buf[1]);
 516
 517         /* write crc */
 518         nxt200x_writebytes(state, 0x2C, buf,2);
 519
 520         /* do a read to stop things */
 521         nxt200x_readbytes(state, 0x2C, buf, 1);
 522
 523         /* set transfer mode to complete */
 524         buf[0] = 0x80;
 525         nxt200x_writebytes(state, 0x2B, buf,1);
 526
 527         return 0;
 528 };
 529
 530 static int nxt200x_setup_frontend_parameters (struct dvb_frontend* fe,
 531                                              struct dvb_frontend_parameters *p)
 532 {
 533         struct nxt200x_state* state = fe->demodulator_priv;
 534         u8 buf[4];
 535
 536         /* stop the micro first */
 537         nxt200x_microcontroller_stop(state);
 538
 539         if (state->demod_chip == NXT2004) {
 540                 /* make sure demod is set to digital */
 541                 buf[0] = 0x04;
 542                 nxt200x_writebytes(state, 0x14, buf, 1);
 543                 buf[0] = 0x00;
 544                 nxt200x_writebytes(state, 0x17, buf, 1);
 545         }
 546
 547         /* get tuning information */
 548         dvb_pll_configure(state->config->pll_desc, buf, p->frequency, 0);
 549
 550         /* set additional params */
 551         switch (p->u.vsb.modulation) {
 552                 case QAM_64:
 553                 case QAM_256:
 554                         /* Set punctured clock for QAM */
 555                         /* This is just a guess since I am unable to test it */
 556                         if (state->config->set_ts_params)
 557                                 state->config->set_ts_params(fe, 1);
 558
 559                         /* set to use cable input */
 560                         buf[3] |= 0x08;
 561                         break;
 562                 case VSB_8:
 563                         /* Set non-punctured clock for VSB */
 564                         if (state->config->set_ts_params)
 565                                 state->config->set_ts_params(fe, 0);
 566                         break;
 567                 default:
 568                         return -EINVAL;
 569                         break;
 570         }
 571
 572         /* write frequency information */
 573         nxt200x_writetuner(state, buf);
 574
 575         /* reset the agc now that tuning has been completed */
 576         nxt200x_agc_reset(state);
 577
 578         /* set target power level */
 579         switch (p->u.vsb.modulation) {
 580                 case QAM_64:
 581                 case QAM_256:
 582                         buf[0] = 0x74;
 583                         break;
 584                 case VSB_8:
 585                         buf[0] = 0x70;
 586                         break;
 587                 default:
 588                         return -EINVAL;
 589                         break;
 590         }
 591         nxt200x_writebytes(state, 0x42, buf, 1);
 592
 593         /* configure sdm */
 594         switch (state->demod_chip) {
 595                 case NXT2002:
 596                         buf[0] = 0x87;
 597                         break;
 598                 case NXT2004:
 599                         buf[0] = 0x07;
 600                         break;
 601                 default:
 602                         return -EINVAL;
 603                         break;
 604         }
 605         nxt200x_writebytes(state, 0x57, buf, 1);
 606
 607         /* write sdm1 input */
 608         buf[0] = 0x10;
 609         buf[1] = 0x00;
 610         nxt200x_writebytes(state, 0x58, buf, 2);
 611
 612         /* write sdmx input */
 613         switch (p->u.vsb.modulation) {
 614                 case QAM_64:
 615                                 buf[0] = 0x68;
 616                                 break;
 617                 case QAM_256:
 618                                 buf[0] = 0x64;
 619                                 break;
 620                 case VSB_8:
 621                                 buf[0] = 0x60;
 622                                 break;
 623                 default:
 624                                 return -EINVAL;
 625                                 break;
 626         }
 627         buf[1] = 0x00;
 628         nxt200x_writebytes(state, 0x5C, buf, 2);
 629
 630         /* write adc power lpf fc */
 631         buf[0] = 0x05;
 632         nxt200x_writebytes(state, 0x43, buf, 1);
 633
 634         if (state->demod_chip == NXT2004) {
 635                 /* write ??? */
 636                 buf[0] = 0x00;
 637                 buf[1] = 0x00;
 638                 nxt200x_writebytes(state, 0x46, buf, 2);
 639         }
 640
 641         /* write accumulator2 input */
 642         buf[0] = 0x80;
 643         buf[1] = 0x00;
 644         nxt200x_writebytes(state, 0x4B, buf, 2);
 645
 646         /* write kg1 */
 647         buf[0] = 0x00;
 648         nxt200x_writebytes(state, 0x4D, buf, 1);
 649
 650         /* write sdm12 lpf fc */
 651         buf[0] = 0x44;
 652         nxt200x_writebytes(state, 0x55, buf, 1);
 653
 654         /* write agc control reg */
 655         buf[0] = 0x04;
 656         nxt200x_writebytes(state, 0x41, buf, 1);
 657
 658         if (state->demod_chip == NXT2004) {
 659                 nxt200x_readreg_multibyte(state, 0x80, buf, 1);
 660                 buf[0] = 0x24;
 661                 nxt200x_writereg_multibyte(state, 0x80, buf, 1);
 662
 663                 /* soft reset? */
 664                 nxt200x_readreg_multibyte(state, 0x08, buf, 1);
 665                 buf[0] = 0x10;
 666                 nxt200x_writereg_multibyte(state, 0x08, buf, 1);
 667                 nxt200x_readreg_multibyte(state, 0x08, buf, 1);
 668                 buf[0] = 0x00;
 669                 nxt200x_writereg_multibyte(state, 0x08, buf, 1);
 670
 671                 nxt200x_readreg_multibyte(state, 0x80, buf, 1);
 672                 buf[0] = 0x04;
 673                 nxt200x_writereg_multibyte(state, 0x80, buf, 1);
 674                 buf[0] = 0x00;
 675                 nxt200x_writereg_multibyte(state, 0x81, buf, 1);
 676                 buf[0] = 0x80; buf[1] = 0x00; buf[2] = 0x00;
 677                 nxt200x_writereg_multibyte(state, 0x82, buf, 3);
 678                 nxt200x_readreg_multibyte(state, 0x88, buf, 1);
 679                 buf[0] = 0x11;
 680                 nxt200x_writereg_multibyte(state, 0x88, buf, 1);
 681                 nxt200x_readreg_multibyte(state, 0x80, buf, 1);
 682                 buf[0] = 0x44;
 683                 nxt200x_writereg_multibyte(state, 0x80, buf, 1);
 684         }
 685
 686         /* write agc ucgp0 */
 687         switch (p->u.vsb.modulation) {
 688                 case QAM_64:
 689                                 buf[0] = 0x02;
 690                                 break;
 691                 case QAM_256:
 692                                 buf[0] = 0x03;
 693                                 break;
 694                 case VSB_8:
 695                                 buf[0] = 0x00;
 696                                 break;
 697                 default:
 698                                 return -EINVAL;
 699                                 break;
 700         }
 701         nxt200x_writebytes(state, 0x30, buf, 1);
 702
 703         /* write agc control reg */
 704         buf[0] = 0x00;
 705         nxt200x_writebytes(state, 0x41, buf, 1);
 706
 707         /* write accumulator2 input */
 708         buf[0] = 0x80;
 709         buf[1] = 0x00;
 710         nxt200x_writebytes(state, 0x49, buf,2);
 711         nxt200x_writebytes(state, 0x4B, buf,2);
 712
 713         /* write agc control reg */
 714         buf[0] = 0x04;
 715         nxt200x_writebytes(state, 0x41, buf, 1);
 716
 717         nxt200x_microcontroller_start(state);
 718
 719         if (state->demod_chip == NXT2004) {
 720                 nxt2004_microcontroller_init(state);
 721
 722                 /* ???? */
 723                 buf[0] = 0xF0;
 724                 buf[1] = 0x00;
 725                 nxt200x_writebytes(state, 0x5C, buf, 2);
 726         }
 727
 728         /* adjacent channel detection should be done here, but I don't
 729         have any stations with this need so I cannot test it */
 730
 731         return 0;
 732 }
 733
 734 static int nxt200x_read_status(struct dvb_frontend* fe, fe_status_t* status)
 735 {
 736         struct nxt200x_state* state = fe->demodulator_priv;
 737         u8 lock;
 738         nxt200x_readbytes(state, 0x31, &lock, 1);
 739
 740         *status = 0;
 741         if (lock & 0x20) {
 742                 *status |= FE_HAS_SIGNAL;
 743                 *status |= FE_HAS_CARRIER;
 744                 *status |= FE_HAS_VITERBI;
 745                 *status |= FE_HAS_SYNC;
 746                 *status |= FE_HAS_LOCK;
 747         }
 748         return 0;
 749 }
 750
 751 static int nxt200x_read_ber(struct dvb_frontend* fe, u32* ber)
 752 {
 753         struct nxt200x_state* state = fe->demodulator_priv;
 754         u8 b[3];
 755
 756         nxt200x_readreg_multibyte(state, 0xE6, b, 3);
 757
 758         *ber = ((b[0] << 8) + b[1]) * 8;
 759
 760         return 0;
 761 }
 762
 763 static int nxt200x_read_signal_strength(struct dvb_frontend* fe, u16* strength)
 764 {
 765         struct nxt200x_state* state = fe->demodulator_priv;
 766         u8 b[2];
 767         u16 temp = 0;
 768
 769         /* setup to read cluster variance */
 770         b[0] = 0x00;
 771         nxt200x_writebytes(state, 0xA1, b, 1);
 772
 773         /* get multreg val */
 774         nxt200x_readreg_multibyte(state, 0xA6, b, 2);
 775
 776         temp = (b[0] << 8) | b[1];
 777         *strength = ((0x7FFF - temp) & 0x0FFF) * 16;
 778
 779         return 0;
 780 }
 781
 782 static int nxt200x_read_snr(struct dvb_frontend* fe, u16* snr)
 783 {
 784
 785         struct nxt200x_state* state = fe->demodulator_priv;
 786         u8 b[2];
 787         u16 temp = 0, temp2;
 788         u32 snrdb = 0;
 789
 790         /* setup to read cluster variance */
 791         b[0] = 0x00;
 792         nxt200x_writebytes(state, 0xA1, b, 1);
 793
 794         /* get multreg val from 0xA6 */
 795         nxt200x_readreg_multibyte(state, 0xA6, b, 2);
 796
 797         temp = (b[0] << 8) | b[1];
 798         temp2 = 0x7FFF - temp;
 799
 800         /* snr will be in db */
 801         if (temp2 > 0x7F00)
 802                 snrdb = 1000*24 + ( 1000*(30-24) * ( temp2 - 0x7F00 ) / ( 0x7FFF - 0x7F00 ) );
 803         else if (temp2 > 0x7EC0)
 804                 snrdb = 1000*18 + ( 1000*(24-18) * ( temp2 - 0x7EC0 ) / ( 0x7F00 - 0x7EC0 ) );
 805         else if (temp2 > 0x7C00)
 806                 snrdb = 1000*12 + ( 1000*(18-12) * ( temp2 - 0x7C00 ) / ( 0x7EC0 - 0x7C00 ) );
 807         else
 808                 snrdb = 1000*0 + ( 1000*(12-0) * ( temp2 - 0 ) / ( 0x7C00 - 0 ) );
 809
 810         /* the value reported back from the frontend will be FFFF=32db 0000=0db */
 811         *snr = snrdb * (0xFFFF/32000);
 812
 813         return 0;
 814 }
 815
 816 static int nxt200x_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
 817 {
 818         struct nxt200x_state* state = fe->demodulator_priv;
 819         u8 b[3];
 820
 821         nxt200x_readreg_multibyte(state, 0xE6, b, 3);
 822         *ucblocks = b[2];
 823
 824         return 0;
 825 }
 826
 827 static int nxt200x_sleep(struct dvb_frontend* fe)
 828 {
 829         return 0;
 830 }
 831
 832 static int nxt2002_init(struct dvb_frontend* fe)
 833 {
 834         struct nxt200x_state* state = fe->demodulator_priv;
 835         const struct firmware *fw;
 836         int ret;
 837         u8 buf[2];
 838
 839         /* request the firmware, this will block until someone uploads it */
 840         printk("nxt2002: Waiting for firmware upload (%s)...\n", NXT2002_DEFAULT_FIRMWARE);
 841         ret = request_firmware(&fw, NXT2002_DEFAULT_FIRMWARE, &state->i2c->dev);
 842         printk("nxt2002: Waiting for firmware upload(2)...\n");
 843         if (ret) {
 844                 printk("nxt2002: No firmware uploaded (timeout or file not found?)\n");
 845                 return ret;
 846         }
 847
 848         ret = nxt2002_load_firmware(fe, fw);
 849         if (ret) {
 850                 printk("nxt2002: Writing firmware to device failed\n");
 851                 release_firmware(fw);
 852                 return ret;
 853         }
 854         printk("nxt2002: Firmware upload complete\n");
 855
 856         /* Put the micro into reset */
 857         nxt200x_microcontroller_stop(state);
 858
 859         /* ensure transfer is complete */
 860         buf[0]=0x00;
 861         nxt200x_writebytes(state, 0x2B, buf, 1);
 862
 863         /* Put the micro into reset for real this time */
 864         nxt200x_microcontroller_stop(state);
 865
 866         /* soft reset everything (agc,frontend,eq,fec)*/
 867         buf[0] = 0x0F;
 868         nxt200x_writebytes(state, 0x08, buf, 1);
 869         buf[0] = 0x00;
 870         nxt200x_writebytes(state, 0x08, buf, 1);
 871
 872         /* write agc sdm configure */
 873         buf[0] = 0xF1;
 874         nxt200x_writebytes(state, 0x57, buf, 1);
 875
 876         /* write mod output format */
 877         buf[0] = 0x20;
 878         nxt200x_writebytes(state, 0x09, buf, 1);
 879
 880         /* write fec mpeg mode */
 881         buf[0] = 0x7E;
 882         buf[1] = 0x00;
 883         nxt200x_writebytes(state, 0xE9, buf, 2);
 884
 885         /* write mux selection */
 886         buf[0] = 0x00;
 887         nxt200x_writebytes(state, 0xCC, buf, 1);
 888
 889         return 0;
 890 }
 891
 892 static int nxt2004_init(struct dvb_frontend* fe)
 893 {
 894         struct nxt200x_state* state = fe->demodulator_priv;
 895         const struct firmware *fw;
 896         int ret;
 897         u8 buf[3];
 898
 899         /* ??? */
 900         buf[0]=0x00;
 901         nxt200x_writebytes(state, 0x1E, buf, 1);
 902
 903         /* request the firmware, this will block until someone uploads it */
 904         printk("nxt2004: Waiting for firmware upload (%s)...\n", NXT2004_DEFAULT_FIRMWARE);
 905         ret = request_firmware(&fw, NXT2004_DEFAULT_FIRMWARE, &state->i2c->dev);
 906         printk("nxt2004: Waiting for firmware upload(2)...\n");
 907         if (ret) {
 908                 printk("nxt2004: No firmware uploaded (timeout or file not found?)\n");
 909                 return ret;
 910         }
 911
 912         ret = nxt2004_load_firmware(fe, fw);
 913         if (ret) {
 914                 printk("nxt2004: Writing firmware to device failed\n");
 915                 release_firmware(fw);
 916                 return ret;
 917         }
 918         printk("nxt2004: Firmware upload complete\n");
 919
 920         /* ensure transfer is complete */
 921         buf[0] = 0x01;
 922         nxt200x_writebytes(state, 0x19, buf, 1);
 923
 924         nxt2004_microcontroller_init(state);
 925         nxt200x_microcontroller_stop(state);
 926         nxt200x_microcontroller_stop(state);
 927         nxt2004_microcontroller_init(state);
 928         nxt200x_microcontroller_stop(state);
 929
 930         /* soft reset everything (agc,frontend,eq,fec)*/
 931         buf[0] = 0xFF;
 932         nxt200x_writereg_multibyte(state, 0x08, buf, 1);
 933         buf[0] = 0x00;
 934         nxt200x_writereg_multibyte(state, 0x08, buf, 1);
 935
 936         /* write agc sdm configure */
 937         buf[0] = 0xD7;
 938         nxt200x_writebytes(state, 0x57, buf, 1);
 939
 940         /* ???*/
 941         buf[0] = 0x07;
 942         buf[1] = 0xfe;
 943         nxt200x_writebytes(state, 0x35, buf, 2);
 944         buf[0] = 0x12;
 945         nxt200x_writebytes(state, 0x34, buf, 1);
 946         buf[0] = 0x80;
 947         nxt200x_writebytes(state, 0x21, buf, 1);
 948
 949         /* ???*/
 950         buf[0] = 0x21;
 951         nxt200x_writebytes(state, 0x0A, buf, 1);
 952
 953         /* ???*/
 954         buf[0] = 0x01;
 955         nxt200x_writereg_multibyte(state, 0x80, buf, 1);
 956
 957         /* write fec mpeg mode */
 958         buf[0] = 0x7E;
 959         buf[1] = 0x00;
 960         nxt200x_writebytes(state, 0xE9, buf, 2);
 961
 962         /* write mux selection */
 963         buf[0] = 0x00;
 964         nxt200x_writebytes(state, 0xCC, buf, 1);
 965
 966         /* ???*/
 967         nxt200x_readreg_multibyte(state, 0x80, buf, 1);
 968         buf[0] = 0x00;
 969         nxt200x_writereg_multibyte(state, 0x80, buf, 1);
 970
 971         /* soft reset? */
 972         nxt200x_readreg_multibyte(state, 0x08, buf, 1);
 973         buf[0] = 0x10;
 974         nxt200x_writereg_multibyte(state, 0x08, buf, 1);
 975         nxt200x_readreg_multibyte(state, 0x08, buf, 1);
 976         buf[0] = 0x00;
 977         nxt200x_writereg_multibyte(state, 0x08, buf, 1);
 978
 979         /* ???*/
 980         nxt200x_readreg_multibyte(state, 0x80, buf, 1);
 981         buf[0] = 0x01;
 982         nxt200x_writereg_multibyte(state, 0x80, buf, 1);
 983         buf[0] = 0x70;
 984         nxt200x_writereg_multibyte(state, 0x81, buf, 1);
 985         buf[0] = 0x31; buf[1] = 0x5E; buf[2] = 0x66;
 986         nxt200x_writereg_multibyte(state, 0x82, buf, 3);
 987
 988         nxt200x_readreg_multibyte(state, 0x88, buf, 1);
 989         buf[0] = 0x11;
 990         nxt200x_writereg_multibyte(state, 0x88, buf, 1);
 991         nxt200x_readreg_multibyte(state, 0x80, buf, 1);
 992         buf[0] = 0x40;
 993         nxt200x_writereg_multibyte(state, 0x80, buf, 1);
 994
 995         nxt200x_readbytes(state, 0x10, buf, 1);
 996         buf[0] = 0x10;
 997         nxt200x_writebytes(state, 0x10, buf, 1);
 998         nxt200x_readbytes(state, 0x0A, buf, 1);
 999         buf[0] = 0x21;
1000         nxt200x_writebytes(state, 0x0A, buf, 1);
1001
1002         nxt2004_microcontroller_init(state);
1003
1004         buf[0] = 0x21;
1005         nxt200x_writebytes(state, 0x0A, buf, 1);
1006         buf[0] = 0x7E;
1007         nxt200x_writebytes(state, 0xE9, buf, 1);
1008         buf[0] = 0x00;
1009         nxt200x_writebytes(state, 0xEA, buf, 1);
1010
1011         nxt200x_readreg_multibyte(state, 0x80, buf, 1);
1012         buf[0] = 0x00;
1013         nxt200x_writereg_multibyte(state, 0x80, buf, 1);
1014         nxt200x_readreg_multibyte(state, 0x80, buf, 1);
1015         buf[0] = 0x00;
1016         nxt200x_writereg_multibyte(state, 0x80, buf, 1);
1017
1018         /* soft reset? */
1019         nxt200x_readreg_multibyte(state, 0x08, buf, 1);
1020         buf[0] = 0x10;
1021         nxt200x_writereg_multibyte(state, 0x08, buf, 1);
1022         nxt200x_readreg_multibyte(state, 0x08, buf, 1);
1023         buf[0] = 0x00;
1024         nxt200x_writereg_multibyte(state, 0x08, buf, 1);
1025
1026         nxt200x_readreg_multibyte(state, 0x80, buf, 1);
1027         buf[0] = 0x04;
1028         nxt200x_writereg_multibyte(state, 0x80, buf, 1);
1029         buf[0] = 0x00;
1030         nxt200x_writereg_multibyte(state, 0x81, buf, 1);
1031         buf[0] = 0x80; buf[1] = 0x00; buf[2] = 0x00;
1032         nxt200x_writereg_multibyte(state, 0x82, buf, 3);
1033
1034         nxt200x_readreg_multibyte(state, 0x88, buf, 1);
1035         buf[0] = 0x11;
1036         nxt200x_writereg_multibyte(state, 0x88, buf, 1);
1037
1038         nxt200x_readreg_multibyte(state, 0x80, buf, 1);
1039         buf[0] = 0x44;
1040         nxt200x_writereg_multibyte(state, 0x80, buf, 1);
1041
1042         /* initialize tuner */
1043         nxt200x_readbytes(state, 0x10, buf, 1);
1044         buf[0] = 0x12;
1045         nxt200x_writebytes(state, 0x10, buf, 1);
1046         buf[0] = 0x04;
1047         nxt200x_writebytes(state, 0x13, buf, 1);
1048         buf[0] = 0x00;
1049         nxt200x_writebytes(state, 0x16, buf, 1);
1050         buf[0] = 0x04;
1051         nxt200x_writebytes(state, 0x14, buf, 1);
1052         buf[0] = 0x00;
1053         nxt200x_writebytes(state, 0x14, buf, 1);
1054         nxt200x_writebytes(state, 0x17, buf, 1);
1055         nxt200x_writebytes(state, 0x14, buf, 1);
1056         nxt200x_writebytes(state, 0x17, buf, 1);
1057
1058         return 0;
1059 }
1060
1061 static int nxt200x_init(struct dvb_frontend* fe)
1062 {
1063         struct nxt200x_state* state = fe->demodulator_priv;
1064         int ret = 0;
1065
1066         if (!state->initialised) {
1067                 switch (state->demod_chip) {
1068                         case NXT2002:
1069                                 ret = nxt2002_init(fe);
1070                                 break;
1071                         case NXT2004:
1072                                 ret = nxt2004_init(fe);
1073                                 break;
1074                         default:
1075                                 return -EINVAL;
1076                                 break;
1077                 }
1078                 state->initialised = 1;
1079         }
1080         return ret;
1081 }
1082
1083 static int nxt200x_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
1084 {
1085         fesettings->min_delay_ms = 500;
1086         fesettings->step_size = 0;
1087         fesettings->max_drift = 0;
1088         return 0;
1089 }
1090
1091 static void nxt200x_release(struct dvb_frontend* fe)
1092 {
1093         struct nxt200x_state* state = fe->demodulator_priv;
1094         kfree(state);
1095 }
1096
1097 static struct dvb_frontend_ops nxt200x_ops;
1098
1099 struct dvb_frontend* nxt200x_attach(const struct nxt200x_config* config,
1100                                    struct i2c_adapter* i2c)
1101 {
1102         struct nxt200x_state* state = NULL;
1103         u8 buf [] = {0,0,0,0,0};
1104
1105         /* allocate memory for the internal state */
1106         state = (struct nxt200x_state*) kmalloc(sizeof(struct nxt200x_state), GFP_KERNEL);
1107         if (state == NULL)
1108                 goto error;
1109         memset(state,0,sizeof(*state));
1110
1111         /* setup the state */
1112         state->config = config;
1113         state->i2c = i2c;
1114         memcpy(&state->ops, &nxt200x_ops, sizeof(struct dvb_frontend_ops));
1115         state->initialised = 0;
1116
1117         /* read card id */
1118         nxt200x_readbytes(state, 0x00, buf, 5);
1119         dprintk("NXT info: %02X %02X %02X %02X %02X\n",
1120                 buf[0], buf[1], buf[2], buf[3], buf[4]);
1121
1122         /* set demod chip */
1123         switch (buf[0]) {
1124                 case 0x04:
1125                         state->demod_chip = NXT2002;
1126                         printk("nxt200x: NXT2002 Detected\n");
1127                         break;
1128                 case 0x05:
1129                         state->demod_chip = NXT2004;
1130                         printk("nxt200x: NXT2004 Detected\n");
1131                         break;
1132                 default:
1133                         goto error;
1134         }
1135
1136         /* make sure demod chip is supported */
1137         switch (state->demod_chip) {
1138                 case NXT2002:
1139                         if (buf[0] != 0x04) goto error;         /* device id */
1140                         if (buf[1] != 0x02) goto error;         /* fab id */
1141                         if (buf[2] != 0x11) goto error;         /* month */
1142                         if (buf[3] != 0x20) goto error;         /* year msb */
1143                         if (buf[4] != 0x00) goto error;         /* year lsb */
1144                         break;
1145                 case NXT2004:
1146                         if (buf[0] != 0x05) goto error;         /* device id */
1147                         break;
1148                 default:
1149                         goto error;
1150         }
1151
1152         /* create dvb_frontend */
1153         state->frontend.ops = &state->ops;
1154         state->frontend.demodulator_priv = state;
1155         return &state->frontend;
1156
1157 error:
1158         kfree(state);
1159         printk("Unknown/Unsupported NXT chip: %02X %02X %02X %02X %02X\n",
1160                 buf[0], buf[1], buf[2], buf[3], buf[4]);
1161         return NULL;
1162 }
1163
1164 static struct dvb_frontend_ops nxt200x_ops = {
1165
1166         .info = {
1167                 .name = "Nextwave NXT200X VSB/QAM frontend",
1168                 .type = FE_ATSC,
1169                 .frequency_min =  54000000,
1170                 .frequency_max = 860000000,
1171                 .frequency_stepsize = 166666,   /* stepsize is just a guess */
1172                 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
1173                         FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
1174                         FE_CAN_8VSB | FE_CAN_QAM_64 | FE_CAN_QAM_256
1175         },
1176
1177         .release = nxt200x_release,
1178
1179         .init = nxt200x_init,
1180         .sleep = nxt200x_sleep,
1181
1182         .set_frontend = nxt200x_setup_frontend_parameters,
1183         .get_tune_settings = nxt200x_get_tune_settings,
1184
1185         .read_status = nxt200x_read_status,
1186         .read_ber = nxt200x_read_ber,
1187         .read_signal_strength = nxt200x_read_signal_strength,
1188         .read_snr = nxt200x_read_snr,
1189         .read_ucblocks = nxt200x_read_ucblocks,
1190 };
1191
1192 module_param(debug, int, 0644);
1193 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
1194
1195 MODULE_DESCRIPTION("NXT200X (ATSC 8VSB & ITU-T J.83 AnnexB 64/256 QAM) Demodulator Driver");
1196 MODULE_AUTHOR("Kirk Lapray, Jean-Francois Thibert, and Taylor Jacob");
1197 MODULE_LICENSE("GPL");
1198
1199 EXPORT_SYMBOL(nxt200x_attach);
1200