xref: /freebsd/share/man/man4/ig4.4 (revision 09a53ad8f1318c5daae6cfb19d97f4f6459f0013)
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 May 30, 2015
28.Dt IG4 4
29.Os
30.Sh NAME
31.Nm ig4
32.Nd Intel(R) fourth generation mobile CPU integrated I2C SMBus driver
33.Sh SYNOPSIS
34To compile this driver into the kernel, place the following lines into
35the kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device ig4"
38.Cd "device smbus"
39.Ed
40.Pp
41Alternatively, 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
44ig4_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49driver provides access to peripherals attached to an I2C SMB controller.
50.Nm
51supports the SMBus controller found in fourth generation Intel(R) Core(TM)
52processors based on the mobile U-processor line for intelligent systems.
53This includes the i7-4650U, i5-4300U, i3-4010U, and 2980U.
54.Sh SYSCTL VARIABLES
55These
56.Xr sysctl 8
57variables are available:
58.Bl -tag -width "debug.ig4_dump"
59.It Va debug.ig4_dump
60Setting this to a non-zero value dumps controller registers to console and
61syslog once.
62The sysctl resets to zero immediately.
63.El
64.Sh SEE ALSO
65.Xr smb 4 ,
66.Xr smbus 4
67.Sh AUTHORS
68.An -nosplit
69The
70.Nm
71driver was written for DragonFly BSD by
72.An Matthew Dillon
73and subsequently ported to
74.Fx
75by
76.An Michael Gmelin Aq Mt freebsd@grem.de .
77.Pp
78This manual page was written by
79.An Michael Gmelin Aq Mt freebsd@grem.de .
80