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