Documentation/media/uapi/mediactl/media-ioc-setup-link.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _media_ioc_setup_link:
   4
   5 **************************
   6 ioctl MEDIA_IOC_SETUP_LINK
   7 **************************
   8
   9 Name
  10 ====
  11
  12 MEDIA_IOC_SETUP_LINK - Modify the properties of a link
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct media_link_desc *argp )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <media-func-open>`.
  26
  27 ``request``
  28     MEDIA_IOC_SETUP_LINK
  29
  30 ``argp``
  31
  32
  33 Description
  34 ===========
  35
  36 To change link properties applications fill a struct
  37 :ref:`media_link_desc <media-link-desc>` with link identification
  38 information (source and sink pad) and the new requested link flags. They
  39 then call the MEDIA_IOC_SETUP_LINK ioctl with a pointer to that
  40 structure.
  41
  42 The only configurable property is the ``ENABLED`` link flag to
  43 enable/disable a link. Links marked with the ``IMMUTABLE`` link flag can
  44 not be enabled or disabled.
  45
  46 Link configuration has no side effect on other links. If an enabled link
  47 at the sink pad prevents the link from being enabled, the driver returns
  48 with an ``EBUSY`` error code.
  49
  50 Only links marked with the ``DYNAMIC`` link flag can be enabled/disabled
  51 while streaming media data. Attempting to enable or disable a streaming
  52 non-dynamic link will return an ``EBUSY`` error code.
  53
  54 If the specified link can't be found the driver returns with an ``EINVAL``
  55 error code.
  56
  57
  58 Return Value
  59 ============
  60
  61 On success 0 is returned, on error -1 and the ``errno`` variable is set
  62 appropriately. The generic error codes are described at the
  63 :ref:`Generic Error Codes <gen-errors>` chapter.
  64
  65 EINVAL
  66     The struct :ref:`media_link_desc <media-link-desc>` references a
  67     non-existing link, or the link is immutable and an attempt to modify
  68     its configuration was made.