/**
* @file
* @ingroup mips_regs
* @brief Standard MIPS register names.
*/
/*
* regs.S -- standard MIPS register names.
*
* Copyright (c) 1995 Cygnus Support
*
* The authors hereby grant permission to use, copy, modify, distribute,
* and license this software and its documentation for any purpose, provided
* that existing copyright notices are retained in all copies and that this
* notice is included verbatim in any distributions. No written agreement,
* license, or royalty fee is required for any of the authorized uses.
* Modifications to this software may be copyrighted by their authors
* and need not follow the licensing terms described here, provided that
* the new terms are clearly indicated on the first page of each file where
* they apply.
*/
/**
* @defgroup mips_regs MIPS Registers
* @ingroup mips_shared
* @brief MIPS Registers
* @{
*/
/**
* @name Standard MIPS register names:
* @{
*/
#define zero $0
#define z0 $0
#define v0 $2
#define v1 $3
#define a0 $4
#define a1 $5
#define a2 $6
#define a3 $7
#define t0 $8
#define t1 $9
#define t2 $10
#define t3 $11
#define t4 $12
#define t5 $13
#define t6 $14
#define t7 $15
#define s0 $16
#define s1 $17
#define s2 $18
#define s3 $19
#define s4 $20
#define s5 $21
#define s6 $22
#define s7 $23
#define t8 $24
#define t9 $25
#define k0 $26 ///< @brief kernel private register 0 */
#define k1 $27 ///< @brief kernel private register 1 */
#define gp $28 ///< @brief global data pointer */
#define sp $29 ///< @brief stack-pointer */
#define fp $30 ///< @brief frame-pointer */
#define ra $31 ///< @brief return address */
#define pc $pc ///< @brief pc, used on mips16 */
#define fp0 $f0
#define fp1 $f1
/** @} */
/**
* @name Useful memory constants:
* @{
*/
#define K0BASE 0x80000000
#ifndef __mips64
#define K1BASE 0xA0000000
#else
#define K1BASE 0xFFFFFFFFA0000000LL
#endif
/** @} */
#define PHYS_TO_K1(a) ((unsigned)(a) | K1BASE)
/**
* @name Standard Co-Processor 0 register numbers:
* @{
*/
#define C0_COUNT $9 ///< @brief Count Register */
#define C0_SR $12 ///< @brief Status Register */
#define C0_CAUSE $13 ///< @brief last exception description */
#define C0_EPC $14 ///< @brief Exception error address */
#define C0_CONFIG $16 ///< @brief CPU configuration */
/** @} */
/**
* @name Standard Status Register bitmasks:
* @{
*/
#define SR_CU1 0x20000000 ///< @brief Mark CP1 as usable */
#define SR_FR 0x04000000 ///< @brief Enable MIPS III FP registers */
#define SR_BEV 0x00400000 ///< @brief Controls location of exception vectors */
#define SR_PE 0x00100000 ///< @brief Mark soft reset (clear parity error) */
#define SR_KX 0x00000080 ///< @brief Kernel extended addressing enabled */
#define SR_SX 0x00000040 ///< @brief Supervisor extended addressing enabled */
#define SR_UX 0x00000020 ///< @brief User extended addressing enabled */
/** @} */
/**
* @name Standard (R4000) cache operations.
* @brief Taken from "MIPS R4000 Microprocessor User's Manual" 2nd edition:
* @{
*/
#define CACHE_I (0) ///< @brief primary instruction */
#define CACHE_D (1) ///< @brief primary data */
#define CACHE_SI (2) ///< @brief secondary instruction */
#define CACHE_SD (3) ///< @brief secondary data (or combined instruction/data) */
#define INDEX_INVALIDATE (0) ///< @brief also encodes WRITEBACK if CACHE_D or CACHE_SD */
#define INDEX_LOAD_TAG (1)
#define INDEX_STORE_TAG (2)
#define CREATE_DIRTY_EXCLUSIVE (3) ///< @brief CACHE_D and CACHE_SD only */
#define HIT_INVALIDATE (4)
#define CACHE_FILL (5) ///< @brief CACHE_I only */
#define HIT_WRITEBACK_INVALIDATE (5) ///< @brief CACHE_D and CACHE_SD only */
#define HIT_WRITEBACK (6) ///< @brief CACHE_I, CACHE_D and CACHE_SD only */
#define HIT_SET_VIRTUAL (7) ///< @brief CACHE_SI and CACHE_SD only */
#define BUILD_CACHE_OP(o,c) (((o) << 2) | (c))
/** @} */
/**
* @name Individual cache operations:
* @{
*/
#define INDEX_INVALIDATE_I BUILD_CACHE_OP(INDEX_INVALIDATE,CACHE_I)
#define INDEX_WRITEBACK_INVALIDATE_D BUILD_CACHE_OP(INDEX_INVALIDATE,CACHE_D)
#define INDEX_INVALIDATE_SI BUILD_CACHE_OP(INDEX_INVALIDATE,CACHE_SI)
#define INDEX_WRITEBACK_INVALIDATE_SD BUILD_CACHE_OP(INDEX_INVALIDATE,CACHE_SD)
#define INDEX_LOAD_TAG_I BUILD_CACHE_OP(INDEX_LOAD_TAG,CACHE_I)
#define INDEX_LOAD_TAG_D BUILD_CACHE_OP(INDEX_LOAD_TAG,CACHE_D)
#define INDEX_LOAD_TAG_SI BUILD_CACHE_OP(INDEX_LOAD_TAG,CACHE_SI)
#define INDEX_LOAD_TAG_SD BUILD_CACHE_OP(INDEX_LOAD_TAG,CACHE_SD)
#define INDEX_STORE_TAG_I BUILD_CACHE_OP(INDEX_STORE_TAG,CACHE_I)
#define INDEX_STORE_TAG_D BUILD_CACHE_OP(INDEX_STORE_TAG,CACHE_D)
#define INDEX_STORE_TAG_SI BUILD_CACHE_OP(INDEX_STORE_TAG,CACHE_SI)
#define INDEX_STORE_TAG_SD BUILD_CACHE_OP(INDEX_STORE_TAG,CACHE_SD)
#define CREATE_DIRTY_EXCLUSIVE_D BUILD_CACHE_OP(CREATE_DIRTY_EXCLUSIVE,CACHE_D)
#define CREATE_DIRTY_EXCLUSIVE_SD BUILD_CACHE_OP(CREATE_DIRTY_EXCLUSIVE,CACHE_SD)
#define HIT_INVALIDATE_I BUILD_CACHE_OP(HIT_INVALIDATE,CACHE_I)
#define HIT_INVALIDATE_D BUILD_CACHE_OP(HIT_INVALIDATE,CACHE_D)
#define HIT_INVALIDATE_SI BUILD_CACHE_OP(HIT_INVALIDATE,CACHE_SI)
#define HIT_INVALIDATE_SD BUILD_CACHE_OP(HIT_INVALIDATE,CACHE_SD)
#define CACHE_FILL_I BUILD_CACHE_OP(CACHE_FILL,CACHE_I)
#define HIT_WRITEBACK_INVALIDATE_D BUILD_CACHE_OP(HIT_WRITEBACK_INVALIDATE,CACHE_D)
#define HIT_WRITEBACK_INVALIDATE_SD BUILD_CACHE_OP(HIT_WRITEBACK_INVALIDATE,CACHE_SD)
#define HIT_WRITEBACK_I BUILD_CACHE_OP(HIT_WRITEBACK,CACHE_I)
#define HIT_WRITEBACK_D BUILD_CACHE_OP(HIT_WRITEBACK,CACHE_D)
#define HIT_WRITEBACK_SD BUILD_CACHE_OP(HIT_WRITEBACK,CACHE_SD)
#define HIT_SET_VIRTUAL_SI BUILD_CACHE_OP(HIT_SET_VIRTUAL,CACHE_SI)
#define HIT_SET_VIRTUAL_SD BUILD_CACHE_OP(HIT_SET_VIRTUAL,CACHE_SD)
/** @} */
/** @} */
/*> EOF regs.S <*/
