Tooltron

/********

 * This file is part of Tooltron.

 *

 * Tooltron is free software: you can redistribute it and/or modify

 * it under the terms of the Lesser GNU General Public License as published by

 * the Free Software Foundation, either version 3 of the License, or

 * (at your option) any later version.

 *

 * Tooltron 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

 * Lesser GNU General Public License for more details.

 * You should have received a copy of the Lesser GNU General Public License

 * along with Tooltron.  If not, see <http://www.gnu.org/licenses/>.

 *

 * Copyright 2009 Kevin Woo <kwoo@2ndt.com>, Brad Neuman <bneuman@andrew.cmu.edu>

 *

 ********/

#ifndef _TOOLTRON_H_

#define _TOOLTRON_H_

#include <stdint.h>

/****** Message Dictionary ******/

// Commonly used message bytes

#define DELIM      '^'

#define SERVER     1

// These are the bytes used in the messaage types

#define TT_ACK      'a'     // Ack

#define TT_NACK     'n'     // Nack

#define TT_KC       'x'     // A transaction containing a key and a card number

#define TT_GRANT    'q'     // Tool access granted

#define TT_DENY     'f'     // Tool access denied

#define TT_TIMEOUT  't'     // Packet timeout

#define TT_RESET    'r'     // Tool reset request

#define TT_BOOT     'b'     // Tool boot message

#define TT_PROGM    'p'     // Program mode request

#define TT_PROGD    'd'     // Program data

#define TT_PING     'g'     // Ping command

#define TT_BAD       0      // If there was a packet parsing error

// Depricated commands:

//#define TT_GET_KEY  'k'     // Get a key from the keyboard

//#define TT_SEND_KEY 's'     // Send a Key back (has 1 extra data packet)

//#define TT_ON       'o'     // Turn the tool on

// Number of bytes that the PROGx packets have in the payload

#define MAX_PAYLOAD_SIZE        32

#define SEND_KEY_PACKET_SIZE    1

#define PROGD_PACKET_SIZE       MAX_PAYLOAD_SIZE

#define SEND_KEY_PACKET_SIZE    1

// Tool timeout?

#define TIMEOUT_SECONDS 10 

#define SERVER_TIMEOUT_SECONDS 3

// Maximum attempts to retry

#define TT_MAX_RETRY    3

// Memory locations

#define MAIN_ADDR 0x0           // User code starts here

#define BOOT_START 0x3C0        // Bootloader code starts here

#define EEPROM_ADDR1 ((void*)1)     // Location of the node's address in the EEPROM

#define EEPROM_ADDR2 ((void*)42)    // Location of the node's address in the EEPROM

#define EEPROM_ADDR3 ((void*)126)   // Location of the node's address in the EEPROM

// Tool ID numbers

#define ID_BROKEN 0 //signified eeprom is probably broken

// Debouncing

#define BUTTON_DEBOUNCE 5

/****** Utility Definitions ******/

#define TRUE    0x01

#define FALSE   0x00

#define ON      0x01

#define OFF     0x00

#endif