i.MX: Fix FEC code for MDIO address selection
[qemu.git] / hmp-commands-info.hx
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5 HXCOMM monitor info commands
6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7
8 STEXI
9 @table @option
10 @item info @var{subcommand}
11 @findex info
12 Show various information about the system state.
13 @table @option
14 ETEXI
15
16     {
17         .name       = "version",
18         .args_type  = "",
19         .params     = "",
20         .help       = "show the version of QEMU",
21         .mhandler.cmd = hmp_info_version,
22     },
23
24 STEXI
25 @item info version
26 @findex version
27 Show the version of QEMU.
28 ETEXI
29
30     {
31         .name       = "network",
32         .args_type  = "",
33         .params     = "",
34         .help       = "show the network state",
35         .mhandler.cmd = hmp_info_network,
36     },
37
38 STEXI
39 @item info network
40 @findex network
41 Show the network state.
42 ETEXI
43
44     {
45         .name       = "chardev",
46         .args_type  = "",
47         .params     = "",
48         .help       = "show the character devices",
49         .mhandler.cmd = hmp_info_chardev,
50     },
51
52 STEXI
53 @item info chardev
54 @findex chardev
55 Show the character devices.
56 ETEXI
57
58     {
59         .name       = "block",
60         .args_type  = "nodes:-n,verbose:-v,device:B?",
61         .params     = "[-n] [-v] [device]",
62         .help       = "show info of one block device or all block devices "
63                       "(-n: show named nodes; -v: show details)",
64         .mhandler.cmd = hmp_info_block,
65     },
66
67 STEXI
68 @item info block
69 @findex block
70 Show info of one block device or all block devices.
71 ETEXI
72
73     {
74         .name       = "blockstats",
75         .args_type  = "",
76         .params     = "",
77         .help       = "show block device statistics",
78         .mhandler.cmd = hmp_info_blockstats,
79     },
80
81 STEXI
82 @item info blockstats
83 @findex blockstats
84 Show block device statistics.
85 ETEXI
86
87     {
88         .name       = "block-jobs",
89         .args_type  = "",
90         .params     = "",
91         .help       = "show progress of ongoing block device operations",
92         .mhandler.cmd = hmp_info_block_jobs,
93     },
94
95 STEXI
96 @item info block-jobs
97 @findex block-jobs
98 Show progress of ongoing block device operations.
99 ETEXI
100
101     {
102         .name       = "registers",
103         .args_type  = "",
104         .params     = "",
105         .help       = "show the cpu registers",
106         .mhandler.cmd = hmp_info_registers,
107     },
108
109 STEXI
110 @item info registers
111 @findex registers
112 Show the cpu registers.
113 ETEXI
114
115 #if defined(TARGET_I386)
116     {
117         .name       = "lapic",
118         .args_type  = "",
119         .params     = "",
120         .help       = "show local apic state",
121         .mhandler.cmd = hmp_info_local_apic,
122     },
123 #endif
124
125 STEXI
126 @item info lapic
127 @findex lapic
128 Show local APIC state
129 ETEXI
130
131 #if defined(TARGET_I386)
132     {
133         .name       = "ioapic",
134         .args_type  = "",
135         .params     = "",
136         .help       = "show io apic state",
137         .mhandler.cmd = hmp_info_io_apic,
138     },
139 #endif
140
141 STEXI
142 @item info ioapic
143 @findex ioapic
144 Show io APIC state
145 ETEXI
146
147     {
148         .name       = "cpus",
149         .args_type  = "",
150         .params     = "",
151         .help       = "show infos for each CPU",
152         .mhandler.cmd = hmp_info_cpus,
153     },
154
155 STEXI
156 @item info cpus
157 @findex cpus
158 Show infos for each CPU.
159 ETEXI
160
161     {
162         .name       = "history",
163         .args_type  = "",
164         .params     = "",
165         .help       = "show the command line history",
166         .mhandler.cmd = hmp_info_history,
167     },
168
169 STEXI
170 @item info history
171 @findex history
172 Show the command line history.
173 ETEXI
174
175 #if defined(TARGET_I386) || defined(TARGET_PPC) || defined(TARGET_MIPS) || \
176     defined(TARGET_LM32) || (defined(TARGET_SPARC) && !defined(TARGET_SPARC64))
177     {
178         .name       = "irq",
179         .args_type  = "",
180         .params     = "",
181         .help       = "show the interrupts statistics (if available)",
182 #ifdef TARGET_SPARC
183         .mhandler.cmd = sun4m_hmp_info_irq,
184 #elif defined(TARGET_LM32)
185         .mhandler.cmd = lm32_hmp_info_irq,
186 #else
187         .mhandler.cmd = hmp_info_irq,
188 #endif
189     },
190
191 STEXI
192 @item info irq
193 @findex irq
194 Show the interrupts statistics (if available).
195 ETEXI
196
197     {
198         .name       = "pic",
199         .args_type  = "",
200         .params     = "",
201         .help       = "show i8259 (PIC) state",
202 #ifdef TARGET_SPARC
203         .mhandler.cmd = sun4m_hmp_info_pic,
204 #elif defined(TARGET_LM32)
205         .mhandler.cmd = lm32_hmp_info_pic,
206 #else
207         .mhandler.cmd = hmp_info_pic,
208 #endif
209     },
210 #endif
211
212 STEXI
213 @item info pic
214 @findex pic
215 Show i8259 (PIC) state.
216 ETEXI
217
218     {
219         .name       = "pci",
220         .args_type  = "",
221         .params     = "",
222         .help       = "show PCI info",
223         .mhandler.cmd = hmp_info_pci,
224     },
225
226 STEXI
227 @item info pci
228 @findex pci
229 Show PCI information.
230 ETEXI
231
232 #if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \
233     defined(TARGET_PPC) || defined(TARGET_XTENSA)
234     {
235         .name       = "tlb",
236         .args_type  = "",
237         .params     = "",
238         .help       = "show virtual to physical memory mappings",
239         .mhandler.cmd = hmp_info_tlb,
240     },
241 #endif
242
243 STEXI
244 @item info tlb
245 @findex tlb
246 Show virtual to physical memory mappings.
247 ETEXI
248
249 #if defined(TARGET_I386)
250     {
251         .name       = "mem",
252         .args_type  = "",
253         .params     = "",
254         .help       = "show the active virtual memory mappings",
255         .mhandler.cmd = hmp_info_mem,
256     },
257 #endif
258
259 STEXI
260 @item info mem
261 @findex mem
262 Show the active virtual memory mappings.
263 ETEXI
264
265     {
266         .name       = "mtree",
267         .args_type  = "",
268         .params     = "",
269         .help       = "show memory tree",
270         .mhandler.cmd = hmp_info_mtree,
271     },
272
273 STEXI
274 @item info mtree
275 @findex mtree
276 Show memory tree.
277 ETEXI
278
279     {
280         .name       = "jit",
281         .args_type  = "",
282         .params     = "",
283         .help       = "show dynamic compiler info",
284         .mhandler.cmd = hmp_info_jit,
285     },
286
287 STEXI
288 @item info jit
289 @findex jit
290 Show dynamic compiler info.
291 ETEXI
292
293     {
294         .name       = "opcount",
295         .args_type  = "",
296         .params     = "",
297         .help       = "show dynamic compiler opcode counters",
298         .mhandler.cmd = hmp_info_opcount,
299     },
300
301 STEXI
302 @item info opcount
303 @findex opcount
304 Show dynamic compiler opcode counters
305 ETEXI
306
307     {
308         .name       = "kvm",
309         .args_type  = "",
310         .params     = "",
311         .help       = "show KVM information",
312         .mhandler.cmd = hmp_info_kvm,
313     },
314
315 STEXI
316 @item info kvm
317 @findex kvm
318 Show KVM information.
319 ETEXI
320
321     {
322         .name       = "numa",
323         .args_type  = "",
324         .params     = "",
325         .help       = "show NUMA information",
326         .mhandler.cmd = hmp_info_numa,
327     },
328
329 STEXI
330 @item info numa
331 @findex numa
332 Show NUMA information.
333 ETEXI
334
335     {
336         .name       = "usb",
337         .args_type  = "",
338         .params     = "",
339         .help       = "show guest USB devices",
340         .mhandler.cmd = hmp_info_usb,
341     },
342
343 STEXI
344 @item info usb
345 @findex usb
346 Show guest USB devices.
347 ETEXI
348
349     {
350         .name       = "usbhost",
351         .args_type  = "",
352         .params     = "",
353         .help       = "show host USB devices",
354         .mhandler.cmd = hmp_info_usbhost,
355     },
356
357 STEXI
358 @item info usbhost
359 @findex usbhost
360 Show host USB devices.
361 ETEXI
362
363     {
364         .name       = "profile",
365         .args_type  = "",
366         .params     = "",
367         .help       = "show profiling information",
368         .mhandler.cmd = hmp_info_profile,
369     },
370
371 STEXI
372 @item info profile
373 @findex profile
374 Show profiling information.
375 ETEXI
376
377     {
378         .name       = "capture",
379         .args_type  = "",
380         .params     = "",
381         .help       = "show capture information",
382         .mhandler.cmd = hmp_info_capture,
383     },
384
385 STEXI
386 @item info capture
387 @findex capture
388 Show capture information.
389 ETEXI
390
391     {
392         .name       = "snapshots",
393         .args_type  = "",
394         .params     = "",
395         .help       = "show the currently saved VM snapshots",
396         .mhandler.cmd = hmp_info_snapshots,
397     },
398
399 STEXI
400 @item info snapshots
401 @findex snapshots
402 Show the currently saved VM snapshots.
403 ETEXI
404
405     {
406         .name       = "status",
407         .args_type  = "",
408         .params     = "",
409         .help       = "show the current VM status (running|paused)",
410         .mhandler.cmd = hmp_info_status,
411     },
412
413 STEXI
414 @item info status
415 @findex status
416 Show the current VM status (running|paused).
417 ETEXI
418
419     {
420         .name       = "mice",
421         .args_type  = "",
422         .params     = "",
423         .help       = "show which guest mouse is receiving events",
424         .mhandler.cmd = hmp_info_mice,
425     },
426
427 STEXI
428 @item info mice
429 @findex mice
430 Show which guest mouse is receiving events.
431 ETEXI
432
433     {
434         .name       = "vnc",
435         .args_type  = "",
436         .params     = "",
437         .help       = "show the vnc server status",
438         .mhandler.cmd = hmp_info_vnc,
439     },
440
441 STEXI
442 @item info vnc
443 @findex vnc
444 Show the vnc server status.
445 ETEXI
446
447 #if defined(CONFIG_SPICE)
448     {
449         .name       = "spice",
450         .args_type  = "",
451         .params     = "",
452         .help       = "show the spice server status",
453         .mhandler.cmd = hmp_info_spice,
454     },
455 #endif
456
457 STEXI
458 @item info spice
459 @findex spice
460 Show the spice server status.
461 ETEXI
462
463     {
464         .name       = "name",
465         .args_type  = "",
466         .params     = "",
467         .help       = "show the current VM name",
468         .mhandler.cmd = hmp_info_name,
469     },
470
471 STEXI
472 @item info name
473 @findex name
474 Show the current VM name.
475 ETEXI
476
477     {
478         .name       = "uuid",
479         .args_type  = "",
480         .params     = "",
481         .help       = "show the current VM UUID",
482         .mhandler.cmd = hmp_info_uuid,
483     },
484
485 STEXI
486 @item info uuid
487 @findex uuid
488 Show the current VM UUID.
489 ETEXI
490
491     {
492         .name       = "cpustats",
493         .args_type  = "",
494         .params     = "",
495         .help       = "show CPU statistics",
496         .mhandler.cmd = hmp_info_cpustats,
497     },
498
499 STEXI
500 @item info cpustats
501 @findex cpustats
502 Show CPU statistics.
503 ETEXI
504
505 #if defined(CONFIG_SLIRP)
506     {
507         .name       = "usernet",
508         .args_type  = "",
509         .params     = "",
510         .help       = "show user network stack connection states",
511         .mhandler.cmd = hmp_info_usernet,
512     },
513 #endif
514
515 STEXI
516 @item info usernet
517 @findex usernet
518 Show user network stack connection states.
519 ETEXI
520
521     {
522         .name       = "migrate",
523         .args_type  = "",
524         .params     = "",
525         .help       = "show migration status",
526         .mhandler.cmd = hmp_info_migrate,
527     },
528
529 STEXI
530 @item info migrate
531 @findex migrate
532 Show migration status.
533 ETEXI
534
535     {
536         .name       = "migrate_capabilities",
537         .args_type  = "",
538         .params     = "",
539         .help       = "show current migration capabilities",
540         .mhandler.cmd = hmp_info_migrate_capabilities,
541     },
542
543 STEXI
544 @item info migrate_capabilities
545 @findex migrate_capabilities
546 Show current migration capabilities.
547 ETEXI
548
549     {
550         .name       = "migrate_parameters",
551         .args_type  = "",
552         .params     = "",
553         .help       = "show current migration parameters",
554         .mhandler.cmd = hmp_info_migrate_parameters,
555     },
556
557 STEXI
558 @item info migrate_parameters
559 @findex migrate_parameters
560 Show current migration parameters.
561 ETEXI
562
563     {
564         .name       = "migrate_cache_size",
565         .args_type  = "",
566         .params     = "",
567         .help       = "show current migration xbzrle cache size",
568         .mhandler.cmd = hmp_info_migrate_cache_size,
569     },
570
571 STEXI
572 @item info migrate_cache_size
573 @findex migrate_cache_size
574 Show current migration xbzrle cache size.
575 ETEXI
576
577     {
578         .name       = "balloon",
579         .args_type  = "",
580         .params     = "",
581         .help       = "show balloon information",
582         .mhandler.cmd = hmp_info_balloon,
583     },
584
585 STEXI
586 @item info balloon
587 @findex balloon
588 Show balloon information.
589 ETEXI
590
591     {
592         .name       = "qtree",
593         .args_type  = "",
594         .params     = "",
595         .help       = "show device tree",
596         .mhandler.cmd = hmp_info_qtree,
597     },
598
599 STEXI
600 @item info qtree
601 @findex qtree
602 Show device tree.
603 ETEXI
604
605     {
606         .name       = "qdm",
607         .args_type  = "",
608         .params     = "",
609         .help       = "show qdev device model list",
610         .mhandler.cmd = hmp_info_qdm,
611     },
612
613 STEXI
614 @item info qdm
615 @findex qdm
616 Show qdev device model list.
617 ETEXI
618
619     {
620         .name       = "qom-tree",
621         .args_type  = "path:s?",
622         .params     = "[path]",
623         .help       = "show QOM composition tree",
624         .mhandler.cmd = hmp_info_qom_tree,
625     },
626
627 STEXI
628 @item info qom-tree
629 @findex qom-tree
630 Show QOM composition tree.
631 ETEXI
632
633     {
634         .name       = "roms",
635         .args_type  = "",
636         .params     = "",
637         .help       = "show roms",
638         .mhandler.cmd = hmp_info_roms,
639     },
640
641 STEXI
642 @item info roms
643 @findex roms
644 Show roms.
645 ETEXI
646
647     {
648         .name       = "trace-events",
649         .args_type  = "",
650         .params     = "",
651         .help       = "show available trace-events & their state",
652         .mhandler.cmd = hmp_info_trace_events,
653     },
654
655 STEXI
656 @item info trace-events
657 @findex trace-events
658 Show available trace-events & their state.
659 ETEXI
660
661     {
662         .name       = "tpm",
663         .args_type  = "",
664         .params     = "",
665         .help       = "show the TPM device",
666         .mhandler.cmd = hmp_info_tpm,
667     },
668
669 STEXI
670 @item info tpm
671 @findex tpm
672 Show the TPM device.
673 ETEXI
674
675     {
676         .name       = "memdev",
677         .args_type  = "",
678         .params     = "",
679         .help       = "show memory backends",
680         .mhandler.cmd = hmp_info_memdev,
681     },
682
683 STEXI
684 @item info memdev
685 @findex memdev
686 Show memory backends
687 ETEXI
688
689     {
690         .name       = "memory-devices",
691         .args_type  = "",
692         .params     = "",
693         .help       = "show memory devices",
694         .mhandler.cmd = hmp_info_memory_devices,
695     },
696
697 STEXI
698 @item info memory-devices
699 @findex memory-devices
700 Show memory devices.
701 ETEXI
702
703     {
704         .name       = "iothreads",
705         .args_type  = "",
706         .params     = "",
707         .help       = "show iothreads",
708         .mhandler.cmd = hmp_info_iothreads,
709     },
710
711 STEXI
712 @item info iothreads
713 @findex iothreads
714 Show iothread's identifiers.
715 ETEXI
716
717     {
718         .name       = "rocker",
719         .args_type  = "name:s",
720         .params     = "name",
721         .help       = "Show rocker switch",
722         .mhandler.cmd = hmp_rocker,
723     },
724
725 STEXI
726 @item info rocker @var{name}
727 @findex rocker
728 Show rocker switch.
729 ETEXI
730
731     {
732         .name       = "rocker-ports",
733         .args_type  = "name:s",
734         .params     = "name",
735         .help       = "Show rocker ports",
736         .mhandler.cmd = hmp_rocker_ports,
737     },
738
739 STEXI
740 @item info rocker_ports @var{name}-ports
741 @findex ocker-ports
742 Show rocker ports.
743 ETEXI
744
745     {
746         .name       = "rocker-of-dpa-flows",
747         .args_type  = "name:s,tbl_id:i?",
748         .params     = "name [tbl_id]",
749         .help       = "Show rocker OF-DPA flow tables",
750         .mhandler.cmd = hmp_rocker_of_dpa_flows,
751     },
752
753 STEXI
754 @item info rocker_of_dpa_flows @var{name} [@var{tbl_id}]
755 @findex rocker-of-dpa-flows
756 Show rocker OF-DPA flow tables.
757 ETEXI
758
759     {
760         .name       = "rocker-of-dpa-groups",
761         .args_type  = "name:s,type:i?",
762         .params     = "name [type]",
763         .help       = "Show rocker OF-DPA groups",
764         .mhandler.cmd = hmp_rocker_of_dpa_groups,
765     },
766
767 STEXI
768 @item info rocker-of-dpa-groups @var{name} [@var{type}]
769 @findex rocker-of-dpa-groups
770 Show rocker OF-DPA groups.
771 ETEXI
772
773 #if defined(TARGET_S390X)
774     {
775         .name       = "skeys",
776         .args_type  = "addr:l",
777         .params     = "address",
778         .help       = "Display the value of a storage key",
779         .mhandler.cmd = hmp_info_skeys,
780     },
781 #endif
782
783 STEXI
784 @item info skeys @var{address}
785 @findex skeys
786 Display the value of a storage key (s390 only)
787 ETEXI
788
789     {
790         .name       = "dump",
791         .args_type  = "",
792         .params     = "",
793         .help       = "Display the latest dump status",
794         .mhandler.cmd = hmp_info_dump,
795     },
796
797 STEXI
798 @item info dump
799 @findex dump
800 Display the latest dump status.
801 ETEXI
802
803 STEXI
804 @end table
805 ETEXI
806
807 STEXI
808 @end table
809 ETEXI