]> git.zerfleddert.de Git - proxmark3-svn/blame - client/cmdmain.c
Fix typo in helps
[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>
15#include "cmdparser.h"
902cb3c0 16#include "proxmark3.h"
7fe9b0b7 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"
9440213d 25#include "util.h"
ec9c7112 26#include "util_posix.h"
1d59cd8d 27#include "cmdscript.h"
fe81b478 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);
f46c3663 35static int CmdRev(const char *Cmd);
cf9aa77d 36
fd368d18 37//For storing command that are received from the device
cf9aa77d 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{
57c69556 47 {"help", CmdHelp, 1, "This help. Use '<command> help' for details of a particular command."},
37239a7c 48 {"data", CmdData, 1, "{ Plot window / data buffer manipulation... }"},
fe81b478 49 {"hf", CmdHF, 1, "{ High Frequency commands... }"},
37239a7c 50 {"hw", CmdHW, 1, "{ Hardware commands... }"},
fe81b478 51 {"lf", CmdLF, 1, "{ Low Frequency commands... }"},
f46c3663 52 {"reveng",CmdRev, 1, "Crc calculations from the software reveng1-30"},
53 {"script",CmdScript,1, "{ Scripting commands }"},
57c69556
MHS
54 {"quit", CmdQuit, 1, "Exit program"},
55 {"exit", CmdQuit, 1, "Exit program"},
7fe9b0b7 56 {NULL, NULL, 0, NULL}
57};
58
57c69556
MHS
59command_t* getTopLevelCommandTable()
60{
61 return CommandTable;
62}
7fe9b0b7 63int CmdHelp(const char *Cmd)
64{
65 CmdsHelp(CommandTable);
66 return 0;
67}
68
69int CmdQuit(const char *Cmd)
70{
2487dfeb 71 return 99;
7fe9b0b7 72}
f46c3663 73
74int CmdRev(const char *Cmd)
75{
76 CmdCrc(Cmd);
77 return 0;
78}
d2219cae 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
42daa759 109}
67b7d6fa 110
111
42daa759 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 */
117int 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;
42daa759 130}
131
67b7d6fa 132
fd368d18 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 */
902cb3c0 142bool WaitForResponseTimeout(uint32_t cmd, UsbCommand* response, size_t ms_timeout) {
fd368d18 143
bfb01844 144 UsbCommand resp;
b915fda3 145
67b7d6fa 146 if (response == NULL) {
bfb01844 147 response = &resp;
67b7d6fa 148 }
fd368d18 149
bfb01844 150 // Wait until the command is received
151 for(size_t dm_seconds=0; dm_seconds < ms_timeout/10; dm_seconds++) {
9484ff3d 152 while(getCommand(response)) {
bfb01844 153 if(response->cmd == cmd){
154 return true;
155 }
156 }
67b7d6fa 157 msleep(10); // XXX ugh
158 if (dm_seconds == 200) { // Two seconds elapsed
bfb01844 159 PrintAndLog("Waiting for a response from the proxmark...");
160 PrintAndLog("Don't forget to cancel its operation first by pressing on the button");
67b7d6fa 161 }
fd368d18 162 }
67b7d6fa 163 return false;
534983d7 164}
165
67b7d6fa 166
902cb3c0 167bool WaitForResponse(uint32_t cmd, UsbCommand* response) {
168 return WaitForResponseTimeout(cmd,response,-1);
7fe9b0b7 169}
170
67b7d6fa 171
7fe9b0b7 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//-----------------------------------------------------------------------------
2487dfeb 176int CommandReceived(char *Cmd) {
177 return CmdsParse(CommandTable, Cmd);
7fe9b0b7 178}
179
67b7d6fa 180
7fe9b0b7 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: {
d0168f2f 190 char s[USB_CMD_DATA_SIZE+1];
191 memset(s, 0x00, sizeof(s));
9484ff3d 192 size_t len = MIN(UC->arg[0],USB_CMD_DATA_SIZE);
193 memcpy(s,UC->d.asBytes,len);
d0168f2f 194 PrintAndLog("#db# %s", s);
9484ff3d 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: {
9484ff3d 204 memcpy(sample_buf+(UC->arg[0]),UC->d.asBytes,UC->arg[1]);
67b7d6fa 205 return;
9484ff3d 206 } break;
902cb3c0 207
3fe4ff4f 208 default:
67b7d6fa 209 storeCommand(UC);
9484ff3d 210 break;
211 }
fd368d18 212
fd368d18 213}
214
Impressum, Datenschutz