1 /* $NetBSD: umidi.c,v 1.44 2011/10/07 19:41:03 jakllsch Exp $ */ 2 /* 3 * Copyright (c) 2001 The NetBSD Foundation, Inc. 4 * All rights reserved. 5 * 6 * This code is derived from software contributed to The NetBSD Foundation 7 * by Takuya SHIOZAKI (tshiozak@NetBSD.org) and (full-size transfers, extended 8 * hw_if) Chapman Flack (chap@NetBSD.org). 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #include <sys/cdefs.h> 33 __KERNEL_RCSID(0, "$NetBSD: umidi.c,v 1.44 2011/10/07 19:41:03 jakllsch Exp $"); 34 35 #include <sys/types.h> 36 #include <sys/param.h> 37 #include <sys/systm.h> 38 #include <sys/kernel.h> 39 #include <sys/malloc.h> 40 #include <sys/device.h> 41 #include <sys/ioctl.h> 42 #include <sys/conf.h> 43 #include <sys/file.h> 44 #include <sys/select.h> 45 #include <sys/proc.h> 46 #include <sys/vnode.h> 47 #include <sys/poll.h> 48 #include <sys/intr.h> 49 50 #include <dev/usb/usb.h> 51 #include <dev/usb/usbdi.h> 52 #include <dev/usb/usbdi_util.h> 53 54 #include <dev/usb/usbdevs.h> 55 #include <dev/usb/uaudioreg.h> 56 #include <dev/usb/umidireg.h> 57 #include <dev/usb/umidivar.h> 58 #include <dev/usb/umidi_quirks.h> 59 60 #include <dev/midi_if.h> 61 62 #ifdef UMIDI_DEBUG 63 #define DPRINTF(x) if (umididebug) printf x 64 #define DPRINTFN(n,x) if (umididebug >= (n)) printf x 65 #include <sys/time.h> 66 static struct timeval umidi_tv; 67 int umididebug = 0; 68 #else 69 #define DPRINTF(x) 70 #define DPRINTFN(n,x) 71 #endif 72 73 74 static int umidi_open(void *, int, 75 void (*)(void *, int), void (*)(void *), void *); 76 static void umidi_close(void *); 77 static int umidi_channelmsg(void *, int, int, u_char *, int); 78 static int umidi_commonmsg(void *, int, u_char *, int); 79 static int umidi_sysex(void *, u_char *, int); 80 static int umidi_rtmsg(void *, int); 81 static void umidi_getinfo(void *, struct midi_info *); 82 83 static usbd_status alloc_pipe(struct umidi_endpoint *); 84 static void free_pipe(struct umidi_endpoint *); 85 86 static usbd_status alloc_all_endpoints(struct umidi_softc *); 87 static void free_all_endpoints(struct umidi_softc *); 88 89 static usbd_status alloc_all_jacks(struct umidi_softc *); 90 static void free_all_jacks(struct umidi_softc *); 91 static usbd_status bind_jacks_to_mididev(struct umidi_softc *, 92 struct umidi_jack *, 93 struct umidi_jack *, 94 struct umidi_mididev *); 95 static void unbind_jacks_from_mididev(struct umidi_mididev *); 96 static void unbind_all_jacks(struct umidi_softc *); 97 static usbd_status assign_all_jacks_automatically(struct umidi_softc *); 98 static usbd_status open_out_jack(struct umidi_jack *, void *, 99 void (*)(void *)); 100 static usbd_status open_in_jack(struct umidi_jack *, void *, 101 void (*)(void *, int)); 102 static void close_out_jack(struct umidi_jack *); 103 static void close_in_jack(struct umidi_jack *); 104 105 static usbd_status attach_mididev(struct umidi_softc *, struct umidi_mididev *); 106 static usbd_status detach_mididev(struct umidi_mididev *, int); 107 static void deactivate_mididev(struct umidi_mididev *); 108 static usbd_status alloc_all_mididevs(struct umidi_softc *, int); 109 static void free_all_mididevs(struct umidi_softc *); 110 static usbd_status attach_all_mididevs(struct umidi_softc *); 111 static usbd_status detach_all_mididevs(struct umidi_softc *, int); 112 static void deactivate_all_mididevs(struct umidi_softc *); 113 static char *describe_mididev(struct umidi_mididev *); 114 115 #ifdef UMIDI_DEBUG 116 static void dump_sc(struct umidi_softc *); 117 static void dump_ep(struct umidi_endpoint *); 118 static void dump_jack(struct umidi_jack *); 119 #endif 120 121 static usbd_status start_input_transfer(struct umidi_endpoint *); 122 static usbd_status start_output_transfer(struct umidi_endpoint *); 123 static int out_jack_output(struct umidi_jack *, u_char *, int, int); 124 static void in_intr(usbd_xfer_handle, usbd_private_handle, usbd_status); 125 static void out_intr(usbd_xfer_handle, usbd_private_handle, usbd_status); 126 static void out_solicit(void *); /* struct umidi_endpoint* for softintr */ 127 128 129 const struct midi_hw_if umidi_hw_if = { 130 umidi_open, 131 umidi_close, 132 umidi_rtmsg, 133 umidi_getinfo, 134 0, /* ioctl */ 135 }; 136 137 struct midi_hw_if_ext umidi_hw_if_ext = { 138 .channel = umidi_channelmsg, 139 .common = umidi_commonmsg, 140 .sysex = umidi_sysex, 141 }; 142 143 struct midi_hw_if_ext umidi_hw_if_mm = { 144 .channel = umidi_channelmsg, 145 .common = umidi_commonmsg, 146 .sysex = umidi_sysex, 147 .compress = 1, 148 }; 149 150 int umidi_match(device_t, cfdata_t, void *); 151 void umidi_attach(device_t, device_t, void *); 152 void umidi_childdet(device_t, device_t); 153 int umidi_detach(device_t, int); 154 int umidi_activate(device_t, enum devact); 155 extern struct cfdriver umidi_cd; 156 CFATTACH_DECL2_NEW(umidi, sizeof(struct umidi_softc), umidi_match, 157 umidi_attach, umidi_detach, umidi_activate, NULL, umidi_childdet); 158 159 int 160 umidi_match(device_t parent, cfdata_t match, void *aux) 161 { 162 struct usbif_attach_arg *uaa = aux; 163 164 DPRINTFN(1,("umidi_match\n")); 165 166 if (umidi_search_quirk(uaa->vendor, uaa->product, uaa->ifaceno)) 167 return UMATCH_IFACECLASS_IFACESUBCLASS; 168 169 if (uaa->class == UICLASS_AUDIO && 170 uaa->subclass == UISUBCLASS_MIDISTREAM) 171 return UMATCH_IFACECLASS_IFACESUBCLASS; 172 173 return UMATCH_NONE; 174 } 175 176 void 177 umidi_attach(device_t parent, device_t self, void *aux) 178 { 179 usbd_status err; 180 struct umidi_softc *sc = device_private(self); 181 struct usbif_attach_arg *uaa = aux; 182 char *devinfop; 183 184 DPRINTFN(1,("umidi_attach\n")); 185 186 sc->sc_dev = self; 187 188 aprint_naive("\n"); 189 aprint_normal("\n"); 190 191 devinfop = usbd_devinfo_alloc(uaa->device, 0); 192 aprint_normal_dev(self, "%s\n", devinfop); 193 usbd_devinfo_free(devinfop); 194 195 sc->sc_iface = uaa->iface; 196 sc->sc_udev = uaa->device; 197 198 sc->sc_quirk = 199 umidi_search_quirk(uaa->vendor, uaa->product, uaa->ifaceno); 200 aprint_normal_dev(self, ""); 201 umidi_print_quirk(sc->sc_quirk); 202 203 204 err = alloc_all_endpoints(sc); 205 if (err!=USBD_NORMAL_COMPLETION) { 206 aprint_error_dev(self, 207 "alloc_all_endpoints failed. (err=%d)\n", err); 208 goto error; 209 } 210 err = alloc_all_jacks(sc); 211 if (err!=USBD_NORMAL_COMPLETION) { 212 free_all_endpoints(sc); 213 aprint_error_dev(self, "alloc_all_jacks failed. (err=%d)\n", 214 err); 215 goto error; 216 } 217 aprint_normal_dev(self, "out=%d, in=%d\n", 218 sc->sc_out_num_jacks, sc->sc_in_num_jacks); 219 220 err = assign_all_jacks_automatically(sc); 221 if (err!=USBD_NORMAL_COMPLETION) { 222 unbind_all_jacks(sc); 223 free_all_jacks(sc); 224 free_all_endpoints(sc); 225 aprint_error_dev(self, 226 "assign_all_jacks_automatically failed. (err=%d)\n", err); 227 goto error; 228 } 229 err = attach_all_mididevs(sc); 230 if (err!=USBD_NORMAL_COMPLETION) { 231 free_all_jacks(sc); 232 free_all_endpoints(sc); 233 aprint_error_dev(self, 234 "attach_all_mididevs failed. (err=%d)\n", err); 235 } 236 237 #ifdef UMIDI_DEBUG 238 dump_sc(sc); 239 #endif 240 241 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, 242 sc->sc_udev, sc->sc_dev); 243 244 return; 245 error: 246 aprint_error_dev(self, "disabled.\n"); 247 sc->sc_dying = 1; 248 return; 249 } 250 251 void 252 umidi_childdet(device_t self, device_t child) 253 { 254 int i; 255 struct umidi_softc *sc = device_private(self); 256 257 KASSERT(sc->sc_mididevs != NULL); 258 259 for (i = 0; i < sc->sc_num_mididevs; i++) { 260 if (sc->sc_mididevs[i].mdev == child) 261 break; 262 } 263 KASSERT(i < sc->sc_num_mididevs); 264 sc->sc_mididevs[i].mdev = NULL; 265 } 266 267 int 268 umidi_activate(device_t self, enum devact act) 269 { 270 struct umidi_softc *sc = device_private(self); 271 272 switch (act) { 273 case DVACT_DEACTIVATE: 274 DPRINTFN(1,("umidi_activate (deactivate)\n")); 275 sc->sc_dying = 1; 276 deactivate_all_mididevs(sc); 277 return 0; 278 default: 279 DPRINTFN(1,("umidi_activate (%d)\n", act)); 280 return EOPNOTSUPP; 281 } 282 } 283 284 int 285 umidi_detach(device_t self, int flags) 286 { 287 struct umidi_softc *sc = device_private(self); 288 289 DPRINTFN(1,("umidi_detach\n")); 290 291 sc->sc_dying = 1; 292 detach_all_mididevs(sc, flags); 293 free_all_mididevs(sc); 294 free_all_jacks(sc); 295 free_all_endpoints(sc); 296 297 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 298 sc->sc_dev); 299 300 return 0; 301 } 302 303 304 /* 305 * midi_if stuffs 306 */ 307 int 308 umidi_open(void *addr, 309 int flags, 310 void (*iintr)(void *, int), 311 void (*ointr)(void *), 312 void *arg) 313 { 314 struct umidi_mididev *mididev = addr; 315 struct umidi_softc *sc = mididev->sc; 316 usbd_status err; 317 318 DPRINTF(("umidi_open: sc=%p\n", sc)); 319 320 if (!sc) 321 return ENXIO; 322 if (mididev->opened) 323 return EBUSY; 324 if (sc->sc_dying) 325 return EIO; 326 327 mididev->opened = 1; 328 mididev->flags = flags; 329 if ((mididev->flags & FWRITE) && mididev->out_jack) { 330 err = open_out_jack(mididev->out_jack, arg, ointr); 331 if ( err != USBD_NORMAL_COMPLETION ) 332 goto bad; 333 } 334 if ((mididev->flags & FREAD) && mididev->in_jack) { 335 err = open_in_jack(mididev->in_jack, arg, iintr); 336 if ( err != USBD_NORMAL_COMPLETION 337 && err != USBD_IN_PROGRESS ) 338 goto bad; 339 } 340 341 return 0; 342 bad: 343 mididev->opened = 0; 344 DPRINTF(("umidi_open: usbd_status %d\n", err)); 345 return USBD_IN_USE == err ? EBUSY : EIO; 346 } 347 348 void 349 umidi_close(void *addr) 350 { 351 int s; 352 struct umidi_mididev *mididev = addr; 353 354 s = splusb(); 355 if ((mididev->flags & FWRITE) && mididev->out_jack) 356 close_out_jack(mididev->out_jack); 357 if ((mididev->flags & FREAD) && mididev->in_jack) 358 close_in_jack(mididev->in_jack); 359 mididev->opened = 0; 360 splx(s); 361 } 362 363 int 364 umidi_channelmsg(void *addr, int status, int channel, u_char *msg, 365 int len) 366 { 367 struct umidi_mididev *mididev = addr; 368 369 if (!mididev->out_jack || !mididev->opened) 370 return EIO; 371 372 return out_jack_output(mididev->out_jack, msg, len, (status>>4)&0xf); 373 } 374 375 int 376 umidi_commonmsg(void *addr, int status, u_char *msg, int len) 377 { 378 struct umidi_mididev *mididev = addr; 379 int cin; 380 381 if (!mididev->out_jack || !mididev->opened) 382 return EIO; 383 384 switch ( len ) { 385 case 1: cin = 5; break; 386 case 2: cin = 2; break; 387 case 3: cin = 3; break; 388 default: return EIO; /* or gcc warns of cin uninitialized */ 389 } 390 391 return out_jack_output(mididev->out_jack, msg, len, cin); 392 } 393 394 int 395 umidi_sysex(void *addr, u_char *msg, int len) 396 { 397 struct umidi_mididev *mididev = addr; 398 int cin; 399 400 if (!mididev->out_jack || !mididev->opened) 401 return EIO; 402 403 switch ( len ) { 404 case 1: cin = 5; break; 405 case 2: cin = 6; break; 406 case 3: cin = (msg[2] == 0xf7) ? 7 : 4; break; 407 default: return EIO; /* or gcc warns of cin uninitialized */ 408 } 409 410 return out_jack_output(mididev->out_jack, msg, len, cin); 411 } 412 413 int 414 umidi_rtmsg(void *addr, int d) 415 { 416 struct umidi_mididev *mididev = addr; 417 u_char msg = d; 418 419 if (!mididev->out_jack || !mididev->opened) 420 return EIO; 421 422 return out_jack_output(mididev->out_jack, &msg, 1, 0xf); 423 } 424 425 void 426 umidi_getinfo(void *addr, struct midi_info *mi) 427 { 428 struct umidi_mididev *mididev = addr; 429 struct umidi_softc *sc = mididev->sc; 430 int mm = UMQ_ISTYPE(sc, UMQ_TYPE_MIDIMAN_GARBLE); 431 432 mi->name = mididev->label; 433 mi->props = MIDI_PROP_OUT_INTR; 434 if (mididev->in_jack) 435 mi->props |= MIDI_PROP_CAN_INPUT; 436 midi_register_hw_if_ext(mm? &umidi_hw_if_mm : &umidi_hw_if_ext); 437 } 438 439 440 /* 441 * each endpoint stuffs 442 */ 443 444 /* alloc/free pipe */ 445 static usbd_status 446 alloc_pipe(struct umidi_endpoint *ep) 447 { 448 struct umidi_softc *sc = ep->sc; 449 usbd_status err; 450 usb_endpoint_descriptor_t *epd; 451 452 epd = usbd_get_endpoint_descriptor(sc->sc_iface, ep->addr); 453 /* 454 * For output, an improvement would be to have a buffer bigger than 455 * wMaxPacketSize by num_jacks-1 additional packet slots; that would 456 * allow out_solicit to fill the buffer to the full packet size in 457 * all cases. But to use usbd_alloc_buffer to get a slightly larger 458 * buffer would not be a good way to do that, because if the addition 459 * would make the buffer exceed USB_MEM_SMALL then a substantially 460 * larger block may be wastefully allocated. Some flavor of double 461 * buffering could serve the same purpose, but would increase the 462 * code complexity, so for now I will live with the current slight 463 * penalty of reducing max transfer size by (num_open-num_scheduled) 464 * packet slots. 465 */ 466 ep->buffer_size = UGETW(epd->wMaxPacketSize); 467 ep->buffer_size -= ep->buffer_size % UMIDI_PACKET_SIZE; 468 469 DPRINTF(("%s: alloc_pipe %p, buffer size %u\n", 470 device_xname(sc->sc_dev), ep, ep->buffer_size)); 471 ep->num_scheduled = 0; 472 ep->this_schedule = 0; 473 ep->next_schedule = 0; 474 ep->soliciting = 0; 475 ep->armed = 0; 476 ep->xfer = usbd_alloc_xfer(sc->sc_udev); 477 if (ep->xfer == NULL) { 478 err = USBD_NOMEM; 479 goto quit; 480 } 481 ep->buffer = usbd_alloc_buffer(ep->xfer, ep->buffer_size); 482 if (ep->buffer == NULL) { 483 usbd_free_xfer(ep->xfer); 484 err = USBD_NOMEM; 485 goto quit; 486 } 487 ep->next_slot = ep->buffer; 488 err = usbd_open_pipe(sc->sc_iface, ep->addr, 0, &ep->pipe); 489 if (err) 490 usbd_free_xfer(ep->xfer); 491 ep->solicit_cookie = softint_establish(SOFTINT_CLOCK, out_solicit, ep); 492 quit: 493 return err; 494 } 495 496 static void 497 free_pipe(struct umidi_endpoint *ep) 498 { 499 DPRINTF(("%s: free_pipe %p\n", device_xname(ep->sc->sc_dev), ep)); 500 usbd_abort_pipe(ep->pipe); 501 usbd_close_pipe(ep->pipe); 502 usbd_free_xfer(ep->xfer); 503 softint_disestablish(ep->solicit_cookie); 504 } 505 506 507 /* alloc/free the array of endpoint structures */ 508 509 static usbd_status alloc_all_endpoints_fixed_ep(struct umidi_softc *); 510 static usbd_status alloc_all_endpoints_yamaha(struct umidi_softc *); 511 static usbd_status alloc_all_endpoints_genuine(struct umidi_softc *); 512 513 static usbd_status 514 alloc_all_endpoints(struct umidi_softc *sc) 515 { 516 usbd_status err; 517 struct umidi_endpoint *ep; 518 int i; 519 520 if (UMQ_ISTYPE(sc, UMQ_TYPE_FIXED_EP)) { 521 err = alloc_all_endpoints_fixed_ep(sc); 522 } else if (UMQ_ISTYPE(sc, UMQ_TYPE_YAMAHA)) { 523 err = alloc_all_endpoints_yamaha(sc); 524 } else { 525 err = alloc_all_endpoints_genuine(sc); 526 } 527 if (err!=USBD_NORMAL_COMPLETION) 528 return err; 529 530 ep = sc->sc_endpoints; 531 for (i=sc->sc_out_num_endpoints+sc->sc_in_num_endpoints; i>0; i--) { 532 err = alloc_pipe(ep++); 533 if (err!=USBD_NORMAL_COMPLETION) { 534 for (; ep!=sc->sc_endpoints; ep--) 535 free_pipe(ep-1); 536 free(sc->sc_endpoints, M_USBDEV); 537 sc->sc_endpoints = sc->sc_out_ep = sc->sc_in_ep = NULL; 538 break; 539 } 540 } 541 return err; 542 } 543 544 static void 545 free_all_endpoints(struct umidi_softc *sc) 546 { 547 int i; 548 for (i=0; i<sc->sc_in_num_endpoints+sc->sc_out_num_endpoints; i++) 549 free_pipe(&sc->sc_endpoints[i]); 550 if (sc->sc_endpoints != NULL) 551 free(sc->sc_endpoints, M_USBDEV); 552 sc->sc_endpoints = sc->sc_out_ep = sc->sc_in_ep = NULL; 553 } 554 555 static usbd_status 556 alloc_all_endpoints_fixed_ep(struct umidi_softc *sc) 557 { 558 usbd_status err; 559 const struct umq_fixed_ep_desc *fp; 560 struct umidi_endpoint *ep; 561 usb_endpoint_descriptor_t *epd; 562 int i; 563 564 fp = umidi_get_quirk_data_from_type(sc->sc_quirk, 565 UMQ_TYPE_FIXED_EP); 566 sc->sc_out_num_jacks = 0; 567 sc->sc_in_num_jacks = 0; 568 sc->sc_out_num_endpoints = fp->num_out_ep; 569 sc->sc_in_num_endpoints = fp->num_in_ep; 570 sc->sc_endpoints = malloc(sizeof(*sc->sc_out_ep)* 571 (sc->sc_out_num_endpoints+ 572 sc->sc_in_num_endpoints), 573 M_USBDEV, M_WAITOK); 574 if (!sc->sc_endpoints) { 575 return USBD_NOMEM; 576 } 577 sc->sc_out_ep = sc->sc_out_num_endpoints ? sc->sc_endpoints : NULL; 578 sc->sc_in_ep = 579 sc->sc_in_num_endpoints ? 580 sc->sc_endpoints+sc->sc_out_num_endpoints : NULL; 581 582 ep = &sc->sc_out_ep[0]; 583 for (i=0; i<sc->sc_out_num_endpoints; i++) { 584 epd = usbd_interface2endpoint_descriptor( 585 sc->sc_iface, 586 fp->out_ep[i].ep); 587 if (!epd) { 588 aprint_error_dev(sc->sc_dev, 589 "cannot get endpoint descriptor(out:%d)\n", 590 fp->out_ep[i].ep); 591 err = USBD_INVAL; 592 goto error; 593 } 594 if (UE_GET_XFERTYPE(epd->bmAttributes)!=UE_BULK || 595 UE_GET_DIR(epd->bEndpointAddress)!=UE_DIR_OUT) { 596 aprint_error_dev(sc->sc_dev, "illegal endpoint(out:%d)\n", 597 fp->out_ep[i].ep); 598 err = USBD_INVAL; 599 goto error; 600 } 601 ep->sc = sc; 602 ep->addr = epd->bEndpointAddress; 603 ep->num_jacks = fp->out_ep[i].num_jacks; 604 sc->sc_out_num_jacks += fp->out_ep[i].num_jacks; 605 ep->num_open = 0; 606 memset(ep->jacks, 0, sizeof(ep->jacks)); 607 ep++; 608 } 609 ep = &sc->sc_in_ep[0]; 610 for (i=0; i<sc->sc_in_num_endpoints; i++) { 611 epd = usbd_interface2endpoint_descriptor( 612 sc->sc_iface, 613 fp->in_ep[i].ep); 614 if (!epd) { 615 aprint_error_dev(sc->sc_dev, 616 "cannot get endpoint descriptor(in:%d)\n", 617 fp->in_ep[i].ep); 618 err = USBD_INVAL; 619 goto error; 620 } 621 /* 622 * MIDISPORT_2X4 inputs on an interrupt rather than a bulk 623 * endpoint. The existing input logic in this driver seems 624 * to work successfully if we just stop treating an interrupt 625 * endpoint as illegal (or the in_progress status we get on 626 * the initial transfer). It does not seem necessary to 627 * actually use the interrupt flavor of alloc_pipe or make 628 * other serious rearrangements of logic. I like that. 629 */ 630 switch ( UE_GET_XFERTYPE(epd->bmAttributes) ) { 631 case UE_BULK: 632 case UE_INTERRUPT: 633 if ( UE_DIR_IN == UE_GET_DIR(epd->bEndpointAddress) ) 634 break; 635 /*FALLTHROUGH*/ 636 default: 637 aprint_error_dev(sc->sc_dev, 638 "illegal endpoint(in:%d)\n", fp->in_ep[i].ep); 639 err = USBD_INVAL; 640 goto error; 641 } 642 643 ep->sc = sc; 644 ep->addr = epd->bEndpointAddress; 645 ep->num_jacks = fp->in_ep[i].num_jacks; 646 sc->sc_in_num_jacks += fp->in_ep[i].num_jacks; 647 ep->num_open = 0; 648 memset(ep->jacks, 0, sizeof(ep->jacks)); 649 ep++; 650 } 651 652 return USBD_NORMAL_COMPLETION; 653 error: 654 free(sc->sc_endpoints, M_USBDEV); 655 sc->sc_endpoints = NULL; 656 return err; 657 } 658 659 static usbd_status 660 alloc_all_endpoints_yamaha(struct umidi_softc *sc) 661 { 662 /* This driver currently supports max 1in/1out bulk endpoints */ 663 usb_descriptor_t *desc; 664 umidi_cs_descriptor_t *udesc; 665 usb_endpoint_descriptor_t *epd; 666 int out_addr, in_addr, i; 667 int dir; 668 size_t remain, descsize; 669 670 sc->sc_out_num_jacks = sc->sc_in_num_jacks = 0; 671 out_addr = in_addr = 0; 672 673 /* detect endpoints */ 674 desc = TO_D(usbd_get_interface_descriptor(sc->sc_iface)); 675 for (i=(int)TO_IFD(desc)->bNumEndpoints-1; i>=0; i--) { 676 epd = usbd_interface2endpoint_descriptor(sc->sc_iface, i); 677 KASSERT(epd != NULL); 678 if (UE_GET_XFERTYPE(epd->bmAttributes) == UE_BULK) { 679 dir = UE_GET_DIR(epd->bEndpointAddress); 680 if (dir==UE_DIR_OUT && !out_addr) 681 out_addr = epd->bEndpointAddress; 682 else if (dir==UE_DIR_IN && !in_addr) 683 in_addr = epd->bEndpointAddress; 684 } 685 } 686 udesc = (umidi_cs_descriptor_t *)NEXT_D(desc); 687 688 /* count jacks */ 689 if (!(udesc->bDescriptorType==UDESC_CS_INTERFACE && 690 udesc->bDescriptorSubtype==UMIDI_MS_HEADER)) 691 return USBD_INVAL; 692 remain = (size_t)UGETW(TO_CSIFD(udesc)->wTotalLength) - 693 (size_t)udesc->bLength; 694 udesc = (umidi_cs_descriptor_t *)NEXT_D(udesc); 695 696 while (remain>=sizeof(usb_descriptor_t)) { 697 descsize = udesc->bLength; 698 if (descsize>remain || descsize==0) 699 break; 700 if (udesc->bDescriptorType==UDESC_CS_INTERFACE && 701 remain>=UMIDI_JACK_DESCRIPTOR_SIZE) { 702 if (udesc->bDescriptorSubtype==UMIDI_OUT_JACK) 703 sc->sc_out_num_jacks++; 704 else if (udesc->bDescriptorSubtype==UMIDI_IN_JACK) 705 sc->sc_in_num_jacks++; 706 } 707 udesc = (umidi_cs_descriptor_t *)NEXT_D(udesc); 708 remain-=descsize; 709 } 710 711 /* validate some parameters */ 712 if (sc->sc_out_num_jacks>UMIDI_MAX_EPJACKS) 713 sc->sc_out_num_jacks = UMIDI_MAX_EPJACKS; 714 if (sc->sc_in_num_jacks>UMIDI_MAX_EPJACKS) 715 sc->sc_in_num_jacks = UMIDI_MAX_EPJACKS; 716 if (sc->sc_out_num_jacks && out_addr) { 717 sc->sc_out_num_endpoints = 1; 718 } else { 719 sc->sc_out_num_endpoints = 0; 720 sc->sc_out_num_jacks = 0; 721 } 722 if (sc->sc_in_num_jacks && in_addr) { 723 sc->sc_in_num_endpoints = 1; 724 } else { 725 sc->sc_in_num_endpoints = 0; 726 sc->sc_in_num_jacks = 0; 727 } 728 sc->sc_endpoints = malloc(sizeof(struct umidi_endpoint)* 729 (sc->sc_out_num_endpoints+ 730 sc->sc_in_num_endpoints), 731 M_USBDEV, M_WAITOK); 732 if (!sc->sc_endpoints) 733 return USBD_NOMEM; 734 if (sc->sc_out_num_endpoints) { 735 sc->sc_out_ep = sc->sc_endpoints; 736 sc->sc_out_ep->sc = sc; 737 sc->sc_out_ep->addr = out_addr; 738 sc->sc_out_ep->num_jacks = sc->sc_out_num_jacks; 739 sc->sc_out_ep->num_open = 0; 740 memset(sc->sc_out_ep->jacks, 0, sizeof(sc->sc_out_ep->jacks)); 741 } else 742 sc->sc_out_ep = NULL; 743 744 if (sc->sc_in_num_endpoints) { 745 sc->sc_in_ep = sc->sc_endpoints+sc->sc_out_num_endpoints; 746 sc->sc_in_ep->sc = sc; 747 sc->sc_in_ep->addr = in_addr; 748 sc->sc_in_ep->num_jacks = sc->sc_in_num_jacks; 749 sc->sc_in_ep->num_open = 0; 750 memset(sc->sc_in_ep->jacks, 0, sizeof(sc->sc_in_ep->jacks)); 751 } else 752 sc->sc_in_ep = NULL; 753 754 return USBD_NORMAL_COMPLETION; 755 } 756 757 static usbd_status 758 alloc_all_endpoints_genuine(struct umidi_softc *sc) 759 { 760 usb_interface_descriptor_t *interface_desc; 761 usb_config_descriptor_t *config_desc; 762 usb_descriptor_t *desc; 763 int num_ep; 764 size_t remain, descsize; 765 struct umidi_endpoint *p, *q, *lowest, *endep, tmpep; 766 int epaddr; 767 768 interface_desc = usbd_get_interface_descriptor(sc->sc_iface); 769 num_ep = interface_desc->bNumEndpoints; 770 sc->sc_endpoints = p = malloc(sizeof(struct umidi_endpoint) * num_ep, 771 M_USBDEV, M_WAITOK); 772 if (!p) 773 return USBD_NOMEM; 774 775 sc->sc_out_num_jacks = sc->sc_in_num_jacks = 0; 776 sc->sc_out_num_endpoints = sc->sc_in_num_endpoints = 0; 777 epaddr = -1; 778 779 /* get the list of endpoints for midi stream */ 780 config_desc = usbd_get_config_descriptor(sc->sc_udev); 781 desc = (usb_descriptor_t *) config_desc; 782 remain = (size_t)UGETW(config_desc->wTotalLength); 783 while (remain>=sizeof(usb_descriptor_t)) { 784 descsize = desc->bLength; 785 if (descsize>remain || descsize==0) 786 break; 787 if (desc->bDescriptorType==UDESC_ENDPOINT && 788 remain>=USB_ENDPOINT_DESCRIPTOR_SIZE && 789 UE_GET_XFERTYPE(TO_EPD(desc)->bmAttributes) == UE_BULK) { 790 epaddr = TO_EPD(desc)->bEndpointAddress; 791 } else if (desc->bDescriptorType==UDESC_CS_ENDPOINT && 792 remain>=UMIDI_CS_ENDPOINT_DESCRIPTOR_SIZE && 793 epaddr!=-1) { 794 if (num_ep>0) { 795 num_ep--; 796 p->sc = sc; 797 p->addr = epaddr; 798 p->num_jacks = TO_CSEPD(desc)->bNumEmbMIDIJack; 799 if (UE_GET_DIR(epaddr)==UE_DIR_OUT) { 800 sc->sc_out_num_endpoints++; 801 sc->sc_out_num_jacks += p->num_jacks; 802 } else { 803 sc->sc_in_num_endpoints++; 804 sc->sc_in_num_jacks += p->num_jacks; 805 } 806 p++; 807 } 808 } else 809 epaddr = -1; 810 desc = NEXT_D(desc); 811 remain-=descsize; 812 } 813 814 /* sort endpoints */ 815 num_ep = sc->sc_out_num_endpoints + sc->sc_in_num_endpoints; 816 p = sc->sc_endpoints; 817 endep = p + num_ep; 818 while (p<endep) { 819 lowest = p; 820 for (q=p+1; q<endep; q++) { 821 if ((UE_GET_DIR(lowest->addr)==UE_DIR_IN && 822 UE_GET_DIR(q->addr)==UE_DIR_OUT) || 823 ((UE_GET_DIR(lowest->addr)== 824 UE_GET_DIR(q->addr)) && 825 (UE_GET_ADDR(lowest->addr)> 826 UE_GET_ADDR(q->addr)))) 827 lowest = q; 828 } 829 if (lowest != p) { 830 memcpy((void *)&tmpep, (void *)p, sizeof(tmpep)); 831 memcpy((void *)p, (void *)lowest, sizeof(tmpep)); 832 memcpy((void *)lowest, (void *)&tmpep, sizeof(tmpep)); 833 } 834 p->num_open = 0; 835 p++; 836 } 837 838 sc->sc_out_ep = sc->sc_out_num_endpoints ? sc->sc_endpoints : NULL; 839 sc->sc_in_ep = 840 sc->sc_in_num_endpoints ? 841 sc->sc_endpoints+sc->sc_out_num_endpoints : NULL; 842 843 return USBD_NORMAL_COMPLETION; 844 } 845 846 847 /* 848 * jack stuffs 849 */ 850 851 static usbd_status 852 alloc_all_jacks(struct umidi_softc *sc) 853 { 854 int i, j; 855 struct umidi_endpoint *ep; 856 struct umidi_jack *jack; 857 const unsigned char *cn_spec; 858 859 if (UMQ_ISTYPE(sc, UMQ_TYPE_CN_SEQ_PER_EP)) 860 sc->cblnums_global = 0; 861 else if (UMQ_ISTYPE(sc, UMQ_TYPE_CN_SEQ_GLOBAL)) 862 sc->cblnums_global = 1; 863 else { 864 /* 865 * I don't think this default is correct, but it preserves 866 * the prior behavior of the code. That's why I defined two 867 * complementary quirks. Any device for which the default 868 * behavior is wrong can be made to work by giving it an 869 * explicit quirk, and if a pattern ever develops (as I suspect 870 * it will) that a lot of otherwise standard USB MIDI devices 871 * need the CN_SEQ_PER_EP "quirk," then this default can be 872 * changed to 0, and the only devices that will break are those 873 * listing neither quirk, and they'll easily be fixed by giving 874 * them the CN_SEQ_GLOBAL quirk. 875 */ 876 sc->cblnums_global = 1; 877 } 878 879 if (UMQ_ISTYPE(sc, UMQ_TYPE_CN_FIXED)) 880 cn_spec = umidi_get_quirk_data_from_type(sc->sc_quirk, 881 UMQ_TYPE_CN_FIXED); 882 else 883 cn_spec = NULL; 884 885 /* allocate/initialize structures */ 886 sc->sc_jacks = 887 malloc(sizeof(*sc->sc_out_jacks)*(sc->sc_in_num_jacks+ 888 sc->sc_out_num_jacks), 889 M_USBDEV, M_WAITOK); 890 if (!sc->sc_jacks) 891 return USBD_NOMEM; 892 sc->sc_out_jacks = 893 sc->sc_out_num_jacks ? sc->sc_jacks : NULL; 894 sc->sc_in_jacks = 895 sc->sc_in_num_jacks ? sc->sc_jacks+sc->sc_out_num_jacks : NULL; 896 897 jack = &sc->sc_out_jacks[0]; 898 for (i=0; i<sc->sc_out_num_jacks; i++) { 899 jack->opened = 0; 900 jack->binded = 0; 901 jack->arg = NULL; 902 jack->u.out.intr = NULL; 903 jack->midiman_ppkt = NULL; 904 if ( sc->cblnums_global ) 905 jack->cable_number = i; 906 jack++; 907 } 908 jack = &sc->sc_in_jacks[0]; 909 for (i=0; i<sc->sc_in_num_jacks; i++) { 910 jack->opened = 0; 911 jack->binded = 0; 912 jack->arg = NULL; 913 jack->u.in.intr = NULL; 914 if ( sc->cblnums_global ) 915 jack->cable_number = i; 916 jack++; 917 } 918 919 /* assign each jacks to each endpoints */ 920 jack = &sc->sc_out_jacks[0]; 921 ep = &sc->sc_out_ep[0]; 922 for (i=0; i<sc->sc_out_num_endpoints; i++) { 923 for (j=0; j<ep->num_jacks; j++) { 924 jack->endpoint = ep; 925 if ( cn_spec != NULL ) 926 jack->cable_number = *cn_spec++; 927 else if ( !sc->cblnums_global ) 928 jack->cable_number = j; 929 ep->jacks[jack->cable_number] = jack; 930 jack++; 931 } 932 ep++; 933 } 934 jack = &sc->sc_in_jacks[0]; 935 ep = &sc->sc_in_ep[0]; 936 for (i=0; i<sc->sc_in_num_endpoints; i++) { 937 for (j=0; j<ep->num_jacks; j++) { 938 jack->endpoint = ep; 939 if ( cn_spec != NULL ) 940 jack->cable_number = *cn_spec++; 941 else if ( !sc->cblnums_global ) 942 jack->cable_number = j; 943 ep->jacks[jack->cable_number] = jack; 944 jack++; 945 } 946 ep++; 947 } 948 949 return USBD_NORMAL_COMPLETION; 950 } 951 952 static void 953 free_all_jacks(struct umidi_softc *sc) 954 { 955 int s; 956 957 s = splaudio(); 958 if (sc->sc_out_jacks) { 959 free(sc->sc_jacks, M_USBDEV); 960 sc->sc_jacks = sc->sc_in_jacks = sc->sc_out_jacks = NULL; 961 } 962 splx(s); 963 } 964 965 static usbd_status 966 bind_jacks_to_mididev(struct umidi_softc *sc, 967 struct umidi_jack *out_jack, 968 struct umidi_jack *in_jack, 969 struct umidi_mididev *mididev) 970 { 971 if ((out_jack && out_jack->binded) || (in_jack && in_jack->binded)) 972 return USBD_IN_USE; 973 if (mididev->out_jack || mididev->in_jack) 974 return USBD_IN_USE; 975 976 if (out_jack) 977 out_jack->binded = 1; 978 if (in_jack) 979 in_jack->binded = 1; 980 mididev->in_jack = in_jack; 981 mididev->out_jack = out_jack; 982 983 return USBD_NORMAL_COMPLETION; 984 } 985 986 static void 987 unbind_jacks_from_mididev(struct umidi_mididev *mididev) 988 { 989 if ((mididev->flags & FWRITE) && mididev->out_jack) 990 close_out_jack(mididev->out_jack); 991 if ((mididev->flags & FREAD) && mididev->in_jack) 992 close_in_jack(mididev->in_jack); 993 994 if (mididev->out_jack) 995 mididev->out_jack->binded = 0; 996 if (mididev->in_jack) 997 mididev->in_jack->binded = 0; 998 mididev->out_jack = mididev->in_jack = NULL; 999 } 1000 1001 static void 1002 unbind_all_jacks(struct umidi_softc *sc) 1003 { 1004 int i; 1005 1006 if (sc->sc_mididevs) 1007 for (i=0; i<sc->sc_num_mididevs; i++) { 1008 unbind_jacks_from_mididev(&sc->sc_mididevs[i]); 1009 } 1010 } 1011 1012 static usbd_status 1013 assign_all_jacks_automatically(struct umidi_softc *sc) 1014 { 1015 usbd_status err; 1016 int i; 1017 struct umidi_jack *out, *in; 1018 const signed char *asg_spec; 1019 1020 err = 1021 alloc_all_mididevs(sc, 1022 max(sc->sc_out_num_jacks, sc->sc_in_num_jacks)); 1023 if (err!=USBD_NORMAL_COMPLETION) 1024 return err; 1025 1026 if ( UMQ_ISTYPE(sc, UMQ_TYPE_MD_FIXED)) 1027 asg_spec = umidi_get_quirk_data_from_type(sc->sc_quirk, 1028 UMQ_TYPE_MD_FIXED); 1029 else 1030 asg_spec = NULL; 1031 1032 for (i=0; i<sc->sc_num_mididevs; i++) { 1033 if ( asg_spec != NULL ) { 1034 if ( *asg_spec == -1 ) 1035 out = NULL; 1036 else 1037 out = &sc->sc_out_jacks[*asg_spec]; 1038 ++ asg_spec; 1039 if ( *asg_spec == -1 ) 1040 in = NULL; 1041 else 1042 in = &sc->sc_in_jacks[*asg_spec]; 1043 ++ asg_spec; 1044 } else { 1045 out = (i<sc->sc_out_num_jacks) ? &sc->sc_out_jacks[i] 1046 : NULL; 1047 in = (i<sc->sc_in_num_jacks) ? &sc->sc_in_jacks[i] 1048 : NULL; 1049 } 1050 err = bind_jacks_to_mididev(sc, out, in, &sc->sc_mididevs[i]); 1051 if (err!=USBD_NORMAL_COMPLETION) { 1052 free_all_mididevs(sc); 1053 return err; 1054 } 1055 } 1056 1057 return USBD_NORMAL_COMPLETION; 1058 } 1059 1060 static usbd_status 1061 open_out_jack(struct umidi_jack *jack, void *arg, void (*intr)(void *)) 1062 { 1063 struct umidi_endpoint *ep = jack->endpoint; 1064 umidi_packet_bufp end; 1065 int s; 1066 int err; 1067 1068 if (jack->opened) 1069 return USBD_IN_USE; 1070 1071 jack->arg = arg; 1072 jack->u.out.intr = intr; 1073 jack->midiman_ppkt = NULL; 1074 end = ep->buffer + ep->buffer_size / sizeof *ep->buffer; 1075 s = splusb(); 1076 jack->opened = 1; 1077 ep->num_open++; 1078 /* 1079 * out_solicit maintains an invariant that there will always be 1080 * (num_open - num_scheduled) slots free in the buffer. as we have 1081 * just incremented num_open, the buffer may be too full to satisfy 1082 * the invariant until a transfer completes, for which we must wait. 1083 */ 1084 while ( end - ep->next_slot < ep->num_open - ep->num_scheduled ) { 1085 err = tsleep(ep, PWAIT|PCATCH, "umi op", mstohz(10)); 1086 if ( err ) { 1087 ep->num_open--; 1088 jack->opened = 0; 1089 splx(s); 1090 return USBD_IOERROR; 1091 } 1092 } 1093 splx(s); 1094 1095 return USBD_NORMAL_COMPLETION; 1096 } 1097 1098 static usbd_status 1099 open_in_jack(struct umidi_jack *jack, void *arg, void (*intr)(void *, int)) 1100 { 1101 usbd_status err = USBD_NORMAL_COMPLETION; 1102 struct umidi_endpoint *ep = jack->endpoint; 1103 1104 if (jack->opened) 1105 return USBD_IN_USE; 1106 1107 jack->arg = arg; 1108 jack->u.in.intr = intr; 1109 jack->opened = 1; 1110 if (ep->num_open++==0 && UE_GET_DIR(ep->addr)==UE_DIR_IN) { 1111 err = start_input_transfer(ep); 1112 if (err != USBD_NORMAL_COMPLETION && 1113 err != USBD_IN_PROGRESS) { 1114 ep->num_open--; 1115 } 1116 } 1117 1118 return err; 1119 } 1120 1121 static void 1122 close_out_jack(struct umidi_jack *jack) 1123 { 1124 struct umidi_endpoint *ep; 1125 int s; 1126 u_int16_t mask; 1127 int err; 1128 1129 if (jack->opened) { 1130 ep = jack->endpoint; 1131 mask = 1 << (jack->cable_number); 1132 s = splusb(); 1133 while ( mask & (ep->this_schedule | ep->next_schedule) ) { 1134 err = tsleep(ep, PWAIT|PCATCH, "umi dr", mstohz(10)); 1135 if ( err ) 1136 break; 1137 } 1138 jack->opened = 0; 1139 jack->endpoint->num_open--; 1140 ep->this_schedule &= ~mask; 1141 ep->next_schedule &= ~mask; 1142 splx(s); 1143 } 1144 } 1145 1146 static void 1147 close_in_jack(struct umidi_jack *jack) 1148 { 1149 if (jack->opened) { 1150 jack->opened = 0; 1151 if (--jack->endpoint->num_open == 0) { 1152 usbd_abort_pipe(jack->endpoint->pipe); 1153 } 1154 } 1155 } 1156 1157 static usbd_status 1158 attach_mididev(struct umidi_softc *sc, struct umidi_mididev *mididev) 1159 { 1160 if (mididev->sc) 1161 return USBD_IN_USE; 1162 1163 mididev->sc = sc; 1164 1165 mididev->label = describe_mididev(mididev); 1166 1167 mididev->mdev = midi_attach_mi(&umidi_hw_if, mididev, sc->sc_dev); 1168 1169 return USBD_NORMAL_COMPLETION; 1170 } 1171 1172 static usbd_status 1173 detach_mididev(struct umidi_mididev *mididev, int flags) 1174 { 1175 if (!mididev->sc) 1176 return USBD_NO_ADDR; 1177 1178 if (mididev->opened) { 1179 umidi_close(mididev); 1180 } 1181 unbind_jacks_from_mididev(mididev); 1182 1183 if (mididev->mdev != NULL) 1184 config_detach(mididev->mdev, flags); 1185 1186 if (NULL != mididev->label) { 1187 free(mididev->label, M_USBDEV); 1188 mididev->label = NULL; 1189 } 1190 1191 mididev->sc = NULL; 1192 1193 return USBD_NORMAL_COMPLETION; 1194 } 1195 1196 static void 1197 deactivate_mididev(struct umidi_mididev *mididev) 1198 { 1199 if (mididev->out_jack) 1200 mididev->out_jack->binded = 0; 1201 if (mididev->in_jack) 1202 mididev->in_jack->binded = 0; 1203 } 1204 1205 static usbd_status 1206 alloc_all_mididevs(struct umidi_softc *sc, int nmidi) 1207 { 1208 sc->sc_num_mididevs = nmidi; 1209 sc->sc_mididevs = malloc(sizeof(*sc->sc_mididevs)*nmidi, 1210 M_USBDEV, M_WAITOK|M_ZERO); 1211 if (!sc->sc_mididevs) 1212 return USBD_NOMEM; 1213 1214 return USBD_NORMAL_COMPLETION; 1215 } 1216 1217 static void 1218 free_all_mididevs(struct umidi_softc *sc) 1219 { 1220 sc->sc_num_mididevs = 0; 1221 if (sc->sc_mididevs) 1222 free(sc->sc_mididevs, M_USBDEV); 1223 } 1224 1225 static usbd_status 1226 attach_all_mididevs(struct umidi_softc *sc) 1227 { 1228 usbd_status err; 1229 int i; 1230 1231 if (sc->sc_mididevs) 1232 for (i=0; i<sc->sc_num_mididevs; i++) { 1233 err = attach_mididev(sc, &sc->sc_mididevs[i]); 1234 if (err!=USBD_NORMAL_COMPLETION) 1235 return err; 1236 } 1237 1238 return USBD_NORMAL_COMPLETION; 1239 } 1240 1241 static usbd_status 1242 detach_all_mididevs(struct umidi_softc *sc, int flags) 1243 { 1244 usbd_status err; 1245 int i; 1246 1247 if (sc->sc_mididevs) 1248 for (i=0; i<sc->sc_num_mididevs; i++) { 1249 err = detach_mididev(&sc->sc_mididevs[i], flags); 1250 if (err!=USBD_NORMAL_COMPLETION) 1251 return err; 1252 } 1253 1254 return USBD_NORMAL_COMPLETION; 1255 } 1256 1257 static void 1258 deactivate_all_mididevs(struct umidi_softc *sc) 1259 { 1260 int i; 1261 1262 if (sc->sc_mididevs) { 1263 for (i=0; i<sc->sc_num_mididevs; i++) 1264 deactivate_mididev(&sc->sc_mididevs[i]); 1265 } 1266 } 1267 1268 /* 1269 * TODO: the 0-based cable numbers will often not match the labeling of the 1270 * equipment. Ideally: 1271 * For class-compliant devices: get the iJack string from the jack descriptor. 1272 * Otherwise: 1273 * - support a DISPLAY_BASE_CN quirk (add the value to each internal cable 1274 * number for display) 1275 * - support an array quirk explictly giving a char * for each jack. 1276 * For now, you get 0-based cable numbers. If there are multiple endpoints and 1277 * the CNs are not globally unique, each is shown with its associated endpoint 1278 * address in hex also. That should not be necessary when using iJack values 1279 * or a quirk array. 1280 */ 1281 static char * 1282 describe_mididev(struct umidi_mididev *md) 1283 { 1284 char in_label[16]; 1285 char out_label[16]; 1286 const char *unit_label; 1287 char *final_label; 1288 struct umidi_softc *sc; 1289 int show_ep_in; 1290 int show_ep_out; 1291 size_t len; 1292 1293 sc = md->sc; 1294 show_ep_in = sc-> sc_in_num_endpoints > 1 && !sc->cblnums_global; 1295 show_ep_out = sc->sc_out_num_endpoints > 1 && !sc->cblnums_global; 1296 1297 if ( NULL == md->in_jack ) 1298 in_label[0] = '\0'; 1299 else if ( show_ep_in ) 1300 snprintf(in_label, sizeof in_label, "<%d(%x) ", 1301 md->in_jack->cable_number, md->in_jack->endpoint->addr); 1302 else 1303 snprintf(in_label, sizeof in_label, "<%d ", 1304 md->in_jack->cable_number); 1305 1306 if ( NULL == md->out_jack ) 1307 out_label[0] = '\0'; 1308 else if ( show_ep_out ) 1309 snprintf(out_label, sizeof out_label, ">%d(%x) ", 1310 md->out_jack->cable_number, md->out_jack->endpoint->addr); 1311 else 1312 snprintf(out_label, sizeof out_label, ">%d ", 1313 md->out_jack->cable_number); 1314 1315 unit_label = device_xname(sc->sc_dev); 1316 1317 len = strlen(in_label) + strlen(out_label) + strlen(unit_label) + 4; 1318 1319 final_label = malloc(len, M_USBDEV, M_WAITOK); 1320 1321 snprintf(final_label, len, "%s%son %s", 1322 in_label, out_label, unit_label); 1323 1324 return final_label; 1325 } 1326 1327 #ifdef UMIDI_DEBUG 1328 static void 1329 dump_sc(struct umidi_softc *sc) 1330 { 1331 int i; 1332 1333 DPRINTFN(10, ("%s: dump_sc\n", device_xname(sc->sc_dev))); 1334 for (i=0; i<sc->sc_out_num_endpoints; i++) { 1335 DPRINTFN(10, ("\tout_ep(%p):\n", &sc->sc_out_ep[i])); 1336 dump_ep(&sc->sc_out_ep[i]); 1337 } 1338 for (i=0; i<sc->sc_in_num_endpoints; i++) { 1339 DPRINTFN(10, ("\tin_ep(%p):\n", &sc->sc_in_ep[i])); 1340 dump_ep(&sc->sc_in_ep[i]); 1341 } 1342 } 1343 1344 static void 1345 dump_ep(struct umidi_endpoint *ep) 1346 { 1347 int i; 1348 for (i=0; i<UMIDI_MAX_EPJACKS; i++) { 1349 if (NULL==ep->jacks[i]) 1350 continue; 1351 DPRINTFN(10, ("\t\tjack[%d]:%p:\n", i, ep->jacks[i])); 1352 dump_jack(ep->jacks[i]); 1353 } 1354 } 1355 static void 1356 dump_jack(struct umidi_jack *jack) 1357 { 1358 DPRINTFN(10, ("\t\t\tep=%p\n", 1359 jack->endpoint)); 1360 } 1361 1362 #endif /* UMIDI_DEBUG */ 1363 1364 1365 1366 /* 1367 * MUX MIDI PACKET 1368 */ 1369 1370 static const int packet_length[16] = { 1371 /*0*/ -1, 1372 /*1*/ -1, 1373 /*2*/ 2, 1374 /*3*/ 3, 1375 /*4*/ 3, 1376 /*5*/ 1, 1377 /*6*/ 2, 1378 /*7*/ 3, 1379 /*8*/ 3, 1380 /*9*/ 3, 1381 /*A*/ 3, 1382 /*B*/ 3, 1383 /*C*/ 2, 1384 /*D*/ 2, 1385 /*E*/ 3, 1386 /*F*/ 1, 1387 }; 1388 1389 #define GET_CN(p) (((unsigned char)(p)>>4)&0x0F) 1390 #define GET_CIN(p) ((unsigned char)(p)&0x0F) 1391 #define MIX_CN_CIN(cn, cin) \ 1392 ((unsigned char)((((unsigned char)(cn)&0x0F)<<4)| \ 1393 ((unsigned char)(cin)&0x0F))) 1394 1395 static usbd_status 1396 start_input_transfer(struct umidi_endpoint *ep) 1397 { 1398 usbd_setup_xfer(ep->xfer, ep->pipe, 1399 (usbd_private_handle)ep, 1400 ep->buffer, ep->buffer_size, 1401 USBD_SHORT_XFER_OK | USBD_NO_COPY, 1402 USBD_NO_TIMEOUT, in_intr); 1403 return usbd_transfer(ep->xfer); 1404 } 1405 1406 static usbd_status 1407 start_output_transfer(struct umidi_endpoint *ep) 1408 { 1409 usbd_status rv; 1410 u_int32_t length; 1411 int i; 1412 1413 length = (ep->next_slot - ep->buffer) * sizeof *ep->buffer; 1414 DPRINTFN(200,("umidi out transfer: start %p end %p length %u\n", 1415 ep->buffer, ep->next_slot, length)); 1416 usbd_setup_xfer(ep->xfer, ep->pipe, 1417 (usbd_private_handle)ep, 1418 ep->buffer, length, 1419 USBD_NO_COPY, USBD_NO_TIMEOUT, out_intr); 1420 rv = usbd_transfer(ep->xfer); 1421 1422 /* 1423 * Once the transfer is scheduled, no more adding to partial 1424 * packets within it. 1425 */ 1426 if (UMQ_ISTYPE(ep->sc, UMQ_TYPE_MIDIMAN_GARBLE)) { 1427 for (i=0; i<UMIDI_MAX_EPJACKS; ++i) 1428 if (NULL != ep->jacks[i]) 1429 ep->jacks[i]->midiman_ppkt = NULL; 1430 } 1431 1432 return rv; 1433 } 1434 1435 #ifdef UMIDI_DEBUG 1436 #define DPR_PACKET(dir, sc, p) \ 1437 if ((unsigned char)(p)[1]!=0xFE) \ 1438 DPRINTFN(500, \ 1439 ("%s: umidi packet(" #dir "): %02X %02X %02X %02X\n", \ 1440 device_xname(sc->sc_dev), \ 1441 (unsigned char)(p)[0], \ 1442 (unsigned char)(p)[1], \ 1443 (unsigned char)(p)[2], \ 1444 (unsigned char)(p)[3])); 1445 #else 1446 #define DPR_PACKET(dir, sc, p) 1447 #endif 1448 1449 /* 1450 * A 4-byte Midiman packet superficially resembles a 4-byte USB MIDI packet 1451 * with the cable number and length in the last byte instead of the first, 1452 * but there the resemblance ends. Where a USB MIDI packet is a semantic 1453 * unit, a Midiman packet is just a wrapper for 1 to 3 bytes of raw MIDI 1454 * with a cable nybble and a length nybble (which, unlike the CIN of a 1455 * real USB MIDI packet, has no semantics at all besides the length). 1456 * A packet received from a Midiman may contain part of a MIDI message, 1457 * more than one MIDI message, or parts of more than one MIDI message. A 1458 * three-byte MIDI message may arrive in three packets of data length 1, and 1459 * running status may be used. Happily, the midi(4) driver above us will put 1460 * it all back together, so the only cost is in USB bandwidth. The device 1461 * has an easier time with what it receives from us: we'll pack messages in 1462 * and across packets, but filling the packets whenever possible and, 1463 * as midi(4) hands us a complete message at a time, we'll never send one 1464 * in a dribble of short packets. 1465 */ 1466 1467 static int 1468 out_jack_output(struct umidi_jack *out_jack, u_char *src, int len, int cin) 1469 { 1470 struct umidi_endpoint *ep = out_jack->endpoint; 1471 struct umidi_softc *sc = ep->sc; 1472 unsigned char *packet; 1473 int s; 1474 int plen; 1475 int poff; 1476 1477 if (sc->sc_dying) 1478 return EIO; 1479 1480 if (!out_jack->opened) 1481 return ENODEV; /* XXX as it was, is this the right errno? */ 1482 1483 #ifdef UMIDI_DEBUG 1484 if ( umididebug >= 100 ) 1485 microtime(&umidi_tv); 1486 #endif 1487 DPRINTFN(100, ("umidi out: %"PRIu64".%06"PRIu64"s ep=%p cn=%d len=%d cin=%#x\n", 1488 umidi_tv.tv_sec%100, (uint64_t)umidi_tv.tv_usec, 1489 ep, out_jack->cable_number, len, cin)); 1490 1491 s = splusb(); 1492 packet = *ep->next_slot++; 1493 KASSERT(ep->buffer_size >= 1494 (ep->next_slot - ep->buffer) * sizeof *ep->buffer); 1495 memset(packet, 0, UMIDI_PACKET_SIZE); 1496 if (UMQ_ISTYPE(sc, UMQ_TYPE_MIDIMAN_GARBLE)) { 1497 if (NULL != out_jack->midiman_ppkt) { /* fill out a prev pkt */ 1498 poff = 0x0f & (out_jack->midiman_ppkt[3]); 1499 plen = 3 - poff; 1500 if (plen > len) 1501 plen = len; 1502 memcpy(out_jack->midiman_ppkt+poff, src, plen); 1503 src += plen; 1504 len -= plen; 1505 plen += poff; 1506 out_jack->midiman_ppkt[3] = 1507 MIX_CN_CIN(out_jack->cable_number, plen); 1508 DPR_PACKET(out+, sc, out_jack->midiman_ppkt); 1509 if (3 == plen) 1510 out_jack->midiman_ppkt = NULL; /* no more */ 1511 } 1512 if (0 == len) 1513 ep->next_slot--; /* won't be needed, nevermind */ 1514 else { 1515 memcpy(packet, src, len); 1516 packet[3] = MIX_CN_CIN(out_jack->cable_number, len); 1517 DPR_PACKET(out, sc, packet); 1518 if (len < 3) 1519 out_jack->midiman_ppkt = packet; 1520 } 1521 } else { /* the nice simple USB class-compliant case */ 1522 packet[0] = MIX_CN_CIN(out_jack->cable_number, cin); 1523 memcpy(packet+1, src, len); 1524 DPR_PACKET(out, sc, packet); 1525 } 1526 ep->next_schedule |= 1<<(out_jack->cable_number); 1527 ++ ep->num_scheduled; 1528 if ( !ep->armed && !ep->soliciting ) { 1529 /* 1530 * It would be bad to call out_solicit directly here (the 1531 * caller need not be reentrant) but a soft interrupt allows 1532 * solicit to run immediately the caller exits its critical 1533 * section, and if the caller has more to write we can get it 1534 * before starting the USB transfer, and send a longer one. 1535 */ 1536 ep->soliciting = 1; 1537 softint_schedule(ep->solicit_cookie); 1538 } 1539 splx(s); 1540 1541 return 0; 1542 } 1543 1544 static void 1545 in_intr(usbd_xfer_handle xfer, usbd_private_handle priv, 1546 usbd_status status) 1547 { 1548 int cn, len, i; 1549 struct umidi_endpoint *ep = (struct umidi_endpoint *)priv; 1550 struct umidi_jack *jack; 1551 unsigned char *packet; 1552 umidi_packet_bufp slot; 1553 umidi_packet_bufp end; 1554 unsigned char *data; 1555 u_int32_t count; 1556 1557 if (ep->sc->sc_dying || !ep->num_open) 1558 return; 1559 1560 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL); 1561 if ( 0 == count % UMIDI_PACKET_SIZE ) { 1562 DPRINTFN(200,("%s: input endpoint %p transfer length %u\n", 1563 device_xname(ep->sc->sc_dev), ep, count)); 1564 } else { 1565 DPRINTF(("%s: input endpoint %p odd transfer length %u\n", 1566 device_xname(ep->sc->sc_dev), ep, count)); 1567 } 1568 1569 slot = ep->buffer; 1570 end = slot + count / sizeof *slot; 1571 1572 for ( packet = *slot; slot < end; packet = *++slot ) { 1573 1574 if ( UMQ_ISTYPE(ep->sc, UMQ_TYPE_MIDIMAN_GARBLE) ) { 1575 cn = (0xf0&(packet[3]))>>4; 1576 len = 0x0f&(packet[3]); 1577 data = packet; 1578 } else { 1579 cn = GET_CN(packet[0]); 1580 len = packet_length[GET_CIN(packet[0])]; 1581 data = packet + 1; 1582 } 1583 /* 0 <= cn <= 15 by inspection of above code */ 1584 if (!(jack = ep->jacks[cn]) || cn != jack->cable_number) { 1585 DPRINTF(("%s: stray input endpoint %p cable %d len %d: " 1586 "%02X %02X %02X (try CN_SEQ quirk?)\n", 1587 device_xname(ep->sc->sc_dev), ep, cn, len, 1588 (unsigned)data[0], 1589 (unsigned)data[1], 1590 (unsigned)data[2])); 1591 return; 1592 } 1593 1594 if (!jack->binded || !jack->opened) 1595 continue; 1596 1597 DPRINTFN(500,("%s: input endpoint %p cable %d len %d: " 1598 "%02X %02X %02X\n", 1599 device_xname(ep->sc->sc_dev), ep, cn, len, 1600 (unsigned)data[0], 1601 (unsigned)data[1], 1602 (unsigned)data[2])); 1603 1604 if (jack->u.in.intr) { 1605 for (i=0; i<len; i++) { 1606 (*jack->u.in.intr)(jack->arg, data[i]); 1607 } 1608 } 1609 1610 } 1611 1612 (void)start_input_transfer(ep); 1613 } 1614 1615 static void 1616 out_intr(usbd_xfer_handle xfer, usbd_private_handle priv, 1617 usbd_status status) 1618 { 1619 struct umidi_endpoint *ep = (struct umidi_endpoint *)priv; 1620 struct umidi_softc *sc = ep->sc; 1621 u_int32_t count; 1622 1623 if (sc->sc_dying) 1624 return; 1625 1626 #ifdef UMIDI_DEBUG 1627 if ( umididebug >= 200 ) 1628 microtime(&umidi_tv); 1629 #endif 1630 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL); 1631 if ( 0 == count % UMIDI_PACKET_SIZE ) { 1632 DPRINTFN(200,("%s: %"PRIu64".%06"PRIu64"s out ep %p xfer length %u\n", 1633 device_xname(ep->sc->sc_dev), 1634 umidi_tv.tv_sec%100, (uint64_t)umidi_tv.tv_usec, ep, count)); 1635 } else { 1636 DPRINTF(("%s: output endpoint %p odd transfer length %u\n", 1637 device_xname(ep->sc->sc_dev), ep, count)); 1638 } 1639 count /= UMIDI_PACKET_SIZE; 1640 1641 /* 1642 * If while the transfer was pending we buffered any new messages, 1643 * move them to the start of the buffer. 1644 */ 1645 ep->next_slot -= count; 1646 if ( ep->buffer < ep->next_slot ) { 1647 memcpy(ep->buffer, ep->buffer + count, 1648 (char *)ep->next_slot - (char *)ep->buffer); 1649 } 1650 wakeup(ep); 1651 /* 1652 * Do not want anyone else to see armed <- 0 before soliciting <- 1. 1653 * Running at splusb so the following should happen to be safe. 1654 */ 1655 ep->armed = 0; 1656 if ( !ep->soliciting ) { 1657 ep->soliciting = 1; 1658 out_solicit(ep); 1659 } 1660 } 1661 1662 /* 1663 * A jack on which we have received a packet must be called back on its 1664 * out.intr handler before it will send us another; it is considered 1665 * 'scheduled'. It is nice and predictable - as long as it is scheduled, 1666 * we need no extra buffer space for it. 1667 * 1668 * In contrast, a jack that is open but not scheduled may supply us a packet 1669 * at any time, driven by the top half, and we must be able to accept it, no 1670 * excuses. So we must ensure that at any point in time there are at least 1671 * (num_open - num_scheduled) slots free. 1672 * 1673 * As long as there are more slots free than that minimum, we can loop calling 1674 * scheduled jacks back on their "interrupt" handlers, soliciting more 1675 * packets, starting the USB transfer only when the buffer space is down to 1676 * the minimum or no jack has any more to send. 1677 */ 1678 static void 1679 out_solicit(void *arg) 1680 { 1681 struct umidi_endpoint *ep = arg; 1682 int s; 1683 umidi_packet_bufp end; 1684 u_int16_t which; 1685 struct umidi_jack *jack; 1686 1687 end = ep->buffer + ep->buffer_size / sizeof *ep->buffer; 1688 1689 for ( ;; ) { 1690 s = splusb(); 1691 if ( end - ep->next_slot <= ep->num_open - ep->num_scheduled ) 1692 break; /* at splusb */ 1693 if ( ep->this_schedule == 0 ) { 1694 if ( ep->next_schedule == 0 ) 1695 break; /* at splusb */ 1696 ep->this_schedule = ep->next_schedule; 1697 ep->next_schedule = 0; 1698 } 1699 /* 1700 * At least one jack is scheduled. Find and mask off the least 1701 * set bit in this_schedule and decrement num_scheduled. 1702 * Convert mask to bit index to find the corresponding jack, 1703 * and call its intr handler. If it has a message, it will call 1704 * back one of the output methods, which will set its bit in 1705 * next_schedule (not copied into this_schedule until the 1706 * latter is empty). In this way we round-robin the jacks that 1707 * have messages to send, until the buffer is as full as we 1708 * dare, and then start a transfer. 1709 */ 1710 which = ep->this_schedule; 1711 which &= (~which)+1; /* now mask of least set bit */ 1712 ep->this_schedule &= ~which; 1713 -- ep->num_scheduled; 1714 splx(s); 1715 1716 -- which; /* now 1s below mask - count 1s to get index */ 1717 which -= ((which >> 1) & 0x5555);/* SWAR credit aggregate.org */ 1718 which = (((which >> 2) & 0x3333) + (which & 0x3333)); 1719 which = (((which >> 4) + which) & 0x0f0f); 1720 which += (which >> 8); 1721 which &= 0x1f; /* the bit index a/k/a jack number */ 1722 1723 jack = ep->jacks[which]; 1724 if (jack->u.out.intr) 1725 (*jack->u.out.intr)(jack->arg); 1726 } 1727 /* splusb at loop exit */ 1728 if ( !ep->armed && ep->next_slot > ep->buffer ) 1729 ep->armed = (USBD_IN_PROGRESS == start_output_transfer(ep)); 1730 ep->soliciting = 0; 1731 splx(s); 1732 } 1733