Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _FE_DISEQC_RECV_SLAVE_REPLY:
   4
   5 ********************************
   6 ioctl FE_DISEQC_RECV_SLAVE_REPLY
   7 ********************************
   8
   9 Name
  10 ====
  11
  12 FE_DISEQC_RECV_SLAVE_REPLY - Receives reply from a DiSEqC 2.0 command
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, FE_DISEQC_RECV_SLAVE_REPLY, struct dvb_diseqc_slave_reply *argp )
  19     :name: FE_DISEQC_RECV_SLAVE_REPLY
  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_slave_reply`
  31
  32
  33 Description
  34 ===========
  35
  36 Receives reply from a DiSEqC 2.0 command.
  37
  38 .. c:type:: dvb_diseqc_slave_reply
  39
  40 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  41
  42 .. flat-table:: struct dvb_diseqc_slave_reply
  43     :header-rows:  0
  44     :stub-columns: 0
  45     :widths:       1 1 2
  46
  47
  48     -  .. row 1
  49
  50        -  uint8_t
  51
  52        -  msg[4]
  53
  54        -  DiSEqC message (framing, data[3])
  55
  56     -  .. row 2
  57
  58        -  uint8_t
  59
  60        -  msg_len
  61
  62        -  Length of the DiSEqC message. Valid values are 0 to 4, where 0
  63           means no msg
  64
  65     -  .. row 3
  66
  67        -  int
  68
  69        -  timeout
  70
  71        -  Return from ioctl after timeout ms with errorcode when no message
  72           was received
  73
  74
  75 Return Value
  76 ============
  77
  78 On success 0 is returned, on error -1 and the ``errno`` variable is set
  79 appropriately. The generic error codes are described at the
  80 :ref:`Generic Error Codes <gen-errors>` chapter.