coreboot
coreboot is an Open Source project aimed at replacing the proprietary BIOS found in most computers.
ec.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 
3 #ifndef __MAINBOARD_EC_H__
4 #define __MAINBOARD_EC_H__
5 
6 #include <ec/ec.h>
8 #include <variant/gpio.h>
9 
10 #define MAINBOARD_EC_SCI_EVENTS \
11  (EC_HOST_EVENT_MASK(EC_HOST_EVENT_LID_CLOSED) |\
12  EC_HOST_EVENT_MASK(EC_HOST_EVENT_LID_OPEN) |\
13  EC_HOST_EVENT_MASK(EC_HOST_EVENT_AC_CONNECTED) |\
14  EC_HOST_EVENT_MASK(EC_HOST_EVENT_AC_DISCONNECTED) |\
15  EC_HOST_EVENT_MASK(EC_HOST_EVENT_BATTERY_LOW) |\
16  EC_HOST_EVENT_MASK(EC_HOST_EVENT_BATTERY_CRITICAL) |\
17  EC_HOST_EVENT_MASK(EC_HOST_EVENT_BATTERY) |\
18  EC_HOST_EVENT_MASK(EC_HOST_EVENT_BATTERY_STATUS) |\
19  EC_HOST_EVENT_MASK(EC_HOST_EVENT_THERMAL_THRESHOLD) |\
20  EC_HOST_EVENT_MASK(EC_HOST_EVENT_THROTTLE_START) |\
21  EC_HOST_EVENT_MASK(EC_HOST_EVENT_THROTTLE_STOP) |\
22  EC_HOST_EVENT_MASK(EC_HOST_EVENT_PD_MCU) |\
23  EC_HOST_EVENT_MASK(EC_HOST_EVENT_MODE_CHANGE) |\
24  EC_HOST_EVENT_MASK(EC_HOST_EVENT_USB_MUX))
25 
26 #define MAINBOARD_EC_SMI_EVENTS \
27  (EC_HOST_EVENT_MASK(EC_HOST_EVENT_LID_CLOSED))
28 
29 /* EC can wake from S5 with lid or power button */
30 #define MAINBOARD_EC_S5_WAKE_EVENTS \
31  (EC_HOST_EVENT_MASK(EC_HOST_EVENT_LID_OPEN) |\
32  EC_HOST_EVENT_MASK(EC_HOST_EVENT_POWER_BUTTON))
33 
34 /* EC can wake from S3 with lid, power button or mode change event */
35 #define MAINBOARD_EC_S3_WAKE_EVENTS \
36  (MAINBOARD_EC_S5_WAKE_EVENTS |\
37  EC_HOST_EVENT_MASK(EC_HOST_EVENT_AC_CONNECTED) |\
38  EC_HOST_EVENT_MASK(EC_HOST_EVENT_AC_DISCONNECTED) |\
39  EC_HOST_EVENT_MASK(EC_HOST_EVENT_KEY_PRESSED) |\
40  EC_HOST_EVENT_MASK(EC_HOST_EVENT_MODE_CHANGE))
41 
42 #define MAINBOARD_EC_S0IX_WAKE_EVENTS \
43  (MAINBOARD_EC_S3_WAKE_EVENTS |\
44  EC_HOST_EVENT_MASK(EC_HOST_EVENT_USB_MUX))
45 
46 /* Log EC wake events plus EC shutdown events */
47 #define MAINBOARD_EC_LOG_EVENTS \
48  (EC_HOST_EVENT_MASK(EC_HOST_EVENT_THERMAL_SHUTDOWN) |\
49  EC_HOST_EVENT_MASK(EC_HOST_EVENT_BATTERY_SHUTDOWN) |\
50  EC_HOST_EVENT_MASK(EC_HOST_EVENT_PANIC))
51 
52 /*
53  * ACPI related definitions for ASL code.
54  */
55 
56 /* Enable EC backed ALS device in ACPI */
57 #define EC_ENABLE_ALS_DEVICE
58 
59 /* Enable MKBP for buttons and switches */
60 #define EC_ENABLE_MKBP_DEVICE
61 
62 /* Enable LID switch and provide wake pin for EC */
63 #define EC_ENABLE_LID_SWITCH
64 #define EC_ENABLE_WAKE_PIN GPE_EC_WAKE
65 
66 #define SIO_EC_MEMMAP_ENABLE /* EC Memory Map Resources */
67 #define SIO_EC_HOST_ENABLE /* EC Host Interface Resources */
68 #define SIO_EC_ENABLE_PS2K /* Enable PS/2 Keyboard */
69 
70 /* Enable EC sync interrupt, EC_SYNC_IRQ is defined in variant/gpio.h */
71 #define EC_ENABLE_SYNC_IRQ
72 
73 /* Enable EC backed PD MCU device in ACPI */
74 #define EC_ENABLE_PD_MCU_DEVICE
75 
76 /* Enable EC backed Keyboard Backlight in ACPI */
77 #define EC_ENABLE_KEYBOARD_BACKLIGHT
78 
79 #endif /* __MAINBOARD_EC_H__ */