xref: /freebsd/sys/dev/spibus/spibus.c (revision c6889cbf664ecddf7fdce7c6d3c90a282c1b5d98)
146b39c90SWarner Losh /*-
2f86e6000SWarner Losh  * Copyright (c) 2006 M. Warner Losh <imp@FreeBSD.org>
346b39c90SWarner Losh  *
446b39c90SWarner Losh  * Redistribution and use in source and binary forms, with or without
546b39c90SWarner Losh  * modification, are permitted provided that the following conditions
646b39c90SWarner Losh  * are met:
746b39c90SWarner Losh  * 1. Redistributions of source code must retain the above copyright
846b39c90SWarner Losh  *    notice, this list of conditions and the following disclaimer.
946b39c90SWarner Losh  * 2. Redistributions in binary form must reproduce the above copyright
1046b39c90SWarner Losh  *    notice, this list of conditions and the following disclaimer in the
1146b39c90SWarner Losh  *    documentation and/or other materials provided with the distribution.
1246b39c90SWarner Losh  *
1346b39c90SWarner Losh  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1446b39c90SWarner Losh  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1546b39c90SWarner Losh  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1646b39c90SWarner Losh  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1746b39c90SWarner Losh  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1846b39c90SWarner Losh  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1946b39c90SWarner Losh  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2046b39c90SWarner Losh  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2146b39c90SWarner Losh  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2246b39c90SWarner Losh  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2346b39c90SWarner Losh  * SUCH DAMAGE.
2446b39c90SWarner Losh  *
2546b39c90SWarner Losh  */
2646b39c90SWarner Losh 
279a795dfaSWarner Losh #include <sys/cdefs.h>
289a795dfaSWarner Losh __FBSDID("$FreeBSD$");
299a795dfaSWarner Losh 
309a795dfaSWarner Losh #include <sys/param.h>
319a795dfaSWarner Losh #include <sys/systm.h>
329a795dfaSWarner Losh #include <sys/malloc.h>
339a795dfaSWarner Losh #include <sys/module.h>
349a795dfaSWarner Losh #include <sys/kernel.h>
359a795dfaSWarner Losh #include <sys/queue.h>
36ddfc9c4cSWarner Losh #include <sys/sbuf.h>
379a795dfaSWarner Losh #include <sys/sysctl.h>
389a795dfaSWarner Losh 
399a795dfaSWarner Losh #include <sys/bus.h>
409a795dfaSWarner Losh #include <machine/bus.h>
419a795dfaSWarner Losh #include <sys/rman.h>
429a795dfaSWarner Losh #include <machine/resource.h>
439a795dfaSWarner Losh 
449a795dfaSWarner Losh #include <dev/spibus/spibusvar.h>
459a795dfaSWarner Losh #include <dev/spibus/spi.h>
469a795dfaSWarner Losh #include "spibus_if.h"
479a795dfaSWarner Losh 
489a795dfaSWarner Losh static int
499a795dfaSWarner Losh spibus_probe(device_t dev)
509a795dfaSWarner Losh {
51c1ec6ac5SIan Lepore 
52c1ec6ac5SIan Lepore 	device_set_desc(dev, "SPI bus");
53c1ec6ac5SIan Lepore 	return (BUS_PROBE_DEFAULT);
549a795dfaSWarner Losh }
559a795dfaSWarner Losh 
569a795dfaSWarner Losh static int
579a795dfaSWarner Losh spibus_attach(device_t dev)
589a795dfaSWarner Losh {
599a795dfaSWarner Losh 	struct spibus_softc *sc = SPIBUS_SOFTC(dev);
609a795dfaSWarner Losh 
619a795dfaSWarner Losh 	sc->dev = dev;
629a795dfaSWarner Losh 	bus_enumerate_hinted_children(dev);
639a795dfaSWarner Losh 	return (bus_generic_attach(dev));
649a795dfaSWarner Losh }
659a795dfaSWarner Losh 
669a795dfaSWarner Losh /*
679a795dfaSWarner Losh  * Since this is not a self-enumerating bus, and since we always add
689a795dfaSWarner Losh  * children in attach, we have to always delete children here.
699a795dfaSWarner Losh  */
709a795dfaSWarner Losh static int
719a795dfaSWarner Losh spibus_detach(device_t dev)
729a795dfaSWarner Losh {
731e55a130SVladimir Kondratyev 	return (device_delete_children(dev));
749a795dfaSWarner Losh }
759a795dfaSWarner Losh 
769a795dfaSWarner Losh static int
779a795dfaSWarner Losh spibus_suspend(device_t dev)
789a795dfaSWarner Losh {
799a795dfaSWarner Losh 	return (bus_generic_suspend(dev));
809a795dfaSWarner Losh }
819a795dfaSWarner Losh 
829a795dfaSWarner Losh static
839a795dfaSWarner Losh int
849a795dfaSWarner Losh spibus_resume(device_t dev)
859a795dfaSWarner Losh {
869a795dfaSWarner Losh 	return (bus_generic_resume(dev));
879a795dfaSWarner Losh }
889a795dfaSWarner Losh 
899a795dfaSWarner Losh static int
909a795dfaSWarner Losh spibus_print_child(device_t dev, device_t child)
919a795dfaSWarner Losh {
929a795dfaSWarner Losh 	struct spibus_ivar *devi = SPIBUS_IVAR(child);
939a795dfaSWarner Losh 	int retval = 0;
949a795dfaSWarner Losh 
959a795dfaSWarner Losh 	retval += bus_print_child_header(dev, child);
969a795dfaSWarner Losh 	retval += printf(" at cs %d", devi->cs);
97f3e8760fSAdrian Chadd 	retval += printf(" mode %d", devi->mode);
984dd8db62SEmmanuel Vadot 	retval += resource_list_print_type(&devi->rl, "irq",
994dd8db62SEmmanuel Vadot 	    SYS_RES_IRQ, "%jd");
1009a795dfaSWarner Losh 	retval += bus_print_child_footer(dev, child);
1019a795dfaSWarner Losh 
1029a795dfaSWarner Losh 	return (retval);
1039a795dfaSWarner Losh }
1049a795dfaSWarner Losh 
1059a795dfaSWarner Losh static void
1069a795dfaSWarner Losh spibus_probe_nomatch(device_t bus, device_t child)
1079a795dfaSWarner Losh {
1089a795dfaSWarner Losh 	struct spibus_ivar *devi = SPIBUS_IVAR(child);
1099a795dfaSWarner Losh 
110f73628e7SMichael Zhilin 	device_printf(bus, "<unknown card> at cs %d mode %d\n", devi->cs,
111f73628e7SMichael Zhilin 	    devi->mode);
1129a795dfaSWarner Losh 	return;
1139a795dfaSWarner Losh }
1149a795dfaSWarner Losh 
1159a795dfaSWarner Losh static int
116ddfc9c4cSWarner Losh spibus_child_location(device_t bus, device_t child, struct sbuf *sb)
1179a795dfaSWarner Losh {
1189a795dfaSWarner Losh 	struct spibus_ivar *devi = SPIBUS_IVAR(child);
1191fcf4de0SIan Lepore 	int cs;
1209a795dfaSWarner Losh 
1211fcf4de0SIan Lepore 	cs = devi->cs & ~SPIBUS_CS_HIGH; /* trim 'cs high' bit */
122ddfc9c4cSWarner Losh 	sbuf_printf(sb, "bus=%d cs=%d", device_get_unit(bus), cs);
1239a795dfaSWarner Losh 	return (0);
1249a795dfaSWarner Losh }
1259a795dfaSWarner Losh 
1269a795dfaSWarner Losh static int
1279ef5c83cSRuslan Bukin spibus_read_ivar(device_t bus, device_t child, int which, uintptr_t *result)
1289a795dfaSWarner Losh {
1299a795dfaSWarner Losh 	struct spibus_ivar *devi = SPIBUS_IVAR(child);
1309a795dfaSWarner Losh 
1319a795dfaSWarner Losh 	switch (which) {
1329a795dfaSWarner Losh 	default:
1339a795dfaSWarner Losh 		return (EINVAL);
1349a795dfaSWarner Losh 	case SPIBUS_IVAR_CS:
1359a795dfaSWarner Losh 		*(uint32_t *)result = devi->cs;
1369a795dfaSWarner Losh 		break;
137f3e8760fSAdrian Chadd 	case SPIBUS_IVAR_MODE:
138f3e8760fSAdrian Chadd 		*(uint32_t *)result = devi->mode;
139f3e8760fSAdrian Chadd 		break;
140f3e8760fSAdrian Chadd 	case SPIBUS_IVAR_CLOCK:
141f3e8760fSAdrian Chadd 		*(uint32_t *)result = devi->clock;
14263b92359SAdrian Chadd 		break;
1433c086734SVal Packett 	case SPIBUS_IVAR_CS_DELAY:
1443c086734SVal Packett 		*(uint32_t *)result = devi->cs_delay;
1453c086734SVal Packett 		break;
1469a795dfaSWarner Losh 	}
1479a795dfaSWarner Losh 	return (0);
1489a795dfaSWarner Losh }
1499a795dfaSWarner Losh 
150392bffb9SIan Lepore static int
151392bffb9SIan Lepore spibus_write_ivar(device_t bus, device_t child, int which, uintptr_t value)
152392bffb9SIan Lepore {
153392bffb9SIan Lepore 	struct spibus_ivar *devi = SPIBUS_IVAR(child);
154392bffb9SIan Lepore 
155392bffb9SIan Lepore 	if (devi == NULL || device_get_parent(child) != bus)
156392bffb9SIan Lepore 		return (EDOOFUS);
157392bffb9SIan Lepore 
158392bffb9SIan Lepore 	switch (which) {
159392bffb9SIan Lepore 	case SPIBUS_IVAR_CLOCK:
160392bffb9SIan Lepore 		/* Any non-zero value is allowed for max clock frequency. */
161392bffb9SIan Lepore 		if (value == 0)
162392bffb9SIan Lepore 			return (EINVAL);
163392bffb9SIan Lepore 		devi->clock = (uint32_t)value;
164392bffb9SIan Lepore 		break;
165392bffb9SIan Lepore 	case SPIBUS_IVAR_CS:
166392bffb9SIan Lepore 		 /* Chip select cannot be changed. */
167392bffb9SIan Lepore 		return (EINVAL);
168392bffb9SIan Lepore 	case SPIBUS_IVAR_MODE:
169392bffb9SIan Lepore 		/* Valid SPI modes are 0-3. */
170392bffb9SIan Lepore 		if (value > 3)
171392bffb9SIan Lepore 			return (EINVAL);
172392bffb9SIan Lepore 		devi->mode = (uint32_t)value;
173392bffb9SIan Lepore 		break;
1743c086734SVal Packett 	case SPIBUS_IVAR_CS_DELAY:
1753c086734SVal Packett 		devi->cs_delay = (uint32_t)value;
1763c086734SVal Packett 		break;
177392bffb9SIan Lepore 	default:
178392bffb9SIan Lepore 		return (EINVAL);
179392bffb9SIan Lepore 	}
180392bffb9SIan Lepore 
181392bffb9SIan Lepore 	return (0);
182392bffb9SIan Lepore }
183392bffb9SIan Lepore 
1849a795dfaSWarner Losh static device_t
1853d844eddSAndriy Gapon spibus_add_child(device_t dev, u_int order, const char *name, int unit)
1869a795dfaSWarner Losh {
1879a795dfaSWarner Losh 	device_t child;
1889a795dfaSWarner Losh 	struct spibus_ivar *devi;
1899a795dfaSWarner Losh 
1909a795dfaSWarner Losh 	child = device_add_child_ordered(dev, order, name, unit);
1919a795dfaSWarner Losh 	if (child == NULL)
1929a795dfaSWarner Losh 		return (child);
1939a795dfaSWarner Losh 	devi = malloc(sizeof(struct spibus_ivar), M_DEVBUF, M_NOWAIT | M_ZERO);
19486663fabSWarner Losh 	if (devi == NULL) {
19586663fabSWarner Losh 		device_delete_child(dev, child);
1969a795dfaSWarner Losh 		return (0);
19786663fabSWarner Losh 	}
1984dd8db62SEmmanuel Vadot 	resource_list_init(&devi->rl);
1999a795dfaSWarner Losh 	device_set_ivars(child, devi);
2009a795dfaSWarner Losh 	return (child);
2019a795dfaSWarner Losh }
2029a795dfaSWarner Losh 
2039a795dfaSWarner Losh static void
2049a795dfaSWarner Losh spibus_hinted_child(device_t bus, const char *dname, int dunit)
2059a795dfaSWarner Losh {
2069a795dfaSWarner Losh 	device_t child;
2074dd8db62SEmmanuel Vadot 	int irq;
2089a795dfaSWarner Losh 	struct spibus_ivar *devi;
2099a795dfaSWarner Losh 
2109a795dfaSWarner Losh 	child = BUS_ADD_CHILD(bus, 0, dname, dunit);
2119a795dfaSWarner Losh 	devi = SPIBUS_IVAR(child);
212f3e8760fSAdrian Chadd 	devi->mode = SPIBUS_MODE_NONE;
21347a7da76SIan Lepore 	resource_int_value(dname, dunit, "clock", &devi->clock);
2149a795dfaSWarner Losh 	resource_int_value(dname, dunit, "cs", &devi->cs);
215f3e8760fSAdrian Chadd 	resource_int_value(dname, dunit, "mode", &devi->mode);
2164dd8db62SEmmanuel Vadot 	if (resource_int_value(dname, dunit, "irq", &irq) == 0) {
2174dd8db62SEmmanuel Vadot 		if (bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1) != 0)
2184dd8db62SEmmanuel Vadot 			device_printf(bus,
2194dd8db62SEmmanuel Vadot 			    "Warning: bus_set_resource() failed\n");
2204dd8db62SEmmanuel Vadot 	}
2214dd8db62SEmmanuel Vadot }
2224dd8db62SEmmanuel Vadot 
2234dd8db62SEmmanuel Vadot static struct resource_list *
2244dd8db62SEmmanuel Vadot spibus_get_resource_list(device_t bus __unused, device_t child)
2254dd8db62SEmmanuel Vadot {
2264dd8db62SEmmanuel Vadot 	struct spibus_ivar *devi;
2274dd8db62SEmmanuel Vadot 
2284dd8db62SEmmanuel Vadot 	devi = SPIBUS_IVAR(child);
2294dd8db62SEmmanuel Vadot 	return (&devi->rl);
2309a795dfaSWarner Losh }
2319a795dfaSWarner Losh 
2329a795dfaSWarner Losh static int
2339a795dfaSWarner Losh spibus_transfer_impl(device_t dev, device_t child, struct spi_command *cmd)
2349a795dfaSWarner Losh {
23586663fabSWarner Losh 	return (SPIBUS_TRANSFER(device_get_parent(dev), child, cmd));
2369a795dfaSWarner Losh }
2379a795dfaSWarner Losh 
2389a795dfaSWarner Losh static device_method_t spibus_methods[] = {
2399a795dfaSWarner Losh 	/* Device interface */
2409a795dfaSWarner Losh 	DEVMETHOD(device_probe,		spibus_probe),
2419a795dfaSWarner Losh 	DEVMETHOD(device_attach,	spibus_attach),
2429a795dfaSWarner Losh 	DEVMETHOD(device_detach,	spibus_detach),
2439a795dfaSWarner Losh 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
2449a795dfaSWarner Losh 	DEVMETHOD(device_suspend,	spibus_suspend),
2459a795dfaSWarner Losh 	DEVMETHOD(device_resume,	spibus_resume),
2469a795dfaSWarner Losh 
2479a795dfaSWarner Losh 	/* Bus interface */
2484dd8db62SEmmanuel Vadot 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
2494dd8db62SEmmanuel Vadot 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
2504dd8db62SEmmanuel Vadot 	DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
2514dd8db62SEmmanuel Vadot 	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
2524dd8db62SEmmanuel Vadot 	DEVMETHOD(bus_adjust_resource,	bus_generic_adjust_resource),
2534dd8db62SEmmanuel Vadot 	DEVMETHOD(bus_alloc_resource,	bus_generic_rl_alloc_resource),
254*c6889cbfSVladimir Kondratyev 	DEVMETHOD(bus_release_resource,	bus_generic_rl_release_resource),
2554dd8db62SEmmanuel Vadot 	DEVMETHOD(bus_get_resource,	bus_generic_rl_get_resource),
2564dd8db62SEmmanuel Vadot 	DEVMETHOD(bus_set_resource,	bus_generic_rl_set_resource),
2574dd8db62SEmmanuel Vadot 	DEVMETHOD(bus_get_resource_list, spibus_get_resource_list),
2584dd8db62SEmmanuel Vadot 
2599a795dfaSWarner Losh 	DEVMETHOD(bus_add_child,	spibus_add_child),
2609a795dfaSWarner Losh 	DEVMETHOD(bus_print_child,	spibus_print_child),
2619a795dfaSWarner Losh 	DEVMETHOD(bus_probe_nomatch,	spibus_probe_nomatch),
2629a795dfaSWarner Losh 	DEVMETHOD(bus_read_ivar,	spibus_read_ivar),
263392bffb9SIan Lepore 	DEVMETHOD(bus_write_ivar,	spibus_write_ivar),
264ddfc9c4cSWarner Losh 	DEVMETHOD(bus_child_location,	spibus_child_location),
2659a795dfaSWarner Losh 	DEVMETHOD(bus_hinted_child,	spibus_hinted_child),
2669a795dfaSWarner Losh 
2679a795dfaSWarner Losh 	/* spibus interface */
2689a795dfaSWarner Losh 	DEVMETHOD(spibus_transfer,	spibus_transfer_impl),
2699a795dfaSWarner Losh 
2704b7ec270SMarius Strobl 	DEVMETHOD_END
2719a795dfaSWarner Losh };
2729a795dfaSWarner Losh 
273585300e9SLuiz Otavio O Souza driver_t spibus_driver = {
2749a795dfaSWarner Losh 	"spibus",
2759a795dfaSWarner Losh 	spibus_methods,
2769a795dfaSWarner Losh 	sizeof(struct spibus_softc)
2779a795dfaSWarner Losh };
2789a795dfaSWarner Losh 
2795f31d14aSJohn Baldwin DRIVER_MODULE(spibus, spi, spibus_driver, 0, 0);
2809a795dfaSWarner Losh MODULE_VERSION(spibus, 1);
281