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