fe-get-info.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .. -*- coding: utf-8; mode: rst -*-
  2. .. _FE_GET_INFO:
  3. *****************
  4. ioctl FE_GET_INFO
  5. *****************
  6. Name
  7. ====
  8. FE_GET_INFO - Query Digital TV frontend capabilities and returns information
  9. about the - front-end. This call only requires read-only access to the device.
  10. Synopsis
  11. ========
  12. .. c:function:: int ioctl( int fd, FE_GET_INFO, struct dvb_frontend_info *argp )
  13. :name: FE_GET_INFO
  14. Arguments
  15. =========
  16. ``fd``
  17. File descriptor returned by :ref:`open() <frontend_f_open>`.
  18. ``argp``
  19. pointer to struct struct
  20. :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.