[mirror_ubuntu-zesty-kernel.git] / drivers / hid / hid-wiimote.h

#ifndef __HID_WIIMOTE_H
#define __HID_WIIMOTE_H

/*
 * HID driver for Nintendo Wiimote devices
 * Copyright (c) 2011 David Herrmann
 */

/*
 * 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; either version 2 of the License, or (at your option)
 * any later version.
 */

#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>

#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_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))

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

struct wiimote_state {
	spinlock_t lock;
	__u8 flags;
	__u8 accel_split[2];

	/* 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;
};

struct wiimote_data {
	struct hid_device *hdev;
	struct input_dev *input;
	struct led_classdev *leds[4];
	struct input_dev *accel;
	struct input_dev *ir;
	struct power_supply battery;

	spinlock_t qlock;
	__u8 head;
	__u8 tail;
	struct wiimote_buf outq[WIIMOTE_BUFSIZE];
	struct work_struct worker;

	struct wiimote_state state;
};

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,
	WIIPROTO_REQ_DRM_K = 0x30,
	WIIPROTO_REQ_DRM_KA = 0x31,
	WIIPROTO_REQ_DRM_KE = 0x32,
	WIIPROTO_REQ_DRM_KAI = 0x33,
	WIIPROTO_REQ_DRM_KEE = 0x34,
	WIIPROTO_REQ_DRM_KAE = 0x35,
	WIIPROTO_REQ_DRM_KIE = 0x36,
	WIIPROTO_REQ_DRM_KAIE = 0x37,
	WIIPROTO_REQ_DRM_E = 0x3d,
	WIIPROTO_REQ_DRM_SKAI1 = 0x3e,
	WIIPROTO_REQ_DRM_SKAI2 = 0x3f,
};

#define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \
									dev))

extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm);
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);

/* 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);
}

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

/* requires the state.lock spinlock to be held */
static inline void wiimote_cmd_set(struct wiimote_data *wdata, int cmd,
								__u32 opt)
{
	INIT_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;

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

#endif
Commit	Line	Data
7e274400 DH	1	#ifndef __HID_WIIMOTE_H
	2	#define __HID_WIIMOTE_H
	3
	4	/*
	5	* HID driver for Nintendo Wiimote devices
	6	* Copyright (c) 2011 David Herrmann
	7	*/
	8
	9	/*
	10	* This program is free software; you can redistribute it and/or modify it
	11	* under the terms of the GNU General Public License as published by the Free
	12	* Software Foundation; either version 2 of the License, or (at your option)
	13	* any later version.
	14	*/
	15
	16	#include <linux/completion.h>
	17	#include <linux/device.h>
	18	#include <linux/hid.h>
	19	#include <linux/input.h>
	20	#include <linux/leds.h>
	21	#include <linux/module.h>
	22	#include <linux/mutex.h>
	23	#include <linux/power_supply.h>
	24	#include <linux/spinlock.h>
	25
	26	#define WIIMOTE_NAME "Nintendo Wii Remote"
	27	#define WIIMOTE_BUFSIZE 32
	28
	29	#define WIIPROTO_FLAG_LED1 0x01
	30	#define WIIPROTO_FLAG_LED2 0x02
	31	#define WIIPROTO_FLAG_LED3 0x04
	32	#define WIIPROTO_FLAG_LED4 0x08
	33	#define WIIPROTO_FLAG_RUMBLE 0x10
	34	#define WIIPROTO_FLAG_ACCEL 0x20
	35	#define WIIPROTO_FLAG_IR_BASIC 0x40
	36	#define WIIPROTO_FLAG_IR_EXT 0x80
	37	#define WIIPROTO_FLAG_IR_FULL 0xc0 /* IR_BASIC \| IR_EXT */
	38	#define WIIPROTO_FLAGS_LEDS (WIIPROTO_FLAG_LED1 \| WIIPROTO_FLAG_LED2 \| \
	39	WIIPROTO_FLAG_LED3 \| WIIPROTO_FLAG_LED4)
	40	#define WIIPROTO_FLAGS_IR (WIIPROTO_FLAG_IR_BASIC \| WIIPROTO_FLAG_IR_EXT \| \
	41	WIIPROTO_FLAG_IR_FULL)
	42
	43	/* return flag for led \num */
	44	#define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1))
	45
	46	struct wiimote_buf {
	47	__u8 data[HID_MAX_BUFFER_SIZE];
	48	size_t size;
	49	};
	50
	51	struct wiimote_state {
	52	spinlock_t lock;
	53	__u8 flags;
	54	__u8 accel_split[2];
	55
	56	/* synchronous cmd requests */
	57	struct mutex sync;
	58	struct completion ready;
	59	int cmd;
	60	__u32 opt;
	61
	62	/* results of synchronous requests */
	63	__u8 cmd_battery;
	64	__u8 cmd_err;
fad8c0e3 DH	65	__u8 *cmd_read_buf;
fad8c0e3 DH	66	__u8 cmd_read_size;
7e274400 DH	67	};
	68
	69	struct wiimote_data {
	70	struct hid_device *hdev;
	71	struct input_dev *input;
	72	struct led_classdev *leds[4];
	73	struct input_dev *accel;
	74	struct input_dev *ir;
	75	struct power_supply battery;
	76
	77	spinlock_t qlock;
	78	__u8 head;
	79	__u8 tail;
	80	struct wiimote_buf outq[WIIMOTE_BUFSIZE];
	81	struct work_struct worker;
	82
	83	struct wiimote_state state;
	84	};
	85
	86	enum wiiproto_reqs {
	87	WIIPROTO_REQ_NULL = 0x0,
	88	WIIPROTO_REQ_RUMBLE = 0x10,
	89	WIIPROTO_REQ_LED = 0x11,
	90	WIIPROTO_REQ_DRM = 0x12,
	91	WIIPROTO_REQ_IR1 = 0x13,
	92	WIIPROTO_REQ_SREQ = 0x15,
	93	WIIPROTO_REQ_WMEM = 0x16,
	94	WIIPROTO_REQ_RMEM = 0x17,
	95	WIIPROTO_REQ_IR2 = 0x1a,
	96	WIIPROTO_REQ_STATUS = 0x20,
	97	WIIPROTO_REQ_DATA = 0x21,
	98	WIIPROTO_REQ_RETURN = 0x22,
	99	WIIPROTO_REQ_DRM_K = 0x30,
	100	WIIPROTO_REQ_DRM_KA = 0x31,
	101	WIIPROTO_REQ_DRM_KE = 0x32,
	102	WIIPROTO_REQ_DRM_KAI = 0x33,
	103	WIIPROTO_REQ_DRM_KEE = 0x34,
	104	WIIPROTO_REQ_DRM_KAE = 0x35,
	105	WIIPROTO_REQ_DRM_KIE = 0x36,
	106	WIIPROTO_REQ_DRM_KAIE = 0x37,
	107	WIIPROTO_REQ_DRM_E = 0x3d,
	108	WIIPROTO_REQ_DRM_SKAI1 = 0x3e,
	109	WIIPROTO_REQ_DRM_SKAI2 = 0x3f,
	110	};
	111
	112	#define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \
	113	dev))
	114
	115	extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm);
	116	extern int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset,
	117	const __u8 *wmem, __u8 size);
fad8c0e3 DH	118	extern ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset,
fad8c0e3 DH	119	__u8 *rmem, __u8 size);
7e274400 DH	120
	121	/* requires the state.lock spinlock to be held */
	122	static inline bool wiimote_cmd_pending(struct wiimote_data *wdata, int cmd,
	123	__u32 opt)
	124	{
	125	return wdata->state.cmd == cmd && wdata->state.opt == opt;
	126	}
	127
	128	/* requires the state.lock spinlock to be held */
	129	static inline void wiimote_cmd_complete(struct wiimote_data *wdata)
	130	{
	131	wdata->state.cmd = WIIPROTO_REQ_NULL;
	132	complete(&wdata->state.ready);
	133	}
	134
	135	static inline int wiimote_cmd_acquire(struct wiimote_data *wdata)
	136	{
	137	return mutex_lock_interruptible(&wdata->state.sync) ? -ERESTARTSYS : 0;
	138	}
	139
	140	/* requires the state.lock spinlock to be held */
	141	static inline void wiimote_cmd_set(struct wiimote_data *wdata, int cmd,
	142	__u32 opt)
	143	{
	144	INIT_COMPLETION(wdata->state.ready);
	145	wdata->state.cmd = cmd;
	146	wdata->state.opt = opt;
	147	}
	148
	149	static inline void wiimote_cmd_release(struct wiimote_data *wdata)
	150	{
	151	mutex_unlock(&wdata->state.sync);
	152	}
	153
	154	static inline int wiimote_cmd_wait(struct wiimote_data *wdata)
	155	{
	156	int ret;
	157
	158	ret = wait_for_completion_interruptible_timeout(&wdata->state.ready, HZ);
	159	if (ret < 0)
	160	return -ERESTARTSYS;
	161	else if (ret == 0)
	162	return -EIO;
	163	else
	164	return 0;
	165	}
	166
	167	#endif