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 October 03, 2016 28.Dt ISL 4 29.Os 30.Sh NAME 31.Nm isl 32.Nd Intersil(TM) I2C ISL29018 sensor 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 isl" 38.Cd "device ig4" 39.Cd "device iicbus" 40.Ed 41.Pp 42Alternatively, to load the driver as a module at boot time, place the following line in 43.Xr loader.conf 5 : 44.Bd -literal -offset indent 45isl_load="YES" 46ig4_load="YES" 47.Ed 48.Pp 49In 50.Pa /boot/device.hints : 51.Cd hint.isl.0.at="iicbus0" 52.Cd hint.isl.0.addr="0x88" 53.Cd hint.isl.1.at="iicbus1" 54.Cd hint.isl.1.addr="0x88" 55.Sh DESCRIPTION 56The 57.Nm 58driver provides access to sensor data provided by the Intersil(TM) I2C 59ISL29018 Digital Ambient Light Sensor and Proximity Sensor with Interrupt 60Function. 61Functionality is basic and provided through the 62.Xr sysctl 8 63interface. 64.Pp 65On a system using 66.Xr device.hints 5 , 67these values are configurable for 68.Nm : 69.Bl -tag -width "hint.isl.%d.addr" 70.It Va hint.isl.%d.at 71target 72.Xr iicbus 4 . 73.It Va hint.isl.%d.addr 74.Nm 75i2c address on the 76.Xr iicbus 4 . 77.El 78.Sh SYSCTL VARIABLES 79The following 80.Xr sysctl 8 81variables are available: 82.Bl -tag -width "dev.isl.X.resolution" 83.It Va dev.isl.X.als 84Current ALS (Ambient Light Sensor) readout. 85.It Va dev.isl.X.ir 86Current IR (InfraRed) sensor readout. 87.It Va dev.isl.X.prox 88Current proximity sensor readout. 89.It Va dev.isl.X.resolution 90Current sensor resolution. 91.It Va dev.isl.X.range 92Current sensor range. 93.El 94.Sh EXAMPLES 95.Ss Ambient light sensor read out 96.Bd -literal 97$ sysctl dev.isl.0.als 98dev.isl.0.als: 64 99.Ed 100.Ss Automatically adjust brightness 101This requires the port 102.Pa graphics/intel-backlight 103and only works with laptops using a supported Intel(R) GPU. 104.Bd -literal 105$ pkg install intel-backlight 106$ sh /usr/local/share/examples/intel-backlight/isl_backlight.sh 107.Ed 108.Sh SEE ALSO 109.Xr ig4 4 , 110.Xr iicbus 4 111.Sh AUTHORS 112.An -nosplit 113The 114.Nm 115driver was written by 116.An Michael Gmelin Aq Mt freebsd@grem.de . 117.Pp 118This manual page was written by 119.An Michael Gmelin Aq Mt freebsd@grem.de . 120.Sh BUGS 121The 122.Nm 123driver detects the device based from the I2C address. 124This might have unforeseen consequences if the initialization sequence 125is sent to an unknown device at that address. 126