xref: /linux/Documentation/userspace-api/media/dvb/fe-get-info.rst (revision c01044cc819160323f3ca4acd44fca487c4432e6)
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
3.. _FE_GET_INFO:
4
5*****************
6ioctl FE_GET_INFO
7*****************
8
9Name
10====
11
12FE_GET_INFO - Query Digital TV frontend capabilities and returns information
13about the - front-end. This call only requires read-only access to the device.
14
15
16Synopsis
17========
18
19.. c:function:: int ioctl( int fd, FE_GET_INFO, struct dvb_frontend_info *argp )
20    :name: FE_GET_INFO
21
22
23Arguments
24=========
25
26``fd``
27    File descriptor returned by :ref:`open() <frontend_f_open>`.
28
29``argp``
30    pointer to struct :c:type:`dvb_frontend_info`
31
32
33Description
34===========
35
36All Digital TV frontend devices support the :ref:`FE_GET_INFO` ioctl. It is
37used to identify kernel devices compatible with this specification and to
38obtain information about driver and hardware capabilities. The ioctl
39takes a pointer to dvb_frontend_info which is filled by the driver.
40When the driver is not compatible with this specification the ioctl
41returns an error.
42
43
44frontend capabilities
45=====================
46
47Capabilities describe what a frontend can do. Some capabilities are
48supported only on some specific frontend types.
49
50The frontend capabilities are described at :c:type:`fe_caps`.
51
52
53Return Value
54============
55
56On success 0 is returned.
57
58On error -1 is returned, and the ``errno`` variable is set
59appropriately.
60
61Generic error codes are described at the
62:ref:`Generic Error Codes <gen-errors>` chapter.
63