FreeBSD src
Go to file
Ian Lepore 422d05da14 Add support for i2c bus mux hardware.
An i2c bus can be divided into segments which can be selectively connected
and disconnected from the main bus. This is usually done to enable using
multiple slave devices having the same address, by isolating the devices
onto separate bus segments, only one of which is connected to the main bus
at once.

There are several types of i2c bus muxes, which break down into two general
categories...

 - Muxes which are themselves i2c slaves. These devices respond to i2c
   commands on their upstream bus, and based on those commands, connect
   various downstream buses to the upstream. In newbus terms, they are both
   a child of an iicbus and the parent of one or more iicbus instances.
 - Muxes which are not i2c devices themselves. Such devices are part of the
   i2c bus electrically, but in newbus terms their parent is some other
   bus. The association with the upstream bus must be established by
   separate metadata (such as FDT data).

In both cases, the mux driver has one or more iicbus child instances
representing the downstream buses. The mux driver implements the iicbus_if
interface, as if it were an iichb host bridge/i2c controller driver. It
services the IO requests sent to it by forwarding them to the iicbus
instance representing the upstream bus, after electrically connecting the
upstream bus to the downstream bus that hosts the i2c slave device which
made the IO request.

The net effect is automatic mux switching which is transparent to slaves on
the downstream buses. They just do i2c IO they way they normally do, and the
bus is electrically connected for the duration of the IO and then idled when
it is complete.

The existing iicbus_if callback() method is enhanced so that the parameter
passed to it can be a struct which contains a device_t for the requesting
bus and slave devices. This change is done by adding a flag that indicates
the extra values are present, and making the flags field the first field of
a new args struct. If the flag is set, the iichb or mux driver can recast
the pointer-to-flags into a pointer-to-struct and access the extra
fields. Thus abi compatibility with older drivers is retained (but a mux
cannot exist on the bus with the older iicbus driver in use.)

A new set of core support routines exists in iicbus.c. This code will help
implement mux drivers for any type of mux hardware by supplying all the
boilerplate code that forwards IO requests upstream. It also has code for
parsing metadata and instantiating the child iicbus instances based on it.

Two new hardware mux drivers are added. The ltc430x driver supports the
LTC4305/4306 mux chips which are controlled via i2c commands. The
iic_gpiomux driver supports any mux hardware which is controlled by
manipulating the state of one or more gpio pins.  Test Plan

Tested locally using a variety of mux'd bus configurations involving both
ltc4305 and a homebrew gpio-controlled mux. Tested configurations included
cascaded muxes (unlikely in the real world, but useful to prove that 'it all
just works' in terms of the automatic switching and upstream forwarding of
IO requests).
2020-01-02 17:51:49 +00:00
bin sh: Fix rare memory leak with SIGINT 2020-01-01 12:06:37 +00:00
cddl Add libdtrace support for arm64 USDT probes. 2019-12-29 21:46:50 +00:00
contrib Merge commit 468a0cb5f from llvm git (by Craig Topper): 2020-01-01 19:45:00 +00:00
crypto sshd: make getpwclass wrapper MON_ISAUTH not MON_AUTH 2019-11-20 16:30:37 +00:00
etc Merge llvm, clang, compiler-rt, libc++, libunwind, lld, lldb and openmp 2019-12-22 11:50:44 +00:00
gnu Move all sources from the llvm project into contrib/llvm-project. 2019-12-20 19:53:05 +00:00
include Revert r355760, r355759 2019-12-15 17:33:26 +00:00
kerberos5 Update Makefile.depend files 2019-12-11 17:37:53 +00:00
lib MFV r356163,r356197: 2019-12-31 00:05:06 +00:00
libexec rtld(1): Do booleans like C99 2019-12-31 05:41:47 +00:00
release release: chase ports r519089 (rpi-firmware update) 2019-12-05 16:17:56 +00:00
rescue Remove unused defines since r147075 2019-07-12 04:44:50 +00:00
sbin Revert r356249 for now as it broke GCC builds. 2020-01-01 09:22:06 +00:00
secure Update Makefile.depend files 2019-12-11 17:37:53 +00:00
share Add support for i2c bus mux hardware. 2020-01-02 17:51:49 +00:00
stand Move stand/ofw/libofw to stand/libofw. 2020-01-02 04:34:22 +00:00
sys Add support for i2c bus mux hardware. 2020-01-02 17:51:49 +00:00
targets Update dirdeps.mk and gendirdeps.mk 2019-12-11 17:38:15 +00:00
tests Add userland tests for route table/lltable rtsock operations. 2019-12-28 12:16:40 +00:00
tools Change reference in HTTPD descriptions to 'simple_httpd' 2019-12-29 02:11:58 +00:00
usr.bin Update the man page to reflect that "-M" and "-N" are deprecated and ignored. 2019-12-31 22:25:06 +00:00
usr.sbin Add a compact columnar output format, available by specifying a second '-l' 2020-01-02 06:56:28 +00:00
.arcconfig
.arclint arc lint: ignore /tests/ in chmod 2017-12-19 03:38:06 +00:00
.cirrus.yml Update vendor/libarchive/dist to git 1dae5a549fe4ab99fd3a49a9edcf897a7b2b1844 2019-12-28 23:40:32 +00:00
.clang-format Add a basic clang-format configuration file 2019-06-07 15:23:52 +00:00
.gitattributes Add a basic clang-format configuration file 2019-06-07 15:23:52 +00:00
.gitignore .gitignore: Add LINT kernel configurations generated into SRCDIR 2019-08-10 18:22:22 +00:00
COPYRIGHT Happy New Year 2020! 2019-12-31 16:01:36 +00:00
LOCKS LOCKS: update current locks 2018-06-09 03:08:04 +00:00
MAINTAINERS Move all sources from the llvm project into contrib/llvm-project. 2019-12-20 19:53:05 +00:00
Makefile Add the missing trailing '/' when setting TARGET_ARCH from TARGET 2020-01-02 11:02:09 +00:00
Makefile.inc1 Remove arm/arm as a valid target. 2020-01-02 03:25:26 +00:00
Makefile.libcompat libcompat: build 32-bit rtld and ldd as part of "everything" 2019-11-07 22:58:10 +00:00
Makefile.sys.inc
ObsoleteFiles.inc Merge llvm, clang, compiler-rt, libc++, libunwind, lld, lldb and openmp 2019-12-22 11:50:44 +00:00
README Import OpenSSL 1.1.1d. 2019-09-10 17:40:53 +00:00
README.md README: add generic notes about GENERIC and NOTES 2018-06-17 19:44:24 +00:00
RELNOTES Add an entry to RELNOTES for r355677. 2019-12-13 16:28:48 +00:00
UPDATING Remove arm/arm as a valid target. 2020-01-02 03:25:26 +00:00

FreeBSD Source:

This is the top level of the FreeBSD source directory. This file was last revised on: FreeBSD

FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms. A large community has continually developed it for more than thirty years. Its advanced networking, security, and storage features have made FreeBSD the platform of choice for many of the busiest web sites and most pervasive embedded networking and storage devices.

For copyright information, please see the file COPYRIGHT in this directory. Additional copyright information also exists for some sources in this tree - please see the specific source directories for more information.

The Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree. See build(7), config(8), https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html for more information, including setting make(1) variables.

Source Roadmap:

bin		System/user commands.

cddl		Various commands and libraries under the Common Development
		and Distribution License.

contrib		Packages contributed by 3rd parties.

crypto		Cryptography stuff (see crypto/README).

etc		Template files for /etc.

gnu		Various commands and libraries under the GNU Public License.
		Please see gnu/COPYING* for more information.

include		System include files.

kerberos5	Kerberos5 (Heimdal) package.

lib		System libraries.

libexec		System daemons.

release		Release building Makefile & associated tools.

rescue		Build system for statically linked /rescue utilities.

sbin		System commands.

secure		Cryptographic libraries and commands.

share		Shared resources.

stand		Boot loader sources.

sys		Kernel sources.

sys/<arch>/conf Kernel configuration files. GENERIC is the configuration
		used in release builds. NOTES contains documentation of
		all possible entries.

tests		Regression tests which can be run by Kyua.  See tests/README
		for additional information.

tools		Utilities for regression testing and miscellaneous tasks.

usr.bin		User commands.

usr.sbin	System administration commands.

For information on synchronizing your source tree with one or more of the FreeBSD Project's development branches, please see:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html