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