plcstat.1.html 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  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. plcstat.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='plcset.1.html' title=' plcset.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='plctest.1.html' title=' plctest.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. plcstat(1) Qualcomm Atheros Open Powerline Toolkit plcstat(1)
  22. NAME
  23. plcstat - Qualcomm Atheros AR7x00 Link Statistics
  24. SYNOPSIS
  25. plcstat [options] [device] [device] [...]
  26. DESCRIPTION
  27. The Atheros Device Statistics Utility polls a device and prints network and link statistics in various formats suitable
  28. for use by other programs. This is a work in progress so user feedback is encouraged. Link statistics are only valid
  29. between one powerline device and another.
  30. This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
  31. instructions.
  32. COMMENTS
  33. This program is identical to legacy program int6kstat but uses version 1 of the Qualcomm Atheros VS_NW_INFO Atheros ven‐
  34. dor-specific message. Older firmware versions may not recognize this message version.
  35. OPTIONS
  36. -C Clear device link statistics using VS_LNK_STATS. Statistics are read and cleared then displayed. The statistics
  37. that are read and displayed depend on options -d, -p and -s but all link statistics are cleared.
  38. -d direction
  39. Return statistics for the specified direction using VS_LNK_STATS. Direction can be 0=tx, 1=rx, 2=both or &quot;rx&quot;,
  40. &quot;tx&quot; or &quot;both&quot;.
  41. -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
  42. program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
  43. -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
  44. this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
  45. network connection; however, if environment string &quot;PLC&quot; is defined then it takes precedence over the default
  46. interface. This option then takes precedence over either default.
  47. -l count
  48. Define the number of times that the command will be repeated for each device specified. Normally, you will repeat
  49. operations on one device only.
  50. -m Displays network membership information, as seen by one device, using VS_NW_INFO. Use option -t for complete net‐
  51. work topology seen by the local host.
  52. -p peernode
  53. Ethernet hardware address of the peer node for VS_LNK_STATS. This option is required for all Link ID values
  54. except 0xFC. The default is 00:00:00:00:00:00.
  55. -q Enter quiet mode. Progress messages are suppressed.
  56. -s linkid
  57. The Link ID for VS_LNK_STATS. Link ID values range from 0 through 255 but not all values are accepted by the
  58. device firmware. Values may be expressed in decimal, binary prefixed with &quot;0b&quot; or hexadecimal prefixed by &quot;0x&quot;.
  59. Many valid values can be expressed by name. Valid values are listed and explained under LINKID. The default Link
  60. ID is 0xFC.
  61. -t Display network topology using VS_SW_VER and VS_NW_INFO messages. This option is similar to option -m but pro‐
  62. vides complete network topology plus device hardware and firmware version. Topology is always relative to the
  63. local host, or local hosts if present. Powerline devices that appear on the command line are not used for this
  64. operation.
  65. -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
  66. -w seconds
  67. Defines the number of seconds to wait before repeating command line options. This option has no effect unless
  68. option -l is also specified with a non-zero value.
  69. -?, --help
  70. Print program help summary on stdout. This option takes precedence over other options on the command line.
  71. -!, --version
  72. Print program version information on stdout. This option takes precedence over other options on the command line.
  73. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
  74. the Linux Toolkit you are using.
  75. ARGUMENTS
  76. device The MAC address of some powerline device. More than one address may be specified. If more than one address is
  77. specified then operations are performed on each device in turn. The default address is local. See DEVICES for
  78. information about symbolic device addresses.
  79. LINKID
  80. 0x00,CSMA-CAP0
  81. Display CSMA statistics for CAP0 traffic using a single peer node. The peer node MAC address must be specified
  82. using option -p.
  83. 0x01,CSMA-CAP1
  84. Display CSMA statistics for CAP1 traffic using a single peer node. The peer node MAC address must be specified
  85. using option -p.
  86. 0x02,CSMA-CAP2
  87. Display CSMA statistics for CAP2 traffic using a single peer node. The peer node MAC address must be specified
  88. using option -p.
  89. 0x03,CSMA-CAP3
  90. Display CSMA statistics for CAP3 traffic using a single peer node. The peer node MAC address must be specified
  91. using option -p.
  92. 0xF8,CSMA-PEER
  93. Display CSMA statistics for all traffic using a single peer node. The peer node MAC address must be specified
  94. using option -p.
  95. 0xFC,CSMA-ALL
  96. Display CSMA statistics for all traffic with all peer nodes. A peer node MAC address is not needed and will be
  97. ignored if provided. This value is the default for option -s.
  98. DEVICES
  99. Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
  100. decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
  101. &quot;00b052000001&quot;, &quot;00:b0:52:00:00:01&quot; and &quot;00b052:000001&quot; are valid and equivalent.
  102. The following MAC addresses are special and may be entered by name instead of number.
  103. all Same as &quot;broadcast&quot;.
  104. broadcast
  105. A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
  106. recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
  107. A foreign device is any device not manufactured by Atheros.
  108. local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
  109. Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
  110. the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
  111. REFERENCES
  112. See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
  113. DISCLAIMER
  114. Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
  115. Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
  116. sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
  117. gram.
  118. EXAMPLES
  119. None.
  120. SEE ALSO
  121. plc(1), plcrate(1), plcstat(1), plctool(1)
  122. CREDITS
  123. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  124. open-plc-utils-0.0.3 Mar 2014 plcstat(1)
  125. </pre>
  126. <div class='footerlink'>
  127. [<a href='plcset.1.html' title=' plcset.1 '>PREV</a>]
  128. [<a href='toolkit.html' title=' Index '>HOME</a>]
  129. [<a href='plctest.1.html' title=' plctest.1 '>NEXT</a>]
  130. </div>
  131. </body>
  132. </html>