[MIPS] <asm/mipsregs.h>: CodinygStyle cleanups
[platform/kernel/u-boot.git] / include / asm-mips / mipsregs.h
1 /*
2  * This file is subject to the terms and conditions of the GNU General Public
3  * License.  See the file "COPYING" in the main directory of this archive
4  * for more details.
5  *
6  * Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001 by Ralf Baechle
7  * Copyright (C) 2000 Silicon Graphics, Inc.
8  * Modified for further R[236]000 support by Paul M. Antoine, 1996.
9  * Kevin D. Kissell, kevink@mips.com and Carsten Langgaard, carstenl@mips.com
10  * Copyright (C) 2000 MIPS Technologies, Inc.  All rights reserved.
11  * Copyright (C) 2003  Maciej W. Rozycki
12  */
13 #ifndef _ASM_MIPSREGS_H
14 #define _ASM_MIPSREGS_H
15
16 #if 0
17 #include <linux/linkage.h>
18 #endif
19
20 /*
21  * The following macros are especially useful for __asm__
22  * inline assembler.
23  */
24 #ifndef __STR
25 #define __STR(x) #x
26 #endif
27 #ifndef STR
28 #define STR(x) __STR(x)
29 #endif
30
31 /*
32  * Coprocessor 0 register names
33  */
34 #define CP0_INDEX $0
35 #define CP0_RANDOM $1
36 #define CP0_ENTRYLO0 $2
37 #define CP0_ENTRYLO1 $3
38 #define CP0_CONF $3
39 #define CP0_CONTEXT $4
40 #define CP0_PAGEMASK $5
41 #define CP0_WIRED $6
42 #define CP0_INFO $7
43 #define CP0_BADVADDR $8
44 #define CP0_COUNT $9
45 #define CP0_ENTRYHI $10
46 #define CP0_COMPARE $11
47 #define CP0_STATUS $12
48 #define CP0_CAUSE $13
49 #define CP0_EPC $14
50 #define CP0_PRID $15
51 #define CP0_CONFIG $16
52 #define CP0_LLADDR $17
53 #define CP0_WATCHLO $18
54 #define CP0_WATCHHI $19
55 #define CP0_XCONTEXT $20
56 #define CP0_FRAMEMASK $21
57 #define CP0_DIAGNOSTIC $22
58 #define CP0_PERFORMANCE $25
59 #define CP0_ECC $26
60 #define CP0_CACHEERR $27
61 #define CP0_TAGLO $28
62 #define CP0_TAGHI $29
63 #define CP0_ERROREPC $30
64
65 /*
66  * R4640/R4650 cp0 register names.  These registers are listed
67  * here only for completeness; without MMU these CPUs are not useable
68  * by Linux.  A future ELKS port might take make Linux run on them
69  * though ...
70  */
71 #define CP0_IBASE $0
72 #define CP0_IBOUND $1
73 #define CP0_DBASE $2
74 #define CP0_DBOUND $3
75 #define CP0_CALG $17
76 #define CP0_IWATCH $18
77 #define CP0_DWATCH $19
78
79 /*
80  * Coprocessor 0 Set 1 register names
81  */
82 #define CP0_S1_DERRADDR0  $26
83 #define CP0_S1_DERRADDR1  $27
84 #define CP0_S1_INTCONTROL $20
85 /*
86  * Coprocessor 1 (FPU) register names
87  */
88 #define CP1_REVISION    $0
89 #define CP1_STATUS      $31
90
91 /*
92  * FPU Status Register Values
93  */
94 /*
95  * Status Register Values
96  */
97
98 #define FPU_CSR_FLUSH   0x01000000      /* flush denormalised results to 0 */
99 #define FPU_CSR_COND    0x00800000      /* $fcc0 */
100 #define FPU_CSR_COND0   0x00800000      /* $fcc0 */
101 #define FPU_CSR_COND1   0x02000000      /* $fcc1 */
102 #define FPU_CSR_COND2   0x04000000      /* $fcc2 */
103 #define FPU_CSR_COND3   0x08000000      /* $fcc3 */
104 #define FPU_CSR_COND4   0x10000000      /* $fcc4 */
105 #define FPU_CSR_COND5   0x20000000      /* $fcc5 */
106 #define FPU_CSR_COND6   0x40000000      /* $fcc6 */
107 #define FPU_CSR_COND7   0x80000000      /* $fcc7 */
108
109 /*
110  * X the exception cause indicator
111  * E the exception enable
112  * S the sticky/flag bit
113  */
114 #define FPU_CSR_ALL_X   0x0003f000
115 #define FPU_CSR_UNI_X   0x00020000
116 #define FPU_CSR_INV_X   0x00010000
117 #define FPU_CSR_DIV_X   0x00008000
118 #define FPU_CSR_OVF_X   0x00004000
119 #define FPU_CSR_UDF_X   0x00002000
120 #define FPU_CSR_INE_X   0x00001000
121
122 #define FPU_CSR_ALL_E   0x00000f80
123 #define FPU_CSR_INV_E   0x00000800
124 #define FPU_CSR_DIV_E   0x00000400
125 #define FPU_CSR_OVF_E   0x00000200
126 #define FPU_CSR_UDF_E   0x00000100
127 #define FPU_CSR_INE_E   0x00000080
128
129 #define FPU_CSR_ALL_S   0x0000007c
130 #define FPU_CSR_INV_S   0x00000040
131 #define FPU_CSR_DIV_S   0x00000020
132 #define FPU_CSR_OVF_S   0x00000010
133 #define FPU_CSR_UDF_S   0x00000008
134 #define FPU_CSR_INE_S   0x00000004
135
136 /* rounding mode */
137 #define FPU_CSR_RN      0x0     /* nearest */
138 #define FPU_CSR_RZ      0x1     /* towards zero */
139 #define FPU_CSR_RU      0x2     /* towards +Infinity */
140 #define FPU_CSR_RD      0x3     /* towards -Infinity */
141
142 /*
143  * Values for PageMask register
144  */
145 #include <linux/config.h>
146 #ifdef CONFIG_CPU_VR41XX
147
148 #define PM_1K           0x00000000
149 #define PM_4K           0x00001800
150 #define PM_16K          0x00007800
151 #define PM_64K          0x0001f800
152 #define PM_256K         0x0007f800
153
154 #else
155
156 #define PM_4K           0x00000000
157 #define PM_16K          0x00006000
158 #define PM_64K          0x0001e000
159 #define PM_256K         0x0007e000
160 #define PM_1M           0x001fe000
161 #define PM_4M           0x007fe000
162 #define PM_16M          0x01ffe000
163
164 #endif
165
166 /*
167  * Values used for computation of new tlb entries
168  */
169 #define PL_4K           12
170 #define PL_16K          14
171 #define PL_64K          16
172 #define PL_256K         18
173 #define PL_1M           20
174 #define PL_4M           22
175 #define PL_16M          24
176
177 /*
178  * Macros to access the system control coprocessor
179  */
180 #define read_32bit_cp0_register(source)                         \
181 ({ int __res;                                                   \
182         __asm__ __volatile__(                                   \
183         ".set\tpush\n\t"                                        \
184         ".set\treorder\n\t"                                     \
185         "mfc0\t%0,"STR(source)"\n\t"                            \
186         ".set\tpop"                                             \
187         : "=r" (__res));                                        \
188         __res;})
189
190 #define read_32bit_cp0_set1_register(source)                    \
191 ({ int __res;                                                   \
192         __asm__ __volatile__(                                   \
193         ".set\tpush\n\t"                                        \
194         ".set\treorder\n\t"                                     \
195         "cfc0\t%0,"STR(source)"\n\t"                            \
196         ".set\tpop"                                             \
197         : "=r" (__res));                                        \
198         __res;})
199
200 /*
201  * For now use this only with interrupts disabled!
202  */
203 #define read_64bit_cp0_register(source)                         \
204 ({ int __res;                                                   \
205         __asm__ __volatile__(                                   \
206         ".set\tmips3\n\t"                                       \
207         "dmfc0\t%0,"STR(source)"\n\t"                           \
208         ".set\tmips0"                                           \
209         : "=r" (__res));                                        \
210         __res;})
211
212 #define write_32bit_cp0_register(register,value)                \
213         __asm__ __volatile__(                                   \
214         "mtc0\t%0,"STR(register)"\n\t"                          \
215         "nop"                                                   \
216         : : "r" (value));
217
218 #define write_32bit_cp0_set1_register(register,value)           \
219         __asm__ __volatile__(                                   \
220         "ctc0\t%0,"STR(register)"\n\t"                          \
221         "nop"                                                   \
222         : : "r" (value));
223
224 #define write_64bit_cp0_register(register,value)                \
225         __asm__ __volatile__(                                   \
226         ".set\tmips3\n\t"                                       \
227         "dmtc0\t%0,"STR(register)"\n\t"                         \
228         ".set\tmips0"                                           \
229         : : "r" (value))
230
231 /*
232  * This should be changed when we get a compiler that support the MIPS32 ISA.
233  */
234 #define read_mips32_cp0_config1()                               \
235 ({ int __res;                                                   \
236         __asm__ __volatile__(                                   \
237         ".set\tnoreorder\n\t"                                   \
238         ".set\tnoat\n\t"                                        \
239         ".word\t0x40018001\n\t"                                 \
240         "move\t%0,$1\n\t"                                       \
241         ".set\tat\n\t"                                          \
242         ".set\treorder"                                         \
243         :"=r" (__res));                                         \
244         __res;})
245
246 #define tlb_write_indexed()                                     \
247         __asm__ __volatile__(                                   \
248                 ".set noreorder\n\t"                            \
249                 "tlbwi\n\t"                                     \
250 ".set reorder")
251
252 /*
253  * R4x00 interrupt enable / cause bits
254  */
255 #define IE_SW0          (1<< 8)
256 #define IE_SW1          (1<< 9)
257 #define IE_IRQ0         (1<<10)
258 #define IE_IRQ1         (1<<11)
259 #define IE_IRQ2         (1<<12)
260 #define IE_IRQ3         (1<<13)
261 #define IE_IRQ4         (1<<14)
262 #define IE_IRQ5         (1<<15)
263
264 /*
265  * R4x00 interrupt cause bits
266  */
267 #define C_SW0           (1<< 8)
268 #define C_SW1           (1<< 9)
269 #define C_IRQ0          (1<<10)
270 #define C_IRQ1          (1<<11)
271 #define C_IRQ2          (1<<12)
272 #define C_IRQ3          (1<<13)
273 #define C_IRQ4          (1<<14)
274 #define C_IRQ5          (1<<15)
275
276 #ifndef _LANGUAGE_ASSEMBLY
277 /*
278  * Manipulate the status register.
279  * Mostly used to access the interrupt bits.
280  */
281 #define __BUILD_SET_CP0(name,register)                          \
282 extern __inline__ unsigned int                                  \
283 set_cp0_##name(unsigned int set)                                \
284 {                                                               \
285         unsigned int res;                                       \
286                                                                 \
287         res = read_32bit_cp0_register(register);                \
288         res |= set;                                             \
289         write_32bit_cp0_register(register, res);                \
290                                                                 \
291         return res;                                             \
292 }                                                               \
293                                                                 \
294 extern __inline__ unsigned int                                  \
295 clear_cp0_##name(unsigned int clear)                            \
296 {                                                               \
297         unsigned int res;                                       \
298                                                                 \
299         res = read_32bit_cp0_register(register);                \
300         res &= ~clear;                                          \
301         write_32bit_cp0_register(register, res);                \
302                                                                 \
303         return res;                                             \
304 }                                                               \
305                                                                 \
306 extern __inline__ unsigned int                                  \
307 change_cp0_##name(unsigned int change, unsigned int new)        \
308 {                                                               \
309         unsigned int res;                                       \
310                                                                 \
311         res = read_32bit_cp0_register(register);                \
312         res &= ~change;                                         \
313         res |= (new & change);                                  \
314         if(change)                                              \
315                 write_32bit_cp0_register(register, res);        \
316                                                                 \
317         return res;                                             \
318 }
319
320 __BUILD_SET_CP0(status,CP0_STATUS)
321 __BUILD_SET_CP0(cause,CP0_CAUSE)
322 __BUILD_SET_CP0(config,CP0_CONFIG)
323
324 #endif /* defined (_LANGUAGE_ASSEMBLY) */
325
326 /*
327  * Bitfields in the R4xx0 cp0 status register
328  */
329 #define ST0_IE                  0x00000001
330 #define ST0_EXL                 0x00000002
331 #define ST0_ERL                 0x00000004
332 #define ST0_KSU                 0x00000018
333 #  define KSU_USER              0x00000010
334 #  define KSU_SUPERVISOR        0x00000008
335 #  define KSU_KERNEL            0x00000000
336 #define ST0_UX                  0x00000020
337 #define ST0_SX                  0x00000040
338 #define ST0_KX                  0x00000080
339 #define ST0_DE                  0x00010000
340 #define ST0_CE                  0x00020000
341
342 /*
343  * Bitfields in the R[23]000 cp0 status register.
344  */
345 #define ST0_IEC                 0x00000001
346 #define ST0_KUC                 0x00000002
347 #define ST0_IEP                 0x00000004
348 #define ST0_KUP                 0x00000008
349 #define ST0_IEO                 0x00000010
350 #define ST0_KUO                 0x00000020
351 /* bits 6 & 7 are reserved on R[23]000 */
352 #define ST0_ISC                 0x00010000
353 #define ST0_SWC                 0x00020000
354 #define ST0_CM                  0x00080000
355
356 /*
357  * Bits specific to the R4640/R4650
358  */
359 #define ST0_UM                  (1   <<  4)
360 #define ST0_IL                  (1   << 23)
361 #define ST0_DL                  (1   << 24)
362
363 /*
364  * Bitfields in the TX39 family CP0 Configuration Register 3
365  */
366 #define TX39_CONF_ICS_SHIFT     19
367 #define TX39_CONF_ICS_MASK      0x00380000
368 #define TX39_CONF_ICS_1KB       0x00000000
369 #define TX39_CONF_ICS_2KB       0x00080000
370 #define TX39_CONF_ICS_4KB       0x00100000
371 #define TX39_CONF_ICS_8KB       0x00180000
372 #define TX39_CONF_ICS_16KB      0x00200000
373
374 #define TX39_CONF_DCS_SHIFT     16
375 #define TX39_CONF_DCS_MASK      0x00070000
376 #define TX39_CONF_DCS_1KB       0x00000000
377 #define TX39_CONF_DCS_2KB       0x00010000
378 #define TX39_CONF_DCS_4KB       0x00020000
379 #define TX39_CONF_DCS_8KB       0x00030000
380 #define TX39_CONF_DCS_16KB      0x00040000
381
382 #define TX39_CONF_CWFON         0x00004000
383 #define TX39_CONF_WBON          0x00002000
384 #define TX39_CONF_RF_SHIFT      10
385 #define TX39_CONF_RF_MASK       0x00000c00
386 #define TX39_CONF_DOZE          0x00000200
387 #define TX39_CONF_HALT          0x00000100
388 #define TX39_CONF_LOCK          0x00000080
389 #define TX39_CONF_ICE           0x00000020
390 #define TX39_CONF_DCE           0x00000010
391 #define TX39_CONF_IRSIZE_SHIFT  2
392 #define TX39_CONF_IRSIZE_MASK   0x0000000c
393 #define TX39_CONF_DRSIZE_SHIFT  0
394 #define TX39_CONF_DRSIZE_MASK   0x00000003
395
396 /*
397  * Status register bits available in all MIPS CPUs.
398  */
399 #define ST0_IM                  0x0000ff00
400 #define  STATUSB_IP0            8
401 #define  STATUSF_IP0            (1   <<  8)
402 #define  STATUSB_IP1            9
403 #define  STATUSF_IP1            (1   <<  9)
404 #define  STATUSB_IP2            10
405 #define  STATUSF_IP2            (1   << 10)
406 #define  STATUSB_IP3            11
407 #define  STATUSF_IP3            (1   << 11)
408 #define  STATUSB_IP4            12
409 #define  STATUSF_IP4            (1   << 12)
410 #define  STATUSB_IP5            13
411 #define  STATUSF_IP5            (1   << 13)
412 #define  STATUSB_IP6            14
413 #define  STATUSF_IP6            (1   << 14)
414 #define  STATUSB_IP7            15
415 #define  STATUSF_IP7            (1   << 15)
416 #define  STATUSB_IP8            0
417 #define  STATUSF_IP8            (1   << 0)
418 #define  STATUSB_IP9            1
419 #define  STATUSF_IP9            (1   << 1)
420 #define  STATUSB_IP10           2
421 #define  STATUSF_IP10           (1   << 2)
422 #define  STATUSB_IP11           3
423 #define  STATUSF_IP11           (1   << 3)
424 #define  STATUSB_IP12           4
425 #define  STATUSF_IP12           (1   << 4)
426 #define  STATUSB_IP13           5
427 #define  STATUSF_IP13           (1   << 5)
428 #define  STATUSB_IP14           6
429 #define  STATUSF_IP14           (1   << 6)
430 #define  STATUSB_IP15           7
431 #define  STATUSF_IP15           (1   << 7)
432 #define ST0_CH                  0x00040000
433 #define ST0_SR                  0x00100000
434 #define ST0_BEV                 0x00400000
435 #define ST0_RE                  0x02000000
436 #define ST0_FR                  0x04000000
437 #define ST0_CU                  0xf0000000
438 #define ST0_CU0                 0x10000000
439 #define ST0_CU1                 0x20000000
440 #define ST0_CU2                 0x40000000
441 #define ST0_CU3                 0x80000000
442 #define ST0_XX                  0x80000000      /* MIPS IV naming */
443
444 /*
445  * Bitfields and bit numbers in the coprocessor 0 cause register.
446  *
447  * Refer to your MIPS R4xx0 manual, chapter 5 for explanation.
448  */
449 #define  CAUSEB_EXCCODE         2
450 #define  CAUSEF_EXCCODE         (31  <<  2)
451 #define  CAUSEB_IP              8
452 #define  CAUSEF_IP              (255 <<  8)
453 #define  CAUSEB_IP0             8
454 #define  CAUSEF_IP0             (1   <<  8)
455 #define  CAUSEB_IP1             9
456 #define  CAUSEF_IP1             (1   <<  9)
457 #define  CAUSEB_IP2             10
458 #define  CAUSEF_IP2             (1   << 10)
459 #define  CAUSEB_IP3             11
460 #define  CAUSEF_IP3             (1   << 11)
461 #define  CAUSEB_IP4             12
462 #define  CAUSEF_IP4             (1   << 12)
463 #define  CAUSEB_IP5             13
464 #define  CAUSEF_IP5             (1   << 13)
465 #define  CAUSEB_IP6             14
466 #define  CAUSEF_IP6             (1   << 14)
467 #define  CAUSEB_IP7             15
468 #define  CAUSEF_IP7             (1   << 15)
469 #define  CAUSEB_IV              23
470 #define  CAUSEF_IV              (1   << 23)
471 #define  CAUSEB_CE              28
472 #define  CAUSEF_CE              (3   << 28)
473 #define  CAUSEB_BD              31
474 #define  CAUSEF_BD              (1   << 31)
475
476 /*
477  * Bits in the coprozessor 0 config register.
478  */
479 #define CONF_CM_CACHABLE_NO_WA          0
480 #define CONF_CM_CACHABLE_WA             1
481 #define CONF_CM_UNCACHED                2
482 #define CONF_CM_CACHABLE_NONCOHERENT    3
483 #define CONF_CM_CACHABLE_CE             4
484 #define CONF_CM_CACHABLE_COW            5
485 #define CONF_CM_CACHABLE_CUW            6
486 #define CONF_CM_CACHABLE_ACCELERATED    7
487 #define CONF_CM_CMASK                   7
488 #define CONF_DB                         (1 <<  4)
489 #define CONF_IB                         (1 <<  5)
490 #define CONF_SC                         (1 << 17)
491 #define CONF_AC                         (1 << 23)
492 #define CONF_HALT                       (1 << 25)
493
494 /*
495  * R10000 performance counter definitions.
496  *
497  * FIXME: The R10000 performance counter opens a nice way to implement CPU
498  *        time accounting with a precission of one cycle.  I don't have
499  *        R10000 silicon but just a manual, so ...
500  */
501
502 /*
503  * Events counted by counter #0
504  */
505 #define CE0_CYCLES                      0
506 #define CE0_INSN_ISSUED                 1
507 #define CE0_LPSC_ISSUED                 2
508 #define CE0_S_ISSUED                    3
509 #define CE0_SC_ISSUED                   4
510 #define CE0_SC_FAILED                   5
511 #define CE0_BRANCH_DECODED              6
512 #define CE0_QW_WB_SECONDARY             7
513 #define CE0_CORRECTED_ECC_ERRORS        8
514 #define CE0_ICACHE_MISSES               9
515 #define CE0_SCACHE_I_MISSES             10
516 #define CE0_SCACHE_I_WAY_MISSPREDICTED  11
517 #define CE0_EXT_INTERVENTIONS_REQ       12
518 #define CE0_EXT_INVALIDATE_REQ          13
519 #define CE0_VIRTUAL_COHERENCY_COND      14
520 #define CE0_INSN_GRADUATED              15
521
522 /*
523  * Events counted by counter #1
524  */
525 #define CE1_CYCLES                      0
526 #define CE1_INSN_GRADUATED              1
527 #define CE1_LPSC_GRADUATED              2
528 #define CE1_S_GRADUATED                 3
529 #define CE1_SC_GRADUATED                4
530 #define CE1_FP_INSN_GRADUATED           5
531 #define CE1_QW_WB_PRIMARY               6
532 #define CE1_TLB_REFILL                  7
533 #define CE1_BRANCH_MISSPREDICTED        8
534 #define CE1_DCACHE_MISS                 9
535 #define CE1_SCACHE_D_MISSES             10
536 #define CE1_SCACHE_D_WAY_MISSPREDICTED  11
537 #define CE1_EXT_INTERVENTION_HITS       12
538 #define CE1_EXT_INVALIDATE_REQ          13
539 #define CE1_SP_HINT_TO_CEXCL_SC_BLOCKS  14
540 #define CE1_SP_HINT_TO_SHARED_SC_BLOCKS 15
541
542 /*
543  * These flags define in which priviledge mode the counters count events
544  */
545 #define CEB_USER        8       /* Count events in user mode, EXL = ERL = 0 */
546 #define CEB_SUPERVISOR  4       /* Count events in supvervisor mode EXL = ERL = 0 */
547 #define CEB_KERNEL      2       /* Count events in kernel mode EXL = ERL = 0 */
548 #define CEB_EXL         1       /* Count events with EXL = 1, ERL = 0 */
549
550 #endif /* _ASM_MIPSREGS_H */