 @@ -1,14 +1,14 @@
-/*	$NetBSD: i2c.c,v 1.60 2018/06/07 05:56:18 thorpej Exp $	*/
+/*	$NetBSD: i2c.c,v 1.61 2018/06/07 13:30:49 thorpej Exp $	*/
 /*
  * Copyright (c) 2003 Wasabi Systems, Inc.
  * All rights reserved.
+ *
  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
 @@ -30,53 +30,54 @@
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
 #ifdef _KERNEL_OPT
 #include "opt_i2c.h"
 #endif
 #include <sys/cdefs.h>
-__KERNEL_RCSID(0, "$NetBSD: i2c.c,v 1.60 2018/06/07 05:56:18 thorpej Exp $");
+__KERNEL_RCSID(0, "$NetBSD: i2c.c,v 1.61 2018/06/07 13:30:49 thorpej Exp $");
 #include <sys/param.h>
 #include <sys/systm.h>
 #include <sys/device.h>
 #include <sys/event.h>
 #include <sys/conf.h>
 #include <sys/malloc.h>
 #include <sys/kmem.h>
 #include <sys/kthread.h>
 #include <sys/proc.h>
 #include <sys/kernel.h>
 #include <sys/fcntl.h>
 #include <sys/module.h>
 #include <sys/once.h>
 #include <sys/mutex.h>
 #include <dev/i2c/i2cvar.h>
 #include "ioconf.h"
 #include "locators.h"
 #ifndef I2C_MAX_ADDR
 #define I2C_MAX_ADDR	0x3ff	/* 10-bit address, max */
 #endif
 struct iic_softc {
 	device_t sc_dev;
 	i2c_tag_t sc_tag;
 	int sc_type;
 	device_t sc_devices[I2C_MAX_ADDR + 1];
 };
 static dev_type_open(iic_open);
 static dev_type_close(iic_close);
 static dev_type_ioctl(iic_ioctl);
 int iic_init(void);
 kmutex_t iic_mtx;
 int iic_refcnt;
 @@ -117,61 +118,258 @@ iic_print_direct(void *aux, const char *
+}
 static int
 iic_print(void *aux, const char *pnp)
+{
 	struct i2c_attach_args *ia = aux;
 	if (ia->ia_addr != (i2c_addr_t)IICCF_ADDR_DEFAULT)
 		aprint_normal(" addr 0x%x", ia->ia_addr);
 	return UNCONF;
+}
 static bool
 iic_is_special_address(i2c_addr_t addr)
+{
 	/*
 	 * See: https://www.i2c-bus.org/addressing/
 	 */
 	/* General Call (read) / Start Byte (write) */
 	if (addr == 0x00)
 		return (true);
 	/* CBUS Addresses */
 	if (addr == 0x01)
 		return (true);
 	/* Reserved for Different Bus Formats */
 	if (addr == 0x02)
 		return (true);
 	/* Reserved for future purposes */
 	if (addr == 0x03)
 		return (true);
 	/* High Speed Master Code */
 	if ((addr & 0x7c) == 0x04)
 		return (true);
 	/* 10-bit Slave Addressing prefix */
 	if ((addr & 0x7c) == 0x78)
 		return (true);
 	/* Reserved for future purposes */
 	if ((addr & 0x7c) == 0x7c)
 		return (true);
 	return (false);
+}
 static int
 iic_probe_none(struct iic_softc *sc,
 	       const struct i2c_attach_args *ia, int flags)
+{
 	return (0);
+}
 static int
 iic_probe_smbus_quick_write(struct iic_softc *sc,
 			    const struct i2c_attach_args *ia, int flags)
+{
 	int error;
 	if ((error = iic_acquire_bus(ia->ia_tag, flags)) == 0) {
 		error = iic_smbus_quick_write(ia->ia_tag, ia->ia_addr, flags);
+	}
 	(void) iic_release_bus(ia->ia_tag, flags);
 	return (error);
+}
 static int
 iic_probe_smbus_receive_byte(struct iic_softc *sc,
 			     const struct i2c_attach_args *ia, int flags)
+{
 	int error;
 	if ((error = iic_acquire_bus(ia->ia_tag, flags)) == 0) {
 		uint8_t dummy;
 		error = iic_smbus_receive_byte(ia->ia_tag, ia->ia_addr,
 					       &dummy, flags);
+	}
 	(void) iic_release_bus(ia->ia_tag, flags);
 	return (error);
+}
 static bool
 iic_indirect_driver_is_whitelisted(struct iic_softc *sc, cfdata_t cf)
+{
 	prop_object_iterator_t iter;
 	prop_array_t whitelist;
 	prop_string_t pstr;
 	prop_type_t ptype;
 	bool rv = false;
 	whitelist = prop_dictionary_get(device_properties(sc->sc_dev),
 					I2C_PROP_INDIRECT_DEVICE_WHITELIST);
 	if (whitelist == NULL) {
 		/* No whitelist -> everything allowed */
 		return (true);
+	}
 	if ((ptype = prop_object_type(whitelist)) != PROP_TYPE_ARRAY) {
 		aprint_error_dev(sc->sc_dev,
 		    "invalid property type (%d) for '%s'; must be array (%d)\n",
 		    ptype, I2C_PROP_INDIRECT_DEVICE_WHITELIST, PROP_TYPE_ARRAY);
 		return (false);
+	}
 	iter = prop_array_iterator(whitelist);
 	while ((pstr = prop_object_iterator_next(iter)) != NULL) {
 		if (prop_string_equals_cstring(pstr, cf->cf_name)) {
 			rv = true;
 			break;
+		}
+	}
 	prop_object_iterator_release(iter);
 	return (rv);
+}
 static int
 iic_search(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
+{
 	struct iic_softc *sc = device_private(parent);
 	struct i2c_attach_args ia;
 	int (*probe_func)(struct iic_softc *,
 			  const struct i2c_attach_args *, int);
 	prop_string_t pstr;
 	i2c_addr_t first_addr, last_addr;
 	/*
-	 * I2C doesn't have any regular probing capability.  If we
+	 * Before we do any more work, consult the allowed-driver
-	 * encounter a cfdata with a wild-carded address or a wild-
+	 * white-list for this bus (if any).
 	 * carded parent spec, we skip them because they can only
 	 * be used for direct-coniguration.
 	 */
-	if (cf->cf_loc[IICCF_ADDR] == IICCF_ADDR_DEFAULT ||
+	if (iic_indirect_driver_is_whitelisted(sc, cf) == false)
-	    cf->cf_pspec->cfp_unit == DVUNIT_ANY)
+		return (0);
 		return 0;
 	/* default to "quick write". */
 	probe_func = iic_probe_smbus_quick_write;
 	pstr = prop_dictionary_get(device_properties(sc->sc_dev),
 				   I2C_PROP_INDIRECT_PROBE_STRATEGY);
 	if (pstr == NULL) {
 		/* Use the default. */
 	} else if (prop_string_equals_cstring(pstr,
 					I2C_PROBE_STRATEGY_QUICK_WRITE)) {
 		probe_func = iic_probe_smbus_quick_write;
 	} else if (prop_string_equals_cstring(pstr,
 					I2C_PROBE_STRATEGY_RECEIVE_BYTE)) {
 		probe_func = iic_probe_smbus_receive_byte;
 	} else if (prop_string_equals_cstring(pstr,
 					I2C_PROBE_STRATEGY_NONE)) {
 		probe_func = iic_probe_none;
 	} else {
 		aprint_error_dev(sc->sc_dev,
 			"unknown probe strategy '%s'; defaulting to '%s'\n",
 			prop_string_cstring_nocopy(pstr),
 			I2C_PROBE_STRATEGY_QUICK_WRITE);
 		/* Use the default. */
+	}
 	ia.ia_tag = sc->sc_tag;
 	ia.ia_size = cf->cf_loc[IICCF_SIZE];
 	ia.ia_type = sc->sc_type;
 	ia.ia_name = NULL;
 	ia.ia_ncompat = 0;
 	ia.ia_compat = NULL;
 	ia.ia_prop = NULL;
-	for (ia.ia_addr = 0; ia.ia_addr <= I2C_MAX_ADDR; ia.ia_addr++) {
+	if (cf->cf_loc[IICCF_ADDR] == IICCF_ADDR_DEFAULT) {
 		/*
 		 * This particular config directive has
 		 * wildcarded the address, so we will
 		 * scan the entire bus for it.
 		 */
 		first_addr = 0;
 		last_addr = I2C_MAX_ADDR;
 	} else {
 		/*
 		 * This config directive hard-wires the i2c
 		 * bus address for the device, so there is
 		 * no need to go poking around at any other
 		 * addresses.
 		 */
 		if (cf->cf_loc[IICCF_ADDR] < 0 ||
 		    cf->cf_loc[IICCF_ADDR] > I2C_MAX_ADDR) {
 			/* Invalid config directive! */
 			return (0);
+		}
 		first_addr = last_addr = cf->cf_loc[IICCF_ADDR];
+	}
 	for (ia.ia_addr = first_addr; ia.ia_addr <= last_addr; ia.ia_addr++) {
 		int error, match_result;
 		/*
 		 * Skip I2C addresses that are reserved for
 		 * special purposes.
 		 */
 		if (iic_is_special_address(ia.ia_addr))
 			continue;
 		/*
 		 * Skip addresses where a device is already attached.
 		 */
 		if (sc->sc_devices[ia.ia_addr] != NULL)
 			continue;
-		if (cf->cf_loc[IICCF_ADDR] != ia.ia_addr)
+		/*
 		 * Call the "match" routine for the device.  If that
 		 * returns success, then call the probe strategy
 		 * function.
+		 *
 		 * We do it in this order because i2c devices tend
 		 * to be found at a small number of possible addresses
 		 * (e.g. read-time clocks that are only ever found at
 		 * 0x68).  This gives the driver a chance to skip any
 		 * address that are not valid for the device, saving
 		 * us from having to poke at the bus to see if anything
 		 * is there.
 		 */
 		match_result = config_match(parent, cf, &ia);
 		if (match_result <= 0)
 			continue;
 		/*
 		 * If the quality of the match by the driver was low
 		 * (i.e. matched on being a valid address only, didn't
 		 * perform any hardware probe), invoke our probe routine
 		 * to see if it looks like something is really there.
 		 */
 		if (match_result == I2C_MATCH_ADDRESS_ONLY &&
 		    (error = (*probe_func)(sc, &ia, I2C_F_POLL)) != 0)
 			continue;
-		if (config_match(parent, cf, &ia) > 0)
+		sc->sc_devices[ia.ia_addr] =
-			sc->sc_devices[ia.ia_addr] =
+		    config_attach(parent, cf, &ia, iic_print);
 			    config_attach(parent, cf, &ia, iic_print);
+	}
 	return 0;
+}
 static void
 iic_child_detach(device_t parent, device_t child)
+{
 	struct iic_softc *sc = device_private(parent);
 	int i;
 	for (i = 0; i <= I2C_MAX_ADDR; i++)
 		if (sc->sc_devices[i] == child) {
 @@ -199,26 +397,27 @@ iic_attach(device_t parent, device_t sel
+{
 	struct iic_softc *sc = device_private(self);
 	struct i2cbus_attach_args *iba = aux;
 	prop_array_t child_devices;
 	prop_dictionary_t props;
 	char *buf;
 	i2c_tag_t ic;
 	int rv;
 	bool indirect_config;
 	aprint_naive("\n");
 	aprint_normal(": I2C bus\n");
 	sc->sc_dev = self;
 	sc->sc_tag = iba->iba_tag;
 	sc->sc_type = iba->iba_type;
 	ic = sc->sc_tag;
 	ic->ic_devname = device_xname(self);
 	LIST_INIT(&(sc->sc_tag->ic_list));
 	LIST_INIT(&(sc->sc_tag->ic_proc_list));
 	rv = kthread_create(PRI_NONE, KTHREAD_MUSTJOIN, NULL,
 	    iic_smbus_intr_thread, ic, &ic->ic_intr_thread,
 	    "%s", ic->ic_devname);
 	if (rv)
 		aprint_error_dev(self, "unable to create intr thread\n");

 @@ -1,14 +1,14 @@
-/*	$NetBSD: i2cvar.h,v 1.12 2018/06/07 05:56:18 thorpej Exp $	*/
+/*	$NetBSD: i2cvar.h,v 1.13 2018/06/07 13:30:49 thorpej Exp $	*/
 /*
  * Copyright (c) 2003 Wasabi Systems, Inc.
  * All rights reserved.
+ *
  * Written by Steve C. Woodford and Jason R. Thorpe for Wasabi Systems, Inc.
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
 @@ -39,26 +39,40 @@
 #define	_DEV_I2C_I2CVAR_H_
 #include <dev/i2c/i2c_io.h>
 #include <prop/proplib.h>
 /* Flags passed to i2c routines. */
 #define	I2C_F_WRITE		0x00	/* new transfer is a write */
 #define	I2C_F_READ		0x01	/* new transfer is a read */
 #define	I2C_F_LAST		0x02	/* last byte of read */
 #define	I2C_F_STOP		0x04	/* send stop after byte */
 #define	I2C_F_POLL		0x08	/* poll, don't sleep */
 #define	I2C_F_PEC		0x10	/* smbus packet error checking */
 /* i2c bus instance properties */
 #define	I2C_PROP_INDIRECT_PROBE_STRATEGY	\
 				"i2c-indirect-probe-strategy"
 #define	I2C_PROBE_STRATEGY_QUICK_WRITE		\
 				"smbus-quick-write"
 #define	I2C_PROBE_STRATEGY_RECEIVE_BYTE		\
 				"smbus-receive-byte"
 #define	I2C_PROBE_STRATEGY_NONE			\
 				"none"
 #define	I2C_PROP_INDIRECT_DEVICE_WHITELIST	\
 				"i2c-indirect-device-whitelist"
 	/* value is a prop_array of prop_strings */
 struct ic_intr_list {
 	LIST_ENTRY(ic_intr_list) il_next;
 	int (*il_intr)(void *);
 	void *il_intrarg;
 };
 /*
  * This structure provides the interface between the i2c framework
  * and the underlying i2c controller.
+ *
  * Note that this structure is designed specifically to allow us
  * to either use the autoconfiguration framework or not.  This
  * allows a driver for a board with a private i2c bus use generic
 @@ -137,26 +151,43 @@ struct i2c_attach_args {
 	 * down to MD drivers through the MI i2c bus otherwise.
+	 *
 	 * On ACPI platforms this is the ACPI_HANDLE of the device.
 	 */
 	uintptr_t	ia_cookie;	/* OF node in openfirmware machines */
 };
 /*
  * API presented to i2c controllers.
  */
 int	iicbus_print(void *, const char *);
 int	iic_compat_match(struct i2c_attach_args*, const char **);
 /*
  * Constants to indicate the quality of a match made by a driver's
  * match routine, from lowest to higest:
+ *
  *	-- Address only; no other checks were made.
+ *
  *	-- Address + device probed and recognized.
+ *
  *	-- Direct-config match by "compatible" string.
+ *
  *	-- Direct-config match by specific driver name.
  */
 #define	I2C_MATCH_ADDRESS_ONLY		1
 #define	I2C_MATCH_ADDRESS_AND_PROBE	2
 #define	I2C_MATCH_DIRECT_COMPATIBLE	10
 #define	I2C_MATCH_DIRECT_SPECIFIC	50
 #ifdef _I2C_PRIVATE
 /*
  * Macros used internally by the i2c framework.
  */
 #define	iic_send_start(ic, flags)					\
 	(*(ic)->ic_send_start)((ic)->ic_cookie, (flags))
 #define	iic_send_stop(ic, flags)					\
 	(*(ic)->ic_send_stop)((ic)->ic_cookie, (flags))
 #define	iic_initiate_xfer(ic, addr, flags)				\
 	(*(ic)->ic_initiate_xfer)((ic)->ic_cookie, (addr), (flags))
 #define	iic_read_byte(ic, bytep, flags)					\
 	(*(ic)->ic_read_byte)((ic)->ic_cookie, (bytep), (flags))