text: /*-
   * Copyright (C) 2009 Yohanes Nugroho <yohanes@gmail.com>
   * based on ehci_mbus.c
   * Copyright (C) 2008 MARVELL INTERNATIONAL LTD.
   * All rights reserved.
   *
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in the
   *    documentation and/or other materials provided with the distribution.
   * 3. Neither the name of MARVELL nor the names of contributors
   *    may be used to endorse or promote products derived from this software
   *    without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   */
  
  
  #include <sys/cdefs.h>
  __FBSDID("$FreeBSD: release/9.1.0/sys/arm/econa/ehci_ebus.c 229118 2011-12-31 15:31:34Z hselasky $");
  
  #include "opt_bus.h"
  
  #include <machine/resource.h>
  
  #include <sys/stdint.h>
  #include <sys/stddef.h>
  #include <sys/param.h>
  #include <sys/queue.h>
  #include <sys/types.h>
  #include <sys/systm.h>
  #include <sys/kernel.h>
  #include <sys/bus.h>
  #include <sys/module.h>
  #include <sys/lock.h>
  #include <sys/mutex.h>
  #include <sys/condvar.h>
  #include <sys/sysctl.h>
  #include <sys/sx.h>
  #include <sys/unistd.h>
  #include <sys/callout.h>
  #include <sys/malloc.h>
  #include <sys/priv.h>
  
  #include <sys/rman.h>
  
  #include <dev/usb/usb.h>
  #include <dev/usb/usbdi.h>
  
  #include <dev/usb/usb_core.h>
  #include <dev/usb/usb_busdma.h>
  #include <dev/usb/usb_process.h>
  #include <dev/usb/usb_util.h>
  
  #include <dev/usb/usb_controller.h>
  #include <dev/usb/usb_bus.h>
  #include <dev/usb/controller/ehci.h>
  #include <dev/usb/controller/ehcireg.h>
  
  
  static device_attach_t ehci_ebus_attach;
  static device_detach_t ehci_ebus_detach;
  
  static void *ih_err;
  
  #define	EHCI_HC_DEVSTR "CNS11XX USB EHCI"
  #define	USB_BRIDGE_INTR_MASK   0x214
  
  static int
  ehci_ebus_probe(device_t self)
  {
  
  	device_set_desc(self, EHCI_HC_DEVSTR);
  
  	return (BUS_PROBE_DEFAULT);
  }
  
  static int
  ehci_ebus_attach(device_t self)
  {
  	ehci_softc_t *sc = device_get_softc(self);
  	bus_space_handle_t bsh;
  	int err;
  	int rid;
  
  	/* initialise some bus fields */
  	sc->sc_bus.parent = self;
  	sc->sc_bus.devices = sc->sc_devices;
  	sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
  
  	/* get all DMA memory */
  	if (usb_bus_mem_alloc_all(&sc->sc_bus,
  	    USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
  		return (ENOMEM);
  	}
  
  	sc->sc_bus.usbrev = USB_REV_2_0;
  
  	rid = 0;
  	sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY,
  	    &rid, RF_ACTIVE);
  	if (!sc->sc_io_res) {
  		device_printf(self, "Could not map memory\n");
  		goto error;
  	}
  	sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
  	bsh = rman_get_bushandle(sc->sc_io_res);
  
  	/*magic, undocumented initialization*/
  	bus_space_write_4((sc)->sc_io_tag, bsh, 0x04, 0x106);
  
  	bus_space_write_4((sc)->sc_io_tag, bsh, 0x40, (3 << 5)|0x2000);
  
  	DELAY(1000);
  
  	sc->sc_io_size =  4096;
  
  	if (bus_space_subregion(sc->sc_io_tag, bsh, 0x4000000,
  	    sc->sc_io_size, &sc->sc_io_hdl) != 0)
  		panic("%s: unable to subregion USB host registers",
  		    device_get_name(self));
  
  	rid = 0;
  	sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
  	    RF_SHAREABLE | RF_ACTIVE);
  	if (sc->sc_irq_res == NULL) {
  		device_printf(self, "Could not allocate irq\n");
  		ehci_ebus_detach(self);
  		return (ENXIO);
  	}
  
  	sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
  	if (!sc->sc_bus.bdev) {
  		device_printf(self, "Could not add USB device\n");
  		goto error;
  	}
  	device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
  	device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR);
  
  	sprintf(sc->sc_vendor, "Cavium");
  
  	err = bus_setup_intr(self,sc->sc_irq_res,
  	    INTR_TYPE_BIO | INTR_MPSAFE, NULL,
  	    (driver_intr_t *)ehci_interrupt, sc,
  	    &sc->sc_intr_hdl);
  	if (err) {
  		device_printf(self, "Could not setup error irq, %d\n", err);
  		ih_err = NULL;
  		goto error;
  	}
  
  	err = ehci_init(sc);
  	if (!err) {
  		err = device_probe_and_attach(sc->sc_bus.bdev);
  	}
  	if (err) {
  		device_printf(self, "USB init failed err=%d\n", err);
  		goto error;
  	}
  	return (0);
  
  error:
  	ehci_ebus_detach(self);
  	return (ENXIO);
  }
  
  static int
  ehci_ebus_detach(device_t self)
  {
  	ehci_softc_t *sc = device_get_softc(self);
  	device_t bdev;
  	int err;
  
  	if (sc->sc_bus.bdev) {
  		bdev = sc->sc_bus.bdev;
  		device_detach(bdev);
  		device_delete_child(self, bdev);
  	}
  	/* during module unload there are lots of children leftover */
  	device_delete_children(self);
  
  	/*
  	 * disable interrupts that might have been switched on in
  	 * ehci_ebus_attach()
  	 */
  	if (sc->sc_io_res) {
  		EWRITE4(sc, USB_BRIDGE_INTR_MASK, 0);
  	}
  	if (sc->sc_irq_res && sc->sc_intr_hdl) {
  		/*
  		 * only call ehci_detach() after ehci_init()
  		 */
  		ehci_detach(sc);
  
  		err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
  
  		if (err)
  			/* XXX or should we panic? */
  			device_printf(self, "Could not tear down irq, %d\n",
  			    err);
  		sc->sc_intr_hdl = NULL;
  	}
  	if (sc->sc_irq_res) {
  		bus_release_resource(self, SYS_RES_IRQ, 1, sc->sc_irq_res);
  		sc->sc_irq_res = NULL;
  	}
  	if (sc->sc_io_res) {
  		bus_release_resource(self, SYS_RES_MEMORY, 0,
  		    sc->sc_io_res);
  		sc->sc_io_res = NULL;
  	}
  	usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
  
  	return (0);
  }
  
  static device_method_t ehci_methods[] = {
  	/* Device interface */
  	DEVMETHOD(device_probe, ehci_ebus_probe),
  	DEVMETHOD(device_attach, ehci_ebus_attach),
  	DEVMETHOD(device_detach, ehci_ebus_detach),
  	DEVMETHOD(device_suspend, bus_generic_suspend),
  	DEVMETHOD(device_resume, bus_generic_resume),
  	DEVMETHOD(device_shutdown, bus_generic_shutdown),
  
  	DEVMETHOD_END
  };
  
  static driver_t ehci_driver = {
  	.name = "ehci",
  	.methods = ehci_methods,
  	.size = sizeof(ehci_softc_t),
  };
  
  static devclass_t ehci_devclass;
  
  DRIVER_MODULE(ehci, econaarm, ehci_driver, ehci_devclass, 0, 0);
  MODULE_DEPEND(ehci, usb, 1, 1, 1);
  