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