1 /* 2 * Remote Controller core header 3 * 4 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation version 2 of the License. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 */ 15 16 #ifndef _RC_CORE 17 #define _RC_CORE 18 19 #include <linux/spinlock.h> 20 #include <linux/kfifo.h> 21 #include <linux/time.h> 22 #include <linux/timer.h> 23 #include <media/rc-map.h> 24 25 extern int rc_core_debug; 26 #define IR_dprintk(level, fmt, ...) \ 27 do { \ 28 if (rc_core_debug >= level) \ 29 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \ 30 } while (0) 31 32 /** 33 * enum rc_driver_type - type of the RC output 34 * 35 * @RC_DRIVER_SCANCODE: Driver or hardware generates a scancode 36 * @RC_DRIVER_IR_RAW: Driver or hardware generates pulse/space sequences. 37 * It needs a Infra-Red pulse/space decoder 38 */ 39 enum rc_driver_type { 40 RC_DRIVER_SCANCODE = 0, 41 RC_DRIVER_IR_RAW, 42 }; 43 44 /** 45 * struct rc_scancode_filter - Filter scan codes. 46 * @data: Scancode data to match. 47 * @mask: Mask of bits of scancode to compare. 48 */ 49 struct rc_scancode_filter { 50 u32 data; 51 u32 mask; 52 }; 53 54 /** 55 * enum rc_filter_type - Filter type constants. 56 * @RC_FILTER_NORMAL: Filter for normal operation. 57 * @RC_FILTER_WAKEUP: Filter for waking from suspend. 58 * @RC_FILTER_MAX: Number of filter types. 59 */ 60 enum rc_filter_type { 61 RC_FILTER_NORMAL = 0, 62 RC_FILTER_WAKEUP, 63 64 RC_FILTER_MAX 65 }; 66 67 /** 68 * struct rc_dev - represents a remote control device 69 * @dev: driver model's view of this device 70 * @initialized: 1 if the device init has completed, 0 otherwise 71 * @sysfs_groups: sysfs attribute groups 72 * @input_name: name of the input child device 73 * @input_phys: physical path to the input child device 74 * @input_id: id of the input child device (struct input_id) 75 * @driver_name: name of the hardware driver which registered this device 76 * @map_name: name of the default keymap 77 * @rc_map: current scan/key table 78 * @lock: used to ensure we've filled in all protocol details before 79 * anyone can call show_protocols or store_protocols 80 * @minor: unique minor remote control device number 81 * @raw: additional data for raw pulse/space devices 82 * @input_dev: the input child device used to communicate events to userspace 83 * @driver_type: specifies if protocol decoding is done in hardware or software 84 * @idle: used to keep track of RX state 85 * @allowed_protocols: bitmask with the supported RC_BIT_* protocols 86 * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols 87 * @allowed_wakeup_protocols: bitmask with the supported RC_BIT_* wakeup protocols 88 * @enabled_wakeup_protocols: bitmask with the enabled RC_BIT_* wakeup protocols 89 * @scancode_filter: scancode filter 90 * @scancode_wakeup_filter: scancode wakeup filters 91 * @scancode_mask: some hardware decoders are not capable of providing the full 92 * scancode to the application. As this is a hardware limit, we can't do 93 * anything with it. Yet, as the same keycode table can be used with other 94 * devices, a mask is provided to allow its usage. Drivers should generally 95 * leave this field in blank 96 * @users: number of current users of the device 97 * @priv: driver-specific data 98 * @keylock: protects the remaining members of the struct 99 * @keypressed: whether a key is currently pressed 100 * @keyup_jiffies: time (in jiffies) when the current keypress should be released 101 * @timer_keyup: timer for releasing a keypress 102 * @last_keycode: keycode of last keypress 103 * @last_protocol: protocol of last keypress 104 * @last_scancode: scancode of last keypress 105 * @last_toggle: toggle value of last command 106 * @timeout: optional time after which device stops sending data 107 * @min_timeout: minimum timeout supported by device 108 * @max_timeout: maximum timeout supported by device 109 * @rx_resolution : resolution (in ns) of input sampler 110 * @tx_resolution: resolution (in ns) of output sampler 111 * @change_protocol: allow changing the protocol used on hardware decoders 112 * @change_wakeup_protocol: allow changing the protocol used for wakeup 113 * filtering 114 * @open: callback to allow drivers to enable polling/irq when IR input device 115 * is opened. 116 * @close: callback to allow drivers to disable polling/irq when IR input device 117 * is opened. 118 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs) 119 * @s_tx_carrier: set transmit carrier frequency 120 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%) 121 * @s_rx_carrier_range: inform driver about carrier it is expected to handle 122 * @tx_ir: transmit IR 123 * @s_idle: enable/disable hardware idle mode, upon which, 124 * device doesn't interrupt host until it sees IR pulses 125 * @s_learning_mode: enable wide band receiver used for learning 126 * @s_carrier_report: enable carrier reports 127 * @s_filter: set the scancode filter 128 * @s_wakeup_filter: set the wakeup scancode filter 129 */ 130 struct rc_dev { 131 struct device dev; 132 atomic_t initialized; 133 const struct attribute_group *sysfs_groups[5]; 134 const char *input_name; 135 const char *input_phys; 136 struct input_id input_id; 137 char *driver_name; 138 const char *map_name; 139 struct rc_map rc_map; 140 struct mutex lock; 141 unsigned int minor; 142 struct ir_raw_event_ctrl *raw; 143 struct input_dev *input_dev; 144 enum rc_driver_type driver_type; 145 bool idle; 146 u64 allowed_protocols; 147 u64 enabled_protocols; 148 u64 allowed_wakeup_protocols; 149 u64 enabled_wakeup_protocols; 150 struct rc_scancode_filter scancode_filter; 151 struct rc_scancode_filter scancode_wakeup_filter; 152 u32 scancode_mask; 153 u32 users; 154 void *priv; 155 spinlock_t keylock; 156 bool keypressed; 157 unsigned long keyup_jiffies; 158 struct timer_list timer_keyup; 159 u32 last_keycode; 160 enum rc_type last_protocol; 161 u32 last_scancode; 162 u8 last_toggle; 163 u32 timeout; 164 u32 min_timeout; 165 u32 max_timeout; 166 u32 rx_resolution; 167 u32 tx_resolution; 168 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type); 169 int (*change_wakeup_protocol)(struct rc_dev *dev, u64 *rc_type); 170 int (*open)(struct rc_dev *dev); 171 void (*close)(struct rc_dev *dev); 172 int (*s_tx_mask)(struct rc_dev *dev, u32 mask); 173 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier); 174 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle); 175 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max); 176 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n); 177 void (*s_idle)(struct rc_dev *dev, bool enable); 178 int (*s_learning_mode)(struct rc_dev *dev, int enable); 179 int (*s_carrier_report) (struct rc_dev *dev, int enable); 180 int (*s_filter)(struct rc_dev *dev, 181 struct rc_scancode_filter *filter); 182 int (*s_wakeup_filter)(struct rc_dev *dev, 183 struct rc_scancode_filter *filter); 184 }; 185 186 #define to_rc_dev(d) container_of(d, struct rc_dev, dev) 187 188 /* 189 * From rc-main.c 190 * Those functions can be used on any type of Remote Controller. They 191 * basically creates an input_dev and properly reports the device as a 192 * Remote Controller, at sys/class/rc. 193 */ 194 195 /** 196 * rc_allocate_device - Allocates a RC device 197 * 198 * returns a pointer to struct rc_dev. 199 */ 200 struct rc_dev *rc_allocate_device(void); 201 202 /** 203 * rc_free_device - Frees a RC device 204 * 205 * @dev: pointer to struct rc_dev. 206 */ 207 void rc_free_device(struct rc_dev *dev); 208 209 /** 210 * rc_register_device - Registers a RC device 211 * 212 * @dev: pointer to struct rc_dev. 213 */ 214 int rc_register_device(struct rc_dev *dev); 215 216 /** 217 * rc_unregister_device - Unregisters a RC device 218 * 219 * @dev: pointer to struct rc_dev. 220 */ 221 void rc_unregister_device(struct rc_dev *dev); 222 223 /** 224 * rc_open - Opens a RC device 225 * 226 * @rdev: pointer to struct rc_dev. 227 */ 228 int rc_open(struct rc_dev *rdev); 229 230 /** 231 * rc_open - Closes a RC device 232 * 233 * @rdev: pointer to struct rc_dev. 234 */ 235 void rc_close(struct rc_dev *rdev); 236 237 void rc_repeat(struct rc_dev *dev); 238 void rc_keydown(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle); 239 void rc_keydown_notimeout(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle); 240 void rc_keyup(struct rc_dev *dev); 241 u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode); 242 243 /* 244 * From rc-raw.c 245 * The Raw interface is specific to InfraRed. It may be a good idea to 246 * split it later into a separate header. 247 */ 248 249 enum raw_event_type { 250 IR_SPACE = (1 << 0), 251 IR_PULSE = (1 << 1), 252 IR_START_EVENT = (1 << 2), 253 IR_STOP_EVENT = (1 << 3), 254 }; 255 256 struct ir_raw_event { 257 union { 258 u32 duration; 259 u32 carrier; 260 }; 261 u8 duty_cycle; 262 263 unsigned pulse:1; 264 unsigned reset:1; 265 unsigned timeout:1; 266 unsigned carrier_report:1; 267 }; 268 269 #define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {} 270 271 static inline void init_ir_raw_event(struct ir_raw_event *ev) 272 { 273 memset(ev, 0, sizeof(*ev)); 274 } 275 276 #define IR_DEFAULT_TIMEOUT MS_TO_NS(125) 277 #define IR_MAX_DURATION 500000000 /* 500 ms */ 278 #define US_TO_NS(usec) ((usec) * 1000) 279 #define MS_TO_US(msec) ((msec) * 1000) 280 #define MS_TO_NS(msec) ((msec) * 1000 * 1000) 281 282 void ir_raw_event_handle(struct rc_dev *dev); 283 int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev); 284 int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type); 285 int ir_raw_event_store_with_filter(struct rc_dev *dev, 286 struct ir_raw_event *ev); 287 void ir_raw_event_set_idle(struct rc_dev *dev, bool idle); 288 289 static inline void ir_raw_event_reset(struct rc_dev *dev) 290 { 291 struct ir_raw_event ev = { .reset = true }; 292 293 ir_raw_event_store(dev, &ev); 294 ir_raw_event_handle(dev); 295 } 296 297 /* extract mask bits out of data and pack them into the result */ 298 static inline u32 ir_extract_bits(u32 data, u32 mask) 299 { 300 u32 vbit = 1, value = 0; 301 302 do { 303 if (mask & 1) { 304 if (data & 1) 305 value |= vbit; 306 vbit <<= 1; 307 } 308 data >>= 1; 309 } while (mask >>= 1); 310 311 return value; 312 } 313 314 #endif /* _RC_CORE */ 315