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