1 /* $OpenBSD: i2cvar.h,v 1.10 2006/02/08 23:15:58 dlg Exp $ */
2 /* $NetBSD: i2cvar.h,v 1.1 2003/09/30 00:35:31 thorpej Exp $ */
3
4 /*
5 * Copyright (c) 2003 Wasabi Systems, Inc.
6 * All rights reserved.
7 *
8 * Written by Steve C. Woodford and Jason R. Thorpe for Wasabi Systems, Inc.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed for the NetBSD Project by
21 * Wasabi Systems, Inc.
22 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
23 * or promote products derived from this software without specific prior
24 * written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
27 * 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 WASABI SYSTEMS, INC
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 #ifndef _DEV_I2C_I2CVAR_H_
40 #define _DEV_I2C_I2CVAR_H_
41
42 #include <dev/i2c/i2c_io.h>
43
44 /* Flags passed to i2c routines. */
45 #define I2C_F_WRITE 0x00 /* new transfer is a write */
46 #define I2C_F_READ 0x01 /* new transfer is a read */
47 #define I2C_F_LAST 0x02 /* last byte of read */
48 #define I2C_F_STOP 0x04 /* send stop after byte */
49 #define I2C_F_POLL 0x08 /* poll, don't sleep */
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 /* Used to attach the i2c framework to the controller. */
94 struct i2cbus_attach_args {
95 const char *iba_name; /* bus name ("iic") */
96 i2c_tag_t iba_tag; /* the controller */
97 void (*iba_bus_scan)(struct device *, struct i2cbus_attach_args *,
98 void *);
99 void *iba_bus_scan_arg;
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 char *ia_name; /* chip name */
108 void *ia_cookie; /* pass extra info from bus to dev */
109 };
110
111 /*
112 * API presented to i2c controllers.
113 */
114 int iicbus_print(void *, const char *);
115
116 #ifdef _I2C_PRIVATE
117 /*
118 * Macros used internally by the i2c framework.
119 */
120 #define iic_send_start(ic, flags) \
121 (*(ic)->ic_send_start)((ic)->ic_cookie, (flags))
122 #define iic_send_stop(ic, flags) \
123 (*(ic)->ic_send_stop)((ic)->ic_cookie, (flags))
124 #define iic_initiate_xfer(ic, addr, flags) \
125 (*(ic)->ic_initiate_xfer)((ic)->ic_cookie, (addr), (flags))
126
127 #define iic_read_byte(ic, bytep, flags) \
128 (*(ic)->ic_read_byte)((ic)->ic_cookie, (bytep), (flags))
129 #define iic_write_byte(ic, byte, flags) \
130 (*(ic)->ic_write_byte)((ic)->ic_cookie, (byte), (flags))
131
132 void iic_scan(struct device *, struct i2cbus_attach_args *);
133 int iic_print(void *, const char *);
134 #endif /* _I2C_PRIVATE */
135
136 /*
137 * Simplified API for clients of the i2c framework. Definitions
138 * in <dev/i2c/i2c_io.h>.
139 */
140 #define iic_acquire_bus(ic, flags) \
141 (*(ic)->ic_acquire_bus)((ic)->ic_cookie, (flags))
142 #define iic_release_bus(ic, flags) \
143 (*(ic)->ic_release_bus)((ic)->ic_cookie, (flags))
144
145 int iic_exec(i2c_tag_t, i2c_op_t, i2c_addr_t, const void *,
146 size_t, void *, size_t, int);
147
148 int iic_smbus_write_byte(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t, int);
149 int iic_smbus_read_byte(i2c_tag_t, i2c_addr_t, uint8_t, uint8_t *, int);
150 int iic_smbus_receive_byte(i2c_tag_t, i2c_addr_t, uint8_t *, int);
151
152 void iic_ignore_addr(u_int8_t addr);
153
154 #endif /* _DEV_I2C_I2CVAR_H_ */