Commit | Line | Data |
---|---|---|
82559ac0 MCC |
1 | .. Permission is granted to copy, distribute and/or modify this |
2 | .. document under the terms of the GNU Free Documentation License, | |
3 | .. Version 1.1 or any later version published by the Free Software | |
4 | .. Foundation, with no Invariant Sections, no Front-Cover Texts | |
5 | .. and no Back-Cover Texts. A copy of the license is included at | |
6 | .. Documentation/media/uapi/fdl-appendix.rst. | |
7 | .. | |
8 | .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections | |
9 | ||
5377d91f MH |
10 | .. _FE_GET_INFO: |
11 | ||
12 | ***************** | |
13 | ioctl FE_GET_INFO | |
14 | ***************** | |
15 | ||
15e7d615 | 16 | Name |
586027ce | 17 | ==== |
5377d91f | 18 | |
699f19e3 MCC |
19 | FE_GET_INFO - Query Digital TV frontend capabilities and returns information |
20 | about the - front-end. This call only requires read-only access to the device. | |
5377d91f | 21 | |
15e7d615 MCC |
22 | |
23 | Synopsis | |
5377d91f MH |
24 | ======== |
25 | ||
cf8076c3 MCC |
26 | .. c:function:: int ioctl( int fd, FE_GET_INFO, struct dvb_frontend_info *argp ) |
27 | :name: FE_GET_INFO | |
5377d91f | 28 | |
586027ce | 29 | |
15e7d615 | 30 | Arguments |
5377d91f MH |
31 | ========= |
32 | ||
33 | ``fd`` | |
34 | File descriptor returned by :ref:`open() <frontend_f_open>`. | |
35 | ||
5377d91f MH |
36 | ``argp`` |
37 | pointer to struct struct | |
e8be7e97 | 38 | :c:type:`dvb_frontend_info` |
5377d91f MH |
39 | |
40 | ||
15e7d615 | 41 | Description |
5377d91f MH |
42 | =========== |
43 | ||
883dfe8a MCC |
44 | All Digital TV frontend devices support the :ref:`FE_GET_INFO` ioctl. It is |
45 | used to identify kernel devices compatible with this specification and to | |
5377d91f MH |
46 | obtain information about driver and hardware capabilities. The ioctl |
47 | takes a pointer to dvb_frontend_info which is filled by the driver. | |
48 | When the driver is not compatible with this specification the ioctl | |
49 | returns an error. | |
50 | ||
5377d91f | 51 | |
5377d91f MH |
52 | frontend capabilities |
53 | ===================== | |
54 | ||
55 | Capabilities describe what a frontend can do. Some capabilities are | |
56 | supported only on some specific frontend types. | |
57 | ||
9d5e27cb | 58 | The frontend capabilities are described at :c:type:`fe_caps`. |
fc833980 | 59 | |
15e7d615 MCC |
60 | |
61 | Return Value | |
fc833980 MCC |
62 | ============ |
63 | ||
9a721b9b MCC |
64 | On success 0 is returned. |
65 | ||
66 | On error -1 is returned, and the ``errno`` variable is set | |
67 | appropriately. | |
68 | ||
69 | Generic error codes are described at the | |
fc833980 | 70 | :ref:`Generic Error Codes <gen-errors>` chapter. |