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     :ref:`dvb_diseqc_slave_reply <dvb-diseqc-slave-reply>`
  31
  32
  33 Description
  34 ===========
  35
  36 Receives reply from a DiSEqC 2.0 command.
  37
  38 .. _dvb-diseqc-slave-reply:
  39
  40 struct dvb_diseqc_slave_reply
  41 -----------------------------
  42
  43 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  44
  45 .. flat-table:: struct dvb_diseqc_slave_reply
  46     :header-rows:  0
  47     :stub-columns: 0
  48     :widths:       1 1 2
  49
  50
  51     -  .. row 1
  52
  53        -  uint8_t
  54
  55        -  msg[4]
  56
  57        -  DiSEqC message (framing, data[3])
  58
  59     -  .. row 2
  60
  61        -  uint8_t
  62
  63        -  msg_len
  64
  65        -  Length of the DiSEqC message. Valid values are 0 to 4, where 0
  66           means no msg
  67
  68     -  .. row 3
  69
  70        -  int
  71
  72        -  timeout
  73
  74        -  Return from ioctl after timeout ms with errorcode when no message
  75           was received
  76
  77
  78 Return Value
  79 ============
  80
  81 On success 0 is returned, on error -1 and the ``errno`` variable is set
  82 appropriately. The generic error codes are described at the
  83 :ref:`Generic Error Codes <gen-errors>` chapter.