drivers/media/rc/ir-core-priv.h

   1 /*
   2  * Remote Controller core raw events header
   3  *
   4  * Copyright (C) 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
  16 #ifndef _IR_RAW_EVENT
  17 #define _IR_RAW_EVENT
  18
  19 #include <linux/slab.h>
  20 #include <linux/spinlock.h>
  21 #include <media/ir-core.h>
  22
  23 struct ir_raw_handler {
  24         struct list_head list;
  25
  26         u64 protocols; /* which are handled by this handler */
  27         int (*decode)(struct input_dev *input_dev, struct ir_raw_event event);
  28
  29         /* These two should only be used by the lirc decoder */
  30         int (*raw_register)(struct input_dev *input_dev);
  31         int (*raw_unregister)(struct input_dev *input_dev);
  32 };
  33
  34 struct ir_raw_event_ctrl {
  35         struct list_head                list;           /* to keep track of raw clients */
  36         struct task_struct              *thread;
  37         spinlock_t                      lock;
  38         struct kfifo                    kfifo;          /* fifo for the pulse/space durations */
  39         ktime_t                         last_event;     /* when last event occurred */
  40         enum raw_event_type             last_type;      /* last event type */
  41         struct input_dev                *input_dev;     /* pointer to the parent input_dev */
  42         u64                             enabled_protocols; /* enabled raw protocol decoders */
  43
  44         /* raw decoder state follows */
  45         struct ir_raw_event prev_ev;
  46         struct ir_raw_event this_ev;
  47         struct nec_dec {
  48                 int state;
  49                 unsigned count;
  50                 u32 bits;
  51                 bool is_nec_x;
  52                 bool necx_repeat;
  53         } nec;
  54         struct rc5_dec {
  55                 int state;
  56                 u32 bits;
  57                 unsigned count;
  58                 unsigned wanted_bits;
  59         } rc5;
  60         struct rc6_dec {
  61                 int state;
  62                 u8 header;
  63                 u32 body;
  64                 bool toggle;
  65                 unsigned count;
  66                 unsigned wanted_bits;
  67         } rc6;
  68         struct sony_dec {
  69                 int state;
  70                 u32 bits;
  71                 unsigned count;
  72         } sony;
  73         struct jvc_dec {
  74                 int state;
  75                 u16 bits;
  76                 u16 old_bits;
  77                 unsigned count;
  78                 bool first;
  79                 bool toggle;
  80         } jvc;
  81         struct rc5_sz_dec {
  82                 int state;
  83                 u32 bits;
  84                 unsigned count;
  85                 unsigned wanted_bits;
  86         } rc5_sz;
  87         struct lirc_codec {
  88                 struct ir_input_dev *ir_dev;
  89                 struct lirc_driver *drv;
  90                 int carrier_low;
  91
  92                 ktime_t gap_start;
  93                 u64 gap_duration;
  94                 bool gap;
  95                 bool send_timeout_reports;
  96
  97         } lirc;
  98 };
  99
 100 /* macros for IR decoders */
 101 static inline bool geq_margin(unsigned d1, unsigned d2, unsigned margin)
 102 {
 103         return d1 > (d2 - margin);
 104 }
 105
 106 static inline bool eq_margin(unsigned d1, unsigned d2, unsigned margin)
 107 {
 108         return ((d1 > (d2 - margin)) && (d1 < (d2 + margin)));
 109 }
 110
 111 static inline bool is_transition(struct ir_raw_event *x, struct ir_raw_event *y)
 112 {
 113         return x->pulse != y->pulse;
 114 }
 115
 116 static inline void decrease_duration(struct ir_raw_event *ev, unsigned duration)
 117 {
 118         if (duration > ev->duration)
 119                 ev->duration = 0;
 120         else
 121                 ev->duration -= duration;
 122 }
 123
 124 /* Returns true if event is normal pulse/space event */
 125 static inline bool is_timing_event(struct ir_raw_event ev)
 126 {
 127         return !ev.carrier_report && !ev.reset;
 128 }
 129
 130 #define TO_US(duration)                 DIV_ROUND_CLOSEST((duration), 1000)
 131 #define TO_STR(is_pulse)                ((is_pulse) ? "pulse" : "space")
 132 /*
 133  * Routines from ir-sysfs.c - Meant to be called only internally inside
 134  * ir-core
 135  */
 136 int ir_register_input(struct input_dev *input_dev);
 137
 138 int ir_register_class(struct input_dev *input_dev);
 139 void ir_unregister_class(struct input_dev *input_dev);
 140
 141 /*
 142  * Routines from ir-raw-event.c to be used internally and by decoders
 143  */
 144 u64 ir_raw_get_allowed_protocols(void);
 145 int ir_raw_event_register(struct input_dev *input_dev);
 146 void ir_raw_event_unregister(struct input_dev *input_dev);
 147 int ir_raw_handler_register(struct ir_raw_handler *ir_raw_handler);
 148 void ir_raw_handler_unregister(struct ir_raw_handler *ir_raw_handler);
 149 void ir_raw_init(void);
 150
 151 int ir_rcmap_init(void);
 152 void ir_rcmap_cleanup(void);
 153 /*
 154  * Decoder initialization code
 155  *
 156  * Those load logic are called during ir-core init, and automatically
 157  * loads the compiled decoders for their usage with IR raw events
 158  */
 159
 160 /* from ir-nec-decoder.c */
 161 #ifdef CONFIG_IR_NEC_DECODER_MODULE
 162 #define load_nec_decode()       request_module("ir-nec-decoder")
 163 #else
 164 #define load_nec_decode()       0
 165 #endif
 166
 167 /* from ir-rc5-decoder.c */
 168 #ifdef CONFIG_IR_RC5_DECODER_MODULE
 169 #define load_rc5_decode()       request_module("ir-rc5-decoder")
 170 #else
 171 #define load_rc5_decode()       0
 172 #endif
 173
 174 /* from ir-rc6-decoder.c */
 175 #ifdef CONFIG_IR_RC6_DECODER_MODULE
 176 #define load_rc6_decode()       request_module("ir-rc6-decoder")
 177 #else
 178 #define load_rc6_decode()       0
 179 #endif
 180
 181 /* from ir-jvc-decoder.c */
 182 #ifdef CONFIG_IR_JVC_DECODER_MODULE
 183 #define load_jvc_decode()       request_module("ir-jvc-decoder")
 184 #else
 185 #define load_jvc_decode()       0
 186 #endif
 187
 188 /* from ir-sony-decoder.c */
 189 #ifdef CONFIG_IR_SONY_DECODER_MODULE
 190 #define load_sony_decode()      request_module("ir-sony-decoder")
 191 #else
 192 #define load_sony_decode()      0
 193 #endif
 194
 195 /* from ir-lirc-codec.c */
 196 #ifdef CONFIG_IR_LIRC_CODEC_MODULE
 197 #define load_lirc_codec()       request_module("ir-lirc-codec")
 198 #else
 199 #define load_lirc_codec()       0
 200 #endif
 201
 202
 203 #endif /* _IR_RAW_EVENT */