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