include/media/lirc.h

   1 /*
   2  * lirc.h - linux infrared remote control header file
   3  * last modified 2010/06/03 by Jarod Wilson
   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
  20 #define LIRC_VALUE_MASK      0x00FFFFFF
  21 #define LIRC_MODE2_MASK      0xFF000000
  22
  23 #define LIRC_SPACE(val) (((val)&LIRC_VALUE_MASK) | LIRC_MODE2_SPACE)
  24 #define LIRC_PULSE(val) (((val)&LIRC_VALUE_MASK) | LIRC_MODE2_PULSE)
  25 #define LIRC_FREQUENCY(val) (((val)&LIRC_VALUE_MASK) | LIRC_MODE2_FREQUENCY)
  26 #define LIRC_TIMEOUT(val) (((val)&LIRC_VALUE_MASK) | LIRC_MODE2_TIMEOUT)
  27
  28 #define LIRC_VALUE(val) ((val)&LIRC_VALUE_MASK)
  29 #define LIRC_MODE2(val) ((val)&LIRC_MODE2_MASK)
  30
  31 #define LIRC_IS_SPACE(val) (LIRC_MODE2(val) == LIRC_MODE2_SPACE)
  32 #define LIRC_IS_PULSE(val) (LIRC_MODE2(val) == LIRC_MODE2_PULSE)
  33 #define LIRC_IS_FREQUENCY(val) (LIRC_MODE2(val) == LIRC_MODE2_FREQUENCY)
  34 #define LIRC_IS_TIMEOUT(val) (LIRC_MODE2(val) == LIRC_MODE2_TIMEOUT)
  35
  36 /*** lirc compatible hardware features ***/
  37
  38 #define LIRC_MODE2SEND(x) (x)
  39 #define LIRC_SEND2MODE(x) (x)
  40 #define LIRC_MODE2REC(x) ((x) << 16)
  41 #define LIRC_REC2MODE(x) ((x) >> 16)
  42
  43 #define LIRC_MODE_RAW                  0x00000001
  44 #define LIRC_MODE_PULSE                0x00000002
  45 #define LIRC_MODE_MODE2                0x00000004
  46 #define LIRC_MODE_LIRCCODE             0x00000010
  47
  48
  49 #define LIRC_CAN_SEND_RAW              LIRC_MODE2SEND(LIRC_MODE_RAW)
  50 #define LIRC_CAN_SEND_PULSE            LIRC_MODE2SEND(LIRC_MODE_PULSE)
  51 #define LIRC_CAN_SEND_MODE2            LIRC_MODE2SEND(LIRC_MODE_MODE2)
  52 #define LIRC_CAN_SEND_LIRCCODE         LIRC_MODE2SEND(LIRC_MODE_LIRCCODE)
  53
  54 #define LIRC_CAN_SEND_MASK             0x0000003f
  55
  56 #define LIRC_CAN_SET_SEND_CARRIER      0x00000100
  57 #define LIRC_CAN_SET_SEND_DUTY_CYCLE   0x00000200
  58 #define LIRC_CAN_SET_TRANSMITTER_MASK  0x00000400
  59
  60 #define LIRC_CAN_REC_RAW               LIRC_MODE2REC(LIRC_MODE_RAW)
  61 #define LIRC_CAN_REC_PULSE             LIRC_MODE2REC(LIRC_MODE_PULSE)
  62 #define LIRC_CAN_REC_MODE2             LIRC_MODE2REC(LIRC_MODE_MODE2)
  63 #define LIRC_CAN_REC_LIRCCODE          LIRC_MODE2REC(LIRC_MODE_LIRCCODE)
  64
  65 #define LIRC_CAN_REC_MASK              LIRC_MODE2REC(LIRC_CAN_SEND_MASK)
  66
  67 #define LIRC_CAN_SET_REC_CARRIER       (LIRC_CAN_SET_SEND_CARRIER << 16)
  68 #define LIRC_CAN_SET_REC_DUTY_CYCLE    (LIRC_CAN_SET_SEND_DUTY_CYCLE << 16)
  69
  70 #define LIRC_CAN_SET_REC_DUTY_CYCLE_RANGE 0x40000000
  71 #define LIRC_CAN_SET_REC_CARRIER_RANGE    0x80000000
  72 #define LIRC_CAN_GET_REC_RESOLUTION       0x20000000
  73 #define LIRC_CAN_SET_REC_TIMEOUT          0x10000000
  74 #define LIRC_CAN_SET_REC_FILTER           0x08000000
  75
  76 #define LIRC_CAN_MEASURE_CARRIER          0x02000000
  77
  78 #define LIRC_CAN_SEND(x) ((x)&LIRC_CAN_SEND_MASK)
  79 #define LIRC_CAN_REC(x) ((x)&LIRC_CAN_REC_MASK)
  80
  81 #define LIRC_CAN_NOTIFY_DECODE            0x01000000
  82
  83 /*** IOCTL commands for lirc driver ***/
  84
  85 #define LIRC_GET_FEATURES              _IOR('i', 0x00000000, __u32)
  86
  87 #define LIRC_GET_SEND_MODE             _IOR('i', 0x00000001, __u32)
  88 #define LIRC_GET_REC_MODE              _IOR('i', 0x00000002, __u32)
  89 #define LIRC_GET_SEND_CARRIER          _IOR('i', 0x00000003, __u32)
  90 #define LIRC_GET_REC_CARRIER           _IOR('i', 0x00000004, __u32)
  91 #define LIRC_GET_SEND_DUTY_CYCLE       _IOR('i', 0x00000005, __u32)
  92 #define LIRC_GET_REC_DUTY_CYCLE        _IOR('i', 0x00000006, __u32)
  93 #define LIRC_GET_REC_RESOLUTION        _IOR('i', 0x00000007, __u32)
  94
  95 #define LIRC_GET_MIN_TIMEOUT           _IOR('i', 0x00000008, __u32)
  96 #define LIRC_GET_MAX_TIMEOUT           _IOR('i', 0x00000009, __u32)
  97
  98 #if 0   /* these ioctls are not used at the moment */
  99 #define LIRC_GET_MIN_FILTER_PULSE      _IOR('i', 0x0000000a, __u32)
 100 #define LIRC_GET_MAX_FILTER_PULSE      _IOR('i', 0x0000000b, __u32)
 101 #define LIRC_GET_MIN_FILTER_SPACE      _IOR('i', 0x0000000c, __u32)
 102 #define LIRC_GET_MAX_FILTER_SPACE      _IOR('i', 0x0000000d, __u32)
 103 #endif
 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_REC_DUTY_CYCLE        _IOW('i', 0x00000016, __u32)
 115 #define LIRC_SET_TRANSMITTER_MASK      _IOW('i', 0x00000017, __u32)
 116
 117 /*
 118  * when a timeout != 0 is set the driver will send a
 119  * LIRC_MODE2_TIMEOUT data packet, otherwise LIRC_MODE2_TIMEOUT is
 120  * never sent, timeout is disabled by default
 121  */
 122 #define LIRC_SET_REC_TIMEOUT           _IOW('i', 0x00000018, __u32)
 123
 124 #if 0   /* these ioctls are not used at the moment */
 125 /*
 126  * pulses shorter than this are filtered out by hardware (software
 127  * emulation in lirc_dev?)
 128  */
 129 #define LIRC_SET_REC_FILTER_PULSE      _IOW('i', 0x00000019, __u32)
 130 /*
 131  * spaces shorter than this are filtered out by hardware (software
 132  * emulation in lirc_dev?)
 133  */
 134 #define LIRC_SET_REC_FILTER_SPACE      _IOW('i', 0x0000001a, __u32)
 135 /*
 136  * if filter cannot be set independantly for pulse/space, this should
 137  * be used
 138  */
 139 #define LIRC_SET_REC_FILTER            _IOW('i', 0x0000001b, __u32)
 140 #endif
 141
 142 /*
 143  * to set a range use
 144  * LIRC_SET_REC_DUTY_CYCLE_RANGE/LIRC_SET_REC_CARRIER_RANGE with the
 145  * lower bound first and later
 146  * LIRC_SET_REC_DUTY_CYCLE/LIRC_SET_REC_CARRIER with the upper bound
 147  */
 148
 149 #define LIRC_SET_REC_DUTY_CYCLE_RANGE  _IOW('i', 0x0000001e, __u32)
 150 #define LIRC_SET_REC_CARRIER_RANGE     _IOW('i', 0x0000001f, __u32)
 151
 152 #define LIRC_NOTIFY_DECODE             _IO('i', 0x00000020)
 153
 154 #if 0   /* these ioctls are not used at the moment */
 155 /*
 156  * from the next key press on the driver will send
 157  * LIRC_MODE2_FREQUENCY packets
 158  */
 159 #define LIRC_MEASURE_CARRIER_ENABLE    _IO('i', 0x00000021)
 160 #define LIRC_MEASURE_CARRIER_DISABLE   _IO('i', 0x00000022)
 161 #endif
 162
 163 #endif