git.rot13.org Git - goodfet/blob - firmware/include/command.h

   1 /*! \file command.h
   2   \author Travis Goodspeed
   3   \brief Command codes and buffers.
   4 */
   5
   6
   7 //Types
   8 #define u8 unsigned char
   9 #define u16 unsigned int
  10 #define u32 unsigned long
  11
  12
  13 #ifdef msp430x2274
  14 //256 bytes, plus overhead
  15 //For chips with very little RAM.
  16 #define CMDDATALEN 0x104
  17 //#warning Very little RAM.
  18 #endif
  19
  20 #ifndef CMDDATALEN
  21 //512 bytes
  22 #define CMDDATALEN 0x204
  23 //4k
  24 //#define CMDDATALEN 0x1004
  25 #endif
  26
  27 //! Global data buffer.
  28 extern unsigned char cmddata[CMDDATALEN];
  29 extern unsigned char silent;
  30
  31 #define cmddataword ((unsigned int*) cmddata)
  32 #define cmddatalong ((unsigned long*) cmddata)
  33 #define memorybyte ((unsigned char*) 0)
  34 #define memoryword ((unsigned int*) 0)
  35
  36 // Global Commands
  37 #define READ  0x00
  38 #define WRITE 0x01
  39 #define PEEK  0x02
  40 #define POKE  0x03
  41 #define SETUP 0x10
  42 #define START 0x20
  43 #define STOP  0x21
  44 #define CALL  0x30
  45 #define EXEC  0x31
  46 #define NOK   0x7E
  47 #define OK    0x7F
  48
  49 #define DEBUGSTR 0xFF
  50
  51 // Monitor Commands
  52 #define MONITOR_CHANGE_BAUD 0x80
  53 #define MONITOR_RAM_PATTERN 0x90
  54 #define MONITOR_RAM_DEPTH 0x91
  55
  56 #define MONITOR_DIR 0xA0
  57 #define MONITOR_OUT 0xA1
  58 #define MONITOR_IN  0xA2
  59
  60 #define MONITOR_SILENT 0xB0
  61 #define MONITOR_CONNECTED 0xB1
  62
  63 #define MONITOR_READBUF 0xC0
  64 #define MONITOR_WRITEBUF 0xC1
  65 #define MONITOR_SIZEBUF 0xC2
  66
  67
  68
  69
  70 //SPI commands
  71 #define SPI_JEDEC 0x80
  72 #define SPI_ERASE 0x81
  73
  74 //OCT commands
  75 #define OCT_CMP 0x90
  76 #define OCT_RES 0x91
  77
  78 #ifdef GCC
  79 #define WEAKDEF __attribute__ ((weak))
  80 #else
  81 //Compiler doesn't support weak linking. :(
  82 #define WEAKDEF
  83 #endif
  84
  85 //! Handle a plugin, weak-linked to error.
  86 extern int pluginhandle(unsigned char app,
  87                         unsigned char verb,
  88                         unsigned int len)
  89   WEAKDEF;
  90
  91
  92 //! Handle a command.  Defined in goodfet.c
  93 void handle(unsigned char app,
  94             unsigned char verb,
  95             unsigned long len);
  96 //! Transmit a header.
  97 void txhead(unsigned char app,
  98             unsigned char verb,
  99             unsigned long len);
 100 //! Transmit data.
 101 void txdata(unsigned char app,
 102             unsigned char verb,
 103             unsigned long len);
 104 //! Transmit a string.
 105 void txstring(unsigned char app,
 106               unsigned char verb,
 107               const char *str);
 108
 109 //! Receive a long.
 110 unsigned long rxlong();
 111 //! Receive a word.
 112 unsigned int rxword();
 113
 114 //! Transmit a long.
 115 void txlong(unsigned long l);
 116 //! Transmit a word.
 117 void txword(unsigned int l);
 118
 119 //! Transmit a debug sequence of bytes
 120 void debugbytes(const char *bytes, unsigned int len);
 121 //! Transmit a debug string.
 122 void debugstr(const char *str);
 123 //! brief Debug a hex word string.
 124 void debughex(u16 v);
 125 //! brief Debug a hex long string.
 126 void debughex32(u32 v);
 127
 128 //! Delay for a count.
 129 void delay(unsigned int count);
 130 //! MSDelay
 131 void msdelay(unsigned int ms);
 132
 133
 134 //! Prepare Timer A; call before using delay_ms or delay_us.
 135 void prep_timer();
 136
 137 //! Delay for specified number of milliseconds (given 16 MHz clock)
 138 void delay_ms( unsigned int ms );
 139
 140 //! Delay for specified number of microseconds (given 16 MHz clock)
 141 void delay_us( unsigned int us );
 142
 143 //! Delay for specified number of clock ticks (16 MHz clock implies 62.5 ns per tick).
 144 void delay_ticks( unsigned int num_ticks );
 145
 146
 147 void monitorhandle(unsigned char, unsigned char, unsigned long);
 148 void spihandle(unsigned char, unsigned char, unsigned long);
 149 void i2chandle(unsigned char, unsigned char, unsigned long) WEAKDEF;
 150 void cchandle(unsigned char, unsigned char, unsigned long) WEAKDEF;
 151 void jtaghandle(unsigned char, unsigned char, unsigned long);
 152 void jtag430handle(unsigned char, unsigned char, unsigned long);
 153 WEAKDEF void ejtaghandle(unsigned char, unsigned char, unsigned long);
 154 WEAKDEF void jtagarm7tdmihandle(unsigned char app, unsigned char verb, unsigned long len);
 155
 156 void jtag430x2handle(unsigned char app, unsigned char verb, unsigned long len);
 157
 158 WEAKDEF void avrhandle(unsigned char app,
 159                        unsigned char verb,
 160                        unsigned long len);
 161 WEAKDEF int smartcardhandle(unsigned char app,
 162                             unsigned char verb,
 163                             unsigned int len);
 164
 165 WEAKDEF void pichandle( unsigned char app,
 166                         unsigned char verb,
 167                         unsigned long len );