SFBConstants.h

Go to the documentation of this file.

/*                                             -*- mode:C++; fill-column:100 -*-
  SFBConstants.h - Names for SFB 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 SFBCONSTANTS_H_
#define SFBCONSTANTS_H_

#include "SFBTypes.h"
#include "SFBMacros.h"

#define HIGH 1            
#define LOW 0             


#define DEC 10            
#define HEX 16            
#define OCT 8             
#define BIN 2             
#define BYTE 0            
#define BESHORT -1        
#define BELONG -2         
#define B36 36            


#define INPUT  0          
#define OUTPUT 1          
#define REFLEX_MODE 2     
#define HW_MODE 3         


#define NORTH  0u         
#define SOUTH  1u         
#define EAST   2u         
#define WEST   3u         
#define FACE_COUNT 4      

#define SPINE 4u          
#define WMEM  5u          
#define BRAIN 6u          
#define ALL_FACES 7u      
#define NO_FACES 8u       
#define MIN_VIRTUAL_FACE 9u  
#define VIRTUAL_FACE_COUNT 16 
#define MAX_FACE_INDEX (MIN_VIRTUAL_FACE+VIRTUAL_FACE_COUNT) 
#define NOT_A_FACE (MAX_FACE_INDEX) 


#define RISING  0x01            
#define FALLING 0x02            
#define CHANGING ((RISING)|(FALLING)) 


#define LSBFIRST 0              
#define MSBFIRST 1              


#define UNKNOWN_BOOT_MODE 0     
#define RED_BOOT_MODE 1         
#define GREEN_BOOT_MODE 2       
#define BLUE_BOOT_MODE 3        
#define MAX_BOOT_MODES 4       


#define PK_DELETED    0x01   
#define PK_OVERRUN    0x02   
#define PK_PARITY     0x04   
#define PK_FRAMING    0x08   
#define PK_BREAK      0x10   
#define PK_BUFFER     0x20   
#define PK_BAD_ESCAPE 0x40   
#define PK_RESERVED8  0x80   
#define PK_BYTE_ERROR (PK_OVERRUN|PK_PARITY|PK_FRAMING|PK_BREAK) 
#define PK_PACKET_ERROR (PK_BUFFER|PK_BAD_ESCAPE)   
#define PK_BROKEN (PK_PACKET_ERROR|PK_BYTE_ERROR)   


#define MAX_PACKET_LENGTH 252  

#define SINGLE_PACKET_BUFFER_SIZE_WORDS (((MAX_PACKET_LENGTH)>>2)+1)
#define SINGLE_PACKET_BUFFER_SIZE_BYTES (SINGLE_PACKET_BUFFER_SIZE_WORDS<<2)

#define BYTE_BUFFER_BITS 9   /* 512 bytes.  Big enough for a worst-case escaped packet (though
                                that's not strictly required, since we deframe incrementally). */
#define BYTE_BUFFER_BYTES (1<<BYTE_BUFFER_BITS)

#define BYTE_BUFFER_MASK (BYTE_BUFFER_BYTES-1)


#endif /*SFBCONSTANTS_H_*/