Pileus Git - ~andy/linux/blob - drivers/media/tuners/tuner-xc2028.c

   1 /* tuner-xc2028
   2  *
   3  * Copyright (c) 2007-2008 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 <linux/slab.h>
  19 #include <asm/unaligned.h>
  20 #include "tuner-i2c.h"
  21 #include "tuner-xc2028.h"
  22 #include "tuner-xc2028-types.h"
  23
  24 #include <linux/dvb/frontend.h>
  25 #include "dvb_frontend.h"
  26
  27 /* Max transfer size done by I2C transfer functions */
  28 #define MAX_XFER_SIZE  80
  29
  30 /* Registers (Write-only) */
  31 #define XREG_INIT         0x00
  32 #define XREG_RF_FREQ      0x02
  33 #define XREG_POWER_DOWN   0x08
  34
  35 /* Registers (Read-only) */
  36 #define XREG_FREQ_ERROR   0x01
  37 #define XREG_LOCK         0x02
  38 #define XREG_VERSION      0x04
  39 #define XREG_PRODUCT_ID   0x08
  40 #define XREG_HSYNC_FREQ   0x10
  41 #define XREG_FRAME_LINES  0x20
  42 #define XREG_SNR          0x40
  43
  44 #define XREG_ADC_ENV      0x0100
  45
  46 static int debug;
  47 module_param(debug, int, 0644);
  48 MODULE_PARM_DESC(debug, "enable verbose debug messages");
  49
  50 static int no_poweroff;
  51 module_param(no_poweroff, int, 0644);
  52 MODULE_PARM_DESC(no_poweroff, "0 (default) powers device off when not used.\n"
  53         "1 keep device energized and with tuner ready all the times.\n"
  54         "  Faster, but consumes more power and keeps the device hotter\n");
  55
  56 static char audio_std[8];
  57 module_param_string(audio_std, audio_std, sizeof(audio_std), 0);
  58 MODULE_PARM_DESC(audio_std,
  59         "Audio standard. XC3028 audio decoder explicitly "
  60         "needs to know what audio\n"
  61         "standard is needed for some video standards with audio A2 or NICAM.\n"
  62         "The valid values are:\n"
  63         "A2\n"
  64         "A2/A\n"
  65         "A2/B\n"
  66         "NICAM\n"
  67         "NICAM/A\n"
  68         "NICAM/B\n");
  69
  70 static char firmware_name[30];
  71 module_param_string(firmware_name, firmware_name, sizeof(firmware_name), 0);
  72 MODULE_PARM_DESC(firmware_name, "Firmware file name. Allows overriding the "
  73                                 "default firmware name\n");
  74
  75 static LIST_HEAD(hybrid_tuner_instance_list);
  76 static DEFINE_MUTEX(xc2028_list_mutex);
  77
  78 /* struct for storing firmware table */
  79 struct firmware_description {
  80         unsigned int  type;
  81         v4l2_std_id   id;
  82         __u16         int_freq;
  83         unsigned char *ptr;
  84         unsigned int  size;
  85 };
  86
  87 struct firmware_properties {
  88         unsigned int    type;
  89         v4l2_std_id     id;
  90         v4l2_std_id     std_req;
  91         __u16           int_freq;
  92         unsigned int    scode_table;
  93         int             scode_nr;
  94 };
  95
  96 enum xc2028_state {
  97         XC2028_NO_FIRMWARE = 0,
  98         XC2028_WAITING_FIRMWARE,
  99         XC2028_ACTIVE,
 100         XC2028_SLEEP,
 101         XC2028_NODEV,
 102 };
 103
 104 struct xc2028_data {
 105         struct list_head        hybrid_tuner_instance_list;
 106         struct tuner_i2c_props  i2c_props;
 107         __u32                   frequency;
 108
 109         enum xc2028_state       state;
 110         const char              *fname;
 111
 112         struct firmware_description *firm;
 113         int                     firm_size;
 114         __u16                   firm_version;
 115
 116         __u16                   hwmodel;
 117         __u16                   hwvers;
 118
 119         struct xc2028_ctrl      ctrl;
 120
 121         struct firmware_properties cur_fw;
 122
 123         struct mutex lock;
 124 };
 125
 126 #define i2c_send(priv, buf, size) ({                                    \
 127         int _rc;                                                        \
 128         _rc = tuner_i2c_xfer_send(&priv->i2c_props, buf, size);         \
 129         if (size != _rc)                                                \
 130                 tuner_info("i2c output error: rc = %d (should be %d)\n",\
 131                            _rc, (int)size);                             \
 132         if (priv->ctrl.msleep)                                          \
 133                 msleep(priv->ctrl.msleep);                              \
 134         _rc;                                                            \
 135 })
 136
 137 #define i2c_send_recv(priv, obuf, osize, ibuf, isize) ({                \
 138         int _rc;                                                        \
 139         _rc = tuner_i2c_xfer_send_recv(&priv->i2c_props, obuf, osize,   \
 140                                        ibuf, isize);                    \
 141         if (isize != _rc)                                               \
 142                 tuner_err("i2c input error: rc = %d (should be %d)\n",  \
 143                            _rc, (int)isize);                            \
 144         if (priv->ctrl.msleep)                                          \
 145                 msleep(priv->ctrl.msleep);                              \
 146         _rc;                                                            \
 147 })
 148
 149 #define send_seq(priv, data...) ({                                      \
 150         static u8 _val[] = data;                                        \
 151         int _rc;                                                        \
 152         if (sizeof(_val) !=                                             \
 153                         (_rc = tuner_i2c_xfer_send(&priv->i2c_props,    \
 154                                                 _val, sizeof(_val)))) { \
 155                 tuner_err("Error on line %d: %d\n", __LINE__, _rc);     \
 156         } else if (priv->ctrl.msleep)                                   \
 157                 msleep(priv->ctrl.msleep);                              \
 158         _rc;                                                            \
 159 })
 160
 161 static int xc2028_get_reg(struct xc2028_data *priv, u16 reg, u16 *val)
 162 {
 163         unsigned char buf[2];
 164         unsigned char ibuf[2];
 165
 166         tuner_dbg("%s %04x called\n", __func__, reg);
 167
 168         buf[0] = reg >> 8;
 169         buf[1] = (unsigned char) reg;
 170
 171         if (i2c_send_recv(priv, buf, 2, ibuf, 2) != 2)
 172                 return -EIO;
 173
 174         *val = (ibuf[1]) | (ibuf[0] << 8);
 175         return 0;
 176 }
 177
 178 #define dump_firm_type(t)       dump_firm_type_and_int_freq(t, 0)
 179 static void dump_firm_type_and_int_freq(unsigned int type, u16 int_freq)
 180 {
 181          if (type & BASE)
 182                 printk("BASE ");
 183          if (type & INIT1)
 184                 printk("INIT1 ");
 185          if (type & F8MHZ)
 186                 printk("F8MHZ ");
 187          if (type & MTS)
 188                 printk("MTS ");
 189          if (type & D2620)
 190                 printk("D2620 ");
 191          if (type & D2633)
 192                 printk("D2633 ");
 193          if (type & DTV6)
 194                 printk("DTV6 ");
 195          if (type & QAM)
 196                 printk("QAM ");
 197          if (type & DTV7)
 198                 printk("DTV7 ");
 199          if (type & DTV78)
 200                 printk("DTV78 ");
 201          if (type & DTV8)
 202                 printk("DTV8 ");
 203          if (type & FM)
 204                 printk("FM ");
 205          if (type & INPUT1)
 206                 printk("INPUT1 ");
 207          if (type & LCD)
 208                 printk("LCD ");
 209          if (type & NOGD)
 210                 printk("NOGD ");
 211          if (type & MONO)
 212                 printk("MONO ");
 213          if (type & ATSC)
 214                 printk("ATSC ");
 215          if (type & IF)
 216                 printk("IF ");
 217          if (type & LG60)
 218                 printk("LG60 ");
 219          if (type & ATI638)
 220                 printk("ATI638 ");
 221          if (type & OREN538)
 222                 printk("OREN538 ");
 223          if (type & OREN36)
 224                 printk("OREN36 ");
 225          if (type & TOYOTA388)
 226                 printk("TOYOTA388 ");
 227          if (type & TOYOTA794)
 228                 printk("TOYOTA794 ");
 229          if (type & DIBCOM52)
 230                 printk("DIBCOM52 ");
 231          if (type & ZARLINK456)
 232                 printk("ZARLINK456 ");
 233          if (type & CHINA)
 234                 printk("CHINA ");
 235          if (type & F6MHZ)
 236                 printk("F6MHZ ");
 237          if (type & INPUT2)
 238                 printk("INPUT2 ");
 239          if (type & SCODE)
 240                 printk("SCODE ");
 241          if (type & HAS_IF)
 242                 printk("HAS_IF_%d ", int_freq);
 243 }
 244
 245 static  v4l2_std_id parse_audio_std_option(void)
 246 {
 247         if (strcasecmp(audio_std, "A2") == 0)
 248                 return V4L2_STD_A2;
 249         if (strcasecmp(audio_std, "A2/A") == 0)
 250                 return V4L2_STD_A2_A;
 251         if (strcasecmp(audio_std, "A2/B") == 0)
 252                 return V4L2_STD_A2_B;
 253         if (strcasecmp(audio_std, "NICAM") == 0)
 254                 return V4L2_STD_NICAM;
 255         if (strcasecmp(audio_std, "NICAM/A") == 0)
 256                 return V4L2_STD_NICAM_A;
 257         if (strcasecmp(audio_std, "NICAM/B") == 0)
 258                 return V4L2_STD_NICAM_B;
 259
 260         return 0;
 261 }
 262
 263 static int check_device_status(struct xc2028_data *priv)
 264 {
 265         switch (priv->state) {
 266         case XC2028_NO_FIRMWARE:
 267         case XC2028_WAITING_FIRMWARE:
 268                 return -EAGAIN;
 269         case XC2028_ACTIVE:
 270         case XC2028_SLEEP:
 271                 return 0;
 272         case XC2028_NODEV:
 273                 return -ENODEV;
 274         }
 275         return 0;
 276 }
 277
 278 static void free_firmware(struct xc2028_data *priv)
 279 {
 280         int i;
 281         tuner_dbg("%s called\n", __func__);
 282
 283         if (!priv->firm)
 284                 return;
 285
 286         for (i = 0; i < priv->firm_size; i++)
 287                 kfree(priv->firm[i].ptr);
 288
 289         kfree(priv->firm);
 290
 291         priv->firm = NULL;
 292         priv->firm_size = 0;
 293         priv->state = XC2028_NO_FIRMWARE;
 294
 295         memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
 296 }
 297
 298 static int load_all_firmwares(struct dvb_frontend *fe,
 299                               const struct firmware *fw)
 300 {
 301         struct xc2028_data    *priv = fe->tuner_priv;
 302         const unsigned char   *p, *endp;
 303         int                   rc = 0;
 304         int                   n, n_array;
 305         char                  name[33];
 306
 307         tuner_dbg("%s called\n", __func__);
 308
 309         p = fw->data;
 310         endp = p + fw->size;
 311
 312         if (fw->size < sizeof(name) - 1 + 2 + 2) {
 313                 tuner_err("Error: firmware file %s has invalid size!\n",
 314                           priv->fname);
 315                 goto corrupt;
 316         }
 317
 318         memcpy(name, p, sizeof(name) - 1);
 319         name[sizeof(name) - 1] = 0;
 320         p += sizeof(name) - 1;
 321
 322         priv->firm_version = get_unaligned_le16(p);
 323         p += 2;
 324
 325         n_array = get_unaligned_le16(p);
 326         p += 2;
 327
 328         tuner_info("Loading %d firmware images from %s, type: %s, ver %d.%d\n",
 329                    n_array, priv->fname, name,
 330                    priv->firm_version >> 8, priv->firm_version & 0xff);
 331
 332         priv->firm = kcalloc(n_array, sizeof(*priv->firm), GFP_KERNEL);
 333         if (priv->firm == NULL) {
 334                 tuner_err("Not enough memory to load firmware file.\n");
 335                 rc = -ENOMEM;
 336                 goto err;
 337         }
 338         priv->firm_size = n_array;
 339
 340         n = -1;
 341         while (p < endp) {
 342                 __u32 type, size;
 343                 v4l2_std_id id;
 344                 __u16 int_freq = 0;
 345
 346                 n++;
 347                 if (n >= n_array) {
 348                         tuner_err("More firmware images in file than "
 349                                   "were expected!\n");
 350                         goto corrupt;
 351                 }
 352
 353                 /* Checks if there's enough bytes to read */
 354                 if (endp - p < sizeof(type) + sizeof(id) + sizeof(size))
 355                         goto header;
 356
 357                 type = get_unaligned_le32(p);
 358                 p += sizeof(type);
 359
 360                 id = get_unaligned_le64(p);
 361                 p += sizeof(id);
 362
 363                 if (type & HAS_IF) {
 364                         int_freq = get_unaligned_le16(p);
 365                         p += sizeof(int_freq);
 366                         if (endp - p < sizeof(size))
 367                                 goto header;
 368                 }
 369
 370                 size = get_unaligned_le32(p);
 371                 p += sizeof(size);
 372
 373                 if (!size || size > endp - p) {
 374                         tuner_err("Firmware type ");
 375                         dump_firm_type(type);
 376                         printk("(%x), id %llx is corrupted "
 377                                "(size=%d, expected %d)\n",
 378                                type, (unsigned long long)id,
 379                                (unsigned)(endp - p), size);
 380                         goto corrupt;
 381                 }
 382
 383                 priv->firm[n].ptr = kzalloc(size, GFP_KERNEL);
 384                 if (priv->firm[n].ptr == NULL) {
 385                         tuner_err("Not enough memory to load firmware file.\n");
 386                         rc = -ENOMEM;
 387                         goto err;
 388                 }
 389                 tuner_dbg("Reading firmware type ");
 390                 if (debug) {
 391                         dump_firm_type_and_int_freq(type, int_freq);
 392                         printk("(%x), id %llx, size=%d.\n",
 393                                type, (unsigned long long)id, size);
 394                 }
 395
 396                 memcpy(priv->firm[n].ptr, p, size);
 397                 priv->firm[n].type = type;
 398                 priv->firm[n].id   = id;
 399                 priv->firm[n].size = size;
 400                 priv->firm[n].int_freq = int_freq;
 401
 402                 p += size;
 403         }
 404
 405         if (n + 1 != priv->firm_size) {
 406                 tuner_err("Firmware file is incomplete!\n");
 407                 goto corrupt;
 408         }
 409
 410         goto done;
 411
 412 header:
 413         tuner_err("Firmware header is incomplete!\n");
 414 corrupt:
 415         rc = -EINVAL;
 416         tuner_err("Error: firmware file is corrupted!\n");
 417
 418 err:
 419         tuner_info("Releasing partially loaded firmware file.\n");
 420         free_firmware(priv);
 421
 422 done:
 423         if (rc == 0)
 424                 tuner_dbg("Firmware files loaded.\n");
 425         else
 426                 priv->state = XC2028_NODEV;
 427
 428         return rc;
 429 }
 430
 431 static int seek_firmware(struct dvb_frontend *fe, unsigned int type,
 432                          v4l2_std_id *id)
 433 {
 434         struct xc2028_data *priv = fe->tuner_priv;
 435         int                 i, best_i = -1, best_nr_matches = 0;
 436         unsigned int        type_mask = 0;
 437
 438         tuner_dbg("%s called, want type=", __func__);
 439         if (debug) {
 440                 dump_firm_type(type);
 441                 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
 442         }
 443
 444         if (!priv->firm) {
 445                 tuner_err("Error! firmware not loaded\n");
 446                 return -EINVAL;
 447         }
 448
 449         if (((type & ~SCODE) == 0) && (*id == 0))
 450                 *id = V4L2_STD_PAL;
 451
 452         if (type & BASE)
 453                 type_mask = BASE_TYPES;
 454         else if (type & SCODE) {
 455                 type &= SCODE_TYPES;
 456                 type_mask = SCODE_TYPES & ~HAS_IF;
 457         } else if (type & DTV_TYPES)
 458                 type_mask = DTV_TYPES;
 459         else if (type & STD_SPECIFIC_TYPES)
 460                 type_mask = STD_SPECIFIC_TYPES;
 461
 462         type &= type_mask;
 463
 464         if (!(type & SCODE))
 465                 type_mask = ~0;
 466
 467         /* Seek for exact match */
 468         for (i = 0; i < priv->firm_size; i++) {
 469                 if ((type == (priv->firm[i].type & type_mask)) &&
 470                     (*id == priv->firm[i].id))
 471                         goto found;
 472         }
 473
 474         /* Seek for generic video standard match */
 475         for (i = 0; i < priv->firm_size; i++) {
 476                 v4l2_std_id match_mask;
 477                 int nr_matches;
 478
 479                 if (type != (priv->firm[i].type & type_mask))
 480                         continue;
 481
 482                 match_mask = *id & priv->firm[i].id;
 483                 if (!match_mask)
 484                         continue;
 485
 486                 if ((*id & match_mask) == *id)
 487                         goto found; /* Supports all the requested standards */
 488
 489                 nr_matches = hweight64(match_mask);
 490                 if (nr_matches > best_nr_matches) {
 491                         best_nr_matches = nr_matches;
 492                         best_i = i;
 493                 }
 494         }
 495
 496         if (best_nr_matches > 0) {
 497                 tuner_dbg("Selecting best matching firmware (%d bits) for "
 498                           "type=", best_nr_matches);
 499                 dump_firm_type(type);
 500                 printk("(%x), id %016llx:\n", type, (unsigned long long)*id);
 501                 i = best_i;
 502                 goto found;
 503         }
 504
 505         /*FIXME: Would make sense to seek for type "hint" match ? */
 506
 507         i = -ENOENT;
 508         goto ret;
 509
 510 found:
 511         *id = priv->firm[i].id;
 512
 513 ret:
 514         tuner_dbg("%s firmware for type=", (i < 0) ? "Can't find" : "Found");
 515         if (debug) {
 516                 dump_firm_type(type);
 517                 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
 518         }
 519         return i;
 520 }
 521
 522 static inline int do_tuner_callback(struct dvb_frontend *fe, int cmd, int arg)
 523 {
 524         struct xc2028_data *priv = fe->tuner_priv;
 525
 526         /* analog side (tuner-core) uses i2c_adap->algo_data.
 527          * digital side is not guaranteed to have algo_data defined.
 528          *
 529          * digital side will always have fe->dvb defined.
 530          * analog side (tuner-core) doesn't (yet) define fe->dvb.
 531          */
 532
 533         return (!fe->callback) ? -EINVAL :
 534                 fe->callback(((fe->dvb) && (fe->dvb->priv)) ?
 535                                 fe->dvb->priv : priv->i2c_props.adap->algo_data,
 536                              DVB_FRONTEND_COMPONENT_TUNER, cmd, arg);
 537 }
 538
 539 static int load_firmware(struct dvb_frontend *fe, unsigned int type,
 540                          v4l2_std_id *id)
 541 {
 542         struct xc2028_data *priv = fe->tuner_priv;
 543         int                pos, rc;
 544         unsigned char      *p, *endp, buf[MAX_XFER_SIZE];
 545
 546         if (priv->ctrl.max_len > sizeof(buf))
 547                 priv->ctrl.max_len = sizeof(buf);
 548
 549         tuner_dbg("%s called\n", __func__);
 550
 551         pos = seek_firmware(fe, type, id);
 552         if (pos < 0)
 553                 return pos;
 554
 555         tuner_info("Loading firmware for type=");
 556         dump_firm_type(priv->firm[pos].type);
 557         printk("(%x), id %016llx.\n", priv->firm[pos].type,
 558                (unsigned long long)*id);
 559
 560         p = priv->firm[pos].ptr;
 561         endp = p + priv->firm[pos].size;
 562
 563         while (p < endp) {
 564                 __u16 size;
 565
 566                 /* Checks if there's enough bytes to read */
 567                 if (p + sizeof(size) > endp) {
 568                         tuner_err("Firmware chunk size is wrong\n");
 569                         return -EINVAL;
 570                 }
 571
 572                 size = le16_to_cpu(*(__le16 *) p);
 573                 p += sizeof(size);
 574
 575                 if (size == 0xffff)
 576                         return 0;
 577
 578                 if (!size) {
 579                         /* Special callback command received */
 580                         rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
 581                         if (rc < 0) {
 582                                 tuner_err("Error at RESET code %d\n",
 583                                            (*p) & 0x7f);
 584                                 return -EINVAL;
 585                         }
 586                         continue;
 587                 }
 588                 if (size >= 0xff00) {
 589                         switch (size) {
 590                         case 0xff00:
 591                                 rc = do_tuner_callback(fe, XC2028_RESET_CLK, 0);
 592                                 if (rc < 0) {
 593                                         tuner_err("Error at RESET code %d\n",
 594                                                   (*p) & 0x7f);
 595                                         return -EINVAL;
 596                                 }
 597                                 break;
 598                         default:
 599                                 tuner_info("Invalid RESET code %d\n",
 600                                            size & 0x7f);
 601                                 return -EINVAL;
 602
 603                         }
 604                         continue;
 605                 }
 606
 607                 /* Checks for a sleep command */
 608                 if (size & 0x8000) {
 609                         msleep(size & 0x7fff);
 610                         continue;
 611                 }
 612
 613                 if ((size + p > endp)) {
 614                         tuner_err("missing bytes: need %d, have %d\n",
 615                                    size, (int)(endp - p));
 616                         return -EINVAL;
 617                 }
 618
 619                 buf[0] = *p;
 620                 p++;
 621                 size--;
 622
 623                 /* Sends message chunks */
 624                 while (size > 0) {
 625                         int len = (size < priv->ctrl.max_len - 1) ?
 626                                    size : priv->ctrl.max_len - 1;
 627
 628                         memcpy(buf + 1, p, len);
 629
 630                         rc = i2c_send(priv, buf, len + 1);
 631                         if (rc < 0) {
 632                                 tuner_err("%d returned from send\n", rc);
 633                                 return -EINVAL;
 634                         }
 635
 636                         p += len;
 637                         size -= len;
 638                 }
 639
 640                 /* silently fail if the frontend doesn't support I2C flush */
 641                 rc = do_tuner_callback(fe, XC2028_I2C_FLUSH, 0);
 642                 if ((rc < 0) && (rc != -EINVAL)) {
 643                         tuner_err("error executing flush: %d\n", rc);
 644                         return rc;
 645                 }
 646         }
 647         return 0;
 648 }
 649
 650 static int load_scode(struct dvb_frontend *fe, unsigned int type,
 651                          v4l2_std_id *id, __u16 int_freq, int scode)
 652 {
 653         struct xc2028_data *priv = fe->tuner_priv;
 654         int                pos, rc;
 655         unsigned char      *p;
 656
 657         tuner_dbg("%s called\n", __func__);
 658
 659         if (!int_freq) {
 660                 pos = seek_firmware(fe, type, id);
 661                 if (pos < 0)
 662                         return pos;
 663         } else {
 664                 for (pos = 0; pos < priv->firm_size; pos++) {
 665                         if ((priv->firm[pos].int_freq == int_freq) &&
 666                             (priv->firm[pos].type & HAS_IF))
 667                                 break;
 668                 }
 669                 if (pos == priv->firm_size)
 670                         return -ENOENT;
 671         }
 672
 673         p = priv->firm[pos].ptr;
 674
 675         if (priv->firm[pos].type & HAS_IF) {
 676                 if (priv->firm[pos].size != 12 * 16 || scode >= 16)
 677                         return -EINVAL;
 678                 p += 12 * scode;
 679         } else {
 680                 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
 681                  * has a 2-byte size header in the firmware format. */
 682                 if (priv->firm[pos].size != 14 * 16 || scode >= 16 ||
 683                     le16_to_cpu(*(__le16 *)(p + 14 * scode)) != 12)
 684                         return -EINVAL;
 685                 p += 14 * scode + 2;
 686         }
 687
 688         tuner_info("Loading SCODE for type=");
 689         dump_firm_type_and_int_freq(priv->firm[pos].type,
 690                                     priv->firm[pos].int_freq);
 691         printk("(%x), id %016llx.\n", priv->firm[pos].type,
 692                (unsigned long long)*id);
 693
 694         if (priv->firm_version < 0x0202)
 695                 rc = send_seq(priv, {0x20, 0x00, 0x00, 0x00});
 696         else
 697                 rc = send_seq(priv, {0xa0, 0x00, 0x00, 0x00});
 698         if (rc < 0)
 699                 return -EIO;
 700
 701         rc = i2c_send(priv, p, 12);
 702         if (rc < 0)
 703                 return -EIO;
 704
 705         rc = send_seq(priv, {0x00, 0x8c});
 706         if (rc < 0)
 707                 return -EIO;
 708
 709         return 0;
 710 }
 711
 712 static int check_firmware(struct dvb_frontend *fe, unsigned int type,
 713                           v4l2_std_id std, __u16 int_freq)
 714 {
 715         struct xc2028_data         *priv = fe->tuner_priv;
 716         struct firmware_properties new_fw;
 717         int                        rc, retry_count = 0;
 718         u16                        version, hwmodel;
 719         v4l2_std_id                std0;
 720
 721         tuner_dbg("%s called\n", __func__);
 722
 723         rc = check_device_status(priv);
 724         if (rc < 0)
 725                 return rc;
 726
 727         if (priv->ctrl.mts && !(type & FM))
 728                 type |= MTS;
 729
 730 retry:
 731         new_fw.type = type;
 732         new_fw.id = std;
 733         new_fw.std_req = std;
 734         new_fw.scode_table = SCODE | priv->ctrl.scode_table;
 735         new_fw.scode_nr = 0;
 736         new_fw.int_freq = int_freq;
 737
 738         tuner_dbg("checking firmware, user requested type=");
 739         if (debug) {
 740                 dump_firm_type(new_fw.type);
 741                 printk("(%x), id %016llx, ", new_fw.type,
 742                        (unsigned long long)new_fw.std_req);
 743                 if (!int_freq) {
 744                         printk("scode_tbl ");
 745                         dump_firm_type(priv->ctrl.scode_table);
 746                         printk("(%x), ", priv->ctrl.scode_table);
 747                 } else
 748                         printk("int_freq %d, ", new_fw.int_freq);
 749                 printk("scode_nr %d\n", new_fw.scode_nr);
 750         }
 751
 752         /*
 753          * No need to reload base firmware if it matches and if the tuner
 754          * is not at sleep mode
 755          */
 756         if ((priv->state == XC2028_ACTIVE) &&
 757             (((BASE | new_fw.type) & BASE_TYPES) ==
 758             (priv->cur_fw.type & BASE_TYPES))) {
 759                 tuner_dbg("BASE firmware not changed.\n");
 760                 goto skip_base;
 761         }
 762
 763         /* Updating BASE - forget about all currently loaded firmware */
 764         memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
 765
 766         /* Reset is needed before loading firmware */
 767         rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
 768         if (rc < 0)
 769                 goto fail;
 770
 771         /* BASE firmwares are all std0 */
 772         std0 = 0;
 773         rc = load_firmware(fe, BASE | new_fw.type, &std0);
 774         if (rc < 0) {
 775                 tuner_err("Error %d while loading base firmware\n",
 776                           rc);
 777                 goto fail;
 778         }
 779
 780         /* Load INIT1, if needed */
 781         tuner_dbg("Load init1 firmware, if exists\n");
 782
 783         rc = load_firmware(fe, BASE | INIT1 | new_fw.type, &std0);
 784         if (rc == -ENOENT)
 785                 rc = load_firmware(fe, (BASE | INIT1 | new_fw.type) & ~F8MHZ,
 786                                    &std0);
 787         if (rc < 0 && rc != -ENOENT) {
 788                 tuner_err("Error %d while loading init1 firmware\n",
 789                           rc);
 790                 goto fail;
 791         }
 792
 793 skip_base:
 794         /*
 795          * No need to reload standard specific firmware if base firmware
 796          * was not reloaded and requested video standards have not changed.
 797          */
 798         if (priv->cur_fw.type == (BASE | new_fw.type) &&
 799             priv->cur_fw.std_req == std) {
 800                 tuner_dbg("Std-specific firmware already loaded.\n");
 801                 goto skip_std_specific;
 802         }
 803
 804         /* Reloading std-specific firmware forces a SCODE update */
 805         priv->cur_fw.scode_table = 0;
 806
 807         rc = load_firmware(fe, new_fw.type, &new_fw.id);
 808         if (rc == -ENOENT)
 809                 rc = load_firmware(fe, new_fw.type & ~F8MHZ, &new_fw.id);
 810
 811         if (rc < 0)
 812                 goto fail;
 813
 814 skip_std_specific:
 815         if (priv->cur_fw.scode_table == new_fw.scode_table &&
 816             priv->cur_fw.scode_nr == new_fw.scode_nr) {
 817                 tuner_dbg("SCODE firmware already loaded.\n");
 818                 goto check_device;
 819         }
 820
 821         if (new_fw.type & FM)
 822                 goto check_device;
 823
 824         /* Load SCODE firmware, if exists */
 825         tuner_dbg("Trying to load scode %d\n", new_fw.scode_nr);
 826
 827         rc = load_scode(fe, new_fw.type | new_fw.scode_table, &new_fw.id,
 828                         new_fw.int_freq, new_fw.scode_nr);
 829
 830 check_device:
 831         if (xc2028_get_reg(priv, 0x0004, &version) < 0 ||
 832             xc2028_get_reg(priv, 0x0008, &hwmodel) < 0) {
 833                 tuner_err("Unable to read tuner registers.\n");
 834                 goto fail;
 835         }
 836
 837         tuner_dbg("Device is Xceive %d version %d.%d, "
 838                   "firmware version %d.%d\n",
 839                   hwmodel, (version & 0xf000) >> 12, (version & 0xf00) >> 8,
 840                   (version & 0xf0) >> 4, version & 0xf);
 841
 842
 843         if (priv->ctrl.read_not_reliable)
 844                 goto read_not_reliable;
 845
 846         /* Check firmware version against what we downloaded. */
 847         if (priv->firm_version != ((version & 0xf0) << 4 | (version & 0x0f))) {
 848                 if (!priv->ctrl.read_not_reliable) {
 849                         tuner_err("Incorrect readback of firmware version.\n");
 850                         goto fail;
 851                 } else {
 852                         tuner_err("Returned an incorrect version. However, "
 853                                   "read is not reliable enough. Ignoring it.\n");
 854                         hwmodel = 3028;
 855                 }
 856         }
 857
 858         /* Check that the tuner hardware model remains consistent over time. */
 859         if (priv->hwmodel == 0 && (hwmodel == 2028 || hwmodel == 3028)) {
 860                 priv->hwmodel = hwmodel;
 861                 priv->hwvers  = version & 0xff00;
 862         } else if (priv->hwmodel == 0 || priv->hwmodel != hwmodel ||
 863                    priv->hwvers != (version & 0xff00)) {
 864                 tuner_err("Read invalid device hardware information - tuner "
 865                           "hung?\n");
 866                 goto fail;
 867         }
 868
 869 read_not_reliable:
 870         priv->cur_fw = new_fw;
 871
 872         /*
 873          * By setting BASE in cur_fw.type only after successfully loading all
 874          * firmwares, we can:
 875          * 1. Identify that BASE firmware with type=0 has been loaded;
 876          * 2. Tell whether BASE firmware was just changed the next time through.
 877          */
 878         priv->cur_fw.type |= BASE;
 879         priv->state = XC2028_ACTIVE;
 880
 881         return 0;
 882
 883 fail:
 884         priv->state = XC2028_SLEEP;
 885
 886         memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
 887         if (retry_count < 8) {
 888                 msleep(50);
 889                 retry_count++;
 890                 tuner_dbg("Retrying firmware load\n");
 891                 goto retry;
 892         }
 893
 894         if (rc == -ENOENT)
 895                 rc = -EINVAL;
 896         return rc;
 897 }
 898
 899 static int xc2028_signal(struct dvb_frontend *fe, u16 *strength)
 900 {
 901         struct xc2028_data *priv = fe->tuner_priv;
 902         u16                 frq_lock, signal = 0;
 903         int                 rc, i;
 904
 905         tuner_dbg("%s called\n", __func__);
 906
 907         rc = check_device_status(priv);
 908         if (rc < 0)
 909                 return rc;
 910
 911         mutex_lock(&priv->lock);
 912
 913         /* Sync Lock Indicator */
 914         for (i = 0; i < 3; i++) {
 915                 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
 916                 if (rc < 0)
 917                         goto ret;
 918
 919                 if (frq_lock)
 920                         break;
 921                 msleep(6);
 922         }
 923
 924         /* Frequency didn't lock */
 925         if (frq_lock == 2)
 926                 goto ret;
 927
 928         /* Get SNR of the video signal */
 929         rc = xc2028_get_reg(priv, XREG_SNR, &signal);
 930         if (rc < 0)
 931                 goto ret;
 932
 933         /* Signal level is 3 bits only */
 934
 935         signal = ((1 << 12) - 1) | ((signal & 0x07) << 12);
 936
 937 ret:
 938         mutex_unlock(&priv->lock);
 939
 940         *strength = signal;
 941
 942         tuner_dbg("signal strength is %d\n", signal);
 943
 944         return rc;
 945 }
 946
 947 static int xc2028_get_afc(struct dvb_frontend *fe, s32 *afc)
 948 {
 949         struct xc2028_data *priv = fe->tuner_priv;
 950         int i, rc;
 951         u16 frq_lock = 0;
 952         s16 afc_reg = 0;
 953
 954         rc = check_device_status(priv);
 955         if (rc < 0)
 956                 return rc;
 957
 958         mutex_lock(&priv->lock);
 959
 960         /* Sync Lock Indicator */
 961         for (i = 0; i < 3; i++) {
 962                 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
 963                 if (rc < 0)
 964                         goto ret;
 965
 966                 if (frq_lock)
 967                         break;
 968                 msleep(6);
 969         }
 970
 971         /* Frequency didn't lock */
 972         if (frq_lock == 2)
 973                 goto ret;
 974
 975         /* Get AFC */
 976         rc = xc2028_get_reg(priv, XREG_FREQ_ERROR, &afc_reg);
 977         if (rc < 0)
 978                 goto ret;
 979
 980         *afc = afc_reg * 15625; /* Hz */
 981
 982         tuner_dbg("AFC is %d Hz\n", *afc);
 983
 984 ret:
 985         mutex_unlock(&priv->lock);
 986
 987         return rc;
 988 }
 989
 990 #define DIV 15625
 991
 992 static int generic_set_freq(struct dvb_frontend *fe, u32 freq /* in HZ */,
 993                             enum v4l2_tuner_type new_type,
 994                             unsigned int type,
 995                             v4l2_std_id std,
 996                             u16 int_freq)
 997 {
 998         struct xc2028_data *priv = fe->tuner_priv;
 999         int                rc = -EINVAL;
1000         unsigned char      buf[4];
1001         u32                div, offset = 0;
1002
1003         tuner_dbg("%s called\n", __func__);
1004
1005         mutex_lock(&priv->lock);
1006
1007         tuner_dbg("should set frequency %d kHz\n", freq / 1000);
1008
1009         if (check_firmware(fe, type, std, int_freq) < 0)
1010                 goto ret;
1011
1012         /* On some cases xc2028 can disable video output, if
1013          * very weak signals are received. By sending a soft
1014          * reset, this is re-enabled. So, it is better to always
1015          * send a soft reset before changing channels, to be sure
1016          * that xc2028 will be in a safe state.
1017          * Maybe this might also be needed for DTV.
1018          */
1019         switch (new_type) {
1020         case V4L2_TUNER_ANALOG_TV:
1021                 rc = send_seq(priv, {0x00, 0x00});
1022
1023                 /* Analog mode requires offset = 0 */
1024                 break;
1025         case V4L2_TUNER_RADIO:
1026                 /* Radio mode requires offset = 0 */
1027                 break;
1028         case V4L2_TUNER_DIGITAL_TV:
1029                 /*
1030                  * Digital modes require an offset to adjust to the
1031                  * proper frequency. The offset depends on what
1032                  * firmware version is used.
1033                  */
1034
1035                 /*
1036                  * Adjust to the center frequency. This is calculated by the
1037                  * formula: offset = 1.25MHz - BW/2
1038                  * For DTV 7/8, the firmware uses BW = 8000, so it needs a
1039                  * further adjustment to get the frequency center on VHF
1040                  */
1041
1042                 /*
1043                  * The firmware DTV78 used to work fine in UHF band (8 MHz
1044                  * bandwidth) but not at all in VHF band (7 MHz bandwidth).
1045                  * The real problem was connected to the formula used to
1046                  * calculate the center frequency offset in VHF band.
1047                  * In fact, removing the 500KHz adjustment fixed the problem.
1048                  * This is coherent to what was implemented for the DTV7
1049                  * firmware.
1050                  * In the end, now the center frequency is the same for all 3
1051                  * firmwares (DTV7, DTV8, DTV78) and doesn't depend on channel
1052                  * bandwidth.
1053                  */
1054
1055                 if (priv->cur_fw.type & DTV6)
1056                         offset = 1750000;
1057                 else    /* DTV7 or DTV8 or DTV78 */
1058                         offset = 2750000;
1059
1060                 /*
1061                  * xc3028 additional "magic"
1062                  * Depending on the firmware version, it needs some adjustments
1063                  * to properly centralize the frequency. This seems to be
1064                  * needed to compensate the SCODE table adjustments made by
1065                  * newer firmwares
1066                  */
1067
1068                 /*
1069                  * The proper adjustment would be to do it at s-code table.
1070                  * However, this didn't work, as reported by
1071                  * Robert Lowery <rglowery@exemail.com.au>
1072                  */
1073
1074 #if 0
1075                 /*
1076                  * Still need tests for XC3028L (firmware 3.2 or upper)
1077                  * So, for now, let's just comment the per-firmware
1078                  * version of this change. Reports with xc3028l working
1079                  * with and without the lines bellow are welcome
1080                  */
1081
1082                 if (priv->firm_version < 0x0302) {
1083                         if (priv->cur_fw.type & DTV7)
1084                                 offset += 500000;
1085                 } else {
1086                         if (priv->cur_fw.type & DTV7)
1087                                 offset -= 300000;
1088                         else if (type != ATSC) /* DVB @6MHz, DTV 8 and DTV 7/8 */
1089                                 offset += 200000;
1090                 }
1091 #endif
1092         }
1093
1094         div = (freq - offset + DIV / 2) / DIV;
1095
1096         /* CMD= Set frequency */
1097         if (priv->firm_version < 0x0202)
1098                 rc = send_seq(priv, {0x00, XREG_RF_FREQ, 0x00, 0x00});
1099         else
1100                 rc = send_seq(priv, {0x80, XREG_RF_FREQ, 0x00, 0x00});
1101         if (rc < 0)
1102                 goto ret;
1103
1104         /* Return code shouldn't be checked.
1105            The reset CLK is needed only with tm6000.
1106            Driver should work fine even if this fails.
1107          */
1108         if (priv->ctrl.msleep)
1109                 msleep(priv->ctrl.msleep);
1110         do_tuner_callback(fe, XC2028_RESET_CLK, 1);
1111
1112         msleep(10);
1113
1114         buf[0] = 0xff & (div >> 24);
1115         buf[1] = 0xff & (div >> 16);
1116         buf[2] = 0xff & (div >> 8);
1117         buf[3] = 0xff & (div);
1118
1119         rc = i2c_send(priv, buf, sizeof(buf));
1120         if (rc < 0)
1121                 goto ret;
1122         msleep(100);
1123
1124         priv->frequency = freq;
1125
1126         tuner_dbg("divisor= %*ph (freq=%d.%03d)\n", 4, buf,
1127                freq / 1000000, (freq % 1000000) / 1000);
1128
1129         rc = 0;
1130
1131 ret:
1132         mutex_unlock(&priv->lock);
1133
1134         return rc;
1135 }
1136
1137 static int xc2028_set_analog_freq(struct dvb_frontend *fe,
1138                               struct analog_parameters *p)
1139 {
1140         struct xc2028_data *priv = fe->tuner_priv;
1141         unsigned int       type=0;
1142
1143         tuner_dbg("%s called\n", __func__);
1144
1145         if (p->mode == V4L2_TUNER_RADIO) {
1146                 type |= FM;
1147                 if (priv->ctrl.input1)
1148                         type |= INPUT1;
1149                 return generic_set_freq(fe, (625l * p->frequency) / 10,
1150                                 V4L2_TUNER_RADIO, type, 0, 0);
1151         }
1152
1153         /* if std is not defined, choose one */
1154         if (!p->std)
1155                 p->std = V4L2_STD_MN;
1156
1157         /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
1158         if (!(p->std & V4L2_STD_MN))
1159                 type |= F8MHZ;
1160
1161         /* Add audio hack to std mask */
1162         p->std |= parse_audio_std_option();
1163
1164         return generic_set_freq(fe, 62500l * p->frequency,
1165                                 V4L2_TUNER_ANALOG_TV, type, p->std, 0);
1166 }
1167
1168 static int xc2028_set_params(struct dvb_frontend *fe)
1169 {
1170         struct dtv_frontend_properties *c = &fe->dtv_property_cache;
1171         u32 delsys = c->delivery_system;
1172         u32 bw = c->bandwidth_hz;
1173         struct xc2028_data *priv = fe->tuner_priv;
1174         int rc;
1175         unsigned int       type = 0;
1176         u16                demod = 0;
1177
1178         tuner_dbg("%s called\n", __func__);
1179
1180         rc = check_device_status(priv);
1181         if (rc < 0)
1182                 return rc;
1183
1184         switch (delsys) {
1185         case SYS_DVBT:
1186         case SYS_DVBT2:
1187                 /*
1188                  * The only countries with 6MHz seem to be Taiwan/Uruguay.
1189                  * Both seem to require QAM firmware for OFDM decoding
1190                  * Tested in Taiwan by Terry Wu <terrywu2009@gmail.com>
1191                  */
1192                 if (bw <= 6000000)
1193                         type |= QAM;
1194
1195                 switch (priv->ctrl.type) {
1196                 case XC2028_D2633:
1197                         type |= D2633;
1198                         break;
1199                 case XC2028_D2620:
1200                         type |= D2620;
1201                         break;
1202                 case XC2028_AUTO:
1203                 default:
1204                         /* Zarlink seems to need D2633 */
1205                         if (priv->ctrl.demod == XC3028_FE_ZARLINK456)
1206                                 type |= D2633;
1207                         else
1208                                 type |= D2620;
1209                 }
1210                 break;
1211         case SYS_ATSC:
1212                 /* The only ATSC firmware (at least on v2.7) is D2633 */
1213                 type |= ATSC | D2633;
1214                 break;
1215         /* DVB-S and pure QAM (FE_QAM) are not supported */
1216         default:
1217                 return -EINVAL;
1218         }
1219
1220         if (bw <= 6000000) {
1221                 type |= DTV6;
1222                 priv->ctrl.vhfbw7 = 0;
1223                 priv->ctrl.uhfbw8 = 0;
1224         } else if (bw <= 7000000) {
1225                 if (c->frequency < 470000000)
1226                         priv->ctrl.vhfbw7 = 1;
1227                 else
1228                         priv->ctrl.uhfbw8 = 0;
1229                 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV7;
1230                 type |= F8MHZ;
1231         } else {
1232                 if (c->frequency < 470000000)
1233                         priv->ctrl.vhfbw7 = 0;
1234                 else
1235                         priv->ctrl.uhfbw8 = 1;
1236                 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV8;
1237                 type |= F8MHZ;
1238         }
1239
1240         /* All S-code tables need a 200kHz shift */
1241         if (priv->ctrl.demod) {
1242                 demod = priv->ctrl.demod;
1243
1244                 /*
1245                  * Newer firmwares require a 200 kHz offset only for ATSC
1246                  */
1247                 if (type == ATSC || priv->firm_version < 0x0302)
1248                         demod += 200;
1249                 /*
1250                  * The DTV7 S-code table needs a 700 kHz shift.
1251                  *
1252                  * DTV7 is only used in Australia.  Germany or Italy may also
1253                  * use this firmware after initialization, but a tune to a UHF
1254                  * channel should then cause DTV78 to be used.
1255                  *
1256                  * Unfortunately, on real-field tests, the s-code offset
1257                  * didn't work as expected, as reported by
1258                  * Robert Lowery <rglowery@exemail.com.au>
1259                  */
1260         }
1261
1262         return generic_set_freq(fe, c->frequency,
1263                                 V4L2_TUNER_DIGITAL_TV, type, 0, demod);
1264 }
1265
1266 static int xc2028_sleep(struct dvb_frontend *fe)
1267 {
1268         struct xc2028_data *priv = fe->tuner_priv;
1269         int rc;
1270
1271         rc = check_device_status(priv);
1272         if (rc < 0)
1273                 return rc;
1274
1275         /* Avoid firmware reload on slow devices or if PM disabled */
1276         if (no_poweroff || priv->ctrl.disable_power_mgmt)
1277                 return 0;
1278
1279         tuner_dbg("Putting xc2028/3028 into poweroff mode.\n");
1280         if (debug > 1) {
1281                 tuner_dbg("Printing sleep stack trace:\n");
1282                 dump_stack();
1283         }
1284
1285         mutex_lock(&priv->lock);
1286
1287         if (priv->firm_version < 0x0202)
1288                 rc = send_seq(priv, {0x00, XREG_POWER_DOWN, 0x00, 0x00});
1289         else
1290                 rc = send_seq(priv, {0x80, XREG_POWER_DOWN, 0x00, 0x00});
1291
1292         priv->state = XC2028_SLEEP;
1293
1294         mutex_unlock(&priv->lock);
1295
1296         return rc;
1297 }
1298
1299 static int xc2028_dvb_release(struct dvb_frontend *fe)
1300 {
1301         struct xc2028_data *priv = fe->tuner_priv;
1302
1303         tuner_dbg("%s called\n", __func__);
1304
1305         mutex_lock(&xc2028_list_mutex);
1306
1307         /* only perform final cleanup if this is the last instance */
1308         if (hybrid_tuner_report_instance_count(priv) == 1) {
1309                 free_firmware(priv);
1310                 kfree(priv->ctrl.fname);
1311                 priv->ctrl.fname = NULL;
1312         }
1313
1314         if (priv)
1315                 hybrid_tuner_release_state(priv);
1316
1317         mutex_unlock(&xc2028_list_mutex);
1318
1319         fe->tuner_priv = NULL;
1320
1321         return 0;
1322 }
1323
1324 static int xc2028_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1325 {
1326         struct xc2028_data *priv = fe->tuner_priv;
1327         int rc;
1328
1329         tuner_dbg("%s called\n", __func__);
1330
1331         rc = check_device_status(priv);
1332         if (rc < 0)
1333                 return rc;
1334
1335         *frequency = priv->frequency;
1336
1337         return 0;
1338 }
1339
1340 static void load_firmware_cb(const struct firmware *fw,
1341                              void *context)
1342 {
1343         struct dvb_frontend *fe = context;
1344         struct xc2028_data *priv = fe->tuner_priv;
1345         int rc;
1346
1347         tuner_dbg("request_firmware_nowait(): %s\n", fw ? "OK" : "error");
1348         if (!fw) {
1349                 tuner_err("Could not load firmware %s.\n", priv->fname);
1350                 priv->state = XC2028_NODEV;
1351                 return;
1352         }
1353
1354         rc = load_all_firmwares(fe, fw);
1355
1356         release_firmware(fw);
1357
1358         if (rc < 0)
1359                 return;
1360         priv->state = XC2028_SLEEP;
1361 }
1362
1363 static int xc2028_set_config(struct dvb_frontend *fe, void *priv_cfg)
1364 {
1365         struct xc2028_data *priv = fe->tuner_priv;
1366         struct xc2028_ctrl *p    = priv_cfg;
1367         int                 rc   = 0;
1368
1369         tuner_dbg("%s called\n", __func__);
1370
1371         mutex_lock(&priv->lock);
1372
1373         /*
1374          * Copy the config data.
1375          * For the firmware name, keep a local copy of the string,
1376          * in order to avoid troubles during device release.
1377          */
1378         kfree(priv->ctrl.fname);
1379         memcpy(&priv->ctrl, p, sizeof(priv->ctrl));
1380         if (p->fname) {
1381                 priv->ctrl.fname = kstrdup(p->fname, GFP_KERNEL);
1382                 if (priv->ctrl.fname == NULL)
1383                         rc = -ENOMEM;
1384         }
1385
1386         /*
1387          * If firmware name changed, frees firmware. As free_firmware will
1388          * reset the status to NO_FIRMWARE, this forces a new request_firmware
1389          */
1390         if (!firmware_name[0] && p->fname &&
1391             priv->fname && strcmp(p->fname, priv->fname))
1392                 free_firmware(priv);
1393
1394         if (priv->ctrl.max_len < 9)
1395                 priv->ctrl.max_len = 13;
1396
1397         if (priv->state == XC2028_NO_FIRMWARE) {
1398                 if (!firmware_name[0])
1399                         priv->fname = priv->ctrl.fname;
1400                 else
1401                         priv->fname = firmware_name;
1402
1403                 rc = request_firmware_nowait(THIS_MODULE, 1,
1404                                              priv->fname,
1405                                              priv->i2c_props.adap->dev.parent,
1406                                              GFP_KERNEL,
1407                                              fe, load_firmware_cb);
1408                 if (rc < 0) {
1409                         tuner_err("Failed to request firmware %s\n",
1410                                   priv->fname);
1411                         priv->state = XC2028_NODEV;
1412                 } else
1413                         priv->state = XC2028_WAITING_FIRMWARE;
1414         }
1415         mutex_unlock(&priv->lock);
1416
1417         return rc;
1418 }
1419
1420 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops = {
1421         .info = {
1422                  .name = "Xceive XC3028",
1423                  .frequency_min = 42000000,
1424                  .frequency_max = 864000000,
1425                  .frequency_step = 50000,
1426                  },
1427
1428         .set_config        = xc2028_set_config,
1429         .set_analog_params = xc2028_set_analog_freq,
1430         .release           = xc2028_dvb_release,
1431         .get_frequency     = xc2028_get_frequency,
1432         .get_rf_strength   = xc2028_signal,
1433         .get_afc           = xc2028_get_afc,
1434         .set_params        = xc2028_set_params,
1435         .sleep             = xc2028_sleep,
1436 };
1437
1438 struct dvb_frontend *xc2028_attach(struct dvb_frontend *fe,
1439                                    struct xc2028_config *cfg)
1440 {
1441         struct xc2028_data *priv;
1442         int instance;
1443
1444         if (debug)
1445                 printk(KERN_DEBUG "xc2028: Xcv2028/3028 init called!\n");
1446
1447         if (NULL == cfg)
1448                 return NULL;
1449
1450         if (!fe) {
1451                 printk(KERN_ERR "xc2028: No frontend!\n");
1452                 return NULL;
1453         }
1454
1455         mutex_lock(&xc2028_list_mutex);
1456
1457         instance = hybrid_tuner_request_state(struct xc2028_data, priv,
1458                                               hybrid_tuner_instance_list,
1459                                               cfg->i2c_adap, cfg->i2c_addr,
1460                                               "xc2028");
1461         switch (instance) {
1462         case 0:
1463                 /* memory allocation failure */
1464                 goto fail;
1465                 break;
1466         case 1:
1467                 /* new tuner instance */
1468                 priv->ctrl.max_len = 13;
1469
1470                 mutex_init(&priv->lock);
1471
1472                 fe->tuner_priv = priv;
1473                 break;
1474         case 2:
1475                 /* existing tuner instance */
1476                 fe->tuner_priv = priv;
1477                 break;
1478         }
1479
1480         memcpy(&fe->ops.tuner_ops, &xc2028_dvb_tuner_ops,
1481                sizeof(xc2028_dvb_tuner_ops));
1482
1483         tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1484
1485         if (cfg->ctrl)
1486                 xc2028_set_config(fe, cfg->ctrl);
1487
1488         mutex_unlock(&xc2028_list_mutex);
1489
1490         return fe;
1491 fail:
1492         mutex_unlock(&xc2028_list_mutex);
1493
1494         xc2028_dvb_release(fe);
1495         return NULL;
1496 }
1497
1498 EXPORT_SYMBOL(xc2028_attach);
1499
1500 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1501 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1502 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
1503 MODULE_LICENSE("GPL");
1504 MODULE_FIRMWARE(XC2028_DEFAULT_FIRMWARE);
1505 MODULE_FIRMWARE(XC3028L_DEFAULT_FIRMWARE);