- 12
       - Buffer for Software Defined Radio (SDR) output stream, see
        :ref:`sdr`.
+    * - ``V4L2_BUF_TYPE_META_CAPTURE``
+      - 13
+      - Buffer for metadata capture, see :ref:`metadata`.
 
 
 
 
--- /dev/null
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _metadata:
+
+******************
+Metadata Interface
+******************
+
+Metadata refers to any non-image data that supplements video frames with
+additional information. This may include statistics computed over the image
+or frame capture parameters supplied by the image source. This interface is
+intended for transfer of metadata to userspace and control of that operation.
+
+The metadata interface is implemented on video capture device nodes. The device
+can be dedicated to metadata or can implement both video and metadata capture
+as specified in its reported capabilities.
+
+Querying Capabilities
+=====================
+
+Device nodes supporting the metadata interface set the ``V4L2_CAP_META_CAPTURE``
+flag in the ``device_caps`` field of the
+:c:type:`v4l2_capability` structure returned by the :c:func:`VIDIOC_QUERYCAP`
+ioctl. That flag means the device can capture metadata to memory.
+
+At least one of the read/write or streaming I/O methods must be supported.
+
+
+Data Format Negotiation
+=======================
+
+The metadata device uses the :ref:`format` ioctls to select the capture format.
+The metadata buffer content format is bound to that selected format. In addition
+to the basic :ref:`format` ioctls, the :c:func:`VIDIOC_ENUM_FMT` ioctl must be
+supported as well.
+
+To use the :ref:`format` ioctls applications set the ``type`` field of the
+:c:type:`v4l2_format` structure to ``V4L2_BUF_TYPE_META_CAPTURE`` and use the
+:c:type:`v4l2_meta_format` ``meta`` member of the ``fmt`` union as needed per
+the desired operation. Both drivers and applications must set the remainder of
+the :c:type:`v4l2_format` structure to 0.
+
+.. _v4l2-meta-format:
+
+.. flat-table:: struct v4l2_meta_format
+    :header-rows:  0
+    :stub-columns: 0
+    :widths:       1 1 2
+
+    * - __u32
+      - ``dataformat``
+      - The data format, set by the application. This is a little endian
+        :ref:`four character code <v4l2-fourcc>`. V4L2 defines metadata formats
+        in :ref:`meta-formats`.
+    * - __u32
+      - ``buffersize``
+      - Maximum buffer size in bytes required for data. The value is set by the
+        driver.
 
     dev-touch
     dev-event
     dev-subdev
+    dev-meta
 
     * - ``V4L2_CAP_SDR_OUTPUT``
       - 0x00400000
       - The device supports the :ref:`SDR Output <sdr>` interface.
+    * - ``V4L2_CAP_META_CAPTURE``
+      - 0x00800000
+      - The device supports the :ref:`metadata` capture interface.
     * - ``V4L2_CAP_READWRITE``
       - 0x01000000
       - The device supports the :ref:`read() <rw>` and/or
 
 replace symbol V4L2_FIELD_TOP :c:type:`v4l2_field`
 
 # Documented enum v4l2_buf_type
+replace symbol V4L2_BUF_TYPE_META_CAPTURE :c:type:`v4l2_buf_type`
 replace symbol V4L2_BUF_TYPE_SDR_CAPTURE :c:type:`v4l2_buf_type`
 replace symbol V4L2_BUF_TYPE_SDR_OUTPUT :c:type:`v4l2_buf_type`
 replace symbol V4L2_BUF_TYPE_SLICED_VBI_CAPTURE :c:type:`v4l2_buf_type`
 replace define V4L2_CAP_SDR_CAPTURE device-capabilities
 replace define V4L2_CAP_EXT_PIX_FORMAT device-capabilities
 replace define V4L2_CAP_SDR_OUTPUT device-capabilities
+replace define V4L2_CAP_META_CAPTURE device-capabilities
 replace define V4L2_CAP_READWRITE device-capabilities
 replace define V4L2_CAP_ASYNCIO device-capabilities
 replace define V4L2_CAP_STREAMING device-capabilities
 
        return 0;
 }
 
+static inline int get_v4l2_meta_format(struct v4l2_meta_format *kp, struct v4l2_meta_format __user *up)
+{
+       if (copy_from_user(kp, up, sizeof(struct v4l2_meta_format)))
+               return -EFAULT;
+       return 0;
+}
+
+static inline int put_v4l2_meta_format(struct v4l2_meta_format *kp, struct v4l2_meta_format __user *up)
+{
+       if (copy_to_user(up, kp, sizeof(struct v4l2_meta_format)))
+               return -EFAULT;
+       return 0;
+}
+
 struct v4l2_format32 {
        __u32   type;   /* enum v4l2_buf_type */
        union {
                struct v4l2_vbi_format  vbi;
                struct v4l2_sliced_vbi_format   sliced;
                struct v4l2_sdr_format  sdr;
+               struct v4l2_meta_format meta;
                __u8    raw_data[200];        /* user-defined */
        } fmt;
 };
        case V4L2_BUF_TYPE_SDR_CAPTURE:
        case V4L2_BUF_TYPE_SDR_OUTPUT:
                return get_v4l2_sdr_format(&kp->fmt.sdr, &up->fmt.sdr);
+       case V4L2_BUF_TYPE_META_CAPTURE:
+               return get_v4l2_meta_format(&kp->fmt.meta, &up->fmt.meta);
        default:
                pr_info("compat_ioctl32: unexpected VIDIOC_FMT type %d\n",
                                                                kp->type);
        case V4L2_BUF_TYPE_SDR_CAPTURE:
        case V4L2_BUF_TYPE_SDR_OUTPUT:
                return put_v4l2_sdr_format(&kp->fmt.sdr, &up->fmt.sdr);
+       case V4L2_BUF_TYPE_META_CAPTURE:
+               return put_v4l2_meta_format(&kp->fmt.meta, &up->fmt.meta);
        default:
                pr_info("compat_ioctl32: unexpected VIDIOC_FMT type %d\n",
                                                                kp->type);
 
                set_bit(_IOC_NR(VIDIOC_ENUM_FREQ_BANDS), valid_ioctls);
 
        if (is_vid || is_tch) {
-               /* video specific ioctls */
+               /* video and metadata specific ioctls */
                if ((is_rx && (ops->vidioc_enum_fmt_vid_cap ||
                               ops->vidioc_enum_fmt_vid_cap_mplane ||
-                              ops->vidioc_enum_fmt_vid_overlay)) ||
+                              ops->vidioc_enum_fmt_vid_overlay ||
+                              ops->vidioc_enum_fmt_meta_cap)) ||
                    (is_tx && (ops->vidioc_enum_fmt_vid_out ||
                               ops->vidioc_enum_fmt_vid_out_mplane)))
                        set_bit(_IOC_NR(VIDIOC_ENUM_FMT), valid_ioctls);
                if ((is_rx && (ops->vidioc_g_fmt_vid_cap ||
                               ops->vidioc_g_fmt_vid_cap_mplane ||
-                              ops->vidioc_g_fmt_vid_overlay)) ||
+                              ops->vidioc_g_fmt_vid_overlay ||
+                              ops->vidioc_g_fmt_meta_cap)) ||
                    (is_tx && (ops->vidioc_g_fmt_vid_out ||
                               ops->vidioc_g_fmt_vid_out_mplane ||
                               ops->vidioc_g_fmt_vid_out_overlay)))
                         set_bit(_IOC_NR(VIDIOC_G_FMT), valid_ioctls);
                if ((is_rx && (ops->vidioc_s_fmt_vid_cap ||
                               ops->vidioc_s_fmt_vid_cap_mplane ||
-                              ops->vidioc_s_fmt_vid_overlay)) ||
+                              ops->vidioc_s_fmt_vid_overlay ||
+                              ops->vidioc_s_fmt_meta_cap)) ||
                    (is_tx && (ops->vidioc_s_fmt_vid_out ||
                               ops->vidioc_s_fmt_vid_out_mplane ||
                               ops->vidioc_s_fmt_vid_out_overlay)))
                         set_bit(_IOC_NR(VIDIOC_S_FMT), valid_ioctls);
                if ((is_rx && (ops->vidioc_try_fmt_vid_cap ||
                               ops->vidioc_try_fmt_vid_cap_mplane ||
-                              ops->vidioc_try_fmt_vid_overlay)) ||
+                              ops->vidioc_try_fmt_vid_overlay ||
+                              ops->vidioc_try_fmt_meta_cap)) ||
                    (is_tx && (ops->vidioc_try_fmt_vid_out ||
                               ops->vidioc_try_fmt_vid_out_mplane ||
                               ops->vidioc_try_fmt_vid_out_overlay)))
        }
 
        if (is_vid || is_vbi || is_sdr || is_tch) {
-               /* ioctls valid for video, vbi or sdr */
+               /* ioctls valid for video, metadata, vbi or sdr */
                SET_VALID_IOCTL(ops, VIDIOC_REQBUFS, vidioc_reqbufs);
                SET_VALID_IOCTL(ops, VIDIOC_QUERYBUF, vidioc_querybuf);
                SET_VALID_IOCTL(ops, VIDIOC_QBUF, vidioc_qbuf);
 
        [V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE] = "vid-out-mplane",
        [V4L2_BUF_TYPE_SDR_CAPTURE]        = "sdr-cap",
        [V4L2_BUF_TYPE_SDR_OUTPUT]         = "sdr-out",
+       [V4L2_BUF_TYPE_META_CAPTURE]       = "meta-cap",
 };
 EXPORT_SYMBOL(v4l2_type_names);
 
        const struct v4l2_sliced_vbi_format *sliced;
        const struct v4l2_window *win;
        const struct v4l2_sdr_format *sdr;
+       const struct v4l2_meta_format *meta;
        unsigned i;
 
        pr_cont("type=%s", prt_names(p->type, v4l2_type_names));
                        (sdr->pixelformat >> 16) & 0xff,
                        (sdr->pixelformat >> 24) & 0xff);
                break;
+       case V4L2_BUF_TYPE_META_CAPTURE:
+               meta = &p->fmt.meta;
+               pr_cont(", dataformat=%c%c%c%c, buffersize=%u\n",
+                       (meta->dataformat >>  0) & 0xff,
+                       (meta->dataformat >>  8) & 0xff,
+                       (meta->dataformat >> 16) & 0xff,
+                       (meta->dataformat >> 24) & 0xff,
+                       meta->buffersize);
+               break;
        }
 }
 
                if (is_sdr && is_tx && ops->vidioc_g_fmt_sdr_out)
                        return 0;
                break;
+       case V4L2_BUF_TYPE_META_CAPTURE:
+               if (is_vid && is_rx && ops->vidioc_g_fmt_meta_cap)
+                       return 0;
+               break;
        default:
                break;
        }
                        break;
                ret = ops->vidioc_enum_fmt_sdr_out(file, fh, arg);
                break;
+       case V4L2_BUF_TYPE_META_CAPTURE:
+               if (unlikely(!is_rx || !is_vid || !ops->vidioc_enum_fmt_meta_cap))
+                       break;
+               ret = ops->vidioc_enum_fmt_meta_cap(file, fh, arg);
+               break;
        }
        if (ret == 0)
                v4l_fill_fmtdesc(p);
                if (unlikely(!is_tx || !is_sdr || !ops->vidioc_g_fmt_sdr_out))
                        break;
                return ops->vidioc_g_fmt_sdr_out(file, fh, arg);
+       case V4L2_BUF_TYPE_META_CAPTURE:
+               if (unlikely(!is_rx || !is_vid || !ops->vidioc_g_fmt_meta_cap))
+                       break;
+               return ops->vidioc_g_fmt_meta_cap(file, fh, arg);
        }
        return -EINVAL;
 }
                        break;
                CLEAR_AFTER_FIELD(p, fmt.sdr);
                return ops->vidioc_s_fmt_sdr_out(file, fh, arg);
+       case V4L2_BUF_TYPE_META_CAPTURE:
+               if (unlikely(!is_rx || !is_vid || !ops->vidioc_s_fmt_meta_cap))
+                       break;
+               CLEAR_AFTER_FIELD(p, fmt.meta);
+               return ops->vidioc_s_fmt_meta_cap(file, fh, arg);
        }
        return -EINVAL;
 }
                        break;
                CLEAR_AFTER_FIELD(p, fmt.sdr);
                return ops->vidioc_try_fmt_sdr_out(file, fh, arg);
+       case V4L2_BUF_TYPE_META_CAPTURE:
+               if (unlikely(!is_rx || !is_vid || !ops->vidioc_try_fmt_meta_cap))
+                       break;
+               CLEAR_AFTER_FIELD(p, fmt.meta);
+               return ops->vidioc_try_fmt_meta_cap(file, fh, arg);
        }
        return -EINVAL;
 }
 
        case V4L2_BUF_TYPE_SDR_OUTPUT:
                requested_sizes[0] = f->fmt.sdr.buffersize;
                break;
+       case V4L2_BUF_TYPE_META_CAPTURE:
+               requested_sizes[0] = f->fmt.meta.buffersize;
+               break;
        default:
                return -EINVAL;
        }
 
  * @vidioc_enum_fmt_sdr_out: pointer to the function that implements
  *     :ref:`VIDIOC_ENUM_FMT <vidioc_enum_fmt>` ioctl logic
  *     for Software Defined Radio output
+ * @vidioc_enum_fmt_meta_cap: pointer to the function that implements
+ *     :ref:`VIDIOC_ENUM_FMT <vidioc_enum_fmt>` ioctl logic
+ *     for metadata capture
  * @vidioc_g_fmt_vid_cap: pointer to the function that implements
  *     :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for video capture
  *     in single plane mode
  * @vidioc_g_fmt_sdr_out: pointer to the function that implements
  *     :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for Software Defined
  *     Radio output
+ * @vidioc_g_fmt_meta_cap: pointer to the function that implements
+ *     :ref:`VIDIOC_G_FMT <vidioc_g_fmt>` ioctl logic for metadata capture
  * @vidioc_s_fmt_vid_cap: pointer to the function that implements
  *     :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for video capture
  *     in single plane mode
  * @vidioc_s_fmt_sdr_out: pointer to the function that implements
  *     :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for Software Defined
  *     Radio output
+ * @vidioc_s_fmt_meta_cap: pointer to the function that implements
+ *     :ref:`VIDIOC_S_FMT <vidioc_g_fmt>` ioctl logic for metadata capture
  * @vidioc_try_fmt_vid_cap: pointer to the function that implements
  *     :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for video capture
  *     in single plane mode
  * @vidioc_try_fmt_sdr_out: pointer to the function that implements
  *     :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for Software Defined
  *     Radio output
+ * @vidioc_try_fmt_meta_cap: pointer to the function that implements
+ *     :ref:`VIDIOC_TRY_FMT <vidioc_g_fmt>` ioctl logic for metadata capture
  * @vidioc_reqbufs: pointer to the function that implements
  *     :ref:`VIDIOC_REQBUFS <vidioc_reqbufs>` ioctl
  * @vidioc_querybuf: pointer to the function that implements
                                       struct v4l2_fmtdesc *f);
        int (*vidioc_enum_fmt_sdr_out)(struct file *file, void *fh,
                                       struct v4l2_fmtdesc *f);
+       int (*vidioc_enum_fmt_meta_cap)(struct file *file, void *fh,
+                                       struct v4l2_fmtdesc *f);
 
        /* VIDIOC_G_FMT handlers */
        int (*vidioc_g_fmt_vid_cap)(struct file *file, void *fh,
                                    struct v4l2_format *f);
        int (*vidioc_g_fmt_sdr_out)(struct file *file, void *fh,
                                    struct v4l2_format *f);
+       int (*vidioc_g_fmt_meta_cap)(struct file *file, void *fh,
+                                    struct v4l2_format *f);
 
        /* VIDIOC_S_FMT handlers */
        int (*vidioc_s_fmt_vid_cap)(struct file *file, void *fh,
                                    struct v4l2_format *f);
        int (*vidioc_s_fmt_sdr_out)(struct file *file, void *fh,
                                    struct v4l2_format *f);
+       int (*vidioc_s_fmt_meta_cap)(struct file *file, void *fh,
+                                    struct v4l2_format *f);
 
        /* VIDIOC_TRY_FMT handlers */
        int (*vidioc_try_fmt_vid_cap)(struct file *file, void *fh,
                                      struct v4l2_format *f);
        int (*vidioc_try_fmt_sdr_out)(struct file *file, void *fh,
                                      struct v4l2_format *f);
+       int (*vidioc_try_fmt_meta_cap)(struct file *file, void *fh,
+                                      struct v4l2_format *f);
 
        /* Buffer handlers */
        int (*vidioc_reqbufs)(struct file *file, void *fh,
 
        EM( V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE,  "VIDEO_OUTPUT_MPLANE" ) \
        EM( V4L2_BUF_TYPE_SDR_CAPTURE,          "SDR_CAPTURE" )         \
        EM( V4L2_BUF_TYPE_SDR_OUTPUT,           "SDR_OUTPUT" )          \
+       EM( V4L2_BUF_TYPE_META_CAPTURE,         "META_CAPTURE" )        \
        EMe(V4L2_BUF_TYPE_PRIVATE,              "PRIVATE" )
 
 SHOW_TYPE
 
        V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE  = 10,
        V4L2_BUF_TYPE_SDR_CAPTURE          = 11,
        V4L2_BUF_TYPE_SDR_OUTPUT           = 12,
+       V4L2_BUF_TYPE_META_CAPTURE         = 13,
        /* Deprecated, do not use */
        V4L2_BUF_TYPE_PRIVATE              = 0x80,
 };
 #define V4L2_CAP_SDR_CAPTURE           0x00100000  /* Is a SDR capture device */
 #define V4L2_CAP_EXT_PIX_FORMAT                0x00200000  /* Supports the extended pixel format */
 #define V4L2_CAP_SDR_OUTPUT            0x00400000  /* Is a SDR output device */
+#define V4L2_CAP_META_CAPTURE          0x00800000  /* Is a metadata capture device */
 
 #define V4L2_CAP_READWRITE              0x01000000  /* read/write systemcalls */
 #define V4L2_CAP_ASYNCIO                0x02000000  /* async I/O */
        __u8                            reserved[24];
 } __attribute__ ((packed));
 
+/**
+ * struct v4l2_meta_format - metadata format definition
+ * @dataformat:                little endian four character code (fourcc)
+ * @buffersize:                maximum size in bytes required for data
+ */
+struct v4l2_meta_format {
+       __u32                           dataformat;
+       __u32                           buffersize;
+} __attribute__ ((packed));
+
 /**
  * struct v4l2_format - stream data format
  * @type:      enum v4l2_buf_type; type of the data stream
                struct v4l2_vbi_format          vbi;     /* V4L2_BUF_TYPE_VBI_CAPTURE */
                struct v4l2_sliced_vbi_format   sliced;  /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
                struct v4l2_sdr_format          sdr;     /* V4L2_BUF_TYPE_SDR_CAPTURE */
+               struct v4l2_meta_format         meta;    /* V4L2_BUF_TYPE_META_CAPTURE */
                __u8    raw_data[200];                   /* user-defined */
        } fmt;
 };