tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1# SPDX-License-Identifier: GPL-2.0-only
2#
3# Platform support for Chrome OS hardware (Chromebooks and Chromeboxes)
4#
5
6menuconfig CHROME_PLATFORMS
7 bool "Platform support for Chrome hardware"
8 depends on X86 || ARM || ARM64 || COMPILE_TEST
9 help
10 Say Y here to get to see options for platform support for
11 various Chromebooks and Chromeboxes. This option alone does
12 not add any kernel code.
13
14 If you say N, all options in this submenu will be skipped and disabled.
15
16if CHROME_PLATFORMS
17
18config CHROMEOS_ACPI
19 tristate "ChromeOS specific ACPI extensions"
20 depends on ACPI
21 help
22 This driver provides the firmware interface for the services
23 exported through the ChromeOS interfaces when using ChromeOS
24 ACPI firmware.
25
26 If you have an ACPI-compatible Chromebook, say Y or M here.
27 The module will be called chromeos_acpi.
28
29config CHROMEOS_LAPTOP
30 tristate "Chrome OS Laptop"
31 depends on I2C && DMI && X86
32 help
33 This driver instantiates i2c and smbus devices such as
34 light sensors and touchpads.
35
36 If you have a supported Chromebook, choose Y or M here.
37 The module will be called chromeos_laptop.
38
39config CHROMEOS_PSTORE
40 tristate "Chrome OS pstore support"
41 depends on X86
42 help
43 This module instantiates the persistent storage on x86 ChromeOS
44 devices. It can be used to store away console logs and crash
45 information across reboots.
46
47 The range of memory used is 0xf00000-0x1000000, traditionally
48 the memory used to back VGA controller memory.
49
50 If you have a supported Chromebook, choose Y or M here.
51 The module will be called chromeos_pstore.
52
53config CHROMEOS_TBMC
54 tristate "ChromeOS Tablet Switch Controller"
55 depends on ACPI
56 depends on INPUT
57 help
58 This option adds a driver for the tablet switch on
59 select Chrome OS systems.
60
61 To compile this driver as a module, choose M here: the
62 module will be called chromeos_tbmc.
63
64config CROS_EC
65 tristate "ChromeOS Embedded Controller"
66 select CROS_EC_PROTO
67 depends on X86 || ARM || ARM64 || COMPILE_TEST
68 help
69 If you say Y here you get support for the ChromeOS Embedded
70 Controller (EC) providing keyboard, battery and power services.
71 You also need to enable the driver for the bus you are using. The
72 protocol for talking to the EC is defined by the bus driver.
73
74 To compile this driver as a module, choose M here: the
75 module will be called cros_ec.
76
77config CROS_EC_I2C
78 tristate "ChromeOS Embedded Controller (I2C)"
79 depends on CROS_EC && I2C
80
81 help
82 If you say Y here, you get support for talking to the ChromeOS
83 EC through an I2C bus. This uses a simple byte-level protocol with
84 a checksum. Failing accesses will be retried three times to
85 improve reliability.
86
87config CROS_EC_RPMSG
88 tristate "ChromeOS Embedded Controller (rpmsg)"
89 depends on CROS_EC && RPMSG && OF
90 help
91 If you say Y here, you get support for talking to the ChromeOS EC
92 through rpmsg. This uses a simple byte-level protocol with a
93 checksum. Also since there's no addition EC-to-host interrupt, this
94 use a byte in message to distinguish host event from host command.
95
96 To compile this driver as a module, choose M here: the
97 module will be called cros_ec_rpmsg.
98
99config CROS_EC_ISHTP
100 tristate "ChromeOS Embedded Controller (ISHTP)"
101 depends on CROS_EC
102 depends on INTEL_ISH_HID
103 help
104 If you say Y here, you get support for talking to the ChromeOS EC
105 firmware running on Intel Integrated Sensor Hub (ISH), using the
106 ISH Transport protocol (ISH-TP). This uses a simple byte-level
107 protocol with a checksum.
108
109 To compile this driver as a module, choose M here: the
110 module will be called cros_ec_ishtp.
111
112config CROS_EC_SPI
113 tristate "ChromeOS Embedded Controller (SPI)"
114 depends on CROS_EC && SPI
115
116 help
117 If you say Y here, you get support for talking to the ChromeOS EC
118 through a SPI bus, using a byte-level protocol. Since the EC's
119 response time cannot be guaranteed, we support ignoring
120 'pre-amble' bytes before the response actually starts.
121
122config CROS_EC_UART
123 tristate "ChromeOS Embedded Controller (UART)"
124 depends on CROS_EC && ACPI && SERIAL_DEV_BUS
125 help
126 If you say Y here, you get support for talking to the ChromeOS EC
127 through a UART, using a byte-level protocol.
128
129 To compile this driver as a module, choose M here: the
130 module will be called cros_ec_uart.
131
132config CROS_EC_LPC
133 tristate "ChromeOS Embedded Controller (LPC)"
134 depends on CROS_EC && ACPI && (X86 || COMPILE_TEST)
135 depends on HAS_IOPORT
136 help
137 If you say Y here, you get support for talking to the ChromeOS EC
138 over an LPC bus, including the LPC Microchip EC (MEC) variant.
139 This uses a simple byte-level protocol with a checksum. This is
140 used for userspace access only. The kernel typically has its own
141 communication methods.
142
143 To compile this driver as a module, choose M here: the
144 module will be called cros_ec_lpcs.
145
146config CROS_EC_PROTO
147 bool
148 help
149 ChromeOS EC communication protocol helpers.
150
151config CROS_KBD_LED_BACKLIGHT
152 tristate "Backlight LED support for Chrome OS keyboards"
153 depends on LEDS_CLASS && (ACPI || CROS_EC || MFD_CROS_EC_DEV)
154 help
155 This option enables support for the keyboard backlight LEDs on
156 select Chrome OS systems.
157
158 To compile this driver as a module, choose M here: the
159 module will be called cros_kbd_led_backlight.
160
161config CROS_EC_CHARDEV
162 tristate "ChromeOS EC miscdevice"
163 depends on MFD_CROS_EC_DEV
164 default MFD_CROS_EC_DEV
165 help
166 This driver adds file operations support to talk with the
167 ChromeOS EC from userspace via a character device.
168
169 To compile this driver as a module, choose M here: the
170 module will be called cros_ec_chardev.
171
172config CROS_EC_LIGHTBAR
173 tristate "Chromebook Pixel's lightbar support"
174 depends on MFD_CROS_EC_DEV
175 default MFD_CROS_EC_DEV
176 help
177 This option exposes the Chromebook Pixel's lightbar to
178 userspace.
179
180 To compile this driver as a module, choose M here: the
181 module will be called cros_ec_lightbar.
182
183config CROS_EC_VBC
184 tristate "ChromeOS EC vboot context support"
185 depends on MFD_CROS_EC_DEV && OF
186 default MFD_CROS_EC_DEV
187 help
188 This option exposes the ChromeOS EC vboot context nvram to
189 userspace.
190
191 To compile this driver as a module, choose M here: the
192 module will be called cros_ec_vbc.
193
194config CROS_EC_DEBUGFS
195 tristate "Export ChromeOS EC internals in DebugFS"
196 depends on MFD_CROS_EC_DEV && DEBUG_FS
197 default MFD_CROS_EC_DEV
198 help
199 This option exposes the ChromeOS EC device internals to
200 userspace.
201
202 To compile this driver as a module, choose M here: the
203 module will be called cros_ec_debugfs.
204
205config CROS_EC_SENSORHUB
206 tristate "ChromeOS EC MEMS Sensor Hub"
207 depends on MFD_CROS_EC_DEV
208 default MFD_CROS_EC_DEV
209 help
210 Allow loading IIO sensors. This driver is loaded by MFD and will in
211 turn query the EC and register the sensors.
212 It also spreads the sensor data coming from the EC to the IIO sensor
213 object.
214
215 To compile this driver as a module, choose M here: the
216 module will be called cros_ec_sensorhub.
217
218config CROS_EC_SYSFS
219 tristate "ChromeOS EC control and information through sysfs"
220 depends on MFD_CROS_EC_DEV && SYSFS
221 default MFD_CROS_EC_DEV
222 help
223 This option exposes some sysfs attributes to control and get
224 information from ChromeOS EC.
225
226 To compile this driver as a module, choose M here: the
227 module will be called cros_ec_sysfs.
228
229config CROS_EC_TYPEC
230 tristate "ChromeOS EC Type-C Connector Control"
231 depends on MFD_CROS_EC_DEV && TYPEC
232 depends on CROS_USBPD_NOTIFY
233 depends on USB_ROLE_SWITCH
234 default MFD_CROS_EC_DEV
235 help
236 If you say Y here, you get support for accessing Type C connector
237 information from the Chrome OS EC.
238
239 To compile this driver as a module, choose M here: the module will be
240 called cros-ec-typec.
241
242config CROS_HPS_I2C
243 tristate "ChromeOS HPS device"
244 depends on HID && I2C && PM
245 help
246 Say Y here if you want to enable support for the ChromeOS
247 human presence sensor (HPS), attached via I2C. The driver supports a
248 sensor connected to the I2C bus and exposes it as a character device.
249 To save power, the sensor is automatically powered down when no
250 clients are accessing it.
251
252config CROS_USBPD_LOGGER
253 tristate "Logging driver for USB PD charger"
254 depends on CHARGER_CROS_USBPD
255 default y
256 select RTC_LIB
257 help
258 This option enables support for logging event data for the USB PD charger
259 available in the Embedded Controller on ChromeOS systems.
260
261 To compile this driver as a module, choose M here: the
262 module will be called cros_usbpd_logger.
263
264config CROS_USBPD_NOTIFY
265 tristate "ChromeOS Type-C power delivery event notifier"
266 depends on MFD_CROS_EC_DEV
267 default MFD_CROS_EC_DEV
268 help
269 If you say Y here, you get support for Type-C PD event notifications
270 from the ChromeOS EC. On ACPI platorms this driver will bind to the
271 GOOG0003 ACPI device, and on platforms which don't have this device it
272 will get initialized on ECs which support the feature
273 EC_FEATURE_USB_PD.
274
275 To compile this driver as a module, choose M here: the
276 module will be called cros_usbpd_notify.
277
278config CHROMEOS_PRIVACY_SCREEN
279 tristate "ChromeOS Privacy Screen support"
280 depends on ACPI
281 depends on DRM
282 select DRM_PRIVACY_SCREEN
283 help
284 This driver provides the support needed for the in-built electronic
285 privacy screen that is present on some ChromeOS devices. When enabled,
286 this should probably always be built into the kernel to avoid or
287 minimize drm probe deferral.
288
289config CROS_TYPEC_SWITCH
290 tristate "ChromeOS EC Type-C Switch Control"
291 depends on MFD_CROS_EC_DEV && TYPEC && ACPI
292 default MFD_CROS_EC_DEV
293 help
294 If you say Y here, you get support for configuring the ChromeOS EC Type-C
295 muxes and retimers.
296
297 To compile this driver as a module, choose M here: the module will be
298 called cros_typec_switch.
299
300source "drivers/platform/chrome/wilco_ec/Kconfig"
301
302# Kunit test cases
303config CROS_KUNIT_EC_PROTO_TEST
304 tristate "Kunit tests for ChromeOS EC protocol" if !KUNIT_ALL_TESTS
305 depends on KUNIT && CROS_EC
306 default KUNIT_ALL_TESTS
307 select CROS_EC_PROTO
308 help
309 Kunit tests for ChromeOS EC protocol.
310
311endif # CHROMEOS_PLATFORMS