1278957Simp/*- 2278957Simp * Copyright (c) 2006 M. Warner Losh 3278957Simp * All rights reserved. 4278957Simp * 5278957Simp * Redistribution and use in source and binary forms, with or without 6278957Simp * modification, are permitted provided that the following conditions 7278957Simp * are met: 8278957Simp * 1. Redistributions of source code must retain the above copyright 9278957Simp * notice, this list of conditions and the following disclaimer. 10278957Simp * 2. Redistributions in binary form must reproduce the above copyright 11278957Simp * notice, this list of conditions and the following disclaimer in the 12278957Simp * documentation and/or other materials provided with the distribution. 13278957Simp * 14278957Simp * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15278957Simp * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16278957Simp * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17278957Simp * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18278957Simp * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19278957Simp * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20278957Simp * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21278957Simp * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22278957Simp * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23278957Simp * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24278957Simp * SUCH DAMAGE. 25278957Simp * 26278957Simp */ 27278957Simp 28160370Simp#include <sys/cdefs.h> 29160370Simp__FBSDID("$FreeBSD: stable/11/sys/dev/spibus/spibus.c 346557 2019-04-22 15:04:11Z ian $"); 30160370Simp 31160370Simp#include <sys/param.h> 32160370Simp#include <sys/systm.h> 33160370Simp#include <sys/malloc.h> 34160370Simp#include <sys/module.h> 35160370Simp#include <sys/kernel.h> 36160370Simp#include <sys/queue.h> 37160370Simp#include <sys/sysctl.h> 38160370Simp#include <sys/types.h> 39160370Simp 40160370Simp#include <sys/bus.h> 41160370Simp#include <machine/bus.h> 42160370Simp#include <sys/rman.h> 43160370Simp#include <machine/resource.h> 44160370Simp 45160370Simp#include <dev/spibus/spibusvar.h> 46160370Simp#include <dev/spibus/spi.h> 47160370Simp#include "spibus_if.h" 48160370Simp 49160370Simpstatic int 50160370Simpspibus_probe(device_t dev) 51160370Simp{ 52332942Sian 53332942Sian device_set_desc(dev, "SPI bus"); 54332942Sian return (BUS_PROBE_DEFAULT); 55160370Simp} 56160370Simp 57160370Simpstatic int 58160370Simpspibus_attach(device_t dev) 59160370Simp{ 60160370Simp struct spibus_softc *sc = SPIBUS_SOFTC(dev); 61160370Simp 62160370Simp sc->dev = dev; 63160370Simp bus_enumerate_hinted_children(dev); 64160370Simp return (bus_generic_attach(dev)); 65160370Simp} 66160370Simp 67160370Simp/* 68160370Simp * Since this is not a self-enumerating bus, and since we always add 69160370Simp * children in attach, we have to always delete children here. 70160370Simp */ 71160370Simpstatic int 72160370Simpspibus_detach(device_t dev) 73160370Simp{ 74332942Sian int err; 75160370Simp 76160370Simp if ((err = bus_generic_detach(dev)) != 0) 77160370Simp return (err); 78332942Sian device_delete_children(dev); 79160370Simp 80160370Simp return (0); 81160370Simp} 82160370Simp 83160370Simpstatic int 84160370Simpspibus_suspend(device_t dev) 85160370Simp{ 86160370Simp return (bus_generic_suspend(dev)); 87160370Simp} 88160370Simp 89160370Simpstatic 90160370Simpint 91160370Simpspibus_resume(device_t dev) 92160370Simp{ 93160370Simp return (bus_generic_resume(dev)); 94160370Simp} 95160370Simp 96160370Simpstatic int 97160370Simpspibus_print_child(device_t dev, device_t child) 98160370Simp{ 99160370Simp struct spibus_ivar *devi = SPIBUS_IVAR(child); 100160370Simp int retval = 0; 101160370Simp 102160370Simp retval += bus_print_child_header(dev, child); 103160370Simp retval += printf(" at cs %d", devi->cs); 104300710Sadrian retval += printf(" mode %d", devi->mode); 105160370Simp retval += bus_print_child_footer(dev, child); 106160370Simp 107160370Simp return (retval); 108160370Simp} 109160370Simp 110160370Simpstatic void 111160370Simpspibus_probe_nomatch(device_t bus, device_t child) 112160370Simp{ 113160370Simp struct spibus_ivar *devi = SPIBUS_IVAR(child); 114160370Simp 115315329Smizhka device_printf(bus, "<unknown card> at cs %d mode %d\n", devi->cs, 116315329Smizhka devi->mode); 117160370Simp return; 118160370Simp} 119160370Simp 120160370Simpstatic int 121160370Simpspibus_child_location_str(device_t bus, device_t child, char *buf, 122160370Simp size_t buflen) 123160370Simp{ 124160370Simp struct spibus_ivar *devi = SPIBUS_IVAR(child); 125346517Sian int cs; 126160370Simp 127346517Sian cs = devi->cs & ~SPIBUS_CS_HIGH; /* trim 'cs high' bit */ 128346517Sian snprintf(buf, buflen, "bus=%d cs=%d", device_get_unit(bus), cs); 129160370Simp return (0); 130160370Simp} 131160370Simp 132160370Simpstatic int 133160370Simpspibus_child_pnpinfo_str(device_t bus, device_t child, char *buf, 134160370Simp size_t buflen) 135160370Simp{ 136160370Simp *buf = '\0'; 137160370Simp return (0); 138160370Simp} 139160370Simp 140160370Simpstatic int 141298651Sbrspibus_read_ivar(device_t bus, device_t child, int which, uintptr_t *result) 142160370Simp{ 143160370Simp struct spibus_ivar *devi = SPIBUS_IVAR(child); 144160370Simp 145160370Simp switch (which) { 146160370Simp default: 147160370Simp return (EINVAL); 148160370Simp case SPIBUS_IVAR_CS: 149160370Simp *(uint32_t *)result = devi->cs; 150160370Simp break; 151300710Sadrian case SPIBUS_IVAR_MODE: 152300710Sadrian *(uint32_t *)result = devi->mode; 153300710Sadrian break; 154300710Sadrian case SPIBUS_IVAR_CLOCK: 155300710Sadrian *(uint32_t *)result = devi->clock; 156300711Sadrian break; 157160370Simp } 158160370Simp return (0); 159160370Simp} 160160370Simp 161332942Sianstatic int 162332942Sianspibus_write_ivar(device_t bus, device_t child, int which, uintptr_t value) 163332942Sian{ 164332942Sian struct spibus_ivar *devi = SPIBUS_IVAR(child); 165332942Sian 166332942Sian if (devi == NULL || device_get_parent(child) != bus) 167332942Sian return (EDOOFUS); 168332942Sian 169332942Sian switch (which) { 170332942Sian case SPIBUS_IVAR_CLOCK: 171332942Sian /* Any non-zero value is allowed for max clock frequency. */ 172332942Sian if (value == 0) 173332942Sian return (EINVAL); 174332942Sian devi->clock = (uint32_t)value; 175332942Sian break; 176332942Sian case SPIBUS_IVAR_CS: 177332942Sian /* Chip select cannot be changed. */ 178332942Sian return (EINVAL); 179332942Sian case SPIBUS_IVAR_MODE: 180332942Sian /* Valid SPI modes are 0-3. */ 181332942Sian if (value > 3) 182332942Sian return (EINVAL); 183332942Sian devi->mode = (uint32_t)value; 184332942Sian break; 185332942Sian default: 186332942Sian return (EINVAL); 187332942Sian } 188332942Sian 189332942Sian return (0); 190332942Sian} 191332942Sian 192160370Simpstatic device_t 193212413Savgspibus_add_child(device_t dev, u_int order, const char *name, int unit) 194160370Simp{ 195160370Simp device_t child; 196160370Simp struct spibus_ivar *devi; 197160370Simp 198160370Simp child = device_add_child_ordered(dev, order, name, unit); 199160370Simp if (child == NULL) 200160370Simp return (child); 201160370Simp devi = malloc(sizeof(struct spibus_ivar), M_DEVBUF, M_NOWAIT | M_ZERO); 202163527Simp if (devi == NULL) { 203163527Simp device_delete_child(dev, child); 204160370Simp return (0); 205163527Simp } 206160370Simp device_set_ivars(child, devi); 207160370Simp return (child); 208160370Simp} 209160370Simp 210160370Simpstatic void 211160370Simpspibus_hinted_child(device_t bus, const char *dname, int dunit) 212160370Simp{ 213160370Simp device_t child; 214160370Simp struct spibus_ivar *devi; 215160370Simp 216160370Simp child = BUS_ADD_CHILD(bus, 0, dname, dunit); 217160370Simp devi = SPIBUS_IVAR(child); 218300710Sadrian devi->mode = SPIBUS_MODE_NONE; 219346557Sian resource_int_value(dname, dunit, "clock", &devi->clock); 220160370Simp resource_int_value(dname, dunit, "cs", &devi->cs); 221300710Sadrian resource_int_value(dname, dunit, "mode", &devi->mode); 222160370Simp} 223160370Simp 224160370Simpstatic int 225160370Simpspibus_transfer_impl(device_t dev, device_t child, struct spi_command *cmd) 226160370Simp{ 227163527Simp return (SPIBUS_TRANSFER(device_get_parent(dev), child, cmd)); 228160370Simp} 229160370Simp 230160370Simpstatic device_method_t spibus_methods[] = { 231160370Simp /* Device interface */ 232160370Simp DEVMETHOD(device_probe, spibus_probe), 233160370Simp DEVMETHOD(device_attach, spibus_attach), 234160370Simp DEVMETHOD(device_detach, spibus_detach), 235160370Simp DEVMETHOD(device_shutdown, bus_generic_shutdown), 236160370Simp DEVMETHOD(device_suspend, spibus_suspend), 237160370Simp DEVMETHOD(device_resume, spibus_resume), 238160370Simp 239160370Simp /* Bus interface */ 240160370Simp DEVMETHOD(bus_add_child, spibus_add_child), 241160370Simp DEVMETHOD(bus_print_child, spibus_print_child), 242160370Simp DEVMETHOD(bus_probe_nomatch, spibus_probe_nomatch), 243160370Simp DEVMETHOD(bus_read_ivar, spibus_read_ivar), 244332942Sian DEVMETHOD(bus_write_ivar, spibus_write_ivar), 245160370Simp DEVMETHOD(bus_child_pnpinfo_str, spibus_child_pnpinfo_str), 246160370Simp DEVMETHOD(bus_child_location_str, spibus_child_location_str), 247160370Simp DEVMETHOD(bus_hinted_child, spibus_hinted_child), 248160370Simp 249160370Simp /* spibus interface */ 250160370Simp DEVMETHOD(spibus_transfer, spibus_transfer_impl), 251160370Simp 252227843Smarius DEVMETHOD_END 253160370Simp}; 254160370Simp 255257064Sloosdriver_t spibus_driver = { 256160370Simp "spibus", 257160370Simp spibus_methods, 258160370Simp sizeof(struct spibus_softc) 259160370Simp}; 260160370Simp 261160370Simpdevclass_t spibus_devclass; 262160370Simp 263192059SgonzoDRIVER_MODULE(spibus, spi, spibus_driver, spibus_devclass, 0, 0); 264160370SimpMODULE_VERSION(spibus, 1); 265