i2cvar.h revision 1.19
1 /* $NetBSD: i2cvar.h,v 1.19 2019/12/22 23:23:32 thorpej Exp $ */ 2 3 /* 4 * Copyright (c) 2003 Wasabi Systems, Inc. 5 * All rights reserved. 6 * 7 * Written by Steve C. Woodford and 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 #ifndef _DEV_I2C_I2CVAR_H_ 39 #define _DEV_I2C_I2CVAR_H_ 40 41 #include <sys/device.h> 42 #include <sys/mutex.h> 43 #include <dev/i2c/i2c_io.h> 44 #include <prop/proplib.h> 45 46 /* Flags passed to i2c routines. */ 47 #define I2C_F_WRITE 0x00 /* new transfer is a write */ 48 #define I2C_F_READ 0x01 /* new transfer is a read */ 49 #define I2C_F_LAST 0x02 /* last byte of read */ 50 #define I2C_F_STOP 0x04 /* send stop after byte */ 51 #define I2C_F_POLL 0x08 /* poll, don't sleep */ 52 #define I2C_F_PEC 0x10 /* smbus packet error checking */ 53 54 /* i2c bus instance properties */ 55 #define I2C_PROP_INDIRECT_PROBE_STRATEGY \ 56 "i2c-indirect-probe-strategy" 57 #define I2C_PROBE_STRATEGY_QUICK_WRITE \ 58 "smbus-quick-write" 59 #define I2C_PROBE_STRATEGY_RECEIVE_BYTE \ 60 "smbus-receive-byte" 61 #define I2C_PROBE_STRATEGY_NONE \ 62 "none" 63 64 #define I2C_PROP_INDIRECT_DEVICE_WHITELIST \ 65 "i2c-indirect-device-whitelist" 66 /* value is a prop_array of prop_strings */ 67 68 struct ic_intr_list { 69 LIST_ENTRY(ic_intr_list) il_next; 70 int (*il_intr)(void *); 71 void *il_intrarg; 72 }; 73 74 /* 75 * This structure provides the interface between the i2c framework 76 * and the underlying i2c controller. 77 * 78 * Note that this structure is designed specifically to allow us 79 * to either use the autoconfiguration framework or not. This 80 * allows a driver for a board with a private i2c bus use generic 81 * i2c client drivers for chips that might be on that board. 82 */ 83 typedef struct i2c_controller { 84 void *ic_cookie; /* controller private */ 85 86 /* 87 * These provide synchronization in the presence of 88 * multiple users of the i2c bus. When a device 89 * driver wishes to perform transfers on the i2c 90 * bus, the driver should acquire the bus. When 91 * the driver is finished, it should release the 92 * bus. 93 * 94 * The main synchronization logic is handled by the 95 * generic i2c layer, but optional hooks to back-end 96 * drivers are provided in case additional processing 97 * is needed (e.g. enabling the i2c controller). 98 */ 99 kmutex_t ic_bus_lock; 100 int (*ic_acquire_bus)(void *, int); 101 void (*ic_release_bus)(void *, int); 102 103 /* 104 * The preferred API for clients of the i2c interface 105 * is the scripted API. This handles i2c controllers 106 * that do not provide raw access to the i2c signals. 107 */ 108 int (*ic_exec)(void *, i2c_op_t, i2c_addr_t, const void *, size_t, 109 void *, size_t, int); 110 111 int (*ic_send_start)(void *, int); 112 int (*ic_send_stop)(void *, int); 113 int (*ic_initiate_xfer)(void *, i2c_addr_t, int); 114 int (*ic_read_byte)(void *, uint8_t *, int); 115 int (*ic_write_byte)(void *, uint8_t, int); 116 117 LIST_HEAD(, ic_intr_list) ic_list; 118 LIST_HEAD(, ic_intr_list) ic_proc_list; 119 volatile int ic_running; 120 volatile int ic_pending; 121 struct lwp *ic_intr_thread; 122 const char *ic_devname; 123 } *i2c_tag_t; 124 125 /* Used to attach the i2c framework to the controller. */ 126 struct i2cbus_attach_args { 127 i2c_tag_t iba_tag; /* the controller */ 128 prop_array_t iba_child_devices; /* child devices (direct config) */ 129 }; 130 131 /* Used to attach devices on the i2c bus. */ 132 struct i2c_attach_args { 133 i2c_tag_t ia_tag; /* our controller */ 134 i2c_addr_t ia_addr; /* address of device */ 135 int ia_type; /* bus type */ 136 /* only set if using direct config */ 137 const char * ia_name; /* name of the device */ 138 int ia_ncompat; /* number of pointers in the 139 ia_compat array */ 140 const char ** ia_compat; /* chip names */ 141 prop_dictionary_t ia_prop; /* dictionnary for this device */ 142 /* 143 * The following is of limited usefulness and should only be used 144 * in rare cases where we really know what we are doing. Example: 145 * a machine dependent i2c driver (located in sys/arch/$arch/dev) 146 * needing to access some firmware properties. 147 * Depending on the firmware in use, an identifier for the device 148 * may be present. Example: on OpenFirmware machines the device 149 * tree OF node - if available. This info is hard to transport 150 * down to MD drivers through the MI i2c bus otherwise. 151 * 152 * On ACPI platforms this is the ACPI_HANDLE of the device. 153 */ 154 uintptr_t ia_cookie; /* OF node in openfirmware machines */ 155 }; 156 157 /* 158 * API presented to i2c controllers. 159 */ 160 int iicbus_print(void *, const char *); 161 void iic_tag_init(i2c_tag_t); 162 void iic_tag_fini(i2c_tag_t); 163 164 /* 165 * API presented to i2c devices. 166 */ 167 int iic_compatible_match(const struct i2c_attach_args *, 168 const struct device_compatible_entry *, 169 const struct device_compatible_entry **); 170 bool iic_use_direct_match(const struct i2c_attach_args *, const cfdata_t, 171 const struct device_compatible_entry *, int *); 172 173 /* 174 * Constants to indicate the quality of a match made by a driver's 175 * match routine, from lowest to higest: 176 * 177 * -- Address only; no other checks were made. 178 * 179 * -- Address + device probed and recognized. 180 * 181 * -- Direct-config match by "compatible" string. 182 * 183 * -- Direct-config match by specific driver name. 184 */ 185 #define I2C_MATCH_ADDRESS_ONLY 1 186 #define I2C_MATCH_ADDRESS_AND_PROBE 2 187 #define I2C_MATCH_DIRECT_COMPATIBLE 10 188 #define I2C_MATCH_DIRECT_COMPATIBLE_MAX 99 189 #define I2C_MATCH_DIRECT_SPECIFIC 100 190 191 #ifdef _I2C_PRIVATE 192 /* 193 * Macros used internally by the i2c framework. 194 */ 195 #define iic_send_start(ic, flags) \ 196 (*(ic)->ic_send_start)((ic)->ic_cookie, (flags)) 197 #define iic_send_stop(ic, flags) \ 198 (*(ic)->ic_send_stop)((ic)->ic_cookie, (flags)) 199 #define iic_initiate_xfer(ic, addr, flags) \ 200 (*(ic)->ic_initiate_xfer)((ic)->ic_cookie, (addr), (flags)) 201 202 #define iic_read_byte(ic, bytep, flags) \ 203 (*(ic)->ic_read_byte)((ic)->ic_cookie, (bytep), (flags)) 204 #define iic_write_byte(ic, byte, flags) \ 205 (*(ic)->ic_write_byte)((ic)->ic_cookie, (byte), (flags)) 206 #endif /* _I2C_PRIVATE */ 207 208 /* 209 * Simplified API for clients of the i2c framework. Definitions 210 * in <dev/i2c/i2c_io.h>. 211 */ 212 int iic_acquire_bus(i2c_tag_t, int); 213 void iic_release_bus(i2c_tag_t, int); 214 int iic_exec(i2c_tag_t, i2c_op_t, i2c_addr_t, const void *, 215 size_t, void *, size_t, int); 216 217 int iic_smbus_write_byte(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t, int); 218 int iic_smbus_write_word(i2c_tag_t, i2c_addr_t, uint8_t, uint16_t, int); 219 int iic_smbus_read_byte(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t *, int); 220 int iic_smbus_read_word(i2c_tag_t, i2c_addr_t, uint8_t, uint16_t *, int); 221 int iic_smbus_receive_byte(i2c_tag_t, i2c_addr_t, uint8_t *, int); 222 int iic_smbus_send_byte(i2c_tag_t, i2c_addr_t, uint8_t, int); 223 int iic_smbus_quick_read(i2c_tag_t, i2c_addr_t, int); 224 int iic_smbus_quick_write(i2c_tag_t, i2c_addr_t, int); 225 int iic_smbus_block_read(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t *, 226 size_t, int); 227 int iic_smbus_block_write(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t *, 228 size_t, int); 229 230 void * iic_smbus_intr_establish(i2c_tag_t, int (*)(void *), void *); 231 void * iic_smbus_intr_establish_proc(i2c_tag_t, int (*)(void *), void *); 232 void iic_smbus_intr_disestablish(i2c_tag_t, void *); 233 void iic_smbus_intr_disestablish_proc(i2c_tag_t, void *); 234 int iic_smbus_intr(i2c_tag_t); 235 236 #endif /* _DEV_I2C_I2CVAR_H_ */ 237
Indexes created Tue Sep 23 23:09:58 GMT 2025