drivers/media/dvb-frontends/sp887x.c

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