v4l2-dev: cleanups and add video_drvdata helper function

From: Hans Verkuil <hverkuil@xs4all.nl>

Cleanup v4l2-dev.[ch], add/improve comments and add a new helper
function: video_drvdata() that can get the private driver data from
a file struct.

Priority: normal

Signed-off-by: Hans Verkuil <hverkuil@xs4all.nl>

2 files changed, 31 insertions, 25 deletions

diff --git a/linux/drivers/media/video/v4l2-dev.c b/linux/drivers/media/video/v4l2-dev.c
index e6ae35df2..37b9a5076 100644
--- a/linux/drivers/media/video/v4l2-dev.c
+++ b/linux/drivers/media/video/v4l2-dev.c
@@ -44,6 +44,7 @@ static ssize_t show_index(struct device *cd,
 			 struct device_attribute *attr, char *buf)
 {
 	struct video_device *vfd = container_of(cd, struct video_device, dev);
+
 	return sprintf(buf, "%i\n", vfd->index);
 }
 
@@ -51,6 +52,7 @@ static ssize_t show_name(struct device *cd,
 			 struct device_attribute *attr, char *buf)
 {
 	struct video_device *vfd = container_of(cd, struct video_device, dev);
+
 	return sprintf(buf, "%.*s\n", (int)sizeof(vfd->name), vfd->name);
 }
 
@@ -63,12 +65,14 @@ static struct device_attribute video_device_attrs[] = {
 static ssize_t show_index(struct class_device *cd, char *buf)
 {
 	struct video_device *vfd = container_of(cd, struct video_device, dev);
+
 	return sprintf(buf, "%i\n", vfd->index);
 }
 
 static ssize_t show_name(struct class_device *cd, char *buf)
 {
 	struct video_device *vfd = container_of(cd, struct video_device, dev);
+
 	return sprintf(buf, "%.*s\n", (int)sizeof(vfd->name), vfd->name);
 }
 
@@ -78,10 +82,7 @@ static CLASS_DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
 
 struct video_device *video_device_alloc(void)
 {
-	struct video_device *vfd;
-
-	vfd = kzalloc(sizeof(*vfd), GFP_KERNEL);
-	return vfd;
+	return kzalloc(sizeof(struct video_device), GFP_KERNEL);
 }
 EXPORT_SYMBOL(video_device_alloc);
 
@@ -298,7 +299,7 @@ int video_register_device_index(struct video_device *vfd, int type, int nr,
 
 	/* pick a minor number */
 	mutex_lock(&videodev_lock);
-	if (nr >= 0  &&  nr < end-base) {
+	if (nr >= 0 && nr < end-base) {
 		/* use the one the driver asked for */
 		i = base + nr;
 		if (NULL != video_device[i]) {
@@ -330,7 +331,7 @@ int video_register_device_index(struct video_device *vfd, int type, int nr,
 	}
 
 	/* sysfs class */
-	memset(&vfd->dev, 0x00, sizeof(vfd->dev));
+	memset(&vfd->dev, 0, sizeof(vfd->dev));
 	vfd->dev.class = &video_class;
 	vfd->dev.devt = MKDEV(VIDEO_MAJOR, vfd->minor);
 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19)
@@ -349,16 +350,14 @@ int video_register_device_index(struct video_device *vfd, int type, int nr,
 		goto fail_minor;
 	}
 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 19)
-	ret = class_device_create_file(&vfd->dev,
-			&class_device_attr_name);
+	ret = class_device_create_file(&vfd->dev, &class_device_attr_name);
 	if (ret < 0) {
 		printk(KERN_ERR "%s: class_device_create_file 'name' failed\n",
 				__func__);
 		class_device_unregister(&vfd->dev);
 		goto fail_minor;
 	}
-	ret = class_device_create_file(&vfd->dev,
-			&class_device_attr_index);
+	ret = class_device_create_file(&vfd->dev, &class_device_attr_index);
 	if (ret < 0) {
 		printk(KERN_ERR "%s: class_device_create_file 'index' failed\n",
 				__func__);
@@ -372,8 +371,8 @@ int video_register_device_index(struct video_device *vfd, int type, int nr,
 fail_minor:
 	mutex_lock(&videodev_lock);
 	video_device[vfd->minor] = NULL;
-	vfd->minor = -1;
 	mutex_unlock(&videodev_lock);
+	vfd->minor = -1;
 	return ret;
 }
 EXPORT_SYMBOL(video_register_device_index);
diff --git a/linux/include/media/v4l2-dev.h b/linux/include/media/v4l2-dev.h
index 926d74551..8252d36ec 100644
--- a/linux/include/media/v4l2-dev.h
+++ b/linux/include/media/v4l2-dev.h
@@ -9,16 +9,14 @@
 #ifndef _V4L2_DEV_H
 #define _V4L2_DEV_H
 
-#define OBSOLETE_DEVDATA 1 /* to be removed soon */
-
 #include <linux/poll.h>
 #include <linux/fs.h>
 #include <linux/device.h>
 #include <linux/mutex.h>
-#include <linux/compiler.h> /* need __user */
 #include <linux/videodev2.h>
 
 #define VIDEO_MAJOR	81
+
 /* Minor device allocation */
 #define MINOR_VFL_TYPE_GRABBER_MIN   0
 #define MINOR_VFL_TYPE_GRABBER_MAX  63
@@ -75,20 +73,25 @@ struct video_device
 	const struct v4l2_ioctl_ops *ioctl_ops;
 };
 
-/* Class-dev to video-device */
+/* dev to video-device */
 #define to_video_device(cd) container_of(cd, struct video_device, dev)
 
-/* Version 2 functions */
+/* Register and unregister devices. Note that if video_register_device fails,
+   the release() callback of the video_device structure is *not* called, so
+   the caller is responsible for freeing any data. Usually that means that
+   you call video_device_release() on failure. */
 int __must_check video_register_device(struct video_device *vfd, int type, int nr);
-int __must_check video_register_device_index(struct video_device *vfd, int type, int nr,
-					int index);
-void video_unregister_device(struct video_device *);
+int __must_check video_register_device_index(struct video_device *vfd,
+						int type, int nr, int index);
+void video_unregister_device(struct video_device *vfd);
 
-/* helper functions to alloc / release struct video_device, the
-   later can be used for video_device->release() */
+/* helper functions to alloc/release struct video_device, the
+   latter can also be used for video_device->release(). */
 struct video_device * __must_check video_device_alloc(void);
+
 /* this release function frees the vfd pointer */
 void video_device_release(struct video_device *vfd);
+
 /* this release function does nothing, use when the video_device is a
    static global struct. Note that having a static video_device is
    a dubious construction at best. */
@@ -105,9 +108,13 @@ static inline void video_set_drvdata(struct video_device *dev, void *data)
 	dev_set_drvdata(&dev->dev, data);
 }
 
-#ifdef OBSOLETE_DEVDATA /* to be removed soon */
-/* Obsolete stuff - Still needed for radio devices and obsolete drivers */
-extern struct video_device* video_devdata(struct file*);
-#endif
+struct video_device *video_devdata(struct file *file);
+
+/* Combine video_get_drvdata and video_devdata as this is
+   used very often. */
+static inline void *video_drvdata(struct file *file)
+{
+	return video_get_drvdata(video_devdata(file));
+}
 
 #endif /* _V4L2_DEV_H */