Add note about another tested PIC target: PIC24FJ64GA002
[goodfet] / firmware / include / command.h
index f91eded..d514e49 100644 (file)
@@ -1,9 +1,37 @@
-// Command handling functions.
+/*! \file command.h
+  \author Travis Goodspeed
+  \brief Command codes and buffers.
+*/
+
+
+//Types
+#define u8 unsigned char
+#define u16 unsigned int
+#define u32 unsigned long
+
+
+#ifdef msp430x2274
+//256 bytes, plus overhead
+//For chips with very little RAM.
+#define CMDDATALEN 0x104
+//#warning Very little RAM.
+#endif
+
+#ifndef CMDDATALEN
+//512 bytes
+#define CMDDATALEN 0x204
+//4k
+//#define CMDDATALEN 0x1004
+#endif
 
 //! Global data buffer.
-extern unsigned char cmddata[256];
+extern unsigned char cmddata[CMDDATALEN];
+extern unsigned char silent;
+
 #define cmddataword ((unsigned int*) cmddata)
+#define cmddatalong ((unsigned long*) cmddata)
 #define memorybyte ((unsigned char*) 0)
+#define memoryword ((unsigned int*) 0)
 
 // Global Commands
 #define READ  0x00
@@ -13,18 +41,117 @@ extern unsigned char cmddata[256];
 #define SETUP 0x10
 #define START 0x20
 #define STOP  0x21
+#define CALL  0x30
+#define EXEC  0x31
 #define NOK   0x7E
 #define OK    0x7F
 
+#define DEBUGSTR 0xFF
+
+
+
+//SPI commands
+#define SPI_JEDEC 0x80
+#define SPI_ERASE 0x81
+#define SPI_RW_EM260 0x82
+
+//OCT commands
+#define OCT_CMP 0x90
+#define OCT_RES 0x91
+
+#ifdef GCC
+#define WEAKDEF __attribute__ ((weak))
+#else
+//Compiler doesn't support weak linking. :(
+#define WEAKDEF
+#endif
+
+//! Handle a plugin, weak-linked to error.
+extern int pluginhandle(unsigned char app,
+                       unsigned char verb,
+                       unsigned int len)
+  WEAKDEF;
+
+
 //! Handle a command.  Defined in goodfet.c
 void handle(unsigned char app,
            unsigned char verb,
-           unsigned  char len);
-
+           unsigned long len);
+//! Transmit a header.
+void txhead(unsigned char app,
+           unsigned char verb,
+           unsigned long len);
 //! Transmit data.
 void txdata(unsigned char app,
            unsigned char verb,
-           unsigned char len);
+           unsigned long len);
+//! Transmit a string.
+void txstring(unsigned char app,
+             unsigned char verb,
+             const char *str);
+
+//! Receive a long.
+unsigned long rxlong();
+//! Receive a word.
+unsigned int rxword();
+
+//! Transmit a long.
+void txlong(unsigned long l);
+//! Transmit a word.
+void txword(unsigned int l);
+
+//! Transmit a debug sequence of bytes
+void debugbytes(const char *bytes, unsigned int len);
+//! Transmit a debug string.
+void debugstr(const char *str);
+//! brief Debug a hex word string.
+void debughex(u16 v);
+//! brief Debug a hex long string.
+void debughex32(u32 v);
 
-//! Delay
+//! Delay for a count.
 void delay(unsigned int count);
+//! MSDelay
+void msdelay(unsigned int ms);
+
+
+//! Prepare Timer B; call before using delay_ms or delay_us.
+void prep_timer();
+
+//! Delay for specified number of milliseconds (given 16 MHz clock)
+void delay_ms( unsigned int ms );
+
+//! Delay for specified number of microseconds (given 16 MHz clock)
+void delay_us( unsigned int us );
+
+//! Delay for specified number of clock ticks (16 MHz clock implies 62.5 ns per tick).
+void delay_ticks( unsigned int num_ticks );
+
+
+void monitorhandle(unsigned char, unsigned char, unsigned long);
+WEAKDEF void spihandle(unsigned char, unsigned char, unsigned long);
+WEAKDEF void i2chandle(unsigned char, unsigned char, unsigned long);
+WEAKDEF void cchandle(unsigned char, unsigned char, unsigned long);
+WEAKDEF void jtaghandle(unsigned char, unsigned char, unsigned long);
+WEAKDEF void jtag430handle(unsigned char, unsigned char, unsigned long);
+WEAKDEF void ejtaghandle(unsigned char, unsigned char, unsigned long);
+WEAKDEF void jtagarm7tdmihandle(unsigned char app, unsigned char verb, unsigned long len);
+
+WEAKDEF void jtag430x2handle(unsigned char app, unsigned char verb, unsigned long len);
+
+WEAKDEF void nrfhandle(unsigned char,
+                      unsigned char,
+                      unsigned long);
+WEAKDEF void ccspihandle(unsigned char,
+                      unsigned char,
+                      unsigned long);
+WEAKDEF void avrhandle(unsigned char app,
+                      unsigned char verb,
+                      unsigned long len);  
+WEAKDEF int smartcardhandle(unsigned char app,
+                           unsigned char verb,
+                           unsigned int len);
+
+WEAKDEF void pichandle( unsigned char app,
+                       unsigned char verb,
+                       unsigned long len );