xref: /freebsd/sys/dev/iicbus/iicbb_if.m (revision 243e928310d073338c5ec089f0dce238a80b9866) 
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 iicbb;
32
33#
34# Default implementation of optional methods
35#
36CODE {
37	static int
38	null_pre_xfer(device_t dev)
39	{
40		return 0;
41	}
42
43	static void
44	null_post_xfer(device_t dev)
45	{
46	}
47
48	static int
49	null_callback(device_t dev, int index, caddr_t data)
50	{
51		return 0;
52	}
53};
54
55#
56# iicbus callback
57#
58METHOD int callback {
59	device_t dev;
60	int index;
61	caddr_t data;
62} DEFAULT null_callback;
63
64#
65# Prepare device for I2C transfer
66#
67METHOD int pre_xfer {
68	device_t dev;
69} DEFAULT null_pre_xfer;
70
71#
72# Cleanup device after I2C transfer
73#
74METHOD void post_xfer {
75	device_t dev;
76} DEFAULT null_post_xfer;
77
78#
79# Set I2C bus data line
80#
81METHOD void setsda {
82	device_t dev;
83	int val;
84};
85
86#
87# Set I2C bus clock line
88#
89METHOD void setscl {
90	device_t dev;
91	int val;
92};
93
94#
95# Get I2C bus data line
96#
97#
98METHOD int getsda {
99	device_t dev;
100};
101
102#
103# Get I2C bus clock line
104#
105#
106METHOD int getscl {
107	device_t dev;
108};
109
110#
111# Reset interface
112#
113METHOD int reset {
114	device_t dev;
115	u_char speed;
116	u_char addr;
117	u_char *oldaddr;
118};
119