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 * @managed_alloc: devm_rc_allocate_device was used to create rc_dev 72 * @sysfs_groups: sysfs attribute groups 73 * @input_name: name of the input child device 74 * @input_phys: physical path to the input child device 75 * @input_id: id of the input child device (struct input_id) 76 * @driver_name: name of the hardware driver which registered this device 77 * @map_name: name of the default keymap 78 * @rc_map: current scan/key table 79 * @lock: used to ensure we've filled in all protocol details before 80 * anyone can call show_protocols or store_protocols 81 * @minor: unique minor remote control device number 82 * @raw: additional data for raw pulse/space devices 83 * @input_dev: the input child device used to communicate events to userspace 84 * @driver_type: specifies if protocol decoding is done in hardware or software 85 * @idle: used to keep track of RX state 86 * @allowed_protocols: bitmask with the supported RC_BIT_* protocols 87 * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols 88 * @allowed_wakeup_protocols: bitmask with the supported RC_BIT_* wakeup protocols 89 * @enabled_wakeup_protocols: bitmask with the enabled RC_BIT_* wakeup protocols 90 * @scancode_filter: scancode filter 91 * @scancode_wakeup_filter: scancode wakeup filters 92 * @scancode_mask: some hardware decoders are not capable of providing the full 93 * scancode to the application. As this is a hardware limit, we can't do 94 * anything with it. Yet, as the same keycode table can be used with other 95 * devices, a mask is provided to allow its usage. Drivers should generally 96 * leave this field in blank 97 * @users: number of current users of the device 98 * @priv: driver-specific data 99 * @keylock: protects the remaining members of the struct 100 * @keypressed: whether a key is currently pressed 101 * @keyup_jiffies: time (in jiffies) when the current keypress should be released 102 * @timer_keyup: timer for releasing a keypress 103 * @last_keycode: keycode of last keypress 104 * @last_protocol: protocol of last keypress 105 * @last_scancode: scancode of last keypress 106 * @last_toggle: toggle value of last command 107 * @timeout: optional time after which device stops sending data 108 * @min_timeout: minimum timeout supported by device 109 * @max_timeout: maximum timeout supported by device 110 * @rx_resolution : resolution (in ns) of input sampler 111 * @tx_resolution: resolution (in ns) of output sampler 112 * @change_protocol: allow changing the protocol used on hardware decoders 113 * @change_wakeup_protocol: allow changing the protocol used for wakeup 114 * filtering 115 * @open: callback to allow drivers to enable polling/irq when IR input device 116 * is opened. 117 * @close: callback to allow drivers to disable polling/irq when IR input device 118 * is opened. 119 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs) 120 * @s_tx_carrier: set transmit carrier frequency 121 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%) 122 * @s_rx_carrier_range: inform driver about carrier it is expected to handle 123 * @tx_ir: transmit IR 124 * @s_idle: enable/disable hardware idle mode, upon which, 125 * device doesn't interrupt host until it sees IR pulses 126 * @s_learning_mode: enable wide band receiver used for learning 127 * @s_carrier_report: enable carrier reports 128 * @s_filter: set the scancode filter 129 * @s_wakeup_filter: set the wakeup scancode filter 130 * @s_timeout: set hardware timeout in ns 131 */ 132 struct rc_dev { 133 struct device dev; 134 atomic_t initialized; 135 bool managed_alloc; 136 const struct attribute_group *sysfs_groups[5]; 137 const char *input_name; 138 const char *input_phys; 139 struct input_id input_id; 140 char *driver_name; 141 const char *map_name; 142 struct rc_map rc_map; 143 struct mutex lock; 144 unsigned int minor; 145 struct ir_raw_event_ctrl *raw; 146 struct input_dev *input_dev; 147 enum rc_driver_type driver_type; 148 bool idle; 149 u64 allowed_protocols; 150 u64 enabled_protocols; 151 u64 allowed_wakeup_protocols; 152 u64 enabled_wakeup_protocols; 153 struct rc_scancode_filter scancode_filter; 154 struct rc_scancode_filter scancode_wakeup_filter; 155 u32 scancode_mask; 156 u32 users; 157 void *priv; 158 spinlock_t keylock; 159 bool keypressed; 160 unsigned long keyup_jiffies; 161 struct timer_list timer_keyup; 162 u32 last_keycode; 163 enum rc_type last_protocol; 164 u32 last_scancode; 165 u8 last_toggle; 166 u32 timeout; 167 u32 min_timeout; 168 u32 max_timeout; 169 u32 rx_resolution; 170 u32 tx_resolution; 171 int (*change_protocol)(struct rc_dev *dev, u64 *rc_type); 172 int (*change_wakeup_protocol)(struct rc_dev *dev, u64 *rc_type); 173 int (*open)(struct rc_dev *dev); 174 void (*close)(struct rc_dev *dev); 175 int (*s_tx_mask)(struct rc_dev *dev, u32 mask); 176 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier); 177 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle); 178 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max); 179 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n); 180 void (*s_idle)(struct rc_dev *dev, bool enable); 181 int (*s_learning_mode)(struct rc_dev *dev, int enable); 182 int (*s_carrier_report) (struct rc_dev *dev, int enable); 183 int (*s_filter)(struct rc_dev *dev, 184 struct rc_scancode_filter *filter); 185 int (*s_wakeup_filter)(struct rc_dev *dev, 186 struct rc_scancode_filter *filter); 187 int (*s_timeout)(struct rc_dev *dev, 188 unsigned int timeout); 189 }; 190 191 #define to_rc_dev(d) container_of(d, struct rc_dev, dev) 192 193 /* 194 * From rc-main.c 195 * Those functions can be used on any type of Remote Controller. They 196 * basically creates an input_dev and properly reports the device as a 197 * Remote Controller, at sys/class/rc. 198 */ 199 200 /** 201 * rc_allocate_device - Allocates a RC device 202 * 203 * returns a pointer to struct rc_dev. 204 */ 205 struct rc_dev *rc_allocate_device(void); 206 207 /** 208 * devm_rc_allocate_device - Managed RC device allocation 209 * 210 * @dev: pointer to struct device 211 * returns a pointer to struct rc_dev. 212 */ 213 struct rc_dev *devm_rc_allocate_device(struct device *dev); 214 215 /** 216 * rc_free_device - Frees a RC device 217 * 218 * @dev: pointer to struct rc_dev. 219 */ 220 void rc_free_device(struct rc_dev *dev); 221 222 /** 223 * rc_register_device - Registers a RC device 224 * 225 * @dev: pointer to struct rc_dev. 226 */ 227 int rc_register_device(struct rc_dev *dev); 228 229 /** 230 * devm_rc_register_device - Manageded registering of a RC device 231 * 232 * @parent: pointer to struct device. 233 * @dev: pointer to struct rc_dev. 234 */ 235 int devm_rc_register_device(struct device *parent, struct rc_dev *dev); 236 237 /** 238 * rc_unregister_device - Unregisters a RC device 239 * 240 * @dev: pointer to struct rc_dev. 241 */ 242 void rc_unregister_device(struct rc_dev *dev); 243 244 /** 245 * rc_open - Opens a RC device 246 * 247 * @rdev: pointer to struct rc_dev. 248 */ 249 int rc_open(struct rc_dev *rdev); 250 251 /** 252 * rc_close - Closes a RC device 253 * 254 * @rdev: pointer to struct rc_dev. 255 */ 256 void rc_close(struct rc_dev *rdev); 257 258 void rc_repeat(struct rc_dev *dev); 259 void rc_keydown(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle); 260 void rc_keydown_notimeout(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle); 261 void rc_keyup(struct rc_dev *dev); 262 u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode); 263 264 /* 265 * From rc-raw.c 266 * The Raw interface is specific to InfraRed. It may be a good idea to 267 * split it later into a separate header. 268 */ 269 270 enum raw_event_type { 271 IR_SPACE = (1 << 0), 272 IR_PULSE = (1 << 1), 273 IR_START_EVENT = (1 << 2), 274 IR_STOP_EVENT = (1 << 3), 275 }; 276 277 struct ir_raw_event { 278 union { 279 u32 duration; 280 u32 carrier; 281 }; 282 u8 duty_cycle; 283 284 unsigned pulse:1; 285 unsigned reset:1; 286 unsigned timeout:1; 287 unsigned carrier_report:1; 288 }; 289 290 #define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {} 291 292 static inline void init_ir_raw_event(struct ir_raw_event *ev) 293 { 294 memset(ev, 0, sizeof(*ev)); 295 } 296 297 #define IR_DEFAULT_TIMEOUT MS_TO_NS(125) 298 #define IR_MAX_DURATION 500000000 /* 500 ms */ 299 #define US_TO_NS(usec) ((usec) * 1000) 300 #define MS_TO_US(msec) ((msec) * 1000) 301 #define MS_TO_NS(msec) ((msec) * 1000 * 1000) 302 303 void ir_raw_event_handle(struct rc_dev *dev); 304 int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev); 305 int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type); 306 int ir_raw_event_store_with_filter(struct rc_dev *dev, 307 struct ir_raw_event *ev); 308 void ir_raw_event_set_idle(struct rc_dev *dev, bool idle); 309 310 static inline void ir_raw_event_reset(struct rc_dev *dev) 311 { 312 struct ir_raw_event ev = { .reset = true }; 313 314 ir_raw_event_store(dev, &ev); 315 ir_raw_event_handle(dev); 316 } 317 318 /* extract mask bits out of data and pack them into the result */ 319 static inline u32 ir_extract_bits(u32 data, u32 mask) 320 { 321 u32 vbit = 1, value = 0; 322 323 do { 324 if (mask & 1) { 325 if (data & 1) 326 value |= vbit; 327 vbit <<= 1; 328 } 329 data >>= 1; 330 } while (mask >>= 1); 331 332 return value; 333 } 334 335 #endif /* _RC_CORE */ 336