RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

2009-02-19 Joel Sherrill <joel.sherrill@oarcorp.com>

Browse Source 
* shell/rtems.t: Add halt command.
This commit is contained in:
Joel Sherrill
2009-02-19 19:20:51 +00:00
parent 4e54befe7b
commit 0a90bf269b
2 changed files with 77 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/ChangeLog
View File

@@ -1,3 +1,7 @@
2009-02-19 Joel Sherrill <joel.sherrill@oarcorp.com>
* shell/rtems.t: Add halt command.
2009-02-12 Joel Sherrill <joel.sherrill@oarcorp.com> 2009-02-12 Joel Sherrill <joel.sherrill@oarcorp.com>
* porting/idlethread.t: Change prototype of IDLE thread to consistently * porting/idlethread.t: Change prototype of IDLE thread to consistently

73
doc/shell/rtems.t
View File

@@ -14,6 +14,7 @@ The RTEMS shell has the following rtems commands:
@itemize @bullet @itemize @bullet
@item @code{halt} - Shutdown the system
@item @code{cpuuse} - print or reset per thread cpu usage @item @code{cpuuse} - print or reset per thread cpu usage
@item @code{stackuse} - print per thread stack usage @item @code{stackuse} - print per thread stack usage
@item @code{perioduse} - print or reset per period usage @item @code{perioduse} - print or reset per period usage
@@ -39,6 +40,78 @@ This section details the RTEMS Specific Commands available. A
subsection is dedicated to each of the commands and subsection is dedicated to each of the commands and
describes the behavior and configuration of that describes the behavior and configuration of that
command as well as providing an example usage. command as well as providing an example usage.
@c
@c
@c
@page
@subsection halt - Shutdown the system
@pgindex halt
@subheading SYNOPSYS:
@example
halt
@end example
@subheading DESCRIPTION:
This command is used to shutdown the RTEMS application.
@subheading EXIT STATUS:
This command does not return.
@subheading NOTES:
@subheading EXAMPLES:
The following is an example of how to use @code{halt}:
@example
SHLL [/] $ halt
@end example
The user will not see another prompt and the system will
shutdown.
@subheading CONFIGURATION:
@findex CONFIGURE_SHELL_NO_COMMAND_HALT
@findex CONFIGURE_SHELL_COMMAND_HALT
This command is included in the default shell command set.
When building a custom command set, define
@code{CONFIGURE_SHELL_COMMAND_HALT} to have this
command included.
This command can be excluded from the shell command set by
defining @code{CONFIGURE_SHELL_NO_COMMAND_HALT} when all
shell commands have been configured.
@subheading PROGRAMMING INFORMATION:
@findex rtems_shell_rtems_main_halt
The @code{halt} is implemented by a C language function
which has the following prototype:
@example
int rtems_shell_rtems_main_halt(
int argc,
char **argv
);
@end example
The configuration structure for the @code{halt} has the
following prototype:
@example
extern rtems_shell_cmd_t rtems_shell_HALT_Command;
@end example
@c @c
@c @c
@c @c