Documentation/userspace-api/media/rc/lirc-get-send-mode.rst

   1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: RC
   3
   4 .. _lirc_get_send_mode:
   5 .. _lirc_set_send_mode:
   6
   7 ************************************************
   8 ioctls LIRC_GET_SEND_MODE and LIRC_SET_SEND_MODE
   9 ************************************************
  10
  11 Name
  12 ====
  13
  14 LIRC_GET_SEND_MODE/LIRC_SET_SEND_MODE - Get/set current transmit mode.
  15
  16 Synopsis
  17 ========
  18
  19 .. c:macro:: LIRC_GET_SEND_MODE
  20
  21 ``int ioctl(int fd, LIRC_GET_SEND_MODE, __u32 *mode)``
  22
  23 .. c:macro:: LIRC_SET_SEND_MODE
  24
  25 ``int ioctl(int fd, LIRC_SET_SEND_MODE, __u32 *mode)``
  26
  27 Arguments
  28 =========
  29
  30 ``fd``
  31     File descriptor returned by open().
  32
  33 ``mode``
  34     The mode used for transmitting.
  35
  36 Description
  37 ===========
  38
  39 Get/set current transmit mode.
  40
  41 Only :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>` and
  42 :ref:`LIRC_MODE_SCANCODE <lirc-mode-scancode>` are supported by for IR send,
  43 depending on the driver. Use :ref:`lirc_get_features` to find out which
  44 modes the driver supports.
  45
  46 Return Value
  47 ============
  48
  49 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  50
  51 .. flat-table::
  52     :header-rows:  0
  53     :stub-columns: 0
  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.