diff options
Diffstat (limited to 'static/freebsd/man4/isl.4 3.html')
| -rw-r--r-- | static/freebsd/man4/isl.4 3.html | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/static/freebsd/man4/isl.4 3.html b/static/freebsd/man4/isl.4 3.html new file mode 100644 index 00000000..0b04d14e --- /dev/null +++ b/static/freebsd/man4/isl.4 3.html @@ -0,0 +1,132 @@ +<table class="head"> + <tr> + <td class="head-ltitle">ISL(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">ISL(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">isl</code> — <span class="Nd">Intersil(TM) + I2C ISL29018 sensor driver</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp">To compile this driver into the kernel, place the following lines + into the kernel configuration file:</p> +<div class="Bd Pp Bd-indent"><code class="Cd">device isl</code> +<br/> +<code class="Cd">device ig4</code> +<br/> +<code class="Cd">device iicbus</code></div> +<p class="Pp">Alternatively, to load the driver as a module at boot time, place + the following line in <a class="Xr">loader.conf(5)</a>:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>isl_load="YES" +ig4_load="YES"</pre> +</div> +<p class="Pp">On many Chromebook models this driver can be automatically + configured with the help of the <a class="Xr">chromebook_platform(4)</a> + driver. Alternatively, the</p> +<br/> +<table class="Nm"> + <tr> + <td><code class="Nm">isl</code></td> + <td>driver can be manually configured in + <span class="Pa">/boot/device.hints</span>: + <br/> + <code class="Cd">hint.isl.0.at="iicbus0"</code> + <br/> + <code class="Cd">hint.isl.0.addr="0x88"</code> + <br/> + <code class="Cd">hint.isl.1.at="iicbus1"</code> + <br/> + <code class="Cd">hint.isl.1.addr="0x88"</code></td> + </tr> +</table> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">isl</code> driver provides access to sensor + data provided by the Intersil(TM) I2C ISL29018 Digital Ambient Light Sensor + and Proximity Sensor with Interrupt Function. Functionality is basic and + provided through the <a class="Xr">sysctl(8)</a> interface.</p> +<p class="Pp">On a system using <a class="Xr">device.hints(5)</a>, these values + are configurable for <code class="Nm">isl</code>:</p> +<dl class="Bl-tag"> + <dt id="hint.isl._d.at"><var class="Va">hint.isl.%d.at</var></dt> + <dd>target <a class="Xr">iicbus(4)</a>.</dd> + <dt id="hint.isl._d.addr"><var class="Va">hint.isl.%d.addr</var></dt> + <dd><code class="Nm">isl</code> i2c address on the + <a class="Xr">iicbus(4)</a>.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL + VARIABLES</a></h1> +<p class="Pp">The following <a class="Xr">sysctl(8)</a> variables are + available:</p> +<dl class="Bl-tag"> + <dt id="dev.isl.X.als"><var class="Va">dev.isl.X.als</var></dt> + <dd>Current ALS (Ambient Light Sensor) readout.</dd> + <dt id="dev.isl.X.ir"><var class="Va">dev.isl.X.ir</var></dt> + <dd>Current IR (InfraRed) sensor readout.</dd> + <dt id="dev.isl.X.prox"><var class="Va">dev.isl.X.prox</var></dt> + <dd>Current proximity sensor readout.</dd> + <dt id="dev.isl.X.resolution"><var class="Va">dev.isl.X.resolution</var></dt> + <dd>Current sensor resolution.</dd> + <dt id="dev.isl.X.range"><var class="Va">dev.isl.X.range</var></dt> + <dd>Current sensor range.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> +<section class="Ss"> +<h2 class="Ss" id="Ambient_light_sensor_read_out"><a class="permalink" href="#Ambient_light_sensor_read_out">Ambient + light sensor read out</a></h2> +<div class="Bd Li"> +<pre>$ sysctl dev.isl.0.als +dev.isl.0.als: 64</pre> +</div> +</section> +<section class="Ss"> +<h2 class="Ss" id="Automatically_adjust_brightness"><a class="permalink" href="#Automatically_adjust_brightness">Automatically + adjust brightness</a></h2> +<p class="Pp">This requires the port + <span class="Pa">graphics/intel-backlight</span> and only works with laptops + using a supported Intel(R) GPU.</p> +<div class="Bd Pp Li"> +<pre>$ pkg install intel-backlight +$ sh /usr/local/share/examples/intel-backlight/isl_backlight.sh</pre> +</div> +</section> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">chromebook_platform(4)</a>, + <a class="Xr">ig4(4)</a>, <a class="Xr">iicbus(4)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <code class="Nm">isl</code> driver was written by + <span class="An">Michael Gmelin</span> + <<a class="Mt" href="mailto:freebsd@grem.de">freebsd@grem.de</a>>.</p> +<p class="Pp">This manual page was written by <span class="An">Michael + Gmelin</span> + <<a class="Mt" href="mailto:freebsd@grem.de">freebsd@grem.de</a>>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1> +<p class="Pp">The <code class="Nm">isl</code> driver detects the device based + from the I2C address. This might have unforeseen consequences if the + initialization sequence is sent to an unknown device at that address.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">December 18, 2018</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |