Merge tag 'tegra-for-4.8-i2c' of git://git.kernel.org/pub/scm/linux/kernel/git/tegra...
[cascardo/linux.git] / Documentation / media / uapi / dvb / video-fwrite.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _video_fwrite:
4
5 =================
6 dvb video write()
7 =================
8
9 Name
10 ----
11
12 dvb video write()
13
14 .. attention:: This ioctl is deprecated.
15
16 Synopsis
17 --------
18
19 .. c:function:: size_t write(int fd, const void *buf, size_t count)
20
21
22 Arguments
23 ---------
24
25 .. flat-table::
26     :header-rows:  0
27     :stub-columns: 0
28
29
30     -  .. row 1
31
32        -  int fd
33
34        -  File descriptor returned by a previous call to open().
35
36     -  .. row 2
37
38        -  void \*buf
39
40        -  Pointer to the buffer containing the PES data.
41
42     -  .. row 3
43
44        -  size_t count
45
46        -  Size of buf.
47
48
49 Description
50 -----------
51
52 This system call can only be used if VIDEO_SOURCE_MEMORY is selected
53 in the ioctl call VIDEO_SELECT_SOURCE. The data provided shall be in
54 PES format, unless the capability allows other formats. If O_NONBLOCK
55 is not specified the function will block until buffer space is
56 available. The amount of data to be transferred is implied by count.
57
58
59 Return Value
60 ------------
61
62 .. flat-table::
63     :header-rows:  0
64     :stub-columns: 0
65
66
67     -  .. row 1
68
69        -  ``EPERM``
70
71        -  Mode VIDEO_SOURCE_MEMORY not selected.
72
73     -  .. row 2
74
75        -  ``ENOMEM``
76
77        -  Attempted to write more data than the internal buffer can hold.
78
79     -  .. row 3
80
81        -  ``EBADF``
82
83        -  fd is not a valid open file descriptor.