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