Home | History | Annotate | Line # | Download | only in dev
      1 /*	$NetBSD: pcfiic_ebus.c,v 1.9 2025/09/01 04:47:03 thorpej Exp $	*/
      2 /*	$OpenBSD: pcfiic_ebus.c,v 1.13 2008/06/08 03:07:40 deraadt Exp $ */
      3 
      4 /*
      5  * Copyright (c) 2006 David Gwynne <dlg (at) openbsd.org>
      6  *
      7  * Permission to use, copy, modify, and distribute this software for any
      8  * purpose with or without fee is hereby granted, provided that the above
      9  * copyright notice and this permission notice appear in all copies.
     10  *
     11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
     12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     18  */
     19 
     20 #include <sys/cdefs.h>
     21 __KERNEL_RCSID(0, "$NetBSD: pcfiic_ebus.c,v 1.9 2025/09/01 04:47:03 thorpej Exp $");
     22 
     23 /*
     24  * Device specific driver for the EBus i2c devices found on some sun4u
     25  * systems. On systems not having a boot-bus controller the i2c devices
     26  * are PCF8584.
     27  */
     28 
     29 #include <sys/param.h>
     30 #include <sys/systm.h>
     31 #include <sys/device.h>
     32 #include <sys/kernel.h>
     33 #include <sys/rwlock.h>
     34 
     35 #include <sys/bus.h>
     36 #include <machine/openfirm.h>
     37 #include <machine/autoconf.h>
     38 
     39 #include <dev/ebus/ebusreg.h>
     40 #include <dev/ebus/ebusvar.h>
     41 
     42 #include <dev/i2c/i2cvar.h>
     43 
     44 #include <dev/ic/pcf8584var.h>
     45 #include <dev/ic/pcf8584reg.h>
     46 
     47 int	pcfiic_ebus_match(device_t, struct cfdata *, void *);
     48 void	pcfiic_ebus_attach(device_t, device_t, void *);
     49 
     50 struct pcfiic_ebus_softc {
     51 	struct pcfiic_softc	esc_sc;
     52 
     53 	int			esc_node;
     54 	void			*esc_ih;
     55 };
     56 
     57 CFATTACH_DECL_NEW(pcfiic_ebus, sizeof(struct pcfiic_ebus_softc),
     58 	pcfiic_ebus_match, pcfiic_ebus_attach, NULL, NULL);
     59 
     60 int
     61 pcfiic_ebus_match(device_t parent, struct cfdata *match, void *aux)
     62 {
     63 	struct ebus_attach_args		*ea = aux;
     64 	char				compat[32];
     65 
     66 	if (strcmp(ea->ea_name, "SUNW,envctrl") == 0 ||
     67 	    strcmp(ea->ea_name, "SUNW,envctrltwo") == 0)
     68 		return (1);
     69 
     70 	if (strcmp(ea->ea_name, "i2c") != 0)
     71 		return (0);
     72 
     73 	if (OF_getprop(ea->ea_node, "compatible", compat, sizeof(compat)) == -1)
     74 		return (0);
     75 
     76 	if (strcmp(compat, "pcf8584") == 0 ||
     77 	    strcmp(compat, "i2cpcf,8584") == 0 ||
     78 	    strcmp(compat, "SUNW,i2c-pic16f747") == 0 ||
     79 	    strcmp(compat, "SUNW,bbc-i2c") == 0)
     80 		return (1);
     81 
     82 	return (0);
     83 }
     84 
     85 void
     86 pcfiic_ebus_attach(device_t parent, device_t self, void *aux)
     87 {
     88 	struct pcfiic_ebus_softc	*esc = device_private(self);
     89 	struct pcfiic_softc		*sc = &esc->esc_sc;
     90 	struct ebus_attach_args		*ea = aux;
     91 	char				compat[32];
     92 	u_int64_t			addr;
     93 	u_int8_t			clock = PCF8584_CLK_12 | PCF8584_SCL_90;
     94 	int				swapregs = 0;
     95 
     96 	if (ea->ea_nreg < 1 || ea->ea_nreg > 2) {
     97 		printf(": expected 1 or 2 registers, got %d\n", ea->ea_nreg);
     98 		return;
     99 	}
    100 
    101 	/* E450 and E250 have a different clock */
    102 	if ((strcmp(ea->ea_name, "SUNW,envctrl") == 0) ||
    103 	    (strcmp(ea->ea_name, "SUNW,envctrltwo") == 0))
    104 		clock = PCF8584_CLK_12 | PCF8584_SCL_45;
    105 
    106 	sc->sc_dev = self;
    107 	if (OF_getprop(ea->ea_node, "compatible", compat, sizeof(compat)) > 0 &&
    108 	    strcmp(compat, "SUNW,bbc-i2c") == 0) {
    109 		/*
    110 		 * On BBC-based machines, Sun swapped the order of
    111 		 * the registers on their clone pcf, plus they feed
    112 		 * it a non-standard clock.
    113 		 */
    114 		int clk = prom_getpropint(findroot(), "clock-frequency", 0);
    115 
    116 		if (clk < 105000000)
    117 			clock = PCF8584_CLK_3 | PCF8584_SCL_90;
    118 		else if (clk < 160000000)
    119 			clock = PCF8584_CLK_4_43 | PCF8584_SCL_90;
    120 		swapregs = 1;
    121 	}
    122 
    123 	if (OF_getprop(ea->ea_node, "own-address", &addr, sizeof(addr)) == -1) {
    124 		addr = 0xaa;
    125 	} else if (addr == 0x00 || addr > 0xff) {
    126 		printf(": invalid address on I2C bus");
    127 		return;
    128 	}
    129 
    130 	if (bus_space_map(ea->ea_bustag,
    131 	    EBUS_ADDR_FROM_REG(&ea->ea_reg[0]),
    132 	    ea->ea_reg[0].size, 0, &sc->sc_ioh) == 0) {
    133 		sc->sc_iot = ea->ea_bustag;
    134 	} else {
    135 		printf(": can't map register space\n");
    136                	return;
    137 	}
    138 
    139 	if (ea->ea_nreg == 2) {
    140 		/*
    141 		 * Second register only occurs on BBC-based machines,
    142 		 * and is likely not prom mapped
    143 		*/
    144 		if (bus_space_map(sc->sc_iot, EBUS_ADDR_FROM_REG(&ea->ea_reg[1]),
    145 		    ea->ea_reg[1].size, 0, &sc->sc_ioh2) != 0) {
    146 			printf(": can't map 2nd register space\n");
    147 			return;
    148 		}
    149 		sc->sc_master = 1;
    150 		printf(": iic mux present");
    151 	}
    152 
    153 	if (ea->ea_nintr >= 1)
    154 		esc->esc_ih = bus_intr_establish(sc->sc_iot, ea->ea_intr[0],
    155 		    IPL_BIO, pcfiic_intr, sc);
    156 	else
    157 		esc->esc_ih = NULL;
    158 
    159 
    160 	if (esc->esc_ih == NULL)
    161 		sc->sc_poll = 1;
    162 
    163 	printf("\n");
    164 
    165 	pcfiic_attach(sc, (i2c_addr_t)(addr >> 1), clock, swapregs);
    166 }
    167