Tighten up Printer bootloader implementation; fold the IsHEX() function logic into...
[pub/USBasp.git] / Demos / Device / LowLevel / RNDISEthernet / RNDISEthernet.txt
index 906ea01..ac72d4a 100644 (file)
@@ -6,14 +6,14 @@
 
 /** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
  *
- *  \section SSec_Compat Demo Compatibility:
+ *  \section Sec_Compat Demo Compatibility:
  *
  *  The following list indicates what microcontrollers are compatible with this demo.
  *
- *  - Series 7 USB AVRs (AT90USBxxx7)
- *  - Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 6 USB AVRs (AT90USBxxx6)
  *
- *  \section SSec_Info USB Information:
+ *  \section Sec_Info USB Information:
  *
  *  The following table gives a rundown of the USB utilization of this demo.
  *
  *    <td>Microsoft RNDIS Specification</td>
  *   </tr>
  *   <tr>
- *    <td><b>Usable Speeds:</b></td>
+ *    <td><b>Supported USB Speeds:</b></td>
  *    <td>Full Speed Mode</td>
  *   </tr>
  *  </table>
  *
- *  \section SSec_Description Project Description:
+ *  \section Sec_Description Project Description:
  *
  *  Remote Network Driver Interface demonstration application.
  *  This gives a simple reference application for implementing
@@ -73,7 +73,7 @@
  *  recommended that it be replaced with an external open source TCP/IP
  *  stack that is feature complete, such as the uIP stack.
  *
- *  \section SSec_Options Project Options
+ *  \section Sec_Options Project Options
  *
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  *
  *    <td><b>Description:</b></td>
  *   </tr>
  *   <tr>
+ *    <td>CLIENT_IP_ADDRESS</td>
+ *    <td>AppConfig.h</td>
+ *    <td>Configures the IP address given to the client (PC) via the DHCP server.</td>
+ *   </tr>
+ *   <tr>
+ *    <td>SERVER_IP_ADDRESS</td>
+ *    <td>AppConfig.h</td>
+ *    <td>Configures the IP address of the virtual server.</td>
+ *   </tr>
+ *   <tr>
+ *    <td>ADAPTER_MAC_ADDRESS</td>
+ *    <td>AppConfig.h</td>
+ *    <td>Configures the MAC address of the RNDIS adapter on the host (PC) side.</td>
+ *   </tr>
+ *   <tr>
+ *    <td>SERVER_MAC_ADDRESS</td>
+ *    <td>AppConfig.h</td>
+ *    <td>Configures the MAC address of the virtual server on the network.</td>
+ *   </tr>
+ *   <tr>
  *    <td>NO_DECODE_ETHERNET</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>When defined, received Ethernet headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_ARP</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>When defined, received ARP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_IP</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>When defined, received IP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_ICMP</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>When defined, received ICMP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_TCP</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>When defined, received TCP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_UDP</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>When defined, received UDP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_DHCP</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>When defined, received DHCP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *  </table>