The Linux Kernel Logo
  • Development process
  • Submitting patches
  • Code of conduct
  • Maintainer handbook
  • All development-process docs
  • Core API
  • Driver APIs
  • Subsystems
  • Locking
  • Licensing rules
  • Writing documentation
  • Development tools
  • Testing guide
  • Hacking guide
  • Tracing
  • Fault injection
  • Livepatching
  • Rust
  • Administration
  • Build system
  • Reporting issues
  • Userspace tools
  • Userspace API
    • System calls
    • Security-related interfaces
    • Devices and I/O
      • OpenCAPI (Open Coherent Accelerator Processor Interface)
      • Allocating dma-buf using heaps
      • Exchanging pixel buffers
      • Firmware Control (FWCTL) Userspace API
      • GPIO
      • IOMMUFD
      • Linux Media Infrastructure userspace API
        • Introduction
        • Part I - Video for Linux API
        • Part II - Digital TV API
        • Part III - Remote Controller API
        • Part IV - Media Controller API
          • 1. Introduction
          • 2. Media device model
          • 3. Types and flags used to represent the media graph elements
          • 4. Request API
          • 5. Function Reference
            • 5.1. media open()
            • 5.2. media close()
            • 5.3. media ioctl()
            • 5.4. ioctl MEDIA_IOC_DEVICE_INFO
            • 5.5. ioctl MEDIA_IOC_G_TOPOLOGY
            • 5.6. ioctl MEDIA_IOC_ENUM_ENTITIES
            • 5.7. ioctl MEDIA_IOC_ENUM_LINKS
            • 5.8. ioctl MEDIA_IOC_SETUP_LINK
              • 5.8.1. Name
              • 5.8.2. Synopsis
              • 5.8.3. Arguments
              • 5.8.4. Description
              • 5.8.5. Return Value
            • 5.9. ioctl MEDIA_IOC_REQUEST_ALLOC
            • 5.10. request close()
            • 5.11. request ioctl()
            • 5.12. request poll()
            • 5.13. ioctl MEDIA_REQUEST_IOC_QUEUE
            • 5.14. ioctl MEDIA_REQUEST_IOC_REINIT
          • 6. Media Controller Header File
          • Revision and Copyright
          • Revision History
        • Part V - Consumer Electronics Control API
        • Generic Error Codes
        • Glossary
        • GNU Free Documentation License
        • Video4Linux (V4L) driver-specific documentation
      • Dell Systems Management Base Driver
      • VDUSE - “vDPA Device in Userspace”
      • ISA Plug & Play support
    • Everything else
  • Firmware
  • Firmware and Devicetree
  • CPU architectures
  • Unsorted documentation
  • Translations
The Linux Kernel
  • The Linux kernel user-space API guide
  • Linux Media Infrastructure userspace API
  • Part IV - Media Controller API
  • 5. Function Reference
  • 5.8. ioctl MEDIA_IOC_SETUP_LINK
  • View page source

5.8. ioctl MEDIA_IOC_SETUP_LINK¶

5.8.1. Name¶

MEDIA_IOC_SETUP_LINK - Modify the properties of a link

5.8.2. Synopsis¶

MEDIA_IOC_SETUP_LINK¶

int ioctl(int fd, MEDIA_IOC_SETUP_LINK, struct media_link_desc *argp)

5.8.3. Arguments¶

fd

File descriptor returned by open().

argp

Pointer to struct media_link_desc.

5.8.4. Description¶

To change link properties applications fill a struct media_link_desc with link identification information (source and sink pad) and the new requested link flags. They then call the MEDIA_IOC_SETUP_LINK ioctl with a pointer to that structure.

The only configurable property is the ENABLED link flag to enable/disable a link. Links marked with the IMMUTABLE link flag can not be enabled or disabled.

Link configuration has no side effect on other links. If an enabled link at the sink pad prevents the link from being enabled, the driver returns with an EBUSY error code.

Only links marked with the DYNAMIC link flag can be enabled/disabled while streaming media data. Attempting to enable or disable a streaming non-dynamic link will return an EBUSY error code.

If the specified link can’t be found the driver returns with an EINVAL error code.

5.8.5. Return Value¶

On success 0 is returned, on error -1 and the errno variable is set appropriately. The generic error codes are described at the Generic Error Codes chapter.

EINVAL

The struct media_link_desc references a non-existing link, or the link is immutable and an attempt to modify its configuration was made.

Previous Next

© Copyright The kernel development community.

Built with Sphinx using a theme provided by Read the Docs.