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