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 25extern int rc_core_debug; 26#define IR_dprintk(level, fmt, ...) \ 27do { \ 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 */ 41enum 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 */ 52struct 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 */ 63enum 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 * @device_name: name of the rc 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_PROTO_BIT_* protocols 91 * @enabled_protocols: bitmask with the enabled RC_PROTO_BIT_* protocols 92 * @allowed_wakeup_protocols: bitmask with the supported RC_PROTO_BIT_* wakeup 93 * protocols 94 * @wakeup_protocol: the enabled RC_PROTO_* wakeup protocol or 95 * RC_PROTO_UNKNOWN if disabled. 96 * @scancode_filter: scancode filter 97 * @scancode_wakeup_filter: scancode wakeup filters 98 * @scancode_mask: some hardware decoders are not capable of providing the full 99 * scancode to the application. As this is a hardware limit, we can't do 100 * anything with it. Yet, as the same keycode table can be used with other 101 * devices, a mask is provided to allow its usage. Drivers should generally 102 * leave this field in blank 103 * @users: number of current users of the device 104 * @priv: driver-specific data 105 * @keylock: protects the remaining members of the struct 106 * @keypressed: whether a key is currently pressed 107 * @keyup_jiffies: time (in jiffies) when the current keypress should be released 108 * @timer_keyup: timer for releasing a keypress 109 * @last_keycode: keycode of last keypress 110 * @last_protocol: protocol of last keypress 111 * @last_scancode: scancode of last keypress 112 * @last_toggle: toggle value of last command 113 * @timeout: optional time after which device stops sending data 114 * @min_timeout: minimum timeout supported by device 115 * @max_timeout: maximum timeout supported by device 116 * @rx_resolution : resolution (in ns) of input sampler 117 * @tx_resolution: resolution (in ns) of output sampler 118 * @change_protocol: allow changing the protocol used on hardware decoders 119 * @open: callback to allow drivers to enable polling/irq when IR input device 120 * is opened. 121 * @close: callback to allow drivers to disable polling/irq when IR input device 122 * is opened. 123 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs) 124 * @s_tx_carrier: set transmit carrier frequency 125 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%) 126 * @s_rx_carrier_range: inform driver about carrier it is expected to handle 127 * @tx_ir: transmit IR 128 * @s_idle: enable/disable hardware idle mode, upon which, 129 * device doesn't interrupt host until it sees IR pulses 130 * @s_learning_mode: enable wide band receiver used for learning 131 * @s_carrier_report: enable carrier reports 132 * @s_filter: set the scancode filter 133 * @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero 134 * then wakeup should be disabled. wakeup_protocol will be set to 135 * a valid protocol if mask is nonzero. 136 * @s_timeout: set hardware timeout in ns 137 */ 138struct rc_dev { 139 struct device dev; 140 bool managed_alloc; 141 const struct attribute_group *sysfs_groups[5]; 142 const char *device_name; 143 const char *input_phys; 144 struct input_id input_id; 145 const char *driver_name; 146 const char *map_name; 147 struct rc_map rc_map; 148 struct mutex lock; 149 unsigned int minor; 150 struct ir_raw_event_ctrl *raw; 151 struct input_dev *input_dev; 152 enum rc_driver_type driver_type; 153 bool idle; 154 bool encode_wakeup; 155 u64 allowed_protocols; 156 u64 enabled_protocols; 157 u64 allowed_wakeup_protocols; 158 enum rc_proto wakeup_protocol; 159 struct rc_scancode_filter scancode_filter; 160 struct rc_scancode_filter scancode_wakeup_filter; 161 u32 scancode_mask; 162 u32 users; 163 void *priv; 164 spinlock_t keylock; 165 bool keypressed; 166 unsigned long keyup_jiffies; 167 struct timer_list timer_keyup; 168 u32 last_keycode; 169 enum rc_proto last_protocol; 170 u32 last_scancode; 171 u8 last_toggle; 172 u32 timeout; 173 u32 min_timeout; 174 u32 max_timeout; 175 u32 rx_resolution; 176 u32 tx_resolution; 177 int (*change_protocol)(struct rc_dev *dev, u64 *rc_proto); 178 int (*open)(struct rc_dev *dev); 179 void (*close)(struct rc_dev *dev); 180 int (*s_tx_mask)(struct rc_dev *dev, u32 mask); 181 int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier); 182 int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle); 183 int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max); 184 int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n); 185 void (*s_idle)(struct rc_dev *dev, bool enable); 186 int (*s_learning_mode)(struct rc_dev *dev, int enable); 187 int (*s_carrier_report) (struct rc_dev *dev, int enable); 188 int (*s_filter)(struct rc_dev *dev, 189 struct rc_scancode_filter *filter); 190 int (*s_wakeup_filter)(struct rc_dev *dev, 191 struct rc_scancode_filter *filter); 192 int (*s_timeout)(struct rc_dev *dev, 193 unsigned int timeout); 194}; 195 196#define to_rc_dev(d) container_of(d, struct rc_dev, dev) 197 198/* 199 * From rc-main.c 200 * Those functions can be used on any type of Remote Controller. They 201 * basically creates an input_dev and properly reports the device as a 202 * Remote Controller, at sys/class/rc. 203 */ 204 205/** 206 * rc_allocate_device - Allocates a RC device 207 * 208 * @rc_driver_type: specifies the type of the RC output to be allocated 209 * returns a pointer to struct rc_dev. 210 */ 211struct rc_dev *rc_allocate_device(enum rc_driver_type); 212 213/** 214 * devm_rc_allocate_device - Managed RC device allocation 215 * 216 * @dev: pointer to struct device 217 * @rc_driver_type: specifies the type of the RC output to be allocated 218 * returns a pointer to struct rc_dev. 219 */ 220struct rc_dev *devm_rc_allocate_device(struct device *dev, enum rc_driver_type); 221 222/** 223 * rc_free_device - Frees a RC device 224 * 225 * @dev: pointer to struct rc_dev. 226 */ 227void rc_free_device(struct rc_dev *dev); 228 229/** 230 * rc_register_device - Registers a RC device 231 * 232 * @dev: pointer to struct rc_dev. 233 */ 234int rc_register_device(struct rc_dev *dev); 235 236/** 237 * devm_rc_register_device - Manageded registering of a RC device 238 * 239 * @parent: pointer to struct device. 240 * @dev: pointer to struct rc_dev. 241 */ 242int devm_rc_register_device(struct device *parent, struct rc_dev *dev); 243 244/** 245 * rc_unregister_device - Unregisters a RC device 246 * 247 * @dev: pointer to struct rc_dev. 248 */ 249void rc_unregister_device(struct rc_dev *dev); 250 251/** 252 * rc_open - Opens a RC device 253 * 254 * @rdev: pointer to struct rc_dev. 255 */ 256int rc_open(struct rc_dev *rdev); 257 258/** 259 * rc_close - Closes a RC device 260 * 261 * @rdev: pointer to struct rc_dev. 262 */ 263void rc_close(struct rc_dev *rdev); 264 265void rc_repeat(struct rc_dev *dev); 266void rc_keydown(struct rc_dev *dev, enum rc_proto protocol, u32 scancode, 267 u8 toggle); 268void rc_keydown_notimeout(struct rc_dev *dev, enum rc_proto protocol, 269 u32 scancode, u8 toggle); 270void rc_keyup(struct rc_dev *dev); 271u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode); 272 273/* 274 * From rc-raw.c 275 * The Raw interface is specific to InfraRed. It may be a good idea to 276 * split it later into a separate header. 277 */ 278struct ir_raw_event { 279 union { 280 u32 duration; 281 u32 carrier; 282 }; 283 u8 duty_cycle; 284 285 unsigned pulse:1; 286 unsigned reset:1; 287 unsigned timeout:1; 288 unsigned carrier_report:1; 289}; 290 291#define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {} 292 293static inline void init_ir_raw_event(struct ir_raw_event *ev) 294{ 295 memset(ev, 0, sizeof(*ev)); 296} 297 298#define IR_DEFAULT_TIMEOUT MS_TO_NS(125) 299#define IR_MAX_DURATION 500000000 /* 500 ms */ 300#define US_TO_NS(usec) ((usec) * 1000) 301#define MS_TO_US(msec) ((msec) * 1000) 302#define MS_TO_NS(msec) ((msec) * 1000 * 1000) 303 304void ir_raw_event_handle(struct rc_dev *dev); 305int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev); 306int ir_raw_event_store_edge(struct rc_dev *dev, bool pulse); 307int ir_raw_event_store_with_filter(struct rc_dev *dev, 308 struct ir_raw_event *ev); 309void ir_raw_event_set_idle(struct rc_dev *dev, bool idle); 310int ir_raw_encode_scancode(enum rc_proto protocol, u32 scancode, 311 struct ir_raw_event *events, unsigned int max); 312 313static inline void ir_raw_event_reset(struct rc_dev *dev) 314{ 315 struct ir_raw_event ev = { .reset = true }; 316 317 ir_raw_event_store(dev, &ev); 318 ir_raw_event_handle(dev); 319} 320 321/* extract mask bits out of data and pack them into the result */ 322static inline u32 ir_extract_bits(u32 data, u32 mask) 323{ 324 u32 vbit = 1, value = 0; 325 326 do { 327 if (mask & 1) { 328 if (data & 1) 329 value |= vbit; 330 vbit <<= 1; 331 } 332 data >>= 1; 333 } while (mask >>= 1); 334 335 return value; 336} 337 338/* Get NEC scancode and protocol type from address and command bytes */ 339static inline u32 ir_nec_bytes_to_scancode(u8 address, u8 not_address, 340 u8 command, u8 not_command, 341 enum rc_proto *protocol) 342{ 343 u32 scancode; 344 345 if ((command ^ not_command) != 0xff) { 346 /* NEC transport, but modified protocol, used by at 347 * least Apple and TiVo remotes 348 */ 349 scancode = not_address << 24 | 350 address << 16 | 351 not_command << 8 | 352 command; 353 *protocol = RC_PROTO_NEC32; 354 } else if ((address ^ not_address) != 0xff) { 355 /* Extended NEC */ 356 scancode = address << 16 | 357 not_address << 8 | 358 command; 359 *protocol = RC_PROTO_NECX; 360 } else { 361 /* Normal NEC */ 362 scancode = address << 8 | command; 363 *protocol = RC_PROTO_NEC; 364 } 365 366 return scancode; 367} 368 369#endif /* _RC_CORE */ 370