mdioblock.1.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. <?xml version='1.0' encoding='iso-8859-1'?>
  2. <!doctype html public '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
  3. <html xmlns='http://www.w3c.org/1999/xhtml' lang='en-us'>
  4. <head>
  5. <title>
  6. mdioblock.1
  7. </title>
  8. <meta http-equiv='content-type' content='text/html;iso-8859-1'/>
  9. <meta name='generator' content='motley-tools 1.9.4 13:40:33 Feb 18 2015'/>
  10. <meta name='author' content='cmaier@cmassoc.net'/>
  11. <meta name='robots' content='noindex,nofollow'/>
  12. <link href='toolkit.css' rel='stylesheet' type='text/css'/>
  13. </head>
  14. <body>
  15. <div class='headerlink'>
  16. [<a href='mac2pwd.1.html' title=' mac2pwd.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='mdioblock2.1.html' title=' mdioblock2.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. mdioblock(1) Qualcomm Atheros Open Powerline Toolkit mdioblock(1)
  22. NAME
  23. mdioblock - Qualcomm Atheros Clause 22 MDIO Instruction Block Assembler
  24. SYNOPSIS
  25. mdioblock [options] file [file] [...] [&gt;stdout]
  26. mdioblock [options] [&lt;stdin] [&gt;stdout]
  27. DESCRIPTION
  28. Assemble an Atheros MDIO instruction block from hexadecimal register instructions. MDIO instruction blocks are written
  29. to Atheros powerline devices as modules using the VS_MOD_OP message type. Alternately, program int6kmod can be used.
  30. Atheros MDIO modules consists of a 16-bit header followed by one or more MDIO communication frames with register masks
  31. and padded to the nearest multiple of 32-bits for download purposes. MDIO instructions are specified here using 802.3
  32. Clause 22 (or phy, reg, data and mask) format. See program mdioblock2 for a similar program that accepts instructions in
  33. 802.3ae Clause 45 (or address, data and mask) format.
  34. This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
  35. instructions.
  36. OPTIONS
  37. -q Quiet mode. Suppresses error messages caused by instruction syntax errors.
  38. -v Verbose mode. Prints instructions on stderr as they are processed.
  39. -?,--help
  40. Displays program help information on stderr. This option takes precedence over all other options on the command
  41. line except version information.
  42. -!,--version
  43. Displays program version information on stderr. This option takes precedence over all other options on the com‐
  44. mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
  45. ARGUMENTS
  46. file A text files contining one or more generic MDIO register intructions consisting of a phy, reg, data and mask
  47. fields. Fields are seperated by whitespace and instructions are terminated with semicolon. Multiple instructions
  48. may appear on a single line or a single instruction can span multiple lines. Script-style comments are permitted
  49. between instructions but not between fields.
  50. REFERENCES
  51. See the Qualcomm Atheros AR7x00 Firmware Technical Reference Manual section on the Module Operation message type for more
  52. information on MDIO Block format.
  53. DISCLAIMER
  54. Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
  55. USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
  56. structure and content in future firmware releases without any obligation to notify or compensate users of this program.
  57. EXAMPLES
  58. The following command reads register instructions from file mdio.txt and writes them as an MDIO program block to file
  59. mdio.bin. In this example, the program acts as a filter.
  60. # mdioblock &lt; mdio.txt &gt; mdio.bin
  61. The following command reads register instructions from files physetup.dat, flowctl.dat and misc.ins and write them all as
  62. one MDIO block to file mdio.bin. The previous contents of file mdio.bin is overwritten.
  63. # mdioblock physetup.dat flowctl.dat misc.ins &gt; mdio.bin
  64. An example register instruction file might look like this. The first two lines consist of one instruction each. An
  65. instruction has phy, reg, data and mask fields. Instruction fields are separated by whitespace. Instructions are sepa‐
  66. rated by a semicolon. Multiple instruction may appear on one line and one instruction can span multiple lines. Script-
  67. style comments are permitted between instructions but not between instruction fields.
  68. 18 00 0000 FFFF;
  69. 10 16 003F FFFF;
  70. # multiple instructions on one line;
  71. 10 17 7E3F FFFF; 18 00 0000 FFFF;
  72. # one instruction on multiple lines;
  73. 10
  74. 02
  75. 0700
  76. FFFF;
  77. 10 03 0000 FFFF;
  78. 18 00 0000 FFFF;
  79. 14 00 007D FFFF;
  80. 14 01 0000 FFFF;
  81. A 16-bit hexdump of the MDIO block will look like this on little-endian hosts. The block consists of a 16-bit header
  82. followed by a variable number of 16-bit triplets. The header indicates the number of triplets that follow. Each triplet
  83. specifies a 16-bit operation, a 16-bit data value and a 16-bit data mask. The application of these fields is beyond the
  84. scope of this man page. Consult the IEEE standards for more information.
  85. # hexdump mdio.bin
  86. 0000000 0241 8185 0000 ffff ad05 003f ffff af05
  87. 0000010 7e3f ffff 8185 0000 ffff 8505 0700 ffff
  88. 0000020 8705 0000 ffff 8185 0000 ffff 8145 007d
  89. 0000030 ffff 8345 0000 ffff
  90. An 8-bit dump of the MDIO block will look like this on all hosts since the MDIO block is always distributed in little-
  91. endian format.
  92. # hexdmp mdio.bin
  93. 00000000 41 02 85 81 00 00 FF FF 05 AD 3F 00 FF FF 05 AF A.........?.....
  94. 00000010 3F 7E FF FF 85 81 00 00 FF FF 05 85 00 07 FF FF ?~..............
  95. 00000020 05 87 00 00 FF FF 85 81 00 00 FF FF 45 81 7D 00 ............E.}.
  96. 00000030 FF FF 45 83 00 00 FF FF ..E.....
  97. SEE ALSO
  98. amp(1), int6kmod(1), int6kmdio(1), int6kmdio2(1), mdioblock2(1), mdiodump(1), mdiogen(1)
  99. CREDITS
  100. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  101. open-plc-utils-0.0.3 Mar 2014 mdioblock(1)
  102. </pre>
  103. <div class='footerlink'>
  104. [<a href='mac2pwd.1.html' title=' mac2pwd.1 '>PREV</a>]
  105. [<a href='toolkit.html' title=' Index '>HOME</a>]
  106. [<a href='mdioblock2.1.html' title=' mdioblock2.1 '>NEXT</a>]
  107. </div>
  108. </body>
  109. </html>