ch01.html 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Chapter 1.  Overview</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><meta name="keywords" content="Intellon, Atheros, Qualcomm, HomePlug, powerline, communications, INT6000, INT6300, INT6400, AR7400, AR7420"><link rel="home" href="index.html" title="Qualcomm Atheros Open Powerline Toolkit"><link rel="up" href="index.html" title="Qualcomm Atheros Open Powerline Toolkit"><link rel="prev" href="index.html" title="Qualcomm Atheros Open Powerline Toolkit"><link rel="next" href="ch01s02.html" title="Background"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 1. 
  2. Overview
  3. </th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch01s02.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 1.  Overview"><div class="titlepage"><div><div><h2 class="title"><a name="overview"></a>Chapter 1. 
  4. Overview
  5. </h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch01.html#overview-intro">
  6. Introduction
  7. </a></span></dt><dt><span class="section"><a href="ch01s02.html">
  8. Background
  9. </a></span></dt><dt><span class="section"><a href="ch01s03.html">
  10. Toolkit Distribution
  11. </a></span></dt><dt><span class="section"><a href="ch01s04.html">
  12. Toolkit Installation on Linux
  13. </a></span></dt><dd><dl><dt><span class="section"><a href="ch01s04.html#idp18533192">
  14. Toolkit Installation on GNU/<span class="productname">Linux</span>™
  15. </a></span></dt><dt><span class="section"><a href="ch01s04.html#idp18547152">
  16. Toolkit Documentation on GNU/Linux
  17. </a></span></dt><dt><span class="section"><a href="ch01s04.html#idp18549840">
  18. Toolkit Removal on GNU/<span class="productname">Linux</span>™
  19. </a></span></dt></dl></dd><dt><span class="section"><a href="ch01s05.html">
  20. Toolkit Installation on Mac OS X
  21. </a></span></dt><dt><span class="section"><a href="ch01s06.html">
  22. Toolkit Installation on <span class="productname">Windows XP</span>™
  23. </a></span></dt><dd><dl><dt><span class="section"><a href="ch01s06.html#idp18602920">
  24. Obtaining the Toolkit
  25. </a></span></dt><dt><span class="section"><a href="ch01s06.html#idp18604624">
  26. Installing the Toolkit
  27. </a></span></dt><dt><span class="section"><a href="ch01s06.html#idp18609216">
  28. Setting the PATH variable
  29. </a></span></dt><dt><span class="section"><a href="ch01s06.html#removal-windows-xp">
  30. Removing the Toolkit
  31. </a></span></dt></dl></dd><dt><span class="section"><a href="ch01s07.html">
  32. Toolkit Installation on <span class="productname">Windows 7</span>™
  33. </a></span></dt><dd><dl><dt><span class="section"><a href="ch01s07.html#idp18672976">
  34. Obtaining the Toolkit
  35. </a></span></dt><dt><span class="section"><a href="ch01s07.html#idp18674680">
  36. Installing the Toolkit
  37. </a></span></dt><dt><span class="section"><a href="ch01s07.html#idp18677792">
  38. Setting the PATH variable
  39. </a></span></dt><dt><span class="section"><a href="ch01s07.html#removal-windows-7">
  40. Removing the Toolkit
  41. </a></span></dt></dl></dd><dt><span class="section"><a href="ch01s08.html">
  42. Toolkit Programs
  43. </a></span></dt><dd><dl><dt><span class="section"><a href="ch01s08.html#programs-6400-Management">
  44. INT6400 Device Management
  45. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-6400-Monitoring">
  46. INT6400 Device Monitoring
  47. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-7400-Management">
  48. AR7400 Device Management
  49. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-7400-Monitoring">
  50. AR7400 Device Monitoring
  51. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-7420">
  52. AR7420 Device Configuration
  53. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-configure">
  54. Parameter File Management
  55. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-firmware">
  56. Firmware File Management
  57. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-ethernet">
  58. Ethernet Traffic
  59. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-passwords">
  60. Passwords and Keys
  61. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-mdio">
  62. MDIO Programming
  63. </a></span></dt><dt><span class="section"><a href="ch01s08.html#programs-serial">
  64. Serial Programming
  65. </a></span></dt></dl></dd><dt><span class="section"><a href="ch01s09.html">
  66. Toolkit Folders
  67. </a></span></dt><dt><span class="section"><a href="ch01s10.html">
  68. Packages
  69. </a></span></dt><dt><span class="section"><a href="ch01s11.html">
  70. Toolkit Support
  71. </a></span></dt></dl></div><div class="section" title="Introduction"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="overview-intro"></a>
  72. Introduction
  73. </h2></div></div></div><p>
  74. The <span class="application">Open Powerline Toolkit</span> (vanilla version) may be downloaded from <a class="ulink" href="" target="_top">https://github.com/qca/open-plc-utils.git</a> by any interested party. An advanced version (chocolate version) may be downloaded from the Qualcomm Atheros Customer FTP site by parties having permission to do so. The chocolate version includes special programs that perform advanced engineering, production and maintenance tasks. Within this document, we refer to both versions, collectively, as <span class="quote">“<span class="quote">the toolkit</span>”</span>.
  75. </p><p>
  76. The toolkit contains C Language source code and <span class="productname">GNU</span>™ makefiles to compile many useful programs. It also includes Linux shell scripts that use these programs, in various ways, to interrogate, control and manage Qualcomm Atheros <span class="productname">INT6000</span>™, <span class="productname">INT6300</span>™, <span class="productname">INT6400</span>™, <span class="productname">AR7400</span>™ and later powerline devices. Qualcomm Atheros also provides a similar, but less extensive, toolkit for <span class="productname">INT5500</span>™ powerline devices.
  77. </p><p>
  78. The toolkit is intended for hardware engineers, verification engineers, field engineers and embedded software developers, consequently, programs are simple and compact. It is not intended for computer novices or retail users. Many customers embed a subset of toolkit programs in products for troubleshooting purposes.
  79. </p><p>
  80. The toolkit includes extensive HTML documentation and online man pages for users who cannot access installed man pages. HTML documentation starts with file <a class="ulink" href="index.html" target="_top">docbook/index.html</a>. Online man pages start with file <a class="ulink" href="toolkit.html" target="_top">docbook/toolkit.html</a>. Qualcomm Atheros recommends that you add these two pages to your browser favorites for later reference.
  81. </p><p>
  82. All toolkit programs are written in C and have command line intefaces. The source code essentially conforms to <a class="ulink" href="http://www.open-std.org/jtc1/sc22/wg14/www/standards.html#9899" target="_top">ISO/IEC9899:1999</a>. The source tree cleanly compiles using gcc or pcc on Ubuntu, OpenBSD and MacOSX. It also compiles under Microsoft C with the inclusion of special header files. The command line interface conforms to <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html#tag_12_02" target="_top"> <em class="citetitle">Section 12.2 Utility Syntax Guidelines</em></a> of The Open Group Base Specification Issue 6 (<a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/mindex.html" target="_top">
  83. <em class="citetitle">IEEE Std 1003.1, 2004 Edition</em></a>).
  84. </p><p>
  85. The toolkit includes Microsoft Visual Studio .NET project files and solutions files to compile toolkit programs, plus the executable version (<code class="filename">.exe</code>) of each program and a set of Microsoft installation file (<code class="filename">.msi</code>) so that the toolkit package comes ready to install and run on any Windows host; however, Qualcomm Atheros does not provide support for Microsoft windows version of this toolkit. Toolkit documentation does provide Windows developers with special guidance on setting up their own Visual Studio projects and solutions, should they want to do that.
  86. </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch01s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">
  87. Qualcomm Atheros Open Powerline Toolkit
  88.  </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 
  89. Background
  90. </td></tr></table></div></body></html>