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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
|
/* $OpenBSD: uhidpp.c,v 1.26 2022/02/05 07:31:40 anton Exp $ */
/*
* Copyright (c) 2021 Anton Lindqvist <anton@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/device.h>
#include <sys/mutex.h>
#include <sys/sensors.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbhid.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdevs.h>
#include <dev/usb/uhidev.h>
/* #define UHIDPP_DEBUG */
#ifdef UHIDPP_DEBUG
#define DPRINTF(x...) do { \
if (uhidpp_debug) \
printf(x); \
} while (0)
#define DREPORT(prefix, repid, buf, len) do { \
if (uhidpp_debug) \
uhidd_dump_report((prefix), (repid), (buf), (len)); \
} while (0)
void uhidd_dump_report(const char *, uint8_t, const unsigned char *, u_int);
int uhidpp_debug = 1;
#else
#define DPRINTF(x...)
#define DREPORT(prefix, repid, buf, len)
#endif
#define HIDPP_LINK_STATUS(x) ((x) & (1 << 7))
#define HIDPP_REPORT_ID_SHORT 0x10
#define HIDPP_REPORT_ID_LONG 0x11
/*
* Length of reports. Note that the effective length is always +1 as
* uhidev_set_report() prepends the report ID.
*/
#define HIDPP_REPORT_SHORT_LENGTH (7 - 1)
#define HIDPP_REPORT_LONG_LENGTH (20 - 1)
/*
* Maximum number of allowed parameters for reports. Note, the parameters always
* starts at offset 3 for both RAP and FAP reports.
*/
#define HIDPP_REPORT_SHORT_PARAMS_MAX (HIDPP_REPORT_SHORT_LENGTH - 3)
#define HIDPP_REPORT_LONG_PARAMS_MAX (HIDPP_REPORT_LONG_LENGTH - 3)
#define HIDPP_DEVICE_ID_RECEIVER 0xff
#define HIDPP_FEAT_ROOT_IDX 0x00
#define HIDPP_FEAT_ROOT_PING_FUNC 0x01
#define HIDPP_FEAT_ROOT_PING_DATA 0x5a
#define HIDPP_SET_REGISTER 0x80
#define HIDPP_GET_REGISTER 0x81
#define HIDPP_SET_LONG_REGISTER 0x82
#define HIDPP_GET_LONG_REGISTER 0x83
#define HIDPP_REG_ENABLE_REPORTS 0x00
#define HIDPP_REG_PAIRING_INFORMATION 0xb5
#define HIDPP_NOTIF_DEVICE_BATTERY_STATUS (1 << 4)
#define HIDPP_NOTIF_RECEIVER_WIRELESS (1 << 0)
#define HIDPP_NOTIF_RECEIVER_SOFTWARE_PRESENT (1 << 3)
/* HID++ 1.0 error codes. */
#define HIDPP_ERROR 0x8f
#define HIDPP_ERROR_SUCCESS 0x00
#define HIDPP_ERROR_INVALID_SUBID 0x01
#define HIDPP_ERROR_INVALID_ADRESS 0x02
#define HIDPP_ERROR_INVALID_VALUE 0x03
#define HIDPP_ERROR_CONNECT_FAIL 0x04
#define HIDPP_ERROR_TOO_MANY_DEVICES 0x05
#define HIDPP_ERROR_ALREADY_EXISTS 0x06
#define HIDPP_ERROR_BUSY 0x07
#define HIDPP_ERROR_UNKNOWN_DEVICE 0x08
#define HIDPP_ERROR_RESOURCE_ERROR 0x09
#define HIDPP_ERROR_REQUEST_UNAVAILABLE 0x0a
#define HIDPP_ERROR_INVALID_PARAM_VALUE 0x0b
#define HIDPP_ERROR_WRONG_PIN_CODE 0x0c
/*
* The software ID is added to feature access reports (FAP) and used to
* distinguish responses from notifications. Note, the software ID must be
* greater than zero which is reserved for notifications.
*/
#define HIDPP_SOFTWARE_ID 0x01
#define HIDPP_SOFTWARE_ID_LEN 4
#define HIDPP20_FEAT_ROOT_ID 0x0000
#define HIDPP20_FEAT_ROOT_GET_FEATURE_FUNC 0x0000
#define HIDPP20_FEAT_FEATURE_ID 0x0001
#define HIDPP20_FEAT_FEATURE_COUNT_FUNC 0x0000
#define HIDPP20_FEAT_FEATURE_ID_FUNC 0x0001
#define HIDPP20_FEAT_BATTERY_ID 0x1000
#define HIDPP20_FEAT_BATTERY_LEVEL_FUNC 0x0000
#define HIDPP20_FEAT_BATTERY_CAPABILITY_FUNC 0x0001
#define HIDPP20_BATTERY_STATUS_CHARGING_DONE 0x0003
#define HIDPP20_BATTERY_CAPABILITY_RECHARGEABLE 0x0004
/* HID++ 2.0 error codes. */
#define HIDPP20_ERROR 0xff
#define HIDPP20_ERROR_NO_ERROR 0x00
#define HIDPP20_ERROR_UNKNOWN 0x01
#define HIDPP20_ERROR_INVALID_ARGUMENT 0x02
#define HIDPP20_ERROR_OUT_OF_RANGE 0x03
#define HIDPP20_ERROR_HARDWARE_ERROR 0x04
#define HIDPP20_ERROR_LOGITECH_INTERNAL 0x05
#define HIDPP20_ERROR_INVALID_FEATURE_INDEX 0x06
#define HIDPP20_ERROR_INVALID_FUNCTION_ID 0x07
#define HIDPP20_ERROR_BUSY 0x08
#define HIDPP20_ERROR_UNSUPPORTED 0x09
/*
* Sentinels used for interrupt response synchronization. The values must be
* disjoint from existing report IDs.
*/
#define UHIDPP_RESP_NONE 0
#define UHIDPP_RESP_WAIT 1
#define UHIDPP_RESP_ERROR 2
/* Maximum number of devices associated with a single receiver. */
#define UHIDPP_NDEVICES 6
/* Maximum number of pending notifications. */
#define UHIDPP_NNOTIFICATIONS 4
/* Number of sensors per paired device. */
#define UHIDPP_NSENSORS 3
/* Feature access report used by the HID++ 2.0 (and greater) protocol. */
struct fap {
uint8_t feature_idx;
uint8_t funcidx_swid;
uint8_t params[HIDPP_REPORT_LONG_PARAMS_MAX];
};
/*
* Register access report used by the HID++ 1.0 protocol. Receivers always uses
* this type of report.
*/
struct rap {
uint8_t sub_id;
uint8_t reg_address;
uint8_t params[HIDPP_REPORT_LONG_PARAMS_MAX];
};
struct uhidpp_report {
uint8_t device_id;
union {
struct fap fap;
struct rap rap;
};
} __packed;
struct uhidpp_notification {
struct uhidpp_report n_rep;
unsigned int n_id;
};
struct uhidpp_device {
uint8_t d_id;
uint8_t d_connected;
uint8_t d_major;
uint8_t d_minor;
uint8_t d_features;
#define UHIDPP_DEVICE_FEATURE_ROOT 0x01
#define UHIDPP_DEVICE_FEATURE_BATTERY 0x02
struct {
struct ksensor b_sens[UHIDPP_NSENSORS];
uint8_t b_feature_idx;
uint8_t b_level;
uint8_t b_status;
uint8_t b_nlevels;
uint8_t b_rechargeable;
} d_battery;
};
/*
* Locking:
* [m] sc_mtx
*/
struct uhidpp_softc {
struct uhidev sc_hdev;
struct usbd_device *sc_udev;
struct mutex sc_mtx;
struct uhidpp_device sc_devices[UHIDPP_NDEVICES];
/* [m] connected devices */
struct uhidpp_notification sc_notifications[UHIDPP_NNOTIFICATIONS];
/* [m] pending notifications */
struct usb_task sc_task; /* [m] notification task */
struct ksensordev sc_sensdev; /* [m] */
struct sensor_task *sc_senstsk; /* [m] */
struct uhidpp_report *sc_req; /* [m] synchronous request buffer */
struct uhidpp_report *sc_resp; /* [m] synchronous response buffer */
u_int sc_resp_state; /* [m] synchronous response state */
};
int uhidpp_match(struct device *, void *, void *);
void uhidpp_attach(struct device *, struct device *, void *);
int uhidpp_detach(struct device *, int flags);
void uhidpp_intr(struct uhidev *addr, void *ibuf, u_int len);
void uhidpp_refresh(void *);
void uhidpp_task(void *);
int uhidpp_sleep(struct uhidpp_softc *, uint64_t);
void uhidpp_device_connect(struct uhidpp_softc *, struct uhidpp_device *);
void uhidpp_device_refresh(struct uhidpp_softc *, struct uhidpp_device *);
int uhidpp_device_features(struct uhidpp_softc *, struct uhidpp_device *);
struct uhidpp_notification *uhidpp_claim_notification(struct uhidpp_softc *);
int uhidpp_consume_notification(struct uhidpp_softc *, struct uhidpp_report *);
int uhidpp_is_notification(struct uhidpp_softc *, struct uhidpp_report *);
static int uhidpp_has_sensors(struct uhidpp_softc *);
int hidpp_get_protocol_version(struct uhidpp_softc *, uint8_t, uint8_t *,
uint8_t *);
int hidpp10_get_name(struct uhidpp_softc *, uint8_t, char *, size_t);
int hidpp10_get_serial(struct uhidpp_softc *, uint8_t, uint8_t *, size_t);
int hidpp10_get_type(struct uhidpp_softc *, uint8_t, const char **);
int hidpp10_enable_notifications(struct uhidpp_softc *, uint8_t);
int hidpp20_root_get_feature(struct uhidpp_softc *, uint8_t, uint16_t,
uint8_t *, uint8_t *);
int hidpp20_feature_get_count(struct uhidpp_softc *, uint8_t, uint8_t,
uint8_t *);
int hidpp20_feature_get_id(struct uhidpp_softc *, uint8_t, uint8_t, uint8_t,
uint16_t *, uint8_t *);
int hidpp20_battery_get_level_status(struct uhidpp_softc *, uint8_t, uint8_t,
uint8_t *, uint8_t *);
int hidpp20_battery_get_capability(struct uhidpp_softc *, uint8_t, uint8_t,
uint8_t *, uint8_t *);
int hidpp20_battery_status_is_charging(uint8_t);
int hidpp_send_validate(uint8_t, int);
int hidpp_send_rap_report(struct uhidpp_softc *, uint8_t, uint8_t, uint8_t,
uint8_t, uint8_t *, int, struct uhidpp_report *);
int hidpp_send_fap_report(struct uhidpp_softc *, uint8_t, uint8_t, uint8_t,
uint8_t, uint8_t *, int, struct uhidpp_report *);
int hidpp_send_report(struct uhidpp_softc *, uint8_t, struct uhidpp_report *,
struct uhidpp_report *);
struct cfdriver uhidpp_cd = {
NULL, "uhidpp", DV_DULL
};
const struct cfattach uhidpp_ca = {
sizeof(struct uhidpp_softc),
uhidpp_match,
uhidpp_attach,
uhidpp_detach,
};
static const struct usb_devno uhidpp_devs[] = {
{ USB_VENDOR_LOGITECH, USB_PRODUCT_ANY },
};
int
uhidpp_match(struct device *parent, void *match, void *aux)
{
struct uhidev_attach_arg *uha = (struct uhidev_attach_arg *)aux;
void *desc;
int descsiz, siz;
if (!UHIDEV_CLAIM_MULTIPLE_REPORTID(uha))
return UMATCH_NONE;
if (usb_lookup(uhidpp_devs,
uha->uaa->vendor, uha->uaa->product) == NULL)
return UMATCH_NONE;
uhidev_get_report_desc(uha->parent, &desc, &descsiz);
siz = hid_report_size(desc, descsiz, hid_output, HIDPP_REPORT_ID_SHORT);
if (siz != HIDPP_REPORT_SHORT_LENGTH)
return UMATCH_NONE;
siz = hid_report_size(desc, descsiz, hid_output, HIDPP_REPORT_ID_LONG);
if (siz != HIDPP_REPORT_LONG_LENGTH)
return UMATCH_NONE;
uha->claimed[HIDPP_REPORT_ID_SHORT] = 1;
uha->claimed[HIDPP_REPORT_ID_LONG] = 1;
return UMATCH_VENDOR_PRODUCT;
}
void
uhidpp_attach(struct device *parent, struct device *self, void *aux)
{
struct uhidpp_softc *sc = (struct uhidpp_softc *)self;
struct uhidev_attach_arg *uha = (struct uhidev_attach_arg *)aux;
struct usb_attach_arg *uaa = uha->uaa;
int npaired = 0;
int error, i;
sc->sc_hdev.sc_intr = uhidpp_intr;
sc->sc_hdev.sc_udev = uaa->device;
sc->sc_hdev.sc_parent = uha->parent;
sc->sc_hdev.sc_report_id = uha->reportid;
/* The largest supported report dictates the sizes. */
sc->sc_hdev.sc_isize = HIDPP_REPORT_LONG_LENGTH;
sc->sc_hdev.sc_osize = HIDPP_REPORT_LONG_LENGTH;
sc->sc_udev = uaa->device;
mtx_init(&sc->sc_mtx, IPL_USB);
sc->sc_resp = NULL;
sc->sc_resp_state = UHIDPP_RESP_NONE;
error = uhidev_open(&sc->sc_hdev);
if (error) {
printf(" open error %d\n", error);
return;
}
usb_init_task(&sc->sc_task, uhidpp_task, sc, USB_TASK_TYPE_GENERIC);
mtx_enter(&sc->sc_mtx);
/*
* Wire up report device handlers before issuing commands to the device
* in order to receive responses. Necessary as uhidev by default
* performs the wiring after the attach routine has returned.
*/
error = uhidev_set_report_dev(sc->sc_hdev.sc_parent, &sc->sc_hdev,
HIDPP_REPORT_ID_SHORT);
if (error) {
mtx_leave(&sc->sc_mtx);
printf(" short report error %d\n", error);
return;
}
error = uhidev_set_report_dev(sc->sc_hdev.sc_parent, &sc->sc_hdev,
HIDPP_REPORT_ID_LONG);
if (error) {
mtx_leave(&sc->sc_mtx);
printf(" long report error %d\n", error);
return;
}
/* Probe paired devices. */
for (i = 0; i < UHIDPP_NDEVICES; i++) {
char name[16];
uint8_t serial[4];
struct uhidpp_device *dev = &sc->sc_devices[i];
const char *type;
uint8_t device_id = i + 1;
dev->d_id = device_id;
if (hidpp10_get_serial(sc, device_id, serial, sizeof(serial)) ||
hidpp10_get_type(sc, device_id, &type) ||
hidpp10_get_name(sc, device_id, name, sizeof(name)))
continue;
if (npaired > 0)
printf(",");
printf(" device %d", device_id);
printf(" %s", type);
printf(" \"%s\"", name);
printf(" serial %02x-%02x-%02x-%02x",
serial[0], serial[1], serial[2], serial[3]);
npaired++;
}
if (npaired == 0)
goto out;
/* Enable notifications for the receiver. */
error = hidpp10_enable_notifications(sc, HIDPP_DEVICE_ID_RECEIVER);
if (error)
printf(" error %d", error);
out:
mtx_leave(&sc->sc_mtx);
printf("\n");
}
int
uhidpp_detach(struct device *self, int flags)
{
struct uhidpp_softc *sc = (struct uhidpp_softc *)self;
int i;
usb_rem_wait_task(sc->sc_udev, &sc->sc_task);
if (uhidpp_has_sensors(sc))
sensor_task_unregister(sc->sc_senstsk);
KASSERT(sc->sc_resp_state == UHIDPP_RESP_NONE);
if (uhidpp_has_sensors(sc))
sensordev_deinstall(&sc->sc_sensdev);
for (i = 0; i < UHIDPP_NDEVICES; i++) {
struct uhidpp_device *dev = &sc->sc_devices[i];
struct ksensor *sens = dev->d_battery.b_sens;
if (!dev->d_connected)
continue;
sensor_detach(&sc->sc_sensdev, &sens[0]);
sensor_detach(&sc->sc_sensdev, &sens[1]);
if (dev->d_battery.b_rechargeable)
sensor_detach(&sc->sc_sensdev, &sens[2]);
}
uhidev_close(&sc->sc_hdev);
return 0;
}
void
uhidpp_intr(struct uhidev *addr, void *buf, u_int len)
{
struct uhidpp_softc *sc = (struct uhidpp_softc *)addr;
struct uhidpp_report *rep = buf;
int dowake = 0;
uint8_t repid;
/*
* Ugliness ahead as the report ID is stripped of by uhidev_intr() but
* needed to determine if an error occurred.
* Note that an error response is always a short report even if the
* command that caused the error is a long report.
*/
repid = ((uint8_t *)buf)[-1];
DREPORT(__func__, repid, buf, len);
mtx_enter(&sc->sc_mtx);
if (uhidpp_is_notification(sc, rep)) {
struct uhidpp_notification *ntf;
ntf = uhidpp_claim_notification(sc);
if (ntf != NULL) {
memcpy(&ntf->n_rep, buf, len);
usb_add_task(sc->sc_udev, &sc->sc_task);
} else {
DPRINTF("%s: too many notifications", __func__);
}
} else {
KASSERT(sc->sc_resp_state == UHIDPP_RESP_WAIT);
dowake = 1;
sc->sc_resp_state = repid;
memcpy(sc->sc_resp, buf, len);
}
mtx_leave(&sc->sc_mtx);
if (dowake)
wakeup(sc);
}
void
uhidpp_refresh(void *arg)
{
struct uhidpp_softc *sc = arg;
int i;
mtx_enter(&sc->sc_mtx);
for (i = 0; i < UHIDPP_NDEVICES; i++) {
struct uhidpp_device *dev = &sc->sc_devices[i];
if (dev->d_connected)
uhidpp_device_refresh(sc, dev);
}
mtx_leave(&sc->sc_mtx);
}
void
uhidpp_task(void *arg)
{
struct uhidpp_softc *sc = arg;
mtx_enter(&sc->sc_mtx);
for (;;) {
struct uhidpp_report rep;
struct uhidpp_device *dev;
if (uhidpp_consume_notification(sc, &rep))
break;
DPRINTF("%s: device_id=%d, sub_id=%02x\n",
__func__, rep.device_id, rep.rap.sub_id);
if (rep.device_id == 0 || rep.device_id > UHIDPP_NDEVICES) {
DPRINTF("%s: invalid device\n", __func__);
continue;
}
dev = &sc->sc_devices[rep.device_id - 1];
switch (rep.rap.sub_id) {
case 0x0e: /* leds */
case 0x40: /* disconnect */
case 0x4b: /* pairing accepted */
break;
case 0x41: /* connect */
/*
* Do nothing if the link is reported to be out of
* range. This happens when a device has been idle for a
* while.
*/
if (HIDPP_LINK_STATUS(rep.rap.params[0]))
uhidpp_device_connect(sc, dev);
break;
}
}
mtx_leave(&sc->sc_mtx);
}
int
uhidpp_sleep(struct uhidpp_softc *sc, uint64_t nsecs)
{
return msleep_nsec(sc, &sc->sc_mtx, PZERO, "uhidpp", nsecs);
}
void
uhidpp_device_connect(struct uhidpp_softc *sc, struct uhidpp_device *dev)
{
struct ksensor *sens;
int error;
uint8_t feature_type;
MUTEX_ASSERT_LOCKED(&sc->sc_mtx);
/* A connected device will continuously send connect events. */
if (dev->d_connected)
return;
/*
* If features are already present, it must be a device lacking battery
* support.
*/
if (dev->d_features)
return;
error = hidpp_get_protocol_version(sc, dev->d_id,
&dev->d_major, &dev->d_minor);
if (error) {
DPRINTF("%s: protocol version failure: device_id=%d, "
"error=%d\n",
__func__, dev->d_id, error);
return;
}
DPRINTF("%s: device_id=%d, version=%d.%d\n",
__func__, dev->d_id, dev->d_major, dev->d_minor);
if (dev->d_major >= 2) {
error = uhidpp_device_features(sc, dev);
if (error) {
DPRINTF("%s: features failure: device_id=%d, "
"error=%d\n",
__func__, dev->d_id, error);
return;
}
error = hidpp20_root_get_feature(sc, dev->d_id,
HIDPP20_FEAT_BATTERY_ID,
&dev->d_battery.b_feature_idx, &feature_type);
if (error) {
DPRINTF("%s: battery feature index failure: "
"device_id=%d, error=%d\n",
__func__, dev->d_id, error);
return;
}
error = hidpp20_battery_get_capability(sc,
dev->d_id, dev->d_battery.b_feature_idx,
&dev->d_battery.b_nlevels, &dev->d_battery.b_rechargeable);
if (error) {
DPRINTF("%s: battery capability failure: device_id=%d, "
"error=%d\n", __func__, dev->d_id, error);
return;
}
} else {
return;
}
dev->d_connected = 1;
sens = &dev->d_battery.b_sens[0];
strlcpy(sens->desc, "battery level", sizeof(sens->desc));
sens->type = SENSOR_PERCENT;
sens->flags = SENSOR_FUNKNOWN;
sensor_attach(&sc->sc_sensdev, sens);
sens = &dev->d_battery.b_sens[1];
strlcpy(sens->desc, "number of battery levels", sizeof(sens->desc));
sens->type = SENSOR_INTEGER;
sens->value = dev->d_battery.b_nlevels;
sensor_attach(&sc->sc_sensdev, sens);
if (dev->d_battery.b_rechargeable) {
sens = &dev->d_battery.b_sens[2];
strlcpy(sens->desc, "charger", sizeof(sens->desc));
sens->type = SENSOR_INDICATOR;
sens->value = 0;
sensor_attach(&sc->sc_sensdev, sens);
}
uhidpp_device_refresh(sc, dev);
/*
* There could be many devices connected to the same receiver, therefore
* only install the sensors once.
*/
if (uhidpp_has_sensors(sc))
return;
strlcpy(sc->sc_sensdev.xname, sc->sc_hdev.sc_dev.dv_xname,
sizeof(sc->sc_sensdev.xname));
sensordev_install(&sc->sc_sensdev);
/*
* The mutex must be temporarily released while calling
* sensor_task_register() as it might end up sleeping.
*/
KASSERT(sc->sc_senstsk == NULL);
mtx_leave(&sc->sc_mtx);
sc->sc_senstsk = sensor_task_register(sc, uhidpp_refresh, 30);
mtx_enter(&sc->sc_mtx);
}
void
uhidpp_device_refresh(struct uhidpp_softc *sc, struct uhidpp_device *dev)
{
MUTEX_ASSERT_LOCKED(&sc->sc_mtx);
if (dev->d_major >= 2) {
int charging, error;
error = hidpp20_battery_get_level_status(sc, dev->d_id,
dev->d_battery.b_feature_idx,
&dev->d_battery.b_level, &dev->d_battery.b_status);
if (error) {
DPRINTF("%s: battery status failure: device_id=%d, "
"error=%d\n",
__func__, dev->d_id, error);
return;
}
charging = hidpp20_battery_status_is_charging(
dev->d_battery.b_status);
dev->d_battery.b_sens[0].value = dev->d_battery.b_level * 1000;
dev->d_battery.b_sens[0].flags &= ~SENSOR_FUNKNOWN;
if (dev->d_battery.b_nlevels < 10) {
/*
* According to the HID++ 2.0 specification, less than
* 10 levels should be mapped to the following 4 levels:
*
* [0, 10] critical
* [11, 30] low
* [31, 80] good
* [81, 100] full
*
* Since sensors are limited to 3 valid statuses, clamp
* it even further. Unless the battery is charging in
* which the level cannot be trusted.
*/
if (charging)
dev->d_battery.b_sens[0].status = SENSOR_S_UNKNOWN;
else if (dev->d_battery.b_level <= 10)
dev->d_battery.b_sens[0].status = SENSOR_S_CRIT;
else if (dev->d_battery.b_level <= 30)
dev->d_battery.b_sens[0].status = SENSOR_S_WARN;
else
dev->d_battery.b_sens[0].status = SENSOR_S_OK;
} else {
/*
* XXX the device supports battery mileage. The current
* level must be checked against resp.fap.params[3]
* given by hidpp20_battery_get_capability().
*/
dev->d_battery.b_sens[0].status = SENSOR_S_UNKNOWN;
}
if (dev->d_battery.b_rechargeable)
dev->d_battery.b_sens[2].value = charging;
}
}
/*
* Enumerate all supported HID++ 2.0 features for the given device.
*/
int
uhidpp_device_features(struct uhidpp_softc *sc, struct uhidpp_device *dev)
{
int error;
uint8_t count, feature_idx, feature_type, i;
/* All devices support the root feature. */
dev->d_features |= UHIDPP_DEVICE_FEATURE_ROOT;
error = hidpp20_root_get_feature(sc, dev->d_id,
HIDPP20_FEAT_FEATURE_ID,
&feature_idx, &feature_type);
if (error) {
DPRINTF("%s: feature index failure: device_id=%d, error=%d\n",
__func__, dev->d_id, error);
return error;
}
error = hidpp20_feature_get_count(sc, dev->d_id, feature_idx, &count);
if (error) {
DPRINTF("%s: feature count failure: device_id=%d, error=%d\n",
__func__, dev->d_id, error);
return error;
}
for (i = 1; i <= count; i++) {
uint16_t id;
uint8_t type;
error = hidpp20_feature_get_id(sc, dev->d_id, feature_idx, i,
&id, &type);
if (error)
continue;
if (id == HIDPP20_FEAT_BATTERY_ID)
dev->d_features |= UHIDPP_DEVICE_FEATURE_BATTERY;
DPRINTF("%s: idx=%d, id=%x, type=%x device_id=%d\n",
__func__, i, id, type, dev->d_id);
}
DPRINTF("%s: device_id=%d, count=%d, features=%x\n",
__func__, dev->d_id, count, dev->d_features);
if ((dev->d_features & UHIDPP_DEVICE_FEATURE_BATTERY) == 0)
return -ENODEV;
return 0;
}
/*
* Returns the next available notification slot, if available.
*/
struct uhidpp_notification *
uhidpp_claim_notification(struct uhidpp_softc *sc)
{
struct uhidpp_notification *ntf = NULL;
int nclaimed = 0;
int i;
MUTEX_ASSERT_LOCKED(&sc->sc_mtx);
for (i = 0; i < UHIDPP_NNOTIFICATIONS; i++) {
struct uhidpp_notification *tmp = &sc->sc_notifications[i];
if (tmp->n_id > 0)
nclaimed++;
else if (ntf == NULL)
ntf = tmp;
}
if (ntf == NULL)
return NULL;
ntf->n_id = nclaimed + 1;
return ntf;
}
/*
* Consume the first unhandled notification, if present.
*/
int
uhidpp_consume_notification(struct uhidpp_softc *sc, struct uhidpp_report *rep)
{
struct uhidpp_notification *ntf = NULL;
int i;
MUTEX_ASSERT_LOCKED(&sc->sc_mtx);
for (i = 0; i < UHIDPP_NNOTIFICATIONS; i++) {
struct uhidpp_notification *tmp = &sc->sc_notifications[i];
if (tmp->n_id > 0 && (ntf == NULL || tmp->n_id < ntf->n_id))
ntf = tmp;
}
if (ntf == NULL)
return 1;
memcpy(rep, &ntf->n_rep, sizeof(*rep));
ntf->n_id = 0;
return 0;
}
/*
* Returns non-zero if the given report is a notification. Otherwise, it must be
* a response.
*/
int
uhidpp_is_notification(struct uhidpp_softc *sc, struct uhidpp_report *rep)
{
/* Not waiting for a response. */
if (sc->sc_req == NULL)
return 1;
/* Everything except the parameters must be repeated in a response. */
if (sc->sc_req->device_id == rep->device_id &&
sc->sc_req->rap.sub_id == rep->rap.sub_id &&
sc->sc_req->rap.reg_address == rep->rap.reg_address)
return 0;
/* An error must always be a response. */
if ((rep->rap.sub_id == HIDPP_ERROR ||
rep->fap.feature_idx == HIDPP20_ERROR) &&
rep->fap.funcidx_swid == sc->sc_req->fap.feature_idx &&
rep->fap.params[0] == sc->sc_req->fap.funcidx_swid)
return 0;
return 1;
}
static int
uhidpp_has_sensors(struct uhidpp_softc *sc)
{
return sc->sc_sensdev.xname[0] != '\0';
}
int
hidpp_get_protocol_version(struct uhidpp_softc *sc, uint8_t device_id,
uint8_t *major, uint8_t *minor)
{
struct uhidpp_report resp;
uint8_t params[3] = { 0, 0, HIDPP_FEAT_ROOT_PING_DATA };
int error;
error = hidpp_send_fap_report(sc,
HIDPP_REPORT_ID_SHORT,
device_id,
HIDPP_FEAT_ROOT_IDX,
HIDPP_FEAT_ROOT_PING_FUNC,
params, sizeof(params), &resp);
if (error == HIDPP_ERROR_INVALID_SUBID) {
*major = 1;
*minor = 0;
return 0;
}
if (error)
return error;
if (resp.rap.params[2] != HIDPP_FEAT_ROOT_PING_DATA)
return -EPROTO;
*major = resp.fap.params[0];
*minor = resp.fap.params[1];
return 0;
}
int
hidpp10_get_name(struct uhidpp_softc *sc, uint8_t device_id,
char *buf, size_t bufsiz)
{
struct uhidpp_report resp;
int error;
uint8_t params[1] = { 0x40 + (device_id - 1) };
uint8_t len;
error = hidpp_send_rap_report(sc,
HIDPP_REPORT_ID_SHORT,
HIDPP_DEVICE_ID_RECEIVER,
HIDPP_GET_LONG_REGISTER,
HIDPP_REG_PAIRING_INFORMATION,
params, sizeof(params), &resp);
if (error)
return error;
len = resp.rap.params[1];
if (len + 2 > sizeof(resp.rap.params))
return -ENAMETOOLONG;
if (len > bufsiz - 1)
len = bufsiz - 1;
memcpy(buf, &resp.rap.params[2], len);
buf[len] = '\0';
return 0;
}
int
hidpp10_get_serial(struct uhidpp_softc *sc, uint8_t device_id,
uint8_t *buf, size_t bufsiz)
{
struct uhidpp_report resp;
int error;
uint8_t params[1] = { 0x30 + (device_id - 1) };
uint8_t len;
error = hidpp_send_rap_report(sc,
HIDPP_REPORT_ID_SHORT,
HIDPP_DEVICE_ID_RECEIVER,
HIDPP_GET_LONG_REGISTER,
HIDPP_REG_PAIRING_INFORMATION,
params, sizeof(params), &resp);
if (error)
return error;
len = 4;
if (bufsiz < len)
len = bufsiz;
memcpy(buf, &resp.rap.params[1], len);
return 0;
}
int
hidpp10_get_type(struct uhidpp_softc *sc, uint8_t device_id, const char **type)
{
struct uhidpp_report resp;
int error;
uint8_t params[1] = { 0x20 + (device_id - 1) };
error = hidpp_send_rap_report(sc,
HIDPP_REPORT_ID_SHORT,
HIDPP_DEVICE_ID_RECEIVER,
HIDPP_GET_LONG_REGISTER,
HIDPP_REG_PAIRING_INFORMATION,
params, sizeof(params), &resp);
if (error)
return error;
switch (resp.rap.params[7]) {
case 0x00:
*type = "unknown";
return 0;
case 0x01:
*type = "keyboard";
return 0;
case 0x02:
*type = "mouse";
return 0;
case 0x03:
*type = "numpad";
return 0;
case 0x04:
*type = "presenter";
return 0;
case 0x08:
*type = "trackball";
return 0;
case 0x09:
*type = "touchpad";
return 0;
}
return -ENOENT;
}
int
hidpp10_enable_notifications(struct uhidpp_softc *sc, uint8_t device_id)
{
struct uhidpp_report resp;
uint8_t params[3];
/* Device reporting flags. */
params[0] = HIDPP_NOTIF_DEVICE_BATTERY_STATUS;
/* Receiver reporting flags. */
params[1] = HIDPP_NOTIF_RECEIVER_WIRELESS |
HIDPP_NOTIF_RECEIVER_SOFTWARE_PRESENT;
/* Device reporting flags (continued). */
params[2] = 0;
return hidpp_send_rap_report(sc,
HIDPP_REPORT_ID_SHORT,
device_id,
HIDPP_SET_REGISTER,
HIDPP_REG_ENABLE_REPORTS,
params, sizeof(params), &resp);
}
int
hidpp20_root_get_feature(struct uhidpp_softc *sc, uint8_t device_id,
uint16_t feature, uint8_t *feature_idx, uint8_t *feature_type)
{
struct uhidpp_report resp;
uint8_t params[2] = { feature >> 8, feature & 0xff };
int error;
error = hidpp_send_fap_report(sc,
HIDPP_REPORT_ID_LONG,
device_id,
HIDPP20_FEAT_ROOT_ID,
HIDPP20_FEAT_ROOT_GET_FEATURE_FUNC,
params, sizeof(params), &resp);
if (error)
return error;
if (resp.fap.params[0] == 0)
return -ENOENT;
*feature_idx = resp.fap.params[0];
*feature_type = resp.fap.params[1];
return 0;
}
int
hidpp20_feature_get_count(struct uhidpp_softc *sc, uint8_t device_id,
uint8_t feature_idx, uint8_t *count)
{
struct uhidpp_report resp;
int error;
error = hidpp_send_fap_report(sc,
HIDPP_REPORT_ID_LONG,
device_id,
feature_idx,
HIDPP20_FEAT_FEATURE_COUNT_FUNC,
NULL, 0, &resp);
if (error)
return error;
*count = resp.fap.params[0];
return 0;
}
int
hidpp20_feature_get_id(struct uhidpp_softc *sc, uint8_t device_id,
uint8_t feature_idx, uint8_t idx, uint16_t *id, uint8_t *type)
{
struct uhidpp_report resp;
uint8_t params[1] = { idx };
int error;
error = hidpp_send_fap_report(sc,
HIDPP_REPORT_ID_LONG,
device_id,
feature_idx,
HIDPP20_FEAT_FEATURE_ID_FUNC,
params, sizeof(params), &resp);
if (error)
return error;
*id = bemtoh16(resp.fap.params);
*type = resp.fap.params[2];
return 0;
}
int
hidpp20_battery_get_level_status(struct uhidpp_softc *sc, uint8_t device_id,
uint8_t feature_idx, uint8_t *level, uint8_t *status)
{
struct uhidpp_report resp;
int error;
error = hidpp_send_fap_report(sc,
HIDPP_REPORT_ID_LONG,
device_id,
feature_idx,
HIDPP20_FEAT_BATTERY_LEVEL_FUNC,
NULL, 0, &resp);
if (error)
return error;
*level = resp.fap.params[0];
/* next_level = resp.fap.params[1]; */
*status = resp.fap.params[2];
/*
* While charging, the reported level cannot be trusted. However, fake
* the battery state once the charging is done.
*/
switch (hidpp20_battery_status_is_charging(*status)) {
case HIDPP20_BATTERY_STATUS_CHARGING_DONE:
*level = 100;
*status = 0;
break;
}
return 0;
}
int
hidpp20_battery_get_capability(struct uhidpp_softc *sc, uint8_t device_id,
uint8_t feature_idx, uint8_t *nlevels, uint8_t *rechargeable)
{
struct uhidpp_report resp;
int error;
error = hidpp_send_fap_report(sc,
HIDPP_REPORT_ID_LONG,
device_id,
feature_idx,
HIDPP20_FEAT_BATTERY_CAPABILITY_FUNC,
NULL, 0, &resp);
if (error)
return error;
*nlevels = resp.fap.params[0];
*rechargeable = resp.fap.params[1] &
HIDPP20_BATTERY_CAPABILITY_RECHARGEABLE;
return 0;
}
int
hidpp20_battery_status_is_charging(uint8_t status)
{
switch (status) {
case 1: /* recharging */
case 2: /* charge in final stage */
case 4: /* recharging below optimal speed */
return status;
case 3: /* charge complete */
return status;
case 0: /* discharging */
case 5: /* invalid battery type */
case 6: /* thermal error */
case 7: /* other charging error */
default:
return 0;
}
}
int
hidpp_send_validate(uint8_t report_id, int nparams)
{
if (report_id == HIDPP_REPORT_ID_SHORT) {
if (nparams > HIDPP_REPORT_SHORT_PARAMS_MAX)
return -EMSGSIZE;
} else if (report_id == HIDPP_REPORT_ID_LONG) {
if (nparams > HIDPP_REPORT_LONG_PARAMS_MAX)
return -EMSGSIZE;
} else {
return -EINVAL;
}
return 0;
}
int
hidpp_send_fap_report(struct uhidpp_softc *sc, uint8_t report_id,
uint8_t device_id, uint8_t feature_idx, uint8_t funcidx_swid,
uint8_t *params, int nparams, struct uhidpp_report *resp)
{
struct uhidpp_report req;
int error;
error = hidpp_send_validate(report_id, nparams);
if (error)
return error;
memset(&req, 0, sizeof(req));
req.device_id = device_id;
req.fap.feature_idx = feature_idx;
req.fap.funcidx_swid =
(funcidx_swid << HIDPP_SOFTWARE_ID_LEN) | HIDPP_SOFTWARE_ID;
memcpy(req.fap.params, params, nparams);
return hidpp_send_report(sc, report_id, &req, resp);
}
int
hidpp_send_rap_report(struct uhidpp_softc *sc, uint8_t report_id,
uint8_t device_id, uint8_t sub_id, uint8_t reg_address,
uint8_t *params, int nparams, struct uhidpp_report *resp)
{
struct uhidpp_report req;
int error;
error = hidpp_send_validate(report_id, nparams);
if (error)
return error;
memset(&req, 0, sizeof(req));
req.device_id = device_id;
req.rap.sub_id = sub_id;
req.rap.reg_address = reg_address;
memcpy(req.rap.params, params, nparams);
return hidpp_send_report(sc, report_id, &req, resp);
}
int
hidpp_send_report(struct uhidpp_softc *sc, uint8_t report_id,
struct uhidpp_report *req, struct uhidpp_report *resp)
{
int error = 0;
int len, n;
MUTEX_ASSERT_LOCKED(&sc->sc_mtx);
if (report_id == HIDPP_REPORT_ID_SHORT)
len = HIDPP_REPORT_SHORT_LENGTH;
else if (report_id == HIDPP_REPORT_ID_LONG)
len = HIDPP_REPORT_LONG_LENGTH;
else
return -EINVAL;
DREPORT(__func__, report_id, (const unsigned char *)req, len);
/* Wait until any ongoing command has completed. */
while (sc->sc_resp_state != UHIDPP_RESP_NONE)
uhidpp_sleep(sc, INFSLP);
sc->sc_req = req;
sc->sc_resp = resp;
sc->sc_resp_state = UHIDPP_RESP_WAIT;
/*
* The mutex must be temporarily released while calling
* uhidev_set_report() as it might end up sleeping.
*/
mtx_leave(&sc->sc_mtx);
n = uhidev_set_report(sc->sc_hdev.sc_parent, UHID_OUTPUT_REPORT,
report_id, req, len);
mtx_enter(&sc->sc_mtx);
if (len != n) {
error = -EBUSY;
goto out;
}
/*
* The interrupt could already have been received while the mutex was
* released. Otherwise, wait for it.
*/
if (sc->sc_resp_state == UHIDPP_RESP_WAIT) {
/* Timeout taken from the hid-logitech-hidpp Linux driver. */
error = uhidpp_sleep(sc, SEC_TO_NSEC(5));
if (error) {
error = -error;
goto out;
}
}
if (sc->sc_resp_state == UHIDPP_RESP_ERROR)
error = -EIO;
else if (sc->sc_resp_state == HIDPP_REPORT_ID_SHORT &&
resp->rap.sub_id == HIDPP_ERROR)
error = resp->rap.params[1];
else if (sc->sc_resp_state == HIDPP_REPORT_ID_LONG &&
resp->fap.feature_idx == HIDPP20_ERROR)
error = resp->fap.params[1];
out:
sc->sc_req = NULL;
sc->sc_resp = NULL;
sc->sc_resp_state = UHIDPP_RESP_NONE;
wakeup(sc);
return error;
}
#ifdef UHIDPP_DEBUG
void
uhidd_dump_report(const char *prefix, uint8_t repid, const unsigned char *buf,
u_int buflen)
{
u_int i;
printf("%s: %02x ", prefix, repid);
for (i = 0; i < buflen; i++) {
printf("%02x%s", buf[i],
i == 2 ? " [" : (i + 1 < buflen ? " " : ""));
}
printf("]\n");
}
#endif
|