]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - share/man/man4/smbus.4
Merge llvm-project 12.0.0 release
[FreeBSD/FreeBSD.git] / share / man / man4 / smbus.4
1 .\" Copyright (c) 1998, Nicolas Souchu
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD$
26 .\"
27 .Dd March 7, 2021
28 .Dt SMBUS 4
29 .Os
30 .Sh NAME
31 .Nm smbus
32 .Nd System Management Bus
33 .Sh SYNOPSIS
34 .Cd "device smbus"
35 .Pp
36 .Cd "device iicsmb"
37 .Sh DESCRIPTION
38 The
39 .Em smbus
40 system provides a uniform, modular and architecture-independent
41 system for the implementation of drivers to control various SMB devices
42 and to utilize different SMB controllers (I2C, PIIX4, vm86...).
43 .Sh System Management Bus
44 The
45 .Em System Management Bus
46 is a two-wire interface through which simple power-related chips can communicate
47 with rest of the system.
48 It uses I2C as its backbone (see
49 .Xr iicbus 4 ) .
50 .Pp
51 A system using SMB passes messages to and from devices instead of tripping
52 individual control lines.
53 .Pp
54 With the SMBus, a device can provide manufacturer information, tell the
55 system what its model/part number is, save its state for a suspend event,
56 report different types of errors, accept control parameters, and return its
57 status.
58 .Pp
59 The SMBus may share the same host device and physical bus as ACCESS bus
60 components provided that an appropriate electrical bridge is provided
61 between the internal SMB devices and external ACCESS bus devices.
62 .Sh SEE ALSO
63 .Xr iicbus 4 ,
64 .Xr iicsmb 4 ,
65 .Xr smb 4
66 .Rs
67 .%T The SMBus specification
68 .%U http://www.smbus.org/specs/
69 .Re
70 .Sh HISTORY
71 The
72 .Nm
73 manual page first appeared in
74 .Fx 3.0 .
75 .Sh AUTHORS
76 This
77 manual page was written by
78 .An Nicolas Souchu .