1 .. -*- coding: utf-8; mode: rst -*-
3 .. _VIDIOC_SUBDEV_ENUM_MBUS_CODE:
5 **********************************
6 ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE
7 **********************************
12 VIDIOC_SUBDEV_ENUM_MBUS_CODE - Enumerate media bus formats
18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_mbus_code_enum * argp )
25 File descriptor returned by :ref:`open() <func-open>`.
28 VIDIOC_SUBDEV_ENUM_MBUS_CODE
36 To enumerate media bus formats available at a given sub-device pad
37 applications initialize the ``pad``, ``which`` and ``index`` fields of
39 :ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>` and
40 call the :ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE` ioctl with a pointer to this
41 structure. Drivers fill the rest of the structure or return an ``EINVAL``
42 error code if either the ``pad`` or ``index`` are invalid. All media bus
43 formats are enumerable by beginning at index zero and incrementing by
44 one until ``EINVAL`` is returned.
46 Available media bus formats may depend on the current 'try' formats at
47 other pads of the sub-device, as well as on the current active links.
48 See :ref:`VIDIOC_SUBDEV_G_FMT` for more
49 information about the try formats.
52 .. _v4l2-subdev-mbus-code-enum:
54 .. flat-table:: struct v4l2_subdev_mbus_code_enum
66 - Pad number as reported by the media controller API.
74 - Number of the format in the enumeration, set by the application.
82 - The media bus format code, as defined in
83 :ref:`v4l2-mbus-format`.
91 - Media bus format codes to be enumerated, from enum
92 :ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`.
100 - Reserved for future extensions. Applications and drivers must set
107 On success 0 is returned, on error -1 and the ``errno`` variable is set
108 appropriately. The generic error codes are described at the
109 :ref:`Generic Error Codes <gen-errors>` chapter.
113 :ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>`
114 ``pad`` references a non-existing pad, or the ``index`` field is out