Merge tag 'efi-2020-07-rc6' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi
[oweals/u-boot.git] / arch / x86 / lib / mpspec.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (C) 2015, Bin Meng <bmeng.cn@gmail.com>
4  *
5  * Adapted from coreboot src/arch/x86/boot/mpspec.c
6  */
7
8 #include <common.h>
9 #include <cpu.h>
10 #include <dm.h>
11 #include <errno.h>
12 #include <fdtdec.h>
13 #include <log.h>
14 #include <asm/cpu.h>
15 #include <asm/irq.h>
16 #include <asm/ioapic.h>
17 #include <asm/lapic.h>
18 #include <asm/mpspec.h>
19 #include <asm/tables.h>
20 #include <dm/uclass-internal.h>
21
22 DECLARE_GLOBAL_DATA_PTR;
23
24 static bool isa_irq_occupied[16];
25
26 struct mp_config_table *mp_write_floating_table(struct mp_floating_table *mf)
27 {
28         ulong mc;
29
30         memcpy(mf->mpf_signature, MPF_SIGNATURE, 4);
31         mf->mpf_physptr = (ulong)mf + sizeof(struct mp_floating_table);
32         mf->mpf_length = 1;
33         mf->mpf_spec = MPSPEC_V14;
34         mf->mpf_checksum = 0;
35         /* We don't use the default configuration table */
36         mf->mpf_feature1 = 0;
37         /* Indicate that virtual wire mode is always implemented */
38         mf->mpf_feature2 = 0;
39         mf->mpf_feature3 = 0;
40         mf->mpf_feature4 = 0;
41         mf->mpf_feature5 = 0;
42         mf->mpf_checksum = table_compute_checksum(mf, mf->mpf_length * 16);
43
44         mc = (ulong)mf + sizeof(struct mp_floating_table);
45         return (struct mp_config_table *)mc;
46 }
47
48 void mp_config_table_init(struct mp_config_table *mc)
49 {
50         memcpy(mc->mpc_signature, MPC_SIGNATURE, 4);
51         mc->mpc_length = sizeof(struct mp_config_table);
52         mc->mpc_spec = MPSPEC_V14;
53         mc->mpc_checksum = 0;
54         mc->mpc_oemptr = 0;
55         mc->mpc_oemsize = 0;
56         mc->mpc_entry_count = 0;
57         mc->mpc_lapic = LAPIC_DEFAULT_BASE;
58         mc->mpe_length = 0;
59         mc->mpe_checksum = 0;
60         mc->reserved = 0;
61
62         /* The oem/product id fields are exactly 8/12 bytes long */
63         table_fill_string(mc->mpc_oem, CONFIG_SYS_VENDOR, 8, ' ');
64         table_fill_string(mc->mpc_product, CONFIG_SYS_BOARD, 12, ' ');
65 }
66
67 void mp_write_processor(struct mp_config_table *mc)
68 {
69         struct mpc_config_processor *mpc;
70         struct udevice *dev;
71         u8 boot_apicid, apicver;
72         u32 cpusignature, cpufeature;
73         struct cpuid_result result;
74
75         boot_apicid = lapicid();
76         apicver = lapic_read(LAPIC_LVR) & 0xff;
77         result = cpuid(1);
78         cpusignature = result.eax;
79         cpufeature = result.edx;
80
81         for (uclass_find_first_device(UCLASS_CPU, &dev);
82              dev;
83              uclass_find_next_device(&dev)) {
84                 struct cpu_platdata *plat = dev_get_parent_platdata(dev);
85                 u8 cpuflag = MPC_CPU_EN;
86
87                 if (!device_active(dev))
88                         continue;
89
90                 mpc = (struct mpc_config_processor *)mp_next_mpc_entry(mc);
91                 mpc->mpc_type = MP_PROCESSOR;
92                 mpc->mpc_apicid = plat->cpu_id;
93                 mpc->mpc_apicver = apicver;
94                 if (boot_apicid == plat->cpu_id)
95                         cpuflag |= MPC_CPU_BP;
96                 mpc->mpc_cpuflag = cpuflag;
97                 mpc->mpc_cpusignature = cpusignature;
98                 mpc->mpc_cpufeature = cpufeature;
99                 mpc->mpc_reserved[0] = 0;
100                 mpc->mpc_reserved[1] = 0;
101                 mp_add_mpc_entry(mc, sizeof(*mpc));
102         }
103 }
104
105 void mp_write_bus(struct mp_config_table *mc, int id, const char *bustype)
106 {
107         struct mpc_config_bus *mpc;
108
109         mpc = (struct mpc_config_bus *)mp_next_mpc_entry(mc);
110         mpc->mpc_type = MP_BUS;
111         mpc->mpc_busid = id;
112         memcpy(mpc->mpc_bustype, bustype, 6);
113         mp_add_mpc_entry(mc, sizeof(*mpc));
114 }
115
116 void mp_write_ioapic(struct mp_config_table *mc, int id, int ver, u32 apicaddr)
117 {
118         struct mpc_config_ioapic *mpc;
119
120         mpc = (struct mpc_config_ioapic *)mp_next_mpc_entry(mc);
121         mpc->mpc_type = MP_IOAPIC;
122         mpc->mpc_apicid = id;
123         mpc->mpc_apicver = ver;
124         mpc->mpc_flags = MPC_APIC_USABLE;
125         mpc->mpc_apicaddr = apicaddr;
126         mp_add_mpc_entry(mc, sizeof(*mpc));
127 }
128
129 void mp_write_intsrc(struct mp_config_table *mc, int irqtype, int irqflag,
130                      int srcbus, int srcbusirq, int dstapic, int dstirq)
131 {
132         struct mpc_config_intsrc *mpc;
133
134         mpc = (struct mpc_config_intsrc *)mp_next_mpc_entry(mc);
135         mpc->mpc_type = MP_INTSRC;
136         mpc->mpc_irqtype = irqtype;
137         mpc->mpc_irqflag = irqflag;
138         mpc->mpc_srcbus = srcbus;
139         mpc->mpc_srcbusirq = srcbusirq;
140         mpc->mpc_dstapic = dstapic;
141         mpc->mpc_dstirq = dstirq;
142         mp_add_mpc_entry(mc, sizeof(*mpc));
143 }
144
145 void mp_write_pci_intsrc(struct mp_config_table *mc, int irqtype,
146                          int srcbus, int dev, int pin, int dstapic, int dstirq)
147 {
148         u8 srcbusirq = (dev << 2) | (pin - 1);
149
150         mp_write_intsrc(mc, irqtype, MP_IRQ_TRIGGER_LEVEL | MP_IRQ_POLARITY_LOW,
151                         srcbus, srcbusirq, dstapic, dstirq);
152 }
153
154 void mp_write_lintsrc(struct mp_config_table *mc, int irqtype, int irqflag,
155                       int srcbus, int srcbusirq, int destapic, int destlint)
156 {
157         struct mpc_config_lintsrc *mpc;
158
159         mpc = (struct mpc_config_lintsrc *)mp_next_mpc_entry(mc);
160         mpc->mpc_type = MP_LINTSRC;
161         mpc->mpc_irqtype = irqtype;
162         mpc->mpc_irqflag = irqflag;
163         mpc->mpc_srcbusid = srcbus;
164         mpc->mpc_srcbusirq = srcbusirq;
165         mpc->mpc_destapic = destapic;
166         mpc->mpc_destlint = destlint;
167         mp_add_mpc_entry(mc, sizeof(*mpc));
168 }
169
170 void mp_write_address_space(struct mp_config_table *mc,
171                             int busid, int addr_type,
172                             u32 addr_base_low, u32 addr_base_high,
173                             u32 addr_length_low, u32 addr_length_high)
174 {
175         struct mp_ext_system_address_space *mpe;
176
177         mpe = (struct mp_ext_system_address_space *)mp_next_mpe_entry(mc);
178         mpe->mpe_type = MPE_SYSTEM_ADDRESS_SPACE;
179         mpe->mpe_length = sizeof(*mpe);
180         mpe->mpe_busid = busid;
181         mpe->mpe_addr_type = addr_type;
182         mpe->mpe_addr_base_low = addr_base_low;
183         mpe->mpe_addr_base_high = addr_base_high;
184         mpe->mpe_addr_length_low = addr_length_low;
185         mpe->mpe_addr_length_high = addr_length_high;
186         mp_add_mpe_entry(mc, (struct mp_ext_config *)mpe);
187 }
188
189 void mp_write_bus_hierarchy(struct mp_config_table *mc,
190                             int busid, int bus_info, int parent_busid)
191 {
192         struct mp_ext_bus_hierarchy *mpe;
193
194         mpe = (struct mp_ext_bus_hierarchy *)mp_next_mpe_entry(mc);
195         mpe->mpe_type = MPE_BUS_HIERARCHY;
196         mpe->mpe_length = sizeof(*mpe);
197         mpe->mpe_busid = busid;
198         mpe->mpe_bus_info = bus_info;
199         mpe->mpe_parent_busid = parent_busid;
200         mpe->reserved[0] = 0;
201         mpe->reserved[1] = 0;
202         mpe->reserved[2] = 0;
203         mp_add_mpe_entry(mc, (struct mp_ext_config *)mpe);
204 }
205
206 void mp_write_compat_address_space(struct mp_config_table *mc, int busid,
207                                    int addr_modifier, u32 range_list)
208 {
209         struct mp_ext_compat_address_space *mpe;
210
211         mpe = (struct mp_ext_compat_address_space *)mp_next_mpe_entry(mc);
212         mpe->mpe_type = MPE_COMPAT_ADDRESS_SPACE;
213         mpe->mpe_length = sizeof(*mpe);
214         mpe->mpe_busid = busid;
215         mpe->mpe_addr_modifier = addr_modifier;
216         mpe->mpe_range_list = range_list;
217         mp_add_mpe_entry(mc, (struct mp_ext_config *)mpe);
218 }
219
220 u32 mptable_finalize(struct mp_config_table *mc)
221 {
222         ulong end;
223
224         mc->mpe_checksum = table_compute_checksum((void *)mp_next_mpc_entry(mc),
225                                                   mc->mpe_length);
226         mc->mpc_checksum = table_compute_checksum(mc, mc->mpc_length);
227         end = mp_next_mpe_entry(mc);
228
229         debug("Write the MP table at: %lx - %lx\n", (ulong)mc, end);
230
231         return end;
232 }
233
234 static void mptable_add_isa_interrupts(struct mp_config_table *mc, int bus_isa,
235                                        int apicid, int external_int2)
236 {
237         int i;
238
239         mp_write_intsrc(mc, external_int2 ? MP_INT : MP_EXTINT,
240                         MP_IRQ_TRIGGER_EDGE | MP_IRQ_POLARITY_HIGH,
241                         bus_isa, 0, apicid, 0);
242         mp_write_intsrc(mc, MP_INT, MP_IRQ_TRIGGER_EDGE | MP_IRQ_POLARITY_HIGH,
243                         bus_isa, 1, apicid, 1);
244         mp_write_intsrc(mc, external_int2 ? MP_EXTINT : MP_INT,
245                         MP_IRQ_TRIGGER_EDGE | MP_IRQ_POLARITY_HIGH,
246                         bus_isa, 0, apicid, 2);
247
248         for (i = 3; i < 16; i++) {
249                 /*
250                  * Do not write ISA interrupt entry if it is already occupied
251                  * by the platform devices.
252                  */
253                 if (isa_irq_occupied[i])
254                         continue;
255
256                 mp_write_intsrc(mc, MP_INT,
257                                 MP_IRQ_TRIGGER_EDGE | MP_IRQ_POLARITY_HIGH,
258                                 bus_isa, i, apicid, i);
259         }
260 }
261
262 /*
263  * Check duplicated I/O interrupt assignment table entry, to make sure
264  * there is only one entry with the given bus, device and interrupt pin.
265  */
266 static bool check_dup_entry(struct mpc_config_intsrc *intsrc_base,
267                             int entry_num, int bus, int device, int pin)
268 {
269         struct mpc_config_intsrc *intsrc = intsrc_base;
270         int i;
271
272         for (i = 0; i < entry_num; i++) {
273                 if (intsrc->mpc_srcbus == bus &&
274                     intsrc->mpc_srcbusirq == ((device << 2) | (pin - 1)))
275                         break;
276                 intsrc++;
277         }
278
279         return (i == entry_num) ? false : true;
280 }
281
282 /* TODO: move this to driver model */
283 __weak int mp_determine_pci_dstirq(int bus, int dev, int func, int pirq)
284 {
285         /* PIRQ[A-H] are connected to I/O APIC INTPIN#16-23 */
286         return pirq + 16;
287 }
288
289 static int mptable_add_intsrc(struct mp_config_table *mc,
290                               int bus_isa, int apicid)
291 {
292         struct mpc_config_intsrc *intsrc_base;
293         int intsrc_entries = 0;
294         const void *blob = gd->fdt_blob;
295         struct udevice *dev;
296         int len, count;
297         const u32 *cell;
298         int i, ret;
299
300         ret = uclass_first_device_err(UCLASS_IRQ, &dev);
301         if (ret && ret != -ENODEV) {
302                 debug("%s: Cannot find irq router node\n", __func__);
303                 return ret;
304         }
305
306         /* Get I/O interrupt information from device tree */
307         cell = fdt_getprop(blob, dev_of_offset(dev), "intel,pirq-routing",
308                            &len);
309         if (!cell)
310                 return -ENOENT;
311
312         if ((len % sizeof(struct pirq_routing)) == 0)
313                 count = len / sizeof(struct pirq_routing);
314         else
315                 return -EINVAL;
316
317         intsrc_base = (struct mpc_config_intsrc *)mp_next_mpc_entry(mc);
318
319         for (i = 0; i < count; i++) {
320                 struct pirq_routing pr;
321                 int bus, dev, func;
322                 int dstirq;
323
324                 pr.bdf = fdt_addr_to_cpu(cell[0]);
325                 pr.pin = fdt_addr_to_cpu(cell[1]);
326                 pr.pirq = fdt_addr_to_cpu(cell[2]);
327                 bus = PCI_BUS(pr.bdf);
328                 dev = PCI_DEV(pr.bdf);
329                 func = PCI_FUNC(pr.bdf);
330
331                 if (check_dup_entry(intsrc_base, intsrc_entries,
332                                     bus, dev, pr.pin)) {
333                         debug("found entry for bus %d device %d INT%c, skipping\n",
334                               bus, dev, 'A' + pr.pin - 1);
335                         cell += sizeof(struct pirq_routing) / sizeof(u32);
336                         continue;
337                 }
338
339                 dstirq = mp_determine_pci_dstirq(bus, dev, func, pr.pirq);
340                 /*
341                  * For PIRQ which is connected to I/O APIC interrupt pin#0-15,
342                  * mark it as occupied so that we can skip it later.
343                  */
344                 if (dstirq < 16)
345                         isa_irq_occupied[dstirq] = true;
346                 mp_write_pci_intsrc(mc, MP_INT, bus, dev, pr.pin,
347                                     apicid, dstirq);
348                 intsrc_entries++;
349                 cell += sizeof(struct pirq_routing) / sizeof(u32);
350         }
351
352         /* Legacy Interrupts */
353         debug("Writing ISA IRQs\n");
354         mptable_add_isa_interrupts(mc, bus_isa, apicid, 0);
355
356         return 0;
357 }
358
359 static void mptable_add_lintsrc(struct mp_config_table *mc, int bus_isa)
360 {
361         mp_write_lintsrc(mc, MP_EXTINT,
362                          MP_IRQ_TRIGGER_EDGE | MP_IRQ_POLARITY_HIGH,
363                          bus_isa, 0, MP_APIC_ALL, 0);
364         mp_write_lintsrc(mc, MP_NMI,
365                          MP_IRQ_TRIGGER_EDGE | MP_IRQ_POLARITY_HIGH,
366                          bus_isa, 0, MP_APIC_ALL, 1);
367 }
368
369 ulong write_mp_table(ulong addr)
370 {
371         struct mp_config_table *mc;
372         int ioapic_id, ioapic_ver;
373         int bus_isa = 0xff;
374         int ret;
375         ulong end;
376
377         /* 16 byte align the table address */
378         addr = ALIGN(addr, 16);
379
380         /* Write floating table */
381         mc = mp_write_floating_table((struct mp_floating_table *)addr);
382
383         /* Write configuration table header */
384         mp_config_table_init(mc);
385
386         /* Write processor entry */
387         mp_write_processor(mc);
388
389         /* Write bus entry */
390         mp_write_bus(mc, bus_isa, BUSTYPE_ISA);
391
392         /* Write I/O APIC entry */
393         ioapic_id = io_apic_read(IO_APIC_ID) >> 24;
394         ioapic_ver = io_apic_read(IO_APIC_VER) & 0xff;
395         mp_write_ioapic(mc, ioapic_id, ioapic_ver, IO_APIC_ADDR);
396
397         /* Write I/O interrupt assignment entry */
398         ret = mptable_add_intsrc(mc, bus_isa, ioapic_id);
399         if (ret)
400                 debug("Failed to write I/O interrupt assignment table\n");
401
402         /* Write local interrupt assignment entry */
403         mptable_add_lintsrc(mc, bus_isa);
404
405         /* Finalize the MP table */
406         end = mptable_finalize(mc);
407
408         return end;
409 }