3d1427ffad5c2eb20dea9717e9e3fa833b5bcf7b
[dragonfly.git] / sys / cpu / i386 / 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/i386/include/segments.h,v 1.13 2007/01/08 03:33:37 dillon 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 SEL_RPL_MASK    0x0003
55
56 #define ISPL(s) ((s)&3)         /* what is the priority level of a selector */
57 #define SEL_KPL 0               /* kernel priority level */
58 #define SEL_UPL 3               /* user priority level */
59 #define ISLDT(s)        ((s)&SEL_LDT)   /* is it local or global */
60 #define SEL_LDT 4               /* local descriptor table */
61 #define IDXSEL(s)       (((s)>>3) & 0x1fff)             /* index of selector */
62 #define LSEL(s,r)       (((s)<<3) | SEL_LDT | r)        /* a local selector */
63 #define GSEL(s,r)       (((s)<<3) | r)                  /* a global selector */
64
65 #ifndef LOCORE
66
67 /*
68  * Memory and System segment descriptors
69  */
70 struct  segment_descriptor      {
71         unsigned sd_lolimit:16 ;        /* segment extent (lsb) */
72         unsigned sd_lobase:24 __attribute__ ((packed));
73                                         /* segment base address (lsb) */
74         unsigned sd_type:5 ;            /* segment type */
75         unsigned sd_dpl:2 ;             /* segment descriptor priority level */
76         unsigned sd_p:1 ;               /* segment descriptor present */
77         unsigned sd_hilimit:4 ;         /* segment extent (msb) */
78         unsigned sd_xx:2 ;              /* unused */
79         unsigned sd_def32:1 ;           /* default 32 vs 16 bit size */
80         unsigned sd_gran:1 ;            /* limit granularity (byte/page units)*/
81         unsigned sd_hibase:8 ;          /* segment base address  (msb) */
82 } ;
83
84 /*
85  * Gate descriptors (e.g. indirect descriptors)
86  */
87 struct  gate_descriptor {
88         unsigned gd_looffset:16 ;       /* gate offset (lsb) */
89         unsigned gd_selector:16 ;       /* gate segment selector */
90         unsigned gd_stkcpy:5 ;          /* number of stack wds to cpy */
91         unsigned gd_xx:3 ;              /* unused */
92         unsigned gd_type:5 ;            /* segment type */
93         unsigned gd_dpl:2 ;             /* segment descriptor priority level */
94         unsigned gd_p:1 ;               /* segment descriptor present */
95         unsigned gd_hioffset:16 ;       /* gate offset (msb) */
96 } ;
97
98 /*
99  * Generic descriptor
100  */
101 union   descriptor      {
102         struct  segment_descriptor sd;
103         struct  gate_descriptor gd;
104 };
105
106 #endif
107
108         /* system segments and gate types */
109 #define SDT_SYSNULL      0      /* system null */
110 #define SDT_SYS286TSS    1      /* system 286 TSS available */
111 #define SDT_SYSLDT       2      /* system local descriptor table */
112 #define SDT_SYS286BSY    3      /* system 286 TSS busy */
113 #define SDT_SYS286CGT    4      /* system 286 call gate */
114 #define SDT_SYSTASKGT    5      /* system task gate */
115 #define SDT_SYS286IGT    6      /* system 286 interrupt gate */
116 #define SDT_SYS286TGT    7      /* system 286 trap gate */
117 #define SDT_SYSNULL2     8      /* system null again */
118 #define SDT_SYS386TSS    9      /* system 386 TSS available */
119 #define SDT_SYSNULL3    10      /* system null again */
120 #define SDT_SYS386BSY   11      /* system 386 TSS busy */
121 #define SDT_SYS386CGT   12      /* system 386 call gate */
122 #define SDT_SYSNULL4    13      /* system null again */
123 #define SDT_SYS386IGT   14      /* system 386 interrupt gate */
124 #define SDT_SYS386TGT   15      /* system 386 trap gate */
125
126         /* memory segment types */
127 #define SDT_MEMRO       16      /* memory read only */
128 #define SDT_MEMROA      17      /* memory read only accessed */
129 #define SDT_MEMRW       18      /* memory read write */
130 #define SDT_MEMRWA      19      /* memory read write accessed */
131 #define SDT_MEMROD      20      /* memory read only expand dwn limit */
132 #define SDT_MEMRODA     21      /* memory read only expand dwn limit accessed */
133 #define SDT_MEMRWD      22      /* memory read write expand dwn limit */
134 #define SDT_MEMRWDA     23      /* memory read write expand dwn limit accessed */
135 #define SDT_MEME        24      /* memory execute only */
136 #define SDT_MEMEA       25      /* memory execute only accessed */
137 #define SDT_MEMER       26      /* memory execute read */
138 #define SDT_MEMERA      27      /* memory execute read accessed */
139 #define SDT_MEMEC       28      /* memory execute only conforming */
140 #define SDT_MEMEAC      29      /* memory execute only accessed conforming */
141 #define SDT_MEMERC      30      /* memory execute read conforming */
142 #define SDT_MEMERAC     31      /* memory execute read accessed conforming */
143
144 #ifndef LOCORE
145
146 /* is memory segment descriptor pointer ? */
147 #define ISMEMSDP(s)     ((s->d_type) >= SDT_MEMRO && (s->d_type) <= SDT_MEMERAC)
148
149 /* is 286 gate descriptor pointer ? */
150 #define IS286GDP(s)     (((s->d_type) >= SDT_SYS286CGT \
151                                  && (s->d_type) < SDT_SYS286TGT))
152
153 /* is 386 gate descriptor pointer ? */
154 #define IS386GDP(s)     (((s->d_type) >= SDT_SYS386CGT \
155                                 && (s->d_type) < SDT_SYS386TGT))
156
157 /* is gate descriptor pointer ? */
158 #define ISGDP(s)        (IS286GDP(s) || IS386GDP(s))
159
160 /* is segment descriptor pointer ? */
161 #define ISSDP(s)        (ISMEMSDP(s) || !ISGDP(s))
162
163 /* is system segment descriptor pointer ? */
164 #define ISSYSSDP(s)     (!ISMEMSDP(s) && !ISGDP(s))
165
166 /*
167  * Software definitions are in this convenient format,
168  * which are translated into inconvenient segment descriptors
169  * when needed to be used by the 386 hardware
170  */
171
172 struct  soft_segment_descriptor {
173         unsigned ssd_base ;             /* segment base address  */
174         unsigned ssd_limit ;            /* segment extent */
175         unsigned ssd_type:5 ;           /* segment type */
176         unsigned ssd_dpl:2 ;            /* segment descriptor priority level */
177         unsigned ssd_p:1 ;              /* segment descriptor present */
178         unsigned ssd_xx:4 ;             /* unused */
179         unsigned ssd_xx1:2 ;            /* unused */
180         unsigned ssd_def32:1 ;          /* default 32 vs 16 bit size */
181         unsigned ssd_gran:1 ;           /* limit granularity (byte/page units)*/
182 };
183
184 /*
185  * region descriptors, used to load gdt/idt tables before segments yet exist.
186  */
187 struct region_descriptor {
188         unsigned rd_limit:16;                           /* segment extent */
189         unsigned rd_base:32 __attribute__ ((packed));   /* base address  */
190 };
191
192 #endif
193
194 /*
195  * Segment Protection Exception code bits
196  */
197
198 #define SEGEX_EXT       0x01    /* recursive or externally induced */
199 #define SEGEX_IDT       0x02    /* interrupt descriptor table */
200 #define SEGEX_TI        0x04    /* local descriptor table */
201                                 /* other bits are affected descriptor index */
202 #define SEGEX_IDX(s)    (((s)>>3)&0x1fff)
203
204 /*
205  * Size of IDT table.  Theoretically we only need to cover past 0x81
206  * (NIDT=130) if not running APIC_IO or SMP, but at this point we might
207  * as well just use all of them.
208  */
209 #define NIDT    256             /* we use them all */
210
211 /*
212  * Entries in the Global Descriptor Table (GDT)
213  */
214 #define GNULL_SEL       0       /* Null Descriptor */
215 #define GCODE_SEL       1       /* Kernel Code Descriptor */
216 #define GDATA_SEL       2       /* Kernel Data Descriptor */
217 #define GPRIV_SEL       3       /* SMP Per-Processor Private Data */
218 #define GPROC0_SEL      4       /* Task state process slot zero and up */
219 #define GLDT_SEL        5       /* LDT - eventually one per process */
220 #define GUSERLDT_SEL    6       /* User LDT */
221 #define GTGATE_SEL      7       /* Process task switch gate */
222 #define GBIOSLOWMEM_SEL 8       /* BIOS low memory access (must be entry 8) */
223 #define GPANIC_SEL      9       /* Task state to consider panic from */
224 #define GBIOSCODE32_SEL 10      /* BIOS interface (32bit Code) */
225 #define GBIOSCODE16_SEL 11      /* BIOS interface (16bit Code) */
226 #define GBIOSDATA_SEL   12      /* BIOS interface (Data) */
227 #define GBIOSUTIL_SEL   13      /* BIOS interface (Utility) */
228 #define GBIOSARGS_SEL   14      /* BIOS interface (Arguments) */
229 #define GTLS_START      15      /* Thread TLS Descriptor */
230 #define GTLS_END        17      /* Thread TLS Descriptor */
231 #define GNDIS_SEL       18      /* For the NDIS layer */
232
233 #define NGTLS           (GTLS_END - GTLS_START + 1)
234 #ifdef BDE_DEBUGGER
235 #define NGDT            21      /* some of 11-17 are reserved for debugger */
236 #else
237 #define NGDT            19
238 #endif
239
240 /*
241  * Entries in the Local Descriptor Table (LDT)
242  */
243 #define LSYS5CALLS_SEL  0       /* forced by intel BCS */
244 #define LSYS5SIGR_SEL   1
245 #define L43BSDCALLS_SEL 2       /* notyet */
246 #define LUCODE_SEL      3
247 #define LSOL26CALLS_SEL 4       /* Solaris >= 2.6 system call gate */
248 #define LUDATA_SEL      5
249 /* separate stack, es,fs,gs sels ? */
250 /* #define      LPOSIXCALLS_SEL 5*/     /* notyet */
251 #define LBSDICALLS_SEL  16      /* BSDI system call gate */
252 #define NLDT            (LBSDICALLS_SEL + 1)
253
254 #ifndef LOCORE
255
256 struct savetls {
257         struct segment_descriptor tls[NGTLS];
258 };
259
260 #endif
261
262 #if defined(_KERNEL) && !defined(LOCORE)
263
264 #ifndef _SYS_TYPES_H_
265 #include <sys/types.h>
266 #endif
267
268 extern int      _default_ldt;
269 extern union descriptor gdt[];
270 extern struct soft_segment_descriptor gdt_segs[];
271 extern struct gate_descriptor *idt;
272 extern union descriptor ldt[NLDT];
273
274 void    lgdt            (struct region_descriptor *rdp);
275 void    lidt            (struct region_descriptor *rdp);
276 void    lldt            (u_short sel);
277 void    sdtossd         (struct segment_descriptor *sdp,
278                              struct soft_segment_descriptor *ssdp);
279 void    ssdtosd         (struct soft_segment_descriptor *ssdp,
280                              struct segment_descriptor *sdp);
281 #endif /* _KERNEL */
282
283 #endif /* !_CPU_SEGMENTS_H_ */