fe-get-info.rst 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
  2. .. c:namespace:: DTV.fe
  3. .. _FE_GET_INFO:
  4. *****************
  5. ioctl FE_GET_INFO
  6. *****************
  7. Name
  8. ====
  9. FE_GET_INFO - Query Digital TV frontend capabilities and returns information
  10. about the - front-end. This call only requires read-only access to the device.
  11. Synopsis
  12. ========
  13. .. c:macro:: FE_GET_INFO
  14. ``int ioctl(int fd, FE_GET_INFO, struct dvb_frontend_info *argp)``
  15. Arguments
  16. =========
  17. ``fd``
  18. File descriptor returned by :c:func:`open()`.
  19. ``argp``
  20. pointer to struct :c:type:`dvb_frontend_info`
  21. Description
  22. ===========
  23. All Digital TV frontend devices support the :ref:`FE_GET_INFO` ioctl. It is
  24. used to identify kernel devices compatible with this specification and to
  25. obtain information about driver and hardware capabilities. The ioctl
  26. takes a pointer to dvb_frontend_info which is filled by the driver.
  27. When the driver is not compatible with this specification the ioctl
  28. returns an error.
  29. frontend capabilities
  30. =====================
  31. Capabilities describe what a frontend can do. Some capabilities are
  32. supported only on some specific frontend types.
  33. The frontend capabilities are described at :c:type:`fe_caps`.
  34. Return Value
  35. ============
  36. On success 0 is returned.
  37. On error -1 is returned, and the ``errno`` variable is set
  38. appropriately.
  39. Generic error codes are described at the
  40. :ref:`Generic Error Codes <gen-errors>` chapter.