V4L/DVB (7042): xc5000: Tuner analog support

From Zhang: This an updated patch that adds analog support for
the xc5000 tuner driver. it was tested on a Pinnacle PCTV HD 800i
card (patches to follow).

Patch commited as-is, cleanup to follow ... Steve.

Signed-off-by: Chaogui Zhang <czhang1974@gmail.com>
Signed-off-by: Steven Toth <stoth@hauppauge.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@infradead.org>

6 files changed, 213 insertions, 38 deletions

diff --git a/Documentation/video4linux/CARDLIST.tuner b/Documentation/video4linux/CARDLIST.tuner
index 2211c8eac643..0e2394695bb8 100644
--- a/Documentation/video4linux/CARDLIST.tuner
+++ b/Documentation/video4linux/CARDLIST.tuner
@@ -73,3 +73,4 @@ tuner=71 - Xceive xc2028/xc3028 tuner
 tuner=72 - Thomson FE6600
 tuner=73 - Samsung TCPG 6121P30A
 tuner=75 - Philips TEA5761 FM Radio
+tuner=76 - Xceive 5000 tuner
diff --git a/drivers/media/dvb/frontends/xc5000.c b/drivers/media/dvb/frontends/xc5000.c
index a036530ee4b4..28048d5307a2 100644
--- a/drivers/media/dvb/frontends/xc5000.c
+++ b/drivers/media/dvb/frontends/xc5000.c
@@ -22,6 +22,7 @@
 
 #include <linux/module.h>
 #include <linux/moduleparam.h>
+#include <linux/videodev2.h>
 #include <linux/delay.h>
 #include <linux/dvb/frontend.h>
 #include <linux/i2c.h>
@@ -56,6 +57,10 @@ MODULE_PARM_DESC(debug, "Turn on/off debugging (default:off).");
 #define XC_RESULT_I2C_READ_FAILURE      3
 #define XC_RESULT_OUT_OF_RANGE          5
 
+/* Product id */
+#define XC_PRODUCT_ID_FW_NOT_LOADED     0x2000
+#define XC_PRODUCT_ID_FW_LOADED         0x1388
+
 /* Registers */
 #define XREG_INIT         0x00
 #define XREG_VIDEO_MODE   0x01
@@ -122,7 +127,29 @@ typedef struct {
 } XC_TV_STANDARD;
 
 /* Tuner standards */
-#define DTV6    17
+#define MN_NTSC_PAL_BTSC        0
+#define MN_NTSC_PAL_A2          1
+#define MN_NTSC_PAL_EIAJ        2
+#define MN_NTSC_PAL_Mono        3
+#define BG_PAL_A2               4
+#define BG_PAL_NICAM            5
+#define BG_PAL_MONO             6
+#define I_PAL_NICAM             7
+#define I_PAL_NICAM_MONO        8
+#define DK_PAL_A2               9
+#define DK_PAL_NICAM            10
+#define DK_PAL_MONO             11
+#define DK_SECAM_A2DK1          12
+#define DK_SECAM_A2LDK3         13
+#define DK_SECAM_A2MONO         14
+#define L_SECAM_NICAM           15
+#define LC_SECAM_NICAM          16
+#define DTV6                    17
+#define DTV8                    18
+#define DTV7_8                  19
+#define DTV7                    20
+#define FM_Radio_INPUT2         21
+#define FM_Radio_INPUT1         22
 
 XC_TV_STANDARD XC5000_Standard[MAX_TV_STANDARD] = {
         {"M/N-NTSC/PAL-BTSC", 0x0400, 0x8020},
@@ -184,12 +211,13 @@ static void xc5000_TunerReset(struct dvb_frontend *fe)
 
         dprintk(1, "%s()\n", __FUNCTION__);
 
-        if (priv->cfg->tuner_reset) {
-                ret = priv->cfg->tuner_reset(fe);
+        if (priv->cfg->tuner_callback) {
+                ret = priv->cfg->tuner_callback(priv->cfg->video_dev,
+                                                XC5000_TUNER_RESET, 0);
                 if (ret)
                         printk(KERN_ERR "xc5000: reset failed\n");
         } else
-                printk(KERN_ERR "xc5000: no tuner reset function, fatal\n");
+                printk(KERN_ERR "xc5000: no tuner reset callback function, fatal\n");
 }
 
 static int xc_write_reg(struct xc5000_priv *priv, u16 regAddr, u16 i2cData)
@@ -259,7 +287,6 @@ static int xc_load_i2c_sequence(struct dvb_frontend *fe, u8 i2c_sequence[])
 
         index=0;
         while ((i2c_sequence[index]!=0xFF) || (i2c_sequence[index+1]!=0xFF)) {
-
                 len = i2c_sequence[index]* 256 + i2c_sequence[index+1];
                 if (len == 0x0000) {
                         /* RESET command */
@@ -311,7 +338,7 @@ static int xc_SetTVStandard(struct xc5000_priv *priv,
         u16 VideoMode, u16 AudioMode)
 {
         int ret;
-        dprintk(1, "%s(%d,%d)\n", __FUNCTION__, VideoMode, AudioMode);
+        dprintk(1, "%s(0x%04x,0x%04x)\n", __FUNCTION__, VideoMode, AudioMode);
         dprintk(1, "%s() Standard = %s\n",
                 __FUNCTION__,
                 XC5000_Standard[priv->video_standard].Name);
@@ -325,7 +352,11 @@ static int xc_SetTVStandard(struct xc5000_priv *priv,
 
 static int xc_shutdown(struct xc5000_priv *priv)
 {
-        return xc_write_reg(priv, XREG_POWER_DOWN, 0);
+        return 0;
+        /* Fixme: cannot bring tuner back alive once shutdown
+         *        without reloading the driver modules.
+         *    return xc_write_reg(priv, XREG_POWER_DOWN, 0);
+         */
 }
 
 static int xc_SetSignalSource(struct xc5000_priv *priv, u16 rf_mode)
@@ -349,7 +380,7 @@ static int xc_set_RF_frequency(struct xc5000_priv *priv, u32 freq_hz)
 {
         u16 freq_code;
 
-        dprintk(1, "%s(%d)\n", __FUNCTION__, freq_hz);
+        dprintk(1, "%s(%u)\n", __FUNCTION__, freq_hz);
 
         if ((freq_hz > xc5000_tuner_ops.info.frequency_max) ||
                 (freq_hz < xc5000_tuner_ops.info.frequency_min))
@@ -457,7 +488,7 @@ static int xc_tune_channel(struct xc5000_priv *priv, u32 freq_hz)
 {
         int found = 0;
 
-        dprintk(1, "%s(%d)\n", __FUNCTION__, freq_hz);
+        dprintk(1, "%s(%u)\n", __FUNCTION__, freq_hz);
 
         if (xc_set_RF_frequency(priv, freq_hz) != XC_RESULT_SUCCESS)
                 return 0;
@@ -480,7 +511,7 @@ static int xc5000_readreg(struct xc5000_priv *priv, u16 reg, u16 *val)
         };
 
         if (i2c_transfer(priv->i2c, msg, 2) != 2) {
-                printk(KERN_WARNING "xc5000 I2C read failed\n");
+                printk(KERN_WARNING "xc5000: I2C read failed\n");
                 return -EREMOTEIO;
         }
 
@@ -494,7 +525,7 @@ static int xc5000_writeregs(struct xc5000_priv *priv, u8 *buf, u8 len)
                 .flags = 0, .buf = buf, .len = len };
 
         if (i2c_transfer(priv->i2c, &msg, 1) != 1) {
-                printk(KERN_ERR "xc5000 I2C write failed (len=%i)\n",
+                printk(KERN_ERR "xc5000: I2C write failed (len=%i)\n",
                         (int)len);
                 return -EREMOTEIO;
         }
@@ -519,16 +550,11 @@ static int xc5000_fwupload(struct dvb_frontend* fe)
         const struct firmware *fw;
         int ret;
 
-        if (!priv->cfg->request_firmware) {
-                printk(KERN_ERR "xc5000: no firmware callback, fatal\n");
-                return -EIO;
-        }
-
         /* request the firmware, this will block and timeout */
         printk(KERN_INFO "xc5000: waiting for firmware upload (%s)...\n",
                 XC5000_DEFAULT_FIRMWARE);
 
-        ret = priv->cfg->request_firmware(fe, &fw, XC5000_DEFAULT_FIRMWARE);
+        ret = request_firmware(&fw, XC5000_DEFAULT_FIRMWARE, &priv->i2c->dev);
         if (ret) {
                 printk(KERN_ERR "xc5000: Upload failed. (file not found?)\n");
                 ret = XC_RESULT_RESET_FAILURE;
@@ -601,7 +627,6 @@ static int xc5000_set_params(struct dvb_frontend *fe,
 
         dprintk(1, "%s() frequency=%d (Hz)\n", __FUNCTION__, params->frequency);
 
-
         switch(params->u.vsb.modulation) {
         case VSB_8:
         case VSB_16:
@@ -658,6 +683,93 @@ static int xc5000_set_params(struct dvb_frontend *fe,
         return 0;
 }
 
+static int xc_load_fw_and_init_tuner(struct dvb_frontend *fe);
+
+static int xc5000_set_analog_params(struct dvb_frontend *fe,
+        struct analog_parameters *params)
+{
+        struct xc5000_priv *priv = fe->tuner_priv;
+        int ret;
+
+        if(priv->fwloaded == 0)
+                xc_load_fw_and_init_tuner(fe);
+
+        dprintk(1, "%s() frequency=%d (in units of 62.5khz)\n",
+                __FUNCTION__, params->frequency);
+
+        priv->rf_mode = XC_RF_MODE_CABLE; /* Fix me: it could be air. */
+
+        /* params->frequency is in units of 62.5khz */
+        priv->freq_hz = params->frequency * 62500;
+
+        /* FIX ME: Some video standards may have several possible audio
+                   standards. We simply default to one of them here.
+         */
+        if(params->std & V4L2_STD_MN) {
+                /* default to BTSC audio standard */
+                priv->video_standard = MN_NTSC_PAL_BTSC;
+                goto tune_channel;
+        }
+
+        if(params->std & V4L2_STD_PAL_BG) {
+                /* default to NICAM audio standard */
+                priv->video_standard = BG_PAL_NICAM;
+                goto tune_channel;
+        }
+
+        if(params->std & V4L2_STD_PAL_I) {
+                /* default to NICAM audio standard */
+                priv->video_standard = I_PAL_NICAM;
+                goto tune_channel;
+        }
+
+        if(params->std & V4L2_STD_PAL_DK) {
+                /* default to NICAM audio standard */
+                priv->video_standard = DK_PAL_NICAM;
+                goto tune_channel;
+        }
+
+        if(params->std & V4L2_STD_SECAM_DK) {
+                /* default to A2 DK1 audio standard */
+                priv->video_standard = DK_SECAM_A2DK1;
+                goto tune_channel;
+        }
+
+        if(params->std & V4L2_STD_SECAM_L) {
+                priv->video_standard = L_SECAM_NICAM;
+                goto tune_channel;
+        }
+
+        if(params->std & V4L2_STD_SECAM_LC) {
+                priv->video_standard = LC_SECAM_NICAM;
+                goto tune_channel;
+        }
+
+tune_channel:
+        ret = xc_SetSignalSource(priv, priv->rf_mode);
+        if (ret != XC_RESULT_SUCCESS) {
+        printk(KERN_ERR
+                        "xc5000: xc_SetSignalSource(%d) failed\n",
+                        priv->rf_mode);
+                return -EREMOTEIO;
+        }
+
+        ret = xc_SetTVStandard(priv,
+                XC5000_Standard[priv->video_standard].VideoMode,
+                XC5000_Standard[priv->video_standard].AudioMode);
+        if (ret != XC_RESULT_SUCCESS) {
+                printk(KERN_ERR "xc5000: xc_SetTVStandard failed\n");
+                return -EREMOTEIO;
+        }
+
+        xc_tune_channel(priv, priv->freq_hz);
+
+        if (debug)
+                xc_debug_dump(priv);
+
+        return 0;
+}
+
 static int xc5000_get_frequency(struct dvb_frontend *fe, u32 *freq)
 {
         struct xc5000_priv *priv = fe->tuner_priv;
@@ -670,6 +782,7 @@ static int xc5000_get_bandwidth(struct dvb_frontend *fe, u32 *bw)
 {
         struct xc5000_priv *priv = fe->tuner_priv;
         dprintk(1, "%s()\n", __FUNCTION__);
+
         *bw = priv->bandwidth;
         return 0;
 }
@@ -691,13 +804,12 @@ static int xc5000_get_status(struct dvb_frontend *fe, u32 *status)
 static int xc_load_fw_and_init_tuner(struct dvb_frontend *fe)
 {
         struct xc5000_priv *priv = fe->tuner_priv;
-        int ret;
+        int ret = 0;
 
         if (priv->fwloaded == 0) {
                 ret = xc5000_fwupload(fe);
                 if (ret != XC_RESULT_SUCCESS)
                         return ret;
-
                 priv->fwloaded = 1;
         }
 
@@ -720,9 +832,27 @@ static int xc_load_fw_and_init_tuner(struct dvb_frontend *fe)
 static int xc5000_sleep(struct dvb_frontend *fe)
 {
         struct xc5000_priv *priv = fe->tuner_priv;
+        int ret;
+
         dprintk(1, "%s()\n", __FUNCTION__);
 
-        return xc_shutdown(priv);
+        /* On Pinnacle PCTV HD 800i, the tuner cannot be reinitialized
+         * once shutdown without reloading the driver. Maybe I am not
+         * doing something right.
+         *
+         */
+
+        ret = xc_shutdown(priv);
+        if(ret != XC_RESULT_SUCCESS) {
+                printk(KERN_ERR
+                        "xc5000: %s() unable to shutdown tuner\n",
+                        __FUNCTION__);
+                return -EREMOTEIO;
+        }
+        else {
+                /* priv->fwloaded = 0; */
+                return XC_RESULT_SUCCESS;
+        }
 }
 
 static int xc5000_init(struct dvb_frontend *fe)
@@ -757,14 +887,15 @@ static const struct dvb_tuner_ops xc5000_tuner_ops = {
                 .frequency_step =      50000,
         },
 
-        .release       = xc5000_release,
-        .init          = xc5000_init,
-        .sleep         = xc5000_sleep,
+        .release           = xc5000_release,
+        .init              = xc5000_init,
+        .sleep             = xc5000_sleep,
 
-        .set_params    = xc5000_set_params,
-        .get_frequency = xc5000_get_frequency,
-        .get_bandwidth = xc5000_get_bandwidth,
-        .get_status    = xc5000_get_status
+        .set_params        = xc5000_set_params,
+        .set_analog_params = xc5000_set_analog_params,
+        .get_frequency     = xc5000_get_frequency,
+        .get_bandwidth     = xc5000_get_bandwidth,
+        .get_status        = xc5000_get_status
 };
 
 struct dvb_frontend * xc5000_attach(struct dvb_frontend *fe,
@@ -783,14 +914,33 @@ struct dvb_frontend * xc5000_attach(struct dvb_frontend *fe,
         priv->cfg = cfg;
         priv->bandwidth = BANDWIDTH_6_MHZ;
         priv->i2c = i2c;
-        priv->fwloaded = 0;
 
+        /* Check if firmware has been loaded. It is possible that another
+           instance of the driver has loaded the firmware.
+         */
         if (xc5000_readreg(priv, XREG_PRODUCT_ID, &id) != 0) {
                 kfree(priv);
                 return NULL;
         }
 
-        if ((id != 0x2000) && (id != 0x1388)) {
+        switch(id) {
+        case XC_PRODUCT_ID_FW_LOADED:
+                printk(KERN_INFO
+                        "xc5000: Successfully identified at address 0x%02x\n",
+                        cfg->i2c_address);
+                printk(KERN_INFO
+                        "xc5000: Firmware has been loaded previously\n");
+                priv->fwloaded = 1;
+                break;
+        case XC_PRODUCT_ID_FW_NOT_LOADED:
+                printk(KERN_INFO
+                        "xc5000: Successfully identified at address 0x%02x\n",
+                        cfg->i2c_address);
+                printk(KERN_INFO
+                        "xc5000: Firmware has not been loaded previously\n");
+                priv->fwloaded = 0;
+                break;
+        default:
                 printk(KERN_ERR
                         "xc5000: Device not found at addr 0x%02x (0x%x)\n",
                         cfg->i2c_address, id);
@@ -798,9 +948,6 @@ struct dvb_frontend * xc5000_attach(struct dvb_frontend *fe,
                 return NULL;
         }
 
-        printk(KERN_INFO "xc5000: successfully identified at address 0x%02x\n",
-                cfg->i2c_address);
-
         memcpy(&fe->ops.tuner_ops, &xc5000_tuner_ops,
                 sizeof(struct dvb_tuner_ops));
 
diff --git a/drivers/media/dvb/frontends/xc5000.h b/drivers/media/dvb/frontends/xc5000.h
index 941b31948133..85b2d438fa41 100644
--- a/drivers/media/dvb/frontends/xc5000.h
+++ b/drivers/media/dvb/frontends/xc5000.h
@@ -28,13 +28,15 @@ struct dvb_frontend;
 struct i2c_adapter;
 
 struct xc5000_config {
-        u8  i2c_address;
-        u32 if_khz;
-        int (*request_firmware)(struct dvb_frontend *fe,
-                const struct firmware **fw, char *name);
-        int (*tuner_reset)(struct dvb_frontend* fe);
+        u8   i2c_address;
+        u32  if_khz;
+        void *video_dev;
+        int  (*tuner_callback) (void *dev, int command, int arg);
 };
 
+/* xc5000 callback command */
+#define XC5000_TUNER_RESET              0
+
 #if defined(CONFIG_DVB_TUNER_XC5000) || defined(CONFIG_DVB_TUNER_XC5000_MODULE)
 extern struct dvb_frontend* xc5000_attach(struct dvb_frontend *fe,
                                           struct i2c_adapter *i2c,
diff --git a/drivers/media/video/tuner-core.c b/drivers/media/video/tuner-core.c
index 35976e6cb1b8..16cdeeafeb6c 100644
--- a/drivers/media/video/tuner-core.c
+++ b/drivers/media/video/tuner-core.c
@@ -27,6 +27,7 @@
 #include "tuner-xc2028.h"
 #include "tuner-simple.h"
 #include "tda9887.h"
+#include "xc5000.h"
 
 #define UNSET (-1U)
 
@@ -329,6 +330,8 @@ static void attach_tda829x(struct tuner *t)
         tda829x_attach(&t->fe, t->i2c->adapter, t->i2c->addr, &cfg);
 }
 
+static struct xc5000_config xc5000_cfg;
+
 static void set_type(struct i2c_client *c, unsigned int type,
                      unsigned int new_mode_mask, unsigned int new_config,
                      int (*tuner_callback) (void *dev, int command,int arg))
@@ -428,6 +431,23 @@ static void set_type(struct i2c_client *c, unsigned int type,
         case TUNER_TDA9887:
                 tda9887_attach(&t->fe, t->i2c->adapter, t->i2c->addr);
                 break;
+        case TUNER_XC5000:
+                xc5000_cfg.i2c_address    = t->i2c->addr;
+                xc5000_cfg.if_khz         = 5380;
+                xc5000_cfg.video_dev      = c->adapter->algo_data;
+                xc5000_cfg.tuner_callback = t->tuner_callback;
+                if (!xc5000_attach(&t->fe, t->i2c->adapter, &xc5000_cfg)) {
+                        t->type = TUNER_ABSENT;
+                        t->mode_mask = T_UNINITIALIZED;
+                        return;
+                }
+                {
+                struct dvb_tuner_ops *xc_tuner_ops;
+                xc_tuner_ops = &t->fe.ops.tuner_ops;
+                if(xc_tuner_ops->init != NULL)
+                        xc_tuner_ops->init(&t->fe);
+                }
+                break;
         default:
                 attach_simple_tuner(t);
                 break;
diff --git a/drivers/media/video/tuner-types.c b/drivers/media/video/tuner-types.c
index e2cd05a05802..883047f9c28c 100644
--- a/drivers/media/video/tuner-types.c
+++ b/drivers/media/video/tuner-types.c
@@ -1475,6 +1475,10 @@ struct tunertype tuners[] = {
                 .name   = "Philips TEA5761 FM Radio",
                 /* see tea5767.c for details */
         },
+        [TUNER_XC5000] = { /* Xceive 5000 */
+                .name   = "Xceive 5000 tuner",
+                /* see xc5000.c for details */
+        },
 };
 
 unsigned const int tuner_count = ARRAY_SIZE(tuners);
diff --git a/include/media/tuner.h b/include/media/tuner.h
index 97be269afbee..1bf24a6ed8f1 100644
--- a/include/media/tuner.h
+++ b/include/media/tuner.h
@@ -121,6 +121,7 @@
 #define TUNER_SAMSUNG_TCPG_6121P30A     73      /* Hauppauge PVR-500 PAL */
 #define TUNER_TDA9887                   74      /* This tuner should be used only internally */
 #define TUNER_TEA5761                   75      /* Only FM Radio Tuner */
+#define TUNER_XC5000                    76      /* Xceive Silicon Tuner */
 
 /* tv card specific */
 #define TDA9887_PRESENT                 (1<<0)