payloads/libpayload/drivers/usb/uhci_rh.c

   1 /*
   2  * This file is part of the libpayload project.
   3  *
   4  * Copyright (C) 2008-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 //#define USB_DEBUG
  31
  32 #include <libpayload.h>
  33 #include "uhci.h"
  34 #include "uhci_private.h"
  35
  36 typedef struct {
  37         int port[2];
  38 } rh_inst_t;
  39
  40 #define RH_INST(dev) ((rh_inst_t*)(dev)->data)
  41
  42 static void
  43 uhci_rh_enable_port (usbdev_t *dev, int port)
  44 {
  45         u16 value;
  46         hci_t *controller = dev->controller;
  47         if (port == 1)
  48                 port = PORTSC1;
  49         else if (port == 2)
  50                 port = PORTSC2;
  51         else {
  52                 debug("Invalid port %d\n", port);
  53                 return;
  54         }
  55
  56         uhci_reg_mask16 (controller, port, ~(1 << 12), 0);      /* wakeup */
  57
  58         uhci_reg_mask16 (controller, port, ~0, 1 << 9); /* reset */
  59         mdelay (30);            // >10ms
  60         uhci_reg_mask16 (controller, port, ~(1 << 9), 0);
  61         mdelay (1);             // >5.3us per spec, <3ms because some devices make trouble
  62
  63         uhci_reg_mask16 (controller, port, ~0, 1 << 2); /* enable */
  64         do {
  65                 value = uhci_reg_read16 (controller, port);
  66                 mdelay (1);
  67         } while (((value & (1 << 2)) == 0) && (value & 0x01));
  68 }
  69
  70 /* disable root hub */
  71 static void
  72 uhci_rh_disable_port (usbdev_t *dev, int port)
  73 {
  74         hci_t *controller = dev->controller;
  75         port = PORTSC2;
  76         if (port == 1)
  77                 port = PORTSC1;
  78         uhci_reg_mask16 (controller, port, ~4, 0);
  79         int value;
  80         do {
  81                 value = uhci_reg_read16 (controller, port);
  82                 mdelay (1);
  83         } while ((value & (1 << 2)) != 0);
  84 }
  85
  86 static void
  87 uhci_rh_scanport (usbdev_t *dev, int port)
  88 {
  89         int portsc, offset;
  90         if (port == 1) {
  91                 portsc = PORTSC1;
  92                 offset = 0;
  93         } else if (port == 2) {
  94                 portsc = PORTSC2;
  95                 offset = 1;
  96         } else {
  97                 debug("Invalid port %d\n", port);
  98                 return;
  99         }
 100         int devno = RH_INST (dev)->port[offset];
 101         if ((dev->controller->devices[devno] != 0) && (devno != -1)) {
 102                 usb_detach_device(dev->controller, devno);
 103                 RH_INST (dev)->port[offset] = -1;
 104         }
 105         uhci_reg_mask16 (dev->controller, portsc, ~0, (1 << 3) | (1 << 2));     // clear port state change, enable port
 106
 107         mdelay(100); // wait for signal to stabilize
 108
 109         if ((uhci_reg_read16 (dev->controller, portsc) & 1) != 0) {
 110                 // device attached
 111
 112                 uhci_rh_disable_port (dev, port);
 113                 uhci_rh_enable_port (dev, port);
 114
 115                 int speed = ((uhci_reg_read16 (dev->controller, portsc) >> 8) & 1);
 116
 117                 RH_INST (dev)->port[offset] = usb_attach_device(dev->controller, dev->address, portsc, speed);
 118         }
 119 }
 120
 121 static int
 122 uhci_rh_report_port_changes (usbdev_t *dev)
 123 {
 124         int stored, real;
 125
 126         stored = (RH_INST (dev)->port[0] == -1);
 127         real = ((uhci_reg_read16 (dev->controller, PORTSC1) & 1) == 0);
 128         if (stored != real) {
 129                 debug("change on port 1\n");
 130                 return 1;
 131         }
 132
 133         stored = (RH_INST (dev)->port[1] == -1);
 134         real = ((uhci_reg_read16 (dev->controller, PORTSC2) & 1) == 0);
 135         if (stored != real) {
 136                 debug("change on port 2\n");
 137                 return 2;
 138         }
 139
 140         // maybe detach+attach happened between two scans?
 141
 142         if ((uhci_reg_read16 (dev->controller, PORTSC1) & 2) > 0) {
 143                 debug("possibly re-attached on port 1\n");
 144                 return 1;
 145         }
 146         if ((uhci_reg_read16 (dev->controller, PORTSC2) & 2) > 0) {
 147                 debug("possibly re-attached on port 2\n");
 148                 return 2;
 149         }
 150
 151         // no change
 152         return -1;
 153 }
 154
 155 static void
 156 uhci_rh_destroy (usbdev_t *dev)
 157 {
 158         uhci_rh_disable_port (dev, 1);
 159         uhci_rh_disable_port (dev, 2);
 160         free (RH_INST (dev));
 161 }
 162
 163 static void
 164 uhci_rh_poll (usbdev_t *dev)
 165 {
 166         int port;
 167         while ((port = uhci_rh_report_port_changes (dev)) != -1)
 168                 uhci_rh_scanport (dev, port);
 169 }
 170
 171 void
 172 uhci_rh_init (usbdev_t *dev)
 173 {
 174         dev->destroy = uhci_rh_destroy;
 175         dev->poll = uhci_rh_poll;
 176
 177         uhci_rh_enable_port (dev, 1);
 178         uhci_rh_enable_port (dev, 2);
 179         dev->data = malloc (sizeof (rh_inst_t));
 180         if (!dev->data)
 181                 fatal("Not enough memory for UHCI RH.\n");
 182
 183         RH_INST (dev)->port[0] = -1;
 184         RH_INST (dev)->port[1] = -1;
 185
 186         /* we can set them here because a root hub _really_ shouldn't
 187            appear elsewhere */
 188         dev->address = 0;
 189         dev->hub = -1;
 190         dev->port = -1;
 191 }