Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst

   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
  10 .. _FE_DISEQC_SEND_MASTER_CMD:
  11
  12 *******************************
  13 ioctl FE_DISEQC_SEND_MASTER_CMD
  14 *******************************
  15
  16 Name
  17 ====
  18
  19 FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command
  20
  21
  22 Synopsis
  23 ========
  24
  25 .. c:function:: int ioctl( int fd, FE_DISEQC_SEND_MASTER_CMD, struct dvb_diseqc_master_cmd *argp )
  26     :name: FE_DISEQC_SEND_MASTER_CMD
  27
  28
  29 Arguments
  30 =========
  31
  32 ``fd``
  33     File descriptor returned by :ref:`open() <frontend_f_open>`.
  34
  35 ``argp``
  36     pointer to struct
  37     :c:type:`dvb_diseqc_master_cmd`
  38
  39
  40 Description
  41 ===========
  42
  43 Sends the DiSEqC command pointed by :c:type:`dvb_diseqc_master_cmd`
  44 to the antenna subsystem.
  45
  46 Return Value
  47 ============
  48
  49 On success 0 is returned.
  50
  51 On error -1 is returned, and the ``errno`` variable is set
  52 appropriately.
  53
  54 Generic error codes are described at the
  55 :ref:`Generic Error Codes <gen-errors>` chapter.
  56