mirror of
https://mirrors.bfsu.edu.cn/git/linux.git
synced 2024-12-28 13:34:38 +08:00
b6b6e67824
Change multi-line note tags to be more symetric, e. g. not starting the text together witht the tag. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
71 lines
1.6 KiB
ReStructuredText
71 lines
1.6 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _cec-func-ioctl:
|
|
|
|
***********
|
|
cec ioctl()
|
|
***********
|
|
|
|
Name
|
|
====
|
|
|
|
cec-ioctl - Control a cec device
|
|
|
|
Synopsis
|
|
========
|
|
|
|
.. code-block:: c
|
|
|
|
#include <sys/ioctl.h>
|
|
|
|
|
|
.. cpp:function:: int ioctl( int fd, int request, void *argp )
|
|
|
|
Arguments
|
|
=========
|
|
|
|
``fd``
|
|
File descriptor returned by :ref:`open() <func-open>`.
|
|
|
|
``request``
|
|
CEC ioctl request code as defined in the cec.h header file, for
|
|
example :ref:`CEC_ADAP_G_CAPS`.
|
|
|
|
``argp``
|
|
Pointer to a request-specific structure.
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
.. note::
|
|
|
|
This documents the proposed CEC API. This API is not yet finalized
|
|
and is currently only available as a staging kernel module.
|
|
|
|
The :c:func:`ioctl()` function manipulates cec device parameters. The
|
|
argument ``fd`` must be an open file descriptor.
|
|
|
|
The ioctl ``request`` code specifies the cec 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 cec ioctl requests and
|
|
their parameters are located in the cec.h header file. All cec ioctl
|
|
requests, their respective function and parameters are specified in
|
|
:ref:`cec-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.
|