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_SET_REC_MODE - Get/set supported receive modes.
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, LIRC_GET_REC_MODE, __u32 rx_modes)
  19         :name: LIRC_GET_REC_MODE
  20
  21 .. c:function:: int ioctl( int fd, LIRC_SET_REC_MODE, __u32 rx_modes)
  22         :name: LIRC_SET_REC_MODE
  23
  24 Arguments
  25 =========
  26
  27 ``fd``
  28     File descriptor returned by open().
  29
  30 ``rx_modes``
  31     Bitmask with the supported transmit modes.
  32
  33 Description
  34 ===========
  35
  36 Get/set supported receive modes. Only :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`
  37 and :ref:`LIRC_MODE_LIRCCODE <lirc-mode-lirccode>` are supported for IR
  38 receive.
  39
  40
  41 Return Value
  42 ============
  43
  44 On success 0 is returned, on error -1 and the ``errno`` variable is set
  45 appropriately. The generic error codes are described at the
  46 :ref:`Generic Error Codes <gen-errors>` chapter.