16f52b16cSGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2b7be7557SAlec Leamas /* 3b7be7557SAlec Leamas * lirc.h - linux infrared remote control header file 4b7be7557SAlec Leamas */ 5b7be7557SAlec Leamas 6b7be7557SAlec Leamas #ifndef _LINUX_LIRC_H 7b7be7557SAlec Leamas #define _LINUX_LIRC_H 8b7be7557SAlec Leamas 9b7be7557SAlec Leamas #include <linux/types.h> 10b7be7557SAlec Leamas #include <linux/ioctl.h> 11b7be7557SAlec Leamas 12b7be7557SAlec Leamas #define PULSE_BIT 0x01000000 13b7be7557SAlec Leamas #define PULSE_MASK 0x00FFFFFF 14b7be7557SAlec Leamas 15b7be7557SAlec Leamas #define LIRC_MODE2_SPACE 0x00000000 16b7be7557SAlec Leamas #define LIRC_MODE2_PULSE 0x01000000 17b7be7557SAlec Leamas #define LIRC_MODE2_FREQUENCY 0x02000000 18b7be7557SAlec Leamas #define LIRC_MODE2_TIMEOUT 0x03000000 1968a99f6aSSean Young #define LIRC_MODE2_OVERFLOW 0x04000000 20b7be7557SAlec Leamas 21b7be7557SAlec Leamas #define LIRC_VALUE_MASK 0x00FFFFFF 22b7be7557SAlec Leamas #define LIRC_MODE2_MASK 0xFF000000 23b7be7557SAlec Leamas 24b7be7557SAlec Leamas #define LIRC_SPACE(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_SPACE) 25b7be7557SAlec Leamas #define LIRC_PULSE(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_PULSE) 26b7be7557SAlec Leamas #define LIRC_FREQUENCY(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_FREQUENCY) 27b7be7557SAlec Leamas #define LIRC_TIMEOUT(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_TIMEOUT) 2868a99f6aSSean Young #define LIRC_OVERFLOW(val) (((val) & LIRC_VALUE_MASK) | LIRC_MODE2_OVERFLOW) 29b7be7557SAlec Leamas 30b7be7557SAlec Leamas #define LIRC_VALUE(val) ((val)&LIRC_VALUE_MASK) 31b7be7557SAlec Leamas #define LIRC_MODE2(val) ((val)&LIRC_MODE2_MASK) 32b7be7557SAlec Leamas 33b7be7557SAlec Leamas #define LIRC_IS_SPACE(val) (LIRC_MODE2(val) == LIRC_MODE2_SPACE) 34b7be7557SAlec Leamas #define LIRC_IS_PULSE(val) (LIRC_MODE2(val) == LIRC_MODE2_PULSE) 35b7be7557SAlec Leamas #define LIRC_IS_FREQUENCY(val) (LIRC_MODE2(val) == LIRC_MODE2_FREQUENCY) 36b7be7557SAlec Leamas #define LIRC_IS_TIMEOUT(val) (LIRC_MODE2(val) == LIRC_MODE2_TIMEOUT) 3768a99f6aSSean Young #define LIRC_IS_OVERFLOW(val) (LIRC_MODE2(val) == LIRC_MODE2_OVERFLOW) 38b7be7557SAlec Leamas 39b7be7557SAlec Leamas /* used heavily by lirc userspace */ 40b7be7557SAlec Leamas #define lirc_t int 41b7be7557SAlec Leamas 42b7be7557SAlec Leamas /*** lirc compatible hardware features ***/ 43b7be7557SAlec Leamas 44b7be7557SAlec Leamas #define LIRC_MODE2SEND(x) (x) 45b7be7557SAlec Leamas #define LIRC_SEND2MODE(x) (x) 46b7be7557SAlec Leamas #define LIRC_MODE2REC(x) ((x) << 16) 47b7be7557SAlec Leamas #define LIRC_REC2MODE(x) ((x) >> 16) 48b7be7557SAlec Leamas 49b7be7557SAlec Leamas #define LIRC_MODE_RAW 0x00000001 50b7be7557SAlec Leamas #define LIRC_MODE_PULSE 0x00000002 51b7be7557SAlec Leamas #define LIRC_MODE_MODE2 0x00000004 529b619258SSean Young #define LIRC_MODE_SCANCODE 0x00000008 53b7be7557SAlec Leamas #define LIRC_MODE_LIRCCODE 0x00000010 54b7be7557SAlec Leamas 55b7be7557SAlec Leamas 56b7be7557SAlec Leamas #define LIRC_CAN_SEND_RAW LIRC_MODE2SEND(LIRC_MODE_RAW) 57b7be7557SAlec Leamas #define LIRC_CAN_SEND_PULSE LIRC_MODE2SEND(LIRC_MODE_PULSE) 58b7be7557SAlec Leamas #define LIRC_CAN_SEND_MODE2 LIRC_MODE2SEND(LIRC_MODE_MODE2) 59b7be7557SAlec Leamas #define LIRC_CAN_SEND_LIRCCODE LIRC_MODE2SEND(LIRC_MODE_LIRCCODE) 60b7be7557SAlec Leamas 61b7be7557SAlec Leamas #define LIRC_CAN_SEND_MASK 0x0000003f 62b7be7557SAlec Leamas 63b7be7557SAlec Leamas #define LIRC_CAN_SET_SEND_CARRIER 0x00000100 64b7be7557SAlec Leamas #define LIRC_CAN_SET_SEND_DUTY_CYCLE 0x00000200 65b7be7557SAlec Leamas #define LIRC_CAN_SET_TRANSMITTER_MASK 0x00000400 66b7be7557SAlec Leamas 67b7be7557SAlec Leamas #define LIRC_CAN_REC_RAW LIRC_MODE2REC(LIRC_MODE_RAW) 68b7be7557SAlec Leamas #define LIRC_CAN_REC_PULSE LIRC_MODE2REC(LIRC_MODE_PULSE) 69b7be7557SAlec Leamas #define LIRC_CAN_REC_MODE2 LIRC_MODE2REC(LIRC_MODE_MODE2) 709b619258SSean Young #define LIRC_CAN_REC_SCANCODE LIRC_MODE2REC(LIRC_MODE_SCANCODE) 71b7be7557SAlec Leamas #define LIRC_CAN_REC_LIRCCODE LIRC_MODE2REC(LIRC_MODE_LIRCCODE) 72b7be7557SAlec Leamas 73b7be7557SAlec Leamas #define LIRC_CAN_REC_MASK LIRC_MODE2REC(LIRC_CAN_SEND_MASK) 74b7be7557SAlec Leamas 75b7be7557SAlec Leamas #define LIRC_CAN_SET_REC_CARRIER (LIRC_CAN_SET_SEND_CARRIER << 16) 76b7be7557SAlec Leamas 77b7be7557SAlec Leamas #define LIRC_CAN_SET_REC_CARRIER_RANGE 0x80000000 78b7be7557SAlec Leamas #define LIRC_CAN_GET_REC_RESOLUTION 0x20000000 79b7be7557SAlec Leamas #define LIRC_CAN_SET_REC_TIMEOUT 0x10000000 80b7be7557SAlec Leamas 81b7be7557SAlec Leamas #define LIRC_CAN_MEASURE_CARRIER 0x02000000 82b7be7557SAlec Leamas #define LIRC_CAN_USE_WIDEBAND_RECEIVER 0x04000000 83b7be7557SAlec Leamas 84b7be7557SAlec Leamas #define LIRC_CAN_SEND(x) ((x)&LIRC_CAN_SEND_MASK) 85b7be7557SAlec Leamas #define LIRC_CAN_REC(x) ((x)&LIRC_CAN_REC_MASK) 86b7be7557SAlec Leamas 87*e5499dd7SSean Young /* 88*e5499dd7SSean Young * Unused features. These features were never implemented, in tree or 89*e5499dd7SSean Young * out of tree. These definitions are here so not to break the lircd build. 90*e5499dd7SSean Young */ 91*e5499dd7SSean Young #define LIRC_CAN_SET_REC_FILTER 0 92*e5499dd7SSean Young #define LIRC_CAN_NOTIFY_DECODE 0 93*e5499dd7SSean Young 94b7be7557SAlec Leamas /*** IOCTL commands for lirc driver ***/ 95b7be7557SAlec Leamas 96b7be7557SAlec Leamas #define LIRC_GET_FEATURES _IOR('i', 0x00000000, __u32) 97b7be7557SAlec Leamas 98b7be7557SAlec Leamas #define LIRC_GET_SEND_MODE _IOR('i', 0x00000001, __u32) 99b7be7557SAlec Leamas #define LIRC_GET_REC_MODE _IOR('i', 0x00000002, __u32) 100b7be7557SAlec Leamas #define LIRC_GET_REC_RESOLUTION _IOR('i', 0x00000007, __u32) 101b7be7557SAlec Leamas 102b7be7557SAlec Leamas #define LIRC_GET_MIN_TIMEOUT _IOR('i', 0x00000008, __u32) 103b7be7557SAlec Leamas #define LIRC_GET_MAX_TIMEOUT _IOR('i', 0x00000009, __u32) 104b7be7557SAlec Leamas 105b7be7557SAlec Leamas /* code length in bits, currently only for LIRC_MODE_LIRCCODE */ 106b7be7557SAlec Leamas #define LIRC_GET_LENGTH _IOR('i', 0x0000000f, __u32) 107b7be7557SAlec Leamas 108b7be7557SAlec Leamas #define LIRC_SET_SEND_MODE _IOW('i', 0x00000011, __u32) 109b7be7557SAlec Leamas #define LIRC_SET_REC_MODE _IOW('i', 0x00000012, __u32) 110b7be7557SAlec Leamas /* Note: these can reset the according pulse_width */ 111b7be7557SAlec Leamas #define LIRC_SET_SEND_CARRIER _IOW('i', 0x00000013, __u32) 112b7be7557SAlec Leamas #define LIRC_SET_REC_CARRIER _IOW('i', 0x00000014, __u32) 113b7be7557SAlec Leamas #define LIRC_SET_SEND_DUTY_CYCLE _IOW('i', 0x00000015, __u32) 114b7be7557SAlec Leamas #define LIRC_SET_TRANSMITTER_MASK _IOW('i', 0x00000017, __u32) 115b7be7557SAlec Leamas 116b7be7557SAlec Leamas /* 117b7be7557SAlec Leamas * when a timeout != 0 is set the driver will send a 118b7be7557SAlec Leamas * LIRC_MODE2_TIMEOUT data packet, otherwise LIRC_MODE2_TIMEOUT is 119b7be7557SAlec Leamas * never sent, timeout is disabled by default 120b7be7557SAlec Leamas */ 121b7be7557SAlec Leamas #define LIRC_SET_REC_TIMEOUT _IOW('i', 0x00000018, __u32) 122b7be7557SAlec Leamas 123b7be7557SAlec Leamas /* 1 enables, 0 disables timeout reports in MODE2 */ 124b7be7557SAlec Leamas #define LIRC_SET_REC_TIMEOUT_REPORTS _IOW('i', 0x00000019, __u32) 125b7be7557SAlec Leamas 126b7be7557SAlec Leamas /* 127b7be7557SAlec Leamas * if enabled from the next key press on the driver will send 128b7be7557SAlec Leamas * LIRC_MODE2_FREQUENCY packets 129b7be7557SAlec Leamas */ 130b7be7557SAlec Leamas #define LIRC_SET_MEASURE_CARRIER_MODE _IOW('i', 0x0000001d, __u32) 131b7be7557SAlec Leamas 132b7be7557SAlec Leamas /* 133d55f09abSMauro Carvalho Chehab * to set a range use LIRC_SET_REC_CARRIER_RANGE with the 134d55f09abSMauro Carvalho Chehab * lower bound first and later LIRC_SET_REC_CARRIER with the upper bound 135b7be7557SAlec Leamas */ 136b7be7557SAlec Leamas #define LIRC_SET_REC_CARRIER_RANGE _IOW('i', 0x0000001f, __u32) 137b7be7557SAlec Leamas 138b7be7557SAlec Leamas #define LIRC_SET_WIDEBAND_RECEIVER _IOW('i', 0x00000023, __u32) 139b7be7557SAlec Leamas 1409b619258SSean Young /* 14195d1544eSSean Young * Return the recording timeout, which is either set by 14295d1544eSSean Young * the ioctl LIRC_SET_REC_TIMEOUT or by the kernel after setting the protocols. 14395d1544eSSean Young */ 14495d1544eSSean Young #define LIRC_GET_REC_TIMEOUT _IOR('i', 0x00000024, __u32) 14595d1544eSSean Young 1464fe21decSMauro Carvalho Chehab /** 1479b619258SSean Young * struct lirc_scancode - decoded scancode with protocol for use with 1489b619258SSean Young * LIRC_MODE_SCANCODE 1499b619258SSean Young * 1509b619258SSean Young * @timestamp: Timestamp in nanoseconds using CLOCK_MONOTONIC when IR 1519b619258SSean Young * was decoded. 1529b619258SSean Young * @flags: should be 0 for transmit. When receiving scancodes, 1539b619258SSean Young * LIRC_SCANCODE_FLAG_TOGGLE or LIRC_SCANCODE_FLAG_REPEAT can be set 1549b619258SSean Young * depending on the protocol 1559b619258SSean Young * @rc_proto: see enum rc_proto 1569b619258SSean Young * @keycode: the translated keycode. Set to 0 for transmit. 1579b619258SSean Young * @scancode: the scancode received or to be sent 1589b619258SSean Young */ 1599b619258SSean Young struct lirc_scancode { 1609b619258SSean Young __u64 timestamp; 1619b619258SSean Young __u16 flags; 1629b619258SSean Young __u16 rc_proto; 1639b619258SSean Young __u32 keycode; 1649b619258SSean Young __u64 scancode; 1659b619258SSean Young }; 1669b619258SSean Young 1679b619258SSean Young /* Set if the toggle bit of rc-5 or rc-6 is enabled */ 1689b619258SSean Young #define LIRC_SCANCODE_FLAG_TOGGLE 1 1699b619258SSean Young /* Set if this is a nec or sanyo repeat */ 1709b619258SSean Young #define LIRC_SCANCODE_FLAG_REPEAT 2 1719b619258SSean Young 1729b619258SSean Young /** 1739b619258SSean Young * enum rc_proto - the Remote Controller protocol 1749b619258SSean Young * 1759b619258SSean Young * @RC_PROTO_UNKNOWN: Protocol not known 1769b619258SSean Young * @RC_PROTO_OTHER: Protocol known but proprietary 1779b619258SSean Young * @RC_PROTO_RC5: Philips RC5 protocol 1789b619258SSean Young * @RC_PROTO_RC5X_20: Philips RC5x 20 bit protocol 1799b619258SSean Young * @RC_PROTO_RC5_SZ: StreamZap variant of RC5 1809b619258SSean Young * @RC_PROTO_JVC: JVC protocol 1819b619258SSean Young * @RC_PROTO_SONY12: Sony 12 bit protocol 1829b619258SSean Young * @RC_PROTO_SONY15: Sony 15 bit protocol 1839b619258SSean Young * @RC_PROTO_SONY20: Sony 20 bit protocol 1849b619258SSean Young * @RC_PROTO_NEC: NEC protocol 1859b619258SSean Young * @RC_PROTO_NECX: Extended NEC protocol 1869b619258SSean Young * @RC_PROTO_NEC32: NEC 32 bit protocol 1879b619258SSean Young * @RC_PROTO_SANYO: Sanyo protocol 1889b619258SSean Young * @RC_PROTO_MCIR2_KBD: RC6-ish MCE keyboard 1899b619258SSean Young * @RC_PROTO_MCIR2_MSE: RC6-ish MCE mouse 1909b619258SSean Young * @RC_PROTO_RC6_0: Philips RC6-0-16 protocol 1919b619258SSean Young * @RC_PROTO_RC6_6A_20: Philips RC6-6A-20 protocol 1929b619258SSean Young * @RC_PROTO_RC6_6A_24: Philips RC6-6A-24 protocol 1939b619258SSean Young * @RC_PROTO_RC6_6A_32: Philips RC6-6A-32 protocol 1949b619258SSean Young * @RC_PROTO_RC6_MCE: MCE (Philips RC6-6A-32 subtype) protocol 1959b619258SSean Young * @RC_PROTO_SHARP: Sharp protocol 1969b619258SSean Young * @RC_PROTO_XMP: XMP protocol 1979b619258SSean Young * @RC_PROTO_CEC: CEC protocol 198447dcc0cSSean Young * @RC_PROTO_IMON: iMon Pad protocol 199721074b0SPatrick Lerda * @RC_PROTO_RCMM12: RC-MM protocol 12 bits 200721074b0SPatrick Lerda * @RC_PROTO_RCMM24: RC-MM protocol 24 bits 201721074b0SPatrick Lerda * @RC_PROTO_RCMM32: RC-MM protocol 32 bits 20217287692SMatthias Reichl * @RC_PROTO_XBOX_DVD: Xbox DVD Movie Playback Kit protocol 203cea357bcSSean Young * @RC_PROTO_MAX: Maximum value of enum rc_proto 2049b619258SSean Young */ 2059b619258SSean Young enum rc_proto { 2069b619258SSean Young RC_PROTO_UNKNOWN = 0, 2079b619258SSean Young RC_PROTO_OTHER = 1, 2089b619258SSean Young RC_PROTO_RC5 = 2, 2099b619258SSean Young RC_PROTO_RC5X_20 = 3, 2109b619258SSean Young RC_PROTO_RC5_SZ = 4, 2119b619258SSean Young RC_PROTO_JVC = 5, 2129b619258SSean Young RC_PROTO_SONY12 = 6, 2139b619258SSean Young RC_PROTO_SONY15 = 7, 2149b619258SSean Young RC_PROTO_SONY20 = 8, 2159b619258SSean Young RC_PROTO_NEC = 9, 2169b619258SSean Young RC_PROTO_NECX = 10, 2179b619258SSean Young RC_PROTO_NEC32 = 11, 2189b619258SSean Young RC_PROTO_SANYO = 12, 2199b619258SSean Young RC_PROTO_MCIR2_KBD = 13, 2209b619258SSean Young RC_PROTO_MCIR2_MSE = 14, 2219b619258SSean Young RC_PROTO_RC6_0 = 15, 2229b619258SSean Young RC_PROTO_RC6_6A_20 = 16, 2239b619258SSean Young RC_PROTO_RC6_6A_24 = 17, 2249b619258SSean Young RC_PROTO_RC6_6A_32 = 18, 2259b619258SSean Young RC_PROTO_RC6_MCE = 19, 2269b619258SSean Young RC_PROTO_SHARP = 20, 2279b619258SSean Young RC_PROTO_XMP = 21, 2289b619258SSean Young RC_PROTO_CEC = 22, 229447dcc0cSSean Young RC_PROTO_IMON = 23, 230721074b0SPatrick Lerda RC_PROTO_RCMM12 = 24, 231721074b0SPatrick Lerda RC_PROTO_RCMM24 = 25, 232721074b0SPatrick Lerda RC_PROTO_RCMM32 = 26, 23317287692SMatthias Reichl RC_PROTO_XBOX_DVD = 27, 23472e637feSDan Carpenter RC_PROTO_MAX = RC_PROTO_XBOX_DVD, 2359b619258SSean Young }; 2369b619258SSean Young 237b7be7557SAlec Leamas #endif 238