Home | History | Annotate | Line # | Download | only in i2c
i2c_subr.c revision 1.6 
      1 /*	$NetBSD: i2c_subr.c,v 1.6 2025/09/21 15:11:26 thorpej Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2003 Wasabi Systems, Inc.
      5  * All rights reserved.
      6  *
      7  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  * 3. All advertising materials mentioning features or use of this software
     18  *    must display the following acknowledgement:
     19  *      This product includes software developed for the NetBSD Project by
     20  *      Wasabi Systems, Inc.
     21  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
     22  *    or promote products derived from this software without specific prior
     23  *    written permission.
     24  *
     25  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
     26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
     29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     35  * POSSIBILITY OF SUCH DAMAGE.
     36  */
     37 
     38 #include <sys/cdefs.h>
     39 __KERNEL_RCSID(0, "$NetBSD: i2c_subr.c,v 1.6 2025/09/21 15:11:26 thorpej Exp $");
     40 
     41 #include <sys/param.h>
     42 #include <sys/device.h>
     43 #include <sys/module.h>
     44 
     45 #include <dev/i2c/i2cvar.h>
     46 
     47 MODULE(MODULE_CLASS_EXEC, i2c_subr, NULL);
     48 
     49 static int
     50 i2c_subr_modcmd(modcmd_t cmd, void *opaque)
     51 {
     52 
     53 	switch (cmd) {
     54 	case MODULE_CMD_INIT:
     55 	case MODULE_CMD_FINI:
     56 		return 0;
     57 	default:
     58 		return ENOTTY;
     59 	}
     60 }
     61 
     62 int
     63 iicbus_print(void *aux, const char *pnp)
     64 {
     65 	struct i2cbus_attach_args *iba = aux;
     66 	i2c_tag_t tag = iba->iba_tag;
     67 
     68 	if (pnp != NULL) {
     69 		aprint_normal("iic at %s", pnp);
     70 	}
     71 	if (tag->ic_channel != I2C_CHANNEL_DEFAULT) {
     72 		aprint_normal(" bus %d", tag->ic_channel);
     73 	}
     74 
     75 	return UNCONF;
     76 }
     77 
     78 /*
     79  * iic_acquire_bus_lock --
     80  *
     81  *	Acquire an i2c bus lock.  Used by iic_acquire_bus() and other
     82  *	places that need to acquire an i2c-related lock with the same
     83  *	logic.
     84  */
     85 int
     86 iic_acquire_bus_lock(kmutex_t *lock, int flags)
     87 {
     88 	if (flags & I2C_F_POLL) {
     89 		/*
     90 		 * Polling should only be used in rare and/or
     91 		 * extreme circumstances; most i2c clients should
     92 		 * be allowed to sleep.
     93 		 *
     94 		 * Really, the ONLY user of I2C_F_POLL should be
     95 		 * "when cold", i.e. during early autoconfiguration
     96 		 * when there is only proc0, and we might have to
     97 		 * read SEEPROMs, etc.  There should be no other
     98 		 * users interfering with our access of the i2c bus
     99 		 * in that case.
    100 		 */
    101 		if (mutex_tryenter(lock) == 0) {
    102 			return EBUSY;
    103 		}
    104 	} else {
    105 		/*
    106 		 * N.B. We implement this as a mutex that we hold across
    107 		 * across a series of requests beause we'd like to get the
    108 		 * priority boost if a higher-priority process wants the
    109 		 * i2c bus while we're asleep waiting for the controller
    110 		 * to perform the I/O.
    111 		 *
    112 		 * XXXJRT Disable preemption here?  We'd like to keep the
    113 		 * CPU while holding this resource, unless we release it
    114 		 * voluntarily (which should only happen while waiting for
    115 		 * a controller to complete I/O).
    116 		 */
    117 		mutex_enter(lock);
    118 	}
    119 
    120 	return 0;
    121 }
    122 
    123 /*
    124  * iic_release_bus_lock --
    125  *
    126  *	Release a previously-acquired i2c-related bus lock.
    127  */
    128 void
    129 iic_release_bus_lock(kmutex_t *lock)
    130 {
    131 	mutex_exit(lock);
    132 }
    133