xref: /freebsd/share/man/man4/chromebook_platform.4 (revision 397e83df75e0fcd0d3fcb95ae4d794cb7600fc89)
1.\" Copyright (c) 2016 Andriy Gapon <avg@FreeBSD.org>
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.Dd October 13, 2016
26.Dt CHROMEBOOK_PLATFORM 4
27.Os
28.Sh NAME
29.Nm chromebook_platform
30.Nd support driver for hardware on various Chromebook models
31.Sh SYNOPSIS
32To compile this driver into the kernel, place the following lines into
33the kernel configuration file:
34.Bd -ragged -offset indent
35.Cd "device chromebook_platform"
36.Ed
37.Pp
38Alternatively, to load the driver as a module at boot time, place the following line in
39.Xr loader.conf 5 :
40.Bd -literal -offset indent
41chromebook_platform_load="YES"
42.Ed
43.Sh DESCRIPTION
44The
45.Nm
46driver provides automatic configuration for devices that cannot be enumerated
47or safely probed.
48In particular, I2C peripherals are different from model to model.
49.Nm
50has a model-specific information about the I2C peripherals, their drivers,
51their bus attachments and slave addresses.
52.Pp
53Note that
54.Nm
55does not load driver modules for the peripherals.
56Those have to be compiled into the kernel or loaded separately.
57.Sh SEE ALSO
58.Xr cyapa 4 ,
59.Xr iicbus 4 ,
60.Xr isl 4
61.Sh AUTHORS
62.An -nosplit
63The
64.Nm
65driver and this manual page were written by
66.An Andriy Gapon Aq Mt avg@FreeBSD.org .
67