1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 #include <sys/param.h>
35 #include <sys/bus.h>
36 #include <sys/condvar.h>
37 #include <sys/conf.h>
38 #include <sys/bio.h>
39 #include <sys/kernel.h>
40 #include <sys/lock.h>
41 #include <sys/malloc.h>
42 #include <sys/module.h>
43 #include <sys/mutex.h>
44 #include <sys/rman.h>
45 #include <sys/systm.h>
46 #include <sys/taskqueue.h>
47 
48 #include <machine/bus.h>
49 #include <machine/resource.h>
50 
51 #include <geom/geom_disk.h>
52 
53 #include <dev/altera/jtag_uart/altera_jtag_uart.h>
54 
55 /*
56  * Nexus bus attachment for Altera JTAG UARTs.  Appropriate for most Altera
57  * FPGA SoC-style configurations in which the IP core will be exposed to the
58  * processor via a memory-mapped Avalon bus.
59  */
60 static int
61 altera_jtag_uart_nexus_probe(device_t dev)
62 {
63 
64 	device_set_desc(dev, "Altera JTAG UART");
65 	return (BUS_PROBE_NOWILDCARD);
66 }
67 
68 static int
69 altera_jtag_uart_nexus_attach(device_t dev)
70 {
71 	struct altera_jtag_uart_softc *sc;
72 	int error;
73 
74 	error = 0;
75 	sc = device_get_softc(dev);
76 	sc->ajus_dev = dev;
77 	sc->ajus_unit = device_get_unit(dev);
78 	sc->ajus_mem_rid = 0;
79 	sc->ajus_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
80 	    &sc->ajus_mem_rid, RF_ACTIVE);
81 	if (sc->ajus_mem_res == NULL) {
82 		device_printf(dev, "couldn't map memory\n");
83 		error = ENXIO;
84 		goto out;
85 	}
86 
87 	/*
88 	 * Interrupt support is optional -- if we can't allocate an IRQ, then
89 	 * we fall back on polling.
90 	 */
91 	sc->ajus_irq_rid = 0;
92 	sc->ajus_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
93 	    &sc->ajus_irq_rid, RF_ACTIVE | RF_SHAREABLE);
94 	if (sc->ajus_irq_res == NULL)
95 		device_printf(dev,
96 		    "IRQ unavailable; selecting polled operation\n");
97 	error = altera_jtag_uart_attach(sc);
98 out:
99 	if (error) {
100 		if (sc->ajus_irq_res != NULL)
101 			bus_release_resource(dev, SYS_RES_IRQ,
102 			    sc->ajus_irq_rid, sc->ajus_irq_res);
103 		if (sc->ajus_mem_res != NULL)
104 			bus_release_resource(dev, SYS_RES_MEMORY,
105 			    sc->ajus_mem_rid, sc->ajus_mem_res);
106 	}
107 	return (error);
108 }
109 
110 static int
111 altera_jtag_uart_nexus_detach(device_t dev)
112 {
113 	struct altera_jtag_uart_softc *sc;
114 
115 	sc = device_get_softc(dev);
116 	KASSERT(sc->ajus_mem_res != NULL, ("%s: resources not allocated",
117 	    __func__));
118 
119 	altera_jtag_uart_detach(sc);
120 	bus_release_resource(dev, SYS_RES_IRQ, sc->ajus_irq_rid,
121 	    sc->ajus_irq_res);
122 	bus_release_resource(dev, SYS_RES_MEMORY, sc->ajus_mem_rid,
123 	    sc->ajus_mem_res);
124 	return (0);
125 }
126 
127 static device_method_t altera_jtag_uart_nexus_methods[] = {
128 	DEVMETHOD(device_probe,		altera_jtag_uart_nexus_probe),
129 	DEVMETHOD(device_attach,	altera_jtag_uart_nexus_attach),
130 	DEVMETHOD(device_detach,	altera_jtag_uart_nexus_detach),
131 	{ 0, 0 }
132 };
133 
134 static driver_t altera_jtag_uart_nexus_driver = {
135 	"altera_jtag_uart",
136 	altera_jtag_uart_nexus_methods,
137 	sizeof(struct altera_jtag_uart_softc),
138 };
139 
140 DRIVER_MODULE(altera_jtag_uart, nexus, altera_jtag_uart_nexus_driver, 0, 0);
141