2 This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
3 Smoothie is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
4 Smoothie is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
5 You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
9 #include "SimpleShell.h"
10 #include "libs/Kernel.h"
11 #include "libs/nuts_bolts.h"
12 #include "libs/utils.h"
13 #include "libs/SerialMessage.h"
14 #include "libs/StreamOutput.h"
15 #include "modules/robot/Conveyor.h"
16 #include "DirHandle.h"
19 #include "PublicDataRequest.h"
20 #include "AppendFileStream.h"
21 #include "FileStream.h"
22 #include "checksumm.h"
23 #include "PublicData.h"
25 //#include "StepTicker.h"
27 #include "modules/tools/temperaturecontrol/TemperatureControlPublicAccess.h"
28 #include "modules/robot/RobotPublicAccess.h"
29 #include "NetworkPublicAccess.h"
30 #include "platform_memory.h"
31 #include "SwitchPublicAccess.h"
34 #include "system_LPC17xx.h"
37 extern unsigned int g_maximumHeapAddress
;
44 extern "C" uint32_t __end__
;
45 extern "C" uint32_t __malloc_free_list
;
46 extern "C" uint32_t _sbrk(int size
);
48 // command lookup table
49 const SimpleShell::ptentry_t
SimpleShell::commands_table
[] = {
50 {"ls", SimpleShell::ls_command
},
51 {"cd", SimpleShell::cd_command
},
52 {"pwd", SimpleShell::pwd_command
},
53 {"cat", SimpleShell::cat_command
},
54 {"rm", SimpleShell::rm_command
},
55 {"mv", SimpleShell::mv_command
},
56 {"upload", SimpleShell::upload_command
},
57 {"reset", SimpleShell::reset_command
},
58 {"dfu", SimpleShell::dfu_command
},
59 {"break", SimpleShell::break_command
},
60 {"help", SimpleShell::help_command
},
61 {"?", SimpleShell::help_command
},
62 {"version", SimpleShell::version_command
},
63 {"mem", SimpleShell::mem_command
},
64 {"get", SimpleShell::get_command
},
65 {"set_temp", SimpleShell::set_temp_command
},
66 {"switch", SimpleShell::switch_command
},
67 {"net", SimpleShell::net_command
},
68 {"load", SimpleShell::load_command
},
69 {"save", SimpleShell::save_command
},
70 {"remount", SimpleShell::remount_command
},
76 int SimpleShell::reset_delay_secs
= 0;
78 // Adam Greens heap walk from http://mbed.org/forum/mbed/topic/2701/?page=4#comment-22556
79 static uint32_t heapWalk(StreamOutput
*stream
, bool verbose
)
81 uint32_t chunkNumber
= 1;
82 // The __end__ linker symbol points to the beginning of the heap.
83 uint32_t chunkCurr
= (uint32_t)&__end__
;
84 // __malloc_free_list is the head pointer to newlib-nano's link list of free chunks.
85 uint32_t freeCurr
= __malloc_free_list
;
86 // Calling _sbrk() with 0 reserves no more memory but it returns the current top of heap.
87 uint32_t heapEnd
= _sbrk(0);
89 uint32_t freeSize
= 0;
90 uint32_t usedSize
= 0;
92 stream
->printf("Used Heap Size: %lu\n", heapEnd
- chunkCurr
);
94 // Walk through the chunks until we hit the end of the heap.
95 while (chunkCurr
< heapEnd
) {
96 // Assume the chunk is in use. Will update later.
98 // The first 32-bit word in a chunk is the size of the allocation. newlib-nano over allocates by 8 bytes.
99 // 4 bytes for this 32-bit chunk size and another 4 bytes to allow for 8 byte-alignment of returned pointer.
100 uint32_t chunkSize
= *(uint32_t *)chunkCurr
;
101 // The start of the next chunk is right after the end of this one.
102 uint32_t chunkNext
= chunkCurr
+ chunkSize
;
104 // The free list is sorted by address.
105 // Check to see if we have found the next free chunk in the heap.
106 if (chunkCurr
== freeCurr
) {
107 // Chunk is free so flag it as such.
109 // The second 32-bit word in a free chunk is a pointer to the next free chunk (again sorted by address).
110 freeCurr
= *(uint32_t *)(freeCurr
+ 4);
113 // Skip past the 32-bit size field in the chunk header.
115 // 8-byte align the data pointer.
116 chunkCurr
= (chunkCurr
+ 7) & ~7;
117 // newlib-nano over allocates by 8 bytes, 4 bytes for the 32-bit chunk size and another 4 bytes to allow for 8
118 // byte-alignment of the returned pointer.
121 stream
->printf(" Chunk: %lu Address: 0x%08lX Size: %lu %s\n", chunkNumber
, chunkCurr
, chunkSize
, isChunkFree
? "CHUNK FREE" : "");
123 if (isChunkFree
) freeSize
+= chunkSize
;
124 else usedSize
+= chunkSize
;
126 chunkCurr
= chunkNext
;
129 stream
->printf("Allocated: %lu, Free: %lu\r\n", usedSize
, freeSize
);
134 void SimpleShell::on_module_loaded()
136 this->register_for_event(ON_CONSOLE_LINE_RECEIVED
);
137 this->register_for_event(ON_GCODE_RECEIVED
);
138 this->register_for_event(ON_SECOND_TICK
);
140 reset_delay_secs
= 0;
143 void SimpleShell::on_second_tick(void *)
145 // we are timing out for the reset
146 if (reset_delay_secs
> 0) {
147 if (--reset_delay_secs
== 0) {
153 void SimpleShell::on_gcode_received(void *argument
)
155 Gcode
*gcode
= static_cast<Gcode
*>(argument
);
156 string args
= get_arguments(gcode
->get_command());
159 if (gcode
->m
== 20) { // list sd card
160 gcode
->mark_as_taken();
161 gcode
->stream
->printf("Begin file list\r\n");
162 ls_command("/sd", gcode
->stream
);
163 gcode
->stream
->printf("End file list\r\n");
165 } else if (gcode
->m
== 30) { // remove file
166 gcode
->mark_as_taken();
167 rm_command("/sd/" + args
, gcode
->stream
);
169 } else if(gcode
->m
== 501) { // load config override
170 gcode
->mark_as_taken();
172 load_command("/sd/config-override", gcode
->stream
);
174 load_command("/sd/config-override." + args
, gcode
->stream
);
177 } else if(gcode
->m
== 504) { // save to specific config override file
178 gcode
->mark_as_taken();
180 save_command("/sd/config-override", gcode
->stream
);
182 save_command("/sd/config-override." + args
, gcode
->stream
);
188 bool SimpleShell::parse_command(const char *cmd
, string args
, StreamOutput
*stream
)
190 for (const ptentry_t
*p
= commands_table
; p
->command
!= NULL
; ++p
) {
191 if (strncasecmp(cmd
, p
->command
, strlen(p
->command
)) == 0) {
192 p
->func(args
, stream
);
200 // When a new line is received, check if it is a command, and if it is, act upon it
201 void SimpleShell::on_console_line_received( void *argument
)
203 SerialMessage new_message
= *static_cast<SerialMessage
*>(argument
);
205 // ignore comments and blank lines and if this is a G code then also ignore it
206 char first_char
= new_message
.message
[0];
207 if(strchr(";( \n\rGMTN", first_char
) != NULL
) return;
209 string possible_command
= new_message
.message
;
211 //new_message.stream->printf("Received %s\r\n", possible_command.c_str());
212 string cmd
= shift_parameter(possible_command
);
214 // find command and execute it
215 parse_command(cmd
.c_str(), possible_command
, new_message
.stream
);
218 // Act upon an ls command
219 // Convert the first parameter into an absolute path, then list the files in that path
220 void SimpleShell::ls_command( string parameters
, StreamOutput
*stream
)
223 while(!parameters
.empty()) {
224 string s
= shift_parameter( parameters
);
225 if(s
.front() == '-') {
229 if(!parameters
.empty()) {
231 path
.append(parameters
);
237 path
= absolute_from_relative(path
);
241 d
= opendir(path
.c_str());
243 while ((p
= readdir(d
)) != NULL
) {
244 stream
->printf("%s", lc(string(p
->d_name
)).c_str());
247 } else if(opts
.find("-s", 0, 2) != string::npos
) {
248 stream
->printf(" %d", p
->d_fsize
);
250 stream
->printf("\r\n");
254 stream
->printf("Could not open directory %s\r\n", path
.c_str());
258 extern SDFAT mounter
;
260 void SimpleShell::remount_command( string parameters
, StreamOutput
*stream
)
263 stream
->printf("remounted\r\n");
267 void SimpleShell::rm_command( string parameters
, StreamOutput
*stream
)
269 const char *fn
= absolute_from_relative(shift_parameter( parameters
)).c_str();
271 if (s
!= 0) stream
->printf("Could not delete %s \r\n", fn
);
275 void SimpleShell::mv_command( string parameters
, StreamOutput
*stream
)
277 string from
= absolute_from_relative(shift_parameter( parameters
));
278 string to
= shift_parameter(parameters
);
279 int s
= rename(from
.c_str(), to
.c_str());
280 if (s
!= 0) stream
->printf("Could not rename %s to %s\r\n", from
.c_str(), to
.c_str());
281 else stream
->printf("renamed %s to %s\r\n", from
.c_str(), to
.c_str());
284 // Change current absolute path to provided path
285 void SimpleShell::cd_command( string parameters
, StreamOutput
*stream
)
287 string folder
= absolute_from_relative( parameters
);
290 d
= opendir(folder
.c_str());
292 stream
->printf("Could not open directory %s \r\n", folder
.c_str() );
294 THEKERNEL
->current_path
= folder
;
299 // Responds with the present working directory
300 void SimpleShell::pwd_command( string parameters
, StreamOutput
*stream
)
302 stream
->printf("%s\r\n", THEKERNEL
->current_path
.c_str());
305 // Output the contents of a file, first parameter is the filename, second is the limit ( in number of lines to output )
306 void SimpleShell::cat_command( string parameters
, StreamOutput
*stream
)
308 // Get parameters ( filename and line limit )
309 string filename
= absolute_from_relative(shift_parameter( parameters
));
310 string limit_paramater
= shift_parameter( parameters
);
312 if ( limit_paramater
!= "" ) {
314 limit
= strtol(limit_paramater
.c_str(), &e
, 10);
315 if (e
<= limit_paramater
.c_str())
320 FILE *lp
= fopen(filename
.c_str(), "r");
322 stream
->printf("File not found: %s\r\n", filename
.c_str());
329 // Print each line of the file
330 while ((c
= fgetc (lp
)) != EOF
) {
331 buffer
.append((char *)&c
, 1);
332 if ( char(c
) == '\n' || ++linecnt
> 80) {
334 stream
->puts(buffer
.c_str());
336 if(linecnt
> 80) linecnt
= 0;
338 if ( newlines
== limit
) {
345 void SimpleShell::upload_command( string parameters
, StreamOutput
*stream
)
347 // this needs to be a hack. it needs to read direct from serial and not allow on_main_loop run until done
348 // NOTE this will block all operation until the upload is complete, so do not do while printing
349 if(!THEKERNEL
->conveyor
->is_queue_empty()) {
350 stream
->printf("upload not allowed while printing or busy\n");
354 // open file to upload to
355 string upload_filename
= absolute_from_relative( parameters
);
356 FILE *fd
= fopen(upload_filename
.c_str(), "w");
358 stream
->printf("uploading to file: %s, send control-D or control-Z to finish\r\n", upload_filename
.c_str());
360 stream
->printf("failed to open file: %s.\r\n", upload_filename
.c_str());
365 bool uploading
= true;
367 if(!stream
->ready()) {
368 // we need to kick things or they die
369 THEKERNEL
->call_event(ON_IDLE
);
373 char c
= stream
->_getc();
374 if( c
== 4 || c
== 26) { // ctrl-D or ctrl-Z
378 stream
->printf("uploaded %d bytes\n", cnt
);
382 // write character to file
384 if(fputc(c
, fd
) != c
) {
385 // error writing to file
386 stream
->printf("error writing to file. ignoring all characters until EOF\r\n");
392 if ((cnt
%400) == 0) {
393 // HACK ALERT to get around fwrite corruption close and re open for append
395 fd
= fopen(upload_filename
.c_str(), "a");
400 // we got an error so ignore everything until EOF
403 if(stream
->ready()) {
406 THEKERNEL
->call_event(ON_IDLE
);
409 } while(c
!= 4 && c
!= 26);
412 // loads the specified config-override file
413 void SimpleShell::load_command( string parameters
, StreamOutput
*stream
)
415 // Get parameters ( filename )
416 string filename
= absolute_from_relative(parameters
);
417 if(filename
== "/") {
418 filename
= THEKERNEL
->config_override_filename();
421 FILE *fp
= fopen(filename
.c_str(), "r");
424 stream
->printf("Loading config override file: %s...\n", filename
.c_str());
425 while(fgets(buf
, sizeof buf
, fp
) != NULL
) {
426 stream
->printf(" %s", buf
);
427 if(buf
[0] == ';') continue; // skip the comments
428 struct SerialMessage message
= {&(StreamOutput::NullStream
), buf
};
429 THEKERNEL
->call_event(ON_CONSOLE_LINE_RECEIVED
, &message
);
431 stream
->printf("config override file executed\n");
435 stream
->printf("File not found: %s\n", filename
.c_str());
439 // saves the specified config-override file
440 void SimpleShell::save_command( string parameters
, StreamOutput
*stream
)
442 // Get parameters ( filename )
443 string filename
= absolute_from_relative(parameters
);
444 if(filename
== "/") {
445 filename
= THEKERNEL
->config_override_filename();
448 //remove(filename.c_str()); // seems to cause a hang every now and then
450 FileStream
fs(filename
.c_str());
451 fs
.printf("; DO NOT EDIT THIS FILE\n");
452 // this also will truncate the existing file instead of deleting it
455 // replace stream with one that writes to config-override file
456 AppendFileStream
*gs
= new AppendFileStream(filename
.c_str());
457 // if(!gs->is_open()) {
458 // stream->printf("Unable to open File %s for write\n", filename.c_str());
462 // issue a M500 which will store values in the file stream
463 Gcode
*gcode
= new Gcode("M500", gs
);
464 THEKERNEL
->call_event(ON_GCODE_RECEIVED
, gcode
);
468 stream
->printf("Settings Stored to %s\r\n", filename
.c_str());
472 void SimpleShell::mem_command( string parameters
, StreamOutput
*stream
)
474 bool verbose
= shift_parameter( parameters
).find_first_of("Vv") != string::npos
;
475 unsigned long heap
= (unsigned long)_sbrk(0);
476 unsigned long m
= g_maximumHeapAddress
- heap
;
477 stream
->printf("Unused Heap: %lu bytes\r\n", m
);
479 uint32_t f
= heapWalk(stream
, verbose
);
480 stream
->printf("Total Free RAM: %lu bytes\r\n", m
+ f
);
482 stream
->printf("Free AHB0: %lu, AHB1: %lu\r\n", AHB0
.free(), AHB1
.free());
489 static uint32_t getDeviceType()
491 #define IAP_LOCATION 0x1FFF1FF1
494 typedef void (*IAP
)(uint32_t *, uint32_t *);
495 IAP iap
= (IAP
) IAP_LOCATION
;
500 iap(command
, result
);
507 // get network config
508 void SimpleShell::net_command( string parameters
, StreamOutput
*stream
)
511 bool ok
= PublicData::get_value( network_checksum
, get_ipconfig_checksum
, &returned_data
);
513 char *str
= (char *)returned_data
;
514 stream
->printf("%s\r\n", str
);
518 stream
->printf("No network detected\n");
522 // print out build version
523 void SimpleShell::version_command( string parameters
, StreamOutput
*stream
)
526 uint32_t dev
= getDeviceType();
527 const char *mcu
= (dev
& 0x00100000) ? "LPC1769" : "LPC1768";
528 stream
->printf("Build version: %s, Build date: %s, MCU: %s, System Clock: %ldMHz\r\n", vers
.get_build(), vers
.get_build_date(), mcu
, SystemCoreClock
/ 1000000);
532 void SimpleShell::reset_command( string parameters
, StreamOutput
*stream
)
534 stream
->printf("Smoothie out. Peace. Rebooting in 5 seconds...\r\n");
535 reset_delay_secs
= 5; // reboot in 5 seconds
538 // go into dfu boot mode
539 void SimpleShell::dfu_command( string parameters
, StreamOutput
*stream
)
541 stream
->printf("Entering boot mode...\r\n");
545 // Break out into the MRI debugging system
546 void SimpleShell::break_command( string parameters
, StreamOutput
*stream
)
548 stream
->printf("Entering MRI debug mode...\r\n");
552 // used to test out the get public data events
553 void SimpleShell::get_command( string parameters
, StreamOutput
*stream
)
555 string what
= shift_parameter( parameters
);
558 if (what
== "temp") {
559 string type
= shift_parameter( parameters
);
560 bool ok
= PublicData::get_value( temperature_control_checksum
, get_checksum(type
), current_temperature_checksum
, &returned_data
);
563 struct pad_temperature temp
= *static_cast<struct pad_temperature
*>(returned_data
);
564 stream
->printf("%s temp: %f/%f @%d\r\n", type
.c_str(), temp
.current_temperature
, temp
.target_temperature
, temp
.pwm
);
566 stream
->printf("%s is not a known temperature device\r\n", type
.c_str());
569 } else if (what
== "pos") {
570 bool ok
= PublicData::get_value( robot_checksum
, current_position_checksum
, &returned_data
);
573 float *pos
= static_cast<float *>(returned_data
);
574 stream
->printf("Position X: %f, Y: %f, Z: %f\r\n", pos
[0], pos
[1], pos
[2]);
577 stream
->printf("get pos command failed\r\n");
582 // used to test out the get public data events
583 void SimpleShell::set_temp_command( string parameters
, StreamOutput
*stream
)
585 string type
= shift_parameter( parameters
);
586 string temp
= shift_parameter( parameters
);
587 float t
= temp
.empty() ? 0.0 : strtof(temp
.c_str(), NULL
);
588 bool ok
= PublicData::set_value( temperature_control_checksum
, get_checksum(type
), &t
);
591 stream
->printf("%s temp set to: %3.1f\r\n", type
.c_str(), t
);
593 stream
->printf("%s is not a known temperature device\r\n", type
.c_str());
597 // used to test out the get public data events for switch
598 void SimpleShell::switch_command( string parameters
, StreamOutput
*stream
)
600 string type
= shift_parameter( parameters
);
601 string value
= shift_parameter( parameters
);
603 if(value
== "on" || value
== "off") {
604 bool b
= value
== "on";
605 ok
= PublicData::set_value( switch_checksum
, get_checksum(type
), state_checksum
, &b
);
607 float v
= strtof(value
.c_str(), NULL
);
608 ok
= PublicData::set_value( switch_checksum
, get_checksum(type
), value_checksum
, &v
);
611 stream
->printf("switch %s set to: %s\r\n", type
.c_str(), value
.c_str());
613 stream
->printf("%s is not a known switch device\r\n", type
.c_str());
617 void SimpleShell::help_command( string parameters
, StreamOutput
*stream
)
619 stream
->printf("Commands:\r\n");
620 stream
->printf("version\r\n");
621 stream
->printf("mem [-v]\r\n");
622 stream
->printf("ls [-s] [folder]\r\n");
623 stream
->printf("cd folder\r\n");
624 stream
->printf("pwd\r\n");
625 stream
->printf("cat file [limit]\r\n");
626 stream
->printf("rm file\r\n");
627 stream
->printf("mv file newfile\r\n");
628 stream
->printf("remount\r\n");
629 stream
->printf("play file [-v]\r\n");
630 stream
->printf("progress - shows progress of current play\r\n");
631 stream
->printf("abort - abort currently playing file\r\n");
632 stream
->printf("reset - reset smoothie\r\n");
633 stream
->printf("dfu - enter dfu boot loader\r\n");
634 stream
->printf("break - break into debugger\r\n");
635 stream
->printf("config-get [<configuration_source>] <configuration_setting>\r\n");
636 stream
->printf("config-set [<configuration_source>] <configuration_setting> <value>\r\n");
637 stream
->printf("get temp [bed|hotend]\r\n");
638 stream
->printf("set_temp bed|hotend 185\r\n");
639 stream
->printf("get pos\r\n");
640 stream
->printf("net\r\n");
641 stream
->printf("load [file] - loads a configuration override file from soecified name or config-override\r\n");
642 stream
->printf("save [file] - saves a configuration override file as specified filename or as config-override\r\n");