Differential D5481 Diff 13840 sys/dev/usb/controller/generic_ohci.c

Changeset View

Standalone View

sys/dev/usb/controller/generic_ohci.c

This file was added.

				/*-
				* Copyright (c) 2006 M. Warner Losh. All rights reserved.
				* Copyright (c) 2016 Emmanuel Vadot <manu@bidouilliste.com>
				* 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.
				*
				* THIS SOFTWARE IS PROVIDED BY THE 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 THE 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.
				*/

				/*
				* Generic OHCI driver based on AT91 OHCI
				*/

				#include <sys/cdefs.h>
				__FBSDID("$FreeBSD$");

				#include "opt_bus.h"
				jmcneill_invisible.caUnsubmitted Done Inline Actions Is this needed? jmcneill_invisible.ca: Is this needed?
				manu_bidouilliste.comAuthorUnsubmitted Done Inline Actions Leftover from the convertion, thanks manu_bidouilliste.com: Leftover from the convertion, thanks

				#include <sys/param.h>
				#include <sys/systm.h>
				#include <sys/bus.h>
				#include <sys/rman.h>
				#include <sys/condvar.h>
				jmcneill_invisible.caUnsubmitted Done Inline Actions condvar.h might be unnecessary as well jmcneill_invisible.ca: condvar.h might be unnecessary as well
				manu_bidouilliste.comAuthorUnsubmitted Done Inline Actions It's needed by usb_busdma.h manu_bidouilliste.com: It's needed by usb_busdma.h
				#include <sys/kernel.h>
				#include <sys/module.h>

				#include <machine/bus.h>
				#include <dev/ofw/ofw_bus.h>
				#include <dev/ofw/ofw_bus_subr.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/ohci.h>
				#include <dev/usb/controller/ohcireg.h>

				#include "generic_ohci_if.h"

				static int generic_ohci_detach(device_t);

				static int
				generic_ohci_probe(device_t dev)
				{

				return (ENXIO);
				/* No ready to use as the OHCI clock must be enabled */
				#ifdef notyet
				if (!ofw_bus_status_okay(dev))
				return (ENXIO);

				if (!ofw_bus_is_compatible(dev, "generic-ohci"))
				return (ENXIO);

				device_set_desc(dev, "Generic OHCI Controller");

				return (BUS_PROBE_DEFAULT);
				#endif
				}

				static int
				generic_ohci_attach(device_t dev)
				{
				ohci_softc_t *sc;
				int err, rid;

				sc = device_get_softc(dev);
				sc->sc_bus.parent = dev;
				sc->sc_bus.devices = sc->sc_devices;
				sc->sc_bus.devices_max = OHCI_MAX_DEVICES;
				sc->sc_bus.dma_bits = 32;

				/* get all DMA memory */
				if (usb_bus_mem_alloc_all(&sc->sc_bus,
				USB_GET_DMA_TAG(dev), &ohci_iterate_hw_softc)) {
				return (ENOMEM);
				}

				rid = 0;
				sc->sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
				&rid, RF_ACTIVE);
				if (!(sc->sc_io_res)) {
				err = ENOMEM;
				goto error;
				}

				sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
				sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
				sc->sc_io_size = rman_get_size(sc->sc_io_res);

				rid = 0;
				sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
				RF_ACTIVE);
				if (!(sc->sc_irq_res)) {
				goto error;
				}
				sc->sc_bus.bdev = device_add_child(dev, "usbus", -1);
				if (!(sc->sc_bus.bdev)) {
				goto error;
				}
				device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);

				strlcpy(sc->sc_vendor, "Generic", sizeof(sc->sc_vendor));

				err = bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_BIO \| INTR_MPSAFE,
				NULL, (driver_intr_t *)ohci_interrupt, sc, &sc->sc_intr_hdl);
				if (err) {
				sc->sc_intr_hdl = NULL;
				goto error;
				}

				if (GENERIC_OHCI_INIT(dev) != 0) {
				err = ENXIO;
				goto error;
				}

				err = ohci_init(sc);
				if (!err) {
				err = device_probe_and_attach(sc->sc_bus.bdev);
				}
				jmcneillUnsubmitted Done Inline Actions You should capture the clk and hwreset handles at attach time, otherwise you will leak the references on detach. jmcneill: You should capture the clk and hwreset handles at attach time, otherwise you will leak the…
				if (err) {
				goto error;
				}

				return (0);
				error:
				generic_ohci_detach(dev);
				return (ENXIO);
				}

				static int
				generic_ohci_detach(device_t dev)
				{
				ohci_softc_t *sc = device_get_softc(dev);
				device_t bdev;
				int err;

				if (sc->sc_bus.bdev) {
				bdev = sc->sc_bus.bdev;
				device_detach(bdev);
				device_delete_child(dev, bdev);
				}

				/* during module unload there are lots of children leftover */
				device_delete_children(dev);

				/*
				* Put the controller into reset, then disable clocks and do
				* the MI tear down. We have to disable the clocks/hardware
				* after we do the rest of the teardown. We also disable the
				* clocks in the opposite order we acquire them, but that
				* doesn't seem to be absolutely necessary. We free up the
				* clocks after we disable them, so the system could, in
				* theory, reuse them.
				*/
				bus_space_write_4(sc->sc_io_tag, sc->sc_io_hdl, OHCI_CONTROL, 0);

				if (GENERIC_OHCI_DEINIT(dev) != 0)
				return (ENXIO);

				if (sc->sc_irq_res && sc->sc_intr_hdl) {
				/*
				* only call ohci_detach() after ohci_init()
				*/
				ohci_detach(sc);
				jmcneill_invisible.caUnsubmitted Done Inline Actions ohci_detach writes to some registers, I don't think you want to be doing that after you've disabled clocks jmcneill_invisible.ca: ohci_detach writes to some registers, I don't think you want to be doing that after you've…

				err = bus_teardown_intr(dev, sc->sc_irq_res, sc->sc_intr_hdl);
				sc->sc_intr_hdl = NULL;
				}
				if (sc->sc_irq_res) {
				bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_irq_res);
				sc->sc_irq_res = NULL;
				}
				if (sc->sc_io_res) {
				bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_io_res);
				sc->sc_io_res = NULL;
				}
				usb_bus_mem_free_all(&sc->sc_bus, &ohci_iterate_hw_softc);

				return (0);
				}

				static device_method_t ohci_methods[] = {
				/* Device interface */
				/* DEVMETHOD(device_probe, generic_ohci_probe), */
				DEVMETHOD(device_attach, generic_ohci_attach),
				DEVMETHOD(device_detach, generic_ohci_detach),

				DEVMETHOD(device_suspend, bus_generic_suspend),
				DEVMETHOD(device_resume, bus_generic_resume),
				DEVMETHOD(device_shutdown, bus_generic_shutdown),

				DEVMETHOD_END
				};

				driver_t ohci_driver = {
				.name = "ohci",
				.methods = ohci_methods,
				.size = sizeof(ohci_softc_t),
				};

				static devclass_t ohci_devclass;

				DRIVER_MODULE(ohci, simplebus, ohci_driver, ohci_devclass, 0, 0);
				MODULE_DEPEND(ohci, usb, 1, 1, 1);