i2c.h revision 1.5.4.3
1 1.5.4.2 tls /* $NetBSD: i2c.h,v 1.5.4.3 2017/12/03 11:37:59 jdolecek Exp $ */ 2 1.5.4.2 tls 3 1.5.4.2 tls /*- 4 1.5.4.3 jdolecek * Copyright (c) 2015 The NetBSD Foundation, Inc. 5 1.5.4.2 tls * All rights reserved. 6 1.5.4.2 tls * 7 1.5.4.2 tls * This code is derived from software contributed to The NetBSD Foundation 8 1.5.4.2 tls * by Taylor R. Campbell. 9 1.5.4.2 tls * 10 1.5.4.2 tls * Redistribution and use in source and binary forms, with or without 11 1.5.4.2 tls * modification, are permitted provided that the following conditions 12 1.5.4.2 tls * are met: 13 1.5.4.2 tls * 1. Redistributions of source code must retain the above copyright 14 1.5.4.2 tls * notice, this list of conditions and the following disclaimer. 15 1.5.4.2 tls * 2. Redistributions in binary form must reproduce the above copyright 16 1.5.4.2 tls * notice, this list of conditions and the following disclaimer in the 17 1.5.4.2 tls * documentation and/or other materials provided with the distribution. 18 1.5.4.2 tls * 19 1.5.4.2 tls * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 1.5.4.2 tls * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 1.5.4.2 tls * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 1.5.4.2 tls * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 1.5.4.2 tls * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 1.5.4.2 tls * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 1.5.4.2 tls * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 1.5.4.2 tls * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 1.5.4.2 tls * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 1.5.4.2 tls * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 1.5.4.2 tls * POSSIBILITY OF SUCH DAMAGE. 30 1.5.4.2 tls */ 31 1.5.4.2 tls 32 1.5.4.2 tls #ifndef _LINUX_I2C_H_ 33 1.5.4.2 tls #define _LINUX_I2C_H_ 34 1.5.4.2 tls 35 1.5.4.2 tls #include <sys/types.h> 36 1.5.4.2 tls #include <sys/device_if.h> 37 1.5.4.2 tls #include <sys/queue.h> /* XXX include order botch: i2cvar.h needs */ 38 1.5.4.3 jdolecek #include <sys/systm.h> 39 1.5.4.2 tls 40 1.5.4.2 tls #include <dev/i2c/i2cvar.h> 41 1.5.4.2 tls 42 1.5.4.3 jdolecek #include <linux/pm.h> 43 1.5.4.3 jdolecek 44 1.5.4.2 tls struct i2c_adapter; 45 1.5.4.2 tls struct i2c_algorithm; 46 1.5.4.2 tls struct i2c_msg; 47 1.5.4.2 tls 48 1.5.4.2 tls #define I2C_NAME_SIZE 20 49 1.5.4.2 tls 50 1.5.4.3 jdolecek /* 51 1.5.4.3 jdolecek * I2C_M_*: i2c_msg flags 52 1.5.4.3 jdolecek */ 53 1.5.4.3 jdolecek #define I2C_M_RD 0x01 /* xfer is read, not write */ 54 1.5.4.3 jdolecek #define I2C_M_NOSTART 0x02 /* don't initiate xfer */ 55 1.5.4.3 jdolecek #define I2C_M_TEN 0x04 /* 10-bit chip address */ 56 1.5.4.2 tls 57 1.5.4.3 jdolecek /* 58 1.5.4.3 jdolecek * I2C_CLASS_*: i2c_adapter classes 59 1.5.4.3 jdolecek */ 60 1.5.4.3 jdolecek #define I2C_CLASS_DDC 0x01 61 1.5.4.2 tls 62 1.5.4.3 jdolecek /* 63 1.5.4.3 jdolecek * I2C_FUNC_*: i2c_adapter functionality bits 64 1.5.4.3 jdolecek */ 65 1.5.4.3 jdolecek #define I2C_FUNC_I2C 0x01 66 1.5.4.3 jdolecek #define I2C_FUNC_NOSTART 0x02 67 1.5.4.3 jdolecek #define I2C_FUNC_SMBUS_EMUL 0x04 68 1.5.4.3 jdolecek #define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x08 69 1.5.4.3 jdolecek #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x10 70 1.5.4.3 jdolecek #define I2C_FUNC_10BIT_ADDR 0x20 71 1.5.4.2 tls 72 1.5.4.3 jdolecek /* 73 1.5.4.3 jdolecek * struct i2c_msg: A single i2c message request on a particular 74 1.5.4.3 jdolecek * address. Read if I2C_M_RD is set, write otherwise. 75 1.5.4.3 jdolecek */ 76 1.5.4.3 jdolecek struct i2c_msg { 77 1.5.4.3 jdolecek i2c_addr_t addr; 78 1.5.4.3 jdolecek uint16_t flags; /* I2C_M_* */ 79 1.5.4.3 jdolecek uint16_t len; 80 1.5.4.3 jdolecek uint8_t *buf; 81 1.5.4.2 tls }; 82 1.5.4.2 tls 83 1.5.4.3 jdolecek /* 84 1.5.4.3 jdolecek * struct i2c_adapter: An i2c bus controller. 85 1.5.4.3 jdolecek */ 86 1.5.4.2 tls struct i2c_adapter { 87 1.5.4.2 tls char name[I2C_NAME_SIZE]; 88 1.5.4.2 tls const struct i2c_algorithm *algo; 89 1.5.4.2 tls void *algo_data; 90 1.5.4.2 tls int retries; 91 1.5.4.2 tls struct module *owner; 92 1.5.4.3 jdolecek unsigned int class; /* I2C_CLASS_* */ 93 1.5.4.2 tls struct { 94 1.5.4.2 tls device_t parent; 95 1.5.4.3 jdolecek } dev; 96 1.5.4.2 tls void *i2ca_adapdata; 97 1.5.4.2 tls }; 98 1.5.4.2 tls 99 1.5.4.3 jdolecek /* 100 1.5.4.3 jdolecek * struct i2c_algorithm: A procedure for transferring an i2c message on 101 1.5.4.3 jdolecek * an i2c bus, along with a set of flags describing its functionality. 102 1.5.4.3 jdolecek */ 103 1.5.4.3 jdolecek struct i2c_algorithm { 104 1.5.4.3 jdolecek int (*master_xfer)(struct i2c_adapter *, struct i2c_msg *, 105 1.5.4.3 jdolecek int); 106 1.5.4.3 jdolecek uint32_t (*functionality)(struct i2c_adapter *); 107 1.5.4.3 jdolecek }; 108 1.5.4.3 jdolecek 109 1.5.4.3 jdolecek /* 110 1.5.4.3 jdolecek * struct i2c_board_info: Parameters to find an i2c bus and a slave on 111 1.5.4.3 jdolecek * it. type is the name of an i2c driver; addr is the slave address; 112 1.5.4.3 jdolecek * platform_data is an extra parameter to pass to the i2c driver. 113 1.5.4.3 jdolecek */ 114 1.5.4.3 jdolecek struct i2c_board_info { 115 1.5.4.3 jdolecek char type[I2C_NAME_SIZE]; 116 1.5.4.3 jdolecek uint16_t addr; 117 1.5.4.3 jdolecek uint16_t flags; 118 1.5.4.3 jdolecek void *platform_data; 119 1.5.4.3 jdolecek }; 120 1.5.4.3 jdolecek 121 1.5.4.3 jdolecek #define I2C_BOARD_INFO(board_type, board_addr) \ 122 1.5.4.3 jdolecek .type = (board_type), \ 123 1.5.4.3 jdolecek .addr = (board_addr) 124 1.5.4.3 jdolecek 125 1.5.4.3 jdolecek /* 126 1.5.4.3 jdolecek * struct i2c_client: An i2c slave device at a particular address on a 127 1.5.4.3 jdolecek * particular bus. 128 1.5.4.3 jdolecek */ 129 1.5.4.3 jdolecek struct i2c_client { 130 1.5.4.3 jdolecek struct i2c_adapter *adapter; 131 1.5.4.3 jdolecek uint16_t addr; 132 1.5.4.3 jdolecek uint16_t flags; 133 1.5.4.3 jdolecek }; 134 1.5.4.3 jdolecek 135 1.5.4.3 jdolecek /* 136 1.5.4.3 jdolecek * struct i2c_device_id: Device id naming a class of i2c slave devices 137 1.5.4.3 jdolecek * and parameters to the driver for the devices. 138 1.5.4.3 jdolecek */ 139 1.5.4.3 jdolecek struct i2c_device_id { 140 1.5.4.3 jdolecek char name[I2C_NAME_SIZE]; 141 1.5.4.3 jdolecek unsigned long driver_data; 142 1.5.4.3 jdolecek }; 143 1.5.4.3 jdolecek 144 1.5.4.3 jdolecek /* 145 1.5.4.3 jdolecek * struct i2c_driver: A driver for a class of i2c slave devices. We 146 1.5.4.3 jdolecek * don't actually use this. 147 1.5.4.3 jdolecek */ 148 1.5.4.3 jdolecek struct i2c_driver { 149 1.5.4.3 jdolecek int (*probe)(struct i2c_client *, const struct i2c_device_id *); 150 1.5.4.3 jdolecek int (*remove)(struct i2c_client *); 151 1.5.4.3 jdolecek struct { 152 1.5.4.3 jdolecek char name[I2C_NAME_SIZE]; 153 1.5.4.3 jdolecek const struct dev_pm_ops pm; 154 1.5.4.3 jdolecek } driver; 155 1.5.4.3 jdolecek }; 156 1.5.4.3 jdolecek 157 1.5.4.3 jdolecek /* 158 1.5.4.3 jdolecek * Adapter management. We don't register these in a global database 159 1.5.4.3 jdolecek * like Linux, so these are just stubs. 160 1.5.4.3 jdolecek */ 161 1.5.4.2 tls static inline int 162 1.5.4.2 tls i2c_add_adapter(struct i2c_adapter *adapter __unused) 163 1.5.4.2 tls { 164 1.5.4.3 jdolecek 165 1.5.4.2 tls return 0; 166 1.5.4.2 tls } 167 1.5.4.2 tls 168 1.5.4.2 tls static inline void 169 1.5.4.2 tls i2c_del_adapter(struct i2c_adapter *adapter __unused) 170 1.5.4.2 tls { 171 1.5.4.2 tls } 172 1.5.4.2 tls 173 1.5.4.2 tls static inline void * 174 1.5.4.2 tls i2c_get_adapdata(const struct i2c_adapter *adapter) 175 1.5.4.2 tls { 176 1.5.4.2 tls 177 1.5.4.2 tls return adapter->i2ca_adapdata; 178 1.5.4.2 tls } 179 1.5.4.2 tls 180 1.5.4.2 tls static inline void 181 1.5.4.2 tls i2c_set_adapdata(struct i2c_adapter *adapter, void *data) 182 1.5.4.2 tls { 183 1.5.4.2 tls 184 1.5.4.2 tls adapter->i2ca_adapdata = data; 185 1.5.4.2 tls } 186 1.5.4.2 tls 187 1.5.4.2 tls /* XXX Make the nm output a little more greppable... */ 188 1.5.4.3 jdolecek #define i2c_master_recv linux_i2c_master_recv 189 1.5.4.3 jdolecek #define i2c_master_send linux_i2c_master_send 190 1.5.4.3 jdolecek #define i2c_new_device linux_i2c_new_device 191 1.5.4.3 jdolecek #define i2c_transfer linux_i2c_transfer 192 1.5.4.3 jdolecek #define i2c_unregister_device linux_i2c_unregister_device 193 1.5.4.3 jdolecek 194 1.5.4.3 jdolecek int i2c_master_send(const struct i2c_client *, const char *, int); 195 1.5.4.3 jdolecek int i2c_master_recv(const struct i2c_client *, char *, int); 196 1.5.4.3 jdolecek struct i2c_client * 197 1.5.4.3 jdolecek i2c_new_device(struct i2c_adapter *, const struct i2c_board_info *); 198 1.5.4.2 tls int i2c_transfer(struct i2c_adapter *, struct i2c_msg *, int); 199 1.5.4.3 jdolecek void i2c_unregister_device(struct i2c_client *); 200 1.5.4.2 tls 201 1.5.4.2 tls #endif /* _LINUX_I2C_H_ */ 202
Indexes created Thu Oct 02 01:09:59 GMT 2025