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

#define ACK_CRC    ADDR ^ SERVER

// These are the bytes used in the messaage types

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

#define TT_ACK     'a'      // Ack

#define TT_NACK    'n'      // Nack

#define TT_TO      'f'      // State timeout

#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_BAD     0        // If there was a packet parsing error

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

#define PROGM_PACKET_SIZE 2

#define PROGD_PACKET_SIZE 32

// Packet handler states

typedef enum {

    sd,         // Looking for start delimiter

    src,        // Looking for source

    dest,       // Looking for destination

    comd,       // Looking for command

    read,       // Reading payload

    cs         // Calculate checksum

} state_t;

// Tool timeout?

#define TIMEOUT_SECONDS 10 

// Memory locations

#define MAIN_ADDR 0x0       // User code starts here

#define BOOT_START 0x400    // Bootloader code starts here

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

#define TRUE  0

#define FALSE 1

/****** Jump Table ******/

// Jump table addresses

// If the bootloader changes, you must change the jump table addresses!

#define JT_INIT_UART        0x0

#define JT_UART_GET_BYTE    0x0

#define JT_UART_SEND_BYTE   0x0

#define JT_PARSE_PACKET     0x0

#define JT_SEND_PACKET      0x0

// Jump table functions for locations that are in the bootloader

#ifdef TOOLBOX

void (*uart_init)(uint16_t baud) = JT_UART_INIT;

int8_t (*uart_get_byte)(uint8_t *output_byte) = JT_UART_GET_BYTE;

void (*uart_send_byte)(uint8_t data) = JT_UART_SEND_BYTE;

void (*uart_toggle_transmit)(uint8_t state) = JT_UART_TOGGLE_TRANSMIT;

char (*parse_packet)(uint8_t *mbuf) = JT_PARSE_PACKET;

void (*send_packet)(uint8_t cmd) = JT_SEND_PACKET;

#endif

#endif