1 /*- 2 * Copyright (c) 2009, Nathan Whitehorn <nwhitehorn@FreeBSD.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice unmodified, this list of conditions, and the following 10 * disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 #include <sys/param.h> 28 #include <sys/bus.h> 29 #include <sys/kernel.h> 30 #include <sys/libkern.h> 31 #include <sys/lock.h> 32 #include <sys/module.h> 33 #include <sys/mutex.h> 34 35 #include <dev/iicbus/iicbus.h> 36 #include <dev/iicbus/iiconf.h> 37 #include <dev/ofw/ofw_bus.h> 38 #include <dev/ofw/ofw_bus_subr.h> 39 #include <dev/ofw/openfirm.h> 40 41 #include "iicbus_if.h" 42 #include "ofw_iicbus_if.h" 43 44 /* Methods */ 45 static device_probe_t ofw_iicbus_probe; 46 static device_attach_t ofw_iicbus_attach; 47 static device_t ofw_iicbus_add_child(device_t dev, u_int order, 48 const char *name, int unit); 49 static const struct ofw_bus_devinfo *ofw_iicbus_get_devinfo(device_t bus, 50 device_t dev); 51 static int ofw_iicbus_set_devinfo(device_t bus, device_t dev, 52 phandle_t ofw_node, char *ofw_name, char *ofw_compat, uint32_t i2c_addr); 53 54 static device_method_t ofw_iicbus_methods[] = { 55 /* Device interface */ 56 DEVMETHOD(device_probe, ofw_iicbus_probe), 57 DEVMETHOD(device_attach, ofw_iicbus_attach), 58 59 /* Bus interface */ 60 DEVMETHOD(bus_child_pnpinfo, ofw_bus_gen_child_pnpinfo), 61 DEVMETHOD(bus_add_child, ofw_iicbus_add_child), 62 63 /* ofw_bus interface */ 64 DEVMETHOD(ofw_bus_get_devinfo, ofw_iicbus_get_devinfo), 65 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 66 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 67 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 68 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 69 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 70 71 /* ofw_iicbus interface */ 72 DEVMETHOD(ofw_iicbus_set_devinfo, ofw_iicbus_set_devinfo), 73 74 DEVMETHOD_END 75 }; 76 77 struct ofw_iicbus_devinfo { 78 struct iicbus_ivar opd_dinfo; /* Must be the first. */ 79 struct ofw_bus_devinfo opd_obdinfo; 80 }; 81 82 DEFINE_CLASS_1(iicbus, ofw_iicbus_driver, ofw_iicbus_methods, 83 sizeof(struct iicbus_softc), iicbus_driver); 84 EARLY_DRIVER_MODULE(ofw_iicbus, iicbb, ofw_iicbus_driver, 0, 0, BUS_PASS_BUS); 85 EARLY_DRIVER_MODULE(ofw_iicbus, iichb, ofw_iicbus_driver, 0, 0, BUS_PASS_BUS); 86 EARLY_DRIVER_MODULE(ofw_iicbus, twsi, ofw_iicbus_driver, 0, 0, BUS_PASS_BUS); 87 MODULE_VERSION(ofw_iicbus, 1); 88 MODULE_DEPEND(ofw_iicbus, iicbus, 1, 1, 1); 89 90 static int 91 ofw_iicbus_probe(device_t dev) 92 { 93 94 if (ofw_bus_get_node(dev) == -1) 95 return (ENXIO); 96 device_set_desc(dev, "OFW I2C bus"); 97 98 return (0); 99 } 100 101 static int 102 ofw_iicbus_attach(device_t dev) 103 { 104 struct iicbus_softc *sc = IICBUS_SOFTC(dev); 105 struct ofw_iicbus_devinfo *dinfo; 106 phandle_t child, node, root; 107 pcell_t freq, paddr; 108 device_t childdev; 109 ssize_t compatlen; 110 char compat[255]; 111 char *curstr; 112 u_int iic_addr_8bit = 0; 113 114 sc->dev = dev; 115 mtx_init(&sc->lock, "iicbus", NULL, MTX_DEF); 116 117 /* 118 * If there is a clock-frequency property for the device node, use it as 119 * the starting value for the bus frequency. Then call the common 120 * routine that handles the tunable/sysctl which allows the FDT value to 121 * be overridden by the user. 122 */ 123 node = ofw_bus_get_node(dev); 124 freq = 0; 125 OF_getencprop(node, "clock-frequency", &freq, sizeof(freq)); 126 iicbus_init_frequency(dev, freq); 127 128 iicbus_reset(dev, IIC_FASTEST, 0, NULL); 129 130 bus_generic_probe(dev); 131 bus_enumerate_hinted_children(dev); 132 133 /* 134 * Check if we're running on a PowerMac, needed for the I2C 135 * address below. 136 */ 137 root = OF_peer(0); 138 compatlen = OF_getprop(root, "compatible", compat, 139 sizeof(compat)); 140 if (compatlen != -1) { 141 for (curstr = compat; curstr < compat + compatlen; 142 curstr += strlen(curstr) + 1) { 143 if (strncmp(curstr, "MacRISC", 7) == 0) 144 iic_addr_8bit = 1; 145 } 146 } 147 148 /* 149 * Attach those children represented in the device tree. 150 */ 151 for (child = OF_child(node); child != 0; child = OF_peer(child)) { 152 /* 153 * Try to get the I2C address first from the i2c-address 154 * property, then try the reg property. It moves around 155 * on different systems. 156 */ 157 if (OF_getencprop(child, "i2c-address", &paddr, 158 sizeof(paddr)) == -1) 159 if (OF_getencprop(child, "reg", &paddr, 160 sizeof(paddr)) == -1) 161 continue; 162 163 /* 164 * Now set up the I2C and OFW bus layer devinfo and add it 165 * to the bus. 166 */ 167 dinfo = malloc(sizeof(struct ofw_iicbus_devinfo), M_DEVBUF, 168 M_NOWAIT | M_ZERO); 169 if (dinfo == NULL) 170 continue; 171 /* 172 * FreeBSD drivers expect I2C addresses to be expressed as 173 * 8-bit values. Apple OFW data contains 8-bit values, but 174 * Linux FDT data contains 7-bit values, so shift them up to 175 * 8-bit format. 176 */ 177 if (iic_addr_8bit) 178 dinfo->opd_dinfo.addr = paddr; 179 else 180 dinfo->opd_dinfo.addr = paddr << 1; 181 182 if (ofw_bus_gen_setup_devinfo(&dinfo->opd_obdinfo, child) != 183 0) { 184 free(dinfo, M_DEVBUF); 185 continue; 186 } 187 188 childdev = device_add_child(dev, NULL, -1); 189 resource_list_init(&dinfo->opd_dinfo.rl); 190 ofw_bus_intr_to_rl(childdev, child, 191 &dinfo->opd_dinfo.rl, NULL); 192 device_set_ivars(childdev, dinfo); 193 } 194 195 /* Register bus */ 196 OF_device_register_xref(OF_xref_from_node(node), dev); 197 return (bus_generic_attach(dev)); 198 } 199 200 static device_t 201 ofw_iicbus_add_child(device_t dev, u_int order, const char *name, int unit) 202 { 203 device_t child; 204 struct ofw_iicbus_devinfo *devi; 205 206 child = device_add_child_ordered(dev, order, name, unit); 207 if (child == NULL) 208 return (child); 209 devi = malloc(sizeof(struct ofw_iicbus_devinfo), M_DEVBUF, 210 M_NOWAIT | M_ZERO); 211 if (devi == NULL) { 212 device_delete_child(dev, child); 213 return (0); 214 } 215 216 /* 217 * NULL all the OFW-related parts of the ivars for non-OFW 218 * children. 219 */ 220 devi->opd_obdinfo.obd_node = -1; 221 devi->opd_obdinfo.obd_name = NULL; 222 devi->opd_obdinfo.obd_compat = NULL; 223 devi->opd_obdinfo.obd_type = NULL; 224 devi->opd_obdinfo.obd_model = NULL; 225 226 device_set_ivars(child, devi); 227 228 return (child); 229 } 230 231 static const struct ofw_bus_devinfo * 232 ofw_iicbus_get_devinfo(device_t bus, device_t dev) 233 { 234 struct ofw_iicbus_devinfo *dinfo; 235 236 dinfo = device_get_ivars(dev); 237 return (&dinfo->opd_obdinfo); 238 } 239 240 static int 241 ofw_iicbus_set_devinfo(device_t bus, device_t dev, phandle_t ofw_node, 242 char *ofw_name, char *ofw_compat, uint32_t i2c_addr) 243 { 244 struct ofw_iicbus_devinfo *devi; 245 246 /* 247 * Setup OFW-related parts of the ivars for manually 248 * created ofw_iicbus childern. 249 */ 250 devi = device_get_ivars(dev); 251 if (devi == NULL) 252 return (ENXIO); 253 254 devi->opd_obdinfo.obd_node = ofw_node; 255 if (ofw_name != NULL) 256 devi->opd_obdinfo.obd_name = strdup(ofw_name, M_OFWPROP); 257 if (ofw_compat != NULL) 258 devi->opd_obdinfo.obd_compat = strdup(ofw_compat, M_OFWPROP); 259 devi->opd_dinfo.addr = i2c_addr; 260 return (0); 261 } 262