1 .\" Copyright (c) 2015 Michael Gmelin <freebsd@grem.de>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd Intersil(TM) I2C ISL29018 sensor driver
34 To compile this driver into the kernel, place the following lines into
35 the kernel configuration file:
36 .Bd -ragged -offset indent
42 Alternatively, to load the driver as a module at boot time, place the following line in
44 .Bd -literal -offset indent
49 On many Chromebook models this driver can be automatically configured with the
51 .Xr chromebook_platform 4
55 driver can be manually configured in
56 .Pa /boot/device.hints :
57 .Cd hint.isl.0.at="iicbus0"
58 .Cd hint.isl.0.addr="0x88"
59 .Cd hint.isl.1.at="iicbus1"
60 .Cd hint.isl.1.addr="0x88"
64 driver provides access to sensor data provided by the Intersil(TM) I2C
65 ISL29018 Digital Ambient Light Sensor and Proximity Sensor with Interrupt
67 Functionality is basic and provided through the
73 these values are configurable for
75 .Bl -tag -width "hint.isl.%d.addr"
79 .It Va hint.isl.%d.addr
87 variables are available:
88 .Bl -tag -width "dev.isl.X.resolution"
90 Current ALS (Ambient Light Sensor) readout.
92 Current IR (InfraRed) sensor readout.
94 Current proximity sensor readout.
95 .It Va dev.isl.X.resolution
96 Current sensor resolution.
97 .It Va dev.isl.X.range
101 .Ss Ambient light sensor read out
103 $ sysctl dev.isl.0.als
106 .Ss Automatically adjust brightness
107 This requires the port
108 .Pa graphics/intel-backlight
109 and only works with laptops using a supported Intel(R) GPU.
111 $ pkg install intel-backlight
112 $ sh /usr/local/share/examples/intel-backlight/isl_backlight.sh
115 .Xr chromebook_platform 4 ,
122 driver was written by
123 .An Michael Gmelin Aq Mt freebsd@grem.de .
125 This manual page was written by
126 .An Michael Gmelin Aq Mt freebsd@grem.de .
130 driver detects the device based from the I2C address.
131 This might have unforeseen consequences if the initialization sequence
132 is sent to an unknown device at that address.