rc-core.h 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  1. /*
  2. * Remote Controller core header
  3. *
  4. * Copyright (C) 2009-2010 by Mauro Carvalho Chehab <mchehab@redhat.com>
  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. #ifndef _RC_CORE
  16. #define _RC_CORE
  17. #include <linux/spinlock.h>
  18. #include <linux/kfifo.h>
  19. #include <linux/time.h>
  20. #include <linux/timer.h>
  21. #include <media/rc-map.h>
  22. extern int rc_core_debug;
  23. #define IR_dprintk(level, fmt, ...) \
  24. do { \
  25. if (rc_core_debug >= level) \
  26. pr_debug("%s: " fmt, __func__, ##__VA_ARGS__); \
  27. } while (0)
  28. enum rc_driver_type {
  29. RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */
  30. RC_DRIVER_IR_RAW, /* Needs a Infra-Red pulse/space decoder */
  31. };
  32. /**
  33. * struct rc_dev - represents a remote control device
  34. * @dev: driver model's view of this device
  35. * @input_name: name of the input child device
  36. * @input_phys: physical path to the input child device
  37. * @input_id: id of the input child device (struct input_id)
  38. * @driver_name: name of the hardware driver which registered this device
  39. * @map_name: name of the default keymap
  40. * @rc_map: current scan/key table
  41. * @lock: used to ensure we've filled in all protocol details before
  42. * anyone can call show_protocols or store_protocols
  43. * @devno: unique remote control device number
  44. * @raw: additional data for raw pulse/space devices
  45. * @input_dev: the input child device used to communicate events to userspace
  46. * @driver_type: specifies if protocol decoding is done in hardware or software
  47. * @idle: used to keep track of RX state
  48. * @allowed_protos: bitmask with the supported RC_BIT_* protocols
  49. * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols
  50. * @scanmask: some hardware decoders are not capable of providing the full
  51. * scancode to the application. As this is a hardware limit, we can't do
  52. * anything with it. Yet, as the same keycode table can be used with other
  53. * devices, a mask is provided to allow its usage. Drivers should generally
  54. * leave this field in blank
  55. * @priv: driver-specific data
  56. * @keylock: protects the remaining members of the struct
  57. * @keypressed: whether a key is currently pressed
  58. * @keyup_jiffies: time (in jiffies) when the current keypress should be released
  59. * @timer_keyup: timer for releasing a keypress
  60. * @last_keycode: keycode of last keypress
  61. * @last_scancode: scancode of last keypress
  62. * @last_toggle: toggle value of last command
  63. * @timeout: optional time after which device stops sending data
  64. * @min_timeout: minimum timeout supported by device
  65. * @max_timeout: maximum timeout supported by device
  66. * @rx_resolution : resolution (in ns) of input sampler
  67. * @tx_resolution: resolution (in ns) of output sampler
  68. * @change_protocol: allow changing the protocol used on hardware decoders
  69. * @open: callback to allow drivers to enable polling/irq when IR input device
  70. * is opened.
  71. * @close: callback to allow drivers to disable polling/irq when IR input device
  72. * is opened.
  73. * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
  74. * @s_tx_carrier: set transmit carrier frequency
  75. * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
  76. * @s_rx_carrier: inform driver about carrier it is expected to handle
  77. * @tx_ir: transmit IR
  78. * @s_idle: enable/disable hardware idle mode, upon which,
  79. * device doesn't interrupt host until it sees IR pulses
  80. * @s_learning_mode: enable wide band receiver used for learning
  81. * @s_carrier_report: enable carrier reports
  82. */
  83. struct rc_dev {
  84. struct device dev;
  85. const char *input_name;
  86. const char *input_phys;
  87. struct input_id input_id;
  88. char *driver_name;
  89. const char *map_name;
  90. struct rc_map rc_map;
  91. struct mutex lock;
  92. unsigned long devno;
  93. struct ir_raw_event_ctrl *raw;
  94. struct input_dev *input_dev;
  95. enum rc_driver_type driver_type;
  96. bool idle;
  97. u64 allowed_protos;
  98. u64 enabled_protocols;
  99. u32 scanmask;
  100. void *priv;
  101. spinlock_t keylock;
  102. bool keypressed;
  103. unsigned long keyup_jiffies;
  104. struct timer_list timer_keyup;
  105. u32 last_keycode;
  106. u32 last_scancode;
  107. u8 last_toggle;
  108. u32 timeout;
  109. u32 min_timeout;
  110. u32 max_timeout;
  111. u32 rx_resolution;
  112. u32 tx_resolution;
  113. int (*change_protocol)(struct rc_dev *dev, u64 *rc_type);
  114. int (*open)(struct rc_dev *dev);
  115. void (*close)(struct rc_dev *dev);
  116. int (*s_tx_mask)(struct rc_dev *dev, u32 mask);
  117. int (*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
  118. int (*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
  119. int (*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
  120. int (*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
  121. void (*s_idle)(struct rc_dev *dev, bool enable);
  122. int (*s_learning_mode)(struct rc_dev *dev, int enable);
  123. int (*s_carrier_report) (struct rc_dev *dev, int enable);
  124. };
  125. #define to_rc_dev(d) container_of(d, struct rc_dev, dev)
  126. /*
  127. * From rc-main.c
  128. * Those functions can be used on any type of Remote Controller. They
  129. * basically creates an input_dev and properly reports the device as a
  130. * Remote Controller, at sys/class/rc.
  131. */
  132. struct rc_dev *rc_allocate_device(void);
  133. void rc_free_device(struct rc_dev *dev);
  134. int rc_register_device(struct rc_dev *dev);
  135. void rc_unregister_device(struct rc_dev *dev);
  136. void rc_repeat(struct rc_dev *dev);
  137. void rc_keydown(struct rc_dev *dev, int scancode, u8 toggle);
  138. void rc_keydown_notimeout(struct rc_dev *dev, int scancode, u8 toggle);
  139. void rc_keyup(struct rc_dev *dev);
  140. u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
  141. /*
  142. * From rc-raw.c
  143. * The Raw interface is specific to InfraRed. It may be a good idea to
  144. * split it later into a separate header.
  145. */
  146. enum raw_event_type {
  147. IR_SPACE = (1 << 0),
  148. IR_PULSE = (1 << 1),
  149. IR_START_EVENT = (1 << 2),
  150. IR_STOP_EVENT = (1 << 3),
  151. };
  152. struct ir_raw_event {
  153. union {
  154. u32 duration;
  155. struct {
  156. u32 carrier;
  157. u8 duty_cycle;
  158. };
  159. };
  160. unsigned pulse:1;
  161. unsigned reset:1;
  162. unsigned timeout:1;
  163. unsigned carrier_report:1;
  164. };
  165. #define DEFINE_IR_RAW_EVENT(event) \
  166. struct ir_raw_event event = { \
  167. { .duration = 0 } , \
  168. .pulse = 0, \
  169. .reset = 0, \
  170. .timeout = 0, \
  171. .carrier_report = 0 }
  172. static inline void init_ir_raw_event(struct ir_raw_event *ev)
  173. {
  174. memset(ev, 0, sizeof(*ev));
  175. }
  176. #define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
  177. #define US_TO_NS(usec) ((usec) * 1000)
  178. #define MS_TO_US(msec) ((msec) * 1000)
  179. #define MS_TO_NS(msec) ((msec) * 1000 * 1000)
  180. void ir_raw_event_handle(struct rc_dev *dev);
  181. int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
  182. int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
  183. int ir_raw_event_store_with_filter(struct rc_dev *dev,
  184. struct ir_raw_event *ev);
  185. void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
  186. static inline void ir_raw_event_reset(struct rc_dev *dev)
  187. {
  188. DEFINE_IR_RAW_EVENT(ev);
  189. ev.reset = true;
  190. ir_raw_event_store(dev, &ev);
  191. ir_raw_event_handle(dev);
  192. }
  193. /* extract mask bits out of data and pack them into the result */
  194. static inline u32 ir_extract_bits(u32 data, u32 mask)
  195. {
  196. u32 vbit = 1, value = 0;
  197. do {
  198. if (mask & 1) {
  199. if (data & 1)
  200. value |= vbit;
  201. vbit <<= 1;
  202. }
  203. data >>= 1;
  204. } while (mask >>= 1);
  205. return value;
  206. }
  207. #endif /* _RC_CORE */