Subversion Repositories shark

Rev

Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

/*
 * (C) Copyright David Brownell 2000-2002
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */


#include <linuxcomp.h>

#include <linux/config.h>

#ifdef CONFIG_USB_DEBUG
        #define DEBUG
#else
        #undef DEBUG
#endif

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <asm/io.h>
#include <asm/irq.h>
#include <linux/usb.h>
#include "hcd.h"


/* PCI-based HCs are normal, but custom bus glue should be ok */


/*-------------------------------------------------------------------------*/

static void hcd_pci_release(struct usb_bus *bus)
{
        struct usb_hcd *hcd = bus->hcpriv;

        if (hcd)
                hcd->driver->hcd_free(hcd);
}

/* configure so an HC device and id are always provided */
/* always called with process context; sleeping is OK */

/**
 * usb_hcd_pci_probe - initialize PCI-based HCDs
 * @dev: USB Host Controller being probed
 * @id: pci hotplug id connecting controller to HCD framework
 * Context: !in_interrupt()
 *
 * Allocates basic PCI resources for this USB host controller, and
 * then invokes the start() method for the HCD associated with it
 * through the hotplug entry's driver_data.
 *
 * Store this function in the HCD's struct pci_driver as probe().
 */

int usb_hcd_pci_probe (struct pci_dev *dev, const struct pci_device_id *id)
{
        struct hc_driver        *driver;
        unsigned long           resource, len;
        void                    *base;
        struct usb_hcd          *hcd;
        int                     retval, region;
        char                    buf [8], *bufp = buf;

        if (usb_disabled())
                return -ENODEV;

        if (!id || !(driver = (struct hc_driver *) id->driver_data))
                return -EINVAL;

        if (pci_enable_device (dev) < 0)
                return -ENODEV;
       
        if (!dev->irq) {
                err ("Found HC with no IRQ.  Check BIOS/PCI %s setup!",
                        pci_name(dev));
                return -ENODEV;
        }
       
        if (driver->flags & HCD_MEMORY) {       // EHCI, OHCI

                region = 0;
                resource = pci_resource_start (dev, 0);
                len = pci_resource_len (dev, 0);
                if (!request_mem_region (resource, len, driver->description)) {
                        dbg ("controller already in use");
                        return -EBUSY;
                }
                base = ioremap_nocache (resource, len);
                if (base == NULL) {
                        dbg ("error mapping memory");
                        retval = -EFAULT;
clean_1:
                        release_mem_region (resource, len);
                        err ("init %s fail, %d", pci_name(dev), retval);
                        return retval;
                }

        } else {                                // UHCI
                resource = len = 0;
                for (region = 0; region < PCI_ROM_RESOURCE; region++) {
                        if (!(pci_resource_flags (dev, region) & IORESOURCE_IO))
                                continue;

                        resource = pci_resource_start (dev, region);
                        len = pci_resource_len (dev, region);
                        if (request_region (resource, len,
                                        driver->description))
                                break;
                }
                if (region == PCI_ROM_RESOURCE) {
                        dbg ("no i/o regions available");
                        return -EBUSY;
                }
                base = (void *) resource;
        }

        // driver->reset(), later on, will transfer device from
        // control by SMM/BIOS to control by Linux (if needed)

        hcd = driver->hcd_alloc ();
        if (hcd == NULL){
                dbg ("hcd alloc fail");
                retval = -ENOMEM;
clean_2:
                if (driver->flags & HCD_MEMORY) {
                        iounmap (base);
                        goto clean_1;
                } else {
                        release_region (resource, len);
                        err ("init %s fail, %d", pci_name(dev), retval);
                        return retval;
                }
        }

        // hcd zeroed everything
        hcd->regs = base;
        hcd->region = region;

        pci_set_drvdata (dev, hcd);
        hcd->driver = driver;
        hcd->description = driver->description;
        hcd->pdev = dev;
        hcd->self.bus_name = pci_name(dev);
        if (hcd->product_desc == NULL)
                hcd->product_desc = "USB Host Controller";
        hcd->self.controller = &dev->dev;
        hcd->controller = hcd->self.controller;

        if ((retval = hcd_buffer_create (hcd)) != 0) {
clean_3:
                driver->hcd_free (hcd);
                goto clean_2;
        }

        dev_info (hcd->controller, "%s\n", hcd->product_desc);

        /* till now HC has been in an indeterminate state ... */
        if (driver->reset && (retval = driver->reset (hcd)) < 0) {
                dev_err (hcd->controller, "can't reset\n");
                goto clean_3;
        }
        hcd->state = USB_STATE_HALT;

        pci_set_master (dev);
#ifndef __sparc__
        sprintf26 (buf, "%d", dev->irq);
#else
        bufp = __irq_itoa(dev->irq);
#endif

        retval = request_irq (dev->irq, usb_hcd_irq, SA_SHIRQ,
                                hcd->description, hcd);
        if (retval != 0) {
                dev_err (hcd->controller,
                                "request interrupt %s failed\n", bufp);
                goto clean_3;
        }
        hcd->irq = dev->irq;

        dev_info (hcd->controller, "irq %s, %s %p\n", bufp,
                (driver->flags & HCD_MEMORY) ? "pci mem" : "io base",
                base);
        usb_bus_init (&hcd->self);
        hcd->self.op = &usb_hcd_operations;
        hcd->self.hcpriv = (void *) hcd;
        hcd->self.release = &hcd_pci_release;

        INIT_LIST_HEAD (&hcd->dev_list);
        usb_register_bus (&hcd->self);

        if ((retval = driver->start (hcd)) < 0)
                usb_hcd_pci_remove (dev);

        return retval;
}
EXPORT_SYMBOL (usb_hcd_pci_probe);


/* may be called without controller electrically present */
/* may be called with controller, bus, and devices active */

/**
 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
 * @dev: USB Host Controller being removed
 * Context: !in_interrupt()
 *
 * Reverses the effect of usb_hcd_pci_probe(), first invoking
 * the HCD's stop() method.  It is always called from a thread
 * context, normally "rmmod", "apmd", or something similar.
 *
 * Store this function in the HCD's struct pci_driver as remove().
 */

void usb_hcd_pci_remove (struct pci_dev *dev)
{
        struct usb_hcd          *hcd;
        struct usb_device       *hub;

        hcd = pci_get_drvdata(dev);
        if (!hcd)
                return;
        dev_info (hcd->controller, "remove, state %x\n", hcd->state);

        if (in_interrupt ())
                BUG ();

        hub = hcd->self.root_hub;
        if (HCD_IS_RUNNING (hcd->state))
                hcd->state = USB_STATE_QUIESCING;

        dev_dbg (hcd->controller, "roothub graceful disconnect\n");
        usb_disconnect (&hub);

        hcd->driver->stop (hcd);
        hcd_buffer_destroy (hcd);
        hcd->state = USB_STATE_HALT;
        pci_set_drvdata (dev, 0);

        free_irq (hcd->irq, hcd);
        if (hcd->driver->flags & HCD_MEMORY) {
                iounmap (hcd->regs);
                release_mem_region (pci_resource_start (dev, 0),
                        pci_resource_len (dev, 0));
        } else {
                release_region (pci_resource_start (dev, hcd->region),
                        pci_resource_len (dev, hcd->region));
        }

        usb_deregister_bus (&hcd->self);
}
EXPORT_SYMBOL (usb_hcd_pci_remove);


#ifdef  CONFIG_PM

/**
 * usb_hcd_pci_suspend - power management suspend of a PCI-based HCD
 * @dev: USB Host Controller being suspended
 * @state: state that the controller is going into
 *
 * Store this function in the HCD's struct pci_driver as suspend().
 */

int usb_hcd_pci_suspend (struct pci_dev *dev, u32 state)
{
        struct usb_hcd          *hcd;
        int                     retval = 0;

        hcd = pci_get_drvdata(dev);
        dev_dbg (hcd->controller, "suspend D%d --> D%d\n",
                        dev->current_state, state);

        switch (hcd->state) {
        case USB_STATE_HALT:
                dev_dbg (hcd->controller, "halted; hcd not suspended\n");
                break;
        case USB_STATE_SUSPENDED:
                dev_dbg (hcd->controller, "hcd already suspended\n");
                break;
        default:
                /* remote wakeup needs hub->suspend() cooperation */
                // pci_enable_wake (dev, 3, 1);

                pci_save_state (dev, hcd->pci_state);

                /* driver may want to disable DMA etc */
                hcd->state = USB_STATE_QUIESCING;
                retval = hcd->driver->suspend (hcd, state);
                if (retval)
                        dev_dbg (hcd->controller, "suspend fail, retval %d\n",
                                        retval);
                else
                        hcd->state = USB_STATE_SUSPENDED;
        }

        pci_set_power_state (dev, state);
        return retval;
}
EXPORT_SYMBOL (usb_hcd_pci_suspend);

/**
 * usb_hcd_pci_resume - power management resume of a PCI-based HCD
 * @dev: USB Host Controller being resumed
 *
 * Store this function in the HCD's struct pci_driver as resume().
 */

int usb_hcd_pci_resume (struct pci_dev *dev)
{
        struct usb_hcd          *hcd;
        int                     retval;

        hcd = pci_get_drvdata(dev);
        dev_dbg (hcd->controller, "resume from state D%d\n",
                        dev->current_state);

        if (hcd->state != USB_STATE_SUSPENDED) {
                dev_dbg (hcd->controller, "can't resume, not suspended!\n");
                return -EL3HLT;
        }
        hcd->state = USB_STATE_RESUMING;

        pci_set_power_state (dev, 0);
        pci_restore_state (dev, hcd->pci_state);

        /* remote wakeup needs hub->suspend() cooperation */
        // pci_enable_wake (dev, 3, 0);

        retval = hcd->driver->resume (hcd);
        if (!HCD_IS_RUNNING (hcd->state)) {
                dev_dbg (hcd->controller, "resume fail, retval %d\n", retval);
                usb_hc_died (hcd);
        }

        return retval;
}
EXPORT_SYMBOL (usb_hcd_pci_resume);

#endif  /* CONFIG_PM */