[linux-block.git] / drivers / hid / hid-wiimote.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
#ifndef __HID_WIIMOTE_H
#define __HID_WIIMOTE_H

/*
 * HID driver for Nintendo Wii / Wii U peripherals
 * Copyright (c) 2011-2013 David Herrmann <dh.herrmann@gmail.com>
 */

/*
 */

#include <linux/completion.h>
#include <linux/device.h>
#include <linux/hid.h>
#include <linux/input.h>
#include <linux/leds.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/power_supply.h>
#include <linux/spinlock.h>
#include <linux/timer.h>

#define WIIMOTE_NAME "Nintendo Wii Remote"
#define WIIMOTE_BUFSIZE 32

#define WIIPROTO_FLAG_LED1		0x01
#define WIIPROTO_FLAG_LED2		0x02
#define WIIPROTO_FLAG_LED3		0x04
#define WIIPROTO_FLAG_LED4		0x08
#define WIIPROTO_FLAG_RUMBLE		0x10
#define WIIPROTO_FLAG_ACCEL		0x20
#define WIIPROTO_FLAG_IR_BASIC		0x40
#define WIIPROTO_FLAG_IR_EXT		0x80
#define WIIPROTO_FLAG_IR_FULL		0xc0 /* IR_BASIC | IR_EXT */
#define WIIPROTO_FLAG_EXT_PLUGGED	0x0100
#define WIIPROTO_FLAG_EXT_USED		0x0200
#define WIIPROTO_FLAG_EXT_ACTIVE	0x0400
#define WIIPROTO_FLAG_MP_PLUGGED	0x0800
#define WIIPROTO_FLAG_MP_USED		0x1000
#define WIIPROTO_FLAG_MP_ACTIVE		0x2000
#define WIIPROTO_FLAG_EXITING		0x4000
#define WIIPROTO_FLAG_DRM_LOCKED	0x8000
#define WIIPROTO_FLAG_BUILTIN_MP	0x010000
#define WIIPROTO_FLAG_NO_MP		0x020000
#define WIIPROTO_FLAG_PRO_CALIB_DONE	0x040000

#define WIIPROTO_FLAGS_LEDS (WIIPROTO_FLAG_LED1 | WIIPROTO_FLAG_LED2 | \
					WIIPROTO_FLAG_LED3 | WIIPROTO_FLAG_LED4)
#define WIIPROTO_FLAGS_IR (WIIPROTO_FLAG_IR_BASIC | WIIPROTO_FLAG_IR_EXT | \
							WIIPROTO_FLAG_IR_FULL)

/* return flag for led \num */
#define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1))

enum wiiproto_keys {
	WIIPROTO_KEY_LEFT,
	WIIPROTO_KEY_RIGHT,
	WIIPROTO_KEY_UP,
	WIIPROTO_KEY_DOWN,
	WIIPROTO_KEY_PLUS,
	WIIPROTO_KEY_MINUS,
	WIIPROTO_KEY_ONE,
	WIIPROTO_KEY_TWO,
	WIIPROTO_KEY_A,
	WIIPROTO_KEY_B,
	WIIPROTO_KEY_HOME,
	WIIPROTO_KEY_COUNT
};

enum wiimote_devtype {
	WIIMOTE_DEV_PENDING,
	WIIMOTE_DEV_UNKNOWN,
	WIIMOTE_DEV_GENERIC,
	WIIMOTE_DEV_GEN10,
	WIIMOTE_DEV_GEN20,
	WIIMOTE_DEV_BALANCE_BOARD,
	WIIMOTE_DEV_PRO_CONTROLLER,
	WIIMOTE_DEV_NUM,
};

enum wiimote_exttype {
	WIIMOTE_EXT_NONE,
	WIIMOTE_EXT_UNKNOWN,
	WIIMOTE_EXT_NUNCHUK,
	WIIMOTE_EXT_CLASSIC_CONTROLLER,
	WIIMOTE_EXT_BALANCE_BOARD,
	WIIMOTE_EXT_PRO_CONTROLLER,
	WIIMOTE_EXT_DRUMS,
	WIIMOTE_EXT_GUITAR,
	WIIMOTE_EXT_TURNTABLE,
	WIIMOTE_EXT_NUM,
};

enum wiimote_mptype {
	WIIMOTE_MP_NONE,
	WIIMOTE_MP_UNKNOWN,
	WIIMOTE_MP_SINGLE,
	WIIMOTE_MP_PASSTHROUGH_NUNCHUK,
	WIIMOTE_MP_PASSTHROUGH_CLASSIC,
};

struct wiimote_buf {
	__u8 data[HID_MAX_BUFFER_SIZE];
	size_t size;
};

struct wiimote_queue {
	spinlock_t lock;
	struct work_struct worker;
	__u8 head;
	__u8 tail;
	struct wiimote_buf outq[WIIMOTE_BUFSIZE];
};

struct wiimote_state {
	spinlock_t lock;
	__u32 flags;
	__u8 accel_split[2];
	__u8 drm;
	__u8 devtype;
	__u8 exttype;
	__u8 mp;

	/* synchronous cmd requests */
	struct mutex sync;
	struct completion ready;
	int cmd;
	__u32 opt;

	/* results of synchronous requests */
	__u8 cmd_battery;
	__u8 cmd_err;
	__u8 *cmd_read_buf;
	__u8 cmd_read_size;

	/* calibration/cache data */
	__u16 calib_bboard[4][3];
	__s16 calib_pro_sticks[4];
	__u8 pressure_drums[7];
	__u8 cache_rumble;
};

struct wiimote_data {
	struct hid_device *hdev;
	struct input_dev *input;
	struct work_struct rumble_worker;
	struct led_classdev *leds[4];
	struct input_dev *accel;
	struct input_dev *ir;
	struct power_supply *battery;
	struct power_supply_desc battery_desc;
	struct input_dev *mp;
	struct timer_list timer;
	struct wiimote_debug *debug;

	union {
		struct input_dev *input;
	} extension;

	struct wiimote_queue queue;
	struct wiimote_state state;
	struct work_struct init_worker;
};

extern bool wiimote_dpad_as_analog;

/* wiimote modules */

enum wiimod_module {
	WIIMOD_KEYS,
	WIIMOD_RUMBLE,
	WIIMOD_BATTERY,
	WIIMOD_LED1,
	WIIMOD_LED2,
	WIIMOD_LED3,
	WIIMOD_LED4,
	WIIMOD_ACCEL,
	WIIMOD_IR,
	WIIMOD_BUILTIN_MP,
	WIIMOD_NO_MP,
	WIIMOD_NUM,
	WIIMOD_NULL = WIIMOD_NUM,
};

#define WIIMOD_FLAG_INPUT		0x0001
#define WIIMOD_FLAG_EXT8		0x0002
#define WIIMOD_FLAG_EXT16		0x0004

struct wiimod_ops {
	__u16 flags;
	unsigned long arg;
	int (*probe) (const struct wiimod_ops *ops,
		      struct wiimote_data *wdata);
	void (*remove) (const struct wiimod_ops *ops,
			struct wiimote_data *wdata);

	void (*in_keys) (struct wiimote_data *wdata, const __u8 *keys);
	void (*in_accel) (struct wiimote_data *wdata, const __u8 *accel);
	void (*in_ir) (struct wiimote_data *wdata, const __u8 *ir, bool packed,
		       unsigned int id);
	void (*in_mp) (struct wiimote_data *wdata, const __u8 *mp);
	void (*in_ext) (struct wiimote_data *wdata, const __u8 *ext);
};

extern const struct wiimod_ops *wiimod_table[WIIMOD_NUM];
extern const struct wiimod_ops *wiimod_ext_table[WIIMOTE_EXT_NUM];
extern const struct wiimod_ops wiimod_mp;

/* wiimote requests */

enum wiiproto_reqs {
	WIIPROTO_REQ_NULL = 0x0,
	WIIPROTO_REQ_RUMBLE = 0x10,
	WIIPROTO_REQ_LED = 0x11,
	WIIPROTO_REQ_DRM = 0x12,
	WIIPROTO_REQ_IR1 = 0x13,
	WIIPROTO_REQ_SREQ = 0x15,
	WIIPROTO_REQ_WMEM = 0x16,
	WIIPROTO_REQ_RMEM = 0x17,
	WIIPROTO_REQ_IR2 = 0x1a,
	WIIPROTO_REQ_STATUS = 0x20,
	WIIPROTO_REQ_DATA = 0x21,
	WIIPROTO_REQ_RETURN = 0x22,

	/* DRM_K: BB*2 */
	WIIPROTO_REQ_DRM_K = 0x30,

	/* DRM_KA: BB*2 AA*3 */
	WIIPROTO_REQ_DRM_KA = 0x31,

	/* DRM_KE: BB*2 EE*8 */
	WIIPROTO_REQ_DRM_KE = 0x32,

	/* DRM_KAI: BB*2 AA*3 II*12 */
	WIIPROTO_REQ_DRM_KAI = 0x33,

	/* DRM_KEE: BB*2 EE*19 */
	WIIPROTO_REQ_DRM_KEE = 0x34,

	/* DRM_KAE: BB*2 AA*3 EE*16 */
	WIIPROTO_REQ_DRM_KAE = 0x35,

	/* DRM_KIE: BB*2 II*10 EE*9 */
	WIIPROTO_REQ_DRM_KIE = 0x36,

	/* DRM_KAIE: BB*2 AA*3 II*10 EE*6 */
	WIIPROTO_REQ_DRM_KAIE = 0x37,

	/* DRM_E: EE*21 */
	WIIPROTO_REQ_DRM_E = 0x3d,

	/* DRM_SKAI1: BB*2 AA*1 II*18 */
	WIIPROTO_REQ_DRM_SKAI1 = 0x3e,

	/* DRM_SKAI2: BB*2 AA*1 II*18 */
	WIIPROTO_REQ_DRM_SKAI2 = 0x3f,

	WIIPROTO_REQ_MAX
};

#define dev_to_wii(pdev) hid_get_drvdata(to_hid_device(pdev))

void __wiimote_schedule(struct wiimote_data *wdata);

extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm);
extern void wiiproto_req_rumble(struct wiimote_data *wdata, __u8 rumble);
extern void wiiproto_req_leds(struct wiimote_data *wdata, int leds);
extern void wiiproto_req_status(struct wiimote_data *wdata);
extern void wiiproto_req_accel(struct wiimote_data *wdata, __u8 accel);
extern void wiiproto_req_ir1(struct wiimote_data *wdata, __u8 flags);
extern void wiiproto_req_ir2(struct wiimote_data *wdata, __u8 flags);
extern int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset,
						const __u8 *wmem, __u8 size);
extern ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset,
							__u8 *rmem, __u8 size);

#define wiiproto_req_rreg(wdata, os, sz) \
				wiiproto_req_rmem((wdata), false, (os), (sz))
#define wiiproto_req_reeprom(wdata, os, sz) \
				wiiproto_req_rmem((wdata), true, (os), (sz))
extern void wiiproto_req_rmem(struct wiimote_data *wdata, bool eeprom,
						__u32 offset, __u16 size);

#ifdef CONFIG_DEBUG_FS

extern int wiidebug_init(struct wiimote_data *wdata);
extern void wiidebug_deinit(struct wiimote_data *wdata);

#else

static inline int wiidebug_init(void *u) { return 0; }
static inline void wiidebug_deinit(void *u) { }

#endif

/* requires the state.lock spinlock to be held */
static inline bool wiimote_cmd_pending(struct wiimote_data *wdata, int cmd,
								__u32 opt)
{
	return wdata->state.cmd == cmd && wdata->state.opt == opt;
}

/* requires the state.lock spinlock to be held */
static inline void wiimote_cmd_complete(struct wiimote_data *wdata)
{
	wdata->state.cmd = WIIPROTO_REQ_NULL;
	complete(&wdata->state.ready);
}

/* requires the state.lock spinlock to be held */
static inline void wiimote_cmd_abort(struct wiimote_data *wdata)
{
	/* Abort synchronous request by waking up the sleeping caller. But
	 * reset the state.cmd field to an invalid value so no further event
	 * handlers will work with it. */
	wdata->state.cmd = WIIPROTO_REQ_MAX;
	complete(&wdata->state.ready);
}

static inline int wiimote_cmd_acquire(struct wiimote_data *wdata)
{
	return mutex_lock_interruptible(&wdata->state.sync) ? -ERESTARTSYS : 0;
}

static inline void wiimote_cmd_acquire_noint(struct wiimote_data *wdata)
{
	mutex_lock(&wdata->state.sync);
}

/* requires the state.lock spinlock to be held */
static inline void wiimote_cmd_set(struct wiimote_data *wdata, int cmd,
								__u32 opt)
{
	reinit_completion(&wdata->state.ready);
	wdata->state.cmd = cmd;
	wdata->state.opt = opt;
}

static inline void wiimote_cmd_release(struct wiimote_data *wdata)
{
	mutex_unlock(&wdata->state.sync);
}

static inline int wiimote_cmd_wait(struct wiimote_data *wdata)
{
	int ret;

	/* The completion acts as implicit memory barrier so we can safely
	 * assume that state.cmd is set on success/failure and isn't accessed
	 * by any other thread, anymore. */

	ret = wait_for_completion_interruptible_timeout(&wdata->state.ready, HZ);
	if (ret < 0)
		return -ERESTARTSYS;
	else if (ret == 0)
		return -EIO;
	else if (wdata->state.cmd != WIIPROTO_REQ_NULL)
		return -EIO;
	else
		return 0;
}

static inline int wiimote_cmd_wait_noint(struct wiimote_data *wdata)
{
	unsigned long ret;

	/* no locking needed; see wiimote_cmd_wait() */
	ret = wait_for_completion_timeout(&wdata->state.ready, HZ);
	if (!ret)
		return -EIO;
	else if (wdata->state.cmd != WIIPROTO_REQ_NULL)
		return -EIO;
	else
		return 0;
}

#endif
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
7e274400 DH	2	#ifndef __HID_WIIMOTE_H
	3	#define __HID_WIIMOTE_H
	4
	5	/*
92eda7e4 DH	6	* HID driver for Nintendo Wii / Wii U peripherals
92eda7e4 DH	7	* Copyright (c) 2011-2013 David Herrmann <dh.herrmann@gmail.com>
7e274400 DH	8	*/
	9
	10	/*
7e274400 DH	11	*/
	12
	13	#include <linux/completion.h>
	14	#include <linux/device.h>
	15	#include <linux/hid.h>
	16	#include <linux/input.h>
	17	#include <linux/leds.h>
	18	#include <linux/module.h>
	19	#include <linux/mutex.h>
	20	#include <linux/power_supply.h>
	21	#include <linux/spinlock.h>
4148b6bf	22	#include <linux/timer.h>
7e274400 DH	23
	24	#define WIIMOTE_NAME "Nintendo Wii Remote"
	25	#define WIIMOTE_BUFSIZE 32
	26
	27	#define WIIPROTO_FLAG_LED1 0x01
	28	#define WIIPROTO_FLAG_LED2 0x02
	29	#define WIIPROTO_FLAG_LED3 0x04
	30	#define WIIPROTO_FLAG_LED4 0x08
	31	#define WIIPROTO_FLAG_RUMBLE 0x10
	32	#define WIIPROTO_FLAG_ACCEL 0x20
	33	#define WIIPROTO_FLAG_IR_BASIC 0x40
	34	#define WIIPROTO_FLAG_IR_EXT 0x80
	35	#define WIIPROTO_FLAG_IR_FULL 0xc0 /* IR_BASIC \| IR_EXT */
c57ff761	36	#define WIIPROTO_FLAG_EXT_PLUGGED 0x0100
4148b6bf DH	37	#define WIIPROTO_FLAG_EXT_USED 0x0200
	38	#define WIIPROTO_FLAG_EXT_ACTIVE 0x0400
	39	#define WIIPROTO_FLAG_MP_PLUGGED 0x0800
	40	#define WIIPROTO_FLAG_MP_USED 0x1000
	41	#define WIIPROTO_FLAG_MP_ACTIVE 0x2000
	42	#define WIIPROTO_FLAG_EXITING 0x4000
d76f89e1	43	#define WIIPROTO_FLAG_DRM_LOCKED 0x8000
9f329741 DH	44	#define WIIPROTO_FLAG_BUILTIN_MP 0x010000
9f329741 DH	45	#define WIIPROTO_FLAG_NO_MP 0x020000
08072dde	46	#define WIIPROTO_FLAG_PRO_CALIB_DONE 0x040000
c57ff761	47
7e274400 DH	48	#define WIIPROTO_FLAGS_LEDS (WIIPROTO_FLAG_LED1 \| WIIPROTO_FLAG_LED2 \| \
	49	WIIPROTO_FLAG_LED3 \| WIIPROTO_FLAG_LED4)
	50	#define WIIPROTO_FLAGS_IR (WIIPROTO_FLAG_IR_BASIC \| WIIPROTO_FLAG_IR_EXT \| \
	51	WIIPROTO_FLAG_IR_FULL)
	52
	53	/* return flag for led \num */
	54	#define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1))
	55
20cef813 DH	56	enum wiiproto_keys {
	57	WIIPROTO_KEY_LEFT,
	58	WIIPROTO_KEY_RIGHT,
	59	WIIPROTO_KEY_UP,
	60	WIIPROTO_KEY_DOWN,
	61	WIIPROTO_KEY_PLUS,
	62	WIIPROTO_KEY_MINUS,
	63	WIIPROTO_KEY_ONE,
	64	WIIPROTO_KEY_TWO,
	65	WIIPROTO_KEY_A,
	66	WIIPROTO_KEY_B,
	67	WIIPROTO_KEY_HOME,
	68	WIIPROTO_KEY_COUNT
	69	};
	70
c57ff761 DH	71	enum wiimote_devtype {
	72	WIIMOTE_DEV_PENDING,
	73	WIIMOTE_DEV_UNKNOWN,
	74	WIIMOTE_DEV_GENERIC,
	75	WIIMOTE_DEV_GEN10,
	76	WIIMOTE_DEV_GEN20,
f1d4bed4	77	WIIMOTE_DEV_BALANCE_BOARD,
b8e0fe31	78	WIIMOTE_DEV_PRO_CONTROLLER,
c57ff761 DH	79	WIIMOTE_DEV_NUM,
	80	};
	81
	82	enum wiimote_exttype {
	83	WIIMOTE_EXT_NONE,
	84	WIIMOTE_EXT_UNKNOWN,
b6ee67b3	85	WIIMOTE_EXT_NUNCHUK,
9d6f9ecb	86	WIIMOTE_EXT_CLASSIC_CONTROLLER,
f1d4bed4	87	WIIMOTE_EXT_BALANCE_BOARD,
b8e0fe31	88	WIIMOTE_EXT_PRO_CONTROLLER,
d4bdf2d2 NAL	89	WIIMOTE_EXT_DRUMS,
d4bdf2d2 NAL	90	WIIMOTE_EXT_GUITAR,
05086f3d	91	WIIMOTE_EXT_TURNTABLE,
c57ff761 DH	92	WIIMOTE_EXT_NUM,
	93	};
	94
4148b6bf DH	95	enum wiimote_mptype {
	96	WIIMOTE_MP_NONE,
	97	WIIMOTE_MP_UNKNOWN,
	98	WIIMOTE_MP_SINGLE,
	99	WIIMOTE_MP_PASSTHROUGH_NUNCHUK,
	100	WIIMOTE_MP_PASSTHROUGH_CLASSIC,
	101	};
	102
7e274400 DH	103	struct wiimote_buf {
	104	__u8 data[HID_MAX_BUFFER_SIZE];
	105	size_t size;
	106	};
	107
13938538 DH	108	struct wiimote_queue {
	109	spinlock_t lock;
	110	struct work_struct worker;
	111	__u8 head;
	112	__u8 tail;
	113	struct wiimote_buf outq[WIIMOTE_BUFSIZE];
	114	};
	115
7e274400 DH	116	struct wiimote_state {
7e274400 DH	117	spinlock_t lock;
c57ff761	118	__u32 flags;
7e274400	119	__u8 accel_split[2];
43d782ae	120	__u8 drm;
c57ff761	121	__u8 devtype;
4148b6bf DH	122	__u8 exttype;
4148b6bf DH	123	__u8 mp;
7e274400 DH	124
	125	/* synchronous cmd requests */
	126	struct mutex sync;
	127	struct completion ready;
	128	int cmd;
	129	__u32 opt;
	130
	131	/* results of synchronous requests */
	132	__u8 cmd_battery;
	133	__u8 cmd_err;
fad8c0e3 DH	134	__u8 *cmd_read_buf;
fad8c0e3 DH	135	__u8 cmd_read_size;
f1d4bed4	136
f50f9aab	137	/* calibration/cache data */
f1d4bed4	138	__u16 calib_bboard[4][3];
08072dde	139	__s16 calib_pro_sticks[4];
d4bdf2d2	140	__u8 pressure_drums[7];
f50f9aab	141	__u8 cache_rumble;
7e274400 DH	142	};
	143
	144	struct wiimote_data {
	145	struct hid_device *hdev;
	146	struct input_dev *input;
f50f9aab	147	struct work_struct rumble_worker;
7e274400 DH	148	struct led_classdev *leds[4];
	149	struct input_dev *accel;
	150	struct input_dev *ir;
297d716f KK	151	struct power_supply *battery;
297d716f KK	152	struct power_supply_desc battery_desc;
34472d37	153	struct input_dev *mp;
4148b6bf	154	struct timer_list timer;
43e5e7c6	155	struct wiimote_debug *debug;
7e274400	156
f1d4bed4 DH	157	union {
	158	struct input_dev *input;
	159	} extension;
	160
13938538	161	struct wiimote_queue queue;
7e274400	162	struct wiimote_state state;
c57ff761	163	struct work_struct init_worker;
7e274400 DH	164	};
7e274400 DH	165
a8cbf80e DM	166	extern bool wiimote_dpad_as_analog;
a8cbf80e DM	167
27f06942 DH	168	/* wiimote modules */
	169
	170	enum wiimod_module {
20cef813 DH	171	WIIMOD_KEYS,
20cef813 DH	172	WIIMOD_RUMBLE,
dcf39231	173	WIIMOD_BATTERY,
6c5ae018 DH	174	WIIMOD_LED1,
	175	WIIMOD_LED2,
	176	WIIMOD_LED3,
	177	WIIMOD_LED4,
0ea16757	178	WIIMOD_ACCEL,
3b5f03c4	179	WIIMOD_IR,
9f329741 DH	180	WIIMOD_BUILTIN_MP,
9f329741 DH	181	WIIMOD_NO_MP,
27f06942 DH	182	WIIMOD_NUM,
	183	WIIMOD_NULL = WIIMOD_NUM,
	184	};
	185
	186	#define WIIMOD_FLAG_INPUT 0x0001
4148b6bf DH	187	#define WIIMOD_FLAG_EXT8 0x0002
4148b6bf DH	188	#define WIIMOD_FLAG_EXT16 0x0004
27f06942 DH	189
	190	struct wiimod_ops {
	191	__u16 flags;
	192	unsigned long arg;
	193	int (probe) (const struct wiimod_ops ops,
	194	struct wiimote_data *wdata);
	195	void (remove) (const struct wiimod_ops ops,
	196	struct wiimote_data *wdata);
	197
	198	void (in_keys) (struct wiimote_data wdata, const __u8 *keys);
	199	void (in_accel) (struct wiimote_data wdata, const __u8 *accel);
	200	void (in_ir) (struct wiimote_data wdata, const __u8 *ir, bool packed,
	201	unsigned int id);
4148b6bf DH	202	void (in_mp) (struct wiimote_data wdata, const __u8 *mp);
4148b6bf DH	203	void (in_ext) (struct wiimote_data wdata, const __u8 *ext);
27f06942 DH	204	};
	205
	206	extern const struct wiimod_ops *wiimod_table[WIIMOD_NUM];
4148b6bf DH	207	extern const struct wiimod_ops *wiimod_ext_table[WIIMOTE_EXT_NUM];
4148b6bf DH	208	extern const struct wiimod_ops wiimod_mp;
27f06942 DH	209
	210	/* wiimote requests */
	211
7e274400 DH	212	enum wiiproto_reqs {
	213	WIIPROTO_REQ_NULL = 0x0,
	214	WIIPROTO_REQ_RUMBLE = 0x10,
	215	WIIPROTO_REQ_LED = 0x11,
	216	WIIPROTO_REQ_DRM = 0x12,
	217	WIIPROTO_REQ_IR1 = 0x13,
	218	WIIPROTO_REQ_SREQ = 0x15,
	219	WIIPROTO_REQ_WMEM = 0x16,
	220	WIIPROTO_REQ_RMEM = 0x17,
	221	WIIPROTO_REQ_IR2 = 0x1a,
	222	WIIPROTO_REQ_STATUS = 0x20,
	223	WIIPROTO_REQ_DATA = 0x21,
	224	WIIPROTO_REQ_RETURN = 0x22,
4148b6bf DH	225
4148b6bf DH	226	/* DRM_K: BB2 /
7e274400	227	WIIPROTO_REQ_DRM_K = 0x30,
4148b6bf DH	228
4148b6bf DH	229	/* DRM_KA: BB2 AA3 */
7e274400	230	WIIPROTO_REQ_DRM_KA = 0x31,
4148b6bf DH	231
4148b6bf DH	232	/* DRM_KE: BB2 EE8 */
7e274400	233	WIIPROTO_REQ_DRM_KE = 0x32,
4148b6bf DH	234
4148b6bf DH	235	/* DRM_KAI: BB2 AA3 II12 /
7e274400	236	WIIPROTO_REQ_DRM_KAI = 0x33,
4148b6bf DH	237
4148b6bf DH	238	/* DRM_KEE: BB2 EE19 */
7e274400	239	WIIPROTO_REQ_DRM_KEE = 0x34,
4148b6bf DH	240
4148b6bf DH	241	/* DRM_KAE: BB2 AA3 EE16 /
7e274400	242	WIIPROTO_REQ_DRM_KAE = 0x35,
4148b6bf DH	243
4148b6bf DH	244	/* DRM_KIE: BB2 II10 EE9 /
7e274400	245	WIIPROTO_REQ_DRM_KIE = 0x36,
4148b6bf DH	246
4148b6bf DH	247	/* DRM_KAIE: BB2 AA3 II10 EE6 */
7e274400	248	WIIPROTO_REQ_DRM_KAIE = 0x37,
4148b6bf DH	249
4148b6bf DH	250	/* DRM_E: EE21 /
7e274400	251	WIIPROTO_REQ_DRM_E = 0x3d,
4148b6bf DH	252
4148b6bf DH	253	/* DRM_SKAI1: BB2 AA1 II18 /
7e274400	254	WIIPROTO_REQ_DRM_SKAI1 = 0x3e,
4148b6bf DH	255
4148b6bf DH	256	/* DRM_SKAI2: BB2 AA1 II18 /
7e274400	257	WIIPROTO_REQ_DRM_SKAI2 = 0x3f,
4148b6bf	258
43d782ae	259	WIIPROTO_REQ_MAX
7e274400 DH	260	};
7e274400 DH	261
ee79a8f8	262	#define dev_to_wii(pdev) hid_get_drvdata(to_hid_device(pdev))
7e274400	263
4148b6bf DH	264	void __wiimote_schedule(struct wiimote_data *wdata);
4148b6bf DH	265
7e274400	266	extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm);
20cef813	267	extern void wiiproto_req_rumble(struct wiimote_data *wdata, __u8 rumble);
6c5ae018	268	extern void wiiproto_req_leds(struct wiimote_data *wdata, int leds);
dcf39231	269	extern void wiiproto_req_status(struct wiimote_data *wdata);
0ea16757	270	extern void wiiproto_req_accel(struct wiimote_data *wdata, __u8 accel);
3b5f03c4 DH	271	extern void wiiproto_req_ir1(struct wiimote_data *wdata, __u8 flags);
3b5f03c4 DH	272	extern void wiiproto_req_ir2(struct wiimote_data *wdata, __u8 flags);
7e274400 DH	273	extern int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset,
7e274400 DH	274	const __u8 *wmem, __u8 size);
fad8c0e3 DH	275	extern ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset,
fad8c0e3 DH	276	__u8 *rmem, __u8 size);
7e274400	277
1d3452c6 DH	278	#define wiiproto_req_rreg(wdata, os, sz) \
	279	wiiproto_req_rmem((wdata), false, (os), (sz))
	280	#define wiiproto_req_reeprom(wdata, os, sz) \
	281	wiiproto_req_rmem((wdata), true, (os), (sz))
	282	extern void wiiproto_req_rmem(struct wiimote_data *wdata, bool eeprom,
	283	__u32 offset, __u16 size);
	284
43e5e7c6 DH	285	#ifdef CONFIG_DEBUG_FS
	286
	287	extern int wiidebug_init(struct wiimote_data *wdata);
	288	extern void wiidebug_deinit(struct wiimote_data *wdata);
	289
	290	#else
	291
	292	static inline int wiidebug_init(void *u) { return 0; }
	293	static inline void wiidebug_deinit(void *u) { }
	294
	295	#endif
	296
7e274400 DH	297	/* requires the state.lock spinlock to be held */
	298	static inline bool wiimote_cmd_pending(struct wiimote_data *wdata, int cmd,
	299	__u32 opt)
	300	{
	301	return wdata->state.cmd == cmd && wdata->state.opt == opt;
	302	}
	303
	304	/* requires the state.lock spinlock to be held */
	305	static inline void wiimote_cmd_complete(struct wiimote_data *wdata)
	306	{
	307	wdata->state.cmd = WIIPROTO_REQ_NULL;
	308	complete(&wdata->state.ready);
	309	}
	310
d758b1f0 DH	311	/* requires the state.lock spinlock to be held */
	312	static inline void wiimote_cmd_abort(struct wiimote_data *wdata)
	313	{
	314	/* Abort synchronous request by waking up the sleeping caller. But
	315	* reset the state.cmd field to an invalid value so no further event
	316	* handlers will work with it. */
	317	wdata->state.cmd = WIIPROTO_REQ_MAX;
	318	complete(&wdata->state.ready);
	319	}
	320
7e274400 DH	321	static inline int wiimote_cmd_acquire(struct wiimote_data *wdata)
	322	{
	323	return mutex_lock_interruptible(&wdata->state.sync) ? -ERESTARTSYS : 0;
	324	}
	325
c57ff761 DH	326	static inline void wiimote_cmd_acquire_noint(struct wiimote_data *wdata)
	327	{
	328	mutex_lock(&wdata->state.sync);
	329	}
	330
7e274400 DH	331	/* requires the state.lock spinlock to be held */
	332	static inline void wiimote_cmd_set(struct wiimote_data *wdata, int cmd,
	333	__u32 opt)
	334	{
16735d02	335	reinit_completion(&wdata->state.ready);
7e274400 DH	336	wdata->state.cmd = cmd;
	337	wdata->state.opt = opt;
	338	}
	339
	340	static inline void wiimote_cmd_release(struct wiimote_data *wdata)
	341	{
	342	mutex_unlock(&wdata->state.sync);
	343	}
	344
	345	static inline int wiimote_cmd_wait(struct wiimote_data *wdata)
	346	{
	347	int ret;
	348
d758b1f0 DH	349	/* The completion acts as implicit memory barrier so we can safely
	350	* assume that state.cmd is set on success/failure and isn't accessed
	351	* by any other thread, anymore. */
	352
7e274400 DH	353	ret = wait_for_completion_interruptible_timeout(&wdata->state.ready, HZ);
	354	if (ret < 0)
	355	return -ERESTARTSYS;
	356	else if (ret == 0)
	357	return -EIO;
d758b1f0 DH	358	else if (wdata->state.cmd != WIIPROTO_REQ_NULL)
d758b1f0 DH	359	return -EIO;
7e274400 DH	360	else
	361	return 0;
	362	}
	363
c57ff761 DH	364	static inline int wiimote_cmd_wait_noint(struct wiimote_data *wdata)
	365	{
	366	unsigned long ret;
	367
d758b1f0	368	/* no locking needed; see wiimote_cmd_wait() */
c57ff761 DH	369	ret = wait_for_completion_timeout(&wdata->state.ready, HZ);
	370	if (!ret)
	371	return -EIO;
d758b1f0 DH	372	else if (wdata->state.cmd != WIIPROTO_REQ_NULL)
d758b1f0 DH	373	return -EIO;
c57ff761 DH	374	else
	375	return 0;
	376	}
	377
7e274400	378	#endif