xref: /linux/drivers/acpi/processor_core.c (revision 76d9b92e68f2bb55890f935c5143f4fef97a935d)
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 <achiang@hp.com>
7  *	- Unified x86/ia64 implementations
8  *
9  * I/O APIC hotplug support
10  *	Yinghai Lu <yinghai@kernel.org>
11  *	Jiang Liu <jiang.liu@intel.com>
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 (!(gicc->flags &
94 	      (ACPI_MADT_ENABLED | ACPI_MADT_GICC_ONLINE_CAPABLE)))
95 		return -ENODEV;
96 
97 	/* device_declaration means Device object in DSDT, in the
98 	 * GIC interrupt model, logical processors are required to
99 	 * have a Processor Device object in the DSDT, so we should
100 	 * check device_declaration here
101 	 */
102 	if (device_declaration && (gicc->uid == acpi_id)) {
103 		*mpidr = gicc->arm_mpidr;
104 		return 0;
105 	}
106 
107 	return -EINVAL;
108 }
109 
110 /*
111  * Retrieve the RISC-V hartid for the processor
112  */
113 static int map_rintc_hartid(struct acpi_subtable_header *entry,
114 			    int device_declaration, u32 acpi_id,
115 			    phys_cpuid_t *hartid)
116 {
117 	struct acpi_madt_rintc *rintc =
118 	    container_of(entry, struct acpi_madt_rintc, header);
119 
120 	if (!(rintc->flags & ACPI_MADT_ENABLED))
121 		return -ENODEV;
122 
123 	/* device_declaration means Device object in DSDT, in the
124 	 * RISC-V, logical processors are required to
125 	 * have a Processor Device object in the DSDT, so we should
126 	 * check device_declaration here
127 	 */
128 	if (device_declaration && rintc->uid == acpi_id) {
129 		*hartid = rintc->hart_id;
130 		return 0;
131 	}
132 
133 	return -EINVAL;
134 }
135 
136 /*
137  * Retrieve LoongArch CPU physical id
138  */
139 static int map_core_pic_id(struct acpi_subtable_header *entry,
140 		int device_declaration, u32 acpi_id, phys_cpuid_t *phys_id)
141 {
142 	struct acpi_madt_core_pic *core_pic =
143 		container_of(entry, struct acpi_madt_core_pic, header);
144 
145 	if (!(core_pic->flags & ACPI_MADT_ENABLED))
146 		return -ENODEV;
147 
148 	/* device_declaration means Device object in DSDT, in LoongArch
149 	 * system, logical processor acpi_id is required in _UID property
150 	 * of DSDT table, so we should check device_declaration here
151 	 */
152 	if (device_declaration && (core_pic->processor_id == acpi_id)) {
153 		*phys_id = core_pic->core_id;
154 		return 0;
155 	}
156 
157 	return -EINVAL;
158 }
159 
160 static phys_cpuid_t map_madt_entry(struct acpi_table_madt *madt,
161 				   int type, u32 acpi_id)
162 {
163 	unsigned long madt_end, entry;
164 	phys_cpuid_t phys_id = PHYS_CPUID_INVALID;	/* CPU hardware ID */
165 
166 	if (!madt)
167 		return phys_id;
168 
169 	entry = (unsigned long)madt;
170 	madt_end = entry + madt->header.length;
171 
172 	/* Parse all entries looking for a match. */
173 
174 	entry += sizeof(struct acpi_table_madt);
175 	while (entry + sizeof(struct acpi_subtable_header) < madt_end) {
176 		struct acpi_subtable_header *header =
177 			(struct acpi_subtable_header *)entry;
178 		if (header->type == ACPI_MADT_TYPE_LOCAL_APIC) {
179 			if (!map_lapic_id(header, acpi_id, &phys_id))
180 				break;
181 		} else if (header->type == ACPI_MADT_TYPE_LOCAL_X2APIC) {
182 			if (!map_x2apic_id(header, type, acpi_id, &phys_id))
183 				break;
184 		} else if (header->type == ACPI_MADT_TYPE_LOCAL_SAPIC) {
185 			if (!map_lsapic_id(header, type, acpi_id, &phys_id))
186 				break;
187 		} else if (header->type == ACPI_MADT_TYPE_GENERIC_INTERRUPT) {
188 			if (!map_gicc_mpidr(header, type, acpi_id, &phys_id))
189 				break;
190 		} else if (header->type == ACPI_MADT_TYPE_RINTC) {
191 			if (!map_rintc_hartid(header, type, acpi_id, &phys_id))
192 				break;
193 		} else if (header->type == ACPI_MADT_TYPE_CORE_PIC) {
194 			if (!map_core_pic_id(header, type, acpi_id, &phys_id))
195 				break;
196 		}
197 		entry += header->length;
198 	}
199 	return phys_id;
200 }
201 
202 phys_cpuid_t __init acpi_map_madt_entry(u32 acpi_id)
203 {
204 	struct acpi_table_madt *madt = NULL;
205 	phys_cpuid_t rv;
206 
207 	acpi_get_table(ACPI_SIG_MADT, 0,
208 		       (struct acpi_table_header **)&madt);
209 	if (!madt)
210 		return PHYS_CPUID_INVALID;
211 
212 	rv = map_madt_entry(madt, 1, acpi_id);
213 
214 	acpi_put_table((struct acpi_table_header *)madt);
215 
216 	return rv;
217 }
218 
219 static phys_cpuid_t map_mat_entry(acpi_handle handle, int type, u32 acpi_id)
220 {
221 	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
222 	union acpi_object *obj;
223 	struct acpi_subtable_header *header;
224 	phys_cpuid_t phys_id = PHYS_CPUID_INVALID;
225 
226 	if (ACPI_FAILURE(acpi_evaluate_object(handle, "_MAT", NULL, &buffer)))
227 		goto exit;
228 
229 	if (!buffer.length || !buffer.pointer)
230 		goto exit;
231 
232 	obj = buffer.pointer;
233 	if (obj->type != ACPI_TYPE_BUFFER ||
234 	    obj->buffer.length < sizeof(struct acpi_subtable_header)) {
235 		goto exit;
236 	}
237 
238 	header = (struct acpi_subtable_header *)obj->buffer.pointer;
239 	if (header->type == ACPI_MADT_TYPE_LOCAL_APIC)
240 		map_lapic_id(header, acpi_id, &phys_id);
241 	else if (header->type == ACPI_MADT_TYPE_LOCAL_SAPIC)
242 		map_lsapic_id(header, type, acpi_id, &phys_id);
243 	else if (header->type == ACPI_MADT_TYPE_LOCAL_X2APIC)
244 		map_x2apic_id(header, type, acpi_id, &phys_id);
245 	else if (header->type == ACPI_MADT_TYPE_GENERIC_INTERRUPT)
246 		map_gicc_mpidr(header, type, acpi_id, &phys_id);
247 	else if (header->type == ACPI_MADT_TYPE_CORE_PIC)
248 		map_core_pic_id(header, type, acpi_id, &phys_id);
249 
250 exit:
251 	kfree(buffer.pointer);
252 	return phys_id;
253 }
254 
255 phys_cpuid_t acpi_get_phys_id(acpi_handle handle, int type, u32 acpi_id)
256 {
257 	phys_cpuid_t phys_id;
258 
259 	phys_id = map_mat_entry(handle, type, acpi_id);
260 	if (invalid_phys_cpuid(phys_id))
261 		phys_id = map_madt_entry(get_madt_table(), type, acpi_id);
262 
263 	return phys_id;
264 }
265 EXPORT_SYMBOL_GPL(acpi_get_phys_id);
266 
267 int acpi_map_cpuid(phys_cpuid_t phys_id, u32 acpi_id)
268 {
269 #ifdef CONFIG_SMP
270 	int i;
271 #endif
272 
273 	if (invalid_phys_cpuid(phys_id)) {
274 		/*
275 		 * On UP processor, there is no _MAT or MADT table.
276 		 * So above phys_id is always set to PHYS_CPUID_INVALID.
277 		 *
278 		 * BIOS may define multiple CPU handles even for UP processor.
279 		 * For example,
280 		 *
281 		 * Scope (_PR)
282 		 * {
283 		 *     Processor (CPU0, 0x00, 0x00000410, 0x06) {}
284 		 *     Processor (CPU1, 0x01, 0x00000410, 0x06) {}
285 		 *     Processor (CPU2, 0x02, 0x00000410, 0x06) {}
286 		 *     Processor (CPU3, 0x03, 0x00000410, 0x06) {}
287 		 * }
288 		 *
289 		 * Ignores phys_id and always returns 0 for the processor
290 		 * handle with acpi id 0 if nr_cpu_ids is 1.
291 		 * This should be the case if SMP tables are not found.
292 		 * Return -EINVAL for other CPU's handle.
293 		 */
294 		if (nr_cpu_ids <= 1 && acpi_id == 0)
295 			return acpi_id;
296 		else
297 			return -EINVAL;
298 	}
299 
300 #ifdef CONFIG_SMP
301 	for_each_possible_cpu(i) {
302 		if (cpu_physical_id(i) == phys_id)
303 			return i;
304 	}
305 #else
306 	/* In UP kernel, only processor 0 is valid */
307 	if (phys_id == 0)
308 		return phys_id;
309 #endif
310 	return -ENODEV;
311 }
312 
313 int acpi_get_cpuid(acpi_handle handle, int type, u32 acpi_id)
314 {
315 	phys_cpuid_t phys_id;
316 
317 	phys_id = acpi_get_phys_id(handle, type, acpi_id);
318 
319 	return acpi_map_cpuid(phys_id, acpi_id);
320 }
321 EXPORT_SYMBOL_GPL(acpi_get_cpuid);
322 
323 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
324 static int get_ioapic_id(struct acpi_subtable_header *entry, u32 gsi_base,
325 			 u64 *phys_addr, int *ioapic_id)
326 {
327 	struct acpi_madt_io_apic *ioapic = (struct acpi_madt_io_apic *)entry;
328 
329 	if (ioapic->global_irq_base != gsi_base)
330 		return 0;
331 
332 	*phys_addr = ioapic->address;
333 	*ioapic_id = ioapic->id;
334 	return 1;
335 }
336 
337 static int parse_madt_ioapic_entry(u32 gsi_base, u64 *phys_addr)
338 {
339 	struct acpi_subtable_header *hdr;
340 	unsigned long madt_end, entry;
341 	struct acpi_table_madt *madt;
342 	int apic_id = -1;
343 
344 	madt = get_madt_table();
345 	if (!madt)
346 		return apic_id;
347 
348 	entry = (unsigned long)madt;
349 	madt_end = entry + madt->header.length;
350 
351 	/* Parse all entries looking for a match. */
352 	entry += sizeof(struct acpi_table_madt);
353 	while (entry + sizeof(struct acpi_subtable_header) < madt_end) {
354 		hdr = (struct acpi_subtable_header *)entry;
355 		if (hdr->type == ACPI_MADT_TYPE_IO_APIC &&
356 		    get_ioapic_id(hdr, gsi_base, phys_addr, &apic_id))
357 			break;
358 		else
359 			entry += hdr->length;
360 	}
361 
362 	return apic_id;
363 }
364 
365 static int parse_mat_ioapic_entry(acpi_handle handle, u32 gsi_base,
366 				  u64 *phys_addr)
367 {
368 	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
369 	struct acpi_subtable_header *header;
370 	union acpi_object *obj;
371 	int apic_id = -1;
372 
373 	if (ACPI_FAILURE(acpi_evaluate_object(handle, "_MAT", NULL, &buffer)))
374 		goto exit;
375 
376 	if (!buffer.length || !buffer.pointer)
377 		goto exit;
378 
379 	obj = buffer.pointer;
380 	if (obj->type != ACPI_TYPE_BUFFER ||
381 	    obj->buffer.length < sizeof(struct acpi_subtable_header))
382 		goto exit;
383 
384 	header = (struct acpi_subtable_header *)obj->buffer.pointer;
385 	if (header->type == ACPI_MADT_TYPE_IO_APIC)
386 		get_ioapic_id(header, gsi_base, phys_addr, &apic_id);
387 
388 exit:
389 	kfree(buffer.pointer);
390 	return apic_id;
391 }
392 
393 /**
394  * acpi_get_ioapic_id - Get IOAPIC ID and physical address matching @gsi_base
395  * @handle:	ACPI object for IOAPIC device
396  * @gsi_base:	GSI base to match with
397  * @phys_addr:	Pointer to store physical address of matching IOAPIC record
398  *
399  * Walk resources returned by ACPI_MAT method, then ACPI MADT table, to search
400  * for an ACPI IOAPIC record matching @gsi_base.
401  * Return IOAPIC id and store physical address in @phys_addr if found a match,
402  * otherwise return <0.
403  */
404 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr)
405 {
406 	int apic_id;
407 
408 	apic_id = parse_mat_ioapic_entry(handle, gsi_base, phys_addr);
409 	if (apic_id == -1)
410 		apic_id = parse_madt_ioapic_entry(gsi_base, phys_addr);
411 
412 	return apic_id;
413 }
414 #endif /* CONFIG_ACPI_HOTPLUG_IOAPIC */
415