freebsd-skq/sys/dev/iicbus/iicbus_if.m
jah 25e5e803e7 Fix numerous issues in iic(4) and iicbus(4):
--Allow multiple open iic fds by storing addressing state in cdevpriv
--Fix, as much as possible, the baked-in race conditions in the iic
ioctl interface by requesting bus ownership on I2CSTART, releasing it on
I2CSTOP/I2CRSTCARD, and requiring bus ownership by the current cdevpriv
to use the I/O ioctls
--Reduce internal iic buffer size and remove 1K read/write limit by
iteratively calling iicbus_read/iicbus_write
--Eliminate dynamic allocation in I2CWRITE/I2CREAD
--Move handling of I2CRDWR to separate function and improve error handling
--Add new I2CSADDR ioctl to store address in current cdevpriv so that
I2CSTART is not needed for read(2)/write(2) to work
--Redesign iicbus_request_bus() and iicbus_release_bus():
    --iicbus_request_bus() no longer falls through if the bus is already
owned by the requesting device.  Multiple threads on the same device may
want exclusive access.  Also, iicbus_release_bus() was never
device-recursive anyway.
    --Previously, if IICBUS_CALLBACK failed in iicbus_release_bus(), but
the following iicbus_poll() call succeeded, IICBUS_CALLBACK would not be
issued again
    --Do not hold iicbus mtx during IICBUS_CALLBACK call.  There are
several drivers that may sleep in IICBUS_CALLBACK, if IIC_WAIT is passed.
    --Do not loop in iicbus_request_bus if IICBUS_CALLBACK returns
EWOULDBLOCK; instead pass that to the caller so that it can retry if so
desired.

Differential Revision:	https://reviews.freebsd.org/D2140
Reviewed by:	imp, jhb, loos
Approved by:	kib (mentor)
2015-04-21 11:50:31 +00:00

142 lines
2.9 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
# Request ownership of bus
# index: IIC_REQUEST_BUS or IIC_RELEASE_BUS
# data: pointer to int containing IIC_WAIT or IIC_DONTWAIT and either IIC_INTR or IIC_NOINTR
# This function is allowed to sleep if *data contains IIC_WAIT.
#
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;