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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Remote Controller core header
 *
 * Copyright (C) 2009-2010 by Mauro Carvalho Chehab
 */

#ifndef _RC_CORE
#define _RC_CORE

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

/**
 * enum rc_driver_type - type of the RC driver.
 *
 * @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 lirc_fh - represents an open lirc file
 * @list: list of open file handles
 * @rc: rcdev for this lirc chardev
 * @carrier_low: when setting the carrier range, first the low end must be
 *	set with an ioctl and then the high end with another ioctl
 * @send_timeout_reports: report timeouts in lirc raw IR.
 * @rawir: queue for incoming raw IR
 * @scancodes: queue for incoming decoded scancodes
 * @wait_poll: poll struct for lirc device
 * @send_mode: lirc mode for sending, either LIRC_MODE_SCANCODE or
 *	LIRC_MODE_PULSE
 * @rec_mode: lirc mode for receiving, either LIRC_MODE_SCANCODE or
 *	LIRC_MODE_MODE2
 */
struct lirc_fh {
	struct list_head list;
	struct rc_dev *rc;
	int				carrier_low;
	bool				send_timeout_reports;
	DECLARE_KFIFO_PTR(rawir, unsigned int);
	DECLARE_KFIFO_PTR(scancodes, struct lirc_scancode);
	wait_queue_head_t		wait_poll;
	u8				send_mode;
	u8				rec_mode;
};

/**
 * 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
 * @timer_repeat: timer for autorepeat events. This is needed for CEC, which
 *	has non-standard repeats.
 * @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 us) of input sampler
 * @tx_resolution: resolution (in us) of output sampler
 * @lirc_dev: lirc device
 * @lirc_cdev: lirc char cdev
 * @gap_start: time when gap starts
 * @gap_duration: duration of initial gap
 * @gap: true if we're in a gap
 * @lirc_fh_lock: protects lirc_fh list
 * @lirc_fh: list of open files
 * @registered: set to true by rc_register_device(), false by
 *	rc_unregister_device
 * @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_wideband_receiver: 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 us
 */
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;
	struct timer_list		timer_repeat;
	u32				last_keycode;
	enum rc_proto			last_protocol;
	u64				last_scancode;
	u8				last_toggle;
	u32				timeout;
	u32				min_timeout;
	u32				max_timeout;
	u32				rx_resolution;
	u32				tx_resolution;
#ifdef CONFIG_LIRC
	struct device			lirc_dev;
	struct cdev			lirc_cdev;
	ktime_t				gap_start;
	u64				gap_duration;
	bool				gap;
	spinlock_t			lirc_fh_lock;
	struct list_head		lirc_fh;
#endif
	bool				registered;
	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_wideband_receiver)(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);

void rc_repeat(struct rc_dev *dev);
void rc_keydown(struct rc_dev *dev, enum rc_proto protocol, u64 scancode,
		u8 toggle);
void rc_keydown_notimeout(struct rc_dev *dev, enum rc_proto protocol,
			  u64 scancode, u8 toggle);
void rc_keyup(struct rc_dev *dev);
u32 rc_g_keycode_from_table(struct rc_dev *dev, u64 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 US_TO_NS(usec)		((usec) * 1000)
#define MS_TO_US(msec)		((msec) * 1000)
#define IR_MAX_DURATION		MS_TO_US(500)
#define IR_DEFAULT_TIMEOUT	MS_TO_US(125)
#define IR_MAX_TIMEOUT		LIRC_VALUE_MASK

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);
int ir_raw_event_store_with_timeout(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);
int ir_raw_encode_carrier(enum rc_proto protocol);

static inline void ir_raw_event_reset(struct rc_dev *dev)
{
	ir_raw_event_store(dev, &((struct ir_raw_event) { .reset = true }));
	dev->idle = true;
	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
8e8e69d6	1	/* SPDX-License-Identifier: GPL-2.0-only */
446e4a64 MCC	2	/*
	3	* Remote Controller core header
	4	*
37e59f87	5	* Copyright (C) 2009-2010 by Mauro Carvalho Chehab
446e4a64 MCC	6	*/
446e4a64 MCC	7
ca86674b MCC	8	#ifndef _RC_CORE
ca86674b MCC	9	#define _RC_CORE
446e4a64	10
446e4a64	11	#include <linux/spinlock.h>
a6ddd4fe	12	#include <linux/cdev.h>
a3572c34 MCC	13	#include <linux/kfifo.h>
a3572c34 MCC	14	#include <linux/time.h>
9f154782	15	#include <linux/timer.h>
02858eed	16	#include <media/rc-map.h>
446e4a64	17
5b6137dc	18	/**
f4ab70e3	19	* enum rc_driver_type - type of the RC driver.
5b6137dc	20	*
f4ab70e3	21	* @RC_DRIVER_SCANCODE: Driver or hardware generates a scancode.
d34aee10 AS	22	* @RC_DRIVER_IR_RAW: Driver or hardware generates pulse/space sequences.
	23	* It needs a Infra-Red pulse/space decoder
	24	* @RC_DRIVER_IR_RAW_TX: Device transmitter only,
	25	* driver requires pulse/space data sequence.
5b6137dc	26	*/
626cf697	27	enum rc_driver_type {
5b6137dc MCC	28	RC_DRIVER_SCANCODE = 0,
5b6137dc MCC	29	RC_DRIVER_IR_RAW,
d34aee10	30	RC_DRIVER_IR_RAW_TX,
626cf697 MCC	31	};
626cf697 MCC	32
00942d1a JH	33	/**
	34	* struct rc_scancode_filter - Filter scan codes.
	35	* @data: Scancode data to match.
	36	* @mask: Mask of bits of scancode to compare.
	37	*/
	38	struct rc_scancode_filter {
	39	u32 data;
	40	u32 mask;
	41	};
	42
	43	/**
	44	* enum rc_filter_type - Filter type constants.
	45	* @RC_FILTER_NORMAL: Filter for normal operation.
	46	* @RC_FILTER_WAKEUP: Filter for waking from suspend.
	47	* @RC_FILTER_MAX: Number of filter types.
	48	*/
	49	enum rc_filter_type {
	50	RC_FILTER_NORMAL = 0,
	51	RC_FILTER_WAKEUP,
	52
	53	RC_FILTER_MAX
	54	};
	55
7e45d660 SY	56	/**
	57	* struct lirc_fh - represents an open lirc file
	58	* @list: list of open file handles
	59	* @rc: rcdev for this lirc chardev
	60	* @carrier_low: when setting the carrier range, first the low end must be
	61	* set with an ioctl and then the high end with another ioctl
	62	* @send_timeout_reports: report timeouts in lirc raw IR.
	63	* @rawir: queue for incoming raw IR
	64	* @scancodes: queue for incoming decoded scancodes
	65	* @wait_poll: poll struct for lirc device
	66	* @send_mode: lirc mode for sending, either LIRC_MODE_SCANCODE or
	67	* LIRC_MODE_PULSE
	68	* @rec_mode: lirc mode for receiving, either LIRC_MODE_SCANCODE or
	69	* LIRC_MODE_MODE2
	70	*/
	71	struct lirc_fh {
	72	struct list_head list;
	73	struct rc_dev *rc;
	74	int carrier_low;
	75	bool send_timeout_reports;
	76	DECLARE_KFIFO_PTR(rawir, unsigned int);
	77	DECLARE_KFIFO_PTR(scancodes, struct lirc_scancode);
	78	wait_queue_head_t wait_poll;
	79	u8 send_mode;
	80	u8 rec_mode;
	81	};
	82
9dfe4e83	83	/**
d8b4b582 DH	84	* struct rc_dev - represents a remote control device
d8b4b582 DH	85	* @dev: driver model's view of this device
ddbf7d5a	86	* @managed_alloc: devm_rc_allocate_device was used to create rc_dev
99b0f3c9	87	* @sysfs_groups: sysfs attribute groups
518f4b26	88	* @device_name: name of the rc child device
d8b4b582 DH	89	* @input_phys: physical path to the input child device
	90	* @input_id: id of the input child device (struct input_id)
	91	* @driver_name: name of the hardware driver which registered this device
	92	* @map_name: name of the default keymap
b088ba65	93	* @rc_map: current scan/key table
08aeb7c9 JW	94	* @lock: used to ensure we've filled in all protocol details before
08aeb7c9 JW	95	* anyone can call show_protocols or store_protocols
fcb13097	96	* @minor: unique minor remote control device number
d8b4b582 DH	97	* @raw: additional data for raw pulse/space devices
d8b4b582 DH	98	* @input_dev: the input child device used to communicate events to userspace
08aeb7c9	99	* @driver_type: specifies if protocol decoding is done in hardware or software
d8b4b582	100	* @idle: used to keep track of RX state
f423ccc1 JH	101	* @encode_wakeup: wakeup filtering uses IR encode API, therefore the allowed
f423ccc1 JH	102	* wakeup protocols is the set of all raw encoders
6d741bfe SY	103	* @allowed_protocols: bitmask with the supported RC_PROTO_BIT_* protocols
	104	* @enabled_protocols: bitmask with the enabled RC_PROTO_BIT_* protocols
	105	* @allowed_wakeup_protocols: bitmask with the supported RC_PROTO_BIT_* wakeup
	106	* protocols
	107	* @wakeup_protocol: the enabled RC_PROTO_* wakeup protocol or
	108	* RC_PROTO_UNKNOWN if disabled.
c5540fbb DH	109	* @scancode_filter: scancode filter
c5540fbb DH	110	* @scancode_wakeup_filter: scancode wakeup filters
9d2f1d3c	111	* @scancode_mask: some hardware decoders are not capable of providing the full
9dfe4e83 MCC	112	* scancode to the application. As this is a hardware limit, we can't do
	113	* anything with it. Yet, as the same keycode table can be used with other
	114	* devices, a mask is provided to allow its usage. Drivers should generally
	115	* leave this field in blank
9d2f1d3c	116	* @users: number of current users of the device
d8b4b582 DH	117	* @priv: driver-specific data
	118	* @keylock: protects the remaining members of the struct
	119	* @keypressed: whether a key is currently pressed
	120	* @keyup_jiffies: time (in jiffies) when the current keypress should be released
	121	* @timer_keyup: timer for releasing a keypress
57c642cb SY	122	* @timer_repeat: timer for autorepeat events. This is needed for CEC, which
57c642cb SY	123	* has non-standard repeats.
d8b4b582	124	* @last_keycode: keycode of last keypress
120703f9	125	* @last_protocol: protocol of last keypress
d8b4b582 DH	126	* @last_scancode: scancode of last keypress
d8b4b582 DH	127	* @last_toggle: toggle value of last command
4a702ebf ML	128	* @timeout: optional time after which device stops sending data
	129	* @min_timeout: minimum timeout supported by device
	130	* @max_timeout: maximum timeout supported by device
528222d8 SY	131	* @rx_resolution : resolution (in us) of input sampler
528222d8 SY	132	* @tx_resolution: resolution (in us) of output sampler
a6ddd4fe SY	133	* @lirc_dev: lirc device
a6ddd4fe SY	134	* @lirc_cdev: lirc char cdev
a60d64b1 SY	135	* @gap_start: time when gap starts
	136	* @gap_duration: duration of initial gap
	137	* @gap: true if we're in a gap
7e45d660 SY	138	* @lirc_fh_lock: protects lirc_fh list
7e45d660 SY	139	* @lirc_fh: list of open files
7790e81f SY	140	* @registered: set to true by rc_register_device(), false by
7790e81f SY	141	* rc_unregister_device
9dfe4e83 MCC	142	* @change_protocol: allow changing the protocol used on hardware decoders
	143	* @open: callback to allow drivers to enable polling/irq when IR input device
	144	* is opened.
	145	* @close: callback to allow drivers to disable polling/irq when IR input device
	146	* is opened.
9b7c54d9 JW	147	* @s_tx_mask: set transmitter mask (for devices with multiple tx outputs)
9b7c54d9 JW	148	* @s_tx_carrier: set transmit carrier frequency
e589333f	149	* @s_tx_duty_cycle: set transmit duty cycle (0% - 100%)
fa810845	150	* @s_rx_carrier_range: inform driver about carrier it is expected to handle
9b7c54d9	151	* @tx_ir: transmit IR
d8b4b582 DH	152	* @s_idle: enable/disable hardware idle mode, upon which,
d8b4b582 DH	153	* device doesn't interrupt host until it sees IR pulses
8b777edf	154	* @s_wideband_receiver: enable wide band receiver used for learning
4651918a	155	* @s_carrier_report: enable carrier reports
120703f9	156	* @s_filter: set the scancode filter
0751d33c SY	157	* @s_wakeup_filter: set the wakeup scancode filter. If the mask is zero
	158	* then wakeup should be disabled. wakeup_protocol will be set to
	159	* a valid protocol if mask is nonzero.
528222d8	160	* @s_timeout: set hardware timeout in us
9dfe4e83	161	*/
d8b4b582 DH	162	struct rc_dev {
d8b4b582 DH	163	struct device dev;
ddbf7d5a	164	bool managed_alloc;
99b0f3c9	165	const struct attribute_group *sysfs_groups[5];
518f4b26	166	const char *device_name;
d8b4b582 DH	167	const char *input_phys;
d8b4b582 DH	168	struct input_id input_id;
518f4b26	169	const char *driver_name;
d8b4b582	170	const char *map_name;
08aeb7c9 JW	171	struct rc_map rc_map;
08aeb7c9 JW	172	struct mutex lock;
fcb13097	173	unsigned int minor;
d8b4b582 DH	174	struct ir_raw_event_ctrl *raw;
	175	struct input_dev *input_dev;
	176	enum rc_driver_type driver_type;
4a702ebf	177	bool idle;
f423ccc1	178	bool encode_wakeup;
c5540fbb DH	179	u64 allowed_protocols;
	180	u64 enabled_protocols;
	181	u64 allowed_wakeup_protocols;
6d741bfe	182	enum rc_proto wakeup_protocol;
c5540fbb DH	183	struct rc_scancode_filter scancode_filter;
c5540fbb DH	184	struct rc_scancode_filter scancode_wakeup_filter;
9d2f1d3c	185	u32 scancode_mask;
8b2ff320	186	u32 users;
d8b4b582 DH	187	void *priv;
	188	spinlock_t keylock;
	189	bool keypressed;
	190	unsigned long keyup_jiffies;
	191	struct timer_list timer_keyup;
57c642cb	192	struct timer_list timer_repeat;
d8b4b582	193	u32 last_keycode;
6d741bfe	194	enum rc_proto last_protocol;
e6c6d7d4	195	u64 last_scancode;
d8b4b582 DH	196	u8 last_toggle;
	197	u32 timeout;
	198	u32 min_timeout;
	199	u32 max_timeout;
	200	u32 rx_resolution;
	201	u32 tx_resolution;
a60d64b1	202	#ifdef CONFIG_LIRC
a6ddd4fe SY	203	struct device lirc_dev;
a6ddd4fe SY	204	struct cdev lirc_cdev;
a60d64b1 SY	205	ktime_t gap_start;
	206	u64 gap_duration;
	207	bool gap;
7e45d660 SY	208	spinlock_t lirc_fh_lock;
7e45d660 SY	209	struct list_head lirc_fh;
a60d64b1	210	#endif
7790e81f	211	bool registered;
6d741bfe	212	int (change_protocol)(struct rc_dev dev, u64 *rc_proto);
d8b4b582 DH	213	int (open)(struct rc_dev dev);
	214	void (close)(struct rc_dev dev);
	215	int (s_tx_mask)(struct rc_dev dev, u32 mask);
	216	int (s_tx_carrier)(struct rc_dev dev, u32 carrier);
	217	int (s_tx_duty_cycle)(struct rc_dev dev, u32 duty_cycle);
	218	int (s_rx_carrier_range)(struct rc_dev dev, u32 min, u32 max);
5588dc2b	219	int (tx_ir)(struct rc_dev dev, unsigned *txbuf, unsigned n);
d8b4b582	220	void (s_idle)(struct rc_dev dev, bool enable);
8b777edf	221	int (s_wideband_receiver)(struct rc_dev dev, int enable);
d8b4b582	222	int (s_carrier_report) (struct rc_dev dev, int enable);
00942d1a	223	int (s_filter)(struct rc_dev dev,
00942d1a	224	struct rc_scancode_filter *filter);
23c843b5 DH	225	int (s_wakeup_filter)(struct rc_dev dev,
23c843b5 DH	226	struct rc_scancode_filter *filter);
4f253cec SY	227	int (s_timeout)(struct rc_dev dev,
4f253cec SY	228	unsigned int timeout);
75543cce	229	};
a3572c34	230
ca86674b MCC	231	#define to_rc_dev(d) container_of(d, struct rc_dev, dev)
	232
	233	/*
	234	* From rc-main.c
	235	* Those functions can be used on any type of Remote Controller. They
	236	* basically creates an input_dev and properly reports the device as a
	237	* Remote Controller, at sys/class/rc.
	238	*/
	239
5b6137dc MCC	240	/**
	241	* rc_allocate_device - Allocates a RC device
	242	*
0f7499fd	243	* @rc_driver_type: specifies the type of the RC output to be allocated
5b6137dc MCC	244	* returns a pointer to struct rc_dev.
5b6137dc MCC	245	*/
0f7499fd	246	struct rc_dev *rc_allocate_device(enum rc_driver_type);
5b6137dc	247
ddbf7d5a HK	248	/**
	249	* devm_rc_allocate_device - Managed RC device allocation
	250	*
	251	* @dev: pointer to struct device
0f7499fd	252	* @rc_driver_type: specifies the type of the RC output to be allocated
ddbf7d5a HK	253	* returns a pointer to struct rc_dev.
ddbf7d5a HK	254	*/
0f7499fd	255	struct rc_dev devm_rc_allocate_device(struct device dev, enum rc_driver_type);
ddbf7d5a	256
5b6137dc MCC	257	/**
	258	* rc_free_device - Frees a RC device
	259	*
	260	* @dev: pointer to struct rc_dev.
	261	*/
ca86674b	262	void rc_free_device(struct rc_dev *dev);
5b6137dc MCC	263
	264	/**
	265	* rc_register_device - Registers a RC device
	266	*
	267	* @dev: pointer to struct rc_dev.
	268	*/
ca86674b	269	int rc_register_device(struct rc_dev *dev);
5b6137dc	270
ddbf7d5a HK	271	/**
	272	* devm_rc_register_device - Manageded registering of a RC device
	273	*
	274	* @parent: pointer to struct device.
	275	* @dev: pointer to struct rc_dev.
	276	*/
	277	int devm_rc_register_device(struct device parent, struct rc_dev dev);
	278
5b6137dc MCC	279	/**
	280	* rc_unregister_device - Unregisters a RC device
	281	*
	282	* @dev: pointer to struct rc_dev.
	283	*/
ca86674b MCC	284	void rc_unregister_device(struct rc_dev *dev);
	285
	286	void rc_repeat(struct rc_dev *dev);
e6c6d7d4	287	void rc_keydown(struct rc_dev *dev, enum rc_proto protocol, u64 scancode,
6d741bfe SY	288	u8 toggle);
6d741bfe SY	289	void rc_keydown_notimeout(struct rc_dev *dev, enum rc_proto protocol,
e6c6d7d4	290	u64 scancode, u8 toggle);
ca86674b	291	void rc_keyup(struct rc_dev *dev);
e6c6d7d4	292	u32 rc_g_keycode_from_table(struct rc_dev *dev, u64 scancode);
ca86674b MCC	293
	294	/*
	295	* From rc-raw.c
	296	* The Raw interface is specific to InfraRed. It may be a good idea to
	297	* split it later into a separate header.
	298	*/
e40b1127	299	struct ir_raw_event {
4651918a ML	300	union {
4651918a ML	301	u32 duration;
5f61ff86	302	u32 carrier;
4651918a	303	};
5f61ff86	304	u8 duty_cycle;
4651918a ML	305
	306	unsigned pulse:1;
	307	unsigned reset:1;
	308	unsigned timeout:1;
	309	unsigned carrier_report:1;
e40b1127 DH	310	};
e40b1127 DH	311
5aad7242 JW	312	#define US_TO_NS(usec) ((usec) * 1000)
5aad7242 JW	313	#define MS_TO_US(msec) ((msec) * 1000)
528222d8 SY	314	#define IR_MAX_DURATION MS_TO_US(500)
528222d8 SY	315	#define IR_DEFAULT_TIMEOUT MS_TO_US(125)
50634548	316	#define IR_MAX_TIMEOUT LIRC_VALUE_MASK
e40b1127	317
d8b4b582 DH	318	void ir_raw_event_handle(struct rc_dev *dev);
d8b4b582 DH	319	int ir_raw_event_store(struct rc_dev dev, struct ir_raw_event ev);
86fe1ac0	320	int ir_raw_event_store_edge(struct rc_dev *dev, bool pulse);
d8b4b582	321	int ir_raw_event_store_with_filter(struct rc_dev *dev,
8d7a77ce SY	322	struct ir_raw_event *ev);
	323	int ir_raw_event_store_with_timeout(struct rc_dev *dev,
	324	struct ir_raw_event *ev);
d8b4b582	325	void ir_raw_event_set_idle(struct rc_dev *dev, bool idle);
6d741bfe	326	int ir_raw_encode_scancode(enum rc_proto protocol, u32 scancode,
3875233d	327	struct ir_raw_event *events, unsigned int max);
cdfaa01c	328	int ir_raw_encode_carrier(enum rc_proto protocol);
4a702ebf	329
d8b4b582	330	static inline void ir_raw_event_reset(struct rc_dev *dev)
e40b1127	331	{
183e19f5	332	ir_raw_event_store(dev, &((struct ir_raw_event) { .reset = true }));
e0d51e6c	333	dev->idle = true;
d8b4b582	334	ir_raw_event_handle(dev);
e40b1127	335	}
724e2495	336
3ffea498 DH	337	/* extract mask bits out of data and pack them into the result */
	338	static inline u32 ir_extract_bits(u32 data, u32 mask)
	339	{
	340	u32 vbit = 1, value = 0;
	341
	342	do {
829ba9fe DH	343	if (mask & 1) {
	344	if (data & 1)
	345	value \|= vbit;
	346	vbit <<= 1;
	347	}
	348	data >>= 1;
3ffea498 DH	349	} while (mask >>= 1);
	350
	351	return value;
	352	}
	353
e8ffda78 SG	354	/* Get NEC scancode and protocol type from address and command bytes */
	355	static inline u32 ir_nec_bytes_to_scancode(u8 address, u8 not_address,
	356	u8 command, u8 not_command,
6d741bfe	357	enum rc_proto *protocol)
e8ffda78 SG	358	{
	359	u32 scancode;
	360
	361	if ((command ^ not_command) != 0xff) {
	362	/* NEC transport, but modified protocol, used by at
	363	* least Apple and TiVo remotes
	364	*/
	365	scancode = not_address << 24 \|
	366	address << 16 \|
	367	not_command << 8 \|
	368	command;
6d741bfe	369	*protocol = RC_PROTO_NEC32;
e8ffda78 SG	370	} else if ((address ^ not_address) != 0xff) {
	371	/* Extended NEC */
	372	scancode = address << 16 \|
	373	not_address << 8 \|
	374	command;
6d741bfe	375	*protocol = RC_PROTO_NECX;
e8ffda78 SG	376	} else {
	377	/* Normal NEC */
	378	scancode = address << 8 \| command;
6d741bfe	379	*protocol = RC_PROTO_NEC;
e8ffda78 SG	380	}
	381
	382	return scancode;
	383	}
	384
ca86674b	385	#endif /* _RC_CORE */