fe-set-frontend.rst 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
  2. .. c:namespace:: DTV.fe
  3. .. _FE_SET_FRONTEND:
  4. ***************
  5. FE_SET_FRONTEND
  6. ***************
  7. .. attention:: This ioctl is deprecated.
  8. Name
  9. ====
  10. FE_SET_FRONTEND
  11. Synopsis
  12. ========
  13. .. c:macro:: FE_SET_FRONTEND
  14. ``int ioctl(int fd, FE_SET_FRONTEND, struct dvb_frontend_parameters *p)``
  15. Arguments
  16. =========
  17. ``fd``
  18. File descriptor returned by :c:func:`open()`.
  19. ``p``
  20. Points to parameters for tuning operation.
  21. Description
  22. ===========
  23. This ioctl call starts a tuning operation using specified parameters.
  24. The result of this call will be successful if the parameters were valid
  25. and the tuning could be initiated. The result of the tuning operation in
  26. itself, however, will arrive asynchronously as an event (see
  27. documentation for :ref:`FE_GET_EVENT` and
  28. FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
  29. operation is initiated before the previous one was completed, the
  30. previous operation will be aborted in favor of the new one. This command
  31. requires read/write access to the device.
  32. Return Value
  33. ============
  34. On success 0 is returned.
  35. On error -1 is returned, and the ``errno`` variable is set
  36. appropriately.
  37. .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  38. .. flat-table::
  39. :header-rows: 0
  40. :stub-columns: 0
  41. :widths: 1 16
  42. - .. row 1
  43. - ``EINVAL``
  44. - Maximum supported symbol rate reached.
  45. Generic error codes are described at the
  46. :ref:`Generic Error Codes <gen-errors>` chapter.