GNU Linux-libre 4.14.295-gnu1
[releases.git] / Documentation / media / uapi / v4l / func-write.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _func-write:
4
5 ************
6 V4L2 write()
7 ************
8
9 Name
10 ====
11
12 v4l2-write - Write to a V4L2 device
13
14
15 Synopsis
16 ========
17
18 .. code-block:: c
19
20     #include <unistd.h>
21
22
23 .. c:function:: ssize_t write( int fd, void *buf, size_t count )
24     :name: v4l2-write
25
26 Arguments
27 =========
28
29 ``fd``
30     File descriptor returned by :ref:`open() <func-open>`.
31
32 ``buf``
33      Buffer with data to be written
34
35 ``count``
36     Number of bytes at the buffer
37
38 Description
39 ===========
40
41 :ref:`write() <func-write>` writes up to ``count`` bytes to the device
42 referenced by the file descriptor ``fd`` from the buffer starting at
43 ``buf``. When the hardware outputs are not active yet, this function
44 enables them. When ``count`` is zero, :ref:`write() <func-write>` returns 0
45 without any other effect.
46
47 When the application does not provide more data in time, the previous
48 video frame, raw VBI image, sliced VPS or WSS data is displayed again.
49 Sliced Teletext or Closed Caption data is not repeated, the driver
50 inserts a blank line instead.
51
52
53 Return Value
54 ============
55
56 On success, the number of bytes written are returned. Zero indicates
57 nothing was written. On error, -1 is returned, and the ``errno``
58 variable is set appropriately. In this case the next write will start at
59 the beginning of a new frame. Possible error codes are:
60
61 EAGAIN
62     Non-blocking I/O has been selected using the
63     :ref:`O_NONBLOCK <func-open>` flag and no buffer space was
64     available to write the data immediately.
65
66 EBADF
67     ``fd`` is not a valid file descriptor or is not open for writing.
68
69 EBUSY
70     The driver does not support multiple write streams and the device is
71     already in use.
72
73 EFAULT
74     ``buf`` references an inaccessible memory area.
75
76 EINTR
77     The call was interrupted by a signal before any data was written.
78
79 EIO
80     I/O error. This indicates some hardware problem.
81
82 EINVAL
83     The :ref:`write() <func-write>` function is not supported by this driver,
84     not on this device, or generally not on this type of device.