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