x86: bus_irq_enable()
[akaros.git] / kern / arch / x86 / ioapic.c
1 /* 
2  * This file is part of the UCB release of Plan 9. It is subject to the license
3  * terms in the LICENSE file found in the top-level directory of this
4  * distribution and at http://akaros.cs.berkeley.edu/files/Plan9License. No
5  * part of the UCB release of Plan 9, including this file, may be copied,
6  * modified, propagated, or distributed except according to the terms contained
7  * in the LICENSE file.
8  */
9
10 #include <vfs.h>
11 #include <kfs.h>
12 #include <slab.h>
13 #include <kmalloc.h>
14 #include <kref.h>
15 #include <string.h>
16 #include <stdio.h>
17 #include <assert.h>
18 #include <error.h>
19 #include <cpio.h>
20 #include <pmap.h>
21 #include <smp.h>
22 #include <ip.h>
23 #include <arch/io.h>
24 #include <acpi.h>
25 #include <trap.h>
26
27 struct Rbus {
28         struct Rbus *next;
29         int devno;
30         struct Rdt *rdt;
31 };
32
33 struct Rdt {
34         struct apic *apic;
35         int intin;
36         uint32_t lo;
37
38         int ref;                                        /* could map to multiple busses */
39         int enabled;                            /* times enabled */
40 };
41
42 enum {                                                  /* IOAPIC registers */
43         Ioregsel = 0x00,                        /* indirect register address */
44         Iowin = 0x10,   /* indirect register data */
45         Ioipa = 0x08,   /* IRQ Pin Assertion */
46         Ioeoi = 0x10,   /* EOI */
47
48         Ioapicid = 0x00,        /* Identification */
49         Ioapicver = 0x01,       /* Version */
50         Ioapicarb = 0x02,       /* Arbitration */
51         Ioabcfg = 0x03, /* Boot Coniguration */
52         Ioredtbl = 0x10,        /* Redirection Table */
53 };
54
55 static struct Rdt rdtarray[Nrdt];
56 static int nrdtarray;
57 static struct Rbus *rdtbus[Nbus];
58 static struct Rdt *rdtvecno[IdtMAX + 1];
59
60 static spinlock_t idtnolock;
61 static int idtno = IdtIOAPIC;
62
63 struct apic xioapic[Napic];
64
65 static bool ioapic_exists(void)
66 {
67         /* not foolproof, if we called this before parsing */
68         return xioapic[0].useable ? TRUE : FALSE;
69 }
70
71 /* TODO: put these in a header */
72 int apiceoi(int);
73 int apicisr(int);
74
75 static void rtblget(struct apic *apic, int sel, uint32_t * hi, uint32_t * lo)
76 {
77         sel = Ioredtbl + 2 * sel;
78
79         write_mmreg32(apic->addr + Ioregsel, sel + 1);
80         *hi = read_mmreg32(apic->addr + Iowin);
81         write_mmreg32(apic->addr + Ioregsel, sel);
82         *lo = read_mmreg32(apic->addr + Iowin);
83 }
84
85 static void rtblput(struct apic *apic, int sel, uint32_t hi, uint32_t lo)
86 {
87         sel = Ioredtbl + 2 * sel;
88
89         write_mmreg32(apic->addr + Ioregsel, sel + 1);
90         write_mmreg32(apic->addr + Iowin, hi);
91         write_mmreg32(apic->addr + Ioregsel, sel);
92         write_mmreg32(apic->addr + Iowin, lo);
93 }
94
95 struct Rdt *rdtlookup(struct apic *apic, int intin)
96 {
97         int i;
98         struct Rdt *r;
99
100         for (i = 0; i < nrdtarray; i++) {
101                 r = rdtarray + i;
102                 if (apic == r->apic && intin == r->intin)
103                         return r;
104         }
105         return NULL;
106 }
107
108 /* busno is the source bus
109  * apic is the destination apic
110  * intin is the INTIN pin on the destination apic
111  * devno is the device number in the style of a PCI Interrupt
112  * Assignment Entry. Which is devno << 2? 
113  * lo is the vector table entry. We need to figure out how
114  * to compute this from acpi. We used to get it from the
115  * mptable but we would like to avoid that.
116  */
117 void ioapicintrinit(int busno, int apicno, int intin, int devno, int lo)
118 {
119         struct Rbus *rbus;
120         struct Rdt *rdt;
121         struct apic *apic;
122         printk("%s: busno %d apicno %d intin %d devno %p lo %p\n", __func__,
123                    busno, apicno, intin, devno, lo);
124
125         if (busno >= Nbus || apicno >= Napic || nrdtarray >= Nrdt) {
126                 printk("FAIL 1\n");
127                 return;
128         }
129         apic = &xioapic[apicno];
130         if (!apic->useable || intin >= apic->nrdt) {
131                 printk("apic->usable %d intin %d apic->nrdt %d OOR\n", apic->useable,
132                            intin, apic->nrdt);
133                 printk("apicno %d, apic %p\n", apicno, apic);
134                 return;
135         }
136
137         rdt = rdtlookup(apic, intin);
138         if (rdt == NULL) {
139                 printk("NO RDT, install it for apic %d intin %d lo %p\n", apicno, intin,
140                            lo);
141                 rdt = &rdtarray[nrdtarray++];
142                 rdt->apic = apic;
143                 rdt->intin = intin;
144                 rdt->lo = lo;
145         } else {
146                 if (lo != rdt->lo) {
147                         printd("mutiple irq botch bus %d %d/%d/%d lo %d vs %d\n",
148                                    busno, apicno, intin, devno, lo, rdt->lo);
149                         return;
150                 }
151                 printk("dup rdt %d %d %d %d %.8p\n", busno, apicno, intin, devno, lo);
152         }
153         rdt->ref++;
154         rbus = kzmalloc(sizeof *rbus, 0);
155         rbus->rdt = rdt;
156         rbus->devno = devno;
157         rbus->next = rdtbus[busno];
158         rdtbus[busno] = rbus;
159 }
160
161 static int map_polarity[4] = {
162         -1, IPhigh, -1, IPlow
163 };
164
165 static int map_edge_level[4] = {
166         -1, TMedge, -1, TMlevel
167 };
168
169 int ioapic_route_irq(int irq, int apicno, int devno)
170 {
171         extern struct Madt *apics;
172         struct Madt *a = apics;
173         struct Apicst *st;
174         uint32_t lo;
175         int pol, edge_level;
176         printk("%s(%d,%d);\n", __func__, irq, apicno);
177         /* find it. */
178         for (st = apics->st; st != NULL; st = st->next) {
179                 printk("Check %d, ", st->type);
180                 if (st->type == ASintovr) {
181                         printk("irq of st is %d\n", st->intovr.irq);
182                         if (st->intovr.irq == irq)
183                                 break;
184                 }
185         }
186         if (!st) {
187                 printk("IRQ %d not found in MADT\n", irq);
188                 return -1;
189         }
190
191         pol = map_polarity[st->intovr.flags & AFpmask];
192         if (pol < 0) {
193                 printk("BAD POLARITY\n");
194                 return -1;
195         }
196
197         edge_level = map_edge_level[(st->intovr.flags & AFlevel) >> 2];
198         if (edge_level < 0) {
199                 printk("BAD edge/level\n");
200                 return -1;
201         }
202         lo = pol | edge_level;
203         ioapicintrinit(0, 8, 0 /*st->intovr.intr */ , devno, lo);
204         printk("FOUND the MADT for %d\n", irq);
205         return 0;
206 }
207
208 void ioapicinit(int id, int ibase, uintptr_t pa)
209 {
210         struct apic *apic;
211         static int base;
212
213         assert(pa == IOAPIC_PBASE);
214         /*
215          * Mark the IOAPIC useable if it has a good ID
216          * and the registers can be mapped.
217          */
218         if (id >= Napic)
219                 return;
220
221         apic = &xioapic[id];
222         apic->addr = IOAPIC_BASE;
223         if (apic->useable)
224                 return;
225         apic->useable = 1;
226         printk("\t\tioapicinit %d: it's useable, apic %p\n", id, apic);
227         apic->paddr = pa;
228
229         /*
230          * Initialise the I/O APIC.
231          * The MultiProcessor Specification says it is the
232          * responsibility of the O/S to set the APIC ID.
233          */
234         spin_lock(&apic->lock);
235         write_mmreg32(apic->addr + Ioregsel, Ioapicver);
236         apic->nrdt = ((read_mmreg32(apic->addr + Iowin) >> 16) & 0xff) + 1;
237         if (ibase != -1)
238                 apic->ibase = ibase;
239         else {
240                 apic->ibase = base;
241                 base += apic->nrdt;
242         }
243         write_mmreg32(apic->addr + Ioregsel, Ioapicid);
244         write_mmreg32(apic->addr + Iowin, id << 24);
245         spin_unlock(&apic->lock);
246 }
247
248 char *ioapicdump(char *start, char *end)
249 {
250         int i, n;
251         struct Rbus *rbus;
252         struct Rdt *rdt;
253         struct apic *apic;
254         uint32_t hi, lo;
255
256         if (!2)
257                 return start;
258         for (i = 0; i < Napic; i++) {
259                 apic = &xioapic[i];
260                 if (!apic->useable || apic->addr == 0)
261                         continue;
262                 start = seprintf(start, end, "ioapic %d addr %#p nrdt %d ibase %d\n",
263                                                  i, apic->addr, apic->nrdt, apic->ibase);
264                 for (n = 0; n < apic->nrdt; n++) {
265                         spin_lock(&apic->lock);
266                         rtblget(apic, n, &hi, &lo);
267                         spin_unlock(&apic->lock);
268                         start = seprintf(start, end, " rdt %2.2d %p %p\n", n, hi, lo);
269                 }
270         }
271         for (i = 0; i < Nbus; i++) {
272                 if ((rbus = rdtbus[i]) == NULL)
273                         continue;
274                 start = seprintf(start, end, "iointr bus %d:\n", i);
275                 for (; rbus != NULL; rbus = rbus->next) {
276                         rdt = rbus->rdt;
277                         start = seprintf(start, end,
278                                                          " apic %ld devno %#p (%d %d) intin %d lo %#p ref %d\n",
279                                                          rdt->apic - xioapic, rbus->devno, rbus->devno >> 2,
280                                                          rbus->devno & 0x03, rdt->intin, rdt->lo, rdt->ref);
281                 }
282         }
283         return start;
284 }
285
286 /* Zeros and masks every redirect entry in every IOAPIC */
287 void ioapiconline(void)
288 {
289         int i;
290         struct apic *apic;
291
292         for (apic = xioapic; apic < &xioapic[Napic]; apic++) {
293                 if (!apic->useable || !apic->addr)
294                         continue;
295                 for (i = 0; i < apic->nrdt; i++) {
296                         spin_lock(&apic->lock);
297                         rtblput(apic, i, 0, Im);
298                         spin_unlock(&apic->lock);
299                 }
300         }
301 }
302
303 static int dfpolicy = 0;
304
305 static void ioapicintrdd(uint32_t * hi, uint32_t * lo)
306 {
307         int i;
308         static int df;
309         static spinlock_t dflock;
310
311         /*
312          * Set delivery mode (lo) and destination field (hi),
313          * according to interrupt routing policy.
314          */
315         /*
316          * The bulk of this code was written ~1995, when there was
317          * one architecture and one generation of hardware, the number
318          * of CPUs was up to 4(8) and the choices for interrupt routing
319          * were physical, or flat logical (optionally with lowest
320          * priority interrupt). Logical mode hasn't scaled well with
321          * the increasing number of packages/cores/threads, so the
322          * fall-back is to physical mode, which works across all processor
323          * generations, both AMD and Intel, using the APIC and xAPIC.
324          *
325          * Interrupt routing policy can be set here.
326          */
327         switch (dfpolicy) {
328                 default:        /* noise core 0 */
329 #warning "sys->machptr[0]->apicno --- what is this in Akaros?"
330                         *hi = 0;        //sys->machptr[0]->apicno<<24;
331                         break;
332                 case 1: /* round-robin */
333                         /*
334                          * Assign each interrupt to a different CPU on a round-robin
335                          * Some idea of the packages/cores/thread topology would be
336                          * useful here, e.g. to not assign interrupts to more than one
337                          * thread in a core. But, as usual, Intel make that an onerous
338                          * task.
339                          */
340                         spin_lock(&dflock);
341                         for (;;) {
342 #if 0
343                                 i = df++;
344                                 if (df >= sys->nmach + 1)
345                                         df = 0;
346                                 if (sys->machptr[i] == NULL || !sys->machptr[i]->online)
347                                         continue;
348                                 i = sys->machptr[i]->apicno;
349 #endif
350 #warning "always picking acpino 0"
351                                 i = 0;
352                                 if (xlapic[i].useable && xlapic[i].addr == 0)
353                                         break;
354                         }
355                         spin_unlock(&dflock);
356
357                         *hi = i << 24;
358                         break;
359         }
360         *lo |= Pm | MTf;
361 }
362
363 int nextvec(void)
364 {
365         unsigned int vecno;
366
367         /* TODO: half-way decent integer service (vmem) */
368         spin_lock(&idtnolock);
369         vecno = idtno;
370         idtno = (idtno + 1) % IdtMAX;
371         if (idtno < IdtIOAPIC)
372                 idtno += IdtIOAPIC;
373         spin_unlock(&idtnolock);
374
375         return vecno;
376 }
377
378 #warning "no msi mask yet"
379 #if 0
380 static int msimask(struct Vkey *v, int mask)
381 {
382         Pcidev *p;
383
384         p = pcimatchtbdf(v->tbdf);
385         if (p == NULL)
386                 return -1;
387         return pcimsimask(p, mask);
388 }
389 #endif
390
391 #warning "No msi yet"
392 #if 0
393 static int intrenablemsi(struct vctl *v, Pcidev * p)
394 {
395         unsigned int vno, lo, hi;
396         uint64_t msivec;
397
398         vno = nextvec();
399
400         lo = IPlow | TMedge | vno;
401         ioapicintrdd(&hi, &lo);
402
403         if (lo & Lm)
404                 lo |= MTlp;
405
406         msivec = (uint64_t) hi << 32 | lo;
407         if (pcimsienable(p, msivec) == -1)
408                 return -1;
409         v->isr = apicisr;
410         v->eoi = apiceoi;
411         v->vno = vno;
412         v->type = "msi";
413         v->mask = msimask;
414
415         printk("msiirq: %T: enabling %.16llp %s irq %d vno %d\n", p->tbdf, msivec,
416                    v->name, v->irq, vno);
417         return vno;
418 }
419 #endif
420 #warning "no disable msi yet"
421 #if 0
422 int disablemsi(Vctl *, Pcidev * p)
423 {
424         if (p == NULL)
425                 return -1;
426         return pcimsimask(p, 1);
427 }
428 #endif
429
430
431 /* Attempts to enable a bus interrupt, initializes irq_h, and returns the IDT
432  * vector to use (-1 on error).
433  *
434  * This will determine the type of bus the device is on (LAPIC, IOAPIC, PIC,
435  * etc), and set the appropriate fields in isr_h.  If applicable, it'll also
436  * allocate an IDT vector, such as for an IOAPIC, and route the IOAPIC entries
437  * appropriately.
438  *
439  * Callers init irq_h->dev_irq and ->tbdf.  tbdf encodes the bus type and the
440  * classic PCI bus:dev:func.
441  *
442  * In plan9, this was ioapicintrenable(). */
443 int bus_irq_enable(struct irq_handler *irq_h)
444 {
445         struct Rbus *rbus;
446         struct Rdt *rdt;
447         uint32_t hi, lo;
448         int busno = 0, devno, vecno;
449         extern int mpisabusno;  // XXX
450         struct pci_device pcidev;
451
452         if (!ioapic_exists() && (BUSTYPE(irq_h->tbdf) != BusLAPIC)) {
453                 irq_h->check_spurious = pic_check_spurious;
454                 irq_h->eoi = pic_send_eoi;
455                 irq_h->mask = pic_mask_irq;
456                 irq_h->unmask = pic_unmask_irq;
457                 irq_h->type = "pic";
458                 /* PIC devices have vector = irq + 32 */
459                 return irq_h->dev_irq + IdtPIC;
460         }
461         switch (BUSTYPE(irq_h->tbdf)) {
462                 case BusLAPIC:
463                         /* nxm used to set the initial 'isr' method (i think equiv to our
464                          * check_spurious) to apiceoi for non-spurious lapic vectors.  in
465                          * effect, i think they were sending the EOI early, and their eoi
466                          * method was 0.  we're not doing that (unless we have to). */
467                         irq_h->check_spurious = lapic_check_spurious;
468                         irq_h->eoi = lapic_send_eoi;
469                         irq_h->mask = 0;
470                         irq_h->unmask = 0;
471                         irq_h->type = "lapic";
472                         /* For the LAPIC, irq == vector */
473                         return irq_h->dev_irq;
474                 case BusISA:
475                         /* TODO: handle when we have ACPI, but no MP tables */
476                         if (mpisabusno == -1)
477                                 panic("no ISA bus allocated");
478                         busno = mpisabusno;
479                         /* need to track the irq in devno in PCI interrupt assignment entry
480                          * format (see mp.c or MP spec D.3). */
481                         devno = irq_h->dev_irq << 2;
482                         break;
483                 case BusPCI:
484                         /* we'll assume it's there. */
485 #if 0
486                         Pcidev *pcidev;
487
488                         busno = BUSBNO(irq_h->tbdf);
489                         if ((pcidev = pcimatchtbdf(irq_h->tbdf)) == NULL)
490                                 panic("no PCI dev for tbdf %p", irq_h->tbdf);
491                         if ((vecno = intrenablemsi(irq_h, pcidev)) != -1)
492                                 return vecno;
493                         disablemsi(irq_h, pcidev);
494 #endif
495                         explode_tbdf(irq_h->tbdf);
496                         devno = pcidev_read8(&pcidev, PciINTP);
497                         printk("INTP is %d\n", devno);
498
499                         if (devno == 0)
500                                 panic("no INTP for tbdf %p", irq_h->tbdf);
501                         /* remember, devno is the device shifted with irq pin in bits 0-1 */
502                         devno = BUSDNO(irq_h->tbdf) << 2 | (devno - 1);
503                         printk("devno is %08lx\n", devno);
504                         printk("bus_irq_enable: tbdf %p busno %d devno %d\n",
505                                    irq_h->tbdf, busno, devno);
506                         break;
507                 default:
508                         panic("Unknown bus type, TBDF %p", irq_h->tbdf);
509         }
510
511         rdt = NULL;
512         for (rbus = rdtbus[busno]; rbus != NULL; rbus = rbus->next) {
513                 printk("Check rbus->devno %p devno %p\n", rbus->devno, devno);
514                 if (rbus->devno == devno) {
515                         rdt = rbus->rdt;
516                         break;
517                 }
518         }
519         if (rdt == NULL) {
520                 // install it? Who knows?
521                 int ioapic_route_irq(int irq, int apicno, int devno);
522                 ioapic_route_irq(irq_h->dev_irq, 0, devno);
523                 printk("rdt is NULLLLLLLLLLLLLLLLLLLLLL\n");
524
525                 /*
526                  * First crack in the smooth exterior of the new code:
527                  * some BIOS make an MPS table where the PCI devices
528                  * are just defaulted to ISA.  Rewrite this to be
529                  * cleaner.
530                  * no MPS table in akaros.
531                  if((busno = mpisabusno) == -1)
532                  return -1;
533
534                  devno = irq_h->dev_irq<<2;
535                  */
536                 for (rbus = rdtbus[busno]; rbus != NULL; rbus = rbus->next)
537                         if (rbus->devno == devno) {
538                                 printk("rbus->devno = %p, devno %p\n", rbus->devno, devno);
539                                 rdt = rbus->rdt;
540                                 break;
541                         }
542                 printk("isa: tbdf %p busno %d devno %d %#p\n",
543                            irq_h->tbdf, busno, devno, rdt);
544         }
545         if (rdt == NULL) {
546                 printk("RDT Is STILL NULL!\n");
547                 return -1;
548         }
549
550         printk("Second crack\n");
551         /*
552          * Second crack:
553          * what to do about devices that intrenable/intrdisable frequently?
554          * 1) there is no ioapicdisable yet;
555          * 2) it would be good to reuse freed vectors.
556          * Oh bugger.
557          */
558         /*
559          * This is a low-frequency event so just lock
560          * the whole IOAPIC to initialise the RDT entry
561          * rather than putting a Lock in each entry.
562          */
563         spin_lock(&rdt->apic->lock);
564         printk("%p: %ld/%d/%d (%d)\n", irq_h->tbdf, rdt->apic - xioapic, rbus->devno,
565                    rdt->intin, devno);
566         if ((rdt->lo & 0xff) == 0) {
567                 vecno = nextvec();
568                 rdt->lo |= vecno;
569                 rdtvecno[vecno] = rdt;
570         } else
571                 printk("%p: mutiple irq bus %d dev %d\n", irq_h->tbdf, busno, devno);
572
573         rdt->enabled++;
574         lo = (rdt->lo & ~Im);
575         ioapicintrdd(&hi, &lo); // XXX picks a destination and sets phys/fixed
576         rtblput(rdt->apic, rdt->intin, hi, lo);
577         vecno = lo & 0xff;
578         spin_unlock(&rdt->apic->lock);
579
580         printk("busno %d devno %d hi %p lo %p vecno %d\n",
581                    busno, devno, hi, lo, vecno);
582
583         irq_h->check_spurious = lapic_check_spurious;
584         irq_h->eoi = lapic_send_eoi;
585         irq_h->mask = 0;
586         irq_h->unmask = 0;
587         irq_h->type = "ioapic";
588
589         return vecno;
590 }
591
592 int ioapicintrdisable(int vecno)
593 {
594         struct Rdt *rdt;
595
596         /*
597          * FOV. Oh dear. This isn't very good.
598          * Fortunately rdtvecno[vecno] is static
599          * once assigned.
600          * Must do better.
601          *
602          * What about any pending interrupts?
603          */
604         if (vecno < 0 || vecno > MaxIdtIOAPIC) {
605                 panic("ioapicintrdisable: vecno %d out of range", vecno);
606                 return -1;
607         }
608         if ((rdt = rdtvecno[vecno]) == NULL) {
609                 // XXX what if they asked for a LAPIC vector?
610                 panic("ioapicintrdisable: vecno %d has no rdt", vecno);
611                 return -1;
612         }
613
614         spin_lock(&rdt->apic->lock);
615         rdt->enabled--;
616         /* XXX looks like they think rdt->lo is supposed to have Im set/masked?  and
617          * they also blow away their 'hi' routing decision from earlier */
618         if (rdt->enabled == 0)
619                 rtblput(rdt->apic, rdt->intin, 0, rdt->lo);
620         spin_unlock(&rdt->apic->lock);
621
622         return 0;
623 }