drivers/media/common/tuners/xc5000.c

   1 /*
   2  *  Driver for Xceive XC5000 "QAM/8VSB single chip tuner"
   3  *
   4  *  Copyright (c) 2007 Xceive Corporation
   5  *  Copyright (c) 2007 Steven Toth <stoth@hauppauge.com>
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22
  23 #include <linux/module.h>
  24 #include <linux/moduleparam.h>
  25 #include <linux/videodev2.h>
  26 #include <linux/delay.h>
  27 #include <linux/dvb/frontend.h>
  28 #include <linux/i2c.h>
  29
  30 #include "dvb_frontend.h"
  31
  32 #include "xc5000.h"
  33 #include "xc5000_priv.h"
  34
  35 static int debug;
  36 module_param(debug, int, 0644);
  37 MODULE_PARM_DESC(debug, "Turn on/off debugging (default:off).");
  38
  39 static int xc5000_load_fw_on_attach;
  40 module_param_named(init_fw, xc5000_load_fw_on_attach, int, 0644);
  41 MODULE_PARM_DESC(init_fw, "Load firmware during driver initialization.");
  42
  43 #define dprintk(level,fmt, arg...) if (debug >= level) \
  44         printk(KERN_INFO "%s: " fmt, "xc5000", ## arg)
  45
  46 #define XC5000_DEFAULT_FIRMWARE "dvb-fe-xc5000-1.1.fw"
  47 #define XC5000_DEFAULT_FIRMWARE_SIZE 12332
  48
  49 /* Misc Defines */
  50 #define MAX_TV_STANDARD                 23
  51 #define XC_MAX_I2C_WRITE_LENGTH         64
  52
  53 /* Signal Types */
  54 #define XC_RF_MODE_AIR                  0
  55 #define XC_RF_MODE_CABLE                1
  56
  57 /* Result codes */
  58 #define XC_RESULT_SUCCESS               0
  59 #define XC_RESULT_RESET_FAILURE         1
  60 #define XC_RESULT_I2C_WRITE_FAILURE     2
  61 #define XC_RESULT_I2C_READ_FAILURE      3
  62 #define XC_RESULT_OUT_OF_RANGE          5
  63
  64 /* Product id */
  65 #define XC_PRODUCT_ID_FW_NOT_LOADED     0x2000
  66 #define XC_PRODUCT_ID_FW_LOADED         0x1388
  67
  68 /* Registers */
  69 #define XREG_INIT         0x00
  70 #define XREG_VIDEO_MODE   0x01
  71 #define XREG_AUDIO_MODE   0x02
  72 #define XREG_RF_FREQ      0x03
  73 #define XREG_D_CODE       0x04
  74 #define XREG_IF_OUT       0x05
  75 #define XREG_SEEK_MODE    0x07
  76 #define XREG_POWER_DOWN   0x0A
  77 #define XREG_SIGNALSOURCE 0x0D /* 0=Air, 1=Cable */
  78 #define XREG_SMOOTHEDCVBS 0x0E
  79 #define XREG_XTALFREQ     0x0F
  80 #define XREG_FINERFFREQ   0x10
  81 #define XREG_DDIMODE      0x11
  82
  83 #define XREG_ADC_ENV      0x00
  84 #define XREG_QUALITY      0x01
  85 #define XREG_FRAME_LINES  0x02
  86 #define XREG_HSYNC_FREQ   0x03
  87 #define XREG_LOCK         0x04
  88 #define XREG_FREQ_ERROR   0x05
  89 #define XREG_SNR          0x06
  90 #define XREG_VERSION      0x07
  91 #define XREG_PRODUCT_ID   0x08
  92 #define XREG_BUSY         0x09
  93
  94 /*
  95    Basic firmware description. This will remain with
  96    the driver for documentation purposes.
  97
  98    This represents an I2C firmware file encoded as a
  99    string of unsigned char. Format is as follows:
 100
 101    char[0  ]=len0_MSB  -> len = len_MSB * 256 + len_LSB
 102    char[1  ]=len0_LSB  -> length of first write transaction
 103    char[2  ]=data0 -> first byte to be sent
 104    char[3  ]=data1
 105    char[4  ]=data2
 106    char[   ]=...
 107    char[M  ]=dataN  -> last byte to be sent
 108    char[M+1]=len1_MSB  -> len = len_MSB * 256 + len_LSB
 109    char[M+2]=len1_LSB  -> length of second write transaction
 110    char[M+3]=data0
 111    char[M+4]=data1
 112    ...
 113    etc.
 114
 115    The [len] value should be interpreted as follows:
 116
 117    len= len_MSB _ len_LSB
 118    len=1111_1111_1111_1111   : End of I2C_SEQUENCE
 119    len=0000_0000_0000_0000   : Reset command: Do hardware reset
 120    len=0NNN_NNNN_NNNN_NNNN   : Normal transaction: number of bytes = {1:32767)
 121    len=1WWW_WWWW_WWWW_WWWW   : Wait command: wait for {1:32767} ms
 122
 123    For the RESET and WAIT commands, the two following bytes will contain
 124    immediately the length of the following transaction.
 125
 126 */
 127 typedef struct {
 128         char *Name;
 129         u16 AudioMode;
 130         u16 VideoMode;
 131 } XC_TV_STANDARD;
 132
 133 /* Tuner standards */
 134 #define MN_NTSC_PAL_BTSC        0
 135 #define MN_NTSC_PAL_A2          1
 136 #define MN_NTSC_PAL_EIAJ        2
 137 #define MN_NTSC_PAL_Mono        3
 138 #define BG_PAL_A2               4
 139 #define BG_PAL_NICAM            5
 140 #define BG_PAL_MONO             6
 141 #define I_PAL_NICAM             7
 142 #define I_PAL_NICAM_MONO        8
 143 #define DK_PAL_A2               9
 144 #define DK_PAL_NICAM            10
 145 #define DK_PAL_MONO             11
 146 #define DK_SECAM_A2DK1          12
 147 #define DK_SECAM_A2LDK3         13
 148 #define DK_SECAM_A2MONO         14
 149 #define L_SECAM_NICAM           15
 150 #define LC_SECAM_NICAM          16
 151 #define DTV6                    17
 152 #define DTV8                    18
 153 #define DTV7_8                  19
 154 #define DTV7                    20
 155 #define FM_Radio_INPUT2         21
 156 #define FM_Radio_INPUT1         22
 157
 158 static XC_TV_STANDARD XC5000_Standard[MAX_TV_STANDARD] = {
 159         {"M/N-NTSC/PAL-BTSC", 0x0400, 0x8020},
 160         {"M/N-NTSC/PAL-A2",   0x0600, 0x8020},
 161         {"M/N-NTSC/PAL-EIAJ", 0x0440, 0x8020},
 162         {"M/N-NTSC/PAL-Mono", 0x0478, 0x8020},
 163         {"B/G-PAL-A2",        0x0A00, 0x8049},
 164         {"B/G-PAL-NICAM",     0x0C04, 0x8049},
 165         {"B/G-PAL-MONO",      0x0878, 0x8059},
 166         {"I-PAL-NICAM",       0x1080, 0x8009},
 167         {"I-PAL-NICAM-MONO",  0x0E78, 0x8009},
 168         {"D/K-PAL-A2",        0x1600, 0x8009},
 169         {"D/K-PAL-NICAM",     0x0E80, 0x8009},
 170         {"D/K-PAL-MONO",      0x1478, 0x8009},
 171         {"D/K-SECAM-A2 DK1",  0x1200, 0x8009},
 172         {"D/K-SECAM-A2 L/DK3",0x0E00, 0x8009},
 173         {"D/K-SECAM-A2 MONO", 0x1478, 0x8009},
 174         {"L-SECAM-NICAM",     0x8E82, 0x0009},
 175         {"L'-SECAM-NICAM",    0x8E82, 0x4009},
 176         {"DTV6",              0x00C0, 0x8002},
 177         {"DTV8",              0x00C0, 0x800B},
 178         {"DTV7/8",            0x00C0, 0x801B},
 179         {"DTV7",              0x00C0, 0x8007},
 180         {"FM Radio-INPUT2",   0x9802, 0x9002},
 181         {"FM Radio-INPUT1",   0x0208, 0x9002}
 182 };
 183
 184 static int  xc5000_is_firmware_loaded(struct dvb_frontend *fe);
 185 static int  xc5000_writeregs(struct xc5000_priv *priv, u8 *buf, u8 len);
 186 static int  xc5000_readregs(struct xc5000_priv *priv, u8 *buf, u8 len);
 187 static void xc5000_TunerReset(struct dvb_frontend *fe);
 188
 189 static int xc_send_i2c_data(struct xc5000_priv *priv, u8 *buf, int len)
 190 {
 191         return xc5000_writeregs(priv, buf, len)
 192                 ? XC_RESULT_I2C_WRITE_FAILURE : XC_RESULT_SUCCESS;
 193 }
 194
 195 static int xc_read_i2c_data(struct xc5000_priv *priv, u8 *buf, int len)
 196 {
 197         return xc5000_readregs(priv, buf, len)
 198                 ? XC_RESULT_I2C_READ_FAILURE : XC_RESULT_SUCCESS;
 199 }
 200
 201 static int xc_reset(struct dvb_frontend *fe)
 202 {
 203         xc5000_TunerReset(fe);
 204         return XC_RESULT_SUCCESS;
 205 }
 206
 207 static void xc_wait(int wait_ms)
 208 {
 209         msleep(wait_ms);
 210 }
 211
 212 static void xc5000_TunerReset(struct dvb_frontend *fe)
 213 {
 214         struct xc5000_priv *priv = fe->tuner_priv;
 215         int ret;
 216
 217         dprintk(1, "%s()\n", __func__);
 218
 219         if (priv->cfg->tuner_callback) {
 220                 ret = priv->cfg->tuner_callback(priv->devptr,
 221                                                 XC5000_TUNER_RESET, 0);
 222                 if (ret)
 223                         printk(KERN_ERR "xc5000: reset failed\n");
 224         } else
 225                 printk(KERN_ERR "xc5000: no tuner reset callback function, fatal\n");
 226 }
 227
 228 static int xc_write_reg(struct xc5000_priv *priv, u16 regAddr, u16 i2cData)
 229 {
 230         u8 buf[4];
 231         int WatchDogTimer = 5;
 232         int result;
 233
 234         buf[0] = (regAddr >> 8) & 0xFF;
 235         buf[1] = regAddr & 0xFF;
 236         buf[2] = (i2cData >> 8) & 0xFF;
 237         buf[3] = i2cData & 0xFF;
 238         result = xc_send_i2c_data(priv, buf, 4);
 239         if (result == XC_RESULT_SUCCESS) {
 240                 /* wait for busy flag to clear */
 241                 while ((WatchDogTimer > 0) && (result == XC_RESULT_SUCCESS)) {
 242                         buf[0] = 0;
 243                         buf[1] = XREG_BUSY;
 244
 245                         result = xc_send_i2c_data(priv, buf, 2);
 246                         if (result == XC_RESULT_SUCCESS) {
 247                                 result = xc_read_i2c_data(priv, buf, 2);
 248                                 if (result == XC_RESULT_SUCCESS) {
 249                                         if ((buf[0] == 0) && (buf[1] == 0)) {
 250                                                 /* busy flag cleared */
 251                                         break;
 252                                         } else {
 253                                                 xc_wait(100); /* wait 5 ms */
 254                                                 WatchDogTimer--;
 255                                         }
 256                                 }
 257                         }
 258                 }
 259         }
 260         if (WatchDogTimer < 0)
 261                 result = XC_RESULT_I2C_WRITE_FAILURE;
 262
 263         return result;
 264 }
 265
 266 static int xc_read_reg(struct xc5000_priv *priv, u16 regAddr, u16 *i2cData)
 267 {
 268         u8 buf[2];
 269         int result;
 270
 271         buf[0] = (regAddr >> 8) & 0xFF;
 272         buf[1] = regAddr & 0xFF;
 273         result = xc_send_i2c_data(priv, buf, 2);
 274         if (result != XC_RESULT_SUCCESS)
 275                 return result;
 276
 277         result = xc_read_i2c_data(priv, buf, 2);
 278         if (result != XC_RESULT_SUCCESS)
 279                 return result;
 280
 281         *i2cData = buf[0] * 256 + buf[1];
 282         return result;
 283 }
 284
 285 static int xc_load_i2c_sequence(struct dvb_frontend *fe, const u8 *i2c_sequence)
 286 {
 287         struct xc5000_priv *priv = fe->tuner_priv;
 288
 289         int i, nbytes_to_send, result;
 290         unsigned int len, pos, index;
 291         u8 buf[XC_MAX_I2C_WRITE_LENGTH];
 292
 293         index=0;
 294         while ((i2c_sequence[index]!=0xFF) || (i2c_sequence[index+1]!=0xFF)) {
 295                 len = i2c_sequence[index]* 256 + i2c_sequence[index+1];
 296                 if (len == 0x0000) {
 297                         /* RESET command */
 298                         result = xc_reset(fe);
 299                         index += 2;
 300                         if (result != XC_RESULT_SUCCESS)
 301                                 return result;
 302                 } else if (len & 0x8000) {
 303                         /* WAIT command */
 304                         xc_wait(len & 0x7FFF);
 305                         index += 2;
 306                 } else {
 307                         /* Send i2c data whilst ensuring individual transactions
 308                          * do not exceed XC_MAX_I2C_WRITE_LENGTH bytes.
 309                          */
 310                         index += 2;
 311                         buf[0] = i2c_sequence[index];
 312                         buf[1] = i2c_sequence[index + 1];
 313                         pos = 2;
 314                         while (pos < len) {
 315                                 if ((len - pos) > XC_MAX_I2C_WRITE_LENGTH - 2) {
 316                                         nbytes_to_send = XC_MAX_I2C_WRITE_LENGTH;
 317                                 } else {
 318                                         nbytes_to_send = (len - pos + 2);
 319                                 }
 320                                 for (i=2; i<nbytes_to_send; i++) {
 321                                         buf[i] = i2c_sequence[index + pos + i - 2];
 322                                 }
 323                                 result = xc_send_i2c_data(priv, buf, nbytes_to_send);
 324
 325                                 if (result != XC_RESULT_SUCCESS)
 326                                         return result;
 327
 328                                 pos += nbytes_to_send - 2;
 329                         }
 330                         index += len;
 331                 }
 332         }
 333         return XC_RESULT_SUCCESS;
 334 }
 335
 336 static int xc_initialize(struct xc5000_priv *priv)
 337 {
 338         dprintk(1, "%s()\n", __func__);
 339         return xc_write_reg(priv, XREG_INIT, 0);
 340 }
 341
 342 static int xc_SetTVStandard(struct xc5000_priv *priv,
 343         u16 VideoMode, u16 AudioMode)
 344 {
 345         int ret;
 346         dprintk(1, "%s(0x%04x,0x%04x)\n", __func__, VideoMode, AudioMode);
 347         dprintk(1, "%s() Standard = %s\n",
 348                 __func__,
 349                 XC5000_Standard[priv->video_standard].Name);
 350
 351         ret = xc_write_reg(priv, XREG_VIDEO_MODE, VideoMode);
 352         if (ret == XC_RESULT_SUCCESS)
 353                 ret = xc_write_reg(priv, XREG_AUDIO_MODE, AudioMode);
 354
 355         return ret;
 356 }
 357
 358 static int xc_shutdown(struct xc5000_priv *priv)
 359 {
 360         return XC_RESULT_SUCCESS;
 361         /* Fixme: cannot bring tuner back alive once shutdown
 362          *        without reloading the driver modules.
 363          *    return xc_write_reg(priv, XREG_POWER_DOWN, 0);
 364          */
 365 }
 366
 367 static int xc_SetSignalSource(struct xc5000_priv *priv, u16 rf_mode)
 368 {
 369         dprintk(1, "%s(%d) Source = %s\n", __func__, rf_mode,
 370                 rf_mode == XC_RF_MODE_AIR ? "ANTENNA" : "CABLE");
 371
 372         if ((rf_mode != XC_RF_MODE_AIR) && (rf_mode != XC_RF_MODE_CABLE))
 373         {
 374                 rf_mode = XC_RF_MODE_CABLE;
 375                 printk(KERN_ERR
 376                         "%s(), Invalid mode, defaulting to CABLE",
 377                         __func__);
 378         }
 379         return xc_write_reg(priv, XREG_SIGNALSOURCE, rf_mode);
 380 }
 381
 382 static const struct dvb_tuner_ops xc5000_tuner_ops;
 383
 384 static int xc_set_RF_frequency(struct xc5000_priv *priv, u32 freq_hz)
 385 {
 386         u16 freq_code;
 387
 388         dprintk(1, "%s(%u)\n", __func__, freq_hz);
 389
 390         if ((freq_hz > xc5000_tuner_ops.info.frequency_max) ||
 391                 (freq_hz < xc5000_tuner_ops.info.frequency_min))
 392                 return XC_RESULT_OUT_OF_RANGE;
 393
 394         freq_code = (u16)(freq_hz / 15625);
 395
 396         return xc_write_reg(priv, XREG_RF_FREQ, freq_code);
 397 }
 398
 399
 400 static int xc_set_IF_frequency(struct xc5000_priv *priv, u32 freq_khz)
 401 {
 402         u32 freq_code = (freq_khz * 1024)/1000;
 403         dprintk(1, "%s(freq_khz = %d) freq_code = 0x%x\n",
 404                 __func__, freq_khz, freq_code);
 405
 406         return xc_write_reg(priv, XREG_IF_OUT, freq_code);
 407 }
 408
 409
 410 static int xc_get_ADC_Envelope(struct xc5000_priv *priv, u16 *adc_envelope)
 411 {
 412         return xc_read_reg(priv, XREG_ADC_ENV, adc_envelope);
 413 }
 414
 415 static int xc_get_frequency_error(struct xc5000_priv *priv, u32 *freq_error_hz)
 416 {
 417         int result;
 418         u16 regData;
 419         u32 tmp;
 420
 421         result = xc_read_reg(priv, XREG_FREQ_ERROR, &regData);
 422         if (result)
 423                 return result;
 424
 425         tmp = (u32)regData;
 426         (*freq_error_hz) = (tmp * 15625) / 1000;
 427         return result;
 428 }
 429
 430 static int xc_get_lock_status(struct xc5000_priv *priv, u16 *lock_status)
 431 {
 432         return xc_read_reg(priv, XREG_LOCK, lock_status);
 433 }
 434
 435 static int xc_get_version(struct xc5000_priv *priv,
 436         u8 *hw_majorversion, u8 *hw_minorversion,
 437         u8 *fw_majorversion, u8 *fw_minorversion)
 438 {
 439         u16 data;
 440         int result;
 441
 442         result = xc_read_reg(priv, XREG_VERSION, &data);
 443         if (result)
 444                 return result;
 445
 446         (*hw_majorversion) = (data >> 12) & 0x0F;
 447         (*hw_minorversion) = (data >>  8) & 0x0F;
 448         (*fw_majorversion) = (data >>  4) & 0x0F;
 449         (*fw_minorversion) = data & 0x0F;
 450
 451         return 0;
 452 }
 453
 454 static int xc_get_hsync_freq(struct xc5000_priv *priv, u32 *hsync_freq_hz)
 455 {
 456         u16 regData;
 457         int result;
 458
 459         result = xc_read_reg(priv, XREG_HSYNC_FREQ, &regData);
 460         if (result)
 461                 return result;
 462
 463         (*hsync_freq_hz) = ((regData & 0x0fff) * 763)/100;
 464         return result;
 465 }
 466
 467 static int xc_get_frame_lines(struct xc5000_priv *priv, u16 *frame_lines)
 468 {
 469         return xc_read_reg(priv, XREG_FRAME_LINES, frame_lines);
 470 }
 471
 472 static int xc_get_quality(struct xc5000_priv *priv, u16 *quality)
 473 {
 474         return xc_read_reg(priv, XREG_QUALITY, quality);
 475 }
 476
 477 static u16 WaitForLock(struct xc5000_priv *priv)
 478 {
 479         u16 lockState = 0;
 480         int watchDogCount = 40;
 481
 482         while ((lockState == 0) && (watchDogCount > 0)) {
 483                 xc_get_lock_status(priv, &lockState);
 484                 if (lockState != 1) {
 485                         xc_wait(5);
 486                         watchDogCount--;
 487                 }
 488         }
 489         return lockState;
 490 }
 491
 492 static int xc_tune_channel(struct xc5000_priv *priv, u32 freq_hz)
 493 {
 494         int found = 0;
 495
 496         dprintk(1, "%s(%u)\n", __func__, freq_hz);
 497
 498         if (xc_set_RF_frequency(priv, freq_hz) != XC_RESULT_SUCCESS)
 499                 return 0;
 500
 501         if (WaitForLock(priv) == 1)
 502                 found = 1;
 503
 504         return found;
 505 }
 506
 507 static int xc5000_readreg(struct xc5000_priv *priv, u16 reg, u16 *val)
 508 {
 509         u8 buf[2] = { reg >> 8, reg & 0xff };
 510         u8 bval[2] = { 0, 0 };
 511         struct i2c_msg msg[2] = {
 512                 { .addr = priv->cfg->i2c_address,
 513                         .flags = 0, .buf = &buf[0], .len = 2 },
 514                 { .addr = priv->cfg->i2c_address,
 515                         .flags = I2C_M_RD, .buf = &bval[0], .len = 2 },
 516         };
 517
 518         if (i2c_transfer(priv->i2c, msg, 2) != 2) {
 519                 printk(KERN_WARNING "xc5000: I2C read failed\n");
 520                 return -EREMOTEIO;
 521         }
 522
 523         *val = (bval[0] << 8) | bval[1];
 524         return 0;
 525 }
 526
 527 static int xc5000_writeregs(struct xc5000_priv *priv, u8 *buf, u8 len)
 528 {
 529         struct i2c_msg msg = { .addr = priv->cfg->i2c_address,
 530                 .flags = 0, .buf = buf, .len = len };
 531
 532         if (i2c_transfer(priv->i2c, &msg, 1) != 1) {
 533                 printk(KERN_ERR "xc5000: I2C write failed (len=%i)\n",
 534                         (int)len);
 535                 return -EREMOTEIO;
 536         }
 537         return 0;
 538 }
 539
 540 static int xc5000_readregs(struct xc5000_priv *priv, u8 *buf, u8 len)
 541 {
 542         struct i2c_msg msg = { .addr = priv->cfg->i2c_address,
 543                 .flags = I2C_M_RD, .buf = buf, .len = len };
 544
 545         if (i2c_transfer(priv->i2c, &msg, 1) != 1) {
 546                 printk(KERN_ERR "xc5000 I2C read failed (len=%i)\n",(int)len);
 547                 return -EREMOTEIO;
 548         }
 549         return 0;
 550 }
 551
 552 static int xc5000_fwupload(struct dvb_frontend* fe)
 553 {
 554         struct xc5000_priv *priv = fe->tuner_priv;
 555         const struct firmware *fw;
 556         int ret;
 557
 558         /* request the firmware, this will block and timeout */
 559         printk(KERN_INFO "xc5000: waiting for firmware upload (%s)...\n",
 560                 XC5000_DEFAULT_FIRMWARE);
 561
 562         ret = request_firmware(&fw, XC5000_DEFAULT_FIRMWARE, &priv->i2c->dev);
 563         if (ret) {
 564                 printk(KERN_ERR "xc5000: Upload failed. (file not found?)\n");
 565                 ret = XC_RESULT_RESET_FAILURE;
 566                 goto out;
 567         } else {
 568                 printk(KERN_INFO "xc5000: firmware read %Zu bytes.\n",
 569                        fw->size);
 570                 ret = XC_RESULT_SUCCESS;
 571         }
 572
 573         if (fw->size != XC5000_DEFAULT_FIRMWARE_SIZE) {
 574                 printk(KERN_ERR "xc5000: firmware incorrect size\n");
 575                 ret = XC_RESULT_RESET_FAILURE;
 576         } else {
 577                 printk(KERN_INFO "xc5000: firmware upload\n");
 578                 ret = xc_load_i2c_sequence(fe,  fw->data );
 579         }
 580
 581 out:
 582         release_firmware(fw);
 583         return ret;
 584 }
 585
 586 static void xc_debug_dump(struct xc5000_priv *priv)
 587 {
 588         u16 adc_envelope;
 589         u32 freq_error_hz = 0;
 590         u16 lock_status;
 591         u32 hsync_freq_hz = 0;
 592         u16 frame_lines;
 593         u16 quality;
 594         u8 hw_majorversion = 0, hw_minorversion = 0;
 595         u8 fw_majorversion = 0, fw_minorversion = 0;
 596
 597         /* Wait for stats to stabilize.
 598          * Frame Lines needs two frame times after initial lock
 599          * before it is valid.
 600          */
 601         xc_wait(100);
 602
 603         xc_get_ADC_Envelope(priv,  &adc_envelope);
 604         dprintk(1, "*** ADC envelope (0-1023) = %d\n", adc_envelope);
 605
 606         xc_get_frequency_error(priv, &freq_error_hz);
 607         dprintk(1, "*** Frequency error = %d Hz\n", freq_error_hz);
 608
 609         xc_get_lock_status(priv,  &lock_status);
 610         dprintk(1, "*** Lock status (0-Wait, 1-Locked, 2-No-signal) = %d\n",
 611                 lock_status);
 612
 613         xc_get_version(priv,  &hw_majorversion, &hw_minorversion,
 614                 &fw_majorversion, &fw_minorversion);
 615         dprintk(1, "*** HW: V%02x.%02x, FW: V%02x.%02x\n",
 616                 hw_majorversion, hw_minorversion,
 617                 fw_majorversion, fw_minorversion);
 618
 619         xc_get_hsync_freq(priv,  &hsync_freq_hz);
 620         dprintk(1, "*** Horizontal sync frequency = %d Hz\n", hsync_freq_hz);
 621
 622         xc_get_frame_lines(priv,  &frame_lines);
 623         dprintk(1, "*** Frame lines = %d\n", frame_lines);
 624
 625         xc_get_quality(priv,  &quality);
 626         dprintk(1, "*** Quality (0:<8dB, 7:>56dB) = %d\n", quality);
 627 }
 628
 629 static int xc5000_set_params(struct dvb_frontend *fe,
 630         struct dvb_frontend_parameters *params)
 631 {
 632         struct xc5000_priv *priv = fe->tuner_priv;
 633         int ret;
 634
 635         dprintk(1, "%s() frequency=%d (Hz)\n", __func__, params->frequency);
 636
 637         switch(params->u.vsb.modulation) {
 638         case VSB_8:
 639         case VSB_16:
 640                 dprintk(1, "%s() VSB modulation\n", __func__);
 641                 priv->rf_mode = XC_RF_MODE_AIR;
 642                 priv->freq_hz = params->frequency - 1750000;
 643                 priv->bandwidth = BANDWIDTH_6_MHZ;
 644                 priv->video_standard = DTV6;
 645                 break;
 646         case QAM_64:
 647         case QAM_256:
 648         case QAM_AUTO:
 649                 dprintk(1, "%s() QAM modulation\n", __func__);
 650                 priv->rf_mode = XC_RF_MODE_CABLE;
 651                 priv->freq_hz = params->frequency - 1750000;
 652                 priv->bandwidth = BANDWIDTH_6_MHZ;
 653                 priv->video_standard = DTV6;
 654                 break;
 655         default:
 656                 return -EINVAL;
 657         }
 658
 659         dprintk(1, "%s() frequency=%d (compensated)\n",
 660                 __func__, priv->freq_hz);
 661
 662         ret = xc_SetSignalSource(priv, priv->rf_mode);
 663         if (ret != XC_RESULT_SUCCESS) {
 664                 printk(KERN_ERR
 665                         "xc5000: xc_SetSignalSource(%d) failed\n",
 666                         priv->rf_mode);
 667                 return -EREMOTEIO;
 668         }
 669
 670         ret = xc_SetTVStandard(priv,
 671                 XC5000_Standard[priv->video_standard].VideoMode,
 672                 XC5000_Standard[priv->video_standard].AudioMode);
 673         if (ret != XC_RESULT_SUCCESS) {
 674                 printk(KERN_ERR "xc5000: xc_SetTVStandard failed\n");
 675                 return -EREMOTEIO;
 676         }
 677
 678         ret = xc_set_IF_frequency(priv, priv->cfg->if_khz);
 679         if (ret != XC_RESULT_SUCCESS) {
 680                 printk(KERN_ERR "xc5000: xc_Set_IF_frequency(%d) failed\n",
 681                         priv->cfg->if_khz);
 682                 return -EIO;
 683         }
 684
 685         xc_tune_channel(priv, priv->freq_hz);
 686
 687         if (debug)
 688                 xc_debug_dump(priv);
 689
 690         return 0;
 691 }
 692
 693 static int xc5000_is_firmware_loaded(struct dvb_frontend *fe)
 694 {
 695         struct xc5000_priv *priv = fe->tuner_priv;
 696         int ret;
 697         u16 id;
 698
 699         ret = xc5000_readreg(priv, XREG_PRODUCT_ID, &id);
 700         if (ret == XC_RESULT_SUCCESS) {
 701                 if (id == XC_PRODUCT_ID_FW_NOT_LOADED)
 702                         ret = XC_RESULT_RESET_FAILURE;
 703                 else
 704                         ret = XC_RESULT_SUCCESS;
 705         }
 706
 707         dprintk(1, "%s() returns %s id = 0x%x\n", __func__,
 708                 ret == XC_RESULT_SUCCESS ? "True" : "False", id);
 709         return ret;
 710 }
 711
 712 static int xc_load_fw_and_init_tuner(struct dvb_frontend *fe);
 713
 714 static int xc5000_set_analog_params(struct dvb_frontend *fe,
 715         struct analog_parameters *params)
 716 {
 717         struct xc5000_priv *priv = fe->tuner_priv;
 718         int ret;
 719
 720         if (xc5000_is_firmware_loaded(fe) != XC_RESULT_SUCCESS)
 721                 xc_load_fw_and_init_tuner(fe);
 722
 723         dprintk(1, "%s() frequency=%d (in units of 62.5khz)\n",
 724                 __func__, params->frequency);
 725
 726         priv->rf_mode = XC_RF_MODE_CABLE; /* Fix me: it could be air. */
 727
 728         /* params->frequency is in units of 62.5khz */
 729         priv->freq_hz = params->frequency * 62500;
 730
 731         /* FIX ME: Some video standards may have several possible audio
 732                    standards. We simply default to one of them here.
 733          */
 734         if(params->std & V4L2_STD_MN) {
 735                 /* default to BTSC audio standard */
 736                 priv->video_standard = MN_NTSC_PAL_BTSC;
 737                 goto tune_channel;
 738         }
 739
 740         if(params->std & V4L2_STD_PAL_BG) {
 741                 /* default to NICAM audio standard */
 742                 priv->video_standard = BG_PAL_NICAM;
 743                 goto tune_channel;
 744         }
 745
 746         if(params->std & V4L2_STD_PAL_I) {
 747                 /* default to NICAM audio standard */
 748                 priv->video_standard = I_PAL_NICAM;
 749                 goto tune_channel;
 750         }
 751
 752         if(params->std & V4L2_STD_PAL_DK) {
 753                 /* default to NICAM audio standard */
 754                 priv->video_standard = DK_PAL_NICAM;
 755                 goto tune_channel;
 756         }
 757
 758         if(params->std & V4L2_STD_SECAM_DK) {
 759                 /* default to A2 DK1 audio standard */
 760                 priv->video_standard = DK_SECAM_A2DK1;
 761                 goto tune_channel;
 762         }
 763
 764         if(params->std & V4L2_STD_SECAM_L) {
 765                 priv->video_standard = L_SECAM_NICAM;
 766                 goto tune_channel;
 767         }
 768
 769         if(params->std & V4L2_STD_SECAM_LC) {
 770                 priv->video_standard = LC_SECAM_NICAM;
 771                 goto tune_channel;
 772         }
 773
 774 tune_channel:
 775         ret = xc_SetSignalSource(priv, priv->rf_mode);
 776         if (ret != XC_RESULT_SUCCESS) {
 777         printk(KERN_ERR
 778                         "xc5000: xc_SetSignalSource(%d) failed\n",
 779                         priv->rf_mode);
 780                 return -EREMOTEIO;
 781         }
 782
 783         ret = xc_SetTVStandard(priv,
 784                 XC5000_Standard[priv->video_standard].VideoMode,
 785                 XC5000_Standard[priv->video_standard].AudioMode);
 786         if (ret != XC_RESULT_SUCCESS) {
 787                 printk(KERN_ERR "xc5000: xc_SetTVStandard failed\n");
 788                 return -EREMOTEIO;
 789         }
 790
 791         xc_tune_channel(priv, priv->freq_hz);
 792
 793         if (debug)
 794                 xc_debug_dump(priv);
 795
 796         return 0;
 797 }
 798
 799 static int xc5000_get_frequency(struct dvb_frontend *fe, u32 *freq)
 800 {
 801         struct xc5000_priv *priv = fe->tuner_priv;
 802         dprintk(1, "%s()\n", __func__);
 803         *freq = priv->freq_hz;
 804         return 0;
 805 }
 806
 807 static int xc5000_get_bandwidth(struct dvb_frontend *fe, u32 *bw)
 808 {
 809         struct xc5000_priv *priv = fe->tuner_priv;
 810         dprintk(1, "%s()\n", __func__);
 811
 812         *bw = priv->bandwidth;
 813         return 0;
 814 }
 815
 816 static int xc5000_get_status(struct dvb_frontend *fe, u32 *status)
 817 {
 818         struct xc5000_priv *priv = fe->tuner_priv;
 819         u16 lock_status = 0;
 820
 821         xc_get_lock_status(priv, &lock_status);
 822
 823         dprintk(1, "%s() lock_status = 0x%08x\n", __func__, lock_status);
 824
 825         *status = lock_status;
 826
 827         return 0;
 828 }
 829
 830 static int xc_load_fw_and_init_tuner(struct dvb_frontend *fe)
 831 {
 832         struct xc5000_priv *priv = fe->tuner_priv;
 833         int ret = 0;
 834
 835         if (xc5000_is_firmware_loaded(fe) != XC_RESULT_SUCCESS) {
 836                 ret = xc5000_fwupload(fe);
 837                 if (ret != XC_RESULT_SUCCESS)
 838                         return ret;
 839         }
 840
 841         /* Start the tuner self-calibration process */
 842         ret |= xc_initialize(priv);
 843
 844         /* Wait for calibration to complete.
 845          * We could continue but XC5000 will clock stretch subsequent
 846          * I2C transactions until calibration is complete.  This way we
 847          * don't have to rely on clock stretching working.
 848          */
 849         xc_wait( 100 );
 850
 851         /* Default to "CABLE" mode */
 852         ret |= xc_write_reg(priv, XREG_SIGNALSOURCE, XC_RF_MODE_CABLE);
 853
 854         return ret;
 855 }
 856
 857 static int xc5000_sleep(struct dvb_frontend *fe)
 858 {
 859         struct xc5000_priv *priv = fe->tuner_priv;
 860         int ret;
 861
 862         dprintk(1, "%s()\n", __func__);
 863
 864         /* On Pinnacle PCTV HD 800i, the tuner cannot be reinitialized
 865          * once shutdown without reloading the driver. Maybe I am not
 866          * doing something right.
 867          *
 868          */
 869
 870         ret = xc_shutdown(priv);
 871         if(ret != XC_RESULT_SUCCESS) {
 872                 printk(KERN_ERR
 873                         "xc5000: %s() unable to shutdown tuner\n",
 874                         __func__);
 875                 return -EREMOTEIO;
 876         }
 877         else {
 878                 return XC_RESULT_SUCCESS;
 879         }
 880 }
 881
 882 static int xc5000_init(struct dvb_frontend *fe)
 883 {
 884         struct xc5000_priv *priv = fe->tuner_priv;
 885         dprintk(1, "%s()\n", __func__);
 886
 887         if (xc_load_fw_and_init_tuner(fe) != XC_RESULT_SUCCESS) {
 888                 printk(KERN_ERR "xc5000: Unable to initialise tuner\n");
 889                 return -EREMOTEIO;
 890         }
 891
 892         if (debug)
 893                 xc_debug_dump(priv);
 894
 895         return 0;
 896 }
 897
 898 static int xc5000_release(struct dvb_frontend *fe)
 899 {
 900         dprintk(1, "%s()\n", __func__);
 901         kfree(fe->tuner_priv);
 902         fe->tuner_priv = NULL;
 903         return 0;
 904 }
 905
 906 static const struct dvb_tuner_ops xc5000_tuner_ops = {
 907         .info = {
 908                 .name           = "Xceive XC5000",
 909                 .frequency_min  =    1000000,
 910                 .frequency_max  = 1023000000,
 911                 .frequency_step =      50000,
 912         },
 913
 914         .release           = xc5000_release,
 915         .init              = xc5000_init,
 916         .sleep             = xc5000_sleep,
 917
 918         .set_params        = xc5000_set_params,
 919         .set_analog_params = xc5000_set_analog_params,
 920         .get_frequency     = xc5000_get_frequency,
 921         .get_bandwidth     = xc5000_get_bandwidth,
 922         .get_status        = xc5000_get_status
 923 };
 924
 925 struct dvb_frontend *xc5000_attach(struct dvb_frontend *fe,
 926                                    struct i2c_adapter *i2c,
 927                                    struct xc5000_config *cfg, void *devptr)
 928 {
 929         struct xc5000_priv *priv = NULL;
 930         u16 id = 0;
 931
 932         dprintk(1, "%s()\n", __func__);
 933
 934         priv = kzalloc(sizeof(struct xc5000_priv), GFP_KERNEL);
 935         if (priv == NULL)
 936                 return NULL;
 937
 938         priv->cfg = cfg;
 939         priv->bandwidth = BANDWIDTH_6_MHZ;
 940         priv->i2c = i2c;
 941         priv->devptr = devptr;
 942
 943         /* Check if firmware has been loaded. It is possible that another
 944            instance of the driver has loaded the firmware.
 945          */
 946         if (xc5000_readreg(priv, XREG_PRODUCT_ID, &id) != 0) {
 947                 kfree(priv);
 948                 return NULL;
 949         }
 950
 951         switch(id) {
 952         case XC_PRODUCT_ID_FW_LOADED:
 953                 printk(KERN_INFO
 954                         "xc5000: Successfully identified at address 0x%02x\n",
 955                         cfg->i2c_address);
 956                 printk(KERN_INFO
 957                         "xc5000: Firmware has been loaded previously\n");
 958                 break;
 959         case XC_PRODUCT_ID_FW_NOT_LOADED:
 960                 printk(KERN_INFO
 961                         "xc5000: Successfully identified at address 0x%02x\n",
 962                         cfg->i2c_address);
 963                 printk(KERN_INFO
 964                         "xc5000: Firmware has not been loaded previously\n");
 965                 break;
 966         default:
 967                 printk(KERN_ERR
 968                         "xc5000: Device not found at addr 0x%02x (0x%x)\n",
 969                         cfg->i2c_address, id);
 970                 kfree(priv);
 971                 return NULL;
 972         }
 973
 974         memcpy(&fe->ops.tuner_ops, &xc5000_tuner_ops,
 975                 sizeof(struct dvb_tuner_ops));
 976
 977         fe->tuner_priv = priv;
 978
 979         if (xc5000_load_fw_on_attach)
 980                 xc5000_init(fe);
 981
 982         return fe;
 983 }
 984 EXPORT_SYMBOL(xc5000_attach);
 985
 986 MODULE_AUTHOR("Steven Toth");
 987 MODULE_DESCRIPTION("Xceive xc5000 silicon tuner driver");
 988 MODULE_LICENSE("GPL");