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 | |
| 19 | #include <linux/input.h> |
| 20 | #include <linux/spinlock.h> |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 21 | #include <linux/kfifo.h> |
| 22 | #include <linux/time.h> |
Mauro Carvalho Chehab | 9f15478 | 2010-03-21 13:00:55 -0300 | [diff] [blame] | 23 | #include <linux/timer.h> |
Mauro Carvalho Chehab | 02858ee | 2010-04-02 20:01:00 -0300 | [diff] [blame^] | 24 | #include <media/rc-map.h> |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 25 | |
| 26 | extern int ir_core_debug; |
| 27 | #define IR_dprintk(level, fmt, arg...) if (ir_core_debug >= level) \ |
| 28 | printk(KERN_DEBUG "%s: " fmt , __func__, ## arg) |
| 29 | |
Mauro Carvalho Chehab | 971e829 | 2009-12-14 13:53:37 -0300 | [diff] [blame] | 30 | #define IR_TYPE_UNKNOWN 0 |
| 31 | #define IR_TYPE_RC5 (1 << 0) /* Philips RC5 protocol */ |
| 32 | #define IR_TYPE_PD (1 << 1) /* Pulse distance encoded IR */ |
| 33 | #define IR_TYPE_NEC (1 << 2) |
| 34 | #define IR_TYPE_OTHER (((u64)1) << 63l) |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 35 | |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 36 | enum raw_event_type { |
| 37 | IR_SPACE = (1 << 0), |
| 38 | IR_PULSE = (1 << 1), |
| 39 | IR_START_EVENT = (1 << 2), |
| 40 | IR_STOP_EVENT = (1 << 3), |
| 41 | }; |
| 42 | |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 43 | struct ir_scancode { |
| 44 | u16 scancode; |
| 45 | u32 keycode; |
| 46 | }; |
| 47 | |
| 48 | struct ir_scancode_table { |
| 49 | struct ir_scancode *scan; |
| 50 | int size; |
Mauro Carvalho Chehab | 2915e5e | 2010-03-12 11:40:13 -0300 | [diff] [blame] | 51 | u64 ir_type; |
| 52 | char *name; |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 53 | spinlock_t lock; |
| 54 | }; |
| 55 | |
Mauro Carvalho Chehab | 9ce50c1 | 2010-04-02 02:33:35 -0300 | [diff] [blame] | 56 | struct rc_keymap { |
| 57 | struct list_head list; |
| 58 | struct ir_scancode_table map; |
| 59 | }; |
| 60 | |
Mauro Carvalho Chehab | e93854d | 2009-12-14 00:16:55 -0300 | [diff] [blame] | 61 | struct ir_dev_props { |
| 62 | unsigned long allowed_protos; |
| 63 | void *priv; |
Mauro Carvalho Chehab | 971e829 | 2009-12-14 13:53:37 -0300 | [diff] [blame] | 64 | int (*change_protocol)(void *priv, u64 ir_type); |
Mauro Carvalho Chehab | 716aab4 | 2010-03-31 14:40:35 -0300 | [diff] [blame] | 65 | int (*open)(void *priv); |
| 66 | void (*close)(void *priv); |
Mauro Carvalho Chehab | e93854d | 2009-12-14 00:16:55 -0300 | [diff] [blame] | 67 | }; |
| 68 | |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 69 | struct ir_raw_event { |
| 70 | struct timespec delta; /* Time spent before event */ |
| 71 | enum raw_event_type type; /* event type */ |
| 72 | }; |
| 73 | |
| 74 | struct ir_raw_event_ctrl { |
| 75 | struct kfifo kfifo; /* fifo for the pulse/space events */ |
| 76 | struct timespec last_event; /* when last event occurred */ |
Mauro Carvalho Chehab | 9f15478 | 2010-03-21 13:00:55 -0300 | [diff] [blame] | 77 | struct timer_list timer_keyup; /* timer for key release */ |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 78 | }; |
Mauro Carvalho Chehab | 53f8702 | 2009-12-14 02:16:36 -0300 | [diff] [blame] | 79 | |
Mauro Carvalho Chehab | 75543cc | 2009-12-11 09:44:23 -0300 | [diff] [blame] | 80 | struct ir_input_dev { |
Mauro Carvalho Chehab | 945cdfa | 2010-03-11 12:41:56 -0300 | [diff] [blame] | 81 | struct device dev; /* device */ |
Mauro Carvalho Chehab | 727e625 | 2010-03-12 21:18:14 -0300 | [diff] [blame] | 82 | char *driver_name; /* Name of the driver module */ |
Mauro Carvalho Chehab | 4714eda | 2009-12-13 16:00:08 -0300 | [diff] [blame] | 83 | struct ir_scancode_table rc_tab; /* scan/key table */ |
| 84 | unsigned long devno; /* device number */ |
Mauro Carvalho Chehab | e93854d | 2009-12-14 00:16:55 -0300 | [diff] [blame] | 85 | const struct ir_dev_props *props; /* Device properties */ |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 86 | struct ir_raw_event_ctrl *raw; /* for raw pulse/space events */ |
Mauro Carvalho Chehab | 6660de5 | 2010-03-21 12:15:16 -0300 | [diff] [blame] | 87 | |
| 88 | /* key info - needed by IR keycode handlers */ |
| 89 | u32 keycode; /* linux key code */ |
| 90 | int keypressed; /* current state */ |
Mauro Carvalho Chehab | 75543cc | 2009-12-11 09:44:23 -0300 | [diff] [blame] | 91 | }; |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 92 | |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 93 | struct ir_raw_handler { |
| 94 | struct list_head list; |
| 95 | |
| 96 | int (*decode)(struct input_dev *input_dev, |
| 97 | struct ir_raw_event *evs, |
| 98 | int len); |
Mauro Carvalho Chehab | 93c312f | 2010-03-25 21:13:43 -0300 | [diff] [blame] | 99 | int (*raw_register)(struct input_dev *input_dev); |
| 100 | int (*raw_unregister)(struct input_dev *input_dev); |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 101 | }; |
| 102 | |
Mauro Carvalho Chehab | 53f8702 | 2009-12-14 02:16:36 -0300 | [diff] [blame] | 103 | #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] | 104 | |
Mauro Carvalho Chehab | 77b7422d | 2010-04-01 22:43:29 -0300 | [diff] [blame] | 105 | #define IR_KEYTABLE(a) \ |
| 106 | ir_codes_ ## a ## _table |
| 107 | |
| 108 | #define DECLARE_IR_KEYTABLE(a) \ |
| 109 | extern struct ir_scancode_table IR_KEYTABLE(a) |
| 110 | |
| 111 | #define DEFINE_IR_KEYTABLE(tabname, type) \ |
| 112 | struct ir_scancode_table IR_KEYTABLE(tabname) = { \ |
| 113 | .scan = tabname, \ |
| 114 | .size = ARRAY_SIZE(tabname), \ |
| 115 | .ir_type = type, \ |
| 116 | .name = #tabname, \ |
| 117 | }; \ |
| 118 | EXPORT_SYMBOL_GPL(IR_KEYTABLE(tabname)) |
| 119 | |
| 120 | #define DEFINE_LEGACY_IR_KEYTABLE(tabname) \ |
| 121 | DEFINE_IR_KEYTABLE(tabname, IR_TYPE_UNKNOWN) |
| 122 | |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 123 | /* Routines from rc-map.c */ |
| 124 | |
| 125 | int ir_register_map(struct rc_keymap *map); |
| 126 | void ir_unregister_map(struct rc_keymap *map); |
| 127 | struct ir_scancode_table *get_rc_map(const char *name); |
Mauro Carvalho Chehab | 02858ee | 2010-04-02 20:01:00 -0300 | [diff] [blame^] | 128 | void rc_map_init(void); |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 129 | |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 130 | /* Routines from ir-keytable.c */ |
| 131 | |
| 132 | u32 ir_g_keycode_from_table(struct input_dev *input_dev, |
| 133 | u32 scancode); |
Mauro Carvalho Chehab | ada3963 | 2010-03-21 12:24:24 -0300 | [diff] [blame] | 134 | void ir_keyup(struct input_dev *dev); |
| 135 | void ir_keydown(struct input_dev *dev, int scancode); |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 136 | int __ir_input_register(struct input_dev *dev, |
Mauro Carvalho Chehab | e93854d | 2009-12-14 00:16:55 -0300 | [diff] [blame] | 137 | const struct ir_scancode_table *ir_codes, |
Mauro Carvalho Chehab | 727e625 | 2010-03-12 21:18:14 -0300 | [diff] [blame] | 138 | const struct ir_dev_props *props, |
| 139 | const char *driver_name); |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 140 | |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 141 | static inline int ir_input_register(struct input_dev *dev, |
| 142 | const char *map_name, |
| 143 | const struct ir_dev_props *props, |
| 144 | const char *driver_name) { |
| 145 | struct ir_scancode_table *ir_codes; |
Mauro Carvalho Chehab | 02858ee | 2010-04-02 20:01:00 -0300 | [diff] [blame^] | 146 | struct ir_input_dev *ir_dev; |
| 147 | int rc; |
| 148 | |
| 149 | if (!map_name) |
| 150 | return -EINVAL; |
Mauro Carvalho Chehab | 9ce50c1 | 2010-04-02 02:33:35 -0300 | [diff] [blame] | 151 | |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 152 | ir_codes = get_rc_map(map_name); |
| 153 | if (!ir_codes) |
| 154 | return -EINVAL; |
| 155 | |
Mauro Carvalho Chehab | 02858ee | 2010-04-02 20:01:00 -0300 | [diff] [blame^] | 156 | rc = __ir_input_register(dev, ir_codes, props, driver_name); |
| 157 | if (rc < 0) |
| 158 | return -EINVAL; |
| 159 | |
| 160 | ir_dev = input_get_drvdata(dev); |
| 161 | |
| 162 | if (!rc && ir_dev->props && ir_dev->props->change_protocol) |
| 163 | rc = ir_dev->props->change_protocol(ir_dev->props->priv, |
| 164 | ir_codes->ir_type); |
| 165 | |
| 166 | return rc; |
Mauro Carvalho Chehab | b2245ba | 2010-04-02 13:18:42 -0300 | [diff] [blame] | 167 | } |
| 168 | |
Mauro Carvalho Chehab | 02858ee | 2010-04-02 20:01:00 -0300 | [diff] [blame^] | 169 | void ir_input_unregister(struct input_dev *input_dev); |
Mauro Carvalho Chehab | 9ce50c1 | 2010-04-02 02:33:35 -0300 | [diff] [blame] | 170 | |
Mauro Carvalho Chehab | 4714eda | 2009-12-13 16:00:08 -0300 | [diff] [blame] | 171 | /* Routines from ir-sysfs.c */ |
| 172 | |
| 173 | int ir_register_class(struct input_dev *input_dev); |
| 174 | void ir_unregister_class(struct input_dev *input_dev); |
| 175 | |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 176 | /* Routines from ir-raw-event.c */ |
| 177 | int ir_raw_event_register(struct input_dev *input_dev); |
| 178 | void ir_raw_event_unregister(struct input_dev *input_dev); |
| 179 | int ir_raw_event_store(struct input_dev *input_dev, enum raw_event_type type); |
| 180 | int ir_raw_event_handle(struct input_dev *input_dev); |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 181 | int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler); |
| 182 | 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] | 183 | void ir_raw_init(void); |
Mauro Carvalho Chehab | a3572c3 | 2010-03-20 20:59:44 -0300 | [diff] [blame] | 184 | |
| 185 | /* from ir-nec-decoder.c */ |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 186 | #ifdef CONFIG_IR_NEC_DECODER_MODULE |
| 187 | #define load_nec_decode() request_module("ir-nec-decoder") |
| 188 | #else |
| 189 | #define load_nec_decode() 0 |
Mauro Carvalho Chehab | 446e4a6 | 2009-12-11 08:34:07 -0300 | [diff] [blame] | 190 | #endif |
Mauro Carvalho Chehab | 995187b | 2010-03-24 20:47:53 -0300 | [diff] [blame] | 191 | |
| 192 | #endif /* _IR_CORE */ |