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