Documentation/media/uapi/rc/lirc-get-rec-mode.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _lirc_get_rec_mode:
   4 .. _lirc_set_rec_mode:
   5
   6 **********************************************
   7 ioctls LIRC_GET_REC_MODE and LIRC_SET_REC_MODE
   8 **********************************************
   9
  10 Name
  11 ====
  12
  13 LIRC_GET_REC_MODE/LIRC_GET_REC_MODE - Get/set supported receive modes.
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, __u32 rx_modes)
  19
  20 Arguments
  21 =========
  22
  23 ``fd``
  24     File descriptor returned by open().
  25
  26 ``request``
  27     LIRC_GET_REC_MODE or LIRC_GET_REC_MODE
  28
  29 ``rx_modes``
  30     Bitmask with the supported transmit modes.
  31
  32 Description
  33 ===========
  34
  35 Get/set supported receive modes. Only :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`
  36 and :ref:`LIRC_MODE_LIRCCODE <lirc-mode-lirccode>` are supported for IR
  37 receive.
  38
  39
  40 Return Value
  41 ============
  42
  43 On success 0 is returned, on error -1 and the ``errno`` variable is set
  44 appropriately. The generic error codes are described at the
  45 :ref:`Generic Error Codes <gen-errors>` chapter.