Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_SUBDEV_ENUM_MBUS_CODE:
   4
   5 **********************************
   6 ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE
   7 **********************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_SUBDEV_ENUM_MBUS_CODE - Enumerate media bus formats
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_mbus_code_enum * argp )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <func-open>`.
  26
  27 ``request``
  28     VIDIOC_SUBDEV_ENUM_MBUS_CODE
  29
  30 ``argp``
  31
  32
  33 Description
  34 ===========
  35
  36 To enumerate media bus formats available at a given sub-device pad
  37 applications initialize the ``pad``, ``which`` and ``index`` fields of
  38 struct
  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.
  45
  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.
  50
  51
  52 .. _v4l2-subdev-mbus-code-enum:
  53
  54 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  55
  56 .. flat-table:: struct v4l2_subdev_mbus_code_enum
  57     :header-rows:  0
  58     :stub-columns: 0
  59     :widths:       1 1 2
  60
  61
  62     -  .. row 1
  63
  64        -  __u32
  65
  66        -  ``pad``
  67
  68        -  Pad number as reported by the media controller API.
  69
  70     -  .. row 2
  71
  72        -  __u32
  73
  74        -  ``index``
  75
  76        -  Number of the format in the enumeration, set by the application.
  77
  78     -  .. row 3
  79
  80        -  __u32
  81
  82        -  ``code``
  83
  84        -  The media bus format code, as defined in
  85           :ref:`v4l2-mbus-format`.
  86
  87     -  .. row 4
  88
  89        -  __u32
  90
  91        -  ``which``
  92
  93        -  Media bus format codes to be enumerated, from enum
  94           :ref:`v4l2_subdev_format_whence <v4l2-subdev-format-whence>`.
  95
  96     -  .. row 5
  97
  98        -  __u32
  99
 100        -  ``reserved``\ [8]
 101
 102        -  Reserved for future extensions. Applications and drivers must set
 103           the array to zero.
 104
 105
 106 Return Value
 107 ============
 108
 109 On success 0 is returned, on error -1 and the ``errno`` variable is set
 110 appropriately. The generic error codes are described at the
 111 :ref:`Generic Error Codes <gen-errors>` chapter.
 112
 113 EINVAL
 114     The struct
 115     :ref:`v4l2_subdev_mbus_code_enum <v4l2-subdev-mbus-code-enum>`
 116     ``pad`` references a non-existing pad, or the ``index`` field is out
 117     of bounds.