Commit c580efb9 authored by Laurent Pinchart's avatar Laurent Pinchart Committed by Hans Verkuil
Browse files

media: v4l2-subdev: Clearly document that the crop API won't be extended 



The V4L2 subdev crop API has been marked as obsolete, deprecated by the
selection API. Despite this, it has recently been extended with streams
support. In hindsight this was a mistake. Make sure it doesn't happen
again by clearly documenting that no new extensions will be accepted.

Suggested-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: default avatarTomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Signed-off-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
parent cefc10d0

Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst

+3 −3
Original line number Diff line number Diff line
@@ -37,9 +37,9 @@ Description 


.. note::



    This is an :ref:`obsolete` interface and may be removed

    in the future. It is superseded by

    :ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`.

    This is an :ref:`obsolete` interface and may be removed in the future. It is

    superseded by :ref:`the selection API <VIDIOC_SUBDEV_G_SELECTION>`. No new

    extensions to the :c:type:`v4l2_subdev_crop` structure will be accepted.



To retrieve the current crop rectangle applications set the ``pad``

field of a struct :c:type:`v4l2_subdev_crop` to the

include/uapi/linux/v4l2-subdev.h

+4 −0
Original line number Diff line number Diff line
@@ -50,6 +50,10 @@ struct v4l2_subdev_format { 
 * @rect: pad crop rectangle boundaries

 * @stream: stream number, defined in subdev routing

 * @reserved: drivers and applications must zero this array

 *

 * The subdev crop API is an obsolete interface and may be removed in the

 * future. It is superseded by the selection API. No new extensions to this

 * structure will be accepted.

 */

struct v4l2_subdev_crop {

	__u32 which;