1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * lirc.h - linux infrared remote control header file
4  * last modified 2010/07/13 by Jarod Wilson
5  */
6 
7 #ifndef _LINUX_LIRC_H
8 #define _LINUX_LIRC_H
9 
10 #include <linux/types.h>
11 #include <linux/ioctl.h>
12 
13 #define PULSE_BIT       0x01000000
14 #define PULSE_MASK      0x00FFFFFF
15 
16 #define LIRC_MODE2_SPACE     0x00000000
17 #define LIRC_MODE2_PULSE     0x01000000
18 #define LIRC_MODE2_FREQUENCY 0x02000000
19 #define LIRC_MODE2_TIMEOUT   0x03000000
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 
29 #define LIRC_VALUE(val) ((val)&LIRC_VALUE_MASK)
30 #define LIRC_MODE2(val) ((val)&LIRC_MODE2_MASK)
31 
32 #define LIRC_IS_SPACE(val) (LIRC_MODE2(val) == LIRC_MODE2_SPACE)
33 #define LIRC_IS_PULSE(val) (LIRC_MODE2(val) == LIRC_MODE2_PULSE)
34 #define LIRC_IS_FREQUENCY(val) (LIRC_MODE2(val) == LIRC_MODE2_FREQUENCY)
35 #define LIRC_IS_TIMEOUT(val) (LIRC_MODE2(val) == LIRC_MODE2_TIMEOUT)
36 
37 /* used heavily by lirc userspace */
38 #define lirc_t int
39 
40 /*** lirc compatible hardware features ***/
41 
42 #define LIRC_MODE2SEND(x) (x)
43 #define LIRC_SEND2MODE(x) (x)
44 #define LIRC_MODE2REC(x) ((x) << 16)
45 #define LIRC_REC2MODE(x) ((x) >> 16)
46 
47 #define LIRC_MODE_RAW                  0x00000001
48 #define LIRC_MODE_PULSE                0x00000002
49 #define LIRC_MODE_MODE2                0x00000004
50 #define LIRC_MODE_LIRCCODE             0x00000010
51 
52 
53 #define LIRC_CAN_SEND_RAW              LIRC_MODE2SEND(LIRC_MODE_RAW)
54 #define LIRC_CAN_SEND_PULSE            LIRC_MODE2SEND(LIRC_MODE_PULSE)
55 #define LIRC_CAN_SEND_MODE2            LIRC_MODE2SEND(LIRC_MODE_MODE2)
56 #define LIRC_CAN_SEND_LIRCCODE         LIRC_MODE2SEND(LIRC_MODE_LIRCCODE)
57 
58 #define LIRC_CAN_SEND_MASK             0x0000003f
59 
60 #define LIRC_CAN_SET_SEND_CARRIER      0x00000100
61 #define LIRC_CAN_SET_SEND_DUTY_CYCLE   0x00000200
62 #define LIRC_CAN_SET_TRANSMITTER_MASK  0x00000400
63 
64 #define LIRC_CAN_REC_RAW               LIRC_MODE2REC(LIRC_MODE_RAW)
65 #define LIRC_CAN_REC_PULSE             LIRC_MODE2REC(LIRC_MODE_PULSE)
66 #define LIRC_CAN_REC_MODE2             LIRC_MODE2REC(LIRC_MODE_MODE2)
67 #define LIRC_CAN_REC_LIRCCODE          LIRC_MODE2REC(LIRC_MODE_LIRCCODE)
68 
69 #define LIRC_CAN_REC_MASK              LIRC_MODE2REC(LIRC_CAN_SEND_MASK)
70 
71 #define LIRC_CAN_SET_REC_CARRIER       (LIRC_CAN_SET_SEND_CARRIER << 16)
72 #define LIRC_CAN_SET_REC_DUTY_CYCLE    (LIRC_CAN_SET_SEND_DUTY_CYCLE << 16)
73 
74 #define LIRC_CAN_SET_REC_DUTY_CYCLE_RANGE 0x40000000
75 #define LIRC_CAN_SET_REC_CARRIER_RANGE    0x80000000
76 #define LIRC_CAN_GET_REC_RESOLUTION       0x20000000
77 #define LIRC_CAN_SET_REC_TIMEOUT          0x10000000
78 #define LIRC_CAN_SET_REC_FILTER           0x08000000
79 
80 #define LIRC_CAN_MEASURE_CARRIER          0x02000000
81 #define LIRC_CAN_USE_WIDEBAND_RECEIVER    0x04000000
82 
83 #define LIRC_CAN_SEND(x) ((x)&LIRC_CAN_SEND_MASK)
84 #define LIRC_CAN_REC(x) ((x)&LIRC_CAN_REC_MASK)
85 
86 #define LIRC_CAN_NOTIFY_DECODE            0x01000000
87 
88 /*** IOCTL commands for lirc driver ***/
89 
90 #define LIRC_GET_FEATURES              _IOR('i', 0x00000000, __u32)
91 
92 #define LIRC_GET_SEND_MODE             _IOR('i', 0x00000001, __u32)
93 #define LIRC_GET_REC_MODE              _IOR('i', 0x00000002, __u32)
94 #define LIRC_GET_REC_RESOLUTION        _IOR('i', 0x00000007, __u32)
95 
96 #define LIRC_GET_MIN_TIMEOUT           _IOR('i', 0x00000008, __u32)
97 #define LIRC_GET_MAX_TIMEOUT           _IOR('i', 0x00000009, __u32)
98 
99 /* code length in bits, currently only for LIRC_MODE_LIRCCODE */
100 #define LIRC_GET_LENGTH                _IOR('i', 0x0000000f, __u32)
101 
102 #define LIRC_SET_SEND_MODE             _IOW('i', 0x00000011, __u32)
103 #define LIRC_SET_REC_MODE              _IOW('i', 0x00000012, __u32)
104 /* Note: these can reset the according pulse_width */
105 #define LIRC_SET_SEND_CARRIER          _IOW('i', 0x00000013, __u32)
106 #define LIRC_SET_REC_CARRIER           _IOW('i', 0x00000014, __u32)
107 #define LIRC_SET_SEND_DUTY_CYCLE       _IOW('i', 0x00000015, __u32)
108 #define LIRC_SET_TRANSMITTER_MASK      _IOW('i', 0x00000017, __u32)
109 
110 /*
111  * when a timeout != 0 is set the driver will send a
112  * LIRC_MODE2_TIMEOUT data packet, otherwise LIRC_MODE2_TIMEOUT is
113  * never sent, timeout is disabled by default
114  */
115 #define LIRC_SET_REC_TIMEOUT           _IOW('i', 0x00000018, __u32)
116 
117 /* 1 enables, 0 disables timeout reports in MODE2 */
118 #define LIRC_SET_REC_TIMEOUT_REPORTS   _IOW('i', 0x00000019, __u32)
119 
120 /*
121  * if enabled from the next key press on the driver will send
122  * LIRC_MODE2_FREQUENCY packets
123  */
124 #define LIRC_SET_MEASURE_CARRIER_MODE	_IOW('i', 0x0000001d, __u32)
125 
126 /*
127  * to set a range use LIRC_SET_REC_CARRIER_RANGE with the
128  * lower bound first and later LIRC_SET_REC_CARRIER with the upper bound
129  */
130 #define LIRC_SET_REC_CARRIER_RANGE     _IOW('i', 0x0000001f, __u32)
131 
132 #define LIRC_SET_WIDEBAND_RECEIVER     _IOW('i', 0x00000023, __u32)
133 
134 #endif
135