[net-next-2.6.git] / drivers / input / joystick / iforce / iforce.h

/*
 * $Id: iforce.h,v 1.13 2002/07/07 10:22:50 jdeneux Exp $
 *
 *  Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
 *  Copyright (c) 2001-2002 Johann Deneux <deneux@ifrance.com>
 *
 *  USB/RS232 I-Force joysticks and wheels.
 */

/*
 * 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.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Should you need to contact me, the author, you can do so either by
 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
 */

#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/input.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/spinlock.h>
#include <linux/usb.h>
#include <linux/serio.h>
#include <linux/circ_buf.h>
#include <linux/mutex.h>

/* This module provides arbitrary resource management routines.
 * I use it to manage the device's memory.
 * Despite the name of this module, I am *not* going to access the ioports.
 */
#include <linux/ioport.h>


#define IFORCE_MAX_LENGTH	16

/* iforce::bus */
#define IFORCE_232	1
#define IFORCE_USB	2

#define IFORCE_EFFECTS_MAX	32

/* Each force feedback effect is made of one core effect, which can be
 * associated to at most to effect modifiers
 */
#define FF_MOD1_IS_USED		0
#define FF_MOD2_IS_USED		1
#define FF_CORE_IS_USED		2
#define FF_CORE_IS_PLAYED	3	/* Effect is currently being played */
#define FF_CORE_SHOULD_PLAY	4	/* User wants the effect to be played */
#define FF_CORE_UPDATE		5	/* Effect is being updated */
#define FF_MODCORE_MAX		5

struct iforce_core_effect {
	/* Information about where modifiers are stored in the device's memory */
	struct resource mod1_chunk;
	struct resource mod2_chunk;
	unsigned long flags[NBITS(FF_MODCORE_MAX)];
};

#define FF_CMD_EFFECT		0x010e
#define FF_CMD_ENVELOPE		0x0208
#define FF_CMD_MAGNITUDE	0x0303
#define FF_CMD_PERIOD		0x0407
#define FF_CMD_CONDITION	0x050a

#define FF_CMD_AUTOCENTER	0x4002
#define FF_CMD_PLAY		0x4103
#define FF_CMD_ENABLE		0x4201
#define FF_CMD_GAIN		0x4301

#define FF_CMD_QUERY		0xff01

/* Buffer for async write */
#define XMIT_SIZE		256
#define XMIT_INC(var, n)	(var)+=n; (var)&= XMIT_SIZE -1
/* iforce::xmit_flags */
#define IFORCE_XMIT_RUNNING	0
#define IFORCE_XMIT_AGAIN	1

struct iforce_device {
	u16 idvendor;
	u16 idproduct;
	char *name;
	signed short *btn;
	signed short *abs;
	signed short *ff;
};

struct iforce {
	struct input_dev *dev;		/* Input device interface */
	struct iforce_device *type;
	int bus;

	unsigned char data[IFORCE_MAX_LENGTH];
	unsigned char edata[IFORCE_MAX_LENGTH];
	u16 ecmd;
	u16 expect_packet;

#ifdef CONFIG_JOYSTICK_IFORCE_232
	struct serio *serio;		/* RS232 transfer */
	int idx, pkt, len, id;
	unsigned char csum;
#endif
#ifdef CONFIG_JOYSTICK_IFORCE_USB
	struct usb_device *usbdev;	/* USB transfer */
	struct urb *irq, *out, *ctrl;
	struct usb_ctrlrequest cr;
#endif
	spinlock_t xmit_lock;
	/* Buffer used for asynchronous sending of bytes to the device */
	struct circ_buf xmit;
	unsigned char xmit_data[XMIT_SIZE];
	long xmit_flags[1];

					/* Force Feedback */
	wait_queue_head_t wait;
	struct resource device_memory;
	struct iforce_core_effect core_effects[IFORCE_EFFECTS_MAX];
	struct mutex mem_mutex;
};

/* Get hi and low bytes of a 16-bits int */
#define HI(a)	((unsigned char)((a) >> 8))
#define LO(a)	((unsigned char)((a) & 0xff))

/* For many parameters, it seems that 0x80 is a special value that should
 * be avoided. Instead, we replace this value by 0x7f
 */
#define HIFIX80(a) ((unsigned char)(((a)<0? (a)+255 : (a))>>8))

/* Encode a time value */
#define TIME_SCALE(a)	(a)


/* Public functions */
/* iforce-serio.c */
void iforce_serial_xmit(struct iforce *iforce);

/* iforce-usb.c */
void iforce_usb_xmit(struct iforce *iforce);
void iforce_usb_delete(struct iforce *iforce);

/* iforce-main.c */
int iforce_init_device(struct iforce *iforce);
void iforce_delete_device(struct iforce *iforce);

/* iforce-packets.c */
int iforce_control_playback(struct iforce*, u16 id, unsigned int);
void iforce_process_packet(struct iforce *iforce, u16 cmd, unsigned char *data);
int iforce_send_packet(struct iforce *iforce, u16 cmd, unsigned char* data);
void iforce_dump_packet(char *msg, u16 cmd, unsigned char *data) ;
int iforce_get_id_packet(struct iforce *iforce, char *packet);

/* iforce-ff.c */
int iforce_upload_periodic(struct iforce *, struct ff_effect *, struct ff_effect *);
int iforce_upload_constant(struct iforce *, struct ff_effect *, struct ff_effect *);
int iforce_upload_condition(struct iforce *, struct ff_effect *, struct ff_effect *);

/* Public variables */
extern struct serio_driver iforce_serio_drv;
extern struct usb_driver iforce_usb_driver;
Commit	Line	Data
1da177e4 LT	1	/*
	2	* $Id: iforce.h,v 1.13 2002/07/07 10:22:50 jdeneux Exp $
	3	*
	4	* Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
	5	* Copyright (c) 2001-2002 Johann Deneux <deneux@ifrance.com>
	6	*
	7	* USB/RS232 I-Force joysticks and wheels.
	8	*/
	9
	10	/*
	11	* This program is free software; you can redistribute it and/or modify
	12	* it under the terms of the GNU General Public License as published by
	13	* the Free Software Foundation; either version 2 of the License, or
	14	* (at your option) any later version.
	15	*
	16	* This program is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	* GNU General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	24	*
	25	* Should you need to contact me, the author, you can do so either by
	26	* e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
	27	* Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
	28	*/
	29
	30	#include <linux/kernel.h>
	31	#include <linux/slab.h>
	32	#include <linux/input.h>
	33	#include <linux/module.h>
	34	#include <linux/init.h>
	35	#include <linux/spinlock.h>
	36	#include <linux/usb.h>
	37	#include <linux/serio.h>
1da177e4	38	#include <linux/circ_buf.h>
72ba9f0c	39	#include <linux/mutex.h>
1da177e4 LT	40
	41	/* This module provides arbitrary resource management routines.
	42	* I use it to manage the device's memory.
	43	* Despite the name of this module, I am not going to access the ioports.
	44	*/
	45	#include <linux/ioport.h>
	46
72ba9f0c	47
1da177e4 LT	48	#define IFORCE_MAX_LENGTH 16
	49
	50	/* iforce::bus */
	51	#define IFORCE_232 1
	52	#define IFORCE_USB 2
	53
f6a01c85	54	#define IFORCE_EFFECTS_MAX 32
1da177e4 LT	55
	56	/* Each force feedback effect is made of one core effect, which can be
	57	* associated to at most to effect modifiers
	58	*/
	59	#define FF_MOD1_IS_USED 0
	60	#define FF_MOD2_IS_USED 1
	61	#define FF_CORE_IS_USED 2
	62	#define FF_CORE_IS_PLAYED 3 /* Effect is currently being played */
	63	#define FF_CORE_SHOULD_PLAY 4 /* User wants the effect to be played */
	64	#define FF_CORE_UPDATE 5 /* Effect is being updated */
	65	#define FF_MODCORE_MAX 5
	66
1da177e4 LT	67	struct iforce_core_effect {
	68	/* Information about where modifiers are stored in the device's memory */
	69	struct resource mod1_chunk;
	70	struct resource mod2_chunk;
	71	unsigned long flags[NBITS(FF_MODCORE_MAX)];
1da177e4 LT	72	};
	73
	74	#define FF_CMD_EFFECT 0x010e
	75	#define FF_CMD_ENVELOPE 0x0208
	76	#define FF_CMD_MAGNITUDE 0x0303
	77	#define FF_CMD_PERIOD 0x0407
	78	#define FF_CMD_CONDITION 0x050a
	79
	80	#define FF_CMD_AUTOCENTER 0x4002
	81	#define FF_CMD_PLAY 0x4103
	82	#define FF_CMD_ENABLE 0x4201
	83	#define FF_CMD_GAIN 0x4301
	84
	85	#define FF_CMD_QUERY 0xff01
	86
	87	/* Buffer for async write */
	88	#define XMIT_SIZE 256
	89	#define XMIT_INC(var, n) (var)+=n; (var)&= XMIT_SIZE -1
	90	/* iforce::xmit_flags */
	91	#define IFORCE_XMIT_RUNNING 0
	92	#define IFORCE_XMIT_AGAIN 1
	93
	94	struct iforce_device {
	95	u16 idvendor;
	96	u16 idproduct;
	97	char *name;
	98	signed short *btn;
	99	signed short *abs;
	100	signed short *ff;
	101	};
	102
	103	struct iforce {
17dd3f0f	104	struct input_dev dev; / Input device interface */
1da177e4 LT	105	struct iforce_device *type;
	106	int bus;
	107
	108	unsigned char data[IFORCE_MAX_LENGTH];
	109	unsigned char edata[IFORCE_MAX_LENGTH];
	110	u16 ecmd;
	111	u16 expect_packet;
	112
	113	#ifdef CONFIG_JOYSTICK_IFORCE_232
	114	struct serio serio; / RS232 transfer */
	115	int idx, pkt, len, id;
	116	unsigned char csum;
	117	#endif
	118	#ifdef CONFIG_JOYSTICK_IFORCE_USB
	119	struct usb_device usbdev; / USB transfer */
	120	struct urb irq, out, *ctrl;
	121	struct usb_ctrlrequest cr;
	122	#endif
	123	spinlock_t xmit_lock;
	124	/* Buffer used for asynchronous sending of bytes to the device */
	125	struct circ_buf xmit;
	126	unsigned char xmit_data[XMIT_SIZE];
	127	long xmit_flags[1];
	128
	129	/* Force Feedback */
	130	wait_queue_head_t wait;
	131	struct resource device_memory;
f6a01c85	132	struct iforce_core_effect core_effects[IFORCE_EFFECTS_MAX];
72ba9f0c	133	struct mutex mem_mutex;
1da177e4 LT	134	};
	135
	136	/* Get hi and low bytes of a 16-bits int */
	137	#define HI(a) ((unsigned char)((a) >> 8))
	138	#define LO(a) ((unsigned char)((a) & 0xff))
	139
	140	/* For many parameters, it seems that 0x80 is a special value that should
	141	* be avoided. Instead, we replace this value by 0x7f
	142	*/
	143	#define HIFIX80(a) ((unsigned char)(((a)<0? (a)+255 : (a))>>8))
	144
	145	/* Encode a time value */
	146	#define TIME_SCALE(a) (a)
	147
	148
	149	/* Public functions */
	150	/* iforce-serio.c */
	151	void iforce_serial_xmit(struct iforce *iforce);
	152
	153	/* iforce-usb.c */
	154	void iforce_usb_xmit(struct iforce *iforce);
	155	void iforce_usb_delete(struct iforce *iforce);
	156
	157	/* iforce-main.c */
	158	int iforce_init_device(struct iforce *iforce);
	159	void iforce_delete_device(struct iforce *iforce);
	160
	161	/* iforce-packets.c */
	162	int iforce_control_playback(struct iforce*, u16 id, unsigned int);
7d12e780	163	void iforce_process_packet(struct iforce iforce, u16 cmd, unsigned char data);
1da177e4 LT	164	int iforce_send_packet(struct iforce iforce, u16 cmd, unsigned char data);
	165	void iforce_dump_packet(char msg, u16 cmd, unsigned char data) ;
	166	int iforce_get_id_packet(struct iforce iforce, char packet);
	167
	168	/* iforce-ff.c */
f6a01c85 AH	169	int iforce_upload_periodic(struct iforce , struct ff_effect , struct ff_effect *);
	170	int iforce_upload_constant(struct iforce , struct ff_effect , struct ff_effect *);
	171	int iforce_upload_condition(struct iforce , struct ff_effect , struct ff_effect *);
1da177e4 LT	172
	173	/* Public variables */
	174	extern struct serio_driver iforce_serio_drv;
	175	extern struct usb_driver iforce_usb_driver;