v4l2-ioctl: properly return -EINVAL when parameters are wrong

Whan an ioctl is implemented, but the parameters are invalid,
the error code should be -EINVAL. However, if the ioctl is
not defined, it should return -ENOTTY instead.

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

diff --git a/drivers/media/video/v4l2-ioctl.c b/drivers/media/video/v4l2-ioctl.c
index 002ce1363443338a714fca863f254968a224f6ee..9f80e9d1fdb728a82bf68153fa93e614924711c5 100644 (file)
--- a/drivers/media/video/v4l2-ioctl.c
+++ b/drivers/media/video/v4l2-ioctl.c
@@ -55,6 +55,14 @@
        memset((u8 *)(p) + offsetof(typeof(*(p)), field) + sizeof((p)->field), \
        0, sizeof(*(p)) - offsetof(typeof(*(p)), field) - sizeof((p)->field))
 
+#define no_ioctl_err(foo) ( (                                          \
+       ops->vidioc_##foo##_fmt_vid_cap ||                              \
+       ops->vidioc_##foo##_fmt_vid_out ||                              \
+       ops->vidioc_##foo##_fmt_vid_cap_mplane ||                       \
+       ops->vidioc_##foo##_fmt_vid_out_mplane ||                       \
+       ops->vidioc_##foo##_fmt_vid_overlay ||                          \
+       ops->vidioc_##foo##_fmt_type_private) ? -EINVAL : -ENOTTY)
+
 struct std_descr {
        v4l2_std_id std;
        const char *descr;
@@ -591,7 +599,7 @@ static long __video_do_ioctl(struct file *file,
                        ret = v4l2_prio_check(vfd->prio, vfh->prio);
                        if (ret)
                                goto exit_prio;
-                       ret = -EINVAL;
+                       ret = -ENOTTY;
                        break;
                }
        }
@@ -638,7 +646,7 @@ static long __video_do_ioctl(struct file *file,
                enum v4l2_priority *p = arg;
 
                if (!ops->vidioc_s_priority && !use_fh_prio)
-                               break;
+                       break;
                dbgarg(cmd, "setting priority to %d\n", *p);
                if (ops->vidioc_s_priority)
                        ret = ops->vidioc_s_priority(file, fh, *p);
@@ -654,37 +662,37 @@ static long __video_do_ioctl(struct file *file,
 
                switch (f->type) {
                case V4L2_BUF_TYPE_VIDEO_CAPTURE:
-                       if (ops->vidioc_enum_fmt_vid_cap)
+                       if (likely(ops->vidioc_enum_fmt_vid_cap))
                                ret = ops->vidioc_enum_fmt_vid_cap(file, fh, f);
                        break;
                case V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE:
-                       if (ops->vidioc_enum_fmt_vid_cap_mplane)
+                       if (likely(ops->vidioc_enum_fmt_vid_cap_mplane))
                                ret = ops->vidioc_enum_fmt_vid_cap_mplane(file,
                                                                        fh, f);
                        break;
                case V4L2_BUF_TYPE_VIDEO_OVERLAY:
-                       if (ops->vidioc_enum_fmt_vid_overlay)
+                       if (likely(ops->vidioc_enum_fmt_vid_overlay))
                                ret = ops->vidioc_enum_fmt_vid_overlay(file,
                                        fh, f);
                        break;
                case V4L2_BUF_TYPE_VIDEO_OUTPUT:
-                       if (ops->vidioc_enum_fmt_vid_out)
+                       if (likely(ops->vidioc_enum_fmt_vid_out))
                                ret = ops->vidioc_enum_fmt_vid_out(file, fh, f);
                        break;
                case V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE:
-                       if (ops->vidioc_enum_fmt_vid_out_mplane)
+                       if (likely(ops->vidioc_enum_fmt_vid_out_mplane))
                                ret = ops->vidioc_enum_fmt_vid_out_mplane(file,
                                                                        fh, f);
                        break;
                case V4L2_BUF_TYPE_PRIVATE:
-                       if (ops->vidioc_enum_fmt_type_private)
+                       if (likely(ops->vidioc_enum_fmt_type_private))
                                ret = ops->vidioc_enum_fmt_type_private(file,
                                                                fh, f);
                        break;
                default:
                        break;
                }
-               if (!ret)
+               if (likely (!ret))
                        dbgarg(cmd, "index=%d, type=%d, flags=%d, "
                                "pixelformat=%c%c%c%c, description='%s'\n",
                                f->index, f->type, f->flags,
@@ -693,6 +701,8 @@ static long __video_do_ioctl(struct file *file,
                                (f->pixelformat >> 16) & 0xff,
                                (f->pixelformat >> 24) & 0xff,
                                f->description);
+               else if (ret == -ENOTTY)
+                       ret = no_ioctl_err(enum);
                break;
        }
        case VIDIOC_G_FMT:
@@ -744,7 +754,7 @@ static long __video_do_ioctl(struct file *file,
                                v4l_print_pix_fmt_mplane(vfd, &f->fmt.pix_mp);
                        break;
                case V4L2_BUF_TYPE_VIDEO_OVERLAY:
-                       if (ops->vidioc_g_fmt_vid_overlay)
+                       if (likely(ops->vidioc_g_fmt_vid_overlay))
                                ret = ops->vidioc_g_fmt_vid_overlay(file,
                                                                    fh, f);
                        break;
@@ -789,34 +799,36 @@ static long __video_do_ioctl(struct file *file,
                                v4l_print_pix_fmt_mplane(vfd, &f->fmt.pix_mp);
                        break;
                case V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY:
-                       if (ops->vidioc_g_fmt_vid_out_overlay)
+                       if (likely(ops->vidioc_g_fmt_vid_out_overlay))
                                ret = ops->vidioc_g_fmt_vid_out_overlay(file,
                                       fh, f);
                        break;
                case V4L2_BUF_TYPE_VBI_CAPTURE:
-                       if (ops->vidioc_g_fmt_vbi_cap)
+                       if (likely(ops->vidioc_g_fmt_vbi_cap))
                                ret = ops->vidioc_g_fmt_vbi_cap(file, fh, f);
                        break;
                case V4L2_BUF_TYPE_VBI_OUTPUT:
-                       if (ops->vidioc_g_fmt_vbi_out)
+                       if (likely(ops->vidioc_g_fmt_vbi_out))
                                ret = ops->vidioc_g_fmt_vbi_out(file, fh, f);
                        break;
                case V4L2_BUF_TYPE_SLICED_VBI_CAPTURE:
-                       if (ops->vidioc_g_fmt_sliced_vbi_cap)
+                       if (likely(ops->vidioc_g_fmt_sliced_vbi_cap))
                                ret = ops->vidioc_g_fmt_sliced_vbi_cap(file,
                                                                        fh, f);
                        break;
                case V4L2_BUF_TYPE_SLICED_VBI_OUTPUT:
-                       if (ops->vidioc_g_fmt_sliced_vbi_out)
+                       if (likely(ops->vidioc_g_fmt_sliced_vbi_out))
                                ret = ops->vidioc_g_fmt_sliced_vbi_out(file,
                                                                        fh, f);
                        break;
                case V4L2_BUF_TYPE_PRIVATE:
-                       if (ops->vidioc_g_fmt_type_private)
+                       if (likely(ops->vidioc_g_fmt_type_private))
                                ret = ops->vidioc_g_fmt_type_private(file,
                                                                fh, f);
                        break;
                }
+               if (unlikely(ret == -ENOTTY))
+                       ret = no_ioctl_err(g);
 
                break;
        }
@@ -926,33 +938,36 @@ static long __video_do_ioctl(struct file *file,
                        break;
                case V4L2_BUF_TYPE_VBI_CAPTURE:
                        CLEAR_AFTER_FIELD(f, fmt.vbi);
-                       if (ops->vidioc_s_fmt_vbi_cap)
+                       if (likely(ops->vidioc_s_fmt_vbi_cap))
                                ret = ops->vidioc_s_fmt_vbi_cap(file, fh, f);
                        break;
                case V4L2_BUF_TYPE_VBI_OUTPUT:
                        CLEAR_AFTER_FIELD(f, fmt.vbi);
-                       if (ops->vidioc_s_fmt_vbi_out)
+                       if (likely(ops->vidioc_s_fmt_vbi_out))
                                ret = ops->vidioc_s_fmt_vbi_out(file, fh, f);
                        break;
                case V4L2_BUF_TYPE_SLICED_VBI_CAPTURE:
                        CLEAR_AFTER_FIELD(f, fmt.sliced);
-                       if (ops->vidioc_s_fmt_sliced_vbi_cap)
+                       if (likely(ops->vidioc_s_fmt_sliced_vbi_cap))
                                ret = ops->vidioc_s_fmt_sliced_vbi_cap(file,
                                                                        fh, f);
                        break;
                case V4L2_BUF_TYPE_SLICED_VBI_OUTPUT:
                        CLEAR_AFTER_FIELD(f, fmt.sliced);
-                       if (ops->vidioc_s_fmt_sliced_vbi_out)
+                       if (likely(ops->vidioc_s_fmt_sliced_vbi_out))
                                ret = ops->vidioc_s_fmt_sliced_vbi_out(file,
                                                                        fh, f);
+
                        break;
                case V4L2_BUF_TYPE_PRIVATE:
                        /* CLEAR_AFTER_FIELD(f, fmt.raw_data); <- does nothing */
-                       if (ops->vidioc_s_fmt_type_private)
+                       if (likely(ops->vidioc_s_fmt_type_private))
                                ret = ops->vidioc_s_fmt_type_private(file,
                                                                fh, f);
                        break;
                }
+               if (unlikely(ret == -ENOTTY))
+                       ret = no_ioctl_err(g);
                break;
        }
        case VIDIOC_TRY_FMT:
@@ -1008,7 +1023,7 @@ static long __video_do_ioctl(struct file *file,
                        break;
                case V4L2_BUF_TYPE_VIDEO_OVERLAY:
                        CLEAR_AFTER_FIELD(f, fmt.win);
-                       if (ops->vidioc_try_fmt_vid_overlay)
+                       if (likely(ops->vidioc_try_fmt_vid_overlay))
                                ret = ops->vidioc_try_fmt_vid_overlay(file,
                                        fh, f);
                        break;
@@ -1057,40 +1072,43 @@ static long __video_do_ioctl(struct file *file,
                        break;
                case V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY:
                        CLEAR_AFTER_FIELD(f, fmt.win);
-                       if (ops->vidioc_try_fmt_vid_out_overlay)
+                       if (likely(ops->vidioc_try_fmt_vid_out_overlay))
                                ret = ops->vidioc_try_fmt_vid_out_overlay(file,
                                       fh, f);
                        break;
                case V4L2_BUF_TYPE_VBI_CAPTURE:
                        CLEAR_AFTER_FIELD(f, fmt.vbi);
-                       if (ops->vidioc_try_fmt_vbi_cap)
+                       if (likely(ops->vidioc_try_fmt_vbi_cap))
                                ret = ops->vidioc_try_fmt_vbi_cap(file, fh, f);
                        break;
                case V4L2_BUF_TYPE_VBI_OUTPUT:
                        CLEAR_AFTER_FIELD(f, fmt.vbi);
-                       if (ops->vidioc_try_fmt_vbi_out)
+                       if (likely(ops->vidioc_try_fmt_vbi_out))
                                ret = ops->vidioc_try_fmt_vbi_out(file, fh, f);
                        break;
                case V4L2_BUF_TYPE_SLICED_VBI_CAPTURE:
                        CLEAR_AFTER_FIELD(f, fmt.sliced);
-                       if (ops->vidioc_try_fmt_sliced_vbi_cap)
+                       if (likely(ops->vidioc_try_fmt_sliced_vbi_cap))
                                ret = ops->vidioc_try_fmt_sliced_vbi_cap(file,
                                                                fh, f);
                        break;
                case V4L2_BUF_TYPE_SLICED_VBI_OUTPUT:
                        CLEAR_AFTER_FIELD(f, fmt.sliced);
-                       if (ops->vidioc_try_fmt_sliced_vbi_out)
+                       if (likely(ops->vidioc_try_fmt_sliced_vbi_out))
                                ret = ops->vidioc_try_fmt_sliced_vbi_out(file,
                                                                fh, f);
+                       else
+                               ret = no_ioctl_err(try);
                        break;
                case V4L2_BUF_TYPE_PRIVATE:
                        /* CLEAR_AFTER_FIELD(f, fmt.raw_data); <- does nothing */
-                       if (ops->vidioc_try_fmt_type_private)
+                       if (likely(ops->vidioc_try_fmt_type_private))
                                ret = ops->vidioc_try_fmt_type_private(file,
                                                                fh, f);
                        break;
                }
-
+               if (unlikely(ret == -ENOTTY))
+                       ret = no_ioctl_err(g);
                break;
        }
        /* FIXME: Those buf reqs could be handled here,
@@ -1262,16 +1280,15 @@ static long __video_do_ioctl(struct file *file,
        {
                v4l2_std_id *id = arg;
 
-               ret = 0;
                /* Calls the specific handler */
                if (ops->vidioc_g_std)
                        ret = ops->vidioc_g_std(file, fh, id);
-               else if (vfd->current_norm)
+               else if (vfd->current_norm) {
+                       ret = 0;
                        *id = vfd->current_norm;
-               else
-                       ret = -EINVAL;
+               }
 
-               if (!ret)
+               if (likely(!ret))
                        dbgarg(cmd, "std=0x%08Lx\n", (long long unsigned)*id);
                break;
        }
@@ -1288,8 +1305,6 @@ static long __video_do_ioctl(struct file *file,
                /* Calls the specific handler */
                if (ops->vidioc_s_std)
                        ret = ops->vidioc_s_std(file, fh, &norm);
-               else
-                       ret = -EINVAL;
 
                /* Updates standard information */
                if (ret >= 0)
@@ -1812,7 +1827,7 @@ static long __video_do_ioctl(struct file *file,
                        if (ops->vidioc_g_std)
                                ret = ops->vidioc_g_std(file, fh, &std);
                        else if (std == 0)
-                               ret = -EINVAL;
+                               ret = -ENOTTY;
                        if (ret == 0)
                                v4l2_video_std_frame_period(std,
                                                    &p->parm.capture.timeperframe);