6f94d6b3eab1264ec88d2fb5ba81e3a741c54e50
[goodfet] / 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 NOK   0x7E
45 #define OK    0x7F
46
47 #define DEBUGSTR 0xFF
48
49 // Monitor Commands
50 #define MONITOR_CHANGE_BAUD 0x80
51 #define MONITOR_RAM_PATTERN 0x90
52 #define MONITOR_RAM_DEPTH 0x91
53
54 #define MONITOR_DIR 0xA0
55 #define MONITOR_OUT 0xA1
56 #define MONITOR_IN  0xA2
57
58 #define MONITOR_SILENT 0xB0
59
60 #define MONITOR_READBUF 0xC0
61 #define MONITOR_WRITEBUF 0xC1
62 #define MONITOR_SIZEBUF 0xC2
63
64
65
66
67 //SPI commands
68 #define SPI_JEDEC 0x80
69 #define SPI_ERASE 0x81
70
71 //OCT commands
72 #define OCT_CMP 0x90
73 #define OCT_RES 0x91
74
75 #define WEAKDEF __attribute__ ((weak))
76
77 //! Handle a plugin, weak-linked to error.
78 extern int pluginhandle(unsigned char app,
79                         unsigned char verb,
80                         unsigned int len)
81   WEAKDEF;
82
83
84 //! Handle a command.  Defined in goodfet.c
85 void handle(unsigned char app,
86             unsigned char verb,
87             unsigned long len);
88 //! Transmit a header.
89 void txhead(unsigned char app,
90             unsigned char verb,
91             unsigned long len);
92 //! Transmit data.
93 void txdata(unsigned char app,
94             unsigned char verb,
95             unsigned long len);
96 //! Transmit a string.
97 void txstring(unsigned char app,
98               unsigned char verb,
99               const char *str);
100
101 //! Receive a long.
102 unsigned long rxlong();
103 //! Receive a word.
104 unsigned int rxword();
105
106 //! Transmit a long.
107 void txlong(unsigned long l);
108 //! Transmit a word.
109 void txword(unsigned int l);
110
111 //! Transmit a debug string.
112 void debugstr(const char *str);
113 //! brief Debug a hex word string.
114 void debughex(u16 v);
115
116 //! Delay for a count.
117 void delay(unsigned int count);
118 //! MSDelay
119 void msdelay(unsigned int ms);
120
121
122 void monitorhandle(unsigned char, unsigned char, unsigned long);
123 void spihandle(unsigned char, unsigned char, unsigned long);
124 void i2chandle(unsigned char, unsigned char, unsigned long) WEAKDEF;
125 void cchandle(unsigned char, unsigned char, unsigned long) WEAKDEF;
126 void jtaghandle(unsigned char, unsigned char, unsigned long);
127 void jtag430handle(unsigned char, unsigned char, unsigned long);
128 void jtag430x2handle(unsigned char app, unsigned char verb,
129                      unsigned long len);
130 void avrhandle(unsigned char app,
131                unsigned char verb,
132                unsigned long len);