The Linux Kernel
4.20.0
  • The Linux kernel user’s and administrator’s guide
  • The Linux kernel user-space API guide
  • Working with the kernel development community
  • Development tools for the kernel
  • How to write kernel documentation
  • Kernel Hacking Guides
  • Linux Tracing Technologies
  • Kernel Maintainer Handbook
  • The Linux driver implementer’s API guide
  • Core API Documentation
  • Linux Media Subsystem Documentation
    • 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. Usage
        • 6. Function Reference
        • 7. Media Controller Header File
        • Revision and Copyright
        • Revision History
      • Part V - Consumer Electronics Control API
      • Generic Error Codes
      • GNU Free Documentation License
    • Media subsystem kernel internal API
    • Linux Digital TV driver-specific documentation
    • Video4Linux (V4L) driver-specific documentation
    • CEC driver-specific documentation
  • Linux Networking Documentation
  • The Linux Input Documentation
  • Linux GPU Driver Developer’s Guide
  • Security Documentation
  • Linux Sound Subsystem Documentation
  • Linux Kernel Crypto API
  • Linux Filesystems API
  • Linux Memory Management Documentation
  • BPF Documentation
  • SuperH Interfaces Guide
  • ext4 Data Structures and Algorithms
  • Translations
The Linux Kernel
  • Docs »
  • Linux Media Subsystem Documentation »
  • Linux Media Infrastructure userspace API »
  • Part IV - Media Controller API »
  • 6. Function Reference »
  • 6.8. ioctl MEDIA_IOC_SETUP_LINK
  • View page source

6.8. ioctl MEDIA_IOC_SETUP_LINK¶

6.8.1. Name¶

MEDIA_IOC_SETUP_LINK - Modify the properties of a link

6.8.2. Synopsis¶

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

6.8.3. Arguments¶

fd
File descriptor returned by open().
argp
Pointer to struct media_link_desc.

6.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.

6.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.
Next Previous

© Copyright The kernel development community.

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