share/man/man4/ig4.4

   1 .\" Copyright (c) 2015 Michael Gmelin <freebsd@grem.de>
   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 September 13, 2018
  28 .Dt IG4 4
  29 .Os
  30 .Sh NAME
  31 .Nm ig4
  32 .Nd Synopsys DesignWare I2C Controller
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel, place the following lines into
  35 the kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device ig4"
  38 .Cd "device iicbus"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a module at boot time, place the following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 ig4_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 driver provides access to peripherals attached to an I2C controller.
  50 .Sh HARDWARE
  51 .Nm
  52 supports the I2C controllers based on Synopsys DesignWare IP that can be found
  53 in Intel(R) Core(TM) processors starting from the fourth generation, Intel(R)
  54 Bay Trail, Apollo Lake SoC families, and some AMD systems.
  55 .Sh SYSCTL VARIABLES
  56 These
  57 .Xr sysctl 8
  58 variables are available:
  59 .Bl -tag -width "debug.ig4_dump"
  60 .It Va debug.ig4_dump
  61 This sysctl is a zero-based bit mask.
  62 When any of the bits are set, a register dump is printed for
  63 every I2C transfer on an
  64 .Nm
  65 device with the same unit number.
  66 .El
  67 .Sh SEE ALSO
  68 .Xr iic 4 ,
  69 .Xr iicbus 4
  70 .Sh AUTHORS
  71 .An -nosplit
  72 The
  73 .Nm
  74 driver was written for DragonFly BSD by
  75 .An Matthew Dillon
  76 and subsequently ported to
  77 .Fx
  78 by
  79 .An Michael Gmelin Aq Mt freebsd@grem.de .
  80 .Pp
  81 This manual page was written by
  82 .An Michael Gmelin Aq Mt freebsd@grem.de .