summaryrefslogtreecommitdiff
path: root/sys/arch/mvme88k/include/asm.h
blob: 40a1cd2caf0b5a4c876ad009bb6cffeb48072a69 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
/*
 * Mach Operating System
 * Copyright (c) 1993-1992 Carnegie Mellon University
 * Copyright (c) 1991 OMRON Corporation
 * All Rights Reserved.
 *
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 *
 * CARNEGIE MELLON AND OMRON ALLOW FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON AND OMRON DISCLAIM ANY LIABILITY OF ANY KIND
 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 *
 * Carnegie Mellon requests users of this software to return to
 *
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 *
 * any improvements or extensions that they make and grant Carnegie the
 * rights to redistribute these changes.
 */

#ifndef __MACHINE_M88K_ASM_H__
#define __MACHINE_M88K_ASM_H__

#ifdef __STDC__
#	define FUNC(NAME) _##NAME
#else
#	define FUNC(NAME) _/**/NAME
#endif

/* Define EH_DEBUG to be non-zero to compile-in various debugging things */
#ifndef	EH_DEBUG
#define EH_DEBUG 1
#endif	EH_DEBUG

#if 0
/* this gives the offsets into various structures of various elements, etc */
#include "assym.s"
#endif

#define	ENTRY(NAME) \
    .align 8; .globl FUNC(NAME); FUNC(NAME):
    

#define  LABEL(name)	 name:  .globl name ;
/*
 * _LABEL(name)
 *	Defines one visible only to the file, unless debugging
 * 	is enabled, in which case it's visible to the world (and
 *	hence to debuggers, and such).
 */
#if EH_DEBUG
#  define _LABEL(name)	name:	.globl name ;
#else
#  define _LABEL(name)	name:               ;
#endif

#define RTE	NOP ; rte

#define PID    cr0
#define PSR    cr1
#define EPSR	cr2
#define SSBR	cr3
#define SXIP	cr4
#define SNIP	cr5
#define SFIP	cr6
#define VBR    cr7
#define DMT0	cr8
#define DMD0	cr9
#define DMA0	cr10
#define DMT1	cr11
#define DMD1	cr12
#define DMA1	cr13
#define DMT2	cr14
#define DMD2	cr15
#define DMA2	cr16
#define SRX    cr16 
#define SR0    cr17
#define SR1    cr18
#define SR2    cr19
#define SR3    cr20

/* MVME197 only */
#define SRX    cr16 
#define EXIP	cr4
#define ENIP	cr5
#define ICMD   cr25
#define ICTL   cr26
#define ISAR   cr27
#define ISAP   cr28
#define IUAP   cr29
#define IIR    cr30
#define IBP    cr31
#define IPPU   cr32
#define IPPL   cr33
#define ISR    cr34
#define ILAR   cr35
#define IPAR   cr36
#define DCMD   cr40
#define DCTL   cr41
#define DSAR   cr42
#define DSAP   cr43
#define DUAP   cr44
#define DIR    cr45
#define DBP    cr46
#define DPPU   cr47
#define DPPL   cr48
#define DSR    cr49
#define DLAR   cr50
#define DPAR   cr51
/* end MVME197 only */

#define FPECR	fcr0
#define FPHS1	fcr1
#define FPLS1	fcr2
#define FPHS2	fcr3
#define FPLS2	fcr4
#define FPPT	fcr5
#define FPRH	fcr6
#define FPRL	fcr7
#define FPIT	fcr8
#define FPSR	fcr62
#define FPCR	fcr63

/*
 * At various times, there is the need to clear the pipeline (i.e.
 * synchronize).  A "tb1 0, r0, foo" will do that (because a trap
 * instruction always synchronizes, and this particular instruction
 * will never actually take the trap).
 */
#if 0
#define FLUSH_PIPELINE	tcnd	ne0, r0, 0
#else
#define FLUSH_PIPELINE	tb1 0, r0, 0
#endif
#define NOP		or r0, r0, r0

/*
 * Useful in some situations.
 * NOTE: If ARG1 or ARG2 are r2 or r3, strange things may happen.  Watch out!
 */
#define CALL(NAME, ARG1, ARG2)             \
  		subu	r31, r31, 32	; \
                or      r2, r0, ARG1    ; \
                bsr.n   NAME            ; \
                or      r3, r0, ARG2	; \
		addu	r31, r31, 32

/* This define is similar to CALL, but accepts a function pointer XXX smurph */
#define CALLP(NAME, ARG1, ARG2)              \
  		subu	r31, r31, 32	   ; \
                or.u	r5, r0, hi16(NAME) ; \
                ld	r4, r5, lo16(NAME) ; \
		or      r2, r0, ARG1       ; \
                jsr.n   r4                 ; \
                or      r3, r0, ARG2	   ; \
		addu	r31, r31, 32

/* This define can replace the xcr instruction XXX smurph */
#define XCR(DR, SR, CR)         ; \
      stcr   r13,    SR0   ; \
      or      r13, r0, SR     ; \
                ldcr   DR, CR      ; \
      stcr   r13, CR      ; \
      ldcr   r13, SR0

/* This define can be used to debug sub routine returns XXX smurph*/
#define STORE_R1(varname)               ; \
      stcr   r13,    SR0   /* r13 now free */   ; \
      /* save r1 to memory location varname */   ; \
      or.u   r13, r0,  hi16(varname)         ; \
      st   r1,  r13, lo16(varname)         ; \
      ldcr   r13, SR0   /* retore r13   */   

/*
 * SR1 - CPU FLAGS REGISTER
 * XXX clean this when the trap handler is reworked. Among the things
 * I like to see is having the trap frame on the kernel stack instead
 * of putting in the PCB. If done properly, we don't need SR1 for doing
 * anything special. nivas
 * 
 * SR1 contains flags about the current CPU status.
 *
 * The bit FLAG_IGNORE_DATA_EXCEPTION indicates that any data exceptions
 * 	should be ignored (well, at least treated in a special way).
 * The bit FLAG_INTERRUPT_EXCEPTION indicates that the current exception
 * 	is the interrupt exception.  Such information can be gotten
 * 	in other ways, but having it in the flags makes it easy for the
 *	exception handler to check quickly.
 * The bit FLAG_ENABLING_FPU indicates that the exception handler is
 * 	in the process of enabling the FPU (so that an exception can
 * 	be serviced).  This is needed because enabling the FPU can
 *	cause other exceptions to happen, and the whole system is
 *	in a rather precarious state and so special cautions must
 * 	be taken.
 */
#define FLAG_CPU_FIELD_WIDTH		2	/* must be <= 12 */
#define FLAG_IGNORE_DATA_EXCEPTION	5	/* bit number 5  */
#define FLAG_INTERRUPT_EXCEPTION	6	/* bit number 6  */
#define FLAG_ENABLING_FPU		7	/* bit number 7  */
#define FLAG_FROM_KERNEL		8	/* bit number 8  */
#define FLAG_187			9	/* bit number 9  */
#define FLAG_188			10	/* bit number 10 */
#define FLAG_197			11	/* bit number 11 */

/* REGister OFFset into the E.F. (exception frame) */
#define REG_OFF(reg_num)  ((reg_num) * 4) /* (num * sizeof(register int))  */
#define GENREG_OFF(num)	(REG_OFF(EF_R0 + (num))) /* GENeral REGister OFFset */

#define GENERAL_BREATHING_ROOM	/* arbitrarily */ 200
#define KERNEL_STACK_BREATHING_ROOM 	\
	(GENERAL_BREATHING_ROOM + SIZEOF_STRUCT_PCB + SIZEOF_STRUCT_UTHREAD)

/*
 * Some registers used during the setting up of the new exception frame.
 * Don't choose r1, r30, or r31 for any of them.
 *
 * Also, if any are 'r2' or 'r3', be careful using with CALL above!
 */
#define FLAGS	r2
#define TMP	r3
#define TMP2	r10
#define TMP3	r11
#define SAVE_TMP2	st	r10, r31, GENREG_OFF(10)
#define SAVE_TMP3	st	r11, r31, GENREG_OFF(11)
#define RESTORE_TMP2	ld	r10, r31, GENREG_OFF(10)
#define RESTORE_TMP3	ld	r11, r31, GENREG_OFF(11)

/*
 * Info about the PSR 
 */
#define PSR_SHADOW_FREEZE_BIT		 0
#define PSR_INTERRUPT_DISABLE_BIT	 1
#define PSR_FPU_DISABLE_BIT		 3
#define PSR_BIG_ENDIAN_MODE		30
#define PSR_SUPERVISOR_MODE_BIT		31

/*
 * Status bits for an SXIP/SNIP/SFIP address.
 */
#define RTE_VALID_BIT	 1
#define RTE_ERROR_BIT	 0

/*
 * Info about DMT0/DMT1/DMT2
 */
#define DMT_VALID_BIT	 0
#define DMT_WRITE_BIT 	 1
#define DMT_LOCK_BIT	12
#define DMT_DOUBLE_BIT	13
#define DMT_DAS_BIT     14
#define DMT_DREG_OFFSET	 7
#define DMT_DREG_WIDTH	 5

/*
 * Bits for eh_debug.
 */
#define DEBUG_INTERRUPT_BIT	0
#define DEBUG_DATA_BIT			1
#define DEBUG_INSTRUCTION_BIT	2
#define DEBUG_MISALIGN_BIT		3
#define DEBUG_UNIMP_BIT			4
#define DEBUG_DIVIDE_BIT		5
#define DEBUG_OF_BIT			   6
#define DEBUG_FPp_BIT			7
#define DEBUG_FPi_BIT			8
#define DEBUG_SYSCALL_BIT	 	9
#define DEBUG_MACHSYSCALL_BIT	10
#define DEBUG_UNIMPLEMENTED_BIT	11
#define DEBUG_PRIVILEGE_BIT	12
#define DEBUG_BOUNDS_BIT		13
#define DEBUG_OVERFLOW_BIT		14
#define DEBUG_ERROR_BIT			15
#define DEBUG_SIGSYS_BIT		16
#define DEBUG_SIGTRAP_BIT		17
#define DEBUG_BREAK_BIT			18
#define DEBUG_TRACE_BIT			19
#define DEBUG_KDB_BIT			20
#define DEBUG_JKDB_BIT			21
#define DEBUG_BUGCALL_BIT		22
#define DEBUG_NON_MASK_BIT	   23		/* MVME197 Non-Maskable Interrupt */
#define DEBUG_197_READ_BIT    25    /* MVME198 Data Read Miss (Software Table Searches) */
#define DEBUG_197_WRITE_BIT   26    /* MVME198 Data Write Miss (Software Table Searches) */
#define DEBUG_197_INST_BIT    27    /* MVME198 Inst ATC Miss (Software Table Searches) */

#define DEBUG_UNKNOWN_BIT		31

/*
 * These things for vector_init.c and locore.c
 */
#if defined(_LOCORE)
# define  PREDEFINED_BY_ROM       0xffffffff
# define  END_OF_VECTOR_LIST      0xfffffffe
#else
# define  PREDEFINED_BY_ROM       0xffffffffU
# define  END_OF_VECTOR_LIST      0xfffffffeU
#endif

/*
 * Define ERROR__XXX_USR if the xxx.usr bug (mask C82N) is present.
 * This implements the workaround.
 */
#define ERRATA__XXX_USR 	1

#ifndef CMMU_DEFS
#define CMMU_DEFS
#define SBC_CMMU_I		0xFFF77000 	/* Single Board Computer code CMMU */
#define SBC_CMMU_D		0xFFF7F000 	/* Single Board Computer data CMMU */

#define VME_CMMU_I0		0xFFF7E000 	/* MVME188 code CMMU 0 */
#define VME_CMMU_I1		0xFFF7D000 	/* MVME188 code CMMU 1 */
#define VME_CMMU_I2		0xFFF7B000 	/* MVME188 code CMMU 2 */
#define VME_CMMU_I3		0xFFF77000 	/* MVME188 code CMMU 3 */
#define VME_CMMU_D0		0xFFF6F000 	/* MVME188 data CMMU 0 */
#define VME_CMMU_D1		0xFFF5F000 	/* MVME188 data CMMU 1 */
#define VME_CMMU_D2		0xFFF3F000 	/* MVME188 data CMMU 2 */
#define VME_CMMU_D3		0xFFF7F000 	/* MVME188 data CMMU 3 */
#endif /* CMMU_DEFS */

#endif __MACHINE_M88K_ASM_H__