drivers/media/dvb-frontends/bcm3510.c

   1 /*
   2  * Support for the Broadcom BCM3510 ATSC demodulator (1st generation Air2PC)
   3  *
   4  *  Copyright (C) 2001-5, B2C2 inc.
   5  *
   6  *  GPL/Linux driver written by Patrick Boettcher <patrick.boettcher@posteo.de>
   7  *
   8  *  This driver is "hard-coded" to be used with the 1st generation of
   9  *  Technisat/B2C2's Air2PC ATSC PCI/USB cards/boxes. The pll-programming
  10  *  (Panasonic CT10S) is located here, which is actually wrong. Unless there is
  11  *  another device with a BCM3510, this is no problem.
  12  *
  13  *  The driver works also with QAM64 DVB-C, but had an unreasonable high
  14  *  UNC. (Tested with the Air2PC ATSC 1st generation)
  15  *
  16  *
  17  * This program is free software; you can redistribute it and/or modify it
  18  * under the terms of the GNU General Public License as published by the Free
  19  * Software Foundation; either version 2 of the License, or (at your option)
  20  * any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful, but WITHOUT
  23  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  24  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  25  * more details.
  26  *
  27  * You should have received a copy of the GNU General Public License along with
  28  * this program; if not, write to the Free Software Foundation, Inc., 675 Mass
  29  * Ave, Cambridge, MA 02139, USA.
  30  */
  31
  32 #include <linux/init.h>
  33 #include <linux/module.h>
  34 #include <linux/device.h>
  35 #include <linux/firmware.h>
  36 #include <linux/jiffies.h>
  37 #include <linux/string.h>
  38 #include <linux/slab.h>
  39 #include <linux/mutex.h>
  40
  41 #include "dvb_frontend.h"
  42 #include "bcm3510.h"
  43 #include "bcm3510_priv.h"
  44
  45 /* Max transfer size done by bcm3510_do_hab_cmd() function */
  46 #define MAX_XFER_SIZE   128
  47
  48 struct bcm3510_state {
  49
  50         struct i2c_adapter* i2c;
  51         const struct bcm3510_config* config;
  52         struct dvb_frontend frontend;
  53
  54         /* demodulator private data */
  55         struct mutex hab_mutex;
  56         u8 firmware_loaded:1;
  57
  58         unsigned long next_status_check;
  59         unsigned long status_check_interval;
  60         struct bcm3510_hab_cmd_status1 status1;
  61         struct bcm3510_hab_cmd_status2 status2;
  62 };
  63
  64 static int debug;
  65 module_param(debug, int, 0644);
  66 MODULE_PARM_DESC(debug, "set debugging level (1=info,2=i2c (|-able)).");
  67
  68 #define dprintk(level,x...) if (level & debug) printk(x)
  69 #define dbufout(b,l,m) {\
  70             int i; \
  71             for (i = 0; i < l; i++) \
  72                 m("%02x ",b[i]); \
  73 }
  74 #define deb_info(args...) dprintk(0x01,args)
  75 #define deb_i2c(args...)  dprintk(0x02,args)
  76 #define deb_hab(args...)  dprintk(0x04,args)
  77
  78 /* transfer functions */
  79 static int bcm3510_writebytes (struct bcm3510_state *state, u8 reg, u8 *buf, u8 len)
  80 {
  81         u8 b[256];
  82         int err;
  83         struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = b, .len = len + 1 };
  84
  85         b[0] = reg;
  86         memcpy(&b[1],buf,len);
  87
  88         deb_i2c("i2c wr %02x: ",reg);
  89         dbufout(buf,len,deb_i2c);
  90         deb_i2c("\n");
  91
  92         if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
  93
  94                 deb_info("%s: i2c write error (addr %02x, reg %02x, err == %i)\n",
  95                         __func__, state->config->demod_address, reg,  err);
  96                 return -EREMOTEIO;
  97         }
  98
  99         return 0;
 100 }
 101
 102 static int bcm3510_readbytes (struct bcm3510_state *state, u8 reg, u8 *buf, u8 len)
 103 {
 104         struct i2c_msg msg[] = {
 105                 { .addr = state->config->demod_address, .flags = 0,        .buf = &reg, .len = 1 },
 106                 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = buf,  .len = len }
 107         };
 108         int err;
 109
 110         memset(buf,0,len);
 111
 112         if ((err = i2c_transfer (state->i2c, msg, 2)) != 2) {
 113                 deb_info("%s: i2c read error (addr %02x, reg %02x, err == %i)\n",
 114                         __func__, state->config->demod_address, reg,  err);
 115                 return -EREMOTEIO;
 116         }
 117         deb_i2c("i2c rd %02x: ",reg);
 118         dbufout(buf,len,deb_i2c);
 119         deb_i2c("\n");
 120
 121         return 0;
 122 }
 123
 124 static int bcm3510_writeB(struct bcm3510_state *state, u8 reg, bcm3510_register_value v)
 125 {
 126         return bcm3510_writebytes(state,reg,&v.raw,1);
 127 }
 128
 129 static int bcm3510_readB(struct bcm3510_state *state, u8 reg, bcm3510_register_value *v)
 130 {
 131         return bcm3510_readbytes(state,reg,&v->raw,1);
 132 }
 133
 134 /* Host Access Buffer transfers */
 135 static int bcm3510_hab_get_response(struct bcm3510_state *st, u8 *buf, int len)
 136 {
 137         bcm3510_register_value v;
 138         int ret,i;
 139
 140         v.HABADR_a6.HABADR = 0;
 141         if ((ret = bcm3510_writeB(st,0xa6,v)) < 0)
 142                 return ret;
 143
 144         for (i = 0; i < len; i++) {
 145                 if ((ret = bcm3510_readB(st,0xa7,&v)) < 0)
 146                         return ret;
 147                 buf[i] = v.HABDATA_a7;
 148         }
 149         return 0;
 150 }
 151
 152 static int bcm3510_hab_send_request(struct bcm3510_state *st, u8 *buf, int len)
 153 {
 154         bcm3510_register_value v,hab;
 155         int ret,i;
 156         unsigned long t;
 157
 158 /* Check if any previous HAB request still needs to be serviced by the
 159  * Acquisition Processor before sending new request */
 160         if ((ret = bcm3510_readB(st,0xa8,&v)) < 0)
 161                 return ret;
 162         if (v.HABSTAT_a8.HABR) {
 163                 deb_info("HAB is running already - clearing it.\n");
 164                 v.HABSTAT_a8.HABR = 0;
 165                 bcm3510_writeB(st,0xa8,v);
 166 //              return -EBUSY;
 167         }
 168
 169 /* Send the start HAB Address (automatically incremented after write of
 170  * HABDATA) and write the HAB Data */
 171         hab.HABADR_a6.HABADR = 0;
 172         if ((ret = bcm3510_writeB(st,0xa6,hab)) < 0)
 173                 return ret;
 174
 175         for (i = 0; i < len; i++) {
 176                 hab.HABDATA_a7 = buf[i];
 177                 if ((ret = bcm3510_writeB(st,0xa7,hab)) < 0)
 178                         return ret;
 179         }
 180
 181 /* Set the HABR bit to indicate AP request in progress (LBHABR allows HABR to
 182  * be written) */
 183         v.raw = 0; v.HABSTAT_a8.HABR = 1; v.HABSTAT_a8.LDHABR = 1;
 184         if ((ret = bcm3510_writeB(st,0xa8,v)) < 0)
 185                 return ret;
 186
 187 /* Polling method: Wait until the AP finishes processing the HAB request */
 188         t = jiffies + 1*HZ;
 189         while (time_before(jiffies, t)) {
 190                 deb_info("waiting for HAB to complete\n");
 191                 msleep(10);
 192                 if ((ret = bcm3510_readB(st,0xa8,&v)) < 0)
 193                         return ret;
 194
 195                 if (!v.HABSTAT_a8.HABR)
 196                         return 0;
 197         }
 198
 199         deb_info("send_request execution timed out.\n");
 200         return -ETIMEDOUT;
 201 }
 202
 203 static int bcm3510_do_hab_cmd(struct bcm3510_state *st, u8 cmd, u8 msgid, u8 *obuf, u8 olen, u8 *ibuf, u8 ilen)
 204 {
 205         u8 ob[MAX_XFER_SIZE], ib[MAX_XFER_SIZE];
 206         int ret = 0;
 207
 208         if (ilen + 2 > sizeof(ib)) {
 209                 deb_hab("do_hab_cmd: ilen=%d is too big!\n", ilen);
 210                 return -EINVAL;
 211         }
 212
 213         if (olen + 2 > sizeof(ob)) {
 214                 deb_hab("do_hab_cmd: olen=%d is too big!\n", olen);
 215                 return -EINVAL;
 216         }
 217
 218         ob[0] = cmd;
 219         ob[1] = msgid;
 220         memcpy(&ob[2],obuf,olen);
 221
 222         deb_hab("hab snd: ");
 223         dbufout(ob,olen+2,deb_hab);
 224         deb_hab("\n");
 225
 226         if (mutex_lock_interruptible(&st->hab_mutex) < 0)
 227                 return -EAGAIN;
 228
 229         if ((ret = bcm3510_hab_send_request(st, ob, olen+2)) < 0 ||
 230                 (ret = bcm3510_hab_get_response(st, ib, ilen+2)) < 0)
 231                 goto error;
 232
 233         deb_hab("hab get: ");
 234         dbufout(ib,ilen+2,deb_hab);
 235         deb_hab("\n");
 236
 237         memcpy(ibuf,&ib[2],ilen);
 238 error:
 239         mutex_unlock(&st->hab_mutex);
 240         return ret;
 241 }
 242
 243 #if 0
 244 /* not needed, we use a semaphore to prevent HAB races */
 245 static int bcm3510_is_ap_ready(struct bcm3510_state *st)
 246 {
 247         bcm3510_register_value ap,hab;
 248         int ret;
 249
 250         if ((ret = bcm3510_readB(st,0xa8,&hab)) < 0 ||
 251                 (ret = bcm3510_readB(st,0xa2,&ap) < 0))
 252                 return ret;
 253
 254         if (ap.APSTAT1_a2.RESET || ap.APSTAT1_a2.IDLE || ap.APSTAT1_a2.STOP || hab.HABSTAT_a8.HABR) {
 255                 deb_info("AP is busy\n");
 256                 return -EBUSY;
 257         }
 258
 259         return 0;
 260 }
 261 #endif
 262
 263 static int bcm3510_bert_reset(struct bcm3510_state *st)
 264 {
 265         bcm3510_register_value b;
 266         int ret;
 267
 268         if ((ret = bcm3510_readB(st,0xfa,&b)) < 0)
 269                 return ret;
 270
 271         b.BERCTL_fa.RESYNC = 0; bcm3510_writeB(st,0xfa,b);
 272         b.BERCTL_fa.RESYNC = 1; bcm3510_writeB(st,0xfa,b);
 273         b.BERCTL_fa.RESYNC = 0; bcm3510_writeB(st,0xfa,b);
 274         b.BERCTL_fa.CNTCTL = 1; b.BERCTL_fa.BITCNT = 1; bcm3510_writeB(st,0xfa,b);
 275
 276         /* clear residual bit counter TODO  */
 277         return 0;
 278 }
 279
 280 static int bcm3510_refresh_state(struct bcm3510_state *st)
 281 {
 282         if (time_after(jiffies,st->next_status_check)) {
 283                 bcm3510_do_hab_cmd(st, CMD_STATUS, MSGID_STATUS1, NULL,0, (u8 *)&st->status1, sizeof(st->status1));
 284                 bcm3510_do_hab_cmd(st, CMD_STATUS, MSGID_STATUS2, NULL,0, (u8 *)&st->status2, sizeof(st->status2));
 285                 st->next_status_check = jiffies + (st->status_check_interval*HZ)/1000;
 286         }
 287         return 0;
 288 }
 289
 290 static int bcm3510_read_status(struct dvb_frontend *fe, enum fe_status *status)
 291 {
 292         struct bcm3510_state* st = fe->demodulator_priv;
 293         bcm3510_refresh_state(st);
 294
 295         *status = 0;
 296         if (st->status1.STATUS1.RECEIVER_LOCK)
 297                 *status |= FE_HAS_LOCK | FE_HAS_SYNC;
 298
 299         if (st->status1.STATUS1.FEC_LOCK)
 300                 *status |= FE_HAS_VITERBI;
 301
 302         if (st->status1.STATUS1.OUT_PLL_LOCK)
 303                 *status |= FE_HAS_SIGNAL | FE_HAS_CARRIER;
 304
 305         if (*status & FE_HAS_LOCK)
 306                 st->status_check_interval = 1500;
 307         else /* more frequently checks if no lock has been achieved yet */
 308                 st->status_check_interval = 500;
 309
 310         deb_info("real_status: %02x\n",*status);
 311         return 0;
 312 }
 313
 314 static int bcm3510_read_ber(struct dvb_frontend* fe, u32* ber)
 315 {
 316         struct bcm3510_state* st = fe->demodulator_priv;
 317         bcm3510_refresh_state(st);
 318
 319         *ber = (st->status2.LDBER0 << 16) | (st->status2.LDBER1 << 8) | st->status2.LDBER2;
 320         return 0;
 321 }
 322
 323 static int bcm3510_read_unc(struct dvb_frontend* fe, u32* unc)
 324 {
 325         struct bcm3510_state* st = fe->demodulator_priv;
 326         bcm3510_refresh_state(st);
 327         *unc = (st->status2.LDUERC0 << 8) | st->status2.LDUERC1;
 328         return 0;
 329 }
 330
 331 static int bcm3510_read_signal_strength(struct dvb_frontend* fe, u16* strength)
 332 {
 333         struct bcm3510_state* st = fe->demodulator_priv;
 334         s32 t;
 335
 336         bcm3510_refresh_state(st);
 337         t = st->status2.SIGNAL;
 338
 339         if (t > 190)
 340                 t = 190;
 341         if (t < 90)
 342                 t = 90;
 343
 344         t -= 90;
 345         t = t * 0xff / 100;
 346         /* normalize if necessary */
 347         *strength = (t << 8) | t;
 348         return 0;
 349 }
 350
 351 static int bcm3510_read_snr(struct dvb_frontend* fe, u16* snr)
 352 {
 353         struct bcm3510_state* st = fe->demodulator_priv;
 354         bcm3510_refresh_state(st);
 355
 356         *snr = st->status1.SNR_EST0*1000 + ((st->status1.SNR_EST1*1000) >> 8);
 357         return 0;
 358 }
 359
 360 /* tuner frontend programming */
 361 static int bcm3510_tuner_cmd(struct bcm3510_state* st,u8 bc, u16 n, u8 a)
 362 {
 363         struct bcm3510_hab_cmd_tune c;
 364         memset(&c,0,sizeof(struct bcm3510_hab_cmd_tune));
 365
 366 /* I2C Mode disabled,  set 16 control / Data pairs */
 367         c.length = 0x10;
 368         c.clock_width = 0;
 369 /* CS1, CS0, DATA, CLK bits control the tuner RF_AGC_SEL pin is set to
 370  * logic high (as Configuration) */
 371         c.misc = 0x10;
 372 /* Set duration of the initial state of TUNCTL = 3.34 micro Sec */
 373         c.TUNCTL_state = 0x40;
 374
 375 /* PRESCALER DIVIDE RATIO | BC1_2_3_4; (band switch), 1stosc REFERENCE COUNTER REF_S12 and REF_S11 */
 376         c.ctl_dat[0].ctrl.size = BITS_8;
 377         c.ctl_dat[0].data      = 0x80 | bc;
 378
 379 /* Control DATA pin, 1stosc REFERENCE COUNTER REF_S10 to REF_S3 */
 380         c.ctl_dat[1].ctrl.size = BITS_8;
 381         c.ctl_dat[1].data      = 4;
 382
 383 /* set CONTROL BIT 1 to 1, 1stosc REFERENCE COUNTER REF_S2 to REF_S1 */
 384         c.ctl_dat[2].ctrl.size = BITS_3;
 385         c.ctl_dat[2].data      = 0x20;
 386
 387 /* control CS0 pin, pulse byte ? */
 388         c.ctl_dat[3].ctrl.size = BITS_3;
 389         c.ctl_dat[3].ctrl.clk_off = 1;
 390         c.ctl_dat[3].ctrl.cs0  = 1;
 391         c.ctl_dat[3].data      = 0x40;
 392
 393 /* PGM_S18 to PGM_S11 */
 394         c.ctl_dat[4].ctrl.size = BITS_8;
 395         c.ctl_dat[4].data      = n >> 3;
 396
 397 /* PGM_S10 to PGM_S8, SWL_S7 to SWL_S3 */
 398         c.ctl_dat[5].ctrl.size = BITS_8;
 399         c.ctl_dat[5].data      = ((n & 0x7) << 5) | (a >> 2);
 400
 401 /* SWL_S2 and SWL_S1, set CONTROL BIT 2 to 0 */
 402         c.ctl_dat[6].ctrl.size = BITS_3;
 403         c.ctl_dat[6].data      = (a << 6) & 0xdf;
 404
 405 /* control CS0 pin, pulse byte ? */
 406         c.ctl_dat[7].ctrl.size = BITS_3;
 407         c.ctl_dat[7].ctrl.clk_off = 1;
 408         c.ctl_dat[7].ctrl.cs0  = 1;
 409         c.ctl_dat[7].data      = 0x40;
 410
 411 /* PRESCALER DIVIDE RATIO, 2ndosc REFERENCE COUNTER REF_S12 and REF_S11 */
 412         c.ctl_dat[8].ctrl.size = BITS_8;
 413         c.ctl_dat[8].data      = 0x80;
 414
 415 /* 2ndosc REFERENCE COUNTER REF_S10 to REF_S3 */
 416         c.ctl_dat[9].ctrl.size = BITS_8;
 417         c.ctl_dat[9].data      = 0x10;
 418
 419 /* set CONTROL BIT 1 to 1, 2ndosc REFERENCE COUNTER REF_S2 to REF_S1 */
 420         c.ctl_dat[10].ctrl.size = BITS_3;
 421         c.ctl_dat[10].data      = 0x20;
 422
 423 /* pulse byte */
 424         c.ctl_dat[11].ctrl.size = BITS_3;
 425         c.ctl_dat[11].ctrl.clk_off = 1;
 426         c.ctl_dat[11].ctrl.cs1  = 1;
 427         c.ctl_dat[11].data      = 0x40;
 428
 429 /* PGM_S18 to PGM_S11 */
 430         c.ctl_dat[12].ctrl.size = BITS_8;
 431         c.ctl_dat[12].data      = 0x2a;
 432
 433 /* PGM_S10 to PGM_S8 and SWL_S7 to SWL_S3 */
 434         c.ctl_dat[13].ctrl.size = BITS_8;
 435         c.ctl_dat[13].data      = 0x8e;
 436
 437 /* SWL_S2 and SWL_S1 and set CONTROL BIT 2 to 0 */
 438         c.ctl_dat[14].ctrl.size = BITS_3;
 439         c.ctl_dat[14].data      = 0;
 440
 441 /* Pulse Byte */
 442         c.ctl_dat[15].ctrl.size = BITS_3;
 443         c.ctl_dat[15].ctrl.clk_off = 1;
 444         c.ctl_dat[15].ctrl.cs1  = 1;
 445         c.ctl_dat[15].data      = 0x40;
 446
 447         return bcm3510_do_hab_cmd(st,CMD_TUNE, MSGID_TUNE,(u8 *) &c,sizeof(c), NULL, 0);
 448 }
 449
 450 static int bcm3510_set_freq(struct bcm3510_state* st,u32 freq)
 451 {
 452         u8 bc,a;
 453         u16 n;
 454         s32 YIntercept,Tfvco1;
 455
 456         freq /= 1000;
 457
 458         deb_info("%dkHz:",freq);
 459         /* set Band Switch */
 460         if (freq <= 168000)
 461                 bc = 0x1c;
 462         else if (freq <= 378000)
 463                 bc = 0x2c;
 464         else
 465                 bc = 0x30;
 466
 467         if (freq >= 470000) {
 468                 freq -= 470001;
 469                 YIntercept = 18805;
 470         } else if (freq >= 90000) {
 471                 freq -= 90001;
 472                 YIntercept = 15005;
 473         } else if (freq >= 76000){
 474                 freq -= 76001;
 475                 YIntercept = 14865;
 476         } else {
 477                 freq -= 54001;
 478                 YIntercept = 14645;
 479         }
 480
 481         Tfvco1 = (((freq/6000)*60 + YIntercept)*4)/10;
 482
 483         n = Tfvco1 >> 6;
 484         a = Tfvco1 & 0x3f;
 485
 486         deb_info(" BC1_2_3_4: %x, N: %x A: %x\n", bc, n, a);
 487         if (n >= 16 && n <= 2047)
 488                 return bcm3510_tuner_cmd(st,bc,n,a);
 489
 490         return -EINVAL;
 491 }
 492
 493 static int bcm3510_set_frontend(struct dvb_frontend *fe)
 494 {
 495         struct dtv_frontend_properties *c = &fe->dtv_property_cache;
 496         struct bcm3510_state* st = fe->demodulator_priv;
 497         struct bcm3510_hab_cmd_ext_acquire cmd;
 498         struct bcm3510_hab_cmd_bert_control bert;
 499         int ret;
 500
 501         memset(&cmd,0,sizeof(cmd));
 502         switch (c->modulation) {
 503                 case QAM_256:
 504                         cmd.ACQUIRE0.MODE = 0x1;
 505                         cmd.ACQUIRE1.SYM_RATE = 0x1;
 506                         cmd.ACQUIRE1.IF_FREQ = 0x1;
 507                         break;
 508                 case QAM_64:
 509                         cmd.ACQUIRE0.MODE = 0x2;
 510                         cmd.ACQUIRE1.SYM_RATE = 0x2;
 511                         cmd.ACQUIRE1.IF_FREQ = 0x1;
 512                         break;
 513 #if 0
 514                 case QAM_256:
 515                         cmd.ACQUIRE0.MODE = 0x3;
 516                         break;
 517                 case QAM_128:
 518                         cmd.ACQUIRE0.MODE = 0x4;
 519                         break;
 520                 case QAM_64:
 521                         cmd.ACQUIRE0.MODE = 0x5;
 522                         break;
 523                 case QAM_32:
 524                         cmd.ACQUIRE0.MODE = 0x6;
 525                         break;
 526                 case QAM_16:
 527                         cmd.ACQUIRE0.MODE = 0x7;
 528                         break;
 529 #endif
 530                 case VSB_8:
 531                         cmd.ACQUIRE0.MODE = 0x8;
 532                         cmd.ACQUIRE1.SYM_RATE = 0x0;
 533                         cmd.ACQUIRE1.IF_FREQ = 0x0;
 534                         break;
 535                 case VSB_16:
 536                         cmd.ACQUIRE0.MODE = 0x9;
 537                         cmd.ACQUIRE1.SYM_RATE = 0x0;
 538                         cmd.ACQUIRE1.IF_FREQ = 0x0;
 539                         break;
 540                 default:
 541                         return -EINVAL;
 542         }
 543         cmd.ACQUIRE0.OFFSET = 0;
 544         cmd.ACQUIRE0.NTSCSWEEP = 1;
 545         cmd.ACQUIRE0.FA = 1;
 546         cmd.ACQUIRE0.BW = 0;
 547
 548 /*      if (enableOffset) {
 549                 cmd.IF_OFFSET0 = xx;
 550                 cmd.IF_OFFSET1 = xx;
 551
 552                 cmd.SYM_OFFSET0 = xx;
 553                 cmd.SYM_OFFSET1 = xx;
 554                 if (enableNtscSweep) {
 555                         cmd.NTSC_OFFSET0;
 556                         cmd.NTSC_OFFSET1;
 557                 }
 558         } */
 559         bcm3510_do_hab_cmd(st, CMD_ACQUIRE, MSGID_EXT_TUNER_ACQUIRE, (u8 *) &cmd, sizeof(cmd), NULL, 0);
 560
 561 /* doing it with different MSGIDs, data book and source differs */
 562         bert.BE = 0;
 563         bert.unused = 0;
 564         bcm3510_do_hab_cmd(st, CMD_STATE_CONTROL, MSGID_BERT_CONTROL, (u8 *) &bert, sizeof(bert), NULL, 0);
 565         bcm3510_do_hab_cmd(st, CMD_STATE_CONTROL, MSGID_BERT_SET, (u8 *) &bert, sizeof(bert), NULL, 0);
 566
 567         bcm3510_bert_reset(st);
 568
 569         ret = bcm3510_set_freq(st, c->frequency);
 570         if (ret < 0)
 571                 return ret;
 572
 573         memset(&st->status1,0,sizeof(st->status1));
 574         memset(&st->status2,0,sizeof(st->status2));
 575         st->status_check_interval = 500;
 576
 577 /* Give the AP some time */
 578         msleep(200);
 579
 580         return 0;
 581 }
 582
 583 static int bcm3510_sleep(struct dvb_frontend* fe)
 584 {
 585         return 0;
 586 }
 587
 588 static int bcm3510_get_tune_settings(struct dvb_frontend *fe, struct dvb_frontend_tune_settings *s)
 589 {
 590         s->min_delay_ms = 1000;
 591         s->step_size = 0;
 592         s->max_drift = 0;
 593         return 0;
 594 }
 595
 596 static void bcm3510_release(struct dvb_frontend* fe)
 597 {
 598         struct bcm3510_state* state = fe->demodulator_priv;
 599         kfree(state);
 600 }
 601
 602 /* firmware download:
 603  * firmware file is build up like this:
 604  * 16bit addr, 16bit length, 8byte of length
 605  */
 606 /*(DEBLOBBED)*/
 607
 608 static int bcm3510_write_ram(struct bcm3510_state *st, u16 addr, const u8 *b,
 609                              u16 len)
 610 {
 611         int ret = 0,i;
 612         bcm3510_register_value vH, vL,vD;
 613
 614         vH.MADRH_a9 = addr >> 8;
 615         vL.MADRL_aa = addr;
 616         if ((ret = bcm3510_writeB(st,0xa9,vH)) < 0) return ret;
 617         if ((ret = bcm3510_writeB(st,0xaa,vL)) < 0) return ret;
 618
 619         for (i = 0; i < len; i++) {
 620                 vD.MDATA_ab = b[i];
 621                 if ((ret = bcm3510_writeB(st,0xab,vD)) < 0)
 622                         return ret;
 623         }
 624
 625         return 0;
 626 }
 627
 628 static int bcm3510_download_firmware(struct dvb_frontend* fe)
 629 {
 630         struct bcm3510_state* st = fe->demodulator_priv;
 631         const struct firmware *fw;
 632         u16 addr,len;
 633         const u8 *b;
 634         int ret,i;
 635
 636         deb_info("requesting firmware\n");
 637         if ((ret = st->config->request_firmware(fe, &fw, "/*(DEBLOBBED)*/")) < 0) {
 638                 err("could not load firmware (%s): %d","/*(DEBLOBBED)*/",ret);
 639                 return ret;
 640         }
 641         deb_info("got firmware: %zu\n", fw->size);
 642
 643         b = fw->data;
 644         for (i = 0; i < fw->size;) {
 645                 addr = le16_to_cpu(*((__le16 *)&b[i]));
 646                 len  = le16_to_cpu(*((__le16 *)&b[i+2]));
 647                 deb_info("firmware chunk, addr: 0x%04x, len: 0x%04x, total length: 0x%04zx\n",addr,len,fw->size);
 648                 if ((ret = bcm3510_write_ram(st,addr,&b[i+4],len)) < 0) {
 649                         err("firmware download failed: %d\n",ret);
 650                         return ret;
 651                 }
 652                 i += 4 + len;
 653         }
 654         release_firmware(fw);
 655         deb_info("firmware download successfully completed\n");
 656         return 0;
 657 }
 658
 659 static int bcm3510_check_firmware_version(struct bcm3510_state *st)
 660 {
 661         struct bcm3510_hab_cmd_get_version_info ver;
 662         bcm3510_do_hab_cmd(st,CMD_GET_VERSION_INFO,MSGID_GET_VERSION_INFO,NULL,0,(u8*)&ver,sizeof(ver));
 663
 664         deb_info("Version information: 0x%02x 0x%02x 0x%02x 0x%02x\n",
 665                 ver.microcode_version, ver.script_version, ver.config_version, ver.demod_version);
 666
 667         if (ver.script_version == BCM3510_DEF_SCRIPT_VERSION &&
 668                 ver.config_version == BCM3510_DEF_CONFIG_VERSION &&
 669                 ver.demod_version  == BCM3510_DEF_DEMOD_VERSION)
 670                 return 0;
 671
 672         deb_info("version check failed\n");
 673         return -ENODEV;
 674 }
 675
 676 /* (un)resetting the AP */
 677 static int bcm3510_reset(struct bcm3510_state *st)
 678 {
 679         int ret;
 680         unsigned long  t;
 681         bcm3510_register_value v;
 682
 683         bcm3510_readB(st,0xa0,&v); v.HCTL1_a0.RESET = 1;
 684         if ((ret = bcm3510_writeB(st,0xa0,v)) < 0)
 685                 return ret;
 686
 687         t = jiffies + 3*HZ;
 688         while (time_before(jiffies, t)) {
 689                 msleep(10);
 690                 if ((ret = bcm3510_readB(st,0xa2,&v)) < 0)
 691                         return ret;
 692
 693                 if (v.APSTAT1_a2.RESET)
 694                         return 0;
 695         }
 696         deb_info("reset timed out\n");
 697         return -ETIMEDOUT;
 698 }
 699
 700 static int bcm3510_clear_reset(struct bcm3510_state *st)
 701 {
 702         bcm3510_register_value v;
 703         int ret;
 704         unsigned long t;
 705
 706         v.raw = 0;
 707         if ((ret = bcm3510_writeB(st,0xa0,v)) < 0)
 708                 return ret;
 709
 710         t = jiffies + 3*HZ;
 711         while (time_before(jiffies, t)) {
 712                 msleep(10);
 713                 if ((ret = bcm3510_readB(st,0xa2,&v)) < 0)
 714                         return ret;
 715
 716                 /* verify that reset is cleared */
 717                 if (!v.APSTAT1_a2.RESET)
 718                         return 0;
 719         }
 720         deb_info("reset clear timed out\n");
 721         return -ETIMEDOUT;
 722 }
 723
 724 static int bcm3510_init_cold(struct bcm3510_state *st)
 725 {
 726         int ret;
 727         bcm3510_register_value v;
 728
 729         /* read Acquisation Processor status register and check it is not in RUN mode */
 730         if ((ret = bcm3510_readB(st,0xa2,&v)) < 0)
 731                 return ret;
 732         if (v.APSTAT1_a2.RUN) {
 733                 deb_info("AP is already running - firmware already loaded.\n");
 734                 return 0;
 735         }
 736
 737         deb_info("reset?\n");
 738         if ((ret = bcm3510_reset(st)) < 0)
 739                 return ret;
 740
 741         deb_info("tristate?\n");
 742         /* tri-state */
 743         v.TSTCTL_2e.CTL = 0;
 744         if ((ret = bcm3510_writeB(st,0x2e,v)) < 0)
 745                 return ret;
 746
 747         deb_info("firmware?\n");
 748         if ((ret = bcm3510_download_firmware(&st->frontend)) < 0 ||
 749                 (ret = bcm3510_clear_reset(st)) < 0)
 750                 return ret;
 751
 752         /* anything left here to Let the acquisition processor begin execution at program counter 0000 ??? */
 753
 754         return 0;
 755 }
 756
 757 static int bcm3510_init(struct dvb_frontend* fe)
 758 {
 759         struct bcm3510_state* st = fe->demodulator_priv;
 760         bcm3510_register_value j;
 761         struct bcm3510_hab_cmd_set_agc c;
 762         int ret;
 763
 764         if ((ret = bcm3510_readB(st,0xca,&j)) < 0)
 765                 return ret;
 766
 767         deb_info("JDEC: %02x\n",j.raw);
 768
 769         switch (j.JDEC_ca.JDEC) {
 770                 case JDEC_WAIT_AT_RAM:
 771                         deb_info("attempting to download firmware\n");
 772                         if ((ret = bcm3510_init_cold(st)) < 0)
 773                                 return ret;
 774                         /* fall-through */
 775                 case JDEC_EEPROM_LOAD_WAIT:
 776                         deb_info("firmware is loaded\n");
 777                         bcm3510_check_firmware_version(st);
 778                         break;
 779                 default:
 780                         return -ENODEV;
 781         }
 782
 783         memset(&c,0,1);
 784         c.SEL = 1;
 785         bcm3510_do_hab_cmd(st,CMD_AUTO_PARAM,MSGID_SET_RF_AGC_SEL,(u8 *)&c,sizeof(c),NULL,0);
 786
 787         return 0;
 788 }
 789
 790
 791 static const struct dvb_frontend_ops bcm3510_ops;
 792
 793 struct dvb_frontend* bcm3510_attach(const struct bcm3510_config *config,
 794                                    struct i2c_adapter *i2c)
 795 {
 796         struct bcm3510_state* state = NULL;
 797         int ret;
 798         bcm3510_register_value v;
 799
 800         /* allocate memory for the internal state */
 801         state = kzalloc(sizeof(struct bcm3510_state), GFP_KERNEL);
 802         if (state == NULL)
 803                 goto error;
 804
 805         /* setup the state */
 806
 807         state->config = config;
 808         state->i2c = i2c;
 809
 810         /* create dvb_frontend */
 811         memcpy(&state->frontend.ops, &bcm3510_ops, sizeof(struct dvb_frontend_ops));
 812         state->frontend.demodulator_priv = state;
 813
 814         mutex_init(&state->hab_mutex);
 815
 816         if ((ret = bcm3510_readB(state,0xe0,&v)) < 0)
 817                 goto error;
 818
 819         deb_info("Revision: 0x%1x, Layer: 0x%1x.\n",v.REVID_e0.REV,v.REVID_e0.LAYER);
 820
 821         if ((v.REVID_e0.REV != 0x1 && v.REVID_e0.LAYER != 0xb) && /* cold */
 822                 (v.REVID_e0.REV != 0x8 && v.REVID_e0.LAYER != 0x0))   /* warm */
 823                 goto error;
 824
 825         info("Revision: 0x%1x, Layer: 0x%1x.",v.REVID_e0.REV,v.REVID_e0.LAYER);
 826
 827         bcm3510_reset(state);
 828
 829         return &state->frontend;
 830
 831 error:
 832         kfree(state);
 833         return NULL;
 834 }
 835 EXPORT_SYMBOL(bcm3510_attach);
 836
 837 static const struct dvb_frontend_ops bcm3510_ops = {
 838         .delsys = { SYS_ATSC, SYS_DVBC_ANNEX_B },
 839         .info = {
 840                 .name = "Broadcom BCM3510 VSB/QAM frontend",
 841                 .frequency_min =  54000000,
 842                 .frequency_max = 803000000,
 843                 /* stepsize is just a guess */
 844                 .frequency_stepsize = 0,
 845                 .caps =
 846                         FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
 847                         FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
 848                         FE_CAN_8VSB | FE_CAN_16VSB |
 849                         FE_CAN_QAM_16 | FE_CAN_QAM_64 | FE_CAN_QAM_128 | FE_CAN_QAM_256
 850         },
 851
 852         .release = bcm3510_release,
 853
 854         .init = bcm3510_init,
 855         .sleep = bcm3510_sleep,
 856
 857         .set_frontend = bcm3510_set_frontend,
 858         .get_tune_settings = bcm3510_get_tune_settings,
 859
 860         .read_status = bcm3510_read_status,
 861         .read_ber = bcm3510_read_ber,
 862         .read_signal_strength = bcm3510_read_signal_strength,
 863         .read_snr = bcm3510_read_snr,
 864         .read_ucblocks = bcm3510_read_unc,
 865 };
 866
 867 MODULE_DESCRIPTION("Broadcom BCM3510 ATSC (8VSB/16VSB & ITU J83 AnnexB FEC QAM64/256) demodulator driver");
 868 MODULE_AUTHOR("Patrick Boettcher <patrick.boettcher@posteo.de>");
 869 MODULE_LICENSE("GPL");