xref: /freebsd/sys/dev/iicbus/iicbus_if.m (revision 2a4a1db342263067035ce69a4017c645da63455d) 
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
29#include <sys/bus.h>
30
31INTERFACE iicbus;
32
33#
34# Interpret interrupt
35#
36METHOD int intr {
37	device_t dev;
38	int event;
39	char *buf;
40};
41
42#
43# iicbus callback
44#
45METHOD int callback {
46	device_t dev;
47	int index;
48	caddr_t data;
49};
50
51#
52# Send REPEATED_START condition
53#
54METHOD int repeated_start {
55	device_t dev;
56	u_char slave;
57	int timeout;
58};
59
60#
61# Send START condition
62#
63METHOD int start {
64	device_t dev;
65	u_char slave;
66	int timeout;
67};
68
69#
70# Send STOP condition
71#
72METHOD int stop {
73	device_t dev;
74};
75
76#
77# Read from I2C bus
78#
79METHOD int read {
80	device_t dev;
81	char *buf;
82	int len;
83	int *bytes;
84	int last;
85	int delay;
86};
87
88#
89# Write to the I2C bus
90#
91METHOD int write {
92	device_t dev;
93	char *buf;
94	int len;
95	int *bytes;
96	int timeout;
97};
98
99#
100# Reset I2C bus
101#
102METHOD int reset {
103	device_t dev;
104	u_char speed;
105	u_char addr;
106	u_char *oldaddr;
107};
108