fix: .history was never written
[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 return 99;
69 }
70 /**
71 * @brief This method should be called when sending a new command to the pm3. In case any old
72 * responses from previous commands are stored in the buffer, a call to this method should clear them.
73 * A better method could have been to have explicit command-ACKS, so we can know which ACK goes to which
74 * operation. Right now we'll just have to live with this.
75 */
76 void clearCommandBuffer()
77 {
78 //This is a very simple operation
79 cmd_tail = cmd_head;
80 }
81
82 /**
83 * @brief storeCommand stores a USB command in a circular buffer
84 * @param UC
85 */
86 void storeCommand(UsbCommand *command)
87 {
88 if( ( cmd_head+1) % CMD_BUFFER_SIZE == cmd_tail)
89 {
90 //If these two are equal, we're about to overwrite in the
91 // circular buffer.
92 PrintAndLog("WARNING: Command buffer about to overwrite command! This needs to be fixed!");
93 }
94 //Store the command at the 'head' location
95 UsbCommand* destination = &cmdBuffer[cmd_head];
96 memcpy(destination, command, sizeof(UsbCommand));
97
98 cmd_head = (cmd_head +1) % CMD_BUFFER_SIZE; //increment head and wrap
99 }
100
101
102 /**
103 * @brief getCommand gets a command from an internal circular buffer.
104 * @param response location to write command
105 * @return 1 if response was returned, 0 if nothing has been received
106 */
107 int getCommand(UsbCommand* response)
108 {
109 //If head == tail, there's nothing to read, or if we just got initialized
110 if(cmd_head == cmd_tail){
111 return 0;
112 }
113 //Pick out the next unread command
114 UsbCommand* last_unread = &cmdBuffer[cmd_tail];
115 memcpy(response, last_unread, sizeof(UsbCommand));
116 //Increment tail - this is a circular buffer, so modulo buffer size
117 cmd_tail = (cmd_tail +1 ) % CMD_BUFFER_SIZE;
118
119 return 1;
120 }
121
122
123 /**
124 * Waits for a certain response type. This method waits for a maximum of
125 * ms_timeout milliseconds for a specified response command.
126 *@brief WaitForResponseTimeout
127 * @param cmd command to wait for
128 * @param response struct to copy received command into.
129 * @param ms_timeout
130 * @return true if command was returned, otherwise false
131 */
132 bool WaitForResponseTimeout(uint32_t cmd, UsbCommand* response, size_t ms_timeout) {
133
134 UsbCommand resp;
135
136 if (response == NULL) {
137 response = &resp;
138 }
139
140 // Wait until the command is received
141 for(size_t dm_seconds=0; dm_seconds < ms_timeout/10; dm_seconds++) {
142 while(getCommand(response)) {
143 if(response->cmd == cmd){
144 return true;
145 }
146 }
147 msleep(10); // XXX ugh
148 if (dm_seconds == 200) { // Two seconds elapsed
149 PrintAndLog("Waiting for a response from the proxmark...");
150 PrintAndLog("Don't forget to cancel its operation first by pressing on the button");
151 }
152 }
153 return false;
154 }
155
156
157 bool WaitForResponse(uint32_t cmd, UsbCommand* response) {
158 return WaitForResponseTimeout(cmd,response,-1);
159 }
160
161
162 //-----------------------------------------------------------------------------
163 // Entry point into our code: called whenever the user types a command and
164 // then presses Enter, which the full command line that they typed.
165 //-----------------------------------------------------------------------------
166 int CommandReceived(char *Cmd) {
167 return CmdsParse(CommandTable, Cmd);
168 }
169
170
171 //-----------------------------------------------------------------------------
172 // Entry point into our code: called whenever we received a packet over USB
173 // that we weren't necessarily expecting, for example a debug print.
174 //-----------------------------------------------------------------------------
175 void UsbCommandReceived(UsbCommand *UC)
176 {
177 switch(UC->cmd) {
178 // First check if we are handling a debug message
179 case CMD_DEBUG_PRINT_STRING: {
180 char s[USB_CMD_DATA_SIZE+1] = {0x00};
181 size_t len = MIN(UC->arg[0],USB_CMD_DATA_SIZE);
182 memcpy(s,UC->d.asBytes,len);
183 PrintAndLog("#db# %s ", s);
184 return;
185 } break;
186
187 case CMD_DEBUG_PRINT_INTEGERS: {
188 PrintAndLog("#db# %08x, %08x, %08x \r\n", UC->arg[0], UC->arg[1], UC->arg[2]);
189 return;
190 } break;
191
192 case CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K: {
193 memcpy(sample_buf+(UC->arg[0]),UC->d.asBytes,UC->arg[1]);
194 return;
195 } break;
196
197 default:
198 storeCommand(UC);
199 break;
200 }
201
202 }
203
Impressum, Datenschutz