share/man/man4/man4.i386/glxiic.4

   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
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel 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
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 glxiic_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver supports the System Management Bus controller of the Geode LX
  53 series CS5536 Companion Device.  The Geode LX is a member of the AMD
  54 Geode family of integrated x86 system chips.
  55 .Pp
  56 Although AMD refers to this device as a System Management Bus (SMBus)
  57 controller, it is really an I2C controller (it lacks SMBus ALERT# and
  58 Alert Response support).
  59 .Pp
  60 The
  61 .Nm
  62 driver supports both I2C master and slave mode.
  63 .Sh SYSCTL VARIABLE
  64 The
  65 .Nm
  66 driver supports the following variable as both
  67 .Xr sysctl 8
  68 and
  69 .Xr loader 8
  70 tunable:
  71 .Bl -tag -width indent
  72 .It Va dev.glxiic.0.timeout
  73 This variable controls the I2C bus timeout in milliseconds.  The
  74 default timeout is 35 milliseconds.  A value of zero disables the
  75 timeout.
  76 .El
  77 .Sh CAVEAT
  78 The
  79 .Nm
  80 driver uses the interrupt line number configured by the board firmware
  81 by default.  If no interrupt line number has been configured by the
  82 board firmware (or to override the interrupt line number configured by
  83 board firmware), place the following line in
  84 .Xr device.hints 5 :
  85 .Bd -ragged -offset indent
  86 hint.glxiic.0.irq="10"
  87 .Ed
  88 .Pp
  89 The interrupt line number must be between 1 and 15.
  90 .Sh SEE ALSO
  91 .Xr iicbus 4 ,
  92 .Xr device.hints 5 ,
  93 .Xr loader.conf 5 ,
  94 .Xr loader 8 ,
  95 .Xr sysctl 8
  96 .Sh HISTORY
  97 The
  98 .Nm
  99 device driver and manual page first appeared in
 100 .Fx 9.0 .
 101 .Sh AUTHORS
 102 .An -nosplit
 103 The
 104 .Nm
 105 device driver and manual page were written by
 106 .An Henrik Brix Andersen Aq brix@FreeBSD.org .