summaryrefslogtreecommitdiffstats
path: root/c/src/lib/libcpu/powerpc/new-exceptions/raw_exception.h
blob: 7fc493a9ea17a27e4e508eb104b638ba626306dd (plain) (blame)
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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
/*
 * raw_execption.h
 *
 *	    This file contains implementation of C function to
 *          Instantiate 60x ppc primary exception entries.
 *	    More detailed information can be found on motorola
 *	    site and more precisely in the following book :
 *
 *		MPC750 
 *		Risc Microporcessor User's Manual
 *		Mtorola REF : MPC750UM/AD 8/97
 *
 * Copyright (C) 1999  Eric Valette (valette@crf.canon.fr)
 *                     Canon Centre Recherche France.
 *
 * Enhanced by Jay Kulpinski <jskulpin@eng01.gdds.com>
 * to support 603, 603e, 604, 604e exceptions
 *
 * moved to "libcpu/powerpc/new-exceptions and consolidated
 * by Thomas Doerfler <Thomas.Doerfler@embedded-brains.de>
 * to be common for all PPCs with new excpetions
 *
 *  The license and distribution terms for this file may be
 *  found in found in the file LICENSE in this distribution or at
 *  http://www.rtems.com/license/LICENSE.
 *
 * $Id$
 */

#ifndef _LIBCPU_RAW_EXCEPTION_H
#define _LIBCPU_RAW_EXCEPTION_H

#include <rtems/powerpc/powerpc.h>

/* For now, many BSPs still rely on <cpu_flavor> being defined
 * but that should be phased out.
 * The BSP support for exceptions and interrupts under 'bspsupp'
 * is designed to be #ifdef <flavor> FREE.
 * BSPs using 'bspsupp' should work with __ppc_generic
 */

#ifndef __ppc_generic

/*
 * find out, whether we want to (re)enable the MMU in the assembly code
 * FIXME: move this to a better location
 */
#if (defined(ppc403) || defined(ppc405))
#define PPC_USE_MMU 0
#else
#define PPC_USE_MMU 1
#endif

/*
 * Exception Vectors and offsets as defined in the MCP750 manual
 * used by most PPCs
 */

#define	ASM_RESET_VECTOR 		0x01
#define	ASM_RESET_VECTOR_OFFSET 	(ASM_RESET_VECTOR << 8)

#define	ASM_MACH_VECTOR			0x02
#define	ASM_MACH_VECTOR_OFFSET 		(ASM_MACH_VECTOR  << 8)

#define	ASM_PROT_VECTOR			0x03
#define	ASM_PROT_VECTOR_OFFSET 		(ASM_PROT_VECTOR  << 8)

#define	ASM_ISI_VECTOR 			0x04
#define	ASM_ISI_VECTOR_OFFSET 		(ASM_ISI_VECTOR   << 8)

#define	ASM_EXT_VECTOR 			0x05
#define	ASM_EXT_VECTOR_OFFSET 		(ASM_EXT_VECTOR   << 8)

#define	ASM_ALIGN_VECTOR 		0x06
#define	ASM_ALIGN_VECTOR_OFFSET 	(ASM_ALIGN_VECTOR << 8)

#define	ASM_PROG_VECTOR			0x07
#define	ASM_PROG_VECTOR_OFFSET 		(ASM_PROG_VECTOR  << 8)

#define	ASM_FLOAT_VECTOR		0x08
#define	ASM_FLOAT_VECTOR_OFFSET		(ASM_FLOAT_VECTOR << 8)

#define	ASM_DEC_VECTOR			0x09
#define	ASM_DEC_VECTOR_OFFSET		(ASM_DEC_VECTOR   << 8)

/* Bummer: Altivec unavailable doesn't fit into this scheme... (0xf20).
 *    We'd like to avoid reserved vectors but OTOH we don't want to use
 *    just an available high number because tables (and copies) are of
 *    size LAST_VALID_EXC.
 *    So until there is a CPU that uses 0xA we'll just use that :-(
 */
#define ASM_60X_VEC_VECTOR			0x0A
#define ASM_60X_VEC_VECTOR_OFFSET		(0xf20)

#define	ASM_SYS_VECTOR			0x0C
#define	ASM_SYS_VECTOR_OFFSET		(ASM_SYS_VECTOR   << 8)

#define	ASM_TRACE_VECTOR		0x0D
#define	ASM_TRACE_VECTOR_OFFSET		(ASM_TRACE_VECTOR << 8)

#if defined(ppc405)
     /*
      * vectors for PPC405
      */
#define	ASM_BOOKE_CRIT_VECTOR                 ASM_RESET_VECTOR
#define	ASM_BOOKE_CRIT_VECTOR_OFFSET          (ASM_BOOKE_CRIT_VECTOR << 8)	

#define	ASM_BOOKE_PIT_VECTOR	                0x10
#define	ASM_BOOKE_PIT_VECTOR_OFFSET           (ASM_BOOKE_PIT_VECTOR      << 8)

#define	ASM_BOOKE_ITLBMISS_VECTOR             0x11
#define	ASM_BOOKE_ITLBMISS_VECTOR_OFFSET      (ASM_BOOKE_ITLBMISS_VECTOR << 8)

#define	ASM_BOOKE_DTLBMISS_VECTOR             0x12
#define	ASM_BOOKE_DTLBMISS_VECTOR_OFFSET      (ASM_BOOKE_DTLBMISS_VECTOR << 8)

#define	ASM_BOOKE_FIT_VECTOR                  0x13
#define	ASM_BOOKE_FIT_VECTOR_OFFSET	        (0x1010)

#define	ASM_BOOKE_WDOG_VECTOR                 0x14
#define	ASM_BOOKE_WDOG_VECTOR_OFFSET	        (0x1020)

#define LAST_VALID_EXC                  ASM_BOOKE_WDOG_VECTOR

/*
 * bit mask of all exception vectors, that are handled
 * as "critical" exsceptions (using SRR2/SRR3/rfci)
 * this value will be evaluated in the default exception entry/exit
 * code to determine, whether to use SRR0/SRR1/rfi or SRR2/SRR3/rfci
 */
#define ASM_VECTORS_CRITICAL			\
  (( 1 << (31-ASM_BOOKE_CRIT_VECTOR))			\
   |(1 << (31-ASM_MACH_VECTOR))			\
   |(1 << (31-ASM_WDOG_VECTOR)))

#elif ( defined(mpc860) || defined(mpc821) )
     /*
      * vectors for MPC8xx
      */

/*
 * FIXME: even more vector names might get used in common,
 * but the names have diverged between different PPC families
 */
#define	ASM_8XX_FLOATASSIST_VECTOR	      0x0E
#define	ASM_8XX_FLOATASSIST_VECTOR_OFFSET (ASM_8XX_FLOATASSIST_VECTOR << 8)

#define	ASM_8XX_SOFTEMUL_VECTOR	      0x10
#define	ASM_8XX_SOFTEMUL_VECTOR_OFFSET    (ASM_8XX_SOFTEMUL_VECTOR << 8)

#define	ASM_8XX_ITLBMISS_VECTOR           0x11
#define	ASM_8XX_ITLBMISS_VECTOR_OFFSET    (ASM_8XX_ITLBMISS_VECTOR << 8)

#define	ASM_8XX_DTLBMISS_VECTOR           0x12
#define	ASM_8XX_DTLBMISS_VECTOR_OFFSET    (ASM_8XX_DTLBMISS_VECTOR << 8)

#define	ASM_8XX_ITLBERROR_VECTOR          0x13
#define	ASM_8XX_ITLBERROR_VECTOR_OFFSET   (ASM_8XX_ITLBERROR_VECTOR << 8)

#define	ASM_8XX_DTLBERROR_VECTOR          0x14
#define	ASM_8XX_DTLBERROR_VECTOR_OFFSET   (ASM_8XX_DTLBERROR_VECTOR << 8)

#define ASM_8XX_DBREAK_VECTOR             0x1C
#define ASM_8XX_DBREAK_VECTOR_OFFSET      (ASM_8XX_DBREAK_VECTOR << 8)

#define ASM_8XX_IBREAK_VECTOR             0x1D
#define ASM_8XX_IBREAK_VECTOR_OFFSET      (ASM_8XX_IBREAK_VECTOR << 8)

#define ASM_8XX_PERIFBREAK_VECTOR         0x1E
#define ASM_8XX_PERIFBREAK_VECTOR_OFFSET  (ASM_8XX_PERIFBREAK_VECTOR << 8)

#define ASM_8XX_DEVPORT_VECTOR            0x1F
#define ASM_8XX_DEVPORT_VECTOR_OFFSET     (ASM_8XX_DEVPORT_VECTOR_OFFSET << 8)

#define LAST_VALID_EXC		ASM_8XX_DEVPORT_VECTOR

#elif (defined(mpc555) || defined(mpc505))
     /*
      * vectorx for MPC5xx
      */
#define	ASM_5XX_FLOATASSIST_VECTOR	0x0E

#define	ASM_5XX_SOFTEMUL_VECTOR	0x10

#define	ASM_5XX_IPROT_VECTOR	0x13
#define	ASM_5XX_DPROT_VECTOR	0x14

#define ASM_5XX_DBREAK_VECTOR	0x1C
#define ASM_5XX_IBREAK_VECTOR	0x1D
#define ASM_5XX_MEBREAK_VECTOR	0x1E
#define ASM_5XX_NMEBREAK_VECTOR	0x1F

#define LAST_VALID_EXC		ASM_5XX_NMEBREAK_VECTOR

#else /* 60x style cpu types */
#define PPC_HAS_60X_VECTORS

#define	ASM_60X_PERFMON_VECTOR		0x0F
#define	ASM_60X_PERFMON_VECTOR_OFFSET	(ASM_60X_PERFMON_VECTOR << 8)

#define	ASM_60X_IMISS_VECTOR		0x10

#define	ASM_60X_DLMISS_VECTOR		0x11

#define	ASM_60X_DSMISS_VECTOR		0x12

#define	ASM_60X_ADDR_VECTOR			0x13
#define	ASM_60X_ADDR_VECTOR_OFFSET	        (ASM_60X_ADDR_VECTOR  << 8)

#define	ASM_60X_SYSMGMT_VECTOR		0x14
#define	ASM_60X_SYSMGMT_VECTOR_OFFSET	(ASM_60X_SYSMGMT_VECTOR << 8)

#define ASM_60X_VEC_ASSIST_VECTOR           0x16
#define ASM_60X_VEC_ASSIST_VECTOR_OFFSET    (ASM_60X_VEC_ASSIST_VECTOR << 8)

#define	ASM_60X_ITM_VECTOR                  0x17
#define	ASM_60X_ITM_VECTOR_OFFSET           (ASM_60X_ITM_VECTOR   << 8)

#define LAST_VALID_EXC                  ASM_60X_ITM_VECTOR

#endif

     /*
      * bits to be set in MSR in exception entry code
      */
#if                     ( PPC_HAS_RI) && ( PPC_USE_MMU)
#define PPC_MSR_EXC_BITS (PPC_MSR_RI   | PPC_MSR_DR | PPC_MSR_IR)
#elif                   ( PPC_HAS_RI) && (!PPC_USE_MMU)
#define PPC_MSR_EXC_BITS (PPC_MSR_RI)
#elif                   (!PPC_HAS_RI) && ( PPC_USE_MMU)
#define PPC_MSR_EXC_BITS (               PPC_MSR_DR | PPC_MSR_IR)
#else
#endif

#else  /* __ppc_generic */

#define	ASM_RESET_VECTOR 		             0x01
#define	ASM_MACH_VECTOR			             0x02
#define	ASM_PROT_VECTOR			             0x03
#define	ASM_ISI_VECTOR 			             0x04
#define	ASM_EXT_VECTOR 			             0x05
#define	ASM_ALIGN_VECTOR 		             0x06
#define	ASM_PROG_VECTOR			             0x07
#define	ASM_FLOAT_VECTOR		             0x08
#define	ASM_DEC_VECTOR			             0x09
#define ASM_60X_VEC_VECTOR			         0x0A
#define	ASM_SYS_VECTOR			             0x0C
#define	ASM_TRACE_VECTOR		             0x0D

#define	ASM_BOOKE_CRIT_VECTOR	             0x01
#define	ASM_BOOKE_PIT_VECTOR	             0x10
#define	ASM_BOOKE_ITLBMISS_VECTOR            0x11
#define	ASM_BOOKE_DTLBMISS_VECTOR            0x12
#define	ASM_BOOKE_FIT_VECTOR                 0x13
#define	ASM_BOOKE_WDOG_VECTOR                0x14

#define	ASM_8XX_FLOATASSIST_VECTOR	         0x0E
#define	ASM_8XX_SOFTEMUL_VECTOR	             0x10
#define	ASM_8XX_ITLBMISS_VECTOR              0x11
#define	ASM_8XX_DTLBMISS_VECTOR              0x12
#define	ASM_8XX_ITLBERROR_VECTOR             0x13
#define	ASM_8XX_DTLBERROR_VECTOR             0x14
#define ASM_8XX_DBREAK_VECTOR                0x1C
#define ASM_8XX_IBREAK_VECTOR                0x1D
#define ASM_8XX_PERIFBREAK_VECTOR            0x1E
#define ASM_8XX_DEVPORT_VECTOR               0x1F

#define	ASM_5XX_FLOATASSIST_VECTOR	         0x0E
#define	ASM_5XX_SOFTEMUL_VECTOR	             0x10
#define	ASM_5XX_IPROT_VECTOR	             0x13
#define	ASM_5XX_DPROT_VECTOR	             0x14
#define ASM_5XX_DBREAK_VECTOR	             0x1C
#define ASM_5XX_IBREAK_VECTOR	             0x1D
#define ASM_5XX_MEBREAK_VECTOR	             0x1E
#define ASM_5XX_NMEBREAK_VECTOR	             0x1F


#define	ASM_60X_PERFMON_VECTOR               0x0F
#define	ASM_60X_IMISS_VECTOR                 0x10
#define	ASM_60X_DLMISS_VECTOR                0x11
#define	ASM_60X_DSMISS_VECTOR                0x12
#define	ASM_60X_ADDR_VECTOR                  0x13
#define	ASM_60X_SYSMGMT_VECTOR               0x14
#define ASM_60X_VEC_ASSIST_VECTOR            0x16
#define	ASM_60X_ITM_VECTOR                   0x17

#define LAST_VALID_EXC                       0x1F

#endif /* __ppc_generic */


#ifndef ASM

/*
 * Type definition for raw exceptions. 
 */

typedef unsigned char  rtems_vector;
struct 	__rtems_raw_except_connect_data__;
typedef void 		(*rtems_raw_except_func)		(void);
typedef unsigned long 	rtems_raw_except_hdl_size;

typedef struct {
  rtems_vector			vector;
  rtems_raw_except_func		raw_hdl;
  rtems_raw_except_hdl_size	raw_hdl_size;
}rtems_raw_except_hdl;
  
typedef void (*rtems_raw_except_enable)		(const struct __rtems_raw_except_connect_data__*);
typedef void (*rtems_raw_except_disable)	(const struct __rtems_raw_except_connect_data__*);
typedef int  (*rtems_raw_except_is_enabled)	(const struct __rtems_raw_except_connect_data__*);

typedef struct __rtems_raw_except_connect_data__{
 /*
  * Exception vector (As defined in the manual)
  */
  rtems_vector			exceptIndex;
  /*
   * Exception raw handler. See comment on handler properties below in function prototype.
   */
  rtems_raw_except_hdl	   	hdl;
  /*
   * function for enabling raw exceptions. In order to be consistent
   * with the fact that the raw connexion can defined in the
   * libcpu library, this library should have no knowledge of
   * board specific hardware to manage exceptions and thus the
   * "on" routine must enable the except at processor level only.
   * 
   */
    rtems_raw_except_enable	on;	
  /*
   * function for disabling raw exceptions. In order to be consistent
   * with the fact that the raw connexion can defined in the
   * libcpu library, this library should have no knowledge of
   * board specific hardware to manage exceptions and thus the
   * "on" routine must disable the except both at device and PIC level.
   * 
   */
  rtems_raw_except_disable	off;
  /*
   * function enabling to know what exception may currently occur
   */
  rtems_raw_except_is_enabled	isOn;
}rtems_raw_except_connect_data;

typedef struct {
  /*
   * size of all the table fields (*Tbl) described below.
   */
  unsigned int	 			exceptSize;
  /*
   * Default handler used when disconnecting exceptions.
   */
  rtems_raw_except_connect_data		defaultRawEntry;
  /*
   * Table containing initials/current value.
   */
  rtems_raw_except_connect_data*	rawExceptHdlTbl;
}rtems_raw_except_global_settings;

/*
 * Exceptions of different categories use different SRR registers
 * to save machine state (:-()
 */
typedef enum {
	PPC_EXC_INVALID        = 0,
	PPC_EXC_CLASSIC        = 1,
	PPC_EXC_405_CRITICAL   = 2,
	PPC_EXC_BOOKE_CRITICAL = 3,
	PPC_EXC_E500_MACHCHK   = 4,
	PPC_EXC_ASYNC          = 0x10000,
} ppc_raw_exception_category;

/*
 * C callable function enabling to set up one raw idt entry
 */
extern int ppc_set_exception (const rtems_raw_except_connect_data*);

/*
 * C callable function enabling to get one current raw idt entry
 */
extern int ppc_get_current_exception (rtems_raw_except_connect_data*);

/*
 * C callable function enabling to remove one current raw idt entry
 */
extern int ppc_delete_exception (const rtems_raw_except_connect_data*);

/*
 * C callable function enabling to check if vector is valid
 * and returns category.
 */
extern ppc_raw_exception_category ppc_vector_is_valid(rtems_vector vector);

/*
 * Exception global init.
 */
extern int ppc_init_exceptions (rtems_raw_except_global_settings* config);
extern int ppc_get_exception_config (rtems_raw_except_global_settings** config);

void* ppc_get_vector_addr(rtems_vector vector);

int ppc_is_e500();
void e500_setup_raw_exceptions();

/* This variable is initialized to 'TRUE' by default;
 * BSPs which have their vectors in ROM should set it
 * to FALSE prior to initializing raw exceptions.
 *
 * I suspect the only candidate is the simulator.
 * After all, the value of this variable is used to
 * determine where to install the prologue code and
 * installing to ROM on anyting that's real ROM
 * will fail anyways.
 *
 * This should probably go away... (T.S. 2007/11/30)
 */
extern boolean bsp_exceptions_in_RAM;

# endif /* ASM */

#endif