source: rtems/doc/shell/rtems.t @ bac3d6d

4.115
Last change on this file since bac3d6d was bac3d6d, checked in by Sebastian Huber <sebastian.huber@…>, on Nov 17, 2014 at 2:42:57 PM

shell: Rename HALT to SHUTDOWN command

Use a normal command for shutdown via exit().

  • Property mode set to 100644
File size: 32.6 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-2008.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5
6@chapter RTEMS Specific Commands
7
8@section Introduction
9
10The RTEMS shell has the following rtems commands:
11
12@itemize @bullet
13
14@item @code{shutdown} - Shutdown the system
15@item @code{cpuuse} - print or reset per thread cpu usage
16@item @code{stackuse} - print per thread stack usage
17@item @code{perioduse} - print or reset per period usage
18@item @code{wkspace} - Display information on Executive Workspace
19@item @code{config} - Show the system configuration.
20@item @code{itask} - List init tasks for the system
21@item @code{extension} - Display information about extensions
22@item @code{task} - Display information about tasks
23@item @code{queue} - Display information about message queues
24@item @code{sema} - display information about semaphores
25@item @code{region} - display information about regions
26@item @code{part} - display information about partitions
27@item @code{object} - Display information about RTEMS objects
28@item @code{driver} - Display the RTEMS device driver table
29@item @code{dname} - Displays information about named drivers
30@item @code{pthread} - Displays information about POSIX threads
31
32@end itemize
33
34@section Commands
35
36This section details the RTEMS Specific Commands available.  A
37subsection is dedicated to each of the commands and
38describes the behavior and configuration of that
39command as well as providing an example usage.
40
41@c
42@c
43@c
44@page
45@subsection shutdown - Shutdown the system
46
47@pgindex shutdown
48
49@subheading SYNOPSYS:
50
51@example
52shutdown
53@end example
54
55@subheading DESCRIPTION:
56
57This command is used to shutdown the RTEMS application.
58
59@subheading EXIT STATUS:
60
61This command does not return.
62
63@subheading NOTES:
64
65
66@subheading EXAMPLES:
67
68The following is an example of how to use @code{shutdown}:
69
70@example
71SHLL [/] $ shutdown
72System shutting down at user request
73@end example
74
75The user will not see another prompt and the system will
76shutdown.
77
78@subheading CONFIGURATION:
79
80@findex CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN
81@findex CONFIGURE_SHELL_COMMAND_SHUTDOWN
82
83This command is included in the default shell command set. 
84When building a custom command set, define
85@code{CONFIGURE_SHELL_COMMAND_SHUTDOWN} to have this
86command included.
87
88This command can be excluded from the shell command set by
89defining @code{CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN} when all
90shell commands have been configured.
91
92@subheading PROGRAMMING INFORMATION:
93
94The configuration structure for the @code{shutdown} has the
95following prototype:
96
97@example
98extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command;
99@end example
100
101@c
102@c
103@c
104@page
105@subsection cpuuse - print or reset per thread cpu usage
106
107@pgindex cpuuse
108
109@subheading SYNOPSYS:
110
111@example
112cpuuse [-r]
113@end example
114
115@subheading DESCRIPTION:
116
117This command may be used to print a report on the per thread
118cpu usage or to reset the per thread CPU usage statistics. When
119invoked with the @code{-r} option, the CPU usage statistics
120are reset.
121
122@subheading EXIT STATUS:
123
124This command returns 0 on success and non-zero if an error is encountered.
125
126@subheading NOTES:
127
128The granularity of the timing information reported is dependent
129upon the BSP and the manner in which RTEMS was built.  In the
130default RTEMS configuration, if the BSP supports nanosecond
131granularity timestamps, then the information reported will be
132highly accurate. Otherwise, the accuracy of the information
133reported is limited by the clock tick quantum.
134
135@subheading EXAMPLES:
136
137The following is an example of how to use @code{cpuuse}:
138
139@example
140SHLL [/] $ cpuuse
141CPU Usage by thread
142   ID            NAME         SECONDS   PERCENT
1430x09010001   IDLE            49.745393   98.953
1440x0a010001   UI1              0.000000    0.000
1450x0a010002   SHLL             0.525928    1.046
146Time since last CPU Usage reset 50.271321 seconds
147SHLL [/] $ cpuuse -r
148Resetting CPU Usage information
149SHLL [/] $ cpuuse
150CPU Usage by thread
151   ID            NAME         SECONDS   PERCENT
1520x09010001   IDLE             0.000000    0.000
1530x0a010001   UI1              0.000000    0.000
1540x0a010002   SHLL             0.003092  100.000
155Time since last CPU Usage reset 0.003092 seconds
156@end example
157
158In the above example, the system had set idle for nearly
159a minute when the first report was generated.  The
160@code{cpuuse -r} and @code{cpuuse} commands were pasted
161from another window so were executed with no gap between.
162In the second report, only the @code{shell} thread has
163run since the CPU Usage was reset.  It has consumed
164approximately 3.092 milliseconds of CPU time processing
165the two commands and generating the output.
166
167@subheading CONFIGURATION:
168
169@findex CONFIGURE_SHELL_NO_COMMAND_CPUUSE
170@findex CONFIGURE_SHELL_COMMAND_CPUUSE
171
172This command is included in the default shell command set. 
173When building a custom command set, define
174@code{CONFIGURE_SHELL_COMMAND_CPUUSE} to have this
175command included.
176
177This command can be excluded from the shell command set by
178defining @code{CONFIGURE_SHELL_NO_COMMAND_CPUUSE} when all
179shell commands have been configured.
180
181@subheading PROGRAMMING INFORMATION:
182
183@findex rtems_shell_rtems_main_cpuuse
184
185The @code{cpuuse} is implemented by a C language function
186which has the following prototype:
187
188@example
189int rtems_shell_rtems_main_cpuuse(
190  int    argc,
191  char **argv
192);
193@end example
194
195The configuration structure for the @code{cpuuse} has the
196following prototype:
197
198@example
199extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
200@end example
201
202@c
203@c
204@c
205@page
206@subsection stackuse - print per thread stack usage
207
208@pgindex stackuse
209
210@subheading SYNOPSYS:
211
212@example
213stackuse
214@end example
215
216@subheading DESCRIPTION:
217
218This command prints a Stack Usage Report for all of the tasks
219and threads in the system.  On systems which support it, the
220usage of the interrupt stack is also included in the report.
221
222@subheading EXIT STATUS:
223
224This command always succeeds and returns 0.
225
226@subheading NOTES:
227
228The @code{CONFIGURE_STACK_CHECKER_ENABLED} @code{confdefs.h} constant
229must be defined when the application is configured for this
230command to have any information to report.
231
232@subheading EXAMPLES:
233
234The following is an example of how to use @code{stackuse}:
235
236@smallexample
237SHLL [/] $ stackuse
238Stack usage by thread
239    ID      NAME    LOW          HIGH     CURRENT     AVAILABLE     USED
2400x09010001  IDLE 0x023d89a0 - 0x023d99af 0x023d9760      4096        608
2410x0a010001  UI1  0x023d9f30 - 0x023daf3f 0x023dad18      4096       1804
2420x0a010002  SHLL 0x023db4c0 - 0x023df4cf 0x023de9d0     16384       5116
2430xffffffff  INTR 0x023d2760 - 0x023d375f 0x00000000      4080        316
244@end smallexample
245
246@subheading CONFIGURATION:
247
248@findex CONFIGURE_SHELL_NO_COMMAND_STACKUSE
249@findex CONFIGURE_SHELL_COMMAND_STACKUSE
250
251This command is included in the default shell command set. 
252When building a custom command set, define
253@code{CONFIGURE_SHELL_COMMAND_STACKUSE} to have this
254command included.
255
256This command can be excluded from the shell command set by
257defining @code{CONFIGURE_SHELL_NO_COMMAND_STACKUSE} when all
258shell commands have been configured.
259
260@subheading PROGRAMMING INFORMATION:
261
262@findex rtems_shell_rtems_main_stackuse
263
264The @code{stackuse} is implemented by a C language function
265which has the following prototype:
266
267@example
268int rtems_shell_rtems_main_stackuse(
269  int    argc,
270  char **argv
271);
272@end example
273
274The configuration structure for the @code{stackuse} has the
275following prototype:
276
277@example
278extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
279@end example
280
281@c
282@c
283@c
284@page
285@subsection perioduse - print or reset per period usage
286
287@pgindex perioduse
288
289@subheading SYNOPSYS:
290
291@example
292perioduse [-r]
293@end example
294
295@subheading DESCRIPTION:
296
297This command may be used to print a statistics report on the rate
298monotonic periods in the application or to reset the rate monotonic
299period usage statistics. When invoked with the @code{-r} option, the
300usage statistics are reset.
301
302@subheading EXIT STATUS:
303
304This command returns 0 on success and non-zero if an error is encountered.
305
306@subheading NOTES:
307
308The granularity of the timing information reported is dependent
309upon the BSP and the manner in which RTEMS was built.  In the
310default RTEMS configuration, if the BSP supports nanosecond
311granularity timestamps, then the information reported will be
312highly accurate. Otherwise, the accuracy of the information
313reported is limited by the clock tick quantum.
314
315@subheading EXAMPLES:
316
317The following is an example of how to use @code{perioduse}:
318
319@smallexample
320SHLL [/] $ perioduse   
321Period information by period
322--- CPU times are in seconds ---
323--- Wall times are in seconds ---
324   ID     OWNER COUNT MISSED          CPU TIME                  WALL TIME
325                                    MIN/MAX/AVG                MIN/MAX/AVG
3260x42010001 TA1    502      0 0:000039/0:042650/0:004158 0:000039/0:020118/0:002848
3270x42010002 TA2    502      0 0:000041/0:042657/0:004309 0:000041/0:020116/0:002848
3280x42010003 TA3    501      0 0:000041/0:041564/0:003653 0:000041/0:020003/0:002814
3290x42010004 TA4    501      0 0:000043/0:044075/0:004911 0:000043/0:020004/0:002814
3300x42010005 TA5     10      0 0:000065/0:005413/0:002739 0:000065/1:000457/0:041058
331
332                                    MIN/MAX/AVG                MIN/MAX/AVG
333SHLL [/] $ perioduse -r
334Resetting Period Usage information
335SHLL [/] $ perioduse
336--- CPU times are in seconds ---
337--- Wall times are in seconds ---
338   ID     OWNER COUNT MISSED          CPU TIME                  WALL TIME
339                                    MIN/MAX/AVG                MIN/MAX/AVG
3400x42010001 TA1      0      0
3410x42010002 TA2      0      0
3420x42010003 TA3      0      0
3430x42010004 TA4      0      0
3440x42010005 TA5      0      0
345@end smallexample
346
347@subheading CONFIGURATION:
348
349@findex CONFIGURE_SHELL_NO_COMMAND_PERIODUSE
350@findex CONFIGURE_SHELL_COMMAND_PERIODUSE
351
352This command is included in the default shell command set. 
353When building a custom command set, define
354@code{CONFIGURE_SHELL_COMMAND_PERIODUSE} to have this
355command included.
356
357This command can be excluded from the shell command set by
358defining @code{CONFIGURE_SHELL_NO_COMMAND_PERIODUSE} when all
359shell commands have been configured.
360
361@subheading PROGRAMMING INFORMATION:
362
363@findex rtems_shell_rtems_main_perioduse
364
365The @code{perioduse} is implemented by a C language function
366which has the following prototype:
367
368@example
369int rtems_shell_rtems_main_perioduse(
370  int    argc,
371  char **argv
372);
373@end example
374
375The configuration structure for the @code{perioduse} has the
376following prototype:
377
378@example
379extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
380@end example
381
382@c
383@c
384@c
385@page
386@subsection wkspace - display information on executive workspace
387
388@pgindex wkspace
389
390@subheading SYNOPSYS:
391
392@example
393wkspace
394@end example
395
396@subheading DESCRIPTION:
397
398This command prints information on the current state of
399the RTEMS Executive Workspace reported.  This includes the
400following information:
401
402@itemize @bullet
403@item Number of free blocks
404@item Largest free block
405@item Total bytes free
406@item Number of used blocks
407@item Largest used block
408@item Total bytes used
409@end itemize
410
411@subheading EXIT STATUS:
412
413This command always succeeds and returns 0.
414
415@subheading NOTES:
416
417NONE
418
419@subheading EXAMPLES:
420
421The following is an example of how to use @code{wkspace}:
422
423@example
424SHLL [/] $ wkspace
425Number of free blocks: 1
426Largest free block:    132336
427Total bytes free:      132336
428Number of used blocks: 36
429Largest used block:    16408
430Total bytes used:      55344
431@end example
432
433@subheading CONFIGURATION:
434
435@findex CONFIGURE_SHELL_NO_COMMAND_WKSPACE
436@findex CONFIGURE_SHELL_COMMAND_WKSPACE
437
438This command is included in the default shell command set. 
439When building a custom command set, define
440@code{CONFIGURE_SHELL_COMMAND_WKSPACE} to have this
441command included.
442
443This command can be excluded from the shell command set by
444defining @code{CONFIGURE_SHELL_NO_COMMAND_WKSPACE} when all
445shell commands have been configured.
446
447@subheading PROGRAMMING INFORMATION:
448
449@findex rtems_shell_rtems_main_wkspace
450
451The @code{wkspace} is implemented by a C language function
452which has the following prototype:
453
454@example
455int rtems_shell_rtems_main_wkspace(
456  int    argc,
457  char **argv
458);
459@end example
460
461The configuration structure for the @code{wkspace} has the
462following prototype:
463
464@example
465extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
466@end example
467
468@c
469@c
470@c
471@page
472@subsection config - show the system configuration.
473
474@pgindex config
475
476@subheading SYNOPSYS:
477
478@example
479config
480@end example
481
482@subheading DESCRIPTION:
483
484This command display information about the RTEMS Configuration.
485
486@subheading EXIT STATUS:
487
488This command always succeeds and returns 0.
489
490@subheading NOTES:
491
492At this time, it does not report every configuration parameter.
493This is an area in which user submissions or sponsorship of
494a developer would be appreciated.
495
496@subheading EXAMPLES:
497
498The following is an example of how to use @code{config}:
499
500@smallexample
501INITIAL (startup) Configuration Info
502------------------------------------------------------------------------------
503WORKSPACE      start: 0x23d22e0;  size: 0x2dd20
504TIME           usec/tick: 10000;  tick/timeslice: 50;  tick/sec: 100
505MAXIMUMS       tasks: 20;  timers: 0;  sems: 50;  que's: 20;  ext's: 1
506               partitions: 0;  regions: 0;  ports: 0;  periods: 0
507@end smallexample
508
509@subheading CONFIGURATION:
510
511@findex CONFIGURE_SHELL_NO_COMMAND_CONFIG
512@findex CONFIGURE_SHELL_COMMAND_CONFIG
513
514This command is included in the default shell command set. 
515When building a custom command set, define
516@code{CONFIGURE_SHELL_COMMAND_CONFIG} to have this
517command included.
518
519This command can be excluded from the shell command set by
520defining @code{CONFIGURE_SHELL_NO_COMMAND_CONFIG} when all
521shell commands have been configured.
522
523@subheading PROGRAMMING INFORMATION:
524
525@findex rtems_shell_rtems_main_config
526
527The @code{config} is implemented by a C language function
528which has the following prototype:
529
530@example
531int rtems_shell_rtems_main_config(
532  int    argc,
533  char **argv
534);
535@end example
536
537The configuration structure for the @code{config} has the
538following prototype:
539
540@example
541extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
542@end example
543
544@c
545@c
546@c
547@page
548@subsection itask - list init tasks for the system
549
550@pgindex itask
551
552@subheading SYNOPSYS:
553
554@example
555itask
556@end example
557
558@subheading DESCRIPTION:
559
560This command prints a report on the set of initialization
561tasks and threads in the system.
562
563@subheading EXIT STATUS:
564
565This command always succeeds and returns 0.
566
567@subheading NOTES:
568
569At this time, it includes only Classic API Initialization Tasks.
570This is an area in which user submissions or sponsorship of
571a developer would be appreciated.
572
573@subheading EXAMPLES:
574
575The following is an example of how to use @code{itask}:
576
577@smallexample
578SHLL [/] $ itask
579  #    NAME   ENTRY        ARGUMENT    PRIO   MODES  ATTRIBUTES   STACK SIZE
580------------------------------------------------------------------------------
581   0   UI1    [0x2002258] 0 [0x0]        1    nP      DEFAULT     4096 [0x1000]
582@end smallexample
583
584@subheading CONFIGURATION:
585
586@findex CONFIGURE_SHELL_NO_COMMAND_ITASK
587@findex CONFIGURE_SHELL_COMMAND_ITASK
588
589This command is included in the default shell command set. 
590When building a custom command set, define
591@code{CONFIGURE_SHELL_COMMAND_ITASK} to have this
592command included.
593
594This command can be excluded from the shell command set by
595defining @code{CONFIGURE_SHELL_NO_COMMAND_ITASK} when all
596shell commands have been configured.
597
598@subheading PROGRAMMING INFORMATION:
599
600@findex rtems_shell_rtems_main_itask
601
602The @code{itask} is implemented by a C language function
603which has the following prototype:
604
605@example
606int rtems_shell_rtems_main_itask(
607  int    argc,
608  char **argv
609);
610@end example
611
612The configuration structure for the @code{itask} has the
613following prototype:
614
615@example
616extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
617@end example
618
619@c
620@c
621@c
622@page
623@subsection extension - display information about extensions
624
625@pgindex extension
626
627@subheading SYNOPSYS:
628
629@example
630extension [id [id ...] ]
631@end example
632
633@subheading DESCRIPTION:
634
635When invoked with no arguments, this command prints information on
636the set of User Extensions currently active in the system.
637
638If invoked with a set of ids as arguments, then just
639those objects are included in the information printed.
640
641@subheading EXIT STATUS:
642
643This command returns 0 on success and non-zero if an error is encountered.
644
645@subheading NOTES:
646
647NONE
648
649@subheading EXAMPLES:
650
651The following is an example of using the @code{extension} command
652on a system with no user extensions.
653
654@smallexample
655SHLL [/] $ extension
656  ID       NAME
657------------------------------------------------------------------------------
658@end smallexample
659
660@subheading CONFIGURATION:
661
662@findex CONFIGURE_SHELL_NO_COMMAND_EXTENSION
663@findex CONFIGURE_SHELL_COMMAND_EXTENSION
664
665This command is included in the default shell command set. 
666When building a custom command set, define
667@code{CONFIGURE_SHELL_COMMAND_EXTENSION} to have this
668command included.
669
670This command can be excluded from the shell command set by
671defining @code{CONFIGURE_SHELL_NO_COMMAND_EXTENSION} when all
672shell commands have been configured.
673
674@subheading PROGRAMMING INFORMATION:
675
676@findex rtems_shell_rtems_main_extension
677
678The @code{extension} is implemented by a C language function
679which has the following prototype:
680
681@example
682int rtems_shell_rtems_main_extension(
683  int    argc,
684  char **argv
685);
686@end example
687
688The configuration structure for the @code{extension} has the
689following prototype:
690
691@example
692extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
693@end example
694
695@c
696@c
697@c
698@page
699@subsection task - display information about tasks
700
701@pgindex task
702
703@subheading SYNOPSYS:
704
705@example
706task [id [id ...] ]
707@end example
708
709@subheading DESCRIPTION:
710
711When invoked with no arguments, this command prints information on
712the set of Classic API Tasks currently active in the system.
713
714If invoked with a set of ids as arguments, then just
715those objects are included in the information printed.
716
717@subheading EXIT STATUS:
718
719This command returns 0 on success and non-zero if an error is encountered.
720
721@subheading NOTES:
722
723NONE
724
725@subheading EXAMPLES:
726
727The following is an example of how to use the @code{task} on an
728application with just two Classic API tasks:
729
730@smallexample
731SHLL [/] $ task
732  ID       NAME   PRIO   STAT   MODES  EVENTS   WAITID  WAITARG  NOTES
733------------------------------------------------------------------------------
7340a010001   UI1      1   SUSP   P:T:nA  NONE                     
7350a010002   SHLL   100   READY  P:T:nA  NONE                     
736@end smallexample
737
738@subheading CONFIGURATION:
739
740@findex CONFIGURE_SHELL_NO_COMMAND_TASK
741@findex CONFIGURE_SHELL_COMMAND_TASK
742
743This command is included in the default shell command set. 
744When building a custom command set, define
745@code{CONFIGURE_SHELL_COMMAND_TASK} to have this
746command included.
747
748This command can be excluded from the shell command set by
749defining @code{CONFIGURE_SHELL_NO_COMMAND_TASK} when all
750shell commands have been configured.
751
752@subheading PROGRAMMING INFORMATION:
753
754@findex rtems_shell_rtems_main_task
755
756The @code{task} is implemented by a C language function
757which has the following prototype:
758
759@example
760int rtems_shell_rtems_main_task(
761  int    argc,
762  char **argv
763);
764@end example
765
766The configuration structure for the @code{task} has the
767following prototype:
768
769@example
770extern rtems_shell_cmd_t rtems_shell_TASK_Command;
771@end example
772
773@c
774@c
775@c
776@page
777@subsection queue - display information about message queues
778
779@pgindex queue
780
781@subheading SYNOPSYS:
782
783@example
784queue [id [id ... ] ]
785@end example
786
787@subheading DESCRIPTION:
788
789When invoked with no arguments, this command prints information on
790the set of Classic API Message Queues currently active in the system.
791
792If invoked with a set of ids as arguments, then just
793those objects are included in the information printed.
794
795@subheading EXIT STATUS:
796
797This command returns 0 on success and non-zero if an error is encountered.
798
799@subheading NOTES:
800
801NONE
802
803@subheading EXAMPLES:
804
805The following is an example of using the @code{queue} command
806on a system with no Classic API Message Queues.
807
808@smallexample
809SHLL [/] $ queue
810  ID       NAME   ATTRIBUTES   PEND   MAXPEND  MAXSIZE
811------------------------------------------------------------------------------
812@end smallexample
813
814@subheading CONFIGURATION:
815
816@findex CONFIGURE_SHELL_NO_COMMAND_QUEUE
817@findex CONFIGURE_SHELL_COMMAND_QUEUE
818
819This command is included in the default shell command set. 
820When building a custom command set, define
821@code{CONFIGURE_SHELL_COMMAND_QUEUE} to have this
822command included.
823
824This command can be excluded from the shell command set by
825defining @code{CONFIGURE_SHELL_NO_COMMAND_QUEUE} when all
826shell commands have been configured.
827
828@subheading PROGRAMMING INFORMATION:
829
830@findex rtems_shell_rtems_main_queue
831
832The @code{queue} is implemented by a C language function
833which has the following prototype:
834
835@example
836int rtems_shell_rtems_main_queue(
837  int    argc,
838  char **argv
839);
840@end example
841
842The configuration structure for the @code{queue} has the
843following prototype:
844
845@example
846extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
847@end example
848
849@c
850@c
851@c
852@page
853@subsection sema - display information about semaphores
854
855@pgindex sema
856
857@subheading SYNOPSYS:
858
859@example
860sema [id [id ... ] ]
861@end example
862
863@subheading DESCRIPTION:
864
865When invoked with no arguments, this command prints information on
866the set of Classic API Semaphores currently active in the system.
867
868If invoked with a set of objects ids as arguments, then just
869those objects are included in the information printed.
870
871@subheading EXIT STATUS:
872
873This command returns 0 on success and non-zero if an error is encountered.
874
875@subheading NOTES:
876
877NONE
878
879@subheading EXAMPLES:
880
881The following is an example of how to use @code{sema}:
882
883@smallexample
884SHLL [/] $ sema
885  ID       NAME   ATTR        PRICEIL CURR_CNT HOLDID
886------------------------------------------------------------------------------
8871a010001   LBIO   PR:BI:IN      0        1     00000000
8881a010002   TRmi   PR:BI:IN      0        1     00000000
8891a010003   LBI00  PR:BI:IN      0        1     00000000
8901a010004   TRia   PR:BI:IN      0        1     00000000
8911a010005   TRoa   PR:BI:IN      0        1     00000000
8921a010006   TRxa   <assoc.c: BAD NAME>   0    0 09010001
8931a010007   LBI01  PR:BI:IN      0        1     00000000
8941a010008   LBI02  PR:BI:IN      0        1     00000000
895@end smallexample
896
897@subheading CONFIGURATION:
898
899@findex CONFIGURE_SHELL_NO_COMMAND_SEMA
900@findex CONFIGURE_SHELL_COMMAND_SEMA
901
902This command is included in the default shell command set. 
903When building a custom command set, define
904@code{CONFIGURE_SHELL_COMMAND_SEMA} to have this
905command included.
906
907This command can be excluded from the shell command set by
908defining @code{CONFIGURE_SHELL_NO_COMMAND_SEMA} when all
909shell commands have been configured.
910
911@subheading PROGRAMMING INFORMATION:
912
913@findex rtems_shell_rtems_main_sema
914
915The @code{sema} is implemented by a C language function
916which has the following prototype:
917
918@example
919int rtems_shell_rtems_main_sema(
920  int    argc,
921  char **argv
922);
923@end example
924
925The configuration structure for the @code{sema} has the
926following prototype:
927
928@example
929extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
930@end example
931
932@c
933@c
934@c
935@page
936@subsection region - display information about regions
937
938@pgindex region
939
940@subheading SYNOPSYS:
941
942@example
943region [id [id ... ] ]
944@end example
945
946@subheading DESCRIPTION:
947
948When invoked with no arguments, this command prints information on
949the set of Classic API Regions currently active in the system.
950
951If invoked with a set of object ids as arguments, then just
952those object are included in the information printed.
953
954@subheading EXIT STATUS:
955
956This command returns 0 on success and non-zero if an error is encountered.
957
958@subheading NOTES:
959
960NONE
961
962@subheading EXAMPLES:
963
964The following is an example of using the @code{region} command
965on a system with no user extensions.
966
967@smallexample
968SHLL [/] $ region
969  ID       NAME   ATTR        STARTADDR LENGTH    PAGE_SIZE USED_BLOCKS
970------------------------------------------------------------------------------
971@end smallexample
972
973@subheading CONFIGURATION:
974
975@findex CONFIGURE_SHELL_NO_COMMAND_REGION
976@findex CONFIGURE_SHELL_COMMAND_REGION
977
978This command is included in the default shell command set. 
979When building a custom command set, define
980@code{CONFIGURE_SHELL_COMMAND_REGION} to have this
981command included.
982
983This command can be excluded from the shell command set by
984defining @code{CONFIGURE_SHELL_NO_COMMAND_REGION} when all
985shell commands have been configured.
986
987@subheading PROGRAMMING INFORMATION:
988
989@findex rtems_shell_rtems_main_region
990
991The @code{region} is implemented by a C language function
992which has the following prototype:
993
994@example
995int rtems_shell_rtems_main_region(
996  int    argc,
997  char **argv
998);
999@end example
1000
1001The configuration structure for the @code{region} has the
1002following prototype:
1003
1004@example
1005extern rtems_shell_cmd_t rtems_shell_REGION_Command;
1006@end example
1007
1008@c
1009@c
1010@c
1011@page
1012@subsection part - display information about partitions
1013
1014@pgindex part
1015
1016@subheading SYNOPSYS:
1017
1018@example
1019part [id [id ... ] ]
1020@end example
1021
1022@subheading DESCRIPTION:
1023
1024When invoked with no arguments, this command prints information on
1025the set of Classic API Partitions currently active in the system.
1026
1027If invoked with a set of object ids as arguments, then just
1028those objects are included in the information printed.
1029
1030@subheading EXIT STATUS:
1031
1032This command returns 0 on success and non-zero if an error is encountered.
1033
1034@subheading NOTES:
1035
1036NONE
1037
1038@subheading EXAMPLES:
1039
1040The following is an example of using the @code{part} command
1041on a system with no user extensions.
1042
1043@smallexample
1044SHLL [/] $ part
1045  ID       NAME   ATTR        STARTADDR LENGTH    BUF_SIZE  USED_BLOCKS
1046------------------------------------------------------------------------------
1047@end smallexample
1048
1049@subheading CONFIGURATION:
1050
1051@findex CONFIGURE_SHELL_NO_COMMAND_PART
1052@findex CONFIGURE_SHELL_COMMAND_PART
1053
1054This command is included in the default shell command set. 
1055When building a custom command set, define
1056@code{CONFIGURE_SHELL_COMMAND_PART} to have this
1057command included.
1058
1059This command can be excluded from the shell command set by
1060defining @code{CONFIGURE_SHELL_NO_COMMAND_PART} when all
1061shell commands have been configured.
1062
1063@subheading PROGRAMMING INFORMATION:
1064
1065@findex rtems_shell_rtems_main_part
1066
1067The @code{part} is implemented by a C language function
1068which has the following prototype:
1069
1070@example
1071int rtems_shell_rtems_main_part(
1072  int    argc,
1073  char **argv
1074);
1075@end example
1076
1077The configuration structure for the @code{part} has the
1078following prototype:
1079
1080@example
1081extern rtems_shell_cmd_t rtems_shell_PART_Command;
1082@end example
1083
1084@c
1085@c
1086@c
1087@page
1088@subsection object - display information about rtems objects
1089
1090@pgindex object
1091
1092@subheading SYNOPSYS:
1093
1094@example
1095object [id [id ...] ]
1096@end example
1097
1098@subheading DESCRIPTION:
1099
1100When invoked with a set of object ids as arguments, then
1101a report on those objects is printed.
1102
1103@subheading EXIT STATUS:
1104
1105This command returns 0 on success and non-zero if an error is encountered.
1106
1107@subheading NOTES:
1108
1109NONE
1110
1111@subheading EXAMPLES:
1112
1113The following is an example of how to use @code{object}:
1114
1115@smallexample
1116SHLL [/] $ object 0a010001 1a010002
1117  ID       NAME   PRIO   STAT   MODES  EVENTS   WAITID  WAITARG  NOTES
1118------------------------------------------------------------------------------
11190a010001   UI1      1   SUSP   P:T:nA  NONE                     
1120  ID       NAME   ATTR        PRICEIL CURR_CNT HOLDID
1121------------------------------------------------------------------------------
11221a010002   TRmi   PR:BI:IN      0        1     00000000
1123@end smallexample
1124
1125@subheading CONFIGURATION:
1126
1127@findex CONFIGURE_SHELL_NO_COMMAND_OBJECT
1128@findex CONFIGURE_SHELL_COMMAND_OBJECT
1129
1130This command is included in the default shell command set. 
1131When building a custom command set, define
1132@code{CONFIGURE_SHELL_COMMAND_OBJECT} to have this
1133command included.
1134
1135This command can be excluded from the shell command set by
1136defining @code{CONFIGURE_SHELL_NO_COMMAND_OBJECT} when all
1137shell commands have been configured.
1138
1139@subheading PROGRAMMING INFORMATION:
1140
1141@findex rtems_shell_rtems_main_object
1142
1143The @code{object} is implemented by a C language function
1144which has the following prototype:
1145
1146@example
1147int rtems_shell_rtems_main_object(
1148  int    argc,
1149  char **argv
1150);
1151@end example
1152
1153The configuration structure for the @code{object} has the
1154following prototype:
1155
1156@example
1157extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
1158@end example
1159
1160@c
1161@c
1162@c
1163@page
1164@subsection driver - display the rtems device driver table
1165
1166@pgindex driver
1167
1168@subheading SYNOPSYS:
1169
1170@example
1171driver [ major [ major ... ] ]
1172@end example
1173
1174@subheading DESCRIPTION:
1175
1176When invoked with no arguments, this command prints information on
1177the set of Device Drivers currently active in the system.
1178
1179If invoked with a set of major numbers as arguments, then just
1180those Device Drivers are included in the information printed.
1181
1182@subheading EXIT STATUS:
1183
1184This command returns 0 on success and non-zero if an error is encountered.
1185
1186@subheading NOTES:
1187
1188NONE
1189
1190@subheading EXAMPLES:
1191
1192The following is an example of how to use @code{driver}:
1193
1194@smallexample
1195SHLL [/] $ driver
1196  Major      Entry points
1197------------------------------------------------------------------------------
1198  0          init: [0x200256c];  control: [0x20024c8]
1199             open: [0x2002518];  close: [0x2002504]
1200             read: [0x20024f0];  write: [0x20024dc]
1201  1          init: [0x20023fc];  control: [0x2002448]
1202             open: [0x0];  close: [0x0]
1203             read: [0x0];  write: [0x0]
1204SHLL [/] $
1205@end smallexample
1206
1207@subheading CONFIGURATION:
1208
1209@findex CONFIGURE_SHELL_NO_COMMAND_DRIVER
1210@findex CONFIGURE_SHELL_COMMAND_DRIVER
1211
1212This command is included in the default shell command set. 
1213When building a custom command set, define
1214@code{CONFIGURE_SHELL_COMMAND_DRIVER} to have this
1215command included.
1216
1217This command can be excluded from the shell command set by
1218defining @code{CONFIGURE_SHELL_NO_COMMAND_DRIVER} when all
1219shell commands have been configured.
1220
1221@subheading PROGRAMMING INFORMATION:
1222
1223@findex rtems_shell_rtems_main_driver
1224
1225The @code{driver} is implemented by a C language function
1226which has the following prototype:
1227
1228@example
1229int rtems_shell_rtems_main_driver(
1230  int    argc,
1231  char **argv
1232);
1233@end example
1234
1235The configuration structure for the @code{driver} has the
1236following prototype:
1237
1238@example
1239extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
1240@end example
1241
1242@c
1243@c
1244@c
1245@page
1246@subsection dname - displays information about named drivers
1247
1248@pgindex dname
1249
1250@subheading SYNOPSYS:
1251
1252@example
1253dname
1254@end example
1255
1256@subheading DESCRIPTION:
1257
1258This command XXX
1259
1260WARNING! XXX This command does not appear to work as of 27 February 2008.
1261
1262@subheading EXIT STATUS:
1263
1264This command returns 0 on success and non-zero if an error is encountered.
1265
1266@subheading NOTES:
1267
1268NONE
1269
1270@subheading EXAMPLES:
1271
1272The following is an example of how to use @code{dname}:
1273
1274@example
1275EXAMPLE_TBD
1276@end example
1277
1278@subheading CONFIGURATION:
1279
1280@findex CONFIGURE_SHELL_NO_COMMAND_DNAME
1281@findex CONFIGURE_SHELL_COMMAND_DNAME
1282
1283This command is included in the default shell command set. 
1284When building a custom command set, define
1285@code{CONFIGURE_SHELL_COMMAND_DNAME} to have this
1286command included.
1287
1288This command can be excluded from the shell command set by
1289defining @code{CONFIGURE_SHELL_NO_COMMAND_DNAME} when all
1290shell commands have been configured.
1291
1292@subheading PROGRAMMING INFORMATION:
1293
1294@findex rtems_shell_rtems_main_dname
1295
1296The @code{dname} is implemented by a C language function
1297which has the following prototype:
1298
1299@example
1300int rtems_shell_rtems_main_dname(
1301  int    argc,
1302  char **argv
1303);
1304@end example
1305
1306The configuration structure for the @code{dname} has the
1307following prototype:
1308
1309@example
1310extern rtems_shell_cmd_t rtems_shell_DNAME_Command;
1311@end example
1312
1313@c
1314@c
1315@c
1316@page
1317@subsection pthread - display information about POSIX threads
1318
1319@pgindex pthread
1320
1321@subheading SYNOPSYS:
1322
1323@example
1324pthread [id [id ...] ]
1325@end example
1326
1327@subheading DESCRIPTION:
1328
1329When invoked with no arguments, this command prints information on
1330the set of POSIX API threads currently active in the system.
1331
1332If invoked with a set of ids as arguments, then just
1333those objects are included in the information printed.
1334
1335@subheading EXIT STATUS:
1336
1337This command returns 0 on success and non-zero if an error is encountered.
1338
1339@subheading NOTES:
1340
1341This command is only available when the POSIX API is configured.
1342
1343@subheading EXAMPLES:
1344
1345The following is an example of how to use the @code{task} on an
1346application with four POSIX threads:
1347
1348@smallexample
1349SHLL [/] $ pthread
1350  ID       NAME           PRI  STATE MODES   EVENTS    WAITID  WAITARG  NOTES
1351------------------------------------------------------------------------------
13520b010002   Main           133 READY  P:T:nA    NONE   43010001 0x7b1148
13530b010003   ISR            133 Wcvar  P:T:nA    NONE   43010003 0x7b1148
13540b01000c                  133 READY  P:T:nA    NONE   33010002 0x7b1148
13550b01000d                  133 Wmutex P:T:nA    NONE   33010002 0x7b1148
1356
1357@end smallexample
1358
1359@subheading CONFIGURATION:
1360
1361This command is part of the monitor commands which are always
1362available in the shell.
1363
1364@subheading PROGRAMMING INFORMATION:
1365
1366This command is not directly available for invocation.
1367
Note: See TracBrowser for help on using the repository browser.