freebsd-dev/share/man/man4/smbus.4

.\" 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$
.\"
.Dd March 7, 2021
.Dt SMBUS 4
.Os
.Sh NAME
.Nm smbus
.Nd System Management Bus
.Sh SYNOPSIS
.Cd "device smbus"
.Pp
.Cd "device iicsmb"
.Sh DESCRIPTION
The
.Em smbus
system provides a uniform, modular and architecture-independent
system for the implementation of drivers to control various SMB devices
and to utilize different SMB controllers (I2C, PIIX4, vm86...).
.Sh System Management Bus
The
.Em System Management Bus
is a two-wire interface through which simple power-related chips can communicate
with rest of the system.
It uses I2C as its backbone (see
.Xr iicbus 4 ) .
.Pp
A system using SMB passes messages to and from devices instead of tripping
individual control lines.
.Pp
With the SMBus, a device can provide manufacturer information, tell the
system what its model/part number is, save its state for a suspend event,
report different types of errors, accept control parameters, and return its
status.
.Pp
The SMBus may share the same host device and physical bus as ACCESS bus
components provided that an appropriate electrical bridge is provided
between the internal SMB devices and external ACCESS bus devices.
.Sh SEE ALSO
.Xr iicbus 4 ,
.Xr iicsmb 4 ,
.Xr smb 4
.Rs
.%T The SMBus specification
.%U http://www.smbus.org/specs/
.Re
.Sh HISTORY
The
.Nm
manual page first appeared in
.Fx 3.0 .
.Sh AUTHORS
This
manual page was written by
.An Nicolas Souchu .
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`.\" 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.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`.\"`
Remove references to the now-removed bktr(4) driver. 2021-03-06 23:15:09 +00:00			`.Dd March 7, 2021`
Fixed spelling error in document title. Fixed syntax error in synopsis. 1999-12-26 16:58:31 +00:00			`.Dt SMBUS 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`.Sh NAME`
			`.Nm smbus`
mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00			`.Nd System Management Bus`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`.Sh SYNOPSIS`
Second round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 16:13:26 +00:00			`.Cd "device smbus"`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`.Pp`
Second round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 16:13:26 +00:00			`.Cd "device iicsmb"`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Em smbus`
			`system provides a uniform, modular and architecture-independent`
			`system for the implementation of drivers to control various SMB devices`
Remove references to the now-removed bktr(4) driver. 2021-03-06 23:15:09 +00:00			`and to utilize different SMB controllers (I2C, PIIX4, vm86...).`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`.Sh System Management Bus`
			`The`
			`.Em System Management Bus`
			`is a two-wire interface through which simple power-related chips can communicate`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`with rest of the system.`
			`It uses I2C as its backbone (see`
Prepare for mdoc(7)NG. 2001-01-16 09:32:40 +00:00			`.Xr iicbus 4 ) .`
Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00			`.Pp`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`A system using SMB passes messages to and from devices instead of tripping`
			`individual control lines.`
Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00			`.Pp`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`With the SMBus, a device can provide manufacturer information, tell the`
			`system what its model/part number is, save its state for a suspend event,`
			`report different types of errors, accept control parameters, and return its`
			`status.`
Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00			`.Pp`
Typo. 1998-11-04 03:21:21 +00:00			`The SMBus may share the same host device and physical bus as ACCESS bus`
			`components provided that an appropriate electrical bridge is provided`
			`between the internal SMB devices and external ACCESS bus devices.`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`.Sh SEE ALSO`
			`.Xr iicbus 4 ,`
			`.Xr iicsmb 4 ,`
			`.Xr smb 4`
Add a reference to the URL of the SMBus specification, so the terminology used in these drivers will become more transparent. MFC after: 1 week 2004-05-13 19:31:31 +00:00			`.Rs`
			`.%T The SMBus specification`
Use the newly brought %U macro. 2010-01-15 16:01:22 +00:00			`.%U http://www.smbus.org/specs/`
Add a reference to the URL of the SMBus specification, so the terminology used in these drivers will become more transparent. MFC after: 1 week 2004-05-13 19:31:31 +00:00			`.Re`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`manual page first appeared in`
			`.Fx 3.0 .`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Sh AUTHORS`
More I2C framework docs. See iicbus(4) for more info. 1998-10-28 00:42:34 +00:00			`This`
			`manual page was written by`
			`.An Nicolas Souchu .`