Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.9 / 60c2820d0f6d3497975b6488e2599f8f611d8b95 / . / Documentation / media / uapi / dvb / video-fopen.rst
blob: 9e5471557b831e38369b3fc1bb483d1c53222cb2 [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]1.. -*- coding: utf-8; mode: rst -*-
2
3.. _video_fopen:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]5================
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]6dvb video open()
7================
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]9Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]10----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]11
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]12dvb video open()
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]13
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]14
15Synopsis
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]16--------
17
Mauro Carvalho Chehab5929cb12016-07-05 15:22:59 -0300[diff] [blame]18.. cpp:function:: int open(const char *deviceName, int flags)
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]19
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]20
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]21Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]22---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]23
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - const char \*deviceName
32
33 - Name of specific video device.
34
35 - .. row 2
36
37 - int flags
38
39 - A bit-wise OR of the following flags:
40
41 - .. row 3
42
43 -
44 - O_RDONLY read-only access
45
46 - .. row 4
47
48 -
49 - O_RDWR read/write access
50
51 - .. row 5
52
53 -
54 - O_NONBLOCK open in non-blocking mode
55
56 - .. row 6
57
58 -
59 - (blocking mode is the default)
60
61
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]62Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -0300[diff] [blame]63-----------
64
65This system call opens a named video device (e.g.
66/dev/dvb/adapter0/video0) for subsequent use.
67
68When an open() call has succeeded, the device will be ready for use. The
69significance of blocking or non-blocking mode is described in the
70documentation for functions where there is a difference. It does not
71affect the semantics of the open() call itself. A device opened in
72blocking mode can later be put into non-blocking mode (and vice versa)
73using the F_SETFL command of the fcntl system call. This is a standard
74system call, documented in the Linux manual page for fcntl. Only one
75user can open the Video Device in O_RDWR mode. All other attempts to
76open the device in this mode will fail, and an error-code will be
77returned. If the Video Device is opened in O_RDONLY mode, the only
78ioctl call that can be used is VIDEO_GET_STATUS. All other call will
79return an error code.
80
81
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -0300[diff] [blame]82Return Value
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]83------------
84
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -0300[diff] [blame]85.. flat-table::
86 :header-rows: 0
87 :stub-columns: 0
88
89
90 - .. row 1
91
92 - ``ENODEV``
93
94 - Device driver not loaded/available.
95
96 - .. row 2
97
98 - ``EINTERNAL``
99
100 - Internal error.
101
102 - .. row 3
103
104 - ``EBUSY``
105
106 - Device or resource busy.
107
108 - .. row 4
109
110 - ``EINVAL``
111
112 - Invalid argument.