media-func-ioctl.rst 1.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
.. -*- coding: utf-8; mode: rst -*-

.. _media-func-ioctl:

*************
media ioctl()
*************

*man media-ioctl(2)*

Control a media device


Synopsis
========

.. code-block:: c

    #include <sys/ioctl.h>


22
.. cpp:function:: int ioctl( int fd, int request, void *argp )
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

Arguments
=========

``fd``
    File descriptor returned by :ref:`open() <func-open>`.

``request``
    Media ioctl request code as defined in the media.h header file, for
    example MEDIA_IOC_SETUP_LINK.

``argp``
    Pointer to a request-specific structure.


Description
===========

41
The :ref:`ioctl() <func-ioctl>` function manipulates media device parameters.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
The argument ``fd`` must be an open file descriptor.

The ioctl ``request`` code specifies the media function to be called. It
has encoded in it whether the argument is an input, output or read/write
parameter, and the size of the argument ``argp`` in bytes.

Macros and structures definitions specifying media ioctl requests and
their parameters are located in the media.h header file. All media ioctl
requests, their respective function and parameters are specified in
:ref:`media-user-func`.


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
:ref:`Generic Error Codes <gen-errors>` chapter.

Request-specific error codes are listed in the individual requests
descriptions.

When an ioctl that takes an output or read/write parameter fails, the
parameter remains unmodified.