xref: /freebsd/sys/dev/iicbus/iicbus_if.m (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
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#include <dev/iicbus/iic.h>
30
31INTERFACE iicbus;
32
33CODE {
34	static int iicbus_nosupport(void)
35	{
36
37		return (ENODEV);
38	}
39
40	static u_int
41	iicbus_default_frequency(device_t bus, u_char speed)
42	{
43
44		return (100000);
45	}
46};
47
48#
49# Interpret interrupt
50#
51METHOD int intr {
52	device_t dev;
53	int event;
54	char *buf;
55};
56
57#
58# iicbus callback
59# Request ownership of bus
60# index: IIC_REQUEST_BUS or IIC_RELEASE_BUS
61# data: pointer to int containing IIC_WAIT or IIC_DONTWAIT and either IIC_INTR or IIC_NOINTR
62# This function is allowed to sleep if *data contains IIC_WAIT.
63#
64METHOD int callback {
65	device_t dev;
66	int index;
67	caddr_t data;
68};
69
70#
71# Send REPEATED_START condition
72#
73METHOD int repeated_start {
74	device_t dev;
75	u_char slave;
76	int timeout;
77} DEFAULT iicbus_nosupport;
78
79#
80# Send START condition
81#
82METHOD int start {
83	device_t dev;
84	u_char slave;
85	int timeout;
86} DEFAULT iicbus_nosupport;
87
88#
89# Send STOP condition
90#
91METHOD int stop {
92	device_t dev;
93} DEFAULT iicbus_nosupport;
94
95#
96# Read from I2C bus
97#
98METHOD int read {
99	device_t dev;
100	char *buf;
101	int len;
102	int *bytes;
103	int last;
104	int delay;
105} DEFAULT iicbus_nosupport;
106
107#
108# Write to the I2C bus
109#
110METHOD int write {
111	device_t dev;
112	const char *buf;
113	int len;
114	int *bytes;
115	int timeout;
116} DEFAULT iicbus_nosupport;
117
118#
119# Reset I2C bus
120#
121METHOD int reset {
122	device_t dev;
123	u_char speed;
124	u_char addr;
125	u_char *oldaddr;
126};
127
128#
129# Generalized Read/Write interface
130#
131METHOD int transfer {
132	device_t dev;
133	struct iic_msg *msgs;
134	uint32_t nmsgs;
135};
136
137#
138# Return the frequency in Hz for the bus running at the given
139# symbolic speed.  Only the IIC_SLOW speed has meaning, it is always
140# 100KHz.  The UNKNOWN, FAST, and FASTEST rates all map to the
141# configured bus frequency, or 100KHz when not otherwise configured.
142#
143METHOD u_int get_frequency {
144	device_t dev;
145	u_char speed;
146} DEFAULT iicbus_default_frequency;
147