func-open.rst 2.0 KB
Newer Older
1 2 3 4 5 6
.. _func-open:

***********
V4L2 open()
***********

7
Name
8
====
9

10
v4l2-open - Open a V4L2 device
11

12 13

Synopsis
14 15 16 17 18 19 20
========

.. code-block:: c

    #include <fcntl.h>


21
.. c:function:: int open( const char *device_name, int flags )
22
    :name: v4l2-open
23

24
Arguments
25 26 27 28 29 30 31 32 33 34
=========

``device_name``
    Device to be opened.

``flags``
    Open flags. Access mode must be ``O_RDWR``. This is just a
    technicality, input devices still support only reading and output
    devices only writing.

35 36 37 38 39 40
    When the ``O_NONBLOCK`` flag is given, the :ref:`read() <func-read>`
    function and the :ref:`VIDIOC_DQBUF <VIDIOC_QBUF>` ioctl will
    return the ``EAGAIN`` error code when no data is available or no
    buffer is in the driver outgoing queue, otherwise these functions
    block until data becomes available. All V4L2 drivers exchanging data
    with applications must support the ``O_NONBLOCK`` flag.
41 42 43 44

    Other flags have no effect.


45
Description
46 47
===========

48
To open a V4L2 device applications call :ref:`open() <func-open>` with the
49 50
desired device name. This function has no side effects; all data format
parameters, current input or output, control values or other properties
51
remain unchanged. At the first :ref:`open() <func-open>` call after loading the
52 53 54 55
driver they will be reset to default values, drivers are never in an
undefined state.


56
Return Value
57 58
============

59
On success :ref:`open() <func-open>` returns the new file descriptor. On error
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
-1 is returned, and the ``errno`` variable is set appropriately.
Possible error codes are:

EACCES
    The caller has no permission to access the device.

EBUSY
    The driver does not support multiple opens and the device is already
    in use.

ENXIO
    No device corresponding to this device special file exists.

ENOMEM
    Not enough kernel memory was available to complete the request.

EMFILE
    The process already has the maximum number of files open.

ENFILE
    The limit on the total number of files open on the system has been
    reached.