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