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