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