]> git.zerfleddert.de Git - proxmark3-svn/blame - client/cmdmain.c
CHG: moved to header file
[proxmark3-svn] / client / cmdmain.c
CommitLineData
a553f267 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
7fe9b0b7 11#include <stdio.h>
12#include <stdlib.h>
13#include <unistd.h>
14#include <string.h>
91c38cf7 15#include "sleep.h"
7fe9b0b7 16#include "cmdparser.h"
902cb3c0 17#include "proxmark3.h"
7fe9b0b7 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"
9440213d 26#include "util.h"
1d59cd8d 27#include "cmdscript.h"
9962091e 28#include "cmdcrc.h"
812513bf 29#include "cmdanalyse.h"
e772353f 30
7fe9b0b7 31unsigned int current_command = CMD_UNKNOWN;
7fe9b0b7 32
33static int CmdHelp(const char *Cmd);
34static int CmdQuit(const char *Cmd);
a71ece51 35static int CmdRev(const char *Cmd);
7fe9b0b7 36
fd368d18 37//For storing command that are received from the device
0de8e387 38#define CMD_BUFFER_SIZE 50
fd368d18 39static UsbCommand cmdBuffer[CMD_BUFFER_SIZE];
40//Points to the next empty position to write to
41static int cmd_head;//Starts as 0
42//Points to the position of the last unread command
43static int cmd_tail;//Starts as 0
44
7fe9b0b7 45static command_t CommandTable[] =
46{
9962091e 47 {"help", CmdHelp, 1, "This help. Use '<command> help' for details of a particular command."},
812513bf 48 {"analyse", CmdAnalyse, 1, "{ Analyse bytes... }"},
9962091e 49 {"data", CmdData, 1, "{ Plot window / data buffer manipulation... }"},
50 {"hf", CmdHF, 1, "{ High Frequency commands... }"},
51 {"hw", CmdHW, 1, "{ Hardware commands... }"},
52 {"lf", CmdLF, 1, "{ Low Frequency commands... }"},
812513bf 53 {"reveng", CmdRev, 1, "Crc calculations from the software reveng 1.40"},
54 {"script", CmdScript, 1, "{ Scripting commands }"},
9962091e 55 {"quit", CmdQuit, 1, "Exit program"},
56 {"exit", CmdQuit, 1, "Exit program"},
57 {NULL, NULL, 0, NULL}
7fe9b0b7 58};
59
57c69556
MHS
60command_t* getTopLevelCommandTable()
61{
62 return CommandTable;
63}
7fe9b0b7 64int CmdHelp(const char *Cmd)
65{
66 CmdsHelp(CommandTable);
67 return 0;
68}
69
70int CmdQuit(const char *Cmd)
71{
cc3c0a51 72 return 99;
7fe9b0b7 73}
a71ece51 74
75int CmdRev(const char *Cmd)
76{
77 CmdCrc(Cmd);
78 return 0;
79}
42daa759 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 */
86void 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 */
96void 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 * @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 */
116int getCommand(UsbCommand* response)
117{
118 //If head == tail, there's nothing to read, or if we just got initialized
a82c1ac8 119 if(cmd_head == cmd_tail) return 0;
120
42daa759 121 //Pick out the next unread command
122 UsbCommand* last_unread = &cmdBuffer[cmd_tail];
123 memcpy(response, last_unread, sizeof(UsbCommand));
719b2377 124
42daa759 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;
42daa759 129}
130
fd368d18 131/**
132 * Waits for a certain response type. This method waits for a maximum of
133 * ms_timeout milliseconds for a specified response command.
134 *@brief WaitForResponseTimeout
135 * @param cmd command to wait for
136 * @param response struct to copy received command into.
137 * @param ms_timeout
138 * @return true if command was returned, otherwise false
139 */
902cb3c0 140bool WaitForResponseTimeout(uint32_t cmd, UsbCommand* response, size_t ms_timeout) {
fd368d18 141
f62b5e12 142 UsbCommand resp;
143
9484ff3d 144 if (response == NULL)
f62b5e12 145 response = &resp;
9484ff3d 146
f62b5e12 147 // Wait until the command is received
0de8e387 148 for ( size_t dm_seconds = 0; dm_seconds < ms_timeout/10; dm_seconds++ ) {
fd368d18 149
0de8e387 150 while( getCommand(response) ) {
719b2377 151 if(response->cmd == cmd)
152 return true;
f62b5e12 153 }
719b2377 154
f62b5e12 155 msleep(10); // XXX ugh
05164399 156 if (dm_seconds == 250) { // 2.5 seconds elapsed
f62b5e12 157 PrintAndLog("Waiting for a response from the proxmark...");
158 PrintAndLog("Don't forget to cancel its operation first by pressing on the button");
159 }
fd368d18 160 }
f62b5e12 161 return false;
534983d7 162}
163
902cb3c0 164bool WaitForResponse(uint32_t cmd, UsbCommand* response) {
0de8e387 165 return WaitForResponseTimeout(cmd, response, -1);
7fe9b0b7 166}
167
168//-----------------------------------------------------------------------------
169// Entry point into our code: called whenever the user types a command and
170// then presses Enter, which the full command line that they typed.
171//-----------------------------------------------------------------------------
cc3c0a51 172int CommandReceived(char *Cmd) {
173 return CmdsParse(CommandTable, Cmd);
7fe9b0b7 174}
175
176//-----------------------------------------------------------------------------
177// Entry point into our code: called whenever we received a packet over USB
178// that we weren't necessarily expecting, for example a debug print.
179//-----------------------------------------------------------------------------
180void UsbCommandReceived(UsbCommand *UC)
181{
9484ff3d 182 switch(UC->cmd) {
183 // First check if we are handling a debug message
184 case CMD_DEBUG_PRINT_STRING: {
719b2377 185 char s[USB_CMD_DATA_SIZE+1];
e0b30228 186 memset(s, 0x00, sizeof(s));
9484ff3d 187 size_t len = MIN(UC->arg[0],USB_CMD_DATA_SIZE);
719b2377 188 memcpy(s, UC->d.asBytes, len);
38e41917 189
190 // test
191 if ( UC->arg[1] == CMD_MEASURE_ANTENNA_TUNING_HF) {
192 printf("\r#db# %s", s);
193 fflush(stdout);
194 }
81b7e894 195 else {
38e41917 196 PrintAndLog("#db# %s", s);
81b7e894 197 }
9484ff3d 198 return;
199 } break;
200
aaa1a9a2 201 case CMD_DEBUG_PRINT_INTEGERS: {
719b2377 202 PrintAndLog("#db# %08x, %08x, %08x", UC->arg[0], UC->arg[1], UC->arg[2]);
203 break;
aaa1a9a2 204 }
719b2377 205 case CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K:
aaa1a9a2 206 case CMD_DOWNLOADED_EML_BIGBUF: {
81b7e894 207 // sample_buf is a array pointer, located in data.c
208 // arg0 = offset in transfer. Startindex of this chunk
209 // arg1 = length bytes to transfer
210 // arg2 = bigbuff tracelength (?)
719b2377 211 memcpy( sample_buf + (UC->arg[0]), UC->d.asBytes, UC->arg[1]);
81b7e894 212 //printf("DBG:: Download from device. chunk %llu | size %llu | tracelen:%llu \n", UC->arg[0], UC->arg[1], UC->arg[2]);
719b2377 213 break;
aaa1a9a2 214 }
5ee53a0e 215 default: {
216 storeCommand(UC);
0de8e387 217 break;
5ee53a0e 218 }
0de8e387 219 }
480e2f23 220
fd368d18 221}
222
Impressum, Datenschutz