xref: /freebsd/sys/dev/iicbus/iicbus_if.m (revision 4cf49a43559ed9fdad601bdcccd2c55963008675) 
1#
2# Copyright (c) 1998 Nicolas Souchu
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9#    notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26# $FreeBSD$
27#
28
29INTERFACE iicbus;
30
31#
32# Interpret interrupt
33#
34METHOD int intr {
35	device_t dev;
36	int event;
37	char *buf;
38};
39
40#
41# iicbus callback
42#
43METHOD int callback {
44	device_t dev;
45	int index;
46	caddr_t data;
47};
48
49#
50# Send REPEATED_START condition
51#
52METHOD int repeated_start {
53	device_t dev;
54	u_char slave;
55	int timeout;
56};
57
58#
59# Send START condition
60#
61METHOD int start {
62	device_t dev;
63	u_char slave;
64	int timeout;
65};
66
67#
68# Send STOP condition
69#
70METHOD int stop {
71	device_t dev;
72};
73
74#
75# Read from I2C bus
76#
77METHOD int read {
78	device_t dev;
79	char *buf;
80	int len;
81	int *bytes;
82	int last;
83	int delay;
84};
85
86#
87# Write to the I2C bus
88#
89METHOD int write {
90	device_t dev;
91	char *buf;
92	int len;
93	int *bytes;
94	int timeout;
95};
96
97#
98# Reset I2C bus
99#
100METHOD int reset {
101	device_t dev;
102	u_char speed;
103	u_char addr;
104	u_char *oldaddr;
105};
106