xref: /freebsd/sys/i386/include/reg.h (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1 /*-
2  * Copyright (c) 1990 The Regents of the University of California.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * William Jolitz.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	from: @(#)reg.h	5.5 (Berkeley) 1/18/91
33  * $FreeBSD$
34  */
35 
36 #ifndef _MACHINE_REG_H_
37 #define	_MACHINE_REG_H_
38 
39 /*
40  * Indices for registers in `struct trapframe' and `struct regs'.
41  *
42  * This interface is deprecated.  In the kernel, it is only used in FPU
43  * emulators to convert from register numbers encoded in instructions to
44  * register values.  Everything else just accesses the relevant struct
45  * members.  In userland, debuggers tend to abuse this interface since
46  * they don't understand that `struct regs' is a struct.  I hope they have
47  * stopped accessing the registers in the trap frame via PT_{READ,WRITE}_U
48  * and we can stop supporting the user area soon.
49  */
50 #define	tFS	(0)
51 #define	tES	(1)
52 #define	tDS	(2)
53 #define	tEDI	(3)
54 #define	tESI	(4)
55 #define	tEBP	(5)
56 #define	tISP	(6)
57 #define	tEBX	(7)
58 #define	tEDX	(8)
59 #define	tECX	(9)
60 #define	tEAX	(10)
61 #define	tERR	(12)
62 #define	tEIP	(13)
63 #define	tCS	(14)
64 #define	tEFLAGS	(15)
65 #define	tESP	(16)
66 #define	tSS	(17)
67 
68 /*
69  * Indices for registers in `struct regs' only.
70  *
71  * Some registers live in the pcb and are only in an "array" with the
72  * other registers in application interfaces that copy all the registers
73  * to or from a `struct regs'.
74  */
75 #define	tGS	(18)
76 
77 /*
78  * Register set accessible via /proc/$pid/regs and PT_{SET,GET}REGS.
79  */
80 struct reg {
81 	unsigned int	r_fs;
82 	unsigned int	r_es;
83 	unsigned int	r_ds;
84 	unsigned int	r_edi;
85 	unsigned int	r_esi;
86 	unsigned int	r_ebp;
87 	unsigned int	r_isp;
88 	unsigned int	r_ebx;
89 	unsigned int	r_edx;
90 	unsigned int	r_ecx;
91 	unsigned int	r_eax;
92 	unsigned int	r_trapno;
93 	unsigned int	r_err;
94 	unsigned int	r_eip;
95 	unsigned int	r_cs;
96 	unsigned int	r_eflags;
97 	unsigned int	r_esp;
98 	unsigned int	r_ss;
99 	unsigned int	r_gs;
100 };
101 
102 /*
103  * Register set accessible via /proc/$pid/fpregs.
104  */
105 struct fpreg {
106 	/*
107 	 * XXX should get struct from npx.h.  Here we give a slightly
108 	 * simplified struct.  This may be too much detail.  Perhaps
109 	 * an array of unsigned longs is best.
110 	 */
111 	unsigned long	fpr_env[7];
112 	unsigned char	fpr_acc[8][10];
113 	unsigned long	fpr_ex_sw;
114 	unsigned char	fpr_pad[64];
115 };
116 
117 struct xmmreg {
118 	/*
119 	 * XXX should get struct from npx.h.  Here we give a slightly
120 	 * simplified struct.  This may be too much detail.  Perhaps
121 	 * an array of unsigned longs is best.
122 	 */
123 	unsigned long	xmm_env[8];
124 	unsigned char	xmm_acc[8][16];
125 	unsigned char	xmm_reg[8][16];
126 	unsigned char	xmm_pad[224];
127 };
128 
129 /*
130  * Register set accessible via /proc/$pid/dbregs.
131  */
132 struct dbreg {
133 	unsigned int  dr[8];	/* debug registers */
134 				/* Index 0-3: debug address registers */
135 				/* Index 4-5: reserved */
136 				/* Index 6: debug status */
137 				/* Index 7: debug control */
138 };
139 
140 #define	DBREG_DR7_LOCAL_ENABLE	0x01
141 #define	DBREG_DR7_GLOBAL_ENABLE	0x02
142 #define	DBREG_DR7_LEN_1		0x00	/* 1 byte length          */
143 #define	DBREG_DR7_LEN_2		0x01
144 #define	DBREG_DR7_LEN_4		0x03
145 #define	DBREG_DR7_EXEC		0x00	/* break on execute       */
146 #define	DBREG_DR7_WRONLY	0x01	/* break on write         */
147 #define	DBREG_DR7_RDWR		0x03	/* break on read or write */
148 #define	DBREG_DR7_MASK(i)	(0xf << ((i) * 4 + 16) | 0x3 << (i) * 2)
149 #define	DBREG_DR7_SET(i, len, access, enable)				\
150 	(((len) << 2 | (access)) << ((i) * 4 + 16) | (enable) << (i) * 2)
151 #define	DBREG_DR7_GD		0x2000
152 #define	DBREG_DR7_ENABLED(d, i)	(((d) & 0x3 << (i) * 2) != 0)
153 #define	DBREG_DR7_ACCESS(d, i)	((d) >> ((i) * 4 + 16) & 0x3)
154 #define	DBREG_DR7_LEN(d, i)	((d) >> ((i) * 4 + 18) & 0x3)
155 
156 #define	DBREG_DRX(d,x)	((d)->dr[(x)])	/* reference dr0 - dr7 by
157 					   register number */
158 
159 #ifdef _KERNEL
160 /*
161  * XXX these interfaces are MI, so they should be declared in a MI place.
162  */
163 int	fill_regs(struct thread *, struct reg *);
164 int	set_regs(struct thread *, struct reg *);
165 int	fill_fpregs(struct thread *, struct fpreg *);
166 int	set_fpregs(struct thread *, struct fpreg *);
167 int	fill_dbregs(struct thread *, struct dbreg *);
168 int	set_dbregs(struct thread *, struct dbreg *);
169 #endif
170 
171 #endif /* !_MACHINE_REG_H_ */
172