SFBMacros.h

Go to the documentation of this file.

/*                                              -*- mode:C++; fill-column:100 -*-
  SFBMacros.h - Standalone early macros requiring no constants.
  Copyright (C) 2008 The Regents of the University of New Mexico.  All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA
*/

#ifndef SFBMACROS_H_
#define SFBMACROS_H_

#include "SFBTypes.h"


#define CLOCKWISE_FACE(dir)        GET_MAP4BY2(MAP4BY2(EAST,WEST,SOUTH,NORTH),dir) 
#define COUNTERCLOCKWISE_FACE(dir) GET_MAP4BY2(MAP4BY2(WEST,EAST,NORTH,SOUTH),dir) 
#define ANTICLOCKWISE_FACE(dir) COUNTERCLOCKWISE_FACE(dir)
#define OPPOSITE_FACE(dir)         GET_MAP4BY2(MAP4BY2(SOUTH,NORTH,WEST,EAST),dir) 
extern const char * const faceNames[];
#define FACE_NAME(face) (faceNames[face]) 
#define FACE_CODE(face) GET_MAP4BY8(MAP4BY8('N','S','E','W'),face) 
#define FACE_NUMBER_FROM_CODE(code) (((((code)&~0x20)^(((code)&~0x20)>>1))-1)&0x3)  
/* This looks fancy shmancy but compiles into ten instructions:

  #define IS_FACE_CODE(code) ((((code)>>6)==1) && ((0x00884020>>((code)&0x1f))&1))

  (mostly because developing the constant sucks), whereas this looks gross and stupid but compiles
  into eight instructions: */
#define IS_FACE_CODE(code)                     \
  (((code)&~0x20)=='N'||   \
   ((code)&~0x20)=='S'||   \
   ((code)&~0x20)=='E'||   \
   ((code)&~0x20)=='W')       



#define SET_BIT(value,bitNum) ((value) |= (1<<(bitNum)))

#define CLEAR_BIT(value,bitNum) ((value) &= ~(1<<(bitNum)))

#define GET_BIT(value,bitNum) (((value)>>(bitNum))&1)

#define TEST_BIT(value,bitNum) ((value)&(1<<(bitNum)))

#define BIT_PAIR_AT_POSITION(bits,newValue,position) \
  ((bits) = ((bits)&(~(3<<(position))))|((newValue)<<(position)))

/****************** Structured H/W register access *****************/

#define REGISTER_OFFSET(baseAddress,byteOffset) \
  (*((uv32 *) (((u32)(baseAddress))+(byteOffset))))

#define MAP4BY2(a, b, c, d) ((((((((u8) d)<<2)|(c))<<2)|(b))<<2)|(a))

#define GET_MAP4BY2(map, idx) (((map)>>((idx)<<1))&0x3)

#define MAP4BY4(a, b, c, d) ((((((((u16) d)<<4)|(c))<<4)|(b))<<4)|(a))

#define GET_MAP4BY4(map, idx) (((map)>>((idx)<<2))&0xf)

#define MAP4BY8(a, b, c, d) ((((((((u32) d)<<8)|(c))<<8)|(b))<<8)|(a))

#define GET_MAP4BY8(map, idx) (((map)>>((idx)<<3))&0xff)

#define MAP3BY3(a, b, c) ((((((u16) c)<<3)|(b))<<3)|(a))

#define GET_MAP3BY3(map, idx) (((map)>>((idx)*3))&0x7)

#define BLINK_MAP(red,green,blue) MAP3BY3(blue,green,red)


#define GET_BLINK_MAP_COLOR(code,color) GET_MAP3BY3(code,2-(color))

#define IS_EARLIER(a,b)          ((((u32)(a))-((u32)(b))) > 0x80000000UL)

#define IS_LATER_OR_EQUAL(a,b)   ((((u32)(a))-((u32)(b))) < 0x80000000UL) 
#define IS_LATER(a,b)            ((((u32)(b))-((u32)(a))) > 0x80000000UL) 
#define IS_EARLIER_OR_EQUAL(a,b) ((((u32)(b))-((u32)(a))) < 0x80000000UL) 
#define IS_EARLIER16(a,b)        ((u16)(((u16)(a))-((u16)(b))) > 0x8000UL)  
#define IS_LATER_OR_EQUAL16(a,b) ((u16)(((u16)(a))-((u16)(b))) < 0x8000UL)  
#define IS_LATER16(a,b)          ((u16)(((u16)(b))-((u16)(a))) > 0x8000UL)  
#define IS_EARLIER_OR_EQUAL16(a,b) ((u16)(((u16)(b))-((u16)(a))) < 0x8000UL)
#define IS_EARLIER8(a,b)        ((u8)(((u8)(a))-((u8)(b))) > 0x80UL)  
#define IS_LATER_OR_EQUAL8(a,b) ((u8)(((u8)(a))-((u8)(b))) < 0x80UL)  
#define IS_LATER8(a,b)          ((u8)(((u8)(b))-((u8)(a))) > 0x80UL)  
#define IS_EARLIER_OR_EQUAL8(a,b) ((u8)(((u8)(b))-((u8)(a))) < 0x80UL)



#define STRUCT_MEMBER_OFFSET(structure,member) ((uptr) &(((structure *) 0)->member))

#define XSTR(arg) STR(arg)  
#define STR(arg) #arg       
#define MIN(a,b) (((a)<(b))?(a):(b))  
#define MAX(a,b) (((a)>(b))?(a):(b)) 
#define FILEPOS __FILE__ ":" XSTR(__LINE__)

/****************** B36 constants macros ******************/

#define B36_CONST_0 0u
#define B36_CONST_1 1u
#define B36_CONST_2 2u
#define B36_CONST_3 3u
#define B36_CONST_4 4u
#define B36_CONST_5 5u
#define B36_CONST_6 6u
#define B36_CONST_7 7u
#define B36_CONST_8 8u
#define B36_CONST_9 9u
#define B36_CONST_A 10u
#define B36_CONST_a 10u
#define B36_CONST_B 11u
#define B36_CONST_b 11u
#define B36_CONST_C 12u
#define B36_CONST_c 12u
#define B36_CONST_D 13u
#define B36_CONST_d 13u
#define B36_CONST_E 14u
#define B36_CONST_e 14u
#define B36_CONST_F 15u
#define B36_CONST_f 15u
#define B36_CONST_G 16u
#define B36_CONST_g 16u
#define B36_CONST_H 17u
#define B36_CONST_h 17u
#define B36_CONST_I 18u
#define B36_CONST_i 18u
#define B36_CONST_J 19u
#define B36_CONST_j 19u
#define B36_CONST_K 20u
#define B36_CONST_k 20u
#define B36_CONST_L 21u
#define B36_CONST_l 21u
#define B36_CONST_M 22u
#define B36_CONST_m 22u
#define B36_CONST_N 23u
#define B36_CONST_n 23u
#define B36_CONST_O 24u
#define B36_CONST_o 24u
#define B36_CONST_P 25u
#define B36_CONST_p 25u
#define B36_CONST_Q 26u
#define B36_CONST_q 26u
#define B36_CONST_R 27u
#define B36_CONST_r 27u
#define B36_CONST_S 28u
#define B36_CONST_s 28u
#define B36_CONST_T 29u
#define B36_CONST_t 29u
#define B36_CONST_U 30u
#define B36_CONST_u 30u
#define B36_CONST_V 31u
#define B36_CONST_v 31u
#define B36_CONST_W 32u
#define B36_CONST_w 32u
#define B36_CONST_X 33u
#define B36_CONST_x 33u
#define B36_CONST_Y 34u
#define B36_CONST_y 34u
#define B36_CONST_Z 35u
#define B36_CONST_z 35u

#define B36_1(a) B36_CONST_##a                                  
#define B36_2(a,b) (B36_1(a)*36u+B36_1(b))                      
#define B36_3(a,b,c) (B36_2(a,b)*36u+B36_1(c))                  
#define B36_4(a,b,c,d) (B36_3(a,b,c)*36u+B36_1(d))              
#define B36_5(a,b,c,d,e) (B36_4(a,b,c,d)*36u+B36_1(e))          
#define B36_6(a,b,c,d,e,f) (B36_5(a,b,c,d,e)*36u+B36_1(f))      
#define B36_7(a,b,c,d,e,f,g) (B36_6(a,b,c,d,e,f)*36u+B36_1(g))  
/****************** Memory placement macros ******************/

#ifndef HOST_MODE

#define IN_BODYRAM  __attribute__((section (".bodyram")))
#define IN_TALKRAM  __attribute__((section (".talkram")))
#define IN_FASTRAM  __attribute__((section (".fastram")))

#define IN_BODYRAM_BSS  __attribute__((section (".bss.bodyram")))
#define IN_TALKRAM_BSS  __attribute__((section (".bss.talkram")))
#define IN_FASTRAM_BSS  __attribute__((section (".bss.fastram")))

#else

#define IN_BODYRAM  /* in host mode */
#define IN_TALKRAM  /* no special ram regions */
#define IN_FASTRAM  /* are defined */

#define IN_BODYRAM_BSS  /* for */
#define IN_TALKRAM_BSS  /* any */
#define IN_FASTRAM_BSS  /* thing */

#endif

#endif /*SFBMACROS_H_*/