Merge branch 'pm-sleep'
[sfrench/cifs-2.6.git] / 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 supported transmit mode.
14
15 Synopsis
16 ========
17
18 .. cpp:function:: int ioctl( int fd, int request, __u32 *tx_modes )
19
20 Arguments
21 =========
22
23 ``fd``
24     File descriptor returned by open().
25
26 ``request``
27     LIRC_GET_SEND_MODE
28
29 ``tx_modes``
30     Bitmask with the supported transmit modes.
31
32
33 Description
34 ===========
35
36 Get/set supported transmit mode.
37
38 Only :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>` is supported by for IR send.
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.