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