src/lib/usbdebug.c

   1 /*
   2  * This file is part of the coreboot project.
   3  *
   4  * Copyright (C) 2006 Eric Biederman (ebiederm@xmission.com)
   5  * Copyright (C) 2007 AMD
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; version 2 of the License.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA
  19  */
  20
  21 #include <stddef.h>
  22 #include <console/console.h>
  23 #include <arch/io.h>
  24 #include <arch/byteorder.h>
  25
  26 #include <usb_ch9.h>
  27 #include <ehci.h>
  28 #include <usbdebug.h>
  29
  30 // Does not work if we want early printk to do usb debug, too..
  31 #define DBGP_DEBUG 0
  32 #if DBGP_DEBUG
  33 # define dbgp_printk(fmt_arg...) printk(BIOS_DEBUG, fmt_arg)
  34 #else
  35 #define dbgp_printk(fmt_arg...)   do {} while(0)
  36 #endif
  37
  38
  39 #define USB_DEBUG_DEVNUM 127
  40
  41 #define DBGP_DATA_TOGGLE        0x8800
  42 #define DBGP_PID_UPDATE(x, tok) \
  43         ((((x) ^ DBGP_DATA_TOGGLE) & 0xffff00) | ((tok) & 0xff))
  44
  45 #define DBGP_LEN_UPDATE(x, len) (((x) & ~0x0f) | ((len) & 0x0f))
  46 /*
  47  * USB Packet IDs (PIDs)
  48  */
  49
  50 /* token */
  51 #define USB_PID_OUT             0xe1
  52 #define USB_PID_IN              0x69
  53 #define USB_PID_SOF             0xa5
  54 #define USB_PID_SETUP           0x2d
  55 /* handshake */
  56 #define USB_PID_ACK             0xd2
  57 #define USB_PID_NAK             0x5a
  58 #define USB_PID_STALL           0x1e
  59 #define USB_PID_NYET            0x96
  60 /* data */
  61 #define USB_PID_DATA0           0xc3
  62 #define USB_PID_DATA1           0x4b
  63 #define USB_PID_DATA2           0x87
  64 #define USB_PID_MDATA           0x0f
  65 /* Special */
  66 #define USB_PID_PREAMBLE        0x3c
  67 #define USB_PID_ERR             0x3c
  68 #define USB_PID_SPLIT           0x78
  69 #define USB_PID_PING            0xb4
  70 #define USB_PID_UNDEF_0         0xf0
  71
  72 #define USB_PID_DATA_TOGGLE     0x88
  73 #define DBGP_CLAIM (DBGP_OWNER | DBGP_ENABLED | DBGP_INUSE)
  74
  75 #define PCI_CAP_ID_EHCI_DEBUG   0xa
  76
  77 #define HUB_ROOT_RESET_TIME     50      /* times are in msec */
  78 #define HUB_SHORT_RESET_TIME    10
  79 #define HUB_LONG_RESET_TIME     200
  80 #define HUB_RESET_TIMEOUT       500
  81
  82 #define DBGP_MAX_PACKET         8
  83
  84 static int dbgp_wait_until_complete(struct ehci_dbg_port *ehci_debug)
  85 {
  86         u32 ctrl;
  87         int loop = 0x100000;
  88
  89         do {
  90                 ctrl = read32((unsigned long)&ehci_debug->control);
  91                 /* Stop when the transaction is finished */
  92                 if (ctrl & DBGP_DONE)
  93                         break;
  94         } while (--loop > 0);
  95
  96         if (!loop)
  97                 return -1;
  98
  99         /* Now that we have observed the completed transaction,
 100          * clear the done bit.
 101          */
 102         write32((unsigned long)&ehci_debug->control, ctrl | DBGP_DONE);
 103         return (ctrl & DBGP_ERROR) ? -DBGP_ERRCODE(ctrl) : DBGP_LEN(ctrl);
 104 }
 105
 106 static void dbgp_breath(void)
 107 {
 108         /* Sleep to give the debug port a chance to breathe */
 109 }
 110
 111 static int dbgp_wait_until_done(struct ehci_dbg_port *ehci_debug, unsigned ctrl)
 112 {
 113         u32 pids, lpid;
 114         int ret;
 115         int loop = 3;
 116
 117 retry:
 118         write32((unsigned long)&ehci_debug->control, ctrl | DBGP_GO);
 119         ret = dbgp_wait_until_complete(ehci_debug);
 120         pids = read32((unsigned long)&ehci_debug->pids);
 121         lpid = DBGP_PID_GET(pids);
 122
 123         if (ret < 0)
 124                 return ret;
 125
 126         /* If the port is getting full or it has dropped data
 127          * start pacing ourselves, not necessary but it's friendly.
 128          */
 129         if ((lpid == USB_PID_NAK) || (lpid == USB_PID_NYET))
 130                 dbgp_breath();
 131
 132         /* If I get a NACK reissue the transmission */
 133         if (lpid == USB_PID_NAK) {
 134                 if (--loop > 0)
 135                         goto retry;
 136         }
 137
 138         return ret;
 139 }
 140
 141 static void dbgp_set_data(struct ehci_dbg_port *ehci_debug, const void *buf, int size)
 142 {
 143         const unsigned char *bytes = buf;
 144         u32 lo, hi;
 145         int i;
 146
 147         lo = hi = 0;
 148         for (i = 0; i < 4 && i < size; i++)
 149                 lo |= bytes[i] << (8*i);
 150         for (; i < 8 && i < size; i++)
 151                 hi |= bytes[i] << (8*(i - 4));
 152         write32((unsigned long)&ehci_debug->data03, lo);
 153         write32((unsigned long)&ehci_debug->data47, hi);
 154 }
 155
 156 static void dbgp_get_data(struct ehci_dbg_port *ehci_debug, void *buf, int size)
 157 {
 158         unsigned char *bytes = buf;
 159         u32 lo, hi;
 160         int i;
 161
 162         lo = read32((unsigned long)&ehci_debug->data03);
 163         hi = read32((unsigned long)&ehci_debug->data47);
 164         for (i = 0; i < 4 && i < size; i++)
 165                 bytes[i] = (lo >> (8*i)) & 0xff;
 166         for (; i < 8 && i < size; i++)
 167                 bytes[i] = (hi >> (8*(i - 4))) & 0xff;
 168 }
 169
 170 static int dbgp_bulk_write(struct ehci_dbg_port *ehci_debug,
 171                 unsigned devnum, unsigned endpoint, const char *bytes, int size)
 172 {
 173         u32 pids, addr, ctrl;
 174         int ret;
 175
 176         if (size > DBGP_MAX_PACKET)
 177                 return -1;
 178
 179         addr = DBGP_EPADDR(devnum, endpoint);
 180
 181         pids = read32((unsigned long)&ehci_debug->pids);
 182         pids = DBGP_PID_UPDATE(pids, USB_PID_OUT);
 183
 184         ctrl = read32((unsigned long)&ehci_debug->control);
 185         ctrl = DBGP_LEN_UPDATE(ctrl, size);
 186         ctrl |= DBGP_OUT;
 187         ctrl |= DBGP_GO;
 188
 189         dbgp_set_data(ehci_debug, bytes, size);
 190         write32((unsigned long)&ehci_debug->address, addr);
 191         write32((unsigned long)&ehci_debug->pids, pids);
 192
 193         ret = dbgp_wait_until_done(ehci_debug, ctrl);
 194
 195         return ret;
 196 }
 197
 198 int dbgp_bulk_write_x(struct ehci_debug_info *dbg_info, const char *bytes, int size)
 199 {
 200         return dbgp_bulk_write(dbg_info->ehci_debug, dbg_info->devnum,
 201                         dbg_info->endpoint_out, bytes, size);
 202 }
 203
 204 static int dbgp_bulk_read(struct ehci_dbg_port *ehci_debug, unsigned devnum,
 205                 unsigned endpoint, void *data, int size)
 206 {
 207         u32 pids, addr, ctrl;
 208         int ret;
 209
 210         if (size > DBGP_MAX_PACKET)
 211                 return -1;
 212
 213         addr = DBGP_EPADDR(devnum, endpoint);
 214
 215         pids = read32((unsigned long)&ehci_debug->pids);
 216         pids = DBGP_PID_UPDATE(pids, USB_PID_IN);
 217
 218         ctrl = read32((unsigned long)&ehci_debug->control);
 219         ctrl = DBGP_LEN_UPDATE(ctrl, size);
 220         ctrl &= ~DBGP_OUT;
 221         ctrl |= DBGP_GO;
 222
 223         write32((unsigned long)&ehci_debug->address, addr);
 224         write32((unsigned long)&ehci_debug->pids, pids);
 225         ret = dbgp_wait_until_done(ehci_debug, ctrl);
 226         if (ret < 0)
 227                 return ret;
 228
 229         if (size > ret)
 230                 size = ret;
 231         dbgp_get_data(ehci_debug, data, size);
 232         return ret;
 233 }
 234
 235 int dbgp_bulk_read_x(struct ehci_debug_info *dbg_info, void *data, int size)
 236 {
 237         return dbgp_bulk_read(dbg_info->ehci_debug, dbg_info->devnum,
 238                         dbg_info->endpoint_in, data, size);
 239 }
 240
 241 #ifdef __PRE_RAM__
 242 static void dbgp_mdelay(int ms)
 243 {
 244         int i;
 245
 246         while (ms--) {
 247                 for (i = 0; i < 1000; i++)
 248                         inb(0x80);
 249         }
 250 }
 251
 252 static int dbgp_control_msg(struct ehci_dbg_port *ehci_debug, unsigned devnum, int requesttype,
 253                 int request, int value, int index, void *data, int size)
 254 {
 255         u32 pids, addr, ctrl;
 256         struct usb_ctrlrequest req;
 257         int read;
 258         int ret;
 259
 260         read = (requesttype & USB_DIR_IN) != 0;
 261         if (size > (read ? DBGP_MAX_PACKET:0))
 262                 return -1;
 263
 264         /* Compute the control message */
 265         req.bRequestType = requesttype;
 266         req.bRequest = request;
 267         req.wValue = cpu_to_le16(value);
 268         req.wIndex = cpu_to_le16(index);
 269         req.wLength = cpu_to_le16(size);
 270
 271         pids = DBGP_PID_SET(USB_PID_DATA0, USB_PID_SETUP);
 272         addr = DBGP_EPADDR(devnum, 0);
 273
 274         ctrl = read32((unsigned long)&ehci_debug->control);
 275         ctrl = DBGP_LEN_UPDATE(ctrl, sizeof(req));
 276         ctrl |= DBGP_OUT;
 277         ctrl |= DBGP_GO;
 278
 279         /* Send the setup message */
 280         dbgp_set_data(ehci_debug, &req, sizeof(req));
 281         write32((unsigned long)&ehci_debug->address, addr);
 282         write32((unsigned long)&ehci_debug->pids, pids);
 283         ret = dbgp_wait_until_done(ehci_debug, ctrl);
 284         if (ret < 0)
 285                 return ret;
 286
 287
 288         /* Read the result */
 289         ret = dbgp_bulk_read(ehci_debug, devnum, 0, data, size);
 290         return ret;
 291 }
 292
 293 static int ehci_reset_port(struct ehci_regs *ehci_regs, int port)
 294 {
 295         u32 portsc;
 296         u32 delay_time, delay_ms;
 297         int loop;
 298
 299         /* Reset the usb debug port */
 300         portsc = read32((unsigned long)&ehci_regs->port_status[port - 1]);
 301         portsc &= ~PORT_PE;
 302         portsc |= PORT_RESET;
 303         write32((unsigned long)&ehci_regs->port_status[port - 1], portsc);
 304
 305         delay_ms = HUB_ROOT_RESET_TIME;
 306         for (delay_time = 0; delay_time < HUB_RESET_TIMEOUT;
 307              delay_time += delay_ms) {
 308                 dbgp_mdelay(delay_ms);
 309
 310                 portsc = read32((unsigned long)&ehci_regs->port_status[port - 1]);
 311                 if (portsc & PORT_RESET) {
 312                         /* force reset to complete */
 313                         loop = 2;
 314                         write32((unsigned long)&ehci_regs->port_status[port - 1],
 315                                         portsc & ~(PORT_RWC_BITS | PORT_RESET));
 316                         do {
 317                                 dbgp_mdelay(delay_ms);
 318                                 portsc = read32((unsigned long)&ehci_regs->port_status[port - 1]);
 319                                 delay_time += delay_ms;
 320                         } while ((portsc & PORT_RESET) && (--loop > 0));
 321                         if (!loop) {
 322                                 printk(BIOS_DEBUG, "ehci_reset_port forced done");
 323                         }
 324                 }
 325
 326                 /* Device went away? */
 327                 if (!(portsc & PORT_CONNECT))
 328                         return -1; //-ENOTCONN;
 329
 330                 /* bomb out completely if something weird happend */
 331                 if ((portsc & PORT_CSC))
 332                         return -2; //-EINVAL;
 333
 334                 /* If we've finished resetting, then break out of the loop */
 335                 if (!(portsc & PORT_RESET) && (portsc & PORT_PE))
 336                         return 0;
 337         }
 338         return -3; //-EBUSY;
 339 }
 340
 341 static int ehci_wait_for_port(struct ehci_regs *ehci_regs, int port)
 342 {
 343         u32 status;
 344         int ret, reps;
 345
 346         for (reps = 0; reps < 3; reps++) {
 347                 dbgp_mdelay(100);
 348                 status = read32((unsigned long)&ehci_regs->status);
 349                 if (status & STS_PCD) {
 350                         ret = ehci_reset_port(ehci_regs, port);
 351                         if (ret == 0)
 352                                 return 0;
 353                 }
 354         }
 355         return -1; //-ENOTCONN;
 356 }
 357
 358
 359 static int usbdebug_init(unsigned ehci_bar, unsigned offset, struct ehci_debug_info *info)
 360 {
 361         struct ehci_caps *ehci_caps;
 362         struct ehci_regs *ehci_regs;
 363         struct ehci_dbg_port *ehci_debug;
 364         unsigned dbgp_endpoint_out;
 365         unsigned dbgp_endpoint_in;
 366
 367         struct usb_debug_descriptor dbgp_desc;
 368         u32 cmd, ctrl, status, portsc, hcs_params;
 369         u32 debug_port, new_debug_port = 0, n_ports;
 370         u32 devnum;
 371         int ret, i;
 372         int loop;
 373         int port_map_tried;
 374         int playtimes = 3;
 375
 376         ehci_caps  = (struct ehci_caps *)ehci_bar;
 377         ehci_regs  = (struct ehci_regs *)(ehci_bar +
 378                         HC_LENGTH(read32((unsigned long)&ehci_caps->hc_capbase)));
 379         ehci_debug = (struct ehci_dbg_port *)(ehci_bar + offset);
 380         info->ehci_debug = (void *)0;
 381
 382 try_next_time:
 383         port_map_tried = 0;
 384
 385 try_next_port:
 386         hcs_params = read32((unsigned long)&ehci_caps->hcs_params);
 387         debug_port = HCS_DEBUG_PORT(hcs_params);
 388         n_ports    = HCS_N_PORTS(hcs_params);
 389
 390         dbgp_printk("ehci_bar: 0x%x\n", ehci_bar);
 391         dbgp_printk("debug_port: %d\n", debug_port);
 392         dbgp_printk("n_ports:    %d\n", n_ports);
 393
 394         for (i = 1; i <= n_ports; i++) {
 395                 portsc = read32((unsigned long)&ehci_regs->port_status[i-1]);
 396                 dbgp_printk("PORTSC #%d: %08x\n", i, portsc);
 397         }
 398
 399         if(port_map_tried && (new_debug_port != debug_port)) {
 400                 if(--playtimes) {
 401                         set_debug_port(debug_port);
 402                         goto try_next_time;
 403                 }
 404                 return -1;
 405         }
 406
 407         loop = 100;
 408         /* Reset the EHCI controller */
 409         cmd = read32((unsigned long)&ehci_regs->command);
 410         cmd |= CMD_RESET;
 411         write32((unsigned long)&ehci_regs->command, cmd);
 412         do {
 413                 dbgp_mdelay(10);
 414                 cmd = read32((unsigned long)&ehci_regs->command);
 415         } while ((cmd & CMD_RESET) && (--loop > 0));
 416
 417         if(!loop) {
 418                 dbgp_printk("Could not reset EHCI controller.\n");
 419                 // on some systems it works without succeeding here.
 420                 // return -2;
 421         } else {
 422                 dbgp_printk("EHCI controller reset successfully.\n");
 423         }
 424
 425         /* Claim ownership, but do not enable yet */
 426         ctrl = read32((unsigned long)&ehci_debug->control);
 427         ctrl |= DBGP_OWNER;
 428         ctrl &= ~(DBGP_ENABLED | DBGP_INUSE);
 429         write32((unsigned long)&ehci_debug->control, ctrl);
 430
 431         /* Start EHCI controller */
 432         cmd = read32((unsigned long)&ehci_regs->command);
 433         cmd &= ~(CMD_LRESET | CMD_IAAD | CMD_PSE | CMD_ASE | CMD_RESET);
 434         cmd |= CMD_RUN;
 435         write32((unsigned long)&ehci_regs->command, cmd);
 436
 437         /* Ensure everything is routed to the EHCI */
 438         write32((unsigned long)&ehci_regs->configured_flag, FLAG_CF);
 439
 440         /* Wait until the controller is no longer halted */
 441         loop = 10;
 442         do {
 443                 dbgp_mdelay(10);
 444                 status = read32((unsigned long)&ehci_regs->status);
 445         } while ((status & STS_HALT) && (--loop > 0));
 446
 447         if(!loop) {
 448                 dbgp_printk("EHCI could not be started.\n");
 449                 return -3;
 450         }
 451         dbgp_printk("EHCI started.\n");
 452
 453         /* Wait for a device to show up in the debug port */
 454         ret = ehci_wait_for_port(ehci_regs, debug_port);
 455         if (ret < 0) {
 456                 dbgp_printk("No device found in debug port %d\n", debug_port);
 457                 goto next_debug_port;
 458         }
 459         dbgp_printk("EHCI done waiting for port.\n");
 460
 461         /* Enable the debug port */
 462         ctrl = read32((unsigned long)&ehci_debug->control);
 463         ctrl |= DBGP_CLAIM;
 464         write32((unsigned long)&ehci_debug->control, ctrl);
 465         ctrl = read32((unsigned long)&ehci_debug->control);
 466         if ((ctrl & DBGP_CLAIM) != DBGP_CLAIM) {
 467                 dbgp_printk("No device in EHCI debug port.\n");
 468                 write32((unsigned long)&ehci_debug->control, ctrl & ~DBGP_CLAIM);
 469                 ret = -4;
 470                 goto err;
 471         }
 472         dbgp_printk("EHCI debug port enabled.\n");
 473
 474         /* Completely transfer the debug device to the debug controller */
 475         portsc = read32((unsigned long)&ehci_regs->port_status[debug_port - 1]);
 476         portsc &= ~PORT_PE;
 477         write32((unsigned long)&ehci_regs->port_status[debug_port - 1], portsc);
 478
 479         dbgp_mdelay(100);
 480
 481         /* Find the debug device and make it device number 127 */
 482         for (devnum = 0; devnum <= 127; devnum++) {
 483                 ret = dbgp_control_msg(ehci_debug, devnum,
 484                         USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_DEVICE,
 485                         USB_REQ_GET_DESCRIPTOR, (USB_DT_DEBUG << 8), 0,
 486                         &dbgp_desc, sizeof(dbgp_desc));
 487                 if (ret > 0)
 488                         break;
 489         }
 490         if (devnum > 127) {
 491                 dbgp_printk("Could not find attached debug device.\n");
 492                 ret = -5;
 493                 goto err;
 494         }
 495         if (ret < 0) {
 496                 dbgp_printk("Attached device is not a debug device.\n");
 497                 ret = -6;
 498                 goto err;
 499         }
 500         dbgp_endpoint_out = dbgp_desc.bDebugOutEndpoint;
 501         dbgp_endpoint_in = dbgp_desc.bDebugInEndpoint;
 502
 503         /* Move the device to 127 if it isn't already there */
 504         if (devnum != USB_DEBUG_DEVNUM) {
 505                 ret = dbgp_control_msg(ehci_debug, devnum,
 506                         USB_DIR_OUT | USB_TYPE_STANDARD | USB_RECIP_DEVICE,
 507                         USB_REQ_SET_ADDRESS, USB_DEBUG_DEVNUM, 0, NULL, 0);
 508                 if (ret < 0) {
 509                         dbgp_printk("Could not move attached device to %d.\n",
 510                                 USB_DEBUG_DEVNUM);
 511                         ret = -7;
 512                         goto err;
 513                 }
 514                 devnum = USB_DEBUG_DEVNUM;
 515                 dbgp_printk("EHCI debug device renamed to 127.\n");
 516         }
 517
 518         /* Enable the debug interface */
 519         ret = dbgp_control_msg(ehci_debug, USB_DEBUG_DEVNUM,
 520                 USB_DIR_OUT | USB_TYPE_STANDARD | USB_RECIP_DEVICE,
 521                 USB_REQ_SET_FEATURE, USB_DEVICE_DEBUG_MODE, 0, NULL, 0);
 522         if (ret < 0) {
 523                 dbgp_printk("Could not enable EHCI debug device.\n");
 524                 ret = -8;
 525                 goto err;
 526         }
 527         dbgp_printk("EHCI debug interface enabled.\n");
 528
 529         /* Perform a small write to get the even/odd data state in sync */
 530         ret = dbgp_bulk_write(ehci_debug, USB_DEBUG_DEVNUM, dbgp_endpoint_out, "USB\r\n",5);
 531         if (ret < 0) {
 532                 dbgp_printk("dbgp_bulk_write failed: %d\n", ret);
 533                 ret = -9;
 534                 goto err;
 535         }
 536         dbgp_printk("Test write done\n");
 537
 538         info->ehci_caps = ehci_caps;
 539         info->ehci_regs = ehci_regs;
 540         info->ehci_debug = ehci_debug;
 541         info->devnum = devnum;
 542         info->endpoint_out = dbgp_endpoint_out;
 543         info->endpoint_in = dbgp_endpoint_in;
 544
 545         return 0;
 546 err:
 547         /* Things didn't work so remove my claim */
 548         ctrl = read32((unsigned long)&ehci_debug->control);
 549         ctrl &= ~(DBGP_CLAIM | DBGP_OUT);
 550         write32((unsigned long)(unsigned long)&ehci_debug->control, ctrl);
 551         //return ret;
 552
 553 next_debug_port:
 554         port_map_tried |= (1 << (debug_port - 1));
 555         new_debug_port = ((debug_port-1 + 1) % n_ports) + 1;
 556         if (port_map_tried != ((1 << n_ports) - 1)) {
 557                 set_debug_port(new_debug_port);
 558                 goto try_next_port;
 559         }
 560         if (--playtimes) {
 561                 //set_debug_port(new_debug_port);
 562                 set_debug_port(debug_port);
 563                 goto try_next_time;
 564         }
 565
 566         return -10;
 567 }
 568
 569 // **** This part is probably x86 specific and used by romstage.c **** //
 570
 571 int early_usbdebug_init(void)
 572 {
 573         struct ehci_debug_info *dbg_info = (struct ehci_debug_info *)
 574             (CONFIG_DCACHE_RAM_BASE + CONFIG_DCACHE_RAM_SIZE - sizeof(struct ehci_debug_info));
 575
 576         return usbdebug_init(CONFIG_EHCI_BAR, CONFIG_EHCI_DEBUG_OFFSET, dbg_info);
 577 }
 578
 579 void usbdebug_tx_byte(unsigned char data)
 580 {
 581         struct ehci_debug_info *dbg_info;
 582
 583         /* "Find" dbg_info structure in Cache */
 584         dbg_info = (struct ehci_debug_info *)
 585             (CONFIG_DCACHE_RAM_BASE + CONFIG_DCACHE_RAM_SIZE - sizeof(struct ehci_debug_info));
 586
 587         if (dbg_info->ehci_debug) {
 588                 dbgp_bulk_write_x(dbg_info, (char*)&data, 1);
 589         }
 590 }
 591 #endif