drivers/media/dvb/frontends/nxt6000.c

   1 /*
   2         NxtWave Communications - NXT6000 demodulator driver
   3
   4     Copyright (C) 2002-2003 Florian Schirmer <jolt@tuxbox.org>
   5     Copyright (C) 2003 Paul Andreassen <paul@andreassen.com.au>
   6
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation; either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program; if not, write to the Free Software
  19     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21 */
  22
  23 #include <linux/init.h>
  24 #include <linux/kernel.h>
  25 #include <linux/module.h>
  26 #include <linux/string.h>
  27 #include <linux/slab.h>
  28
  29 #include "dvb_frontend.h"
  30 #include "nxt6000_priv.h"
  31 #include "nxt6000.h"
  32
  33
  34
  35 struct nxt6000_state {
  36
  37         struct i2c_adapter *i2c;
  38
  39         struct dvb_frontend_ops ops;
  40
  41         /* configuration settings */
  42         const struct nxt6000_config* config;
  43
  44         struct dvb_frontend frontend;
  45
  46 };
  47
  48 static int debug = 0;
  49 #define dprintk if (debug) printk
  50
  51 static int nxt6000_writereg(struct nxt6000_state* state, u8 reg, u8 data)
  52 {
  53         u8 buf[] = {reg, data};
  54         struct i2c_msg msg = {.addr = state->config->demod_address,.flags = 0,.buf = buf,.len = 2 };
  55         int ret;
  56
  57         if ((ret = i2c_transfer(state->i2c, &msg, 1)) != 1)
  58                 dprintk("nxt6000: nxt6000_write error (reg: 0x%02X, data: 0x%02X, ret: %d)\n", reg, data, ret);
  59
  60         return (ret != 1) ? -EFAULT : 0;
  61 }
  62
  63 static u8 nxt6000_readreg(struct nxt6000_state* state, u8 reg)
  64 {
  65         int ret;
  66         u8 b0[] = {reg};
  67         u8 b1[] = {0};
  68         struct i2c_msg msgs[] = {
  69                 {.addr = state->config->demod_address,.flags = 0,.buf = b0,.len = 1},
  70                 {.addr = state->config->demod_address,.flags = I2C_M_RD,.buf = b1,.len = 1}
  71         };
  72
  73         ret = i2c_transfer(state->i2c, msgs, 2);
  74
  75         if (ret != 2)
  76                 dprintk("nxt6000: nxt6000_read error (reg: 0x%02X, ret: %d)\n", reg, ret);
  77
  78         return b1[0];
  79 }
  80
  81 static void nxt6000_reset(struct nxt6000_state* state)
  82 {
  83         u8 val;
  84
  85         val = nxt6000_readreg(state, OFDM_COR_CTL);
  86
  87         nxt6000_writereg(state, OFDM_COR_CTL, val & ~COREACT);
  88         nxt6000_writereg(state, OFDM_COR_CTL, val | COREACT);
  89 }
  90
  91 static int nxt6000_set_bandwidth(struct nxt6000_state* state, fe_bandwidth_t bandwidth)
  92 {
  93         u16 nominal_rate;
  94         int result;
  95
  96         switch(bandwidth) {
  97
  98                 case BANDWIDTH_6_MHZ:
  99
 100                         nominal_rate = 0x55B7;
 101
 102                         break;
 103
 104                 case BANDWIDTH_7_MHZ:
 105
 106                         nominal_rate = 0x6400;
 107
 108                         break;
 109
 110                 case BANDWIDTH_8_MHZ:
 111
 112                         nominal_rate = 0x7249;
 113
 114                         break;
 115
 116                 default:
 117                         return -EINVAL;
 118         }
 119
 120         if ((result = nxt6000_writereg(state, OFDM_TRL_NOMINALRATE_1, nominal_rate & 0xFF)) < 0)
 121                 return result;
 122
 123         return nxt6000_writereg(state, OFDM_TRL_NOMINALRATE_2, (nominal_rate >> 8) & 0xFF);
 124 }
 125
 126 static int nxt6000_set_guard_interval(struct nxt6000_state* state, fe_guard_interval_t guard_interval)
 127 {
 128         switch(guard_interval) {
 129
 130                 case GUARD_INTERVAL_1_32:
 131                 return nxt6000_writereg(state, OFDM_COR_MODEGUARD, 0x00 | (nxt6000_readreg(state, OFDM_COR_MODEGUARD) & ~0x03));
 132
 133                 case GUARD_INTERVAL_1_16:
 134                 return nxt6000_writereg(state, OFDM_COR_MODEGUARD, 0x01 | (nxt6000_readreg(state, OFDM_COR_MODEGUARD) & ~0x03));
 135
 136                 case GUARD_INTERVAL_AUTO:
 137                 case GUARD_INTERVAL_1_8:
 138                 return nxt6000_writereg(state, OFDM_COR_MODEGUARD, 0x02 | (nxt6000_readreg(state, OFDM_COR_MODEGUARD) & ~0x03));
 139
 140                 case GUARD_INTERVAL_1_4:
 141                 return nxt6000_writereg(state, OFDM_COR_MODEGUARD, 0x03 | (nxt6000_readreg(state, OFDM_COR_MODEGUARD) & ~0x03));
 142
 143                 default:
 144                         return -EINVAL;
 145         }
 146 }
 147
 148 static int nxt6000_set_inversion(struct nxt6000_state* state, fe_spectral_inversion_t inversion)
 149 {
 150         switch(inversion) {
 151
 152                 case INVERSION_OFF:
 153                 return nxt6000_writereg(state, OFDM_ITB_CTL, 0x00);
 154
 155                 case INVERSION_ON:
 156                 return nxt6000_writereg(state, OFDM_ITB_CTL, ITBINV);
 157
 158                 default:
 159                         return -EINVAL;
 160
 161         }
 162 }
 163
 164 static int nxt6000_set_transmission_mode(struct nxt6000_state* state, fe_transmit_mode_t transmission_mode)
 165 {
 166         int result;
 167
 168         switch(transmission_mode) {
 169
 170                 case TRANSMISSION_MODE_2K:
 171                 if ((result = nxt6000_writereg(state, EN_DMD_RACQ, 0x00 | (nxt6000_readreg(state, EN_DMD_RACQ) & ~0x03))) < 0)
 172                                 return result;
 173
 174                 return nxt6000_writereg(state, OFDM_COR_MODEGUARD, (0x00 << 2) | (nxt6000_readreg(state, OFDM_COR_MODEGUARD) & ~0x04));
 175
 176                 case TRANSMISSION_MODE_8K:
 177                 case TRANSMISSION_MODE_AUTO:
 178                 if ((result = nxt6000_writereg(state, EN_DMD_RACQ, 0x02 | (nxt6000_readreg(state, EN_DMD_RACQ) & ~0x03))) < 0)
 179                                 return result;
 180
 181                 return nxt6000_writereg(state, OFDM_COR_MODEGUARD, (0x01 << 2) | (nxt6000_readreg(state, OFDM_COR_MODEGUARD) & ~0x04));
 182
 183                 default:
 184                         return -EINVAL;
 185
 186         }
 187 }
 188
 189 static void nxt6000_setup(struct dvb_frontend* fe)
 190 {
 191         struct nxt6000_state* state = (struct nxt6000_state*) fe->demodulator_priv;
 192
 193         nxt6000_writereg(state, RS_COR_SYNC_PARAM, SYNC_PARAM);
 194         nxt6000_writereg(state, BER_CTRL, /*(1 << 2) | */ (0x01 << 1) | 0x01);
 195         nxt6000_writereg(state, VIT_COR_CTL, VIT_COR_RESYNC);
 196         nxt6000_writereg(state, OFDM_COR_CTL, (0x01 << 5) | (nxt6000_readreg(state, OFDM_COR_CTL) & 0x0F));
 197         nxt6000_writereg(state, OFDM_COR_MODEGUARD, FORCEMODE8K | 0x02);
 198         nxt6000_writereg(state, OFDM_AGC_CTL, AGCLAST | INITIAL_AGC_BW);
 199         nxt6000_writereg(state, OFDM_ITB_FREQ_1, 0x06);
 200         nxt6000_writereg(state, OFDM_ITB_FREQ_2, 0x31);
 201         nxt6000_writereg(state, OFDM_CAS_CTL, (0x01 << 7) | (0x02 << 3) | 0x04);
 202         nxt6000_writereg(state, CAS_FREQ, 0xBB);        /* CHECKME */
 203         nxt6000_writereg(state, OFDM_SYR_CTL, 1 << 2);
 204         nxt6000_writereg(state, OFDM_PPM_CTL_1, PPM256);
 205         nxt6000_writereg(state, OFDM_TRL_NOMINALRATE_1, 0x49);
 206         nxt6000_writereg(state, OFDM_TRL_NOMINALRATE_2, 0x72);
 207         nxt6000_writereg(state, ANALOG_CONTROL_0, 1 << 5);
 208         nxt6000_writereg(state, EN_DMD_RACQ, (1 << 7) | (3 << 4) | 2);
 209         nxt6000_writereg(state, DIAG_CONFIG, TB_SET);
 210
 211         if (state->config->clock_inversion)
 212                 nxt6000_writereg(state, SUB_DIAG_MODE_SEL, CLKINVERSION);
 213         else
 214                 nxt6000_writereg(state, SUB_DIAG_MODE_SEL, 0);
 215
 216         nxt6000_writereg(state, TS_FORMAT, 0);
 217
 218         if (state->config->pll_init) {
 219                 nxt6000_writereg(state, ENABLE_TUNER_IIC, 0x01);        /* open i2c bus switch */
 220                 state->config->pll_init(fe);
 221                 nxt6000_writereg(state, ENABLE_TUNER_IIC, 0x00);        /* close i2c bus switch */
 222         }
 223 }
 224
 225 static void nxt6000_dump_status(struct nxt6000_state *state)
 226 {
 227         u8 val;
 228
 229 /*
 230         printk("RS_COR_STAT: 0x%02X\n", nxt6000_readreg(fe, RS_COR_STAT));
 231         printk("VIT_SYNC_STATUS: 0x%02X\n", nxt6000_readreg(fe, VIT_SYNC_STATUS));
 232         printk("OFDM_COR_STAT: 0x%02X\n", nxt6000_readreg(fe, OFDM_COR_STAT));
 233         printk("OFDM_SYR_STAT: 0x%02X\n", nxt6000_readreg(fe, OFDM_SYR_STAT));
 234         printk("OFDM_TPS_RCVD_1: 0x%02X\n", nxt6000_readreg(fe, OFDM_TPS_RCVD_1));
 235         printk("OFDM_TPS_RCVD_2: 0x%02X\n", nxt6000_readreg(fe, OFDM_TPS_RCVD_2));
 236         printk("OFDM_TPS_RCVD_3: 0x%02X\n", nxt6000_readreg(fe, OFDM_TPS_RCVD_3));
 237         printk("OFDM_TPS_RCVD_4: 0x%02X\n", nxt6000_readreg(fe, OFDM_TPS_RCVD_4));
 238         printk("OFDM_TPS_RESERVED_1: 0x%02X\n", nxt6000_readreg(fe, OFDM_TPS_RESERVED_1));
 239         printk("OFDM_TPS_RESERVED_2: 0x%02X\n", nxt6000_readreg(fe, OFDM_TPS_RESERVED_2));
 240 */
 241         printk("NXT6000 status:");
 242
 243         val = nxt6000_readreg(state, RS_COR_STAT);
 244
 245         printk(" DATA DESCR LOCK: %d,", val & 0x01);
 246         printk(" DATA SYNC LOCK: %d,", (val >> 1) & 0x01);
 247
 248         val = nxt6000_readreg(state, VIT_SYNC_STATUS);
 249
 250         printk(" VITERBI LOCK: %d,", (val >> 7) & 0x01);
 251
 252         switch((val >> 4) & 0x07) {
 253
 254                 case 0x00:
 255
 256                         printk(" VITERBI CODERATE: 1/2,");
 257
 258                         break;
 259
 260                 case 0x01:
 261
 262                         printk(" VITERBI CODERATE: 2/3,");
 263
 264                         break;
 265
 266                 case 0x02:
 267
 268                         printk(" VITERBI CODERATE: 3/4,");
 269
 270                         break;
 271
 272                 case 0x03:
 273                         printk(" VITERBI CODERATE: 5/6,");
 274                 break;
 275
 276                 case 0x04:
 277                         printk(" VITERBI CODERATE: 7/8,");
 278                         break;
 279
 280                 default:
 281
 282                         printk(" VITERBI CODERATE: Reserved,");
 283
 284         }
 285
 286         val = nxt6000_readreg(state, OFDM_COR_STAT);
 287
 288         printk(" CHCTrack: %d,", (val >> 7) & 0x01);
 289         printk(" TPSLock: %d,", (val >> 6) & 0x01);
 290         printk(" SYRLock: %d,", (val >> 5) & 0x01);
 291         printk(" AGCLock: %d,", (val >> 4) & 0x01);
 292
 293         switch(val & 0x0F) {
 294
 295                 case 0x00:
 296
 297                         printk(" CoreState: IDLE,");
 298
 299                         break;
 300
 301                 case 0x02:
 302
 303                         printk(" CoreState: WAIT_AGC,");
 304
 305                         break;
 306
 307                 case 0x03:
 308
 309                         printk(" CoreState: WAIT_SYR,");
 310
 311                         break;
 312
 313                 case 0x04:
 314                         printk(" CoreState: WAIT_PPM,");
 315                 break;
 316
 317                 case 0x01:
 318                         printk(" CoreState: WAIT_TRL,");
 319                         break;
 320
 321                 case 0x05:
 322
 323                         printk(" CoreState: WAIT_TPS,");
 324
 325                         break;
 326
 327                 case 0x06:
 328
 329                         printk(" CoreState: MONITOR_TPS,");
 330
 331                         break;
 332
 333                 default:
 334
 335                         printk(" CoreState: Reserved,");
 336
 337         }
 338
 339         val = nxt6000_readreg(state, OFDM_SYR_STAT);
 340
 341         printk(" SYRLock: %d,", (val >> 4) & 0x01);
 342         printk(" SYRMode: %s,", (val >> 2) & 0x01 ? "8K" : "2K");
 343
 344         switch((val >> 4) & 0x03) {
 345
 346                 case 0x00:
 347
 348                         printk(" SYRGuard: 1/32,");
 349
 350                         break;
 351
 352                 case 0x01:
 353
 354                         printk(" SYRGuard: 1/16,");
 355
 356                         break;
 357
 358                 case 0x02:
 359
 360                         printk(" SYRGuard: 1/8,");
 361
 362                         break;
 363
 364                 case 0x03:
 365                         printk(" SYRGuard: 1/4,");
 366                         break;
 367         }
 368
 369         val = nxt6000_readreg(state, OFDM_TPS_RCVD_3);
 370
 371         switch((val >> 4) & 0x07) {
 372
 373                 case 0x00:
 374
 375                         printk(" TPSLP: 1/2,");
 376
 377                         break;
 378
 379                 case 0x01:
 380
 381                         printk(" TPSLP: 2/3,");
 382
 383                         break;
 384
 385                 case 0x02:
 386
 387                         printk(" TPSLP: 3/4,");
 388
 389                         break;
 390
 391                 case 0x03:
 392                         printk(" TPSLP: 5/6,");
 393                 break;
 394
 395                 case 0x04:
 396                         printk(" TPSLP: 7/8,");
 397                         break;
 398
 399                 default:
 400
 401                         printk(" TPSLP: Reserved,");
 402
 403         }
 404
 405         switch(val & 0x07) {
 406
 407                 case 0x00:
 408
 409                         printk(" TPSHP: 1/2,");
 410
 411                         break;
 412
 413                 case 0x01:
 414
 415                         printk(" TPSHP: 2/3,");
 416
 417                         break;
 418
 419                 case 0x02:
 420
 421                         printk(" TPSHP: 3/4,");
 422
 423                         break;
 424
 425                 case 0x03:
 426                         printk(" TPSHP: 5/6,");
 427                 break;
 428
 429                 case 0x04:
 430                         printk(" TPSHP: 7/8,");
 431                         break;
 432
 433                 default:
 434
 435                         printk(" TPSHP: Reserved,");
 436
 437         }
 438
 439         val = nxt6000_readreg(state, OFDM_TPS_RCVD_4);
 440
 441         printk(" TPSMode: %s,", val & 0x01 ? "8K" : "2K");
 442
 443         switch((val >> 4) & 0x03) {
 444
 445                 case 0x00:
 446
 447                         printk(" TPSGuard: 1/32,");
 448
 449                         break;
 450
 451                 case 0x01:
 452
 453                         printk(" TPSGuard: 1/16,");
 454
 455                         break;
 456
 457                 case 0x02:
 458
 459                         printk(" TPSGuard: 1/8,");
 460
 461                         break;
 462
 463                 case 0x03:
 464
 465                         printk(" TPSGuard: 1/4,");
 466
 467                         break;
 468
 469         }
 470
 471         /* Strange magic required to gain access to RF_AGC_STATUS */
 472         nxt6000_readreg(state, RF_AGC_VAL_1);
 473         val = nxt6000_readreg(state, RF_AGC_STATUS);
 474         val = nxt6000_readreg(state, RF_AGC_STATUS);
 475
 476         printk(" RF AGC LOCK: %d,", (val >> 4) & 0x01);
 477         printk("\n");
 478 }
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490 static int nxt6000_read_status(struct dvb_frontend* fe, fe_status_t* status)
 491 {
 492                         u8 core_status;
 493         struct nxt6000_state* state = (struct nxt6000_state*) fe->demodulator_priv;
 494
 495                         *status = 0;
 496
 497         core_status = nxt6000_readreg(state, OFDM_COR_STAT);
 498
 499                         if (core_status & AGCLOCKED)
 500                                 *status |= FE_HAS_SIGNAL;
 501
 502         if (nxt6000_readreg(state, OFDM_SYR_STAT) & GI14_SYR_LOCK)
 503                                 *status |= FE_HAS_CARRIER;
 504
 505         if (nxt6000_readreg(state, VIT_SYNC_STATUS) & VITINSYNC)
 506                                 *status |= FE_HAS_VITERBI;
 507
 508         if (nxt6000_readreg(state, RS_COR_STAT) & RSCORESTATUS)
 509                                 *status |= FE_HAS_SYNC;
 510
 511                         if ((core_status & TPSLOCKED) && (*status == (FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_SYNC)))
 512                                 *status |= FE_HAS_LOCK;
 513
 514                         if (debug)
 515                 nxt6000_dump_status(state);
 516
 517                         return 0;
 518                 }
 519
 520 static int nxt6000_init(struct dvb_frontend* fe)
 521                 {
 522         struct nxt6000_state* state = (struct nxt6000_state*) fe->demodulator_priv;
 523
 524         nxt6000_reset(state);
 525         nxt6000_setup(fe);
 526
 527                         return 0;
 528                 }
 529
 530
 531 static int nxt6000_set_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters *param)
 532                 {
 533         struct nxt6000_state* state = (struct nxt6000_state*) fe->demodulator_priv;
 534                         int result;
 535
 536         nxt6000_writereg(state, ENABLE_TUNER_IIC, 0x01);        /* open i2c bus switch */
 537         state->config->pll_set(fe, param);
 538         nxt6000_writereg(state, ENABLE_TUNER_IIC, 0x00);        /* close i2c bus switch */
 539
 540         if ((result = nxt6000_set_bandwidth(state, param->u.ofdm.bandwidth)) < 0)
 541                                                 return result;
 542         if ((result = nxt6000_set_guard_interval(state, param->u.ofdm.guard_interval)) < 0)
 543                                 return result;
 544         if ((result = nxt6000_set_transmission_mode(state, param->u.ofdm.transmission_mode)) < 0)
 545                                 return result;
 546         if ((result = nxt6000_set_inversion(state, param->inversion)) < 0)
 547                                 return result;
 548
 549         return 0;
 550 }
 551
 552
 553 static void nxt6000_release(struct dvb_frontend* fe)
 554 {
 555         struct nxt6000_state* state = (struct nxt6000_state*) fe->demodulator_priv;
 556         kfree(state);
 557         }
 558
 559 static struct dvb_frontend_ops nxt6000_ops;
 560
 561 struct dvb_frontend* nxt6000_attach(const struct nxt6000_config* config,
 562                                     struct i2c_adapter* i2c)
 563 {
 564         struct nxt6000_state* state = NULL;
 565
 566         /* allocate memory for the internal state */
 567         state = (struct nxt6000_state*) kmalloc(sizeof(struct nxt6000_state), GFP_KERNEL);
 568         if (state == NULL) goto error;
 569
 570         /* setup the state */
 571         state->config = config;
 572         state->i2c = i2c;
 573         memcpy(&state->ops, &nxt6000_ops, sizeof(struct dvb_frontend_ops));
 574
 575         /* check if the demod is there */
 576         if (nxt6000_readreg(state, OFDM_MSC_REV) != NXT6000ASICDEVICE) goto error;
 577
 578         /* create dvb_frontend */
 579         state->frontend.ops = &state->ops;
 580         state->frontend.demodulator_priv = state;
 581         return &state->frontend;
 582
 583 error:
 584         if (state) kfree(state);
 585         return NULL;
 586         }
 587
 588 static struct dvb_frontend_ops nxt6000_ops = {
 589
 590         .info = {
 591                 .name = "NxtWave NXT6000 DVB-T",
 592                 .type = FE_OFDM,
 593                 .frequency_min = 0,
 594                 .frequency_max = 863250000,
 595                 .frequency_stepsize = 62500,
 596                 /*.frequency_tolerance = *//* FIXME: 12% of SR */
 597                 .symbol_rate_min = 0,   /* FIXME */
 598                 .symbol_rate_max = 9360000,     /* FIXME */
 599                 .symbol_rate_tolerance = 4000,
 600                 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
 601                         FE_CAN_FEC_4_5 | FE_CAN_FEC_5_6 | FE_CAN_FEC_6_7 |
 602                         FE_CAN_FEC_7_8 | FE_CAN_FEC_8_9 | FE_CAN_FEC_AUTO |
 603                         FE_CAN_QAM_16 | FE_CAN_QAM_64 | FE_CAN_QAM_AUTO |
 604                         FE_CAN_TRANSMISSION_MODE_AUTO | FE_CAN_GUARD_INTERVAL_AUTO |
 605                         FE_CAN_HIERARCHY_AUTO,
 606         },
 607
 608         .release = nxt6000_release,
 609
 610         .init = nxt6000_init,
 611
 612         .set_frontend = nxt6000_set_frontend,
 613
 614         .read_status = nxt6000_read_status,
 615 };
 616
 617 module_param(debug, int, 0644);
 618 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
 619
 620 MODULE_DESCRIPTION("NxtWave NXT6000 DVB-T demodulator driver");
 621 MODULE_AUTHOR("Florian Schirmer");
 622 MODULE_LICENSE("GPL");
 623
 624 EXPORT_SYMBOL(nxt6000_attach);