src/haptic/linux/SDL_syshaptic.c
author Edgar Simo <bobbens@gmail.com>
Thu, 10 Jul 2008 17:16:11 +0000
branchgsoc2008_force_feedback
changeset 2515 030fc4375e63
parent 2513 55fd9103a330
child 2517 37c13c12c878
permissions -rw-r--r--
Added SDL_HapticNumEffectsPlaying().
bobbens@2472
     1
/*
bobbens@2472
     2
    SDL - Simple DirectMedia Layer
bobbens@2472
     3
    Copyright (C) 2008 Edgar Simo
bobbens@2472
     4
bobbens@2472
     5
    This library is free software; you can redistribute it and/or
bobbens@2472
     6
    modify it under the terms of the GNU Lesser General Public
bobbens@2472
     7
    License as published by the Free Software Foundation; either
bobbens@2472
     8
    version 2.1 of the License, or (at your option) any later version.
bobbens@2472
     9
bobbens@2472
    10
    This library is distributed in the hope that it will be useful,
bobbens@2472
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
bobbens@2472
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
bobbens@2472
    13
    Lesser General Public License for more details.
bobbens@2472
    14
bobbens@2472
    15
    You should have received a copy of the GNU Lesser General Public
bobbens@2472
    16
    License along with this library; if not, write to the Free Software
bobbens@2472
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
bobbens@2472
    18
bobbens@2472
    19
    Sam Lantinga
bobbens@2472
    20
    slouken@libsdl.org
bobbens@2472
    21
*/
bobbens@2472
    22
#include "SDL_config.h"
bobbens@2472
    23
bobbens@2493
    24
#ifdef SDL_HAPTIC_LINUX
bobbens@2472
    25
bobbens@2472
    26
#include "SDL_haptic.h"
bobbens@2472
    27
#include "../SDL_syshaptic.h"
bobbens@2489
    28
#include "SDL_joystick.h"
bobbens@2489
    29
#include "../../joystick/SDL_sysjoystick.h" /* For the real SDL_Joystick */
bobbens@2489
    30
#include "../../joystick/linux/SDL_sysjoystick_c.h" /* For joystick hwdata */ 
bobbens@2472
    31
bobbens@2472
    32
#include <unistd.h> /* close */
bobbens@2472
    33
#include <linux/input.h>
bobbens@2472
    34
#include <sys/ioctl.h>
bobbens@2472
    35
#include <sys/types.h>
bobbens@2472
    36
#include <sys/stat.h>
bobbens@2472
    37
#include <fcntl.h>
bobbens@2472
    38
#include <linux/limits.h>
bobbens@2472
    39
#include <string.h>
bobbens@2496
    40
#include <errno.h>
bobbens@2510
    41
#include <math.h>
bobbens@2510
    42
bobbens@2510
    43
#ifndef M_PI
bobbens@2510
    44
#  define M_PI     3.14159265358979323846
bobbens@2510
    45
#endif
bobbens@2472
    46
bobbens@2472
    47
bobbens@2472
    48
#define MAX_HAPTICS  32
bobbens@2472
    49
bobbens@2472
    50
bobbens@2475
    51
/*
bobbens@2475
    52
 * List of available haptic devices.
bobbens@2475
    53
 */
bobbens@2472
    54
static struct
bobbens@2472
    55
{
bobbens@2472
    56
   char *fname;
bobbens@2472
    57
   SDL_Haptic *haptic;
bobbens@2472
    58
} SDL_hapticlist[MAX_HAPTICS];
bobbens@2472
    59
bobbens@2475
    60
bobbens@2475
    61
/*
bobbens@2475
    62
 * Haptic system hardware data.
bobbens@2475
    63
 */
bobbens@2472
    64
struct haptic_hwdata
bobbens@2472
    65
{
bobbens@2472
    66
   int fd;
bobbens@2472
    67
};
bobbens@2472
    68
bobbens@2472
    69
bobbens@2477
    70
/*
bobbens@2477
    71
 * Haptic system effect data.
bobbens@2477
    72
 */
bobbens@2477
    73
struct haptic_hweffect
bobbens@2477
    74
{
bobbens@2511
    75
   struct ff_effect effect; /* The linux kernel effect structure. */
bobbens@2477
    76
};
bobbens@2477
    77
bobbens@2477
    78
bobbens@2475
    79
bobbens@2472
    80
#define test_bit(nr, addr) \
bobbens@2472
    81
   (((1UL << ((nr) & 31)) & (((const unsigned int *) addr)[(nr) >> 5])) != 0)
bobbens@2472
    82
#define EV_TEST(ev,f) \
bobbens@2472
    83
   if (test_bit((ev), features)) ret |= (f);
bobbens@2475
    84
/*
bobbens@2475
    85
 * Test whether a device has haptic properties.
bobbens@2475
    86
 * Returns available properties or 0 if there are none.
bobbens@2475
    87
 */
bobbens@2472
    88
static int
bobbens@2472
    89
EV_IsHaptic(int fd)
bobbens@2472
    90
{
bobbens@2472
    91
   unsigned int ret;
bobbens@2472
    92
   unsigned long features[1 + FF_MAX/sizeof(unsigned long)];
bobbens@2472
    93
bobbens@2512
    94
   /* Ask device for what it has. */
bobbens@2472
    95
   ret = 0;
bobbens@2512
    96
   if (ioctl(fd, EVIOCGBIT(EV_FF, sizeof(features)), features) < 0) {
bobbens@2513
    97
      SDL_SetError("Haptic: Unable to get device's features: %s", strerror(errno));
bobbens@2490
    98
      return -1;
bobbens@2490
    99
   }
bobbens@2472
   100
bobbens@2512
   101
   /* Convert supported features to SDL_HAPTIC platform-neutral features. */
bobbens@2472
   102
   EV_TEST(FF_CONSTANT,   SDL_HAPTIC_CONSTANT);
bobbens@2487
   103
   EV_TEST(FF_PERIODIC,   SDL_HAPTIC_SINE |
bobbens@2487
   104
                          SDL_HAPTIC_SQUARE |
bobbens@2487
   105
                          SDL_HAPTIC_TRIANGLE |
bobbens@2487
   106
                          SDL_HAPTIC_SAWTOOTHUP |
bobbens@2487
   107
                          SDL_HAPTIC_SAWTOOTHDOWN);
bobbens@2472
   108
   EV_TEST(FF_RAMP,       SDL_HAPTIC_RAMP);
bobbens@2472
   109
   EV_TEST(FF_SPRING,     SDL_HAPTIC_SPRING);
bobbens@2472
   110
   EV_TEST(FF_FRICTION,   SDL_HAPTIC_FRICTION);
bobbens@2472
   111
   EV_TEST(FF_DAMPER,     SDL_HAPTIC_DAMPER);
bobbens@2472
   112
   EV_TEST(FF_INERTIA,    SDL_HAPTIC_INERTIA);
bobbens@2486
   113
   EV_TEST(FF_CUSTOM,     SDL_HAPTIC_CUSTOM);
bobbens@2472
   114
   EV_TEST(FF_GAIN,       SDL_HAPTIC_GAIN);
bobbens@2472
   115
   EV_TEST(FF_AUTOCENTER, SDL_HAPTIC_AUTOCENTER);
bobbens@2472
   116
bobbens@2512
   117
   /* Return what it supports. */
bobbens@2472
   118
   return ret;
bobbens@2472
   119
}
bobbens@2472
   120
bobbens@2512
   121
bobbens@2512
   122
/*
bobbens@2512
   123
 * Tests whether a device is a mouse or not.
bobbens@2512
   124
 */
bobbens@2512
   125
static int
bobbens@2512
   126
EV_IsMouse(int fd)
bobbens@2512
   127
{
bobbens@2512
   128
   unsigned long argp[40];
bobbens@2512
   129
bobbens@2512
   130
   /* Ask for supported features. */
bobbens@2512
   131
   if (ioctl(fd, EVIOCGBIT(EV_KEY, sizeof(argp)), argp) < 0) {
bobbens@2512
   132
      return -1;
bobbens@2512
   133
   }
bobbens@2512
   134
bobbens@2512
   135
   /* Currently we only test for BTN_MOUSE which can give fake positives. */
bobbens@2512
   136
   if (test_bit(BTN_MOUSE,argp) != 0) {
bobbens@2512
   137
      return 1;
bobbens@2512
   138
   }
bobbens@2512
   139
bobbens@2512
   140
   return 0;
bobbens@2512
   141
}
bobbens@2512
   142
bobbens@2500
   143
/*
bobbens@2500
   144
 * Initializes the haptic subsystem by finding available devices.
bobbens@2500
   145
 */
bobbens@2472
   146
int
bobbens@2472
   147
SDL_SYS_HapticInit(void)
bobbens@2472
   148
{
bobbens@2472
   149
   const char joydev_pattern[] = "/dev/input/event%d";
bobbens@2472
   150
   dev_t dev_nums[MAX_HAPTICS];
bobbens@2472
   151
   char path[PATH_MAX];
bobbens@2472
   152
   struct stat sb;
bobbens@2472
   153
   int fd;
bobbens@2472
   154
   int i, j, k;
bobbens@2472
   155
   int duplicate;
bobbens@2472
   156
   int numhaptics;
bobbens@2472
   157
bobbens@2472
   158
   numhaptics = 0;
bobbens@2472
   159
bobbens@2512
   160
   /* 
bobbens@2512
   161
    * Limit amount of checks to MAX_HAPTICS since we may or may not have
bobbens@2512
   162
    * permission to some or all devices.
bobbens@2512
   163
    */
bobbens@2472
   164
   i = 0;
bobbens@2472
   165
   for (j = 0; j < MAX_HAPTICS; ++j) {
bobbens@2472
   166
bobbens@2472
   167
      snprintf(path, PATH_MAX, joydev_pattern, i++);
bobbens@2472
   168
bobbens@2472
   169
      /* check to see if file exists */
bobbens@2472
   170
      if (stat(path,&sb) != 0)
bobbens@2472
   171
         break;
bobbens@2472
   172
bobbens@2472
   173
      /* check for duplicates */
bobbens@2472
   174
      duplicate = 0;
bobbens@2472
   175
      for (k = 0; (k < numhaptics) && !duplicate; ++k) {
bobbens@2472
   176
         if (sb.st_rdev == dev_nums[k]) {
bobbens@2472
   177
            duplicate = 1;
bobbens@2472
   178
         }                                                     
bobbens@2472
   179
      }                                                         
bobbens@2472
   180
      if (duplicate) {
bobbens@2472
   181
         continue;
bobbens@2472
   182
      }
bobbens@2472
   183
bobbens@2472
   184
      /* try to open */
bobbens@2472
   185
      fd = open(path, O_RDWR, 0);
bobbens@2472
   186
      if (fd < 0) continue;
bobbens@2472
   187
bobbens@2472
   188
#ifdef DEBUG_INPUT_EVENTS
bobbens@2472
   189
      printf("Checking %s\n", path);
bobbens@2472
   190
#endif          
bobbens@2472
   191
bobbens@2472
   192
      /* see if it works */
bobbens@2490
   193
      if (EV_IsHaptic(fd) > 0) {
bobbens@2472
   194
         SDL_hapticlist[numhaptics].fname = SDL_strdup(path);
bobbens@2472
   195
         SDL_hapticlist[numhaptics].haptic = NULL;
bobbens@2472
   196
         dev_nums[numhaptics] = sb.st_rdev;
bobbens@2472
   197
         ++numhaptics;
bobbens@2472
   198
      }
bobbens@2472
   199
      close(fd);
bobbens@2472
   200
   }
bobbens@2472
   201
bobbens@2472
   202
   return numhaptics;
bobbens@2472
   203
}
bobbens@2472
   204
bobbens@2472
   205
bobbens@2475
   206
/*
bobbens@2475
   207
 * Return the name of a haptic device, does not need to be opened.
bobbens@2475
   208
 */
bobbens@2472
   209
const char *
bobbens@2472
   210
SDL_SYS_HapticName(int index)
bobbens@2472
   211
{
bobbens@2472
   212
   int fd;
bobbens@2472
   213
   static char namebuf[128];
bobbens@2472
   214
   char *name;
bobbens@2472
   215
bobbens@2512
   216
   /* Open the haptic device. */
bobbens@2472
   217
   name = NULL;
bobbens@2472
   218
   fd = open(SDL_hapticlist[index].fname, O_RDONLY, 0);
bobbens@2512
   219
bobbens@2472
   220
   if (fd >= 0) {
bobbens@2512
   221
bobbens@2512
   222
      /* Check for name ioctl. */
bobbens@2472
   223
      if (ioctl(fd, EVIOCGNAME(sizeof(namebuf)), namebuf) <= 0) {
bobbens@2512
   224
bobbens@2512
   225
         /* No name found, return device character device */
bobbens@2472
   226
         name = SDL_hapticlist[index].fname;
bobbens@2472
   227
      }
bobbens@2512
   228
      /* Name found, return name. */
bobbens@2472
   229
      else {
bobbens@2472
   230
         name = namebuf;
bobbens@2472
   231
      }
bobbens@2472
   232
   }
bobbens@2472
   233
   close(fd);
bobbens@2472
   234
bobbens@2472
   235
   return name;
bobbens@2472
   236
}
bobbens@2472
   237
bobbens@2472
   238
bobbens@2475
   239
/*
bobbens@2490
   240
 * Opens the haptic device from the file descriptor.
bobbens@2475
   241
 */
bobbens@2490
   242
static int
bobbens@2490
   243
SDL_SYS_HapticOpenFromFD(SDL_Haptic * haptic, int fd)
bobbens@2472
   244
{
bobbens@2476
   245
   /* Allocate the hwdata */
bobbens@2476
   246
   haptic->hwdata = (struct haptic_hwdata *)
bobbens@2477
   247
         SDL_malloc(sizeof(*haptic->hwdata));
bobbens@2476
   248
   if (haptic->hwdata == NULL) {
bobbens@2476
   249
      SDL_OutOfMemory();
bobbens@2477
   250
      goto open_err;
bobbens@2476
   251
   }
bobbens@2476
   252
   SDL_memset(haptic->hwdata, 0, sizeof(*haptic->hwdata));
bobbens@2512
   253
bobbens@2478
   254
   /* Set the data */
bobbens@2476
   255
   haptic->hwdata->fd = fd;
bobbens@2478
   256
   haptic->supported = EV_IsHaptic(fd);
bobbens@2472
   257
bobbens@2477
   258
   /* Set the effects */
bobbens@2477
   259
   if (ioctl(fd, EVIOCGEFFECTS, &haptic->neffects) < 0) {
bobbens@2513
   260
      SDL_SetError("Haptic: Unable to query device memory: %s", strerror(errno));
bobbens@2477
   261
      goto open_err;
bobbens@2477
   262
   }
bobbens@2515
   263
   haptic->nplaying = haptic->neffects; /* Linux makes no distinction. */
bobbens@2477
   264
   haptic->effects = (struct haptic_effect *)
bobbens@2477
   265
         SDL_malloc(sizeof(struct haptic_effect) * haptic->neffects);
bobbens@2477
   266
   if (haptic->effects == NULL) {
bobbens@2477
   267
      SDL_OutOfMemory();
bobbens@2477
   268
      goto open_err;
bobbens@2477
   269
   }
bobbens@2483
   270
   /* Clear the memory */
bobbens@2483
   271
   SDL_memset(haptic->effects, 0,
bobbens@2483
   272
         sizeof(struct haptic_effect) * haptic->neffects);
bobbens@2477
   273
bobbens@2472
   274
   return 0;
bobbens@2477
   275
bobbens@2477
   276
   /* Error handling */
bobbens@2477
   277
open_err:
bobbens@2477
   278
   close(fd);
bobbens@2477
   279
   if (haptic->hwdata != NULL) {
bobbens@2477
   280
      free(haptic->hwdata);
bobbens@2477
   281
      haptic->hwdata = NULL;
bobbens@2477
   282
   }
bobbens@2477
   283
   return -1;
bobbens@2472
   284
}
bobbens@2472
   285
bobbens@2472
   286
bobbens@2475
   287
/*
bobbens@2490
   288
 * Opens a haptic device for usage.
bobbens@2490
   289
 */
bobbens@2490
   290
int
bobbens@2490
   291
SDL_SYS_HapticOpen(SDL_Haptic * haptic)
bobbens@2490
   292
{
bobbens@2490
   293
   int fd;
bobbens@2490
   294
bobbens@2490
   295
   /* Open the character device */
bobbens@2490
   296
   fd = open(SDL_hapticlist[haptic->index].fname, O_RDWR, 0);
bobbens@2490
   297
   if (fd < 0) {
bobbens@2513
   298
      SDL_SetError("Haptic: Unable to open %s: %s",
bobbens@2496
   299
            SDL_hapticlist[haptic->index], strerror(errno));
bobbens@2490
   300
      return -1;
bobbens@2490
   301
   }
bobbens@2490
   302
   
bobbens@2490
   303
   return SDL_SYS_HapticOpenFromFD(haptic,fd);
bobbens@2512
   304
}
bobbens@2512
   305
bobbens@2512
   306
bobbens@2512
   307
/*
bobbens@2512
   308
 * Opens a haptic device from first mouse it finds for usage.
bobbens@2512
   309
 */
bobbens@2512
   310
int
bobbens@2512
   311
SDL_SYS_HapticMouse(void)
bobbens@2512
   312
{
bobbens@2512
   313
   int fd;
bobbens@2512
   314
   int i;
bobbens@2512
   315
bobbens@2512
   316
   for (i=0; i<SDL_numhaptics; i++) {
bobbens@2512
   317
bobbens@2512
   318
      /* Open the device. */
bobbens@2512
   319
      fd = open(SDL_hapticlist[i].fname, O_RDWR, 0);
bobbens@2512
   320
      if (fd < 0) {
bobbens@2513
   321
         SDL_SetError("Haptic: Unable to open %s: %s",
bobbens@2512
   322
               SDL_hapticlist[i], strerror(errno));
bobbens@2512
   323
         return -1;
bobbens@2512
   324
      }
bobbens@2512
   325
bobbens@2512
   326
      if (EV_IsMouse(fd)) {
bobbens@2512
   327
         close(fd);
bobbens@2512
   328
         return i;
bobbens@2512
   329
      }
bobbens@2512
   330
bobbens@2512
   331
      close(fd);
bobbens@2512
   332
   }
bobbens@2512
   333
   
bobbens@2512
   334
   return -1;
bobbens@2512
   335
}
bobbens@2490
   336
bobbens@2490
   337
bobbens@2490
   338
/*
bobbens@2489
   339
 * Checks to see if a joystick has haptic features.
bobbens@2489
   340
 */
bobbens@2489
   341
int
bobbens@2489
   342
SDL_SYS_JoystickIsHaptic(SDL_Joystick * joystick)
bobbens@2489
   343
{
bobbens@2490
   344
   return EV_IsHaptic(joystick->hwdata->fd);
bobbens@2490
   345
}
bobbens@2490
   346
bobbens@2490
   347
bobbens@2490
   348
/*
bobbens@2490
   349
 * Checks to see if the haptic device and joystick and in reality the same.
bobbens@2490
   350
 */
bobbens@2490
   351
int
bobbens@2490
   352
SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic, SDL_Joystick * joystick)
bobbens@2490
   353
{
bobbens@2490
   354
   if (SDL_strcmp(joystick->name,haptic->name)==0) {
bobbens@2489
   355
      return 1;
bobbens@2490
   356
   }
bobbens@2489
   357
   return 0;
bobbens@2489
   358
}
bobbens@2489
   359
bobbens@2489
   360
bobbens@2489
   361
/*
bobbens@2489
   362
 * Opens a SDL_Haptic from a SDL_Joystick.
bobbens@2489
   363
 */
bobbens@2489
   364
int
bobbens@2489
   365
SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic, SDL_Joystick * joystick)
bobbens@2489
   366
{
bobbens@2490
   367
   int fd;
bobbens@2490
   368
   fd = open(joystick->hwdata->fname, O_RDWR, 0);
bobbens@2490
   369
   return SDL_SYS_HapticOpenFromFD(haptic,fd);
bobbens@2489
   370
}
bobbens@2489
   371
bobbens@2489
   372
bobbens@2489
   373
/*
bobbens@2475
   374
 * Closes the haptic device.
bobbens@2475
   375
 */
bobbens@2475
   376
void
bobbens@2475
   377
SDL_SYS_HapticClose(SDL_Haptic * haptic)
bobbens@2475
   378
{
bobbens@2476
   379
   if (haptic->hwdata) {
bobbens@2476
   380
bobbens@2476
   381
      /* Clean up */
bobbens@2476
   382
      close(haptic->hwdata->fd);
bobbens@2476
   383
bobbens@2476
   384
      /* Free */
bobbens@2476
   385
      SDL_free(haptic->hwdata);
bobbens@2476
   386
      haptic->hwdata = NULL;
bobbens@2477
   387
      SDL_free(haptic->effects);
bobbens@2477
   388
      haptic->neffects = 0;
bobbens@2476
   389
   }
bobbens@2475
   390
}
bobbens@2475
   391
bobbens@2475
   392
bobbens@2477
   393
/* 
bobbens@2477
   394
 * Clean up after system specific haptic stuff
bobbens@2477
   395
 */
bobbens@2474
   396
void
bobbens@2474
   397
SDL_SYS_HapticQuit(void)
bobbens@2474
   398
{
bobbens@2474
   399
   int i;
bobbens@2474
   400
bobbens@2474
   401
   for (i=0; SDL_hapticlist[i].fname != NULL; i++) {
bobbens@2474
   402
      SDL_free(SDL_hapticlist[i].fname);
bobbens@2474
   403
   }
bobbens@2474
   404
   SDL_hapticlist[0].fname = NULL;
bobbens@2474
   405
}
bobbens@2474
   406
bobbens@2500
   407
/*
bobbens@2500
   408
 * Returns the ff_effect usable direction from a SDL_HapticDirection.
bobbens@2500
   409
 */
bobbens@2500
   410
static Uint16
bobbens@2500
   411
SDL_SYS_ToDirection( SDL_HapticDirection * dir )
bobbens@2500
   412
{
bobbens@2500
   413
   Uint32 tmp;
bobbens@2511
   414
   float f; /* Ideally we'd use fixed point math instead of floats... */
bobbens@2500
   415
bobbens@2500
   416
   switch (dir->type) {
bobbens@2500
   417
      case SDL_HAPTIC_POLAR:
bobbens@2502
   418
         /* Linux directions are inverted. */
bobbens@2502
   419
         tmp = (((18000 + dir->dir[0]) % 36000) * 0xFFFF) / 36000;
bobbens@2500
   420
         return (Uint16) tmp;
bobbens@2500
   421
      case SDL_HAPTIC_CARTESIAN:
bobbens@2511
   422
         /* We must invert "x" and "y" to go clockwise. */
bobbens@2510
   423
         f = atan2(dir->dir[0], dir->dir[1]);
bobbens@2510
   424
         tmp = (int)(f*18000./M_PI) % 36000;
bobbens@2510
   425
         tmp = (tmp * 0xFFFF) / 36000;
bobbens@2510
   426
         return (Uint16) tmp;
bobbens@2500
   427
bobbens@2500
   428
      default:
bobbens@2500
   429
         return -1;
bobbens@2500
   430
   }
bobbens@2500
   431
bobbens@2500
   432
   return 0;
bobbens@2500
   433
}
bobbens@2500
   434
bobbens@2481
   435
#define  CLAMP(x)    (((x) > 32767) ? 32767 : x)
bobbens@2477
   436
/*
bobbens@2479
   437
 * Initializes the linux effect struct from a haptic_effect.
bobbens@2481
   438
 * Values above 32767 (for unsigned) are unspecified so we must clamp.
bobbens@2479
   439
 */
bobbens@2479
   440
static int
bobbens@2480
   441
SDL_SYS_ToFFEffect( struct ff_effect * dest, SDL_HapticEffect * src )
bobbens@2479
   442
{
bobbens@2482
   443
   int i;
bobbens@2480
   444
   SDL_HapticConstant *constant;
bobbens@2480
   445
   SDL_HapticPeriodic *periodic;
bobbens@2482
   446
   SDL_HapticCondition *condition;
bobbens@2482
   447
   SDL_HapticRamp *ramp;
bobbens@2480
   448
bobbens@2480
   449
   /* Clear up */
bobbens@2479
   450
   SDL_memset(dest, 0, sizeof(struct ff_effect));
bobbens@2480
   451
bobbens@2480
   452
   switch (src->type) {
bobbens@2479
   453
      case SDL_HAPTIC_CONSTANT:
bobbens@2480
   454
         constant = &src->constant;
bobbens@2480
   455
bobbens@2480
   456
         /* Header */
bobbens@2479
   457
         dest->type = FF_CONSTANT;
bobbens@2500
   458
         dest->direction = SDL_SYS_ToDirection(&constant->direction);
bobbens@2480
   459
bobbens@2480
   460
         /* Replay */
bobbens@2481
   461
         dest->replay.length = CLAMP(constant->length);
bobbens@2481
   462
         dest->replay.delay = CLAMP(constant->delay);
bobbens@2480
   463
bobbens@2480
   464
         /* Trigger */
bobbens@2481
   465
         dest->trigger.button = CLAMP(constant->button);
bobbens@2481
   466
         dest->trigger.interval = CLAMP(constant->interval);
bobbens@2480
   467
bobbens@2480
   468
         /* Constant */
bobbens@2480
   469
         dest->u.constant.level = constant->level;
bobbens@2480
   470
bobbens@2480
   471
         /* Envelope */
bobbens@2481
   472
         dest->u.constant.envelope.attack_length = CLAMP(constant->attack_length);
bobbens@2481
   473
         dest->u.constant.envelope.attack_level = CLAMP(constant->attack_level);
bobbens@2481
   474
         dest->u.constant.envelope.fade_length = CLAMP(constant->fade_length);
bobbens@2481
   475
         dest->u.constant.envelope.fade_level = CLAMP(constant->fade_level);
bobbens@2480
   476
bobbens@2480
   477
         break;
bobbens@2480
   478
bobbens@2487
   479
      case SDL_HAPTIC_SINE:
bobbens@2487
   480
      case SDL_HAPTIC_SQUARE:
bobbens@2487
   481
      case SDL_HAPTIC_TRIANGLE:
bobbens@2487
   482
      case SDL_HAPTIC_SAWTOOTHUP:
bobbens@2487
   483
      case SDL_HAPTIC_SAWTOOTHDOWN:
bobbens@2480
   484
         periodic = &src->periodic;
bobbens@2480
   485
bobbens@2480
   486
         /* Header */
bobbens@2480
   487
         dest->type = FF_PERIODIC;
bobbens@2500
   488
         dest->direction = SDL_SYS_ToDirection(&periodic->direction);
bobbens@2480
   489
         
bobbens@2480
   490
         /* Replay */
bobbens@2481
   491
         dest->replay.length = CLAMP(periodic->length);
bobbens@2481
   492
         dest->replay.delay = CLAMP(periodic->delay);
bobbens@2480
   493
         
bobbens@2480
   494
         /* Trigger */
bobbens@2481
   495
         dest->trigger.button = CLAMP(periodic->button);
bobbens@2481
   496
         dest->trigger.interval = CLAMP(periodic->interval);
bobbens@2480
   497
         
bobbens@2487
   498
         /* Periodic */
bobbens@2487
   499
         if (periodic->type == SDL_HAPTIC_SINE)
bobbens@2487
   500
            dest->u.periodic.waveform = FF_SINE;
bobbens@2487
   501
         else if (periodic->type == SDL_HAPTIC_SQUARE)
bobbens@2487
   502
            dest->u.periodic.waveform = FF_SQUARE;
bobbens@2487
   503
         else if (periodic->type == SDL_HAPTIC_TRIANGLE)       
bobbens@2487
   504
            dest->u.periodic.waveform = FF_TRIANGLE;
bobbens@2487
   505
         else if (periodic->type == SDL_HAPTIC_SAWTOOTHUP)       
bobbens@2487
   506
            dest->u.periodic.waveform = FF_SAW_UP;
bobbens@2487
   507
         else if (periodic->type == SDL_HAPTIC_SAWTOOTHDOWN)       
bobbens@2487
   508
            dest->u.periodic.waveform = FF_SAW_DOWN;
bobbens@2481
   509
         dest->u.periodic.period = CLAMP(periodic->period);
bobbens@2480
   510
         dest->u.periodic.magnitude = periodic->magnitude;
bobbens@2480
   511
         dest->u.periodic.offset = periodic->offset;
bobbens@2481
   512
         dest->u.periodic.phase = CLAMP(periodic->phase);
bobbens@2480
   513
         
bobbens@2480
   514
         /* Envelope */
bobbens@2481
   515
         dest->u.periodic.envelope.attack_length = CLAMP(periodic->attack_length);
bobbens@2481
   516
         dest->u.periodic.envelope.attack_level = CLAMP(periodic->attack_level);
bobbens@2481
   517
         dest->u.periodic.envelope.fade_length = CLAMP(periodic->fade_length);
bobbens@2481
   518
         dest->u.periodic.envelope.fade_level = CLAMP(periodic->fade_level);
bobbens@2479
   519
bobbens@2479
   520
         break;
bobbens@2479
   521
bobbens@2482
   522
      case SDL_HAPTIC_SPRING:
bobbens@2482
   523
      case SDL_HAPTIC_DAMPER:
bobbens@2482
   524
      case SDL_HAPTIC_INERTIA:
bobbens@2482
   525
      case SDL_HAPTIC_FRICTION:
bobbens@2482
   526
         condition = &src->condition;
bobbens@2482
   527
bobbens@2482
   528
         /* Header */
bobbens@2503
   529
         if (condition->type == SDL_HAPTIC_SPRING)
bobbens@2482
   530
            dest->type = FF_SPRING;
bobbens@2503
   531
         else if (condition->type == SDL_HAPTIC_DAMPER)
bobbens@2482
   532
            dest->type = FF_DAMPER;
bobbens@2503
   533
         else if (condition->type == SDL_HAPTIC_INERTIA)
bobbens@2482
   534
            dest->type = FF_INERTIA;
bobbens@2503
   535
         else if (condition->type == SDL_HAPTIC_FRICTION)
bobbens@2482
   536
            dest->type = FF_FRICTION;
bobbens@2500
   537
         dest->direction = 0; /* Handled by the condition-specifics. */
bobbens@2482
   538
bobbens@2482
   539
         /* Replay */
bobbens@2482
   540
         dest->replay.length = CLAMP(condition->length);
bobbens@2482
   541
         dest->replay.delay = CLAMP(condition->delay);
bobbens@2482
   542
bobbens@2482
   543
         /* Trigger */
bobbens@2482
   544
         dest->trigger.button = CLAMP(condition->button);
bobbens@2482
   545
         dest->trigger.interval = CLAMP(condition->interval);
bobbens@2482
   546
bobbens@2500
   547
         /* Condition */
bobbens@2500
   548
         /* X axis */
bobbens@2500
   549
         dest->u.condition[0].right_saturation = CLAMP(condition->right_sat[0]);
bobbens@2500
   550
         dest->u.condition[0].left_saturation = CLAMP(condition->left_sat[0]);
bobbens@2500
   551
         dest->u.condition[0].right_coeff = condition->right_coeff[0];
bobbens@2500
   552
         dest->u.condition[0].left_coeff = condition->left_coeff[0];
bobbens@2500
   553
         dest->u.condition[0].deadband = CLAMP(condition->deadband[0]);
bobbens@2500
   554
         dest->u.condition[0].center = condition->center[0];
bobbens@2500
   555
         /* Y axis */
bobbens@2500
   556
         dest->u.condition[1].right_saturation = CLAMP(condition->right_sat[1]);
bobbens@2500
   557
         dest->u.condition[1].left_saturation = CLAMP(condition->left_sat[1]);
bobbens@2500
   558
         dest->u.condition[1].right_coeff = condition->right_coeff[1];
bobbens@2500
   559
         dest->u.condition[1].left_coeff = condition->left_coeff[1];  
bobbens@2500
   560
         dest->u.condition[1].deadband = CLAMP(condition->deadband[1]);
bobbens@2500
   561
         dest->u.condition[1].center = condition->center[1];
bobbens@2482
   562
bobbens@2482
   563
         break;
bobbens@2482
   564
bobbens@2482
   565
      case SDL_HAPTIC_RAMP:
bobbens@2482
   566
         ramp = &src->ramp;
bobbens@2482
   567
bobbens@2482
   568
         /* Header */
bobbens@2482
   569
         dest->type = FF_RAMP;
bobbens@2500
   570
         dest->direction = SDL_SYS_ToDirection(&ramp->direction);
bobbens@2482
   571
bobbens@2482
   572
         /* Replay */
bobbens@2482
   573
         dest->replay.length = CLAMP(ramp->length);
bobbens@2482
   574
         dest->replay.delay = CLAMP(ramp->delay);
bobbens@2482
   575
bobbens@2482
   576
         /* Trigger */
bobbens@2482
   577
         dest->trigger.button = CLAMP(ramp->button);
bobbens@2482
   578
         dest->trigger.interval = CLAMP(ramp->interval);
bobbens@2482
   579
bobbens@2482
   580
         /* Ramp */
bobbens@2482
   581
         dest->u.ramp.start_level = ramp->start;
bobbens@2482
   582
         dest->u.ramp.end_level = ramp->end;
bobbens@2482
   583
bobbens@2482
   584
         /* Envelope */
bobbens@2482
   585
         dest->u.ramp.envelope.attack_length = CLAMP(ramp->attack_length);
bobbens@2482
   586
         dest->u.ramp.envelope.attack_level = CLAMP(ramp->attack_level);
bobbens@2482
   587
         dest->u.ramp.envelope.fade_length = CLAMP(ramp->fade_length);
bobbens@2482
   588
         dest->u.ramp.envelope.fade_level = CLAMP(ramp->fade_level);
bobbens@2482
   589
bobbens@2482
   590
         break;
bobbens@2482
   591
bobbens@2482
   592
bobbens@2479
   593
      default:
bobbens@2513
   594
         SDL_SetError("Haptic: Unknown effect type.");
bobbens@2479
   595
         return -1;
bobbens@2479
   596
   }
bobbens@2479
   597
bobbens@2479
   598
   return 0;
bobbens@2479
   599
}
bobbens@2479
   600
bobbens@2483
   601
bobbens@2479
   602
/*
bobbens@2477
   603
 * Creates a new haptic effect.
bobbens@2477
   604
 */
bobbens@2477
   605
int
bobbens@2480
   606
SDL_SYS_HapticNewEffect(SDL_Haptic * haptic, struct haptic_effect * effect,
bobbens@2480
   607
      SDL_HapticEffect * base)
bobbens@2477
   608
{
bobbens@2480
   609
   struct ff_effect * linux_effect;
bobbens@2480
   610
bobbens@2479
   611
   /* Allocate the hardware effect */
bobbens@2479
   612
   effect->hweffect = (struct haptic_hweffect *) 
bobbens@2479
   613
         SDL_malloc(sizeof(struct haptic_hweffect));
bobbens@2479
   614
   if (effect->hweffect == NULL) {
bobbens@2479
   615
      SDL_OutOfMemory();
bobbens@2479
   616
      return -1;
bobbens@2479
   617
   }
bobbens@2479
   618
bobbens@2479
   619
   /* Prepare the ff_effect */
bobbens@2480
   620
   linux_effect = &effect->hweffect->effect;
bobbens@2480
   621
   if (SDL_SYS_ToFFEffect( linux_effect, base ) != 0) {
bobbens@2488
   622
      goto new_effect_err;
bobbens@2479
   623
   }
bobbens@2480
   624
   linux_effect->id = -1; /* Have the kernel give it an id */
bobbens@2479
   625
bobbens@2479
   626
   /* Upload the effect */
bobbens@2480
   627
   if (ioctl(haptic->hwdata->fd, EVIOCSFF, linux_effect) < 0) {
bobbens@2513
   628
      SDL_SetError("Haptic: Error uploading effect to the device: %s", strerror(errno));
bobbens@2488
   629
      goto new_effect_err;
bobbens@2488
   630
   }
bobbens@2488
   631
bobbens@2488
   632
   return 0;
bobbens@2488
   633
bobbens@2488
   634
new_effect_err:
bobbens@2488
   635
   free(effect->hweffect);
bobbens@2488
   636
   effect->hweffect = NULL;
bobbens@2488
   637
   return -1;
bobbens@2488
   638
}
bobbens@2488
   639
bobbens@2488
   640
bobbens@2488
   641
/*
bobbens@2488
   642
 * Updates an effect.
bobbens@2488
   643
 *
bobbens@2488
   644
 * Note: Dynamically updating the direction can in some cases force
bobbens@2488
   645
 * the effect to restart and run once.
bobbens@2488
   646
 */
bobbens@2488
   647
int SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,
bobbens@2488
   648
      struct haptic_effect * effect, SDL_HapticEffect * data)
bobbens@2488
   649
{
bobbens@2488
   650
   struct ff_effect linux_effect;
bobbens@2488
   651
bobbens@2488
   652
   /* Create the new effect */
bobbens@2488
   653
   if (SDL_SYS_ToFFEffect( &linux_effect, data ) != 0) {
bobbens@2488
   654
      return -1;
bobbens@2488
   655
   }
bobbens@2488
   656
   linux_effect.id = effect->hweffect->effect.id;
bobbens@2488
   657
bobbens@2488
   658
   /* See if it can be uploaded. */
bobbens@2488
   659
   if (ioctl(haptic->hwdata->fd, EVIOCSFF, &linux_effect) < 0) {
bobbens@2513
   660
      SDL_SetError("Haptic: Error updating the effect: %s", strerror(errno));
bobbens@2479
   661
      return -1;
bobbens@2479
   662
   }
bobbens@2479
   663
bobbens@2488
   664
   /* Copy the new effect into memory. */
bobbens@2488
   665
   SDL_memcpy( &effect->hweffect->effect, &linux_effect, sizeof(struct ff_effect) );
bobbens@2488
   666
bobbens@2488
   667
   return effect->hweffect->effect.id;
bobbens@2477
   668
}
bobbens@2477
   669
bobbens@2474
   670
bobbens@2479
   671
/*
bobbens@2479
   672
 * Runs an effect.
bobbens@2479
   673
 */
bobbens@2479
   674
int
bobbens@2479
   675
SDL_SYS_HapticRunEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2479
   676
{
bobbens@2479
   677
   struct input_event run;
bobbens@2479
   678
bobbens@2479
   679
   /* Prepare to run the effect */
bobbens@2479
   680
   run.type = EV_FF;
bobbens@2479
   681
   run.code = effect->hweffect->effect.id;
bobbens@2479
   682
   run.value = 1;
bobbens@2479
   683
bobbens@2479
   684
   if (write(haptic->hwdata->fd, (const void*) &run, sizeof(run)) < 0) {
bobbens@2513
   685
      SDL_SetError("Haptic: Unable to run the effect: %s", strerror(errno));
bobbens@2479
   686
      return -1;
bobbens@2479
   687
   }
bobbens@2479
   688
bobbens@2479
   689
   return 0;
bobbens@2479
   690
}
bobbens@2479
   691
bobbens@2479
   692
bobbens@2479
   693
/*
bobbens@2485
   694
 * Stops an effect.
bobbens@2485
   695
 */
bobbens@2485
   696
int
bobbens@2485
   697
SDL_SYS_HapticStopEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2485
   698
{
bobbens@2485
   699
   struct input_event stop;
bobbens@2485
   700
bobbens@2485
   701
   stop.type = EV_FF;
bobbens@2485
   702
   stop.code = effect->hweffect->effect.id;
bobbens@2485
   703
   stop.value = 0;
bobbens@2485
   704
bobbens@2485
   705
   if (write(haptic->hwdata->fd, (const void*) &stop, sizeof(stop)) < 0) {
bobbens@2513
   706
      SDL_SetError("Haptic: Unable to stop the effect: %s", strerror(errno));
bobbens@2485
   707
      return -1;
bobbens@2485
   708
   }
bobbens@2485
   709
bobbens@2485
   710
   return 0;
bobbens@2485
   711
}
bobbens@2485
   712
bobbens@2485
   713
bobbens@2485
   714
/*
bobbens@2487
   715
 * Frees the effect.
bobbens@2479
   716
 */
bobbens@2479
   717
void
bobbens@2479
   718
SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2479
   719
{
bobbens@2479
   720
   if (ioctl(haptic->hwdata->fd, EVIOCRMFF, effect->hweffect->effect.id) < 0) {
bobbens@2513
   721
      SDL_SetError("Haptic: Error removing the effect from the device: %s",
bobbens@2496
   722
            strerror(errno));
bobbens@2479
   723
   }
bobbens@2479
   724
   SDL_free(effect->hweffect);
bobbens@2479
   725
   effect->hweffect = NULL;
bobbens@2479
   726
}
bobbens@2479
   727
bobbens@2479
   728
bobbens@2483
   729
/*
bobbens@2495
   730
 * Gets the status of a haptic effect.
bobbens@2495
   731
 */
bobbens@2495
   732
int
bobbens@2495
   733
SDL_SYS_HapticGetEffectStatus(SDL_Haptic * haptic, struct haptic_effect * effect)
bobbens@2495
   734
{
bobbens@2495
   735
#if 0  /* Not supported atm. */
bobbens@2495
   736
   struct input_event ie;
bobbens@2495
   737
bobbens@2495
   738
   ie.type = EV_FF;
bobbens@2495
   739
   ie.type = EV_FF_STATUS;
bobbens@2495
   740
   ie.code = effect->hweffect->effect.id;
bobbens@2495
   741
bobbens@2495
   742
   if (write(haptic->hwdata->fd, &ie, sizeof(ie)) < 0) {
bobbens@2513
   743
      SDL_SetError("Haptic: Error getting device status.");
bobbens@2495
   744
      return -1;
bobbens@2495
   745
   }
bobbens@2495
   746
bobbens@2495
   747
   return 0;
bobbens@2495
   748
#endif
bobbens@2495
   749
bobbens@2495
   750
   return -1;
bobbens@2495
   751
}
bobbens@2495
   752
bobbens@2495
   753
bobbens@2495
   754
/*
bobbens@2483
   755
 * Sets the gain.
bobbens@2483
   756
 */
bobbens@2483
   757
int
bobbens@2483
   758
SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain)
bobbens@2483
   759
{
bobbens@2483
   760
   struct input_event ie;
bobbens@2483
   761
bobbens@2483
   762
   ie.type = EV_FF;
bobbens@2483
   763
   ie.code = FF_GAIN;
bobbens@2483
   764
   ie.value = (0xFFFFUL * gain) / 100;
bobbens@2483
   765
bobbens@2484
   766
   if (write(haptic->hwdata->fd, &ie, sizeof(ie)) < 0) {
bobbens@2513
   767
      SDL_SetError("Haptic: Error setting gain: %s", strerror(errno));
bobbens@2484
   768
      return -1;
bobbens@2483
   769
   }
bobbens@2483
   770
bobbens@2484
   771
   return 0;
bobbens@2483
   772
}
bobbens@2483
   773
bobbens@2483
   774
bobbens@2484
   775
/*
bobbens@2484
   776
 * Sets the autocentering.
bobbens@2484
   777
 */
bobbens@2484
   778
int
bobbens@2484
   779
SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter)
bobbens@2484
   780
{
bobbens@2484
   781
   struct input_event ie;
bobbens@2484
   782
bobbens@2484
   783
   ie.type = EV_FF;
bobbens@2484
   784
   ie.code = FF_AUTOCENTER;
bobbens@2484
   785
   ie.value = (0xFFFFUL * autocenter) / 100;
bobbens@2484
   786
bobbens@2484
   787
   if (write(haptic->hwdata->fd, &ie, sizeof(ie)) < 0) {
bobbens@2513
   788
      SDL_SetError("Haptic: Error setting autocenter: %s", strerror(errno));
bobbens@2484
   789
      return -1;
bobbens@2484
   790
   }
bobbens@2484
   791
bobbens@2484
   792
   return 0;
bobbens@2484
   793
}
bobbens@2484
   794
bobbens@2484
   795
bobbens@2472
   796
#endif /* SDL_HAPTIC_LINUX */