summaryrefslogtreecommitdiffstats
path: root/shell/rtems_specific_commands.rst
blob: 127e52435e27ff2d155d68b044c7f5bc67ffe81e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
.. comment SPDX-License-Identifier: CC-BY-SA-4.0

.. COMMENT: COPYRIGHT (c) 1988-2008.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.

RTEMS Specific Commands
***********************

Introduction
============

The RTEMS shell has the following RTEMS specific commands:

- shutdown_ - Shutdown the system

- cpuinfo_ - print per-processor information

- cpuuse_ - print or reset per thread cpu usage

- stackuse_ - print per thread stack usage

- perioduse_ - print or reset per period usage

- profreport_ - print a profiling report

- wkspace_ - Display information on Executive Workspace

- config_ - Show the system configuration.

- itask_ - List init tasks for the system

- extension_ - Display information about extensions

- task_ - Display information about tasks

- queue_ - Display information about message queues

- sema_ - display information about semaphores

- region_ - display information about regions

- part_ - display information about partitions

- object_ - Display information about RTEMS objects

- driver_ - Display the RTEMS device driver table

- dname_ - Displays information about named drivers

- pthread_ - Displays information about POSIX threads

Commands
========

This section details the RTEMS Specific Commands available.  A subsection is
dedicated to each of the commands and describes the behavior and configuration
of that command as well as providing an example usage.

.. raw:: latex

   \clearpage

.. _shutdown:

shutdown - Shutdown the system
------------------------------
.. index:: shutdown

SYNOPSYS:
    .. code-block:: shell

        shutdown

DESCRIPTION:
    This command is used to shutdown the RTEMS application.

EXIT STATUS:
    This command does not return.

NOTES:
    NONE

EXAMPLES:
    The following is an example of how to use ``shutdown``:

    .. code-block:: shell

        SHLL [/] $ shutdown
        System shutting down at user request

    The user will not see another prompt and the system will shutdown.

.. index:: CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN
.. index:: CONFIGURE_SHELL_COMMAND_SHUTDOWN

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_SHUTDOWN`` to have
    this command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_SHUTDOWN`` when all shell commands have been
    configured.

PROGRAMMING INFORMATION:
    The configuration structure for the ``shutdown`` has the following
    prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_SHUTDOWN_Command;

.. raw:: latex

   \clearpage

.. _cpuinfo:

cpuinfo - print per-processor information
--------------------------------------------
.. index:: cpuinfo

SYNOPSYS:
    .. code-block:: shell

        cpuinfo

DESCRIPTION:
    This command may be used to print per-processor information.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

EXAMPLES:
    The following is an example of how to use ``cpuinfo``:

    .. code-block:: shell

        SHLL [/] $ cpuinfo
        -------------------------------------------------------------------------------
                                    PER PROCESSOR INFORMATION
        -------+--------+--------------+-----------------------------------------------
         INDEX | ONLINE | SCHEDULER ID | SCHEDULER NAME
        -------+--------+--------------+-----------------------------------------------
             0 |      1 |   0x0f010001 | UPD

    In the above example, the system has only one processor.  This processor
    has the index zero and is online.  It is owned by the scheduler with the
    identifier ``0x0f010001`` and name ``UPD``.

.. index:: CONFIGURE_SHELL_NO_COMMAND_CPUINFO
.. index:: CONFIGURE_SHELL_COMMAND_CPUINFO

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_CPUINFO`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_CPUINFO`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_cpuinfo

PROGRAMMING INFORMATION:
    The ``cpuinfo`` is implemented by a C language function which has the following
    prototype:

    .. code-block:: c

        int rtems_cpu_info_report(
            const rtems_printer *printer
        );

    The configuration structure for the ``cpuinfo`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_CPUINFO_Command;

.. raw:: latex

   \clearpage

.. _cpuuse:

cpuuse - print or reset per thread cpu usage
--------------------------------------------
.. index:: cpuuse

SYNOPSYS:
    .. code-block:: shell

        cpuuse [-r]

DESCRIPTION:
    This command may be used to print a report on the per thread cpu usage or
    to reset the per thread CPU usage statistics. When invoked with the ``-r``
    option, the CPU usage statistics are reset.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    The granularity of the timing information reported is dependent upon the
    BSP and the manner in which RTEMS was built.  In the default RTEMS
    configuration, if the BSP supports nanosecond granularity timestamps, then
    the information reported will be highly accurate. Otherwise, the accuracy
    of the information reported is limited by the clock tick quantum.

EXAMPLES:
    The following is an example of how to use ``cpuuse``:

    .. code-block:: shell

        [/] cpuuse
        -------------------------------------------------------------------------------
                                      CPU USAGE BY THREAD
        ------------+----------------------------------------+---------------+---------
         ID         | NAME                                   | SECONDS       | PERCENT
        ------------+----------------------------------------+---------------+---------
         0x09010001 | IDLE                                   |     11.444381 |  73.938
         0x0a010001 | UI1                                    |      0.206754 |   1.335
         0x0a010002 | BSWP                                   |      0.008277 |   0.053
         0x0a010003 | BRDA                                   |      0.000952 |   0.006
         0x0a010004 | MDIA                                   |      0.000334 |   0.002
         0x0a010005 | TIME                                   |      0.912809 |   5.895
         0x0a010006 | IRQS                                   |      0.004810 |   0.031
         0x0a010007 | swi1: netisr 0                         |      0.002593 |   0.016
         0x0a010008 | kqueue_ctx task                        |      0.000663 |   0.004
         0x0a010009 | swi5: fast task                        |      0.000059 |   0.000
         0x0a01000a | thread taskq                           |      0.000057 |   0.000
         0x0a01000b | swi6: task queu                        |      0.003063 |   0.019
         0x0a01000c | DHCP                                   |      1.391745 |   8.986
         0x0a01000d | FTPa                                   |      0.002203 |   0.014
         0x0a01000e | FTPb                                   |      0.000233 |   0.001
         0x0a01000f | FTPc                                   |      0.000226 |   0.001
         0x0a010010 | FTPd                                   |      0.000228 |   0.001
         0x0a010011 | FTPD                                   |      0.002959 |   0.019
         0x0a010012 | TNTD                                   |      0.001111 |   0.007
         0x0a010013 | SHLL                                   |      1.508445 |   9.736
        ------------+----------------------------------------+---------------+---------
         TIME SINCE LAST CPU USAGE RESET IN SECONDS:                         15.492171
        -------------------------------------------------------------------------------
        [/] # cpuuse -r
        Resetting CPU Usage information
        [/] # cpuuse
        -------------------------------------------------------------------------------
                                      CPU USAGE BY THREAD
        ------------+----------------------------------------+---------------+---------
         ID         | NAME                                   | SECONDS       | PERCENT
        ------------+----------------------------------------+---------------+---------
         0x09010001 | IDLE                                   |      0.000000 |   0.000
         0x0a010001 | UI1                                    |      0.000000 |   0.000
         0x0a010002 | BSWP                                   |      0.000000 |   0.000
         0x0a010003 | BRDA                                   |      0.000000 |   0.000
         0x0a010004 | MDIA                                   |      0.000000 |   0.000
         0x0a010005 | TIME                                   |      0.000000 |   0.000
         0x0a010006 | IRQS                                   |      0.000000 |   0.000
         0x0a010007 | swi1: netisr 0                         |      0.000000 |   0.000
         0x0a010008 | kqueue_ctx task                        |      0.000000 |   0.000
         0x0a010009 | swi5: fast task                        |      0.000000 |   0.000
         0x0a01000a | thread taskq                           |      0.000000 |   0.000
         0x0a01000b | swi6: task queu                        |      0.000000 |   0.000
         0x0a01000c | DHCP                                   |      0.000000 |   0.000
         0x0a01000d | FTPa                                   |      0.000000 |   0.000
         0x0a01000e | FTPb                                   |      0.000000 |   0.000
         0x0a01000f | FTPc                                   |      0.000000 |   0.000
         0x0a010010 | FTPd                                   |      0.000000 |   0.000
         0x0a010011 | FTPD                                   |      0.000000 |   0.000
         0x0a010012 | TNTD                                   |      0.000000 |   0.000
         0x0a010013 | SHLL                                   |      0.016503 |  99.962
        ------------+----------------------------------------+---------------+---------
         TIME SINCE LAST CPU USAGE RESET IN SECONDS:                          0.016509
        -------------------------------------------------------------------------------

    In the above example, the system did something for roughly 15 seconds when the
    first report was generated.  The ``cpuuse -r`` and ``cpuuse`` commands were
    pasted from another window so were executed with no gap between.  In the
    second report, only the ``SHLL`` thread has run since the CPU Usage was
    reset.  It has consumed approximately 16.509 milliseconds of CPU time
    processing the two commands and generating the output.

.. index:: CONFIGURE_SHELL_NO_COMMAND_CPUUSE
.. index:: CONFIGURE_SHELL_COMMAND_CPUUSE

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_CPUUSE`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_CPUUSE`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_cpuuse

PROGRAMMING INFORMATION:
    The ``cpuuse`` is implemented by a C language function which has the following
    prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_cpuuse(
           int    argc,
           char **argv
        );

    The configuration structure for the ``cpuuse`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_CPUUSE_Command;

.. raw:: latex

   \clearpage

.. _stackuse:

stackuse - print per thread stack usage
---------------------------------------
.. index:: stackuse

SYNOPSYS:
    .. code-block:: shell

        stackuse

DESCRIPTION:
    This command prints a Stack Usage Report for all of the tasks and threads
    in the system.  On systems which support it, the usage of the interrupt
    stack is also included in the report.

EXIT STATUS:
    This command always succeeds and returns 0.

NOTES:
    The ``CONFIGURE_STACK_CHECKER_ENABLED`` ``confdefs.h`` constant must be
    defined when the application is configured for this command to have any
    information to report.

EXAMPLES:
    The following is an example of how to use ``stackuse``:

    .. code-block:: shell

        [/] # stackuse
                                     STACK USAGE BY THREAD
        ID         NAME                  LOW        HIGH       CURRENT    AVAIL  USED
        0x09010001 IDLE                  0x03559960 0x03564055 0x03563728   4080    584
        0x0a010001 UI1                   0x03564664 0x03597431 0x03596976  32752   4168
        0x0a010002 BSWP                  0x03714576 0x03718671 0x03718408   4080    564
        0x0a010003 BRDA                  0x03718680 0x03722775 0x03722480   4080    596
        0x0a010004 MDIA                  0x03722808 0x03755575 0x03755288  32752    588
        0x0a010005 TIME                  0x03755664 0x03788431 0x03788168  32752   1448
        0x0a010006 IRQS                  0x03788440 0x03821207 0x03820952  32752    608
        0x0a010007 swi1: netisr 0        0x03896880 0x03929647 0x03929376  32752    820
        0x0a010008 kqueue_ctx task       0x03929872 0x03962639 0x03962392  32752    580
        0x0a010009 swi5: fast task       0x03963088 0x03995855 0x03995584  32752    572
        0x0a01000a thread taskq          0x03996080 0x04028847 0x04028600  32752    548
        0x0a01000b swi6: task queu       0x04029296 0x04062063 0x04061792  32752   1364
        0x0a01000c DHCP                  0x04250192 0x04258383 0x04257288   8176   2764
        0x0a01000d FTPa                  0x04258792 0x04266983 0x04265792   8176   1548
        0x0a01000e FTPb                  0x04267120 0x04275311 0x04274120   8176   1496
        0x0a01000f FTPc                  0x04275448 0x04283639 0x04282448   8176   1496
        0x0a010010 FTPd                  0x04283776 0x04291967 0x04290776   8176   1496
        0x0a010011 FTPD                  0x04292104 0x04296199 0x04295784   4080    772
        0x0a010012 TNTD                  0x04297088 0x04329855 0x04329368  32752    804
        0x0a010013 SHLL                  0x04329976 0x04346359 0x04344576  16368   3616

.. index:: CONFIGURE_SHELL_NO_COMMAND_STACKUSE
.. index:: CONFIGURE_SHELL_COMMAND_STACKUSE

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_STACKUSE`` to have
    this command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_STACKUSE`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_stackuse

PROGRAMMING INFORMATION:
    The ``stackuse`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_stackuse(
            int    argc,
            char **argv
        );

    The configuration structure for the ``stackuse`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;

.. raw:: latex

   \clearpage

.. _perioduse:

perioduse - print or reset per period usage
-------------------------------------------
.. index:: perioduse

SYNOPSYS:
    .. code-block:: shell

        perioduse [-r]

DESCRIPTION:
    This command may be used to print a statistics report on the rate monotonic
    periods in the application or to reset the rate monotonic period usage
    statistics. When invoked with the ``-r`` option, the usage statistics are
    reset.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    The granularity of the timing information reported is dependent upon the
    BSP and the manner in which RTEMS was built.  In the default RTEMS
    configuration, if the BSP supports nanosecond granularity timestamps, then
    the information reported will be highly accurate. Otherwise, the accuracy
    of the information reported is limited by the clock tick quantum.

EXAMPLES:
    The following is an example of how to use ``perioduse``:

    .. code-block:: shell

        SHLL [/] $ perioduse
        Period information by period
        --- CPU times are in seconds ---
        --- Wall times are in seconds ---
        ID     OWNER COUNT MISSED          CPU TIME                  WALL TIME
        MIN/MAX/AVG                MIN/MAX/AVG
        0x42010001 TA1    502      0 0:000039/0:042650/0:004158 0:000039/0:020118/0:002848
        0x42010002 TA2    502      0 0:000041/0:042657/0:004309 0:000041/0:020116/0:002848
        0x42010003 TA3    501      0 0:000041/0:041564/0:003653 0:000041/0:020003/0:002814
        0x42010004 TA4    501      0 0:000043/0:044075/0:004911 0:000043/0:020004/0:002814
        0x42010005 TA5     10      0 0:000065/0:005413/0:002739 0:000065/1:000457/0:041058
        MIN/MAX/AVG                MIN/MAX/AVG
        SHLL [/] $ perioduse -r
        Resetting Period Usage information
        SHLL [/] $ perioduse
        --- CPU times are in seconds ---
        --- Wall times are in seconds ---
        ID     OWNER COUNT MISSED          CPU TIME                  WALL TIME
        MIN/MAX/AVG                MIN/MAX/AVG
        0x42010001 TA1      0      0
        0x42010002 TA2      0      0
        0x42010003 TA3      0      0
        0x42010004 TA4      0      0
        0x42010005 TA5      0      0

.. index:: CONFIGURE_SHELL_NO_COMMAND_PERIODUSE
.. index:: CONFIGURE_SHELL_COMMAND_PERIODUSE

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_PERIODUSE`` to have
    this command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_PERIODUSE`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_perioduse

PROGRAMMING INFORMATION:
    The ``perioduse`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_perioduse(
            int    argc,
            char **argv
        );

    The configuration structure for the ``perioduse`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_PERIODUSE_Command;

.. raw:: latex

   \clearpage

.. _profreport:

profreport - print a profiling report
-------------------------------------
.. index:: profreport

SYNOPSYS:
    .. code-block:: shell

        profreport

DESCRIPTION:
    This command may be used to print a profiling report if profiling is built
    into the RTEMS kernel.

EXIT STATUS:
    This command returns 0.

NOTES:
    Profiling must be enabled at build configuration time to get profiling
    information.

EXAMPLES:
    The following is an example of how to use ``profreport``:

    .. code-block:: shell

        SHLL [/] $ profreport
        <ProfilingReport name="Shell">
        <PerCPUProfilingReport processorIndex="0">
        <MaxThreadDispatchDisabledTime unit="ns">10447</MaxThreadDispatchDisabledTime>
        <MeanThreadDispatchDisabledTime unit="ns">2</MeanThreadDispatchDisabledTime>
        <TotalThreadDispatchDisabledTime unit="ns">195926627</TotalThreadDispatchDisabledTime>
        <ThreadDispatchDisabledCount>77908688</ThreadDispatchDisabledCount>
        <MaxInterruptDelay unit="ns">0</MaxInterruptDelay>
        <MaxInterruptTime unit="ns">688</MaxInterruptTime>
        <MeanInterruptTime unit="ns">127</MeanInterruptTime>
        <TotalInterruptTime unit="ns">282651157</TotalInterruptTime>
        <InterruptCount>2215855</InterruptCount>
        </PerCPUProfilingReport>
        <PerCPUProfilingReport processorIndex="1">
        <MaxThreadDispatchDisabledTime unit="ns">9053</MaxThreadDispatchDisabledTime>
        <MeanThreadDispatchDisabledTime unit="ns">41</MeanThreadDispatchDisabledTime>
        <TotalThreadDispatchDisabledTime unit="ns">3053830335</TotalThreadDispatchDisabledTime>
        <ThreadDispatchDisabledCount>73334202</ThreadDispatchDisabledCount>
        <MaxInterruptDelay unit="ns">0</MaxInterruptDelay>
        <MaxInterruptTime unit="ns">57</MaxInterruptTime>
        <MeanInterruptTime unit="ns">35</MeanInterruptTime>
        <TotalInterruptTime unit="ns">76980203</TotalInterruptTime>
        <InterruptCount>2141179</InterruptCount>
        </PerCPUProfilingReport>
        <SMPLockProfilingReport name="SMP lock stats">
        <MaxAcquireTime unit="ns">608</MaxAcquireTime>
        <MaxSectionTime unit="ns">1387</MaxSectionTime>
        <MeanAcquireTime unit="ns">112</MeanAcquireTime>
        <MeanSectionTime unit="ns">338</MeanSectionTime>
        <TotalAcquireTime unit="ns">119031</TotalAcquireTime>
        <TotalSectionTime unit="ns">357222</TotalSectionTime>
        <UsageCount>1055</UsageCount>
        <ContentionCount initialQueueLength="0">1055</ContentionCount>
        <ContentionCount initialQueueLength="1">0</ContentionCount>
        <ContentionCount initialQueueLength="2">0</ContentionCount>
        <ContentionCount initialQueueLength="3">0</ContentionCount>
        </SMPLockProfilingReport>
        <SMPLockProfilingReport name="Giant">
        <MaxAcquireTime unit="ns">4186</MaxAcquireTime>
        <MaxSectionTime unit="ns">7575</MaxSectionTime>
        <MeanAcquireTime unit="ns">160</MeanAcquireTime>
        <MeanSectionTime unit="ns">183</MeanSectionTime>
        <TotalAcquireTime unit="ns">1772793111</TotalAcquireTime>
        <TotalSectionTime unit="ns">2029733879</TotalSectionTime>
        <UsageCount>11039140</UsageCount>
        <ContentionCount initialQueueLength="0">11037655</ContentionCount>
        <ContentionCount initialQueueLength="1">1485</ContentionCount>
        <ContentionCount initialQueueLength="2">0</ContentionCount>
        <ContentionCount initialQueueLength="3">0</ContentionCount>
        </SMPLockProfilingReport>
        </ProfilingReport>

.. index:: CONFIGURE_SHELL_NO_COMMAND_PROFREPORT
.. index:: CONFIGURE_SHELL_COMMAND_PROFREPORT

CONFIGURATION:
    When building a custom command set, define
    ``CONFIGURE_SHELL_COMMAND_PROFREPORT`` to have this command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_PROFREPORT`` when all shell commands have been
    configured.

PROGRAMMING INFORMATION:
    The configuration structure for the ``profreport`` has the following
    prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_PROFREPORT_Command;

.. raw:: latex

   \clearpage

.. _wkspace:

wkspace - display information on executive workspace
----------------------------------------------------
.. index:: wkspace

SYNOPSYS:
    .. code-block:: shell

        wkspace

DESCRIPTION:
    This command prints information on the current state of the RTEMS Executive
    Workspace reported.  This includes the following information:

    - Number of free blocks

    - Largest free block

    - Total bytes free

    - Number of used blocks

    - Largest used block

    - Total bytes used

EXIT STATUS:
    This command always succeeds and returns 0.

NOTES:
    NONE

EXAMPLES:
    The following is an example of how to use ``wkspace``:

    .. code-block:: shell

        SHLL [/] $ wkspace
        Number of free blocks: 1
        Largest free block:    132336
        Total bytes free:      132336
        Number of used blocks: 36
        Largest used block:    16408
        Total bytes used:      55344

.. index:: CONFIGURE_SHELL_NO_COMMAND_WKSPACE
.. index:: CONFIGURE_SHELL_COMMAND_WKSPACE

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_WKSPACE`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_WKSPACE`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_wkspace

PROGRAMMING INFORMATION:
    The ``wkspace`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_wkspace(
            int    argc,
            char **argv
        );

    The configuration structure for the ``wkspace`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;

.. raw:: latex

   \clearpage

.. _config:

config - show the system configuration.
---------------------------------------
.. index:: config

SYNOPSYS:
    .. code-block:: shell

        config

DESCRIPTION:
    This command display information about the RTEMS Configuration.

EXIT STATUS:
    This command always succeeds and returns 0.

NOTES:
    At this time, it does not report every configuration parameter.  This is an
    area in which user submissions or sponsorship of a developer would be
    appreciated.

EXAMPLES:
    The following is an example of how to use ``config``:

    .. code-block:: shell

        SHLL [/] $ config
        INITIAL (startup) Configuration Info

        WORKSPACE      start: 0x23d22e0;  size: 0x2dd20
        TIME           usec/tick: 10000;  tick/timeslice: 50;  tick/sec: 100
        MAXIMUMS       tasks: 20;  timers: 0;  sems: 50;  que's: 20;  ext's: 1
        partitions: 0;  regions: 0;  ports: 0;  periods: 0

.. index:: CONFIGURE_SHELL_NO_COMMAND_CONFIG
.. index:: CONFIGURE_SHELL_COMMAND_CONFIG

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_CONFIG`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_CONFIG`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_config

PROGRAMMING INFORMATION:
    The ``config`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_config(
            int    argc,
            char **argv
        );

    The configuration structure for the ``config`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_CONFIG_Command;

.. raw:: latex

   \clearpage

.. _itask:

itask - list init tasks for the system
--------------------------------------
.. index:: itask

SYNOPSYS:
    .. code-block:: shell

        itask

DESCRIPTION:
    This command prints a report on the set of initialization tasks and threads
    in the system.

EXIT STATUS:
    This command always succeeds and returns 0.

NOTES:
    At this time, it includes only Classic API Initialization Tasks.  This is an
    area in which user submissions or sponsorship of a developer would be
    appreciated.

EXAMPLES:
    The following is an example of how to use ``itask``:

    .. code-block:: shell

        SHLL [/] $ itask
        #    NAME   ENTRY        ARGUMENT    PRIO   MODES  ATTRIBUTES   STACK SIZE
        ------------------------------------------------------------------------------
        0   UI1    [0x2002258] 0 [0x0]        1    nP      DEFAULT     4096 [0x1000]

.. index:: CONFIGURE_SHELL_NO_COMMAND_ITASK
.. index:: CONFIGURE_SHELL_COMMAND_ITASK

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_ITASK`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_ITASK`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_itask

PROGRAMMING INFORMATION:
    The ``itask`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_itask(
            int    argc,
            char **argv
        );

    The configuration structure for the ``itask`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_ITASK_Command;

.. raw:: latex

   \clearpage

.. _extension:

extension - display information about extensions
------------------------------------------------
.. index:: extension

SYNOPSYS:
    .. code-block:: shell

        extension [id [id ...]]

DESCRIPTION:
    When invoked with no arguments, this command prints information on the set
    of User Extensions currently active in the system.

    If invoked with a set of ids as arguments, then just those objects are
    included in the information printed.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    NONE

EXAMPLES:
    The following is an example of using the ``extension`` command on a system
    with no user extensions.

    .. code-block:: shell

        SHLL [/] $ extension
        ID       NAME
        ------------------------------------------------------------------------------

.. index:: CONFIGURE_SHELL_NO_COMMAND_EXTENSION
.. index:: CONFIGURE_SHELL_COMMAND_EXTENSION

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_EXTENSION`` to have
    this command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_EXTENSION`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_extension

PROGRAMMING INFORMATION:
    The ``extension`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_extension(
            int    argc,
            char **argv
        );

    The configuration structure for the ``extension`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_EXTENSION_Command;

.. raw:: latex

   \clearpage

.. _task:

task - display information about tasks
--------------------------------------
.. index:: task

SYNOPSYS:
    .. code-block:: shell

        task [id [id ...]]

DESCRIPTION:
    When invoked with no arguments, this command prints information on the set
    of Classic API Tasks currently active in the system.

    If invoked with a set of ids as arguments, then just those objects are
    included in the information printed.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    NONE

EXAMPLES:
    The following is an example of how to use the ``task`` on an application
    with just two Classic API tasks:

    .. code-block:: shell

        SHLL [/] $ task
        ID       NAME   PRIO   STAT   MODES  EVENTS   WAITID  WAITARG  NOTES
        ------------------------------------------------------------------------------
        0a010001   UI1      1   SUSP   P:T:nA  NONE
        0a010002   SHLL   100   READY  P:T:nA  NONE

.. index:: CONFIGURE_SHELL_NO_COMMAND_TASK
.. index:: CONFIGURE_SHELL_COMMAND_TASK

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_TASK`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_TASK`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_task

PROGRAMMING INFORMATION:
    The ``task`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: shell

        int rtems_shell_rtems_main_task(
            int    argc,
            char **argv
        );

    The configuration structure for the ``task`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_TASK_Command;

.. raw:: latex

   \clearpage

.. _queue:

queue - display information about message queues
------------------------------------------------
.. index:: queue

SYNOPSYS:
    .. code-block:: shell

        queue [id [id ... ]]

DESCRIPTION:
    When invoked with no arguments, this command prints information on the set
    of Classic API Message Queues currently active in the system.

    If invoked with a set of ids as arguments, then just those objects are
    included in the information printed.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    NONE

EXAMPLES:
    The following is an example of using the ``queue`` command on a system with
    no Classic API Message Queues.

    .. code-block:: shell

        SHLL [/] $ queue
        ID       NAME   ATTRIBUTES   PEND   MAXPEND  MAXSIZE
        ------------------------------------------------------------------------------

.. index:: CONFIGURE_SHELL_NO_COMMAND_QUEUE
.. index:: CONFIGURE_SHELL_COMMAND_QUEUE

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_QUEUE`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_QUEUE`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_queue

PROGRAMMING INFORMATION:
    The ``queue`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_queue(
            int    argc,
            char **argv
        );

    The configuration structure for the ``queue`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_QUEUE_Command;

.. raw:: latex

   \clearpage

.. _sema:

sema - display information about semaphores
-------------------------------------------
.. index:: sema

SYNOPSYS:
    .. code-block:: shell

        sema [id [id ... ]]

DESCRIPTION:
    When invoked with no arguments, this command prints information on the set
    of Classic API Semaphores currently active in the system.

    If invoked with a set of objects ids as arguments, then just those objects
    are included in the information printed.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    NONE

EXAMPLES:
    The following is an example of how to use ``sema``:

    .. code-block:: shell

        SHLL [/] $ sema
        ID       NAME   ATTR        PRICEIL CURR_CNT HOLDID
        ------------------------------------------------------------------------------
        1a010001   LBIO   PR:BI:IN      0        1     00000000
        1a010002   TRmi   PR:BI:IN      0        1     00000000
        1a010003   LBI00  PR:BI:IN      0        1     00000000
        1a010004   TRia   PR:BI:IN      0        1     00000000
        1a010005   TRoa   PR:BI:IN      0        1     00000000
        1a010006   TRxa   <assoc.c: BAD NAME>   0    0 09010001
        1a010007   LBI01  PR:BI:IN      0        1     00000000
        1a010008   LBI02  PR:BI:IN      0        1     00000000

.. index:: CONFIGURE_SHELL_NO_COMMAND_SEMA
.. index:: CONFIGURE_SHELL_COMMAND_SEMA

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_SEMA`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_SEMA`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_sema

PROGRAMMING INFORMATION:
    The ``sema`` is implemented by a C language function which has the following
    prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_sema(
            int    argc,
            char **argv
        );

    The configuration structure for the ``sema`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_SEMA_Command;

.. raw:: latex

   \clearpage

.. _region:

region - display information about regions
------------------------------------------
.. index:: region

SYNOPSYS:
    .. code-block:: shell

        region [id [id ... ]]

DESCRIPTION:
    When invoked with no arguments, this command prints information on the set
    of Classic API Regions currently active in the system.

    If invoked with a set of object ids as arguments, then just those object
    are included in the information printed.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    NONE

EXAMPLES:
    The following is an example of using the ``region`` command on a system
    with no user extensions.

    .. code-block:: shell

        SHLL [/] $ region
        ID       NAME   ATTR        STARTADDR LENGTH    PAGE_SIZE USED_BLOCKS
        ------------------------------------------------------------------------------

.. index:: CONFIGURE_SHELL_NO_COMMAND_REGION
.. index:: CONFIGURE_SHELL_COMMAND_REGION

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_REGION`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_REGION`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_region

PROGRAMMING INFORMATION:
    The ``region`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_region(
            int    argc,
            char **argv
        );

    The configuration structure for the ``region`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_REGION_Command;

.. raw:: latex

   \clearpage

.. _part:

part - display information about partitions
-------------------------------------------
.. index:: part

SYNOPSYS:
    .. code-block:: shell

        part [id [id ... ]]

DESCRIPTION:
    When invoked with no arguments, this command prints information on the set
    of Classic API Partitions currently active in the system.

    If invoked with a set of object ids as arguments, then just those objects
    are included in the information printed.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    NONE

EXAMPLES:
    The following is an example of using the ``part`` command on a system with
    no user extensions.

    .. code-block:: shell

        SHLL [/] $ part
        ID       NAME   ATTR        STARTADDR LENGTH    BUF_SIZE  USED_BLOCKS
        ------------------------------------------------------------------------------

.. index:: CONFIGURE_SHELL_NO_COMMAND_PART
.. index:: CONFIGURE_SHELL_COMMAND_PART

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_PART`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_PART`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_part

PROGRAMMING INFORMATION:
    The ``part`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_part(
            int    argc,
            char **argv
        );

    The configuration structure for the ``part`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_PART_Command;

.. raw:: latex

   \clearpage

.. _object:

object - display information about RTEMS objects
------------------------------------------------
.. index:: object

SYNOPSYS:
    .. code-block:: shell

        object [id [id ...]]

DESCRIPTION:
    When invoked with a set of object ids as arguments, then a report on those
    objects is printed.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    NONE

EXAMPLES:
    The following is an example of how to use ``object``:

    .. code-block:: shell

        SHLL [/] $ object 0a010001 1a010002
        ID       NAME   PRIO   STAT   MODES  EVENTS   WAITID  WAITARG  NOTES
        ------------------------------------------------------------------------------
        0a010001   UI1      1   SUSP   P:T:nA  NONE
        ID       NAME   ATTR        PRICEIL CURR_CNT HOLDID
        ------------------------------------------------------------------------------
        1a010002   TRmi   PR:BI:IN      0        1     00000000

.. index:: CONFIGURE_SHELL_NO_COMMAND_OBJECT
.. index:: CONFIGURE_SHELL_COMMAND_OBJECT

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_OBJECT`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_OBJECT`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_object

PROGRAMMING INFORMATION:
    The ``object`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_object(
            int    argc,
            char **argv
        );

    The configuration structure for the ``object`` has the
    following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_OBJECT_Command;

.. raw:: latex

   \clearpage

.. _driver:

driver - display the RTEMS device driver table
----------------------------------------------
.. index:: driver

SYNOPSYS:
    .. code-block:: shell

        driver [major [major ...]]

DESCRIPTION:
    When invoked with no arguments, this command prints information on the set
    of Device Drivers currently active in the system.

    If invoked with a set of major numbers as arguments, then just those Device
    Drivers are included in the information printed.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    NONE

EXAMPLES:
    The following is an example of how to use ``driver``:

    .. code-block:: shell

        SHLL [/] $ driver
        Major      Entry points
        ------------------------------------------------------------------------------
        0          init: [0x200256c];  control: [0x20024c8]
        open: [0x2002518];  close: [0x2002504]
        read: [0x20024f0];  write: [0x20024dc]
        1          init: [0x20023fc];  control: [0x2002448]
        open: [0x0];  close: [0x0]
        read: [0x0];  write: [0x0]
        SHLL [/] $

.. index:: CONFIGURE_SHELL_NO_COMMAND_DRIVER
.. index:: CONFIGURE_SHELL_COMMAND_DRIVER

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_DRIVER`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_DRIVER`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_driver

PROGRAMMING INFORMATION:
    The ``driver`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_driver(
            int    argc,
            char **argv
        );

    The configuration structure for the ``driver`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_DRIVER_Command;

.. raw:: latex

   \clearpage

.. _dname:

dname - displays information about named drivers
------------------------------------------------
.. index:: dname

SYNOPSYS:
    .. code-block:: shell

        dname

DESCRIPTION:
    WARNING! This command does not appear to work as of 27 February 2008.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    NONE

EXAMPLES:
    The following is an example of how to use ``dname``:

    .. code-block:: shell

        EXAMPLE_TBD

.. index:: CONFIGURE_SHELL_NO_COMMAND_DNAME
.. index:: CONFIGURE_SHELL_COMMAND_DNAME

CONFIGURATION:
    This command is included in the default shell command set.  When building a
    custom command set, define ``CONFIGURE_SHELL_COMMAND_DNAME`` to have this
    command included.

    This command can be excluded from the shell command set by defining
    ``CONFIGURE_SHELL_NO_COMMAND_DNAME`` when all shell commands have been
    configured.

.. index:: rtems_shell_rtems_main_dname

PROGRAMMING INFORMATION:
    The ``dname`` is implemented by a C language function which has the
    following prototype:

    .. code-block:: c

        int rtems_shell_rtems_main_dname(
            int    argc,
            char **argv
        );

    The configuration structure for the ``dname`` has the following prototype:

    .. code-block:: c

        extern rtems_shell_cmd_t rtems_shell_DNAME_Command;

.. raw:: latex

   \clearpage

.. _pthread:

pthread - display information about POSIX threads
-------------------------------------------------
.. index:: pthread

SYNOPSYS:
    .. code-block:: shell

        pthread [id [id ...]]

DESCRIPTION:
    When invoked with no arguments, this command prints information on the set
    of POSIX API threads currently active in the system.

    If invoked with a set of ids as arguments, then just those objects are
    included in the information printed.

EXIT STATUS:
    This command returns 0 on success and non-zero if an error is encountered.

NOTES:
    This command is only available when the POSIX API is configured.

EXAMPLES:
    The following is an example of how to use the ``task`` on an application
    with four POSIX threads:

    .. code-block:: shell

        SHLL [/] $ pthread
        ID       NAME           PRI  STATE MODES   EVENTS    WAITID  WAITARG  NOTES
        ------------------------------------------------------------------------------
        0b010002   Main           133 READY  P:T:nA    NONE   43010001 0x7b1148
        0b010003   ISR            133 Wcvar  P:T:nA    NONE   43010003 0x7b1148
        0b01000c                  133 READY  P:T:nA    NONE   33010002 0x7b1148
        0b01000d                  133 Wmutex P:T:nA    NONE   33010002 0x7b1148

CONFIGURATION:
    This command is part of the monitor commands which are always available in
    the shell.

PROGRAMMING INFORMATION:
    This command is not directly available for invocation.