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