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