xref: /freebsd/share/man/man4/man4.i386/glxiic.4 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1.\" Copyright (c) 2011 Henrik Brix Andersen <brix@FreeBSD.org>
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 ``AS IS'' AND ANY EXPRESS OR
14.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23.\"
24.\" $FreeBSD$
25.\"
26.Dd May 15, 2011
27.Dt GLXIIC 4 i386
28.Os
29.Sh NAME
30.Nm glxiic
31.Nd Geode LX CS5536 I2C controller driver
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device pci"
38.Cd "device isa"
39.Cd "device glxiic"
40.Cd "device iicbus"
41.Ed
42.Pp
43Alternatively, to load the driver as a
44module at boot time, place the following line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47glxiic_load="YES"
48.Ed
49.Sh DESCRIPTION
50The
51.Nm
52driver supports the System Management Bus controller of the Geode LX
53series CS5536 Companion Device.
54The Geode LX is a member of the AMD Geode family of integrated x86 system chips.
55.Pp
56Although AMD refers to this device as a System Management Bus (SMBus)
57controller, it is really an I2C controller (it lacks SMBus ALERT# and
58Alert Response support).
59.Pp
60The
61.Nm
62driver supports both I2C master and slave mode.
63.Sh SYSCTL VARIABLE
64The
65.Nm
66driver supports the following variable as both
67.Xr sysctl 8
68and
69.Xr loader 8
70tunable:
71.Bl -tag -width indent
72.It Va dev.glxiic.0.timeout
73This variable controls the I2C bus timeout in milliseconds.
74The default timeout is 35 milliseconds.
75A value of zero disables the timeout.
76.El
77.Sh CAVEAT
78The
79.Nm
80driver uses the interrupt line number configured by the board firmware
81by default.
82If no interrupt line number has been configured by the board firmware
83(or to override the interrupt line number configured by board firmware),
84place the following line in
85.Xr device.hints 5 :
86.Bd -ragged -offset indent
87hint.glxiic.0.irq="10"
88.Ed
89.Pp
90The interrupt line number must be between 1 and 15.
91.Sh SEE ALSO
92.Xr iicbus 4 ,
93.Xr device.hints 5 ,
94.Xr loader.conf 5 ,
95.Xr loader 8 ,
96.Xr sysctl 8
97.Sh HISTORY
98The
99.Nm
100device driver and manual page first appeared in
101.Fx 9.0 .
102.Sh AUTHORS
103.An -nosplit
104The
105.Nm
106device driver and manual page were written by
107.An Henrik Brix Andersen Aq Mt brix@FreeBSD.org .
108