musb_otg.c revision 196219
1/* $FreeBSD: head/sys/dev/usb/controller/musb_otg.c 196219 2009-08-14 20:03:53Z jhb $ */ 2/*- 3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27/* 28 * Thanks to Mentor Graphics for providing a reference driver for this USB chip 29 * at their homepage. 30 */ 31 32/* 33 * This file contains the driver for the Mentor Graphics Inventra USB 34 * 2.0 High Speed Dual-Role controller. 35 * 36 * NOTE: The current implementation only supports Device Side Mode! 37 */ 38 39#include <sys/stdint.h> 40#include <sys/stddef.h> 41#include <sys/param.h> 42#include <sys/queue.h> 43#include <sys/types.h> 44#include <sys/systm.h> 45#include <sys/kernel.h> 46#include <sys/bus.h> 47#include <sys/linker_set.h> 48#include <sys/module.h> 49#include <sys/lock.h> 50#include <sys/mutex.h> 51#include <sys/condvar.h> 52#include <sys/sysctl.h> 53#include <sys/sx.h> 54#include <sys/unistd.h> 55#include <sys/callout.h> 56#include <sys/malloc.h> 57#include <sys/priv.h> 58 59#include <dev/usb/usb.h> 60#include <dev/usb/usbdi.h> 61 62#define USB_DEBUG_VAR musbotgdebug 63 64#include <dev/usb/usb_core.h> 65#include <dev/usb/usb_debug.h> 66#include <dev/usb/usb_busdma.h> 67#include <dev/usb/usb_process.h> 68#include <dev/usb/usb_transfer.h> 69#include <dev/usb/usb_device.h> 70#include <dev/usb/usb_hub.h> 71#include <dev/usb/usb_util.h> 72 73#include <dev/usb/usb_controller.h> 74#include <dev/usb/usb_bus.h> 75#include <dev/usb/controller/musb_otg.h> 76 77#define MUSBOTG_INTR_ENDPT 1 78 79#define MUSBOTG_BUS2SC(bus) \ 80 ((struct musbotg_softc *)(((uint8_t *)(bus)) - \ 81 USB_P2U(&(((struct musbotg_softc *)0)->sc_bus)))) 82 83#define MUSBOTG_PC2SC(pc) \ 84 MUSBOTG_BUS2SC(USB_DMATAG_TO_XROOT((pc)->tag_parent)->bus) 85 86#ifdef USB_DEBUG 87static int musbotgdebug = 0; 88 89SYSCTL_NODE(_hw_usb, OID_AUTO, musbotg, CTLFLAG_RW, 0, "USB musbotg"); 90SYSCTL_INT(_hw_usb_musbotg, OID_AUTO, debug, CTLFLAG_RW, 91 &musbotgdebug, 0, "Debug level"); 92#endif 93 94/* prototypes */ 95 96struct usb_bus_methods musbotg_bus_methods; 97struct usb_pipe_methods musbotg_device_bulk_methods; 98struct usb_pipe_methods musbotg_device_ctrl_methods; 99struct usb_pipe_methods musbotg_device_intr_methods; 100struct usb_pipe_methods musbotg_device_isoc_methods; 101 102static musbotg_cmd_t musbotg_setup_rx; 103static musbotg_cmd_t musbotg_setup_data_rx; 104static musbotg_cmd_t musbotg_setup_data_tx; 105static musbotg_cmd_t musbotg_setup_status; 106static musbotg_cmd_t musbotg_data_rx; 107static musbotg_cmd_t musbotg_data_tx; 108static void musbotg_device_done(struct usb_xfer *, usb_error_t); 109static void musbotg_do_poll(struct usb_bus *); 110static void musbotg_standard_done(struct usb_xfer *); 111static void musbotg_interrupt_poll(struct musbotg_softc *); 112static void musbotg_root_intr(struct musbotg_softc *); 113 114/* 115 * Here is a configuration that the chip supports. 116 */ 117static const struct usb_hw_ep_profile musbotg_ep_profile[1] = { 118 119 [0] = { 120 .max_in_frame_size = 64,/* fixed */ 121 .max_out_frame_size = 64, /* fixed */ 122 .is_simplex = 1, 123 .support_control = 1, 124 } 125}; 126 127static void 128musbotg_get_hw_ep_profile(struct usb_device *udev, 129 const struct usb_hw_ep_profile **ppf, uint8_t ep_addr) 130{ 131 struct musbotg_softc *sc; 132 133 sc = MUSBOTG_BUS2SC(udev->bus); 134 135 if (ep_addr == 0) { 136 /* control endpoint */ 137 *ppf = musbotg_ep_profile; 138 } else if (ep_addr <= sc->sc_ep_max) { 139 /* other endpoints */ 140 *ppf = sc->sc_hw_ep_profile + ep_addr; 141 } else { 142 *ppf = NULL; 143 } 144} 145 146static void 147musbotg_clocks_on(struct musbotg_softc *sc) 148{ 149 if (sc->sc_flags.clocks_off && 150 sc->sc_flags.port_powered) { 151 152 DPRINTFN(4, "\n"); 153 154 if (sc->sc_clocks_on) { 155 (sc->sc_clocks_on) (sc->sc_clocks_arg); 156 } 157 sc->sc_flags.clocks_off = 0; 158 159 /* XXX enable Transceiver */ 160 } 161} 162 163static void 164musbotg_clocks_off(struct musbotg_softc *sc) 165{ 166 if (!sc->sc_flags.clocks_off) { 167 168 DPRINTFN(4, "\n"); 169 170 /* XXX disable Transceiver */ 171 172 if (sc->sc_clocks_off) { 173 (sc->sc_clocks_off) (sc->sc_clocks_arg); 174 } 175 sc->sc_flags.clocks_off = 1; 176 } 177} 178 179static void 180musbotg_pull_common(struct musbotg_softc *sc, uint8_t on) 181{ 182 uint8_t temp; 183 184 temp = MUSB2_READ_1(sc, MUSB2_REG_POWER); 185 if (on) 186 temp |= MUSB2_MASK_SOFTC; 187 else 188 temp &= ~MUSB2_MASK_SOFTC; 189 190 MUSB2_WRITE_1(sc, MUSB2_REG_POWER, temp); 191} 192 193static void 194musbotg_pull_up(struct musbotg_softc *sc) 195{ 196 /* pullup D+, if possible */ 197 198 if (!sc->sc_flags.d_pulled_up && 199 sc->sc_flags.port_powered) { 200 sc->sc_flags.d_pulled_up = 1; 201 musbotg_pull_common(sc, 1); 202 } 203} 204 205static void 206musbotg_pull_down(struct musbotg_softc *sc) 207{ 208 /* pulldown D+, if possible */ 209 210 if (sc->sc_flags.d_pulled_up) { 211 sc->sc_flags.d_pulled_up = 0; 212 musbotg_pull_common(sc, 0); 213 } 214} 215 216static void 217musbotg_wakeup_peer(struct musbotg_softc *sc) 218{ 219 uint8_t temp; 220 221 if (!(sc->sc_flags.status_suspend)) { 222 return; 223 } 224 225 temp = MUSB2_READ_1(sc, MUSB2_REG_POWER); 226 temp |= MUSB2_MASK_RESUME; 227 MUSB2_WRITE_1(sc, MUSB2_REG_POWER, temp); 228 229 /* wait 8 milliseconds */ 230 /* Wait for reset to complete. */ 231 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 125); 232 233 temp = MUSB2_READ_1(sc, MUSB2_REG_POWER); 234 temp &= ~MUSB2_MASK_RESUME; 235 MUSB2_WRITE_1(sc, MUSB2_REG_POWER, temp); 236} 237 238static void 239musbotg_set_address(struct musbotg_softc *sc, uint8_t addr) 240{ 241 DPRINTFN(4, "addr=%d\n", addr); 242 addr &= 0x7F; 243 MUSB2_WRITE_1(sc, MUSB2_REG_FADDR, addr); 244} 245 246static uint8_t 247musbotg_setup_rx(struct musbotg_td *td) 248{ 249 struct musbotg_softc *sc; 250 struct usb_device_request req; 251 uint16_t count; 252 uint8_t csr; 253 254 /* get pointer to softc */ 255 sc = MUSBOTG_PC2SC(td->pc); 256 257 /* select endpoint 0 */ 258 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, 0); 259 260 /* read out FIFO status */ 261 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 262 263 DPRINTFN(4, "csr=0x%02x\n", csr); 264 265 /* 266 * NOTE: If DATAEND is set we should not call the 267 * callback, hence the status stage is not complete. 268 */ 269 if (csr & MUSB2_MASK_CSR0L_DATAEND) { 270 /* do not stall at this point */ 271 td->did_stall = 1; 272 /* wait for interrupt */ 273 goto not_complete; 274 } 275 if (csr & MUSB2_MASK_CSR0L_SENTSTALL) { 276 /* clear SENTSTALL */ 277 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 0); 278 /* get latest status */ 279 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 280 /* update EP0 state */ 281 sc->sc_ep0_busy = 0; 282 } 283 if (csr & MUSB2_MASK_CSR0L_SETUPEND) { 284 /* clear SETUPEND */ 285 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 286 MUSB2_MASK_CSR0L_SETUPEND_CLR); 287 /* get latest status */ 288 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 289 /* update EP0 state */ 290 sc->sc_ep0_busy = 0; 291 } 292 if (sc->sc_ep0_busy) { 293 goto not_complete; 294 } 295 if (!(csr & MUSB2_MASK_CSR0L_RXPKTRDY)) { 296 goto not_complete; 297 } 298 /* clear did stall flag */ 299 td->did_stall = 0; 300 /* get the packet byte count */ 301 count = MUSB2_READ_2(sc, MUSB2_REG_RXCOUNT); 302 303 /* verify data length */ 304 if (count != td->remainder) { 305 DPRINTFN(0, "Invalid SETUP packet " 306 "length, %d bytes\n", count); 307 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 308 MUSB2_MASK_CSR0L_RXPKTRDY_CLR); 309 goto not_complete; 310 } 311 if (count != sizeof(req)) { 312 DPRINTFN(0, "Unsupported SETUP packet " 313 "length, %d bytes\n", count); 314 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 315 MUSB2_MASK_CSR0L_RXPKTRDY_CLR); 316 goto not_complete; 317 } 318 /* receive data */ 319 bus_space_read_multi_1(sc->sc_io_tag, sc->sc_io_hdl, 320 MUSB2_REG_EPFIFO(0), (void *)&req, sizeof(req)); 321 322 /* copy data into real buffer */ 323 usbd_copy_in(td->pc, 0, &req, sizeof(req)); 324 325 td->offset = sizeof(req); 326 td->remainder = 0; 327 328 /* set pending command */ 329 sc->sc_ep0_cmd = MUSB2_MASK_CSR0L_RXPKTRDY_CLR; 330 331 /* we need set stall or dataend after this */ 332 sc->sc_ep0_busy = 1; 333 334 /* sneak peek the set address */ 335 if ((req.bmRequestType == UT_WRITE_DEVICE) && 336 (req.bRequest == UR_SET_ADDRESS)) { 337 sc->sc_dv_addr = req.wValue[0] & 0x7F; 338 } else { 339 sc->sc_dv_addr = 0xFF; 340 } 341 return (0); /* complete */ 342 343not_complete: 344 /* abort any ongoing transfer */ 345 if (!td->did_stall) { 346 DPRINTFN(4, "stalling\n"); 347 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 348 MUSB2_MASK_CSR0L_SENDSTALL); 349 td->did_stall = 1; 350 } 351 return (1); /* not complete */ 352} 353 354/* Control endpoint only data handling functions (RX/TX/SYNC) */ 355 356static uint8_t 357musbotg_setup_data_rx(struct musbotg_td *td) 358{ 359 struct usb_page_search buf_res; 360 struct musbotg_softc *sc; 361 uint16_t count; 362 uint8_t csr; 363 uint8_t got_short; 364 365 /* get pointer to softc */ 366 sc = MUSBOTG_PC2SC(td->pc); 367 368 /* select endpoint 0 */ 369 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, 0); 370 371 /* check if a command is pending */ 372 if (sc->sc_ep0_cmd) { 373 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, sc->sc_ep0_cmd); 374 sc->sc_ep0_cmd = 0; 375 } 376 /* read out FIFO status */ 377 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 378 379 DPRINTFN(4, "csr=0x%02x\n", csr); 380 381 got_short = 0; 382 383 if (csr & (MUSB2_MASK_CSR0L_SETUPEND | 384 MUSB2_MASK_CSR0L_SENTSTALL)) { 385 if (td->remainder == 0) { 386 /* 387 * We are actually complete and have 388 * received the next SETUP 389 */ 390 DPRINTFN(4, "faking complete\n"); 391 return (0); /* complete */ 392 } 393 /* 394 * USB Host Aborted the transfer. 395 */ 396 td->error = 1; 397 return (0); /* complete */ 398 } 399 if (!(csr & MUSB2_MASK_CSR0L_RXPKTRDY)) { 400 return (1); /* not complete */ 401 } 402 /* get the packet byte count */ 403 count = MUSB2_READ_2(sc, MUSB2_REG_RXCOUNT); 404 405 /* verify the packet byte count */ 406 if (count != td->max_frame_size) { 407 if (count < td->max_frame_size) { 408 /* we have a short packet */ 409 td->short_pkt = 1; 410 got_short = 1; 411 } else { 412 /* invalid USB packet */ 413 td->error = 1; 414 return (0); /* we are complete */ 415 } 416 } 417 /* verify the packet byte count */ 418 if (count > td->remainder) { 419 /* invalid USB packet */ 420 td->error = 1; 421 return (0); /* we are complete */ 422 } 423 while (count > 0) { 424 uint32_t temp; 425 426 usbd_get_page(td->pc, td->offset, &buf_res); 427 428 /* get correct length */ 429 if (buf_res.length > count) { 430 buf_res.length = count; 431 } 432 /* check for unaligned memory address */ 433 if (USB_P2U(buf_res.buffer) & 3) { 434 435 temp = count & ~3; 436 437 if (temp) { 438 /* receive data 4 bytes at a time */ 439 bus_space_read_multi_4(sc->sc_io_tag, sc->sc_io_hdl, 440 MUSB2_REG_EPFIFO(0), sc->sc_bounce_buf, 441 temp / 4); 442 } 443 temp = count & 3; 444 if (temp) { 445 /* receive data 1 byte at a time */ 446 bus_space_read_multi_1(sc->sc_io_tag, sc->sc_io_hdl, 447 MUSB2_REG_EPFIFO(0), 448 (void *)(&sc->sc_bounce_buf[count / 4]), temp); 449 } 450 usbd_copy_in(td->pc, td->offset, 451 sc->sc_bounce_buf, count); 452 453 /* update offset and remainder */ 454 td->offset += count; 455 td->remainder -= count; 456 break; 457 } 458 /* check if we can optimise */ 459 if (buf_res.length >= 4) { 460 461 /* receive data 4 bytes at a time */ 462 bus_space_read_multi_4(sc->sc_io_tag, sc->sc_io_hdl, 463 MUSB2_REG_EPFIFO(0), buf_res.buffer, 464 buf_res.length / 4); 465 466 temp = buf_res.length & ~3; 467 468 /* update counters */ 469 count -= temp; 470 td->offset += temp; 471 td->remainder -= temp; 472 continue; 473 } 474 /* receive data */ 475 bus_space_read_multi_1(sc->sc_io_tag, sc->sc_io_hdl, 476 MUSB2_REG_EPFIFO(0), buf_res.buffer, buf_res.length); 477 478 /* update counters */ 479 count -= buf_res.length; 480 td->offset += buf_res.length; 481 td->remainder -= buf_res.length; 482 } 483 484 /* check if we are complete */ 485 if ((td->remainder == 0) || got_short) { 486 if (td->short_pkt) { 487 /* we are complete */ 488 sc->sc_ep0_cmd = MUSB2_MASK_CSR0L_RXPKTRDY_CLR; 489 return (0); 490 } 491 /* else need to receive a zero length packet */ 492 } 493 /* write command - need more data */ 494 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 495 MUSB2_MASK_CSR0L_RXPKTRDY_CLR); 496 return (1); /* not complete */ 497} 498 499static uint8_t 500musbotg_setup_data_tx(struct musbotg_td *td) 501{ 502 struct usb_page_search buf_res; 503 struct musbotg_softc *sc; 504 uint16_t count; 505 uint8_t csr; 506 507 /* get pointer to softc */ 508 sc = MUSBOTG_PC2SC(td->pc); 509 510 /* select endpoint 0 */ 511 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, 0); 512 513 /* check if a command is pending */ 514 if (sc->sc_ep0_cmd) { 515 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, sc->sc_ep0_cmd); 516 sc->sc_ep0_cmd = 0; 517 } 518 /* read out FIFO status */ 519 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 520 521 DPRINTFN(4, "csr=0x%02x\n", csr); 522 523 if (csr & (MUSB2_MASK_CSR0L_SETUPEND | 524 MUSB2_MASK_CSR0L_SENTSTALL)) { 525 /* 526 * The current transfer was aborted 527 * by the USB Host 528 */ 529 td->error = 1; 530 return (0); /* complete */ 531 } 532 if (csr & MUSB2_MASK_CSR0L_TXPKTRDY) { 533 return (1); /* not complete */ 534 } 535 count = td->max_frame_size; 536 if (td->remainder < count) { 537 /* we have a short packet */ 538 td->short_pkt = 1; 539 count = td->remainder; 540 } 541 while (count > 0) { 542 uint32_t temp; 543 544 usbd_get_page(td->pc, td->offset, &buf_res); 545 546 /* get correct length */ 547 if (buf_res.length > count) { 548 buf_res.length = count; 549 } 550 /* check for unaligned memory address */ 551 if (USB_P2U(buf_res.buffer) & 3) { 552 553 usbd_copy_out(td->pc, td->offset, 554 sc->sc_bounce_buf, count); 555 556 temp = count & ~3; 557 558 if (temp) { 559 /* transmit data 4 bytes at a time */ 560 bus_space_write_multi_4(sc->sc_io_tag, sc->sc_io_hdl, 561 MUSB2_REG_EPFIFO(0), sc->sc_bounce_buf, 562 temp / 4); 563 } 564 temp = count & 3; 565 if (temp) { 566 /* receive data 1 byte at a time */ 567 bus_space_write_multi_1(sc->sc_io_tag, sc->sc_io_hdl, 568 MUSB2_REG_EPFIFO(0), 569 ((void *)&sc->sc_bounce_buf[count / 4]), temp); 570 } 571 /* update offset and remainder */ 572 td->offset += count; 573 td->remainder -= count; 574 break; 575 } 576 /* check if we can optimise */ 577 if (buf_res.length >= 4) { 578 579 /* transmit data 4 bytes at a time */ 580 bus_space_write_multi_4(sc->sc_io_tag, sc->sc_io_hdl, 581 MUSB2_REG_EPFIFO(0), buf_res.buffer, 582 buf_res.length / 4); 583 584 temp = buf_res.length & ~3; 585 586 /* update counters */ 587 count -= temp; 588 td->offset += temp; 589 td->remainder -= temp; 590 continue; 591 } 592 /* transmit data */ 593 bus_space_write_multi_1(sc->sc_io_tag, sc->sc_io_hdl, 594 MUSB2_REG_EPFIFO(0), buf_res.buffer, buf_res.length); 595 596 /* update counters */ 597 count -= buf_res.length; 598 td->offset += buf_res.length; 599 td->remainder -= buf_res.length; 600 } 601 602 /* check remainder */ 603 if (td->remainder == 0) { 604 if (td->short_pkt) { 605 sc->sc_ep0_cmd = MUSB2_MASK_CSR0L_TXPKTRDY; 606 return (0); /* complete */ 607 } 608 /* else we need to transmit a short packet */ 609 } 610 /* write command */ 611 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 612 MUSB2_MASK_CSR0L_TXPKTRDY); 613 614 return (1); /* not complete */ 615} 616 617static uint8_t 618musbotg_setup_status(struct musbotg_td *td) 619{ 620 struct musbotg_softc *sc; 621 uint8_t csr; 622 623 /* get pointer to softc */ 624 sc = MUSBOTG_PC2SC(td->pc); 625 626 /* select endpoint 0 */ 627 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, 0); 628 629 if (sc->sc_ep0_busy) { 630 sc->sc_ep0_busy = 0; 631 sc->sc_ep0_cmd |= MUSB2_MASK_CSR0L_DATAEND; 632 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, sc->sc_ep0_cmd); 633 sc->sc_ep0_cmd = 0; 634 } 635 /* read out FIFO status */ 636 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 637 638 DPRINTFN(4, "csr=0x%02x\n", csr); 639 640 if (csr & MUSB2_MASK_CSR0L_DATAEND) { 641 /* wait for interrupt */ 642 return (1); /* not complete */ 643 } 644 if (sc->sc_dv_addr != 0xFF) { 645 /* write function address */ 646 musbotg_set_address(sc, sc->sc_dv_addr); 647 } 648 return (0); /* complete */ 649} 650 651static uint8_t 652musbotg_data_rx(struct musbotg_td *td) 653{ 654 struct usb_page_search buf_res; 655 struct musbotg_softc *sc; 656 uint16_t count; 657 uint8_t csr; 658 uint8_t to; 659 uint8_t got_short; 660 661 to = 8; /* don't loop forever! */ 662 got_short = 0; 663 664 /* get pointer to softc */ 665 sc = MUSBOTG_PC2SC(td->pc); 666 667 /* select endpoint */ 668 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, td->ep_no); 669 670repeat: 671 /* read out FIFO status */ 672 csr = MUSB2_READ_1(sc, MUSB2_REG_RXCSRL); 673 674 DPRINTFN(4, "csr=0x%02x\n", csr); 675 676 /* clear overrun */ 677 if (csr & MUSB2_MASK_CSRL_RXOVERRUN) { 678 /* make sure we don't clear "RXPKTRDY" */ 679 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRL, 680 MUSB2_MASK_CSRL_RXPKTRDY); 681 } 682 /* check status */ 683 if (!(csr & MUSB2_MASK_CSRL_RXPKTRDY)) { 684 return (1); /* not complete */ 685 } 686 /* get the packet byte count */ 687 count = MUSB2_READ_2(sc, MUSB2_REG_RXCOUNT); 688 689 DPRINTFN(4, "count=0x%04x\n", count); 690 691 /* 692 * Check for short or invalid packet: 693 */ 694 if (count != td->max_frame_size) { 695 if (count < td->max_frame_size) { 696 /* we have a short packet */ 697 td->short_pkt = 1; 698 got_short = 1; 699 } else { 700 /* invalid USB packet */ 701 td->error = 1; 702 return (0); /* we are complete */ 703 } 704 } 705 /* verify the packet byte count */ 706 if (count > td->remainder) { 707 /* invalid USB packet */ 708 td->error = 1; 709 return (0); /* we are complete */ 710 } 711 while (count > 0) { 712 uint32_t temp; 713 714 usbd_get_page(td->pc, td->offset, &buf_res); 715 716 /* get correct length */ 717 if (buf_res.length > count) { 718 buf_res.length = count; 719 } 720 /* check for unaligned memory address */ 721 if (USB_P2U(buf_res.buffer) & 3) { 722 723 temp = count & ~3; 724 725 if (temp) { 726 /* receive data 4 bytes at a time */ 727 bus_space_read_multi_4(sc->sc_io_tag, sc->sc_io_hdl, 728 MUSB2_REG_EPFIFO(td->ep_no), sc->sc_bounce_buf, 729 temp / 4); 730 } 731 temp = count & 3; 732 if (temp) { 733 /* receive data 1 byte at a time */ 734 bus_space_read_multi_1(sc->sc_io_tag, 735 sc->sc_io_hdl, MUSB2_REG_EPFIFO(td->ep_no), 736 ((void *)&sc->sc_bounce_buf[count / 4]), temp); 737 } 738 usbd_copy_in(td->pc, td->offset, 739 sc->sc_bounce_buf, count); 740 741 /* update offset and remainder */ 742 td->offset += count; 743 td->remainder -= count; 744 break; 745 } 746 /* check if we can optimise */ 747 if (buf_res.length >= 4) { 748 749 /* receive data 4 bytes at a time */ 750 bus_space_read_multi_4(sc->sc_io_tag, sc->sc_io_hdl, 751 MUSB2_REG_EPFIFO(td->ep_no), buf_res.buffer, 752 buf_res.length / 4); 753 754 temp = buf_res.length & ~3; 755 756 /* update counters */ 757 count -= temp; 758 td->offset += temp; 759 td->remainder -= temp; 760 continue; 761 } 762 /* receive data */ 763 bus_space_read_multi_1(sc->sc_io_tag, sc->sc_io_hdl, 764 MUSB2_REG_EPFIFO(td->ep_no), buf_res.buffer, 765 buf_res.length); 766 767 /* update counters */ 768 count -= buf_res.length; 769 td->offset += buf_res.length; 770 td->remainder -= buf_res.length; 771 } 772 773 /* clear status bits */ 774 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRL, 0); 775 776 /* check if we are complete */ 777 if ((td->remainder == 0) || got_short) { 778 if (td->short_pkt) { 779 /* we are complete */ 780 return (0); 781 } 782 /* else need to receive a zero length packet */ 783 } 784 if (--to) { 785 goto repeat; 786 } 787 return (1); /* not complete */ 788} 789 790static uint8_t 791musbotg_data_tx(struct musbotg_td *td) 792{ 793 struct usb_page_search buf_res; 794 struct musbotg_softc *sc; 795 uint16_t count; 796 uint8_t csr; 797 uint8_t to; 798 799 to = 8; /* don't loop forever! */ 800 801 /* get pointer to softc */ 802 sc = MUSBOTG_PC2SC(td->pc); 803 804 /* select endpoint */ 805 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, td->ep_no); 806 807repeat: 808 809 /* read out FIFO status */ 810 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 811 812 DPRINTFN(4, "csr=0x%02x\n", csr); 813 814 if (csr & (MUSB2_MASK_CSRL_TXINCOMP | 815 MUSB2_MASK_CSRL_TXUNDERRUN)) { 816 /* clear status bits */ 817 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 0); 818 } 819 if (csr & MUSB2_MASK_CSRL_TXPKTRDY) { 820 return (1); /* not complete */ 821 } 822 /* check for short packet */ 823 count = td->max_frame_size; 824 if (td->remainder < count) { 825 /* we have a short packet */ 826 td->short_pkt = 1; 827 count = td->remainder; 828 } 829 while (count > 0) { 830 uint32_t temp; 831 832 usbd_get_page(td->pc, td->offset, &buf_res); 833 834 /* get correct length */ 835 if (buf_res.length > count) { 836 buf_res.length = count; 837 } 838 /* check for unaligned memory address */ 839 if (USB_P2U(buf_res.buffer) & 3) { 840 841 usbd_copy_out(td->pc, td->offset, 842 sc->sc_bounce_buf, count); 843 844 temp = count & ~3; 845 846 if (temp) { 847 /* transmit data 4 bytes at a time */ 848 bus_space_write_multi_4(sc->sc_io_tag, 849 sc->sc_io_hdl, MUSB2_REG_EPFIFO(td->ep_no), 850 sc->sc_bounce_buf, temp / 4); 851 } 852 temp = count & 3; 853 if (temp) { 854 /* receive data 1 byte at a time */ 855 bus_space_write_multi_1(sc->sc_io_tag, sc->sc_io_hdl, 856 MUSB2_REG_EPFIFO(td->ep_no), 857 ((void *)&sc->sc_bounce_buf[count / 4]), temp); 858 } 859 /* update offset and remainder */ 860 td->offset += count; 861 td->remainder -= count; 862 break; 863 } 864 /* check if we can optimise */ 865 if (buf_res.length >= 4) { 866 867 /* transmit data 4 bytes at a time */ 868 bus_space_write_multi_4(sc->sc_io_tag, sc->sc_io_hdl, 869 MUSB2_REG_EPFIFO(td->ep_no), buf_res.buffer, 870 buf_res.length / 4); 871 872 temp = buf_res.length & ~3; 873 874 /* update counters */ 875 count -= temp; 876 td->offset += temp; 877 td->remainder -= temp; 878 continue; 879 } 880 /* transmit data */ 881 bus_space_write_multi_1(sc->sc_io_tag, sc->sc_io_hdl, 882 MUSB2_REG_EPFIFO(td->ep_no), buf_res.buffer, 883 buf_res.length); 884 885 /* update counters */ 886 count -= buf_res.length; 887 td->offset += buf_res.length; 888 td->remainder -= buf_res.length; 889 } 890 891 /* write command */ 892 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 893 MUSB2_MASK_CSRL_TXPKTRDY); 894 895 /* check remainder */ 896 if (td->remainder == 0) { 897 if (td->short_pkt) { 898 return (0); /* complete */ 899 } 900 /* else we need to transmit a short packet */ 901 } 902 if (--to) { 903 goto repeat; 904 } 905 return (1); /* not complete */ 906} 907 908static uint8_t 909musbotg_xfer_do_fifo(struct usb_xfer *xfer) 910{ 911 struct musbotg_softc *sc; 912 struct musbotg_td *td; 913 914 DPRINTFN(8, "\n"); 915 916 td = xfer->td_transfer_cache; 917 while (1) { 918 if ((td->func) (td)) { 919 /* operation in progress */ 920 break; 921 } 922 if (((void *)td) == xfer->td_transfer_last) { 923 goto done; 924 } 925 if (td->error) { 926 goto done; 927 } else if (td->remainder > 0) { 928 /* 929 * We had a short transfer. If there is no alternate 930 * next, stop processing ! 931 */ 932 if (!td->alt_next) { 933 goto done; 934 } 935 } 936 /* 937 * Fetch the next transfer descriptor and transfer 938 * some flags to the next transfer descriptor 939 */ 940 td = td->obj_next; 941 xfer->td_transfer_cache = td; 942 } 943 return (1); /* not complete */ 944 945done: 946 sc = MUSBOTG_BUS2SC(xfer->xroot->bus); 947 948 /* compute all actual lengths */ 949 950 musbotg_standard_done(xfer); 951 952 return (0); /* complete */ 953} 954 955static void 956musbotg_interrupt_poll(struct musbotg_softc *sc) 957{ 958 struct usb_xfer *xfer; 959 960repeat: 961 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) { 962 if (!musbotg_xfer_do_fifo(xfer)) { 963 /* queue has been modified */ 964 goto repeat; 965 } 966 } 967} 968 969void 970musbotg_vbus_interrupt(struct musbotg_softc *sc, uint8_t is_on) 971{ 972 DPRINTFN(4, "vbus = %u\n", is_on); 973 974 USB_BUS_LOCK(&sc->sc_bus); 975 if (is_on) { 976 if (!sc->sc_flags.status_vbus) { 977 sc->sc_flags.status_vbus = 1; 978 979 /* complete root HUB interrupt endpoint */ 980 musbotg_root_intr(sc); 981 } 982 } else { 983 if (sc->sc_flags.status_vbus) { 984 sc->sc_flags.status_vbus = 0; 985 sc->sc_flags.status_bus_reset = 0; 986 sc->sc_flags.status_suspend = 0; 987 sc->sc_flags.change_suspend = 0; 988 sc->sc_flags.change_connect = 1; 989 990 /* complete root HUB interrupt endpoint */ 991 musbotg_root_intr(sc); 992 } 993 } 994 995 USB_BUS_UNLOCK(&sc->sc_bus); 996} 997 998void 999musbotg_interrupt(struct musbotg_softc *sc) 1000{ 1001 uint16_t rx_status; 1002 uint16_t tx_status; 1003 uint8_t usb_status; 1004 uint8_t temp; 1005 uint8_t to = 2; 1006 1007 USB_BUS_LOCK(&sc->sc_bus); 1008 1009repeat: 1010 1011 /* read all interrupt registers */ 1012 usb_status = MUSB2_READ_1(sc, MUSB2_REG_INTUSB); 1013 1014 /* read all FIFO interrupts */ 1015 rx_status = MUSB2_READ_2(sc, MUSB2_REG_INTRX); 1016 tx_status = MUSB2_READ_2(sc, MUSB2_REG_INTTX); 1017 1018 /* check for any bus state change interrupts */ 1019 1020 if (usb_status & (MUSB2_MASK_IRESET | 1021 MUSB2_MASK_IRESUME | MUSB2_MASK_ISUSP)) { 1022 1023 DPRINTFN(4, "real bus interrupt 0x%08x\n", usb_status); 1024 1025 if (usb_status & MUSB2_MASK_IRESET) { 1026 1027 /* set correct state */ 1028 sc->sc_flags.status_bus_reset = 1; 1029 sc->sc_flags.status_suspend = 0; 1030 sc->sc_flags.change_suspend = 0; 1031 sc->sc_flags.change_connect = 1; 1032 1033 /* determine line speed */ 1034 temp = MUSB2_READ_1(sc, MUSB2_REG_POWER); 1035 if (temp & MUSB2_MASK_HSMODE) 1036 sc->sc_flags.status_high_speed = 1; 1037 else 1038 sc->sc_flags.status_high_speed = 0; 1039 1040 /* 1041 * After reset all interrupts are on and we need to 1042 * turn them off! 1043 */ 1044 temp = MUSB2_MASK_IRESET; 1045 /* disable resume interrupt */ 1046 temp &= ~MUSB2_MASK_IRESUME; 1047 /* enable suspend interrupt */ 1048 temp |= MUSB2_MASK_ISUSP; 1049 MUSB2_WRITE_1(sc, MUSB2_REG_INTUSBE, temp); 1050 /* disable TX and RX interrupts */ 1051 MUSB2_WRITE_2(sc, MUSB2_REG_INTTXE, 0); 1052 MUSB2_WRITE_2(sc, MUSB2_REG_INTRXE, 0); 1053 } 1054 /* 1055 * If RXRSM and RXSUSP is set at the same time we interpret 1056 * that like RESUME. Resume is set when there is at least 3 1057 * milliseconds of inactivity on the USB BUS. 1058 */ 1059 if (usb_status & MUSB2_MASK_IRESUME) { 1060 if (sc->sc_flags.status_suspend) { 1061 sc->sc_flags.status_suspend = 0; 1062 sc->sc_flags.change_suspend = 1; 1063 1064 temp = MUSB2_READ_1(sc, MUSB2_REG_INTUSBE); 1065 /* disable resume interrupt */ 1066 temp &= ~MUSB2_MASK_IRESUME; 1067 /* enable suspend interrupt */ 1068 temp |= MUSB2_MASK_ISUSP; 1069 MUSB2_WRITE_1(sc, MUSB2_REG_INTUSBE, temp); 1070 } 1071 } else if (usb_status & MUSB2_MASK_ISUSP) { 1072 if (!sc->sc_flags.status_suspend) { 1073 sc->sc_flags.status_suspend = 1; 1074 sc->sc_flags.change_suspend = 1; 1075 1076 temp = MUSB2_READ_1(sc, MUSB2_REG_INTUSBE); 1077 /* disable suspend interrupt */ 1078 temp &= ~MUSB2_MASK_ISUSP; 1079 /* enable resume interrupt */ 1080 temp |= MUSB2_MASK_IRESUME; 1081 MUSB2_WRITE_1(sc, MUSB2_REG_INTUSBE, temp); 1082 } 1083 } 1084 /* complete root HUB interrupt endpoint */ 1085 musbotg_root_intr(sc); 1086 } 1087 /* check for any endpoint interrupts */ 1088 1089 if (rx_status || tx_status) { 1090 DPRINTFN(4, "real endpoint interrupt " 1091 "rx=0x%04x, tx=0x%04x\n", rx_status, tx_status); 1092 } 1093 /* poll one time regardless of FIFO status */ 1094 1095 musbotg_interrupt_poll(sc); 1096 1097 if (--to) 1098 goto repeat; 1099 1100 USB_BUS_UNLOCK(&sc->sc_bus); 1101} 1102 1103static void 1104musbotg_setup_standard_chain_sub(struct musbotg_std_temp *temp) 1105{ 1106 struct musbotg_td *td; 1107 1108 /* get current Transfer Descriptor */ 1109 td = temp->td_next; 1110 temp->td = td; 1111 1112 /* prepare for next TD */ 1113 temp->td_next = td->obj_next; 1114 1115 /* fill out the Transfer Descriptor */ 1116 td->func = temp->func; 1117 td->pc = temp->pc; 1118 td->offset = temp->offset; 1119 td->remainder = temp->len; 1120 td->error = 0; 1121 td->did_stall = temp->did_stall; 1122 td->short_pkt = temp->short_pkt; 1123 td->alt_next = temp->setup_alt_next; 1124} 1125 1126static void 1127musbotg_setup_standard_chain(struct usb_xfer *xfer) 1128{ 1129 struct musbotg_std_temp temp; 1130 struct musbotg_softc *sc; 1131 struct musbotg_td *td; 1132 uint32_t x; 1133 uint8_t ep_no; 1134 1135 DPRINTFN(8, "addr=%d endpt=%d sumlen=%d speed=%d\n", 1136 xfer->address, UE_GET_ADDR(xfer->endpointno), 1137 xfer->sumlen, usbd_get_speed(xfer->xroot->udev)); 1138 1139 temp.max_frame_size = xfer->max_frame_size; 1140 1141 td = xfer->td_start[0]; 1142 xfer->td_transfer_first = td; 1143 xfer->td_transfer_cache = td; 1144 1145 /* setup temp */ 1146 1147 temp.td = NULL; 1148 temp.td_next = xfer->td_start[0]; 1149 temp.offset = 0; 1150 temp.setup_alt_next = xfer->flags_int.short_frames_ok; 1151 temp.did_stall = !xfer->flags_int.control_stall; 1152 1153 sc = MUSBOTG_BUS2SC(xfer->xroot->bus); 1154 ep_no = (xfer->endpointno & UE_ADDR); 1155 1156 /* check if we should prepend a setup message */ 1157 1158 if (xfer->flags_int.control_xfr) { 1159 if (xfer->flags_int.control_hdr) { 1160 1161 temp.func = &musbotg_setup_rx; 1162 temp.len = xfer->frlengths[0]; 1163 temp.pc = xfer->frbuffers + 0; 1164 temp.short_pkt = temp.len ? 1 : 0; 1165 1166 musbotg_setup_standard_chain_sub(&temp); 1167 } 1168 x = 1; 1169 } else { 1170 x = 0; 1171 } 1172 1173 if (x != xfer->nframes) { 1174 if (xfer->endpointno & UE_DIR_IN) { 1175 if (xfer->flags_int.control_xfr) 1176 temp.func = &musbotg_setup_data_tx; 1177 else 1178 temp.func = &musbotg_data_tx; 1179 } else { 1180 if (xfer->flags_int.control_xfr) 1181 temp.func = &musbotg_setup_data_rx; 1182 else 1183 temp.func = &musbotg_data_rx; 1184 } 1185 1186 /* setup "pc" pointer */ 1187 temp.pc = xfer->frbuffers + x; 1188 } 1189 while (x != xfer->nframes) { 1190 1191 /* DATA0 / DATA1 message */ 1192 1193 temp.len = xfer->frlengths[x]; 1194 1195 x++; 1196 1197 if (x == xfer->nframes) { 1198 if (xfer->flags_int.control_xfr) { 1199 if (xfer->flags_int.control_act) { 1200 temp.setup_alt_next = 0; 1201 } 1202 } else { 1203 temp.setup_alt_next = 0; 1204 } 1205 } 1206 if (temp.len == 0) { 1207 1208 /* make sure that we send an USB packet */ 1209 1210 temp.short_pkt = 0; 1211 1212 } else { 1213 1214 /* regular data transfer */ 1215 1216 temp.short_pkt = (xfer->flags.force_short_xfer) ? 0 : 1; 1217 } 1218 1219 musbotg_setup_standard_chain_sub(&temp); 1220 1221 if (xfer->flags_int.isochronous_xfr) { 1222 temp.offset += temp.len; 1223 } else { 1224 /* get next Page Cache pointer */ 1225 temp.pc = xfer->frbuffers + x; 1226 } 1227 } 1228 1229 /* check for control transfer */ 1230 if (xfer->flags_int.control_xfr) { 1231 1232 /* always setup a valid "pc" pointer for status and sync */ 1233 temp.pc = xfer->frbuffers + 0; 1234 temp.len = 0; 1235 temp.short_pkt = 0; 1236 temp.setup_alt_next = 0; 1237 1238 /* check if we should append a status stage */ 1239 if (!xfer->flags_int.control_act) { 1240 /* 1241 * Send a DATA1 message and invert the current 1242 * endpoint direction. 1243 */ 1244 temp.func = &musbotg_setup_status; 1245 musbotg_setup_standard_chain_sub(&temp); 1246 } 1247 } 1248 /* must have at least one frame! */ 1249 td = temp.td; 1250 xfer->td_transfer_last = td; 1251} 1252 1253static void 1254musbotg_timeout(void *arg) 1255{ 1256 struct usb_xfer *xfer = arg; 1257 1258 DPRINTFN(1, "xfer=%p\n", xfer); 1259 1260 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 1261 1262 /* transfer is transferred */ 1263 musbotg_device_done(xfer, USB_ERR_TIMEOUT); 1264} 1265 1266static void 1267musbotg_ep_int_set(struct usb_xfer *xfer, uint8_t on) 1268{ 1269 struct musbotg_softc *sc = MUSBOTG_BUS2SC(xfer->xroot->bus); 1270 uint16_t temp; 1271 uint8_t ep_no = xfer->endpointno & UE_ADDR; 1272 1273 /* 1274 * Only enable the endpoint interrupt when we are 1275 * actually waiting for data, hence we are dealing 1276 * with level triggered interrupts ! 1277 */ 1278 if (ep_no == 0) { 1279 temp = MUSB2_READ_2(sc, MUSB2_REG_INTTXE); 1280 if (on) 1281 temp |= MUSB2_MASK_EPINT(0); 1282 else 1283 temp &= ~MUSB2_MASK_EPINT(0); 1284 1285 MUSB2_WRITE_2(sc, MUSB2_REG_INTTXE, temp); 1286 } else { 1287 if (USB_GET_DATA_ISREAD(xfer)) { 1288 temp = MUSB2_READ_2(sc, MUSB2_REG_INTRXE); 1289 if (on) 1290 temp |= MUSB2_MASK_EPINT(ep_no); 1291 else 1292 temp &= ~MUSB2_MASK_EPINT(ep_no); 1293 MUSB2_WRITE_2(sc, MUSB2_REG_INTRXE, temp); 1294 1295 } else { 1296 temp = MUSB2_READ_2(sc, MUSB2_REG_INTTXE); 1297 if (on) 1298 temp |= MUSB2_MASK_EPINT(ep_no); 1299 else 1300 temp &= ~MUSB2_MASK_EPINT(ep_no); 1301 MUSB2_WRITE_2(sc, MUSB2_REG_INTTXE, temp); 1302 } 1303 } 1304} 1305 1306static void 1307musbotg_start_standard_chain(struct usb_xfer *xfer) 1308{ 1309 DPRINTFN(8, "\n"); 1310 1311 /* poll one time */ 1312 if (musbotg_xfer_do_fifo(xfer)) { 1313 1314 musbotg_ep_int_set(xfer, 1); 1315 1316 DPRINTFN(14, "enabled interrupts on endpoint\n"); 1317 1318 /* put transfer on interrupt queue */ 1319 usbd_transfer_enqueue(&xfer->xroot->bus->intr_q, xfer); 1320 1321 /* start timeout, if any */ 1322 if (xfer->timeout != 0) { 1323 usbd_transfer_timeout_ms(xfer, 1324 &musbotg_timeout, xfer->timeout); 1325 } 1326 } 1327} 1328 1329static void 1330musbotg_root_intr(struct musbotg_softc *sc) 1331{ 1332 DPRINTFN(8, "\n"); 1333 1334 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED); 1335 1336 /* set port bit */ 1337 sc->sc_hub_idata[0] = 0x02; /* we only have one port */ 1338 1339 uhub_root_intr(&sc->sc_bus, sc->sc_hub_idata, 1340 sizeof(sc->sc_hub_idata)); 1341} 1342 1343static usb_error_t 1344musbotg_standard_done_sub(struct usb_xfer *xfer) 1345{ 1346 struct musbotg_td *td; 1347 uint32_t len; 1348 uint8_t error; 1349 1350 DPRINTFN(8, "\n"); 1351 1352 td = xfer->td_transfer_cache; 1353 1354 do { 1355 len = td->remainder; 1356 1357 if (xfer->aframes != xfer->nframes) { 1358 /* 1359 * Verify the length and subtract 1360 * the remainder from "frlengths[]": 1361 */ 1362 if (len > xfer->frlengths[xfer->aframes]) { 1363 td->error = 1; 1364 } else { 1365 xfer->frlengths[xfer->aframes] -= len; 1366 } 1367 } 1368 /* Check for transfer error */ 1369 if (td->error) { 1370 /* the transfer is finished */ 1371 error = 1; 1372 td = NULL; 1373 break; 1374 } 1375 /* Check for short transfer */ 1376 if (len > 0) { 1377 if (xfer->flags_int.short_frames_ok) { 1378 /* follow alt next */ 1379 if (td->alt_next) { 1380 td = td->obj_next; 1381 } else { 1382 td = NULL; 1383 } 1384 } else { 1385 /* the transfer is finished */ 1386 td = NULL; 1387 } 1388 error = 0; 1389 break; 1390 } 1391 td = td->obj_next; 1392 1393 /* this USB frame is complete */ 1394 error = 0; 1395 break; 1396 1397 } while (0); 1398 1399 /* update transfer cache */ 1400 1401 xfer->td_transfer_cache = td; 1402 1403 return (error ? 1404 USB_ERR_STALLED : USB_ERR_NORMAL_COMPLETION); 1405} 1406 1407static void 1408musbotg_standard_done(struct usb_xfer *xfer) 1409{ 1410 usb_error_t err = 0; 1411 1412 DPRINTFN(12, "xfer=%p endpoint=%p transfer done\n", 1413 xfer, xfer->endpoint); 1414 1415 /* reset scanner */ 1416 1417 xfer->td_transfer_cache = xfer->td_transfer_first; 1418 1419 if (xfer->flags_int.control_xfr) { 1420 1421 if (xfer->flags_int.control_hdr) { 1422 1423 err = musbotg_standard_done_sub(xfer); 1424 } 1425 xfer->aframes = 1; 1426 1427 if (xfer->td_transfer_cache == NULL) { 1428 goto done; 1429 } 1430 } 1431 while (xfer->aframes != xfer->nframes) { 1432 1433 err = musbotg_standard_done_sub(xfer); 1434 xfer->aframes++; 1435 1436 if (xfer->td_transfer_cache == NULL) { 1437 goto done; 1438 } 1439 } 1440 1441 if (xfer->flags_int.control_xfr && 1442 !xfer->flags_int.control_act) { 1443 1444 err = musbotg_standard_done_sub(xfer); 1445 } 1446done: 1447 musbotg_device_done(xfer, err); 1448} 1449 1450/*------------------------------------------------------------------------* 1451 * musbotg_device_done 1452 * 1453 * NOTE: this function can be called more than one time on the 1454 * same USB transfer! 1455 *------------------------------------------------------------------------*/ 1456static void 1457musbotg_device_done(struct usb_xfer *xfer, usb_error_t error) 1458{ 1459 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 1460 1461 DPRINTFN(2, "xfer=%p, endpoint=%p, error=%d\n", 1462 xfer, xfer->endpoint, error); 1463 1464 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) { 1465 1466 musbotg_ep_int_set(xfer, 0); 1467 1468 DPRINTFN(14, "disabled interrupts on endpoint\n"); 1469 } 1470 /* dequeue transfer and start next transfer */ 1471 usbd_transfer_done(xfer, error); 1472} 1473 1474static void 1475musbotg_set_stall(struct usb_device *udev, struct usb_xfer *xfer, 1476 struct usb_endpoint *ep, uint8_t *did_stall) 1477{ 1478 struct musbotg_softc *sc; 1479 uint8_t ep_no; 1480 1481 USB_BUS_LOCK_ASSERT(udev->bus, MA_OWNED); 1482 1483 DPRINTFN(4, "endpoint=%p\n", ep); 1484 1485 if (xfer) { 1486 /* cancel any ongoing transfers */ 1487 musbotg_device_done(xfer, USB_ERR_STALLED); 1488 } 1489 /* set FORCESTALL */ 1490 sc = MUSBOTG_BUS2SC(udev->bus); 1491 1492 ep_no = (ep->edesc->bEndpointAddress & UE_ADDR); 1493 1494 /* select endpoint */ 1495 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, ep_no); 1496 1497 if (ep->edesc->bEndpointAddress & UE_DIR_IN) { 1498 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 1499 MUSB2_MASK_CSRL_TXSENDSTALL); 1500 } else { 1501 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRL, 1502 MUSB2_MASK_CSRL_RXSENDSTALL); 1503 } 1504} 1505 1506static void 1507musbotg_clear_stall_sub(struct musbotg_softc *sc, uint16_t wMaxPacket, 1508 uint8_t ep_no, uint8_t ep_type, uint8_t ep_dir) 1509{ 1510 uint16_t mps; 1511 uint16_t temp; 1512 uint8_t csr; 1513 1514 if (ep_type == UE_CONTROL) { 1515 /* clearing stall is not needed */ 1516 return; 1517 } 1518 /* select endpoint */ 1519 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, ep_no); 1520 1521 /* compute max frame size */ 1522 mps = wMaxPacket & 0x7FF; 1523 switch ((wMaxPacket >> 11) & 3) { 1524 case 1: 1525 mps *= 2; 1526 break; 1527 case 2: 1528 mps *= 3; 1529 break; 1530 default: 1531 break; 1532 } 1533 1534 if (ep_dir == UE_DIR_IN) { 1535 1536 temp = 0; 1537 1538 /* Configure endpoint */ 1539 switch (ep_type) { 1540 case UE_INTERRUPT: 1541 MUSB2_WRITE_1(sc, MUSB2_REG_TXMAXP, wMaxPacket); 1542 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRH, 1543 MUSB2_MASK_CSRH_TXMODE | temp); 1544 break; 1545 case UE_ISOCHRONOUS: 1546 MUSB2_WRITE_1(sc, MUSB2_REG_TXMAXP, wMaxPacket); 1547 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRH, 1548 MUSB2_MASK_CSRH_TXMODE | 1549 MUSB2_MASK_CSRH_TXISO | temp); 1550 break; 1551 case UE_BULK: 1552 MUSB2_WRITE_1(sc, MUSB2_REG_TXMAXP, wMaxPacket); 1553 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRH, 1554 MUSB2_MASK_CSRH_TXMODE | temp); 1555 break; 1556 default: 1557 break; 1558 } 1559 1560 /* Need to flush twice in case of double bufring */ 1561 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 1562 if (csr & MUSB2_MASK_CSRL_TXFIFONEMPTY) { 1563 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 1564 MUSB2_MASK_CSRL_TXFFLUSH); 1565 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 1566 if (csr & MUSB2_MASK_CSRL_TXFIFONEMPTY) { 1567 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 1568 MUSB2_MASK_CSRL_TXFFLUSH); 1569 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 1570 } 1571 } 1572 /* reset data toggle */ 1573 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 1574 MUSB2_MASK_CSRL_TXDT_CLR); 1575 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 0); 1576 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 1577 1578 /* set double/single buffering */ 1579 temp = MUSB2_READ_2(sc, MUSB2_REG_TXDBDIS); 1580 if (mps <= (sc->sc_hw_ep_profile[ep_no]. 1581 max_in_frame_size / 2)) { 1582 /* double buffer */ 1583 temp &= ~(1 << ep_no); 1584 } else { 1585 /* single buffer */ 1586 temp |= (1 << ep_no); 1587 } 1588 MUSB2_WRITE_2(sc, MUSB2_REG_TXDBDIS, temp); 1589 1590 /* clear sent stall */ 1591 if (csr & MUSB2_MASK_CSRL_TXSENTSTALL) { 1592 MUSB2_WRITE_1(sc, MUSB2_REG_TXCSRL, 0); 1593 csr = MUSB2_READ_1(sc, MUSB2_REG_TXCSRL); 1594 } 1595 } else { 1596 1597 temp = 0; 1598 1599 /* Configure endpoint */ 1600 switch (ep_type) { 1601 case UE_INTERRUPT: 1602 MUSB2_WRITE_1(sc, MUSB2_REG_RXMAXP, wMaxPacket); 1603 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRH, 1604 MUSB2_MASK_CSRH_RXNYET | temp); 1605 break; 1606 case UE_ISOCHRONOUS: 1607 MUSB2_WRITE_1(sc, MUSB2_REG_RXMAXP, wMaxPacket); 1608 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRH, 1609 MUSB2_MASK_CSRH_RXNYET | 1610 MUSB2_MASK_CSRH_RXISO | temp); 1611 break; 1612 case UE_BULK: 1613 MUSB2_WRITE_1(sc, MUSB2_REG_RXMAXP, wMaxPacket); 1614 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRH, temp); 1615 break; 1616 default: 1617 break; 1618 } 1619 1620 /* Need to flush twice in case of double bufring */ 1621 csr = MUSB2_READ_1(sc, MUSB2_REG_RXCSRL); 1622 if (csr & MUSB2_MASK_CSRL_RXPKTRDY) { 1623 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRL, 1624 MUSB2_MASK_CSRL_RXFFLUSH); 1625 csr = MUSB2_READ_1(sc, MUSB2_REG_RXCSRL); 1626 if (csr & MUSB2_MASK_CSRL_RXPKTRDY) { 1627 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRL, 1628 MUSB2_MASK_CSRL_RXFFLUSH); 1629 csr = MUSB2_READ_1(sc, MUSB2_REG_RXCSRL); 1630 } 1631 } 1632 /* reset data toggle */ 1633 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRL, 1634 MUSB2_MASK_CSRL_RXDT_CLR); 1635 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRL, 0); 1636 csr = MUSB2_READ_1(sc, MUSB2_REG_RXCSRL); 1637 1638 /* set double/single buffering */ 1639 temp = MUSB2_READ_2(sc, MUSB2_REG_RXDBDIS); 1640 if (mps <= (sc->sc_hw_ep_profile[ep_no]. 1641 max_out_frame_size / 2)) { 1642 /* double buffer */ 1643 temp &= ~(1 << ep_no); 1644 } else { 1645 /* single buffer */ 1646 temp |= (1 << ep_no); 1647 } 1648 MUSB2_WRITE_2(sc, MUSB2_REG_RXDBDIS, temp); 1649 1650 /* clear sent stall */ 1651 if (csr & MUSB2_MASK_CSRL_RXSENTSTALL) { 1652 MUSB2_WRITE_1(sc, MUSB2_REG_RXCSRL, 0); 1653 } 1654 } 1655} 1656 1657static void 1658musbotg_clear_stall(struct usb_device *udev, struct usb_endpoint *ep) 1659{ 1660 struct musbotg_softc *sc; 1661 struct usb_endpoint_descriptor *ed; 1662 1663 DPRINTFN(4, "endpoint=%p\n", ep); 1664 1665 USB_BUS_LOCK_ASSERT(udev->bus, MA_OWNED); 1666 1667 /* check mode */ 1668 if (udev->flags.usb_mode != USB_MODE_DEVICE) { 1669 /* not supported */ 1670 return; 1671 } 1672 /* get softc */ 1673 sc = MUSBOTG_BUS2SC(udev->bus); 1674 1675 /* get endpoint descriptor */ 1676 ed = ep->edesc; 1677 1678 /* reset endpoint */ 1679 musbotg_clear_stall_sub(sc, 1680 UGETW(ed->wMaxPacketSize), 1681 (ed->bEndpointAddress & UE_ADDR), 1682 (ed->bmAttributes & UE_XFERTYPE), 1683 (ed->bEndpointAddress & (UE_DIR_IN | UE_DIR_OUT))); 1684} 1685 1686usb_error_t 1687musbotg_init(struct musbotg_softc *sc) 1688{ 1689 struct usb_hw_ep_profile *pf; 1690 uint8_t nrx; 1691 uint8_t ntx; 1692 uint8_t temp; 1693 uint8_t fsize; 1694 uint8_t frx; 1695 uint8_t ftx; 1696 1697 DPRINTFN(1, "start\n"); 1698 1699 /* set up the bus structure */ 1700 sc->sc_bus.usbrev = USB_REV_2_0; 1701 sc->sc_bus.methods = &musbotg_bus_methods; 1702 1703 USB_BUS_LOCK(&sc->sc_bus); 1704 1705 /* turn on clocks */ 1706 1707 if (sc->sc_clocks_on) { 1708 (sc->sc_clocks_on) (sc->sc_clocks_arg); 1709 } 1710 /* wait a little for things to stabilise */ 1711 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 1000); 1712 1713 /* disable all interrupts */ 1714 1715 MUSB2_WRITE_1(sc, MUSB2_REG_INTUSBE, 0); 1716 MUSB2_WRITE_2(sc, MUSB2_REG_INTTXE, 0); 1717 MUSB2_WRITE_2(sc, MUSB2_REG_INTRXE, 0); 1718 1719 /* disable pullup */ 1720 1721 musbotg_pull_common(sc, 0); 1722 1723 /* wait a little bit (10ms) */ 1724 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 100); 1725 1726 /* disable double packet buffering */ 1727 MUSB2_WRITE_2(sc, MUSB2_REG_RXDBDIS, 0xFFFF); 1728 MUSB2_WRITE_2(sc, MUSB2_REG_TXDBDIS, 0xFFFF); 1729 1730 /* enable HighSpeed and ISO Update flags */ 1731 1732 MUSB2_WRITE_1(sc, MUSB2_REG_POWER, 1733 MUSB2_MASK_HSENAB | MUSB2_MASK_ISOUPD); 1734 1735 /* clear Session bit, if set */ 1736 1737 temp = MUSB2_READ_1(sc, MUSB2_REG_DEVCTL); 1738 temp &= ~MUSB2_MASK_SESS; 1739 MUSB2_WRITE_1(sc, MUSB2_REG_DEVCTL, temp); 1740 1741 DPRINTF("DEVCTL=0x%02x\n", temp); 1742 1743 /* disable testmode */ 1744 1745 MUSB2_WRITE_1(sc, MUSB2_REG_TESTMODE, 0); 1746 1747 /* set default value */ 1748 1749 MUSB2_WRITE_1(sc, MUSB2_REG_MISC, 0); 1750 1751 /* select endpoint index 0 */ 1752 1753 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, 0); 1754 1755 /* read out number of endpoints */ 1756 1757 nrx = 1758 (MUSB2_READ_1(sc, MUSB2_REG_EPINFO) / 16); 1759 1760 ntx = 1761 (MUSB2_READ_1(sc, MUSB2_REG_EPINFO) % 16); 1762 1763 /* these numbers exclude the control endpoint */ 1764 1765 DPRINTFN(2, "RX/TX endpoints: %u/%u\n", nrx, ntx); 1766 1767 sc->sc_ep_max = (nrx > ntx) ? nrx : ntx; 1768 if (sc->sc_ep_max == 0) { 1769 DPRINTFN(2, "ERROR: Looks like the clocks are off!\n"); 1770 } 1771 /* read out configuration data */ 1772 1773 sc->sc_conf_data = MUSB2_READ_1(sc, MUSB2_REG_CONFDATA); 1774 1775 DPRINTFN(2, "Config Data: 0x%02x\n", 1776 sc->sc_conf_data); 1777 1778 DPRINTFN(2, "HW version: 0x%04x\n", 1779 MUSB2_READ_1(sc, MUSB2_REG_HWVERS)); 1780 1781 /* initialise endpoint profiles */ 1782 1783 for (temp = 1; temp <= sc->sc_ep_max; temp++) { 1784 pf = sc->sc_hw_ep_profile + temp; 1785 1786 /* select endpoint */ 1787 MUSB2_WRITE_1(sc, MUSB2_REG_EPINDEX, temp); 1788 1789 fsize = MUSB2_READ_1(sc, MUSB2_REG_FSIZE); 1790 frx = (fsize & MUSB2_MASK_RX_FSIZE) / 16;; 1791 ftx = (fsize & MUSB2_MASK_TX_FSIZE); 1792 1793 DPRINTF("Endpoint %u FIFO size: IN=%u, OUT=%u\n", 1794 temp, pf->max_in_frame_size, 1795 pf->max_out_frame_size); 1796 1797 if (frx && ftx && (temp <= nrx) && (temp <= ntx)) { 1798 pf->max_in_frame_size = 1 << ftx; 1799 pf->max_out_frame_size = 1 << frx; 1800 pf->is_simplex = 0; /* duplex */ 1801 pf->support_multi_buffer = 1; 1802 pf->support_bulk = 1; 1803 pf->support_interrupt = 1; 1804 pf->support_isochronous = 1; 1805 pf->support_in = 1; 1806 pf->support_out = 1; 1807 } else if (frx && (temp <= nrx)) { 1808 pf->max_out_frame_size = 1 << frx; 1809 pf->is_simplex = 1; /* simplex */ 1810 pf->support_multi_buffer = 1; 1811 pf->support_bulk = 1; 1812 pf->support_interrupt = 1; 1813 pf->support_isochronous = 1; 1814 pf->support_out = 1; 1815 } else if (ftx && (temp <= ntx)) { 1816 pf->max_in_frame_size = 1 << ftx; 1817 pf->is_simplex = 1; /* simplex */ 1818 pf->support_multi_buffer = 1; 1819 pf->support_bulk = 1; 1820 pf->support_interrupt = 1; 1821 pf->support_isochronous = 1; 1822 pf->support_in = 1; 1823 } 1824 } 1825 1826 /* turn on default interrupts */ 1827 1828 MUSB2_WRITE_1(sc, MUSB2_REG_INTUSBE, 1829 MUSB2_MASK_IRESET); 1830 1831 musbotg_clocks_off(sc); 1832 1833 USB_BUS_UNLOCK(&sc->sc_bus); 1834 1835 /* catch any lost interrupts */ 1836 1837 musbotg_do_poll(&sc->sc_bus); 1838 1839 return (0); /* success */ 1840} 1841 1842void 1843musbotg_uninit(struct musbotg_softc *sc) 1844{ 1845 USB_BUS_LOCK(&sc->sc_bus); 1846 1847 /* disable all interrupts */ 1848 MUSB2_WRITE_1(sc, MUSB2_REG_INTUSBE, 0); 1849 MUSB2_WRITE_2(sc, MUSB2_REG_INTTXE, 0); 1850 MUSB2_WRITE_2(sc, MUSB2_REG_INTRXE, 0); 1851 1852 sc->sc_flags.port_powered = 0; 1853 sc->sc_flags.status_vbus = 0; 1854 sc->sc_flags.status_bus_reset = 0; 1855 sc->sc_flags.status_suspend = 0; 1856 sc->sc_flags.change_suspend = 0; 1857 sc->sc_flags.change_connect = 1; 1858 1859 musbotg_pull_down(sc); 1860 musbotg_clocks_off(sc); 1861 USB_BUS_UNLOCK(&sc->sc_bus); 1862} 1863 1864void 1865musbotg_suspend(struct musbotg_softc *sc) 1866{ 1867 return; 1868} 1869 1870void 1871musbotg_resume(struct musbotg_softc *sc) 1872{ 1873 return; 1874} 1875 1876static void 1877musbotg_do_poll(struct usb_bus *bus) 1878{ 1879 struct musbotg_softc *sc = MUSBOTG_BUS2SC(bus); 1880 1881 USB_BUS_LOCK(&sc->sc_bus); 1882 musbotg_interrupt_poll(sc); 1883 USB_BUS_UNLOCK(&sc->sc_bus); 1884} 1885 1886/*------------------------------------------------------------------------* 1887 * musbotg bulk support 1888 *------------------------------------------------------------------------*/ 1889static void 1890musbotg_device_bulk_open(struct usb_xfer *xfer) 1891{ 1892 return; 1893} 1894 1895static void 1896musbotg_device_bulk_close(struct usb_xfer *xfer) 1897{ 1898 musbotg_device_done(xfer, USB_ERR_CANCELLED); 1899} 1900 1901static void 1902musbotg_device_bulk_enter(struct usb_xfer *xfer) 1903{ 1904 return; 1905} 1906 1907static void 1908musbotg_device_bulk_start(struct usb_xfer *xfer) 1909{ 1910 /* setup TDs */ 1911 musbotg_setup_standard_chain(xfer); 1912 musbotg_start_standard_chain(xfer); 1913} 1914 1915struct usb_pipe_methods musbotg_device_bulk_methods = 1916{ 1917 .open = musbotg_device_bulk_open, 1918 .close = musbotg_device_bulk_close, 1919 .enter = musbotg_device_bulk_enter, 1920 .start = musbotg_device_bulk_start, 1921}; 1922 1923/*------------------------------------------------------------------------* 1924 * musbotg control support 1925 *------------------------------------------------------------------------*/ 1926static void 1927musbotg_device_ctrl_open(struct usb_xfer *xfer) 1928{ 1929 return; 1930} 1931 1932static void 1933musbotg_device_ctrl_close(struct usb_xfer *xfer) 1934{ 1935 musbotg_device_done(xfer, USB_ERR_CANCELLED); 1936} 1937 1938static void 1939musbotg_device_ctrl_enter(struct usb_xfer *xfer) 1940{ 1941 return; 1942} 1943 1944static void 1945musbotg_device_ctrl_start(struct usb_xfer *xfer) 1946{ 1947 /* setup TDs */ 1948 musbotg_setup_standard_chain(xfer); 1949 musbotg_start_standard_chain(xfer); 1950} 1951 1952struct usb_pipe_methods musbotg_device_ctrl_methods = 1953{ 1954 .open = musbotg_device_ctrl_open, 1955 .close = musbotg_device_ctrl_close, 1956 .enter = musbotg_device_ctrl_enter, 1957 .start = musbotg_device_ctrl_start, 1958}; 1959 1960/*------------------------------------------------------------------------* 1961 * musbotg interrupt support 1962 *------------------------------------------------------------------------*/ 1963static void 1964musbotg_device_intr_open(struct usb_xfer *xfer) 1965{ 1966 return; 1967} 1968 1969static void 1970musbotg_device_intr_close(struct usb_xfer *xfer) 1971{ 1972 musbotg_device_done(xfer, USB_ERR_CANCELLED); 1973} 1974 1975static void 1976musbotg_device_intr_enter(struct usb_xfer *xfer) 1977{ 1978 return; 1979} 1980 1981static void 1982musbotg_device_intr_start(struct usb_xfer *xfer) 1983{ 1984 /* setup TDs */ 1985 musbotg_setup_standard_chain(xfer); 1986 musbotg_start_standard_chain(xfer); 1987} 1988 1989struct usb_pipe_methods musbotg_device_intr_methods = 1990{ 1991 .open = musbotg_device_intr_open, 1992 .close = musbotg_device_intr_close, 1993 .enter = musbotg_device_intr_enter, 1994 .start = musbotg_device_intr_start, 1995}; 1996 1997/*------------------------------------------------------------------------* 1998 * musbotg full speed isochronous support 1999 *------------------------------------------------------------------------*/ 2000static void 2001musbotg_device_isoc_open(struct usb_xfer *xfer) 2002{ 2003 return; 2004} 2005 2006static void 2007musbotg_device_isoc_close(struct usb_xfer *xfer) 2008{ 2009 musbotg_device_done(xfer, USB_ERR_CANCELLED); 2010} 2011 2012static void 2013musbotg_device_isoc_enter(struct usb_xfer *xfer) 2014{ 2015 struct musbotg_softc *sc = MUSBOTG_BUS2SC(xfer->xroot->bus); 2016 uint32_t temp; 2017 uint32_t nframes; 2018 uint32_t fs_frames; 2019 2020 DPRINTFN(5, "xfer=%p next=%d nframes=%d\n", 2021 xfer, xfer->endpoint->isoc_next, xfer->nframes); 2022 2023 /* get the current frame index */ 2024 2025 nframes = MUSB2_READ_2(sc, MUSB2_REG_FRAME); 2026 2027 /* 2028 * check if the frame index is within the window where the frames 2029 * will be inserted 2030 */ 2031 temp = (nframes - xfer->endpoint->isoc_next) & MUSB2_MASK_FRAME; 2032 2033 if (usbd_get_speed(xfer->xroot->udev) == USB_SPEED_HIGH) { 2034 fs_frames = (xfer->nframes + 7) / 8; 2035 } else { 2036 fs_frames = xfer->nframes; 2037 } 2038 2039 if ((xfer->endpoint->is_synced == 0) || 2040 (temp < fs_frames)) { 2041 /* 2042 * If there is data underflow or the pipe queue is 2043 * empty we schedule the transfer a few frames ahead 2044 * of the current frame position. Else two isochronous 2045 * transfers might overlap. 2046 */ 2047 xfer->endpoint->isoc_next = (nframes + 3) & MUSB2_MASK_FRAME; 2048 xfer->endpoint->is_synced = 1; 2049 DPRINTFN(2, "start next=%d\n", xfer->endpoint->isoc_next); 2050 } 2051 /* 2052 * compute how many milliseconds the insertion is ahead of the 2053 * current frame position: 2054 */ 2055 temp = (xfer->endpoint->isoc_next - nframes) & MUSB2_MASK_FRAME; 2056 2057 /* 2058 * pre-compute when the isochronous transfer will be finished: 2059 */ 2060 xfer->isoc_time_complete = 2061 usb_isoc_time_expand(&sc->sc_bus, nframes) + temp + 2062 fs_frames; 2063 2064 /* compute frame number for next insertion */ 2065 xfer->endpoint->isoc_next += fs_frames; 2066 2067 /* setup TDs */ 2068 musbotg_setup_standard_chain(xfer); 2069} 2070 2071static void 2072musbotg_device_isoc_start(struct usb_xfer *xfer) 2073{ 2074 /* start TD chain */ 2075 musbotg_start_standard_chain(xfer); 2076} 2077 2078struct usb_pipe_methods musbotg_device_isoc_methods = 2079{ 2080 .open = musbotg_device_isoc_open, 2081 .close = musbotg_device_isoc_close, 2082 .enter = musbotg_device_isoc_enter, 2083 .start = musbotg_device_isoc_start, 2084}; 2085 2086/*------------------------------------------------------------------------* 2087 * musbotg root control support 2088 *------------------------------------------------------------------------* 2089 * Simulate a hardware HUB by handling all the necessary requests. 2090 *------------------------------------------------------------------------*/ 2091 2092static const struct usb_device_descriptor musbotg_devd = { 2093 .bLength = sizeof(struct usb_device_descriptor), 2094 .bDescriptorType = UDESC_DEVICE, 2095 .bcdUSB = {0x00, 0x02}, 2096 .bDeviceClass = UDCLASS_HUB, 2097 .bDeviceSubClass = UDSUBCLASS_HUB, 2098 .bDeviceProtocol = UDPROTO_HSHUBSTT, 2099 .bMaxPacketSize = 64, 2100 .bcdDevice = {0x00, 0x01}, 2101 .iManufacturer = 1, 2102 .iProduct = 2, 2103 .bNumConfigurations = 1, 2104}; 2105 2106static const struct usb_device_qualifier musbotg_odevd = { 2107 .bLength = sizeof(struct usb_device_qualifier), 2108 .bDescriptorType = UDESC_DEVICE_QUALIFIER, 2109 .bcdUSB = {0x00, 0x02}, 2110 .bDeviceClass = UDCLASS_HUB, 2111 .bDeviceSubClass = UDSUBCLASS_HUB, 2112 .bDeviceProtocol = UDPROTO_FSHUB, 2113 .bMaxPacketSize0 = 0, 2114 .bNumConfigurations = 0, 2115}; 2116 2117static const struct musbotg_config_desc musbotg_confd = { 2118 .confd = { 2119 .bLength = sizeof(struct usb_config_descriptor), 2120 .bDescriptorType = UDESC_CONFIG, 2121 .wTotalLength[0] = sizeof(musbotg_confd), 2122 .bNumInterface = 1, 2123 .bConfigurationValue = 1, 2124 .iConfiguration = 0, 2125 .bmAttributes = UC_SELF_POWERED, 2126 .bMaxPower = 0, 2127 }, 2128 .ifcd = { 2129 .bLength = sizeof(struct usb_interface_descriptor), 2130 .bDescriptorType = UDESC_INTERFACE, 2131 .bNumEndpoints = 1, 2132 .bInterfaceClass = UICLASS_HUB, 2133 .bInterfaceSubClass = UISUBCLASS_HUB, 2134 .bInterfaceProtocol = UIPROTO_HSHUBSTT, 2135 }, 2136 .endpd = { 2137 .bLength = sizeof(struct usb_endpoint_descriptor), 2138 .bDescriptorType = UDESC_ENDPOINT, 2139 .bEndpointAddress = (UE_DIR_IN | MUSBOTG_INTR_ENDPT), 2140 .bmAttributes = UE_INTERRUPT, 2141 .wMaxPacketSize[0] = 8, 2142 .bInterval = 255, 2143 }, 2144}; 2145 2146static const struct usb_hub_descriptor_min musbotg_hubd = { 2147 .bDescLength = sizeof(musbotg_hubd), 2148 .bDescriptorType = UDESC_HUB, 2149 .bNbrPorts = 1, 2150 .wHubCharacteristics[0] = 2151 (UHD_PWR_NO_SWITCH | UHD_OC_INDIVIDUAL) & 0xFF, 2152 .wHubCharacteristics[1] = 2153 (UHD_PWR_NO_SWITCH | UHD_OC_INDIVIDUAL) >> 16, 2154 .bPwrOn2PwrGood = 50, 2155 .bHubContrCurrent = 0, 2156 .DeviceRemovable = {0}, /* port is removable */ 2157}; 2158 2159#define STRING_LANG \ 2160 0x09, 0x04, /* American English */ 2161 2162#define STRING_VENDOR \ 2163 'M', 0, 'e', 0, 'n', 0, 't', 0, 'o', 0, 'r', 0, ' ', 0, \ 2164 'G', 0, 'r', 0, 'a', 0, 'p', 0, 'h', 0, 'i', 0, 'c', 0, 's', 0 2165 2166#define STRING_PRODUCT \ 2167 'O', 0, 'T', 0, 'G', 0, ' ', 0, 'R', 0, \ 2168 'o', 0, 'o', 0, 't', 0, ' ', 0, 'H', 0, \ 2169 'U', 0, 'B', 0, 2170 2171USB_MAKE_STRING_DESC(STRING_LANG, musbotg_langtab); 2172USB_MAKE_STRING_DESC(STRING_VENDOR, musbotg_vendor); 2173USB_MAKE_STRING_DESC(STRING_PRODUCT, musbotg_product); 2174 2175static usb_error_t 2176musbotg_roothub_exec(struct usb_device *udev, 2177 struct usb_device_request *req, const void **pptr, uint16_t *plength) 2178{ 2179 struct musbotg_softc *sc = MUSBOTG_BUS2SC(udev->bus); 2180 const void *ptr; 2181 uint16_t len; 2182 uint16_t value; 2183 uint16_t index; 2184 usb_error_t err; 2185 2186 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED); 2187 2188 /* buffer reset */ 2189 ptr = (const void *)&sc->sc_hub_temp; 2190 len = 0; 2191 err = 0; 2192 2193 value = UGETW(req->wValue); 2194 index = UGETW(req->wIndex); 2195 2196 /* demultiplex the control request */ 2197 2198 switch (req->bmRequestType) { 2199 case UT_READ_DEVICE: 2200 switch (req->bRequest) { 2201 case UR_GET_DESCRIPTOR: 2202 goto tr_handle_get_descriptor; 2203 case UR_GET_CONFIG: 2204 goto tr_handle_get_config; 2205 case UR_GET_STATUS: 2206 goto tr_handle_get_status; 2207 default: 2208 goto tr_stalled; 2209 } 2210 break; 2211 2212 case UT_WRITE_DEVICE: 2213 switch (req->bRequest) { 2214 case UR_SET_ADDRESS: 2215 goto tr_handle_set_address; 2216 case UR_SET_CONFIG: 2217 goto tr_handle_set_config; 2218 case UR_CLEAR_FEATURE: 2219 goto tr_valid; /* nop */ 2220 case UR_SET_DESCRIPTOR: 2221 goto tr_valid; /* nop */ 2222 case UR_SET_FEATURE: 2223 default: 2224 goto tr_stalled; 2225 } 2226 break; 2227 2228 case UT_WRITE_ENDPOINT: 2229 switch (req->bRequest) { 2230 case UR_CLEAR_FEATURE: 2231 switch (UGETW(req->wValue)) { 2232 case UF_ENDPOINT_HALT: 2233 goto tr_handle_clear_halt; 2234 case UF_DEVICE_REMOTE_WAKEUP: 2235 goto tr_handle_clear_wakeup; 2236 default: 2237 goto tr_stalled; 2238 } 2239 break; 2240 case UR_SET_FEATURE: 2241 switch (UGETW(req->wValue)) { 2242 case UF_ENDPOINT_HALT: 2243 goto tr_handle_set_halt; 2244 case UF_DEVICE_REMOTE_WAKEUP: 2245 goto tr_handle_set_wakeup; 2246 default: 2247 goto tr_stalled; 2248 } 2249 break; 2250 case UR_SYNCH_FRAME: 2251 goto tr_valid; /* nop */ 2252 default: 2253 goto tr_stalled; 2254 } 2255 break; 2256 2257 case UT_READ_ENDPOINT: 2258 switch (req->bRequest) { 2259 case UR_GET_STATUS: 2260 goto tr_handle_get_ep_status; 2261 default: 2262 goto tr_stalled; 2263 } 2264 break; 2265 2266 case UT_WRITE_INTERFACE: 2267 switch (req->bRequest) { 2268 case UR_SET_INTERFACE: 2269 goto tr_handle_set_interface; 2270 case UR_CLEAR_FEATURE: 2271 goto tr_valid; /* nop */ 2272 case UR_SET_FEATURE: 2273 default: 2274 goto tr_stalled; 2275 } 2276 break; 2277 2278 case UT_READ_INTERFACE: 2279 switch (req->bRequest) { 2280 case UR_GET_INTERFACE: 2281 goto tr_handle_get_interface; 2282 case UR_GET_STATUS: 2283 goto tr_handle_get_iface_status; 2284 default: 2285 goto tr_stalled; 2286 } 2287 break; 2288 2289 case UT_WRITE_CLASS_INTERFACE: 2290 case UT_WRITE_VENDOR_INTERFACE: 2291 /* XXX forward */ 2292 break; 2293 2294 case UT_READ_CLASS_INTERFACE: 2295 case UT_READ_VENDOR_INTERFACE: 2296 /* XXX forward */ 2297 break; 2298 2299 case UT_WRITE_CLASS_DEVICE: 2300 switch (req->bRequest) { 2301 case UR_CLEAR_FEATURE: 2302 goto tr_valid; 2303 case UR_SET_DESCRIPTOR: 2304 case UR_SET_FEATURE: 2305 break; 2306 default: 2307 goto tr_stalled; 2308 } 2309 break; 2310 2311 case UT_WRITE_CLASS_OTHER: 2312 switch (req->bRequest) { 2313 case UR_CLEAR_FEATURE: 2314 goto tr_handle_clear_port_feature; 2315 case UR_SET_FEATURE: 2316 goto tr_handle_set_port_feature; 2317 case UR_CLEAR_TT_BUFFER: 2318 case UR_RESET_TT: 2319 case UR_STOP_TT: 2320 goto tr_valid; 2321 2322 default: 2323 goto tr_stalled; 2324 } 2325 break; 2326 2327 case UT_READ_CLASS_OTHER: 2328 switch (req->bRequest) { 2329 case UR_GET_TT_STATE: 2330 goto tr_handle_get_tt_state; 2331 case UR_GET_STATUS: 2332 goto tr_handle_get_port_status; 2333 default: 2334 goto tr_stalled; 2335 } 2336 break; 2337 2338 case UT_READ_CLASS_DEVICE: 2339 switch (req->bRequest) { 2340 case UR_GET_DESCRIPTOR: 2341 goto tr_handle_get_class_descriptor; 2342 case UR_GET_STATUS: 2343 goto tr_handle_get_class_status; 2344 2345 default: 2346 goto tr_stalled; 2347 } 2348 break; 2349 default: 2350 goto tr_stalled; 2351 } 2352 goto tr_valid; 2353 2354tr_handle_get_descriptor: 2355 switch (value >> 8) { 2356 case UDESC_DEVICE: 2357 if (value & 0xff) { 2358 goto tr_stalled; 2359 } 2360 len = sizeof(musbotg_devd); 2361 ptr = (const void *)&musbotg_devd; 2362 goto tr_valid; 2363 case UDESC_CONFIG: 2364 if (value & 0xff) { 2365 goto tr_stalled; 2366 } 2367 len = sizeof(musbotg_confd); 2368 ptr = (const void *)&musbotg_confd; 2369 goto tr_valid; 2370 case UDESC_STRING: 2371 switch (value & 0xff) { 2372 case 0: /* Language table */ 2373 len = sizeof(musbotg_langtab); 2374 ptr = (const void *)&musbotg_langtab; 2375 goto tr_valid; 2376 2377 case 1: /* Vendor */ 2378 len = sizeof(musbotg_vendor); 2379 ptr = (const void *)&musbotg_vendor; 2380 goto tr_valid; 2381 2382 case 2: /* Product */ 2383 len = sizeof(musbotg_product); 2384 ptr = (const void *)&musbotg_product; 2385 goto tr_valid; 2386 default: 2387 break; 2388 } 2389 break; 2390 default: 2391 goto tr_stalled; 2392 } 2393 goto tr_stalled; 2394 2395tr_handle_get_config: 2396 len = 1; 2397 sc->sc_hub_temp.wValue[0] = sc->sc_conf; 2398 goto tr_valid; 2399 2400tr_handle_get_status: 2401 len = 2; 2402 USETW(sc->sc_hub_temp.wValue, UDS_SELF_POWERED); 2403 goto tr_valid; 2404 2405tr_handle_set_address: 2406 if (value & 0xFF00) { 2407 goto tr_stalled; 2408 } 2409 sc->sc_rt_addr = value; 2410 goto tr_valid; 2411 2412tr_handle_set_config: 2413 if (value >= 2) { 2414 goto tr_stalled; 2415 } 2416 sc->sc_conf = value; 2417 goto tr_valid; 2418 2419tr_handle_get_interface: 2420 len = 1; 2421 sc->sc_hub_temp.wValue[0] = 0; 2422 goto tr_valid; 2423 2424tr_handle_get_tt_state: 2425tr_handle_get_class_status: 2426tr_handle_get_iface_status: 2427tr_handle_get_ep_status: 2428 len = 2; 2429 USETW(sc->sc_hub_temp.wValue, 0); 2430 goto tr_valid; 2431 2432tr_handle_set_halt: 2433tr_handle_set_interface: 2434tr_handle_set_wakeup: 2435tr_handle_clear_wakeup: 2436tr_handle_clear_halt: 2437 goto tr_valid; 2438 2439tr_handle_clear_port_feature: 2440 if (index != 1) { 2441 goto tr_stalled; 2442 } 2443 DPRINTFN(8, "UR_CLEAR_PORT_FEATURE on port %d\n", index); 2444 2445 switch (value) { 2446 case UHF_PORT_SUSPEND: 2447 musbotg_wakeup_peer(sc); 2448 break; 2449 2450 case UHF_PORT_ENABLE: 2451 sc->sc_flags.port_enabled = 0; 2452 break; 2453 2454 case UHF_PORT_TEST: 2455 case UHF_PORT_INDICATOR: 2456 case UHF_C_PORT_ENABLE: 2457 case UHF_C_PORT_OVER_CURRENT: 2458 case UHF_C_PORT_RESET: 2459 /* nops */ 2460 break; 2461 case UHF_PORT_POWER: 2462 sc->sc_flags.port_powered = 0; 2463 musbotg_pull_down(sc); 2464 musbotg_clocks_off(sc); 2465 break; 2466 case UHF_C_PORT_CONNECTION: 2467 sc->sc_flags.change_connect = 0; 2468 break; 2469 case UHF_C_PORT_SUSPEND: 2470 sc->sc_flags.change_suspend = 0; 2471 break; 2472 default: 2473 err = USB_ERR_IOERROR; 2474 goto done; 2475 } 2476 goto tr_valid; 2477 2478tr_handle_set_port_feature: 2479 if (index != 1) { 2480 goto tr_stalled; 2481 } 2482 DPRINTFN(8, "UR_SET_PORT_FEATURE\n"); 2483 2484 switch (value) { 2485 case UHF_PORT_ENABLE: 2486 sc->sc_flags.port_enabled = 1; 2487 break; 2488 case UHF_PORT_SUSPEND: 2489 case UHF_PORT_RESET: 2490 case UHF_PORT_TEST: 2491 case UHF_PORT_INDICATOR: 2492 /* nops */ 2493 break; 2494 case UHF_PORT_POWER: 2495 sc->sc_flags.port_powered = 1; 2496 break; 2497 default: 2498 err = USB_ERR_IOERROR; 2499 goto done; 2500 } 2501 goto tr_valid; 2502 2503tr_handle_get_port_status: 2504 2505 DPRINTFN(8, "UR_GET_PORT_STATUS\n"); 2506 2507 if (index != 1) { 2508 goto tr_stalled; 2509 } 2510 if (sc->sc_flags.status_vbus) { 2511 musbotg_clocks_on(sc); 2512 musbotg_pull_up(sc); 2513 } else { 2514 musbotg_pull_down(sc); 2515 musbotg_clocks_off(sc); 2516 } 2517 2518 /* Select Device Side Mode */ 2519 value = UPS_PORT_MODE_DEVICE; 2520 2521 if (sc->sc_flags.status_high_speed) { 2522 value |= UPS_HIGH_SPEED; 2523 } 2524 if (sc->sc_flags.port_powered) { 2525 value |= UPS_PORT_POWER; 2526 } 2527 if (sc->sc_flags.port_enabled) { 2528 value |= UPS_PORT_ENABLED; 2529 } 2530 if (sc->sc_flags.status_vbus && 2531 sc->sc_flags.status_bus_reset) { 2532 value |= UPS_CURRENT_CONNECT_STATUS; 2533 } 2534 if (sc->sc_flags.status_suspend) { 2535 value |= UPS_SUSPEND; 2536 } 2537 USETW(sc->sc_hub_temp.ps.wPortStatus, value); 2538 2539 value = 0; 2540 2541 if (sc->sc_flags.change_connect) { 2542 value |= UPS_C_CONNECT_STATUS; 2543 2544 if (sc->sc_flags.status_vbus && 2545 sc->sc_flags.status_bus_reset) { 2546 /* reset EP0 state */ 2547 sc->sc_ep0_busy = 0; 2548 sc->sc_ep0_cmd = 0; 2549 } 2550 } 2551 if (sc->sc_flags.change_suspend) { 2552 value |= UPS_C_SUSPEND; 2553 } 2554 USETW(sc->sc_hub_temp.ps.wPortChange, value); 2555 len = sizeof(sc->sc_hub_temp.ps); 2556 goto tr_valid; 2557 2558tr_handle_get_class_descriptor: 2559 if (value & 0xFF) { 2560 goto tr_stalled; 2561 } 2562 ptr = (const void *)&musbotg_hubd; 2563 len = sizeof(musbotg_hubd); 2564 goto tr_valid; 2565 2566tr_stalled: 2567 err = USB_ERR_STALLED; 2568tr_valid: 2569done: 2570 *plength = len; 2571 *pptr = ptr; 2572 return (err); 2573} 2574 2575static void 2576musbotg_xfer_setup(struct usb_setup_params *parm) 2577{ 2578 const struct usb_hw_ep_profile *pf; 2579 struct musbotg_softc *sc; 2580 struct usb_xfer *xfer; 2581 void *last_obj; 2582 uint32_t ntd; 2583 uint32_t n; 2584 uint8_t ep_no; 2585 2586 sc = MUSBOTG_BUS2SC(parm->udev->bus); 2587 xfer = parm->curr_xfer; 2588 2589 /* 2590 * NOTE: This driver does not use any of the parameters that 2591 * are computed from the following values. Just set some 2592 * reasonable dummies: 2593 */ 2594 parm->hc_max_packet_size = 0x400; 2595 parm->hc_max_frame_size = 0x400; 2596 2597 if ((parm->methods == &musbotg_device_isoc_methods) || 2598 (parm->methods == &musbotg_device_intr_methods)) 2599 parm->hc_max_packet_count = 3; 2600 else 2601 parm->hc_max_packet_count = 1; 2602 2603 usbd_transfer_setup_sub(parm); 2604 2605 /* 2606 * compute maximum number of TDs 2607 */ 2608 if (parm->methods == &musbotg_device_ctrl_methods) { 2609 2610 ntd = xfer->nframes + 1 /* STATUS */ + 1 /* SYNC */ ; 2611 2612 } else if (parm->methods == &musbotg_device_bulk_methods) { 2613 2614 ntd = xfer->nframes + 1 /* SYNC */ ; 2615 2616 } else if (parm->methods == &musbotg_device_intr_methods) { 2617 2618 ntd = xfer->nframes + 1 /* SYNC */ ; 2619 2620 } else if (parm->methods == &musbotg_device_isoc_methods) { 2621 2622 ntd = xfer->nframes + 1 /* SYNC */ ; 2623 2624 } else { 2625 2626 ntd = 0; 2627 } 2628 2629 /* 2630 * check if "usbd_transfer_setup_sub" set an error 2631 */ 2632 if (parm->err) { 2633 return; 2634 } 2635 /* 2636 * allocate transfer descriptors 2637 */ 2638 last_obj = NULL; 2639 2640 /* 2641 * get profile stuff 2642 */ 2643 if (ntd) { 2644 2645 ep_no = xfer->endpointno & UE_ADDR; 2646 musbotg_get_hw_ep_profile(parm->udev, &pf, ep_no); 2647 2648 if (pf == NULL) { 2649 /* should not happen */ 2650 parm->err = USB_ERR_INVAL; 2651 return; 2652 } 2653 } else { 2654 ep_no = 0; 2655 pf = NULL; 2656 } 2657 2658 /* align data */ 2659 parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 2660 2661 for (n = 0; n != ntd; n++) { 2662 2663 struct musbotg_td *td; 2664 2665 if (parm->buf) { 2666 2667 td = USB_ADD_BYTES(parm->buf, parm->size[0]); 2668 2669 /* init TD */ 2670 td->max_frame_size = xfer->max_frame_size; 2671 td->ep_no = ep_no; 2672 td->obj_next = last_obj; 2673 2674 last_obj = td; 2675 } 2676 parm->size[0] += sizeof(*td); 2677 } 2678 2679 xfer->td_start[0] = last_obj; 2680} 2681 2682static void 2683musbotg_xfer_unsetup(struct usb_xfer *xfer) 2684{ 2685 return; 2686} 2687 2688static void 2689musbotg_ep_init(struct usb_device *udev, struct usb_endpoint_descriptor *edesc, 2690 struct usb_endpoint *ep) 2691{ 2692 struct musbotg_softc *sc = MUSBOTG_BUS2SC(udev->bus); 2693 2694 DPRINTFN(2, "endpoint=%p, addr=%d, endpt=%d, mode=%d (%d)\n", 2695 ep, udev->address, 2696 edesc->bEndpointAddress, udev->flags.usb_mode, 2697 sc->sc_rt_addr); 2698 2699 if (udev->device_index != sc->sc_rt_addr) { 2700 2701 if (udev->flags.usb_mode != USB_MODE_DEVICE) { 2702 /* not supported */ 2703 return; 2704 } 2705 if ((udev->speed != USB_SPEED_FULL) && 2706 (udev->speed != USB_SPEED_HIGH)) { 2707 /* not supported */ 2708 return; 2709 } 2710 switch (edesc->bmAttributes & UE_XFERTYPE) { 2711 case UE_CONTROL: 2712 ep->methods = &musbotg_device_ctrl_methods; 2713 break; 2714 case UE_INTERRUPT: 2715 ep->methods = &musbotg_device_intr_methods; 2716 break; 2717 case UE_ISOCHRONOUS: 2718 ep->methods = &musbotg_device_isoc_methods; 2719 break; 2720 case UE_BULK: 2721 ep->methods = &musbotg_device_bulk_methods; 2722 break; 2723 default: 2724 /* do nothing */ 2725 break; 2726 } 2727 } 2728} 2729 2730struct usb_bus_methods musbotg_bus_methods = 2731{ 2732 .endpoint_init = &musbotg_ep_init, 2733 .xfer_setup = &musbotg_xfer_setup, 2734 .xfer_unsetup = &musbotg_xfer_unsetup, 2735 .get_hw_ep_profile = &musbotg_get_hw_ep_profile, 2736 .set_stall = &musbotg_set_stall, 2737 .clear_stall = &musbotg_clear_stall, 2738 .roothub_exec = &musbotg_roothub_exec, 2739 .xfer_poll = &musbotg_do_poll, 2740}; 2741