xref: /openbmc/linux/include/uapi/linux/lirc.h (revision e5499dd7)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * lirc.h - linux infrared remote control header file
4  */
5 
6 #ifndef _LINUX_LIRC_H
7 #define _LINUX_LIRC_H
8 
9 #include <linux/types.h>
10 #include <linux/ioctl.h>
11 
12 #define PULSE_BIT       0x01000000
13 #define PULSE_MASK      0x00FFFFFF
14 
15 #define LIRC_MODE2_SPACE     0x00000000
16 #define LIRC_MODE2_PULSE     0x01000000
17 #define LIRC_MODE2_FREQUENCY 0x02000000
18 #define LIRC_MODE2_TIMEOUT   0x03000000
19 #define LIRC_MODE2_OVERFLOW  0x04000000
20 
21 #define LIRC_VALUE_MASK      0x00FFFFFF
22 #define LIRC_MODE2_MASK      0xFF000000
23 
24 #define LIRC_SPACE(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_SPACE)
25 #define LIRC_PULSE(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_PULSE)
26 #define LIRC_FREQUENCY(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_FREQUENCY)
27 #define LIRC_TIMEOUT(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_TIMEOUT)
28 #define LIRC_OVERFLOW(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_OVERFLOW)
29 
30 #define LIRC_VALUE(val) ((val)&LIRC_VALUE_MASK)
31 #define LIRC_MODE2(val) ((val)&LIRC_MODE2_MASK)
32 
33 #define LIRC_IS_SPACE(val) (LIRC_MODE2(val) == LIRC_MODE2_SPACE)
34 #define LIRC_IS_PULSE(val) (LIRC_MODE2(val) == LIRC_MODE2_PULSE)
35 #define LIRC_IS_FREQUENCY(val) (LIRC_MODE2(val) == LIRC_MODE2_FREQUENCY)
36 #define LIRC_IS_TIMEOUT(val) (LIRC_MODE2(val) == LIRC_MODE2_TIMEOUT)
37 #define LIRC_IS_OVERFLOW(val) (LIRC_MODE2(val) == LIRC_MODE2_OVERFLOW)
38 
39 /* used heavily by lirc userspace */
40 #define lirc_t int
41 
42 /*** lirc compatible hardware features ***/
43 
44 #define LIRC_MODE2SEND(x) (x)
45 #define LIRC_SEND2MODE(x) (x)
46 #define LIRC_MODE2REC(x) ((x) << 16)
47 #define LIRC_REC2MODE(x) ((x) >> 16)
48 
49 #define LIRC_MODE_RAW                  0x00000001
50 #define LIRC_MODE_PULSE                0x00000002
51 #define LIRC_MODE_MODE2                0x00000004
52 #define LIRC_MODE_SCANCODE             0x00000008
53 #define LIRC_MODE_LIRCCODE             0x00000010
54 
55 
56 #define LIRC_CAN_SEND_RAW              LIRC_MODE2SEND(LIRC_MODE_RAW)
57 #define LIRC_CAN_SEND_PULSE            LIRC_MODE2SEND(LIRC_MODE_PULSE)
58 #define LIRC_CAN_SEND_MODE2            LIRC_MODE2SEND(LIRC_MODE_MODE2)
59 #define LIRC_CAN_SEND_LIRCCODE         LIRC_MODE2SEND(LIRC_MODE_LIRCCODE)
60 
61 #define LIRC_CAN_SEND_MASK             0x0000003f
62 
63 #define LIRC_CAN_SET_SEND_CARRIER      0x00000100
64 #define LIRC_CAN_SET_SEND_DUTY_CYCLE   0x00000200
65 #define LIRC_CAN_SET_TRANSMITTER_MASK  0x00000400
66 
67 #define LIRC_CAN_REC_RAW               LIRC_MODE2REC(LIRC_MODE_RAW)
68 #define LIRC_CAN_REC_PULSE             LIRC_MODE2REC(LIRC_MODE_PULSE)
69 #define LIRC_CAN_REC_MODE2             LIRC_MODE2REC(LIRC_MODE_MODE2)
70 #define LIRC_CAN_REC_SCANCODE          LIRC_MODE2REC(LIRC_MODE_SCANCODE)
71 #define LIRC_CAN_REC_LIRCCODE          LIRC_MODE2REC(LIRC_MODE_LIRCCODE)
72 
73 #define LIRC_CAN_REC_MASK              LIRC_MODE2REC(LIRC_CAN_SEND_MASK)
74 
75 #define LIRC_CAN_SET_REC_CARRIER       (LIRC_CAN_SET_SEND_CARRIER << 16)
76 
77 #define LIRC_CAN_SET_REC_CARRIER_RANGE    0x80000000
78 #define LIRC_CAN_GET_REC_RESOLUTION       0x20000000
79 #define LIRC_CAN_SET_REC_TIMEOUT          0x10000000
80 
81 #define LIRC_CAN_MEASURE_CARRIER          0x02000000
82 #define LIRC_CAN_USE_WIDEBAND_RECEIVER    0x04000000
83 
84 #define LIRC_CAN_SEND(x) ((x)&LIRC_CAN_SEND_MASK)
85 #define LIRC_CAN_REC(x) ((x)&LIRC_CAN_REC_MASK)
86 
87 /*
88  * Unused features. These features were never implemented, in tree or
89  * out of tree. These definitions are here so not to break the lircd build.
90  */
91 #define LIRC_CAN_SET_REC_FILTER		0
92 #define LIRC_CAN_NOTIFY_DECODE		0
93 
94 /*** IOCTL commands for lirc driver ***/
95 
96 #define LIRC_GET_FEATURES              _IOR('i', 0x00000000, __u32)
97 
98 #define LIRC_GET_SEND_MODE             _IOR('i', 0x00000001, __u32)
99 #define LIRC_GET_REC_MODE              _IOR('i', 0x00000002, __u32)
100 #define LIRC_GET_REC_RESOLUTION        _IOR('i', 0x00000007, __u32)
101 
102 #define LIRC_GET_MIN_TIMEOUT           _IOR('i', 0x00000008, __u32)
103 #define LIRC_GET_MAX_TIMEOUT           _IOR('i', 0x00000009, __u32)
104 
105 /* code length in bits, currently only for LIRC_MODE_LIRCCODE */
106 #define LIRC_GET_LENGTH                _IOR('i', 0x0000000f, __u32)
107 
108 #define LIRC_SET_SEND_MODE             _IOW('i', 0x00000011, __u32)
109 #define LIRC_SET_REC_MODE              _IOW('i', 0x00000012, __u32)
110 /* Note: these can reset the according pulse_width */
111 #define LIRC_SET_SEND_CARRIER          _IOW('i', 0x00000013, __u32)
112 #define LIRC_SET_REC_CARRIER           _IOW('i', 0x00000014, __u32)
113 #define LIRC_SET_SEND_DUTY_CYCLE       _IOW('i', 0x00000015, __u32)
114 #define LIRC_SET_TRANSMITTER_MASK      _IOW('i', 0x00000017, __u32)
115 
116 /*
117  * when a timeout != 0 is set the driver will send a
118  * LIRC_MODE2_TIMEOUT data packet, otherwise LIRC_MODE2_TIMEOUT is
119  * never sent, timeout is disabled by default
120  */
121 #define LIRC_SET_REC_TIMEOUT           _IOW('i', 0x00000018, __u32)
122 
123 /* 1 enables, 0 disables timeout reports in MODE2 */
124 #define LIRC_SET_REC_TIMEOUT_REPORTS   _IOW('i', 0x00000019, __u32)
125 
126 /*
127  * if enabled from the next key press on the driver will send
128  * LIRC_MODE2_FREQUENCY packets
129  */
130 #define LIRC_SET_MEASURE_CARRIER_MODE	_IOW('i', 0x0000001d, __u32)
131 
132 /*
133  * to set a range use LIRC_SET_REC_CARRIER_RANGE with the
134  * lower bound first and later LIRC_SET_REC_CARRIER with the upper bound
135  */
136 #define LIRC_SET_REC_CARRIER_RANGE     _IOW('i', 0x0000001f, __u32)
137 
138 #define LIRC_SET_WIDEBAND_RECEIVER     _IOW('i', 0x00000023, __u32)
139 
140 /*
141  * Return the recording timeout, which is either set by
142  * the ioctl LIRC_SET_REC_TIMEOUT or by the kernel after setting the protocols.
143  */
144 #define LIRC_GET_REC_TIMEOUT	       _IOR('i', 0x00000024, __u32)
145 
146 /**
147  * struct lirc_scancode - decoded scancode with protocol for use with
148  *	LIRC_MODE_SCANCODE
149  *
150  * @timestamp: Timestamp in nanoseconds using CLOCK_MONOTONIC when IR
151  *	was decoded.
152  * @flags: should be 0 for transmit. When receiving scancodes,
153  *	LIRC_SCANCODE_FLAG_TOGGLE or LIRC_SCANCODE_FLAG_REPEAT can be set
154  *	depending on the protocol
155  * @rc_proto: see enum rc_proto
156  * @keycode: the translated keycode. Set to 0 for transmit.
157  * @scancode: the scancode received or to be sent
158  */
159 struct lirc_scancode {
160 	__u64	timestamp;
161 	__u16	flags;
162 	__u16	rc_proto;
163 	__u32	keycode;
164 	__u64	scancode;
165 };
166 
167 /* Set if the toggle bit of rc-5 or rc-6 is enabled */
168 #define LIRC_SCANCODE_FLAG_TOGGLE	1
169 /* Set if this is a nec or sanyo repeat */
170 #define LIRC_SCANCODE_FLAG_REPEAT	2
171 
172 /**
173  * enum rc_proto - the Remote Controller protocol
174  *
175  * @RC_PROTO_UNKNOWN: Protocol not known
176  * @RC_PROTO_OTHER: Protocol known but proprietary
177  * @RC_PROTO_RC5: Philips RC5 protocol
178  * @RC_PROTO_RC5X_20: Philips RC5x 20 bit protocol
179  * @RC_PROTO_RC5_SZ: StreamZap variant of RC5
180  * @RC_PROTO_JVC: JVC protocol
181  * @RC_PROTO_SONY12: Sony 12 bit protocol
182  * @RC_PROTO_SONY15: Sony 15 bit protocol
183  * @RC_PROTO_SONY20: Sony 20 bit protocol
184  * @RC_PROTO_NEC: NEC protocol
185  * @RC_PROTO_NECX: Extended NEC protocol
186  * @RC_PROTO_NEC32: NEC 32 bit protocol
187  * @RC_PROTO_SANYO: Sanyo protocol
188  * @RC_PROTO_MCIR2_KBD: RC6-ish MCE keyboard
189  * @RC_PROTO_MCIR2_MSE: RC6-ish MCE mouse
190  * @RC_PROTO_RC6_0: Philips RC6-0-16 protocol
191  * @RC_PROTO_RC6_6A_20: Philips RC6-6A-20 protocol
192  * @RC_PROTO_RC6_6A_24: Philips RC6-6A-24 protocol
193  * @RC_PROTO_RC6_6A_32: Philips RC6-6A-32 protocol
194  * @RC_PROTO_RC6_MCE: MCE (Philips RC6-6A-32 subtype) protocol
195  * @RC_PROTO_SHARP: Sharp protocol
196  * @RC_PROTO_XMP: XMP protocol
197  * @RC_PROTO_CEC: CEC protocol
198  * @RC_PROTO_IMON: iMon Pad protocol
199  * @RC_PROTO_RCMM12: RC-MM protocol 12 bits
200  * @RC_PROTO_RCMM24: RC-MM protocol 24 bits
201  * @RC_PROTO_RCMM32: RC-MM protocol 32 bits
202  * @RC_PROTO_XBOX_DVD: Xbox DVD Movie Playback Kit protocol
203  * @RC_PROTO_MAX: Maximum value of enum rc_proto
204  */
205 enum rc_proto {
206 	RC_PROTO_UNKNOWN	= 0,
207 	RC_PROTO_OTHER		= 1,
208 	RC_PROTO_RC5		= 2,
209 	RC_PROTO_RC5X_20	= 3,
210 	RC_PROTO_RC5_SZ		= 4,
211 	RC_PROTO_JVC		= 5,
212 	RC_PROTO_SONY12		= 6,
213 	RC_PROTO_SONY15		= 7,
214 	RC_PROTO_SONY20		= 8,
215 	RC_PROTO_NEC		= 9,
216 	RC_PROTO_NECX		= 10,
217 	RC_PROTO_NEC32		= 11,
218 	RC_PROTO_SANYO		= 12,
219 	RC_PROTO_MCIR2_KBD	= 13,
220 	RC_PROTO_MCIR2_MSE	= 14,
221 	RC_PROTO_RC6_0		= 15,
222 	RC_PROTO_RC6_6A_20	= 16,
223 	RC_PROTO_RC6_6A_24	= 17,
224 	RC_PROTO_RC6_6A_32	= 18,
225 	RC_PROTO_RC6_MCE	= 19,
226 	RC_PROTO_SHARP		= 20,
227 	RC_PROTO_XMP		= 21,
228 	RC_PROTO_CEC		= 22,
229 	RC_PROTO_IMON		= 23,
230 	RC_PROTO_RCMM12		= 24,
231 	RC_PROTO_RCMM24		= 25,
232 	RC_PROTO_RCMM32		= 26,
233 	RC_PROTO_XBOX_DVD	= 27,
234 	RC_PROTO_MAX		= RC_PROTO_XBOX_DVD,
235 };
236 
237 #endif
238