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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _lirc_get_send_mode:
  11 .. _lirc_set_send_mode:
  12
  13 ************************************************
  14 ioctls LIRC_GET_SEND_MODE and LIRC_SET_SEND_MODE
  15 ************************************************
  16
  17 Name
  18 ====
  19
  20 LIRC_GET_SEND_MODE/LIRC_SET_SEND_MODE - Get/set current transmit mode.
  21
  22 Synopsis
  23 ========
  24
  25 .. c:function:: int ioctl( int fd, LIRC_GET_SEND_MODE, __u32 *mode )
  26     :name: LIRC_GET_SEND_MODE
  27
  28 .. c:function:: int ioctl( int fd, LIRC_SET_SEND_MODE, __u32 *mode )
  29     :name: LIRC_SET_SEND_MODE
  30
  31 Arguments
  32 =========
  33
  34 ``fd``
  35     File descriptor returned by open().
  36
  37 ``mode``
  38     The mode used for transmitting.
  39
  40
  41 Description
  42 ===========
  43
  44 Get/set current transmit mode.
  45
  46 Only :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>` and
  47 :ref:`LIRC_MODE_SCANCODE <lirc-mode-scancode>` are supported by for IR send,
  48 depending on the driver. Use :ref:`lirc_get_features` to find out which
  49 modes the driver supports.
  50
  51 Return Value
  52 ============
  53
  54
  55 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  56
  57 .. flat-table::
  58     :header-rows:  0
  59     :stub-columns: 0
  60
  61
  62     -  .. row 1
  63
  64        -  ``ENODEV``
  65
  66        -  Device not available.
  67
  68     -  .. row 2
  69
  70        -  ``ENOTTY``
  71
  72        -  Device does not support transmitting.
  73
  74     -  .. row 3
  75
  76        -  ``EINVAL``
  77
  78        -  Invalid mode or invalid mode for this device.