plcotst.1.html 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  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. plcotst.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='plcmdio32.1.html' title=' plcmdio32.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='plcrate.1.html' title=' plcrate.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. plcotst(1) Qualcomm Atheros Open Powerline Toolkit plcotst(1)
  22. NAME
  23. plcotst - PLC One-Time Self-Test Manager
  24. SYNOPSIS
  25. plcotst [options] [device] [device] [...]
  26. DESCRIPTION
  27. Manage the PLC One-Time Self-Test feature on Atheros powerline devices. Normally, selftest is performed once, on startup
  28. at the factory, but it can also be configured and run again using this utility. Selftest results are stored by the
  29. firmware and can be read using this utility, as well. The selftest is configured when configuration options are speci‐
  30. fied on the command line; otherwise, selftest results are read or cleared.
  31. This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
  32. instructions.
  33. OPTIONS
  34. -c version Configuration version number. Permitted values are 0 through 255. The default is 0. This option applies to
  35. both selftest configuration and selftest results.
  36. -C Clear stored selftest results. This option clears stored selftest results. This option implies selftest results
  37. and supercedes options -d, -f, -m, -r and -R, if present on the command line.
  38. -d seconds
  39. Delay selftest after reboot. Permitted delay times are 0 through UINT_MAX seconds. The default is 0 seconds.
  40. This option implies selftest configuration and supercedes option -C, if present on the command line.
  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. -f count
  44. Run the flash memory selftest count times. Valid values are 0 through UINT_MAX. The default is 0 which effec‐
  45. tively suppresses the test. This option implies selftest configuration and supercedes option -C, if present on
  46. the command line.
  47. -m count
  48. Run the memory selftest count times. Valid values are 0 through UINT_MAX. The default is 0 which suppresses
  49. effectively the test. This option implies selftest configuration and supercedes option -C, if present on the com‐
  50. mand line.
  51. -q Suppresses status messages on stderr.
  52. -r flag
  53. Run selftest after reboot. Permitted values are 0 through 255. Expected values are 0 for false and 1 for true.
  54. The default is 1. If the memory test count and flash test count are both 0 no testing will occur when the time
  55. comes. This option implies selftest configuration and supercedes option -C, if present on the command line.
  56. -R flag
  57. Reset device after selftest. Permitted values are 0 through 255. Expected values are 0 for false and 1 for true.
  58. The default is 0. This option applies to selftest configuration only and supercedes option -C, if present on the
  59. command line.
  60. -t timeout
  61. Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
  62. response. The default is shown in brackets on the program menu.
  63. -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
  64. be saved as text files for reference.
  65. -?,--help
  66. Print program help summary on stdout. This option takes precedence over other options on the command line.
  67. -!,--version
  68. Print program version information on stdout. This option takes precedence over other options on the command line.
  69. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
  70. the Linux Toolkit you are using.
  71. ARGUMENTS
  72. device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
  73. line. If more than one address is specified then operations are performed on each device in turn. The default
  74. address is local. as explained in the DEVICES section.
  75. EXAMPLES
  76. The following example prints stored test results for the local device on stdout because no options are specified on the
  77. command line.
  78. # plcotst
  79. The next example prints stored test results for remote device 00:B0:52:BA:BE:DE and clears them afterwards.
  80. # plcotst -C
  81. The next example configures the PLC selftest to wait 5 seconds before execution because option -d is present. It also
  82. configures the selftest to reset the device after execution because option -R is present
  83. # plcotst -d 5 -R
  84. REFERENCES
  85. See the Qualcomm Atheros Powerline Firmware Technical Reference Manual for more information about firmware selftest.
  86. DISCLAIMER
  87. None.
  88. SEE ALSO
  89. plc(1)
  90. CREDITS
  91. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  92. open-plc-utils-0.0.3 Mar 2014 plcotst(1)
  93. </pre>
  94. <div class='footerlink'>
  95. [<a href='plcmdio32.1.html' title=' plcmdio32.1 '>PREV</a>]
  96. [<a href='toolkit.html' title=' Index '>HOME</a>]
  97. [<a href='plcrate.1.html' title=' plcrate.1 '>NEXT</a>]
  98. </div>
  99. </body>
  100. </html>