sys/dev/altera/jtag_uart/altera_jtag_uart_fdt.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2012 Robert N. M. Watson
   5  * All rights reserved.
   6  *
   7  * This software was developed by SRI International and the University of
   8  * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
   9  * ("CTSRD"), as part of the DARPA CRASH research programme.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 #include <sys/param.h>
  37 #include <sys/bus.h>
  38 #include <sys/condvar.h>
  39 #include <sys/conf.h>
  40 #include <sys/bio.h>
  41 #include <sys/kernel.h>
  42 #include <sys/lock.h>
  43 #include <sys/malloc.h>
  44 #include <sys/module.h>
  45 #include <sys/mutex.h>
  46 #include <sys/rman.h>
  47 #include <sys/systm.h>
  48 #include <sys/taskqueue.h>
  49
  50 #include <machine/bus.h>
  51 #include <machine/resource.h>
  52
  53 #include <geom/geom_disk.h>
  54
  55 #include <dev/altera/jtag_uart/altera_jtag_uart.h>
  56
  57 #include <dev/fdt/fdt_common.h>
  58 #include <dev/ofw/openfirm.h>
  59 #include <dev/ofw/ofw_bus.h>
  60 #include <dev/ofw/ofw_bus_subr.h>
  61
  62 /*
  63  * FDT bus attachment for Altera JTAG UARTs.
  64  */
  65 static int
  66 altera_jtag_uart_fdt_probe(device_t dev)
  67 {
  68
  69         if (!ofw_bus_status_okay(dev))
  70                 return (ENXIO);
  71
  72         if (ofw_bus_is_compatible(dev, "altera,jtag_uart-11_0")) {
  73                 device_set_desc(dev, "Altera JTAG UART");
  74                 return (BUS_PROBE_DEFAULT);
  75         }
  76         return (ENXIO);
  77 }
  78
  79 static int
  80 altera_jtag_uart_fdt_attach(device_t dev)
  81 {
  82         struct altera_jtag_uart_softc *sc;
  83         int error;
  84
  85         error = 0;
  86         sc = device_get_softc(dev);
  87         sc->ajus_dev = dev;
  88         sc->ajus_unit = device_get_unit(dev);
  89         sc->ajus_mem_rid = 0;
  90         sc->ajus_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
  91             &sc->ajus_mem_rid, RF_ACTIVE);
  92         if (sc->ajus_mem_res == NULL) {
  93                 device_printf(dev, "couldn't map memory\n");
  94                 error = ENXIO;
  95                 goto out;
  96         }
  97
  98         /*
  99          * Interrupt support is optional -- if we can't allocate an IRQ, then
 100          * we fall back on polling.
 101          */
 102         sc->ajus_irq_rid = 0;
 103         sc->ajus_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
 104             &sc->ajus_irq_rid, RF_ACTIVE | RF_SHAREABLE);
 105         if (sc->ajus_irq_res == NULL)
 106                 device_printf(dev,
 107                     "IRQ unavailable; selecting polled operation\n");
 108         error = altera_jtag_uart_attach(sc);
 109 out:
 110         if (error) {
 111                 if (sc->ajus_irq_res != NULL)
 112                         bus_release_resource(dev, SYS_RES_IRQ,
 113                             sc->ajus_irq_rid, sc->ajus_irq_res);
 114                 if (sc->ajus_mem_res != NULL)
 115                         bus_release_resource(dev, SYS_RES_MEMORY,
 116                             sc->ajus_mem_rid, sc->ajus_mem_res);
 117         }
 118         return (error);
 119 }
 120
 121 static int
 122 altera_jtag_uart_fdt_detach(device_t dev)
 123 {
 124         struct altera_jtag_uart_softc *sc;
 125
 126         sc = device_get_softc(dev);
 127         KASSERT(sc->ajus_mem_res != NULL, ("%s: resources not allocated",
 128             __func__));
 129
 130         altera_jtag_uart_detach(sc);
 131         bus_release_resource(dev, SYS_RES_IRQ, sc->ajus_irq_rid,
 132             sc->ajus_irq_res);
 133         bus_release_resource(dev, SYS_RES_MEMORY, sc->ajus_mem_rid,
 134             sc->ajus_mem_res);
 135         return (0);
 136 }
 137
 138 static device_method_t altera_jtag_uart_fdt_methods[] = {
 139         DEVMETHOD(device_probe,         altera_jtag_uart_fdt_probe),
 140         DEVMETHOD(device_attach,        altera_jtag_uart_fdt_attach),
 141         DEVMETHOD(device_detach,        altera_jtag_uart_fdt_detach),
 142         { 0, 0 }
 143 };
 144
 145 static driver_t altera_jtag_uart_fdt_driver = {
 146         "altera_jtag_uart",
 147         altera_jtag_uart_fdt_methods,
 148         sizeof(struct altera_jtag_uart_softc),
 149 };
 150
 151 DRIVER_MODULE(altera_jtag_uart, simplebus, altera_jtag_uart_fdt_driver,
 152     altera_jtag_uart_devclass, 0, 0);