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