deced5585c6dc343ebe2d74a8e7f6e6068ba25c1
[proxmark3-svn] / client / cmdmain.c
1 //-----------------------------------------------------------------------------
2 // Copyright (C) 2010 iZsh <izsh at fail0verflow.com>
3 //
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
6 // the license.
7 //-----------------------------------------------------------------------------
8 // Main command parser entry point
9 //-----------------------------------------------------------------------------
10
11 #include <stdio.h>
12 #include <stdlib.h>
13 #include <unistd.h>
14 #include <string.h>
15 #include "sleep.h"
16 #include "cmdparser.h"
17 #include "proxmark3.h"
18 #include "data.h"
19 #include "usb_cmd.h"
20 #include "ui.h"
21 #include "cmdhf.h"
22 #include "cmddata.h"
23 #include "cmdhw.h"
24 #include "cmdlf.h"
25 #include "cmdmain.h"
26 #include "util.h"
27 #include "cmdscript.h"
28
29
30 unsigned int current_command = CMD_UNKNOWN;
31
32 static int CmdHelp(const char *Cmd);
33 static int CmdQuit(const char *Cmd);
34
35 //For storing command that are received from the device
36 #define CMD_BUFFER_SIZE 50
37 static UsbCommand cmdBuffer[CMD_BUFFER_SIZE];
38 //Points to the next empty position to write to
39 static int cmd_head;//Starts as 0
40 //Points to the position of the last unread command
41 static int cmd_tail;//Starts as 0
42
43 static command_t CommandTable[] =
44 {
45 {"help", CmdHelp, 1, "This help. Use '<command> help' for details of a particular command."},
46 {"data", CmdData, 1, "{ Plot window / data buffer manipulation... }"},
47 {"hf", CmdHF, 1, "{ High Frequency commands... }"},
48 {"hw", CmdHW, 1, "{ Hardware commands... }"},
49 {"lf", CmdLF, 1, "{ Low Frequency commands... }"},
50 {"script", CmdScript, 1,"{ Scripting commands }"},
51 {"quit", CmdQuit, 1, "Exit program"},
52 {"exit", CmdQuit, 1, "Exit program"},
53 {NULL, NULL, 0, NULL}
54 };
55
56 command_t* getTopLevelCommandTable()
57 {
58 return CommandTable;
59 }
60 int CmdHelp(const char *Cmd)
61 {
62 CmdsHelp(CommandTable);
63 return 0;
64 }
65
66 int CmdQuit(const char *Cmd)
67 {
68 exit(0);
69 return 0;
70 }
71 /**
72 * @brief This method should be called when sending a new command to the pm3. In case any old
73 * responses from previous commands are stored in the buffer, a call to this method should clear them.
74 * A better method could have been to have explicit command-ACKS, so we can know which ACK goes to which
75 * operation. Right now we'll just have to live with this.
76 */
77 void clearCommandBuffer()
78 {
79 //This is a very simple operation
80 cmd_tail = cmd_head;
81 }
82
83 /**
84 * @brief storeCommand stores a USB command in a circular buffer
85 * @param UC
86 */
87 void storeCommand(UsbCommand *command)
88 {
89 if( ( cmd_head+1) % CMD_BUFFER_SIZE == cmd_tail)
90 {
91 //If these two are equal, we're about to overwrite in the
92 // circular buffer.
93 PrintAndLog("WARNING: Command buffer about to overwrite command! This needs to be fixed!");
94 }
95 //Store the command at the 'head' location
96 UsbCommand* destination = &cmdBuffer[cmd_head];
97 memcpy(destination, command, sizeof(UsbCommand));
98
99 cmd_head = (cmd_head +1) % CMD_BUFFER_SIZE; //increment head and wrap
100 }
101
102
103 /**
104 * @brief getCommand gets a command from an internal circular buffer.
105 * @param response location to write command
106 * @return 1 if response was returned, 0 if nothing has been received
107 */
108 int getCommand(UsbCommand* response)
109 {
110 //If head == tail, there's nothing to read, or if we just got initialized
111 if(cmd_head == cmd_tail){
112 return 0;
113 }
114 //Pick out the next unread command
115 UsbCommand* last_unread = &cmdBuffer[cmd_tail];
116 memcpy(response, last_unread, sizeof(UsbCommand));
117 //Increment tail - this is a circular buffer, so modulo buffer size
118 cmd_tail = (cmd_tail +1 ) % CMD_BUFFER_SIZE;
119
120 return 1;
121 }
122
123
124 /**
125 * Waits for a certain response type. This method waits for a maximum of
126 * ms_timeout milliseconds for a specified response command.
127 *@brief WaitForResponseTimeout
128 * @param cmd command to wait for
129 * @param response struct to copy received command into.
130 * @param ms_timeout
131 * @return true if command was returned, otherwise false
132 */
133 bool WaitForResponseTimeout(uint32_t cmd, UsbCommand* response, size_t ms_timeout) {
134
135 UsbCommand resp;
136
137 if (response == NULL) {
138 response = &resp;
139 }
140
141 // Wait until the command is received
142 for(size_t dm_seconds=0; dm_seconds < ms_timeout/10; dm_seconds++) {
143 while(getCommand(response)) {
144 if(response->cmd == cmd){
145 return true;
146 }
147 }
148 msleep(10); // XXX ugh
149 if (dm_seconds == 200) { // Two seconds elapsed
150 PrintAndLog("Waiting for a response from the proxmark...");
151 PrintAndLog("Don't forget to cancel its operation first by pressing on the button");
152 }
153 }
154 return false;
155 }
156
157
158 bool WaitForResponse(uint32_t cmd, UsbCommand* response) {
159 return WaitForResponseTimeout(cmd,response,-1);
160 }
161
162
163 //-----------------------------------------------------------------------------
164 // Entry point into our code: called whenever the user types a command and
165 // then presses Enter, which the full command line that they typed.
166 //-----------------------------------------------------------------------------
167 void CommandReceived(char *Cmd) {
168 CmdsParse(CommandTable, Cmd);
169 }
170
171
172 //-----------------------------------------------------------------------------
173 // Entry point into our code: called whenever we received a packet over USB
174 // that we weren't necessarily expecting, for example a debug print.
175 //-----------------------------------------------------------------------------
176 void UsbCommandReceived(UsbCommand *UC)
177 {
178 switch(UC->cmd) {
179 // First check if we are handling a debug message
180 case CMD_DEBUG_PRINT_STRING: {
181 char s[USB_CMD_DATA_SIZE+1] = {0x00};
182 size_t len = MIN(UC->arg[0],USB_CMD_DATA_SIZE);
183 memcpy(s,UC->d.asBytes,len);
184 PrintAndLog("#db# %s ", s);
185 return;
186 } break;
187
188 case CMD_DEBUG_PRINT_INTEGERS: {
189 PrintAndLog("#db# %08x, %08x, %08x \r\n", UC->arg[0], UC->arg[1], UC->arg[2]);
190 return;
191 } break;
192
193 case CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K: {
194 memcpy(sample_buf+(UC->arg[0]),UC->d.asBytes,UC->arg[1]);
195 return;
196 } break;
197
198 default:
199 storeCommand(UC);
200 break;
201 }
202
203 }
204
Impressum, Datenschutz