share/man/man4/isl.4

   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 July 25, 2015
  28 .Dt ISL 4
  29 .Os
  30 .Sh NAME
  31 .Nm isl
  32 .Nd Intersil(TM) I2C ISL29018 sensor driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel, place the following lines into
  35 the kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device isl"
  38 .Cd "device ig4"
  39 .Cd "device smbus"
  40 .Ed
  41 .Pp
  42 Alternatively, 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
  45 isl_load="YES"
  46 ig4_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver provides access to sensor data provided by the Intersil(TM) I2C
  52 ISL29018 Digital Ambient Light Sensor and Proximity Sensor with Interrupt
  53 Function.
  54 Functionality is basic and provided through the
  55 .Xr sysctl 8
  56 interface.
  57 .Sh SYSCTL VARIABLES
  58 The following
  59 .Xr sysctl 8
  60 variables are available:
  61 .Bl -tag -width "dev.isl.X.resolution"
  62 .It Va dev.isl.X.als
  63 Current ALS (Ambient Light Sensor) readout.
  64 .It Va dev.isl.X.ir
  65 Current IR (InfraRed) sensor readout.
  66 .It Va dev.isl.X.prox
  67 Current proximity sensor readout.
  68 .It Va dev.isl.X.resolution
  69 Current sensor resolution.
  70 .It Va dev.isl.X.range
  71 Current sensor range.
  72 .El
  73 .Sh EXAMPLES
  74 .Ss Ambient light sensor read out
  75 .Bd -literal
  76 $ sysctl dev.isl.0.als
  77 dev.isl.0.als: 64
  78 .Ed
  79 .Ss Automatically adjust brightness
  80 This requires the port
  81 .Pa graphics/intel-backlight
  82 and only works with laptops using a supported Intel(R) GPU.
  83 .Bd -literal
  84 $ pkg install intel-backlight
  85 $ sh /usr/local/share/examples/intel-backlight/isl_backlight.sh
  86 .Ed
  87 .Sh SEE ALSO
  88 .Xr ig4 4 ,
  89 .Xr smbus 4
  90 .Sh AUTHORS
  91 .An -nosplit
  92 The
  93 .Nm
  94 driver was written by
  95 .An Michael Gmelin Aq Mt freebsd@grem.de .
  96 .Pp
  97 This manual page was written by
  98 .An Michael Gmelin Aq Mt freebsd@grem.de .
  99 .Sh BUGS
 100 The
 101 .Nm
 102 driver detects the device based on its I2C address (0x44).
 103 This might have unforeseen consequences if the initialization sequence
 104 is sent to an unknown device at that address.