payloads/libpayload/drivers/usb/ehci_rh.c

   1 /*
   2  * This file is part of the libpayload project.
   3  *
   4  * Copyright (C) 2010 coresystems GmbH
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <libpayload.h>
  31 #include "ehci.h"
  32 #include "ehci_private.h"
  33
  34 typedef struct {
  35         int n_ports;
  36         /* typical C, n_ports is the number
  37          * of ports, while ports[] spans [0,n_ports-1],
  38          * even though the spec counts from 1.
  39          */
  40         volatile portsc_t *ports;
  41         int *devices;
  42 } rh_inst_t;
  43
  44 #define RH_INST(dev) ((rh_inst_t*)(dev)->data)
  45
  46 static void
  47 ehci_rh_destroy (usbdev_t *dev)
  48 {
  49         free (RH_INST(dev)->devices);
  50         free (RH_INST(dev));
  51 }
  52
  53 static void
  54 ehci_rh_hand_over_port (usbdev_t *dev, int port)
  55 {
  56         volatile portsc_t *p = &(RH_INST(dev)->ports[port]);
  57
  58         debug("giving up port %x, it's USB1\n", port+1);
  59
  60         /* Lowspeed device. Hand over to companion */
  61         *p |= P_PORT_OWNER;
  62         do {} while (!(*p & P_CONN_STATUS_CHANGE));
  63         /* RW/C register, so clear it by writing 1 */
  64         *p |= P_CONN_STATUS_CHANGE;
  65         return;
  66 }
  67
  68 static void
  69 ehci_rh_scanport (usbdev_t *dev, int port)
  70 {
  71         volatile portsc_t *p = &(RH_INST(dev)->ports[port]);
  72         if (RH_INST(dev)->devices[port]!=-1) {
  73                 debug("Unregister device at port %x\n", port+1);
  74                 usb_detach_device(dev->controller, RH_INST(dev)->devices[port]);
  75                 RH_INST(dev)->devices[port]=-1;
  76         }
  77         /* device connected, handle */
  78         if (*p & P_CURR_CONN_STATUS) {
  79                 mdelay(100);
  80                 if ((*p & P_LINE_STATUS) == P_LINE_STATUS_LOWSPEED) {
  81                         ehci_rh_hand_over_port(dev, port);
  82                         return;
  83                 }
  84
  85                 /* Deassert enable, assert reset.  These must change
  86                  * atomically.
  87                  */
  88                 *p = (*p & ~P_PORT_ENABLE) | P_PORT_RESET;
  89
  90                 /* Wait a bit while reset is active. */
  91                 mdelay(50);
  92
  93                 /* Deassert reset. */
  94                 *p &= ~P_PORT_RESET;
  95
  96                 /* Wait for flag change to finish. The controller might take a while */
  97                 while (*p & P_PORT_RESET) ;
  98                 if (!(*p & P_PORT_ENABLE)) {
  99                         ehci_rh_hand_over_port(dev, port);
 100                         return;
 101                 }
 102                 debug("port %x hosts a USB2 device\n", port+1);
 103                 RH_INST(dev)->devices[port] = usb_attach_device(dev->controller, dev->address, port, 2);
 104         }
 105         /* RW/C register, so clear it by writing 1 */
 106         *p |= P_CONN_STATUS_CHANGE;
 107 }
 108
 109 static int
 110 ehci_rh_report_port_changes (usbdev_t *dev)
 111 {
 112         int i;
 113         for (i=0; i<RH_INST(dev)->n_ports; i++) {
 114                 if (RH_INST(dev)->ports[i] & P_CONN_STATUS_CHANGE)
 115                         return i;
 116         }
 117         return -1;
 118 }
 119
 120 static void
 121 ehci_rh_poll (usbdev_t *dev)
 122 {
 123         int port;
 124         while ((port = ehci_rh_report_port_changes (dev)) != -1)
 125                 ehci_rh_scanport (dev, port);
 126 }
 127
 128
 129 void
 130 ehci_rh_init (usbdev_t *dev)
 131 {
 132         int i;
 133         volatile portsc_t *p;
 134
 135         dev->destroy = ehci_rh_destroy;
 136         dev->poll = ehci_rh_poll;
 137
 138         dev->data = malloc(sizeof(rh_inst_t));
 139
 140         RH_INST(dev)->n_ports = EHCI_INST(dev->controller)->capabilities->hcsparams & HCS_NPORTS_MASK;
 141         RH_INST(dev)->ports = EHCI_INST(dev->controller)->operation->portsc;
 142
 143         debug("root hub has %x ports\n", RH_INST(dev)->n_ports);
 144
 145         RH_INST(dev)->devices = malloc(RH_INST(dev)->n_ports * sizeof(int));
 146         for (i=0; i < RH_INST(dev)->n_ports; i++) {
 147                 p = &(RH_INST(dev)->ports[i]);
 148                 RH_INST(dev)->devices[i] = -1;
 149                 *p |= P_PP;
 150         }
 151
 152         dev->address = 0;
 153         dev->hub = -1;
 154         dev->port = -1;
 155 }