Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 1 | /* |
| 2 | * Remote Controller core header |
| 3 | * |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 4 | * Copyright (C) 2009-2010 by Mauro Carvalho Chehab <mchehab@redhat.com> |
| 5 | * |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 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 _IR_CORE |
| 17 | #define _IR_CORE |
| 18 | |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 19 | #include <linux/spinlock.h> |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 20 | #include <linux/kfifo.h> |
| 21 | #include <linux/time.h> |
Mauro Carvalho Chehab | 9f15478 | 2010-03-21 13:00:55 -0300 | [diff] [blame] | 22 | #include <linux/timer.h> |
Mauro Carvalho Chehab | 02858ee | 2010-04-02 20:01:00 -0300 | [diff] [blame] | 23 | #include <media/rc-map.h> |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 24 | |
| 25 | extern int ir_core_debug; |
| 26 | #define IR_dprintk(level, fmt, arg...) if (ir_core_debug >= level) \ |
| 27 | printk(KERN_DEBUG "%s: " fmt , __func__, ## arg) |
| 28 | |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 29 | enum raw_event_type { |
| 30 | IR_SPACE = (1 << 0), |
| 31 | IR_PULSE = (1 << 1), |
| 32 | IR_START_EVENT = (1 << 2), |
| 33 | IR_STOP_EVENT = (1 << 3), |
| 34 | }; |
| 35 | |
Mauro Carvalho Chehab | 9dfe4e8 | 2010-04-04 14:06:55 -0300 | [diff] [blame^] | 36 | /** |
| 37 | * struct ir_dev_props - Allow caller drivers to set special properties |
| 38 | * @allowed_protos: bitmask with the supported IR_TYPE_* protocols |
| 39 | * @scanmask: some hardware decoders are not capable of providing the full |
| 40 | * scancode to the application. As this is a hardware limit, we can't do |
| 41 | * anything with it. Yet, as the same keycode table can be used with other |
| 42 | * devices, a mask is provided to allow its usage. Drivers should generally |
| 43 | * leave this field in blank |
| 44 | * @priv: driver-specific data, to be used on the callbacks |
| 45 | * @change_protocol: allow changing the protocol used on hardware decoders |
| 46 | * @open: callback to allow drivers to enable polling/irq when IR input device |
| 47 | * is opened. |
| 48 | * @close: callback to allow drivers to disable polling/irq when IR input device |
| 49 | * is opened. |
| 50 | */ |
Mauro Carvalho Chehab | e93854d | 2009-12-14 00:16:55 -0300 | [diff] [blame] | 51 | struct ir_dev_props { |
Mauro Carvalho Chehab | 9dfe4e8 | 2010-04-04 14:06:55 -0300 | [diff] [blame^] | 52 | unsigned long allowed_protos; |
| 53 | u32 scanmask; |
Mauro Carvalho Chehab | e93854d | 2009-12-14 00:16:55 -0300 | [diff] [blame] | 54 | void *priv; |
Mauro Carvalho Chehab | 9dfe4e8 | 2010-04-04 14:06:55 -0300 | [diff] [blame^] | 55 | int (*change_protocol)(void *priv, u64 ir_type); |
| 56 | int (*open)(void *priv); |
| 57 | void (*close)(void *priv); |
Mauro Carvalho Chehab | e93854d | 2009-12-14 00:16:55 -0300 | [diff] [blame] | 58 | }; |
| 59 | |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 60 | struct ir_raw_event { |
| 61 | struct timespec delta; /* Time spent before event */ |
| 62 | enum raw_event_type type; /* event type */ |
| 63 | }; |
| 64 | |
| 65 | struct ir_raw_event_ctrl { |
| 66 | struct kfifo kfifo; /* fifo for the pulse/space events */ |
| 67 | struct timespec last_event; /* when last event occurred */ |
| 68 | }; |
Mauro Carvalho Chehab | 53f8702 | 2009-12-14 02:16:36 -0300 | [diff] [blame] | 69 | |
Mauro Carvalho Chehab | 75543cc | 2009-12-11 09:44:23 -0300 | [diff] [blame] | 70 | struct ir_input_dev { |
Mauro Carvalho Chehab | 945cdfa | 2010-03-11 12:41:56 -0300 | [diff] [blame] | 71 | struct device dev; /* device */ |
Mauro Carvalho Chehab | 727e625 | 2010-03-12 21:18:14 -0300 | [diff] [blame] | 72 | char *driver_name; /* Name of the driver module */ |
Mauro Carvalho Chehab | 4714eda | 2009-12-13 16:00:08 -0300 | [diff] [blame] | 73 | struct ir_scancode_table rc_tab; /* scan/key table */ |
| 74 | unsigned long devno; /* device number */ |
Mauro Carvalho Chehab | e93854d | 2009-12-14 00:16:55 -0300 | [diff] [blame] | 75 | const struct ir_dev_props *props; /* Device properties */ |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 76 | struct ir_raw_event_ctrl *raw; /* for raw pulse/space events */ |
David Härdeman | a374fef | 2010-04-02 15:58:29 -0300 | [diff] [blame] | 77 | struct input_dev *input_dev; /* the input device associated with this device */ |
Mauro Carvalho Chehab | 6660de5 | 2010-03-21 12:15:16 -0300 | [diff] [blame] | 78 | |
| 79 | /* key info - needed by IR keycode handlers */ |
David Härdeman | a374fef | 2010-04-02 15:58:29 -0300 | [diff] [blame] | 80 | spinlock_t keylock; /* protects the below members */ |
| 81 | bool keypressed; /* current state */ |
| 82 | unsigned long keyup_jiffies; /* when should the current keypress be released? */ |
| 83 | struct timer_list timer_keyup; /* timer for releasing a keypress */ |
| 84 | u32 last_keycode; /* keycode of last command */ |
| 85 | u32 last_scancode; /* scancode of last command */ |
| 86 | u8 last_toggle; /* toggle of last command */ |
Mauro Carvalho Chehab | 75543cc | 2009-12-11 09:44:23 -0300 | [diff] [blame] | 87 | }; |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 88 | |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 89 | struct ir_raw_handler { |
| 90 | struct list_head list; |
| 91 | |
| 92 | int (*decode)(struct input_dev *input_dev, |
Mauro Carvalho Chehab | 587835a | 2010-04-04 10:44:51 -0300 | [diff] [blame] | 93 | struct ir_raw_event *ev); |
Mauro Carvalho Chehab | 93c312f | 2010-03-25 21:13:43 -0300 | [diff] [blame] | 94 | int (*raw_register)(struct input_dev *input_dev); |
| 95 | int (*raw_unregister)(struct input_dev *input_dev); |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 96 | }; |
| 97 | |
Mauro Carvalho Chehab | 53f8702 | 2009-12-14 02:16:36 -0300 | [diff] [blame] | 98 | #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr) |
Mauro Carvalho Chehab | 75543cc | 2009-12-11 09:44:23 -0300 | [diff] [blame] | 99 | |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 100 | /* Routines from ir-keytable.c */ |
| 101 | |
| 102 | u32 ir_g_keycode_from_table(struct input_dev *input_dev, |
| 103 | u32 scancode); |
David Härdeman | a374fef | 2010-04-02 15:58:29 -0300 | [diff] [blame] | 104 | void ir_repeat(struct input_dev *dev); |
| 105 | void ir_keydown(struct input_dev *dev, int scancode, u8 toggle); |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 106 | int __ir_input_register(struct input_dev *dev, |
Mauro Carvalho Chehab | e93854d | 2009-12-14 00:16:55 -0300 | [diff] [blame] | 107 | const struct ir_scancode_table *ir_codes, |
Mauro Carvalho Chehab | 727e625 | 2010-03-12 21:18:14 -0300 | [diff] [blame] | 108 | const struct ir_dev_props *props, |
| 109 | const char *driver_name); |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 110 | |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 111 | static inline int ir_input_register(struct input_dev *dev, |
| 112 | const char *map_name, |
| 113 | const struct ir_dev_props *props, |
| 114 | const char *driver_name) { |
| 115 | struct ir_scancode_table *ir_codes; |
Mauro Carvalho Chehab | 02858ee | 2010-04-02 20:01:00 -0300 | [diff] [blame] | 116 | struct ir_input_dev *ir_dev; |
| 117 | int rc; |
| 118 | |
| 119 | if (!map_name) |
| 120 | return -EINVAL; |
Mauro Carvalho Chehab | 9ce50c1 | 2010-04-02 02:33:35 -0300 | [diff] [blame] | 121 | |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 122 | ir_codes = get_rc_map(map_name); |
| 123 | if (!ir_codes) |
| 124 | return -EINVAL; |
| 125 | |
Mauro Carvalho Chehab | 02858ee | 2010-04-02 20:01:00 -0300 | [diff] [blame] | 126 | rc = __ir_input_register(dev, ir_codes, props, driver_name); |
| 127 | if (rc < 0) |
| 128 | return -EINVAL; |
| 129 | |
| 130 | ir_dev = input_get_drvdata(dev); |
| 131 | |
| 132 | if (!rc && ir_dev->props && ir_dev->props->change_protocol) |
| 133 | rc = ir_dev->props->change_protocol(ir_dev->props->priv, |
| 134 | ir_codes->ir_type); |
| 135 | |
| 136 | return rc; |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 137 | } |
| 138 | |
Mauro Carvalho Chehab | 02858ee | 2010-04-02 20:01:00 -0300 | [diff] [blame] | 139 | void ir_input_unregister(struct input_dev *input_dev); |
Mauro Carvalho Chehab | 9ce50c1 | 2010-04-02 02:33:35 -0300 | [diff] [blame] | 140 | |
Mauro Carvalho Chehab | 4714eda | 2009-12-13 16:00:08 -0300 | [diff] [blame] | 141 | /* Routines from ir-sysfs.c */ |
| 142 | |
| 143 | int ir_register_class(struct input_dev *input_dev); |
| 144 | void ir_unregister_class(struct input_dev *input_dev); |
| 145 | |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 146 | /* Routines from ir-raw-event.c */ |
| 147 | int ir_raw_event_register(struct input_dev *input_dev); |
| 148 | void ir_raw_event_unregister(struct input_dev *input_dev); |
| 149 | int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type); |
| 150 | int ir_raw_event_handle(struct input_dev *input_dev); |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 151 | int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler); |
| 152 | void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler); |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 153 | void ir_raw_init(void); |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 154 | |
| 155 | /* from ir-nec-decoder.c */ |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 156 | #ifdef CONFIG_IR_NEC_DECODER_MODULE |
| 157 | #define load_nec_decode() request_module("ir-nec-decoder") |
| 158 | #else |
| 159 | #define load_nec_decode() 0 |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 160 | #endif |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 161 | |
Mauro Carvalho Chehab | db1423a | 2010-04-04 10:27:20 -0300 | [diff] [blame] | 162 | /* from ir-rc5-decoder.c */ |
| 163 | #ifdef CONFIG_IR_RC5_DECODER_MODULE |
| 164 | #define load_rc5_decode() request_module("ir-rc5-decoder") |
| 165 | #else |
| 166 | #define load_rc5_decode() 0 |
| 167 | #endif |
| 168 | |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 169 | #endif /* _IR_CORE */ |