-
Notifications
You must be signed in to change notification settings - Fork 1
/
hid-pidff.c
1378 lines (1171 loc) · 37.4 KB
/
hid-pidff.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Force feedback driver for USB HID PID compliant devices
*
* Copyright (c) 2005, 2006 Anssi Hannula <anssi.hannula@gmail.com>
* Copyright (c) 2024 Makarenko Oleg <oleg@makarenk.ooo>
* Copyright (c) 2024 Tomasz Pakuła <tomasz@pakula.org>
*/
/*
*/
/* #define DEBUG */
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
#include <linux/input.h>
#include <linux/slab.h>
#include <linux/usb.h>
#include <linux/hid.h>
//#include "usbhid.h"
#include "hid-pidff.h"
#define PID_EFFECTS_MAX 64
/* Report usage table used to put reports into an array */
#define PID_SET_EFFECT 0
#define PID_EFFECT_OPERATION 1
#define PID_DEVICE_GAIN 2
#define PID_POOL 3
#define PID_BLOCK_LOAD 4
#define PID_BLOCK_FREE 5
#define PID_DEVICE_CONTROL 6
#define PID_CREATE_NEW_EFFECT 7
#define PID_REQUIRED_REPORTS 7
#define PID_SET_ENVELOPE 8
#define PID_SET_CONDITION 9
#define PID_SET_PERIODIC 10
#define PID_SET_CONSTANT 11
#define PID_SET_RAMP 12
static const u8 pidff_reports[] = {
0x21, 0x77, 0x7d, 0x7f, 0x89, 0x90, 0x96, 0xab,
0x5a, 0x5f, 0x6e, 0x73, 0x74
};
/* device_control is really 0x95, but 0x96 specified as it is the usage of
the only field in that report */
/* Value usage tables used to put fields and values into arrays */
#define PID_EFFECT_BLOCK_INDEX 0
#define PID_DURATION 1
#define PID_GAIN 2
#define PID_TRIGGER_BUTTON 3
#define PID_TRIGGER_REPEAT_INT 4
#define PID_DIRECTION_ENABLE 5
#define PID_START_DELAY 6
static const u8 pidff_set_effect[] = {
0x22, 0x50, 0x52, 0x53, 0x54, 0x56, 0xa7
};
#define PID_ATTACK_LEVEL 1
#define PID_ATTACK_TIME 2
#define PID_FADE_LEVEL 3
#define PID_FADE_TIME 4
static const u8 pidff_set_envelope[] = { 0x22, 0x5b, 0x5c, 0x5d, 0x5e };
#define PID_PARAM_BLOCK_OFFSET 1
#define PID_CP_OFFSET 2
#define PID_POS_COEFFICIENT 3
#define PID_NEG_COEFFICIENT 4
#define PID_POS_SATURATION 5
#define PID_NEG_SATURATION 6
#define PID_DEAD_BAND 7
static const u8 pidff_set_condition[] = {
0x22, 0x23, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65
};
#define PID_MAGNITUDE 1
#define PID_OFFSET 2
#define PID_PHASE 3
#define PID_PERIOD 4
static const u8 pidff_set_periodic[] = { 0x22, 0x70, 0x6f, 0x71, 0x72 };
static const u8 pidff_set_constant[] = { 0x22, 0x70 };
#define PID_RAMP_START 1
#define PID_RAMP_END 2
static const u8 pidff_set_ramp[] = { 0x22, 0x75, 0x76 };
#define PID_RAM_POOL_AVAILABLE 1
static const u8 pidff_block_load[] = { 0x22, 0xac };
#define PID_LOOP_COUNT 1
static const u8 pidff_effect_operation[] = { 0x22, 0x7c };
static const u8 pidff_block_free[] = { 0x22 };
#define PID_DEVICE_GAIN_FIELD 0
static const u8 pidff_device_gain[] = { 0x7e };
#define PID_RAM_POOL_SIZE 0
#define PID_SIMULTANEOUS_MAX 1
#define PID_DEVICE_MANAGED_POOL 2
static const u8 pidff_pool[] = { 0x80, 0x83, 0xa9 };
/* Special field key tables used to put special field keys into arrays */
#define PID_ENABLE_ACTUATORS 0
#define PID_RESET 1
static const u8 pidff_device_control[] = { 0x97, 0x9a };
#define PID_CONSTANT 0
#define PID_RAMP 1
#define PID_SQUARE 2
#define PID_SINE 3
#define PID_TRIANGLE 4
#define PID_SAW_UP 5
#define PID_SAW_DOWN 6
#define PID_SPRING 7
#define PID_DAMPER 8
#define PID_INERTIA 9
#define PID_FRICTION 10
static const u8 pidff_effect_types[] = {
0x26, 0x27, 0x30, 0x31, 0x32, 0x33, 0x34,
0x40, 0x41, 0x42, 0x43
};
#define PID_BLOCK_LOAD_SUCCESS 0
#define PID_BLOCK_LOAD_FULL 1
static const u8 pidff_block_load_status[] = { 0x8c, 0x8d };
#define PID_EFFECT_START 0
#define PID_EFFECT_STOP 1
static const u8 pidff_effect_operation_status[] = { 0x79, 0x7b };
struct pidff_usage {
struct hid_field *field;
s32 *value;
};
struct pidff_device {
struct hid_device *hid;
struct hid_report *reports[sizeof(pidff_reports)];
struct pidff_usage set_effect[sizeof(pidff_set_effect)];
struct pidff_usage set_envelope[sizeof(pidff_set_envelope)];
struct pidff_usage set_condition[sizeof(pidff_set_condition)];
struct pidff_usage set_periodic[sizeof(pidff_set_periodic)];
struct pidff_usage set_constant[sizeof(pidff_set_constant)];
struct pidff_usage set_ramp[sizeof(pidff_set_ramp)];
struct pidff_usage device_gain[sizeof(pidff_device_gain)];
struct pidff_usage block_load[sizeof(pidff_block_load)];
struct pidff_usage pool[sizeof(pidff_pool)];
struct pidff_usage effect_operation[sizeof(pidff_effect_operation)];
struct pidff_usage block_free[sizeof(pidff_block_free)];
/* Special field is a field that is not composed of
usage<->value pairs that pidff_usage values are */
/* Special field in create_new_effect */
struct hid_field *create_new_effect_type;
/* Special fields in set_effect */
struct hid_field *set_effect_type;
struct hid_field *effect_direction;
/* Special field in device_control */
struct hid_field *device_control;
/* Special field in block_load */
struct hid_field *block_load_status;
/* Special field in effect_operation */
struct hid_field *effect_operation_status;
int control_id[sizeof(pidff_device_control)];
int type_id[sizeof(pidff_effect_types)];
int status_id[sizeof(pidff_block_load_status)];
int operation_id[sizeof(pidff_effect_operation_status)];
int pid_id[PID_EFFECTS_MAX];
unsigned quirks;
};
/*
* Scale an unsigned value with range 0..max for the given field
*/
static int pidff_rescale(int i, int max, struct hid_field *field)
{
return i * (field->logical_maximum - field->logical_minimum) / max +
field->logical_minimum;
}
/*
* Scale a signed value in range -0x8000..0x7fff for the given field
*/
static int pidff_rescale_signed(int i, struct hid_field *field)
{
return i == 0 ? 0 : i >
0 ? i * field->logical_maximum / 0x7fff : i *
field->logical_minimum / -0x8000;
}
static void pidff_set(struct pidff_usage *usage, u16 value)
{
usage->value[0] = pidff_rescale(value, 0xffff, usage->field);
pr_debug("calculated from %d to %d\n", value, usage->value[0]);
}
static void pidff_set_signed(struct pidff_usage *usage, s16 value)
{
if (usage->field->logical_minimum < 0)
usage->value[0] = pidff_rescale_signed(value, usage->field);
else {
if (value < 0)
usage->value[0] =
pidff_rescale(-value, 0x8000, usage->field);
else
usage->value[0] =
pidff_rescale(value, 0x7fff, usage->field);
}
pr_debug("calculated from %d to %d\n", value, usage->value[0]);
}
/*
* Send envelope report to the device
*/
static void pidff_set_envelope_report(struct pidff_device *pidff,
struct ff_envelope *envelope)
{
pidff->set_envelope[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
pidff->set_envelope[PID_ATTACK_LEVEL].value[0] =
pidff_rescale(envelope->attack_level >
0x7fff ? 0x7fff : envelope->attack_level, 0x7fff,
pidff->set_envelope[PID_ATTACK_LEVEL].field);
pidff->set_envelope[PID_FADE_LEVEL].value[0] =
pidff_rescale(envelope->fade_level >
0x7fff ? 0x7fff : envelope->fade_level, 0x7fff,
pidff->set_envelope[PID_FADE_LEVEL].field);
pidff->set_envelope[PID_ATTACK_TIME].value[0] = envelope->attack_length;
pidff->set_envelope[PID_FADE_TIME].value[0] = envelope->fade_length;
hid_dbg(pidff->hid, "attack %u => %d\n",
envelope->attack_level,
pidff->set_envelope[PID_ATTACK_LEVEL].value[0]);
hid_hw_request(pidff->hid, pidff->reports[PID_SET_ENVELOPE],
HID_REQ_SET_REPORT);
}
/*
* Test if the new envelope differs from old one
*/
static int pidff_needs_set_envelope(struct ff_envelope *envelope,
struct ff_envelope *old)
{
return envelope->attack_level != old->attack_level ||
envelope->fade_level != old->fade_level ||
envelope->attack_length != old->attack_length ||
envelope->fade_length != old->fade_length;
}
/*
* Send constant force report to the device
*/
static void pidff_set_constant_force_report(struct pidff_device *pidff,
struct ff_effect *effect)
{
pidff->set_constant[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
pidff_set_signed(&pidff->set_constant[PID_MAGNITUDE],
effect->u.constant.level);
hid_hw_request(pidff->hid, pidff->reports[PID_SET_CONSTANT],
HID_REQ_SET_REPORT);
}
/*
* Test if the constant parameters have changed between effects
*/
static int pidff_needs_set_constant(struct ff_effect *effect,
struct ff_effect *old)
{
return effect->u.constant.level != old->u.constant.level;
}
/*
* Send set effect report to the device
*/
static void pidff_set_effect_report(struct pidff_device *pidff,
struct ff_effect *effect)
{
/* check for device quirks */
unsigned short direction = effect->direction;
unsigned short length = effect->replay.length;
if (pidff->quirks & PIDFF_QUIRK_FIX_0_INFINITE_LENGTH && length == 0)
length = 0xffff;
if ((effect->type == FF_DAMPER ||
effect->type == FF_FRICTION ||
effect->type == FF_SPRING ||
effect->type == FF_INERTIA) &&
pidff->quirks & PIDFF_QUIRK_FIX_WHEEL_DIRECTION)
direction = 0x3FFF;
pidff->set_effect[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
pidff->set_effect_type->value[0] =
pidff->create_new_effect_type->value[0];
pidff->set_effect[PID_DURATION].value[0] = length;
pidff->set_effect[PID_TRIGGER_BUTTON].value[0] =
effect->trigger.button;
pidff->set_effect[PID_TRIGGER_REPEAT_INT].value[0] =
effect->trigger.interval;
pidff->set_effect[PID_GAIN].value[0] =
pidff->set_effect[PID_GAIN].field->logical_maximum;
pidff->set_effect[PID_DIRECTION_ENABLE].value[0] = 1;
pidff->effect_direction->value[0] =
pidff_rescale(direction, 0xffff, pidff->effect_direction);
pidff->set_effect[PID_START_DELAY].value[0] = effect->replay.delay;
hid_hw_request(pidff->hid, pidff->reports[PID_SET_EFFECT],
HID_REQ_SET_REPORT);
}
/*
* Test if the values used in set_effect have changed
*/
static int pidff_needs_set_effect(struct ff_effect *effect,
struct ff_effect *old)
{
return effect->replay.length != old->replay.length ||
effect->trigger.interval != old->trigger.interval ||
effect->trigger.button != old->trigger.button ||
effect->direction != old->direction ||
effect->replay.delay != old->replay.delay;
}
/*
* Send periodic effect report to the device
*/
static void pidff_set_periodic_report(struct pidff_device *pidff,
struct ff_effect *effect)
{
pidff->set_periodic[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
pidff_set_signed(&pidff->set_periodic[PID_MAGNITUDE],
effect->u.periodic.magnitude);
pidff_set_signed(&pidff->set_periodic[PID_OFFSET],
effect->u.periodic.offset);
pidff_set(&pidff->set_periodic[PID_PHASE], effect->u.periodic.phase);
pidff->set_periodic[PID_PERIOD].value[0] = effect->u.periodic.period;
hid_hw_request(pidff->hid, pidff->reports[PID_SET_PERIODIC],
HID_REQ_SET_REPORT);
}
/*
* Test if periodic effect parameters have changed
*/
static int pidff_needs_set_periodic(struct ff_effect *effect,
struct ff_effect *old)
{
return effect->u.periodic.magnitude != old->u.periodic.magnitude ||
effect->u.periodic.offset != old->u.periodic.offset ||
effect->u.periodic.phase != old->u.periodic.phase ||
effect->u.periodic.period != old->u.periodic.period;
}
/*
* Send condition effect reports to the device
*/
static void pidff_set_condition_report(struct pidff_device *pidff,
struct ff_effect *effect)
{
int i;
pidff->set_condition[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
for (i = 0; i < 2; i++) {
pidff->set_condition[PID_PARAM_BLOCK_OFFSET].value[0] = i;
pidff_set_signed(&pidff->set_condition[PID_CP_OFFSET],
effect->u.condition[i].center);
pidff_set_signed(&pidff->set_condition[PID_POS_COEFFICIENT],
effect->u.condition[i].right_coeff);
pidff_set_signed(&pidff->set_condition[PID_NEG_COEFFICIENT],
effect->u.condition[i].left_coeff);
pidff_set(&pidff->set_condition[PID_POS_SATURATION],
effect->u.condition[i].right_saturation);
pidff_set(&pidff->set_condition[PID_NEG_SATURATION],
effect->u.condition[i].left_saturation);
pidff_set(&pidff->set_condition[PID_DEAD_BAND],
effect->u.condition[i].deadband);
hid_hw_request(pidff->hid, pidff->reports[PID_SET_CONDITION],
HID_REQ_SET_REPORT);
}
}
/*
* Test if condition effect parameters have changed
*/
static int pidff_needs_set_condition(struct ff_effect *effect,
struct ff_effect *old)
{
int i;
int ret = 0;
for (i = 0; i < 2; i++) {
struct ff_condition_effect *cond = &effect->u.condition[i];
struct ff_condition_effect *old_cond = &old->u.condition[i];
ret |= cond->center != old_cond->center ||
cond->right_coeff != old_cond->right_coeff ||
cond->left_coeff != old_cond->left_coeff ||
cond->right_saturation != old_cond->right_saturation ||
cond->left_saturation != old_cond->left_saturation ||
cond->deadband != old_cond->deadband;
}
return ret;
}
/*
* Send ramp force report to the device
*/
static void pidff_set_ramp_force_report(struct pidff_device *pidff,
struct ff_effect *effect)
{
pidff->set_ramp[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
pidff_set_signed(&pidff->set_ramp[PID_RAMP_START],
effect->u.ramp.start_level);
pidff_set_signed(&pidff->set_ramp[PID_RAMP_END],
effect->u.ramp.end_level);
hid_hw_request(pidff->hid, pidff->reports[PID_SET_RAMP],
HID_REQ_SET_REPORT);
}
/*
* Test if ramp force parameters have changed
*/
static int pidff_needs_set_ramp(struct ff_effect *effect, struct ff_effect *old)
{
return effect->u.ramp.start_level != old->u.ramp.start_level ||
effect->u.ramp.end_level != old->u.ramp.end_level;
}
/*
* Send a request for effect upload to the device
*
* Returns 0 if device reported success, -ENOSPC if the device reported memory
* is full. Upon unknown response the function will retry for 60 times, if
* still unsuccessful -EIO is returned.
*/
static int pidff_request_effect_upload(struct pidff_device *pidff, int efnum)
{
int j;
pidff->create_new_effect_type->value[0] = efnum;
hid_hw_request(pidff->hid, pidff->reports[PID_CREATE_NEW_EFFECT],
HID_REQ_SET_REPORT);
hid_dbg(pidff->hid, "create_new_effect sent, type: %d\n", efnum);
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0] = 0;
pidff->block_load_status->value[0] = 0;
hid_hw_wait(pidff->hid);
for (j = 0; j < 60; j++) {
hid_dbg(pidff->hid, "pid_block_load requested\n");
hid_hw_request(pidff->hid, pidff->reports[PID_BLOCK_LOAD],
HID_REQ_GET_REPORT);
hid_hw_wait(pidff->hid);
if (pidff->block_load_status->value[0] ==
pidff->status_id[PID_BLOCK_LOAD_SUCCESS]) {
hid_dbg(pidff->hid, "device reported free memory: %d bytes\n",
pidff->block_load[PID_RAM_POOL_AVAILABLE].value ?
pidff->block_load[PID_RAM_POOL_AVAILABLE].value[0] : -1);
return 0;
}
if (pidff->block_load_status->value[0] ==
pidff->status_id[PID_BLOCK_LOAD_FULL]) {
hid_dbg(pidff->hid, "not enough memory free: %d bytes\n",
pidff->block_load[PID_RAM_POOL_AVAILABLE].value ?
pidff->block_load[PID_RAM_POOL_AVAILABLE].value[0] : -1);
return -ENOSPC;
}
}
hid_err(pidff->hid, "pid_block_load failed 60 times\n");
return -EIO;
}
/*
* Play the effect with PID id n times
*/
static void pidff_playback_pid(struct pidff_device *pidff, int pid_id, int n)
{
pidff->effect_operation[PID_EFFECT_BLOCK_INDEX].value[0] = pid_id;
if (n == 0) {
pidff->effect_operation_status->value[0] =
pidff->operation_id[PID_EFFECT_STOP];
} else {
pidff->effect_operation_status->value[0] =
pidff->operation_id[PID_EFFECT_START];
n = clamp(n, pidff->effect_operation[PID_LOOP_COUNT].field->logical_minimum,
pidff->effect_operation[PID_LOOP_COUNT].field->logical_maximum);
pidff->effect_operation[PID_LOOP_COUNT].value[0] = n;
}
hid_dbg(pidff->hid, "Playing effect %d %d times\n", pid_id, n);
hid_hw_request(pidff->hid, pidff->reports[PID_EFFECT_OPERATION],
HID_REQ_SET_REPORT);
}
/*
* Play the effect with effect id @effect_id for @value times
*/
static int pidff_playback(struct input_dev *dev, int effect_id, int value)
{
struct pidff_device *pidff = dev->ff->private;
pidff_playback_pid(pidff, pidff->pid_id[effect_id], value);
return 0;
}
/*
* Erase effect with PID id
*/
static void pidff_erase_pid(struct pidff_device *pidff, int pid_id)
{
pidff->block_free[PID_EFFECT_BLOCK_INDEX].value[0] = pid_id;
hid_hw_request(pidff->hid, pidff->reports[PID_BLOCK_FREE],
HID_REQ_SET_REPORT);
}
/*
* Stop and erase effect with effect_id
*/
static int pidff_erase_effect(struct input_dev *dev, int effect_id)
{
struct pidff_device *pidff = dev->ff->private;
int pid_id = pidff->pid_id[effect_id];
hid_dbg(pidff->hid, "starting to erase %d/%d\n",
effect_id, pidff->pid_id[effect_id]);
/* Wait for the queue to clear. We do not want a full fifo to
prevent the effect removal. */
hid_hw_wait(pidff->hid);
pidff_playback_pid(pidff, pid_id, 0);
pidff_erase_pid(pidff, pid_id);
return 0;
}
/*
* Effect upload handler
*/
static int pidff_upload_effect(struct input_dev *dev, struct ff_effect *effect,
struct ff_effect *old)
{
struct pidff_device *pidff = dev->ff->private;
int type_id;
int error;
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0] = 0;
if (old) {
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->pid_id[effect->id];
}
hid_dbg(pidff->hid, "Upload effect 0x%02x,", effect->type);
switch (effect->type) {
case FF_CONSTANT:
if (!old) {
error = pidff_request_effect_upload(pidff,
pidff->type_id[PID_CONSTANT]);
if (error)
return error;
}
if (!old || pidff_needs_set_effect(effect, old))
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_constant(effect, old))
pidff_set_constant_force_report(pidff, effect);
if (!old ||
pidff_needs_set_envelope(&effect->u.constant.envelope,
&old->u.constant.envelope))
pidff_set_envelope_report(pidff,
&effect->u.constant.envelope);
break;
case FF_PERIODIC:
if (!old) {
switch (effect->u.periodic.waveform) {
case FF_SQUARE:
type_id = PID_SQUARE;
break;
case FF_TRIANGLE:
type_id = PID_TRIANGLE;
break;
case FF_SINE:
type_id = PID_SINE;
break;
case FF_SAW_UP:
type_id = PID_SAW_UP;
break;
case FF_SAW_DOWN:
type_id = PID_SAW_DOWN;
break;
default:
hid_err(pidff->hid, "invalid waveform\n");
return -EINVAL;
}
error = pidff_request_effect_upload(pidff,
pidff->type_id[type_id]);
if (error)
return error;
}
if (!old || pidff_needs_set_effect(effect, old))
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_periodic(effect, old))
pidff_set_periodic_report(pidff, effect);
if (!old ||
pidff_needs_set_envelope(&effect->u.periodic.envelope,
&old->u.periodic.envelope))
pidff_set_envelope_report(pidff,
&effect->u.periodic.envelope);
break;
case FF_RAMP:
if (!old) {
error = pidff_request_effect_upload(pidff,
pidff->type_id[PID_RAMP]);
if (error)
return error;
}
if (!old || pidff_needs_set_effect(effect, old))
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_ramp(effect, old))
pidff_set_ramp_force_report(pidff, effect);
if (!old ||
pidff_needs_set_envelope(&effect->u.ramp.envelope,
&old->u.ramp.envelope))
pidff_set_envelope_report(pidff,
&effect->u.ramp.envelope);
break;
case FF_SPRING:
if (!old) {
error = pidff_request_effect_upload(pidff,
pidff->type_id[PID_SPRING]);
if (error)
return error;
}
if (!old || pidff_needs_set_effect(effect, old))
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_condition(effect, old))
pidff_set_condition_report(pidff, effect);
break;
case FF_FRICTION:
if (!old) {
error = pidff_request_effect_upload(pidff,
pidff->type_id[PID_FRICTION]);
if (error)
return error;
}
if (!old || pidff_needs_set_effect(effect, old))
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_condition(effect, old))
pidff_set_condition_report(pidff, effect);
break;
case FF_DAMPER:
if (!old) {
error = pidff_request_effect_upload(pidff,
pidff->type_id[PID_DAMPER]);
if (error)
return error;
}
if (!old || pidff_needs_set_effect(effect, old))
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_condition(effect, old))
pidff_set_condition_report(pidff, effect);
break;
case FF_INERTIA:
if (!old) {
error = pidff_request_effect_upload(pidff,
pidff->type_id[PID_INERTIA]);
if (error)
return error;
}
if (!old || pidff_needs_set_effect(effect, old))
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_condition(effect, old))
pidff_set_condition_report(pidff, effect);
break;
default:
hid_err(pidff->hid, "invalid type\n");
return -EINVAL;
}
if (!old)
pidff->pid_id[effect->id] =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
hid_dbg(pidff->hid, "uploaded\n");
return 0;
}
/*
* set_gain() handler
*/
static void pidff_set_gain(struct input_dev *dev, u16 gain)
{
struct pidff_device *pidff = dev->ff->private;
pidff_set(&pidff->device_gain[PID_DEVICE_GAIN_FIELD], gain);
hid_hw_request(pidff->hid, pidff->reports[PID_DEVICE_GAIN],
HID_REQ_SET_REPORT);
}
static void pidff_autocenter(struct pidff_device *pidff, u16 magnitude)
{
struct hid_field *field =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].field;
if (!magnitude) {
pidff_playback_pid(pidff, field->logical_minimum, 0);
return;
}
pidff_playback_pid(pidff, field->logical_minimum, 1);
pidff->set_effect[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].field->logical_minimum;
pidff->set_effect_type->value[0] = pidff->type_id[PID_SPRING];
pidff->set_effect[PID_DURATION].value[0] = 0;
pidff->set_effect[PID_TRIGGER_BUTTON].value[0] = 0;
pidff->set_effect[PID_TRIGGER_REPEAT_INT].value[0] = 0;
pidff_set(&pidff->set_effect[PID_GAIN], magnitude);
pidff->set_effect[PID_DIRECTION_ENABLE].value[0] = 1;
pidff->set_effect[PID_START_DELAY].value[0] = 0;
hid_hw_request(pidff->hid, pidff->reports[PID_SET_EFFECT],
HID_REQ_SET_REPORT);
}
/*
* pidff_set_autocenter() handler
*/
static void pidff_set_autocenter(struct input_dev *dev, u16 magnitude)
{
struct pidff_device *pidff = dev->ff->private;
pidff_autocenter(pidff, magnitude);
}
/*
* Find fields from a report and fill a pidff_usage
*/
static int pidff_find_fields(struct pidff_usage *usage, const u8 *table,
struct hid_report *report, int count, int strict)
{
int i, j, k, found;
for (k = 0; k < count; k++) {
found = 0;
for (i = 0; i < report->maxfield; i++) {
if (report->field[i]->maxusage !=
report->field[i]->report_count) {
pr_debug("maxusage and report_count do not match, skipping\n");
continue;
}
for (j = 0; j < report->field[i]->maxusage; j++) {
if (report->field[i]->usage[j].hid ==
(HID_UP_PID | table[k])) {
pr_debug("found %d at %d->%d\n",
k, i, j);
usage[k].field = report->field[i];
usage[k].value =
&report->field[i]->value[j];
found = 1;
break;
}
}
if (found)
break;
}
if (!found && strict) {
pr_debug("failed to locate %d\n", k);
return -1;
}
}
return 0;
}
/*
* Return index into pidff_reports for the given usage
*/
static int pidff_check_usage(int usage)
{
int i;
for (i = 0; i < sizeof(pidff_reports); i++)
if (usage == (HID_UP_PID | pidff_reports[i]))
return i;
return -1;
}
/*
* Find the reports and fill pidff->reports[]
* report_type specifies either OUTPUT or FEATURE reports
*/
static void pidff_find_reports(struct hid_device *hid, int report_type,
struct pidff_device *pidff)
{
struct hid_report *report;
int i, ret;
list_for_each_entry(report,
&hid->report_enum[report_type].report_list, list) {
if (report->maxfield < 1)
continue;
ret = pidff_check_usage(report->field[0]->logical);
if (ret != -1) {
hid_dbg(hid, "found usage 0x%02x from field->logical\n",
pidff_reports[ret]);
pidff->reports[ret] = report;
continue;
}
/*
* Sometimes logical collections are stacked to indicate
* different usages for the report and the field, in which
* case we want the usage of the parent. However, Linux HID
* implementation hides this fact, so we have to dig it up
* ourselves
*/
i = report->field[0]->usage[0].collection_index;
if (i <= 0 ||
hid->collection[i - 1].type != HID_COLLECTION_LOGICAL)
continue;
ret = pidff_check_usage(hid->collection[i - 1].usage);
if (ret != -1 && !pidff->reports[ret]) {
hid_dbg(hid,
"found usage 0x%02x from collection array\n",
pidff_reports[ret]);
pidff->reports[ret] = report;
}
}
}
/*
* Test if the required reports have been found
*/
static int pidff_reports_ok(struct pidff_device *pidff)
{
int i;
for (i = 0; i <= PID_REQUIRED_REPORTS; i++) {
if (!pidff->reports[i]) {
hid_dbg(pidff->hid, "%d missing\n", i);
return 0;
}
}
return 1;
}
/*
* Find a field with a specific usage within a report
*/
static struct hid_field *pidff_find_special_field(struct hid_report *report,
int usage, int enforce_min)
{
int i;
for (i = 0; i < report->maxfield; i++) {
if (report->field[i]->logical == (HID_UP_PID | usage) &&
report->field[i]->report_count > 0) {
if (!enforce_min ||
report->field[i]->logical_minimum == 1)
return report->field[i];
else {
pr_err("logical_minimum is not 1 as it should be\n");
return NULL;
}
}
}
return NULL;
}
/*
* Fill a pidff->*_id struct table
*/
static int pidff_find_special_keys(int *keys, struct hid_field *fld,
const u8 *usagetable, int count)
{
int i, j;
int found = 0;
for (i = 0; i < count; i++) {
for (j = 0; j < fld->maxusage; j++) {
if (fld->usage[j].hid == (HID_UP_PID | usagetable[i])) {
keys[i] = j + 1;
found++;
break;
}
}
}
return found;
}
#define PIDFF_FIND_SPECIAL_KEYS(keys, field, name) \
pidff_find_special_keys(pidff->keys, pidff->field, pidff_ ## name, \
sizeof(pidff_ ## name))
/*
* Find and check the special fields
*/
static int pidff_find_special_fields(struct pidff_device *pidff)
{
hid_dbg(pidff->hid, "finding special fields\n");
pidff->create_new_effect_type =
pidff_find_special_field(pidff->reports[PID_CREATE_NEW_EFFECT],
0x25, 1);
pidff->set_effect_type =
pidff_find_special_field(pidff->reports[PID_SET_EFFECT],
0x25, 1);
pidff->effect_direction =
pidff_find_special_field(pidff->reports[PID_SET_EFFECT],
0x57, 0);
pidff->device_control =
pidff_find_special_field(pidff->reports[PID_DEVICE_CONTROL],
0x96, 1);
pidff->block_load_status =
pidff_find_special_field(pidff->reports[PID_BLOCK_LOAD],
0x8b, 1);
pidff->effect_operation_status =
pidff_find_special_field(pidff->reports[PID_EFFECT_OPERATION],
0x78, 1);
hid_dbg(pidff->hid, "search done\n");
if (!pidff->create_new_effect_type || !pidff->set_effect_type) {
hid_err(pidff->hid, "effect lists not found\n");
return -1;
}
if (!pidff->effect_direction) {
hid_err(pidff->hid, "direction field not found\n");
return -1;
}
if (!pidff->device_control) {
hid_err(pidff->hid, "device control field not found\n");
return -1;
}
if (!pidff->block_load_status) {
hid_err(pidff->hid, "block load status field not found\n");
return -1;
}
if (!pidff->effect_operation_status) {
hid_err(pidff->hid, "effect operation field not found\n");
return -1;
}
pidff_find_special_keys(pidff->control_id, pidff->device_control,
pidff_device_control,
sizeof(pidff_device_control));
PIDFF_FIND_SPECIAL_KEYS(control_id, device_control, device_control);
if (!PIDFF_FIND_SPECIAL_KEYS(type_id, create_new_effect_type,
effect_types)) {