xref: /freebsd/share/man/man4/chromebook_platform.4 (revision 2940eb19a15e9b1ff7483eb781a4c55371305070)
1448897d3SAndriy Gapon.\" Copyright (c) 2016 Andriy Gapon <avg@FreeBSD.org>
2448897d3SAndriy Gapon.\" All rights reserved.
3448897d3SAndriy Gapon.\"
4448897d3SAndriy Gapon.\" Redistribution and use in source and binary forms, with or without
5448897d3SAndriy Gapon.\" modification, are permitted provided that the following conditions
6448897d3SAndriy Gapon.\" are met:
7448897d3SAndriy Gapon.\" 1. Redistributions of source code must retain the above copyright
8448897d3SAndriy Gapon.\"    notice, this list of conditions and the following disclaimer.
9448897d3SAndriy Gapon.\" 2. Redistributions in binary form must reproduce the above copyright
10448897d3SAndriy Gapon.\"    notice, this list of conditions and the following disclaimer in the
11448897d3SAndriy Gapon.\"    documentation and/or other materials provided with the distribution.
12448897d3SAndriy Gapon.\"
13448897d3SAndriy Gapon.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14448897d3SAndriy Gapon.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15448897d3SAndriy Gapon.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16448897d3SAndriy Gapon.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17448897d3SAndriy Gapon.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18448897d3SAndriy Gapon.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19448897d3SAndriy Gapon.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20448897d3SAndriy Gapon.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21448897d3SAndriy Gapon.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22448897d3SAndriy Gapon.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23448897d3SAndriy Gapon.\" SUCH DAMAGE.
24448897d3SAndriy Gapon.\"
25448897d3SAndriy Gapon.\" $FreeBSD$
26448897d3SAndriy Gapon.\"
27448897d3SAndriy Gapon.Dd October 13, 2016
28448897d3SAndriy Gapon.Dt CHROMEBOOK_PLATFORM 4
29448897d3SAndriy Gapon.Os
30448897d3SAndriy Gapon.Sh NAME
31448897d3SAndriy Gapon.Nm chromebook_platform
32448897d3SAndriy Gapon.Nd support driver for hardware on various Chromebook models
33448897d3SAndriy Gapon.Sh SYNOPSIS
34448897d3SAndriy GaponTo compile this driver into the kernel, place the following lines into
35448897d3SAndriy Gaponthe kernel configuration file:
36448897d3SAndriy Gapon.Bd -ragged -offset indent
37448897d3SAndriy Gapon.Cd "device chromebook_platform"
38448897d3SAndriy Gapon.Ed
39448897d3SAndriy Gapon.Pp
40448897d3SAndriy GaponAlternatively, to load the driver as a module at boot time, place the following line in
41448897d3SAndriy Gapon.Xr loader.conf 5 :
42448897d3SAndriy Gapon.Bd -literal -offset indent
43448897d3SAndriy Gaponchromebook_platform_load="YES"
44448897d3SAndriy Gapon.Ed
45448897d3SAndriy Gapon.Sh DESCRIPTION
46448897d3SAndriy GaponThe
47448897d3SAndriy Gapon.Nm
48448897d3SAndriy Gapondriver provides automatic configuration for devices that cannot be enumerated
49448897d3SAndriy Gaponor safely probed.
50448897d3SAndriy GaponIn particular, I2C peripherals are different from model to model.
51448897d3SAndriy Gapon.Nm
52448897d3SAndriy Gaponhas a model-specific information about the I2C peripherals, their drivers,
53448897d3SAndriy Gapontheir bus attachments and slave addresses.
54448897d3SAndriy Gapon.Pp
55448897d3SAndriy GaponNote that
56448897d3SAndriy Gapon.Nm
57448897d3SAndriy Gapondoes not load driver modules for the peripherals.
58448897d3SAndriy GaponThose have to be compiled into the kernel or loaded separately.
59448897d3SAndriy Gapon.Sh SEE ALSO
60448897d3SAndriy Gapon.Xr cyapa 4 ,
61448897d3SAndriy Gapon.Xr iicbus 4 ,
62*2940eb19SChristian Brueffer.Xr isl 4
63448897d3SAndriy Gapon.Sh AUTHORS
64448897d3SAndriy Gapon.An -nosplit
65448897d3SAndriy GaponThe
66448897d3SAndriy Gapon.Nm
67448897d3SAndriy Gapondriver and this manual page were written by
68448897d3SAndriy Gapon.An Andriy Gapon Aq Mt avg@FreeBSD.org .
69