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 __BASEBOARD_EC_H__
4 #define __BASEBOARD_EC_H__
5 
6 #include <ec/ec.h>
8 #include <baseboard/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_USB_CHARGER) |\
23  EC_HOST_EVENT_MASK(EC_HOST_EVENT_MKBP) |\
24  EC_HOST_EVENT_MASK(EC_HOST_EVENT_PD_MCU) |\
25  EC_HOST_EVENT_MASK(EC_HOST_EVENT_MODE_CHANGE))
26 
27 #define MAINBOARD_EC_SMI_EVENTS \
28  (EC_HOST_EVENT_MASK(EC_HOST_EVENT_LID_CLOSED))
29 
30 /* EC can wake from S5 with lid or power button */
31 #define MAINBOARD_EC_S5_WAKE_EVENTS \
32  (EC_HOST_EVENT_MASK(EC_HOST_EVENT_LID_OPEN) |\
33  EC_HOST_EVENT_MASK(EC_HOST_EVENT_POWER_BUTTON))
34 
35 /*
36  * EC can wake from S3/S0ix with:
37  * 1. Lid open
38  * 2. Power button
39  * 3. Key press
40  * 4. Mode change
41  * 5. AC Connect/Disconnect
42  */
43 #define MAINBOARD_EC_S3_WAKE_EVENTS \
44  (MAINBOARD_EC_S5_WAKE_EVENTS |\
45  EC_HOST_EVENT_MASK(EC_HOST_EVENT_AC_CONNECTED) |\
46  EC_HOST_EVENT_MASK(EC_HOST_EVENT_AC_DISCONNECTED) |\
47  EC_HOST_EVENT_MASK(EC_HOST_EVENT_KEY_PRESSED) |\
48  EC_HOST_EVENT_MASK(EC_HOST_EVENT_MODE_CHANGE))
49 
50 #define MAINBOARD_EC_S0IX_WAKE_EVENTS (MAINBOARD_EC_S3_WAKE_EVENTS)
51 
52 /* Log EC wake events plus EC shutdown events */
53 #define MAINBOARD_EC_LOG_EVENTS \
54  (EC_HOST_EVENT_MASK(EC_HOST_EVENT_THERMAL_SHUTDOWN) |\
55  EC_HOST_EVENT_MASK(EC_HOST_EVENT_BATTERY_SHUTDOWN) |\
56  EC_HOST_EVENT_MASK(EC_HOST_EVENT_PANIC))
57 
58 /*
59  * ACPI related definitions for ASL code.
60  */
61 
62 /* Enable EC backed ALS device in ACPI */
63 #define EC_ENABLE_ALS_DEVICE
64 
65 /* Enable MKBP for buttons and switches */
66 #define EC_ENABLE_MKBP_DEVICE
67 
68 /* Enable LID switch and provide wake pin for EC */
69 #define EC_ENABLE_LID_SWITCH
70 #define EC_ENABLE_WAKE_PIN GPE_EC_WAKE
71 
72 /* Enable EC backed PD MCU device in ACPI */
73 #define EC_ENABLE_PD_MCU_DEVICE
74 
75 #define SIO_EC_MEMMAP_ENABLE /* EC Memory Map Resources */
76 #define SIO_EC_HOST_ENABLE /* EC Host Interface Resources */
77 #define SIO_EC_ENABLE_PS2K /* Enable PS/2 Keyboard */
78 
79 /* Enable EC SYNC IRQ, EC_SYNC_IRQ is defined in baseboard/gpio.h */
80 #define EC_ENABLE_SYNC_IRQ
81 
82 #endif /* __BASEBOARD_EC_H__ */