The Linux Kernel
6.3.0-rc3
  • A guide to the Kernel Development Process
  • Submitting patches: the essential guide to getting your code into the kernel
  • Code of conduct
  • Kernel Maintainer Handbook
  • All development-process docs
  • Core API Documentation
  • Driver implementer’s API guide
  • Kernel subsystem documentation
  • Locking in the kernel
  • Linux kernel licensing rules
  • How to write kernel documentation
  • Development tools for the kernel
  • Kernel Testing Guide
  • Kernel Hacking Guides
  • Linux Tracing Technologies
  • fault-injection
  • Kernel Livepatching
  • Rust
  • The Linux kernel user’s and administrator’s guide
  • The kernel build system
  • Reporting issues
  • User-space tools
  • The Linux kernel user-space API guide
    • No New Privileges Flag
    • Seccomp BPF (SECure COMPuting with filters)
    • Landlock: unprivileged access control
    • unshare system call
    • Speculation Control
    • OpenCAPI (Open Coherent Accelerator Processor Interface)
    • eBPF Userspace API
    • IOCTLs
    • IOMMU Userspace API
    • 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.7.1. Name
            • 5.7.2. Synopsis
            • 5.7.3. Arguments
            • 5.7.4. Description
            • 5.7.5. Return Value
          • 5.8. ioctl MEDIA_IOC_SETUP_LINK
          • 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
    • Netlink Handbook
    • Platform Profile Selection (e.g. /sys/firmware/acpi/platform_profile)
    • VDUSE - “vDPA Device in Userspace”
    • futex2
  • The Linux kernel firmware guide
  • Open 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.7. ioctl MEDIA_IOC_ENUM_LINKS
  • View page source

5.7. ioctl MEDIA_IOC_ENUM_LINKS¶

5.7.1. Name¶

MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity

5.7.2. Synopsis¶

MEDIA_IOC_ENUM_LINKS¶

int ioctl(int fd, MEDIA_IOC_ENUM_LINKS, struct media_links_enum *argp)

5.7.3. Arguments¶

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

5.7.4. Description¶

To enumerate pads and/or links for a given entity, applications set the entity field of a struct media_links_enum structure and initialize the struct media_pad_desc and struct media_link_desc structure arrays pointed by the pads and links fields. They then call the MEDIA_IOC_ENUM_LINKS ioctl with a pointer to this structure.

If the pads field is not NULL, the driver fills the pads array with information about the entity’s pads. The array must have enough room to store all the entity’s pads. The number of pads can be retrieved with ioctl MEDIA_IOC_ENUM_ENTITIES.

If the links field is not NULL, the driver fills the links array with information about the entity’s outbound links. The array must have enough room to store all the entity’s outbound links. The number of outbound links can be retrieved with ioctl MEDIA_IOC_ENUM_ENTITIES.

Only forward links that originate at one of the entity’s source pads are returned during the enumeration process.

media_links_enum¶
struct media_links_enum¶
__u32 entity Entity id, set by the application.
struct media_pad_desc *pads Pointer to a pads array allocated by the application. Ignored if NULL.
struct media_link_desc *links Pointer to a links array allocated by the application. Ignored if NULL.
__u32 reserved[4] Reserved for future extensions. Drivers and applications must set the array to zero.
media_pad_desc¶
struct media_pad_desc¶
__u32 entity ID of the entity this pad belongs to.
__u16 index Pad index, starts at 0.
__u32 flags Pad flags, see Media pad flags for more details.
__u32 reserved[2] Reserved for future extensions. Drivers and applications must set the array to zero.
media_link_desc¶
struct media_link_desc¶
struct media_pad_desc source Pad at the origin of this link.
struct media_pad_desc sink Pad at the target of this link.
__u32 flags Link flags, see Media link flags for more details.
__u32 reserved[2] Reserved for future extensions. Drivers and applications must set the array to zero.

5.7.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_links_enum id references a non-existing entity.
Previous Next

© Copyright The kernel development community.

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