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