8.57. ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE

8.57.1. Name

VIDIOC_SUBDEV_ENUM_MBUS_CODE - Enumerate media bus formats

8.57.2. Synopsis

int ioctl(int fd, VIDIOC_SUBDEV_ENUM_MBUS_CODE, struct v4l2_subdev_mbus_code_enum * argp)

8.57.3. Arguments

fd

File descriptor returned by open().

argp

8.57.4. Description

To enumerate media bus formats available at a given sub-device pad applications initialize the pad, which and index fields of struct v4l2_subdev_mbus_code_enum and call the ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE ioctl with a pointer to this structure. Drivers fill the rest of the structure or return an EINVAL error code if either the pad or index are invalid. All media bus formats are enumerable by beginning at index zero and incrementing by one until EINVAL is returned.

Available media bus formats may depend on the current ‘try’ formats at other pads of the sub-device, as well as on the current active links. See ioctl VIDIOC_SUBDEV_G_FMT, VIDIOC_SUBDEV_S_FMT for more information about the try formats.

v4l2_subdev_mbus_code_enum

struct v4l2_subdev_mbus_code_enum

__u32	pad	Pad number as reported by the media controller API.
__u32	index	Number of the format in the enumeration, set by the application.
__u32	code	The media bus format code, as defined in Media Bus Formats.
__u32	which	Media bus format codes to be enumerated, from enum v4l2_subdev_format_whence.
__u32	reserved[8]	Reserved for future extensions. Applications and drivers must set the array to zero.

8.57.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 v4l2_subdev_mbus_code_enum pad references a non-existing pad, or the index field is out of bounds.