int6khost.1.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  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. int6khost.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='int6kf.1.html' title=' int6kf.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='int6kid.1.html' title=' int6kid.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. int6khost(1) Qualcomm Atheros Open Powerline Toolkit int6khost(1)
  22. NAME
  23. int6khost - INT6300 Host Emulator
  24. SYNOPSIS
  25. int6khost [options] -C file -N file -P file -n file -p file
  26. DESCRIPTION
  27. The INT6300 Host Emulator waits for VS_HST_ACTION.IND messages from a local device and services them as described in the
  28. INT6300 Technical Reference Manual. It can be used to demonstrate or verify proper device/host interaction for flash-
  29. less devices. This program is not production grade and will stop dead - like a bug! - when things go wrong. Use the
  30. Qualcomm Atheros Embedded API for real-time, production-grade applications.
  31. Host emulation applies to flash-less device designs where a local host processor provides the persistent storage. The
  32. local host can provide a wide range of intelligent storage functions for a device but this program offers one. Options
  33. -C, -N and -P name existing files that store factory default memory configuration, runtime firmware and parameters,
  34. respectively. Options -n and -p name scratch files that will store user firmware and parameters, respectively.This is
  35. similiar to the standard Atheros NVRAM scheme but still different.
  36. To use the program, connect a flash-less device to the host via ethernet then start this program with the correct file‐
  37. names. The program will automatically respond to device requests to download memory configuration, firmware and/or
  38. parameters and upload firmware or and/or parameters under device control. See the Qualcomm Atheros Firmware Technical
  39. Reference Manual for more information.
  40. This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
  41. instructions.
  42. OPTIONS
  43. -C filename
  44. Use this file to download memory configuration when requested by the local device. The file must exist and have a
  45. valid configuration file format or it will be rejected. No assumptions are made based on filename and no filename
  46. conventions are enforced. The program will not over-write this file. This option and argument are required.
  47. -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
  48. program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
  49. -F[F] Flash NVRAM once downloaded firmware has started. The same firmware and PIB are downloaded, again, using
  50. VS_WR_MOD and written to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere on the command
  51. line will perform a forced flash. When no NVRAM is present, normal and force flash cause the device to upload to
  52. the host. When blank or corrupted NVRAM is present, forced flash writes to NVRAM. This operation will fail when
  53. no NVRAM is present.
  54. -i interface
  55. Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
  56. this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
  57. network connection; however, if environment string &quot;PLC&quot; is defined then it takes precedence over the default
  58. interface. This option then takes precedence over either default.
  59. -N filename
  60. Use this file to download firmware when requested by the local device. The file must exist and have a valid NVM
  61. file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
  62. enforced. The program will not over-write this file. This option and argument are required.
  63. -n filename
  64. Use this file to store firmware uploaded from the local device. The file need not exist but an error will occur
  65. if it cannot be created or written. If firmware is uploaded to this file, it is used for subsequent firmware
  66. downloads unless the device requests a factory reset. In that case, the file specified by option -N is used.
  67. This option and argument are optional. If omitted then the default filename host.pib will be used.
  68. -P filename
  69. Use this file to download parameters when requested by the local device. The file must exist and have a valid PIB
  70. file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
  71. enforced. The program will not over-write this file. This option and argument are required.
  72. -p filename
  73. Use this file to store parameters uploaded from the local device. The file need not exist but an error will occur
  74. if it cannot be created or written. Once parameters are uploaded to this file, it is used for subsequent parame‐
  75. ter downloads unless the device requests a factory reset. In that case, the file specified by option -P is used.
  76. This option and argument are optional. If omitted then the default filename host.nvm will be used.
  77. -q Suppress status messages on stderr.
  78. -t milliseconds
  79. Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
  80. response. The default is shown in brackets on the program menu.
  81. -v Print additional information on stdout. In particular, this option will print incoming and outgoing Ethernet
  82. frames on stdout.
  83. -?, --help
  84. Print program help summary on stdout. This option takes precedence over other options on the command line.
  85. -!, --version
  86. Print program version information on stdout. This option takes precedence over other options on the command line.
  87. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
  88. the Linux Toolkit you are using.
  89. ARGUMENTS
  90. None.
  91. REFERENCES
  92. See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
  93. EXAMPLES
  94. The following command starts the host emulator. The -C, -N and -P options are always required. Their order is not
  95. important.
  96. int6khost -C test.cfg -N test.nvm -P test.pib
  97. &gt; eth0 00:B0:52:00:00:01 Waiting for Host Action Requests
  98. &gt;
  99. DISCLAIMER
  100. Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
  101. Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
  102. sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
  103. gram.
  104. SEE ALSO
  105. plc(1), int64host(1), int6k(1), int6kboot(1) plchost(1)
  106. CREDITS
  107. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  108. open-plc-utils-0.0.3 Mar 2014 int6khost(1)
  109. </pre>
  110. <div class='footerlink'>
  111. [<a href='int6kf.1.html' title=' int6kf.1 '>PREV</a>]
  112. [<a href='toolkit.html' title=' Index '>HOME</a>]
  113. [<a href='int6kid.1.html' title=' int6kid.1 '>NEXT</a>]
  114. </div>
  115. </body>
  116. </html>