ir-core.h 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  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 _IR_CORE
  16. #define _IR_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 ir_core_debug;
  23. #define IR_dprintk(level, fmt, arg...) if (ir_core_debug >= level) \
  24. printk(KERN_DEBUG "%s: " fmt , __func__, ## arg)
  25. enum rc_driver_type {
  26. RC_DRIVER_SCANCODE = 0, /* Driver or hardware generates a scancode */
  27. RC_DRIVER_IR_RAW, /* Needs a Infra-Red pulse/space decoder */
  28. };
  29. /**
  30. * struct ir_dev_props - Allow caller drivers to set special properties
  31. * @driver_type: specifies if the driver or hardware have already a decoder,
  32. * or if it needs to use the IR raw event decoders to produce a scancode
  33. * @allowed_protos: bitmask with the supported IR_TYPE_* protocols
  34. * @scanmask: some hardware decoders are not capable of providing the full
  35. * scancode to the application. As this is a hardware limit, we can't do
  36. * anything with it. Yet, as the same keycode table can be used with other
  37. * devices, a mask is provided to allow its usage. Drivers should generally
  38. * leave this field in blank
  39. * @timeout: optional time after which device stops sending data
  40. * @min_timeout: minimum timeout supported by device
  41. * @max_timeout: maximum timeout supported by device
  42. * @rx_resolution : resolution (in ns) of input sampler
  43. * @tx_resolution: resolution (in ns) of output sampler
  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. * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
  51. * @s_tx_carrier: set transmit carrier frequency
  52. * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
  53. * @s_rx_carrier: inform driver about carrier it is expected to handle
  54. * @tx_ir: transmit IR
  55. * @s_idle: optional: enable/disable hardware idle mode, upon which,
  56. device doesn't interrupt host until it sees IR pulses
  57. * @s_learning_mode: enable wide band receiver used for learning
  58. * @s_carrier_report: enable carrier reports
  59. */
  60. struct ir_dev_props {
  61. enum rc_driver_type driver_type;
  62. unsigned long allowed_protos;
  63. u32 scanmask;
  64. u32 timeout;
  65. u32 min_timeout;
  66. u32 max_timeout;
  67. u32 rx_resolution;
  68. u32 tx_resolution;
  69. void *priv;
  70. int (*change_protocol)(void *priv, u64 ir_type);
  71. int (*open)(void *priv);
  72. void (*close)(void *priv);
  73. int (*s_tx_mask)(void *priv, u32 mask);
  74. int (*s_tx_carrier)(void *priv, u32 carrier);
  75. int (*s_tx_duty_cycle)(void *priv, u32 duty_cycle);
  76. int (*s_rx_carrier_range)(void *priv, u32 min, u32 max);
  77. int (*tx_ir)(void *priv, int *txbuf, u32 n);
  78. void (*s_idle)(void *priv, bool enable);
  79. int (*s_learning_mode)(void *priv, int enable);
  80. int (*s_carrier_report) (void *priv, int enable);
  81. };
  82. struct ir_input_dev {
  83. struct device dev; /* device */
  84. char *driver_name; /* Name of the driver module */
  85. struct ir_scancode_table rc_tab; /* scan/key table */
  86. unsigned long devno; /* device number */
  87. struct ir_dev_props *props; /* Device properties */
  88. struct ir_raw_event_ctrl *raw; /* for raw pulse/space events */
  89. struct input_dev *input_dev; /* the input device associated with this device */
  90. bool idle;
  91. /* key info - needed by IR keycode handlers */
  92. spinlock_t keylock; /* protects the below members */
  93. bool keypressed; /* current state */
  94. unsigned long keyup_jiffies; /* when should the current keypress be released? */
  95. struct timer_list timer_keyup; /* timer for releasing a keypress */
  96. u32 last_keycode; /* keycode of last command */
  97. u32 last_scancode; /* scancode of last command */
  98. u8 last_toggle; /* toggle of last command */
  99. };
  100. enum raw_event_type {
  101. IR_SPACE = (1 << 0),
  102. IR_PULSE = (1 << 1),
  103. IR_START_EVENT = (1 << 2),
  104. IR_STOP_EVENT = (1 << 3),
  105. };
  106. #define to_ir_input_dev(_attr) container_of(_attr, struct ir_input_dev, attr)
  107. /* From ir-keytable.c */
  108. int __ir_input_register(struct input_dev *dev,
  109. const struct ir_scancode_table *ir_codes,
  110. struct ir_dev_props *props,
  111. const char *driver_name);
  112. static inline int ir_input_register(struct input_dev *dev,
  113. const char *map_name,
  114. struct ir_dev_props *props,
  115. const char *driver_name) {
  116. struct ir_scancode_table *ir_codes;
  117. struct ir_input_dev *ir_dev;
  118. int rc;
  119. if (!map_name)
  120. return -EINVAL;
  121. ir_codes = get_rc_map(map_name);
  122. if (!ir_codes) {
  123. ir_codes = get_rc_map(RC_MAP_EMPTY);
  124. if (!ir_codes)
  125. return -EINVAL;
  126. }
  127. rc = __ir_input_register(dev, ir_codes, props, driver_name);
  128. if (rc < 0)
  129. return -EINVAL;
  130. ir_dev = input_get_drvdata(dev);
  131. if (!rc && ir_dev->props && ir_dev->props->change_protocol)
  132. rc = ir_dev->props->change_protocol(ir_dev->props->priv,
  133. ir_codes->ir_type);
  134. return rc;
  135. }
  136. void ir_input_unregister(struct input_dev *input_dev);
  137. void ir_repeat(struct input_dev *dev);
  138. void ir_keydown(struct input_dev *dev, int scancode, u8 toggle);
  139. void ir_keyup(struct ir_input_dev *ir);
  140. u32 ir_g_keycode_from_table(struct input_dev *input_dev, u32 scancode);
  141. /* From ir-raw-event.c */
  142. struct ir_raw_event {
  143. union {
  144. u32 duration;
  145. struct {
  146. u32 carrier;
  147. u8 duty_cycle;
  148. };
  149. };
  150. unsigned pulse:1;
  151. unsigned reset:1;
  152. unsigned timeout:1;
  153. unsigned carrier_report:1;
  154. };
  155. #define DEFINE_IR_RAW_EVENT(event) \
  156. struct ir_raw_event event = { \
  157. { .duration = 0 } , \
  158. .pulse = 0, \
  159. .reset = 0, \
  160. .timeout = 0, \
  161. .carrier_report = 0 }
  162. static inline void init_ir_raw_event(struct ir_raw_event *ev)
  163. {
  164. memset(ev, 0, sizeof(*ev));
  165. }
  166. #define IR_MAX_DURATION 0xFFFFFFFF /* a bit more than 4 seconds */
  167. void ir_raw_event_handle(struct input_dev *input_dev);
  168. int ir_raw_event_store(struct input_dev *input_dev, struct ir_raw_event *ev);
  169. int ir_raw_event_store_edge(struct input_dev *input_dev, enum raw_event_type type);
  170. int ir_raw_event_store_with_filter(struct input_dev *input_dev,
  171. struct ir_raw_event *ev);
  172. void ir_raw_event_set_idle(struct input_dev *input_dev, bool idle);
  173. static inline void ir_raw_event_reset(struct input_dev *input_dev)
  174. {
  175. DEFINE_IR_RAW_EVENT(ev);
  176. ev.reset = true;
  177. ir_raw_event_store(input_dev, &ev);
  178. ir_raw_event_handle(input_dev);
  179. }
  180. #endif /* _IR_CORE */