drivers/usb/input/pid.h

   1 /*
   2  *  PID Force feedback support for hid devices.
   3  *
   4  *  Copyright (c) 2002 Rodrigo Damazio.
   5  */
   6
   7 /*
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21  *
  22  * Should you need to contact me, the author, you can do so by
  23  * e-mail - mail your message to <rdamazio@lsi.usp.br>
  24  */
  25
  26 #define FF_EFFECTS_MAX 64
  27
  28 #define FF_PID_FLAGS_USED       1  /* If the effect exists */
  29 #define FF_PID_FLAGS_UPDATING   2  /* If the effect is being updated */
  30 #define FF_PID_FLAGS_PLAYING    3  /* If the effect is currently being played */
  31
  32 #define FF_PID_FALSE    0
  33 #define FF_PID_TRUE     1
  34
  35 struct hid_pid_effect {
  36     unsigned long flags;
  37     pid_t owner;
  38     unsigned int device_id;  // The device-assigned ID
  39     struct ff_effect effect;
  40 };
  41
  42 struct hid_ff_pid {
  43     struct hid_device *hid;
  44     unsigned long int gain;
  45
  46     struct urb *urbffout;
  47     struct usb_ctrlrequest ffcr;
  48     spinlock_t lock;
  49
  50     char ctrl_buffer[8];
  51
  52     struct hid_pid_effect effects[FF_EFFECTS_MAX];
  53 };
  54
  55 /*
  56  * Constants from the PID usage table (still far from complete)
  57  */
  58
  59 #define FF_PID_USAGE_BLOCK_LOAD         0x89UL
  60 #define FF_PID_USAGE_BLOCK_FREE         0x90UL
  61 #define FF_PID_USAGE_NEW_EFFECT         0xABUL
  62 #define FF_PID_USAGE_POOL_REPORT        0x7FUL