V4L/DVB (11367): v4l2-common: remove legacy code

Now that all drivers are converted to v4l2_subdev we can remove legacy code
in v4l2-common. Also move the documentation of the internal API to
v4l2-subdev.h where it really belongs.

Signed-off-by: Hans Verkuil <hverkuil@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

2 files changed, 104 insertions, 138 deletions

diff --git a/include/media/v4l2-common.h b/include/media/v4l2-common.h
index 3a6905615d6..8ec50fea9e0 100644
--- a/include/media/v4l2-common.h
+++ b/include/media/v4l2-common.h
@@ -125,7 +125,7 @@ int v4l2_chip_match_host(const struct v4l2_dbg_match *match);
 
 /* ------------------------------------------------------------------------- */
 
-/* Helper function for I2C legacy drivers */
+/* I2C Helper functions */
 
 struct i2c_driver;
 struct i2c_adapter;
@@ -135,9 +135,6 @@ struct v4l2_device;
 struct v4l2_subdev;
 struct v4l2_subdev_ops;
 
-int v4l2_i2c_attach(struct i2c_adapter *adapter, int address, struct i2c_driver *driver,
-                const char *name,
-                int (*probe)(struct i2c_client *, const struct i2c_device_id *));
 
 /* Load an i2c module and return an initialized v4l2_subdev struct.
    Only call request_module if module_name != NULL.
@@ -171,139 +168,25 @@ const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
 
 /* ------------------------------------------------------------------------- */
 
-/* Internal ioctls */
-
-/* VIDIOC_INT_DECODE_VBI_LINE */
-struct v4l2_decode_vbi_line {
-        u32 is_second_field;    /* Set to 0 for the first (odd) field,
-                                   set to 1 for the second (even) field. */
-        u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
-                                   On exit points to the start of the payload. */
-        u32 line;               /* Line number of the sliced VBI data (1-23) */
-        u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
-};
+/* Note: these remaining ioctls should be removed as well, but they are still
+   used in tuner-simple.c (TUNER_SET_CONFIG) and cx18/ivtv (RESET and
+   S_AUDIO_ROUTING). To remove these ioctls some more cleanup is needed in
+   those modules. */
 
+/* s_config */
 struct v4l2_priv_tun_config {
         int tuner;
         void *priv;
 };
-
-/* audio ioctls */
-
-/* v4l device was opened in Radio mode, to be replaced by VIDIOC_INT_S_TUNER_MODE */
-#define AUDC_SET_RADIO        _IO('d',88)
-
-/* tuner ioctls */
-
-/* Sets tuner type and its I2C addr */
-#define TUNER_SET_TYPE_ADDR          _IOW('d', 90, int)
-
-/* Puts tuner on powersaving state, disabling it, except for i2c. To be replaced
-   by VIDIOC_INT_S_STANDBY. */
-#define TUNER_SET_STANDBY            _IOW('d', 91, int)
-
-/* Sets tda9887 specific stuff, like port1, port2 and qss */
 #define TUNER_SET_CONFIG           _IOW('d', 92, struct v4l2_priv_tun_config)
 
-/* Switch the tuner to a specific tuner mode. Replacement of AUDC_SET_RADIO */
-#define VIDIOC_INT_S_TUNER_MODE      _IOW('d', 93, enum v4l2_tuner_type)
-
-/* Generic standby command. Passing -1 (all bits set to 1) will put the whole
-   chip into standby mode, value 0 will make the chip fully active. Specific
-   bits can be used by certain chips to enable/disable specific subsystems.
-   Replacement of TUNER_SET_STANDBY. */
-#define VIDIOC_INT_S_STANDBY         _IOW('d', 94, u32)
-
-/* 100, 101 used by  VIDIOC_DBG_[SG]_REGISTER */
-
-/* Generic reset command. The argument selects which subsystems to reset.
-   Passing 0 will always reset the whole chip. */
-#define VIDIOC_INT_RESET                _IOW ('d', 102, u32)
-
-/* Set the frequency (in Hz) of the audio clock output.
-   Used to slave an audio processor to the video decoder, ensuring that audio
-   and video remain synchronized.
-   Usual values for the frequency are 48000, 44100 or 32000 Hz.
-   If the frequency is not supported, then -EINVAL is returned. */
-#define VIDIOC_INT_AUDIO_CLOCK_FREQ     _IOW ('d', 103, u32)
-
-/* Video decoders that support sliced VBI need to implement this ioctl.
-   Field p of the v4l2_sliced_vbi_line struct is set to the start of the VBI
-   data that was generated by the decoder. The driver then parses the sliced
-   VBI data and sets the other fields in the struct accordingly. The pointer p
-   is updated to point to the start of the payload which can be copied
-   verbatim into the data field of the v4l2_sliced_vbi_data struct. If no
-   valid VBI data was found, then the type field is set to 0 on return. */
-#define VIDIOC_INT_DECODE_VBI_LINE      _IOWR('d', 104, struct v4l2_decode_vbi_line)
-
-/* Used to generate VBI signals on a video signal. v4l2_sliced_vbi_data is
-   filled with the data packets that should be output. Note that if you set
-   the line field to 0, then that VBI signal is disabled. If no
-   valid VBI data was found, then the type field is set to 0 on return. */
-#define VIDIOC_INT_S_VBI_DATA           _IOW ('d', 105, struct v4l2_sliced_vbi_data)
-
-/* Used to obtain the sliced VBI packet from a readback register. Not all
-   video decoders support this. If no data is available because the readback
-   register contains invalid or erroneous data -EIO is returned. Note that
-   you must fill in the 'id' member and the 'field' member (to determine
-   whether CC data from the first or second field should be obtained). */
-#define VIDIOC_INT_G_VBI_DATA           _IOWR('d', 106, struct v4l2_sliced_vbi_data)
-
-/* Sets I2S speed in bps. This is used to provide a standard way to select I2S
-   clock used by driving digital audio streams at some board designs.
-   Usual values for the frequency are 1024000 and 2048000.
-   If the frequency is not supported, then -EINVAL is returned. */
-#define VIDIOC_INT_I2S_CLOCK_FREQ       _IOW ('d', 108, u32)
-
-/* Routing definition, device dependent. It specifies which inputs (if any)
-   should be routed to which outputs (if any). */
+/* s_routing: routing definition, device dependent. It specifies which inputs
+   (if any) should be routed to which outputs (if any). */
 struct v4l2_routing {
         u32 input;
         u32 output;
 };
-
-/* These internal commands should be used to define the inputs and outputs
-   of an audio/video chip. They will replace the v4l2 API commands
-   VIDIOC_S/G_INPUT, VIDIOC_S/G_OUTPUT, VIDIOC_S/G_AUDIO and VIDIOC_S/G_AUDOUT
-   that are meant to be used by the user.
-   The internal commands should be used to switch inputs/outputs
-   because only the driver knows how to map a 'Television' input to the precise
-   input/output routing of an A/D converter, or a DSP, or a video digitizer.
-   These four commands should only be sent directly to an i2c device, they
-   should not be broadcast as the routing is very device specific. */
 #define VIDIOC_INT_S_AUDIO_ROUTING      _IOW ('d', 109, struct v4l2_routing)
-#define VIDIOC_INT_G_AUDIO_ROUTING      _IOR ('d', 110, struct v4l2_routing)
-#define VIDIOC_INT_S_VIDEO_ROUTING      _IOW ('d', 111, struct v4l2_routing)
-#define VIDIOC_INT_G_VIDEO_ROUTING      _IOR ('d', 112, struct v4l2_routing)
-
-struct v4l2_crystal_freq {
-        u32 freq;       /* frequency in Hz of the crystal */
-        u32 flags;      /* device specific flags */
-};
-
-/* Sets the frequency of the crystal used to generate the clocks.
-   An extra flags field allows device specific configuration regarding
-   clock frequency dividers, etc. If not used, then set flags to 0.
-   If the frequency is not supported, then -EINVAL is returned. */
-#define VIDIOC_INT_S_CRYSTAL_FREQ       _IOW('d', 113, struct v4l2_crystal_freq)
-
-/* Initialize the sensor registors to some sort of reasonable
-   default values. */
-#define VIDIOC_INT_INIT                 _IOW('d', 114, u32)
-
-/* Set v4l2_std_id for video OUTPUT devices. This is ignored by
-   video input devices. */
-#define VIDIOC_INT_S_STD_OUTPUT         _IOW('d', 115, v4l2_std_id)
-
-/* Get v4l2_std_id for video OUTPUT devices. This is ignored by
-   video input devices. */
-#define VIDIOC_INT_G_STD_OUTPUT         _IOW('d', 116, v4l2_std_id)
-
-/* Set GPIO pins. Very simple right now, might need to be extended with
-   a v4l2_gpio struct if a direction is also needed. */
-#define VIDIOC_INT_S_GPIO               _IOW('d', 117, u32)
-
-/* Get input status. Same as the status field in the v4l2_input struct. */
-#define VIDIOC_INT_G_INPUT_STATUS       _IOR('d', 118, u32)
+#define VIDIOC_INT_RESET                _IOW ('d', 102, u32)
 
 #endif /* V4L2_COMMON_H_ */
diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
index 1d181b4ccb0..9a8535be1ed 100644
--- a/include/media/v4l2-subdev.h
+++ b/include/media/v4l2-subdev.h
@@ -27,6 +27,22 @@ struct v4l2_device;
 struct v4l2_subdev;
 struct tuner_setup;
 
+/* decode_vbi_line */
+struct v4l2_decode_vbi_line {
+        u32 is_second_field;    /* Set to 0 for the first (odd) field,
+                                   set to 1 for the second (even) field. */
+        u8 *p;                  /* Pointer to the sliced VBI data from the decoder.
+                                   On exit points to the start of the payload. */
+        u32 line;               /* Line number of the sliced VBI data (1-23) */
+        u32 type;               /* VBI service type (V4L2_SLICED_*). 0 if no service found */
+};
+
+/* s_crystal_freq */
+struct v4l2_crystal_freq {
+        u32 freq;       /* frequency in Hz of the crystal */
+        u32 flags;      /* device specific flags */
+};
+
 /* Sub-devices are devices that are connected somehow to the main bridge
    device. These devices are usually audio/video muxers/encoders/decoders or
    sensors and webcam controllers.
@@ -68,6 +84,21 @@ struct tuner_setup;
    the use-case it might be better to use subdev-specific ops (currently
    not yet implemented) since ops provide proper type-checking.
  */
+
+/* init: initialize the sensor registors to some sort of reasonable default
+        values. Do not use for new drivers and should be removed in existing
+        drivers.
+
+  reset: generic reset command. The argument selects which subsystems to
+        reset. Passing 0 will always reset the whole chip. Do not use for new
+        drivers without discussing this first on the linux-media mailinglist.
+        There should be no reason normally to reset a device.
+
+   s_gpio: set GPIO pins. Very simple right now, might need to be extended with
+        a direction argument if needed.
+
+   s_standby: puts tuner on powersaving state, disabling it, except for i2c.
+ */
 struct v4l2_subdev_core_ops {
         int (*g_chip_ident)(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip);
         int (*log_status)(struct v4l2_subdev *sd);
@@ -89,6 +120,14 @@ struct v4l2_subdev_core_ops {
 #endif
 };
 
+/* s_mode: switch the tuner to a specific tuner mode. Replacement of s_radio.
+
+   s_radio: v4l device was opened in Radio mode, to be replaced by s_mode.
+
+   s_type_addr: sets tuner type and its I2C addr.
+
+   s_config: sets tda9887 specific stuff, like port1, port2 and qss
+ */
 struct v4l2_subdev_tuner_ops {
         int (*s_mode)(struct v4l2_subdev *sd, enum v4l2_tuner_type);
         int (*s_radio)(struct v4l2_subdev *sd);
@@ -101,12 +140,68 @@ struct v4l2_subdev_tuner_ops {
         int (*s_config)(struct v4l2_subdev *sd, const struct v4l2_priv_tun_config *config);
 };
 
+/* s_clock_freq: set the frequency (in Hz) of the audio clock output.
+        Used to slave an audio processor to the video decoder, ensuring that
+        audio and video remain synchronized. Usual values for the frequency
+        are 48000, 44100 or 32000 Hz. If the frequency is not supported, then
+        -EINVAL is returned.
+
+   s_i2s_clock_freq: sets I2S speed in bps. This is used to provide a standard
+        way to select I2S clock used by driving digital audio streams at some
+        board designs. Usual values for the frequency are 1024000 and 2048000.
+        If the frequency is not supported, then -EINVAL is returned.
+
+   s_routing: used to define the input and/or output pins of an audio chip.
+        Never attempt to use user-level input IDs (e.g. Composite, S-Video,
+        Tuner) at this level. An i2c device shouldn't know about whether an
+        input pin is connected to a Composite connector, become on another
+        board or platform it might be connected to something else entirely.
+        The calling driver is responsible for mapping a user-level input to
+        the right pins on the i2c device.
+ */
 struct v4l2_subdev_audio_ops {
         int (*s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
         int (*s_i2s_clock_freq)(struct v4l2_subdev *sd, u32 freq);
         int (*s_routing)(struct v4l2_subdev *sd, const struct v4l2_routing *route);
 };
 
+/*
+   decode_vbi_line: video decoders that support sliced VBI need to implement
+        this ioctl. Field p of the v4l2_sliced_vbi_line struct is set to the
+        start of the VBI data that was generated by the decoder. The driver
+        then parses the sliced VBI data and sets the other fields in the
+        struct accordingly. The pointer p is updated to point to the start of
+        the payload which can be copied verbatim into the data field of the
+        v4l2_sliced_vbi_data struct. If no valid VBI data was found, then the
+        type field is set to 0 on return.
+
+  s_vbi_data: used to generate VBI signals on a video signal.
+        v4l2_sliced_vbi_data is filled with the data packets that should be
+        output. Note that if you set the line field to 0, then that VBI signal
+        is disabled. If no valid VBI data was found, then the type field is
+        set to 0 on return.
+
+  g_vbi_data: used to obtain the sliced VBI packet from a readback register.
+        Not all video decoders support this. If no data is available because
+        the readback register contains invalid or erroneous data -EIO is
+        returned. Note that you must fill in the 'id' member and the 'field'
+        member (to determine whether CC data from the first or second field
+        should be obtained).
+
+  s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
+        video input devices.
+
+  s_crystal_freq: sets the frequency of the crystal used to generate the
+        clocks. An extra flags field allows device specific configuration
+        regarding clock frequency dividers, etc. If not used, then set flags
+        to 0. If the frequency is not supported, then -EINVAL is returned.
+
+  g_input_status: get input status. Same as the status field in the v4l2_input
+        struct.
+
+  s_routing: see s_routing in audio_ops, except this version is for video
+        devices.
+ */
 struct v4l2_subdev_video_ops {
         int (*s_routing)(struct v4l2_subdev *sd, const struct v4l2_routing *route);
         int (*s_crystal_freq)(struct v4l2_subdev *sd, struct v4l2_crystal_freq *freq);
@@ -163,18 +258,6 @@ static inline void *v4l2_get_subdevdata(const struct v4l2_subdev *sd)
         return sd->priv;
 }
 
-/* Convert an ioctl-type command to the proper v4l2_subdev_ops function call.
-   This is used by subdev modules that can be called by both old-style ioctl
-   commands and through the v4l2_subdev_ops.
-
-   The ioctl API of the subdev driver can call this function to call the
-   right ops based on the ioctl cmd and arg.
-
-   Once all subdev drivers have been converted and all drivers no longer
-   use the ioctl interface, then this function can be removed.
- */
-int v4l2_subdev_command(struct v4l2_subdev *sd, unsigned cmd, void *arg);
-
 static inline void v4l2_subdev_init(struct v4l2_subdev *sd,
                                         const struct v4l2_subdev_ops *ops)
 {