[mirror_ubuntu-bionic-kernel.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_PROTO_BIT_* protocols
 * @enabled_protocols: bitmask with the enabled RC_PROTO_BIT_* protocols
 * @allowed_wakeup_protocols: bitmask with the supported RC_PROTO_BIT_* wakeup
 *	protocols
 * @wakeup_protocol: the enabled RC_PROTO_* wakeup protocol or
 *	RC_PROTO_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_proto			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_proto			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_proto);
	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_proto protocol, u32 scancode,
		u8 toggle);
void rc_keydown_notimeout(struct rc_dev *dev, enum rc_proto 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.
 */
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, bool pulse);
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_proto 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;
}

/* Get NEC scancode and protocol type from address and command bytes */
static inline u32 ir_nec_bytes_to_scancode(u8 address, u8 not_address,
					   u8 command, u8 not_command,
					   enum rc_proto *protocol)
{
	u32 scancode;

	if ((command ^ not_command) != 0xff) {
		/* NEC transport, but modified protocol, used by at
		 * least Apple and TiVo remotes
		 */
		scancode = not_address << 24 |
			address     << 16 |
			not_command <<  8 |
			command;
		*protocol = RC_PROTO_NEC32;
	} else if ((address ^ not_address) != 0xff) {
		/* Extended NEC */
		scancode = address     << 16 |
			   not_address <<  8 |
			   command;
		*protocol = RC_PROTO_NECX;
	} else {
		/* Normal NEC */
		scancode = address << 8 | command;
		*protocol = RC_PROTO_NEC;
	}

	return scancode;
}

#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
6d741bfe SY	90	* @allowed_protocols: bitmask with the supported RC_PROTO_BIT_* protocols
	91	* @enabled_protocols: bitmask with the enabled RC_PROTO_BIT_* protocols
	92	* @allowed_wakeup_protocols: bitmask with the supported RC_PROTO_BIT_* wakeup
	93	* protocols
	94	* @wakeup_protocol: the enabled RC_PROTO_* wakeup protocol or
	95	* RC_PROTO_UNKNOWN if disabled.
c5540fbb DH	96	* @scancode_filter: scancode filter
c5540fbb DH	97	* @scancode_wakeup_filter: scancode wakeup filters
9d2f1d3c	98	* @scancode_mask: some hardware decoders are not capable of providing the full
9dfe4e83 MCC	99	* scancode to the application. As this is a hardware limit, we can't do
	100	* anything with it. Yet, as the same keycode table can be used with other
	101	* devices, a mask is provided to allow its usage. Drivers should generally
	102	* leave this field in blank
9d2f1d3c	103	* @users: number of current users of the device
d8b4b582 DH	104	* @priv: driver-specific data
	105	* @keylock: protects the remaining members of the struct
	106	* @keypressed: whether a key is currently pressed
	107	* @keyup_jiffies: time (in jiffies) when the current keypress should be released
	108	* @timer_keyup: timer for releasing a keypress
	109	* @last_keycode: keycode of last keypress
120703f9	110	* @last_protocol: protocol of last keypress
d8b4b582 DH	111	* @last_scancode: scancode of last keypress
d8b4b582 DH	112	* @last_toggle: toggle value of last command
4a702ebf ML	113	* @timeout: optional time after which device stops sending data
	114	* @min_timeout: minimum timeout supported by device
	115	* @max_timeout: maximum timeout supported by device
e589333f ML	116	* @rx_resolution : resolution (in ns) of input sampler
e589333f ML	117	* @tx_resolution: resolution (in ns) of output sampler
9dfe4e83 MCC	118	* @change_protocol: allow changing the protocol used on hardware decoders
	119	* @open: callback to allow drivers to enable polling/irq when IR input device
	120	* is opened.
	121	* @close: callback to allow drivers to disable polling/irq when IR input device
	122	* is opened.
9b7c54d9 JW	123	* @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
9b7c54d9 JW	124	* @s_tx_carrier: set transmit carrier frequency
e589333f	125	* @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
fa810845	126	* @s_rx_carrier_range: inform driver about carrier it is expected to handle
9b7c54d9	127	* @tx_ir: transmit IR
d8b4b582 DH	128	* @s_idle: enable/disable hardware idle mode, upon which,
d8b4b582 DH	129	* device doesn't interrupt host until it sees IR pulses
e589333f	130	* @s_learning_mode: enable wide band receiver used for learning
4651918a	131	* @s_carrier_report: enable carrier reports
120703f9	132	* @s_filter: set the scancode filter
0751d33c SY	133	* @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero
	134	* then wakeup should be disabled. wakeup_protocol will be set to
	135	* a valid protocol if mask is nonzero.
4f253cec	136	* @s_timeout: set hardware timeout in ns
9dfe4e83	137	*/
d8b4b582 DH	138	struct rc_dev {
d8b4b582 DH	139	struct device dev;
ddbf7d5a	140	bool managed_alloc;
99b0f3c9	141	const struct attribute_group *sysfs_groups[5];
518f4b26	142	const char *device_name;
d8b4b582 DH	143	const char *input_phys;
d8b4b582 DH	144	struct input_id input_id;
518f4b26	145	const char *driver_name;
d8b4b582	146	const char *map_name;
08aeb7c9 JW	147	struct rc_map rc_map;
08aeb7c9 JW	148	struct mutex lock;
fcb13097	149	unsigned int minor;
d8b4b582 DH	150	struct ir_raw_event_ctrl *raw;
	151	struct input_dev *input_dev;
	152	enum rc_driver_type driver_type;
4a702ebf	153	bool idle;
f423ccc1	154	bool encode_wakeup;
c5540fbb DH	155	u64 allowed_protocols;
	156	u64 enabled_protocols;
	157	u64 allowed_wakeup_protocols;
6d741bfe	158	enum rc_proto wakeup_protocol;
c5540fbb DH	159	struct rc_scancode_filter scancode_filter;
c5540fbb DH	160	struct rc_scancode_filter scancode_wakeup_filter;
9d2f1d3c	161	u32 scancode_mask;
8b2ff320	162	u32 users;
d8b4b582 DH	163	void *priv;
	164	spinlock_t keylock;
	165	bool keypressed;
	166	unsigned long keyup_jiffies;
	167	struct timer_list timer_keyup;
	168	u32 last_keycode;
6d741bfe	169	enum rc_proto last_protocol;
d8b4b582 DH	170	u32 last_scancode;
	171	u8 last_toggle;
	172	u32 timeout;
	173	u32 min_timeout;
	174	u32 max_timeout;
	175	u32 rx_resolution;
	176	u32 tx_resolution;
6d741bfe	177	int (change_protocol)(struct rc_dev dev, u64 *rc_proto);
d8b4b582 DH	178	int (open)(struct rc_dev dev);
	179	void (close)(struct rc_dev dev);
	180	int (s_tx_mask)(struct rc_dev dev, u32 mask);
	181	int (s_tx_carrier)(struct rc_dev dev, u32 carrier);
	182	int (s_tx_duty_cycle)(struct rc_dev dev, u32 duty_cycle);
	183	int (s_rx_carrier_range)(struct rc_dev dev, u32 min, u32 max);
5588dc2b	184	int (tx_ir)(struct rc_dev dev, unsigned *txbuf, unsigned n);
d8b4b582 DH	185	void (s_idle)(struct rc_dev dev, bool enable);
	186	int (s_learning_mode)(struct rc_dev dev, int enable);
	187	int (s_carrier_report) (struct rc_dev dev, int enable);
00942d1a	188	int (s_filter)(struct rc_dev dev,
00942d1a	189	struct rc_scancode_filter *filter);
23c843b5 DH	190	int (s_wakeup_filter)(struct rc_dev dev,
23c843b5 DH	191	struct rc_scancode_filter *filter);
4f253cec SY	192	int (s_timeout)(struct rc_dev dev,
4f253cec SY	193	unsigned int timeout);
75543cce	194	};
a3572c34	195
ca86674b MCC	196	#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
	197
	198	/*
	199	* From rc-main.c
	200	* Those functions can be used on any type of Remote Controller. They
	201	* basically creates an input_dev and properly reports the device as a
	202	* Remote Controller, at sys/class/rc.
	203	*/
	204
5b6137dc MCC	205	/**
	206	* rc_allocate_device - Allocates a RC device
	207	*
0f7499fd	208	* @rc_driver_type: specifies the type of the RC output to be allocated
5b6137dc MCC	209	* returns a pointer to struct rc_dev.
5b6137dc MCC	210	*/
0f7499fd	211	struct rc_dev *rc_allocate_device(enum rc_driver_type);
5b6137dc	212
ddbf7d5a HK	213	/**
	214	* devm_rc_allocate_device - Managed RC device allocation
	215	*
	216	* @dev: pointer to struct device
0f7499fd	217	* @rc_driver_type: specifies the type of the RC output to be allocated
ddbf7d5a HK	218	* returns a pointer to struct rc_dev.
ddbf7d5a HK	219	*/
0f7499fd	220	struct rc_dev devm_rc_allocate_device(struct device dev, enum rc_driver_type);
ddbf7d5a	221
5b6137dc MCC	222	/**
	223	* rc_free_device - Frees a RC device
	224	*
	225	* @dev: pointer to struct rc_dev.
	226	*/
ca86674b	227	void rc_free_device(struct rc_dev *dev);
5b6137dc MCC	228
	229	/**
	230	* rc_register_device - Registers a RC device
	231	*
	232	* @dev: pointer to struct rc_dev.
	233	*/
ca86674b	234	int rc_register_device(struct rc_dev *dev);
5b6137dc	235
ddbf7d5a HK	236	/**
	237	* devm_rc_register_device - Manageded registering of a RC device
	238	*
	239	* @parent: pointer to struct device.
	240	* @dev: pointer to struct rc_dev.
	241	*/
	242	int devm_rc_register_device(struct device parent, struct rc_dev dev);
	243
5b6137dc MCC	244	/**
	245	* rc_unregister_device - Unregisters a RC device
	246	*
	247	* @dev: pointer to struct rc_dev.
	248	*/
ca86674b MCC	249	void rc_unregister_device(struct rc_dev *dev);
ca86674b MCC	250
5b6137dc MCC	251	/**
	252	* rc_open - Opens a RC device
	253	*
	254	* @rdev: pointer to struct rc_dev.
	255	*/
8b2ff320	256	int rc_open(struct rc_dev *rdev);
5b6137dc MCC	257
5b6137dc MCC	258	/**
e383ce07	259	* rc_close - Closes a RC device
5b6137dc MCC	260	*
	261	* @rdev: pointer to struct rc_dev.
	262	*/
8b2ff320 SK	263	void rc_close(struct rc_dev *rdev);
8b2ff320 SK	264
ca86674b	265	void rc_repeat(struct rc_dev *dev);
6d741bfe SY	266	void rc_keydown(struct rc_dev *dev, enum rc_proto protocol, u32 scancode,
	267	u8 toggle);
	268	void rc_keydown_notimeout(struct rc_dev *dev, enum rc_proto protocol,
	269	u32 scancode, u8 toggle);
ca86674b MCC	270	void rc_keyup(struct rc_dev *dev);
	271	u32 rc_g_keycode_from_table(struct rc_dev *dev, u32 scancode);
	272
	273	/*
	274	* From rc-raw.c
	275	* The Raw interface is specific to InfraRed. It may be a good idea to
	276	* split it later into a separate header.
	277	*/
e40b1127	278	struct ir_raw_event {
4651918a ML	279	union {
4651918a ML	280	u32 duration;
5f61ff86	281	u32 carrier;
4651918a	282	};
5f61ff86	283	u8 duty_cycle;
4651918a ML	284
	285	unsigned pulse:1;
	286	unsigned reset:1;
	287	unsigned timeout:1;
	288	unsigned carrier_report:1;
e40b1127 DH	289	};
e40b1127 DH	290
5f61ff86	291	#define DEFINE_IR_RAW_EVENT(event) struct ir_raw_event event = {}
4651918a ML	292
	293	static inline void init_ir_raw_event(struct ir_raw_event *ev)
	294	{
	295	memset(ev, 0, sizeof(*ev));
	296	}
	297
c8e1bbc5	298	#define IR_DEFAULT_TIMEOUT MS_TO_NS(125)
6b20cf3c	299	#define IR_MAX_DURATION 500000000 /* 500 ms */
5aad7242 JW	300	#define US_TO_NS(usec) ((usec) * 1000)
	301	#define MS_TO_US(msec) ((msec) * 1000)
	302	#define MS_TO_NS(msec) ((msec) * 1000 * 1000)
e40b1127	303
d8b4b582 DH	304	void ir_raw_event_handle(struct rc_dev *dev);
d8b4b582 DH	305	int ir_raw_event_store(struct rc_dev dev, struct ir_raw_event ev);
86fe1ac0	306	int ir_raw_event_store_edge(struct rc_dev *dev, bool pulse);
d8b4b582	307	int ir_raw_event_store_with_filter(struct rc_dev *dev,
4a702ebf	308	struct ir_raw_event *ev);
d8b4b582	309	void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
6d741bfe	310	int ir_raw_encode_scancode(enum rc_proto protocol, u32 scancode,
3875233d	311	struct ir_raw_event *events, unsigned int max);
4a702ebf	312
d8b4b582	313	static inline void ir_raw_event_reset(struct rc_dev *dev)
e40b1127	314	{
5f61ff86	315	struct ir_raw_event ev = { .reset = true };
4651918a	316
d8b4b582 DH	317	ir_raw_event_store(dev, &ev);
d8b4b582 DH	318	ir_raw_event_handle(dev);
e40b1127	319	}
724e2495	320
3ffea498 DH	321	/* extract mask bits out of data and pack them into the result */
	322	static inline u32 ir_extract_bits(u32 data, u32 mask)
	323	{
	324	u32 vbit = 1, value = 0;
	325
	326	do {
829ba9fe DH	327	if (mask & 1) {
	328	if (data & 1)
	329	value \|= vbit;
	330	vbit <<= 1;
	331	}
	332	data >>= 1;
3ffea498 DH	333	} while (mask >>= 1);
	334
	335	return value;
	336	}
	337
e8ffda78 SG	338	/* Get NEC scancode and protocol type from address and command bytes */
	339	static inline u32 ir_nec_bytes_to_scancode(u8 address, u8 not_address,
	340	u8 command, u8 not_command,
6d741bfe	341	enum rc_proto *protocol)
e8ffda78 SG	342	{
	343	u32 scancode;
	344
	345	if ((command ^ not_command) != 0xff) {
	346	/* NEC transport, but modified protocol, used by at
	347	* least Apple and TiVo remotes
	348	*/
	349	scancode = not_address << 24 \|
	350	address << 16 \|
	351	not_command << 8 \|
	352	command;
6d741bfe	353	*protocol = RC_PROTO_NEC32;
e8ffda78 SG	354	} else if ((address ^ not_address) != 0xff) {
	355	/* Extended NEC */
	356	scancode = address << 16 \|
	357	not_address << 8 \|
	358	command;
6d741bfe	359	*protocol = RC_PROTO_NECX;
e8ffda78 SG	360	} else {
	361	/* Normal NEC */
	362	scancode = address << 8 \| command;
6d741bfe	363	*protocol = RC_PROTO_NEC;
e8ffda78 SG	364	}
	365
	366	return scancode;
	367	}
	368
ca86674b	369	#endif /* _RC_CORE */