/
umidi.c
2009 lines (1736 loc) · 52 KB
/
umidi.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
/* $NetBSD: umidi.c,v 1.82 2020/01/02 08:08:30 maxv Exp $ */
/*
* Copyright (c) 2001, 2012, 2014 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Takuya SHIOZAKI (tshiozak@NetBSD.org), (full-size transfers, extended
* hw_if) Chapman Flack (chap@NetBSD.org), and Matthew R. Green
* (mrg@eterna.com.au).
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: umidi.c,v 1.82 2020/01/02 08:08:30 maxv Exp $");
#ifdef _KERNEL_OPT
#include "opt_usb.h"
#endif
#include <sys/types.h>
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/kmem.h>
#include <sys/device.h>
#include <sys/ioctl.h>
#include <sys/conf.h>
#include <sys/file.h>
#include <sys/select.h>
#include <sys/proc.h>
#include <sys/vnode.h>
#include <sys/poll.h>
#include <sys/intr.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdi_util.h>
#include <dev/usb/usbdevs.h>
#include <dev/usb/umidi_quirks.h>
#include <dev/midi_if.h>
/* Jack Descriptor */
#define UMIDI_MS_HEADER 0x01
#define UMIDI_IN_JACK 0x02
#define UMIDI_OUT_JACK 0x03
/* Jack Type */
#define UMIDI_EMBEDDED 0x01
#define UMIDI_EXTERNAL 0x02
/* generic, for iteration */
typedef struct {
uByte bLength;
uByte bDescriptorType;
uByte bDescriptorSubtype;
} UPACKED umidi_cs_descriptor_t;
typedef struct {
uByte bLength;
uByte bDescriptorType;
uByte bDescriptorSubtype;
uWord bcdMSC;
uWord wTotalLength;
} UPACKED umidi_cs_interface_descriptor_t;
#define UMIDI_CS_INTERFACE_DESCRIPTOR_SIZE 7
typedef struct {
uByte bLength;
uByte bDescriptorType;
uByte bDescriptorSubtype;
uByte bNumEmbMIDIJack;
} UPACKED umidi_cs_endpoint_descriptor_t;
#define UMIDI_CS_ENDPOINT_DESCRIPTOR_SIZE 4
typedef struct {
uByte bLength;
uByte bDescriptorType;
uByte bDescriptorSubtype;
uByte bJackType;
uByte bJackID;
} UPACKED umidi_jack_descriptor_t;
#define UMIDI_JACK_DESCRIPTOR_SIZE 5
#define TO_D(p) ((usb_descriptor_t *)(p))
#define NEXT_D(desc) TO_D((char *)(desc)+(desc)->bLength)
#define TO_IFD(desc) ((usb_interface_descriptor_t *)(desc))
#define TO_CSIFD(desc) ((umidi_cs_interface_descriptor_t *)(desc))
#define TO_EPD(desc) ((usb_endpoint_descriptor_t *)(desc))
#define TO_CSEPD(desc) ((umidi_cs_endpoint_descriptor_t *)(desc))
#define UMIDI_PACKET_SIZE 4
/*
* hierarchie
*
* <-- parent child -->
*
* umidi(sc) -> endpoint -> jack <- (dynamically assignable) - mididev
* ^ | ^ |
* +-----+ +-----+
*/
/* midi device */
struct umidi_mididev {
struct umidi_softc *sc;
device_t mdev;
/* */
struct umidi_jack *in_jack;
struct umidi_jack *out_jack;
char *label;
size_t label_len;
/* */
int opened;
int closing;
int flags;
};
/* Jack Information */
struct umidi_jack {
struct umidi_endpoint *endpoint;
/* */
int cable_number;
void *arg;
int bound;
int opened;
unsigned char *midiman_ppkt;
union {
struct {
void (*intr)(void *);
} out;
struct {
void (*intr)(void *, int);
} in;
} u;
};
#define UMIDI_MAX_EPJACKS 16
typedef unsigned char (*umidi_packet_bufp)[UMIDI_PACKET_SIZE];
/* endpoint data */
struct umidi_endpoint {
struct umidi_softc *sc;
/* */
int addr;
struct usbd_pipe *pipe;
struct usbd_xfer *xfer;
umidi_packet_bufp buffer;
umidi_packet_bufp next_slot;
uint32_t buffer_size;
int num_scheduled;
int num_open;
int num_jacks;
int soliciting;
void *solicit_cookie;
int armed;
struct umidi_jack *jacks[UMIDI_MAX_EPJACKS];
uint16_t this_schedule; /* see UMIDI_MAX_EPJACKS */
uint16_t next_schedule;
};
/* software context */
struct umidi_softc {
device_t sc_dev;
struct usbd_device *sc_udev;
struct usbd_interface *sc_iface;
const struct umidi_quirk *sc_quirk;
int sc_dying;
int sc_out_num_jacks;
struct umidi_jack *sc_out_jacks;
int sc_in_num_jacks;
struct umidi_jack *sc_in_jacks;
struct umidi_jack *sc_jacks;
int sc_num_mididevs;
struct umidi_mididev *sc_mididevs;
int sc_out_num_endpoints;
struct umidi_endpoint *sc_out_ep;
int sc_in_num_endpoints;
struct umidi_endpoint *sc_in_ep;
struct umidi_endpoint *sc_endpoints;
size_t sc_endpoints_len;
int cblnums_global;
kmutex_t sc_lock;
kcondvar_t sc_cv;
kcondvar_t sc_detach_cv;
int sc_refcnt;
};
#ifdef UMIDI_DEBUG
#define DPRINTF(x) if (umididebug) printf x
#define DPRINTFN(n,x) if (umididebug >= (n)) printf x
#include <sys/time.h>
static struct timeval umidi_tv;
int umididebug = 0;
#else
#define DPRINTF(x)
#define DPRINTFN(n,x)
#endif
#define UMIDI_ENDPOINT_SIZE(sc) (sizeof(*(sc)->sc_out_ep) * \
(sc->sc_out_num_endpoints + \
sc->sc_in_num_endpoints))
static int umidi_open(void *, int,
void (*)(void *, int), void (*)(void *), void *);
static void umidi_close(void *);
static int umidi_channelmsg(void *, int, int, u_char *, int);
static int umidi_commonmsg(void *, int, u_char *, int);
static int umidi_sysex(void *, u_char *, int);
static int umidi_rtmsg(void *, int);
static void umidi_getinfo(void *, struct midi_info *);
static void umidi_get_locks(void *, kmutex_t **, kmutex_t **);
static usbd_status alloc_pipe(struct umidi_endpoint *);
static void free_pipe(struct umidi_endpoint *);
static usbd_status alloc_all_endpoints(struct umidi_softc *);
static void free_all_endpoints(struct umidi_softc *);
static usbd_status alloc_all_jacks(struct umidi_softc *);
static void free_all_jacks(struct umidi_softc *);
static usbd_status bind_jacks_to_mididev(struct umidi_softc *,
struct umidi_jack *,
struct umidi_jack *,
struct umidi_mididev *);
static void unbind_jacks_from_mididev(struct umidi_mididev *);
static void unbind_all_jacks(struct umidi_softc *);
static usbd_status assign_all_jacks_automatically(struct umidi_softc *);
static usbd_status open_out_jack(struct umidi_jack *, void *,
void (*)(void *));
static usbd_status open_in_jack(struct umidi_jack *, void *,
void (*)(void *, int));
static void close_out_jack(struct umidi_jack *);
static void close_in_jack(struct umidi_jack *);
static usbd_status attach_mididev(struct umidi_softc *, struct umidi_mididev *);
static usbd_status detach_mididev(struct umidi_mididev *, int);
static void deactivate_mididev(struct umidi_mididev *);
static usbd_status alloc_all_mididevs(struct umidi_softc *, int);
static void free_all_mididevs(struct umidi_softc *);
static usbd_status attach_all_mididevs(struct umidi_softc *);
static usbd_status detach_all_mididevs(struct umidi_softc *, int);
static void deactivate_all_mididevs(struct umidi_softc *);
static void describe_mididev(struct umidi_mididev *);
#ifdef UMIDI_DEBUG
static void dump_sc(struct umidi_softc *);
static void dump_ep(struct umidi_endpoint *);
static void dump_jack(struct umidi_jack *);
#endif
static usbd_status start_input_transfer(struct umidi_endpoint *);
static usbd_status start_output_transfer(struct umidi_endpoint *);
static int out_jack_output(struct umidi_jack *, u_char *, int, int);
static void in_intr(struct usbd_xfer *, void *, usbd_status);
static void out_intr(struct usbd_xfer *, void *, usbd_status);
static void out_solicit(void *); /* struct umidi_endpoint* for softintr */
static void out_solicit_locked(void *); /* pre-locked version */
const struct midi_hw_if umidi_hw_if = {
.open = umidi_open,
.close = umidi_close,
.output = umidi_rtmsg,
.getinfo = umidi_getinfo,
.get_locks = umidi_get_locks,
};
struct midi_hw_if_ext umidi_hw_if_ext = {
.channel = umidi_channelmsg,
.common = umidi_commonmsg,
.sysex = umidi_sysex,
};
struct midi_hw_if_ext umidi_hw_if_mm = {
.channel = umidi_channelmsg,
.common = umidi_commonmsg,
.sysex = umidi_sysex,
.compress = 1,
};
static int umidi_match(device_t, cfdata_t, void *);
static void umidi_attach(device_t, device_t, void *);
static void umidi_childdet(device_t, device_t);
static int umidi_detach(device_t, int);
static int umidi_activate(device_t, enum devact);
CFATTACH_DECL2_NEW(umidi, sizeof(struct umidi_softc), umidi_match,
umidi_attach, umidi_detach, umidi_activate, NULL, umidi_childdet);
static int
umidi_match(device_t parent, cfdata_t match, void *aux)
{
struct usbif_attach_arg *uiaa = aux;
DPRINTFN(1,("umidi_match\n"));
if (umidi_search_quirk(uiaa->uiaa_vendor, uiaa->uiaa_product,
uiaa->uiaa_ifaceno))
return UMATCH_IFACECLASS_IFACESUBCLASS;
if (uiaa->uiaa_class == UICLASS_AUDIO &&
uiaa->uiaa_subclass == UISUBCLASS_MIDISTREAM)
return UMATCH_IFACECLASS_IFACESUBCLASS;
return UMATCH_NONE;
}
static void
umidi_attach(device_t parent, device_t self, void *aux)
{
usbd_status err;
struct umidi_softc *sc = device_private(self);
struct usbif_attach_arg *uiaa = aux;
char *devinfop;
DPRINTFN(1,("umidi_attach\n"));
sc->sc_dev = self;
aprint_naive("\n");
aprint_normal("\n");
devinfop = usbd_devinfo_alloc(uiaa->uiaa_device, 0);
aprint_normal_dev(self, "%s\n", devinfop);
usbd_devinfo_free(devinfop);
sc->sc_iface = uiaa->uiaa_iface;
sc->sc_udev = uiaa->uiaa_device;
sc->sc_quirk = umidi_search_quirk(uiaa->uiaa_vendor,
uiaa->uiaa_product, uiaa->uiaa_ifaceno);
aprint_normal_dev(self, "");
umidi_print_quirk(sc->sc_quirk);
mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_SOFTUSB);
cv_init(&sc->sc_cv, "umidopcl");
cv_init(&sc->sc_detach_cv, "umidetcv");
sc->sc_refcnt = 0;
err = alloc_all_endpoints(sc);
if (err != USBD_NORMAL_COMPLETION) {
aprint_error_dev(self,
"alloc_all_endpoints failed. (err=%d)\n", err);
goto out;
}
err = alloc_all_jacks(sc);
if (err != USBD_NORMAL_COMPLETION) {
aprint_error_dev(self, "alloc_all_jacks failed. (err=%d)\n",
err);
goto out_free_endpoints;
}
aprint_normal_dev(self, "out=%d, in=%d\n",
sc->sc_out_num_jacks, sc->sc_in_num_jacks);
err = assign_all_jacks_automatically(sc);
if (err != USBD_NORMAL_COMPLETION) {
aprint_error_dev(self,
"assign_all_jacks_automatically failed. (err=%d)\n", err);
goto out_free_jacks;
}
err = attach_all_mididevs(sc);
if (err != USBD_NORMAL_COMPLETION) {
aprint_error_dev(self,
"attach_all_mididevs failed. (err=%d)\n", err);
goto out_free_jacks;
}
#ifdef UMIDI_DEBUG
dump_sc(sc);
#endif
usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);
return;
out_free_jacks:
unbind_all_jacks(sc);
free_all_jacks(sc);
out_free_endpoints:
free_all_endpoints(sc);
out:
aprint_error_dev(self, "disabled.\n");
sc->sc_dying = 1;
return;
}
static void
umidi_childdet(device_t self, device_t child)
{
int i;
struct umidi_softc *sc = device_private(self);
KASSERT(sc->sc_mididevs != NULL);
for (i = 0; i < sc->sc_num_mididevs; i++) {
if (sc->sc_mididevs[i].mdev == child)
break;
}
KASSERT(i < sc->sc_num_mididevs);
sc->sc_mididevs[i].mdev = NULL;
}
static int
umidi_activate(device_t self, enum devact act)
{
struct umidi_softc *sc = device_private(self);
switch (act) {
case DVACT_DEACTIVATE:
DPRINTFN(1,("umidi_activate (deactivate)\n"));
sc->sc_dying = 1;
deactivate_all_mididevs(sc);
return 0;
default:
DPRINTFN(1,("umidi_activate (%d)\n", act));
return EOPNOTSUPP;
}
}
static int
umidi_detach(device_t self, int flags)
{
struct umidi_softc *sc = device_private(self);
DPRINTFN(1,("umidi_detach\n"));
mutex_enter(&sc->sc_lock);
sc->sc_dying = 1;
if (--sc->sc_refcnt >= 0)
if (cv_timedwait(&sc->sc_detach_cv, &sc->sc_lock, hz * 60))
aprint_error_dev(self, ": didn't detach\n");
mutex_exit(&sc->sc_lock);
detach_all_mididevs(sc, flags);
free_all_mididevs(sc);
free_all_jacks(sc);
free_all_endpoints(sc);
usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
mutex_destroy(&sc->sc_lock);
cv_destroy(&sc->sc_detach_cv);
cv_destroy(&sc->sc_cv);
return 0;
}
/*
* midi_if stuffs
*/
int
umidi_open(void *addr,
int flags,
void (*iintr)(void *, int),
void (*ointr)(void *),
void *arg)
{
struct umidi_mididev *mididev = addr;
struct umidi_softc *sc = mididev->sc;
usbd_status err;
KASSERT(mutex_owned(&sc->sc_lock));
DPRINTF(("umidi_open: sc=%p\n", sc));
if (mididev->opened)
return EBUSY;
if (sc->sc_dying)
return EIO;
mididev->opened = 1;
mididev->flags = flags;
if ((mididev->flags & FWRITE) && mididev->out_jack) {
err = open_out_jack(mididev->out_jack, arg, ointr);
if (err != USBD_NORMAL_COMPLETION)
goto bad;
}
if ((mididev->flags & FREAD) && mididev->in_jack) {
err = open_in_jack(mididev->in_jack, arg, iintr);
KASSERT(mididev->opened);
if (err != USBD_NORMAL_COMPLETION &&
err != USBD_IN_PROGRESS) {
if (mididev->out_jack)
close_out_jack(mididev->out_jack);
goto bad;
}
}
return 0;
bad:
mididev->opened = 0;
DPRINTF(("umidi_open: usbd_status %d\n", err));
KASSERT(mutex_owned(&sc->sc_lock));
return USBD_IN_USE == err ? EBUSY : EIO;
}
void
umidi_close(void *addr)
{
struct umidi_mididev *mididev = addr;
struct umidi_softc *sc = mididev->sc;
KASSERT(mutex_owned(&sc->sc_lock));
if (mididev->closing)
return;
mididev->closing = 1;
sc->sc_refcnt++;
if ((mididev->flags & FWRITE) && mididev->out_jack)
close_out_jack(mididev->out_jack);
if ((mididev->flags & FREAD) && mididev->in_jack)
close_in_jack(mididev->in_jack);
if (--sc->sc_refcnt < 0)
cv_broadcast(&sc->sc_detach_cv);
mididev->opened = 0;
mididev->closing = 0;
}
int
umidi_channelmsg(void *addr, int status, int channel, u_char *msg,
int len)
{
struct umidi_mididev *mididev = addr;
KASSERT(mutex_owned(&mididev->sc->sc_lock));
if (!mididev->out_jack || !mididev->opened || mididev->closing)
return EIO;
return out_jack_output(mididev->out_jack, msg, len, (status>>4)&0xf);
}
int
umidi_commonmsg(void *addr, int status, u_char *msg, int len)
{
struct umidi_mididev *mididev = addr;
int cin;
KASSERT(mutex_owned(&mididev->sc->sc_lock));
if (!mididev->out_jack || !mididev->opened || mididev->closing)
return EIO;
switch ( len ) {
case 1: cin = 5; break;
case 2: cin = 2; break;
case 3: cin = 3; break;
default: return EIO; /* or gcc warns of cin uninitialized */
}
return out_jack_output(mididev->out_jack, msg, len, cin);
}
int
umidi_sysex(void *addr, u_char *msg, int len)
{
struct umidi_mididev *mididev = addr;
int cin;
KASSERT(mutex_owned(&mididev->sc->sc_lock));
if (!mididev->out_jack || !mididev->opened || mididev->closing)
return EIO;
switch ( len ) {
case 1: cin = 5; break;
case 2: cin = 6; break;
case 3: cin = (msg[2] == 0xf7) ? 7 : 4; break;
default: return EIO; /* or gcc warns of cin uninitialized */
}
return out_jack_output(mididev->out_jack, msg, len, cin);
}
int
umidi_rtmsg(void *addr, int d)
{
struct umidi_mididev *mididev = addr;
u_char msg = d;
KASSERT(mutex_owned(&mididev->sc->sc_lock));
if (!mididev->out_jack || !mididev->opened || mididev->closing)
return EIO;
return out_jack_output(mididev->out_jack, &msg, 1, 0xf);
}
void
umidi_getinfo(void *addr, struct midi_info *mi)
{
struct umidi_mididev *mididev = addr;
struct umidi_softc *sc = mididev->sc;
int mm = UMQ_ISTYPE(sc, UMQ_TYPE_MIDIMAN_GARBLE);
KASSERT(mutex_owned(&sc->sc_lock));
mi->name = mididev->label;
mi->props = MIDI_PROP_OUT_INTR;
if (mididev->in_jack)
mi->props |= MIDI_PROP_CAN_INPUT;
midi_register_hw_if_ext(mm? &umidi_hw_if_mm : &umidi_hw_if_ext);
}
static void
umidi_get_locks(void *addr, kmutex_t **thread, kmutex_t **intr)
{
struct umidi_mididev *mididev = addr;
struct umidi_softc *sc = mididev->sc;
*intr = NULL;
*thread = &sc->sc_lock;
}
/*
* each endpoint stuffs
*/
/* alloc/free pipe */
static usbd_status
alloc_pipe(struct umidi_endpoint *ep)
{
struct umidi_softc *sc = ep->sc;
usbd_status err;
usb_endpoint_descriptor_t *epd;
epd = usbd_get_endpoint_descriptor(sc->sc_iface, ep->addr);
/*
* For output, an improvement would be to have a buffer bigger than
* wMaxPacketSize by num_jacks-1 additional packet slots; that would
* allow out_solicit to fill the buffer to the full packet size in
* all cases. But to use usbd_create_xfer to get a slightly larger
* buffer would not be a good way to do that, because if the addition
* would make the buffer exceed USB_MEM_SMALL then a substantially
* larger block may be wastefully allocated. Some flavor of double
* buffering could serve the same purpose, but would increase the
* code complexity, so for now I will live with the current slight
* penalty of reducing max transfer size by (num_open-num_scheduled)
* packet slots.
*/
ep->buffer_size = UGETW(epd->wMaxPacketSize);
ep->buffer_size -= ep->buffer_size % UMIDI_PACKET_SIZE;
DPRINTF(("%s: alloc_pipe %p, buffer size %u\n",
device_xname(sc->sc_dev), ep, ep->buffer_size));
ep->num_scheduled = 0;
ep->this_schedule = 0;
ep->next_schedule = 0;
ep->soliciting = 0;
ep->armed = 0;
err = usbd_open_pipe(sc->sc_iface, ep->addr, USBD_MPSAFE, &ep->pipe);
if (err)
goto quit;
int error = usbd_create_xfer(ep->pipe, ep->buffer_size,
0, 0, &ep->xfer);
if (error) {
usbd_close_pipe(ep->pipe);
return USBD_NOMEM;
}
ep->buffer = usbd_get_buffer(ep->xfer);
ep->next_slot = ep->buffer;
ep->solicit_cookie = softint_establish(SOFTINT_CLOCK | SOFTINT_MPSAFE,
out_solicit, ep);
quit:
return err;
}
static void
free_pipe(struct umidi_endpoint *ep)
{
DPRINTF(("%s: free_pipe %p\n", device_xname(ep->sc->sc_dev), ep));
usbd_abort_pipe(ep->pipe);
usbd_destroy_xfer(ep->xfer);
usbd_close_pipe(ep->pipe);
softint_disestablish(ep->solicit_cookie);
}
/* alloc/free the array of endpoint structures */
static usbd_status alloc_all_endpoints_fixed_ep(struct umidi_softc *);
static usbd_status alloc_all_endpoints_yamaha(struct umidi_softc *);
static usbd_status alloc_all_endpoints_genuine(struct umidi_softc *);
static usbd_status
alloc_all_endpoints(struct umidi_softc *sc)
{
usbd_status err;
struct umidi_endpoint *ep;
int i;
if (UMQ_ISTYPE(sc, UMQ_TYPE_FIXED_EP)) {
err = alloc_all_endpoints_fixed_ep(sc);
} else if (UMQ_ISTYPE(sc, UMQ_TYPE_YAMAHA)) {
err = alloc_all_endpoints_yamaha(sc);
} else {
err = alloc_all_endpoints_genuine(sc);
}
if (err != USBD_NORMAL_COMPLETION)
return err;
ep = sc->sc_endpoints;
for (i = sc->sc_out_num_endpoints+sc->sc_in_num_endpoints; i > 0; i--) {
err = alloc_pipe(ep++);
if (err != USBD_NORMAL_COMPLETION) {
for (; ep != sc->sc_endpoints; ep--)
free_pipe(ep-1);
kmem_free(sc->sc_endpoints, sc->sc_endpoints_len);
sc->sc_endpoints = sc->sc_out_ep = sc->sc_in_ep = NULL;
break;
}
}
return err;
}
static void
free_all_endpoints(struct umidi_softc *sc)
{
int i;
for (i=0; i<sc->sc_in_num_endpoints+sc->sc_out_num_endpoints; i++)
free_pipe(&sc->sc_endpoints[i]);
if (sc->sc_endpoints != NULL)
kmem_free(sc->sc_endpoints, sc->sc_endpoints_len);
sc->sc_endpoints = sc->sc_out_ep = sc->sc_in_ep = NULL;
}
static usbd_status
alloc_all_endpoints_fixed_ep(struct umidi_softc *sc)
{
usbd_status err;
const struct umq_fixed_ep_desc *fp;
struct umidi_endpoint *ep;
usb_endpoint_descriptor_t *epd;
int i;
fp = umidi_get_quirk_data_from_type(sc->sc_quirk,
UMQ_TYPE_FIXED_EP);
sc->sc_out_num_jacks = 0;
sc->sc_in_num_jacks = 0;
sc->sc_out_num_endpoints = fp->num_out_ep;
sc->sc_in_num_endpoints = fp->num_in_ep;
sc->sc_endpoints_len = UMIDI_ENDPOINT_SIZE(sc);
sc->sc_endpoints = kmem_zalloc(sc->sc_endpoints_len, KM_SLEEP);
sc->sc_out_ep = sc->sc_out_num_endpoints ? sc->sc_endpoints : NULL;
sc->sc_in_ep =
sc->sc_in_num_endpoints ?
sc->sc_endpoints+sc->sc_out_num_endpoints : NULL;
ep = &sc->sc_out_ep[0];
for (i = 0; i < sc->sc_out_num_endpoints; i++) {
epd = usbd_interface2endpoint_descriptor(
sc->sc_iface,
fp->out_ep[i].ep);
if (!epd) {
aprint_error_dev(sc->sc_dev,
"cannot get endpoint descriptor(out:%d)\n",
fp->out_ep[i].ep);
err = USBD_INVAL;
goto error;
}
if (UE_GET_XFERTYPE(epd->bmAttributes)!=UE_BULK ||
UE_GET_DIR(epd->bEndpointAddress)!=UE_DIR_OUT) {
aprint_error_dev(sc->sc_dev,
"illegal endpoint(out:%d)\n", fp->out_ep[i].ep);
err = USBD_INVAL;
goto error;
}
ep->sc = sc;
ep->addr = epd->bEndpointAddress;
ep->num_jacks = fp->out_ep[i].num_jacks;
sc->sc_out_num_jacks += fp->out_ep[i].num_jacks;
ep->num_open = 0;
ep++;
}
ep = &sc->sc_in_ep[0];
for (i = 0; i < sc->sc_in_num_endpoints; i++) {
epd = usbd_interface2endpoint_descriptor(
sc->sc_iface,
fp->in_ep[i].ep);
if (!epd) {
aprint_error_dev(sc->sc_dev,
"cannot get endpoint descriptor(in:%d)\n",
fp->in_ep[i].ep);
err = USBD_INVAL;
goto error;
}
/*
* MIDISPORT_2X4 inputs on an interrupt rather than a bulk
* endpoint. The existing input logic in this driver seems
* to work successfully if we just stop treating an interrupt
* endpoint as illegal (or the in_progress status we get on
* the initial transfer). It does not seem necessary to
* actually use the interrupt flavor of alloc_pipe or make
* other serious rearrangements of logic. I like that.
*/
switch ( UE_GET_XFERTYPE(epd->bmAttributes) ) {
case UE_BULK:
case UE_INTERRUPT:
if (UE_DIR_IN == UE_GET_DIR(epd->bEndpointAddress))
break;
/*FALLTHROUGH*/
default:
aprint_error_dev(sc->sc_dev,
"illegal endpoint(in:%d)\n", fp->in_ep[i].ep);
err = USBD_INVAL;
goto error;
}
ep->sc = sc;
ep->addr = epd->bEndpointAddress;
ep->num_jacks = fp->in_ep[i].num_jacks;
sc->sc_in_num_jacks += fp->in_ep[i].num_jacks;
ep->num_open = 0;
ep++;
}
return USBD_NORMAL_COMPLETION;
error:
kmem_free(sc->sc_endpoints, UMIDI_ENDPOINT_SIZE(sc));
sc->sc_endpoints = NULL;
return err;
}
static usbd_status
alloc_all_endpoints_yamaha(struct umidi_softc *sc)
{
/* This driver currently supports max 1in/1out bulk endpoints */
usb_descriptor_t *desc;
umidi_cs_descriptor_t *udesc;
usb_endpoint_descriptor_t *epd;
int out_addr, in_addr, i;
int dir;
size_t remain, descsize;
sc->sc_out_num_jacks = sc->sc_in_num_jacks = 0;
out_addr = in_addr = 0;
/* detect endpoints */
desc = TO_D(usbd_get_interface_descriptor(sc->sc_iface));
for (i=(int)TO_IFD(desc)->bNumEndpoints-1; i>=0; i--) {
epd = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
KASSERT(epd != NULL);
if (UE_GET_XFERTYPE(epd->bmAttributes) == UE_BULK) {
dir = UE_GET_DIR(epd->bEndpointAddress);
if (dir==UE_DIR_OUT && !out_addr)
out_addr = epd->bEndpointAddress;
else if (dir==UE_DIR_IN && !in_addr)
in_addr = epd->bEndpointAddress;
}
}
udesc = (umidi_cs_descriptor_t *)NEXT_D(desc);
/* count jacks */
if (!(udesc->bDescriptorType==UDESC_CS_INTERFACE &&
udesc->bDescriptorSubtype==UMIDI_MS_HEADER))
return USBD_INVAL;
remain = (size_t)UGETW(TO_CSIFD(udesc)->wTotalLength) -
(size_t)udesc->bLength;
udesc = (umidi_cs_descriptor_t *)NEXT_D(udesc);
while (remain >= sizeof(usb_descriptor_t)) {
descsize = udesc->bLength;
if (descsize>remain || descsize==0)
break;
if (udesc->bDescriptorType == UDESC_CS_INTERFACE &&
remain >= UMIDI_JACK_DESCRIPTOR_SIZE) {
if (udesc->bDescriptorSubtype == UMIDI_OUT_JACK)
sc->sc_out_num_jacks++;
else if (udesc->bDescriptorSubtype == UMIDI_IN_JACK)
sc->sc_in_num_jacks++;
}
udesc = (umidi_cs_descriptor_t *)NEXT_D(udesc);
remain -= descsize;
}
/* validate some parameters */
if (sc->sc_out_num_jacks>UMIDI_MAX_EPJACKS)
sc->sc_out_num_jacks = UMIDI_MAX_EPJACKS;
if (sc->sc_in_num_jacks>UMIDI_MAX_EPJACKS)
sc->sc_in_num_jacks = UMIDI_MAX_EPJACKS;
if (sc->sc_out_num_jacks && out_addr) {
sc->sc_out_num_endpoints = 1;
} else {
sc->sc_out_num_endpoints = 0;
sc->sc_out_num_jacks = 0;
}
if (sc->sc_in_num_jacks && in_addr) {
sc->sc_in_num_endpoints = 1;
} else {
sc->sc_in_num_endpoints = 0;
sc->sc_in_num_jacks = 0;
}
sc->sc_endpoints_len = UMIDI_ENDPOINT_SIZE(sc);
sc->sc_endpoints = kmem_zalloc(sc->sc_endpoints_len, KM_SLEEP);
if (sc->sc_out_num_endpoints) {
sc->sc_out_ep = sc->sc_endpoints;
sc->sc_out_ep->sc = sc;
sc->sc_out_ep->addr = out_addr;
sc->sc_out_ep->num_jacks = sc->sc_out_num_jacks;
sc->sc_out_ep->num_open = 0;
} else
sc->sc_out_ep = NULL;
if (sc->sc_in_num_endpoints) {
sc->sc_in_ep = sc->sc_endpoints+sc->sc_out_num_endpoints;
sc->sc_in_ep->sc = sc;
sc->sc_in_ep->addr = in_addr;
sc->sc_in_ep->num_jacks = sc->sc_in_num_jacks;
sc->sc_in_ep->num_open = 0;
} else
sc->sc_in_ep = NULL;
return USBD_NORMAL_COMPLETION;
}
static usbd_status
alloc_all_endpoints_genuine(struct umidi_softc *sc)
{
usb_interface_descriptor_t *interface_desc;
usb_config_descriptor_t *config_desc;
usb_descriptor_t *desc;
int num_ep;
size_t remain, descsize;
struct umidi_endpoint *p, *q, *lowest, *endep, tmpep;
int epaddr;
interface_desc = usbd_get_interface_descriptor(sc->sc_iface);
num_ep = interface_desc->bNumEndpoints;
if (num_ep == 0)
return USBD_INVAL;
sc->sc_endpoints_len = sizeof(struct umidi_endpoint) * num_ep;
sc->sc_endpoints = p = kmem_zalloc(sc->sc_endpoints_len, KM_SLEEP);
sc->sc_out_num_jacks = sc->sc_in_num_jacks = 0;
sc->sc_out_num_endpoints = sc->sc_in_num_endpoints = 0;
epaddr = -1;
/* get the list of endpoints for midi stream */
config_desc = usbd_get_config_descriptor(sc->sc_udev);
desc = (usb_descriptor_t *) config_desc;
remain = (size_t)UGETW(config_desc->wTotalLength);
while (remain>=sizeof(usb_descriptor_t)) {
descsize = desc->bLength;
if (descsize>remain || descsize==0)
break;
if (desc->bDescriptorType==UDESC_ENDPOINT &&
remain>=USB_ENDPOINT_DESCRIPTOR_SIZE &&
UE_GET_XFERTYPE(TO_EPD(desc)->bmAttributes) == UE_BULK) {
epaddr = TO_EPD(desc)->bEndpointAddress;
} else if (desc->bDescriptorType==UDESC_CS_ENDPOINT &&
remain>=UMIDI_CS_ENDPOINT_DESCRIPTOR_SIZE &&
epaddr!=-1) {
if (num_ep>0) {
num_ep--;
p->sc = sc;
p->addr = epaddr;
p->num_jacks = TO_CSEPD(desc)->bNumEmbMIDIJack;
if (UE_GET_DIR(epaddr)==UE_DIR_OUT) {
sc->sc_out_num_endpoints++;
sc->sc_out_num_jacks += p->num_jacks;
} else {
sc->sc_in_num_endpoints++;