Merge git://git.kernel.org/pub/scm/linux/kernel/git/mason/btrfs-unstable
[pandora-kernel.git] / drivers / media / video / tuner-core.c
index dcf03fa..9363ed9 100644 (file)
@@ -1,7 +1,17 @@
 /*
- *
  * i2c tv tuner chip device driver
  * core core, i.e. kernel interfaces, registering and so on
+ *
+ * Copyright(c) by Ralph Metzler, Gerd Knorr, Gunther Mayer
+ *
+ * Copyright(c) 2005-2011 by Mauro Carvalho Chehab
+ *     - Added support for a separate Radio tuner
+ *     - Major rework and cleanups at the code
+ *
+ * This driver supports many devices and the idea is to let the driver
+ * detect which device is present. So rather than listing all supported
+ * devices here, we pretend to support a single, fake device type that will
+ * handle both radio and analog TV tuning.
  */
 
 #include <linux/module.h>
@@ -67,6 +77,7 @@ module_param_string(ntsc, ntsc, sizeof(ntsc), 0644);
  */
 
 static LIST_HEAD(tuner_list);
+static const struct v4l2_subdev_ops tuner_ops;
 
 /*
  * Debug macros
@@ -124,6 +135,13 @@ struct tuner {
        const char          *name;
 };
 
+/*
+ * Function prototypes
+ */
+
+static void set_tv_freq(struct i2c_client *c, unsigned int freq);
+static void set_radio_freq(struct i2c_client *c, unsigned int freq);
+
 /*
  * tuner attach/detach logic
  */
@@ -233,13 +251,24 @@ static struct analog_demod_ops tuner_analog_ops = {
 };
 
 /*
- * Functions that are common to both TV and radio
+ * Functions to select between radio and TV and tuner probe/remove functions
  */
 
-static void set_tv_freq(struct i2c_client *c, unsigned int freq);
-static void set_radio_freq(struct i2c_client *c, unsigned int freq);
-static const struct v4l2_subdev_ops tuner_ops;
-
+/**
+ * set_type - Sets the tuner type for a given device
+ *
+ * @c:                 i2c_client descriptoy
+ * @type:              type of the tuner (e. g. tuner number)
+ * @new_mode_mask:     Indicates if tuner supports TV and/or Radio
+ * @new_config:                an optional parameter ranging from 0-255 used by
+                       a few tuners to adjust an internal parameter,
+                       like LNA mode
+ * @tuner_callback:    an optional function to be called when switching
+ *                     to analog mode
+ *
+ * This function applys the tuner config to tuner specified
+ * by tun_setup structure. It contains several per-tuner initialization "magic"
+ */
 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 component, int cmd, int arg))
@@ -452,6 +481,15 @@ static int tuner_s_type_addr(struct v4l2_subdev *sd,
        return 0;
 }
 
+/**
+ * tuner_s_config - Sets tuner configuration
+ *
+ * @sd:                subdev descriptor
+ * @cfg:       tuner configuration
+ *
+ * Calls tuner set_config() private function to set some tuner-internal
+ * parameters
+ */
 static int tuner_s_config(struct v4l2_subdev *sd,
                          const struct v4l2_priv_tun_config *cfg)
 {
@@ -470,10 +508,20 @@ static int tuner_s_config(struct v4l2_subdev *sd,
        return 0;
 }
 
-/* Search for existing radio and/or TV tuners on the given I2C adapter.
-   Note that when this function is called from tuner_probe you can be
-   certain no other devices will be added/deleted at the same time, I2C
-   core protects against that. */
+/**
+ * tuner_lookup - Seek for tuner adapters
+ *
+ * @adap:      i2c_adapter struct
+ * @radio:     pointer to be filled if the adapter is radio
+ * @tv:                pointer to be filled if the adapter is TV
+ *
+ * Search for existing radio and/or TV tuners on the given I2C adapter,
+ * discarding demod-only adapters (tda9887).
+ *
+ * Note that when this function is called from tuner_probe you can be
+ * certain no other devices will be added/deleted at the same time, I2C
+ * core protects against that.
+ */
 static void tuner_lookup(struct i2c_adapter *adap,
                struct tuner **radio, struct tuner **tv)
 {
@@ -490,20 +538,31 @@ static void tuner_lookup(struct i2c_adapter *adap,
                        continue;
 
                mode_mask = pos->mode_mask;
-               pos->standby = 1;
                if (*radio == NULL && mode_mask == T_RADIO)
                        *radio = pos;
                /* Note: currently TDA9887 is the only demod-only
                   device. If other devices appear then we need to
                   make this test more general. */
                else if (*tv == NULL && pos->type != TUNER_TDA9887 &&
-                        (pos->mode_mask & (T_ANALOG_TV | T_DIGITAL_TV)))
+                        (pos->mode_mask & T_ANALOG_TV))
                        *tv = pos;
        }
 }
 
-/* During client attach, set_type is called by adapter's attach_inform callback.
-   set_type must then be completed by tuner_probe.
+/**
+ *tuner_probe - Probes the existing tuners on an I2C bus
+ *
+ * @client:    i2c_client descriptor
+ * @id:                not used
+ *
+ * This routine probes for tuners at the expected I2C addresses. On most
+ * cases, if a device answers to a given I2C address, it assumes that the
+ * device is a tuner. On a few cases, however, an additional logic is needed
+ * to double check if the device is really a tuner, or to identify the tuner
+ * type, like on tea5767/5761 devices.
+ *
+ * During client attach, set_type is called by adapter's attach_inform callback.
+ * set_type must then be completed by tuner_probe.
  */
 static int tuner_probe(struct i2c_client *client,
                       const struct i2c_device_id *id)
@@ -565,8 +624,7 @@ static int tuner_probe(struct i2c_client *client,
                        } else {
                                /* Default is being tda9887 */
                                t->type = TUNER_TDA9887;
-                               t->mode_mask = T_RADIO | T_ANALOG_TV |
-                                              T_DIGITAL_TV;
+                               t->mode_mask = T_RADIO | T_ANALOG_TV;
                                goto register_client;
                        }
                        break;
@@ -596,7 +654,7 @@ static int tuner_probe(struct i2c_client *client,
           first found TV tuner. */
        tuner_lookup(t->i2c->adapter, &radio, &tv);
        if (tv == NULL) {
-               t->mode_mask = T_ANALOG_TV | T_DIGITAL_TV;
+               t->mode_mask = T_ANALOG_TV;
                if (radio == NULL)
                        t->mode_mask |= T_RADIO;
                tuner_dbg("Setting mode_mask to 0x%02x\n", t->mode_mask);
@@ -607,21 +665,24 @@ register_client:
        /* Sets a default mode */
        if (t->mode_mask & T_ANALOG_TV)
                t->mode = V4L2_TUNER_ANALOG_TV;
-       else if (t->mode_mask & T_RADIO)
-               t->mode = V4L2_TUNER_RADIO;
        else
-               t->mode = V4L2_TUNER_DIGITAL_TV;
+               t->mode = V4L2_TUNER_RADIO;
        set_type(client, t->type, t->mode_mask, t->config, t->fe.callback);
        list_add_tail(&t->list, &tuner_list);
 
-       tuner_info("Tuner %d found with type(s)%s%s%s.\n",
+       tuner_info("Tuner %d found with type(s)%s%s.\n",
                   t->type,
-                  t->mode_mask & T_RADIO ? " radio" : "",
-                  t->mode_mask & T_ANALOG_TV ? " TV" : "",
-                  t->mode_mask & T_ANALOG_TV ? " DTV" : "");
+                  t->mode_mask & T_RADIO ? " Radio" : "",
+                  t->mode_mask & T_ANALOG_TV ? " TV" : "");
        return 0;
 }
 
+/**
+ * tuner_remove - detaches a tuner
+ *
+ * @client:    i2c_client descriptor
+ */
+
 static int tuner_remove(struct i2c_client *client)
 {
        struct tuner *t = to_tuner(i2c_get_clientdata(client));
@@ -635,11 +696,85 @@ static int tuner_remove(struct i2c_client *client)
        return 0;
 }
 
+/*
+ * Functions to switch between Radio and TV
+ *
+ * A few cards have a separate I2C tuner for radio. Those routines
+ * take care of switching between TV/Radio mode, filtering only the
+ * commands that apply to the Radio or TV tuner.
+ */
+
+/**
+ * check_mode - Verify if tuner supports the requested mode
+ * @t: a pointer to the module's internal struct_tuner
+ *
+ * This function checks if the tuner is capable of tuning analog TV,
+ * digital TV or radio, depending on what the caller wants. If the
+ * tuner can't support that mode, it returns -EINVAL. Otherwise, it
+ * returns 0.
+ * This function is needed for boards that have a separate tuner for
+ * radio (like devices with tea5767).
+ */
+static inline int check_mode(struct tuner *t, enum v4l2_tuner_type mode)
+{
+       if ((1 << mode & t->mode_mask) == 0)
+               return -EINVAL;
+
+       return 0;
+}
+
+/**
+ * set_mode_freq - Switch tuner to other mode.
+ * @client:    struct i2c_client pointer
+ * @t:         a pointer to the module's internal struct_tuner
+ * @mode:      enum v4l2_type (radio or TV)
+ * @freq:      frequency to set (0 means to use the previous one)
+ *
+ * If tuner doesn't support the needed mode (radio or TV), prints a
+ * debug message and returns -EINVAL, changing its state to standby.
+ * Otherwise, changes the state and sets frequency to the last value, if
+ * the tuner can sleep or if it supports both Radio and TV.
+ */
+static int set_mode_freq(struct i2c_client *client, struct tuner *t,
+                        enum v4l2_tuner_type mode, unsigned int freq)
+{
+       struct analog_demod_ops *analog_ops = &t->fe.ops.analog_ops;
+
+       if (mode != t->mode) {
+               if (check_mode(t, mode) == -EINVAL) {
+                       tuner_dbg("Tuner doesn't support mode %d. "
+                                 "Putting tuner to sleep\n", mode);
+                       t->standby = true;
+                       if (analog_ops->standby)
+                               analog_ops->standby(&t->fe);
+                       return -EINVAL;
+               }
+               t->mode = mode;
+               tuner_dbg("Changing to mode %d\n", mode);
+       }
+       if (t->mode == V4L2_TUNER_RADIO) {
+               if (freq)
+                       t->radio_freq = freq;
+               set_radio_freq(client, t->radio_freq);
+       } else {
+               if (freq)
+                       t->tv_freq = freq;
+               set_tv_freq(client, t->tv_freq);
+       }
+
+       return 0;
+}
+
 /*
  * Functions that are specific for TV mode
  */
 
-/* Set tuner frequency,  freq in Units of 62.5kHz = 1/16MHz */
+/**
+ * set_tv_freq - Set tuner frequency,  freq in Units of 62.5 kHz = 1/16MHz
+ *
+ * @c: i2c_client descriptor
+ * @freq: frequency
+ */
 static void set_tv_freq(struct i2c_client *c, unsigned int freq)
 {
        struct tuner *t = to_tuner(i2c_get_clientdata(c));
@@ -679,7 +814,19 @@ static void set_tv_freq(struct i2c_client *c, unsigned int freq)
        analog_ops->set_params(&t->fe, &params);
 }
 
-/* get more precise norm info from insmod option */
+/**
+ * tuner_fixup_std - force a given video standard variant
+ *
+ * @t: tuner internal struct
+ *
+ * A few devices or drivers have problem to detect some standard variations.
+ * On other operational systems, the drivers generally have a per-country
+ * code, and some logic to apply per-country hacks. V4L2 API doesn't provide
+ * such hacks. Instead, it relies on a proper video standard selection from
+ * the userspace application. However, as some apps are buggy, not allowing
+ * to distinguish all video standard variations, a modprobe parameter can
+ * be used to force a video standard match.
+ */
 static int tuner_fixup_std(struct tuner *t)
 {
        if ((t->std & V4L2_STD_PAL) == V4L2_STD_PAL) {
@@ -801,6 +948,12 @@ static int tuner_fixup_std(struct tuner *t)
  * Functions that are specific for Radio mode
  */
 
+/**
+ * set_radio_freq - Set tuner frequency,  freq in Units of 62.5 Hz  = 1/16kHz
+ *
+ * @c: i2c_client descriptor
+ * @freq: frequency
+ */
 static void set_radio_freq(struct i2c_client *c, unsigned int freq)
 {
        struct tuner *t = to_tuner(i2c_get_clientdata(c));
@@ -840,66 +993,9 @@ static void set_radio_freq(struct i2c_client *c, unsigned int freq)
        analog_ops->set_params(&t->fe, &params);
 }
 
-/**
- * check_mode - Verify if tuner supports the requested mode
- * @t: a pointer to the module's internal struct_tuner
- *
- * This function checks if the tuner is capable of tuning analog TV,
- * digital TV or radio, depending on what the caller wants. If the
- * tuner can't support that mode, it returns -EINVAL. Otherwise, it
- * returns 0.
- * This function is needed for boards that have a separate tuner for
- * radio (like devices with tea5767).
- */
-static inline int check_mode(struct tuner *t, enum v4l2_tuner_type mode)
-{
-       if ((1 << mode & t->mode_mask) == 0)
-               return -EINVAL;
-
-       return 0;
-}
-
-/**
- * set_mode_freq - Switch tuner to other mode.
- * @client:    struct i2c_client pointer
- * @t:         a pointer to the module's internal struct_tuner
- * @mode:      enum v4l2_type (radio or TV)
- * @freq:      frequency to set (0 means to use the previous one)
- *
- * If tuner doesn't support the needed mode (radio or TV), prints a
- * debug message and returns -EINVAL, changing internal state to T_STANDBY.
- * Otherwise, changes the state and sets frequency to the last value, if
- * the tuner can sleep or if it supports both Radio and TV.
+/*
+ * Debug function for reporting tuner status to userspace
  */
-static int set_mode_freq(struct i2c_client *client, struct tuner *t,
-                        enum v4l2_tuner_type mode, unsigned int freq)
-{
-       struct analog_demod_ops *analog_ops = &t->fe.ops.analog_ops;
-
-       if (mode != t->mode) {
-               if (check_mode(t, mode) == -EINVAL) {
-                       tuner_dbg("Tuner doesn't support mode %d. "
-                                 "Putting tuner to sleep\n", mode);
-                       t->standby = true;
-                       if (analog_ops->standby)
-                               analog_ops->standby(&t->fe);
-                       return -EINVAL;
-               }
-               t->mode = mode;
-               tuner_dbg("Changing to mode %d\n", mode);
-       }
-       if (t->mode == V4L2_TUNER_RADIO) {
-               if (freq)
-                       t->radio_freq = freq;
-               set_radio_freq(client, t->radio_freq);
-       } else {
-               if (freq)
-                       t->tv_freq = freq;
-               set_tv_freq(client, t->tv_freq);
-       }
-
-       return 0;
-}
 
 /**
  * tuner_status - Dumps the current tuner status at dmesg
@@ -955,6 +1051,24 @@ static void tuner_status(struct dvb_frontend *fe)
                           analog_ops->has_signal(fe));
 }
 
+/*
+ * Function to splicitly change mode to radio. Probably not needed anymore
+ */
+
+static int tuner_s_radio(struct v4l2_subdev *sd)
+{
+       struct tuner *t = to_tuner(sd);
+       struct i2c_client *client = v4l2_get_subdevdata(sd);
+
+       if (set_mode_freq(client, t, V4L2_TUNER_RADIO, 0) == -EINVAL)
+               return 0;
+       return 0;
+}
+
+/*
+ * Tuner callbacks to handle userspace ioctl's
+ */
+
 /**
  * tuner_s_power - controls the power state of the tuner
  * @sd: pointer to struct v4l2_subdev
@@ -976,21 +1090,6 @@ static int tuner_s_power(struct v4l2_subdev *sd, int on)
        return 0;
 }
 
-/* ---------------------------------------------------------------------- */
-
-static int tuner_s_radio(struct v4l2_subdev *sd)
-{
-       struct tuner *t = to_tuner(sd);
-       struct i2c_client *client = v4l2_get_subdevdata(sd);
-
-       if (set_mode_freq(client, t, V4L2_TUNER_RADIO, 0) == -EINVAL)
-               return 0;
-       return 0;
-}
-
-/* --- v4l ioctls --- */
-/* take care: bttv does userspace copying, we'll get a
-   kernel pointer here... */
 static int tuner_s_std(struct v4l2_subdev *sd, v4l2_std_id std)
 {
        struct tuner *t = to_tuner(sd);
@@ -1141,7 +1240,9 @@ static int tuner_command(struct i2c_client *client, unsigned cmd, void *arg)
        return -ENOIOCTLCMD;
 }
 
-/* ----------------------------------------------------------------------- */
+/*
+ * Callback structs
+ */
 
 static const struct v4l2_subdev_core_ops tuner_core_ops = {
        .log_status = tuner_log_status,
@@ -1164,11 +1265,10 @@ static const struct v4l2_subdev_ops tuner_ops = {
        .tuner = &tuner_tuner_ops,
 };
 
-/* ----------------------------------------------------------------------- */
+/*
+ * I2C structs and module init functions
+ */
 
-/* This driver supports many devices and the idea is to let the driver
-   detect which device is present. So rather than listing all supported
-   devices here, we pretend to support a single, fake device type. */
 static const struct i2c_device_id tuner_id[] = {
        { "tuner", }, /* autodetect */
        { }