diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-29 23:37:59 +0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-09 15:34:01 +0300 |
commit | e8be7e97e639af6f968473e5a598afbebc737b9c (patch) | |
tree | a33c38e32956ad127634eabb978f824ecbbb6c65 /Documentation/media/uapi/v4l/diff-v4l.rst | |
parent | 2257e180101c910c2d93dd226ab1e500e4a6813c (diff) | |
download | linux-e8be7e97e639af6f968473e5a598afbebc737b9c.tar.xz |
[media] docs-rst: convert uAPI structs to C domain
instead of declaring the uAPI structs using usual refs, e. g.:
.. _foo-struct:
Use the C domain way:
.. c:type:: foo_struct
This way, the kAPI documentation can use cross-references to
point to the uAPI symbols.
That solves about ~100 undefined warnings like:
WARNING: c:type reference target not found: foo_struct
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/v4l/diff-v4l.rst')
-rw-r--r-- | Documentation/media/uapi/v4l/diff-v4l.rst | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/Documentation/media/uapi/v4l/diff-v4l.rst b/Documentation/media/uapi/v4l/diff-v4l.rst index 93263e477127..93794e015e7c 100644 --- a/Documentation/media/uapi/v4l/diff-v4l.rst +++ b/Documentation/media/uapi/v4l/diff-v4l.rst @@ -88,7 +88,7 @@ The V4L ``VIDIOCGCAP`` ioctl is equivalent to V4L2's :ref:`VIDIOC_QUERYCAP`. The ``name`` field in struct :c:type:`struct video_capability` became -``card`` in struct :ref:`v4l2_capability <v4l2-capability>`, ``type`` +``card`` in struct :c:type:`v4l2_capability`, ``type`` was replaced by ``capabilities``. Note V4L2 does not distinguish between device types like this, better think of basic video input, video output and radio devices supporting a set of related functions like video @@ -108,7 +108,7 @@ introduction. - ``struct video_capability`` ``type`` - - struct :ref:`v4l2_capability <v4l2-capability>` + - struct :c:type:`v4l2_capability` ``capabilities`` flags - Purpose @@ -150,7 +150,7 @@ introduction. - ``VID_TYPE_CHROMAKEY`` - ``V4L2_FBUF_CAP_CHROMAKEY`` in field ``capability`` of struct - :ref:`v4l2_framebuffer <v4l2-framebuffer>` + :c:type:`v4l2_framebuffer` - Whether chromakey overlay is supported. For more information on overlay see :ref:`overlay`. @@ -161,7 +161,7 @@ introduction. - ``V4L2_FBUF_CAP_LIST_CLIPPING`` and ``V4L2_FBUF_CAP_BITMAP_CLIPPING`` in field ``capability`` of - struct :ref:`v4l2_framebuffer <v4l2-framebuffer>` + struct :c:type:`v4l2_framebuffer` - Whether clipping the overlaid image is supported, see :ref:`overlay`. @@ -171,7 +171,7 @@ introduction. - ``VID_TYPE_FRAMERAM`` - ``V4L2_FBUF_CAP_EXTERNOVERLAY`` *not set* in field ``capability`` - of struct :ref:`v4l2_framebuffer <v4l2-framebuffer>` + of struct :c:type:`v4l2_framebuffer` - Whether overlay overwrites frame buffer memory, see :ref:`overlay`. @@ -269,7 +269,7 @@ device. The equivalent V4L2 ioctls are :ref:`VIDIOC_ENUMINPUT`, :ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` using struct -:ref:`v4l2_input <v4l2-input>` as discussed in :ref:`video`. +:c:type:`v4l2_input` as discussed in :ref:`video`. The ``channel`` field counting inputs was renamed to ``index``, the video input types were renamed as follows: @@ -285,7 +285,7 @@ video input types were renamed as follows: - struct :c:type:`struct video_channel` ``type`` - - struct :ref:`v4l2_input <v4l2-input>` ``type`` + - struct :c:type:`v4l2_input` ``type`` - .. row 2 @@ -305,7 +305,7 @@ input, V4L2 assumes each video input is connected to at most one tuner. However a tuner can have more than one input, i. e. RF connectors, and a device can have multiple tuners. The index number of the tuner associated with the input, if any, is stored in field ``tuner`` of -struct :ref:`v4l2_input <v4l2-input>`. Enumeration of tuners is +struct :c:type:`v4l2_input`. Enumeration of tuners is discussed in :ref:`tuner`. The redundant ``VIDEO_VC_TUNER`` flag was dropped. Video inputs @@ -332,7 +332,7 @@ The V4L ``VIDIOCGTUNER`` and ``VIDIOCSTUNER`` ioctl and struct V4L TV or radio device. The equivalent V4L2 ioctls are :ref:`VIDIOC_G_TUNER <VIDIOC_G_TUNER>` and :ref:`VIDIOC_S_TUNER <VIDIOC_G_TUNER>` using struct -:ref:`v4l2_tuner <v4l2-tuner>`. Tuners are covered in :ref:`tuner`. +:c:type:`v4l2_tuner`. Tuners are covered in :ref:`tuner`. The ``tuner`` field counting tuners was renamed to ``index``. The fields ``name``, ``rangelow`` and ``rangehigh`` remained unchanged. @@ -340,7 +340,7 @@ The ``tuner`` field counting tuners was renamed to ``index``. The fields The ``VIDEO_TUNER_PAL``, ``VIDEO_TUNER_NTSC`` and ``VIDEO_TUNER_SECAM`` flags indicating the supported video standards were dropped. This information is now contained in the associated struct -:ref:`v4l2_input <v4l2-input>`. No replacement exists for the +:c:type:`v4l2_input`. No replacement exists for the ``VIDEO_TUNER_NORM`` flag indicating whether the video standard can be switched. The ``mode`` field to select a different video standard was replaced by a whole new set of ioctls and structures described in @@ -353,18 +353,18 @@ Japan with numbers 3-6 (sic). The ``VIDEO_TUNER_STEREO_ON`` flag indicating stereo reception became ``V4L2_TUNER_SUB_STEREO`` in field ``rxsubchans``. This field also permits the detection of monaural and bilingual audio, see the -definition of struct :ref:`v4l2_tuner <v4l2-tuner>` for details. +definition of struct :c:type:`v4l2_tuner` for details. Presently no replacement exists for the ``VIDEO_TUNER_RDS_ON`` and ``VIDEO_TUNER_MBS_ON`` flags. The ``VIDEO_TUNER_LOW`` flag was renamed to ``V4L2_TUNER_CAP_LOW`` in -the struct :ref:`v4l2_tuner <v4l2-tuner>` ``capability`` field. +the struct :c:type:`v4l2_tuner` ``capability`` field. The ``VIDIOCGFREQ`` and ``VIDIOCSFREQ`` ioctl to change the tuner frequency where renamed to :ref:`VIDIOC_G_FREQUENCY <VIDIOC_G_FREQUENCY>` and :ref:`VIDIOC_S_FREQUENCY <VIDIOC_G_FREQUENCY>`. They take a pointer -to a struct :ref:`v4l2_frequency <v4l2-frequency>` instead of an +to a struct :c:type:`v4l2_frequency` instead of an unsigned long integer. @@ -434,7 +434,7 @@ The ``depth`` (average number of bits per pixel) of a video image is implied by the selected image format. V4L2 does not explicitly provide such information assuming applications recognizing the format are aware of the image depth and others need not know. The ``palette`` field moved -into the struct :ref:`v4l2_pix_format <v4l2-pix-format>`: +into the struct :c:type:`v4l2_pix_format`: @@ -447,7 +447,7 @@ into the struct :ref:`v4l2_pix_format <v4l2-pix-format>`: - struct :c:type:`struct video_picture` ``palette`` - - struct :ref:`v4l2_pix_format <v4l2-pix-format>` ``pixfmt`` + - struct :c:type:`v4l2_pix_format` ``pixfmt`` - .. row 2 @@ -558,7 +558,7 @@ The ``VIDIOCGAUDIO`` and ``VIDIOCSAUDIO`` ioctl and struct of a V4L device. The equivalent V4L2 ioctls are :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and :ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` using struct -:ref:`v4l2_audio <v4l2-audio>` as discussed in :ref:`audio`. +:c:type:`v4l2_audio` as discussed in :ref:`audio`. The ``audio`` "channel number" field counting audio inputs was renamed to ``index``. @@ -571,10 +571,10 @@ standard is BTSC ``VIDEO_SOUND_LANG2`` refers to SAP and specification, there is no way to query the selected mode. On ``VIDIOCGAUDIO`` the driver returns the *actually received* audio programmes in this field. In the V4L2 API this information is stored in -the struct :ref:`v4l2_tuner <v4l2-tuner>` ``rxsubchans`` and +the struct :c:type:`v4l2_tuner` ``rxsubchans`` and ``audmode`` fields, respectively. See :ref:`tuner` for more information on tuners. Related to audio modes struct -:ref:`v4l2_audio <v4l2-audio>` also reports if this is a mono or +:c:type:`v4l2_audio` also reports if this is a mono or stereo input, regardless if the source is a tuner. The following fields where replaced by V4L2 controls accessible with the @@ -645,8 +645,8 @@ The V4L2 ioctls equivalent to ``VIDIOCGFBUF`` and ``VIDIOCSFBUF`` are :c:type:`struct video_buffer` remained unchanged, except V4L2 defines a flag to indicate non-destructive overlays instead of a ``NULL`` pointer. All other fields moved into the struct -:ref:`v4l2_pix_format <v4l2-pix-format>` ``fmt`` substructure of -struct :ref:`v4l2_framebuffer <v4l2-framebuffer>`. The ``depth`` +:c:type:`v4l2_pix_format` ``fmt`` substructure of +struct :c:type:`v4l2_framebuffer`. The ``depth`` field was replaced by ``pixelformat``. See :ref:`pixfmt-rgb` for a list of RGB formats and their respective color depths. @@ -654,23 +654,23 @@ Instead of the special ioctls ``VIDIOCGWIN`` and ``VIDIOCSWIN`` V4L2 uses the general-purpose data format negotiation ioctls :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. They take a pointer to a struct -:ref:`v4l2_format <v4l2-format>` as argument. Here the ``win`` member +:c:type:`v4l2_format` as argument. Here the ``win`` member of the ``fmt`` union is used, a struct -:ref:`v4l2_window <v4l2-window>`. +:c:type:`v4l2_window`. The ``x``, ``y``, ``width`` and ``height`` fields of struct :c:type:`struct video_window` moved into struct -:ref:`v4l2_rect <v4l2-rect>` substructure ``w`` of struct +:c:type:`v4l2_rect` substructure ``w`` of struct :c:type:`struct v4l2_window`. The ``chromakey``, ``clips``, and ``clipcount`` fields remained unchanged. Struct :c:type:`struct video_clip` was renamed to struct -:ref:`v4l2_clip <v4l2-clip>`, also containing a struct +:c:type:`v4l2_clip`, also containing a struct :c:type:`struct v4l2_rect`, but the semantics are still the same. The ``VIDEO_WINDOW_INTERLACE`` flag was dropped. Instead applications must set the ``field`` field to ``V4L2_FIELD_ANY`` or ``V4L2_FIELD_INTERLACED``. The ``VIDEO_WINDOW_CHROMAKEY`` flag moved -into struct :ref:`v4l2_framebuffer <v4l2-framebuffer>`, under the new +into struct :c:type:`v4l2_framebuffer`, under the new name ``V4L2_FBUF_FLAG_CHROMAKEY``. In V4L, storing a bitmap pointer in ``clips`` and setting ``clipcount`` @@ -691,12 +691,12 @@ To capture only a subsection of the full picture V4L defines the :c:type:`struct video_capture`. The equivalent V4L2 ioctls are :ref:`VIDIOC_G_CROP <VIDIOC_G_CROP>` and :ref:`VIDIOC_S_CROP <VIDIOC_G_CROP>` using struct -:ref:`v4l2_crop <v4l2-crop>`, and the related +:c:type:`v4l2_crop`, and the related :ref:`VIDIOC_CROPCAP` ioctl. This is a rather complex matter, see :ref:`crop` for details. The ``x``, ``y``, ``width`` and ``height`` fields moved into struct -:ref:`v4l2_rect <v4l2-rect>` substructure ``c`` of struct +:c:type:`v4l2_rect` substructure ``c`` of struct :c:type:`struct v4l2_crop`. The ``decimation`` field was dropped. In the V4L2 API the scaling factor is implied by the size of the cropping rectangle and the size of the captured or overlaid image. @@ -704,8 +704,8 @@ rectangle and the size of the captured or overlaid image. The ``VIDEO_CAPTURE_ODD`` and ``VIDEO_CAPTURE_EVEN`` flags to capture only the odd or even field, respectively, were replaced by ``V4L2_FIELD_TOP`` and ``V4L2_FIELD_BOTTOM`` in the field named -``field`` of struct :ref:`v4l2_pix_format <v4l2-pix-format>` and -struct :ref:`v4l2_window <v4l2-window>`. These structures are used to +``field`` of struct :c:type:`v4l2_pix_format` and +struct :c:type:`v4l2_window`. These structures are used to select a capture or overlay format with the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. @@ -730,8 +730,8 @@ To select an image format and size, V4L provides the ``VIDIOCSPICT`` and ``VIDIOCSWIN`` ioctls. V4L2 uses the general-purpose data format negotiation ioctls :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>`. They take a pointer to a struct -:ref:`v4l2_format <v4l2-format>` as argument, here the struct -:ref:`v4l2_pix_format <v4l2-pix-format>` named ``pix`` of its +:c:type:`v4l2_format` as argument, here the struct +:c:type:`v4l2_pix_format` named ``pix`` of its ``fmt`` union is used. For more information about the V4L2 read interface see :ref:`rw`. @@ -838,7 +838,7 @@ with the following parameters: - .. row 1 - - struct :ref:`v4l2_vbi_format <v4l2-vbi-format>` + - struct :c:type:`v4l2_vbi_format` - V4L, BTTV driver @@ -896,7 +896,7 @@ interface specified in :ref:`raw-vbi`. An ``offset`` field does not exist, ``sample_format`` is supposed to be ``VIDEO_PALETTE_RAW``, equivalent to ``V4L2_PIX_FMT_GREY``. The remaining fields are probably equivalent to struct -:ref:`v4l2_vbi_format <v4l2-vbi-format>`. +:c:type:`v4l2_vbi_format`. Apparently only the Zoran (ZR 36120) driver implements these ioctls. The semantics differ from those specified for V4L2 in two ways. The |