ehci_ixp4xx.c revision 228483
134229Speter/*- 258478Sobrien * Copyright (c) 2008 Sam Leffler. All rights reserved. 334229Speter * 434229Speter * Redistribution and use in source and binary forms, with or without 551408Sobrien * modification, are permitted provided that the following conditions 634229Speter * are met: 752112Sobrien * 1. Redistributions of source code must retain the above copyright 818334Speter * notice, this list of conditions and the following disclaimer. 918334Speter * 2. Redistributions in binary form must reproduce the above copyright 1018334Speter * notice, this list of conditions and the following disclaimer in the 1118334Speter * documentation and/or other materials provided with the distribution. 1218334Speter * 1318334Speter * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 1418334Speter * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 1518334Speter * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 1618334Speter * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 1718334Speter * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 1818334Speter * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1918334Speter * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2018334Speter * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2118334Speter * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2218334Speter * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2318334Speter */ 2418334Speter 2518334Speter/* 2651408Sobrien * IXP435 attachment driver for the USB Enhanced Host Controller. 2718334Speter */ 2858478Sobrien 2958478Sobrien#include <sys/cdefs.h> 3058478Sobrien__FBSDID("$FreeBSD: head/sys/dev/usb/controller/ehci_ixp4xx.c 228483 2011-12-14 00:28:54Z hselasky $"); 3158478Sobrien 3251408Sobrien#include "opt_bus.h" 3358478Sobrien 3458478Sobrien#include <sys/stdint.h> 3558478Sobrien#include <sys/stddef.h> 3658478Sobrien#include <sys/param.h> 3751408Sobrien#include <sys/queue.h> 3858478Sobrien#include <sys/types.h> 3958478Sobrien#include <sys/systm.h> 4058478Sobrien#include <sys/kernel.h> 4158478Sobrien#include <sys/bus.h> 4258478Sobrien#include <sys/module.h> 4358478Sobrien#include <sys/lock.h> 4458478Sobrien#include <sys/mutex.h> 4558478Sobrien#include <sys/condvar.h> 4658478Sobrien#include <sys/sysctl.h> 4758478Sobrien#include <sys/sx.h> 4858478Sobrien#include <sys/unistd.h> 4958478Sobrien#include <sys/callout.h> 5058478Sobrien#include <sys/malloc.h> 5158478Sobrien#include <sys/priv.h> 5258478Sobrien 5358478Sobrien#include <dev/usb/usb.h> 5458478Sobrien#include <dev/usb/usbdi.h> 5558478Sobrien 5658478Sobrien#include <dev/usb/usb_core.h> 5758478Sobrien#include <dev/usb/usb_busdma.h> 5858478Sobrien#include <dev/usb/usb_process.h> 5958478Sobrien#include <dev/usb/usb_util.h> 6058478Sobrien 6158478Sobrien#include <dev/usb/usb_controller.h> 6258478Sobrien#include <dev/usb/usb_bus.h> 6358478Sobrien#include <dev/usb/controller/ehci.h> 6458478Sobrien#include <dev/usb/controller/ehcireg.h> 6558478Sobrien 6658478Sobrien#include <arm/xscale/ixp425/ixp425reg.h> 6758478Sobrien#include <arm/xscale/ixp425/ixp425var.h> 6858478Sobrien 6958478Sobrien#define EHCI_VENDORID_IXP4XX 0x42fa05 7058478Sobrien#define EHCI_HC_DEVSTR "IXP4XX Integrated USB 2.0 controller" 7158478Sobrien 7258478Sobrienstruct ixp_ehci_softc { 7358478Sobrien ehci_softc_t base; /* storage for EHCI code */ 7458478Sobrien bus_space_tag_t iot; 7558478Sobrien bus_space_handle_t ioh; 7658478Sobrien struct bus_space tag; /* tag for private bus space ops */ 7758478Sobrien}; 7858478Sobrien 7958478Sobrienstatic device_attach_t ehci_ixp_attach; 8058478Sobrienstatic device_detach_t ehci_ixp_detach; 8158478Sobrien 8258478Sobrienstatic uint8_t ehci_bs_r_1(void *, bus_space_handle_t, bus_size_t); 8358478Sobrienstatic void ehci_bs_w_1(void *, bus_space_handle_t, bus_size_t, u_int8_t); 8458478Sobrienstatic uint16_t ehci_bs_r_2(void *, bus_space_handle_t, bus_size_t); 8558478Sobrienstatic void ehci_bs_w_2(void *, bus_space_handle_t, bus_size_t, uint16_t); 8658478Sobrienstatic uint32_t ehci_bs_r_4(void *, bus_space_handle_t, bus_size_t); 8758478Sobrienstatic void ehci_bs_w_4(void *, bus_space_handle_t, bus_size_t, uint32_t); 8858478Sobrien 8958478Sobrienstatic int 9058478Sobrienehci_ixp_probe(device_t self) 9158478Sobrien{ 9258478Sobrien 9358478Sobrien device_set_desc(self, EHCI_HC_DEVSTR); 9458478Sobrien 9558478Sobrien return (BUS_PROBE_DEFAULT); 9658478Sobrien} 9758478Sobrien 9858478Sobrienstatic int 9958478Sobrienehci_ixp_attach(device_t self) 10058478Sobrien{ 10158478Sobrien struct ixp_ehci_softc *isc = device_get_softc(self); 10258478Sobrien ehci_softc_t *sc = &isc->base; 10358478Sobrien int err; 10458478Sobrien int rid; 10558478Sobrien 10658478Sobrien /* initialise some bus fields */ 10758478Sobrien sc->sc_bus.parent = self; 10858478Sobrien sc->sc_bus.devices = sc->sc_devices; 10958478Sobrien sc->sc_bus.devices_max = EHCI_MAX_DEVICES; 11058478Sobrien 11158478Sobrien /* get all DMA memory */ 11258478Sobrien if (usb_bus_mem_alloc_all(&sc->sc_bus, 11358478Sobrien USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) { 11458478Sobrien return (ENOMEM); 11558478Sobrien } 11658478Sobrien 11758478Sobrien /* NB: hints fix the memory location and irq */ 11858478Sobrien 11958478Sobrien rid = 0; 12058478Sobrien sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE); 12158478Sobrien if (!sc->sc_io_res) { 12258478Sobrien device_printf(self, "Could not map memory\n"); 12358478Sobrien goto error; 12458478Sobrien } 12558478Sobrien 12658478Sobrien /* 12758478Sobrien * Craft special resource for bus space ops that handle 12858478Sobrien * byte-alignment of non-word addresses. Also, since 12958478Sobrien * we're already intercepting bus space ops we handle 13058478Sobrien * the register window offset that could otherwise be 13134229Speter * done with bus_space_subregion. 13234229Speter */ 13334229Speter isc->iot = rman_get_bustag(sc->sc_io_res); 13418349Speter isc->tag.bs_cookie = isc->iot; 13534229Speter /* read single */ 13634229Speter isc->tag.bs_r_1 = ehci_bs_r_1, 13734229Speter isc->tag.bs_r_2 = ehci_bs_r_2, 13834229Speter isc->tag.bs_r_4 = ehci_bs_r_4, 13918349Speter /* write (single) */ 14034229Speter isc->tag.bs_w_1 = ehci_bs_w_1, 14152112Sobrien isc->tag.bs_w_2 = ehci_bs_w_2, 14268601Sobrien isc->tag.bs_w_4 = ehci_bs_w_4, 14368601Sobrien 14468601Sobrien sc->sc_io_tag = &isc->tag; 14568601Sobrien sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 14668601Sobrien sc->sc_io_size = IXP435_USB1_SIZE - 0x100; 14768601Sobrien 14818349Speter rid = 0; 14958478Sobrien sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 15058478Sobrien RF_ACTIVE); 15158478Sobrien if (sc->sc_irq_res == NULL) { 15258478Sobrien device_printf(self, "Could not allocate irq\n"); 15358478Sobrien goto error; 15434229Speter } 15534229Speter sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 15634229Speter if (!sc->sc_bus.bdev) { 15734229Speter device_printf(self, "Could not add USB device\n"); 15834229Speter goto error; 15918349Speter } 16058478Sobrien device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 16158478Sobrien device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR); 16258478Sobrien 16318349Speter sprintf(sc->sc_vendor, "Intel"); 16458478Sobrien 16558478Sobrien 16658478Sobrien err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 16718349Speter NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 16858478Sobrien if (err) { 16958478Sobrien device_printf(self, "Could not setup irq, %d\n", err); 17058478Sobrien sc->sc_intr_hdl = NULL; 17151408Sobrien goto error; 17258478Sobrien } 17358478Sobrien 17458478Sobrien /* 17518349Speter * Arrange to force Host mode, select big-endian byte alignment, 17658478Sobrien * and arrange to not terminate reset operations (the adapter 17758478Sobrien * will ignore it if we do but might as well save a reg write). 17858478Sobrien * Also, the controller has an embedded Transaction Translator 17958478Sobrien * which means port speed must be read from the Port Status 18058478Sobrien * register following a port enable. 18158478Sobrien */ 18258478Sobrien sc->sc_flags |= EHCI_SCFLG_TT 18358478Sobrien | EHCI_SCFLG_SETMODE 18458478Sobrien | EHCI_SCFLG_BIGEDESC 18558478Sobrien | EHCI_SCFLG_BIGEMMIO 18658478Sobrien | EHCI_SCFLG_NORESTERM 18758478Sobrien ; 18858478Sobrien 18958478Sobrien err = ehci_init(sc); 19058478Sobrien if (!err) { 19158478Sobrien err = device_probe_and_attach(sc->sc_bus.bdev); 19258478Sobrien } 19358478Sobrien if (err) { 19458478Sobrien device_printf(self, "USB init failed err=%d\n", err); 19558478Sobrien goto error; 19658478Sobrien } 19758478Sobrien return (0); 19858478Sobrien 19958478Sobrienerror: 20058478Sobrien ehci_ixp_detach(self); 20158478Sobrien return (ENXIO); 20258478Sobrien} 20358478Sobrien 20458478Sobrienstatic int 20558478Sobrienehci_ixp_detach(device_t self) 20658478Sobrien{ 20758478Sobrien struct ixp_ehci_softc *isc = device_get_softc(self); 20858478Sobrien ehci_softc_t *sc = &isc->base; 20958478Sobrien device_t bdev; 21073325Sobrien int err; 21173325Sobrien 21258478Sobrien if (sc->sc_bus.bdev) { 21358478Sobrien bdev = sc->sc_bus.bdev; 21458478Sobrien device_detach(bdev); 21558478Sobrien device_delete_child(self, bdev); 21658478Sobrien } 21758478Sobrien /* during module unload there are lots of children leftover */ 21858478Sobrien device_delete_children(self); 21958478Sobrien 22058478Sobrien if (sc->sc_irq_res && sc->sc_intr_hdl) { 22158478Sobrien /* 22258478Sobrien * only call ehci_detach() after ehci_init() 22358478Sobrien */ 22458478Sobrien ehci_detach(sc); 22558478Sobrien 22658478Sobrien err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 22758478Sobrien 22858478Sobrien if (err) 22958478Sobrien /* XXX or should we panic? */ 23058478Sobrien device_printf(self, "Could not tear down irq, %d\n", 23158478Sobrien err); 23258478Sobrien sc->sc_intr_hdl = NULL; 23358478Sobrien } 23458478Sobrien 23558478Sobrien if (sc->sc_irq_res) { 23658478Sobrien bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 23758478Sobrien sc->sc_irq_res = NULL; 23858478Sobrien } 23958478Sobrien if (sc->sc_io_res) { 24058478Sobrien bus_release_resource(self, SYS_RES_MEMORY, 0, 24158478Sobrien sc->sc_io_res); 24258478Sobrien sc->sc_io_res = NULL; 24358478Sobrien } 24458478Sobrien usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc); 24558478Sobrien 24658478Sobrien return (0); 24758478Sobrien} 24858478Sobrien 24958478Sobrien/* 25058478Sobrien * Bus space accessors for PIO operations. 25158478Sobrien */ 25258478Sobrien 25358478Sobrienstatic uint8_t 25458478Sobrienehci_bs_r_1(void *t, bus_space_handle_t h, bus_size_t o) 25558478Sobrien{ 25658478Sobrien return bus_space_read_1((bus_space_tag_t) t, h, 25758478Sobrien 0x100 + (o &~ 3) + (3 - (o & 3))); 25858478Sobrien} 25958478Sobrien 26058478Sobrienstatic void 26158478Sobrienehci_bs_w_1(void *t, bus_space_handle_t h, bus_size_t o, u_int8_t v) 26258478Sobrien{ 26358478Sobrien panic("%s", __func__); 26458478Sobrien} 26558478Sobrien 26658478Sobrienstatic uint16_t 26758478Sobrienehci_bs_r_2(void *t, bus_space_handle_t h, bus_size_t o) 26858478Sobrien{ 26934229Speter return bus_space_read_2((bus_space_tag_t) t, h, 27034229Speter 0x100 + (o &~ 3) + (2 - (o & 3))); 27158478Sobrien} 27258478Sobrien 27358478Sobrienstatic void 27434229Speterehci_bs_w_2(void *t, bus_space_handle_t h, bus_size_t o, uint16_t v) 27518349Speter{ 27634229Speter panic("%s", __func__); 27734229Speter} 27834229Speter 27934229Speterstatic uint32_t 28034229Speterehci_bs_r_4(void *t, bus_space_handle_t h, bus_size_t o) 28158478Sobrien{ 28258478Sobrien return bus_space_read_4((bus_space_tag_t) t, h, 0x100 + o); 28358478Sobrien} 28418349Speter 28534229Speterstatic void 28658478Sobrienehci_bs_w_4(void *t, bus_space_handle_t h, bus_size_t o, uint32_t v) 28758478Sobrien{ 28858478Sobrien bus_space_write_4((bus_space_tag_t) t, h, 0x100 + o, v); 28934229Speter} 29034229Speter 29152112Sobrienstatic device_method_t ehci_methods[] = { 29252112Sobrien /* Device interface */ 29318334Speter DEVMETHOD(device_probe, ehci_ixp_probe), 29458478Sobrien DEVMETHOD(device_attach, ehci_ixp_attach), 29558478Sobrien DEVMETHOD(device_detach, ehci_ixp_detach), 29658478Sobrien DEVMETHOD(device_suspend, bus_generic_suspend), 29758478Sobrien DEVMETHOD(device_resume, bus_generic_resume), 29858478Sobrien DEVMETHOD(device_shutdown, bus_generic_shutdown), 29958478Sobrien 30058478Sobrien DEVMETHOD_END 30158478Sobrien}; 30258478Sobrien 30358478Sobrienstatic driver_t ehci_driver = { 30458478Sobrien "ehci", 30558478Sobrien ehci_methods, 30658478Sobrien sizeof(struct ixp_ehci_softc), 30758478Sobrien}; 30858478Sobrien 30958478Sobrienstatic devclass_t ehci_devclass; 31058478Sobrien 31158478SobrienDRIVER_MODULE(ehci, ixp, ehci_driver, ehci_devclass, 0, 0); 31258478SobrienMODULE_DEPEND(ehci, usb, 1, 1, 1); 31358478Sobrien