x86: Maps in the full LAPIC and IOAPIC size (XCC)
[akaros.git] / kern / arch / x86 / ros / mmu64.h
1 #ifndef ROS_INC_ARCH_MMU64_H
2 #define ROS_INC_ARCH_MMU64_H
3
4 #ifndef ROS_INC_ARCH_MMU_H
5 #error "Do not include include ros/arch/mmu64.h directly"
6 #endif
7
8 #ifndef __ASSEMBLER__
9 #include <ros/common.h>
10 typedef unsigned long pte_t;
11 typedef unsigned long pde_t;
12 #endif
13
14 /* Virtual memory map:                                  Virt Addresses
15  *                                                      perms: kernel/user
16  *
17  *                     +------------------------------+ 0xffffffffffffffff -+
18  *                     |                              |                     |
19  *                     |   Mapped to lowmem, unused   | RW/--               |
20  *                     |                              |                     |
21  *  "end" symbol  -->  +------------------------------+        PML3_PTE_REACH
22  *                     |                              |                     |
23  *                     |  Kernel link/load location   |                     |
24  *                     |    (mapped to 0, physical)   |                     |
25  *                     |                              |                     |
26  * KERN_LOAD_ADDR -->  +------------------------------+ 0xffffffffc0000000 -+
27  *                     |                              |
28  *                     |          Local APIC          | RW/--  APIC_SIZE (1MB)
29  *                     |                              |
30  *    LAPIC_BASE  -->  +------------------------------+ 0xffffffffbff00000
31  *                     |                              |
32  *                     |            IOAPIC            | RW/--  APIC_SIZE (1MB)
33  *                     |                              |
34  *  IOAPIC_BASE,  -->  +------------------------------+ 0xffffffffbfe00000
35  *  KERN_DYN_TOP       |   Kernel Dynamic Mappings    |
36  *                     |              .               |
37  *                     :              .               :
38  *                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RW/--
39  *                     :                              :
40  *                     |          Unmapped            | --/--
41  *                     |                              |
42  *                     |  Kernel static linking limit |
43  *                     +------------------------------+ 0xffffffff80000000
44  *                     |                              |
45  *                     |                              |
46  *                     |                              |
47  *  VPT_TOP    ----->  +------------------------------+ 0xffffff0000000000 -+
48  *                     |                              |                     |
49  *                     |                              |                     |
50  *                     |  Cur. Page Table (Kern. RW)  | RW/--  P4ML_PTE_REACH
51  *                     |                              |                     |
52  *                     |                              |                     |
53  *    VPT,     ----->  +------------------------------+ 0xfffffe8000000000 -+
54  *  KERN_VMAP_TOP      |                              |
55  *                     :              .               :
56  *                     :              .               :
57  *                     :              .               :
58  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| RW/--
59  *                     |                              | RW/--
60  *                     |                              | RW/--
61  *                     |                              | RW/--
62  *                     |   Remapped Physical Memory   | RW/--
63  *                     |                              | RW/--
64  *                     |                              | RW/--
65  *                     |                              | RW/--
66  *    KERNBASE  ---->  +------------------------------+ 0xffff800000000000
67  *                     |                              |
68  *                     |                              |
69  *                     |                              |
70  *                     |   Non-canonical addresses    |
71  *                     |         (unusable)           |
72  *                     |                              |
73  *                     |                              |
74  * ULIM (not canon) -> +------------------------------+ 0x0000800000000000 -+
75  *                     +     Highest user address     + 0x00007fffffffffff  |
76  *                     |                              |                     |
77  *                     |  Cur. Page Table (User R-)   | R-/R-  PML4_PTE_REACH
78  *                     |                              |                     |
79  *    UVPT      ---->  +------------------------------+ 0x00007f8000000000 -+
80  *                     | Unmapped (expandable region) |                     |
81  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|                     |
82  *                     |     Per-Process R/O Info     | R-/R-  PML2_PTE_REACH
83  *                     |         (procinfo)           |                     |
84  * UWLIM, UINFO ---->  +------------------------------+ 0x00007f7fffe00000 -+
85  *                     | Unmapped (expandable region) |                     |
86  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|                     |
87  *                     |     Per-Process R/W Data     | RW/RW  PML2_PTE_REACH
88  *                     |         (procdata)           |                     |
89  *    UDATA     ---->  +------------------------------+ 0x00007f7fffc00000 -+
90  *                     |                              |
91  *                     |    Global Shared R/W Data    | RW/RW  PGSIZE
92  *                     |                              |
93  * UMAPTOP, UGDATA ->  +------------------------------+ 0x00007f7fffbff000
94  *    USTACKTOP        |                              |
95  *                     |      Normal User Stack       | RW/RW 256 * PGSIZE
96  *                     |                              |
97  *                     +------------------------------+ 0x00007f7fffaff000
98  *                     |                              |
99  *                     |        Empty Memory          |
100  *                     |                              |
101  *                     .                              .
102  *                     .                              .
103  *    BRK_END   ---->  +------------------------------+ 0x0000400000000000
104  *                     .                              .
105  *                     .                              .
106  *                     |                              |
107  *                     |        Empty Memory          |
108  *                     |                              |
109  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|
110  *                     |                              |
111  *                     |     Program Data & Heap      |
112  *                     |                              |
113  *                     +------------------------------+ 0x0000000000400000
114  *                     |                              |
115  *                     |       Empty Memory (*)       |
116  *                     |                              |
117  *                     +------------------------------+ 0x0000000000000000
118  */
119
120 /* Physical Mapping symbols:
121  * At IOPHYSMEM (640K) there is a 384K hole for I/O.  From the kernel,
122  * IOPHYSMEM can be addressed at KERNBASE + IOPHYSMEM.  The hole ends
123  * at physical address EXTPHYSMEM. */
124 #define IOPHYSMEM               0x0A0000
125 #define VGAPHYSMEM              0x0A0000
126 #define DEVPHYSMEM              0x0C0000
127 #define BIOSPHYSMEM             0x0F0000
128 #define EXTPHYSMEM              0x100000
129
130 /* Kernel Virtual Memory Mapping */
131
132 /* The kernel needs to be loaded in the top 2 GB of memory, since we compile it
133  * with -mcmodel=kernel (helps with relocations).  We're actually loading it in
134  * the top 1 GB. */
135 #define KERN_LOAD_ADDR  0xffffffffc0000000
136 /* Static kernel mappings */
137 #define APIC_SIZE               0x100000
138 #define LAPIC_BASE              (KERN_LOAD_ADDR - APIC_SIZE)
139 #define IOAPIC_BASE             (LAPIC_BASE - APIC_SIZE)
140 /* All arches must define this, which is the lower limit of their static
141  * mappings, and where the dynamic mappings will start. */
142 #define KERN_DYN_TOP    IOAPIC_BASE
143
144 /* Virtual page table.  Every PML4 has a PTE at the slot (PML4(VPT))
145  * corresponding to VPT that points to that PML4's base.  In essence, the 512
146  * GB chunk of the VA space from VPT..VPT_TOP is a window into the paging
147  * structure.
148  *
149  * The VPT needs to be aligned on 39 bits.
150  *
151  * Ex: Say the VPT's entry in 9 bits is "9v".  If you construct a VA from:
152  * 9v9v9v9v000, the paging hardware will recurse 4 times, with the end result
153  * being the PML4.  That virtual address will map to the PML4 itself.
154  *
155  * If you want to see a specific PML3, figure out which entry it is in the
156  * PML4 (using PML3(va)), say 9 bits = "9X".  The VA 9v9v9v9X000 will map to
157  * that PML3. */
158 #define VPT_TOP                 0xffffff0000000000
159 #define VPT                             (VPT_TOP - PML4_PTE_REACH)
160 /* Helper to return the current outer pgdir via the VPT mapping. */
161 #define VPD (VPT + ((VPT & 0x0000ffffffffffff) >> 9) +                         \
162                    ((VPT & 0x0000ffffffffffff) >> 18) +                        \
163                    ((VPT & 0x0000ffffffffffff) >> 27))
164 #define vpd VPD
165
166 /* Top of the kernel virtual mapping area (KERNBASE) */
167 #define KERN_VMAP_TOP   (VPT)
168 /* Base of the physical memory map. This maps from 0 physical to max_paddr */
169 #define KERNBASE        0xffff800000000000
170
171 /* Highest user address: 0x00007fffffffffff: 1 zero, 47 ones, sign extended.
172  * From here down to UWLIM is User Read-only */
173 #define ULIM            0x0000800000000000
174 /* Same as VPT but read-only for users */
175 #define UVPT                    (ULIM - PML4_PTE_REACH)
176 /* Arbitrary boundary between the break and the start of
177  * memory returned by calls to mmap with addr = 0 */
178 #define BRK_END                 0x0000400000000000
179
180 /* **************************************** */
181 /* Page table constants, macros, etc */
182
183 /* A linear address 'la' has a five-part structure as follows:
184  *
185  * +-----9------+-----9------+-----9------+-----9------+---------12----------+
186  * | PML4 bits  | PML3 bits  | PML2 bits  | PML1 bits  |     Page offset     |
187  * |   offset   |   offset   |   offset   |   offset   |                     |
188  * +------------+------------+------------+------------+---------------------+
189  *  \ PML4(la) / \ PML3(la) / \ PML2(la) / \ PML1(la) / \---- PGOFF(la) ----/
190  *  \------------------ LA2PPN(la) -------------------/
191  *
192  * The PMLx, PGOFF, and LA2PPN macros decompose linear addresses as shown.
193  * To construct a linear address la from these, use:
194  * PGADDR(PML4(la), PML3(la), PML2(la), PML1(la), PGOFF(la)).
195  * Careful, that's arch- and bit-specific.
196  *
197  * I'd somewhat like it if we started counting from the outer-most PT, though
198  * amd coined the term PML4 for the outermost, instead of PML1.  Incidentally,
199  * they also don't use numbers other than PML4, sticking with names like PDP. */
200
201 #define PML4_SHIFT              39
202 #define PML3_SHIFT              30
203 #define PML2_SHIFT              21
204 #define PML1_SHIFT              12
205 #define BITS_PER_PML    9
206
207 /* PTE reach is the amount of VM an entry can map, either as a jumbo or as
208  * further page tables.  I'd like to write these as shifts, but I can't please
209  * both the compiler and the assembler. */
210 #define PML4_PTE_REACH  (0x0000008000000000)    /* No jumbos available */
211 #define PML3_PTE_REACH  (0x0000000040000000)    /* 1 GB jumbos available */
212 #define PML2_PTE_REACH  (0x0000000000200000)    /* 2 MB jumbos available */
213 #define PML1_PTE_REACH  (0x0000000000001000)    /* aka, PGSIZE */
214
215 /* Reach is the amount of VM a table can map, counting all of its entries.
216  * Note that a PML(n)_PTE is a PML(n-1) table. */
217 #define PML3_REACH              (PML4_PTE_REACH)
218 #define PML2_REACH              (PML3_PTE_REACH)
219 #define PML1_REACH              (PML2_PTE_REACH)
220
221 /* PMLx(la, shift) gives the 9 bits specifying the la's entry in the PML
222  * corresponding to shift.  PMLn(la) gives the 9 bits for PML4, etc. */
223 #define PMLx(la, shift) (((uintptr_t)(la) >> (shift)) & 0x1ff)
224 #define PML4(la)                PMLx(la, PML4_SHIFT)
225 #define PML3(la)                PMLx(la, PML3_SHIFT)
226 #define PML2(la)                PMLx(la, PML2_SHIFT)
227 #define PML1(la)                PMLx(la, PML1_SHIFT)
228
229 /* Common kernel helpers */
230 #define PGSHIFT                 PML1_SHIFT
231 #define PGSIZE                  PML1_PTE_REACH
232 #define LA2PPN(la)              ((uintptr_t)(la) >> PGSHIFT)
233 #define PTE2PPN(pte)    LA2PPN(pte)
234 #define PGOFF(la)               ((uintptr_t)(la) & (PGSIZE - 1))
235
236 /* construct PTE from PPN and flags */
237 #define PTE(ppn, flags) ((ppn) << PGSHIFT | PGOFF(flags))
238
239 /* construct linear address from indexes and offset */
240 #define PGADDR(p4, p3, p2, p1, o) ((void*)(((p4) << PML4_SHIFT) |              \
241                                            ((p3) << PML3_SHIFT) |              \
242                                            ((p2) << PML2_SHIFT) |              \
243                                            ((p1) << PML1_SHIFT) |(o)))
244
245 /* These are used in older code, referring to the outer-most page table */
246 #define PDX(la)                 PML4(la)
247 #define NPDENTRIES              512
248 /* This is used in places (procinfo) meaning "size of smallest jumbo page" */
249 #define PTSIZE PML2_PTE_REACH
250
251
252 /* TODO: not sure if we'll need these - limited to 64bit code */
253 /* this only gives us the L1 PML */
254 #define PTX(la)         ((((uintptr_t) (la)) >> 12) & 0x1ff)
255 #define JPGOFF(la)      (((uintptr_t) (la)) & 0x001FFFFF)
256 #define NPTENTRIES              512
257 #define JPGSIZE PTSIZE
258
259 /* Page table/directory entry flags. */
260
261 /* Some things to be careful of:  Global and PAT only apply to the last PTE in
262  * a chain: so either a PTE in PML1, or a Jumbo PTE in PML2 or 3.  When PAT
263  * applies, which bit we use depends on whether we are jumbo or not.  For PML1,
264  * PAT is bit 8.  For jumbo PTEs (and only when they are for a jumbo page), we
265  * use bit 12. */
266 #define PTE_P                   0x001   /* Present */
267 #define PTE_W                   0x002   /* Writeable */
268 #define PTE_U                   0x004   /* User */
269 #define PTE_PWT                 0x008   /* Write-Through */
270 #define PTE_PCD                 0x010   /* Cache-Disable */
271 #define PTE_A                   0x020   /* Accessed */
272 #define PTE_D                   0x040   /* Dirty */
273 #define PTE_PS                  0x080   /* Page Size */
274 #define PTE_PAT                 0x080   /* Page attribute table */
275 #define PTE_G                   0x100   /* Global Page */
276 #define PTE_JPAT                0x800   /* Jumbo PAT */
277
278 /* Permissions fields and common access modes.  These should be read as 'just
279  * kernel or user too' and 'RO or RW'.  USER_RO means read-only for everyone. */
280 #define PTE_PERM                (PTE_W | PTE_U)
281 #define PTE_KERN_RW             PTE_W           // Kernel Read/Write
282 #define PTE_KERN_RO             0               // Kernel Read-Only
283 #define PTE_USER_RW             (PTE_W | PTE_U) // Kernel/User Read/Write
284 #define PTE_USER_RO             PTE_U           // Kernel/User Read-Only
285
286 /* The PTE/translation part of a PTE/virtual(linear) address.  It's used
287  * frequently to be the page address of a virtual address.  Note this doesn't
288  * work on jumbo PTEs due to the reserved bits.  Jumbo's don't have a PTE_ADDR
289  * in them - just a base address of wherever they point. */
290 #define PTE_ADDR(pte)   ((physaddr_t) (pte) & ~(PGSIZE - 1))
291 /* More meaningful macro, same as PTE_ADDR */
292 #define PG_ADDR(la)     ((uintptr_t)(la) & ~(PGSIZE - 1))
293
294 /* we must guarantee that for any PTE, exactly one of the following is true */
295 #define PAGE_PRESENT(pte) ((pte) & PTE_P)
296 #define PAGE_UNMAPPED(pte) ((pte) == 0)
297 #define PAGE_PAGED_OUT(pte) (!PAGE_PRESENT(pte) && !PAGE_UNMAPPED(pte))
298
299
300 /* **************************************** */
301 /* Segmentation */
302
303 /* Global descriptor numbers */
304 #define GD_NULL                 0x00    /* NULL descriptor */
305 #define GD_KT                   0x08    /* kernel text */
306 #define GD_KD                   0x10    /* kernel data */
307 /* syscall/sysret wants UD before UT, but KT before KD.  it really wants UT32,
308  * UD, UT64.  anyways... */
309 #define GD_UD                   0x18    /* user data */
310 #define GD_UT                   0x20    /* user text */
311 #define GD_TSS                  0x28    /* Task segment selector */
312 #define GD_TSS2                 0x30    /* Placeholder, TSS is 2-descriptors wide */
313 /* These two aren't in the GDT yet (might never be) */
314 #define GD_LDT                  0x38    /* Local descriptor table */
315 #define GD_LDT2                 0x40    /* Placeholder */
316
317 #ifdef __ASSEMBLER__
318
319 /* Macros to build GDT entries in assembly. */
320 #define SEG_NULL                                                \
321         .word 0, 0;                                             \
322         .byte 0, 0, 0, 0
323
324 /* 64 bit code segment.  This is for long mode, no compatibility.  If we want
325  * to support 32 bit apps later, we'll want to adjust this. */
326 #define SEG_CODE_64(dpl)                                                    \
327         .word 0, 0;                                                             \
328         .byte 0;                                                                \
329         .byte (((1/*p*/) << 7) | ((dpl) << 5) | 0x18 | ((0/*c*/) << 2));        \
330         .byte (((0/*d*/) << 6) | ((1/*l*/) << 5));                              \
331         .byte 0;
332
333 /* 64 bit data segment.  These are pretty much completely ignored (except if we
334  * use them for fs/gs, or compatibility mode */
335 #define SEG_DATA_64(dpl)                                                    \
336         .word 0xffff, 0;                                                        \
337         .byte 0;                                                                \
338         .byte (0x92 | ((dpl) << 5));                                            \
339         .byte 0x8f;                                                             \
340         .byte 0;
341
342 /* System segments (TSS/LDT) are twice as long as usual (16 bytes). */
343 #define SEG_SYS_64(type, base, lim, dpl)                                       \
344         .word ((lim) & 0xffff);                                                    \
345         .word ((base) & 0xffff);                                                   \
346         .byte (((base) >> 16) & 0xff);                                             \
347         .byte ((1 << 7) | ((dpl) << 5) | (type));                                  \
348         .byte (((1/*g*/) << 7) | (((lim) >> 16) & 0xf));                           \
349         .byte (((base) >> 24) & 0xff);                                             \
350         .quad ((base) >> 32);                                                      \
351         .quad 0;
352
353 /* Default segment (32 bit style).  Would work for fs/gs, if needed */
354 #define SEG(type, base, lim)                                                \
355         .word (((lim) >> 12) & 0xffff);                                         \
356         .word ((base) & 0xffff);                                                \
357         .byte (((base) >> 16) & 0xff);                                          \
358         .byte (0x90 | (type));                                                  \
359         .byte (0xC0 | (((lim) >> 28) & 0xf));                                   \
360         .byte (((base) >> 24) & 0xff)
361
362 #else   // not __ASSEMBLER__
363
364 /* Legacy Segment Descriptor (used for 64 bit data and code) */
365 typedef struct Segdesc {
366         unsigned sd_lim_15_0 : 16;  // Low bits of segment limit
367         unsigned sd_base_15_0 : 16; // Low bits of segment base address
368         unsigned sd_base_23_16 : 8; // Middle bits of segment base address
369         unsigned sd_type : 4;       // Segment type (see STS_ constants)
370         unsigned sd_s : 1;          // 0 = system, 1 = application
371         unsigned sd_dpl : 2;        // Descriptor Privilege Level
372         unsigned sd_p : 1;          // Present
373         unsigned sd_lim_19_16 : 4;  // High bits of segment limit
374         unsigned sd_avl : 1;        // Unused (available for software use)
375         unsigned sd_rsv1 : 1;       // Reserved
376         unsigned sd_db : 1;         // 0 = 16-bit segment, 1 = 32-bit segment
377         unsigned sd_g : 1;          // Granularity: limit scaled by 4K when set
378         unsigned sd_base_31_24 : 8; // High bits of segment base address
379 } segdesc_t;
380
381 /* Lower half is similar (more ignored, etc)  to a legacy system descriptor */
382 struct x86_sysseg64 {
383         unsigned sd_lim_15_0 : 16;      /* Low bits of segment limit */
384         unsigned sd_base_15_0 : 16;     /* Low bits of segment base address */
385         unsigned sd_base_23_16 : 8;     /* Middle bits of segment base address */
386         unsigned sd_type : 4;           /* Segment type (see STS_ constants) */
387         unsigned sd_s : 1;                      /* 0 = system, 1 = application */
388         unsigned sd_dpl : 2;            /* Descriptor Privilege Level */
389         unsigned sd_p : 1;                      /* Present */
390         unsigned sd_lim_19_16 : 4;      /* High bits of segment limit */
391         unsigned sd_avl : 1;            /* Unused (available for software use) */
392         unsigned sd_rsv2 : 2;           /* Reserved */
393         unsigned sd_g : 1;                      /* Granularity: limit scaled by 4K when set */
394         unsigned sd_base_31_24 : 8;     /* 24-31 bits of segment base address */
395         unsigned sd_base_63_32;         /* top 32 bits of the base */
396         unsigned sd_reserved;           /* some parts must be zero, just zero it all */
397 };
398 typedef struct x86_sysseg64 syssegdesc_t;
399
400 /* G(ranularity) determines if the limit is shifted */
401 #define __SEG_SYS64(type, base, lim, dpl, g)                                   \
402 { ((lim) >> ((g) * 12)) & 0xffff, (base) & 0xffff, ((base) >> 16) & 0xff,      \
403     type, 0, dpl, 1, (unsigned) (lim) >> 28, 0, 0, (g),                        \
404     ((unsigned) (base) >> 24) & 0xff,                                          \
405     ((unsigned long) (base) >> 32), 0 }
406
407 /* Normal system segment descriptor (LDT or TSS). (limit is scaled by 4k) */
408 #define SEG_SYS64(type, base, lim, dpl)                                        \
409         __SEG_SYS64(type, base, lim, dpl, 1)
410
411 /* Smaller system segment descriptor (LDT or TSS). */
412 #define SEG_SYS64_SMALL(type, base, lim, dpl)                                  \
413         __SEG_SYS64(type, base, lim, dpl, 0)
414
415 #define SEG_SYS_SMALL(type, base, lim, dpl) \
416         SEG_SYS64_SMALL(type, base, lim, dpl)
417
418 /* 64 bit task state segment (AMD 2:12.2.5) */
419 typedef struct taskstate {
420         uint32_t                                        ts_rsv1;        /* reserved / ignored */
421         uint64_t                                        ts_rsp0;        /* stack ptr in ring 0 */
422         uint64_t                                        ts_rsp1;        /* stack ptr in ring 1 */
423         uint64_t                                        ts_rsp2;        /* stack ptr in ring 2 */
424         uint64_t                                        ts_rsv2;        /* reserved / ignored */
425         uint64_t                                        ts_ist1;        /* IST stacks: unconditional rsp */
426         uint64_t                                        ts_ist2;        /* check AMD 2:8.9.4 for info */
427         uint64_t                                        ts_ist3;
428         uint64_t                                        ts_ist4;
429         uint64_t                                        ts_ist5;
430         uint64_t                                        ts_ist6;
431         uint64_t                                        ts_ist7;
432         uint64_t                                        ts_rsv3;        /* reserved / ignored */
433         uint16_t                                        ts_rsv4;        /* reserved / ignored */
434         uint16_t                                        ts_iobm;        /* IO base map (offset) */
435 } __attribute__((packed)) taskstate_t;
436
437 /* 64 bit gate descriptors for interrupts and traps */
438 typedef struct Gatedesc {
439         unsigned gd_off_15_0 : 16;      /* low 16 bits of offset in segment */
440         unsigned gd_ss : 16;            /* segment selector */
441         unsigned gd_ist : 3;            /* interrupt stack table selector (0 = none) */
442         unsigned gd_rsv1 : 5;           /* ignored */
443         unsigned gd_type : 4;           /* type(STS_{TG,IG32,TG32}) */
444         unsigned gd_s : 1;                      /* must be 0 (system) */
445         unsigned gd_dpl : 2;            /* DPL - highest ring allowed to use this */
446         unsigned gd_p : 1;                      /* Present */
447         unsigned gd_off_31_16 : 16;     /* 16-31 bits of offset in segment */
448         unsigned gd_off_63_32;          /* top 32 bits of offset */
449         unsigned gd_rsv2;                       /* reserved / unsused */
450 } gatedesc_t;
451
452 /* Set up an IST-capable 64 bit interrupt/trap gate descriptor.  IST selects a
453  * stack pointer from the interrupt-stack table (in TSS) that will be loaded
454  * unconditionally when we hit this gate  - regardless of privelege change. */
455 #define SETGATE64(gate, istrap, sel, off, dpl, ist)                            \
456 {                                                                              \
457         (gate).gd_off_15_0 = (uintptr_t) (off) & 0xffff;                           \
458         (gate).gd_ss = (sel);                                                      \
459         (gate).gd_ist = (ist);                                                     \
460         (gate).gd_rsv1 = 0;                                                        \
461         (gate).gd_type = (istrap) ? STS_TG32 : STS_IG32;                           \
462         (gate).gd_s = 0;                                                           \
463         (gate).gd_dpl = (dpl);                                                     \
464         (gate).gd_p = 1;                                                           \
465         (gate).gd_off_31_16 = (uintptr_t) (off) >> 16;                             \
466         (gate).gd_off_63_32 = (uintptr_t) (off) >> 32;                             \
467         (gate).gd_rsv2 = 0;                                                        \
468 }
469
470 /* Set up a normal, 64 bit interrupt/trap gate descriptor.
471  * - istrap: 1 for a trap (= exception) gate, 0 for an interrupt gate.
472  *   - interrupt gates automatically disable interrupts (cli)
473  * - sel: Code segment selector for interrupt/trap handler
474  * - off: Offset in code segment for interrupt/trap handler (address)
475  * - dpl: Descriptor Privilege Level -
476  *        the privilege level required for software to invoke
477  *        this interrupt/trap gate explicitly using an int instruction. */
478 #define SETGATE(gate, istrap, sel, off, dpl)                                   \
479         SETGATE64(gate, istrap, sel, off, dpl, 0)
480
481 // Pseudo-descriptors used for LGDT, LLDT and LIDT instructions.
482 typedef struct Pseudodesc {
483         uint16_t pd_lim;                // Limit
484         uintptr_t pd_base;              // Base address
485 } __attribute__ ((packed)) pseudodesc_t;
486
487 #endif /* !__ASSEMBLER__ */
488
489 // Application segment type bits
490 #define STA_X           0x8         // Executable segment
491 #define STA_E           0x4         // Expand down (non-executable segments)
492 #define STA_C           0x4         // Conforming code segment (executable only)
493 #define STA_W           0x2         // Writeable (non-executable segments)
494 #define STA_R           0x2         // Readable (executable segments)
495 #define STA_A           0x1         // Accessed
496
497 /* System segment type bits.  All other types are reserved/illegal.  The '32' is
498  * mostly a legacy naming - the bits work for both 64 and 32. */
499 #define STS_LDT         0x2             /* 64-bit Local Descriptor Table  */
500 #define STS_T32A        0x9             /* Available 64-bit TSS */
501 #define STS_T32B        0xB             /* Busy 64-bit TSS */
502 #define STS_CG32        0xC             /* 64-bit Call Gate */
503 #define STS_IG32        0xE             /* 64-bit Interrupt Gate */
504 #define STS_TG32        0xF             /* 64-bit Trap Gate */
505
506 #define SEG_COUNT       7               /* Number of GDT segments */
507 /* TODO: Probably won't use this */
508 #define LDT_SIZE        (8192 * sizeof(segdesc_t))
509
510 /* TLS 'syscall', coupled to trapentry64.S.  Needed a non-canon 'addr' */
511 #define FASTCALL_SETFSBASE 0xf0f0000000000001
512
513 #endif /* ROS_INC_ARCH_MMU64_H */