blob: 08174d341f4a10cbb54b1a2cc2e894a3ee17c028 [file] [log] [blame]
Anssi Hannula224ee882006-07-19 01:40:47 -04001/*
2 * Force feedback driver for USB HID PID compliant devices
3 *
4 * Copyright (c) 2005, 2006 Anssi Hannula <anssi.hannula@gmail.com>
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
23/* #define DEBUG */
24
Joe Perches4291ee32010-12-09 19:29:03 -080025#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
Anssi Hannula224ee882006-07-19 01:40:47 -040026
Anssi Hannula224ee882006-07-19 01:40:47 -040027#include <linux/input.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090028#include <linux/slab.h>
Anssi Hannula224ee882006-07-19 01:40:47 -040029#include <linux/usb.h>
30
Jiri Kosinadde58452006-12-08 18:40:44 +010031#include <linux/hid.h>
32
33#include "usbhid.h"
Anssi Hannula224ee882006-07-19 01:40:47 -040034
35#define PID_EFFECTS_MAX 64
36
37/* Report usage table used to put reports into an array */
38
39#define PID_SET_EFFECT 0
40#define PID_EFFECT_OPERATION 1
41#define PID_DEVICE_GAIN 2
42#define PID_POOL 3
43#define PID_BLOCK_LOAD 4
44#define PID_BLOCK_FREE 5
45#define PID_DEVICE_CONTROL 6
46#define PID_CREATE_NEW_EFFECT 7
47
48#define PID_REQUIRED_REPORTS 7
49
50#define PID_SET_ENVELOPE 8
51#define PID_SET_CONDITION 9
52#define PID_SET_PERIODIC 10
53#define PID_SET_CONSTANT 11
54#define PID_SET_RAMP 12
55static const u8 pidff_reports[] = {
56 0x21, 0x77, 0x7d, 0x7f, 0x89, 0x90, 0x96, 0xab,
57 0x5a, 0x5f, 0x6e, 0x73, 0x74
58};
59
60/* device_control is really 0x95, but 0x96 specified as it is the usage of
61the only field in that report */
62
63/* Value usage tables used to put fields and values into arrays */
64
65#define PID_EFFECT_BLOCK_INDEX 0
66
67#define PID_DURATION 1
68#define PID_GAIN 2
69#define PID_TRIGGER_BUTTON 3
70#define PID_TRIGGER_REPEAT_INT 4
71#define PID_DIRECTION_ENABLE 5
72#define PID_START_DELAY 6
73static const u8 pidff_set_effect[] = {
74 0x22, 0x50, 0x52, 0x53, 0x54, 0x56, 0xa7
75};
76
77#define PID_ATTACK_LEVEL 1
78#define PID_ATTACK_TIME 2
79#define PID_FADE_LEVEL 3
80#define PID_FADE_TIME 4
81static const u8 pidff_set_envelope[] = { 0x22, 0x5b, 0x5c, 0x5d, 0x5e };
82
83#define PID_PARAM_BLOCK_OFFSET 1
84#define PID_CP_OFFSET 2
85#define PID_POS_COEFFICIENT 3
86#define PID_NEG_COEFFICIENT 4
87#define PID_POS_SATURATION 5
88#define PID_NEG_SATURATION 6
89#define PID_DEAD_BAND 7
90static const u8 pidff_set_condition[] = {
91 0x22, 0x23, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65
92};
93
94#define PID_MAGNITUDE 1
95#define PID_OFFSET 2
96#define PID_PHASE 3
97#define PID_PERIOD 4
98static const u8 pidff_set_periodic[] = { 0x22, 0x70, 0x6f, 0x71, 0x72 };
99static const u8 pidff_set_constant[] = { 0x22, 0x70 };
100
101#define PID_RAMP_START 1
102#define PID_RAMP_END 2
103static const u8 pidff_set_ramp[] = { 0x22, 0x75, 0x76 };
104
105#define PID_RAM_POOL_AVAILABLE 1
106static const u8 pidff_block_load[] = { 0x22, 0xac };
107
108#define PID_LOOP_COUNT 1
109static const u8 pidff_effect_operation[] = { 0x22, 0x7c };
110
111static const u8 pidff_block_free[] = { 0x22 };
112
113#define PID_DEVICE_GAIN_FIELD 0
114static const u8 pidff_device_gain[] = { 0x7e };
115
116#define PID_RAM_POOL_SIZE 0
117#define PID_SIMULTANEOUS_MAX 1
118#define PID_DEVICE_MANAGED_POOL 2
119static const u8 pidff_pool[] = { 0x80, 0x83, 0xa9 };
120
121/* Special field key tables used to put special field keys into arrays */
122
123#define PID_ENABLE_ACTUATORS 0
124#define PID_RESET 1
125static const u8 pidff_device_control[] = { 0x97, 0x9a };
126
127#define PID_CONSTANT 0
128#define PID_RAMP 1
129#define PID_SQUARE 2
130#define PID_SINE 3
131#define PID_TRIANGLE 4
132#define PID_SAW_UP 5
133#define PID_SAW_DOWN 6
134#define PID_SPRING 7
135#define PID_DAMPER 8
136#define PID_INERTIA 9
137#define PID_FRICTION 10
138static const u8 pidff_effect_types[] = {
139 0x26, 0x27, 0x30, 0x31, 0x32, 0x33, 0x34,
140 0x40, 0x41, 0x42, 0x43
141};
142
143#define PID_BLOCK_LOAD_SUCCESS 0
144#define PID_BLOCK_LOAD_FULL 1
145static const u8 pidff_block_load_status[] = { 0x8c, 0x8d };
146
147#define PID_EFFECT_START 0
148#define PID_EFFECT_STOP 1
149static const u8 pidff_effect_operation_status[] = { 0x79, 0x7b };
150
151struct pidff_usage {
152 struct hid_field *field;
153 s32 *value;
154};
155
156struct pidff_device {
157 struct hid_device *hid;
158
159 struct hid_report *reports[sizeof(pidff_reports)];
160
161 struct pidff_usage set_effect[sizeof(pidff_set_effect)];
162 struct pidff_usage set_envelope[sizeof(pidff_set_envelope)];
163 struct pidff_usage set_condition[sizeof(pidff_set_condition)];
164 struct pidff_usage set_periodic[sizeof(pidff_set_periodic)];
165 struct pidff_usage set_constant[sizeof(pidff_set_constant)];
166 struct pidff_usage set_ramp[sizeof(pidff_set_ramp)];
167
168 struct pidff_usage device_gain[sizeof(pidff_device_gain)];
169 struct pidff_usage block_load[sizeof(pidff_block_load)];
170 struct pidff_usage pool[sizeof(pidff_pool)];
171 struct pidff_usage effect_operation[sizeof(pidff_effect_operation)];
172 struct pidff_usage block_free[sizeof(pidff_block_free)];
173
174 /* Special field is a field that is not composed of
175 usage<->value pairs that pidff_usage values are */
176
177 /* Special field in create_new_effect */
178 struct hid_field *create_new_effect_type;
179
180 /* Special fields in set_effect */
181 struct hid_field *set_effect_type;
182 struct hid_field *effect_direction;
183
184 /* Special field in device_control */
185 struct hid_field *device_control;
186
187 /* Special field in block_load */
188 struct hid_field *block_load_status;
189
190 /* Special field in effect_operation */
191 struct hid_field *effect_operation_status;
192
193 int control_id[sizeof(pidff_device_control)];
194 int type_id[sizeof(pidff_effect_types)];
195 int status_id[sizeof(pidff_block_load_status)];
196 int operation_id[sizeof(pidff_effect_operation_status)];
197
198 int pid_id[PID_EFFECTS_MAX];
199};
200
201/*
202 * Scale an unsigned value with range 0..max for the given field
203 */
204static int pidff_rescale(int i, int max, struct hid_field *field)
205{
206 return i * (field->logical_maximum - field->logical_minimum) / max +
207 field->logical_minimum;
208}
209
210/*
211 * Scale a signed value in range -0x8000..0x7fff for the given field
212 */
213static int pidff_rescale_signed(int i, struct hid_field *field)
214{
215 return i == 0 ? 0 : i >
216 0 ? i * field->logical_maximum / 0x7fff : i *
217 field->logical_minimum / -0x8000;
218}
219
220static void pidff_set(struct pidff_usage *usage, u16 value)
221{
222 usage->value[0] = pidff_rescale(value, 0xffff, usage->field);
Joe Perches4291ee32010-12-09 19:29:03 -0800223 pr_debug("calculated from %d to %d\n", value, usage->value[0]);
Anssi Hannula224ee882006-07-19 01:40:47 -0400224}
225
226static void pidff_set_signed(struct pidff_usage *usage, s16 value)
227{
228 if (usage->field->logical_minimum < 0)
229 usage->value[0] = pidff_rescale_signed(value, usage->field);
230 else {
231 if (value < 0)
232 usage->value[0] =
233 pidff_rescale(-value, 0x8000, usage->field);
234 else
235 usage->value[0] =
236 pidff_rescale(value, 0x7fff, usage->field);
237 }
Joe Perches4291ee32010-12-09 19:29:03 -0800238 pr_debug("calculated from %d to %d\n", value, usage->value[0]);
Anssi Hannula224ee882006-07-19 01:40:47 -0400239}
240
241/*
242 * Send envelope report to the device
243 */
244static void pidff_set_envelope_report(struct pidff_device *pidff,
245 struct ff_envelope *envelope)
246{
247 pidff->set_envelope[PID_EFFECT_BLOCK_INDEX].value[0] =
248 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
249
250 pidff->set_envelope[PID_ATTACK_LEVEL].value[0] =
251 pidff_rescale(envelope->attack_level >
252 0x7fff ? 0x7fff : envelope->attack_level, 0x7fff,
253 pidff->set_envelope[PID_ATTACK_LEVEL].field);
254 pidff->set_envelope[PID_FADE_LEVEL].value[0] =
255 pidff_rescale(envelope->fade_level >
256 0x7fff ? 0x7fff : envelope->fade_level, 0x7fff,
257 pidff->set_envelope[PID_FADE_LEVEL].field);
258
259 pidff->set_envelope[PID_ATTACK_TIME].value[0] = envelope->attack_length;
260 pidff->set_envelope[PID_FADE_TIME].value[0] = envelope->fade_length;
261
Joe Perches4291ee32010-12-09 19:29:03 -0800262 hid_dbg(pidff->hid, "attack %u => %d\n",
263 envelope->attack_level,
264 pidff->set_envelope[PID_ATTACK_LEVEL].value[0]);
Anssi Hannula224ee882006-07-19 01:40:47 -0400265
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100266 hid_hw_request(pidff->hid, pidff->reports[PID_SET_ENVELOPE],
267 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400268}
269
270/*
271 * Test if the new envelope differs from old one
272 */
273static int pidff_needs_set_envelope(struct ff_envelope *envelope,
274 struct ff_envelope *old)
275{
276 return envelope->attack_level != old->attack_level ||
277 envelope->fade_level != old->fade_level ||
278 envelope->attack_length != old->attack_length ||
279 envelope->fade_length != old->fade_length;
280}
281
282/*
283 * Send constant force report to the device
284 */
285static void pidff_set_constant_force_report(struct pidff_device *pidff,
286 struct ff_effect *effect)
287{
288 pidff->set_constant[PID_EFFECT_BLOCK_INDEX].value[0] =
289 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
290 pidff_set_signed(&pidff->set_constant[PID_MAGNITUDE],
291 effect->u.constant.level);
292
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100293 hid_hw_request(pidff->hid, pidff->reports[PID_SET_CONSTANT],
294 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400295}
296
297/*
298 * Test if the constant parameters have changed between effects
299 */
300static int pidff_needs_set_constant(struct ff_effect *effect,
301 struct ff_effect *old)
302{
303 return effect->u.constant.level != old->u.constant.level;
304}
305
306/*
307 * Send set effect report to the device
308 */
309static void pidff_set_effect_report(struct pidff_device *pidff,
310 struct ff_effect *effect)
311{
312 pidff->set_effect[PID_EFFECT_BLOCK_INDEX].value[0] =
313 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
314 pidff->set_effect_type->value[0] =
315 pidff->create_new_effect_type->value[0];
316 pidff->set_effect[PID_DURATION].value[0] = effect->replay.length;
317 pidff->set_effect[PID_TRIGGER_BUTTON].value[0] = effect->trigger.button;
318 pidff->set_effect[PID_TRIGGER_REPEAT_INT].value[0] =
319 effect->trigger.interval;
320 pidff->set_effect[PID_GAIN].value[0] =
321 pidff->set_effect[PID_GAIN].field->logical_maximum;
322 pidff->set_effect[PID_DIRECTION_ENABLE].value[0] = 1;
323 pidff->effect_direction->value[0] =
324 pidff_rescale(effect->direction, 0xffff,
325 pidff->effect_direction);
326 pidff->set_effect[PID_START_DELAY].value[0] = effect->replay.delay;
327
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100328 hid_hw_request(pidff->hid, pidff->reports[PID_SET_EFFECT],
329 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400330}
331
332/*
333 * Test if the values used in set_effect have changed
334 */
335static int pidff_needs_set_effect(struct ff_effect *effect,
336 struct ff_effect *old)
337{
338 return effect->replay.length != old->replay.length ||
339 effect->trigger.interval != old->trigger.interval ||
340 effect->trigger.button != old->trigger.button ||
341 effect->direction != old->direction ||
342 effect->replay.delay != old->replay.delay;
343}
344
345/*
346 * Send periodic effect report to the device
347 */
348static void pidff_set_periodic_report(struct pidff_device *pidff,
349 struct ff_effect *effect)
350{
351 pidff->set_periodic[PID_EFFECT_BLOCK_INDEX].value[0] =
352 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
353 pidff_set_signed(&pidff->set_periodic[PID_MAGNITUDE],
354 effect->u.periodic.magnitude);
355 pidff_set_signed(&pidff->set_periodic[PID_OFFSET],
356 effect->u.periodic.offset);
357 pidff_set(&pidff->set_periodic[PID_PHASE], effect->u.periodic.phase);
358 pidff->set_periodic[PID_PERIOD].value[0] = effect->u.periodic.period;
359
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100360 hid_hw_request(pidff->hid, pidff->reports[PID_SET_PERIODIC],
361 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400362
363}
364
365/*
366 * Test if periodic effect parameters have changed
367 */
368static int pidff_needs_set_periodic(struct ff_effect *effect,
369 struct ff_effect *old)
370{
371 return effect->u.periodic.magnitude != old->u.periodic.magnitude ||
372 effect->u.periodic.offset != old->u.periodic.offset ||
373 effect->u.periodic.phase != old->u.periodic.phase ||
374 effect->u.periodic.period != old->u.periodic.period;
375}
376
377/*
378 * Send condition effect reports to the device
379 */
380static void pidff_set_condition_report(struct pidff_device *pidff,
381 struct ff_effect *effect)
382{
383 int i;
384
385 pidff->set_condition[PID_EFFECT_BLOCK_INDEX].value[0] =
386 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
387
388 for (i = 0; i < 2; i++) {
389 pidff->set_condition[PID_PARAM_BLOCK_OFFSET].value[0] = i;
390 pidff_set_signed(&pidff->set_condition[PID_CP_OFFSET],
391 effect->u.condition[i].center);
392 pidff_set_signed(&pidff->set_condition[PID_POS_COEFFICIENT],
393 effect->u.condition[i].right_coeff);
394 pidff_set_signed(&pidff->set_condition[PID_NEG_COEFFICIENT],
395 effect->u.condition[i].left_coeff);
396 pidff_set(&pidff->set_condition[PID_POS_SATURATION],
397 effect->u.condition[i].right_saturation);
398 pidff_set(&pidff->set_condition[PID_NEG_SATURATION],
399 effect->u.condition[i].left_saturation);
400 pidff_set(&pidff->set_condition[PID_DEAD_BAND],
401 effect->u.condition[i].deadband);
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100402 hid_hw_request(pidff->hid, pidff->reports[PID_SET_CONDITION],
403 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400404 }
405}
406
407/*
408 * Test if condition effect parameters have changed
409 */
410static int pidff_needs_set_condition(struct ff_effect *effect,
411 struct ff_effect *old)
412{
413 int i;
414 int ret = 0;
415
416 for (i = 0; i < 2; i++) {
417 struct ff_condition_effect *cond = &effect->u.condition[i];
418 struct ff_condition_effect *old_cond = &old->u.condition[i];
419
420 ret |= cond->center != old_cond->center ||
421 cond->right_coeff != old_cond->right_coeff ||
422 cond->left_coeff != old_cond->left_coeff ||
423 cond->right_saturation != old_cond->right_saturation ||
424 cond->left_saturation != old_cond->left_saturation ||
425 cond->deadband != old_cond->deadband;
426 }
427
428 return ret;
429}
430
431/*
432 * Send ramp force report to the device
433 */
434static void pidff_set_ramp_force_report(struct pidff_device *pidff,
435 struct ff_effect *effect)
436{
437 pidff->set_ramp[PID_EFFECT_BLOCK_INDEX].value[0] =
438 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
439 pidff_set_signed(&pidff->set_ramp[PID_RAMP_START],
440 effect->u.ramp.start_level);
441 pidff_set_signed(&pidff->set_ramp[PID_RAMP_END],
442 effect->u.ramp.end_level);
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100443 hid_hw_request(pidff->hid, pidff->reports[PID_SET_RAMP],
444 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400445}
446
447/*
448 * Test if ramp force parameters have changed
449 */
450static int pidff_needs_set_ramp(struct ff_effect *effect, struct ff_effect *old)
451{
452 return effect->u.ramp.start_level != old->u.ramp.start_level ||
453 effect->u.ramp.end_level != old->u.ramp.end_level;
454}
455
456/*
457 * Send a request for effect upload to the device
458 *
459 * Returns 0 if device reported success, -ENOSPC if the device reported memory
460 * is full. Upon unknown response the function will retry for 60 times, if
461 * still unsuccessful -EIO is returned.
462 */
463static int pidff_request_effect_upload(struct pidff_device *pidff, int efnum)
464{
465 int j;
466
467 pidff->create_new_effect_type->value[0] = efnum;
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100468 hid_hw_request(pidff->hid, pidff->reports[PID_CREATE_NEW_EFFECT],
469 HID_REQ_SET_REPORT);
Joe Perches4291ee32010-12-09 19:29:03 -0800470 hid_dbg(pidff->hid, "create_new_effect sent, type: %d\n", efnum);
Anssi Hannula224ee882006-07-19 01:40:47 -0400471
472 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0] = 0;
473 pidff->block_load_status->value[0] = 0;
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +0100474 hid_hw_wait(pidff->hid);
Anssi Hannula224ee882006-07-19 01:40:47 -0400475
476 for (j = 0; j < 60; j++) {
Joe Perches4291ee32010-12-09 19:29:03 -0800477 hid_dbg(pidff->hid, "pid_block_load requested\n");
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100478 hid_hw_request(pidff->hid, pidff->reports[PID_BLOCK_LOAD],
479 HID_REQ_GET_REPORT);
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +0100480 hid_hw_wait(pidff->hid);
Anssi Hannula224ee882006-07-19 01:40:47 -0400481 if (pidff->block_load_status->value[0] ==
482 pidff->status_id[PID_BLOCK_LOAD_SUCCESS]) {
Joe Perches4291ee32010-12-09 19:29:03 -0800483 hid_dbg(pidff->hid, "device reported free memory: %d bytes\n",
484 pidff->block_load[PID_RAM_POOL_AVAILABLE].value ?
485 pidff->block_load[PID_RAM_POOL_AVAILABLE].value[0] : -1);
Anssi Hannula224ee882006-07-19 01:40:47 -0400486 return 0;
487 }
488 if (pidff->block_load_status->value[0] ==
489 pidff->status_id[PID_BLOCK_LOAD_FULL]) {
Joe Perches4291ee32010-12-09 19:29:03 -0800490 hid_dbg(pidff->hid, "not enough memory free: %d bytes\n",
491 pidff->block_load[PID_RAM_POOL_AVAILABLE].value ?
Anssi Hannula224ee882006-07-19 01:40:47 -0400492 pidff->block_load[PID_RAM_POOL_AVAILABLE].value[0] : -1);
493 return -ENOSPC;
494 }
495 }
Joe Perches4291ee32010-12-09 19:29:03 -0800496 hid_err(pidff->hid, "pid_block_load failed 60 times\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400497 return -EIO;
498}
499
500/*
501 * Play the effect with PID id n times
502 */
503static void pidff_playback_pid(struct pidff_device *pidff, int pid_id, int n)
504{
505 pidff->effect_operation[PID_EFFECT_BLOCK_INDEX].value[0] = pid_id;
506
507 if (n == 0) {
508 pidff->effect_operation_status->value[0] =
509 pidff->operation_id[PID_EFFECT_STOP];
510 } else {
511 pidff->effect_operation_status->value[0] =
512 pidff->operation_id[PID_EFFECT_START];
513 pidff->effect_operation[PID_LOOP_COUNT].value[0] = n;
514 }
515
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100516 hid_hw_request(pidff->hid, pidff->reports[PID_EFFECT_OPERATION],
517 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400518}
519
520/**
521 * Play the effect with effect id @effect_id for @value times
522 */
523static int pidff_playback(struct input_dev *dev, int effect_id, int value)
524{
525 struct pidff_device *pidff = dev->ff->private;
526
527 pidff_playback_pid(pidff, pidff->pid_id[effect_id], value);
528
529 return 0;
530}
531
532/*
533 * Erase effect with PID id
534 */
535static void pidff_erase_pid(struct pidff_device *pidff, int pid_id)
536{
537 pidff->block_free[PID_EFFECT_BLOCK_INDEX].value[0] = pid_id;
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100538 hid_hw_request(pidff->hid, pidff->reports[PID_BLOCK_FREE],
539 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400540}
541
542/*
543 * Stop and erase effect with effect_id
544 */
545static int pidff_erase_effect(struct input_dev *dev, int effect_id)
546{
547 struct pidff_device *pidff = dev->ff->private;
548 int pid_id = pidff->pid_id[effect_id];
549
Joe Perches4291ee32010-12-09 19:29:03 -0800550 hid_dbg(pidff->hid, "starting to erase %d/%d\n",
551 effect_id, pidff->pid_id[effect_id]);
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200552 /* Wait for the queue to clear. We do not want a full fifo to
553 prevent the effect removal. */
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +0100554 hid_hw_wait(pidff->hid);
Anssi Hannula224ee882006-07-19 01:40:47 -0400555 pidff_playback_pid(pidff, pid_id, 0);
556 pidff_erase_pid(pidff, pid_id);
557
558 return 0;
559}
560
561/*
562 * Effect upload handler
563 */
564static int pidff_upload_effect(struct input_dev *dev, struct ff_effect *effect,
565 struct ff_effect *old)
566{
567 struct pidff_device *pidff = dev->ff->private;
568 int type_id;
569 int error;
570
Jim Keire8f46e42015-02-26 09:14:03 +0000571 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0] = 0;
Jiri Kosinab9e9cd32015-03-27 16:03:26 +0100572 if (old) {
Jim Keire8f46e42015-02-26 09:14:03 +0000573 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0] =
574 pidff->pid_id[effect->id];
575 }
576
Anssi Hannula224ee882006-07-19 01:40:47 -0400577 switch (effect->type) {
578 case FF_CONSTANT:
579 if (!old) {
580 error = pidff_request_effect_upload(pidff,
581 pidff->type_id[PID_CONSTANT]);
582 if (error)
583 return error;
584 }
585 if (!old || pidff_needs_set_effect(effect, old))
586 pidff_set_effect_report(pidff, effect);
587 if (!old || pidff_needs_set_constant(effect, old))
588 pidff_set_constant_force_report(pidff, effect);
589 if (!old ||
590 pidff_needs_set_envelope(&effect->u.constant.envelope,
591 &old->u.constant.envelope))
592 pidff_set_envelope_report(pidff,
593 &effect->u.constant.envelope);
594 break;
595
596 case FF_PERIODIC:
597 if (!old) {
598 switch (effect->u.periodic.waveform) {
599 case FF_SQUARE:
600 type_id = PID_SQUARE;
601 break;
602 case FF_TRIANGLE:
603 type_id = PID_TRIANGLE;
604 break;
605 case FF_SINE:
606 type_id = PID_SINE;
607 break;
608 case FF_SAW_UP:
609 type_id = PID_SAW_UP;
610 break;
611 case FF_SAW_DOWN:
612 type_id = PID_SAW_DOWN;
613 break;
614 default:
Joe Perches4291ee32010-12-09 19:29:03 -0800615 hid_err(pidff->hid, "invalid waveform\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400616 return -EINVAL;
617 }
618
619 error = pidff_request_effect_upload(pidff,
620 pidff->type_id[type_id]);
621 if (error)
622 return error;
623 }
624 if (!old || pidff_needs_set_effect(effect, old))
625 pidff_set_effect_report(pidff, effect);
626 if (!old || pidff_needs_set_periodic(effect, old))
627 pidff_set_periodic_report(pidff, effect);
628 if (!old ||
629 pidff_needs_set_envelope(&effect->u.periodic.envelope,
630 &old->u.periodic.envelope))
631 pidff_set_envelope_report(pidff,
632 &effect->u.periodic.envelope);
633 break;
634
635 case FF_RAMP:
636 if (!old) {
637 error = pidff_request_effect_upload(pidff,
638 pidff->type_id[PID_RAMP]);
639 if (error)
640 return error;
641 }
642 if (!old || pidff_needs_set_effect(effect, old))
643 pidff_set_effect_report(pidff, effect);
644 if (!old || pidff_needs_set_ramp(effect, old))
645 pidff_set_ramp_force_report(pidff, effect);
646 if (!old ||
647 pidff_needs_set_envelope(&effect->u.ramp.envelope,
648 &old->u.ramp.envelope))
649 pidff_set_envelope_report(pidff,
650 &effect->u.ramp.envelope);
651 break;
652
653 case FF_SPRING:
654 if (!old) {
655 error = pidff_request_effect_upload(pidff,
656 pidff->type_id[PID_SPRING]);
657 if (error)
658 return error;
659 }
660 if (!old || pidff_needs_set_effect(effect, old))
661 pidff_set_effect_report(pidff, effect);
662 if (!old || pidff_needs_set_condition(effect, old))
663 pidff_set_condition_report(pidff, effect);
664 break;
665
666 case FF_FRICTION:
667 if (!old) {
668 error = pidff_request_effect_upload(pidff,
669 pidff->type_id[PID_FRICTION]);
670 if (error)
671 return error;
672 }
673 if (!old || pidff_needs_set_effect(effect, old))
674 pidff_set_effect_report(pidff, effect);
675 if (!old || pidff_needs_set_condition(effect, old))
676 pidff_set_condition_report(pidff, effect);
677 break;
678
679 case FF_DAMPER:
680 if (!old) {
681 error = pidff_request_effect_upload(pidff,
682 pidff->type_id[PID_DAMPER]);
683 if (error)
684 return error;
685 }
686 if (!old || pidff_needs_set_effect(effect, old))
687 pidff_set_effect_report(pidff, effect);
688 if (!old || pidff_needs_set_condition(effect, old))
689 pidff_set_condition_report(pidff, effect);
690 break;
691
692 case FF_INERTIA:
693 if (!old) {
694 error = pidff_request_effect_upload(pidff,
695 pidff->type_id[PID_INERTIA]);
696 if (error)
697 return error;
698 }
699 if (!old || pidff_needs_set_effect(effect, old))
700 pidff_set_effect_report(pidff, effect);
701 if (!old || pidff_needs_set_condition(effect, old))
702 pidff_set_condition_report(pidff, effect);
703 break;
704
705 default:
Joe Perches4291ee32010-12-09 19:29:03 -0800706 hid_err(pidff->hid, "invalid type\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400707 return -EINVAL;
708 }
709
710 if (!old)
711 pidff->pid_id[effect->id] =
712 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
713
Joe Perches4291ee32010-12-09 19:29:03 -0800714 hid_dbg(pidff->hid, "uploaded\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400715
716 return 0;
717}
718
719/*
720 * set_gain() handler
721 */
722static void pidff_set_gain(struct input_dev *dev, u16 gain)
723{
724 struct pidff_device *pidff = dev->ff->private;
725
726 pidff_set(&pidff->device_gain[PID_DEVICE_GAIN_FIELD], gain);
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100727 hid_hw_request(pidff->hid, pidff->reports[PID_DEVICE_GAIN],
728 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400729}
730
731static void pidff_autocenter(struct pidff_device *pidff, u16 magnitude)
732{
733 struct hid_field *field =
734 pidff->block_load[PID_EFFECT_BLOCK_INDEX].field;
735
736 if (!magnitude) {
737 pidff_playback_pid(pidff, field->logical_minimum, 0);
738 return;
739 }
740
741 pidff_playback_pid(pidff, field->logical_minimum, 1);
742
743 pidff->set_effect[PID_EFFECT_BLOCK_INDEX].value[0] =
744 pidff->block_load[PID_EFFECT_BLOCK_INDEX].field->logical_minimum;
745 pidff->set_effect_type->value[0] = pidff->type_id[PID_SPRING];
746 pidff->set_effect[PID_DURATION].value[0] = 0;
747 pidff->set_effect[PID_TRIGGER_BUTTON].value[0] = 0;
748 pidff->set_effect[PID_TRIGGER_REPEAT_INT].value[0] = 0;
749 pidff_set(&pidff->set_effect[PID_GAIN], magnitude);
Diogo Kastrup816cbfd2007-06-19 14:16:15 +0200750 pidff->set_effect[PID_DIRECTION_ENABLE].value[0] = 1;
Anssi Hannula224ee882006-07-19 01:40:47 -0400751 pidff->set_effect[PID_START_DELAY].value[0] = 0;
752
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100753 hid_hw_request(pidff->hid, pidff->reports[PID_SET_EFFECT],
754 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -0400755}
756
757/*
758 * pidff_set_autocenter() handler
759 */
760static void pidff_set_autocenter(struct input_dev *dev, u16 magnitude)
761{
762 struct pidff_device *pidff = dev->ff->private;
763
764 pidff_autocenter(pidff, magnitude);
765}
766
767/*
768 * Find fields from a report and fill a pidff_usage
769 */
770static int pidff_find_fields(struct pidff_usage *usage, const u8 *table,
771 struct hid_report *report, int count, int strict)
772{
773 int i, j, k, found;
774
775 for (k = 0; k < count; k++) {
776 found = 0;
777 for (i = 0; i < report->maxfield; i++) {
778 if (report->field[i]->maxusage !=
779 report->field[i]->report_count) {
Joe Perches4291ee32010-12-09 19:29:03 -0800780 pr_debug("maxusage and report_count do not match, skipping\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400781 continue;
782 }
783 for (j = 0; j < report->field[i]->maxusage; j++) {
784 if (report->field[i]->usage[j].hid ==
785 (HID_UP_PID | table[k])) {
Joe Perches4291ee32010-12-09 19:29:03 -0800786 pr_debug("found %d at %d->%d\n",
787 k, i, j);
Anssi Hannula224ee882006-07-19 01:40:47 -0400788 usage[k].field = report->field[i];
789 usage[k].value =
790 &report->field[i]->value[j];
791 found = 1;
792 break;
793 }
794 }
795 if (found)
796 break;
797 }
798 if (!found && strict) {
Joe Perches4291ee32010-12-09 19:29:03 -0800799 pr_debug("failed to locate %d\n", k);
Anssi Hannula224ee882006-07-19 01:40:47 -0400800 return -1;
801 }
802 }
803 return 0;
804}
805
806/*
807 * Return index into pidff_reports for the given usage
808 */
809static int pidff_check_usage(int usage)
810{
811 int i;
812
813 for (i = 0; i < sizeof(pidff_reports); i++)
814 if (usage == (HID_UP_PID | pidff_reports[i]))
815 return i;
816
817 return -1;
818}
819
820/*
821 * Find the reports and fill pidff->reports[]
822 * report_type specifies either OUTPUT or FEATURE reports
823 */
824static void pidff_find_reports(struct hid_device *hid, int report_type,
825 struct pidff_device *pidff)
826{
827 struct hid_report *report;
828 int i, ret;
829
830 list_for_each_entry(report,
831 &hid->report_enum[report_type].report_list, list) {
832 if (report->maxfield < 1)
833 continue;
834 ret = pidff_check_usage(report->field[0]->logical);
835 if (ret != -1) {
Joe Perches4291ee32010-12-09 19:29:03 -0800836 hid_dbg(hid, "found usage 0x%02x from field->logical\n",
837 pidff_reports[ret]);
Anssi Hannula224ee882006-07-19 01:40:47 -0400838 pidff->reports[ret] = report;
839 continue;
840 }
841
842 /*
843 * Sometimes logical collections are stacked to indicate
844 * different usages for the report and the field, in which
845 * case we want the usage of the parent. However, Linux HID
846 * implementation hides this fact, so we have to dig it up
847 * ourselves
848 */
849 i = report->field[0]->usage[0].collection_index;
850 if (i <= 0 ||
851 hid->collection[i - 1].type != HID_COLLECTION_LOGICAL)
852 continue;
853 ret = pidff_check_usage(hid->collection[i - 1].usage);
854 if (ret != -1 && !pidff->reports[ret]) {
Joe Perches4291ee32010-12-09 19:29:03 -0800855 hid_dbg(hid,
856 "found usage 0x%02x from collection array\n",
857 pidff_reports[ret]);
Anssi Hannula224ee882006-07-19 01:40:47 -0400858 pidff->reports[ret] = report;
859 }
860 }
861}
862
863/*
864 * Test if the required reports have been found
865 */
866static int pidff_reports_ok(struct pidff_device *pidff)
867{
868 int i;
869
870 for (i = 0; i <= PID_REQUIRED_REPORTS; i++) {
871 if (!pidff->reports[i]) {
Joe Perches4291ee32010-12-09 19:29:03 -0800872 hid_dbg(pidff->hid, "%d missing\n", i);
Anssi Hannula224ee882006-07-19 01:40:47 -0400873 return 0;
874 }
875 }
876
877 return 1;
878}
879
880/*
881 * Find a field with a specific usage within a report
882 */
883static struct hid_field *pidff_find_special_field(struct hid_report *report,
884 int usage, int enforce_min)
885{
886 int i;
887
888 for (i = 0; i < report->maxfield; i++) {
889 if (report->field[i]->logical == (HID_UP_PID | usage) &&
890 report->field[i]->report_count > 0) {
891 if (!enforce_min ||
892 report->field[i]->logical_minimum == 1)
893 return report->field[i];
894 else {
Joe Perches4291ee32010-12-09 19:29:03 -0800895 pr_err("logical_minimum is not 1 as it should be\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400896 return NULL;
897 }
898 }
899 }
900 return NULL;
901}
902
903/*
904 * Fill a pidff->*_id struct table
905 */
906static int pidff_find_special_keys(int *keys, struct hid_field *fld,
907 const u8 *usagetable, int count)
908{
909
910 int i, j;
911 int found = 0;
912
913 for (i = 0; i < count; i++) {
914 for (j = 0; j < fld->maxusage; j++) {
915 if (fld->usage[j].hid == (HID_UP_PID | usagetable[i])) {
916 keys[i] = j + 1;
917 found++;
918 break;
919 }
920 }
921 }
922 return found;
923}
924
925#define PIDFF_FIND_SPECIAL_KEYS(keys, field, name) \
926 pidff_find_special_keys(pidff->keys, pidff->field, pidff_ ## name, \
927 sizeof(pidff_ ## name))
928
929/*
930 * Find and check the special fields
931 */
932static int pidff_find_special_fields(struct pidff_device *pidff)
933{
Joe Perches4291ee32010-12-09 19:29:03 -0800934 hid_dbg(pidff->hid, "finding special fields\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400935
936 pidff->create_new_effect_type =
937 pidff_find_special_field(pidff->reports[PID_CREATE_NEW_EFFECT],
938 0x25, 1);
939 pidff->set_effect_type =
940 pidff_find_special_field(pidff->reports[PID_SET_EFFECT],
941 0x25, 1);
942 pidff->effect_direction =
943 pidff_find_special_field(pidff->reports[PID_SET_EFFECT],
944 0x57, 0);
945 pidff->device_control =
946 pidff_find_special_field(pidff->reports[PID_DEVICE_CONTROL],
947 0x96, 1);
948 pidff->block_load_status =
949 pidff_find_special_field(pidff->reports[PID_BLOCK_LOAD],
950 0x8b, 1);
951 pidff->effect_operation_status =
952 pidff_find_special_field(pidff->reports[PID_EFFECT_OPERATION],
953 0x78, 1);
954
Joe Perches4291ee32010-12-09 19:29:03 -0800955 hid_dbg(pidff->hid, "search done\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400956
957 if (!pidff->create_new_effect_type || !pidff->set_effect_type) {
Joe Perches4291ee32010-12-09 19:29:03 -0800958 hid_err(pidff->hid, "effect lists not found\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400959 return -1;
960 }
961
962 if (!pidff->effect_direction) {
Joe Perches4291ee32010-12-09 19:29:03 -0800963 hid_err(pidff->hid, "direction field not found\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400964 return -1;
965 }
966
967 if (!pidff->device_control) {
Joe Perches4291ee32010-12-09 19:29:03 -0800968 hid_err(pidff->hid, "device control field not found\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400969 return -1;
970 }
971
972 if (!pidff->block_load_status) {
Joe Perches4291ee32010-12-09 19:29:03 -0800973 hid_err(pidff->hid, "block load status field not found\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400974 return -1;
975 }
976
977 if (!pidff->effect_operation_status) {
Joe Perches4291ee32010-12-09 19:29:03 -0800978 hid_err(pidff->hid, "effect operation field not found\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400979 return -1;
980 }
981
982 pidff_find_special_keys(pidff->control_id, pidff->device_control,
983 pidff_device_control,
984 sizeof(pidff_device_control));
985
986 PIDFF_FIND_SPECIAL_KEYS(control_id, device_control, device_control);
987
988 if (!PIDFF_FIND_SPECIAL_KEYS(type_id, create_new_effect_type,
989 effect_types)) {
Joe Perches4291ee32010-12-09 19:29:03 -0800990 hid_err(pidff->hid, "no effect types found\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400991 return -1;
992 }
993
994 if (PIDFF_FIND_SPECIAL_KEYS(status_id, block_load_status,
995 block_load_status) !=
996 sizeof(pidff_block_load_status)) {
Joe Perches4291ee32010-12-09 19:29:03 -0800997 hid_err(pidff->hid,
998 "block load status identifiers not found\n");
Anssi Hannula224ee882006-07-19 01:40:47 -0400999 return -1;
1000 }
1001
1002 if (PIDFF_FIND_SPECIAL_KEYS(operation_id, effect_operation_status,
1003 effect_operation_status) !=
1004 sizeof(pidff_effect_operation_status)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001005 hid_err(pidff->hid, "effect operation identifiers not found\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001006 return -1;
1007 }
1008
1009 return 0;
1010}
1011
1012/**
1013 * Find the implemented effect types
1014 */
1015static int pidff_find_effects(struct pidff_device *pidff,
1016 struct input_dev *dev)
1017{
1018 int i;
1019
1020 for (i = 0; i < sizeof(pidff_effect_types); i++) {
1021 int pidff_type = pidff->type_id[i];
1022 if (pidff->set_effect_type->usage[pidff_type].hid !=
1023 pidff->create_new_effect_type->usage[pidff_type].hid) {
Joe Perches4291ee32010-12-09 19:29:03 -08001024 hid_err(pidff->hid,
1025 "effect type number %d is invalid\n", i);
Anssi Hannula224ee882006-07-19 01:40:47 -04001026 return -1;
1027 }
1028 }
1029
1030 if (pidff->type_id[PID_CONSTANT])
1031 set_bit(FF_CONSTANT, dev->ffbit);
1032 if (pidff->type_id[PID_RAMP])
1033 set_bit(FF_RAMP, dev->ffbit);
1034 if (pidff->type_id[PID_SQUARE]) {
1035 set_bit(FF_SQUARE, dev->ffbit);
1036 set_bit(FF_PERIODIC, dev->ffbit);
1037 }
1038 if (pidff->type_id[PID_SINE]) {
1039 set_bit(FF_SINE, dev->ffbit);
1040 set_bit(FF_PERIODIC, dev->ffbit);
1041 }
1042 if (pidff->type_id[PID_TRIANGLE]) {
1043 set_bit(FF_TRIANGLE, dev->ffbit);
1044 set_bit(FF_PERIODIC, dev->ffbit);
1045 }
1046 if (pidff->type_id[PID_SAW_UP]) {
1047 set_bit(FF_SAW_UP, dev->ffbit);
1048 set_bit(FF_PERIODIC, dev->ffbit);
1049 }
1050 if (pidff->type_id[PID_SAW_DOWN]) {
1051 set_bit(FF_SAW_DOWN, dev->ffbit);
1052 set_bit(FF_PERIODIC, dev->ffbit);
1053 }
1054 if (pidff->type_id[PID_SPRING])
1055 set_bit(FF_SPRING, dev->ffbit);
1056 if (pidff->type_id[PID_DAMPER])
1057 set_bit(FF_DAMPER, dev->ffbit);
1058 if (pidff->type_id[PID_INERTIA])
1059 set_bit(FF_INERTIA, dev->ffbit);
1060 if (pidff->type_id[PID_FRICTION])
1061 set_bit(FF_FRICTION, dev->ffbit);
1062
1063 return 0;
1064
1065}
1066
1067#define PIDFF_FIND_FIELDS(name, report, strict) \
1068 pidff_find_fields(pidff->name, pidff_ ## name, \
1069 pidff->reports[report], \
1070 sizeof(pidff_ ## name), strict)
1071
1072/*
1073 * Fill and check the pidff_usages
1074 */
1075static int pidff_init_fields(struct pidff_device *pidff, struct input_dev *dev)
1076{
1077 int envelope_ok = 0;
1078
1079 if (PIDFF_FIND_FIELDS(set_effect, PID_SET_EFFECT, 1)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001080 hid_err(pidff->hid, "unknown set_effect report layout\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001081 return -ENODEV;
1082 }
1083
1084 PIDFF_FIND_FIELDS(block_load, PID_BLOCK_LOAD, 0);
1085 if (!pidff->block_load[PID_EFFECT_BLOCK_INDEX].value) {
Joe Perches4291ee32010-12-09 19:29:03 -08001086 hid_err(pidff->hid, "unknown pid_block_load report layout\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001087 return -ENODEV;
1088 }
1089
1090 if (PIDFF_FIND_FIELDS(effect_operation, PID_EFFECT_OPERATION, 1)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001091 hid_err(pidff->hid, "unknown effect_operation report layout\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001092 return -ENODEV;
1093 }
1094
1095 if (PIDFF_FIND_FIELDS(block_free, PID_BLOCK_FREE, 1)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001096 hid_err(pidff->hid, "unknown pid_block_free report layout\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001097 return -ENODEV;
1098 }
1099
1100 if (!PIDFF_FIND_FIELDS(set_envelope, PID_SET_ENVELOPE, 1))
1101 envelope_ok = 1;
1102
1103 if (pidff_find_special_fields(pidff) || pidff_find_effects(pidff, dev))
1104 return -ENODEV;
1105
1106 if (!envelope_ok) {
1107 if (test_and_clear_bit(FF_CONSTANT, dev->ffbit))
Joe Perches4291ee32010-12-09 19:29:03 -08001108 hid_warn(pidff->hid,
1109 "has constant effect but no envelope\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001110 if (test_and_clear_bit(FF_RAMP, dev->ffbit))
Joe Perches4291ee32010-12-09 19:29:03 -08001111 hid_warn(pidff->hid,
1112 "has ramp effect but no envelope\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001113
1114 if (test_and_clear_bit(FF_PERIODIC, dev->ffbit))
Joe Perches4291ee32010-12-09 19:29:03 -08001115 hid_warn(pidff->hid,
1116 "has periodic effect but no envelope\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001117 }
1118
1119 if (test_bit(FF_CONSTANT, dev->ffbit) &&
1120 PIDFF_FIND_FIELDS(set_constant, PID_SET_CONSTANT, 1)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001121 hid_warn(pidff->hid, "unknown constant effect layout\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001122 clear_bit(FF_CONSTANT, dev->ffbit);
1123 }
1124
1125 if (test_bit(FF_RAMP, dev->ffbit) &&
1126 PIDFF_FIND_FIELDS(set_ramp, PID_SET_RAMP, 1)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001127 hid_warn(pidff->hid, "unknown ramp effect layout\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001128 clear_bit(FF_RAMP, dev->ffbit);
1129 }
1130
1131 if ((test_bit(FF_SPRING, dev->ffbit) ||
1132 test_bit(FF_DAMPER, dev->ffbit) ||
1133 test_bit(FF_FRICTION, dev->ffbit) ||
1134 test_bit(FF_INERTIA, dev->ffbit)) &&
1135 PIDFF_FIND_FIELDS(set_condition, PID_SET_CONDITION, 1)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001136 hid_warn(pidff->hid, "unknown condition effect layout\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001137 clear_bit(FF_SPRING, dev->ffbit);
1138 clear_bit(FF_DAMPER, dev->ffbit);
1139 clear_bit(FF_FRICTION, dev->ffbit);
1140 clear_bit(FF_INERTIA, dev->ffbit);
1141 }
1142
1143 if (test_bit(FF_PERIODIC, dev->ffbit) &&
1144 PIDFF_FIND_FIELDS(set_periodic, PID_SET_PERIODIC, 1)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001145 hid_warn(pidff->hid, "unknown periodic effect layout\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001146 clear_bit(FF_PERIODIC, dev->ffbit);
1147 }
1148
1149 PIDFF_FIND_FIELDS(pool, PID_POOL, 0);
1150
1151 if (!PIDFF_FIND_FIELDS(device_gain, PID_DEVICE_GAIN, 1))
1152 set_bit(FF_GAIN, dev->ffbit);
1153
1154 return 0;
1155}
1156
1157/*
1158 * Reset the device
1159 */
1160static void pidff_reset(struct pidff_device *pidff)
1161{
1162 struct hid_device *hid = pidff->hid;
1163 int i = 0;
1164
1165 pidff->device_control->value[0] = pidff->control_id[PID_RESET];
1166 /* We reset twice as sometimes hid_wait_io isn't waiting long enough */
Benjamin Tissoiresd88142722013-02-25 11:31:46 +01001167 hid_hw_request(hid, pidff->reports[PID_DEVICE_CONTROL], HID_REQ_SET_REPORT);
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +01001168 hid_hw_wait(hid);
Benjamin Tissoiresd88142722013-02-25 11:31:46 +01001169 hid_hw_request(hid, pidff->reports[PID_DEVICE_CONTROL], HID_REQ_SET_REPORT);
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +01001170 hid_hw_wait(hid);
Anssi Hannula224ee882006-07-19 01:40:47 -04001171
1172 pidff->device_control->value[0] =
1173 pidff->control_id[PID_ENABLE_ACTUATORS];
Benjamin Tissoiresd88142722013-02-25 11:31:46 +01001174 hid_hw_request(hid, pidff->reports[PID_DEVICE_CONTROL], HID_REQ_SET_REPORT);
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +01001175 hid_hw_wait(hid);
Anssi Hannula224ee882006-07-19 01:40:47 -04001176
1177 /* pool report is sometimes messed up, refetch it */
Benjamin Tissoiresd88142722013-02-25 11:31:46 +01001178 hid_hw_request(hid, pidff->reports[PID_POOL], HID_REQ_GET_REPORT);
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +01001179 hid_hw_wait(hid);
Anssi Hannula224ee882006-07-19 01:40:47 -04001180
1181 if (pidff->pool[PID_SIMULTANEOUS_MAX].value) {
Anssi Hannula1168df72009-11-04 00:57:35 +02001182 while (pidff->pool[PID_SIMULTANEOUS_MAX].value[0] < 2) {
Anssi Hannula224ee882006-07-19 01:40:47 -04001183 if (i++ > 20) {
Joe Perches4291ee32010-12-09 19:29:03 -08001184 hid_warn(pidff->hid,
1185 "device reports %d simultaneous effects\n",
1186 pidff->pool[PID_SIMULTANEOUS_MAX].value[0]);
Anssi Hannula224ee882006-07-19 01:40:47 -04001187 break;
1188 }
Joe Perches4291ee32010-12-09 19:29:03 -08001189 hid_dbg(pidff->hid, "pid_pool requested again\n");
Benjamin Tissoiresd88142722013-02-25 11:31:46 +01001190 hid_hw_request(hid, pidff->reports[PID_POOL],
1191 HID_REQ_GET_REPORT);
Benjamin Tissoiresb7966a42013-02-25 11:31:47 +01001192 hid_hw_wait(hid);
Anssi Hannula224ee882006-07-19 01:40:47 -04001193 }
1194 }
1195}
1196
1197/*
1198 * Test if autocenter modification is using the supported method
1199 */
1200static int pidff_check_autocenter(struct pidff_device *pidff,
1201 struct input_dev *dev)
1202{
1203 int error;
1204
1205 /*
1206 * Let's find out if autocenter modification is supported
1207 * Specification doesn't specify anything, so we request an
1208 * effect upload and cancel it immediately. If the approved
1209 * effect id was one above the minimum, then we assume the first
1210 * effect id is a built-in spring type effect used for autocenter
1211 */
1212
1213 error = pidff_request_effect_upload(pidff, 1);
1214 if (error) {
Joe Perches4291ee32010-12-09 19:29:03 -08001215 hid_err(pidff->hid, "upload request failed\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001216 return error;
1217 }
1218
1219 if (pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0] ==
1220 pidff->block_load[PID_EFFECT_BLOCK_INDEX].field->logical_minimum + 1) {
1221 pidff_autocenter(pidff, 0xffff);
1222 set_bit(FF_AUTOCENTER, dev->ffbit);
1223 } else {
Joe Perches4291ee32010-12-09 19:29:03 -08001224 hid_notice(pidff->hid,
1225 "device has unknown autocenter control method\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001226 }
1227
1228 pidff_erase_pid(pidff,
1229 pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0]);
1230
1231 return 0;
1232
1233}
1234
1235/*
1236 * Check if the device is PID and initialize it
1237 */
1238int hid_pidff_init(struct hid_device *hid)
1239{
1240 struct pidff_device *pidff;
1241 struct hid_input *hidinput = list_entry(hid->inputs.next,
1242 struct hid_input, list);
1243 struct input_dev *dev = hidinput->input;
1244 struct ff_device *ff;
1245 int max_effects;
1246 int error;
1247
Joe Perches4291ee32010-12-09 19:29:03 -08001248 hid_dbg(hid, "starting pid init\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001249
1250 if (list_empty(&hid->report_enum[HID_OUTPUT_REPORT].report_list)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001251 hid_dbg(hid, "not a PID device, no output report\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001252 return -ENODEV;
1253 }
1254
1255 pidff = kzalloc(sizeof(*pidff), GFP_KERNEL);
1256 if (!pidff)
1257 return -ENOMEM;
1258
1259 pidff->hid = hid;
1260
Jim Keirafd700d2015-01-23 17:21:12 +00001261 hid_device_io_start(hid);
1262
Anssi Hannula224ee882006-07-19 01:40:47 -04001263 pidff_find_reports(hid, HID_OUTPUT_REPORT, pidff);
1264 pidff_find_reports(hid, HID_FEATURE_REPORT, pidff);
1265
1266 if (!pidff_reports_ok(pidff)) {
Joe Perches4291ee32010-12-09 19:29:03 -08001267 hid_dbg(hid, "reports not ok, aborting\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001268 error = -ENODEV;
1269 goto fail;
1270 }
1271
1272 error = pidff_init_fields(pidff, dev);
1273 if (error)
1274 goto fail;
1275
1276 pidff_reset(pidff);
1277
1278 if (test_bit(FF_GAIN, dev->ffbit)) {
1279 pidff_set(&pidff->device_gain[PID_DEVICE_GAIN_FIELD], 0xffff);
Benjamin Tissoiresd88142722013-02-25 11:31:46 +01001280 hid_hw_request(hid, pidff->reports[PID_DEVICE_GAIN],
1281 HID_REQ_SET_REPORT);
Anssi Hannula224ee882006-07-19 01:40:47 -04001282 }
1283
1284 error = pidff_check_autocenter(pidff, dev);
1285 if (error)
1286 goto fail;
1287
1288 max_effects =
1289 pidff->block_load[PID_EFFECT_BLOCK_INDEX].field->logical_maximum -
1290 pidff->block_load[PID_EFFECT_BLOCK_INDEX].field->logical_minimum +
1291 1;
Joe Perches4291ee32010-12-09 19:29:03 -08001292 hid_dbg(hid, "max effects is %d\n", max_effects);
Anssi Hannula224ee882006-07-19 01:40:47 -04001293
1294 if (max_effects > PID_EFFECTS_MAX)
1295 max_effects = PID_EFFECTS_MAX;
1296
1297 if (pidff->pool[PID_SIMULTANEOUS_MAX].value)
Joe Perches4291ee32010-12-09 19:29:03 -08001298 hid_dbg(hid, "max simultaneous effects is %d\n",
1299 pidff->pool[PID_SIMULTANEOUS_MAX].value[0]);
Anssi Hannula224ee882006-07-19 01:40:47 -04001300
1301 if (pidff->pool[PID_RAM_POOL_SIZE].value)
Joe Perches4291ee32010-12-09 19:29:03 -08001302 hid_dbg(hid, "device memory size is %d bytes\n",
1303 pidff->pool[PID_RAM_POOL_SIZE].value[0]);
Anssi Hannula224ee882006-07-19 01:40:47 -04001304
1305 if (pidff->pool[PID_DEVICE_MANAGED_POOL].value &&
1306 pidff->pool[PID_DEVICE_MANAGED_POOL].value[0] == 0) {
Joe Perches4291ee32010-12-09 19:29:03 -08001307 hid_notice(hid,
1308 "device does not support device managed pool\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001309 goto fail;
1310 }
1311
1312 error = input_ff_create(dev, max_effects);
1313 if (error)
1314 goto fail;
1315
1316 ff = dev->ff;
1317 ff->private = pidff;
1318 ff->upload = pidff_upload_effect;
1319 ff->erase = pidff_erase_effect;
1320 ff->set_gain = pidff_set_gain;
1321 ff->set_autocenter = pidff_set_autocenter;
1322 ff->playback = pidff_playback;
1323
Joe Perches4291ee32010-12-09 19:29:03 -08001324 hid_info(dev, "Force feedback for USB HID PID devices by Anssi Hannula <anssi.hannula@gmail.com>\n");
Anssi Hannula224ee882006-07-19 01:40:47 -04001325
Jim Keirafd700d2015-01-23 17:21:12 +00001326 hid_device_io_stop(hid);
1327
Anssi Hannula224ee882006-07-19 01:40:47 -04001328 return 0;
1329
1330 fail:
Jim Keirafd700d2015-01-23 17:21:12 +00001331 hid_device_io_stop(hid);
1332
Anssi Hannula224ee882006-07-19 01:40:47 -04001333 kfree(pidff);
1334 return error;
1335}