1130320Smarius/*- 2130320Smarius * Copyright (c) 2004 Marius Strobl, Joerg Wunsch 3130320Smarius * 4130320Smarius * derived from sys/i386/isa/pcf.c which is: 5130320Smarius * 6130320Smarius * Copyright (c) 1998 Nicolas Souchu, Marc Bouget 7130320Smarius * All rights reserved. 8130320Smarius * 9130320Smarius * Redistribution and use in source and binary forms, with or without 10130320Smarius * modification, are permitted provided that the following conditions 11130320Smarius * are met: 12130320Smarius * 1. Redistributions of source code must retain the above copyright 13130320Smarius * notice, this list of conditions and the following disclaimer. 14130320Smarius * 2. Redistributions in binary form must reproduce the above copyright 15130320Smarius * notice, this list of conditions and the following disclaimer in the 16130320Smarius * documentation and/or other materials provided with the distribution. 17130320Smarius * 18130320Smarius * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19130320Smarius * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20130320Smarius * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21130320Smarius * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22130320Smarius * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23130320Smarius * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24130320Smarius * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25130320Smarius * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26130320Smarius * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27130320Smarius * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28130320Smarius * SUCH DAMAGE. 29130320Smarius */ 30130320Smarius#include <sys/cdefs.h> 31130320Smarius__FBSDID("$FreeBSD: releng/10.2/sys/dev/pcf/pcf_ebus.c 233018 2012-03-15 22:53:39Z nwhitehorn $"); 32130320Smarius 33130320Smarius/* 34130320Smarius * Device specific driver for the EBus i2c devices found on some sun4u 35130320Smarius * systems. On systems not having a boot-bus controller the i2c devices 36130320Smarius * are PCF8584. 37130320Smarius * 38130320Smarius * Known onboard slave devices on the primary bus are: 39130320Smarius * 40130320Smarius * AXe: 41130320Smarius * 0x40 PCF8574 I/O fan status (CPU fans 1+2) 42130320Smarius * 0x9e PCF8591 A/D temperature (CPU + hotspot) 43130320Smarius * 44130320Smarius * AXmp: 45130320Smarius * 0x70 PCF8574 I/O fan status (fans 1-4) 46130320Smarius * 0x78 PCF8574 I/O fan fail interrupt 47130320Smarius * 0x9a PCF8591 A/D voltage (CPU core) 48130320Smarius * 0x9c PCF8591 A/D temperature (hotspots 1+2, aux. analog 1+2) 49130320Smarius * 0x9e PCF8591 A/D temperature (CPUs 1-4) 50130320Smarius * 51130320Smarius * CP1400: 52130320Smarius * 0x70 PCF8574 I/O reserved for factory use 53130320Smarius * 0x9e PCF8591 A/D temperature (CPU) 54130320Smarius * 55130320Smarius * CP1500: 56130320Smarius * 0x70 PCF8574 I/O reserved for factory use 57130320Smarius * 0x72 PCF8574 I/O geographic address + power supply status lines 58130320Smarius * 0x9e PCF8591 A/D temperature (CPU) 59130320Smarius * 0xa0 AT24C01A hostid 60130320Smarius * 61130320Smarius * For AXmp, CP1400 and CP1500 these are described in more detail in: 62130320Smarius * http://www.sun.com/oem/products/manuals/805-7581-04.pdf 63130320Smarius * 64130320Smarius */ 65130320Smarius 66130320Smarius#include <sys/param.h> 67130320Smarius#include <sys/bus.h> 68181303Sjhb#include <sys/lock.h> 69130320Smarius#include <sys/kernel.h> 70130320Smarius#include <sys/module.h> 71181303Sjhb#include <sys/mutex.h> 72130320Smarius#include <sys/resource.h> 73181303Sjhb#include <sys/systm.h> 74130320Smarius 75133589Smarius#include <dev/ofw/ofw_bus.h> 76133589Smarius#include <dev/ofw/openfirm.h> 77133589Smarius 78130320Smarius#include <machine/bus.h> 79130320Smarius#include <machine/resource.h> 80130320Smarius 81130320Smarius#include <sys/rman.h> 82130320Smarius 83130320Smarius#include <dev/iicbus/iiconf.h> 84130320Smarius#include <dev/pcf/pcfvar.h> 85130320Smarius#include "iicbus_if.h" 86130320Smarius 87130320Smarius#define PCF_NAME "pcf" 88130320Smarius 89130320Smariusstatic int pcf_ebus_probe(device_t); 90130320Smariusstatic int pcf_ebus_attach(device_t); 91130320Smariusstatic int pcf_ebus_detach(device_t); 92130320Smarius 93130320Smariusstatic device_method_t pcf_ebus_methods[] = { 94130320Smarius /* device interface */ 95130320Smarius DEVMETHOD(device_probe, pcf_ebus_probe), 96130320Smarius DEVMETHOD(device_attach, pcf_ebus_attach), 97130320Smarius DEVMETHOD(device_detach, pcf_ebus_detach), 98130320Smarius 99130320Smarius /* iicbus interface */ 100130320Smarius DEVMETHOD(iicbus_callback, iicbus_null_callback), 101130320Smarius DEVMETHOD(iicbus_repeated_start, pcf_repeated_start), 102130320Smarius DEVMETHOD(iicbus_start, pcf_start), 103130320Smarius DEVMETHOD(iicbus_stop, pcf_stop), 104130320Smarius DEVMETHOD(iicbus_write, pcf_write), 105130320Smarius DEVMETHOD(iicbus_read, pcf_read), 106130320Smarius DEVMETHOD(iicbus_reset, pcf_rst_card), 107130320Smarius { 0, 0 } 108130320Smarius}; 109130320Smarius 110130320Smariusstatic devclass_t pcf_ebus_devclass; 111130320Smarius 112130320Smariusstatic driver_t pcf_ebus_driver = { 113130320Smarius PCF_NAME, 114130320Smarius pcf_ebus_methods, 115130320Smarius sizeof(struct pcf_softc), 116130320Smarius}; 117130320Smarius 118130320Smariusstatic int 119130320Smariuspcf_ebus_probe(device_t dev) 120130320Smarius{ 121133589Smarius const char *compat; 122130320Smarius 123130320Smarius /* 124130320Smarius * We must not attach to this i2c device if this is a system with 125130320Smarius * a boot-bus controller. Additionally testing the compatibility 126130320Smarius * property will hopefully take care of this. 127130320Smarius */ 128133589Smarius if (strcmp("i2c", ofw_bus_get_name(dev)) == 0) { 129133589Smarius compat = ofw_bus_get_compat(dev); 130130320Smarius if (compat != NULL && strcmp("i2cpcf,8584", compat) == 0) { 131130320Smarius device_set_desc(dev, "PCF8584 I2C bus controller"); 132130320Smarius return (0); 133130320Smarius } 134130320Smarius } 135130320Smarius return (ENXIO); 136130320Smarius} 137130320Smarius 138130320Smariusstatic int 139130320Smariuspcf_ebus_attach(device_t dev) 140130320Smarius{ 141130320Smarius struct pcf_softc *sc; 142130320Smarius int rv = ENXIO; 143130320Smarius phandle_t node; 144130320Smarius uint64_t own_addr; 145130320Smarius 146130320Smarius sc = DEVTOSOFTC(dev); 147181303Sjhb mtx_init(&sc->pcf_lock, device_get_nameunit(dev), "pcf", MTX_DEF); 148130320Smarius 149130320Smarius /* get OFW node of the pcf */ 150233018Snwhitehorn if ((node = ofw_bus_get_node(dev)) == -1) { 151130320Smarius device_printf(dev, "cannot get OFW node\n"); 152130320Smarius goto error; 153130320Smarius } 154130320Smarius 155130320Smarius /* IO port is mandatory */ 156146966Smarius sc->res_ioport = bus_alloc_resource_any(dev, SYS_RES_MEMORY, 157130320Smarius &sc->rid_ioport, RF_ACTIVE); 158130320Smarius if (sc->res_ioport == 0) { 159130320Smarius device_printf(dev, "cannot reserve I/O port range\n"); 160130320Smarius goto error; 161130320Smarius } 162130320Smarius 163130320Smarius sc->pcf_flags = device_get_flags(dev); 164130320Smarius 165130320Smarius /* 166130320Smarius * XXX use poll-mode property? 167130320Smarius */ 168130320Smarius if (!(sc->pcf_flags & IIC_POLLED)) { 169130320Smarius sc->res_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, 170130320Smarius &sc->rid_irq, RF_ACTIVE); 171130320Smarius if (sc->res_irq == 0) { 172130320Smarius device_printf(dev, "can't reserve irq, polled mode.\n"); 173130320Smarius sc->pcf_flags |= IIC_POLLED; 174130320Smarius } 175130320Smarius } 176130320Smarius 177130320Smarius /* 178130320Smarius * XXX on AXmp there's probably a second IRQ which is the fan fail 179130320Smarius * interrupt genererated by the PCF8574 at 0x78. 180130320Smarius */ 181130320Smarius 182130320Smarius /* get address of the pcf */ 183130320Smarius if (OF_getprop(node, "own-address", &own_addr, sizeof(own_addr)) == 184130320Smarius -1) { 185130320Smarius device_printf(dev, "cannot get own address\n"); 186130320Smarius goto error; 187130320Smarius } 188130320Smarius if (bootverbose) 189130320Smarius device_printf(dev, "PCF8584 address: 0x%08llx\n", (unsigned 190130320Smarius long long)own_addr); 191130320Smarius 192130320Smarius /* reset the chip */ 193130320Smarius pcf_rst_card(dev, IIC_FASTEST, own_addr, NULL); 194130320Smarius 195130320Smarius if (sc->res_irq) { 196155921Sjhb rv = bus_setup_intr(dev, sc->res_irq, 197166901Spiso INTR_TYPE_NET /* | INTR_ENTROPY */, NULL, pcf_intr, sc, 198130320Smarius &sc->intr_cookie); 199130320Smarius if (rv) { 200130320Smarius device_printf(dev, "could not setup IRQ\n"); 201130320Smarius goto error; 202130320Smarius } 203130320Smarius } 204130320Smarius 205130320Smarius if ((sc->iicbus = device_add_child(dev, "iicbus", -1)) == NULL) 206130320Smarius device_printf(dev, "could not allocate iicbus instance\n"); 207130320Smarius 208130320Smarius /* probe and attach the iicbus */ 209130320Smarius bus_generic_attach(dev); 210130320Smarius 211130320Smarius return (0); 212130320Smarius 213130320Smariuserror: 214130320Smarius if (sc->res_irq != 0) { 215130320Smarius bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq, 216130320Smarius sc->res_irq); 217130320Smarius } 218130320Smarius if (sc->res_ioport != 0) { 219146966Smarius bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_ioport, 220130320Smarius sc->res_ioport); 221130320Smarius } 222181303Sjhb mtx_destroy(&sc->pcf_lock); 223130320Smarius return (rv); 224130320Smarius} 225130320Smarius 226130320Smariusstatic int 227130320Smariuspcf_ebus_detach(device_t dev) 228130320Smarius{ 229130320Smarius struct pcf_softc *sc; 230130320Smarius int rv; 231130320Smarius 232130320Smarius sc = DEVTOSOFTC(dev); 233130320Smarius 234130320Smarius if ((rv = bus_generic_detach(dev)) != 0) 235130320Smarius return (rv); 236130320Smarius 237130320Smarius if ((rv = device_delete_child(dev, sc->iicbus)) != 0) 238130320Smarius return (rv); 239130320Smarius 240130320Smarius if (sc->res_irq != 0) { 241155921Sjhb bus_teardown_intr(dev, sc->res_irq, 242130320Smarius sc->intr_cookie); 243130320Smarius bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq, 244130320Smarius sc->res_irq); 245130320Smarius } 246130320Smarius 247146966Smarius bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_ioport, 248130320Smarius sc->res_ioport); 249181303Sjhb mtx_destroy(&sc->pcf_lock); 250130320Smarius 251130320Smarius return (0); 252130320Smarius} 253130320Smarius 254130320SmariusDRIVER_MODULE(pcf_ebus, ebus, pcf_ebus_driver, pcf_ebus_devclass, 0, 0); 255