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