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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _FE_DISEQC_SEND_MASTER_CMD:
   4
   5 *******************************
   6 ioctl FE_DISEQC_SEND_MASTER_CMD
   7 *******************************
   8
   9 Name
  10 ====
  11
  12 FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, FE_DISEQC_SEND_MASTER_CMD, struct dvb_diseqc_master_cmd *argp )
  19     :name: FE_DISEQC_SEND_MASTER_CMD
  20
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :ref:`open() <frontend_f_open>`.
  27
  28 ``argp``
  29     pointer to struct
  30     :c:type:`dvb_diseqc_master_cmd`
  31
  32
  33 Description
  34 ===========
  35
  36 Sends a DiSEqC command to the antenna subsystem.
  37
  38
  39 .. c:type:: dvb_diseqc_master_cmd
  40
  41 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  42
  43 .. flat-table:: struct dvb_diseqc_master_cmd
  44     :header-rows:  0
  45     :stub-columns: 0
  46     :widths:       1 1 2
  47
  48
  49     -  .. row 1
  50
  51        -  uint8_t
  52
  53        -  msg[6]
  54
  55        -  DiSEqC message (framing, address, command, data[3])
  56
  57     -  .. row 2
  58
  59        -  uint8_t
  60
  61        -  msg_len
  62
  63        -  Length of the DiSEqC message. Valid values are 3 to 6
  64
  65 Return Value
  66 ============
  67
  68 On success 0 is returned, on error -1 and the ``errno`` variable is set
  69 appropriately. The generic error codes are described at the
  70 :ref:`Generic Error Codes <gen-errors>` chapter.
  71