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