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 "libs/Kernel.h"
10 #include "SimpleShell.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"
21 #include "modules/tools/temperaturecontrol/TemperatureControlPublicAccess.h"
22 #include "modules/robot/RobotPublicAccess.h"
24 //extern "C" caddr_t _sbrk(int incr);
25 extern unsigned int g_maximumHeapAddress
;
32 extern "C" uint32_t __end__
;
33 extern "C" uint32_t __malloc_free_list
;
34 extern "C" uint32_t _sbrk(int size
);
37 // Adam Greens heap walk from http://mbed.org/forum/mbed/topic/2701/?page=4#comment-22556
38 static void heapWalk(StreamOutput
* stream
, bool verbose
)
40 uint32_t chunkNumber
= 1;
41 // The __end__ linker symbol points to the beginning of the heap.
42 uint32_t chunkCurr
= (uint32_t)&__end__
;
43 // __malloc_free_list is the head pointer to newlib-nano's link list of free chunks.
44 uint32_t freeCurr
= __malloc_free_list
;
45 // Calling _sbrk() with 0 reserves no more memory but it returns the current top of heap.
46 uint32_t heapEnd
= _sbrk(0);
51 stream
->printf("Used Heap Size: %lu\n", heapEnd
- chunkCurr
);
53 // Walk through the chunks until we hit the end of the heap.
54 while (chunkCurr
< heapEnd
)
56 // Assume the chunk is in use. Will update later.
58 // The first 32-bit word in a chunk is the size of the allocation. newlib-nano over allocates by 8 bytes.
59 // 4 bytes for this 32-bit chunk size and another 4 bytes to allow for 8 byte-alignment of returned pointer.
60 uint32_t chunkSize
= *(uint32_t*)chunkCurr
;
61 // The start of the next chunk is right after the end of this one.
62 uint32_t chunkNext
= chunkCurr
+ chunkSize
;
64 // The free list is sorted by address.
65 // Check to see if we have found the next free chunk in the heap.
66 if (chunkCurr
== freeCurr
)
68 // Chunk is free so flag it as such.
70 // The second 32-bit word in a free chunk is a pointer to the next free chunk (again sorted by address).
71 freeCurr
= *(uint32_t*)(freeCurr
+ 4);
74 // Skip past the 32-bit size field in the chunk header.
76 // 8-byte align the data pointer.
77 chunkCurr
= (chunkCurr
+ 7) & ~7;
78 // newlib-nano over allocates by 8 bytes, 4 bytes for the 32-bit chunk size and another 4 bytes to allow for 8
79 // byte-alignment of the returned pointer.
82 stream
->printf(" Chunk: %lu Address: 0x%08lX Size: %lu %s\n", chunkNumber
, chunkCurr
, chunkSize
, isChunkFree
? "CHUNK FREE" : "");
84 if(isChunkFree
) freeSize
+= chunkSize
;
85 else usedSize
+= chunkSize
;
87 chunkCurr
= chunkNext
;
90 stream
->printf("Allocated: %lu, Free: %lu\r\n", usedSize
, freeSize
);
94 void SimpleShell::on_module_loaded(){
95 this->current_path
= "/";
96 this->register_for_event(ON_CONSOLE_LINE_RECEIVED
);
97 this->reset_delay_secs
= 0;
99 this->register_for_event(ON_SECOND_TICK
);
100 this->register_for_event(ON_GCODE_RECEIVED
);
103 void SimpleShell::on_second_tick(void*) {
104 // we are timing out for the reset
105 if (this->reset_delay_secs
> 0) {
106 if(--this->reset_delay_secs
== 0){
112 void SimpleShell::on_gcode_received(void *argument
) {
113 Gcode
*gcode
= static_cast<Gcode
*>(argument
);
116 if (gcode
->m
== 20) { // list sd card
117 gcode
->mark_as_taken();
118 gcode
->stream
->printf("Begin file list\r\n");
119 ls_command("/sd", gcode
->stream
);
120 gcode
->stream
->printf("End file list\r\n");
125 // When a new line is received, check if it is a command, and if it is, act upon it
126 void SimpleShell::on_console_line_received( void* argument
){
127 SerialMessage new_message
= *static_cast<SerialMessage
*>(argument
);
128 string possible_command
= new_message
.message
;
130 //new_message.stream->printf("Received %s\r\n", possible_command.c_str());
132 // We don't compare to a string but to a checksum of that string, this saves some space in flash memory
133 unsigned short check_sum
= get_checksum( possible_command
.substr(0,possible_command
.find_first_of(" \r\n")) ); // todo: put this method somewhere more convenient
135 // Act depending on command
136 if (check_sum
== ls_command_checksum
)
137 this->ls_command( get_arguments(possible_command
), new_message
.stream
);
138 else if (check_sum
== cd_command_checksum
)
139 this->cd_command( get_arguments(possible_command
), new_message
.stream
);
140 else if (check_sum
== pwd_command_checksum
)
141 this->pwd_command( get_arguments(possible_command
), new_message
.stream
);
142 else if (check_sum
== cat_command_checksum
)
143 this->cat_command( get_arguments(possible_command
), new_message
.stream
);
144 else if (check_sum
== break_command_checksum
)
145 this->break_command(get_arguments(possible_command
),new_message
.stream
);
146 else if (check_sum
== reset_command_checksum
)
147 this->reset_command(get_arguments(possible_command
),new_message
.stream
);
148 else if (check_sum
== dfu_command_checksum
)
149 this->dfu_command(get_arguments(possible_command
),new_message
.stream
);
150 else if (check_sum
== help_command_checksum
)
151 this->help_command(get_arguments(possible_command
),new_message
.stream
);
152 else if (check_sum
== version_command_checksum
)
153 this->version_command(get_arguments(possible_command
),new_message
.stream
);
154 else if (check_sum
== get_command_checksum
)
155 this->get_command(get_arguments(possible_command
),new_message
.stream
);
156 else if (check_sum
== set_temp_command_checksum
)
157 this->set_temp_command(get_arguments(possible_command
),new_message
.stream
);
158 else if (check_sum
== mem_command_checksum
)
159 this->mem_command(get_arguments(possible_command
),new_message
.stream
);
163 // Convert a path indication ( absolute or relative ) into a path ( absolute )
164 string
SimpleShell::absolute_from_relative( string path
){
165 if( path
[0] == '/' ){ return path
; }
166 if( path
[0] == '.' ){ return this->current_path
; }
167 return this->current_path
+ path
;
170 // Act upon an ls command
171 // Convert the first parameter into an absolute path, then list the files in that path
172 void SimpleShell::ls_command( string parameters
, StreamOutput
* stream
){
173 string folder
= this->absolute_from_relative( parameters
);
176 d
= opendir(folder
.c_str());
178 while((p
= readdir(d
)) != NULL
) { stream
->printf("%s\r\n", lc(string(p
->d_name
)).c_str()); }
181 stream
->printf("Could not open directory %s \r\n", folder
.c_str());
185 // Change current absolute path to provided path
186 void SimpleShell::cd_command( string parameters
, StreamOutput
* stream
){
187 string folder
= this->absolute_from_relative( parameters
);
188 if( folder
[folder
.length()-1] != '/' ){ folder
+= "/"; }
190 d
= opendir(folder
.c_str());
192 stream
->printf("Could not open directory %s \r\n", folder
.c_str() );
194 this->current_path
= folder
;
199 // Responds with the present working directory
200 void SimpleShell::pwd_command( string parameters
, StreamOutput
* stream
){
201 stream
->printf("%s\r\n", this->current_path
.c_str());
204 // Output the contents of a file, first parameter is the filename, second is the limit ( in number of lines to output )
205 void SimpleShell::cat_command( string parameters
, StreamOutput
* stream
){
207 // Get parameters ( filename and line limit )
208 string filename
= this->absolute_from_relative(shift_parameter( parameters
));
209 string limit_paramater
= shift_parameter( parameters
);
211 if( limit_paramater
!= "" )
214 limit
= strtol(limit_paramater
.c_str(), &e
, 10);
215 if (e
<= limit_paramater
.c_str())
220 FILE *lp
= fopen(filename
.c_str(), "r");
222 stream
->printf("File not found: %s\r\n", filename
.c_str());
229 // Print each line of the file
230 while ((c
= fgetc (lp
)) != EOF
){
231 buffer
.append((char *)&c
, 1);
232 if( char(c
) == '\n' ){
234 stream
->puts(buffer
.c_str());
237 if( newlines
== limit
){ break; }
244 void SimpleShell::mem_command( string parameters
, StreamOutput
* stream
){
245 bool verbose
= shift_parameter( parameters
).find_first_of("Vv") != string::npos
;
246 unsigned long heap
= (unsigned long)_sbrk(0);
247 unsigned long m
= g_maximumHeapAddress
- heap
;
248 stream
->printf("Unused Heap: %lu bytes\r\n", m
);
250 heapWalk(stream
, verbose
);
253 // print out build version
254 void SimpleShell::version_command( string parameters
, StreamOutput
* stream
){
256 stream
->printf("Build version: %s, Build date: %s, System Clock: %ldMHz\r\n", vers
.get_build(), vers
.get_build_date(), SystemCoreClock
/ 1000000);
260 void SimpleShell::reset_command( string parameters
, StreamOutput
* stream
){
261 stream
->printf("Smoothie out. Peace. Rebooting in 5 seconds...\r\n");
262 this->reset_delay_secs
= 5; // reboot in 5 seconds
265 // go into dfu boot mode
266 void SimpleShell::dfu_command( string parameters
, StreamOutput
* stream
){
267 stream
->printf("Entering boot mode...\r\n");
271 // Break out into the MRI debugging system
272 void SimpleShell::break_command( string parameters
, StreamOutput
* stream
){
273 stream
->printf("Entering MRI debug mode...\r\n");
277 // used to test out the get public data events
278 void SimpleShell::get_command( string parameters
, StreamOutput
* stream
){
279 int what
= get_checksum(shift_parameter( parameters
));
282 if(what
== get_temp_command_checksum
) {
283 string type
= shift_parameter( parameters
);
284 bool ok
= this->kernel
->public_data
->get_value( temperature_control_checksum
, get_checksum(type
), current_temperature_checksum
, &returned_data
);
287 struct pad_temperature temp
= *static_cast<struct pad_temperature
*>(returned_data
);
288 stream
->printf("%s temp: %f/%f @%d\r\n", type
.c_str(), temp
.current_temperature
, temp
.target_temperature
, temp
.pwm
);
290 stream
->printf("%s is not a known temperature device\r\n", type
.c_str());
293 }else if(what
== get_pos_command_checksum
) {
294 bool ok
= this->kernel
->public_data
->get_value( robot_checksum
, current_position_checksum
, &returned_data
);
297 double *pos
= static_cast<double *>(returned_data
);
298 stream
->printf("Position X: %f, Y: %f, Z: %f\r\n", pos
[0], pos
[1], pos
[2]);
301 stream
->printf("get pos command failed\r\n");
306 // used to test out the get public data events
307 void SimpleShell::set_temp_command( string parameters
, StreamOutput
* stream
){
308 string type
= shift_parameter( parameters
);
309 string temp
= shift_parameter( parameters
);
310 double t
= temp
.empty() ? 0.0 : strtod(temp
.c_str(), NULL
);
311 bool ok
= this->kernel
->public_data
->set_value( temperature_control_checksum
, get_checksum(type
), &t
);
314 stream
->printf("%s temp set to: %3.1f\r\n", type
.c_str(), t
);
316 stream
->printf("%s is not a known temperature device\r\n", type
.c_str());
320 void SimpleShell::help_command( string parameters
, StreamOutput
* stream
){
321 stream
->printf("Commands:\r\n");
322 stream
->printf("version\r\n");
323 stream
->printf("mem [-v]\r\n");
324 stream
->printf("ls [folder]\r\n");
325 stream
->printf("cd folder\r\n");
326 stream
->printf("pwd\r\n");
327 stream
->printf("cat file [limit]\r\n");
328 stream
->printf("play file [-q]\r\n");
329 stream
->printf("progress - shows progress of current play\r\n");
330 stream
->printf("abort - abort currently playing file\r\n");
331 stream
->printf("reset - reset smoothie\r\n");
332 stream
->printf("dfu - enter dfu boot loader\r\n");
333 stream
->printf("break - break into debugger\r\n");
334 stream
->printf("config-get [<configuration_source>] <configuration_setting>\r\n");
335 stream
->printf("config-set [<configuration_source>] <configuration_setting> <value>\r\n");
336 stream
->printf("config-load [<file_name>]\r\n");
337 stream
->printf("get temp [bed|hotend]\r\n");
338 stream
->printf("set_temp bed|hotend 185\r\n");
339 stream
->printf("get pos\r\n");