The Linux Kernel
  • Linux Kernel Documentation
    • Introduction
    • Sphinx Build
    • Writing Documentation
    • Including kernel-doc comments
    • Writing kernel-doc comments
    • DocBook XML [DEPRECATED]
  • Linux Kernel Development Documentation
    • A guide to the Kernel Development Process
  • Development tools for the kernel
    • Coccinelle
    • Sparse
    • kcov: code coverage for fuzzing
    • Using gcov with the Linux kernel
    • The Kernel Address Sanitizer (KASAN)
    • The Undefined Behavior Sanitizer - UBSAN
    • Kernel Memory Leak Detector
    • Getting started with kmemcheck
    • Debugging kernel and modules via gdb
  • The Linux driver implementer’s API guide
    • Driver Basics
    • Device drivers infrastructure
    • Message-based devices
    • Sound Devices
    • Frame Buffer Library
    • Input Subsystem
    • Serial Peripheral Interface (SPI)
    • I2C and SMBus Subsystem
    • High Speed Synchronous Serial Interface (HSI)
    • Parallel Port Devices
    • 16x50 UART Driver
    • Pulse-Width Modulation (PWM)
  • Linux Media Subsystem Documentation
    • Linux Media Infrastructure userspace API
    • Media subsystem kernel internal API
    • Linux Digital TV driver-specific documentation
    • Video4Linux (V4L) driver-specific documentation
  • Linux GPU Driver Developer’s Guide
    • Introduction
    • DRM Internals
    • DRM Memory Management
    • Kernel Mode Setting (KMS)
    • Mode Setting Helper Functions
    • Userland interfaces
    • drm/i915 Intel GFX Driver
    • VGA Switcheroo
    • VGA Arbiter
  • Linux 802.11 Driver Developer’s Guide
    • Introduction
    • cfg80211 subsystem
    • mac80211 subsystem (basics)
    • mac80211 subsystem (advanced)
  • Hardware vulnerabilities
    • L1TF - L1 Terminal Fault
    • MDS - Microarchitectural Data Sampling
    • TAA - TSX Asynchronous Abort
    • iTLB multihit
  • x86 architecture specifics
    • Microarchitectural Data Sampling (MDS) mitigation
    • TSX Async Abort (TAA) mitigation
 
The Linux Kernel
  • Docs »
  • Linux Media Subsystem Documentation »
  • Linux Media Infrastructure userspace API »
  • Part IV - Media Controller API »
  • 4. Function Reference »
  • 4.7. ioctl MEDIA_IOC_ENUM_LINKS
  • View page source

4.7. ioctl MEDIA_IOC_ENUM_LINKS¶

4.7.1. Name¶

MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity

4.7.2. Synopsis¶

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

4.7.3. Arguments¶

fd
File descriptor returned by open().

argp

4.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.
media_pad_desc¶
struct media_pad_desc
__u32 entity ID of the entity this pad belongs to.
__u16 index 0-based pad index.
__u32 flags Pad flags, see Media pad flags for more details.
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.

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

© Copyright 2016, The kernel development community.

Sphinx theme provided by Read the Docs