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
  52
  53 //SPI commands
  54 #define SPI_JEDEC 0x80
  55 #define SPI_ERASE 0x81
  56
  57 //OCT commands
  58 #define OCT_CMP 0x90
  59 #define OCT_RES 0x91
  60
  61 #ifdef GCC
  62 #define WEAKDEF __attribute__ ((weak))
  63 #else
  64 //Compiler doesn't support weak linking. :(
  65 #define WEAKDEF
  66 #endif
  67
  68 //! Handle a plugin, weak-linked to error.
  69 extern int pluginhandle(unsigned char app,
  70                         unsigned char verb,
  71                         unsigned int len)
  72   WEAKDEF;
  73
  74
  75 //! Handle a command.  Defined in goodfet.c
  76 void handle(unsigned char app,
  77             unsigned char verb,
  78             unsigned long len);
  79 //! Transmit a header.
  80 void txhead(unsigned char app,
  81             unsigned char verb,
  82             unsigned long len);
  83 //! Transmit data.
  84 void txdata(unsigned char app,
  85             unsigned char verb,
  86             unsigned long len);
  87 //! Transmit a string.
  88 void txstring(unsigned char app,
  89               unsigned char verb,
  90               const char *str);
  91
  92 //! Receive a long.
  93 unsigned long rxlong();
  94 //! Receive a word.
  95 unsigned int rxword();
  96
  97 //! Transmit a long.
  98 void txlong(unsigned long l);
  99 //! Transmit a word.
 100 void txword(unsigned int l);
 101
 102 //! Transmit a debug sequence of bytes
 103 void debugbytes(const char *bytes, unsigned int len);
 104 //! Transmit a debug string.
 105 void debugstr(const char *str);
 106 //! brief Debug a hex word string.
 107 void debughex(u16 v);
 108 //! brief Debug a hex long string.
 109 void debughex32(u32 v);
 110
 111 //! Delay for a count.
 112 void delay(unsigned int count);
 113 //! MSDelay
 114 void msdelay(unsigned int ms);
 115
 116
 117 //! Prepare Timer A; call before using delay_ms or delay_us.
 118 void prep_timer();
 119
 120 //! Delay for specified number of milliseconds (given 16 MHz clock)
 121 void delay_ms( unsigned int ms );
 122
 123 //! Delay for specified number of microseconds (given 16 MHz clock)
 124 void delay_us( unsigned int us );
 125
 126 //! Delay for specified number of clock ticks (16 MHz clock implies 62.5 ns per tick).
 127 void delay_ticks( unsigned int num_ticks );
 128
 129
 130 void monitorhandle(unsigned char, unsigned char, unsigned long);
 131 WEAKDEF void spihandle(unsigned char, unsigned char, unsigned long);
 132 WEAKDEF void i2chandle(unsigned char, unsigned char, unsigned long);
 133 WEAKDEF void cchandle(unsigned char, unsigned char, unsigned long);
 134 WEAKDEF void jtaghandle(unsigned char, unsigned char, unsigned long);
 135 WEAKDEF void jtag430handle(unsigned char, unsigned char, unsigned long);
 136 WEAKDEF void ejtaghandle(unsigned char, unsigned char, unsigned long);
 137 WEAKDEF void jtagarm7tdmihandle(unsigned char app, unsigned char verb, unsigned long len);
 138
 139 WEAKDEF void jtag430x2handle(unsigned char app, unsigned char verb, unsigned long len);
 140
 141 WEAKDEF void nrfhandle(unsigned char,
 142                        unsigned char,
 143                        unsigned long);
 144 WEAKDEF void avrhandle(unsigned char app,
 145                        unsigned char verb,
 146                        unsigned long len);
 147 WEAKDEF int smartcardhandle(unsigned char app,
 148                             unsigned char verb,
 149                             unsigned int len);
 150
 151 WEAKDEF void pichandle( unsigned char app,
 152                         unsigned char verb,
 153                         unsigned long len );