Merge greybus driver tree into 4.8-rc6
[cascardo/linux.git] / Documentation / media / uapi / dvb / fe-get-frontend.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _FE_GET_FRONTEND:
4
5 ***************
6 FE_GET_FRONTEND
7 ***************
8
9 Name
10 ====
11
12 FE_GET_FRONTEND
13
14
15 Synopsis
16 ========
17
18 .. cpp:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
19
20
21 Arguments
22 =========
23
24 .. flat-table::
25     :header-rows:  0
26     :stub-columns: 0
27
28
29     -  .. row 1
30
31        -  int fd
32
33        -  File descriptor returned by a previous call to open().
34
35     -  .. row 2
36
37        -  int request
38
39        -  Equals :ref:`FE_SET_FRONTEND` for this
40           command.
41
42     -  .. row 3
43
44        -  struct dvb_frontend_parameters \*p
45
46        -  Points to parameters for tuning operation.
47
48
49 Description
50 ===========
51
52 This ioctl call queries the currently effective frontend parameters. For
53 this command, read-only access to the device is sufficient.
54
55
56 Return Value
57 ============
58
59 On success 0 is returned, on error -1 and the ``errno`` variable is set
60 appropriately. The generic error codes are described at the
61 :ref:`Generic Error Codes <gen-errors>` chapter.
62
63
64
65 .. flat-table::
66     :header-rows:  0
67     :stub-columns: 0
68
69
70     -  .. row 1
71
72        -  ``EINVAL``
73
74        -  Maximum supported symbol rate reached.