1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later 2.. c:namespace:: V4L 3 4.. _VIDIOC_SUBDEV_ENUM_MBUS_CODE: 5 6********************************** 7ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE 8********************************** 9 10Name 11==== 12 13VIDIOC_SUBDEV_ENUM_MBUS_CODE - Enumerate media bus formats 14 15Synopsis 16======== 17 18.. c:macro:: VIDIOC_SUBDEV_ENUM_MBUS_CODE 19 20``int ioctl(int fd, VIDIOC_SUBDEV_ENUM_MBUS_CODE, struct v4l2_subdev_mbus_code_enum * argp)`` 21 22Arguments 23========= 24 25``fd`` 26 File descriptor returned by :c:func:`open()`. 27 28``argp`` 29 Pointer to struct :c:type:`v4l2_subdev_mbus_code_enum`. 30 31Description 32=========== 33 34To enumerate media bus formats available at a given sub-device pad 35applications initialize the ``pad``, ``which`` and ``index`` fields of 36struct 37:c:type:`v4l2_subdev_mbus_code_enum` and 38call the :ref:`VIDIOC_SUBDEV_ENUM_MBUS_CODE` ioctl with a pointer to this 39structure. Drivers fill the rest of the structure or return an ``EINVAL`` 40error code if either the ``pad`` or ``index`` are invalid. All media bus 41formats are enumerable by beginning at index zero and incrementing by 42one until ``EINVAL`` is returned. 43 44Available media bus formats may depend on the current 'try' formats at 45other pads of the sub-device, as well as on the current active links. 46See :ref:`VIDIOC_SUBDEV_G_FMT` for more 47information about the try formats. 48 49.. c:type:: v4l2_subdev_mbus_code_enum 50 51.. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.5cm}| 52 53.. flat-table:: struct v4l2_subdev_mbus_code_enum 54 :header-rows: 0 55 :stub-columns: 0 56 :widths: 1 1 2 57 58 * - __u32 59 - ``pad`` 60 - Pad number as reported by the media controller API. 61 * - __u32 62 - ``index`` 63 - Number of the format in the enumeration, set by the application. 64 * - __u32 65 - ``code`` 66 - The media bus format code, as defined in 67 :ref:`v4l2-mbus-format`. 68 * - __u32 69 - ``which`` 70 - Media bus format codes to be enumerated, from enum 71 :ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`. 72 * - __u32 73 - ``flags`` 74 - See :ref:`v4l2-subdev-mbus-code-flags` 75 * - __u32 76 - ``stream`` 77 - Stream identifier. 78 * - __u32 79 - ``reserved``\ [6] 80 - Reserved for future extensions. Applications and drivers must set 81 the array to zero. 82 83 84 85.. raw:: latex 86 87 \footnotesize 88 89.. tabularcolumns:: |p{8.8cm}|p{2.2cm}|p{6.3cm}| 90 91.. _v4l2-subdev-mbus-code-flags: 92 93.. flat-table:: Subdev Media Bus Code Enumerate Flags 94 :header-rows: 0 95 :stub-columns: 0 96 :widths: 1 1 2 97 98 * - V4L2_SUBDEV_MBUS_CODE_CSC_COLORSPACE 99 - 0x00000001 100 - The driver allows the application to try to change the default colorspace 101 encoding. The application can ask to configure the colorspace of the 102 subdevice when calling the :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` 103 ioctl with :ref:`V4L2_MBUS_FRAMEFMT_SET_CSC <mbus-framefmt-set-csc>` set. 104 See :ref:`v4l2-mbus-format` on how to do this. 105 * - V4L2_SUBDEV_MBUS_CODE_CSC_XFER_FUNC 106 - 0x00000002 107 - The driver allows the application to try to change the default transform function. 108 The application can ask to configure the transform function of 109 the subdevice when calling the :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` 110 ioctl with :ref:`V4L2_MBUS_FRAMEFMT_SET_CSC <mbus-framefmt-set-csc>` set. 111 See :ref:`v4l2-mbus-format` on how to do this. 112 * - V4L2_SUBDEV_MBUS_CODE_CSC_YCBCR_ENC 113 - 0x00000004 114 - The driver allows the application to try to change the default Y'CbCr 115 encoding. The application can ask to configure the Y'CbCr encoding of the 116 subdevice when calling the :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` 117 ioctl with :ref:`V4L2_MBUS_FRAMEFMT_SET_CSC <mbus-framefmt-set-csc>` set. 118 See :ref:`v4l2-mbus-format` on how to do this. 119 * - V4L2_SUBDEV_MBUS_CODE_CSC_HSV_ENC 120 - 0x00000004 121 - The driver allows the application to try to change the default HSV 122 encoding. The application can ask to configure the HSV encoding of the 123 subdevice when calling the :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` 124 ioctl with :ref:`V4L2_MBUS_FRAMEFMT_SET_CSC <mbus-framefmt-set-csc>` set. 125 See :ref:`v4l2-mbus-format` on how to do this. 126 * - V4L2_SUBDEV_MBUS_CODE_CSC_QUANTIZATION 127 - 0x00000008 128 - The driver allows the application to try to change the default 129 quantization. The application can ask to configure the quantization of 130 the subdevice when calling the :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` 131 ioctl with :ref:`V4L2_MBUS_FRAMEFMT_SET_CSC <mbus-framefmt-set-csc>` set. 132 See :ref:`v4l2-mbus-format` on how to do this. 133 134.. raw:: latex 135 136 \normalsize 137 138Return Value 139============ 140 141On success 0 is returned, on error -1 and the ``errno`` variable is set 142appropriately. The generic error codes are described at the 143:ref:`Generic Error Codes <gen-errors>` chapter. 144 145EINVAL 146 The struct 147 :c:type:`v4l2_subdev_mbus_code_enum` 148 ``pad`` references a non-existing pad, or the ``index`` field is out 149 of bounds. 150