mdiodump.1 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. .TH mdiodump 1 "Mar 2014" "plc-utils-2.1.6" "Qualcomm Atheros Powerline Toolkit"
  2. .SH NAME
  3. mdiodump - Qualcomm Atheros MDIO Custom Module Analyser
  4. .SH SYNOPSIS
  5. .BR mdiodump
  6. .RI [ options ]
  7. .RI file
  8. .RI [ file ]
  9. [...]
  10. .SH DESCRIPTION
  11. Read one or more binary MDIO program files and output MDIO instructions on stdout.
  12. These instructions are suitable as input to program \fBmdioblock\fR which outputs MDIO programs.
  13. See the \fBmdioblock\fR manpage for more information.
  14. .PP
  15. This program is part of the Qualcomm Atheros Powerline Toolkit.
  16. See the \fBPLC\fR man page for an overview and installation instructions.
  17. .SH OPTIONS
  18. .TP
  19. .RB - s
  20. Print summary information on stdout instead of MDIO instructions.
  21. .TP
  22. -\fBt \fIphy_type\fR
  23. Specify the PHY chipset that this MDIO module will be used with.
  24. The only supported option arguments are "ar8236" and "generic".
  25. Argument "ar8236" indicates that the MDIO register instructions are Atheros AR8236 specific.
  26. The AR8236 supports special MDIO registers and instructions in addition to generic MDIO registers and instructions.
  27. The default is "generic" which displays instructions as standard MDIO instructions.
  28. This option and option \fB-b\fR are mutually exclusive.
  29. .TP
  30. .RB - v
  31. Prints additional information on stdout.
  32. In particular, this option causes mdiodump to display every MDIO command present instead of just the simulation summary.
  33. .TP
  34. .RB - ? ,-- help
  35. Displays program help information on stderr.
  36. This option takes precedence over all other options on the command line except version information.
  37. .TP
  38. .RB - ! ,-- version
  39. Displays program version information on stderr.
  40. This option takes precedence over all other options on the command line except help information.
  41. Use this option when sending screen dumps to Atheros technical staff.
  42. .SH ARGUMENTS
  43. .TP
  44. .IR file
  45. The MDIO custom module file to operate on.
  46. .SH REFERENCES
  47. See the Qualcomm Atheros \fIHomePlug AV Firmware Technical Reference Manual\fR for information about generic MDIO register instruction.
  48. See the Qualcomm Atheros \fIAR8236 Six-Port Fast Ethernet Switch Data Sheet\fR for detailed information about AR8236 specific MDIO registers and instructions.
  49. .SH DISCLAIMER
  50. Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL USA.
  51. Consequently, public information may not be available.
  52. Qualcomm Atheros reserves the right to modify message structure and content in future firmware releases without any obligation to notify or compensate users of this program.
  53. .SH EXAMPLES
  54. None.
  55. .SH SEE ALSO
  56. .BR amp ( 1 ),
  57. .BR int6kmod ( 1 ),
  58. .BR int6kmdio ( 1 ),
  59. .BR int6kmdio2 ( 1 ),
  60. .BR mdioblock ( 1 ),
  61. .BR mdioblock2 ( 1 ),
  62. .BR mdiogen ( 1 ),
  63. .BR plcmdio16 ( 1 ),
  64. .BR plcmdio32 ( 1 )
  65. .SH CREDITS
  66. Nathaniel Houghton <nhoughto@qca.qualcomm.com>
  67. Charles Maier <cmaier@qca.qualcomm.com>
  68. Marc Bertola <marc.bertola@qca.qualcomm.com>