xref: /freebsd-src/share/man/man4/ig4.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
171d51719SMichael Gmelin.\" Copyright (c) 2015 Michael Gmelin <freebsd@grem.de>
271d51719SMichael Gmelin.\" All rights reserved.
371d51719SMichael Gmelin.\"
471d51719SMichael Gmelin.\" Redistribution and use in source and binary forms, with or without
571d51719SMichael Gmelin.\" modification, are permitted provided that the following conditions
671d51719SMichael Gmelin.\" are met:
771d51719SMichael Gmelin.\" 1. Redistributions of source code must retain the above copyright
871d51719SMichael Gmelin.\"    notice, this list of conditions and the following disclaimer.
971d51719SMichael Gmelin.\" 2. Redistributions in binary form must reproduce the above copyright
1071d51719SMichael Gmelin.\"    notice, this list of conditions and the following disclaimer in the
1171d51719SMichael Gmelin.\"    documentation and/or other materials provided with the distribution.
1271d51719SMichael Gmelin.\"
1371d51719SMichael Gmelin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1471d51719SMichael Gmelin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1571d51719SMichael Gmelin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1671d51719SMichael Gmelin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1771d51719SMichael Gmelin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1871d51719SMichael Gmelin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1971d51719SMichael Gmelin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2071d51719SMichael Gmelin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2171d51719SMichael Gmelin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2271d51719SMichael Gmelin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2371d51719SMichael Gmelin.\" SUCH DAMAGE.
2471d51719SMichael Gmelin.\"
2523679408SOleksandr Tymoshenko.Dd September 13, 2018
2671d51719SMichael Gmelin.Dt IG4 4
2771d51719SMichael Gmelin.Os
2871d51719SMichael Gmelin.Sh NAME
2971d51719SMichael Gmelin.Nm ig4
3023679408SOleksandr Tymoshenko.Nd Synopsys DesignWare I2C Controller
3171d51719SMichael Gmelin.Sh SYNOPSIS
3271d51719SMichael GmelinTo compile this driver into the kernel, place the following lines into
3371d51719SMichael Gmelinthe kernel configuration file:
3471d51719SMichael Gmelin.Bd -ragged -offset indent
3571d51719SMichael Gmelin.Cd "device ig4"
36448897d3SAndriy Gapon.Cd "device iicbus"
3771d51719SMichael Gmelin.Ed
3871d51719SMichael Gmelin.Pp
3971d51719SMichael GmelinAlternatively, to load the driver as a module at boot time, place the following line in
4071d51719SMichael Gmelin.Xr loader.conf 5 :
4171d51719SMichael Gmelin.Bd -literal -offset indent
4271d51719SMichael Gmelinig4_load="YES"
4371d51719SMichael Gmelin.Ed
4471d51719SMichael Gmelin.Sh DESCRIPTION
4571d51719SMichael GmelinThe
4671d51719SMichael Gmelin.Nm
47448897d3SAndriy Gapondriver provides access to peripherals attached to an I2C controller.
48448897d3SAndriy Gapon.Sh HARDWARE
4971d51719SMichael Gmelin.Nm
5023679408SOleksandr Tymoshenkosupports the I2C controllers based on Synopsys DesignWare IP that can be found
5123679408SOleksandr Tymoshenkoin Intel(R) Core(TM) processors starting from the fourth generation, Intel(R)
5223679408SOleksandr TymoshenkoBay Trail, Apollo Lake SoC families, and some AMD systems.
5371d51719SMichael Gmelin.Sh SYSCTL VARIABLES
5471d51719SMichael GmelinThese
5571d51719SMichael Gmelin.Xr sysctl 8
5671d51719SMichael Gmelinvariables are available:
5771d51719SMichael Gmelin.Bl -tag -width "debug.ig4_dump"
5871d51719SMichael Gmelin.It Va debug.ig4_dump
59448897d3SAndriy GaponThis sysctl is a zero-based bit mask.
60448897d3SAndriy GaponWhen any of the bits are set, a register dump is printed for
61448897d3SAndriy Gaponevery I2C transfer on an
62448897d3SAndriy Gapon.Nm
63448897d3SAndriy Gapondevice with the same unit number.
6471d51719SMichael Gmelin.El
6571d51719SMichael Gmelin.Sh SEE ALSO
66448897d3SAndriy Gapon.Xr iic 4 ,
67448897d3SAndriy Gapon.Xr iicbus 4
6871d51719SMichael Gmelin.Sh AUTHORS
6971d51719SMichael Gmelin.An -nosplit
7071d51719SMichael GmelinThe
7171d51719SMichael Gmelin.Nm
72*1cc60ae8SBenedict Reuschlingdriver was written for
73*1cc60ae8SBenedict Reuschling.Dx
74*1cc60ae8SBenedict Reuschlingby
7571d51719SMichael Gmelin.An Matthew Dillon
7671d51719SMichael Gmelinand subsequently ported to
7771d51719SMichael Gmelin.Fx
7871d51719SMichael Gmelinby
7971d51719SMichael Gmelin.An Michael Gmelin Aq Mt freebsd@grem.de .
8071d51719SMichael Gmelin.Pp
8171d51719SMichael GmelinThis manual page was written by
8271d51719SMichael Gmelin.An Michael Gmelin Aq Mt freebsd@grem.de .
83