Context Navigation

source: rtems-docs/shell/rtems_specific_commands.rst @ f052446

Last change on this file since f052446 was f052446, checked in by Chris Johns <chrisj@…>, on 08/03/22 at 05:01:43
commands: Add 'rtems' command
Property mode set to `100644`
File size: 48.2 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: