#define _SIM_BITS_H_
-/* bit manipulation routines:
+/* Bit manipulation routines:
Bit numbering: The bits are numbered according to the target ISA's
convention. That being controlled by WITH_TARGET_WORD_MSB. For
NB: Use EXTRACTED, MSEXTRACTED and LSEXTRACTED as a guideline for
naming. LSMASK and LSMASKED are wrong.
- BIT*(POS): Constant with just 1 bit set.
+ BIT*(POS): `*' bit constant with just 1 bit set.
- LSBIT*(OFFSET): Constant with just 1 bit set - LS bit is zero.
+ LSBIT*(OFFSET): `*' bit constant with just 1 bit set - LS bit is
+ zero.
- MSBIT*(OFFSET): Constant with just 1 bit set - MS bit is zero.
+ MSBIT*(OFFSET): `*' bit constant with just 1 bit set - MS bit is
+ zero.
- MASK*(FIRST, LAST): Constant with bits [FIRST .. LAST] set. The
- <MACRO> (no size) version permits FIRST >= LAST and generates a
- wrapped bit mask vis ([0..LAST] | [FIRST..LSB]).
+ MASK*(FIRST, LAST): `*' bit constant with bits [FIRST .. LAST]
+ set. The <MACRO> (no size) version permits FIRST >= LAST and
+ generates a wrapped bit mask vis ([0..LAST] | [FIRST..LSB]).
LSMASK*(FIRST, LAST): Like MASK - LS bit is zero.
IEA_MASKED(SHOULD_MASK, ADDR): Convert the address to the targets
natural size. If in 32bit mode, discard the high 32bits.
- EXTENDED*(VALUE): Convert the `*' bit value to the targets natural
- word size. Sign extned the value if needed.
+ EXTEND*(VALUE): Convert the `*' bit value to the targets natural
+ word size. Sign extend the value if needed.
+
+ ALIGN_*(VALUE): Round the value upwards so that it is aligned to a
+ `_*' byte boundary.
- ALIGN_*(VALUE): Round upwards the value so that it is aligned.
+ FLOOR_*(VALUE): Truncate the value so that it is aligned to a `_*'
+ byte boundary.
- FLOOR_*(VALUE): Truncate the value so that it is aligned.
+ ROT*(VALUE, NR_BITS): Return the `*' bit VALUE rotated by NR_BITS
+ right (positive) or left (negative).
- ROTL*(VALUE, NR_BITS): Return the value rotated by NR_BITS left.
+ ROTL*(VALUE, NR_BITS): Return the `*' bit value rotated by NR_BITS
+ left. 0 <= NR_BITS <= `*'.
- ROTR*(VALUE, NR_BITS): Return the value rotated by NR_BITS right.
+ ROTR*(VALUE, NR_BITS): Return the `*' bit value rotated by NR_BITS
+ right. 0 <= NR_BITS <= N.
- SEXT*(VAL, SIGN_BIT): Treat SIGN_BIT as the sign, extend it.
+ SEXT*(VALUE, SIGN_BIT): Treat SIGN_BIT as VALUEs sign, extend it ti
+ `*' bits.
Note: Only the BIT* and MASK* macros return a constant that can be
used in variable declarations.
#define _MSB_32(START, STOP) (START <= STOP \
? (START < 32 ? 0 : START - 32) \
: (STOP < 32 ? 0 : STOP - 32))
+#define _MSB_16(START, STOP) (START <= STOP \
+ ? (START < 48 ? 0 : START - 48) \
+ : (STOP < 48 ? 0 : STOP - 48))
#else
#define _MSB_32(START, STOP) (START >= STOP \
? (START >= 32 ? 31 : START) \
: (STOP >= 32 ? 31 : STOP))
+#define _MSB_16(START, STOP) (START >= STOP \
+ ? (START >= 16 ? 15 : START) \
+ : (STOP >= 16 ? 15 : STOP))
#endif
#if (WITH_TARGET_WORD_MSB == 0)
#define _LSB_32(START, STOP) (START <= STOP \
? (STOP < 32 ? 0 : STOP - 32) \
: (START < 32 ? 0 : START - 32))
+#define _LSB_16(START, STOP) (START <= STOP \
+ ? (STOP < 48 ? 0 : STOP - 48) \
+ : (START < 48 ? 0 : START - 48))
#else
#define _LSB_32(START, STOP) (START >= STOP \
? (STOP >= 32 ? 31 : STOP) \
: (START >= 32 ? 31 : START))
+#define _LSB_16(START, STOP) (START >= STOP \
+ ? (STOP >= 16 ? 15 : STOP) \
+ : (START >= 16 ? 15 : START))
#endif
#if (WITH_TARGET_WORD_MSB == 0)
/* LS/MS Bit operations */
-#define LSBIT8(POS) ((unsigned8)1 << (POS))
+#define LSBIT8(POS) ((unsigned8) 1 << (POS))
#define LSBIT16(POS) ((unsigned16)1 << (POS))
#define LSBIT32(POS) ((unsigned32)1 << (POS))
#define LSBIT64(POS) ((unsigned64)1 << (POS))
-#define LSBIT(POS) ((unsigned_word)1 << (POS))
-#define MSBIT8(POS) ((unsigned8)1 << (8 - 1 - (POS)))
+#if (WITH_TARGET_WORD_BITSIZE == 64)
+#define LSBIT(POS) LSBIT64 (POS)
+#endif
+#if (WITH_TARGET_WORD_BITSIZE == 32)
+#define LSBIT(POS) ((unsigned32)((POS) >= 32 \
+ ? 0 \
+ : (1 << ((POS) >= 32 ? 0 : (POS)))))
+#endif
+#if (WITH_TARGET_WORD_BITSIZE == 16)
+#define LSBIT(POS) ((unsigned16)((POS) >= 16 \
+ ? 0 \
+ : (1 << ((POS) >= 16 ? 0 : (POS)))))
+#endif
+
+
+#define MSBIT8(POS) ((unsigned8) 1 << ( 8 - 1 - (POS)))
#define MSBIT16(POS) ((unsigned16)1 << (16 - 1 - (POS)))
#define MSBIT32(POS) ((unsigned32)1 << (32 - 1 - (POS)))
#define MSBIT64(POS) ((unsigned64)1 << (64 - 1 - (POS)))
-#define MSBIT(POS) ((unsigned_word)1 << (WITH_TARGET_WORD_BITSIZE - 1 - (POS)))
+#if (WITH_TARGET_WORD_BITSIZE == 64)
+#define MSBIT(POS) MSBIT64 (POS)
+#endif
+#if (WITH_TARGET_WORD_BITSIZE == 32)
+#define MSBIT(POS) ((unsigned32)((POS) < 32 \
+ ? 0 \
+ : (1 << ((POS) < 32 ? 0 : (64 - 1) - (POS)))))
+#endif
+#if (WITH_TARGET_WORD_BITSIZE == 16)
+#define MSBIT(POS) ((unsigned16)((POS) < 48 \
+ ? 0 \
+ : (1 << ((POS) < 48 ? 0 : (64 - 1) - (POS)))))
+#endif
-/* Bit operations */
-#define _BITn(WIDTH, POS) ((natural##WIDTH)1 \
- << _LSB_SHIFT (WIDTH, POS))
+/* Bit operations */
#define BIT4(POS) (1 << _LSB_SHIFT (4, (POS)))
#define BIT5(POS) (1 << _LSB_SHIFT (5, (POS)))
-#define BIT8(POS) (1 << _LSB_SHIFT (8, (POS)))
#define BIT10(POS) (1 << _LSB_SHIFT (10, (POS)))
-#define BIT16(POS) _BITn (16, (POS))
-#define BIT32(POS) _BITn (32, (POS))
-#define BIT64(POS) _BITn (64, (POS))
-#if (WITH_TARGET_WORD_BITSIZE == 64)
-#define BIT(POS) BIT64(POS)
-#endif
-#if (WITH_TARGET_WORD_BITSIZE == 32)
#if (WITH_TARGET_WORD_MSB == 0)
-#define BIT(POS) ((POS) < 32 \
- ? 0 \
- : (1 << ((POS) < 32 ? 0 : _LSB_SHIFT(64, (POS)))))
+#define BIT8 MSBIT8
+#define BIT16 MSBIT16
+#define BIT32 MSBIT32
+#define BIT64 MSBIT64
+#define BIT MSBIT
#else
-#define BIT(POS) ((POS) >= 32 \
- ? 0 \
- : (1 << ((POS) >= 32 ? 0 : (POS))))
-#endif
-#endif
-#if !defined (BIT)
-#error "BIT never defined"
+#define BIT8 LSBIT8
+#define BIT16 LSBIT16
+#define BIT32 LSBIT32
+#define BIT64 LSBIT64
+#define BIT LSBIT
#endif
+
/* multi bit mask */
/* 111111 -> mmll11 -> mm11ll */
_MSB_POS (32, 0), \
_MSB_32 ((START), (STOP))))))
#endif
+#if (WITH_TARGET_WORD_BITSIZE == 16)
+#define MASK(START, STOP) \
+ (_POS_LE ((START), (STOP)) \
+ ? (_POS_LE ((STOP), _MSB_POS (64, 15)) \
+ ? 0 \
+ : _MASKn (16, \
+ _MSB_16 ((START), (STOP)), \
+ _LSB_16 ((START), (STOP)))) \
+ : (_MASKn (16, \
+ _LSB_16 ((START), (STOP)), \
+ _LSB_POS (16, 0)) \
+ | (_POS_LE ((STOP), _MSB_POS (64, 15)) \
+ ? 0 \
+ : _MASKn (16, \
+ _MSB_POS (16, 0), \
+ _MSB_16 ((START), (STOP))))))
+#endif
#if !defined (MASK)
#error "MASK never undefined"
#endif
_LSB_POS (WIDTH, FIRST), \
_LSB_POS (WIDTH, LAST))
+#define LSMASK8(FIRST, LAST) _LSMASKn ( 8, (FIRST), (LAST))
#define LSMASK16(FIRST, LAST) _LSMASKn (16, (FIRST), (LAST))
#define LSMASK32(FIRST, LAST) _LSMASKn (32, (FIRST), (LAST))
#define LSMASK64(FIRST, LAST) _LSMASKn (64, (FIRST), (LAST))
_MSB_POS (WIDTH, FIRST), \
_MSB_POS (WIDTH, LAST))
+#define MSMASK8(FIRST, LAST) _MSMASKn ( 8, (FIRST), (LAST))
#define MSMASK16(FIRST, LAST) _MSMASKn (16, (FIRST), (LAST))
#define MSMASK32(FIRST, LAST) _MSMASKn (32, (FIRST), (LAST))
#define MSMASK64(FIRST, LAST) _MSMASKn (64, (FIRST), (LAST))
#if (WITH_TARGET_WORD_MSB == 0)
+#define MASK8 MSMASK8
#define MASK16 MSMASK16
#define MASK32 MSMASK32
#define MASK64 MSMASK64
#else
+#define MASK8 LSMASK8
#define MASK16 LSMASK16
#define MASK32 LSMASK32
#define MASK64 LSMASK64
/* mask the required bits, leaving them in place */
+INLINE_SIM_BITS(unsigned8) LSMASKED8 (unsigned8 word, int first, int last);
INLINE_SIM_BITS(unsigned16) LSMASKED16 (unsigned16 word, int first, int last);
INLINE_SIM_BITS(unsigned32) LSMASKED32 (unsigned32 word, int first, int last);
INLINE_SIM_BITS(unsigned64) LSMASKED64 (unsigned64 word, int first, int last);
INLINE_SIM_BITS(unsigned_word) LSMASKED (unsigned_word word, int first, int last);
+INLINE_SIM_BITS(unsigned8) MSMASKED8 (unsigned8 word, int first, int last);
INLINE_SIM_BITS(unsigned16) MSMASKED16 (unsigned16 word, int first, int last);
INLINE_SIM_BITS(unsigned32) MSMASKED32 (unsigned32 word, int first, int last);
INLINE_SIM_BITS(unsigned64) MSMASKED64 (unsigned64 word, int first, int last);
INLINE_SIM_BITS(unsigned_word) MSMASKED (unsigned_word word, int first, int last);
#if (WITH_TARGET_WORD_MSB == 0)
+#define MASKED8 MSMASKED8
#define MASKED16 MSMASKED16
#define MASKED32 MSMASKED32
#define MASKED64 MSMASKED64
-#define MASKED MSMASKED
+#define MASKED MSMASKED
#else
+#define MASKED8 LSMASKED8
#define MASKED16 LSMASKED16
#define MASKED32 LSMASKED32
#define MASKED64 LSMASKED64
/* extract the required bits aligning them with the lsb */
+INLINE_SIM_BITS(unsigned8) LSEXTRACTED8 (unsigned8 val, int start, int stop);
INLINE_SIM_BITS(unsigned16) LSEXTRACTED16 (unsigned16 val, int start, int stop);
INLINE_SIM_BITS(unsigned32) LSEXTRACTED32 (unsigned32 val, int start, int stop);
INLINE_SIM_BITS(unsigned64) LSEXTRACTED64 (unsigned64 val, int start, int stop);
INLINE_SIM_BITS(unsigned_word) LSEXTRACTED (unsigned_word val, int start, int stop);
+INLINE_SIM_BITS(unsigned8) MSEXTRACTED8 (unsigned8 val, int start, int stop);
INLINE_SIM_BITS(unsigned16) MSEXTRACTED16 (unsigned16 val, int start, int stop);
INLINE_SIM_BITS(unsigned32) MSEXTRACTED32 (unsigned32 val, int start, int stop);
INLINE_SIM_BITS(unsigned64) MSEXTRACTED64 (unsigned64 val, int start, int stop);
INLINE_SIM_BITS(unsigned_word) MSEXTRACTED (unsigned_word val, int start, int stop);
#if (WITH_TARGET_WORD_MSB == 0)
+#define EXTRACTED8 MSEXTRACTED8
#define EXTRACTED16 MSEXTRACTED16
#define EXTRACTED32 MSEXTRACTED32
#define EXTRACTED64 MSEXTRACTED64
#define EXTRACTED MSEXTRACTED
#else
+#define EXTRACTED8 LSEXTRACTED8
#define EXTRACTED16 LSEXTRACTED16
#define EXTRACTED32 LSEXTRACTED32
#define EXTRACTED64 LSEXTRACTED64
#define SHUFFLED(WORD, OLD, NEW) _SHUFFLEDn (_word, WORD, OLD, NEW)
-/* move a group of bits around */
+/* Insert a group of bits into a bit position */
+
+INLINE_SIM_BITS(unsigned8) LSINSERTED8 (unsigned8 val, int start, int stop);
+INLINE_SIM_BITS(unsigned16) LSINSERTED16 (unsigned16 val, int start, int stop);
+INLINE_SIM_BITS(unsigned32) LSINSERTED32 (unsigned32 val, int start, int stop);
+INLINE_SIM_BITS(unsigned64) LSINSERTED64 (unsigned64 val, int start, int stop);
+INLINE_SIM_BITS(unsigned_word) LSINSERTED (unsigned_word val, int start, int stop);
-INLINE_SIM_BITS(unsigned16) INSERTED16 (unsigned16 val, int start, int stop);
-INLINE_SIM_BITS(unsigned32) INSERTED32 (unsigned32 val, int start, int stop);
-INLINE_SIM_BITS(unsigned64) INSERTED64 (unsigned64 val, int start, int stop);
+INLINE_SIM_BITS(unsigned8) MSINSERTED8 (unsigned8 val, int start, int stop);
+INLINE_SIM_BITS(unsigned16) MSINSERTED16 (unsigned16 val, int start, int stop);
+INLINE_SIM_BITS(unsigned32) MSINSERTED32 (unsigned32 val, int start, int stop);
+INLINE_SIM_BITS(unsigned64) MSINSERTED64 (unsigned64 val, int start, int stop);
+INLINE_SIM_BITS(unsigned_word) MSINSERTED (unsigned_word val, int start, int stop);
-INLINE_SIM_BITS(unsigned_word) INSERTED (unsigned_word val, int start, int stop);
+#if (WITH_TARGET_WORD_MSB == 0)
+#define INSERTED8 MSINSERTED8
+#define INSERTED16 MSINSERTED16
+#define INSERTED32 MSINSERTED32
+#define INSERTED64 MSINSERTED64
+#define INSERTED MSINSERTED
+#else
+#define INSERTED8 LSINSERTED8
+#define INSERTED16 LSINSERTED16
+#define INSERTED32 LSINSERTED32
+#define INSERTED64 LSINSERTED64
+#define INSERTED LSINSERTED
+#endif
+
+
+
+/* MOVE bits from one loc to another (combination of extract/insert) */
+
+#define MOVED8(VAL,OH,OL,NH,NL) INSERTED8 (EXTRACTED8 ((VAL), OH, OL), NH, NL)
+#define MOVED16(VAL,OH,OL,NH,NL) INSERTED16(EXTRACTED16((VAL), OH, OL), NH, NL)
+#define MOVED32(VAL,OH,OL,NH,NL) INSERTED32(EXTRACTED32((VAL), OH, OL), NH, NL)
+#define MOVED64(VAL,OH,OL,NH,NL) INSERTED64(EXTRACTED64((VAL), OH, OL), NH, NL)
+#define MOVED(VAL,OH,OL,NH,NL) INSERTED (EXTRACTED ((VAL), OH, OL), NH, NL)
/* Sign extend the quantity to the targets natural word size */
-#define EXTEND8(X) ((signed_word)(signed8)(X))
+#define EXTEND4(X) (LSSEXT ((X), 3))
+#define EXTEND5(X) (LSSEXT ((X), 4))
+#define EXTEND8(X) ((signed_word)(signed8)(X))
+#define EXTEND11(X) (LSSEXT ((X), 10))
+#define EXTEND15(X) (LSSEXT ((X), 14))
#define EXTEND16(X) ((signed_word)(signed16)(X))
+#define EXTEND24(X) (LSSEXT ((X), 23))
#define EXTEND32(X) ((signed_word)(signed32)(X))
#define EXTEND64(X) ((signed_word)(signed64)(X))
#if (WITH_TARGET_WORD_BITSIZE == 32)
#define EXTENDED(X) (X)
#endif
+#if (WITH_TARGET_WORD_BITSIZE == 16)
+#define EXTENDED(X) (X)
+#endif
/* memory alignment macro's */
intentionally omited. */
+INLINE_SIM_BITS(unsigned8) ROT8 (unsigned8 val, int shift);
INLINE_SIM_BITS(unsigned16) ROT16 (unsigned16 val, int shift);
INLINE_SIM_BITS(unsigned32) ROT32 (unsigned32 val, int shift);
INLINE_SIM_BITS(unsigned64) ROT64 (unsigned64 val, int shift);
+INLINE_SIM_BITS(unsigned8) ROTL8 (unsigned8 val, int shift);
INLINE_SIM_BITS(unsigned16) ROTL16 (unsigned16 val, int shift);
INLINE_SIM_BITS(unsigned32) ROTL32 (unsigned32 val, int shift);
INLINE_SIM_BITS(unsigned64) ROTL64 (unsigned64 val, int shift);
+INLINE_SIM_BITS(unsigned8) ROTR8 (unsigned8 val, int shift);
INLINE_SIM_BITS(unsigned16) ROTR16 (unsigned16 val, int shift);
INLINE_SIM_BITS(unsigned32) ROTR32 (unsigned32 val, int shift);
INLINE_SIM_BITS(unsigned64) ROTR64 (unsigned64 val, int shift);
/* Sign extension operations */
-INLINE_SIM_BITS(unsigned16) SEXT16 (signed16 val, int sign_bit);
-INLINE_SIM_BITS(unsigned32) SEXT32 (signed32 val, int sign_bit);
-INLINE_SIM_BITS(unsigned64) SEXT64 (signed64 val, int sign_bit);
+INLINE_SIM_BITS(unsigned8) LSSEXT8 (signed8 val, int sign_bit);
+INLINE_SIM_BITS(unsigned16) LSSEXT16 (signed16 val, int sign_bit);
+INLINE_SIM_BITS(unsigned32) LSSEXT32 (signed32 val, int sign_bit);
+INLINE_SIM_BITS(unsigned64) LSSEXT64 (signed64 val, int sign_bit);
+INLINE_SIM_BITS(unsigned_word) LSSEXT (signed_word val, int sign_bit);
+
+INLINE_SIM_BITS(unsigned8) MSSEXT8 (signed8 val, int sign_bit);
+INLINE_SIM_BITS(unsigned16) MSSEXT16 (signed16 val, int sign_bit);
+INLINE_SIM_BITS(unsigned32) MSSEXT32 (signed32 val, int sign_bit);
+INLINE_SIM_BITS(unsigned64) MSSEXT64 (signed64 val, int sign_bit);
+INLINE_SIM_BITS(unsigned_word) MSSEXT (signed_word val, int sign_bit);
-INLINE_SIM_BITS(unsigned_word) SEXT (signed_word val, int sign_bit);
+#if (WITH_TARGET_WORD_MSB == 0)
+#define SEXT8 MSSEXT8
+#define SEXT16 MSSEXT16
+#define SEXT32 MSSEXT32
+#define SEXT64 MSSEXT64
+#define SEXT MSSEXT
+#else
+#define SEXT8 LSSEXT8
+#define SEXT16 LSSEXT16
+#define SEXT32 LSSEXT32
+#define SEXT64 LSSEXT64
+#define SEXT LSSEXT
+#endif
-#if ((SIM_BITS_INLINE & INCLUDE_MODULE) && (SIM_BITS_INLINE & INCLUDED_BY_MODULE))
+#if H_REVEALS_MODULE_P (SIM_BITS_INLINE)
#include "sim-bits.c"
#endif