1 /* $NetBSD: i2cvar.h,v 1.4 2006/06/26 18:19:40 drochner 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 <dev/i2c/i2c_io.h> 42 43 /* Flags passed to i2c routines. */ 44 #define I2C_F_WRITE 0x00 /* new transfer is a write */ 45 #define I2C_F_READ 0x01 /* new transfer is a read */ 46 #define I2C_F_LAST 0x02 /* last byte of read */ 47 #define I2C_F_STOP 0x04 /* send stop after byte */ 48 #define I2C_F_POLL 0x08 /* poll, don't sleep */ 49 #define I2C_F_PEC 0x10 /* smbus packet error checking */ 50 51 /* 52 * This structure provides the interface between the i2c framework 53 * and the underlying i2c controller. 54 * 55 * Note that this structure is designed specifically to allow us 56 * to either use the autoconfiguration framework or not. This 57 * allows a driver for a board with a private i2c bus use generic 58 * i2c client drivers for chips that might be on that board. 59 */ 60 typedef struct i2c_controller { 61 void *ic_cookie; /* controller private */ 62 63 /* 64 * These provide synchronization in the presence of 65 * multiple users of the i2c bus. When a device 66 * driver wishes to perform transfers on the i2c 67 * bus, the driver should acquire the bus. When 68 * the driver is finished, it should release the 69 * bus. 70 * 71 * This is provided by the back-end since a single 72 * controller may present e.g. i2c and smbus views 73 * of the same set of i2c wires. 74 */ 75 int (*ic_acquire_bus)(void *, int); 76 void (*ic_release_bus)(void *, int); 77 78 /* 79 * The preferred API for clients of the i2c interface 80 * is the scripted API. This handles i2c controllers 81 * that do not provide raw access to the i2c signals. 82 */ 83 int (*ic_exec)(void *, i2c_op_t, i2c_addr_t, const void *, size_t, 84 void *, size_t, int); 85 86 int (*ic_send_start)(void *, int); 87 int (*ic_send_stop)(void *, int); 88 int (*ic_initiate_xfer)(void *, i2c_addr_t, int); 89 int (*ic_read_byte)(void *, uint8_t *, int); 90 int (*ic_write_byte)(void *, uint8_t, int); 91 } *i2c_tag_t; 92 93 /* I2C bus types */ 94 #define I2C_TYPE_SMBUS 1 95 96 /* Used to attach the i2c framework to the controller. */ 97 struct i2cbus_attach_args { 98 i2c_tag_t iba_tag; /* the controller */ 99 int iba_type; /* bus type */ 100 }; 101 102 /* Used to attach devices on the i2c bus. */ 103 struct i2c_attach_args { 104 i2c_tag_t ia_tag; /* our controller */ 105 i2c_addr_t ia_addr; /* address of device */ 106 int ia_size; /* size (for EEPROMs) */ 107 int ia_type; /* bus type */ 108 }; 109 110 /* 111 * API presented to i2c controllers. 112 */ 113 int iicbus_print(void *, const char *); 114 115 #ifdef _I2C_PRIVATE 116 /* 117 * Macros used internally by the i2c framework. 118 */ 119 #define iic_send_start(ic, flags) \ 120 (*(ic)->ic_send_start)((ic)->ic_cookie, (flags)) 121 #define iic_send_stop(ic, flags) \ 122 (*(ic)->ic_send_stop)((ic)->ic_cookie, (flags)) 123 #define iic_initiate_xfer(ic, addr, flags) \ 124 (*(ic)->ic_initiate_xfer)((ic)->ic_cookie, (addr), (flags)) 125 126 #define iic_read_byte(ic, bytep, flags) \ 127 (*(ic)->ic_read_byte)((ic)->ic_cookie, (bytep), (flags)) 128 #define iic_write_byte(ic, byte, flags) \ 129 (*(ic)->ic_write_byte)((ic)->ic_cookie, (byte), (flags)) 130 #endif /* _I2C_PRIVATE */ 131 132 /* 133 * Simplified API for clients of the i2c framework. Definitions 134 * in <dev/i2c/i2c_io.h>. 135 */ 136 #define iic_acquire_bus(ic, flags) \ 137 (*(ic)->ic_acquire_bus)((ic)->ic_cookie, (flags)) 138 #define iic_release_bus(ic, flags) \ 139 (*(ic)->ic_release_bus)((ic)->ic_cookie, (flags)) 140 141 int iic_exec(i2c_tag_t, i2c_op_t, i2c_addr_t, const void *, 142 size_t, void *, size_t, int); 143 144 int iic_smbus_write_byte(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t, int); 145 int iic_smbus_write_word(i2c_tag_t, i2c_addr_t, uint8_t, uint16_t, int); 146 int iic_smbus_read_byte(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t *, int); 147 int iic_smbus_read_word(i2c_tag_t, i2c_addr_t, uint8_t, uint16_t *, int); 148 int iic_smbus_receive_byte(i2c_tag_t, i2c_addr_t, uint8_t *, int); 149 int iic_smbus_send_byte(i2c_tag_t, i2c_addr_t, uint8_t, int); 150 int iic_smbus_quick_read(i2c_tag_t, i2c_addr_t, int); 151 int iic_smbus_quick_write(i2c_tag_t, i2c_addr_t, int); 152 int iic_smbus_block_read(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t *, 153 size_t, int); 154 int iic_smbus_block_write(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t *, 155 size_t, int); 156 157 #endif /* _DEV_I2C_I2CVAR_H_ */ 158