amptest.1.html 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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. amptest.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='ampstat.1.html' title=' ampstat.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='amptone.1.html' title=' amptone.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. amptest(1) Qualcomm Atheros Open Powerline Toolkit amptest(1)
  22. NAME
  23. amptest - Qualcomm Atheros PLC Test Applet Loader
  24. SYNOPSIS
  25. amptest [options] [file] [file] [...]
  26. DESCRIPTION
  27. Download and execute one or more test applets on the local Qualcomm Atheros PLC device. An applet is a small firmware
  28. image that can be started by the bootloader and that returns to the bootloader when done. This program is an alternative
  29. to program int6ktest but has been replaced by program plctest.
  30. A Qualcomm Atheros firmware image file may contain one or more applets. Each applet is preceded by a header that speci‐
  31. fies the image size, load address and start address. Program amptest sequentially downloads and executes each applet
  32. found in each image file specified on the command line. It waits for each applet to complete before downloading and exe‐
  33. cuting the next one. The program terminates once all applets in all files have been executed or some applet fails to
  34. complete within 60 seconds.
  35. Most applets return to the Bootloader on successful completion so that another applet can be downloaded and executed.
  36. This allows applet chains to be executed using one command. A chain may consist of one file containing multiple applets
  37. or multiple files each containing one applet or any combination of single and multiple applet files. The chain will
  38. break, after a timeout, if any applet in the chain fails to return to the Bootloader in time. Failure to return in time
  39. may be either a good thing or a bad thing depending on applet design.
  40. This program is part of the Qualcomm Atheros Powerline Toolkit. See the APT man page for an overview and installation
  41. instructions.
  42. COMMENTS
  43. The Qualcomm Atheros Powerline Toolkit contains a set of legacy applets in folder applets. These were designed for use
  44. with program int6ktest and most will not display console messages properly using this program. A new series of compati‐
  45. ble applets are under development and should be available through Atheros Field Application Engineering.
  46. Assuming a good set of applets are available, this program is ideal for testing reference designs for performance and
  47. production units for defects. Applets may become available for testing onboard connections, memory integrity and noise
  48. immunity. Consult with Atheros Field Application Engineering for applet availability.
  49. OPTIONS
  50. -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
  51. program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
  52. -i interface
  53. Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
  54. this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
  55. network connection; however, if environment string &quot;PLC&quot; is defined then it takes precedence over the default
  56. interface. This option then takes precedence over either default.
  57. -l Sequentially execute and re-execute all applets in all files on the command line until the program is terminated
  58. with ^C.
  59. -q Suppresses normal progress and status messages.
  60. -t milliseconds
  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. Specifically, this option prints incoming and outgoing frames in hexadec‐
  64. imal format on stdout. Output can be directed to a text file for analysis.
  65. -w seconds
  66. Application timeout in seconds. This application will wait this long for an applet to terminate and return to the
  67. bootloader before reporting an error and proceeding to the next applet.
  68. -x Cause the program to exit on the first error instead of moving on to the next applet. Error exits return a non-
  69. zero value to the shell.
  70. -?, --help
  71. Print program help summary on stdout. This option takes precedence over other options on the command line.
  72. -!, --version
  73. Print program version information on stdout. This option takes precedence over other options on the command line.
  74. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
  75. the Linux Toolkit you are using.
  76. ARGUMENTS
  77. file The name of an Atheros image file. The image file may contain one or more images. Each image will be downloaded
  78. and executed in turn until all images are executed or an image fails to return to the Bootloader within 1 minute
  79. for some reason.
  80. EXAMPLES
  81. The following example sequentially downloads then executes each image in file abc.nvm in turn. Each image must complete
  82. and return to the bootloader before the next one downloads. Observe that no device address is needed because Atheros
  83. powerline devices use address 00:b0:52:00:00:01 when in bootloader mode.
  84. # amptest abc.nvm
  85. The following example will sequentially download and execute the images in each file abc.nvm, def.nvm and ghi.nvm in
  86. turn.
  87. # amptest abc.nvm def.nvm ghi.nvm
  88. DISCLAIMER
  89. Atheros image file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public informa‐
  90. tion is not available. Qualcomm Atheros reserves the right to change file structure or content in future firmware
  91. releases without any obligation to notify or compensate users of this program. This program is reserved for use by
  92. Atheros Field Engineers. Use of this program may void some contractual obligations made by Atheros.
  93. SEE ALSO
  94. APT(1), chknvm(1), chknvm2(1), int6ktest(1), nvmsplit(1), nvmmerge(1), plctest(1), setnvm(1)
  95. CREDITS
  96. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  97. open-plc-utils-0.0.3 Mar 2014 amptest(1)
  98. </pre>
  99. <div class='footerlink'>
  100. [<a href='ampstat.1.html' title=' ampstat.1 '>PREV</a>]
  101. [<a href='toolkit.html' title=' Index '>HOME</a>]
  102. [<a href='amptone.1.html' title=' amptone.1 '>NEXT</a>]
  103. </div>
  104. </body>
  105. </html>