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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _lirc_get_send_mode:
   4 .. _lirc_set_send_mode:
   5
   6 ************************************************
   7 ioctls LIRC_GET_SEND_MODE and LIRC_SET_SEND_MODE
   8 ************************************************
   9
  10 Name
  11 ====
  12
  13 LIRC_GET_SEND_MODE/LIRC_SET_SEND_MODE - Get/set current transmit mode.
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, LIRC_GET_SEND_MODE, __u32 *mode )
  19     :name: LIRC_GET_SEND_MODE
  20
  21 .. c:function:: int ioctl( int fd, LIRC_SET_SEND_MODE, __u32 *mode )
  22     :name: LIRC_SET_SEND_MODE
  23
  24 Arguments
  25 =========
  26
  27 ``fd``
  28     File descriptor returned by open().
  29
  30 ``mode``
  31     The mode used for transmitting.
  32
  33
  34 Description
  35 ===========
  36
  37 Get/set current transmit mode.
  38
  39 Only :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>` and
  40 :ref:`LIRC_MODE_SCANCODE <lirc-mode-scancode>` are supported by for IR send,
  41 depending on the driver. Use :ref:`lirc_get_features` to find out which
  42 modes the driver supports.
  43
  44 Return Value
  45 ============
  46
  47
  48 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  49
  50 .. flat-table::
  51     :header-rows:  0
  52     :stub-columns: 0
  53
  54
  55     -  .. row 1
  56
  57        -  ``ENODEV``
  58
  59        -  Device not available.
  60
  61     -  .. row 2
  62
  63        -  ``ENOTTY``
  64
  65        -  Device does not support transmitting.
  66
  67     -  .. row 3
  68
  69        -  ``EINVAL``
  70
  71        -  Invalid mode or invalid mode for this device.