drivers/media/dvb/frontends/sp887x.c

   1 /*
   2    Driver for the Spase sp887x demodulator
   3 */
   4
   5 /*
   6  * This driver needs external firmware. Please use the command
   7  * "<kerneldir>/Documentation/dvb/get_dvb_firmware sp887x" to
   8  * download/extract it, and then copy it to /usr/lib/hotplug/firmware.
   9  */
  10 #define SP887X_DEFAULT_FIRMWARE "dvb-fe-sp887x.fw"
  11
  12 #include <linux/init.h>
  13 #include <linux/module.h>
  14 #include <linux/moduleparam.h>
  15 #include <linux/device.h>
  16 #include <linux/firmware.h>
  17
  18 #include "dvb_frontend.h"
  19 #include "sp887x.h"
  20
  21
  22 struct sp887x_state {
  23
  24         struct i2c_adapter* i2c;
  25
  26         struct dvb_frontend_ops ops;
  27
  28         const struct sp887x_config* config;
  29
  30         struct dvb_frontend frontend;
  31
  32         /* demodulator private data */
  33         u8 initialised:1;
  34 };
  35
  36 static int debug;
  37 #define dprintk(args...) \
  38         do { \
  39                 if (debug) printk(KERN_DEBUG "sp887x: " args); \
  40         } while (0)
  41
  42 static int i2c_writebytes (struct sp887x_state* state, u8 *buf, u8 len)
  43 {
  44         struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = len };
  45         int err;
  46
  47         if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
  48                 printk ("%s: i2c write error (addr %02x, err == %i)\n",
  49                         __FUNCTION__, state->config->demod_address, err);
  50                 return -EREMOTEIO;
  51         }
  52
  53         return 0;
  54 }
  55
  56 static int sp887x_writereg (struct sp887x_state* state, u16 reg, u16 data)
  57 {
  58         u8 b0 [] = { reg >> 8 , reg & 0xff, data >> 8, data & 0xff };
  59         struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 4 };
  60         int ret;
  61
  62         if ((ret = i2c_transfer(state->i2c, &msg, 1)) != 1) {
  63                 /**
  64                  *  in case of soft reset we ignore ACK errors...
  65                  */
  66                 if (!(reg == 0xf1a && data == 0x000 &&
  67                         (ret == -EREMOTEIO || ret == -EFAULT)))
  68                 {
  69                         printk("%s: writereg error "
  70                                "(reg %03x, data %03x, ret == %i)\n",
  71                                __FUNCTION__, reg & 0xffff, data & 0xffff, ret);
  72                         return ret;
  73                 }
  74         }
  75
  76         return 0;
  77 }
  78
  79 static int sp887x_readreg (struct sp887x_state* state, u16 reg)
  80 {
  81         u8 b0 [] = { reg >> 8 , reg & 0xff };
  82         u8 b1 [2];
  83         int ret;
  84         struct i2c_msg msg[] = {{ .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 2 },
  85                          { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 2 }};
  86
  87         if ((ret = i2c_transfer(state->i2c, msg, 2)) != 2) {
  88                 printk("%s: readreg error (ret == %i)\n", __FUNCTION__, ret);
  89                 return -1;
  90         }
  91
  92         return (((b1[0] << 8) | b1[1]) & 0xfff);
  93 }
  94
  95 static void sp887x_microcontroller_stop (struct sp887x_state* state)
  96 {
  97         dprintk("%s\n", __FUNCTION__);
  98         sp887x_writereg(state, 0xf08, 0x000);
  99         sp887x_writereg(state, 0xf09, 0x000);
 100
 101         /* microcontroller STOP */
 102         sp887x_writereg(state, 0xf00, 0x000);
 103 }
 104
 105 static void sp887x_microcontroller_start (struct sp887x_state* state)
 106 {
 107         dprintk("%s\n", __FUNCTION__);
 108         sp887x_writereg(state, 0xf08, 0x000);
 109         sp887x_writereg(state, 0xf09, 0x000);
 110
 111         /* microcontroller START */
 112         sp887x_writereg(state, 0xf00, 0x001);
 113 }
 114
 115 static void sp887x_setup_agc (struct sp887x_state* state)
 116 {
 117         /* setup AGC parameters */
 118         dprintk("%s\n", __FUNCTION__);
 119         sp887x_writereg(state, 0x33c, 0x054);
 120         sp887x_writereg(state, 0x33b, 0x04c);
 121         sp887x_writereg(state, 0x328, 0x000);
 122         sp887x_writereg(state, 0x327, 0x005);
 123         sp887x_writereg(state, 0x326, 0x001);
 124         sp887x_writereg(state, 0x325, 0x001);
 125         sp887x_writereg(state, 0x324, 0x001);
 126         sp887x_writereg(state, 0x318, 0x050);
 127         sp887x_writereg(state, 0x317, 0x3fe);
 128         sp887x_writereg(state, 0x316, 0x001);
 129         sp887x_writereg(state, 0x313, 0x005);
 130         sp887x_writereg(state, 0x312, 0x002);
 131         sp887x_writereg(state, 0x306, 0x000);
 132         sp887x_writereg(state, 0x303, 0x000);
 133 }
 134
 135 #define BLOCKSIZE 30
 136 #define FW_SIZE 0x4000
 137 /**
 138  *  load firmware and setup MPEG interface...
 139  */
 140 static int sp887x_initial_setup (struct dvb_frontend* fe, const struct firmware *fw)
 141 {
 142         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 143         u8 buf [BLOCKSIZE+2];
 144         int i;
 145         int fw_size = fw->size;
 146         unsigned char *mem = fw->data;
 147
 148         dprintk("%s\n", __FUNCTION__);
 149
 150         /* ignore the first 10 bytes, then we expect 0x4000 bytes of firmware */
 151         if (fw_size < FW_SIZE+10)
 152                 return -ENODEV;
 153
 154         mem = fw->data + 10;
 155
 156         /* soft reset */
 157         sp887x_writereg(state, 0xf1a, 0x000);
 158
 159         sp887x_microcontroller_stop (state);
 160
 161         printk ("%s: firmware upload... ", __FUNCTION__);
 162
 163         /* setup write pointer to -1 (end of memory) */
 164         /* bit 0x8000 in address is set to enable 13bit mode */
 165         sp887x_writereg(state, 0x8f08, 0x1fff);
 166
 167         /* dummy write (wrap around to start of memory) */
 168         sp887x_writereg(state, 0x8f0a, 0x0000);
 169
 170         for (i = 0; i < FW_SIZE; i += BLOCKSIZE) {
 171                 int c = BLOCKSIZE;
 172                 int err;
 173
 174                 if (i+c > FW_SIZE)
 175                         c = FW_SIZE - i;
 176
 177                 /* bit 0x8000 in address is set to enable 13bit mode */
 178                 /* bit 0x4000 enables multibyte read/write transfers */
 179                 /* write register is 0xf0a */
 180                 buf[0] = 0xcf;
 181                 buf[1] = 0x0a;
 182
 183                 memcpy(&buf[2], mem + i, c);
 184
 185                 if ((err = i2c_writebytes (state, buf, c+2)) < 0) {
 186                         printk ("failed.\n");
 187                         printk ("%s: i2c error (err == %i)\n", __FUNCTION__, err);
 188                         return err;
 189                 }
 190         }
 191
 192         /* don't write RS bytes between packets */
 193         sp887x_writereg(state, 0xc13, 0x001);
 194
 195         /* suppress clock if (!data_valid) */
 196         sp887x_writereg(state, 0xc14, 0x000);
 197
 198         /* setup MPEG interface... */
 199         sp887x_writereg(state, 0xc1a, 0x872);
 200         sp887x_writereg(state, 0xc1b, 0x001);
 201         sp887x_writereg(state, 0xc1c, 0x000); /* parallel mode (serial mode == 1) */
 202         sp887x_writereg(state, 0xc1a, 0x871);
 203
 204         /* ADC mode, 2 for MT8872, 3 for SP8870/SP8871 */
 205         sp887x_writereg(state, 0x301, 0x002);
 206
 207         sp887x_setup_agc(state);
 208
 209         /* bit 0x010: enable data valid signal */
 210         sp887x_writereg(state, 0xd00, 0x010);
 211         sp887x_writereg(state, 0x0d1, 0x000);
 212
 213         /* setup the PLL */
 214         if (state->config->pll_init) {
 215                 sp887x_writereg(state, 0x206, 0x001);
 216                 state->config->pll_init(fe);
 217                 sp887x_writereg(state, 0x206, 0x000);
 218         }
 219
 220         printk ("done.\n");
 221         return 0;
 222 };
 223
 224 static int configure_reg0xc05 (struct dvb_frontend_parameters *p, u16 *reg0xc05)
 225 {
 226         int known_parameters = 1;
 227
 228         *reg0xc05 = 0x000;
 229
 230         switch (p->u.ofdm.constellation) {
 231         case QPSK:
 232                 break;
 233         case QAM_16:
 234                 *reg0xc05 |= (1 << 10);
 235                 break;
 236         case QAM_64:
 237                 *reg0xc05 |= (2 << 10);
 238                 break;
 239         case QAM_AUTO:
 240                 known_parameters = 0;
 241                 break;
 242         default:
 243                 return -EINVAL;
 244         };
 245
 246         switch (p->u.ofdm.hierarchy_information) {
 247         case HIERARCHY_NONE:
 248                 break;
 249         case HIERARCHY_1:
 250                 *reg0xc05 |= (1 << 7);
 251                 break;
 252         case HIERARCHY_2:
 253                 *reg0xc05 |= (2 << 7);
 254                 break;
 255         case HIERARCHY_4:
 256                 *reg0xc05 |= (3 << 7);
 257                 break;
 258         case HIERARCHY_AUTO:
 259                 known_parameters = 0;
 260                 break;
 261         default:
 262                 return -EINVAL;
 263         };
 264
 265         switch (p->u.ofdm.code_rate_HP) {
 266         case FEC_1_2:
 267                 break;
 268         case FEC_2_3:
 269                 *reg0xc05 |= (1 << 3);
 270                 break;
 271         case FEC_3_4:
 272                 *reg0xc05 |= (2 << 3);
 273                 break;
 274         case FEC_5_6:
 275                 *reg0xc05 |= (3 << 3);
 276                 break;
 277         case FEC_7_8:
 278                 *reg0xc05 |= (4 << 3);
 279                 break;
 280         case FEC_AUTO:
 281                 known_parameters = 0;
 282                 break;
 283         default:
 284                 return -EINVAL;
 285         };
 286
 287         if (known_parameters)
 288                 *reg0xc05 |= (2 << 1);  /* use specified parameters */
 289         else
 290                 *reg0xc05 |= (1 << 1);  /* enable autoprobing */
 291
 292         return 0;
 293 }
 294
 295 /**
 296  *  estimates division of two 24bit numbers,
 297  *  derived from the ves1820/stv0299 driver code
 298  */
 299 static void divide (int n, int d, int *quotient_i, int *quotient_f)
 300 {
 301         unsigned int q, r;
 302
 303         r = (n % d) << 8;
 304         q = (r / d);
 305
 306         if (quotient_i)
 307                 *quotient_i = q;
 308
 309         if (quotient_f) {
 310                 r = (r % d) << 8;
 311                 q = (q << 8) | (r / d);
 312                 r = (r % d) << 8;
 313                 *quotient_f = (q << 8) | (r / d);
 314         }
 315 }
 316
 317 static void sp887x_correct_offsets (struct sp887x_state* state,
 318                              struct dvb_frontend_parameters *p,
 319                              int actual_freq)
 320 {
 321         static const u32 srate_correction [] = { 1879617, 4544878, 8098561 };
 322         int bw_index = p->u.ofdm.bandwidth - BANDWIDTH_8_MHZ;
 323         int freq_offset = actual_freq - p->frequency;
 324         int sysclock = 61003; //[kHz]
 325         int ifreq = 36000000;
 326         int freq;
 327         int frequency_shift;
 328
 329         if (p->inversion == INVERSION_ON)
 330                 freq = ifreq - freq_offset;
 331         else
 332                 freq = ifreq + freq_offset;
 333
 334         divide(freq / 333, sysclock, NULL, &frequency_shift);
 335
 336         if (p->inversion == INVERSION_ON)
 337                 frequency_shift = -frequency_shift;
 338
 339         /* sample rate correction */
 340         sp887x_writereg(state, 0x319, srate_correction[bw_index] >> 12);
 341         sp887x_writereg(state, 0x31a, srate_correction[bw_index] & 0xfff);
 342
 343         /* carrier offset correction */
 344         sp887x_writereg(state, 0x309, frequency_shift >> 12);
 345         sp887x_writereg(state, 0x30a, frequency_shift & 0xfff);
 346 }
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361 static int sp887x_setup_frontend_parameters (struct dvb_frontend* fe,
 362                                       struct dvb_frontend_parameters *p)
 363 {
 364         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 365         int actual_freq, err;
 366         u16 val, reg0xc05;
 367
 368         if (p->u.ofdm.bandwidth != BANDWIDTH_8_MHZ &&
 369             p->u.ofdm.bandwidth != BANDWIDTH_7_MHZ &&
 370             p->u.ofdm.bandwidth != BANDWIDTH_6_MHZ)
 371                 return -EINVAL;
 372
 373         if ((err = configure_reg0xc05(p, &reg0xc05)))
 374                 return err;
 375
 376         sp887x_microcontroller_stop(state);
 377
 378         /* setup the PLL */
 379         sp887x_writereg(state, 0x206, 0x001);
 380         actual_freq = state->config->pll_set(fe, p);
 381         sp887x_writereg(state, 0x206, 0x000);
 382
 383         /* read status reg in order to clear <pending irqs */
 384         sp887x_readreg(state, 0x200);
 385
 386         sp887x_correct_offsets(state, p, actual_freq);
 387
 388         /* filter for 6/7/8 Mhz channel */
 389         if (p->u.ofdm.bandwidth == BANDWIDTH_6_MHZ)
 390                 val = 2;
 391         else if (p->u.ofdm.bandwidth == BANDWIDTH_7_MHZ)
 392                 val = 1;
 393         else
 394                 val = 0;
 395
 396         sp887x_writereg(state, 0x311, val);
 397
 398         /* scan order: 2k first = 0, 8k first = 1 */
 399         if (p->u.ofdm.transmission_mode == TRANSMISSION_MODE_2K)
 400                 sp887x_writereg(state, 0x338, 0x000);
 401         else
 402                 sp887x_writereg(state, 0x338, 0x001);
 403
 404         sp887x_writereg(state, 0xc05, reg0xc05);
 405
 406         if (p->u.ofdm.bandwidth == BANDWIDTH_6_MHZ)
 407                 val = 2 << 3;
 408         else if (p->u.ofdm.bandwidth == BANDWIDTH_7_MHZ)
 409                 val = 3 << 3;
 410         else
 411                 val = 0 << 3;
 412
 413         /* enable OFDM and SAW bits as lock indicators in sync register 0xf17,
 414          * optimize algorithm for given bandwidth...
 415          */
 416         sp887x_writereg(state, 0xf14, 0x160 | val);
 417         sp887x_writereg(state, 0xf15, 0x000);
 418
 419         sp887x_microcontroller_start(state);
 420         return 0;
 421 }
 422
 423 static int sp887x_read_status(struct dvb_frontend* fe, fe_status_t* status)
 424         {
 425         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 426         u16 snr12 = sp887x_readreg(state, 0xf16);
 427         u16 sync0x200 = sp887x_readreg(state, 0x200);
 428         u16 sync0xf17 = sp887x_readreg(state, 0xf17);
 429
 430                 *status = 0;
 431
 432                 if (snr12 > 0x00f)
 433                         *status |= FE_HAS_SIGNAL;
 434
 435                 //if (sync0x200 & 0x004)
 436                 //      *status |= FE_HAS_SYNC | FE_HAS_CARRIER;
 437
 438                 //if (sync0x200 & 0x008)
 439                 //      *status |= FE_HAS_VITERBI;
 440
 441                 if ((sync0xf17 & 0x00f) == 0x002) {
 442                         *status |= FE_HAS_LOCK;
 443                         *status |= FE_HAS_VITERBI | FE_HAS_SYNC | FE_HAS_CARRIER;
 444                 }
 445
 446                 if (sync0x200 & 0x001) {        /* tuner adjustment requested...*/
 447                         int steps = (sync0x200 >> 4) & 0x00f;
 448                         if (steps & 0x008)
 449                                 steps = -steps;
 450                         dprintk("sp887x: implement tuner adjustment (%+i steps)!!\n",
 451                                steps);
 452                 }
 453
 454         return 0;
 455         }
 456
 457 static int sp887x_read_ber(struct dvb_frontend* fe, u32* ber)
 458         {
 459         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 460
 461         *ber = (sp887x_readreg(state, 0xc08) & 0x3f) |
 462                (sp887x_readreg(state, 0xc07) << 6);
 463         sp887x_writereg(state, 0xc08, 0x000);
 464         sp887x_writereg(state, 0xc07, 0x000);
 465                 if (*ber >= 0x3fff0)
 466                         *ber = ~0;
 467
 468         return 0;
 469         }
 470
 471 static int sp887x_read_signal_strength(struct dvb_frontend* fe, u16* strength)
 472         {
 473         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 474
 475         u16 snr12 = sp887x_readreg(state, 0xf16);
 476                 u32 signal = 3 * (snr12 << 4);
 477         *strength = (signal < 0xffff) ? signal : 0xffff;
 478
 479         return 0;
 480         }
 481
 482 static int sp887x_read_snr(struct dvb_frontend* fe, u16* snr)
 483         {
 484         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 485
 486         u16 snr12 = sp887x_readreg(state, 0xf16);
 487         *snr = (snr12 << 4) | (snr12 >> 8);
 488
 489                 return 0;
 490         }
 491
 492 static int sp887x_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
 493 {
 494         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 495
 496         *ucblocks = sp887x_readreg(state, 0xc0c);
 497         if (*ucblocks == 0xfff)
 498                 *ucblocks = ~0;
 499
 500         return 0;
 501 }
 502
 503 static int sp887x_sleep(struct dvb_frontend* fe)
 504 {
 505         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 506
 507         /* tristate TS output and disable interface pins */
 508         sp887x_writereg(state, 0xc18, 0x000);
 509
 510         return 0;
 511         }
 512
 513 static int sp887x_init(struct dvb_frontend* fe)
 514 {
 515         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 516         const struct firmware *fw = NULL;
 517         int ret;
 518
 519         if (!state->initialised) {
 520         /* request the firmware, this will block until someone uploads it */
 521                 printk("sp887x: waiting for firmware upload (%s)...\n", SP887X_DEFAULT_FIRMWARE);
 522                 ret = state->config->request_firmware(fe, &fw, SP887X_DEFAULT_FIRMWARE);
 523         if (ret) {
 524                 printk("sp887x: no firmware upload (timeout or file not found?)\n");
 525                         return ret;
 526         }
 527
 528                 ret = sp887x_initial_setup(fe, fw);
 529         if (ret) {
 530                 printk("sp887x: writing firmware to device failed\n");
 531                         release_firmware(fw);
 532                         return ret;
 533         }
 534                 printk("sp887x: firmware upload complete\n");
 535                 state->initialised = 1;
 536         }
 537
 538         /* enable TS output and interface pins */
 539         sp887x_writereg(state, 0xc18, 0x00d);
 540
 541         return 0;
 542 }
 543
 544 static int sp887x_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
 545 {
 546         fesettings->min_delay_ms = 350;
 547         fesettings->step_size = 166666*2;
 548         fesettings->max_drift = (166666*2)+1;
 549         return 0;
 550 }
 551
 552 static void sp887x_release(struct dvb_frontend* fe)
 553 {
 554         struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
 555         kfree(state);
 556 }
 557
 558 static struct dvb_frontend_ops sp887x_ops;
 559
 560 struct dvb_frontend* sp887x_attach(const struct sp887x_config* config,
 561                                    struct i2c_adapter* i2c)
 562 {
 563         struct sp887x_state* state = NULL;
 564
 565         /* allocate memory for the internal state */
 566         state = (struct sp887x_state*) kmalloc(sizeof(struct sp887x_state), GFP_KERNEL);
 567         if (state == NULL) goto error;
 568
 569         /* setup the state */
 570         state->config = config;
 571         state->i2c = i2c;
 572         memcpy(&state->ops, &sp887x_ops, sizeof(struct dvb_frontend_ops));
 573         state->initialised = 0;
 574
 575         /* check if the demod is there */
 576         if (sp887x_readreg(state, 0x0200) < 0) 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 sp887x_ops = {
 589
 590         .info = {
 591                 .name = "Spase SP887x DVB-T",
 592                 .type = FE_OFDM,
 593                 .frequency_min =  50500000,
 594                 .frequency_max = 858000000,
 595                 .frequency_stepsize = 166666,
 596                 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
 597                         FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
 598                         FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_64 |
 599                         FE_CAN_RECOVER
 600         },
 601
 602         .release = sp887x_release,
 603
 604         .init = sp887x_init,
 605         .sleep = sp887x_sleep,
 606
 607         .set_frontend = sp887x_setup_frontend_parameters,
 608         .get_tune_settings = sp887x_get_tune_settings,
 609
 610         .read_status = sp887x_read_status,
 611         .read_ber = sp887x_read_ber,
 612         .read_signal_strength = sp887x_read_signal_strength,
 613         .read_snr = sp887x_read_snr,
 614         .read_ucblocks = sp887x_read_ucblocks,
 615 };
 616
 617 module_param(debug, int, 0644);
 618 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
 619
 620 MODULE_DESCRIPTION("Spase sp887x DVB-T demodulator driver");
 621 MODULE_LICENSE("GPL");
 622
 623 EXPORT_SYMBOL(sp887x_attach);