more header changes for amd64 port; the pc64 building infrastructure
[dragonfly.git] / sys / cpu / amd64 / include / segments.h
1 /*-
2  * Copyright (c) 1989, 1990 William F. Jolitz
3  * Copyright (c) 1990 The Regents of the University of California.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * William Jolitz.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *      This product includes software developed by the University of
20  *      California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *      from: @(#)segments.h    7.1 (Berkeley) 5/9/91
38  * $FreeBSD: src/sys/i386/include/segments.h,v 1.24 1999/12/29 04:33:07 peter Exp $
39  * $DragonFly: src/sys/cpu/amd64/include/segments.h,v 1.2 2007/09/23 04:29:30 yanyh Exp $
40  */
41
42 #ifndef _CPU_SEGMENTS_H_
43 #define _CPU_SEGMENTS_H_
44
45 /*
46  * 386 Segmentation Data Structures and definitions
47  *      William F. Jolitz (william@ernie.berkeley.edu) 6/20/1989
48  */
49
50 /*
51  * Selectors
52  */
53
54 #define ISPL(s) ((s)&3)         /* what is the priority level of a selector */
55 #define SEL_KPL 0               /* kernel priority level */
56 #define SEL_UPL 3               /* user priority level */
57 #define ISLDT(s)        ((s)&SEL_LDT)   /* is it local or global */
58 #define SEL_LDT 4               /* local descriptor table */
59 #define IDXSEL(s)       (((s)>>3) & 0x1fff)             /* index of selector */
60 #define LSEL(s,r)       (((s)<<3) | SEL_LDT | r)        /* a local selector */
61 #define GSEL(s,r)       (((s)<<3) | r)                  /* a global selector */
62
63 #ifndef LOCORE
64
65 /*
66  * Memory and System segment descriptors
67  */
68 struct  segment_descriptor      {
69         unsigned sd_lolimit:16 ;        /* segment extent (lsb) */
70         unsigned sd_lobase:24 __attribute__ ((packed));
71                                         /* segment base address (lsb) */
72         unsigned sd_type:5 ;            /* segment type */
73         unsigned sd_dpl:2 ;             /* segment descriptor priority level */
74         unsigned sd_p:1 ;               /* segment descriptor present */
75         unsigned sd_hilimit:4 ;         /* segment extent (msb) */
76         unsigned sd_xx:2 ;              /* unused */
77         unsigned sd_def32:1 ;           /* default 32 vs 16 bit size */
78         unsigned sd_gran:1 ;            /* limit granularity (byte/page units)*/
79         unsigned sd_hibase:8 ;          /* segment base address  (msb) */
80 } ;
81
82 /*
83  * Gate descriptors (e.g. indirect descriptors)
84  */
85 struct  gate_descriptor {
86         unsigned gd_looffset:16 ;       /* gate offset (lsb) */
87         unsigned gd_selector:16 ;       /* gate segment selector */
88         unsigned gd_stkcpy:5 ;          /* number of stack wds to cpy */
89         unsigned gd_xx:3 ;              /* unused */
90         unsigned gd_type:5 ;            /* segment type */
91         unsigned gd_dpl:2 ;             /* segment descriptor priority level */
92         unsigned gd_p:1 ;               /* segment descriptor present */
93         unsigned gd_hioffset:16 ;       /* gate offset (msb) */
94 } ;
95
96 /*
97  * Generic descriptor
98  */
99 union   descriptor      {
100         struct  segment_descriptor sd;
101         struct  gate_descriptor gd;
102 };
103
104 #endif /* LOCORE */
105
106 /* system segments and gate types */
107 #define SDT_SYSNULL      0      /* system null */
108 #define SDT_SYS286TSS    1      /* system 286 TSS available */
109 #define SDT_SYSLDT       2      /* system local descriptor table */
110 #define SDT_SYS286BSY    3      /* system 286 TSS busy */
111 #define SDT_SYS286CGT    4      /* system 286 call gate */
112 #define SDT_SYSTASKGT    5      /* system task gate */
113 #define SDT_SYS286IGT    6      /* system 286 interrupt gate */
114 #define SDT_SYS286TGT    7      /* system 286 trap gate */
115 #define SDT_SYSNULL2     8      /* system null again */
116 #define SDT_SYS386TSS    9      /* system 386 TSS available */
117 #define SDT_SYSNULL3    10      /* system null again */
118 #define SDT_SYS386BSY   11      /* system 386 TSS busy */
119 #define SDT_SYS386CGT   12      /* system 386 call gate */
120 #define SDT_SYSNULL4    13      /* system null again */
121 #define SDT_SYS386IGT   14      /* system 386 interrupt gate */
122 #define SDT_SYS386TGT   15      /* system 386 trap gate */
123
124         /* memory segment types */
125 #define SDT_MEMRO       16      /* memory read only */
126 #define SDT_MEMROA      17      /* memory read only accessed */
127 #define SDT_MEMRW       18      /* memory read write */
128 #define SDT_MEMRWA      19      /* memory read write accessed */
129 #define SDT_MEMROD      20      /* memory read only expand dwn limit */
130 #define SDT_MEMRODA     21      /* memory read only expand dwn limit accessed */
131 #define SDT_MEMRWD      22      /* memory read write expand dwn limit */
132 #define SDT_MEMRWDA     23      /* memory read write expand dwn limit accessed */
133 #define SDT_MEME        24      /* memory execute only */
134 #define SDT_MEMEA       25      /* memory execute only accessed */
135 #define SDT_MEMER       26      /* memory execute read */
136 #define SDT_MEMERA      27      /* memory execute read accessed */
137 #define SDT_MEMEC       28      /* memory execute only conforming */
138 #define SDT_MEMEAC      29      /* memory execute only accessed conforming */
139 #define SDT_MEMERC      30      /* memory execute read conforming */
140 #define SDT_MEMERAC     31      /* memory execute read accessed conforming */
141
142
143 #ifndef LOCORE
144
145 /* is memory segment descriptor pointer ? */
146 #define ISMEMSDP(s)     ((s->d_type) >= SDT_MEMRO && (s->d_type) <= SDT_MEMERAC)
147
148 /* is 286 gate descriptor pointer ? */
149 #define IS286GDP(s)     (((s->d_type) >= SDT_SYS286CGT \
150                                  && (s->d_type) < SDT_SYS286TGT))
151
152 /* is 386 gate descriptor pointer ? */
153 #define IS386GDP(s)     (((s->d_type) >= SDT_SYS386CGT \
154                                 && (s->d_type) < SDT_SYS386TGT))
155
156 /* is gate descriptor pointer ? */
157 #define ISGDP(s)        (IS286GDP(s) || IS386GDP(s))
158
159 /* is segment descriptor pointer ? */
160 #define ISSDP(s)        (ISMEMSDP(s) || !ISGDP(s))
161
162 /* is system segment descriptor pointer ? */
163 #define ISSYSSDP(s)     (!ISMEMSDP(s) && !ISGDP(s))
164
165 /*
166  * Software definitions are in this convenient format,
167  * which are translated into inconvenient segment descriptors
168  * when needed to be used by the 386 hardware
169  */
170
171 #if 0
172
173 struct  soft_segment_descriptor {
174         unsigned ssd_base ;             /* segment base address  */
175         unsigned ssd_limit ;            /* segment extent */
176         unsigned ssd_type:5 ;           /* segment type */
177         unsigned ssd_dpl:2 ;            /* segment descriptor priority level */
178         unsigned ssd_p:1 ;              /* segment descriptor present */
179         unsigned ssd_xx:4 ;             /* unused */
180         unsigned ssd_xx1:2 ;            /* unused */
181         unsigned ssd_def32:1 ;          /* default 32 vs 16 bit size */
182         unsigned ssd_gran:1 ;           /* limit granularity (byte/page units)*/
183 };
184 #endif /* 0 */
185
186 /*
187  * region descriptors, used to load gdt/idt tables before segments yet exist.
188  */
189 struct region_descriptor {
190         unsigned rd_limit:16;                           /* segment extent */
191         unsigned rd_base:32 __attribute__ ((packed));   /* base address  */
192 };
193
194 #endif /* LOCORE */
195
196 /*
197  * Segment Protection Exception code bits
198  */
199
200 #define SEGEX_EXT       0x01    /* recursive or externally induced */
201 #define SEGEX_IDT       0x02    /* interrupt descriptor table */
202 #define SEGEX_TI        0x04    /* local descriptor table */
203                                 /* other bits are affected descriptor index */
204 #define SEGEX_IDX(s)    ((s)>>3)&0x1fff)
205
206 /*
207  * Size of the IDT table.  Theoretically we only need to cover past 0x81 
208  * (NIDT=130) if not running APIC_IO or SMP, but at this point we might
209  * as well just use all of them.
210  */
211 #define NIDT    256             /* we use them all */
212
213 /*
214  * Entries in the Global Descriptor Table (GDT)
215  */
216 #define GNULL_SEL       0       /* Null Descriptor */
217 #define GCODE_SEL       1       /* Kernel Code Descriptor */
218 #define GDATA_SEL       2       /* Kernel Data Descriptor */
219 #define GPRIV_SEL       3       /* SMP Per-Processor Private Data */
220 #define GPROC0_SEL      4       /* Task state process slot zero and up */
221 #define GLDT_SEL        5       /* LDT - eventually one per process */
222 #define GUSERLDT_SEL    6       /* User LDT */
223 #define GTGATE_SEL      7       /* Process task switch gate */
224 #define GBIOSLOWMEM_SEL 8       /* BIOS low memory access (must be entry 8) */
225 #define GPANIC_SEL      9       /* Task state to consider panic from */
226 #define GBIOSCODE32_SEL 10      /* BIOS interface (32bit Code) */
227 #define GBIOSCODE16_SEL 11      /* BIOS interface (16bit Code) */
228 #define GBIOSDATA_SEL   12      /* BIOS interface (Data) */
229 #define GBIOSUTIL_SEL   13      /* BIOS interface (Utility) */
230 #define GBIOSARGS_SEL   14      /* BIOS interface (Arguments) */
231 #define GTLS_START      15      /* Thread TLS Descriptor */
232 #define GTLS_END        17      /* Thread TLS Descriptor */
233
234 #define NGTLS                   (GTLS_END - GTLS_START + 1)
235 #ifdef BDE_DEBUGGER
236 #define NGDT            18      /* some of 11-17 are reserved for debugger */
237 #else
238 #define NGDT            15
239 #endif
240
241 /*
242  * Entries in the Local Descriptor Table (LDT)
243  */
244 #define LSYS5CALLS_SEL  0       /* forced by intel BCS */
245 #define LSYS5SIGR_SEL   1
246 #define L43BSDCALLS_SEL 2       /* notyet */
247 #define LUCODE_SEL      3
248 #define LSOL26CALLS_SEL 4       /* Solaris >= 2.6 system call gate */
249 #define LUDATA_SEL      5
250 /* separate stack, es,fs,gs sels ? */
251 /* #define      LPOSIXCALLS_SEL 5*/     /* notyet */
252 #define LBSDICALLS_SEL  16      /* BSDI system call gate */
253 #define NLDT            (LBSDICALLS_SEL + 1)
254
255 #ifndef LOCORE
256 struct savetls {
257         struct segment_descriptor tls[NGTLS];
258 };
259
260 #ifdef _KERNEL
261 extern int      _default_ldt;
262 extern union descriptor gdt[];
263 extern struct soft_segment_descriptor gdt_segs[];
264 extern struct gate_descriptor *idt;
265 extern union descriptor ldt[NLDT];
266
267 void    lgdt            (struct region_descriptor *rdp);
268 void    sdtossd         (struct segment_descriptor *sdp,
269                              struct soft_segment_descriptor *ssdp);
270 void    ssdtosd         (struct soft_segment_descriptor *ssdp,
271                              struct segment_descriptor *sdp);
272 #endif /* _KERNEL */
273 #endif /* LOCORE */
274
275 #endif /* !_CPU_SEGMENTS_H_ */