xref: /freebsd/share/man/man4/chromebook_platform.4 (revision 448897d366c218f9fd6208427eef1e6dd51f78d0)
1*448897d3SAndriy Gapon.\" Copyright (c) 2016 Andriy Gapon <avg@FreeBSD.org>
2*448897d3SAndriy Gapon.\" All rights reserved.
3*448897d3SAndriy Gapon.\"
4*448897d3SAndriy Gapon.\" Redistribution and use in source and binary forms, with or without
5*448897d3SAndriy Gapon.\" modification, are permitted provided that the following conditions
6*448897d3SAndriy Gapon.\" are met:
7*448897d3SAndriy Gapon.\" 1. Redistributions of source code must retain the above copyright
8*448897d3SAndriy Gapon.\"    notice, this list of conditions and the following disclaimer.
9*448897d3SAndriy Gapon.\" 2. Redistributions in binary form must reproduce the above copyright
10*448897d3SAndriy Gapon.\"    notice, this list of conditions and the following disclaimer in the
11*448897d3SAndriy Gapon.\"    documentation and/or other materials provided with the distribution.
12*448897d3SAndriy Gapon.\"
13*448897d3SAndriy Gapon.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*448897d3SAndriy Gapon.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*448897d3SAndriy Gapon.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*448897d3SAndriy Gapon.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*448897d3SAndriy Gapon.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*448897d3SAndriy Gapon.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*448897d3SAndriy Gapon.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*448897d3SAndriy Gapon.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*448897d3SAndriy Gapon.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*448897d3SAndriy Gapon.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*448897d3SAndriy Gapon.\" SUCH DAMAGE.
24*448897d3SAndriy Gapon.\"
25*448897d3SAndriy Gapon.\" $FreeBSD$
26*448897d3SAndriy Gapon.\"
27*448897d3SAndriy Gapon.Dd October 13, 2016
28*448897d3SAndriy Gapon.Dt CHROMEBOOK_PLATFORM 4
29*448897d3SAndriy Gapon.Os
30*448897d3SAndriy Gapon.Sh NAME
31*448897d3SAndriy Gapon.Nm chromebook_platform
32*448897d3SAndriy Gapon.Nd support driver for hardware on various Chromebook models
33*448897d3SAndriy Gapon.Sh SYNOPSIS
34*448897d3SAndriy GaponTo compile this driver into the kernel, place the following lines into
35*448897d3SAndriy Gaponthe kernel configuration file:
36*448897d3SAndriy Gapon.Bd -ragged -offset indent
37*448897d3SAndriy Gapon.Cd "device chromebook_platform"
38*448897d3SAndriy Gapon.Ed
39*448897d3SAndriy Gapon.Pp
40*448897d3SAndriy GaponAlternatively, to load the driver as a module at boot time, place the following line in
41*448897d3SAndriy Gapon.Xr loader.conf 5 :
42*448897d3SAndriy Gapon.Bd -literal -offset indent
43*448897d3SAndriy Gaponchromebook_platform_load="YES"
44*448897d3SAndriy Gapon.Ed
45*448897d3SAndriy Gapon.Sh DESCRIPTION
46*448897d3SAndriy GaponThe
47*448897d3SAndriy Gapon.Nm
48*448897d3SAndriy Gapondriver provides automatic configuration for devices that cannot be enumerated
49*448897d3SAndriy Gaponor safely probed.
50*448897d3SAndriy GaponIn particular, I2C peripherals are different from model to model.
51*448897d3SAndriy Gapon.Nm
52*448897d3SAndriy Gaponhas a model-specific information about the I2C peripherals, their drivers,
53*448897d3SAndriy Gapontheir bus attachments and slave addresses.
54*448897d3SAndriy Gapon.Pp
55*448897d3SAndriy GaponNote that
56*448897d3SAndriy Gapon.Nm
57*448897d3SAndriy Gapondoes not load driver modules for the peripherals.
58*448897d3SAndriy GaponThose have to be compiled into the kernel or loaded separately.
59*448897d3SAndriy Gapon.Sh SEE ALSO
60*448897d3SAndriy Gapon.Xr cyapa 4 ,
61*448897d3SAndriy Gapon.Xr iicbus 4 ,
62*448897d3SAndriy Gapon.Xr isl 4 ,
63*448897d3SAndriy Gapon.Sh AUTHORS
64*448897d3SAndriy Gapon.An -nosplit
65*448897d3SAndriy GaponThe
66*448897d3SAndriy Gapon.Nm
67*448897d3SAndriy Gapondriver and this manual page were written by
68*448897d3SAndriy Gapon.An Andriy Gapon Aq Mt avg@FreeBSD.org .
69