LXR linux/drivers/input/joystick/iforce/iforce.h

   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 * Should you need to contact me, the author, you can do so either by
  24 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  25 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  26 */
  27
  28#include <linux/kernel.h>
  29#include <linux/slab.h>
  30#include <linux/input.h>
  31#include <linux/module.h>
  32#include <linux/spinlock.h>
  33#include <linux/usb.h>
  34#include <linux/serio.h>
  35#include <linux/circ_buf.h>
  36#include <linux/mutex.h>
  37
  38/* This module provides arbitrary resource management routines.
  39 * I use it to manage the device's memory.
  40 * Despite the name of this module, I am *not* going to access the ioports.
  41 */
  42#include <linux/ioport.h>
  43
  44
  45#define IFORCE_MAX_LENGTH       16
  46
  47/* iforce::bus */
  48#define IFORCE_232      1
  49#define IFORCE_USB      2
  50
  51#define IFORCE_EFFECTS_MAX      32
  52
  53/* Each force feedback effect is made of one core effect, which can be
  54 * associated to at most to effect modifiers
  55 */
  56#define FF_MOD1_IS_USED         0
  57#define FF_MOD2_IS_USED         1
  58#define FF_CORE_IS_USED         2
  59#define FF_CORE_IS_PLAYED       3       /* Effect is currently being played */
  60#define FF_CORE_SHOULD_PLAY     4       /* User wants the effect to be played */
  61#define FF_CORE_UPDATE          5       /* Effect is being updated */
  62#define FF_MODCORE_CNT          6
  63
  64struct iforce_core_effect {
  65        /* Information about where modifiers are stored in the device's memory */
  66        struct resource mod1_chunk;
  67        struct resource mod2_chunk;
  68        unsigned long flags[BITS_TO_LONGS(FF_MODCORE_CNT)];
  69};
  70
  71#define FF_CMD_EFFECT           0x010e
  72#define FF_CMD_ENVELOPE         0x0208
  73#define FF_CMD_MAGNITUDE        0x0303
  74#define FF_CMD_PERIOD           0x0407
  75#define FF_CMD_CONDITION        0x050a
  76
  77#define FF_CMD_AUTOCENTER       0x4002
  78#define FF_CMD_PLAY             0x4103
  79#define FF_CMD_ENABLE           0x4201
  80#define FF_CMD_GAIN             0x4301
  81
  82#define FF_CMD_QUERY            0xff01
  83
  84/* Buffer for async write */
  85#define XMIT_SIZE               256
  86#define XMIT_INC(var, n)        (var)+=n; (var)&= XMIT_SIZE -1
  87/* iforce::xmit_flags */
  88#define IFORCE_XMIT_RUNNING     0
  89#define IFORCE_XMIT_AGAIN       1
  90
  91struct iforce_device {
  92        u16 idvendor;
  93        u16 idproduct;
  94        char *name;
  95        signed short *btn;
  96        signed short *abs;
  97        signed short *ff;
  98};
  99
 100struct iforce {
 101        struct input_dev *dev;          /* Input device interface */
 102        struct iforce_device *type;
 103        int bus;
 104
 105        unsigned char data[IFORCE_MAX_LENGTH];
 106        unsigned char edata[IFORCE_MAX_LENGTH];
 107        u16 ecmd;
 108        u16 expect_packet;
 109
 110#ifdef CONFIG_JOYSTICK_IFORCE_232
 111        struct serio *serio;            /* RS232 transfer */
 112        int idx, pkt, len, id;
 113        unsigned char csum;
 114#endif
 115#ifdef CONFIG_JOYSTICK_IFORCE_USB
 116        struct usb_device *usbdev;      /* USB transfer */
 117        struct usb_interface *intf;
 118        struct urb *irq, *out, *ctrl;
 119        struct usb_ctrlrequest cr;
 120#endif
 121        spinlock_t xmit_lock;
 122        /* Buffer used for asynchronous sending of bytes to the device */
 123        struct circ_buf xmit;
 124        unsigned char xmit_data[XMIT_SIZE];
 125        unsigned long xmit_flags[1];
 126
 127                                        /* Force Feedback */
 128        wait_queue_head_t wait;
 129        struct resource device_memory;
 130        struct iforce_core_effect core_effects[IFORCE_EFFECTS_MAX];
 131        struct mutex mem_mutex;
 132};
 133
 134/* Get hi and low bytes of a 16-bits int */
 135#define HI(a)   ((unsigned char)((a) >> 8))
 136#define LO(a)   ((unsigned char)((a) & 0xff))
 137
 138/* For many parameters, it seems that 0x80 is a special value that should
 139 * be avoided. Instead, we replace this value by 0x7f
 140 */
 141#define HIFIX80(a) ((unsigned char)(((a)<0? (a)+255 : (a))>>8))
 142
 143/* Encode a time value */
 144#define TIME_SCALE(a)   (a)
 145
 146
 147/* Public functions */
 148/* iforce-serio.c */
 149void iforce_serial_xmit(struct iforce *iforce);
 150
 151/* iforce-usb.c */
 152void iforce_usb_xmit(struct iforce *iforce);
 153
 154/* iforce-main.c */
 155int iforce_init_device(struct iforce *iforce);
 156
 157/* iforce-packets.c */
 158int iforce_control_playback(struct iforce*, u16 id, unsigned int);
 159void iforce_process_packet(struct iforce *iforce, u16 cmd, unsigned char *data);
 160int iforce_send_packet(struct iforce *iforce, u16 cmd, unsigned char* data);
 161void iforce_dump_packet(char *msg, u16 cmd, unsigned char *data) ;
 162int iforce_get_id_packet(struct iforce *iforce, char *packet);
 163
 164/* iforce-ff.c */
 165int iforce_upload_periodic(struct iforce *, struct ff_effect *, struct ff_effect *);
 166int iforce_upload_constant(struct iforce *, struct ff_effect *, struct ff_effect *);
 167int iforce_upload_condition(struct iforce *, struct ff_effect *, struct ff_effect *);
 168
 169/* Public variables */
 170extern struct serio_driver iforce_serio_drv;
 171extern struct usb_driver iforce_usb_driver;
 172