1d1eb86e5SZhang Rui // SPDX-License-Identifier: GPL-2.0-only
2d1eb86e5SZhang Rui
3d1eb86e5SZhang Rui /*
4d1eb86e5SZhang Rui * FPDT support for exporting boot and suspend/resume performance data
5d1eb86e5SZhang Rui *
6d1eb86e5SZhang Rui * Copyright (C) 2021 Intel Corporation. All rights reserved.
7d1eb86e5SZhang Rui */
8d1eb86e5SZhang Rui
9d1eb86e5SZhang Rui #define pr_fmt(fmt) "ACPI FPDT: " fmt
10d1eb86e5SZhang Rui
11d1eb86e5SZhang Rui #include <linux/acpi.h>
12d1eb86e5SZhang Rui
13d1eb86e5SZhang Rui /*
14d1eb86e5SZhang Rui * FPDT contains ACPI table header and a number of fpdt_subtable_entries.
15d1eb86e5SZhang Rui * Each fpdt_subtable_entry points to a subtable: FBPT or S3PT.
16d1eb86e5SZhang Rui * Each FPDT subtable (FBPT/S3PT) is composed of a fpdt_subtable_header
17d1eb86e5SZhang Rui * and a number of fpdt performance records.
18d1eb86e5SZhang Rui * Each FPDT performance record is composed of a fpdt_record_header and
19d1eb86e5SZhang Rui * performance data fields, for boot or suspend or resume phase.
20d1eb86e5SZhang Rui */
21d1eb86e5SZhang Rui enum fpdt_subtable_type {
22d1eb86e5SZhang Rui SUBTABLE_FBPT,
23d1eb86e5SZhang Rui SUBTABLE_S3PT,
24d1eb86e5SZhang Rui };
25d1eb86e5SZhang Rui
26d1eb86e5SZhang Rui struct fpdt_subtable_entry {
27d1eb86e5SZhang Rui u16 type; /* refer to enum fpdt_subtable_type */
28d1eb86e5SZhang Rui u8 length;
29d1eb86e5SZhang Rui u8 revision;
30d1eb86e5SZhang Rui u32 reserved;
31d1eb86e5SZhang Rui u64 address; /* physical address of the S3PT/FBPT table */
32d1eb86e5SZhang Rui };
33d1eb86e5SZhang Rui
34d1eb86e5SZhang Rui struct fpdt_subtable_header {
35d1eb86e5SZhang Rui u32 signature;
36d1eb86e5SZhang Rui u32 length;
37d1eb86e5SZhang Rui };
38d1eb86e5SZhang Rui
39d1eb86e5SZhang Rui enum fpdt_record_type {
40d1eb86e5SZhang Rui RECORD_S3_RESUME,
41d1eb86e5SZhang Rui RECORD_S3_SUSPEND,
42d1eb86e5SZhang Rui RECORD_BOOT,
43d1eb86e5SZhang Rui };
44d1eb86e5SZhang Rui
45d1eb86e5SZhang Rui struct fpdt_record_header {
46d1eb86e5SZhang Rui u16 type; /* refer to enum fpdt_record_type */
47d1eb86e5SZhang Rui u8 length;
48d1eb86e5SZhang Rui u8 revision;
49d1eb86e5SZhang Rui };
50d1eb86e5SZhang Rui
51d1eb86e5SZhang Rui struct resume_performance_record {
52d1eb86e5SZhang Rui struct fpdt_record_header header;
53d1eb86e5SZhang Rui u32 resume_count;
54d1eb86e5SZhang Rui u64 resume_prev;
55d1eb86e5SZhang Rui u64 resume_avg;
56d1eb86e5SZhang Rui } __attribute__((packed));
57d1eb86e5SZhang Rui
58d1eb86e5SZhang Rui struct boot_performance_record {
59d1eb86e5SZhang Rui struct fpdt_record_header header;
60d1eb86e5SZhang Rui u32 reserved;
61d1eb86e5SZhang Rui u64 firmware_start;
62d1eb86e5SZhang Rui u64 bootloader_load;
63d1eb86e5SZhang Rui u64 bootloader_launch;
64d1eb86e5SZhang Rui u64 exitbootservice_start;
65d1eb86e5SZhang Rui u64 exitbootservice_end;
66d1eb86e5SZhang Rui } __attribute__((packed));
67d1eb86e5SZhang Rui
68d1eb86e5SZhang Rui struct suspend_performance_record {
69d1eb86e5SZhang Rui struct fpdt_record_header header;
70d1eb86e5SZhang Rui u64 suspend_start;
71d1eb86e5SZhang Rui u64 suspend_end;
72d1eb86e5SZhang Rui } __attribute__((packed));
73d1eb86e5SZhang Rui
74d1eb86e5SZhang Rui
75d1eb86e5SZhang Rui static struct resume_performance_record *record_resume;
76d1eb86e5SZhang Rui static struct suspend_performance_record *record_suspend;
77d1eb86e5SZhang Rui static struct boot_performance_record *record_boot;
78d1eb86e5SZhang Rui
79d1eb86e5SZhang Rui #define FPDT_ATTR(phase, name) \
80d1eb86e5SZhang Rui static ssize_t name##_show(struct kobject *kobj, \
81d1eb86e5SZhang Rui struct kobj_attribute *attr, char *buf) \
82d1eb86e5SZhang Rui { \
83d1eb86e5SZhang Rui return sprintf(buf, "%llu\n", record_##phase->name); \
84d1eb86e5SZhang Rui } \
85d1eb86e5SZhang Rui static struct kobj_attribute name##_attr = \
86d1eb86e5SZhang Rui __ATTR(name##_ns, 0444, name##_show, NULL)
87d1eb86e5SZhang Rui
88d1eb86e5SZhang Rui FPDT_ATTR(resume, resume_prev);
89d1eb86e5SZhang Rui FPDT_ATTR(resume, resume_avg);
90d1eb86e5SZhang Rui FPDT_ATTR(suspend, suspend_start);
91d1eb86e5SZhang Rui FPDT_ATTR(suspend, suspend_end);
92d1eb86e5SZhang Rui FPDT_ATTR(boot, firmware_start);
93d1eb86e5SZhang Rui FPDT_ATTR(boot, bootloader_load);
94d1eb86e5SZhang Rui FPDT_ATTR(boot, bootloader_launch);
95d1eb86e5SZhang Rui FPDT_ATTR(boot, exitbootservice_start);
96d1eb86e5SZhang Rui FPDT_ATTR(boot, exitbootservice_end);
97d1eb86e5SZhang Rui
resume_count_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)98d1eb86e5SZhang Rui static ssize_t resume_count_show(struct kobject *kobj,
99d1eb86e5SZhang Rui struct kobj_attribute *attr, char *buf)
100d1eb86e5SZhang Rui {
101d1eb86e5SZhang Rui return sprintf(buf, "%u\n", record_resume->resume_count);
102d1eb86e5SZhang Rui }
103d1eb86e5SZhang Rui
104d1eb86e5SZhang Rui static struct kobj_attribute resume_count_attr =
105d1eb86e5SZhang Rui __ATTR_RO(resume_count);
106d1eb86e5SZhang Rui
107d1eb86e5SZhang Rui static struct attribute *resume_attrs[] = {
108d1eb86e5SZhang Rui &resume_count_attr.attr,
109d1eb86e5SZhang Rui &resume_prev_attr.attr,
110d1eb86e5SZhang Rui &resume_avg_attr.attr,
111d1eb86e5SZhang Rui NULL
112d1eb86e5SZhang Rui };
113d1eb86e5SZhang Rui
114d1eb86e5SZhang Rui static const struct attribute_group resume_attr_group = {
115d1eb86e5SZhang Rui .attrs = resume_attrs,
116d1eb86e5SZhang Rui .name = "resume",
117d1eb86e5SZhang Rui };
118d1eb86e5SZhang Rui
119d1eb86e5SZhang Rui static struct attribute *suspend_attrs[] = {
120d1eb86e5SZhang Rui &suspend_start_attr.attr,
121d1eb86e5SZhang Rui &suspend_end_attr.attr,
122d1eb86e5SZhang Rui NULL
123d1eb86e5SZhang Rui };
124d1eb86e5SZhang Rui
125d1eb86e5SZhang Rui static const struct attribute_group suspend_attr_group = {
126d1eb86e5SZhang Rui .attrs = suspend_attrs,
127d1eb86e5SZhang Rui .name = "suspend",
128d1eb86e5SZhang Rui };
129d1eb86e5SZhang Rui
130d1eb86e5SZhang Rui static struct attribute *boot_attrs[] = {
131d1eb86e5SZhang Rui &firmware_start_attr.attr,
132d1eb86e5SZhang Rui &bootloader_load_attr.attr,
133d1eb86e5SZhang Rui &bootloader_launch_attr.attr,
134d1eb86e5SZhang Rui &exitbootservice_start_attr.attr,
135d1eb86e5SZhang Rui &exitbootservice_end_attr.attr,
136d1eb86e5SZhang Rui NULL
137d1eb86e5SZhang Rui };
138d1eb86e5SZhang Rui
139d1eb86e5SZhang Rui static const struct attribute_group boot_attr_group = {
140d1eb86e5SZhang Rui .attrs = boot_attrs,
141d1eb86e5SZhang Rui .name = "boot",
142d1eb86e5SZhang Rui };
143d1eb86e5SZhang Rui
144d1eb86e5SZhang Rui static struct kobject *fpdt_kobj;
145d1eb86e5SZhang Rui
146211391bfSHans de Goede #if defined CONFIG_X86 && defined CONFIG_PHYS_ADDR_T_64BIT
147211391bfSHans de Goede #include <linux/processor.h>
fpdt_address_valid(u64 address)148211391bfSHans de Goede static bool fpdt_address_valid(u64 address)
149211391bfSHans de Goede {
150211391bfSHans de Goede /*
151211391bfSHans de Goede * On some systems the table contains invalid addresses
152211391bfSHans de Goede * with unsuppored high address bits set, check for this.
153211391bfSHans de Goede */
154211391bfSHans de Goede return !(address >> boot_cpu_data.x86_phys_bits);
155211391bfSHans de Goede }
156211391bfSHans de Goede #else
fpdt_address_valid(u64 address)157211391bfSHans de Goede static bool fpdt_address_valid(u64 address)
158211391bfSHans de Goede {
159211391bfSHans de Goede return true;
160211391bfSHans de Goede }
161211391bfSHans de Goede #endif
162211391bfSHans de Goede
fpdt_process_subtable(u64 address,u32 subtable_type)163d1eb86e5SZhang Rui static int fpdt_process_subtable(u64 address, u32 subtable_type)
164d1eb86e5SZhang Rui {
165d1eb86e5SZhang Rui struct fpdt_subtable_header *subtable_header;
166d1eb86e5SZhang Rui struct fpdt_record_header *record_header;
167d1eb86e5SZhang Rui char *signature = (subtable_type == SUBTABLE_FBPT ? "FBPT" : "S3PT");
168d1eb86e5SZhang Rui u32 length, offset;
169d1eb86e5SZhang Rui int result;
170d1eb86e5SZhang Rui
171211391bfSHans de Goede if (!fpdt_address_valid(address)) {
172211391bfSHans de Goede pr_info(FW_BUG "invalid physical address: 0x%llx!\n", address);
173211391bfSHans de Goede return -EINVAL;
174211391bfSHans de Goede }
175211391bfSHans de Goede
176d1eb86e5SZhang Rui subtable_header = acpi_os_map_memory(address, sizeof(*subtable_header));
177d1eb86e5SZhang Rui if (!subtable_header)
178d1eb86e5SZhang Rui return -ENOMEM;
179d1eb86e5SZhang Rui
180d1eb86e5SZhang Rui if (strncmp((char *)&subtable_header->signature, signature, 4)) {
181d1eb86e5SZhang Rui pr_info(FW_BUG "subtable signature and type mismatch!\n");
182d1eb86e5SZhang Rui return -EINVAL;
183d1eb86e5SZhang Rui }
184d1eb86e5SZhang Rui
185d1eb86e5SZhang Rui length = subtable_header->length;
186d1eb86e5SZhang Rui acpi_os_unmap_memory(subtable_header, sizeof(*subtable_header));
187d1eb86e5SZhang Rui
188d1eb86e5SZhang Rui subtable_header = acpi_os_map_memory(address, length);
189d1eb86e5SZhang Rui if (!subtable_header)
190d1eb86e5SZhang Rui return -ENOMEM;
191d1eb86e5SZhang Rui
192d1eb86e5SZhang Rui offset = sizeof(*subtable_header);
193d1eb86e5SZhang Rui while (offset < length) {
194d1eb86e5SZhang Rui record_header = (void *)subtable_header + offset;
195d1eb86e5SZhang Rui offset += record_header->length;
196d1eb86e5SZhang Rui
197*a83c68a3SVasily Khoruzhick if (!record_header->length) {
198*a83c68a3SVasily Khoruzhick pr_err(FW_BUG "Zero-length record found in FPTD.\n");
199*a83c68a3SVasily Khoruzhick result = -EINVAL;
200*a83c68a3SVasily Khoruzhick goto err;
201*a83c68a3SVasily Khoruzhick }
202*a83c68a3SVasily Khoruzhick
203d1eb86e5SZhang Rui switch (record_header->type) {
204d1eb86e5SZhang Rui case RECORD_S3_RESUME:
205d1eb86e5SZhang Rui if (subtable_type != SUBTABLE_S3PT) {
206d1eb86e5SZhang Rui pr_err(FW_BUG "Invalid record %d for subtable %s\n",
207d1eb86e5SZhang Rui record_header->type, signature);
208*a83c68a3SVasily Khoruzhick result = -EINVAL;
209*a83c68a3SVasily Khoruzhick goto err;
210d1eb86e5SZhang Rui }
211d1eb86e5SZhang Rui if (record_resume) {
212d1eb86e5SZhang Rui pr_err("Duplicate resume performance record found.\n");
213d1eb86e5SZhang Rui continue;
214d1eb86e5SZhang Rui }
215d1eb86e5SZhang Rui record_resume = (struct resume_performance_record *)record_header;
216d1eb86e5SZhang Rui result = sysfs_create_group(fpdt_kobj, &resume_attr_group);
217d1eb86e5SZhang Rui if (result)
218*a83c68a3SVasily Khoruzhick goto err;
219d1eb86e5SZhang Rui break;
220d1eb86e5SZhang Rui case RECORD_S3_SUSPEND:
221d1eb86e5SZhang Rui if (subtable_type != SUBTABLE_S3PT) {
222d1eb86e5SZhang Rui pr_err(FW_BUG "Invalid %d for subtable %s\n",
223d1eb86e5SZhang Rui record_header->type, signature);
224d1eb86e5SZhang Rui continue;
225d1eb86e5SZhang Rui }
226d1eb86e5SZhang Rui if (record_suspend) {
227d1eb86e5SZhang Rui pr_err("Duplicate suspend performance record found.\n");
228d1eb86e5SZhang Rui continue;
229d1eb86e5SZhang Rui }
230d1eb86e5SZhang Rui record_suspend = (struct suspend_performance_record *)record_header;
231d1eb86e5SZhang Rui result = sysfs_create_group(fpdt_kobj, &suspend_attr_group);
232d1eb86e5SZhang Rui if (result)
233*a83c68a3SVasily Khoruzhick goto err;
234d1eb86e5SZhang Rui break;
235d1eb86e5SZhang Rui case RECORD_BOOT:
236d1eb86e5SZhang Rui if (subtable_type != SUBTABLE_FBPT) {
237d1eb86e5SZhang Rui pr_err(FW_BUG "Invalid %d for subtable %s\n",
238d1eb86e5SZhang Rui record_header->type, signature);
239*a83c68a3SVasily Khoruzhick result = -EINVAL;
240*a83c68a3SVasily Khoruzhick goto err;
241d1eb86e5SZhang Rui }
242d1eb86e5SZhang Rui if (record_boot) {
243d1eb86e5SZhang Rui pr_err("Duplicate boot performance record found.\n");
244d1eb86e5SZhang Rui continue;
245d1eb86e5SZhang Rui }
246d1eb86e5SZhang Rui record_boot = (struct boot_performance_record *)record_header;
247d1eb86e5SZhang Rui result = sysfs_create_group(fpdt_kobj, &boot_attr_group);
248d1eb86e5SZhang Rui if (result)
249*a83c68a3SVasily Khoruzhick goto err;
250d1eb86e5SZhang Rui break;
251d1eb86e5SZhang Rui
252d1eb86e5SZhang Rui default:
25397e03410SAdrian Huang /* Other types are reserved in ACPI 6.4 spec. */
25497e03410SAdrian Huang break;
255d1eb86e5SZhang Rui }
256d1eb86e5SZhang Rui }
257d1eb86e5SZhang Rui return 0;
258*a83c68a3SVasily Khoruzhick
259*a83c68a3SVasily Khoruzhick err:
260*a83c68a3SVasily Khoruzhick if (record_boot)
261*a83c68a3SVasily Khoruzhick sysfs_remove_group(fpdt_kobj, &boot_attr_group);
262*a83c68a3SVasily Khoruzhick
263*a83c68a3SVasily Khoruzhick if (record_suspend)
264*a83c68a3SVasily Khoruzhick sysfs_remove_group(fpdt_kobj, &suspend_attr_group);
265*a83c68a3SVasily Khoruzhick
266*a83c68a3SVasily Khoruzhick if (record_resume)
267*a83c68a3SVasily Khoruzhick sysfs_remove_group(fpdt_kobj, &resume_attr_group);
268*a83c68a3SVasily Khoruzhick
269*a83c68a3SVasily Khoruzhick return result;
270d1eb86e5SZhang Rui }
271d1eb86e5SZhang Rui
acpi_init_fpdt(void)272d1eb86e5SZhang Rui static int __init acpi_init_fpdt(void)
273d1eb86e5SZhang Rui {
274d1eb86e5SZhang Rui acpi_status status;
275d1eb86e5SZhang Rui struct acpi_table_header *header;
276d1eb86e5SZhang Rui struct fpdt_subtable_entry *subtable;
277d1eb86e5SZhang Rui u32 offset = sizeof(*header);
278*a83c68a3SVasily Khoruzhick int result;
279d1eb86e5SZhang Rui
280d1eb86e5SZhang Rui status = acpi_get_table(ACPI_SIG_FPDT, 0, &header);
281d1eb86e5SZhang Rui
282d1eb86e5SZhang Rui if (ACPI_FAILURE(status))
283d1eb86e5SZhang Rui return 0;
284d1eb86e5SZhang Rui
285d1eb86e5SZhang Rui fpdt_kobj = kobject_create_and_add("fpdt", acpi_kobj);
286dd9eaa23SJing Xiangfeng if (!fpdt_kobj) {
287*a83c68a3SVasily Khoruzhick result = -ENOMEM;
288*a83c68a3SVasily Khoruzhick goto err_nomem;
289dd9eaa23SJing Xiangfeng }
290d1eb86e5SZhang Rui
291d1eb86e5SZhang Rui while (offset < header->length) {
292d1eb86e5SZhang Rui subtable = (void *)header + offset;
293d1eb86e5SZhang Rui switch (subtable->type) {
294d1eb86e5SZhang Rui case SUBTABLE_FBPT:
295d1eb86e5SZhang Rui case SUBTABLE_S3PT:
296*a83c68a3SVasily Khoruzhick result = fpdt_process_subtable(subtable->address,
297d1eb86e5SZhang Rui subtable->type);
298*a83c68a3SVasily Khoruzhick if (result)
299*a83c68a3SVasily Khoruzhick goto err_subtable;
300d1eb86e5SZhang Rui break;
301d1eb86e5SZhang Rui default:
30297e03410SAdrian Huang /* Other types are reserved in ACPI 6.4 spec. */
303d1eb86e5SZhang Rui break;
304d1eb86e5SZhang Rui }
305d1eb86e5SZhang Rui offset += sizeof(*subtable);
306d1eb86e5SZhang Rui }
307d1eb86e5SZhang Rui return 0;
308*a83c68a3SVasily Khoruzhick err_subtable:
309*a83c68a3SVasily Khoruzhick kobject_put(fpdt_kobj);
310*a83c68a3SVasily Khoruzhick
311*a83c68a3SVasily Khoruzhick err_nomem:
312*a83c68a3SVasily Khoruzhick acpi_put_table(header);
313*a83c68a3SVasily Khoruzhick return result;
314d1eb86e5SZhang Rui }
315d1eb86e5SZhang Rui
316d1eb86e5SZhang Rui fs_initcall(acpi_init_fpdt);
317