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