560c600a6a0f0406a7e14bd42c324d2988e630f3
[dragonfly.git] / sys / platform / pc64 / x86_64 / mp_machdep.c
1 /*
2  * Copyright (c) 1996, by Steve Passe
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. The name of the developer may NOT be used to endorse or promote products
11  *    derived from this software without specific prior written permission.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  *
25  * $FreeBSD: src/sys/i386/i386/mp_machdep.c,v 1.115.2.15 2003/03/14 21:22:35 jhb Exp $
26  * $DragonFly: src/sys/platform/pc32/i386/mp_machdep.c,v 1.60 2008/06/07 12:03:52 mneumann Exp $
27  */
28
29 #include "opt_cpu.h"
30
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/sysctl.h>
35 #include <sys/malloc.h>
36 #include <sys/memrange.h>
37 #include <sys/cons.h>   /* cngetc() */
38 #include <sys/machintr.h>
39
40 #include <sys/mplock2.h>
41
42 #include <vm/vm.h>
43 #include <vm/vm_param.h>
44 #include <vm/pmap.h>
45 #include <vm/vm_kern.h>
46 #include <vm/vm_extern.h>
47 #include <sys/lock.h>
48 #include <vm/vm_map.h>
49 #include <sys/user.h>
50 #ifdef GPROF 
51 #include <sys/gmon.h>
52 #endif
53
54 #include <machine/smp.h>
55 #include <machine_base/apic/apicreg.h>
56 #include <machine/atomic.h>
57 #include <machine/cpufunc.h>
58 #include <machine_base/apic/mpapic.h>
59 #include <machine/psl.h>
60 #include <machine/segments.h>
61 #include <machine/tss.h>
62 #include <machine/specialreg.h>
63 #include <machine/globaldata.h>
64
65 #include <machine/md_var.h>             /* setidt() */
66 #include <machine_base/icu/icu.h>               /* IPIs */
67 #include <machine_base/isa/intr_machdep.h>      /* IPIs */
68
69 #define FIXUP_EXTRA_APIC_INTS   8       /* additional entries we may create */
70
71 #define WARMBOOT_TARGET         0
72 #define WARMBOOT_OFF            (KERNBASE + 0x0467)
73 #define WARMBOOT_SEG            (KERNBASE + 0x0469)
74
75 #define BIOS_BASE               (0xf0000)
76 #define BIOS_SIZE               (0x10000)
77 #define BIOS_COUNT              (BIOS_SIZE/4)
78
79 #define CMOS_REG                (0x70)
80 #define CMOS_DATA               (0x71)
81 #define BIOS_RESET              (0x0f)
82 #define BIOS_WARM               (0x0a)
83
84 #define PROCENTRY_FLAG_EN       0x01
85 #define PROCENTRY_FLAG_BP       0x02
86 #define IOAPICENTRY_FLAG_EN     0x01
87
88
89 /* MP Floating Pointer Structure */
90 typedef struct MPFPS {
91         char    signature[4];
92         u_int32_t pap;
93         u_char  length;
94         u_char  spec_rev;
95         u_char  checksum;
96         u_char  mpfb1;
97         u_char  mpfb2;
98         u_char  mpfb3;
99         u_char  mpfb4;
100         u_char  mpfb5;
101 }      *mpfps_t;
102
103 /* MP Configuration Table Header */
104 typedef struct MPCTH {
105         char    signature[4];
106         u_short base_table_length;
107         u_char  spec_rev;
108         u_char  checksum;
109         u_char  oem_id[8];
110         u_char  product_id[12];
111         u_int32_t oem_table_pointer;
112         u_short oem_table_size;
113         u_short entry_count;
114         u_int32_t apic_address;
115         u_short extended_table_length;
116         u_char  extended_table_checksum;
117         u_char  reserved;
118 }      *mpcth_t;
119
120
121 typedef struct PROCENTRY {
122         u_char  type;
123         u_char  apic_id;
124         u_char  apic_version;
125         u_char  cpu_flags;
126         u_int32_t cpu_signature;
127         u_int32_t feature_flags;
128         u_int32_t reserved1;
129         u_int32_t reserved2;
130 }      *proc_entry_ptr;
131
132 typedef struct BUSENTRY {
133         u_char  type;
134         u_char  bus_id;
135         char    bus_type[6];
136 }      *bus_entry_ptr;
137
138 typedef struct IOAPICENTRY {
139         u_char  type;
140         u_char  apic_id;
141         u_char  apic_version;
142         u_char  apic_flags;
143         u_int32_t apic_address;
144 }      *io_apic_entry_ptr;
145
146 typedef struct INTENTRY {
147         u_char  type;
148         u_char  int_type;
149         u_short int_flags;
150         u_char  src_bus_id;
151         u_char  src_bus_irq;
152         u_char  dst_apic_id;
153         u_char  dst_apic_int;
154 }      *int_entry_ptr;
155
156 /* descriptions of MP basetable entries */
157 typedef struct BASETABLE_ENTRY {
158         u_char  type;
159         u_char  length;
160         char    name[16];
161 }       basetable_entry;
162
163 /*
164  * this code MUST be enabled here and in mpboot.s.
165  * it follows the very early stages of AP boot by placing values in CMOS ram.
166  * it NORMALLY will never be needed and thus the primitive method for enabling.
167  *
168  */
169 #if defined(CHECK_POINTS)
170 #define CHECK_READ(A)    (outb(CMOS_REG, (A)), inb(CMOS_DATA))
171 #define CHECK_WRITE(A,D) (outb(CMOS_REG, (A)), outb(CMOS_DATA, (D)))
172
173 #define CHECK_INIT(D);                          \
174         CHECK_WRITE(0x34, (D));                 \
175         CHECK_WRITE(0x35, (D));                 \
176         CHECK_WRITE(0x36, (D));                 \
177         CHECK_WRITE(0x37, (D));                 \
178         CHECK_WRITE(0x38, (D));                 \
179         CHECK_WRITE(0x39, (D));
180
181 #define CHECK_PRINT(S);                         \
182         kprintf("%s: %d, %d, %d, %d, %d, %d\n", \
183            (S),                                 \
184            CHECK_READ(0x34),                    \
185            CHECK_READ(0x35),                    \
186            CHECK_READ(0x36),                    \
187            CHECK_READ(0x37),                    \
188            CHECK_READ(0x38),                    \
189            CHECK_READ(0x39));
190
191 #else                           /* CHECK_POINTS */
192
193 #define CHECK_INIT(D)
194 #define CHECK_PRINT(S)
195
196 #endif                          /* CHECK_POINTS */
197
198 /*
199  * Values to send to the POST hardware.
200  */
201 #define MP_BOOTADDRESS_POST     0x10
202 #define MP_PROBE_POST           0x11
203 #define MPTABLE_PASS1_POST      0x12
204
205 #define MP_START_POST           0x13
206 #define MP_ENABLE_POST          0x14
207 #define MPTABLE_PASS2_POST      0x15
208
209 #define START_ALL_APS_POST      0x16
210 #define INSTALL_AP_TRAMP_POST   0x17
211 #define START_AP_POST           0x18
212
213 #define MP_ANNOUNCE_POST        0x19
214
215 static int need_hyperthreading_fixup;
216 static u_int logical_cpus;
217 u_int   logical_cpus_mask;
218
219 /** XXX FIXME: where does this really belong, isa.h/isa.c perhaps? */
220 int     current_postcode;
221
222 /** XXX FIXME: what system files declare these??? */
223 extern struct region_descriptor r_gdt, r_idt;
224
225 int     bsp_apic_ready = 0;     /* flags useability of BSP apic */
226 int     mp_naps;                /* # of Applications processors */
227 int     mp_nbusses;             /* # of busses */
228 #ifdef APIC_IO
229 int     mp_napics;              /* # of IO APICs */
230 #endif
231 int     boot_cpu_id;            /* designated BSP */
232 vm_offset_t cpu_apic_address;
233 #ifdef APIC_IO
234 vm_offset_t io_apic_address[NAPICID];   /* NAPICID is more than enough */
235 u_int32_t *io_apic_versions;
236 #endif
237 extern  int nkpt;
238
239 u_int32_t cpu_apic_versions[MAXCPU];
240 int64_t tsc0_offset;
241 extern int64_t tsc_offsets[];
242
243 #ifdef APIC_IO
244 struct apic_intmapinfo  int_to_apicintpin[APIC_INTMAPSIZE];
245 #endif
246
247 /*
248  * APIC ID logical/physical mapping structures.
249  * We oversize these to simplify boot-time config.
250  */
251 int     cpu_num_to_apic_id[NAPICID];
252 #ifdef APIC_IO
253 int     io_num_to_apic_id[NAPICID];
254 #endif
255 int     apic_id_to_logical[NAPICID];
256
257 /* AP uses this during bootstrap.  Do not staticize.  */
258 char *bootSTK;
259 static int bootAP;
260
261 /* Hotwire a 0->4MB V==P mapping */
262 extern pt_entry_t *KPTphys;
263
264 /*
265  * SMP page table page.  Setup by locore to point to a page table
266  * page from which we allocate per-cpu privatespace areas io_apics,
267  * and so forth.
268  */
269
270 #define IO_MAPPING_START_INDEX  \
271                 (SMP_MAXCPU * sizeof(struct privatespace) / PAGE_SIZE)
272
273 extern pt_entry_t *SMPpt;
274
275 struct pcb stoppcbs[MAXCPU];
276
277 extern inthand_t IDTVEC(fast_syscall), IDTVEC(fast_syscall32);
278
279 /*
280  * Local data and functions.
281  */
282
283 static int      mp_capable;
284 static u_int    boot_address;
285 static u_int    base_memory;
286 static int      mp_finish;
287
288 static mpfps_t  mpfps;
289 static long     search_for_sig(u_int32_t target, int count);
290 static void     mp_enable(u_int boot_addr);
291
292 static void     mptable_hyperthread_fixup(u_int id_mask);
293 static void     mptable_pass1(void);
294 static int      mptable_pass2(void);
295 static void     default_mp_table(int type);
296 static void     fix_mp_table(void);
297 #ifdef APIC_IO
298 static void     setup_apic_irq_mapping(void);
299 static int      apic_int_is_bus_type(int intr, int bus_type);
300 #endif
301 static int      start_all_aps(u_int boot_addr);
302 #if 0
303 static void     install_ap_tramp(u_int boot_addr);
304 #endif
305 static int      start_ap(struct mdglobaldata *gd, u_int boot_addr);
306
307 static cpumask_t smp_startup_mask = 1;  /* which cpus have been started */
308 cpumask_t smp_active_mask = 1;  /* which cpus are ready for IPIs etc? */
309 SYSCTL_INT(_machdep, OID_AUTO, smp_active, CTLFLAG_RD, &smp_active_mask, 0, "");
310 static u_int    bootMP_size;
311
312 /*
313  * Calculate usable address in base memory for AP trampoline code.
314  */
315 u_int
316 mp_bootaddress(u_int basemem)
317 {
318         POSTCODE(MP_BOOTADDRESS_POST);
319
320         base_memory = basemem;
321
322         bootMP_size = mptramp_end - mptramp_start;
323         boot_address = trunc_page(basemem * 1024); /* round down to 4k boundary */
324         if (((basemem * 1024) - boot_address) < bootMP_size)
325                 boot_address -= PAGE_SIZE;      /* not enough, lower by 4k */
326         /* 3 levels of page table pages */
327         mptramp_pagetables = boot_address - (PAGE_SIZE * 3);
328
329         return mptramp_pagetables;
330 }
331
332
333 /*
334  * Look for an Intel MP spec table (ie, SMP capable hardware).
335  */
336 int
337 mp_probe(void)
338 {
339         long    x;
340         u_long  segment;
341         u_int32_t target;
342  
343         /*
344          * Make sure our SMPpt[] page table is big enough to hold all the
345          * mappings we need.
346          */
347         KKASSERT(IO_MAPPING_START_INDEX < NPTEPG - 2);
348
349         POSTCODE(MP_PROBE_POST);
350
351         /* see if EBDA exists */
352         if ((segment = (u_long) * (u_short *) (KERNBASE + 0x40e)) != 0) {
353                 /* search first 1K of EBDA */
354                 target = (u_int32_t) (segment << 4);
355                 if ((x = search_for_sig(target, 1024 / 4)) != -1L)
356                         goto found;
357         } else {
358                 /* last 1K of base memory, effective 'top of base' passed in */
359                 target = (u_int32_t) (base_memory - 0x400);
360                 if ((x = search_for_sig(target, 1024 / 4)) != -1L)
361                         goto found;
362         }
363
364         /* search the BIOS */
365         target = (u_int32_t) BIOS_BASE;
366         if ((x = search_for_sig(target, BIOS_COUNT)) != -1L)
367                 goto found;
368
369         /* nothing found */
370         mpfps = (mpfps_t)0;
371         mp_capable = 0;
372         return 0;
373
374 found:
375         /*
376          * Calculate needed resources.  We can safely map physical
377          * memory into SMPpt after mptable_pass1() completes.
378          */
379         mpfps = (mpfps_t)x;
380         mptable_pass1();
381
382         /* flag fact that we are running multiple processors */
383         mp_capable = 1;
384         return 1;
385 }
386
387
388 /*
389  * Startup the SMP processors.
390  */
391 void
392 mp_start(void)
393 {
394         POSTCODE(MP_START_POST);
395
396         /* look for MP capable motherboard */
397         if (mp_capable)
398                 mp_enable(boot_address);
399         else
400                 panic("MP hardware not found!");
401 }
402
403
404 /*
405  * Print various information about the SMP system hardware and setup.
406  */
407 void
408 mp_announce(void)
409 {
410         int     x;
411
412         POSTCODE(MP_ANNOUNCE_POST);
413
414         kprintf("DragonFly/MP: Multiprocessor motherboard\n");
415         kprintf(" cpu0 (BSP): apic id: %2d", CPU_TO_ID(0));
416         kprintf(", version: 0x%08x", cpu_apic_versions[0]);
417         kprintf(", at 0x%08jx\n", (intmax_t)cpu_apic_address);
418         for (x = 1; x <= mp_naps; ++x) {
419                 kprintf(" cpu%d (AP):  apic id: %2d", x, CPU_TO_ID(x));
420                 kprintf(", version: 0x%08x", cpu_apic_versions[x]);
421                 kprintf(", at 0x%08jx\n", (intmax_t)cpu_apic_address);
422         }
423
424 #if defined(APIC_IO)
425         for (x = 0; x < mp_napics; ++x) {
426                 kprintf(" io%d (APIC): apic id: %2d", x, IO_TO_ID(x));
427                 kprintf(", version: 0x%08x", io_apic_versions[x]);
428                 kprintf(", at 0x%08x\n", io_apic_address[x]);
429         }
430 #else
431         kprintf(" Warning: APIC I/O disabled\n");
432 #endif  /* APIC_IO */
433 }
434
435 /*
436  * AP cpu's call this to sync up protected mode.
437  *
438  * WARNING! %gs is not set up on entry.  This routine sets up %gs.
439  */
440 void
441 init_secondary(void)
442 {
443         int     gsel_tss;
444         int     x, myid = bootAP;
445         u_int64_t msr, cr0;
446         struct mdglobaldata *md;
447         struct privatespace *ps;
448
449         ps = &CPU_prvspace[myid];
450
451         gdt_segs[GPROC0_SEL].ssd_base =
452                 (long) &ps->mdglobaldata.gd_common_tss;
453         ps->mdglobaldata.mi.gd_prvspace = ps;
454
455         /* We fill the 32-bit segment descriptors */
456         for (x = 0; x < NGDT; x++) {
457                 if (x != GPROC0_SEL && x != (GPROC0_SEL + 1))
458                         ssdtosd(&gdt_segs[x], &gdt[myid * NGDT + x]);
459         }
460         /* And now a 64-bit one */
461         ssdtosyssd(&gdt_segs[GPROC0_SEL],
462             (struct system_segment_descriptor *)&gdt[myid * NGDT + GPROC0_SEL]);
463
464         r_gdt.rd_limit = NGDT * sizeof(gdt[0]) - 1;
465         r_gdt.rd_base = (long) &gdt[myid * NGDT];
466         lgdt(&r_gdt);                   /* does magic intra-segment return */
467
468         /* lgdt() destroys the GSBASE value, so we load GSBASE after lgdt() */
469         wrmsr(MSR_FSBASE, 0);           /* User value */
470         wrmsr(MSR_GSBASE, (u_int64_t)ps);
471         wrmsr(MSR_KGSBASE, 0);          /* XXX User value while we're in the kernel */
472
473         lidt(&r_idt);
474
475 #if 0
476         lldt(_default_ldt);
477         mdcpu->gd_currentldt = _default_ldt;
478 #endif
479
480         gsel_tss = GSEL(GPROC0_SEL, SEL_KPL);
481         gdt[myid * NGDT + GPROC0_SEL].sd_type = SDT_SYSTSS;
482
483         md = mdcpu;     /* loaded through %gs:0 (mdglobaldata.mi.gd_prvspace)*/
484
485         md->gd_common_tss.tss_rsp0 = 0; /* not used until after switch */
486 #if 0 /* JG XXX */
487         md->gd_common_tss.tss_ioopt = (sizeof md->gd_common_tss) << 16;
488 #endif
489         md->gd_tss_gdt = &gdt[myid * NGDT + GPROC0_SEL];
490         md->gd_common_tssd = *md->gd_tss_gdt;
491 #if 0 /* JG XXX */
492         md->gd_common_tss.tss_ist1 = (long)&doublefault_stack[PAGE_SIZE];
493 #endif
494         ltr(gsel_tss);
495
496         /*
497          * Set to a known state:
498          * Set by mpboot.s: CR0_PG, CR0_PE
499          * Set by cpu_setregs: CR0_NE, CR0_MP, CR0_TS, CR0_WP, CR0_AM
500          */
501         cr0 = rcr0();
502         cr0 &= ~(CR0_CD | CR0_NW | CR0_EM);
503         load_cr0(cr0);
504
505         /* Set up the fast syscall stuff */
506         msr = rdmsr(MSR_EFER) | EFER_SCE;
507         wrmsr(MSR_EFER, msr);
508         wrmsr(MSR_LSTAR, (u_int64_t)IDTVEC(fast_syscall));
509         wrmsr(MSR_CSTAR, (u_int64_t)IDTVEC(fast_syscall32));
510         msr = ((u_int64_t)GSEL(GCODE_SEL, SEL_KPL) << 32) |
511               ((u_int64_t)GSEL(GUCODE32_SEL, SEL_UPL) << 48);
512         wrmsr(MSR_STAR, msr);
513         wrmsr(MSR_SF_MASK, PSL_NT|PSL_T|PSL_I|PSL_C|PSL_D);
514
515         pmap_set_opt();         /* PSE/4MB pages, etc */
516 #if JGXXX
517         /* Initialize the PAT MSR. */
518         pmap_init_pat();
519 #endif
520
521         /* set up CPU registers and state */
522         cpu_setregs();
523
524         /* set up SSE/NX registers */
525         initializecpu();
526
527         /* set up FPU state on the AP */
528         npxinit(__INITIAL_NPXCW__);
529
530         /* disable the APIC, just to be SURE */
531         lapic->svr &= ~APIC_SVR_ENABLE;
532
533         /* data returned to BSP */
534         cpu_apic_versions[0] = lapic->version;
535 }
536
537 /*******************************************************************
538  * local functions and data
539  */
540
541 /*
542  * start the SMP system
543  */
544 static void
545 mp_enable(u_int boot_addr)
546 {
547         int     x;
548 #if defined(APIC_IO)
549         int     apic;
550         u_int   ux;
551 #endif  /* APIC_IO */
552
553         POSTCODE(MP_ENABLE_POST);
554
555 #if 0 /* JGXXX */
556         /* turn on 4MB of V == P addressing so we can get to MP table */
557         *(int *)PTD = PG_V | PG_RW | ((uintptr_t)(void *)KPTphys & PG_FRAME);
558         cpu_invltlb();
559 #endif
560
561         /* examine the MP table for needed info, uses physical addresses */
562         x = mptable_pass2();
563
564 #if 0 /* JGXXX */
565         *(int *)PTD = 0;
566         cpu_invltlb();
567 #endif /* 0 JGXXX */
568
569         /* can't process default configs till the CPU APIC is pmapped */
570         if (x)
571                 default_mp_table(x);
572
573         /* post scan cleanup */
574         fix_mp_table();
575
576 #if defined(APIC_IO)
577
578         setup_apic_irq_mapping();
579
580         /* fill the LOGICAL io_apic_versions table */
581         for (apic = 0; apic < mp_napics; ++apic) {
582                 ux = io_apic_read(apic, IOAPIC_VER);
583                 io_apic_versions[apic] = ux;
584                 io_apic_set_id(apic, IO_TO_ID(apic));
585         }
586
587         /* program each IO APIC in the system */
588         for (apic = 0; apic < mp_napics; ++apic)
589                 if (io_apic_setup(apic) < 0)
590                         panic("IO APIC setup failure");
591
592 #endif  /* APIC_IO */
593
594         /*
595          * These are required for SMP operation
596          */
597
598         /* install a 'Spurious INTerrupt' vector */
599         setidt(XSPURIOUSINT_OFFSET, Xspuriousint,
600                SDT_SYSIGT, SEL_KPL, 0);
601
602         /* install an inter-CPU IPI for TLB invalidation */
603         setidt(XINVLTLB_OFFSET, Xinvltlb,
604                SDT_SYSIGT, SEL_KPL, 0);
605
606         /* install an inter-CPU IPI for IPIQ messaging */
607         setidt(XIPIQ_OFFSET, Xipiq,
608                SDT_SYSIGT, SEL_KPL, 0);
609
610         /* install a timer vector */
611         setidt(XTIMER_OFFSET, Xtimer,
612                SDT_SYSIGT, SEL_KPL, 0);
613         
614         /* install an inter-CPU IPI for CPU stop/restart */
615         setidt(XCPUSTOP_OFFSET, Xcpustop,
616                SDT_SYSIGT, SEL_KPL, 0);
617
618         /* start each Application Processor */
619         start_all_aps(boot_addr);
620 }
621
622
623 /*
624  * look for the MP spec signature
625  */
626
627 /* string defined by the Intel MP Spec as identifying the MP table */
628 #define MP_SIG          0x5f504d5f      /* _MP_ */
629 #define NEXT(X)         ((X) += 4)
630 static long
631 search_for_sig(u_int32_t target, int count)
632 {
633         int     x;
634         u_int32_t *addr = (u_int32_t *) (KERNBASE + target);
635
636         for (x = 0; x < count; NEXT(x))
637                 if (addr[x] == MP_SIG)
638                         /* make array index a byte index */
639                         return (long)(&addr[x]);
640
641         return -1;
642 }
643
644
645 static basetable_entry basetable_entry_types[] =
646 {
647         {0, 20, "Processor"},
648         {1, 8, "Bus"},
649         {2, 8, "I/O APIC"},
650         {3, 8, "I/O INT"},
651         {4, 8, "Local INT"}
652 };
653
654 typedef struct BUSDATA {
655         u_char  bus_id;
656         enum busTypes bus_type;
657 }       bus_datum;
658
659 typedef struct INTDATA {
660         u_char  int_type;
661         u_short int_flags;
662         u_char  src_bus_id;
663         u_char  src_bus_irq;
664         u_char  dst_apic_id;
665         u_char  dst_apic_int;
666         u_char  int_vector;
667 }       io_int, local_int;
668
669 typedef struct BUSTYPENAME {
670         u_char  type;
671         char    name[7];
672 }       bus_type_name;
673
674 static bus_type_name bus_type_table[] =
675 {
676         {CBUS, "CBUS"},
677         {CBUSII, "CBUSII"},
678         {EISA, "EISA"},
679         {MCA, "MCA"},
680         {UNKNOWN_BUSTYPE, "---"},
681         {ISA, "ISA"},
682         {MCA, "MCA"},
683         {UNKNOWN_BUSTYPE, "---"},
684         {UNKNOWN_BUSTYPE, "---"},
685         {UNKNOWN_BUSTYPE, "---"},
686         {UNKNOWN_BUSTYPE, "---"},
687         {UNKNOWN_BUSTYPE, "---"},
688         {PCI, "PCI"},
689         {UNKNOWN_BUSTYPE, "---"},
690         {UNKNOWN_BUSTYPE, "---"},
691         {UNKNOWN_BUSTYPE, "---"},
692         {UNKNOWN_BUSTYPE, "---"},
693         {XPRESS, "XPRESS"},
694         {UNKNOWN_BUSTYPE, "---"}
695 };
696 /* from MP spec v1.4, table 5-1 */
697 static int default_data[7][5] =
698 {
699 /*   nbus, id0, type0, id1, type1 */
700         {1, 0, ISA, 255, 255},
701         {1, 0, EISA, 255, 255},
702         {1, 0, EISA, 255, 255},
703         {1, 0, MCA, 255, 255},
704         {2, 0, ISA, 1, PCI},
705         {2, 0, EISA, 1, PCI},
706         {2, 0, MCA, 1, PCI}
707 };
708
709
710 /* the bus data */
711 static bus_datum *bus_data;
712
713 #ifdef APIC_IO
714 /* the IO INT data, one entry per possible APIC INTerrupt */
715 static io_int  *io_apic_ints;
716 static int nintrs;
717 #endif
718
719 static int processor_entry      (proc_entry_ptr entry, int cpu);
720 static int bus_entry            (bus_entry_ptr entry, int bus);
721 #ifdef APIC_IO
722 static int io_apic_entry        (io_apic_entry_ptr entry, int apic);
723 static int int_entry            (int_entry_ptr entry, int intr);
724 #endif
725 static int lookup_bus_type      (char *name);
726
727
728 /*
729  * 1st pass on motherboard's Intel MP specification table.
730  *
731  * initializes:
732  *      ncpus = 1
733  *
734  * determines:
735  *      cpu_apic_address (common to all CPUs)
736  *      io_apic_address[N]
737  *      mp_naps
738  *      mp_nbusses
739  *      mp_napics
740  *      nintrs
741  */
742 static void
743 mptable_pass1(void)
744 {
745 #ifdef APIC_IO
746         int     x;
747 #endif
748         mpcth_t cth;
749         int     totalSize;
750         void*   position;
751         int     count;
752         int     type;
753         u_int   id_mask;
754
755         POSTCODE(MPTABLE_PASS1_POST);
756
757 #ifdef APIC_IO
758         /* clear various tables */
759         for (x = 0; x < NAPICID; ++x) {
760                 io_apic_address[x] = ~0;        /* IO APIC address table */
761         }
762 #endif
763
764         /* init everything to empty */
765         mp_naps = 0;
766         mp_nbusses = 0;
767 #ifdef APIC_IO
768         mp_napics = 0;
769         nintrs = 0;
770 #endif
771         id_mask = 0;
772
773         /* check for use of 'default' configuration */
774         if (mpfps->mpfb1 != 0) {
775                 /* use default addresses */
776                 cpu_apic_address = DEFAULT_APIC_BASE;
777 #ifdef APIC_IO
778                 io_apic_address[0] = DEFAULT_IO_APIC_BASE;
779 #endif
780
781                 /* fill in with defaults */
782                 mp_naps = 2;            /* includes BSP */
783                 mp_nbusses = default_data[mpfps->mpfb1 - 1][0];
784 #if defined(APIC_IO)
785                 mp_napics = 1;
786                 nintrs = 16;
787 #endif  /* APIC_IO */
788         }
789         else {
790                 if (mpfps->pap == 0)
791                         panic("MP Configuration Table Header MISSING!");
792                 cth = (void *)PHYS_TO_DMAP(mpfps->pap);
793
794                 cpu_apic_address = (vm_offset_t) cth->apic_address;
795
796                 /* walk the table, recording info of interest */
797                 totalSize = cth->base_table_length - sizeof(struct MPCTH);
798                 position = (u_char *) cth + sizeof(struct MPCTH);
799                 count = cth->entry_count;
800
801                 while (count--) {
802                         switch (type = *(u_char *) position) {
803                         case 0: /* processor_entry */
804                                 if (((proc_entry_ptr)position)->cpu_flags
805                                     & PROCENTRY_FLAG_EN) {
806                                         ++mp_naps;
807                                         id_mask |= 1 <<
808                                             ((proc_entry_ptr)position)->apic_id;
809                                 }
810                                 break;
811                         case 1: /* bus_entry */
812                                 ++mp_nbusses;
813                                 break;
814                         case 2: /* io_apic_entry */
815 #ifdef APIC_IO
816                                 if (((io_apic_entry_ptr)position)->apic_flags
817                                         & IOAPICENTRY_FLAG_EN)
818                                         io_apic_address[mp_napics++] =
819                                             (vm_offset_t)((io_apic_entry_ptr)
820                                                 position)->apic_address;
821 #endif
822                                 break;
823                         case 3: /* int_entry */
824 #ifdef APIC_IO
825                                 ++nintrs;
826 #endif
827                                 break;
828                         case 4: /* int_entry */
829                                 break;
830                         default:
831                                 panic("mpfps Base Table HOSED!");
832                                 /* NOTREACHED */
833                         }
834
835                         totalSize -= basetable_entry_types[type].length;
836                         position = (uint8_t *)position +
837                             basetable_entry_types[type].length;
838                 }
839         }
840
841         /* qualify the numbers */
842         if (mp_naps > MAXCPU) {
843                 kprintf("Warning: only using %d of %d available CPUs!\n",
844                         MAXCPU, mp_naps);
845                 mp_naps = MAXCPU;
846         }
847
848         /* See if we need to fixup HT logical CPUs. */
849         mptable_hyperthread_fixup(id_mask);
850         
851         /*
852          * Count the BSP.
853          * This is also used as a counter while starting the APs.
854          */
855         ncpus = 1;
856
857         --mp_naps;      /* subtract the BSP */
858 }
859
860
861 /*
862  * 2nd pass on motherboard's Intel MP specification table.
863  *
864  * sets:
865  *      boot_cpu_id
866  *      ID_TO_IO(N), phy APIC ID to log CPU/IO table
867  *      CPU_TO_ID(N), logical CPU to APIC ID table
868  *      IO_TO_ID(N), logical IO to APIC ID table
869  *      bus_data[N]
870  *      io_apic_ints[N]
871  */
872 static int
873 mptable_pass2(void)
874 {
875         struct PROCENTRY proc;
876         int     x;
877         mpcth_t cth;
878         int     totalSize;
879         void*   position;
880         int     count;
881         int     type;
882         int     apic, bus, cpu, intr;
883         int     i;
884
885         POSTCODE(MPTABLE_PASS2_POST);
886
887         /* Initialize fake proc entry for use with HT fixup. */
888         bzero(&proc, sizeof(proc));
889         proc.type = 0;
890         proc.cpu_flags = PROCENTRY_FLAG_EN;
891
892 #ifdef APIC_IO
893         MALLOC(io_apic_versions, u_int32_t *, sizeof(u_int32_t) * mp_napics,
894             M_DEVBUF, M_WAITOK);
895         MALLOC(ioapic, volatile ioapic_t **, sizeof(ioapic_t *) * mp_napics,
896             M_DEVBUF, M_WAITOK | M_ZERO);
897         MALLOC(io_apic_ints, io_int *, sizeof(io_int) * (nintrs + FIXUP_EXTRA_APIC_INTS),
898             M_DEVBUF, M_WAITOK);
899 #endif
900         MALLOC(bus_data, bus_datum *, sizeof(bus_datum) * mp_nbusses,
901             M_DEVBUF, M_WAITOK);
902
903 #ifdef APIC_IO
904         for (i = 0; i < mp_napics; i++) {
905                 ioapic[i] = permanent_io_mapping(io_apic_address[i]);
906         }
907 #endif
908
909         /* clear various tables */
910         for (x = 0; x < NAPICID; ++x) {
911                 CPU_TO_ID(x) = -1;      /* logical CPU to APIC ID table */
912 #ifdef APIC_IO
913                 ID_TO_IO(x) = -1;       /* phy APIC ID to log CPU/IO table */
914                 IO_TO_ID(x) = -1;       /* logical IO to APIC ID table */
915 #endif
916         }
917
918         /* clear bus data table */
919         for (x = 0; x < mp_nbusses; ++x)
920                 bus_data[x].bus_id = 0xff;
921
922 #ifdef APIC_IO
923         /* clear IO APIC INT table */
924         for (x = 0; x < (nintrs + 1); ++x) {
925                 io_apic_ints[x].int_type = 0xff;
926                 io_apic_ints[x].int_vector = 0xff;
927         }
928 #endif
929
930         /* setup the cpu/apic mapping arrays */
931         boot_cpu_id = -1;
932
933         /* record whether PIC or virtual-wire mode */
934         machintr_setvar_simple(MACHINTR_VAR_IMCR_PRESENT, mpfps->mpfb2 & 0x80);
935
936         /* check for use of 'default' configuration */
937         if (mpfps->mpfb1 != 0)
938                 return mpfps->mpfb1;    /* return default configuration type */
939
940         if (mpfps->pap == 0)
941                 panic("MP Configuration Table Header MISSING!");
942
943         cth = (void *)PHYS_TO_DMAP(mpfps->pap);
944         /* walk the table, recording info of interest */
945         totalSize = cth->base_table_length - sizeof(struct MPCTH);
946         position = (u_char *) cth + sizeof(struct MPCTH);
947         count = cth->entry_count;
948         apic = bus = intr = 0;
949         cpu = 1;                                /* pre-count the BSP */
950
951         while (count--) {
952                 switch (type = *(u_char *) position) {
953                 case 0:
954                         if (processor_entry(position, cpu))
955                                 ++cpu;
956
957                         if (need_hyperthreading_fixup) {
958                                 /*
959                                  * Create fake mptable processor entries
960                                  * and feed them to processor_entry() to
961                                  * enumerate the logical CPUs.
962                                  */
963                                 proc.apic_id = ((proc_entry_ptr)position)->apic_id;
964                                 for (i = 1; i < logical_cpus; i++) {
965                                         proc.apic_id++;
966                                         processor_entry(&proc, cpu);
967                                         logical_cpus_mask |= (1 << cpu);
968                                         cpu++;
969                                 }
970                         }
971                         break;
972                 case 1:
973                         if (bus_entry(position, bus))
974                                 ++bus;
975                         break;
976                 case 2:
977 #ifdef APIC_IO
978                         if (io_apic_entry(position, apic))
979                                 ++apic;
980 #endif
981                         break;
982                 case 3:
983 #ifdef APIC_IO
984                         if (int_entry(position, intr))
985                                 ++intr;
986 #endif
987                         break;
988                 case 4:
989                         /* int_entry(position); */
990                         break;
991                 default:
992                         panic("mpfps Base Table HOSED!");
993                         /* NOTREACHED */
994                 }
995
996                 totalSize -= basetable_entry_types[type].length;
997                 position = (uint8_t *)position + basetable_entry_types[type].length;
998         }
999
1000         if (boot_cpu_id == -1)
1001                 panic("NO BSP found!");
1002
1003         /* report fact that its NOT a default configuration */
1004         return 0;
1005 }
1006
1007 /*
1008  * Check if we should perform a hyperthreading "fix-up" to
1009  * enumerate any logical CPU's that aren't already listed
1010  * in the table.
1011  *
1012  * XXX: We assume that all of the physical CPUs in the
1013  * system have the same number of logical CPUs.
1014  *
1015  * XXX: We assume that APIC ID's are allocated such that
1016  * the APIC ID's for a physical processor are aligned
1017  * with the number of logical CPU's in the processor.
1018  */
1019 static void
1020 mptable_hyperthread_fixup(u_int id_mask)
1021 {
1022         u_int i, id;
1023
1024         /* Nothing to do if there is no HTT support. */
1025         if ((cpu_feature & CPUID_HTT) == 0)
1026                 return;
1027         logical_cpus = (cpu_procinfo & CPUID_HTT_CORES) >> 16;
1028         if (logical_cpus <= 1)
1029                 return;
1030
1031         /*
1032          * For each APIC ID of a CPU that is set in the mask,
1033          * scan the other candidate APIC ID's for this
1034          * physical processor.  If any of those ID's are
1035          * already in the table, then kill the fixup.
1036          */
1037         for (id = 0; id <= MAXCPU; id++) {
1038                 if ((id_mask & 1 << id) == 0)
1039                         continue;
1040                 /* First, make sure we are on a logical_cpus boundary. */
1041                 if (id % logical_cpus != 0)
1042                         return;
1043                 for (i = id + 1; i < id + logical_cpus; i++)
1044                         if ((id_mask & 1 << i) != 0)
1045                                 return;
1046         }
1047
1048         /*
1049          * Ok, the ID's checked out, so enable the fixup.  We have to fixup
1050          * mp_naps right now.
1051          */
1052         need_hyperthreading_fixup = 1;
1053         mp_naps *= logical_cpus;
1054 }
1055
1056 #ifdef APIC_IO
1057
1058 void
1059 assign_apic_irq(int apic, int intpin, int irq)
1060 {
1061         int x;
1062         
1063         if (int_to_apicintpin[irq].ioapic != -1)
1064                 panic("assign_apic_irq: inconsistent table");
1065         
1066         int_to_apicintpin[irq].ioapic = apic;
1067         int_to_apicintpin[irq].int_pin = intpin;
1068         int_to_apicintpin[irq].apic_address = ioapic[apic];
1069         int_to_apicintpin[irq].redirindex = IOAPIC_REDTBL + 2 * intpin;
1070         
1071         for (x = 0; x < nintrs; x++) {
1072                 if ((io_apic_ints[x].int_type == 0 || 
1073                      io_apic_ints[x].int_type == 3) &&
1074                     io_apic_ints[x].int_vector == 0xff &&
1075                     io_apic_ints[x].dst_apic_id == IO_TO_ID(apic) &&
1076                     io_apic_ints[x].dst_apic_int == intpin)
1077                         io_apic_ints[x].int_vector = irq;
1078         }
1079 }
1080
1081 void
1082 revoke_apic_irq(int irq)
1083 {
1084         int x;
1085         int oldapic;
1086         int oldintpin;
1087         
1088         if (int_to_apicintpin[irq].ioapic == -1)
1089                 panic("revoke_apic_irq: inconsistent table");
1090         
1091         oldapic = int_to_apicintpin[irq].ioapic;
1092         oldintpin = int_to_apicintpin[irq].int_pin;
1093
1094         int_to_apicintpin[irq].ioapic = -1;
1095         int_to_apicintpin[irq].int_pin = 0;
1096         int_to_apicintpin[irq].apic_address = NULL;
1097         int_to_apicintpin[irq].redirindex = 0;
1098         
1099         for (x = 0; x < nintrs; x++) {
1100                 if ((io_apic_ints[x].int_type == 0 || 
1101                      io_apic_ints[x].int_type == 3) &&
1102                     io_apic_ints[x].int_vector != 0xff &&
1103                     io_apic_ints[x].dst_apic_id == IO_TO_ID(oldapic) &&
1104                     io_apic_ints[x].dst_apic_int == oldintpin)
1105                         io_apic_ints[x].int_vector = 0xff;
1106         }
1107 }
1108
1109 /*
1110  * Allocate an IRQ 
1111  */
1112 static void
1113 allocate_apic_irq(int intr)
1114 {
1115         int apic;
1116         int intpin;
1117         int irq;
1118         
1119         if (io_apic_ints[intr].int_vector != 0xff)
1120                 return;         /* Interrupt handler already assigned */
1121         
1122         if (io_apic_ints[intr].int_type != 0 &&
1123             (io_apic_ints[intr].int_type != 3 ||
1124              (io_apic_ints[intr].dst_apic_id == IO_TO_ID(0) &&
1125               io_apic_ints[intr].dst_apic_int == 0)))
1126                 return;         /* Not INT or ExtInt on != (0, 0) */
1127         
1128         irq = 0;
1129         while (irq < APIC_INTMAPSIZE &&
1130                int_to_apicintpin[irq].ioapic != -1)
1131                 irq++;
1132         
1133         if (irq >= APIC_INTMAPSIZE)
1134                 return;         /* No free interrupt handlers */
1135         
1136         apic = ID_TO_IO(io_apic_ints[intr].dst_apic_id);
1137         intpin = io_apic_ints[intr].dst_apic_int;
1138         
1139         assign_apic_irq(apic, intpin, irq);
1140 }
1141
1142
1143 static void
1144 swap_apic_id(int apic, int oldid, int newid)
1145 {
1146         int x;
1147         int oapic;
1148         
1149
1150         if (oldid == newid)
1151                 return;                 /* Nothing to do */
1152         
1153         kprintf("Changing APIC ID for IO APIC #%d from %d to %d in MP table\n",
1154                apic, oldid, newid);
1155         
1156         /* Swap physical APIC IDs in interrupt entries */
1157         for (x = 0; x < nintrs; x++) {
1158                 if (io_apic_ints[x].dst_apic_id == oldid)
1159                         io_apic_ints[x].dst_apic_id = newid;
1160                 else if (io_apic_ints[x].dst_apic_id == newid)
1161                         io_apic_ints[x].dst_apic_id = oldid;
1162         }
1163         
1164         /* Swap physical APIC IDs in IO_TO_ID mappings */
1165         for (oapic = 0; oapic < mp_napics; oapic++)
1166                 if (IO_TO_ID(oapic) == newid)
1167                         break;
1168         
1169         if (oapic < mp_napics) {
1170                 kprintf("Changing APIC ID for IO APIC #%d from "
1171                        "%d to %d in MP table\n",
1172                        oapic, newid, oldid);
1173                 IO_TO_ID(oapic) = oldid;
1174         }
1175         IO_TO_ID(apic) = newid;
1176 }
1177
1178
1179 static void
1180 fix_id_to_io_mapping(void)
1181 {
1182         int x;
1183
1184         for (x = 0; x < NAPICID; x++)
1185                 ID_TO_IO(x) = -1;
1186         
1187         for (x = 0; x <= mp_naps; x++)
1188                 if (CPU_TO_ID(x) < NAPICID)
1189                         ID_TO_IO(CPU_TO_ID(x)) = x;
1190         
1191         for (x = 0; x < mp_napics; x++)
1192                 if (IO_TO_ID(x) < NAPICID)
1193                         ID_TO_IO(IO_TO_ID(x)) = x;
1194 }
1195
1196
1197 static int
1198 first_free_apic_id(void)
1199 {
1200         int freeid, x;
1201         
1202         for (freeid = 0; freeid < NAPICID; freeid++) {
1203                 for (x = 0; x <= mp_naps; x++)
1204                         if (CPU_TO_ID(x) == freeid)
1205                                 break;
1206                 if (x <= mp_naps)
1207                         continue;
1208                 for (x = 0; x < mp_napics; x++)
1209                         if (IO_TO_ID(x) == freeid)
1210                                 break;
1211                 if (x < mp_napics)
1212                         continue;
1213                 return freeid;
1214         }
1215         return freeid;
1216 }
1217
1218
1219 static int
1220 io_apic_id_acceptable(int apic, int id)
1221 {
1222         int cpu;                /* Logical CPU number */
1223         int oapic;              /* Logical IO APIC number for other IO APIC */
1224
1225         if (id >= NAPICID)
1226                 return 0;       /* Out of range */
1227         
1228         for (cpu = 0; cpu <= mp_naps; cpu++)
1229                 if (CPU_TO_ID(cpu) == id)
1230                         return 0;       /* Conflict with CPU */
1231         
1232         for (oapic = 0; oapic < mp_napics && oapic < apic; oapic++)
1233                 if (IO_TO_ID(oapic) == id)
1234                         return 0;       /* Conflict with other APIC */
1235         
1236         return 1;               /* ID is acceptable for IO APIC */
1237 }
1238
1239 static
1240 io_int *
1241 io_apic_find_int_entry(int apic, int pin)
1242 {
1243         int     x;
1244
1245         /* search each of the possible INTerrupt sources */
1246         for (x = 0; x < nintrs; ++x) {
1247                 if ((apic == ID_TO_IO(io_apic_ints[x].dst_apic_id)) &&
1248                     (pin == io_apic_ints[x].dst_apic_int))
1249                         return (&io_apic_ints[x]);
1250         }
1251         return NULL;
1252 }
1253
1254 #endif
1255
1256 /*
1257  * parse an Intel MP specification table
1258  */
1259 static void
1260 fix_mp_table(void)
1261 {
1262         int     x;
1263 #ifdef APIC_IO
1264         int     id;
1265         int     apic;           /* IO APIC unit number */
1266         int     freeid;         /* Free physical APIC ID */
1267         int     physid;         /* Current physical IO APIC ID */
1268         io_int *io14;
1269 #endif
1270         int     bus_0 = 0;      /* Stop GCC warning */
1271         int     bus_pci = 0;    /* Stop GCC warning */
1272         int     num_pci_bus;
1273
1274         /*
1275          * Fix mis-numbering of the PCI bus and its INT entries if the BIOS
1276          * did it wrong.  The MP spec says that when more than 1 PCI bus
1277          * exists the BIOS must begin with bus entries for the PCI bus and use
1278          * actual PCI bus numbering.  This implies that when only 1 PCI bus
1279          * exists the BIOS can choose to ignore this ordering, and indeed many
1280          * MP motherboards do ignore it.  This causes a problem when the PCI
1281          * sub-system makes requests of the MP sub-system based on PCI bus
1282          * numbers.     So here we look for the situation and renumber the
1283          * busses and associated INTs in an effort to "make it right".
1284          */
1285
1286         /* find bus 0, PCI bus, count the number of PCI busses */
1287         for (num_pci_bus = 0, x = 0; x < mp_nbusses; ++x) {
1288                 if (bus_data[x].bus_id == 0) {
1289                         bus_0 = x;
1290                 }
1291                 if (bus_data[x].bus_type == PCI) {
1292                         ++num_pci_bus;
1293                         bus_pci = x;
1294                 }
1295         }
1296         /*
1297          * bus_0 == slot of bus with ID of 0
1298          * bus_pci == slot of last PCI bus encountered
1299          */
1300
1301         /* check the 1 PCI bus case for sanity */
1302         /* if it is number 0 all is well */
1303         if (num_pci_bus == 1 &&
1304             bus_data[bus_pci].bus_id != 0) {
1305                 
1306                 /* mis-numbered, swap with whichever bus uses slot 0 */
1307
1308                 /* swap the bus entry types */
1309                 bus_data[bus_pci].bus_type = bus_data[bus_0].bus_type;
1310                 bus_data[bus_0].bus_type = PCI;
1311
1312 #ifdef APIC_IO
1313                 /* swap each relavant INTerrupt entry */
1314                 id = bus_data[bus_pci].bus_id;
1315                 for (x = 0; x < nintrs; ++x) {
1316                         if (io_apic_ints[x].src_bus_id == id) {
1317                                 io_apic_ints[x].src_bus_id = 0;
1318                         }
1319                         else if (io_apic_ints[x].src_bus_id == 0) {
1320                                 io_apic_ints[x].src_bus_id = id;
1321                         }
1322                 }
1323 #endif
1324         }
1325
1326 #ifdef APIC_IO
1327         /* Assign IO APIC IDs.
1328          * 
1329          * First try the existing ID. If a conflict is detected, try
1330          * the ID in the MP table.  If a conflict is still detected, find
1331          * a free id.
1332          *
1333          * We cannot use the ID_TO_IO table before all conflicts has been
1334          * resolved and the table has been corrected.
1335          */
1336         for (apic = 0; apic < mp_napics; ++apic) { /* For all IO APICs */
1337                 
1338                 /* First try to use the value set by the BIOS */
1339                 physid = io_apic_get_id(apic);
1340                 if (io_apic_id_acceptable(apic, physid)) {
1341                         if (IO_TO_ID(apic) != physid)
1342                                 swap_apic_id(apic, IO_TO_ID(apic), physid);
1343                         continue;
1344                 }
1345
1346                 /* Then check if the value in the MP table is acceptable */
1347                 if (io_apic_id_acceptable(apic, IO_TO_ID(apic)))
1348                         continue;
1349
1350                 /* Last resort, find a free APIC ID and use it */
1351                 freeid = first_free_apic_id();
1352                 if (freeid >= NAPICID)
1353                         panic("No free physical APIC IDs found");
1354                 
1355                 if (io_apic_id_acceptable(apic, freeid)) {
1356                         swap_apic_id(apic, IO_TO_ID(apic), freeid);
1357                         continue;
1358                 }
1359                 panic("Free physical APIC ID not usable");
1360         }
1361         fix_id_to_io_mapping();
1362 #endif
1363
1364 #ifdef APIC_IO
1365         /* detect and fix broken Compaq MP table */
1366         if (apic_int_type(0, 0) == -1) {
1367                 kprintf("APIC_IO: MP table broken: 8259->APIC entry missing!\n");
1368                 io_apic_ints[nintrs].int_type = 3;      /* ExtInt */
1369                 io_apic_ints[nintrs].int_vector = 0xff; /* Unassigned */
1370                 /* XXX fixme, set src bus id etc, but it doesn't seem to hurt */
1371                 io_apic_ints[nintrs].dst_apic_id = IO_TO_ID(0);
1372                 io_apic_ints[nintrs].dst_apic_int = 0;  /* Pin 0 */
1373                 nintrs++;
1374         } else if (apic_int_type(0, 0) == 0) {
1375                 kprintf("APIC_IO: MP table broken: ExtINT entry corrupt!\n");
1376                 for (x = 0; x < nintrs; ++x)
1377                         if ((0 == ID_TO_IO(io_apic_ints[x].dst_apic_id)) &&
1378                             (0 == io_apic_ints[x].dst_apic_int)) {
1379                                 io_apic_ints[x].int_type = 3;
1380                                 io_apic_ints[x].int_vector = 0xff;
1381                                 break;
1382                         }
1383         }
1384
1385         /*
1386          * Fix missing IRQ 15 when IRQ 14 is an ISA interrupt.  IDE
1387          * controllers universally come in pairs.  If IRQ 14 is specified
1388          * as an ISA interrupt, then IRQ 15 had better be too.
1389          *
1390          * [ Shuttle XPC / AMD Athlon X2 ]
1391          *      The MPTable is missing an entry for IRQ 15.  Note that the
1392          *      ACPI table has an entry for both 14 and 15.
1393          */
1394         if (apic_int_type(0, 14) == 0 && apic_int_type(0, 15) == -1) {
1395                 kprintf("APIC_IO: MP table broken: IRQ 15 not ISA when IRQ 14 is!\n");
1396                 io14 = io_apic_find_int_entry(0, 14);
1397                 io_apic_ints[nintrs] = *io14;
1398                 io_apic_ints[nintrs].src_bus_irq = 15;
1399                 io_apic_ints[nintrs].dst_apic_int = 15;
1400                 nintrs++;
1401         }
1402 #endif
1403 }
1404
1405 #ifdef APIC_IO
1406
1407 /* Assign low level interrupt handlers */
1408 static void
1409 setup_apic_irq_mapping(void)
1410 {
1411         int     x;
1412         int     int_vector;
1413
1414         /* Clear array */
1415         for (x = 0; x < APIC_INTMAPSIZE; x++) {
1416                 int_to_apicintpin[x].ioapic = -1;
1417                 int_to_apicintpin[x].int_pin = 0;
1418                 int_to_apicintpin[x].apic_address = NULL;
1419                 int_to_apicintpin[x].redirindex = 0;
1420         }
1421
1422         /* First assign ISA/EISA interrupts */
1423         for (x = 0; x < nintrs; x++) {
1424                 int_vector = io_apic_ints[x].src_bus_irq;
1425                 if (int_vector < APIC_INTMAPSIZE &&
1426                     io_apic_ints[x].int_vector == 0xff && 
1427                     int_to_apicintpin[int_vector].ioapic == -1 &&
1428                     (apic_int_is_bus_type(x, ISA) ||
1429                      apic_int_is_bus_type(x, EISA)) &&
1430                     io_apic_ints[x].int_type == 0) {
1431                         assign_apic_irq(ID_TO_IO(io_apic_ints[x].dst_apic_id), 
1432                                         io_apic_ints[x].dst_apic_int,
1433                                         int_vector);
1434                 }
1435         }
1436
1437         /* Assign ExtInt entry if no ISA/EISA interrupt 0 entry */
1438         for (x = 0; x < nintrs; x++) {
1439                 if (io_apic_ints[x].dst_apic_int == 0 &&
1440                     io_apic_ints[x].dst_apic_id == IO_TO_ID(0) &&
1441                     io_apic_ints[x].int_vector == 0xff && 
1442                     int_to_apicintpin[0].ioapic == -1 &&
1443                     io_apic_ints[x].int_type == 3) {
1444                         assign_apic_irq(0, 0, 0);
1445                         break;
1446                 }
1447         }
1448
1449         /* Assign PCI interrupts */
1450         for (x = 0; x < nintrs; ++x) {
1451                 if (io_apic_ints[x].int_type == 0 &&
1452                     io_apic_ints[x].int_vector == 0xff && 
1453                     apic_int_is_bus_type(x, PCI))
1454                         allocate_apic_irq(x);
1455         }
1456 }
1457
1458 #endif
1459
1460 static int
1461 processor_entry(proc_entry_ptr entry, int cpu)
1462 {
1463         /* check for usability */
1464         if (!(entry->cpu_flags & PROCENTRY_FLAG_EN))
1465                 return 0;
1466
1467         if(entry->apic_id >= NAPICID)
1468                 panic("CPU APIC ID out of range (0..%d)", NAPICID - 1);
1469         /* check for BSP flag */
1470         if (entry->cpu_flags & PROCENTRY_FLAG_BP) {
1471                 boot_cpu_id = entry->apic_id;
1472                 CPU_TO_ID(0) = entry->apic_id;
1473                 ID_TO_CPU(entry->apic_id) = 0;
1474                 return 0;       /* its already been counted */
1475         }
1476
1477         /* add another AP to list, if less than max number of CPUs */
1478         else if (cpu < MAXCPU) {
1479                 CPU_TO_ID(cpu) = entry->apic_id;
1480                 ID_TO_CPU(entry->apic_id) = cpu;
1481                 return 1;
1482         }
1483
1484         return 0;
1485 }
1486
1487
1488 static int
1489 bus_entry(bus_entry_ptr entry, int bus)
1490 {
1491         int     x;
1492         char    c, name[8];
1493
1494         /* encode the name into an index */
1495         for (x = 0; x < 6; ++x) {
1496                 if ((c = entry->bus_type[x]) == ' ')
1497                         break;
1498                 name[x] = c;
1499         }
1500         name[x] = '\0';
1501
1502         if ((x = lookup_bus_type(name)) == UNKNOWN_BUSTYPE)
1503                 panic("unknown bus type: '%s'", name);
1504
1505         bus_data[bus].bus_id = entry->bus_id;
1506         bus_data[bus].bus_type = x;
1507
1508         return 1;
1509 }
1510
1511 #ifdef APIC_IO
1512
1513 static int
1514 io_apic_entry(io_apic_entry_ptr entry, int apic)
1515 {
1516         if (!(entry->apic_flags & IOAPICENTRY_FLAG_EN))
1517                 return 0;
1518
1519         IO_TO_ID(apic) = entry->apic_id;
1520         if (entry->apic_id < NAPICID)
1521                 ID_TO_IO(entry->apic_id) = apic;
1522
1523         return 1;
1524 }
1525
1526 #endif
1527
1528 static int
1529 lookup_bus_type(char *name)
1530 {
1531         int     x;
1532
1533         for (x = 0; x < MAX_BUSTYPE; ++x)
1534                 if (strcmp(bus_type_table[x].name, name) == 0)
1535                         return bus_type_table[x].type;
1536
1537         return UNKNOWN_BUSTYPE;
1538 }
1539
1540 #ifdef APIC_IO
1541
1542 static int
1543 int_entry(int_entry_ptr entry, int intr)
1544 {
1545         int apic;
1546
1547         io_apic_ints[intr].int_type = entry->int_type;
1548         io_apic_ints[intr].int_flags = entry->int_flags;
1549         io_apic_ints[intr].src_bus_id = entry->src_bus_id;
1550         io_apic_ints[intr].src_bus_irq = entry->src_bus_irq;
1551         if (entry->dst_apic_id == 255) {
1552                 /* This signal goes to all IO APICS.  Select an IO APIC
1553                    with sufficient number of interrupt pins */
1554                 for (apic = 0; apic < mp_napics; apic++)
1555                         if (((io_apic_read(apic, IOAPIC_VER) & 
1556                               IOART_VER_MAXREDIR) >> MAXREDIRSHIFT) >= 
1557                             entry->dst_apic_int)
1558                                 break;
1559                 if (apic < mp_napics)
1560                         io_apic_ints[intr].dst_apic_id = IO_TO_ID(apic);
1561                 else
1562                         io_apic_ints[intr].dst_apic_id = entry->dst_apic_id;
1563         } else
1564                 io_apic_ints[intr].dst_apic_id = entry->dst_apic_id;
1565         io_apic_ints[intr].dst_apic_int = entry->dst_apic_int;
1566
1567         return 1;
1568 }
1569
1570 static int
1571 apic_int_is_bus_type(int intr, int bus_type)
1572 {
1573         int     bus;
1574
1575         for (bus = 0; bus < mp_nbusses; ++bus)
1576                 if ((bus_data[bus].bus_id == io_apic_ints[intr].src_bus_id)
1577                     && ((int) bus_data[bus].bus_type == bus_type))
1578                         return 1;
1579
1580         return 0;
1581 }
1582
1583 /*
1584  * Given a traditional ISA INT mask, return an APIC mask.
1585  */
1586 u_int
1587 isa_apic_mask(u_int isa_mask)
1588 {
1589         int isa_irq;
1590         int apic_pin;
1591
1592 #if defined(SKIP_IRQ15_REDIRECT)
1593         if (isa_mask == (1 << 15)) {
1594                 kprintf("skipping ISA IRQ15 redirect\n");
1595                 return isa_mask;
1596         }
1597 #endif  /* SKIP_IRQ15_REDIRECT */
1598
1599         isa_irq = ffs(isa_mask);                /* find its bit position */
1600         if (isa_irq == 0)                       /* doesn't exist */
1601                 return 0;
1602         --isa_irq;                              /* make it zero based */
1603
1604         apic_pin = isa_apic_irq(isa_irq);       /* look for APIC connection */
1605         if (apic_pin == -1)
1606                 return 0;
1607
1608         return (1 << apic_pin);                 /* convert pin# to a mask */
1609 }
1610
1611 /*
1612  * Determine which APIC pin an ISA/EISA INT is attached to.
1613  */
1614 #define INTTYPE(I)      (io_apic_ints[(I)].int_type)
1615 #define INTPIN(I)       (io_apic_ints[(I)].dst_apic_int)
1616 #define INTIRQ(I)       (io_apic_ints[(I)].int_vector)
1617 #define INTAPIC(I)      (ID_TO_IO(io_apic_ints[(I)].dst_apic_id))
1618
1619 #define SRCBUSIRQ(I)    (io_apic_ints[(I)].src_bus_irq)
1620 int
1621 isa_apic_irq(int isa_irq)
1622 {
1623         int     intr;
1624
1625         for (intr = 0; intr < nintrs; ++intr) {         /* check each record */
1626                 if (INTTYPE(intr) == 0) {               /* standard INT */
1627                         if (SRCBUSIRQ(intr) == isa_irq) {
1628                                 if (apic_int_is_bus_type(intr, ISA) ||
1629                                     apic_int_is_bus_type(intr, EISA)) {
1630                                         if (INTIRQ(intr) == 0xff)
1631                                                 return -1; /* unassigned */
1632                                         return INTIRQ(intr);    /* found */
1633                                 }
1634                         }
1635                 }
1636         }
1637         return -1;                                      /* NOT found */
1638 }
1639
1640
1641 /*
1642  * Determine which APIC pin a PCI INT is attached to.
1643  */
1644 #define SRCBUSID(I)     (io_apic_ints[(I)].src_bus_id)
1645 #define SRCBUSDEVICE(I) ((io_apic_ints[(I)].src_bus_irq >> 2) & 0x1f)
1646 #define SRCBUSLINE(I)   (io_apic_ints[(I)].src_bus_irq & 0x03)
1647 int
1648 pci_apic_irq(int pciBus, int pciDevice, int pciInt)
1649 {
1650         int     intr;
1651
1652         --pciInt;                                       /* zero based */
1653
1654         for (intr = 0; intr < nintrs; ++intr) {         /* check each record */
1655                 if ((INTTYPE(intr) == 0)                /* standard INT */
1656                     && (SRCBUSID(intr) == pciBus)
1657                     && (SRCBUSDEVICE(intr) == pciDevice)
1658                     && (SRCBUSLINE(intr) == pciInt)) {  /* a candidate IRQ */
1659                         if (apic_int_is_bus_type(intr, PCI)) {
1660                                 if (INTIRQ(intr) == 0xff) {
1661                                         kprintf("IOAPIC: pci_apic_irq() "
1662                                                 "failed\n");
1663                                         return -1;      /* unassigned */
1664                                 }
1665                                 return INTIRQ(intr);    /* exact match */
1666                         }
1667                 }
1668         }
1669
1670         return -1;                                      /* NOT found */
1671 }
1672
1673 int
1674 next_apic_irq(int irq) 
1675 {
1676         int intr, ointr;
1677         int bus, bustype;
1678
1679         bus = 0;
1680         bustype = 0;
1681         for (intr = 0; intr < nintrs; intr++) {
1682                 if (INTIRQ(intr) != irq || INTTYPE(intr) != 0)
1683                         continue;
1684                 bus = SRCBUSID(intr);
1685                 bustype = apic_bus_type(bus);
1686                 if (bustype != ISA &&
1687                     bustype != EISA &&
1688                     bustype != PCI)
1689                         continue;
1690                 break;
1691         }
1692         if (intr >= nintrs) {
1693                 return -1;
1694         }
1695         for (ointr = intr + 1; ointr < nintrs; ointr++) {
1696                 if (INTTYPE(ointr) != 0)
1697                         continue;
1698                 if (bus != SRCBUSID(ointr))
1699                         continue;
1700                 if (bustype == PCI) {
1701                         if (SRCBUSDEVICE(intr) != SRCBUSDEVICE(ointr))
1702                                 continue;
1703                         if (SRCBUSLINE(intr) != SRCBUSLINE(ointr))
1704                                 continue;
1705                 }
1706                 if (bustype == ISA || bustype == EISA) {
1707                         if (SRCBUSIRQ(intr) != SRCBUSIRQ(ointr))
1708                                 continue;
1709                 }
1710                 if (INTPIN(intr) == INTPIN(ointr))
1711                         continue;
1712                 break;
1713         }
1714         if (ointr >= nintrs) {
1715                 return -1;
1716         }
1717         return INTIRQ(ointr);
1718 }
1719 #undef SRCBUSLINE
1720 #undef SRCBUSDEVICE
1721 #undef SRCBUSID
1722 #undef SRCBUSIRQ
1723
1724 #undef INTPIN
1725 #undef INTIRQ
1726 #undef INTAPIC
1727 #undef INTTYPE
1728
1729 #endif
1730
1731 /*
1732  * Reprogram the MB chipset to NOT redirect an ISA INTerrupt.
1733  *
1734  * XXX FIXME:
1735  *  Exactly what this means is unclear at this point.  It is a solution
1736  *  for motherboards that redirect the MBIRQ0 pin.  Generically a motherboard
1737  *  could route any of the ISA INTs to upper (>15) IRQ values.  But most would
1738  *  NOT be redirected via MBIRQ0, thus "undirect()ing" them would NOT be an
1739  *  option.
1740  */
1741 int
1742 undirect_isa_irq(int rirq)
1743 {
1744 #if defined(READY)
1745         if (bootverbose)
1746             kprintf("Freeing redirected ISA irq %d.\n", rirq);
1747         /** FIXME: tickle the MB redirector chip */
1748         return /* XXX */;
1749 #else
1750         if (bootverbose)
1751             kprintf("Freeing (NOT implemented) redirected ISA irq %d.\n", rirq);
1752         return 0;
1753 #endif  /* READY */
1754 }
1755
1756
1757 /*
1758  * Reprogram the MB chipset to NOT redirect a PCI INTerrupt
1759  */
1760 int
1761 undirect_pci_irq(int rirq)
1762 {
1763 #if defined(READY)
1764         if (bootverbose)
1765                 kprintf("Freeing redirected PCI irq %d.\n", rirq);
1766
1767         /** FIXME: tickle the MB redirector chip */
1768         return /* XXX */;
1769 #else
1770         if (bootverbose)
1771                 kprintf("Freeing (NOT implemented) redirected PCI irq %d.\n",
1772                        rirq);
1773         return 0;
1774 #endif  /* READY */
1775 }
1776
1777
1778 /*
1779  * given a bus ID, return:
1780  *  the bus type if found
1781  *  -1 if NOT found
1782  */
1783 int
1784 apic_bus_type(int id)
1785 {
1786         int     x;
1787
1788         for (x = 0; x < mp_nbusses; ++x)
1789                 if (bus_data[x].bus_id == id)
1790                         return bus_data[x].bus_type;
1791
1792         return -1;
1793 }
1794
1795 #ifdef APIC_IO
1796
1797 /*
1798  * given a LOGICAL APIC# and pin#, return:
1799  *  the associated src bus ID if found
1800  *  -1 if NOT found
1801  */
1802 int
1803 apic_src_bus_id(int apic, int pin)
1804 {
1805         int     x;
1806
1807         /* search each of the possible INTerrupt sources */
1808         for (x = 0; x < nintrs; ++x)
1809                 if ((apic == ID_TO_IO(io_apic_ints[x].dst_apic_id)) &&
1810                     (pin == io_apic_ints[x].dst_apic_int))
1811                         return (io_apic_ints[x].src_bus_id);
1812
1813         return -1;              /* NOT found */
1814 }
1815
1816 /*
1817  * given a LOGICAL APIC# and pin#, return:
1818  *  the associated src bus IRQ if found
1819  *  -1 if NOT found
1820  */
1821 int
1822 apic_src_bus_irq(int apic, int pin)
1823 {
1824         int     x;
1825
1826         for (x = 0; x < nintrs; x++)
1827                 if ((apic == ID_TO_IO(io_apic_ints[x].dst_apic_id)) &&
1828                     (pin == io_apic_ints[x].dst_apic_int))
1829                         return (io_apic_ints[x].src_bus_irq);
1830
1831         return -1;              /* NOT found */
1832 }
1833
1834
1835 /*
1836  * given a LOGICAL APIC# and pin#, return:
1837  *  the associated INTerrupt type if found
1838  *  -1 if NOT found
1839  */
1840 int
1841 apic_int_type(int apic, int pin)
1842 {
1843         int     x;
1844
1845         /* search each of the possible INTerrupt sources */
1846         for (x = 0; x < nintrs; ++x) {
1847                 if ((apic == ID_TO_IO(io_apic_ints[x].dst_apic_id)) &&
1848                     (pin == io_apic_ints[x].dst_apic_int))
1849                         return (io_apic_ints[x].int_type);
1850         }
1851         return -1;              /* NOT found */
1852 }
1853
1854 /*
1855  * Return the IRQ associated with an APIC pin
1856  */
1857 int 
1858 apic_irq(int apic, int pin)
1859 {
1860         int x;
1861         int res;
1862
1863         for (x = 0; x < nintrs; ++x) {
1864                 if ((apic == ID_TO_IO(io_apic_ints[x].dst_apic_id)) &&
1865                     (pin == io_apic_ints[x].dst_apic_int)) {
1866                         res = io_apic_ints[x].int_vector;
1867                         if (res == 0xff)
1868                                 return -1;
1869                         if (apic != int_to_apicintpin[res].ioapic)
1870                                 panic("apic_irq: inconsistent table %d/%d", apic, int_to_apicintpin[res].ioapic);
1871                         if (pin != int_to_apicintpin[res].int_pin)
1872                                 panic("apic_irq inconsistent table (2)");
1873                         return res;
1874                 }
1875         }
1876         return -1;
1877 }
1878
1879
1880 /*
1881  * given a LOGICAL APIC# and pin#, return:
1882  *  the associated trigger mode if found
1883  *  -1 if NOT found
1884  */
1885 int
1886 apic_trigger(int apic, int pin)
1887 {
1888         int     x;
1889
1890         /* search each of the possible INTerrupt sources */
1891         for (x = 0; x < nintrs; ++x)
1892                 if ((apic == ID_TO_IO(io_apic_ints[x].dst_apic_id)) &&
1893                     (pin == io_apic_ints[x].dst_apic_int))
1894                         return ((io_apic_ints[x].int_flags >> 2) & 0x03);
1895
1896         return -1;              /* NOT found */
1897 }
1898
1899
1900 /*
1901  * given a LOGICAL APIC# and pin#, return:
1902  *  the associated 'active' level if found
1903  *  -1 if NOT found
1904  */
1905 int
1906 apic_polarity(int apic, int pin)
1907 {
1908         int     x;
1909
1910         /* search each of the possible INTerrupt sources */
1911         for (x = 0; x < nintrs; ++x)
1912                 if ((apic == ID_TO_IO(io_apic_ints[x].dst_apic_id)) &&
1913                     (pin == io_apic_ints[x].dst_apic_int))
1914                         return (io_apic_ints[x].int_flags & 0x03);
1915
1916         return -1;              /* NOT found */
1917 }
1918
1919 #endif
1920
1921 /*
1922  * set data according to MP defaults
1923  * FIXME: probably not complete yet...
1924  */
1925 static void
1926 default_mp_table(int type)
1927 {
1928         int     ap_cpu_id;
1929 #if defined(APIC_IO)
1930         int     io_apic_id;
1931         int     pin;
1932 #endif  /* APIC_IO */
1933
1934 #if 0
1935         kprintf("  MP default config type: %d\n", type);
1936         switch (type) {
1937         case 1:
1938                 kprintf("   bus: ISA, APIC: 82489DX\n");
1939                 break;
1940         case 2:
1941                 kprintf("   bus: EISA, APIC: 82489DX\n");
1942                 break;
1943         case 3:
1944                 kprintf("   bus: EISA, APIC: 82489DX\n");
1945                 break;
1946         case 4:
1947                 kprintf("   bus: MCA, APIC: 82489DX\n");
1948                 break;
1949         case 5:
1950                 kprintf("   bus: ISA+PCI, APIC: Integrated\n");
1951                 break;
1952         case 6:
1953                 kprintf("   bus: EISA+PCI, APIC: Integrated\n");
1954                 break;
1955         case 7:
1956                 kprintf("   bus: MCA+PCI, APIC: Integrated\n");
1957                 break;
1958         default:
1959                 kprintf("   future type\n");
1960                 break;
1961                 /* NOTREACHED */
1962         }
1963 #endif  /* 0 */
1964
1965         boot_cpu_id = (lapic->id & APIC_ID_MASK) >> 24;
1966         ap_cpu_id = (boot_cpu_id == 0) ? 1 : 0;
1967
1968         /* BSP */
1969         CPU_TO_ID(0) = boot_cpu_id;
1970         ID_TO_CPU(boot_cpu_id) = 0;
1971
1972         /* one and only AP */
1973         CPU_TO_ID(1) = ap_cpu_id;
1974         ID_TO_CPU(ap_cpu_id) = 1;
1975
1976 #if defined(APIC_IO)
1977         /* one and only IO APIC */
1978         io_apic_id = (io_apic_read(0, IOAPIC_ID) & APIC_ID_MASK) >> 24;
1979
1980         /*
1981          * sanity check, refer to MP spec section 3.6.6, last paragraph
1982          * necessary as some hardware isn't properly setting up the IO APIC
1983          */
1984 #if defined(REALLY_ANAL_IOAPICID_VALUE)
1985         if (io_apic_id != 2) {
1986 #else
1987         if ((io_apic_id == 0) || (io_apic_id == 1) || (io_apic_id == 15)) {
1988 #endif  /* REALLY_ANAL_IOAPICID_VALUE */
1989                 io_apic_set_id(0, 2);
1990                 io_apic_id = 2;
1991         }
1992         IO_TO_ID(0) = io_apic_id;
1993         ID_TO_IO(io_apic_id) = 0;
1994 #endif  /* APIC_IO */
1995
1996         /* fill out bus entries */
1997         switch (type) {
1998         case 1:
1999         case 2:
2000         case 3:
2001         case 4:
2002         case 5:
2003         case 6:
2004         case 7:
2005                 bus_data[0].bus_id = default_data[type - 1][1];
2006                 bus_data[0].bus_type = default_data[type - 1][2];
2007                 bus_data[1].bus_id = default_data[type - 1][3];
2008                 bus_data[1].bus_type = default_data[type - 1][4];
2009                 break;
2010
2011         /* case 4: case 7:                 MCA NOT supported */
2012         default:                /* illegal/reserved */
2013                 panic("BAD default MP config: %d", type);
2014                 /* NOTREACHED */
2015         }
2016
2017 #if defined(APIC_IO)
2018         /* general cases from MP v1.4, table 5-2 */
2019         for (pin = 0; pin < 16; ++pin) {
2020                 io_apic_ints[pin].int_type = 0;
2021                 io_apic_ints[pin].int_flags = 0x05;     /* edge/active-hi */
2022                 io_apic_ints[pin].src_bus_id = 0;
2023                 io_apic_ints[pin].src_bus_irq = pin;    /* IRQ2 caught below */
2024                 io_apic_ints[pin].dst_apic_id = io_apic_id;
2025                 io_apic_ints[pin].dst_apic_int = pin;   /* 1-to-1 */
2026         }
2027
2028         /* special cases from MP v1.4, table 5-2 */
2029         if (type == 2) {
2030                 io_apic_ints[2].int_type = 0xff;        /* N/C */
2031                 io_apic_ints[13].int_type = 0xff;       /* N/C */
2032 #if !defined(APIC_MIXED_MODE)
2033                 /** FIXME: ??? */
2034                 panic("sorry, can't support type 2 default yet");
2035 #endif  /* APIC_MIXED_MODE */
2036         }
2037         else
2038                 io_apic_ints[2].src_bus_irq = 0;        /* ISA IRQ0 is on APIC INT 2 */
2039
2040         if (type == 7)
2041                 io_apic_ints[0].int_type = 0xff;        /* N/C */
2042         else
2043                 io_apic_ints[0].int_type = 3;   /* vectored 8259 */
2044 #endif  /* APIC_IO */
2045 }
2046
2047 /*
2048  * Map a physical memory address representing I/O into KVA.  The I/O
2049  * block is assumed not to cross a page boundary.
2050  */
2051 void *
2052 permanent_io_mapping(vm_paddr_t pa)
2053 {
2054         KKASSERT(pa < 0x100000000LL);
2055
2056         return pmap_mapdev_uncacheable(pa, PAGE_SIZE);
2057 }
2058
2059 /*
2060  * start each AP in our list
2061  */
2062 static int
2063 start_all_aps(u_int boot_addr)
2064 {
2065         vm_offset_t va = boot_address + KERNBASE;
2066         u_int64_t *pt4, *pt3, *pt2;
2067         int     x, i, pg;
2068         int     shift;
2069         u_char  mpbiosreason;
2070         u_long  mpbioswarmvec;
2071         struct mdglobaldata *gd;
2072         struct privatespace *ps;
2073
2074         POSTCODE(START_ALL_APS_POST);
2075
2076         /* Initialize BSP's local APIC */
2077         apic_initialize(TRUE);
2078         bsp_apic_ready = 1;
2079
2080         /* install the AP 1st level boot code */
2081         pmap_kenter(va, boot_address);
2082         cpu_invlpg((void *)va);         /* JG XXX */
2083         bcopy(mptramp_start, (void *)va, bootMP_size);
2084
2085         /* Locate the page tables, they'll be below the trampoline */
2086         pt4 = (u_int64_t *)(uintptr_t)(mptramp_pagetables + KERNBASE);
2087         pt3 = pt4 + (PAGE_SIZE) / sizeof(u_int64_t);
2088         pt2 = pt3 + (PAGE_SIZE) / sizeof(u_int64_t);
2089
2090         /* Create the initial 1GB replicated page tables */
2091         for (i = 0; i < 512; i++) {
2092                 /* Each slot of the level 4 pages points to the same level 3 page */
2093                 pt4[i] = (u_int64_t)(uintptr_t)(mptramp_pagetables + PAGE_SIZE);
2094                 pt4[i] |= PG_V | PG_RW | PG_U;
2095
2096                 /* Each slot of the level 3 pages points to the same level 2 page */
2097                 pt3[i] = (u_int64_t)(uintptr_t)(mptramp_pagetables + (2 * PAGE_SIZE));
2098                 pt3[i] |= PG_V | PG_RW | PG_U;
2099
2100                 /* The level 2 page slots are mapped with 2MB pages for 1GB. */
2101                 pt2[i] = i * (2 * 1024 * 1024);
2102                 pt2[i] |= PG_V | PG_RW | PG_PS | PG_U;
2103         }
2104
2105         /* save the current value of the warm-start vector */
2106         mpbioswarmvec = *((u_int32_t *) WARMBOOT_OFF);
2107         outb(CMOS_REG, BIOS_RESET);
2108         mpbiosreason = inb(CMOS_DATA);
2109
2110         /* setup a vector to our boot code */
2111         *((volatile u_short *) WARMBOOT_OFF) = WARMBOOT_TARGET;
2112         *((volatile u_short *) WARMBOOT_SEG) = (boot_address >> 4);
2113         outb(CMOS_REG, BIOS_RESET);
2114         outb(CMOS_DATA, BIOS_WARM);     /* 'warm-start' */
2115
2116         /* start each AP */
2117         for (x = 1; x <= mp_naps; ++x) {
2118
2119                 /* This is a bit verbose, it will go away soon.  */
2120
2121                 /* first page of AP's private space */
2122                 pg = x * x86_64_btop(sizeof(struct privatespace));
2123
2124                 /* allocate new private data page(s) */
2125                 gd = (struct mdglobaldata *)kmem_alloc(&kernel_map, 
2126                                 MDGLOBALDATA_BASEALLOC_SIZE);
2127
2128                 gd = &CPU_prvspace[x].mdglobaldata;     /* official location */
2129                 bzero(gd, sizeof(*gd));
2130                 gd->mi.gd_prvspace = ps = &CPU_prvspace[x];
2131
2132                 /* prime data page for it to use */
2133                 mi_gdinit(&gd->mi, x);
2134                 cpu_gdinit(gd, x);
2135                 gd->gd_CMAP1 = &SMPpt[pg + 0];
2136                 gd->gd_CMAP2 = &SMPpt[pg + 1];
2137                 gd->gd_CMAP3 = &SMPpt[pg + 2];
2138                 gd->gd_PMAP1 = &SMPpt[pg + 3];
2139                 gd->gd_CADDR1 = ps->CPAGE1;
2140                 gd->gd_CADDR2 = ps->CPAGE2;
2141                 gd->gd_CADDR3 = ps->CPAGE3;
2142                 gd->gd_PADDR1 = (pt_entry_t *)ps->PPAGE1;
2143                 gd->mi.gd_ipiq = (void *)kmem_alloc(&kernel_map, sizeof(lwkt_ipiq) * (mp_naps + 1));
2144                 bzero(gd->mi.gd_ipiq, sizeof(lwkt_ipiq) * (mp_naps + 1));
2145
2146                 /* setup a vector to our boot code */
2147                 *((volatile u_short *) WARMBOOT_OFF) = WARMBOOT_TARGET;
2148                 *((volatile u_short *) WARMBOOT_SEG) = (boot_addr >> 4);
2149                 outb(CMOS_REG, BIOS_RESET);
2150                 outb(CMOS_DATA, BIOS_WARM);     /* 'warm-start' */
2151
2152                 /*
2153                  * Setup the AP boot stack
2154                  */
2155                 bootSTK = &ps->idlestack[UPAGES*PAGE_SIZE/2];
2156                 bootAP = x;
2157
2158                 /* attempt to start the Application Processor */
2159                 CHECK_INIT(99); /* setup checkpoints */
2160                 if (!start_ap(gd, boot_addr)) {
2161                         kprintf("AP #%d (PHY# %d) failed!\n", x, CPU_TO_ID(x));
2162                         CHECK_PRINT("trace");   /* show checkpoints */
2163                         /* better panic as the AP may be running loose */
2164                         kprintf("panic y/n? [y] ");
2165                         if (cngetc() != 'n')
2166                                 panic("bye-bye");
2167                 }
2168                 CHECK_PRINT("trace");           /* show checkpoints */
2169
2170                 /* record its version info */
2171                 cpu_apic_versions[x] = cpu_apic_versions[0];
2172         }
2173
2174         /* set ncpus to 1 + highest logical cpu.  Not all may have come up */
2175         ncpus = x;
2176
2177         /* ncpus2 -- ncpus rounded down to the nearest power of 2 */
2178         for (shift = 0; (1 << shift) <= ncpus; ++shift)
2179                 ;
2180         --shift;
2181         ncpus2_shift = shift;
2182         ncpus2 = 1 << shift;
2183         ncpus2_mask = ncpus2 - 1;
2184
2185         /* ncpus_fit -- ncpus rounded up to the nearest power of 2 */
2186         if ((1 << shift) < ncpus)
2187                 ++shift;
2188         ncpus_fit = 1 << shift;
2189         ncpus_fit_mask = ncpus_fit - 1;
2190
2191         /* build our map of 'other' CPUs */
2192         mycpu->gd_other_cpus = smp_startup_mask & ~(1 << mycpu->gd_cpuid);
2193         mycpu->gd_ipiq = (void *)kmem_alloc(&kernel_map, sizeof(lwkt_ipiq) * ncpus);
2194         bzero(mycpu->gd_ipiq, sizeof(lwkt_ipiq) * ncpus);
2195
2196         /* fill in our (BSP) APIC version */
2197         cpu_apic_versions[0] = lapic->version;
2198
2199         /* restore the warmstart vector */
2200         *(u_long *) WARMBOOT_OFF = mpbioswarmvec;
2201         outb(CMOS_REG, BIOS_RESET);
2202         outb(CMOS_DATA, mpbiosreason);
2203
2204         /*
2205          * NOTE!  The idlestack for the BSP was setup by locore.  Finish
2206          * up, clean out the P==V mapping we did earlier.
2207          */
2208 #if JGXXX
2209         for (x = 0; x < NKPT; x++)
2210                 PTD[x] = 0;
2211 #endif
2212         pmap_set_opt();
2213
2214         /* number of APs actually started */
2215         return ncpus - 1;
2216 }
2217
2218
2219 /*
2220  * load the 1st level AP boot code into base memory.
2221  */
2222
2223 /* targets for relocation */
2224 extern void bigJump(void);
2225 extern void bootCodeSeg(void);
2226 extern void bootDataSeg(void);
2227 extern void MPentry(void);
2228 extern u_int MP_GDT;
2229 extern u_int mp_gdtbase;
2230
2231 #if 0
2232
2233 static void
2234 install_ap_tramp(u_int boot_addr)
2235 {
2236         int     x;
2237         int     size = *(int *) ((u_long) & bootMP_size);
2238         u_char *src = (u_char *) ((u_long) bootMP);
2239         u_char *dst = (u_char *) boot_addr + KERNBASE;
2240         u_int   boot_base = (u_int) bootMP;
2241         u_int8_t *dst8;
2242         u_int16_t *dst16;
2243         u_int32_t *dst32;
2244
2245         POSTCODE(INSTALL_AP_TRAMP_POST);
2246
2247         for (x = 0; x < size; ++x)
2248                 *dst++ = *src++;
2249
2250         /*
2251          * modify addresses in code we just moved to basemem. unfortunately we
2252          * need fairly detailed info about mpboot.s for this to work.  changes
2253          * to mpboot.s might require changes here.
2254          */
2255
2256         /* boot code is located in KERNEL space */
2257         dst = (u_char *) boot_addr + KERNBASE;
2258
2259         /* modify the lgdt arg */
2260         dst32 = (u_int32_t *) (dst + ((u_int) & mp_gdtbase - boot_base));
2261         *dst32 = boot_addr + ((u_int) & MP_GDT - boot_base);
2262
2263         /* modify the ljmp target for MPentry() */
2264         dst32 = (u_int32_t *) (dst + ((u_int) bigJump - boot_base) + 1);
2265         *dst32 = ((u_int) MPentry - KERNBASE);
2266
2267         /* modify the target for boot code segment */
2268         dst16 = (u_int16_t *) (dst + ((u_int) bootCodeSeg - boot_base));
2269         dst8 = (u_int8_t *) (dst16 + 1);
2270         *dst16 = (u_int) boot_addr & 0xffff;
2271         *dst8 = ((u_int) boot_addr >> 16) & 0xff;
2272
2273         /* modify the target for boot data segment */
2274         dst16 = (u_int16_t *) (dst + ((u_int) bootDataSeg - boot_base));
2275         dst8 = (u_int8_t *) (dst16 + 1);
2276         *dst16 = (u_int) boot_addr & 0xffff;
2277         *dst8 = ((u_int) boot_addr >> 16) & 0xff;
2278 }
2279
2280 #endif
2281
2282 /*
2283  * this function starts the AP (application processor) identified
2284  * by the APIC ID 'physicalCpu'.  It does quite a "song and dance"
2285  * to accomplish this.  This is necessary because of the nuances
2286  * of the different hardware we might encounter.  It ain't pretty,
2287  * but it seems to work.
2288  *
2289  * NOTE: eventually an AP gets to ap_init(), which is called just 
2290  * before the AP goes into the LWKT scheduler's idle loop.
2291  */
2292 static int
2293 start_ap(struct mdglobaldata *gd, u_int boot_addr)
2294 {
2295         int     physical_cpu;
2296         int     vector;
2297         u_long  icr_lo, icr_hi;
2298
2299         POSTCODE(START_AP_POST);
2300
2301         /* get the PHYSICAL APIC ID# */
2302         physical_cpu = CPU_TO_ID(gd->mi.gd_cpuid);
2303
2304         /* calculate the vector */
2305         vector = (boot_addr >> 12) & 0xff;
2306
2307         /* Make sure the target cpu sees everything */
2308         wbinvd();
2309
2310         /*
2311          * first we do an INIT/RESET IPI this INIT IPI might be run, reseting
2312          * and running the target CPU. OR this INIT IPI might be latched (P5
2313          * bug), CPU waiting for STARTUP IPI. OR this INIT IPI might be
2314          * ignored.
2315          */
2316
2317         /* setup the address for the target AP */
2318         icr_hi = lapic->icr_hi & ~APIC_ID_MASK;
2319         icr_hi |= (physical_cpu << 24);
2320         lapic->icr_hi = icr_hi;
2321
2322         /* do an INIT IPI: assert RESET */
2323         icr_lo = lapic->icr_lo & 0xfff00000;
2324         lapic->icr_lo = icr_lo | 0x0000c500;
2325
2326         /* wait for pending status end */
2327         while (lapic->icr_lo & APIC_DELSTAT_MASK)
2328                  /* spin */ ;
2329
2330         /* do an INIT IPI: deassert RESET */
2331         lapic->icr_lo = icr_lo | 0x00008500;
2332
2333         /* wait for pending status end */
2334         u_sleep(10000);         /* wait ~10mS */
2335         while (lapic->icr_lo & APIC_DELSTAT_MASK)
2336                  /* spin */ ;
2337
2338         /*
2339          * next we do a STARTUP IPI: the previous INIT IPI might still be
2340          * latched, (P5 bug) this 1st STARTUP would then terminate
2341          * immediately, and the previously started INIT IPI would continue. OR
2342          * the previous INIT IPI has already run. and this STARTUP IPI will
2343          * run. OR the previous INIT IPI was ignored. and this STARTUP IPI
2344          * will run.
2345          */
2346
2347         /* do a STARTUP IPI */
2348         lapic->icr_lo = icr_lo | 0x00000600 | vector;
2349         while (lapic->icr_lo & APIC_DELSTAT_MASK)
2350                  /* spin */ ;
2351         u_sleep(200);           /* wait ~200uS */
2352
2353         /*
2354          * finally we do a 2nd STARTUP IPI: this 2nd STARTUP IPI should run IF
2355          * the previous STARTUP IPI was cancelled by a latched INIT IPI. OR
2356          * this STARTUP IPI will be ignored, as only ONE STARTUP IPI is
2357          * recognized after hardware RESET or INIT IPI.
2358          */
2359
2360         lapic->icr_lo = icr_lo | 0x00000600 | vector;
2361         while (lapic->icr_lo & APIC_DELSTAT_MASK)
2362                  /* spin */ ;
2363         u_sleep(200);           /* wait ~200uS */
2364
2365         /* wait for it to start, see ap_init() */
2366         set_apic_timer(5000000);/* == 5 seconds */
2367         while (read_apic_timer()) {
2368                 if (smp_startup_mask & (1 << gd->mi.gd_cpuid))
2369                         return 1;       /* return SUCCESS */
2370         }
2371         return 0;               /* return FAILURE */
2372 }
2373
2374
2375 /*
2376  * Lazy flush the TLB on all other CPU's.  DEPRECATED.
2377  *
2378  * If for some reason we were unable to start all cpus we cannot safely
2379  * use broadcast IPIs.
2380  */
2381 void
2382 smp_invltlb(void)
2383 {
2384 #ifdef SMP
2385         if (smp_startup_mask == smp_active_mask) {
2386                 all_but_self_ipi(XINVLTLB_OFFSET);
2387         } else {
2388                 selected_apic_ipi(smp_active_mask, XINVLTLB_OFFSET,
2389                         APIC_DELMODE_FIXED);
2390         }
2391 #endif
2392 }
2393
2394 /*
2395  * When called the executing CPU will send an IPI to all other CPUs
2396  *  requesting that they halt execution.
2397  *
2398  * Usually (but not necessarily) called with 'other_cpus' as its arg.
2399  *
2400  *  - Signals all CPUs in map to stop.
2401  *  - Waits for each to stop.
2402  *
2403  * Returns:
2404  *  -1: error
2405  *   0: NA
2406  *   1: ok
2407  *
2408  * XXX FIXME: this is not MP-safe, needs a lock to prevent multiple CPUs
2409  *            from executing at same time.
2410  */
2411 int
2412 stop_cpus(u_int map)
2413 {
2414         map &= smp_active_mask;
2415
2416         /* send the Xcpustop IPI to all CPUs in map */
2417         selected_apic_ipi(map, XCPUSTOP_OFFSET, APIC_DELMODE_FIXED);
2418         
2419         while ((stopped_cpus & map) != map)
2420                 /* spin */ ;
2421
2422         return 1;
2423 }
2424
2425
2426 /*
2427  * Called by a CPU to restart stopped CPUs. 
2428  *
2429  * Usually (but not necessarily) called with 'stopped_cpus' as its arg.
2430  *
2431  *  - Signals all CPUs in map to restart.
2432  *  - Waits for each to restart.
2433  *
2434  * Returns:
2435  *  -1: error
2436  *   0: NA
2437  *   1: ok
2438  */
2439 int
2440 restart_cpus(u_int map)
2441 {
2442         /* signal other cpus to restart */
2443         started_cpus = map & smp_active_mask;
2444
2445         while ((stopped_cpus & map) != 0) /* wait for each to clear its bit */
2446                 /* spin */ ;
2447
2448         return 1;
2449 }
2450
2451 /*
2452  * This is called once the mpboot code has gotten us properly relocated
2453  * and the MMU turned on, etc.   ap_init() is actually the idle thread,
2454  * and when it returns the scheduler will call the real cpu_idle() main
2455  * loop for the idlethread.  Interrupts are disabled on entry and should
2456  * remain disabled at return.
2457  */
2458 void
2459 ap_init(void)
2460 {
2461         u_int   apic_id;
2462
2463         /*
2464          * Adjust smp_startup_mask to signal the BSP that we have started
2465          * up successfully.  Note that we do not yet hold the BGL.  The BSP
2466          * is waiting for our signal.
2467          *
2468          * We can't set our bit in smp_active_mask yet because we are holding
2469          * interrupts physically disabled and remote cpus could deadlock
2470          * trying to send us an IPI.
2471          */
2472         smp_startup_mask |= 1 << mycpu->gd_cpuid;
2473         cpu_mfence();
2474
2475         /*
2476          * Interlock for finalization.  Wait until mp_finish is non-zero,
2477          * then get the MP lock.
2478          *
2479          * Note: We are in a critical section.
2480          *
2481          * Note: We have to synchronize td_mpcount to our desired MP state
2482          * before calling cpu_try_mplock().
2483          *
2484          * Note: we are the idle thread, we can only spin.
2485          *
2486          * Note: The load fence is memory volatile and prevents the compiler
2487          * from improperly caching mp_finish, and the cpu from improperly
2488          * caching it.
2489          */
2490         while (mp_finish == 0)
2491             cpu_lfence();
2492         ++curthread->td_mpcount;
2493         while (cpu_try_mplock() == 0)
2494             ;
2495
2496         if (cpu_feature & CPUID_TSC) {
2497             /*
2498              * The BSP is constantly updating tsc0_offset, figure out the
2499              * relative difference to synchronize ktrdump.
2500              */
2501             tsc_offsets[mycpu->gd_cpuid] = rdtsc() - tsc0_offset;
2502         }
2503
2504         /* BSP may have changed PTD while we're waiting for the lock */
2505         cpu_invltlb();
2506
2507 #if defined(I586_CPU) && !defined(NO_F00F_HACK)
2508         lidt(&r_idt);
2509 #endif
2510
2511         /* Build our map of 'other' CPUs. */
2512         mycpu->gd_other_cpus = smp_startup_mask & ~(1 << mycpu->gd_cpuid);
2513
2514         kprintf("SMP: AP CPU #%d Launched!\n", mycpu->gd_cpuid);
2515
2516         /* A quick check from sanity claus */
2517         apic_id = (apic_id_to_logical[(lapic->id & 0x0f000000) >> 24]);
2518         if (mycpu->gd_cpuid != apic_id) {
2519                 kprintf("SMP: cpuid = %d\n", mycpu->gd_cpuid);
2520                 kprintf("SMP: apic_id = %d\n", apic_id);
2521 #if JGXXX
2522                 kprintf("PTD[MPPTDI] = %p\n", (void *)PTD[MPPTDI]);
2523 #endif
2524                 panic("cpuid mismatch! boom!!");
2525         }
2526
2527         /* Initialize AP's local APIC for irq's */
2528         apic_initialize(FALSE);
2529
2530         /* Set memory range attributes for this CPU to match the BSP */
2531         mem_range_AP_init();
2532
2533         /*
2534          * Once we go active we must process any IPIQ messages that may
2535          * have been queued, because no actual IPI will occur until we
2536          * set our bit in the smp_active_mask.  If we don't the IPI
2537          * message interlock could be left set which would also prevent
2538          * further IPIs.
2539          *
2540          * The idle loop doesn't expect the BGL to be held and while
2541          * lwkt_switch() normally cleans things up this is a special case
2542          * because we returning almost directly into the idle loop.
2543          *
2544          * The idle thread is never placed on the runq, make sure
2545          * nothing we've done put it there.
2546          */
2547         KKASSERT(curthread->td_mpcount == 1);
2548         smp_active_mask |= 1 << mycpu->gd_cpuid;
2549
2550         /*
2551          * Enable interrupts here.  idle_restore will also do it, but
2552          * doing it here lets us clean up any strays that got posted to
2553          * the CPU during the AP boot while we are still in a critical
2554          * section.
2555          */
2556         __asm __volatile("sti; pause; pause"::);
2557         mdcpu->gd_fpending = 0;
2558
2559         initclocks_pcpu();      /* clock interrupts (via IPIs) */
2560         lwkt_process_ipiq();
2561
2562         /*
2563          * Releasing the mp lock lets the BSP finish up the SMP init
2564          */
2565         rel_mplock();
2566         KKASSERT((curthread->td_flags & TDF_RUNQ) == 0);
2567 }
2568
2569 /*
2570  * Get SMP fully working before we start initializing devices.
2571  */
2572 static
2573 void
2574 ap_finish(void)
2575 {
2576         mp_finish = 1;
2577         if (bootverbose)
2578                 kprintf("Finish MP startup\n");
2579         if (cpu_feature & CPUID_TSC)
2580                 tsc0_offset = rdtsc();
2581         tsc_offsets[0] = 0;
2582         rel_mplock();
2583         while (smp_active_mask != smp_startup_mask) {
2584                 cpu_lfence();
2585                 if (cpu_feature & CPUID_TSC)
2586                         tsc0_offset = rdtsc();
2587         }
2588         while (try_mplock() == 0)
2589                 ;
2590         if (bootverbose)
2591                 kprintf("Active CPU Mask: %08x\n", smp_active_mask);
2592 }
2593
2594 SYSINIT(finishsmp, SI_BOOT2_FINISH_SMP, SI_ORDER_FIRST, ap_finish, NULL)
2595
2596 void
2597 cpu_send_ipiq(int dcpu)
2598 {
2599         if ((1 << dcpu) & smp_active_mask)
2600                 single_apic_ipi(dcpu, XIPIQ_OFFSET, APIC_DELMODE_FIXED);
2601 }
2602
2603 #if 0   /* single_apic_ipi_passive() not working yet */
2604 /*
2605  * Returns 0 on failure, 1 on success
2606  */
2607 int
2608 cpu_send_ipiq_passive(int dcpu)
2609 {
2610         int r = 0;
2611         if ((1 << dcpu) & smp_active_mask) {
2612                 r = single_apic_ipi_passive(dcpu, XIPIQ_OFFSET,
2613                                         APIC_DELMODE_FIXED);
2614         }
2615         return(r);
2616 }
2617 #endif
2618