1 //-----------------------------------------------------------------------------
2 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
4 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
5 // at your option, any later version. See the LICENSE.txt file for the text of
7 //-----------------------------------------------------------------------------
8 // Main command parser entry point
9 //-----------------------------------------------------------------------------
16 #include "cmdparser.h"
17 #include "proxmark3.h"
27 #include "cmdscript.h"
31 unsigned int current_command
= CMD_UNKNOWN
;
33 static int CmdHelp(const char *Cmd
);
34 static int CmdQuit(const char *Cmd
);
35 static int CmdRev(const char *Cmd
);
36 // for testing reveng api - cmdcrc.c
38 static int CmdrevengT(const char *Cmd);
39 static int CmdrevengC(const char *Cmd);
40 static int CmdrevengA(const char *Cmd);
42 //For storing command that are received from the device
43 static UsbCommand cmdBuffer
[CMD_BUFFER_SIZE
];
44 //Points to the next empty position to write to
45 static int cmd_head
;//Starts as 0
46 //Points to the position of the last unread command
47 static int cmd_tail
;//Starts as 0
49 static command_t CommandTable
[] =
51 {"help", CmdHelp
, 1, "This help. Use '<command> help' for details of a particular command."},
52 {"data", CmdData
, 1, "{ Plot window / data buffer manipulation... }"},
53 {"hf", CmdHF
, 1, "{ High Frequency commands... }"},
54 {"hw", CmdHW
, 1, "{ Hardware commands... }"},
55 {"lf", CmdLF
, 1, "{ Low Frequency commands... }"},
56 {"reveng",CmdRev
, 1, "Crc calculations from the software reveng1-30"},
57 /* // for testing reveng api - cmdcrc.c
58 {"revenga",CmdrevengA,1, "TEST Crc calculations from the software reveng1-30"},
59 {"revengt",CmdrevengT,1, "TEST Crc calculations from the software reveng1-30"},
60 {"revengc",CmdrevengC,1, "TEST Crc calculations from the software reveng1-30"},
62 {"script",CmdScript
,1, "{ Scripting commands }"},
63 {"quit", CmdQuit
, 1, "Exit program"},
64 {"exit", CmdQuit
, 1, "Exit program"},
68 command_t
* getTopLevelCommandTable()
72 int CmdHelp(const char *Cmd
)
74 CmdsHelp(CommandTable
);
78 int CmdQuit(const char *Cmd
)
84 int CmdRev(const char *Cmd
)
90 /* // for testing reveng api - cmdcrc.c
91 int CmdrevengA(const char *Cmd)
93 return CmdrevengSearch(Cmd);
95 int CmdrevengT(const char *Cmd)
97 return CmdrevengTest(Cmd);
99 int CmdrevengC(const char *Cmd)
101 return CmdrevengTestC(Cmd);
105 * @brief This method should be called when sending a new command to the pm3. In case any old
106 * responses from previous commands are stored in the buffer, a call to this method should clear them.
107 * A better method could have been to have explicit command-ACKS, so we can know which ACK goes to which
108 * operation. Right now we'll just have to live with this.
110 void clearCommandBuffer()
112 //This is a very simple operation
117 * @brief storeCommand stores a USB command in a circular buffer
120 void storeCommand(UsbCommand
*command
)
122 if( ( cmd_head
+1) % CMD_BUFFER_SIZE
== cmd_tail
)
124 //If these two are equal, we're about to overwrite in the
126 PrintAndLog("WARNING: Command buffer about to overwrite command! This needs to be fixed!");
128 //Store the command at the 'head' location
129 UsbCommand
* destination
= &cmdBuffer
[cmd_head
];
130 memcpy(destination
, command
, sizeof(UsbCommand
));
132 cmd_head
= (cmd_head
+1) % CMD_BUFFER_SIZE
; //increment head and wrap
136 * @brief getCommand gets a command from an internal circular buffer.
137 * @param response location to write command
138 * @return 1 if response was returned, 0 if nothing has been received
140 int getCommand(UsbCommand
* response
)
142 //If head == tail, there's nothing to read, or if we just got initialized
143 if(cmd_head
== cmd_tail
){
146 //Pick out the next unread command
147 UsbCommand
* last_unread
= &cmdBuffer
[cmd_tail
];
148 memcpy(response
, last_unread
, sizeof(UsbCommand
));
149 //Increment tail - this is a circular buffer, so modulo buffer size
150 cmd_tail
= (cmd_tail
+1 ) % CMD_BUFFER_SIZE
;
157 * Waits for a certain response type. This method waits for a maximum of
158 * ms_timeout milliseconds for a specified response command.
159 *@brief WaitForResponseTimeout
160 * @param cmd command to wait for
161 * @param response struct to copy received command into.
163 * @return true if command was returned, otherwise false
165 bool WaitForResponseTimeout(uint32_t cmd
, UsbCommand
* response
, size_t ms_timeout
) {
169 if (response
== NULL
)
173 // Wait until the command is received
174 for(size_t dm_seconds
=0; dm_seconds
< ms_timeout
/10; dm_seconds
++) {
176 while(getCommand(response
)) {
177 if(response
->cmd
== cmd
){
181 msleep(10); // XXX ugh
182 if (dm_seconds
== 200) { // Two seconds elapsed
183 PrintAndLog("Waiting for a response from the proxmark...");
184 PrintAndLog("Don't forget to cancel its operation first by pressing on the button");
190 bool WaitForResponse(uint32_t cmd
, UsbCommand
* response
) {
191 return WaitForResponseTimeout(cmd
,response
,-1);
194 //-----------------------------------------------------------------------------
195 // Entry point into our code: called whenever the user types a command and
196 // then presses Enter, which the full command line that they typed.
197 //-----------------------------------------------------------------------------
198 void CommandReceived(char *Cmd
) {
199 CmdsParse(CommandTable
, Cmd
);
202 //-----------------------------------------------------------------------------
203 // Entry point into our code: called whenever we received a packet over USB
204 // that we weren't necessarily expecting, for example a debug print.
205 //-----------------------------------------------------------------------------
206 void UsbCommandReceived(UsbCommand
*UC
)
209 // First check if we are handling a debug message
210 case CMD_DEBUG_PRINT_STRING
: {
211 char s
[USB_CMD_DATA_SIZE
+1] = {0x00};
212 size_t len
= MIN(UC
->arg
[0],USB_CMD_DATA_SIZE
);
213 memcpy(s
,UC
->d
.asBytes
,len
);
214 PrintAndLog("#db# %s ", s
);
218 case CMD_DEBUG_PRINT_INTEGERS
: {
219 PrintAndLog("#db# %08x, %08x, %08x \r\n", UC
->arg
[0], UC
->arg
[1], UC
->arg
[2]);
223 case CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K
: {
224 memcpy(sample_buf
+(UC
->arg
[0]),UC
->d
.asBytes
,UC
->arg
[1]);