[linux-2.6-block.git] / include / media / rc-core.h

/*
 * Remote Controller core header
 *
 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab
 *
 * This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 */

#ifndef _RC_CORE
#define _RC_CORE

#include <linux/spinlock.h>
#include <linux/kfifo.h>
#include <linux/time.h>
#include <linux/timer.h>
#include <media/rc-map.h>

extern int rc_core_debug;
#define IR_dprintk(level, fmt, ...)				\
do {								\
	if (rc_core_debug >= level)				\
		printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);	\
} while (0)

/**
 * enum rc_driver_type - type of the RC output
 *
 * @RC_DRIVER_SCANCODE:	 Driver or hardware generates a scancode
 * @RC_DRIVER_IR_RAW:	 Driver or hardware generates pulse/space sequences.
 *			 It needs a Infra-Red pulse/space decoder
 * @RC_DRIVER_IR_RAW_TX: Device transmitter only,
 *			 driver requires pulse/space data sequence.
 */
enum rc_driver_type {
	RC_DRIVER_SCANCODE = 0,
	RC_DRIVER_IR_RAW,
	RC_DRIVER_IR_RAW_TX,
};

/**
 * struct rc_scancode_filter - Filter scan codes.
 * @data:	Scancode data to match.
 * @mask:	Mask of bits of scancode to compare.
 */
struct rc_scancode_filter {
	u32 data;
	u32 mask;
};

/**
 * enum rc_filter_type - Filter type constants.
 * @RC_FILTER_NORMAL:	Filter for normal operation.
 * @RC_FILTER_WAKEUP:	Filter for waking from suspend.
 * @RC_FILTER_MAX:	Number of filter types.
 */
enum rc_filter_type {
	RC_FILTER_NORMAL = 0,
	RC_FILTER_WAKEUP,

	RC_FILTER_MAX
};

/**
 * struct rc_dev - represents a remote control device
 * @dev: driver model's view of this device
 * @managed_alloc: devm_rc_allocate_device was used to create rc_dev
 * @sysfs_groups: sysfs attribute groups
 * @device_name: name of the rc child device
 * @input_phys: physical path to the input child device
 * @input_id: id of the input child device (struct input_id)
 * @driver_name: name of the hardware driver which registered this device
 * @map_name: name of the default keymap
 * @rc_map: current scan/key table
 * @lock: used to ensure we've filled in all protocol details before
 *	anyone can call show_protocols or store_protocols
 * @minor: unique minor remote control device number
 * @raw: additional data for raw pulse/space devices
 * @input_dev: the input child device used to communicate events to userspace
 * @driver_type: specifies if protocol decoding is done in hardware or software
 * @idle: used to keep track of RX state
 * @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed
 *	wakeup protocols is the set of all raw encoders
 * @allowed_protocols: bitmask with the supported RC_BIT_* protocols
 * @enabled_protocols: bitmask with the enabled RC_BIT_* protocols
 * @allowed_wakeup_protocols: bitmask with the supported RC_BIT_* wakeup protocols
 * @wakeup_protocol: the enabled RC_TYPE_* wakeup protocol or
 *	RC_TYPE_UNKNOWN if disabled.
 * @scancode_filter: scancode filter
 * @scancode_wakeup_filter: scancode wakeup filters
 * @scancode_mask: some hardware decoders are not capable of providing the full
 *	scancode to the application. As this is a hardware limit, we can't do
 *	anything with it. Yet, as the same keycode table can be used with other
 *	devices, a mask is provided to allow its usage. Drivers should generally
 *	leave this field in blank
 * @users: number of current users of the device
 * @priv: driver-specific data
 * @keylock: protects the remaining members of the struct
 * @keypressed: whether a key is currently pressed
 * @keyup_jiffies: time (in jiffies) when the current keypress should be released
 * @timer_keyup: timer for releasing a keypress
 * @last_keycode: keycode of last keypress
 * @last_protocol: protocol of last keypress
 * @last_scancode: scancode of last keypress
 * @last_toggle: toggle value of last command
 * @timeout: optional time after which device stops sending data
 * @min_timeout: minimum timeout supported by device
 * @max_timeout: maximum timeout supported by device
 * @rx_resolution : resolution (in ns) of input sampler
 * @tx_resolution: resolution (in ns) of output sampler
 * @change_protocol: allow changing the protocol used on hardware decoders
 * @open: callback to allow drivers to enable polling/irq when IR input device
 *	is opened.
 * @close: callback to allow drivers to disable polling/irq when IR input device
 *	is opened.
 * @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
 * @s_tx_carrier: set transmit carrier frequency
 * @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
 * @s_rx_carrier_range: inform driver about carrier it is expected to handle
 * @tx_ir: transmit IR
 * @s_idle: enable/disable hardware idle mode, upon which,
 *	device doesn't interrupt host until it sees IR pulses
 * @s_learning_mode: enable wide band receiver used for learning
 * @s_carrier_report: enable carrier reports
 * @s_filter: set the scancode filter
 * @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero
 *	then wakeup should be disabled. wakeup_protocol will be set to
 *	a valid protocol if mask is nonzero.
 * @s_timeout: set hardware timeout in ns
 */
struct rc_dev {
	struct device			dev;
	bool				managed_alloc;
	const struct attribute_group	*sysfs_groups[5];
	const char			*device_name;
	const char			*input_phys;
	struct input_id			input_id;
	const char			*driver_name;
	const char			*map_name;
	struct rc_map			rc_map;
	struct mutex			lock;
	unsigned int			minor;
	struct ir_raw_event_ctrl	*raw;
	struct input_dev		*input_dev;
	enum rc_driver_type		driver_type;
	bool				idle;
	bool				encode_wakeup;
	u64				allowed_protocols;
	u64				enabled_protocols;
	u64				allowed_wakeup_protocols;
	enum rc_type			wakeup_protocol;
	struct rc_scancode_filter	scancode_filter;
	struct rc_scancode_filter	scancode_wakeup_filter;
	u32				scancode_mask;
	u32				users;
	void				*priv;
	spinlock_t			keylock;
	bool				keypressed;
	unsigned long			keyup_jiffies;
	struct timer_list		timer_keyup;
	u32				last_keycode;
	enum rc_type			last_protocol;
	u32				last_scancode;
	u8				last_toggle;
	u32				timeout;
	u32				min_timeout;
	u32				max_timeout;
	u32				rx_resolution;
	u32				tx_resolution;
	int				(*change_protocol)(struct rc_dev *dev, u64 *rc_type);
	int				(*open)(struct rc_dev *dev);
	void				(*close)(struct rc_dev *dev);
	int				(*s_tx_mask)(struct rc_dev *dev, u32 mask);
	int				(*s_tx_carrier)(struct rc_dev *dev, u32 carrier);
	int				(*s_tx_duty_cycle)(struct rc_dev *dev, u32 duty_cycle);
	int				(*s_rx_carrier_range)(struct rc_dev *dev, u32 min, u32 max);
	int				(*tx_ir)(struct rc_dev *dev, unsigned *txbuf, unsigned n);
	void				(*s_idle)(struct rc_dev *dev, bool enable);
	int				(*s_learning_mode)(struct rc_dev *dev, int enable);
	int				(*s_carrier_report) (struct rc_dev *dev, int enable);
	int				(*s_filter)(struct rc_dev *dev,
						    struct rc_scancode_filter *filter);
	int				(*s_wakeup_filter)(struct rc_dev *dev,
							   struct rc_scancode_filter *filter);
	int				(*s_timeout)(struct rc_dev *dev,
						     unsigned int timeout);
};

#define to_rc_dev(d) container_of(d, struct rc_dev, dev)

/*
 * From rc-main.c
 * Those functions can be used on any type of Remote Controller. They
 * basically creates an input_dev and properly reports the device as a
 * Remote Controller, at sys/class/rc.
 */

/**
 * rc_allocate_device - Allocates a RC device
 *
 * @rc_driver_type: specifies the type of the RC output to be allocated
 * returns a pointer to struct rc_dev.
 */
struct rc_dev *rc_allocate_device(enum rc_driver_type);

/**
 * devm_rc_allocate_device - Managed RC device allocation
 *
 * @dev: pointer to struct device
 * @rc_driver_type: specifies the type of the RC output to be allocated
 * returns a pointer to struct rc_dev.
 */
struct rc_dev *devm_rc_allocate_device(struct device *dev, enum rc_driver_type);

/**
 * rc_free_device - Frees a RC device
 *
 * @dev: pointer to struct rc_dev.
 */
void rc_free_device(struct rc_dev *dev);

/**
 * rc_register_device - Registers a RC device
 *
 * @dev: pointer to struct rc_dev.
 */
int rc_register_device(struct rc_dev *dev);

/**
 * devm_rc_register_device - Manageded registering of a RC device
 *
 * @parent: pointer to struct device.
 * @dev: pointer to struct rc_dev.
 */
int devm_rc_register_device(struct device *parent, struct rc_dev *dev);

/**
 * rc_unregister_device - Unregisters a RC device
 *
 * @dev: pointer to struct rc_dev.
 */
void rc_unregister_device(struct rc_dev *dev);

/**
 * rc_open - Opens a RC device
 *
 * @rdev: pointer to struct rc_dev.
 */
int rc_open(struct rc_dev *rdev);

/**
 * rc_close - Closes a RC device
 *
 * @rdev: pointer to struct rc_dev.
 */
void rc_close(struct rc_dev *rdev);

void rc_repeat(struct rc_dev *dev);
void rc_keydown(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
void rc_keydown_notimeout(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
void rc_keyup(struct rc_dev *dev);
u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);

/*
 * From rc-raw.c
 * The Raw interface is specific to InfraRed. It may be a good idea to
 * split it later into a separate header.
 */

enum raw_event_type {
	IR_SPACE        = (1 << 0),
	IR_PULSE        = (1 << 1),
	IR_START_EVENT  = (1 << 2),
	IR_STOP_EVENT   = (1 << 3),
};

struct ir_raw_event {
	union {
		u32             duration;
		u32             carrier;
	};
	u8                      duty_cycle;

	unsigned                pulse:1;
	unsigned                reset:1;
	unsigned                timeout:1;
	unsigned                carrier_report:1;
};

#define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {}

static inline void init_ir_raw_event(struct ir_raw_event *ev)
{
	memset(ev, 0, sizeof(*ev));
}

#define IR_DEFAULT_TIMEOUT	MS_TO_NS(125)
#define IR_MAX_DURATION         500000000	/* 500 ms */
#define US_TO_NS(usec)		((usec) * 1000)
#define MS_TO_US(msec)		((msec) * 1000)
#define MS_TO_NS(msec)		((msec) * 1000 * 1000)

void ir_raw_event_handle(struct rc_dev *dev);
int ir_raw_event_store(struct rc_dev *dev, struct ir_raw_event *ev);
int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
int ir_raw_event_store_with_filter(struct rc_dev *dev,
				struct ir_raw_event *ev);
void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
int ir_raw_encode_scancode(enum rc_type protocol, u32 scancode,
			   struct ir_raw_event *events, unsigned int max);

static inline void ir_raw_event_reset(struct rc_dev *dev)
{
	struct ir_raw_event ev = { .reset = true };

	ir_raw_event_store(dev, &ev);
	ir_raw_event_handle(dev);
}

/* extract mask bits out of data and pack them into the result */
static inline u32 ir_extract_bits(u32 data, u32 mask)
{
	u32 vbit = 1, value = 0;

	do {
		if (mask & 1) {
			if (data & 1)
				value |= vbit;
			vbit <<= 1;
		}
		data >>= 1;
	} while (mask >>= 1);

	return value;
}

#endif /* _RC_CORE */
Commit	Line	Data
446e4a64 MCC	1	/*
	2	* Remote Controller core header
	3	*
37e59f87	4	* Copyright (C) 2009-2010 by Mauro Carvalho Chehab
995187be	5	*
446e4a64 MCC	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
ca86674b MCC	16	#ifndef _RC_CORE
ca86674b MCC	17	#define _RC_CORE
446e4a64	18
446e4a64	19	#include <linux/spinlock.h>
a3572c34 MCC	20	#include <linux/kfifo.h>
a3572c34 MCC	21	#include <linux/time.h>
9f154782	22	#include <linux/timer.h>
02858eed	23	#include <media/rc-map.h>
446e4a64	24
6bda9644	25	extern int rc_core_debug;
86b0dbef JP	26	#define IR_dprintk(level, fmt, ...) \
	27	do { \
	28	if (rc_core_debug >= level) \
7cec72ce	29	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
86b0dbef	30	} while (0)
446e4a64	31
5b6137dc MCC	32	/**
	33	* enum rc_driver_type - type of the RC output
	34	*
d34aee10 AS	35	* @RC_DRIVER_SCANCODE: Driver or hardware generates a scancode
	36	* @RC_DRIVER_IR_RAW: Driver or hardware generates pulse/space sequences.
	37	* It needs a Infra-Red pulse/space decoder
	38	* @RC_DRIVER_IR_RAW_TX: Device transmitter only,
	39	* driver requires pulse/space data sequence.
5b6137dc	40	*/
626cf697	41	enum rc_driver_type {
5b6137dc MCC	42	RC_DRIVER_SCANCODE = 0,
5b6137dc MCC	43	RC_DRIVER_IR_RAW,
d34aee10	44	RC_DRIVER_IR_RAW_TX,
626cf697 MCC	45	};
626cf697 MCC	46
00942d1a JH	47	/**
	48	* struct rc_scancode_filter - Filter scan codes.
	49	* @data: Scancode data to match.
	50	* @mask: Mask of bits of scancode to compare.
	51	*/
	52	struct rc_scancode_filter {
	53	u32 data;
	54	u32 mask;
	55	};
	56
	57	/**
	58	* enum rc_filter_type - Filter type constants.
	59	* @RC_FILTER_NORMAL: Filter for normal operation.
	60	* @RC_FILTER_WAKEUP: Filter for waking from suspend.
	61	* @RC_FILTER_MAX: Number of filter types.
	62	*/
	63	enum rc_filter_type {
	64	RC_FILTER_NORMAL = 0,
	65	RC_FILTER_WAKEUP,
	66
	67	RC_FILTER_MAX
	68	};
	69
9dfe4e83	70	/**
d8b4b582 DH	71	* struct rc_dev - represents a remote control device
d8b4b582 DH	72	* @dev: driver model's view of this device
ddbf7d5a	73	* @managed_alloc: devm_rc_allocate_device was used to create rc_dev
99b0f3c9	74	* @sysfs_groups: sysfs attribute groups
518f4b26	75	* @device_name: name of the rc child device
d8b4b582 DH	76	* @input_phys: physical path to the input child device
	77	* @input_id: id of the input child device (struct input_id)
	78	* @driver_name: name of the hardware driver which registered this device
	79	* @map_name: name of the default keymap
b088ba65	80	* @rc_map: current scan/key table
08aeb7c9 JW	81	* @lock: used to ensure we've filled in all protocol details before
08aeb7c9 JW	82	* anyone can call show_protocols or store_protocols
fcb13097	83	* @minor: unique minor remote control device number
d8b4b582 DH	84	* @raw: additional data for raw pulse/space devices
d8b4b582 DH	85	* @input_dev: the input child device used to communicate events to userspace
08aeb7c9	86	* @driver_type: specifies if protocol decoding is done in hardware or software
d8b4b582	87	* @idle: used to keep track of RX state
f423ccc1 JH	88	* @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed
f423ccc1 JH	89	* wakeup protocols is the set of all raw encoders
c5540fbb DH	90	* @allowed_protocols: bitmask with the supported RC_BIT_* protocols
	91	* @enabled_protocols: bitmask with the enabled RC_BIT_* protocols
	92	* @allowed_wakeup_protocols: bitmask with the supported RC_BIT_* wakeup protocols
0751d33c SY	93	* @wakeup_protocol: the enabled RC_TYPE_* wakeup protocol or
0751d33c SY	94	* RC_TYPE_UNKNOWN if disabled.
c5540fbb DH	95	* @scancode_filter: scancode filter
c5540fbb DH	96	* @scancode_wakeup_filter: scancode wakeup filters
9d2f1d3c	97	* @scancode_mask: some hardware decoders are not capable of providing the full
9dfe4e83 MCC	98	* scancode to the application. As this is a hardware limit, we can't do
	99	* anything with it. Yet, as the same keycode table can be used with other
	100	* devices, a mask is provided to allow its usage. Drivers should generally
	101	* leave this field in blank
9d2f1d3c	102	* @users: number of current users of the device
d8b4b582 DH	103	* @priv: driver-specific data
	104	* @keylock: protects the remaining members of the struct
	105	* @keypressed: whether a key is currently pressed
	106	* @keyup_jiffies: time (in jiffies) when the current keypress should be released
	107	* @timer_keyup: timer for releasing a keypress
	108	* @last_keycode: keycode of last keypress
120703f9	109	* @last_protocol: protocol of last keypress
d8b4b582 DH	110	* @last_scancode: scancode of last keypress
d8b4b582 DH	111	* @last_toggle: toggle value of last command
4a702ebf ML	112	* @timeout: optional time after which device stops sending data
	113	* @min_timeout: minimum timeout supported by device
	114	* @max_timeout: maximum timeout supported by device
e589333f ML	115	* @rx_resolution : resolution (in ns) of input sampler
e589333f ML	116	* @tx_resolution: resolution (in ns) of output sampler
9dfe4e83 MCC	117	* @change_protocol: allow changing the protocol used on hardware decoders
	118	* @open: callback to allow drivers to enable polling/irq when IR input device
	119	* is opened.
	120	* @close: callback to allow drivers to disable polling/irq when IR input device
	121	* is opened.
9b7c54d9 JW	122	* @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
9b7c54d9 JW	123	* @s_tx_carrier: set transmit carrier frequency
e589333f	124	* @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
fa810845	125	* @s_rx_carrier_range: inform driver about carrier it is expected to handle
9b7c54d9	126	* @tx_ir: transmit IR
d8b4b582 DH	127	* @s_idle: enable/disable hardware idle mode, upon which,
d8b4b582 DH	128	* device doesn't interrupt host until it sees IR pulses
e589333f	129	* @s_learning_mode: enable wide band receiver used for learning
4651918a	130	* @s_carrier_report: enable carrier reports
120703f9	131	* @s_filter: set the scancode filter
0751d33c SY	132	* @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero
	133	* then wakeup should be disabled. wakeup_protocol will be set to
	134	* a valid protocol if mask is nonzero.
4f253cec	135	* @s_timeout: set hardware timeout in ns
9dfe4e83	136	*/
d8b4b582 DH	137	struct rc_dev {
d8b4b582 DH	138	struct device dev;
ddbf7d5a	139	bool managed_alloc;
99b0f3c9	140	const struct attribute_group *sysfs_groups[5];
518f4b26	141	const char *device_name;
d8b4b582 DH	142	const char *input_phys;
d8b4b582 DH	143	struct input_id input_id;
518f4b26	144	const char *driver_name;
d8b4b582	145	const char *map_name;
08aeb7c9 JW	146	struct rc_map rc_map;
08aeb7c9 JW	147	struct mutex lock;
fcb13097	148	unsigned int minor;
d8b4b582 DH	149	struct ir_raw_event_ctrl *raw;
	150	struct input_dev *input_dev;
	151	enum rc_driver_type driver_type;
4a702ebf	152	bool idle;
f423ccc1	153	bool encode_wakeup;
c5540fbb DH	154	u64 allowed_protocols;
	155	u64 enabled_protocols;
	156	u64 allowed_wakeup_protocols;
0751d33c	157	enum rc_type wakeup_protocol;
c5540fbb DH	158	struct rc_scancode_filter scancode_filter;
c5540fbb DH	159	struct rc_scancode_filter scancode_wakeup_filter;
9d2f1d3c	160	u32 scancode_mask;
8b2ff320	161	u32 users;
d8b4b582 DH	162	void *priv;
	163	spinlock_t keylock;
	164	bool keypressed;
	165	unsigned long keyup_jiffies;
	166	struct timer_list timer_keyup;
	167	u32 last_keycode;
120703f9	168	enum rc_type last_protocol;
d8b4b582 DH	169	u32 last_scancode;
	170	u8 last_toggle;
	171	u32 timeout;
	172	u32 min_timeout;
	173	u32 max_timeout;
	174	u32 rx_resolution;
	175	u32 tx_resolution;
c003ab1b	176	int (change_protocol)(struct rc_dev dev, u64 *rc_type);
d8b4b582 DH	177	int (open)(struct rc_dev dev);
	178	void (close)(struct rc_dev dev);
	179	int (s_tx_mask)(struct rc_dev dev, u32 mask);
	180	int (s_tx_carrier)(struct rc_dev dev, u32 carrier);
	181	int (s_tx_duty_cycle)(struct rc_dev dev, u32 duty_cycle);
	182	int (s_rx_carrier_range)(struct rc_dev dev, u32 min, u32 max);
5588dc2b	183	int (tx_ir)(struct rc_dev dev, unsigned *txbuf, unsigned n);
d8b4b582 DH	184	void (s_idle)(struct rc_dev dev, bool enable);
	185	int (s_learning_mode)(struct rc_dev dev, int enable);
	186	int (s_carrier_report) (struct rc_dev dev, int enable);
00942d1a	187	int (s_filter)(struct rc_dev dev,
00942d1a	188	struct rc_scancode_filter *filter);
23c843b5 DH	189	int (s_wakeup_filter)(struct rc_dev dev,
23c843b5 DH	190	struct rc_scancode_filter *filter);
4f253cec SY	191	int (s_timeout)(struct rc_dev dev,
4f253cec SY	192	unsigned int timeout);
75543cce	193	};
a3572c34	194
ca86674b MCC	195	#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
	196
	197	/*
	198	* From rc-main.c
	199	* Those functions can be used on any type of Remote Controller. They
	200	* basically creates an input_dev and properly reports the device as a
	201	* Remote Controller, at sys/class/rc.
	202	*/
	203
5b6137dc MCC	204	/**
	205	* rc_allocate_device - Allocates a RC device
	206	*
0f7499fd	207	* @rc_driver_type: specifies the type of the RC output to be allocated
5b6137dc MCC	208	* returns a pointer to struct rc_dev.
5b6137dc MCC	209	*/
0f7499fd	210	struct rc_dev *rc_allocate_device(enum rc_driver_type);
5b6137dc	211
ddbf7d5a HK	212	/**
	213	* devm_rc_allocate_device - Managed RC device allocation
	214	*
	215	* @dev: pointer to struct device
0f7499fd	216	* @rc_driver_type: specifies the type of the RC output to be allocated
ddbf7d5a HK	217	* returns a pointer to struct rc_dev.
ddbf7d5a HK	218	*/
0f7499fd	219	struct rc_dev devm_rc_allocate_device(struct device dev, enum rc_driver_type);
ddbf7d5a	220
5b6137dc MCC	221	/**
	222	* rc_free_device - Frees a RC device
	223	*
	224	* @dev: pointer to struct rc_dev.
	225	*/
ca86674b	226	void rc_free_device(struct rc_dev *dev);
5b6137dc MCC	227
	228	/**
	229	* rc_register_device - Registers a RC device
	230	*
	231	* @dev: pointer to struct rc_dev.
	232	*/
ca86674b	233	int rc_register_device(struct rc_dev *dev);
5b6137dc	234
ddbf7d5a HK	235	/**
	236	* devm_rc_register_device - Manageded registering of a RC device
	237	*
	238	* @parent: pointer to struct device.
	239	* @dev: pointer to struct rc_dev.
	240	*/
	241	int devm_rc_register_device(struct device parent, struct rc_dev dev);
	242
5b6137dc MCC	243	/**
	244	* rc_unregister_device - Unregisters a RC device
	245	*
	246	* @dev: pointer to struct rc_dev.
	247	*/
ca86674b MCC	248	void rc_unregister_device(struct rc_dev *dev);
ca86674b MCC	249
5b6137dc MCC	250	/**
	251	* rc_open - Opens a RC device
	252	*
	253	* @rdev: pointer to struct rc_dev.
	254	*/
8b2ff320	255	int rc_open(struct rc_dev *rdev);
5b6137dc MCC	256
5b6137dc MCC	257	/**
e383ce07	258	* rc_close - Closes a RC device
5b6137dc MCC	259	*
	260	* @rdev: pointer to struct rc_dev.
	261	*/
8b2ff320 SK	262	void rc_close(struct rc_dev *rdev);
8b2ff320 SK	263
ca86674b	264	void rc_repeat(struct rc_dev *dev);
120703f9 DH	265	void rc_keydown(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
120703f9 DH	266	void rc_keydown_notimeout(struct rc_dev *dev, enum rc_type protocol, u32 scancode, u8 toggle);
ca86674b MCC	267	void rc_keyup(struct rc_dev *dev);
	268	u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
	269
	270	/*
	271	* From rc-raw.c
	272	* The Raw interface is specific to InfraRed. It may be a good idea to
	273	* split it later into a separate header.
	274	*/
	275
3f113e36 MCC	276	enum raw_event_type {
	277	IR_SPACE = (1 << 0),
	278	IR_PULSE = (1 << 1),
	279	IR_START_EVENT = (1 << 2),
	280	IR_STOP_EVENT = (1 << 3),
995187be MCC	281	};
995187be MCC	282
e40b1127	283	struct ir_raw_event {
4651918a ML	284	union {
4651918a ML	285	u32 duration;
5f61ff86	286	u32 carrier;
4651918a	287	};
5f61ff86	288	u8 duty_cycle;
4651918a ML	289
	290	unsigned pulse:1;
	291	unsigned reset:1;
	292	unsigned timeout:1;
	293	unsigned carrier_report:1;
e40b1127 DH	294	};
e40b1127 DH	295
5f61ff86	296	#define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {}
4651918a ML	297
	298	static inline void init_ir_raw_event(struct ir_raw_event *ev)
	299	{
	300	memset(ev, 0, sizeof(*ev));
	301	}
	302
c8e1bbc5	303	#define IR_DEFAULT_TIMEOUT MS_TO_NS(125)
6b20cf3c	304	#define IR_MAX_DURATION 500000000 /* 500 ms */
5aad7242 JW	305	#define US_TO_NS(usec) ((usec) * 1000)
	306	#define MS_TO_US(msec) ((msec) * 1000)
	307	#define MS_TO_NS(msec) ((msec) * 1000 * 1000)
e40b1127	308
d8b4b582 DH	309	void ir_raw_event_handle(struct rc_dev *dev);
	310	int ir_raw_event_store(struct rc_dev dev, struct ir_raw_event ev);
	311	int ir_raw_event_store_edge(struct rc_dev *dev, enum raw_event_type type);
	312	int ir_raw_event_store_with_filter(struct rc_dev *dev,
4a702ebf	313	struct ir_raw_event *ev);
d8b4b582	314	void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
3875233d JH	315	int ir_raw_encode_scancode(enum rc_type protocol, u32 scancode,
3875233d JH	316	struct ir_raw_event *events, unsigned int max);
4a702ebf	317
d8b4b582	318	static inline void ir_raw_event_reset(struct rc_dev *dev)
e40b1127	319	{
5f61ff86	320	struct ir_raw_event ev = { .reset = true };
4651918a	321
d8b4b582 DH	322	ir_raw_event_store(dev, &ev);
d8b4b582 DH	323	ir_raw_event_handle(dev);
e40b1127	324	}
724e2495	325
3ffea498 DH	326	/* extract mask bits out of data and pack them into the result */
	327	static inline u32 ir_extract_bits(u32 data, u32 mask)
	328	{
	329	u32 vbit = 1, value = 0;
	330
	331	do {
829ba9fe DH	332	if (mask & 1) {
	333	if (data & 1)
	334	value \|= vbit;
	335	vbit <<= 1;
	336	}
	337	data >>= 1;
3ffea498 DH	338	} while (mask >>= 1);
	339
	340	return value;
	341	}
	342
ca86674b	343	#endif /* _RC_CORE */