Documentation/media/uapi/v4l/vidioc-g-edid.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_G_EDID:
   4
   5 ******************************************************************************
   6 ioctl VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID, VIDIOC_SUBDEV_S_EDID
   7 ******************************************************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_G_EDID - VIDIOC_S_EDID - VIDIOC_SUBDEV_G_EDID - VIDIOC_SUBDEV_S_EDID - Get or set the EDID of a video receiver/transmitter
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <func-open>`.
  26
  27 ``request``
  28     VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID,
  29     VIDIOC_SUBDEV_S_EDID
  30
  31 ``argp``
  32
  33
  34 Description
  35 ===========
  36
  37 These ioctls can be used to get or set an EDID associated with an input
  38 from a receiver or an output of a transmitter device. They can be used
  39 with subdevice nodes (/dev/v4l-subdevX) or with video nodes
  40 (/dev/videoX).
  41
  42 When used with video nodes the ``pad`` field represents the input (for
  43 video capture devices) or output (for video output devices) index as is
  44 returned by :ref:`VIDIOC_ENUMINPUT` and
  45 :ref:`VIDIOC_ENUMOUTPUT` respectively. When used
  46 with subdevice nodes the ``pad`` field represents the input or output
  47 pad of the subdevice. If there is no EDID support for the given ``pad``
  48 value, then the ``EINVAL`` error code will be returned.
  49
  50 To get the EDID data the application has to fill in the ``pad``,
  51 ``start_block``, ``blocks`` and ``edid`` fields, zero the ``reserved``
  52 array and call :ref:`VIDIOC_G_EDID <VIDIOC_G_EDID>`. The current EDID from block
  53 ``start_block`` and of size ``blocks`` will be placed in the memory
  54 ``edid`` points to. The ``edid`` pointer must point to memory at least
  55 ``blocks`` * 128 bytes large (the size of one block is 128 bytes).
  56
  57 If there are fewer blocks than specified, then the driver will set
  58 ``blocks`` to the actual number of blocks. If there are no EDID blocks
  59 available at all, then the error code ``ENODATA`` is set.
  60
  61 If blocks have to be retrieved from the sink, then this call will block
  62 until they have been read.
  63
  64 If ``start_block`` and ``blocks`` are both set to 0 when
  65 :ref:`VIDIOC_G_EDID <VIDIOC_G_EDID>` is called, then the driver will set ``blocks`` to the
  66 total number of available EDID blocks and it will return 0 without
  67 copying any data. This is an easy way to discover how many EDID blocks
  68 there are.
  69
  70 .. note::
  71
  72    If there are no EDID blocks available at all, then
  73    the driver will set ``blocks`` to 0 and it returns 0.
  74
  75 To set the EDID blocks of a receiver the application has to fill in the
  76 ``pad``, ``blocks`` and ``edid`` fields, set ``start_block`` to 0 and
  77 zero the ``reserved`` array. It is not possible to set part of an EDID,
  78 it is always all or nothing. Setting the EDID data is only valid for
  79 receivers as it makes no sense for a transmitter.
  80
  81 The driver assumes that the full EDID is passed in. If there are more
  82 EDID blocks than the hardware can handle then the EDID is not written,
  83 but instead the error code ``E2BIG`` is set and ``blocks`` is set to the
  84 maximum that the hardware supports. If ``start_block`` is any value
  85 other than 0 then the error code ``EINVAL`` is set.
  86
  87 To disable an EDID you set ``blocks`` to 0. Depending on the hardware
  88 this will drive the hotplug pin low and/or block the source from reading
  89 the EDID data in some way. In any case, the end result is the same: the
  90 EDID is no longer available.
  91
  92
  93 .. _v4l2-edid:
  94
  95 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  96
  97 .. flat-table:: struct v4l2_edid
  98     :header-rows:  0
  99     :stub-columns: 0
 100     :widths:       1 1 2
 101
 102
 103     -  .. row 1
 104
 105        -  __u32
 106
 107        -  ``pad``
 108
 109        -  Pad for which to get/set the EDID blocks. When used with a video
 110           device node the pad represents the input or output index as
 111           returned by :ref:`VIDIOC_ENUMINPUT` and
 112           :ref:`VIDIOC_ENUMOUTPUT` respectively.
 113
 114     -  .. row 2
 115
 116        -  __u32
 117
 118        -  ``start_block``
 119
 120        -  Read the EDID from starting with this block. Must be 0 when
 121           setting the EDID.
 122
 123     -  .. row 3
 124
 125        -  __u32
 126
 127        -  ``blocks``
 128
 129        -  The number of blocks to get or set. Must be less or equal to 256
 130           (the maximum number of blocks as defined by the standard). When
 131           you set the EDID and ``blocks`` is 0, then the EDID is disabled or
 132           erased.
 133
 134     -  .. row 4
 135
 136        -  __u32
 137
 138        -  ``reserved``\ [5]
 139
 140        -  Reserved for future extensions. Applications and drivers must set
 141           the array to zero.
 142
 143     -  .. row 5
 144
 145        -  __u8 *
 146
 147        -  ``edid``
 148
 149        -  Pointer to memory that contains the EDID. The minimum size is
 150           ``blocks`` * 128.
 151
 152
 153 Return Value
 154 ============
 155
 156 On success 0 is returned, on error -1 and the ``errno`` variable is set
 157 appropriately. The generic error codes are described at the
 158 :ref:`Generic Error Codes <gen-errors>` chapter.
 159
 160 ``ENODATA``
 161     The EDID data is not available.
 162
 163 ``E2BIG``
 164     The EDID data you provided is more than the hardware can handle.