blob: 5d2df808df18e01838f16b068cd18527b2d07a95 [file] [log] [blame]
Markus Heiser5377d912016-06-30 15:18:56 +02001.. -*- coding: utf-8; mode: rst -*-
2
3.. _FE_GET_FRONTEND:
4
5***************
6FE_GET_FRONTEND
7***************
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -03009Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030010====
Markus Heiser5377d912016-06-30 15:18:56 +020011
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030012FE_GET_FRONTEND
Markus Heiser5377d912016-06-30 15:18:56 +020013
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030014
15Synopsis
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030016========
Markus Heiser5377d912016-06-30 15:18:56 +020017
Mauro Carvalho Chehab5929cb12016-07-05 15:22:59 -030018.. cpp:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
Markus Heiser5377d912016-06-30 15:18:56 +020019
Markus Heiser5377d912016-06-30 15:18:56 +020020
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030021Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030022=========
Markus Heiser5377d912016-06-30 15:18:56 +020023
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
Mauro Carvalho Chehab73470812016-07-01 13:58:44 -030039 - Equals :ref:`FE_SET_FRONTEND` for this
Mauro Carvalho Chehab0579e6e2016-07-04 16:25:48 -030040 command.
Markus Heiser5377d912016-06-30 15:18:56 +020041
42 - .. row 3
43
Mauro Carvalho Chehabd0904842016-07-04 12:37:18 -030044 - struct dvb_frontend_parameters \*p
Markus Heiser5377d912016-06-30 15:18:56 +020045
46 - Points to parameters for tuning operation.
47
48
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030049Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030050===========
51
52This ioctl call queries the currently effective frontend parameters. For
53this command, read-only access to the device is sufficient.
54
55
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030056Return Value
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030057============
Markus Heiser5377d912016-06-30 15:18:56 +020058
59On success 0 is returned, on error -1 and the ``errno`` variable is set
60appropriately. 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
Mauro Carvalho Chehabcdb4af02016-07-03 11:53:09 -030072 - ``EINVAL``
Markus Heiser5377d912016-06-30 15:18:56 +020073
74 - Maximum supported symbol rate reached.