freebsd-dev/sys/dev/iicbus/iicbus_if.m
Ian Lepore 844aff82a6 Allow i2c bus speed to be configured via hints, FDT data, and sysctl.
The current support for controlling i2c bus speed is an inconsistant mess.
There are 4 symbolic speed values defined, UNKNOWN, SLOW, FAST, FASTEST.
It seems to be universally assumed that SLOW means the standard 100KHz
rate from the original spec.  Nothing ever calls iicbus_reset() with a
speed of FAST, although some drivers would treat it as the 400KHz standard
speed.  Mostly iicbus_reset() is called with the speed set to UNKNOWN or
FASTEST, and there's really no telling what any individual driver will do
with those.

The speed of an i2c bus is limited by the speed of the slowest device on
the bus.  This means that generally the bus speed needs to be configured
based on the board/system and the components within it.  Historically for
i2c we've configured with device hints.  Newer systems use FDT data and it
documents a clock-frequency property for i2c busses.  Hobbyists and
developers are likely to want on the fly changes.  These changes provide
all 3 methods, but do not require any existing drivers to change to use
the new facilities.

This adds an iicbus method, iicbus_get_frequency(dev, speed) that gets the
frequency for the requested symbolic speed.  If the symbolic speed is SLOW
or if there is no speed configured for the bus, the returned value is
100KHz, always.  Otherwise, if bus speed is configured by hints, fdt,
tunable, or sysctl, that speed is returned.  It also adds a helper
function, iicbus_init_frequency() that any bus driver subclassed from
iicbus can initialize the frequency from some other source of info.

Initial driver implementations are provided for Freescale and TI.

Differential Revision:        https://reviews.freebsd.org/D1174
PR:		195009
2014-11-18 01:54:31 +00:00

138 lines
2.7 KiB
Objective-C

#-
# Copyright (c) 1998 Nicolas Souchu
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# $FreeBSD$
#
#include <sys/bus.h>
#include <dev/iicbus/iic.h>
INTERFACE iicbus;
CODE {
static u_int
iicbus_default_frequency(device_t bus, u_char speed)
{
return (100000);
}
};
#
# Interpret interrupt
#
METHOD int intr {
device_t dev;
int event;
char *buf;
};
#
# iicbus callback
#
METHOD int callback {
device_t dev;
int index;
caddr_t data;
};
#
# Send REPEATED_START condition
#
METHOD int repeated_start {
device_t dev;
u_char slave;
int timeout;
};
#
# Send START condition
#
METHOD int start {
device_t dev;
u_char slave;
int timeout;
};
#
# Send STOP condition
#
METHOD int stop {
device_t dev;
};
#
# Read from I2C bus
#
METHOD int read {
device_t dev;
char *buf;
int len;
int *bytes;
int last;
int delay;
};
#
# Write to the I2C bus
#
METHOD int write {
device_t dev;
const char *buf;
int len;
int *bytes;
int timeout;
};
#
# Reset I2C bus
#
METHOD int reset {
device_t dev;
u_char speed;
u_char addr;
u_char *oldaddr;
};
#
# Generalized Read/Write interface
#
METHOD int transfer {
device_t dev;
struct iic_msg *msgs;
uint32_t nmsgs;
};
#
# Return the frequency in Hz for the bus running at the given
# symbolic speed. Only the IIC_SLOW speed has meaning, it is always
# 100KHz. The UNKNOWN, FAST, and FASTEST rates all map to the
# configured bus frequency, or 100KHz when not otherwise configured.
#
METHOD u_int get_frequency {
device_t dev;
u_char speed;
} DEFAULT iicbus_default_frequency;