SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/media/video/tuner-xc2028.c

   1 /* tuner-xc2028
   2  *
   3  * Copyright (c) 2007 Mauro Carvalho Chehab (mchehab@infradead.org)
   4  *
   5  * Copyright (c) 2007 Michel Ludwig (michel.ludwig@gmail.com)
   6  *       - frontend interface
   7  *
   8  * This code is placed under the terms of the GNU General Public License v2
   9  */
  10
  11 #include <linux/i2c.h>
  12 #include <asm/div64.h>
  13 #include <linux/firmware.h>
  14 #include <linux/videodev2.h>
  15 #include <linux/delay.h>
  16 #include <media/tuner.h>
  17 #include <linux/mutex.h>
  18 #include "tuner-i2c.h"
  19 #include "tuner-xc2028.h"
  20 #include "tuner-xc2028-types.h"
  21
  22 #include <linux/dvb/frontend.h>
  23 #include "dvb_frontend.h"
  24
  25
  26 static int debug;
  27 module_param(debug, int, 0644);
  28 MODULE_PARM_DESC(debug, "enable verbose debug messages");
  29
  30 static char audio_std[8];
  31 module_param_string(audio_std, audio_std, sizeof(audio_std), 0);
  32 MODULE_PARM_DESC(audio_std,
  33         "Audio standard. XC3028 audio decoder explicitly "
  34         "needs to know what audio\n"
  35         "standard is needed for some video standards with audio A2 or NICAM.\n"
  36         "The valid values are:\n"
  37         "A2\n"
  38         "A2/A\n"
  39         "A2/B\n"
  40         "NICAM\n"
  41         "NICAM/A\n"
  42         "NICAM/B\n");
  43
  44 static LIST_HEAD(xc2028_list);
  45 static DEFINE_MUTEX(xc2028_list_mutex);
  46
  47 /* struct for storing firmware table */
  48 struct firmware_description {
  49         unsigned int  type;
  50         v4l2_std_id   id;
  51         __u16         int_freq;
  52         unsigned char *ptr;
  53         unsigned int  size;
  54 };
  55
  56 struct firmware_properties {
  57         unsigned int    type;
  58         v4l2_std_id     id;
  59         v4l2_std_id     std_req;
  60         __u16           int_freq;
  61         unsigned int    scode_table;
  62         int             scode_nr;
  63 };
  64
  65 struct xc2028_data {
  66         struct list_head        xc2028_list;
  67         struct tuner_i2c_props  i2c_props;
  68         int                     (*tuner_callback) (void *dev,
  69                                                    int command, int arg);
  70         void                    *video_dev;
  71         int                     count;
  72         __u32                   frequency;
  73
  74         struct firmware_description *firm;
  75         int                     firm_size;
  76         __u16                   firm_version;
  77
  78         __u16                   hwmodel;
  79         __u16                   hwvers;
  80
  81         struct xc2028_ctrl      ctrl;
  82
  83         struct firmware_properties cur_fw;
  84
  85         struct mutex lock;
  86 };
  87
  88 #define i2c_send(priv, buf, size) ({                                    \
  89         int _rc;                                                        \
  90         _rc = tuner_i2c_xfer_send(&priv->i2c_props, buf, size);         \
  91         if (size != _rc)                                                \
  92                 tuner_info("i2c output error: rc = %d (should be %d)\n",\
  93                            _rc, (int)size);                             \
  94         _rc;                                                            \
  95 })
  96
  97 #define i2c_rcv(priv, buf, size) ({                                     \
  98         int _rc;                                                        \
  99         _rc = tuner_i2c_xfer_recv(&priv->i2c_props, buf, size);         \
 100         if (size != _rc)                                                \
 101                 tuner_err("i2c input error: rc = %d (should be %d)\n",  \
 102                            _rc, (int)size);                             \
 103         _rc;                                                            \
 104 })
 105
 106 #define i2c_send_recv(priv, obuf, osize, ibuf, isize) ({                \
 107         int _rc;                                                        \
 108         _rc = tuner_i2c_xfer_send_recv(&priv->i2c_props, obuf, osize,   \
 109                                        ibuf, isize);                    \
 110         if (isize != _rc)                                               \
 111                 tuner_err("i2c input error: rc = %d (should be %d)\n",  \
 112                            _rc, (int)isize);                            \
 113         _rc;                                                            \
 114 })
 115
 116 #define send_seq(priv, data...) ({                                      \
 117         static u8 _val[] = data;                                        \
 118         int _rc;                                                        \
 119         if (sizeof(_val) !=                                             \
 120                         (_rc = tuner_i2c_xfer_send(&priv->i2c_props,    \
 121                                                 _val, sizeof(_val)))) { \
 122                 tuner_err("Error on line %d: %d\n", __LINE__, _rc);     \
 123         } else                                                          \
 124                 msleep(10);                                             \
 125         _rc;                                                            \
 126 })
 127
 128 static unsigned int xc2028_get_reg(struct xc2028_data *priv, u16 reg, u16 *val)
 129 {
 130         unsigned char buf[2];
 131         unsigned char ibuf[2];
 132
 133         tuner_dbg("%s %04x called\n", __FUNCTION__, reg);
 134
 135         buf[0] = reg >> 8;
 136         buf[1] = (unsigned char) reg;
 137
 138         if (i2c_send_recv(priv, buf, 2, ibuf, 2) != 2)
 139                 return -EIO;
 140
 141         *val = (ibuf[1]) | (ibuf[0] << 8);
 142         return 0;
 143 }
 144
 145 #define dump_firm_type(t)       dump_firm_type_and_int_freq(t, 0)
 146 static void dump_firm_type_and_int_freq(unsigned int type, u16 int_freq)
 147 {
 148          if (type & BASE)
 149                 printk("BASE ");
 150          if (type & INIT1)
 151                 printk("INIT1 ");
 152          if (type & F8MHZ)
 153                 printk("F8MHZ ");
 154          if (type & MTS)
 155                 printk("MTS ");
 156          if (type & D2620)
 157                 printk("D2620 ");
 158          if (type & D2633)
 159                 printk("D2633 ");
 160          if (type & DTV6)
 161                 printk("DTV6 ");
 162          if (type & QAM)
 163                 printk("QAM ");
 164          if (type & DTV7)
 165                 printk("DTV7 ");
 166          if (type & DTV78)
 167                 printk("DTV78 ");
 168          if (type & DTV8)
 169                 printk("DTV8 ");
 170          if (type & FM)
 171                 printk("FM ");
 172          if (type & INPUT1)
 173                 printk("INPUT1 ");
 174          if (type & LCD)
 175                 printk("LCD ");
 176          if (type & NOGD)
 177                 printk("NOGD ");
 178          if (type & MONO)
 179                 printk("MONO ");
 180          if (type & ATSC)
 181                 printk("ATSC ");
 182          if (type & IF)
 183                 printk("IF ");
 184          if (type & LG60)
 185                 printk("LG60 ");
 186          if (type & ATI638)
 187                 printk("ATI638 ");
 188          if (type & OREN538)
 189                 printk("OREN538 ");
 190          if (type & OREN36)
 191                 printk("OREN36 ");
 192          if (type & TOYOTA388)
 193                 printk("TOYOTA388 ");
 194          if (type & TOYOTA794)
 195                 printk("TOYOTA794 ");
 196          if (type & DIBCOM52)
 197                 printk("DIBCOM52 ");
 198          if (type & ZARLINK456)
 199                 printk("ZARLINK456 ");
 200          if (type & CHINA)
 201                 printk("CHINA ");
 202          if (type & F6MHZ)
 203                 printk("F6MHZ ");
 204          if (type & INPUT2)
 205                 printk("INPUT2 ");
 206          if (type & SCODE)
 207                 printk("SCODE ");
 208          if (type & HAS_IF)
 209                 printk("HAS_IF_%d ", int_freq);
 210 }
 211
 212 static  v4l2_std_id parse_audio_std_option(void)
 213 {
 214         if (strcasecmp(audio_std, "A2") == 0)
 215                 return V4L2_STD_A2;
 216         if (strcasecmp(audio_std, "A2/A") == 0)
 217                 return V4L2_STD_A2_A;
 218         if (strcasecmp(audio_std, "A2/B") == 0)
 219                 return V4L2_STD_A2_B;
 220         if (strcasecmp(audio_std, "NICAM") == 0)
 221                 return V4L2_STD_NICAM;
 222         if (strcasecmp(audio_std, "NICAM/A") == 0)
 223                 return V4L2_STD_NICAM_A;
 224         if (strcasecmp(audio_std, "NICAM/B") == 0)
 225                 return V4L2_STD_NICAM_B;
 226
 227         return 0;
 228 }
 229
 230 static void free_firmware(struct xc2028_data *priv)
 231 {
 232         int i;
 233
 234         if (!priv->firm)
 235                 return;
 236
 237         for (i = 0; i < priv->firm_size; i++)
 238                 kfree(priv->firm[i].ptr);
 239
 240         kfree(priv->firm);
 241
 242         priv->firm = NULL;
 243         priv->firm_size = 0;
 244
 245         memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
 246 }
 247
 248 static int load_all_firmwares(struct dvb_frontend *fe)
 249 {
 250         struct xc2028_data    *priv = fe->tuner_priv;
 251         const struct firmware *fw   = NULL;
 252         unsigned char         *p, *endp;
 253         int                   rc = 0;
 254         int                   n, n_array;
 255         char                  name[33];
 256
 257         tuner_dbg("%s called\n", __FUNCTION__);
 258
 259         tuner_dbg("Reading firmware %s\n", priv->ctrl.fname);
 260         rc = request_firmware(&fw, priv->ctrl.fname,
 261                               &priv->i2c_props.adap->dev);
 262         if (rc < 0) {
 263                 if (rc == -ENOENT)
 264                         tuner_err("Error: firmware %s not found.\n",
 265                                    priv->ctrl.fname);
 266                 else
 267                         tuner_err("Error %d while requesting firmware %s \n",
 268                                    rc, priv->ctrl.fname);
 269
 270                 return rc;
 271         }
 272         p = fw->data;
 273         endp = p + fw->size;
 274
 275         if (fw->size < sizeof(name) - 1 + 2 + 2) {
 276                 tuner_err("Error: firmware file %s has invalid size!\n",
 277                           priv->ctrl.fname);
 278                 goto corrupt;
 279         }
 280
 281         memcpy(name, p, sizeof(name) - 1);
 282         name[sizeof(name) - 1] = 0;
 283         p += sizeof(name) - 1;
 284
 285         priv->firm_version = le16_to_cpu(*(__u16 *) p);
 286         p += 2;
 287
 288         n_array = le16_to_cpu(*(__u16 *) p);
 289         p += 2;
 290
 291         tuner_info("Loading %d firmware images from %s, type: %s, ver %d.%d\n",
 292                    n_array, priv->ctrl.fname, name,
 293                    priv->firm_version >> 8, priv->firm_version & 0xff);
 294
 295         priv->firm = kzalloc(sizeof(*priv->firm) * n_array, GFP_KERNEL);
 296         if (priv->firm == NULL) {
 297                 tuner_err("Not enough memory to load firmware file.\n");
 298                 rc = -ENOMEM;
 299                 goto err;
 300         }
 301         priv->firm_size = n_array;
 302
 303         n = -1;
 304         while (p < endp) {
 305                 __u32 type, size;
 306                 v4l2_std_id id;
 307                 __u16 int_freq = 0;
 308
 309                 n++;
 310                 if (n >= n_array) {
 311                         tuner_err("More firmware images in file than "
 312                                   "were expected!\n");
 313                         goto corrupt;
 314                 }
 315
 316                 /* Checks if there's enough bytes to read */
 317                 if (p + sizeof(type) + sizeof(id) + sizeof(size) > endp) {
 318                         tuner_err("Firmware header is incomplete!\n");
 319                         goto corrupt;
 320                 }
 321
 322                 type = le32_to_cpu(*(__u32 *) p);
 323                 p += sizeof(type);
 324
 325                 id = le64_to_cpu(*(v4l2_std_id *) p);
 326                 p += sizeof(id);
 327
 328                 if (type & HAS_IF) {
 329                         int_freq = le16_to_cpu(*(__u16 *) p);
 330                         p += sizeof(int_freq);
 331                 }
 332
 333                 size = le32_to_cpu(*(__u32 *) p);
 334                 p += sizeof(size);
 335
 336                 if ((!size) || (size + p > endp)) {
 337                         tuner_err("Firmware type ");
 338                         dump_firm_type(type);
 339                         printk("(%x), id %llx is corrupted "
 340                                "(size=%d, expected %d)\n",
 341                                type, (unsigned long long)id,
 342                                (unsigned)(endp - p), size);
 343                         goto corrupt;
 344                 }
 345
 346                 priv->firm[n].ptr = kzalloc(size, GFP_KERNEL);
 347                 if (priv->firm[n].ptr == NULL) {
 348                         tuner_err("Not enough memory to load firmware file.\n");
 349                         rc = -ENOMEM;
 350                         goto err;
 351                 }
 352                 tuner_dbg("Reading firmware type ");
 353                 if (debug) {
 354                         dump_firm_type_and_int_freq(type, int_freq);
 355                         printk("(%x), id %llx, size=%d.\n",
 356                                type, (unsigned long long)id, size);
 357                 }
 358
 359                 memcpy(priv->firm[n].ptr, p, size);
 360                 priv->firm[n].type = type;
 361                 priv->firm[n].id   = id;
 362                 priv->firm[n].size = size;
 363                 priv->firm[n].int_freq = int_freq;
 364
 365                 p += size;
 366         }
 367
 368         if (n + 1 != priv->firm_size) {
 369                 tuner_err("Firmware file is incomplete!\n");
 370                 goto corrupt;
 371         }
 372
 373         goto done;
 374
 375 corrupt:
 376         rc = -EINVAL;
 377         tuner_err("Error: firmware file is corrupted!\n");
 378
 379 err:
 380         tuner_info("Releasing partially loaded firmware file.\n");
 381         free_firmware(priv);
 382
 383 done:
 384         release_firmware(fw);
 385         if (rc == 0)
 386                 tuner_dbg("Firmware files loaded.\n");
 387
 388         return rc;
 389 }
 390
 391 static int seek_firmware(struct dvb_frontend *fe, unsigned int type,
 392                          v4l2_std_id *id)
 393 {
 394         struct xc2028_data *priv = fe->tuner_priv;
 395         int                 i, best_i = -1, best_nr_matches = 0;
 396         unsigned int        ign_firm_type_mask = 0;
 397
 398         tuner_dbg("%s called, want type=", __FUNCTION__);
 399         if (debug) {
 400                 dump_firm_type(type);
 401                 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
 402         }
 403
 404         if (!priv->firm) {
 405                 tuner_err("Error! firmware not loaded\n");
 406                 return -EINVAL;
 407         }
 408
 409         if (((type & ~SCODE) == 0) && (*id == 0))
 410                 *id = V4L2_STD_PAL;
 411
 412         if (type & BASE)
 413                 type &= BASE_TYPES;
 414         else if (type & SCODE) {
 415                 type &= SCODE_TYPES;
 416                 ign_firm_type_mask = HAS_IF;
 417         } else if (type & DTV_TYPES)
 418                 type &= DTV_TYPES;
 419         else if (type & STD_SPECIFIC_TYPES)
 420                 type &= STD_SPECIFIC_TYPES;
 421
 422         /* Seek for exact match */
 423         for (i = 0; i < priv->firm_size; i++) {
 424                 if ((type == (priv->firm[i].type & ~ign_firm_type_mask)) &&
 425                     (*id == priv->firm[i].id))
 426                         goto found;
 427         }
 428
 429         /* Seek for generic video standard match */
 430         for (i = 0; i < priv->firm_size; i++) {
 431                 v4l2_std_id match_mask;
 432                 int nr_matches;
 433
 434                 if (type != (priv->firm[i].type & ~ign_firm_type_mask))
 435                         continue;
 436
 437                 match_mask = *id & priv->firm[i].id;
 438                 if (!match_mask)
 439                         continue;
 440
 441                 if ((*id & match_mask) == *id)
 442                         goto found; /* Supports all the requested standards */
 443
 444                 nr_matches = hweight64(match_mask);
 445                 if (nr_matches > best_nr_matches) {
 446                         best_nr_matches = nr_matches;
 447                         best_i = i;
 448                 }
 449         }
 450
 451         if (best_nr_matches > 0) {
 452                 tuner_dbg("Selecting best matching firmware (%d bits) for "
 453                           "type=", best_nr_matches);
 454                 dump_firm_type(type);
 455                 printk("(%x), id %016llx:\n", type, (unsigned long long)*id);
 456                 i = best_i;
 457                 goto found;
 458         }
 459
 460         /*FIXME: Would make sense to seek for type "hint" match ? */
 461
 462         i = -ENOENT;
 463         goto ret;
 464
 465 found:
 466         *id = priv->firm[i].id;
 467
 468 ret:
 469         tuner_dbg("%s firmware for type=", (i < 0) ? "Can't find" : "Found");
 470         if (debug) {
 471                 dump_firm_type(type);
 472                 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
 473         }
 474         return i;
 475 }
 476
 477 static int load_firmware(struct dvb_frontend *fe, unsigned int type,
 478                          v4l2_std_id *id)
 479 {
 480         struct xc2028_data *priv = fe->tuner_priv;
 481         int                pos, rc;
 482         unsigned char      *p, *endp, buf[priv->ctrl.max_len];
 483
 484         tuner_dbg("%s called\n", __FUNCTION__);
 485
 486         pos = seek_firmware(fe, type, id);
 487         if (pos < 0)
 488                 return pos;
 489
 490         tuner_info("Loading firmware for type=");
 491         dump_firm_type(priv->firm[pos].type);
 492         printk("(%x), id %016llx.\n", priv->firm[pos].type,
 493                (unsigned long long)*id);
 494
 495         p = priv->firm[pos].ptr;
 496         endp = p + priv->firm[pos].size;
 497
 498         while (p < endp) {
 499                 __u16 size;
 500
 501                 /* Checks if there's enough bytes to read */
 502                 if (p + sizeof(size) > endp) {
 503                         tuner_err("Firmware chunk size is wrong\n");
 504                         return -EINVAL;
 505                 }
 506
 507                 size = le16_to_cpu(*(__u16 *) p);
 508                 p += sizeof(size);
 509
 510                 if (size == 0xffff)
 511                         return 0;
 512
 513                 if (!size) {
 514                         /* Special callback command received */
 515                         rc = priv->tuner_callback(priv->video_dev,
 516                                                   XC2028_TUNER_RESET, 0);
 517                         if (rc < 0) {
 518                                 tuner_err("Error at RESET code %d\n",
 519                                            (*p) & 0x7f);
 520                                 return -EINVAL;
 521                         }
 522                         continue;
 523                 }
 524                 if (size >= 0xff00) {
 525                         switch (size) {
 526                         case 0xff00:
 527                                 rc = priv->tuner_callback(priv->video_dev,
 528                                                         XC2028_RESET_CLK, 0);
 529                                 if (rc < 0) {
 530                                         tuner_err("Error at RESET code %d\n",
 531                                                   (*p) & 0x7f);
 532                                         return -EINVAL;
 533                                 }
 534                                 break;
 535                         default:
 536                                 tuner_info("Invalid RESET code %d\n",
 537                                            size & 0x7f);
 538                                 return -EINVAL;
 539
 540                         }
 541                         continue;
 542                 }
 543
 544                 /* Checks for a sleep command */
 545                 if (size & 0x8000) {
 546                         msleep(size & 0x7fff);
 547                         continue;
 548                 }
 549
 550                 if ((size + p > endp)) {
 551                         tuner_err("missing bytes: need %d, have %d\n",
 552                                    size, (int)(endp - p));
 553                         return -EINVAL;
 554                 }
 555
 556                 buf[0] = *p;
 557                 p++;
 558                 size--;
 559
 560                 /* Sends message chunks */
 561                 while (size > 0) {
 562                         int len = (size < priv->ctrl.max_len - 1) ?
 563                                    size : priv->ctrl.max_len - 1;
 564
 565                         memcpy(buf + 1, p, len);
 566
 567                         rc = i2c_send(priv, buf, len + 1);
 568                         if (rc < 0) {
 569                                 tuner_err("%d returned from send\n", rc);
 570                                 return -EINVAL;
 571                         }
 572
 573                         p += len;
 574                         size -= len;
 575                 }
 576         }
 577         return 0;
 578 }
 579
 580 static int load_scode(struct dvb_frontend *fe, unsigned int type,
 581                          v4l2_std_id *id, __u16 int_freq, int scode)
 582 {
 583         struct xc2028_data *priv = fe->tuner_priv;
 584         int                pos, rc;
 585         unsigned char      *p;
 586
 587         tuner_dbg("%s called\n", __FUNCTION__);
 588
 589         if (!int_freq) {
 590                 pos = seek_firmware(fe, type, id);
 591                 if (pos < 0)
 592                         return pos;
 593         } else {
 594                 for (pos = 0; pos < priv->firm_size; pos++) {
 595                         if ((priv->firm[pos].int_freq == int_freq) &&
 596                             (priv->firm[pos].type & HAS_IF))
 597                                 break;
 598                 }
 599                 if (pos == priv->firm_size)
 600                         return -ENOENT;
 601         }
 602
 603         p = priv->firm[pos].ptr;
 604
 605         if (priv->firm[pos].type & HAS_IF) {
 606                 if (priv->firm[pos].size != 12 * 16 || scode >= 16)
 607                         return -EINVAL;
 608                 p += 12 * scode;
 609         } else {
 610                 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
 611                  * has a 2-byte size header in the firmware format. */
 612                 if (priv->firm[pos].size != 14 * 16 || scode >= 16 ||
 613                     le16_to_cpu(*(__u16 *)(p + 14 * scode)) != 12)
 614                         return -EINVAL;
 615                 p += 14 * scode + 2;
 616         }
 617
 618         tuner_info("Loading SCODE for type=");
 619         dump_firm_type_and_int_freq(priv->firm[pos].type,
 620                                     priv->firm[pos].int_freq);
 621         printk("(%x), id %016llx.\n", priv->firm[pos].type,
 622                (unsigned long long)*id);
 623
 624         if (priv->firm_version < 0x0202)
 625                 rc = send_seq(priv, {0x20, 0x00, 0x00, 0x00});
 626         else
 627                 rc = send_seq(priv, {0xa0, 0x00, 0x00, 0x00});
 628         if (rc < 0)
 629                 return -EIO;
 630
 631         rc = i2c_send(priv, p, 12);
 632         if (rc < 0)
 633                 return -EIO;
 634
 635         rc = send_seq(priv, {0x00, 0x8c});
 636         if (rc < 0)
 637                 return -EIO;
 638
 639         return 0;
 640 }
 641
 642 static int check_firmware(struct dvb_frontend *fe, unsigned int type,
 643                           v4l2_std_id std, __u16 int_freq)
 644 {
 645         struct xc2028_data         *priv = fe->tuner_priv;
 646         struct firmware_properties new_fw;
 647         int                        rc = 0, is_retry = 0;
 648         u16                        version, hwmodel;
 649         v4l2_std_id                std0;
 650
 651         tuner_dbg("%s called\n", __FUNCTION__);
 652
 653         if (!priv->firm) {
 654                 if (!priv->ctrl.fname) {
 655                         tuner_info("xc2028/3028 firmware name not set!\n");
 656                         return -EINVAL;
 657                 }
 658
 659                 rc = load_all_firmwares(fe);
 660                 if (rc < 0)
 661                         return rc;
 662         }
 663
 664         if (priv->ctrl.mts && !(type & FM))
 665                 type |= MTS;
 666
 667 retry:
 668         new_fw.type = type;
 669         new_fw.id = std;
 670         new_fw.std_req = std;
 671         new_fw.scode_table = SCODE | priv->ctrl.scode_table;
 672         new_fw.scode_nr = 0;
 673         new_fw.int_freq = int_freq;
 674
 675         tuner_dbg("checking firmware, user requested type=");
 676         if (debug) {
 677                 dump_firm_type(new_fw.type);
 678                 printk("(%x), id %016llx, ", new_fw.type,
 679                        (unsigned long long)new_fw.std_req);
 680                 if (!int_freq) {
 681                         printk("scode_tbl ");
 682                         dump_firm_type(priv->ctrl.scode_table);
 683                         printk("(%x), ", priv->ctrl.scode_table);
 684                 } else
 685                         printk("int_freq %d, ", new_fw.int_freq);
 686                 printk("scode_nr %d\n", new_fw.scode_nr);
 687         }
 688
 689         /* No need to reload base firmware if it matches */
 690         if (((BASE | new_fw.type) & BASE_TYPES) ==
 691             (priv->cur_fw.type & BASE_TYPES)) {
 692                 tuner_dbg("BASE firmware not changed.\n");
 693                 goto skip_base;
 694         }
 695
 696         /* Updating BASE - forget about all currently loaded firmware */
 697         memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
 698
 699         /* Reset is needed before loading firmware */
 700         rc = priv->tuner_callback(priv->video_dev,
 701                                   XC2028_TUNER_RESET, 0);
 702         if (rc < 0)
 703                 goto fail;
 704
 705         /* BASE firmwares are all std0 */
 706         std0 = 0;
 707         rc = load_firmware(fe, BASE | new_fw.type, &std0);
 708         if (rc < 0) {
 709                 tuner_err("Error %d while loading base firmware\n",
 710                           rc);
 711                 goto fail;
 712         }
 713
 714         /* Load INIT1, if needed */
 715         tuner_dbg("Load init1 firmware, if exists\n");
 716
 717         rc = load_firmware(fe, BASE | INIT1 | new_fw.type, &std0);
 718         if (rc == -ENOENT)
 719                 rc = load_firmware(fe, (BASE | INIT1 | new_fw.type) & ~F8MHZ,
 720                                    &std0);
 721         if (rc < 0 && rc != -ENOENT) {
 722                 tuner_err("Error %d while loading init1 firmware\n",
 723                           rc);
 724                 goto fail;
 725         }
 726
 727 skip_base:
 728         /*
 729          * No need to reload standard specific firmware if base firmware
 730          * was not reloaded and requested video standards have not changed.
 731          */
 732         if (priv->cur_fw.type == (BASE | new_fw.type) &&
 733             priv->cur_fw.std_req == std) {
 734                 tuner_dbg("Std-specific firmware already loaded.\n");
 735                 goto skip_std_specific;
 736         }
 737
 738         /* Reloading std-specific firmware forces a SCODE update */
 739         priv->cur_fw.scode_table = 0;
 740
 741         rc = load_firmware(fe, new_fw.type, &new_fw.id);
 742         if (rc == -ENOENT)
 743                 rc = load_firmware(fe, new_fw.type & ~F8MHZ, &new_fw.id);
 744
 745         if (rc < 0)
 746                 goto fail;
 747
 748 skip_std_specific:
 749         if (priv->cur_fw.scode_table == new_fw.scode_table &&
 750             priv->cur_fw.scode_nr == new_fw.scode_nr) {
 751                 tuner_dbg("SCODE firmware already loaded.\n");
 752                 goto check_device;
 753         }
 754
 755         if (new_fw.type & FM)
 756                 goto check_device;
 757
 758         /* Load SCODE firmware, if exists */
 759         tuner_dbg("Trying to load scode %d\n", new_fw.scode_nr);
 760
 761         rc = load_scode(fe, new_fw.type | new_fw.scode_table, &new_fw.id,
 762                         new_fw.int_freq, new_fw.scode_nr);
 763
 764 check_device:
 765         if (xc2028_get_reg(priv, 0x0004, &version) < 0 ||
 766             xc2028_get_reg(priv, 0x0008, &hwmodel) < 0) {
 767                 tuner_err("Unable to read tuner registers.\n");
 768                 goto fail;
 769         }
 770
 771         tuner_info("Device is Xceive %d version %d.%d, "
 772                    "firmware version %d.%d\n",
 773                    hwmodel, (version & 0xf000) >> 12, (version & 0xf00) >> 8,
 774                    (version & 0xf0) >> 4, version & 0xf);
 775
 776         /* Check firmware version against what we downloaded. */
 777         if (priv->firm_version != ((version & 0xf0) << 4 | (version & 0x0f))) {
 778                 tuner_err("Incorrect readback of firmware version.\n");
 779                 goto fail;
 780         }
 781
 782         /* Check that the tuner hardware model remains consistent over time. */
 783         if (priv->hwmodel == 0 && (hwmodel == 2028 || hwmodel == 3028)) {
 784                 priv->hwmodel = hwmodel;
 785                 priv->hwvers  = version & 0xff00;
 786         } else if (priv->hwmodel == 0 || priv->hwmodel != hwmodel ||
 787                    priv->hwvers != (version & 0xff00)) {
 788                 tuner_err("Read invalid device hardware information - tuner "
 789                           "hung?\n");
 790                 goto fail;
 791         }
 792
 793         memcpy(&priv->cur_fw, &new_fw, sizeof(priv->cur_fw));
 794
 795         /*
 796          * By setting BASE in cur_fw.type only after successfully loading all
 797          * firmwares, we can:
 798          * 1. Identify that BASE firmware with type=0 has been loaded;
 799          * 2. Tell whether BASE firmware was just changed the next time through.
 800          */
 801         priv->cur_fw.type |= BASE;
 802
 803         return 0;
 804
 805 fail:
 806         memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
 807         if (!is_retry) {
 808                 msleep(50);
 809                 is_retry = 1;
 810                 tuner_dbg("Retrying firmware load\n");
 811                 goto retry;
 812         }
 813
 814         if (rc == -ENOENT)
 815                 rc = -EINVAL;
 816         return rc;
 817 }
 818
 819 static int xc2028_signal(struct dvb_frontend *fe, u16 *strength)
 820 {
 821         struct xc2028_data *priv = fe->tuner_priv;
 822         u16                 frq_lock, signal = 0;
 823         int                 rc;
 824
 825         tuner_dbg("%s called\n", __FUNCTION__);
 826
 827         mutex_lock(&priv->lock);
 828
 829         /* Sync Lock Indicator */
 830         rc = xc2028_get_reg(priv, 0x0002, &frq_lock);
 831         if (rc < 0 || frq_lock == 0)
 832                 goto ret;
 833
 834         /* Frequency is locked. Return signal quality */
 835
 836         /* Get SNR of the video signal */
 837         rc = xc2028_get_reg(priv, 0x0040, &signal);
 838         if (rc < 0)
 839                 signal = -frq_lock;
 840
 841 ret:
 842         mutex_unlock(&priv->lock);
 843
 844         *strength = signal;
 845
 846         return rc;
 847 }
 848
 849 #define DIV 15625
 850
 851 static int generic_set_freq(struct dvb_frontend *fe, u32 freq /* in HZ */,
 852                             enum tuner_mode new_mode,
 853                             unsigned int type,
 854                             v4l2_std_id std,
 855                             u16 int_freq)
 856 {
 857         struct xc2028_data *priv = fe->tuner_priv;
 858         int                rc = -EINVAL;
 859         unsigned char      buf[4];
 860         u32                div, offset = 0;
 861
 862         tuner_dbg("%s called\n", __FUNCTION__);
 863
 864         mutex_lock(&priv->lock);
 865
 866         tuner_dbg("should set frequency %d kHz\n", freq / 1000);
 867
 868         if (check_firmware(fe, type, std, int_freq) < 0)
 869                 goto ret;
 870
 871         /* On some cases xc2028 can disable video output, if
 872          * very weak signals are received. By sending a soft
 873          * reset, this is re-enabled. So, it is better to always
 874          * send a soft reset before changing channels, to be sure
 875          * that xc2028 will be in a safe state.
 876          * Maybe this might also be needed for DTV.
 877          */
 878         if (new_mode == T_ANALOG_TV) {
 879                 rc = send_seq(priv, {0x00, 0x00});
 880         } else if (priv->cur_fw.type & ATSC) {
 881                 offset = 1750000;
 882         } else {
 883                 offset = 2750000;
 884                 /*
 885                  * We must adjust the offset by 500kHz in two cases in order
 886                  * to correctly center the IF output:
 887                  * 1) When the ZARLINK456 or DIBCOM52 tables were explicitly
 888                  *    selected and a 7MHz channel is tuned;
 889                  * 2) When tuning a VHF channel with DTV78 firmware.
 890                  */
 891                 if (((priv->cur_fw.type & DTV7) &&
 892                      (priv->cur_fw.scode_table & (ZARLINK456 | DIBCOM52))) ||
 893                     ((priv->cur_fw.type & DTV78) && freq < 470000000))
 894                         offset -= 500000;
 895         }
 896
 897         div = (freq - offset + DIV / 2) / DIV;
 898
 899         /* CMD= Set frequency */
 900         if (priv->firm_version < 0x0202)
 901                 rc = send_seq(priv, {0x00, 0x02, 0x00, 0x00});
 902         else
 903                 rc = send_seq(priv, {0x80, 0x02, 0x00, 0x00});
 904         if (rc < 0)
 905                 goto ret;
 906
 907         rc = priv->tuner_callback(priv->video_dev, XC2028_RESET_CLK, 1);
 908         if (rc < 0)
 909                 goto ret;
 910
 911         msleep(10);
 912
 913         buf[0] = 0xff & (div >> 24);
 914         buf[1] = 0xff & (div >> 16);
 915         buf[2] = 0xff & (div >> 8);
 916         buf[3] = 0xff & (div);
 917
 918         rc = i2c_send(priv, buf, sizeof(buf));
 919         if (rc < 0)
 920                 goto ret;
 921         msleep(100);
 922
 923         priv->frequency = freq;
 924
 925         tuner_dbg("divisor= %02x %02x %02x %02x (freq=%d.%03d)\n",
 926                buf[0], buf[1], buf[2], buf[3],
 927                freq / 1000000, (freq % 1000000) / 1000);
 928
 929         rc = 0;
 930
 931 ret:
 932         mutex_unlock(&priv->lock);
 933
 934         return rc;
 935 }
 936
 937 static int xc2028_set_analog_freq(struct dvb_frontend *fe,
 938                               struct analog_parameters *p)
 939 {
 940         struct xc2028_data *priv = fe->tuner_priv;
 941         unsigned int       type=0;
 942
 943         tuner_dbg("%s called\n", __FUNCTION__);
 944
 945         if (p->mode == V4L2_TUNER_RADIO) {
 946                 type |= FM;
 947                 if (priv->ctrl.input1)
 948                         type |= INPUT1;
 949                 return generic_set_freq(fe, (625l * p->frequency) / 10,
 950                                 T_ANALOG_TV, type, 0, 0);
 951         }
 952
 953         /* if std is not defined, choose one */
 954         if (!p->std)
 955                 p->std = V4L2_STD_MN;
 956
 957         /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
 958         if (!(p->std & V4L2_STD_MN))
 959                 type |= F8MHZ;
 960
 961         /* Add audio hack to std mask */
 962         p->std |= parse_audio_std_option();
 963
 964         return generic_set_freq(fe, 62500l * p->frequency,
 965                                 T_ANALOG_TV, type, p->std, 0);
 966 }
 967
 968 static int xc2028_set_params(struct dvb_frontend *fe,
 969                              struct dvb_frontend_parameters *p)
 970 {
 971         struct xc2028_data *priv = fe->tuner_priv;
 972         unsigned int       type=0;
 973         fe_bandwidth_t     bw = BANDWIDTH_8_MHZ;
 974         u16                demod = 0;
 975
 976         tuner_dbg("%s called\n", __FUNCTION__);
 977
 978         if (priv->ctrl.d2633)
 979                 type |= D2633;
 980         else
 981                 type |= D2620;
 982
 983         switch(fe->ops.info.type) {
 984         case FE_OFDM:
 985                 bw = p->u.ofdm.bandwidth;
 986                 break;
 987         case FE_QAM:
 988                 tuner_info("WARN: There are some reports that "
 989                            "QAM 6 MHz doesn't work.\n"
 990                            "If this works for you, please report by "
 991                            "e-mail to: v4l-dvb-maintainer@linuxtv.org\n");
 992                 bw = BANDWIDTH_6_MHZ;
 993                 type |= QAM;
 994                 break;
 995         case FE_ATSC:
 996                 bw = BANDWIDTH_6_MHZ;
 997                 /* The only ATSC firmware (at least on v2.7) is D2633,
 998                    so overrides ctrl->d2633 */
 999                 type |= ATSC| D2633;
1000                 type &= ~D2620;
1001                 break;
1002         /* DVB-S is not supported */
1003         default:
1004                 return -EINVAL;
1005         }
1006
1007         switch (bw) {
1008         case BANDWIDTH_8_MHZ:
1009                 if (p->frequency < 470000000)
1010                         priv->ctrl.vhfbw7 = 0;
1011                 else
1012                         priv->ctrl.uhfbw8 = 1;
1013                 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV8;
1014                 type |= F8MHZ;
1015                 break;
1016         case BANDWIDTH_7_MHZ:
1017                 if (p->frequency < 470000000)
1018                         priv->ctrl.vhfbw7 = 1;
1019                 else
1020                         priv->ctrl.uhfbw8 = 0;
1021                 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV7;
1022                 type |= F8MHZ;
1023                 break;
1024         case BANDWIDTH_6_MHZ:
1025                 type |= DTV6;
1026                 priv->ctrl.vhfbw7 = 0;
1027                 priv->ctrl.uhfbw8 = 0;
1028                 break;
1029         default:
1030                 tuner_err("error: bandwidth not supported.\n");
1031         };
1032
1033         /* All S-code tables need a 200kHz shift */
1034         if (priv->ctrl.demod)
1035                 demod = priv->ctrl.demod + 200;
1036
1037         return generic_set_freq(fe, p->frequency,
1038                                 T_DIGITAL_TV, type, 0, demod);
1039 }
1040
1041 static int xc2028_sleep(struct dvb_frontend *fe)
1042 {
1043         struct xc2028_data *priv = fe->tuner_priv;
1044         int rc = 0;
1045
1046         tuner_dbg("%s called\n", __FUNCTION__);
1047
1048         mutex_lock(&priv->lock);
1049
1050         if (priv->firm_version < 0x0202)
1051                 rc = send_seq(priv, {0x00, 0x08, 0x00, 0x00});
1052         else
1053                 rc = send_seq(priv, {0x80, 0x08, 0x00, 0x00});
1054
1055         priv->cur_fw.type = 0;  /* need firmware reload */
1056
1057         mutex_unlock(&priv->lock);
1058
1059         return rc;
1060 }
1061
1062
1063 static int xc2028_dvb_release(struct dvb_frontend *fe)
1064 {
1065         struct xc2028_data *priv = fe->tuner_priv;
1066
1067         tuner_dbg("%s called\n", __FUNCTION__);
1068
1069         mutex_lock(&xc2028_list_mutex);
1070
1071         priv->count--;
1072
1073         if (!priv->count) {
1074                 list_del(&priv->xc2028_list);
1075
1076                 kfree(priv->ctrl.fname);
1077
1078                 free_firmware(priv);
1079                 kfree(priv);
1080                 fe->tuner_priv = NULL;
1081         }
1082
1083         mutex_unlock(&xc2028_list_mutex);
1084
1085         return 0;
1086 }
1087
1088 static int xc2028_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1089 {
1090         struct xc2028_data *priv = fe->tuner_priv;
1091
1092         tuner_dbg("%s called\n", __FUNCTION__);
1093
1094         *frequency = priv->frequency;
1095
1096         return 0;
1097 }
1098
1099 static int xc2028_set_config(struct dvb_frontend *fe, void *priv_cfg)
1100 {
1101         struct xc2028_data *priv = fe->tuner_priv;
1102         struct xc2028_ctrl *p    = priv_cfg;
1103         int                 rc   = 0;
1104
1105         tuner_dbg("%s called\n", __FUNCTION__);
1106
1107         mutex_lock(&priv->lock);
1108
1109         kfree(priv->ctrl.fname);
1110         free_firmware(priv);
1111
1112         memcpy(&priv->ctrl, p, sizeof(priv->ctrl));
1113         priv->ctrl.fname = NULL;
1114
1115         if (p->fname) {
1116                 priv->ctrl.fname = kstrdup(p->fname, GFP_KERNEL);
1117                 if (priv->ctrl.fname == NULL)
1118                         rc = -ENOMEM;
1119         }
1120
1121         if (priv->ctrl.max_len < 9)
1122                 priv->ctrl.max_len = 13;
1123
1124         mutex_unlock(&priv->lock);
1125
1126         return rc;
1127 }
1128
1129 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops = {
1130         .info = {
1131                  .name = "Xceive XC3028",
1132                  .frequency_min = 42000000,
1133                  .frequency_max = 864000000,
1134                  .frequency_step = 50000,
1135                  },
1136
1137         .set_config        = xc2028_set_config,
1138         .set_analog_params = xc2028_set_analog_freq,
1139         .release           = xc2028_dvb_release,
1140         .get_frequency     = xc2028_get_frequency,
1141         .get_rf_strength   = xc2028_signal,
1142         .set_params        = xc2028_set_params,
1143         .sleep             = xc2028_sleep,
1144
1145 };
1146
1147 struct dvb_frontend *xc2028_attach(struct dvb_frontend *fe,
1148                                    struct xc2028_config *cfg)
1149 {
1150         struct xc2028_data *priv;
1151         void               *video_dev;
1152
1153         if (debug)
1154                 printk(KERN_DEBUG "xc2028: Xcv2028/3028 init called!\n");
1155
1156         if (NULL == cfg || NULL == cfg->video_dev)
1157                 return NULL;
1158
1159         if (!fe) {
1160                 printk(KERN_ERR "xc2028: No frontend!\n");
1161                 return NULL;
1162         }
1163
1164         video_dev = cfg->video_dev;
1165
1166         mutex_lock(&xc2028_list_mutex);
1167
1168         list_for_each_entry(priv, &xc2028_list, xc2028_list) {
1169                 if (priv->video_dev == cfg->video_dev) {
1170                         video_dev = NULL;
1171                         break;
1172                 }
1173         }
1174
1175         if (video_dev) {
1176                 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1177                 if (priv == NULL) {
1178                         mutex_unlock(&xc2028_list_mutex);
1179                         return NULL;
1180                 }
1181
1182                 priv->i2c_props.addr = cfg->i2c_addr;
1183                 priv->i2c_props.adap = cfg->i2c_adap;
1184                 priv->i2c_props.name = "xc2028";
1185
1186                 priv->video_dev = video_dev;
1187                 priv->tuner_callback = cfg->callback;
1188                 priv->ctrl.max_len = 13;
1189
1190                 mutex_init(&priv->lock);
1191
1192                 list_add_tail(&priv->xc2028_list, &xc2028_list);
1193         }
1194
1195         fe->tuner_priv = priv;
1196         priv->count++;
1197
1198         memcpy(&fe->ops.tuner_ops, &xc2028_dvb_tuner_ops,
1199                sizeof(xc2028_dvb_tuner_ops));
1200
1201         tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1202
1203         if (cfg->ctrl)
1204                 xc2028_set_config(fe, cfg->ctrl);
1205
1206         mutex_unlock(&xc2028_list_mutex);
1207
1208         return fe;
1209 }
1210
1211 EXPORT_SYMBOL(xc2028_attach);
1212
1213 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1214 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1215 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
1216 MODULE_LICENSE("GPL");