xref: /linux-6.15/drivers/acpi/processor_core.c (revision ababa16f)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2005 Intel Corporation
4  * Copyright (C) 2009 Hewlett-Packard Development Company, L.P.
5  *
6  *	Alex Chiang <[email protected]>
7  *	- Unified x86/ia64 implementations
8  *
9  * I/O APIC hotplug support
10  *	Yinghai Lu <[email protected]>
11  *	Jiang Liu <[email protected]>
12  */
13 #include <linux/export.h>
14 #include <linux/acpi.h>
15 #include <acpi/processor.h>
16 
17 static struct acpi_table_madt *get_madt_table(void)
18 {
19 	static struct acpi_table_madt *madt;
20 	static int read_madt;
21 
22 	if (!read_madt) {
23 		if (ACPI_FAILURE(acpi_get_table(ACPI_SIG_MADT, 0,
24 					(struct acpi_table_header **)&madt)))
25 			madt = NULL;
26 		read_madt++;
27 	}
28 
29 	return madt;
30 }
31 
32 static int map_lapic_id(struct acpi_subtable_header *entry,
33 		 u32 acpi_id, phys_cpuid_t *apic_id)
34 {
35 	struct acpi_madt_local_apic *lapic =
36 		container_of(entry, struct acpi_madt_local_apic, header);
37 
38 	if (!(lapic->lapic_flags & ACPI_MADT_ENABLED))
39 		return -ENODEV;
40 
41 	if (lapic->processor_id != acpi_id)
42 		return -EINVAL;
43 
44 	*apic_id = lapic->id;
45 	return 0;
46 }
47 
48 static int map_x2apic_id(struct acpi_subtable_header *entry,
49 		int device_declaration, u32 acpi_id, phys_cpuid_t *apic_id)
50 {
51 	struct acpi_madt_local_x2apic *apic =
52 		container_of(entry, struct acpi_madt_local_x2apic, header);
53 
54 	if (!(apic->lapic_flags & ACPI_MADT_ENABLED))
55 		return -ENODEV;
56 
57 	if (device_declaration && (apic->uid == acpi_id)) {
58 		*apic_id = apic->local_apic_id;
59 		return 0;
60 	}
61 
62 	return -EINVAL;
63 }
64 
65 static int map_lsapic_id(struct acpi_subtable_header *entry,
66 		int device_declaration, u32 acpi_id, phys_cpuid_t *apic_id)
67 {
68 	struct acpi_madt_local_sapic *lsapic =
69 		container_of(entry, struct acpi_madt_local_sapic, header);
70 
71 	if (!(lsapic->lapic_flags & ACPI_MADT_ENABLED))
72 		return -ENODEV;
73 
74 	if (device_declaration) {
75 		if ((entry->length < 16) || (lsapic->uid != acpi_id))
76 			return -EINVAL;
77 	} else if (lsapic->processor_id != acpi_id)
78 		return -EINVAL;
79 
80 	*apic_id = (lsapic->id << 8) | lsapic->eid;
81 	return 0;
82 }
83 
84 /*
85  * Retrieve the ARM CPU physical identifier (MPIDR)
86  */
87 static int map_gicc_mpidr(struct acpi_subtable_header *entry,
88 		int device_declaration, u32 acpi_id, phys_cpuid_t *mpidr)
89 {
90 	struct acpi_madt_generic_interrupt *gicc =
91 	    container_of(entry, struct acpi_madt_generic_interrupt, header);
92 
93 	if (!acpi_gicc_is_usable(gicc))
94 		return -ENODEV;
95 
96 	/* device_declaration means Device object in DSDT, in the
97 	 * GIC interrupt model, logical processors are required to
98 	 * have a Processor Device object in the DSDT, so we should
99 	 * check device_declaration here
100 	 */
101 	if (device_declaration && (gicc->uid == acpi_id)) {
102 		*mpidr = gicc->arm_mpidr;
103 		return 0;
104 	}
105 
106 	return -EINVAL;
107 }
108 
109 /*
110  * Retrieve the RISC-V hartid for the processor
111  */
112 static int map_rintc_hartid(struct acpi_subtable_header *entry,
113 			    int device_declaration, u32 acpi_id,
114 			    phys_cpuid_t *hartid)
115 {
116 	struct acpi_madt_rintc *rintc =
117 	    container_of(entry, struct acpi_madt_rintc, header);
118 
119 	if (!(rintc->flags & ACPI_MADT_ENABLED))
120 		return -ENODEV;
121 
122 	/* device_declaration means Device object in DSDT, in the
123 	 * RISC-V, logical processors are required to
124 	 * have a Processor Device object in the DSDT, so we should
125 	 * check device_declaration here
126 	 */
127 	if (device_declaration && rintc->uid == acpi_id) {
128 		*hartid = rintc->hart_id;
129 		return 0;
130 	}
131 
132 	return -EINVAL;
133 }
134 
135 /*
136  * Retrieve LoongArch CPU physical id
137  */
138 static int map_core_pic_id(struct acpi_subtable_header *entry,
139 		int device_declaration, u32 acpi_id, phys_cpuid_t *phys_id)
140 {
141 	struct acpi_madt_core_pic *core_pic =
142 		container_of(entry, struct acpi_madt_core_pic, header);
143 
144 	if (!(core_pic->flags & ACPI_MADT_ENABLED))
145 		return -ENODEV;
146 
147 	/* device_declaration means Device object in DSDT, in LoongArch
148 	 * system, logical processor acpi_id is required in _UID property
149 	 * of DSDT table, so we should check device_declaration here
150 	 */
151 	if (device_declaration && (core_pic->processor_id == acpi_id)) {
152 		*phys_id = core_pic->core_id;
153 		return 0;
154 	}
155 
156 	return -EINVAL;
157 }
158 
159 static phys_cpuid_t map_madt_entry(struct acpi_table_madt *madt,
160 				   int type, u32 acpi_id)
161 {
162 	unsigned long madt_end, entry;
163 	phys_cpuid_t phys_id = PHYS_CPUID_INVALID;	/* CPU hardware ID */
164 
165 	if (!madt)
166 		return phys_id;
167 
168 	entry = (unsigned long)madt;
169 	madt_end = entry + madt->header.length;
170 
171 	/* Parse all entries looking for a match. */
172 
173 	entry += sizeof(struct acpi_table_madt);
174 	while (entry + sizeof(struct acpi_subtable_header) < madt_end) {
175 		struct acpi_subtable_header *header =
176 			(struct acpi_subtable_header *)entry;
177 		if (header->type == ACPI_MADT_TYPE_LOCAL_APIC) {
178 			if (!map_lapic_id(header, acpi_id, &phys_id))
179 				break;
180 		} else if (header->type == ACPI_MADT_TYPE_LOCAL_X2APIC) {
181 			if (!map_x2apic_id(header, type, acpi_id, &phys_id))
182 				break;
183 		} else if (header->type == ACPI_MADT_TYPE_LOCAL_SAPIC) {
184 			if (!map_lsapic_id(header, type, acpi_id, &phys_id))
185 				break;
186 		} else if (header->type == ACPI_MADT_TYPE_GENERIC_INTERRUPT) {
187 			if (!map_gicc_mpidr(header, type, acpi_id, &phys_id))
188 				break;
189 		} else if (header->type == ACPI_MADT_TYPE_RINTC) {
190 			if (!map_rintc_hartid(header, type, acpi_id, &phys_id))
191 				break;
192 		} else if (header->type == ACPI_MADT_TYPE_CORE_PIC) {
193 			if (!map_core_pic_id(header, type, acpi_id, &phys_id))
194 				break;
195 		}
196 		entry += header->length;
197 	}
198 	return phys_id;
199 }
200 
201 phys_cpuid_t __init acpi_map_madt_entry(u32 acpi_id)
202 {
203 	struct acpi_table_madt *madt = NULL;
204 	phys_cpuid_t rv;
205 
206 	acpi_get_table(ACPI_SIG_MADT, 0,
207 		       (struct acpi_table_header **)&madt);
208 	if (!madt)
209 		return PHYS_CPUID_INVALID;
210 
211 	rv = map_madt_entry(madt, 1, acpi_id);
212 
213 	acpi_put_table((struct acpi_table_header *)madt);
214 
215 	return rv;
216 }
217 
218 int __init acpi_get_madt_revision(void)
219 {
220 	struct acpi_table_header *madt = NULL;
221 	int revision;
222 
223 	if (ACPI_FAILURE(acpi_get_table(ACPI_SIG_MADT, 0, &madt)))
224 		return -EINVAL;
225 
226 	revision = madt->revision;
227 
228 	acpi_put_table(madt);
229 
230 	return revision;
231 }
232 
233 static phys_cpuid_t map_mat_entry(acpi_handle handle, int type, u32 acpi_id)
234 {
235 	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
236 	union acpi_object *obj;
237 	struct acpi_subtable_header *header;
238 	phys_cpuid_t phys_id = PHYS_CPUID_INVALID;
239 
240 	if (ACPI_FAILURE(acpi_evaluate_object(handle, "_MAT", NULL, &buffer)))
241 		goto exit;
242 
243 	if (!buffer.length || !buffer.pointer)
244 		goto exit;
245 
246 	obj = buffer.pointer;
247 	if (obj->type != ACPI_TYPE_BUFFER ||
248 	    obj->buffer.length < sizeof(struct acpi_subtable_header)) {
249 		goto exit;
250 	}
251 
252 	header = (struct acpi_subtable_header *)obj->buffer.pointer;
253 	if (header->type == ACPI_MADT_TYPE_LOCAL_APIC)
254 		map_lapic_id(header, acpi_id, &phys_id);
255 	else if (header->type == ACPI_MADT_TYPE_LOCAL_SAPIC)
256 		map_lsapic_id(header, type, acpi_id, &phys_id);
257 	else if (header->type == ACPI_MADT_TYPE_LOCAL_X2APIC)
258 		map_x2apic_id(header, type, acpi_id, &phys_id);
259 	else if (header->type == ACPI_MADT_TYPE_GENERIC_INTERRUPT)
260 		map_gicc_mpidr(header, type, acpi_id, &phys_id);
261 	else if (header->type == ACPI_MADT_TYPE_CORE_PIC)
262 		map_core_pic_id(header, type, acpi_id, &phys_id);
263 
264 exit:
265 	kfree(buffer.pointer);
266 	return phys_id;
267 }
268 
269 phys_cpuid_t acpi_get_phys_id(acpi_handle handle, int type, u32 acpi_id)
270 {
271 	phys_cpuid_t phys_id;
272 
273 	phys_id = map_mat_entry(handle, type, acpi_id);
274 	if (invalid_phys_cpuid(phys_id))
275 		phys_id = map_madt_entry(get_madt_table(), type, acpi_id);
276 
277 	return phys_id;
278 }
279 EXPORT_SYMBOL_GPL(acpi_get_phys_id);
280 
281 int acpi_map_cpuid(phys_cpuid_t phys_id, u32 acpi_id)
282 {
283 #ifdef CONFIG_SMP
284 	int i;
285 #endif
286 
287 	if (invalid_phys_cpuid(phys_id)) {
288 		/*
289 		 * On UP processor, there is no _MAT or MADT table.
290 		 * So above phys_id is always set to PHYS_CPUID_INVALID.
291 		 *
292 		 * BIOS may define multiple CPU handles even for UP processor.
293 		 * For example,
294 		 *
295 		 * Scope (_PR)
296 		 * {
297 		 *     Processor (CPU0, 0x00, 0x00000410, 0x06) {}
298 		 *     Processor (CPU1, 0x01, 0x00000410, 0x06) {}
299 		 *     Processor (CPU2, 0x02, 0x00000410, 0x06) {}
300 		 *     Processor (CPU3, 0x03, 0x00000410, 0x06) {}
301 		 * }
302 		 *
303 		 * Ignores phys_id and always returns 0 for the processor
304 		 * handle with acpi id 0 if nr_cpu_ids is 1.
305 		 * This should be the case if SMP tables are not found.
306 		 * Return -EINVAL for other CPU's handle.
307 		 */
308 		if (nr_cpu_ids <= 1 && acpi_id == 0)
309 			return acpi_id;
310 		else
311 			return -EINVAL;
312 	}
313 
314 #ifdef CONFIG_SMP
315 	for_each_possible_cpu(i) {
316 		if (cpu_physical_id(i) == phys_id)
317 			return i;
318 	}
319 #else
320 	/* In UP kernel, only processor 0 is valid */
321 	if (phys_id == 0)
322 		return phys_id;
323 #endif
324 	return -ENODEV;
325 }
326 
327 int acpi_get_cpuid(acpi_handle handle, int type, u32 acpi_id)
328 {
329 	phys_cpuid_t phys_id;
330 
331 	phys_id = acpi_get_phys_id(handle, type, acpi_id);
332 
333 	return acpi_map_cpuid(phys_id, acpi_id);
334 }
335 EXPORT_SYMBOL_GPL(acpi_get_cpuid);
336 
337 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
338 static int get_ioapic_id(struct acpi_subtable_header *entry, u32 gsi_base,
339 			 u64 *phys_addr, int *ioapic_id)
340 {
341 	struct acpi_madt_io_apic *ioapic = (struct acpi_madt_io_apic *)entry;
342 
343 	if (ioapic->global_irq_base != gsi_base)
344 		return 0;
345 
346 	*phys_addr = ioapic->address;
347 	*ioapic_id = ioapic->id;
348 	return 1;
349 }
350 
351 static int parse_madt_ioapic_entry(u32 gsi_base, u64 *phys_addr)
352 {
353 	struct acpi_subtable_header *hdr;
354 	unsigned long madt_end, entry;
355 	struct acpi_table_madt *madt;
356 	int apic_id = -1;
357 
358 	madt = get_madt_table();
359 	if (!madt)
360 		return apic_id;
361 
362 	entry = (unsigned long)madt;
363 	madt_end = entry + madt->header.length;
364 
365 	/* Parse all entries looking for a match. */
366 	entry += sizeof(struct acpi_table_madt);
367 	while (entry + sizeof(struct acpi_subtable_header) < madt_end) {
368 		hdr = (struct acpi_subtable_header *)entry;
369 		if (hdr->type == ACPI_MADT_TYPE_IO_APIC &&
370 		    get_ioapic_id(hdr, gsi_base, phys_addr, &apic_id))
371 			break;
372 		else
373 			entry += hdr->length;
374 	}
375 
376 	return apic_id;
377 }
378 
379 static int parse_mat_ioapic_entry(acpi_handle handle, u32 gsi_base,
380 				  u64 *phys_addr)
381 {
382 	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
383 	struct acpi_subtable_header *header;
384 	union acpi_object *obj;
385 	int apic_id = -1;
386 
387 	if (ACPI_FAILURE(acpi_evaluate_object(handle, "_MAT", NULL, &buffer)))
388 		goto exit;
389 
390 	if (!buffer.length || !buffer.pointer)
391 		goto exit;
392 
393 	obj = buffer.pointer;
394 	if (obj->type != ACPI_TYPE_BUFFER ||
395 	    obj->buffer.length < sizeof(struct acpi_subtable_header))
396 		goto exit;
397 
398 	header = (struct acpi_subtable_header *)obj->buffer.pointer;
399 	if (header->type == ACPI_MADT_TYPE_IO_APIC)
400 		get_ioapic_id(header, gsi_base, phys_addr, &apic_id);
401 
402 exit:
403 	kfree(buffer.pointer);
404 	return apic_id;
405 }
406 
407 /**
408  * acpi_get_ioapic_id - Get IOAPIC ID and physical address matching @gsi_base
409  * @handle:	ACPI object for IOAPIC device
410  * @gsi_base:	GSI base to match with
411  * @phys_addr:	Pointer to store physical address of matching IOAPIC record
412  *
413  * Walk resources returned by ACPI_MAT method, then ACPI MADT table, to search
414  * for an ACPI IOAPIC record matching @gsi_base.
415  * Return IOAPIC id and store physical address in @phys_addr if found a match,
416  * otherwise return <0.
417  */
418 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr)
419 {
420 	int apic_id;
421 
422 	apic_id = parse_mat_ioapic_entry(handle, gsi_base, phys_addr);
423 	if (apic_id == -1)
424 		apic_id = parse_madt_ioapic_entry(gsi_base, phys_addr);
425 
426 	return apic_id;
427 }
428 #endif /* CONFIG_ACPI_HOTPLUG_IOAPIC */
429