Home | History | Annotate | Line # | Download | only in i2c
i2c_calls.h revision 1.1 
      1 /*	$NetBSD: i2c_calls.h,v 1.1 2025/09/21 17:54:16 thorpej Exp $	*/
      2 
      3 /*
      4  * THIS FILE IS AUTOMATICALLY GENERATED.  DO NOT EDIT.
      5  *
      6  * generated from:
      7  *	NetBSD
      8  */
      9 
     10 /*-
     11  * Copyright (c) 2021 The NetBSD Foundation, Inc.
     12  * All rights reserved.
     13  *
     14  * This code is derived from software contributed to The NetBSD Foundation
     15  * by Jason R. Thorpe.
     16  *
     17  * Redistribution and use in source and binary forms, with or without
     18  * modification, are permitted provided that the following conditions
     19  * are met:
     20  * 1. Redistributions of source code must retain the above copyright
     21  *    notice, this list of conditions and the following disclaimer.
     22  * 2. Redistributions in binary form must reproduce the above copyright
     23  *    notice, this list of conditions and the following disclaimer in the
     24  *    documentation and/or other materials provided with the distribution.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 /*
     40  * Device calls used by the I2C subsystem.
     41  */
     42 
     43 #ifndef _I2C_CALLS_H_
     44 #define _I2C_CALLS_H_
     45 
     46 #include <sys/device.h>
     47 
     48 #include <dev/i2c/i2cvar.h>
     49 
     50 /*
     51  * i2c-enumerate-devices
     52  *
     53  * Enumerates the devices connected to the I2C bus, filling out
     54  * the i2c_attach_args and invoking the callback for each one.
     55  * The caller provides the storage for the i2c_attach_args.
     56  *
     57  * If the callback returns true, then enumeration continues.  If
     58  * the callback returns false, enumeration is stopped.
     59  *
     60  * Call returns 0 if successful, or an error code upon failure:
     61  *
     62  * ENOTSUP	The device handle implementation for the
     63  *		I2C bus does not support this device call.
     64  */
     65 struct i2c_enumerate_devices_args {
     66 	struct i2c_attach_args *ia;	/* IN */
     67 	bool (*callback)(device_t, struct i2c_enumerate_devices_args *);
     68 };
     69 
     70 union i2c_enumerate_devices_binding {
     71 	struct device_call_generic generic;
     72 	struct {
     73 		const char *name;
     74 		struct i2c_enumerate_devices_args *args;
     75 	} binding;
     76 };
     77 
     78 #define I2C_ENUMERATE_DEVICES_STR "i2c-enumerate-devices"
     79 
     80 #define I2C_ENUMERATE_DEVICES(_args_) \
     81 	&((const union i2c_enumerate_devices_binding){ \
     82 		.binding.name = "i2c-enumerate-devices", \
     83 		.binding.args = (_args_), \
     84 	})
     85 
     86 #endif /* _I2C_CALLS_H_ */
     87