source: rtems-docs/shell/rtems_specific_commands.rst @ 4e85468

5am
Last change on this file since 4e85468 was 4e85468, checked in by Sebastian Huber <sebastian.huber@…>, on Jun 16, 2017 at 4:19:16 AM

shell: Update task command

  • Property mode set to 100644
File size: 46.1 KB
RevLine 
[489740f]1.. comment SPDX-License-Identifier: CC-BY-SA-4.0
2
[35bcd00]3.. COMMENT: COPYRIGHT (c) 1988-2008.
4.. COMMENT: On-Line Applications Research Corporation (OAR).
5.. COMMENT: All rights reserved.
6
[8ca13ed]7RTEMS Specific Commands
[f15d607]8***********************
[8ca13ed]9
10Introduction
11============
12
[a1c7180]13The RTEMS shell has the following RTEMS specific commands:
[8ca13ed]14
[35bcd00]15- shutdown_ - Shutdown the system
[8ca13ed]16
[f517010]17- cpuinfo_ - print per-processor information
18
[35bcd00]19- cpuuse_ - print or reset per thread cpu usage
[8ca13ed]20
[35bcd00]21- stackuse_ - print per thread stack usage
[8ca13ed]22
[35bcd00]23- perioduse_ - print or reset per period usage
[8ca13ed]24
[35bcd00]25- profreport_ - print a profiling report
[8ca13ed]26
[35bcd00]27- wkspace_ - Display information on Executive Workspace
[8ca13ed]28
[35bcd00]29- config_ - Show the system configuration.
[8ca13ed]30
[35bcd00]31- itask_ - List init tasks for the system
[8ca13ed]32
[35bcd00]33- extension_ - Display information about extensions
[8ca13ed]34
[35bcd00]35- task_ - Display information about tasks
[8ca13ed]36
[35bcd00]37- queue_ - Display information about message queues
[8ca13ed]38
[35bcd00]39- sema_ - display information about semaphores
[8ca13ed]40
[35bcd00]41- region_ - display information about regions
[8ca13ed]42
[35bcd00]43- part_ - display information about partitions
[8ca13ed]44
[35bcd00]45- object_ - Display information about RTEMS objects
[8ca13ed]46
[35bcd00]47- driver_ - Display the RTEMS device driver table
[8ca13ed]48
[35bcd00]49- dname_ - Displays information about named drivers
[8ca13ed]50
[35bcd00]51- pthread_ - Displays information about POSIX threads
[8ca13ed]52
53Commands
54========
55
[bf61a8b]56This section details the RTEMS Specific Commands available.  A subsection is
57dedicated to each of the commands and describes the behavior and configuration
58of that command as well as providing an example usage.
59
60.. raw:: latex
61
62   \clearpage
[8ca13ed]63
[35bcd00]64.. _shutdown:
65
[8ca13ed]66shutdown - Shutdown the system
67------------------------------
68.. index:: shutdown
69
[bf61a8b]70SYNOPSYS:
71    .. code-block:: shell
[8ca13ed]72
[bf61a8b]73        shutdown
[8ca13ed]74
[bf61a8b]75DESCRIPTION:
76    This command is used to shutdown the RTEMS application.
[8ca13ed]77
[bf61a8b]78EXIT STATUS:
79    This command does not return.
[8ca13ed]80
[bf61a8b]81NOTES:
82    NONE
[8ca13ed]83
[bf61a8b]84EXAMPLES:
85    The following is an example of how to use ``shutdown``:
[8ca13ed]86
[bf61a8b]87    .. code-block:: shell
[35bcd00]88
[bf61a8b]89        SHLL [/] $ shutdown
90        System shutting down at user request
[8ca13ed]91
[bf61a8b]92    The user will not see another prompt and the system will shutdown.
[8ca13ed]93
94.. index:: CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN
95.. index:: CONFIGURE_SHELL_COMMAND_SHUTDOWN
96
[bf61a8b]97CONFIGURATION:
98    This command is included in the default shell command set.  When building a
99    custom command set, define ``CONFIGURE_SHELL_COMMAND_SHUTDOWN`` to have
100    this command included.
101
102    This command can be excluded from the shell command set by defining
103    ``CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN`` when all shell commands have been
104    configured.
[8ca13ed]105
[bf61a8b]106PROGRAMMING INFORMATION:
107    The configuration structure for the ``shutdown`` has the following
108    prototype:
[8ca13ed]109
[bf61a8b]110    .. code-block:: c
[8ca13ed]111
[bf61a8b]112        extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command;
[35bcd00]113
[bf61a8b]114.. raw:: latex
[8ca13ed]115
[bf61a8b]116   \clearpage
[8ca13ed]117
[f517010]118.. _cpuinfo:
119
120cpuinfo - print per-processor information
121--------------------------------------------
122.. index:: cpuinfo
123
124SYNOPSYS:
125    .. code-block:: shell
126
127        cpuinfo
128
129DESCRIPTION:
130    This command may be used to print per-processor information.
131
132EXIT STATUS:
133    This command returns 0 on success and non-zero if an error is encountered.
134
135EXAMPLES:
136    The following is an example of how to use ``cpuinfo``:
137
138    .. code-block:: shell
139
140        SHLL [/] $ cpuinfo
141        -------------------------------------------------------------------------------
142                                    PER PROCESSOR INFORMATION
143        -------+--------+--------------+-----------------------------------------------
144         INDEX | ONLINE | SCHEDULER ID | SCHEDULER NAME
145        -------+--------+--------------+-----------------------------------------------
146             0 |      1 |   0x0f010001 | UPD
147
148    In the above example, the system has only one processor.  This processor
149    has the index zero and is online.  It is owned by the scheduler with the
150    identifier ``0x0f010001`` and name ``UPD``.
151
152.. index:: CONFIGURE_SHELL_NO_COMMAND_CPUINFO
153.. index:: CONFIGURE_SHELL_COMMAND_CPUINFO
154
155CONFIGURATION:
156    This command is included in the default shell command set.  When building a
157    custom command set, define ``CONFIGURE_SHELL_COMMAND_CPUINFO`` to have this
158    command included.
159
160    This command can be excluded from the shell command set by defining
161    ``CONFIGURE_SHELL_NO_COMMAND_CPUINFO`` when all shell commands have been
162    configured.
163
164.. index:: rtems_shell_rtems_main_cpuinfo
165
166PROGRAMMING INFORMATION:
167    The ``cpuinfo`` is implemented by a C language function which has the following
168    prototype:
169
170    .. code-block:: c
171
172        int rtems_cpu_info_report(
173            const rtems_printer *printer
174        );
175
176    The configuration structure for the ``cpuinfo`` has the following prototype:
177
178    .. code-block:: c
179
180        extern rtems_shell_cmd_t rtems_shell_CPUINFO_Command;
181
182.. raw:: latex
183
184   \clearpage
185
[35bcd00]186.. _cpuuse:
187
[8ca13ed]188cpuuse - print or reset per thread cpu usage
189--------------------------------------------
190.. index:: cpuuse
191
[bf61a8b]192SYNOPSYS:
193    .. code-block:: shell
194
195        cpuuse [-r]
196
197DESCRIPTION:
198    This command may be used to print a report on the per thread cpu usage or
199    to reset the per thread CPU usage statistics. When invoked with the ``-r``
200    option, the CPU usage statistics are reset.
201
202EXIT STATUS:
203    This command returns 0 on success and non-zero if an error is encountered.
204
205NOTES:
206    The granularity of the timing information reported is dependent upon the
207    BSP and the manner in which RTEMS was built.  In the default RTEMS
208    configuration, if the BSP supports nanosecond granularity timestamps, then
209    the information reported will be highly accurate. Otherwise, the accuracy
210    of the information reported is limited by the clock tick quantum.
211
212EXAMPLES:
213    The following is an example of how to use ``cpuuse``:
214
215    .. code-block:: shell
216
[8363c3d]217        [/] cpuuse
218        -------------------------------------------------------------------------------
219                                      CPU USAGE BY THREAD
220        ------------+----------------------------------------+---------------+---------
221         ID         | NAME                                   | SECONDS       | PERCENT
222        ------------+----------------------------------------+---------------+---------
223         0x09010001 | IDLE                                   |     11.444381 |  73.938
224         0x0a010001 | UI1                                    |      0.206754 |   1.335
225         0x0a010002 | BSWP                                   |      0.008277 |   0.053
226         0x0a010003 | BRDA                                   |      0.000952 |   0.006
227         0x0a010004 | MDIA                                   |      0.000334 |   0.002
228         0x0a010005 | TIME                                   |      0.912809 |   5.895
229         0x0a010006 | IRQS                                   |      0.004810 |   0.031
230         0x0a010007 | swi1: netisr 0                         |      0.002593 |   0.016
231         0x0a010008 | kqueue_ctx task                        |      0.000663 |   0.004
232         0x0a010009 | swi5: fast task                        |      0.000059 |   0.000
233         0x0a01000a | thread taskq                           |      0.000057 |   0.000
234         0x0a01000b | swi6: task queu                        |      0.003063 |   0.019
235         0x0a01000c | DHCP                                   |      1.391745 |   8.986
236         0x0a01000d | FTPa                                   |      0.002203 |   0.014
237         0x0a01000e | FTPb                                   |      0.000233 |   0.001
238         0x0a01000f | FTPc                                   |      0.000226 |   0.001
239         0x0a010010 | FTPd                                   |      0.000228 |   0.001
240         0x0a010011 | FTPD                                   |      0.002959 |   0.019
241         0x0a010012 | TNTD                                   |      0.001111 |   0.007
242         0x0a010013 | SHLL                                   |      1.508445 |   9.736
243        ------------+----------------------------------------+---------------+---------
244         TIME SINCE LAST CPU USAGE RESET IN SECONDS:                         15.492171
245        -------------------------------------------------------------------------------
246        [/] # cpuuse -r
[bf61a8b]247        Resetting CPU Usage information
[8363c3d]248        [/] # cpuuse
249        -------------------------------------------------------------------------------
250                                      CPU USAGE BY THREAD
251        ------------+----------------------------------------+---------------+---------
252         ID         | NAME                                   | SECONDS       | PERCENT
253        ------------+----------------------------------------+---------------+---------
254         0x09010001 | IDLE                                   |      0.000000 |   0.000
255         0x0a010001 | UI1                                    |      0.000000 |   0.000
256         0x0a010002 | BSWP                                   |      0.000000 |   0.000
257         0x0a010003 | BRDA                                   |      0.000000 |   0.000
258         0x0a010004 | MDIA                                   |      0.000000 |   0.000
259         0x0a010005 | TIME                                   |      0.000000 |   0.000
260         0x0a010006 | IRQS                                   |      0.000000 |   0.000
261         0x0a010007 | swi1: netisr 0                         |      0.000000 |   0.000
262         0x0a010008 | kqueue_ctx task                        |      0.000000 |   0.000
263         0x0a010009 | swi5: fast task                        |      0.000000 |   0.000
264         0x0a01000a | thread taskq                           |      0.000000 |   0.000
265         0x0a01000b | swi6: task queu                        |      0.000000 |   0.000
266         0x0a01000c | DHCP                                   |      0.000000 |   0.000
267         0x0a01000d | FTPa                                   |      0.000000 |   0.000
268         0x0a01000e | FTPb                                   |      0.000000 |   0.000
269         0x0a01000f | FTPc                                   |      0.000000 |   0.000
270         0x0a010010 | FTPd                                   |      0.000000 |   0.000
271         0x0a010011 | FTPD                                   |      0.000000 |   0.000
272         0x0a010012 | TNTD                                   |      0.000000 |   0.000
273         0x0a010013 | SHLL                                   |      0.016503 |  99.962
274        ------------+----------------------------------------+---------------+---------
275         TIME SINCE LAST CPU USAGE RESET IN SECONDS:                          0.016509
276        -------------------------------------------------------------------------------
277
278    In the above example, the system did something for roughly 15 seconds when the
279    first report was generated.  The ``cpuuse -r`` and ``cpuuse`` commands were
[bf61a8b]280    pasted from another window so were executed with no gap between.  In the
[8363c3d]281    second report, only the ``SHLL`` thread has run since the CPU Usage was
282    reset.  It has consumed approximately 16.509 milliseconds of CPU time
[bf61a8b]283    processing the two commands and generating the output.
[8ca13ed]284
285.. index:: CONFIGURE_SHELL_NO_COMMAND_CPUUSE
286.. index:: CONFIGURE_SHELL_COMMAND_CPUUSE
287
[bf61a8b]288CONFIGURATION:
289    This command is included in the default shell command set.  When building a
290    custom command set, define ``CONFIGURE_SHELL_COMMAND_CPUUSE`` to have this
291    command included.
[8ca13ed]292
[bf61a8b]293    This command can be excluded from the shell command set by defining
294    ``CONFIGURE_SHELL_NO_COMMAND_CPUUSE`` when all shell commands have been
295    configured.
[8ca13ed]296
297.. index:: rtems_shell_rtems_main_cpuuse
298
[bf61a8b]299PROGRAMMING INFORMATION:
300    The ``cpuuse`` is implemented by a C language function which has the following
301    prototype:
302
303    .. code-block:: c
[35bcd00]304
[bf61a8b]305        int rtems_shell_rtems_main_cpuuse(
306           int    argc,
307           char **argv
308        );
[8ca13ed]309
[bf61a8b]310    The configuration structure for the ``cpuuse`` has the following prototype:
[8ca13ed]311
[bf61a8b]312    .. code-block:: c
[35bcd00]313
[bf61a8b]314        extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;
[8ca13ed]315
[bf61a8b]316.. raw:: latex
317
318   \clearpage
[8ca13ed]319
[35bcd00]320.. _stackuse:
321
[8ca13ed]322stackuse - print per thread stack usage
323---------------------------------------
324.. index:: stackuse
325
[bf61a8b]326SYNOPSYS:
327    .. code-block:: shell
[8ca13ed]328
[bf61a8b]329        stackuse
[8ca13ed]330
[bf61a8b]331DESCRIPTION:
332    This command prints a Stack Usage Report for all of the tasks and threads
333    in the system.  On systems which support it, the usage of the interrupt
334    stack is also included in the report.
[8ca13ed]335
[bf61a8b]336EXIT STATUS:
337    This command always succeeds and returns 0.
[8ca13ed]338
[bf61a8b]339NOTES:
340    The ``CONFIGURE_STACK_CHECKER_ENABLED`` ``confdefs.h`` constant must be
341    defined when the application is configured for this command to have any
342    information to report.
[8ca13ed]343
[bf61a8b]344EXAMPLES:
345    The following is an example of how to use ``stackuse``:
[8ca13ed]346
[bf61a8b]347    .. code-block:: shell
[8ca13ed]348
[8363c3d]349        [/] # stackuse
350                                     STACK USAGE BY THREAD
351        ID         NAME                  LOW        HIGH       CURRENT    AVAIL  USED
352        0x09010001 IDLE                  0x03559960 0x03564055 0x03563728   4080    584
353        0x0a010001 UI1                   0x03564664 0x03597431 0x03596976  32752   4168
354        0x0a010002 BSWP                  0x03714576 0x03718671 0x03718408   4080    564
355        0x0a010003 BRDA                  0x03718680 0x03722775 0x03722480   4080    596
356        0x0a010004 MDIA                  0x03722808 0x03755575 0x03755288  32752    588
357        0x0a010005 TIME                  0x03755664 0x03788431 0x03788168  32752   1448
358        0x0a010006 IRQS                  0x03788440 0x03821207 0x03820952  32752    608
359        0x0a010007 swi1: netisr 0        0x03896880 0x03929647 0x03929376  32752    820
360        0x0a010008 kqueue_ctx task       0x03929872 0x03962639 0x03962392  32752    580
361        0x0a010009 swi5: fast task       0x03963088 0x03995855 0x03995584  32752    572
362        0x0a01000a thread taskq          0x03996080 0x04028847 0x04028600  32752    548
363        0x0a01000b swi6: task queu       0x04029296 0x04062063 0x04061792  32752   1364
364        0x0a01000c DHCP                  0x04250192 0x04258383 0x04257288   8176   2764
365        0x0a01000d FTPa                  0x04258792 0x04266983 0x04265792   8176   1548
366        0x0a01000e FTPb                  0x04267120 0x04275311 0x04274120   8176   1496
367        0x0a01000f FTPc                  0x04275448 0x04283639 0x04282448   8176   1496
368        0x0a010010 FTPd                  0x04283776 0x04291967 0x04290776   8176   1496
369        0x0a010011 FTPD                  0x04292104 0x04296199 0x04295784   4080    772
370        0x0a010012 TNTD                  0x04297088 0x04329855 0x04329368  32752    804
371        0x0a010013 SHLL                  0x04329976 0x04346359 0x04344576  16368   3616
[8ca13ed]372
373.. index:: CONFIGURE_SHELL_NO_COMMAND_STACKUSE
374.. index:: CONFIGURE_SHELL_COMMAND_STACKUSE
375
[bf61a8b]376CONFIGURATION:
377    This command is included in the default shell command set.  When building a
378    custom command set, define ``CONFIGURE_SHELL_COMMAND_STACKUSE`` to have
379    this command included.
[8ca13ed]380
[bf61a8b]381    This command can be excluded from the shell command set by defining
382    ``CONFIGURE_SHELL_NO_COMMAND_STACKUSE`` when all shell commands have been
383    configured.
[8ca13ed]384
385.. index:: rtems_shell_rtems_main_stackuse
386
[bf61a8b]387PROGRAMMING INFORMATION:
388    The ``stackuse`` is implemented by a C language function which has the
389    following prototype:
[35bcd00]390
[bf61a8b]391    .. code-block:: c
[8ca13ed]392
[bf61a8b]393        int rtems_shell_rtems_main_stackuse(
394            int    argc,
395            char **argv
396        );
[8ca13ed]397
[bf61a8b]398    The configuration structure for the ``stackuse`` has the following prototype:
[35bcd00]399
[bf61a8b]400    .. code-block:: c
[8ca13ed]401
[bf61a8b]402        extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;
403
404.. raw:: latex
405
406   \clearpage
[8ca13ed]407
[35bcd00]408.. _perioduse:
409
[8ca13ed]410perioduse - print or reset per period usage
411-------------------------------------------
412.. index:: perioduse
413
[bf61a8b]414SYNOPSYS:
415    .. code-block:: shell
416
417        perioduse [-r]
418
419DESCRIPTION:
420    This command may be used to print a statistics report on the rate monotonic
421    periods in the application or to reset the rate monotonic period usage
422    statistics. When invoked with the ``-r`` option, the usage statistics are
423    reset.
424
425EXIT STATUS:
426    This command returns 0 on success and non-zero if an error is encountered.
427
428NOTES:
429    The granularity of the timing information reported is dependent upon the
430    BSP and the manner in which RTEMS was built.  In the default RTEMS
431    configuration, if the BSP supports nanosecond granularity timestamps, then
432    the information reported will be highly accurate. Otherwise, the accuracy
433    of the information reported is limited by the clock tick quantum.
434
435EXAMPLES:
436    The following is an example of how to use ``perioduse``:
437
438    .. code-block:: shell
439
440        SHLL [/] $ perioduse
441        Period information by period
442        --- CPU times are in seconds ---
443        --- Wall times are in seconds ---
444        ID     OWNER COUNT MISSED          CPU TIME                  WALL TIME
445        MIN/MAX/AVG                MIN/MAX/AVG
446        0x42010001 TA1    502      0 0:000039/0:042650/0:004158 0:000039/0:020118/0:002848
447        0x42010002 TA2    502      0 0:000041/0:042657/0:004309 0:000041/0:020116/0:002848
448        0x42010003 TA3    501      0 0:000041/0:041564/0:003653 0:000041/0:020003/0:002814
449        0x42010004 TA4    501      0 0:000043/0:044075/0:004911 0:000043/0:020004/0:002814
450        0x42010005 TA5     10      0 0:000065/0:005413/0:002739 0:000065/1:000457/0:041058
451        MIN/MAX/AVG                MIN/MAX/AVG
452        SHLL [/] $ perioduse -r
453        Resetting Period Usage information
454        SHLL [/] $ perioduse
455        --- CPU times are in seconds ---
456        --- Wall times are in seconds ---
457        ID     OWNER COUNT MISSED          CPU TIME                  WALL TIME
458        MIN/MAX/AVG                MIN/MAX/AVG
459        0x42010001 TA1      0      0
460        0x42010002 TA2      0      0
461        0x42010003 TA3      0      0
462        0x42010004 TA4      0      0
463        0x42010005 TA5      0      0
[8ca13ed]464
465.. index:: CONFIGURE_SHELL_NO_COMMAND_PERIODUSE
466.. index:: CONFIGURE_SHELL_COMMAND_PERIODUSE
467
[bf61a8b]468CONFIGURATION:
469    This command is included in the default shell command set.  When building a
470    custom command set, define ``CONFIGURE_SHELL_COMMAND_PERIODUSE`` to have
471    this command included.
[8ca13ed]472
[bf61a8b]473    This command can be excluded from the shell command set by defining
474    ``CONFIGURE_SHELL_NO_COMMAND_PERIODUSE`` when all shell commands have been
475    configured.
[8ca13ed]476
477.. index:: rtems_shell_rtems_main_perioduse
478
[bf61a8b]479PROGRAMMING INFORMATION:
480    The ``perioduse`` is implemented by a C language function which has the
481    following prototype:
[35bcd00]482
[bf61a8b]483    .. code-block:: c
[8ca13ed]484
[bf61a8b]485        int rtems_shell_rtems_main_perioduse(
486            int    argc,
487            char **argv
488        );
[8ca13ed]489
[bf61a8b]490    The configuration structure for the ``perioduse`` has the following prototype:
[35bcd00]491
[bf61a8b]492    .. code-block:: c
[8ca13ed]493
[bf61a8b]494        extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;
495
496.. raw:: latex
497
498   \clearpage
[8ca13ed]499
[35bcd00]500.. _profreport:
501
[8ca13ed]502profreport - print a profiling report
503-------------------------------------
504.. index:: profreport
505
[bf61a8b]506SYNOPSYS:
507    .. code-block:: shell
508
509        profreport
510
511DESCRIPTION:
512    This command may be used to print a profiling report if profiling is built
513    into the RTEMS kernel.
514
515EXIT STATUS:
516    This command returns 0.
517
518NOTES:
519    Profiling must be enabled at build configuration time to get profiling
520    information.
521
522EXAMPLES:
523    The following is an example of how to use ``profreport``:
524
525    .. code-block:: shell
526
527        SHLL [/] $ profreport
528        <ProfilingReport name="Shell">
529        <PerCPUProfilingReport processorIndex="0">
530        <MaxThreadDispatchDisabledTime unit="ns">10447</MaxThreadDispatchDisabledTime>
531        <MeanThreadDispatchDisabledTime unit="ns">2</MeanThreadDispatchDisabledTime>
532        <TotalThreadDispatchDisabledTime unit="ns">195926627</TotalThreadDispatchDisabledTime>
533        <ThreadDispatchDisabledCount>77908688</ThreadDispatchDisabledCount>
534        <MaxInterruptDelay unit="ns">0</MaxInterruptDelay>
535        <MaxInterruptTime unit="ns">688</MaxInterruptTime>
536        <MeanInterruptTime unit="ns">127</MeanInterruptTime>
537        <TotalInterruptTime unit="ns">282651157</TotalInterruptTime>
538        <InterruptCount>2215855</InterruptCount>
539        </PerCPUProfilingReport>
540        <PerCPUProfilingReport processorIndex="1">
541        <MaxThreadDispatchDisabledTime unit="ns">9053</MaxThreadDispatchDisabledTime>
542        <MeanThreadDispatchDisabledTime unit="ns">41</MeanThreadDispatchDisabledTime>
543        <TotalThreadDispatchDisabledTime unit="ns">3053830335</TotalThreadDispatchDisabledTime>
544        <ThreadDispatchDisabledCount>73334202</ThreadDispatchDisabledCount>
545        <MaxInterruptDelay unit="ns">0</MaxInterruptDelay>
546        <MaxInterruptTime unit="ns">57</MaxInterruptTime>
547        <MeanInterruptTime unit="ns">35</MeanInterruptTime>
548        <TotalInterruptTime unit="ns">76980203</TotalInterruptTime>
549        <InterruptCount>2141179</InterruptCount>
550        </PerCPUProfilingReport>
551        <SMPLockProfilingReport name="SMP lock stats">
552        <MaxAcquireTime unit="ns">608</MaxAcquireTime>
553        <MaxSectionTime unit="ns">1387</MaxSectionTime>
554        <MeanAcquireTime unit="ns">112</MeanAcquireTime>
555        <MeanSectionTime unit="ns">338</MeanSectionTime>
556        <TotalAcquireTime unit="ns">119031</TotalAcquireTime>
557        <TotalSectionTime unit="ns">357222</TotalSectionTime>
558        <UsageCount>1055</UsageCount>
559        <ContentionCount initialQueueLength="0">1055</ContentionCount>
560        <ContentionCount initialQueueLength="1">0</ContentionCount>
561        <ContentionCount initialQueueLength="2">0</ContentionCount>
562        <ContentionCount initialQueueLength="3">0</ContentionCount>
563        </SMPLockProfilingReport>
564        <SMPLockProfilingReport name="Giant">
565        <MaxAcquireTime unit="ns">4186</MaxAcquireTime>
566        <MaxSectionTime unit="ns">7575</MaxSectionTime>
567        <MeanAcquireTime unit="ns">160</MeanAcquireTime>
568        <MeanSectionTime unit="ns">183</MeanSectionTime>
569        <TotalAcquireTime unit="ns">1772793111</TotalAcquireTime>
570        <TotalSectionTime unit="ns">2029733879</TotalSectionTime>
571        <UsageCount>11039140</UsageCount>
572        <ContentionCount initialQueueLength="0">11037655</ContentionCount>
573        <ContentionCount initialQueueLength="1">1485</ContentionCount>
574        <ContentionCount initialQueueLength="2">0</ContentionCount>
575        <ContentionCount initialQueueLength="3">0</ContentionCount>
576        </SMPLockProfilingReport>
577        </ProfilingReport>
[8ca13ed]578
579.. index:: CONFIGURE_SHELL_NO_COMMAND_PROFREPORT
580.. index:: CONFIGURE_SHELL_COMMAND_PROFREPORT
581
[bf61a8b]582CONFIGURATION:
583    When building a custom command set, define
584    ``CONFIGURE_SHELL_COMMAND_PROFREPORT`` to have this command included.
585
586    This command can be excluded from the shell command set by defining
587    ``CONFIGURE_SHELL_NO_COMMAND_PROFREPORT`` when all shell commands have been
588    configured.
[8ca13ed]589
[bf61a8b]590PROGRAMMING INFORMATION:
591    The configuration structure for the ``profreport`` has the following
592    prototype:
[8ca13ed]593
[bf61a8b]594    .. code-block:: c
[8ca13ed]595
[bf61a8b]596        extern rtems_shell_cmd_t rtems_shell_PROFREPORT_Command;
[35bcd00]597
[bf61a8b]598.. raw:: latex
[8ca13ed]599
[bf61a8b]600   \clearpage
[8ca13ed]601
[35bcd00]602.. _wkspace:
603
[8ca13ed]604wkspace - display information on executive workspace
605----------------------------------------------------
606.. index:: wkspace
607
[bf61a8b]608SYNOPSYS:
609    .. code-block:: shell
[8ca13ed]610
[bf61a8b]611        wkspace
[8ca13ed]612
[bf61a8b]613DESCRIPTION:
614    This command prints information on the current state of the RTEMS Executive
615    Workspace reported.  This includes the following information:
[8ca13ed]616
[bf61a8b]617    - Number of free blocks
[8ca13ed]618
[bf61a8b]619    - Largest free block
[8ca13ed]620
[bf61a8b]621    - Total bytes free
[8ca13ed]622
[bf61a8b]623    - Number of used blocks
[8ca13ed]624
[bf61a8b]625    - Largest used block
[8ca13ed]626
[bf61a8b]627    - Total bytes used
[8ca13ed]628
[bf61a8b]629EXIT STATUS:
630    This command always succeeds and returns 0.
[8ca13ed]631
[bf61a8b]632NOTES:
633    NONE
[8ca13ed]634
[bf61a8b]635EXAMPLES:
636    The following is an example of how to use ``wkspace``:
[8ca13ed]637
[bf61a8b]638    .. code-block:: shell
[8ca13ed]639
[bf61a8b]640        SHLL [/] $ wkspace
641        Number of free blocks: 1
642        Largest free block:    132336
643        Total bytes free:      132336
644        Number of used blocks: 36
645        Largest used block:    16408
646        Total bytes used:      55344
[8ca13ed]647
648.. index:: CONFIGURE_SHELL_NO_COMMAND_WKSPACE
649.. index:: CONFIGURE_SHELL_COMMAND_WKSPACE
650
[bf61a8b]651CONFIGURATION:
652    This command is included in the default shell command set.  When building a
653    custom command set, define ``CONFIGURE_SHELL_COMMAND_WKSPACE`` to have this
654    command included.
[8ca13ed]655
[bf61a8b]656    This command can be excluded from the shell command set by defining
657    ``CONFIGURE_SHELL_NO_COMMAND_WKSPACE`` when all shell commands have been
658    configured.
[8ca13ed]659
660.. index:: rtems_shell_rtems_main_wkspace
661
[bf61a8b]662PROGRAMMING INFORMATION:
663    The ``wkspace`` is implemented by a C language function which has the
664    following prototype:
[35bcd00]665
[bf61a8b]666    .. code-block:: c
[8ca13ed]667
[bf61a8b]668        int rtems_shell_rtems_main_wkspace(
669            int    argc,
670            char **argv
671        );
[8ca13ed]672
[bf61a8b]673    The configuration structure for the ``wkspace`` has the following prototype:
[35bcd00]674
[bf61a8b]675    .. code-block:: c
[8ca13ed]676
[bf61a8b]677        extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;
678
679.. raw:: latex
680
681   \clearpage
[8ca13ed]682
[35bcd00]683.. _config:
684
[8ca13ed]685config - show the system configuration.
686---------------------------------------
687.. index:: config
688
[bf61a8b]689SYNOPSYS:
690    .. code-block:: shell
[8ca13ed]691
[bf61a8b]692        config
[8ca13ed]693
[bf61a8b]694DESCRIPTION:
695    This command display information about the RTEMS Configuration.
[8ca13ed]696
[bf61a8b]697EXIT STATUS:
698    This command always succeeds and returns 0.
[8ca13ed]699
[bf61a8b]700NOTES:
701    At this time, it does not report every configuration parameter.  This is an
702    area in which user submissions or sponsorship of a developer would be
703    appreciated.
[8ca13ed]704
[bf61a8b]705EXAMPLES:
706    The following is an example of how to use ``config``:
[8ca13ed]707
[bf61a8b]708    .. code-block:: shell
[8ca13ed]709
[bf61a8b]710        SHLL [/] $ config
711        INITIAL (startup) Configuration Info
[8ca13ed]712
[bf61a8b]713        WORKSPACE      start: 0x23d22e0;  size: 0x2dd20
714        TIME           usec/tick: 10000;  tick/timeslice: 50;  tick/sec: 100
715        MAXIMUMS       tasks: 20;  timers: 0;  sems: 50;  que's: 20;  ext's: 1
716        partitions: 0;  regions: 0;  ports: 0;  periods: 0
[8ca13ed]717
718.. index:: CONFIGURE_SHELL_NO_COMMAND_CONFIG
719.. index:: CONFIGURE_SHELL_COMMAND_CONFIG
720
[bf61a8b]721CONFIGURATION:
722    This command is included in the default shell command set.  When building a
723    custom command set, define ``CONFIGURE_SHELL_COMMAND_CONFIG`` to have this
724    command included.
[8ca13ed]725
[bf61a8b]726    This command can be excluded from the shell command set by defining
727    ``CONFIGURE_SHELL_NO_COMMAND_CONFIG`` when all shell commands have been
728    configured.
[8ca13ed]729
730.. index:: rtems_shell_rtems_main_config
731
[bf61a8b]732PROGRAMMING INFORMATION:
733    The ``config`` is implemented by a C language function which has the
734    following prototype:
735
736    .. code-block:: c
[35bcd00]737
[bf61a8b]738        int rtems_shell_rtems_main_config(
739            int    argc,
740            char **argv
741        );
[8ca13ed]742
[bf61a8b]743    The configuration structure for the ``config`` has the following prototype:
[8ca13ed]744
[bf61a8b]745    .. code-block:: c
[35bcd00]746
[bf61a8b]747        extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;
[8ca13ed]748
[bf61a8b]749.. raw:: latex
750
751   \clearpage
[8ca13ed]752
[35bcd00]753.. _itask:
754
[8ca13ed]755itask - list init tasks for the system
756--------------------------------------
757.. index:: itask
758
[bf61a8b]759SYNOPSYS:
760    .. code-block:: shell
[8ca13ed]761
[bf61a8b]762        itask
[8ca13ed]763
[bf61a8b]764DESCRIPTION:
765    This command prints a report on the set of initialization tasks and threads
766    in the system.
[8ca13ed]767
[bf61a8b]768EXIT STATUS:
769    This command always succeeds and returns 0.
[8ca13ed]770
[bf61a8b]771NOTES:
772    At this time, it includes only Classic API Initialization Tasks.  This is an
773    area in which user submissions or sponsorship of a developer would be
774    appreciated.
[8ca13ed]775
[bf61a8b]776EXAMPLES:
777    The following is an example of how to use ``itask``:
[8ca13ed]778
[bf61a8b]779    .. code-block:: shell
[8ca13ed]780
[bf61a8b]781        SHLL [/] $ itask
782        #    NAME   ENTRY        ARGUMENT    PRIO   MODES  ATTRIBUTES   STACK SIZE
783        ------------------------------------------------------------------------------
784        0   UI1    [0x2002258] 0 [0x0]        1    nP      DEFAULT     4096 [0x1000]
[8ca13ed]785
786.. index:: CONFIGURE_SHELL_NO_COMMAND_ITASK
787.. index:: CONFIGURE_SHELL_COMMAND_ITASK
788
[bf61a8b]789CONFIGURATION:
790    This command is included in the default shell command set.  When building a
791    custom command set, define ``CONFIGURE_SHELL_COMMAND_ITASK`` to have this
792    command included.
[8ca13ed]793
[bf61a8b]794    This command can be excluded from the shell command set by defining
795    ``CONFIGURE_SHELL_NO_COMMAND_ITASK`` when all shell commands have been
796    configured.
[8ca13ed]797
798.. index:: rtems_shell_rtems_main_itask
799
[bf61a8b]800PROGRAMMING INFORMATION:
801    The ``itask`` is implemented by a C language function which has the
802    following prototype:
803
804    .. code-block:: c
805
806        int rtems_shell_rtems_main_itask(
807            int    argc,
808            char **argv
809        );
[35bcd00]810
[bf61a8b]811    The configuration structure for the ``itask`` has the following prototype:
[8ca13ed]812
[bf61a8b]813    .. code-block:: c
[8ca13ed]814
[bf61a8b]815        extern rtems_shell_cmd_t rtems_shell_ITASK_Command;
[35bcd00]816
[bf61a8b]817.. raw:: latex
[8ca13ed]818
[bf61a8b]819   \clearpage
[8ca13ed]820
[35bcd00]821.. _extension:
822
[8ca13ed]823extension - display information about extensions
824------------------------------------------------
825.. index:: extension
826
[bf61a8b]827SYNOPSYS:
828    .. code-block:: shell
[8ca13ed]829
[bf61a8b]830        extension [id [id ...]]
[8ca13ed]831
[bf61a8b]832DESCRIPTION:
833    When invoked with no arguments, this command prints information on the set
834    of User Extensions currently active in the system.
[8ca13ed]835
[bf61a8b]836    If invoked with a set of ids as arguments, then just those objects are
837    included in the information printed.
[8ca13ed]838
[bf61a8b]839EXIT STATUS:
840    This command returns 0 on success and non-zero if an error is encountered.
[8ca13ed]841
[bf61a8b]842NOTES:
843    NONE
[8ca13ed]844
[bf61a8b]845EXAMPLES:
846    The following is an example of using the ``extension`` command on a system
847    with no user extensions.
[8ca13ed]848
[bf61a8b]849    .. code-block:: shell
[35bcd00]850
[bf61a8b]851        SHLL [/] $ extension
852        ID       NAME
853        ------------------------------------------------------------------------------
[8ca13ed]854
855.. index:: CONFIGURE_SHELL_NO_COMMAND_EXTENSION
856.. index:: CONFIGURE_SHELL_COMMAND_EXTENSION
857
[bf61a8b]858CONFIGURATION:
859    This command is included in the default shell command set.  When building a
860    custom command set, define ``CONFIGURE_SHELL_COMMAND_EXTENSION`` to have
861    this command included.
[8ca13ed]862
[bf61a8b]863    This command can be excluded from the shell command set by defining
864    ``CONFIGURE_SHELL_NO_COMMAND_EXTENSION`` when all shell commands have been
865    configured.
[8ca13ed]866
867.. index:: rtems_shell_rtems_main_extension
868
[bf61a8b]869PROGRAMMING INFORMATION:
870    The ``extension`` is implemented by a C language function which has the
871    following prototype:
872
873    .. code-block:: c
[35bcd00]874
[bf61a8b]875        int rtems_shell_rtems_main_extension(
876            int    argc,
877            char **argv
878        );
[8ca13ed]879
[bf61a8b]880    The configuration structure for the ``extension`` has the following prototype:
[8ca13ed]881
[bf61a8b]882    .. code-block:: c
[35bcd00]883
[bf61a8b]884        extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;
[8ca13ed]885
[bf61a8b]886.. raw:: latex
887
888   \clearpage
[8ca13ed]889
[35bcd00]890.. _task:
891
[8ca13ed]892task - display information about tasks
893--------------------------------------
894.. index:: task
895
[bf61a8b]896SYNOPSYS:
897    .. code-block:: shell
[8ca13ed]898
[bf61a8b]899        task [id [id ...]]
[8ca13ed]900
[bf61a8b]901DESCRIPTION:
902    When invoked with no arguments, this command prints information on the set
903    of Classic API Tasks currently active in the system.
[8ca13ed]904
[bf61a8b]905    If invoked with a set of ids as arguments, then just those objects are
906    included in the information printed.
[8ca13ed]907
[bf61a8b]908EXIT STATUS:
909    This command returns 0 on success and non-zero if an error is encountered.
[8ca13ed]910
[bf61a8b]911NOTES:
912    NONE
[8ca13ed]913
[bf61a8b]914EXAMPLES:
915    The following is an example of how to use the ``task`` on an application
916    with just two Classic API tasks:
[8ca13ed]917
[bf61a8b]918    .. code-block:: shell
[8ca13ed]919
[e6cb6b7]920        SHLL [/] # task
[4e85468]921        ID       NAME                 SHED PRI STATE  MODES    EVENTS WAITINFO
[bf61a8b]922        ------------------------------------------------------------------------------
[4e85468]923        0a010001 UI1                  UPD  254 EV     P:T:nA   NONE
924        0a010002 SHLL                 UPD  100 READY  P:T:nA   NONE
[8ca13ed]925
926.. index:: CONFIGURE_SHELL_NO_COMMAND_TASK
927.. index:: CONFIGURE_SHELL_COMMAND_TASK
928
[bf61a8b]929CONFIGURATION:
930    This command is included in the default shell command set.  When building a
931    custom command set, define ``CONFIGURE_SHELL_COMMAND_TASK`` to have this
932    command included.
[8ca13ed]933
[bf61a8b]934    This command can be excluded from the shell command set by defining
935    ``CONFIGURE_SHELL_NO_COMMAND_TASK`` when all shell commands have been
936    configured.
[8ca13ed]937
938.. index:: rtems_shell_rtems_main_task
939
[bf61a8b]940PROGRAMMING INFORMATION:
941    The ``task`` is implemented by a C language function which has the
942    following prototype:
[35bcd00]943
[bf61a8b]944    .. code-block:: shell
[8ca13ed]945
[bf61a8b]946        int rtems_shell_rtems_main_task(
947            int    argc,
948            char **argv
949        );
[8ca13ed]950
[bf61a8b]951    The configuration structure for the ``task`` has the following prototype:
[35bcd00]952
[bf61a8b]953    .. code-block:: c
[8ca13ed]954
[bf61a8b]955        extern rtems_shell_cmd_t rtems_shell_TASK_Command;
956
957.. raw:: latex
958
959   \clearpage
[8ca13ed]960
[35bcd00]961.. _queue:
962
[8ca13ed]963queue - display information about message queues
964------------------------------------------------
965.. index:: queue
966
[bf61a8b]967SYNOPSYS:
968    .. code-block:: shell
[8ca13ed]969
[bf61a8b]970        queue [id [id ... ]]
[8ca13ed]971
[bf61a8b]972DESCRIPTION:
973    When invoked with no arguments, this command prints information on the set
974    of Classic API Message Queues currently active in the system.
[8ca13ed]975
[bf61a8b]976    If invoked with a set of ids as arguments, then just those objects are
977    included in the information printed.
[8ca13ed]978
[bf61a8b]979EXIT STATUS:
980    This command returns 0 on success and non-zero if an error is encountered.
[8ca13ed]981
[bf61a8b]982NOTES:
983    NONE
[8ca13ed]984
[bf61a8b]985EXAMPLES:
986    The following is an example of using the ``queue`` command on a system with
987    no Classic API Message Queues.
[8ca13ed]988
[bf61a8b]989    .. code-block:: shell
[8ca13ed]990
[bf61a8b]991        SHLL [/] $ queue
992        ID       NAME   ATTRIBUTES   PEND   MAXPEND  MAXSIZE
993        ------------------------------------------------------------------------------
[8ca13ed]994
995.. index:: CONFIGURE_SHELL_NO_COMMAND_QUEUE
996.. index:: CONFIGURE_SHELL_COMMAND_QUEUE
997
[bf61a8b]998CONFIGURATION:
999    This command is included in the default shell command set.  When building a
1000    custom command set, define ``CONFIGURE_SHELL_COMMAND_QUEUE`` to have this
1001    command included.
[8ca13ed]1002
[bf61a8b]1003    This command can be excluded from the shell command set by defining
1004    ``CONFIGURE_SHELL_NO_COMMAND_QUEUE`` when all shell commands have been
1005    configured.
[8ca13ed]1006
1007.. index:: rtems_shell_rtems_main_queue
1008
[bf61a8b]1009PROGRAMMING INFORMATION:
1010    The ``queue`` is implemented by a C language function which has the
1011    following prototype:
1012
1013    .. code-block:: c
[35bcd00]1014
[bf61a8b]1015        int rtems_shell_rtems_main_queue(
1016            int    argc,
1017            char **argv
1018        );
[8ca13ed]1019
[bf61a8b]1020    The configuration structure for the ``queue`` has the following prototype:
[8ca13ed]1021
[bf61a8b]1022    .. code-block:: c
[35bcd00]1023
[bf61a8b]1024        extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;
[8ca13ed]1025
[bf61a8b]1026.. raw:: latex
1027
1028   \clearpage
[8ca13ed]1029
[35bcd00]1030.. _sema:
1031
[8ca13ed]1032sema - display information about semaphores
1033-------------------------------------------
1034.. index:: sema
1035
[bf61a8b]1036SYNOPSYS:
1037    .. code-block:: shell
[8ca13ed]1038
[bf61a8b]1039        sema [id [id ... ]]
[8ca13ed]1040
[bf61a8b]1041DESCRIPTION:
1042    When invoked with no arguments, this command prints information on the set
1043    of Classic API Semaphores currently active in the system.
[8ca13ed]1044
[bf61a8b]1045    If invoked with a set of objects ids as arguments, then just those objects
1046    are included in the information printed.
[8ca13ed]1047
[bf61a8b]1048EXIT STATUS:
1049    This command returns 0 on success and non-zero if an error is encountered.
[8ca13ed]1050
[bf61a8b]1051NOTES:
1052    NONE
[8ca13ed]1053
[bf61a8b]1054EXAMPLES:
1055    The following is an example of how to use ``sema``:
[8ca13ed]1056
[bf61a8b]1057    .. code-block:: shell
[35bcd00]1058
[bf61a8b]1059        SHLL [/] $ sema
1060        ID       NAME   ATTR        PRICEIL CURR_CNT HOLDID
1061        ------------------------------------------------------------------------------
1062        1a010001   LBIO   PR:BI:IN      0        1     00000000
1063        1a010002   TRmi   PR:BI:IN      0        1     00000000
1064        1a010003   LBI00  PR:BI:IN      0        1     00000000
1065        1a010004   TRia   PR:BI:IN      0        1     00000000
1066        1a010005   TRoa   PR:BI:IN      0        1     00000000
1067        1a010006   TRxa   <assoc.c: BAD NAME>   0    0 09010001
1068        1a010007   LBI01  PR:BI:IN      0        1     00000000
1069        1a010008   LBI02  PR:BI:IN      0        1     00000000
[8ca13ed]1070
1071.. index:: CONFIGURE_SHELL_NO_COMMAND_SEMA
1072.. index:: CONFIGURE_SHELL_COMMAND_SEMA
1073
[bf61a8b]1074CONFIGURATION:
1075    This command is included in the default shell command set.  When building a
1076    custom command set, define ``CONFIGURE_SHELL_COMMAND_SEMA`` to have this
1077    command included.
[8ca13ed]1078
[bf61a8b]1079    This command can be excluded from the shell command set by defining
1080    ``CONFIGURE_SHELL_NO_COMMAND_SEMA`` when all shell commands have been
1081    configured.
[8ca13ed]1082
1083.. index:: rtems_shell_rtems_main_sema
1084
[bf61a8b]1085PROGRAMMING INFORMATION:
1086    The ``sema`` is implemented by a C language function which has the following
1087    prototype:
1088
1089    .. code-block:: c
[35bcd00]1090
[bf61a8b]1091        int rtems_shell_rtems_main_sema(
1092            int    argc,
1093            char **argv
1094        );
[8ca13ed]1095
[bf61a8b]1096    The configuration structure for the ``sema`` has the following prototype:
[8ca13ed]1097
[bf61a8b]1098    .. code-block:: c
[35bcd00]1099
[bf61a8b]1100        extern rtems_shell_cmd_t rtems_shell_SEMA_Command;
[8ca13ed]1101
[bf61a8b]1102.. raw:: latex
1103
1104   \clearpage
[8ca13ed]1105
[35bcd00]1106.. _region:
1107
[8ca13ed]1108region - display information about regions
1109------------------------------------------
1110.. index:: region
1111
[bf61a8b]1112SYNOPSYS:
1113    .. code-block:: shell
[8ca13ed]1114
[bf61a8b]1115        region [id [id ... ]]
[8ca13ed]1116
[bf61a8b]1117DESCRIPTION:
1118    When invoked with no arguments, this command prints information on the set
1119    of Classic API Regions currently active in the system.
[8ca13ed]1120
[bf61a8b]1121    If invoked with a set of object ids as arguments, then just those object
1122    are included in the information printed.
[8ca13ed]1123
[bf61a8b]1124EXIT STATUS:
1125    This command returns 0 on success and non-zero if an error is encountered.
[8ca13ed]1126
[bf61a8b]1127NOTES:
1128    NONE
[8ca13ed]1129
[bf61a8b]1130EXAMPLES:
1131    The following is an example of using the ``region`` command on a system
1132    with no user extensions.
[8ca13ed]1133
[bf61a8b]1134    .. code-block:: shell
[8ca13ed]1135
[bf61a8b]1136        SHLL [/] $ region
1137        ID       NAME   ATTR        STARTADDR LENGTH    PAGE_SIZE USED_BLOCKS
1138        ------------------------------------------------------------------------------
[8ca13ed]1139
1140.. index:: CONFIGURE_SHELL_NO_COMMAND_REGION
1141.. index:: CONFIGURE_SHELL_COMMAND_REGION
1142
[bf61a8b]1143CONFIGURATION:
1144    This command is included in the default shell command set.  When building a
1145    custom command set, define ``CONFIGURE_SHELL_COMMAND_REGION`` to have this
1146    command included.
[8ca13ed]1147
[bf61a8b]1148    This command can be excluded from the shell command set by defining
1149    ``CONFIGURE_SHELL_NO_COMMAND_REGION`` when all shell commands have been
1150    configured.
[8ca13ed]1151
1152.. index:: rtems_shell_rtems_main_region
1153
[bf61a8b]1154PROGRAMMING INFORMATION:
1155    The ``region`` is implemented by a C language function which has the
1156    following prototype:
1157
1158    .. code-block:: c
1159
1160        int rtems_shell_rtems_main_region(
1161            int    argc,
1162            char **argv
1163        );
[35bcd00]1164
[bf61a8b]1165    The configuration structure for the ``region`` has the following prototype:
[8ca13ed]1166
[bf61a8b]1167    .. code-block:: c
[8ca13ed]1168
[bf61a8b]1169        extern rtems_shell_cmd_t rtems_shell_REGION_Command;
[35bcd00]1170
[bf61a8b]1171.. raw:: latex
[8ca13ed]1172
[bf61a8b]1173   \clearpage
[8ca13ed]1174
[35bcd00]1175.. _part:
1176
[8ca13ed]1177part - display information about partitions
1178-------------------------------------------
1179.. index:: part
1180
[bf61a8b]1181SYNOPSYS:
1182    .. code-block:: shell
[8ca13ed]1183
[bf61a8b]1184        part [id [id ... ]]
[8ca13ed]1185
[bf61a8b]1186DESCRIPTION:
1187    When invoked with no arguments, this command prints information on the set
1188    of Classic API Partitions currently active in the system.
[8ca13ed]1189
[bf61a8b]1190    If invoked with a set of object ids as arguments, then just those objects
1191    are included in the information printed.
[8ca13ed]1192
[bf61a8b]1193EXIT STATUS:
1194    This command returns 0 on success and non-zero if an error is encountered.
[8ca13ed]1195
[bf61a8b]1196NOTES:
1197    NONE
[8ca13ed]1198
[bf61a8b]1199EXAMPLES:
1200    The following is an example of using the ``part`` command on a system with
1201    no user extensions.
[8ca13ed]1202
[bf61a8b]1203    .. code-block:: shell
[8ca13ed]1204
[bf61a8b]1205        SHLL [/] $ part
1206        ID       NAME   ATTR        STARTADDR LENGTH    BUF_SIZE  USED_BLOCKS
1207        ------------------------------------------------------------------------------
[8ca13ed]1208
1209.. index:: CONFIGURE_SHELL_NO_COMMAND_PART
1210.. index:: CONFIGURE_SHELL_COMMAND_PART
1211
[bf61a8b]1212CONFIGURATION:
1213    This command is included in the default shell command set.  When building a
1214    custom command set, define ``CONFIGURE_SHELL_COMMAND_PART`` to have this
1215    command included.
[8ca13ed]1216
[bf61a8b]1217    This command can be excluded from the shell command set by defining
1218    ``CONFIGURE_SHELL_NO_COMMAND_PART`` when all shell commands have been
1219    configured.
[8ca13ed]1220
1221.. index:: rtems_shell_rtems_main_part
1222
[bf61a8b]1223PROGRAMMING INFORMATION:
1224    The ``part`` is implemented by a C language function which has the
1225    following prototype:
1226
1227    .. code-block:: c
[35bcd00]1228
[bf61a8b]1229        int rtems_shell_rtems_main_part(
1230            int    argc,
1231            char **argv
1232        );
[8ca13ed]1233
[bf61a8b]1234    The configuration structure for the ``part`` has the following prototype:
[8ca13ed]1235
[bf61a8b]1236    .. code-block:: c
[35bcd00]1237
[bf61a8b]1238        extern rtems_shell_cmd_t rtems_shell_PART_Command;
[8ca13ed]1239
[bf61a8b]1240.. raw:: latex
1241
1242   \clearpage
[8ca13ed]1243
[35bcd00]1244.. _object:
1245
[a1c7180]1246object - display information about RTEMS objects
[8ca13ed]1247------------------------------------------------
1248.. index:: object
1249
[bf61a8b]1250SYNOPSYS:
1251    .. code-block:: shell
[8ca13ed]1252
[bf61a8b]1253        object [id [id ...]]
[8ca13ed]1254
[bf61a8b]1255DESCRIPTION:
1256    When invoked with a set of object ids as arguments, then a report on those
1257    objects is printed.
[8ca13ed]1258
[bf61a8b]1259EXIT STATUS:
1260    This command returns 0 on success and non-zero if an error is encountered.
[8ca13ed]1261
[bf61a8b]1262NOTES:
1263    NONE
[8ca13ed]1264
[bf61a8b]1265EXAMPLES:
1266    The following is an example of how to use ``object``:
[8ca13ed]1267
[bf61a8b]1268    .. code-block:: shell
[8ca13ed]1269
[bf61a8b]1270        SHLL [/] $ object 0a010001 1a010002
1271        ID       NAME   PRIO   STAT   MODES  EVENTS   WAITID  WAITARG  NOTES
1272        ------------------------------------------------------------------------------
1273        0a010001   UI1      1   SUSP   P:T:nA  NONE
1274        ID       NAME   ATTR        PRICEIL CURR_CNT HOLDID
1275        ------------------------------------------------------------------------------
1276        1a010002   TRmi   PR:BI:IN      0        1     00000000
[8ca13ed]1277
1278.. index:: CONFIGURE_SHELL_NO_COMMAND_OBJECT
1279.. index:: CONFIGURE_SHELL_COMMAND_OBJECT
1280
[bf61a8b]1281CONFIGURATION:
1282    This command is included in the default shell command set.  When building a
1283    custom command set, define ``CONFIGURE_SHELL_COMMAND_OBJECT`` to have this
1284    command included.
[8ca13ed]1285
[bf61a8b]1286    This command can be excluded from the shell command set by defining
1287    ``CONFIGURE_SHELL_NO_COMMAND_OBJECT`` when all shell commands have been
1288    configured.
[8ca13ed]1289
1290.. index:: rtems_shell_rtems_main_object
1291
[bf61a8b]1292PROGRAMMING INFORMATION:
1293    The ``object`` is implemented by a C language function which has the
1294    following prototype:
1295
1296    .. code-block:: c
1297
1298        int rtems_shell_rtems_main_object(
1299            int    argc,
1300            char **argv
1301        );
[35bcd00]1302
[bf61a8b]1303    The configuration structure for the ``object`` has the
1304    following prototype:
[8ca13ed]1305
[bf61a8b]1306    .. code-block:: c
[8ca13ed]1307
[bf61a8b]1308        extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;
[35bcd00]1309
[bf61a8b]1310.. raw:: latex
[8ca13ed]1311
[bf61a8b]1312   \clearpage
[8ca13ed]1313
[35bcd00]1314.. _driver:
1315
[a1c7180]1316driver - display the RTEMS device driver table
[8ca13ed]1317----------------------------------------------
1318.. index:: driver
1319
[bf61a8b]1320SYNOPSYS:
1321    .. code-block:: shell
[8ca13ed]1322
[bf61a8b]1323        driver [major [major ...]]
[8ca13ed]1324
[bf61a8b]1325DESCRIPTION:
1326    When invoked with no arguments, this command prints information on the set
1327    of Device Drivers currently active in the system.
[8ca13ed]1328
[bf61a8b]1329    If invoked with a set of major numbers as arguments, then just those Device
1330    Drivers are included in the information printed.
[8ca13ed]1331
[bf61a8b]1332EXIT STATUS:
1333    This command returns 0 on success and non-zero if an error is encountered.
[8ca13ed]1334
[bf61a8b]1335NOTES:
1336    NONE
[8ca13ed]1337
[bf61a8b]1338EXAMPLES:
1339    The following is an example of how to use ``driver``:
[8ca13ed]1340
[bf61a8b]1341    .. code-block:: shell
[35bcd00]1342
[bf61a8b]1343        SHLL [/] $ driver
1344        Major      Entry points
1345        ------------------------------------------------------------------------------
1346        0          init: [0x200256c];  control: [0x20024c8]
1347        open: [0x2002518];  close: [0x2002504]
1348        read: [0x20024f0];  write: [0x20024dc]
1349        1          init: [0x20023fc];  control: [0x2002448]
1350        open: [0x0];  close: [0x0]
1351        read: [0x0];  write: [0x0]
1352        SHLL [/] $
[8ca13ed]1353
1354.. index:: CONFIGURE_SHELL_NO_COMMAND_DRIVER
1355.. index:: CONFIGURE_SHELL_COMMAND_DRIVER
1356
[bf61a8b]1357CONFIGURATION:
1358    This command is included in the default shell command set.  When building a
1359    custom command set, define ``CONFIGURE_SHELL_COMMAND_DRIVER`` to have this
1360    command included.
[8ca13ed]1361
[bf61a8b]1362    This command can be excluded from the shell command set by defining
1363    ``CONFIGURE_SHELL_NO_COMMAND_DRIVER`` when all shell commands have been
1364    configured.
[8ca13ed]1365
1366.. index:: rtems_shell_rtems_main_driver
1367
[bf61a8b]1368PROGRAMMING INFORMATION:
1369    The ``driver`` is implemented by a C language function which has the
1370    following prototype:
1371
1372    .. code-block:: c
[35bcd00]1373
[bf61a8b]1374        int rtems_shell_rtems_main_driver(
1375            int    argc,
1376            char **argv
1377        );
[8ca13ed]1378
[bf61a8b]1379    The configuration structure for the ``driver`` has the following prototype:
[8ca13ed]1380
[bf61a8b]1381    .. code-block:: c
[35bcd00]1382
[bf61a8b]1383        extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;
[8ca13ed]1384
[bf61a8b]1385.. raw:: latex
1386
1387   \clearpage
[8ca13ed]1388
[35bcd00]1389.. _dname:
1390
[8ca13ed]1391dname - displays information about named drivers
1392------------------------------------------------
1393.. index:: dname
1394
[bf61a8b]1395SYNOPSYS:
1396    .. code-block:: shell
[8ca13ed]1397
[bf61a8b]1398        dname
[8ca13ed]1399
[bf61a8b]1400DESCRIPTION:
1401    WARNING! This command does not appear to work as of 27 February 2008.
[8ca13ed]1402
[bf61a8b]1403EXIT STATUS:
1404    This command returns 0 on success and non-zero if an error is encountered.
[8ca13ed]1405
[bf61a8b]1406NOTES:
1407    NONE
[35bcd00]1408
[bf61a8b]1409EXAMPLES:
1410    The following is an example of how to use ``dname``:
[8ca13ed]1411
[bf61a8b]1412    .. code-block:: shell
[8ca13ed]1413
[bf61a8b]1414        EXAMPLE_TBD
[8ca13ed]1415
1416.. index:: CONFIGURE_SHELL_NO_COMMAND_DNAME
1417.. index:: CONFIGURE_SHELL_COMMAND_DNAME
1418
[bf61a8b]1419CONFIGURATION:
1420    This command is included in the default shell command set.  When building a
1421    custom command set, define ``CONFIGURE_SHELL_COMMAND_DNAME`` to have this
1422    command included.
[8ca13ed]1423
[bf61a8b]1424    This command can be excluded from the shell command set by defining
1425    ``CONFIGURE_SHELL_NO_COMMAND_DNAME`` when all shell commands have been
1426    configured.
[8ca13ed]1427
1428.. index:: rtems_shell_rtems_main_dname
1429
[bf61a8b]1430PROGRAMMING INFORMATION:
1431    The ``dname`` is implemented by a C language function which has the
1432    following prototype:
1433
1434    .. code-block:: c
1435
1436        int rtems_shell_rtems_main_dname(
1437            int    argc,
1438            char **argv
1439        );
[35bcd00]1440
[bf61a8b]1441    The configuration structure for the ``dname`` has the following prototype:
[8ca13ed]1442
[bf61a8b]1443    .. code-block:: c
[8ca13ed]1444
[bf61a8b]1445        extern rtems_shell_cmd_t rtems_shell_DNAME_Command;
[35bcd00]1446
[bf61a8b]1447.. raw:: latex
[8ca13ed]1448
[bf61a8b]1449   \clearpage
[8ca13ed]1450
[35bcd00]1451.. _pthread:
1452
[8ca13ed]1453pthread - display information about POSIX threads
1454-------------------------------------------------
1455.. index:: pthread
1456
[bf61a8b]1457SYNOPSYS:
1458    .. code-block:: shell
[8ca13ed]1459
[bf61a8b]1460        pthread [id [id ...]]
[8ca13ed]1461
[bf61a8b]1462DESCRIPTION:
1463    When invoked with no arguments, this command prints information on the set
1464    of POSIX API threads currently active in the system.
[8ca13ed]1465
[bf61a8b]1466    If invoked with a set of ids as arguments, then just those objects are
1467    included in the information printed.
[8ca13ed]1468
[bf61a8b]1469EXIT STATUS:
1470    This command returns 0 on success and non-zero if an error is encountered.
[35bcd00]1471
[bf61a8b]1472NOTES:
1473    This command is only available when the POSIX API is configured.
[8ca13ed]1474
[bf61a8b]1475EXAMPLES:
1476    The following is an example of how to use the ``task`` on an application
1477    with four POSIX threads:
[8ca13ed]1478
[bf61a8b]1479    .. code-block:: shell
[8ca13ed]1480
[bf61a8b]1481        SHLL [/] $ pthread
1482        ID       NAME           PRI  STATE MODES   EVENTS    WAITID  WAITARG  NOTES
1483        ------------------------------------------------------------------------------
1484        0b010002   Main           133 READY  P:T:nA    NONE   43010001 0x7b1148
1485        0b010003   ISR            133 Wcvar  P:T:nA    NONE   43010003 0x7b1148
1486        0b01000c                  133 READY  P:T:nA    NONE   33010002 0x7b1148
1487        0b01000d                  133 Wmutex P:T:nA    NONE   33010002 0x7b1148
[8ca13ed]1488
[bf61a8b]1489CONFIGURATION:
1490    This command is part of the monitor commands which are always available in
1491    the shell.
[8ca13ed]1492
[bf61a8b]1493PROGRAMMING INFORMATION:
1494    This command is not directly available for invocation.
Note: See TracBrowser for help on using the repository browser.