138774Snsouch/*- 293023Snsouch * Copyright (c) 1998, 2001 Nicolas Souchu 338774Snsouch * All rights reserved. 438774Snsouch * 538774Snsouch * Redistribution and use in source and binary forms, with or without 638774Snsouch * modification, are permitted provided that the following conditions 738774Snsouch * are met: 838774Snsouch * 1. Redistributions of source code must retain the above copyright 938774Snsouch * notice, this list of conditions and the following disclaimer. 1038774Snsouch * 2. Redistributions in binary form must reproduce the above copyright 1138774Snsouch * notice, this list of conditions and the following disclaimer in the 1238774Snsouch * documentation and/or other materials provided with the distribution. 1338774Snsouch * 1438774Snsouch * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1538774Snsouch * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1638774Snsouch * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1738774Snsouch * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1838774Snsouch * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1938774Snsouch * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2038774Snsouch * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2138774Snsouch * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2238774Snsouch * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2338774Snsouch * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2438774Snsouch * SUCH DAMAGE. 2538774Snsouch */ 2638774Snsouch 27119418Sobrien#include <sys/cdefs.h> 28119418Sobrien__FBSDID("$FreeBSD: stable/11/sys/dev/iicbus/iicbus.c 350031 2019-07-16 15:02:28Z avg $"); 29119418Sobrien 3038774Snsouch/* 3138774Snsouch * Autoconfiguration and support routines for the Philips serial I2C bus 3238774Snsouch */ 3338774Snsouch 3438774Snsouch#include <sys/param.h> 3538774Snsouch#include <sys/systm.h> 3638774Snsouch#include <sys/kernel.h> 37181304Sjhb#include <sys/lock.h> 38167856Simp#include <sys/malloc.h> 3938774Snsouch#include <sys/module.h> 40181304Sjhb#include <sys/mutex.h> 41282674Sloos#include <sys/rman.h> 42274641Sian#include <sys/sysctl.h> 43289656Sdumbbell#include <sys/bus.h> 4438774Snsouch 4538774Snsouch#include <dev/iicbus/iiconf.h> 4638774Snsouch#include <dev/iicbus/iicbus.h> 4738774Snsouch 4838774Snsouch#include "iicbus_if.h" 4938774Snsouch 50129152Sjoerg/* See comments below for why auto-scanning is a bad idea. */ 51129152Sjoerg#define SCAN_IICBUS 0 52129152Sjoerg 5340782Snsouchstatic int 5440782Snsouchiicbus_probe(device_t dev) 5540782Snsouch{ 56160372Simp 5742442Snsouch device_set_desc(dev, "Philips I2C bus"); 58186833Snwhitehorn 59186833Snwhitehorn /* Allow other subclasses to override this driver. */ 60187457Snwhitehorn return (BUS_PROBE_GENERIC); 6140782Snsouch} 6240782Snsouch 63129152Sjoerg#if SCAN_IICBUS 64289656Sdumbbellstatic int 6540782Snsouchiic_probe_device(device_t dev, u_char addr) 6640782Snsouch{ 6740782Snsouch int count; 6840782Snsouch char byte; 6940782Snsouch 7040782Snsouch if ((addr & 1) == 0) { 7140782Snsouch /* is device writable? */ 7240782Snsouch if (!iicbus_start(dev, (u_char)addr, 0)) { 7340782Snsouch iicbus_stop(dev); 7440782Snsouch return (1); 7540782Snsouch } 7640782Snsouch } else { 7740782Snsouch /* is device readable? */ 7840782Snsouch if (!iicbus_block_read(dev, (u_char)addr, &byte, 1, &count)) 7940782Snsouch return (1); 8040782Snsouch } 8140782Snsouch 8240782Snsouch return (0); 8340782Snsouch} 8442442Snsouch#endif 8540782Snsouch 8638774Snsouch/* 8740782Snsouch * We add all the devices which we know about. 8840782Snsouch * The generic attach routine will attach them if they are alive. 8938774Snsouch */ 9038774Snsouchstatic int 9140782Snsouchiicbus_attach(device_t dev) 9238774Snsouch{ 93129152Sjoerg#if SCAN_IICBUS 94129152Sjoerg unsigned char addr; 95129152Sjoerg#endif 96167856Simp struct iicbus_softc *sc = IICBUS_SOFTC(dev); 97228257Sadrian int strict; 98129152Sjoerg 99167856Simp sc->dev = dev; 100181304Sjhb mtx_init(&sc->lock, "iicbus", NULL, MTX_DEF); 101274641Sian iicbus_init_frequency(dev, 0); 10240782Snsouch iicbus_reset(dev, IIC_FASTEST, 0, NULL); 103228257Sadrian if (resource_int_value(device_get_name(dev), 104228257Sadrian device_get_unit(dev), "strict", &strict) == 0) 105228257Sadrian sc->strict = strict; 106228257Sadrian else 107228257Sadrian sc->strict = 1; 10838774Snsouch 10942442Snsouch /* device probing is meaningless since the bus is supposed to be 11042442Snsouch * hot-plug. Moreover, some I2C chips do not appreciate random 11142442Snsouch * accesses like stop after start to fast, reads for less than 11242442Snsouch * x bytes... 11342442Snsouch */ 114129152Sjoerg#if SCAN_IICBUS 11540782Snsouch printf("Probing for devices on iicbus%d:", device_get_unit(dev)); 11638774Snsouch 11740782Snsouch /* probe any devices */ 118129152Sjoerg for (addr = 16; addr < 240; addr++) { 11940782Snsouch if (iic_probe_device(dev, (u_char)addr)) { 12040782Snsouch printf(" <%x>", addr); 12140782Snsouch } 12240782Snsouch } 12340782Snsouch printf("\n"); 12442442Snsouch#endif 125181304Sjhb bus_generic_probe(dev); 126167856Simp bus_enumerate_hinted_children(dev); 12738774Snsouch bus_generic_attach(dev); 12838774Snsouch return (0); 12938774Snsouch} 130289656Sdumbbell 13193023Snsouchstatic int 13293023Snsouchiicbus_detach(device_t dev) 13393023Snsouch{ 134181304Sjhb struct iicbus_softc *sc = IICBUS_SOFTC(dev); 135160372Simp 13693023Snsouch iicbus_reset(dev, IIC_FASTEST, 0, NULL); 13793023Snsouch bus_generic_detach(dev); 138289657Sdumbbell device_delete_children(dev); 139181304Sjhb mtx_destroy(&sc->lock); 14093023Snsouch return (0); 14193023Snsouch} 142289656Sdumbbell 14393023Snsouchstatic int 144167856Simpiicbus_print_child(device_t dev, device_t child) 14593023Snsouch{ 146167856Simp struct iicbus_ivar *devi = IICBUS_IVAR(child); 147167856Simp int retval = 0; 148160372Simp 149167856Simp retval += bus_print_child_header(dev, child); 150167856Simp if (devi->addr != 0) 151167856Simp retval += printf(" at addr %#x", devi->addr); 152297199Sjhibbits resource_list_print_type(&devi->rl, "irq", SYS_RES_IRQ, "%jd"); 153167856Simp retval += bus_print_child_footer(dev, child); 154167856Simp 155167856Simp return (retval); 156167856Simp} 157167856Simp 158167856Simpstatic void 159167856Simpiicbus_probe_nomatch(device_t bus, device_t child) 160167856Simp{ 161167856Simp struct iicbus_ivar *devi = IICBUS_IVAR(child); 162167856Simp 163282702Sloos device_printf(bus, "<unknown card> at addr %#x\n", devi->addr); 164167856Simp} 165167856Simp 166167856Simpstatic int 167167856Simpiicbus_child_location_str(device_t bus, device_t child, char *buf, 168167856Simp size_t buflen) 169167856Simp{ 170167856Simp struct iicbus_ivar *devi = IICBUS_IVAR(child); 171167856Simp 172167856Simp snprintf(buf, buflen, "addr=%#x", devi->addr); 17393023Snsouch return (0); 17493023Snsouch} 17593023Snsouch 176167856Simpstatic int 177167856Simpiicbus_child_pnpinfo_str(device_t bus, device_t child, char *buf, 178167856Simp size_t buflen) 179167856Simp{ 180167856Simp *buf = '\0'; 181167856Simp return (0); 182167856Simp} 183167856Simp 184167856Simpstatic int 185188461Simpiicbus_read_ivar(device_t bus, device_t child, int which, uintptr_t *result) 186167856Simp{ 187167856Simp struct iicbus_ivar *devi = IICBUS_IVAR(child); 188167856Simp 189167856Simp switch (which) { 190167856Simp default: 191167856Simp return (EINVAL); 192167856Simp case IICBUS_IVAR_ADDR: 193209800Snwhitehorn *result = devi->addr; 194167856Simp break; 195167856Simp } 196167856Simp return (0); 197167856Simp} 198167856Simp 199310070Savgstatic int 200310070Savgiicbus_write_ivar(device_t bus, device_t child, int which, uintptr_t value) 201310070Savg{ 202310070Savg struct iicbus_ivar *devi = IICBUS_IVAR(child); 203310070Savg 204310070Savg switch (which) { 205310070Savg default: 206310070Savg return (EINVAL); 207310070Savg case IICBUS_IVAR_ADDR: 208310072Savg if (devi->addr != 0) 209310072Savg return (EINVAL); 210310072Savg devi->addr = value; 211310070Savg } 212310070Savg return (0); 213310070Savg} 214310070Savg 215167856Simpstatic device_t 216212413Savgiicbus_add_child(device_t dev, u_int order, const char *name, int unit) 217167856Simp{ 218167856Simp device_t child; 219167856Simp struct iicbus_ivar *devi; 220167856Simp 221167856Simp child = device_add_child_ordered(dev, order, name, unit); 222167856Simp if (child == NULL) 223167856Simp return (child); 224167856Simp devi = malloc(sizeof(struct iicbus_ivar), M_DEVBUF, M_NOWAIT | M_ZERO); 225167856Simp if (devi == NULL) { 226167856Simp device_delete_child(dev, child); 227167856Simp return (0); 228167856Simp } 229282674Sloos resource_list_init(&devi->rl); 230167856Simp device_set_ivars(child, devi); 231167856Simp return (child); 232167856Simp} 233167856Simp 234167856Simpstatic void 235167856Simpiicbus_hinted_child(device_t bus, const char *dname, int dunit) 236167856Simp{ 237167856Simp device_t child; 238282674Sloos int irq; 239167856Simp struct iicbus_ivar *devi; 240167856Simp 241167856Simp child = BUS_ADD_CHILD(bus, 0, dname, dunit); 242167856Simp devi = IICBUS_IVAR(child); 243167856Simp resource_int_value(dname, dunit, "addr", &devi->addr); 244282674Sloos if (resource_int_value(dname, dunit, "irq", &irq) == 0) { 245282674Sloos if (bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1) != 0) 246282674Sloos device_printf(bus, 247282674Sloos "warning: bus_set_resource() failed\n"); 248282674Sloos } 249167856Simp} 250167856Simp 251282674Sloosstatic struct resource_list * 252282674Sloosiicbus_get_resource_list(device_t bus __unused, device_t child) 253282674Sloos{ 254282674Sloos struct iicbus_ivar *devi; 255282674Sloos 256282674Sloos devi = IICBUS_IVAR(child); 257282674Sloos return (&devi->rl); 258282674Sloos} 259282674Sloos 26038774Snsouchint 26138774Snsouchiicbus_generic_intr(device_t dev, int event, char *buf) 26238774Snsouch{ 263160372Simp 26438774Snsouch return (0); 26538774Snsouch} 26638774Snsouch 26740782Snsouchint 26840782Snsouchiicbus_null_callback(device_t dev, int index, caddr_t data) 26940782Snsouch{ 270160372Simp 27140782Snsouch return (0); 27240782Snsouch} 27340782Snsouch 27440782Snsouchint 27540782Snsouchiicbus_null_repeated_start(device_t dev, u_char addr) 27640782Snsouch{ 277160372Simp 27840782Snsouch return (IIC_ENOTSUPP); 27940782Snsouch} 28040782Snsouch 281274641Sianvoid 282274641Sianiicbus_init_frequency(device_t dev, u_int bus_freq) 283274641Sian{ 284274641Sian struct iicbus_softc *sc = IICBUS_SOFTC(dev); 285274641Sian 286274641Sian /* 287274641Sian * If a bus frequency value was passed in, use it. Otherwise initialize 288274641Sian * it first to the standard i2c 100KHz frequency, then override that 289274641Sian * from a hint if one exists. 290274641Sian */ 291274641Sian if (bus_freq > 0) 292274641Sian sc->bus_freq = bus_freq; 293274641Sian else { 294274641Sian sc->bus_freq = 100000; 295274641Sian resource_int_value(device_get_name(dev), device_get_unit(dev), 296274641Sian "frequency", (int *)&sc->bus_freq); 297274641Sian } 298274641Sian /* 299274641Sian * Set up the sysctl that allows the bus frequency to be changed. 300274641Sian * It is flagged as a tunable so that the user can set the value in 301274641Sian * loader(8), and that will override any other setting from any source. 302274641Sian * The sysctl tunable/value is the one most directly controlled by the 303274641Sian * user and thus the one that always takes precedence. 304274641Sian */ 305274641Sian SYSCTL_ADD_UINT(device_get_sysctl_ctx(dev), 306274641Sian SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), 307274641Sian OID_AUTO, "frequency", CTLFLAG_RW | CTLFLAG_TUN, &sc->bus_freq, 308274641Sian sc->bus_freq, "Bus frequency in Hz"); 309274641Sian} 310274641Sian 311274641Sianstatic u_int 312274641Sianiicbus_get_frequency(device_t dev, u_char speed) 313274641Sian{ 314274641Sian struct iicbus_softc *sc = IICBUS_SOFTC(dev); 315274641Sian 316274641Sian /* 317274641Sian * If the frequency has not been configured for the bus, or the request 318274641Sian * is specifically for SLOW speed, use the standard 100KHz rate, else 319274641Sian * use the configured bus speed. 320274641Sian */ 321274641Sian if (sc->bus_freq == 0 || speed == IIC_SLOW) 322274641Sian return (100000); 323274641Sian return (sc->bus_freq); 324274641Sian} 325274641Sian 326167856Simpstatic device_method_t iicbus_methods[] = { 327282668Sloos /* device interface */ 328282668Sloos DEVMETHOD(device_probe, iicbus_probe), 329282668Sloos DEVMETHOD(device_attach, iicbus_attach), 330282668Sloos DEVMETHOD(device_detach, iicbus_detach), 331167856Simp 332282668Sloos /* bus interface */ 333282674Sloos DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 334282674Sloos DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 335282674Sloos DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 336282674Sloos DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 337282674Sloos DEVMETHOD(bus_adjust_resource, bus_generic_adjust_resource), 338282702Sloos DEVMETHOD(bus_alloc_resource, bus_generic_rl_alloc_resource), 339282674Sloos DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 340282702Sloos DEVMETHOD(bus_release_resource, bus_generic_rl_release_resource), 341282702Sloos DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 342282674Sloos DEVMETHOD(bus_get_resource_list, iicbus_get_resource_list), 343282668Sloos DEVMETHOD(bus_add_child, iicbus_add_child), 344282668Sloos DEVMETHOD(bus_print_child, iicbus_print_child), 345167856Simp DEVMETHOD(bus_probe_nomatch, iicbus_probe_nomatch), 346167856Simp DEVMETHOD(bus_read_ivar, iicbus_read_ivar), 347310070Savg DEVMETHOD(bus_write_ivar, iicbus_write_ivar), 348167856Simp DEVMETHOD(bus_child_pnpinfo_str, iicbus_child_pnpinfo_str), 349167856Simp DEVMETHOD(bus_child_location_str, iicbus_child_location_str), 350167856Simp DEVMETHOD(bus_hinted_child, iicbus_hinted_child), 351167856Simp 352167856Simp /* iicbus interface */ 353167856Simp DEVMETHOD(iicbus_transfer, iicbus_transfer), 354274641Sian DEVMETHOD(iicbus_get_frequency, iicbus_get_frequency), 355167856Simp 356227843Smarius DEVMETHOD_END 357167856Simp}; 358167856Simp 359167856Simpdriver_t iicbus_driver = { 360167856Simp "iicbus", 361167856Simp iicbus_methods, 362167856Simp sizeof(struct iicbus_softc), 363167856Simp}; 364167856Simp 365167856Simpdevclass_t iicbus_devclass; 366167856Simp 36793023SnsouchMODULE_VERSION(iicbus, IICBUS_MODVER); 368187261SnwhitehornDRIVER_MODULE(iicbus, iichb, iicbus_driver, iicbus_devclass, 0, 0); 369