//
// Copyright (c) Microsoft Corporation.  All rights reserved.
//
//
// Use of this source code is subject to the terms of the Microsoft end-user
// license agreement (EULA) under which you licensed this SOFTWARE PRODUCT.
// If you did not accept the terms of the EULA, you are not authorized to use
// this source code. For a copy of the EULA, please see the LICENSE.RTF on your
// install media.
//

USB RNDIS KITL allows developers to debug and flash their devices over USB.
Remote NDIS abstracts your device as a "Local Area Connection", so it can
use your desktop's NIC as a proxy to the network. As such, we configure
Platform Builder's connectivity options for Ethernet.

The necessary RNDIS host drivers are shipped in Windows XP.  For other
Windows OS, please refer to:
http://www.microsoft.com/hwdev/resources/hwservices/rndis.asp
Note that the Microsoft generic RNDISMINI Product ID is 0x0301 and
the Vendor ID is 0x045E.

You'll need the following files in XP to use the USB RNDIS host driver.

windows\inf\usb8023.inf
windows\system32\drivers\usb8023.sys
windows\system32\drivers\rndismp.sys

The steps below will explain how to get these files and set up your
machine.  After you have follow these steps, your USB RNDIS KITL connection
will come up automatically.

1) Install the Microsoft USB RNDIS driver. The GENERIC RNDIS driver
    ships with Windows 2K SP4 and above, however an extra .inf file is
    required to associate the Microsoft VID/PID with the generic driver.
   a) Copy usb8023.inf from \public\common\oak\drivers\ethdbg\rndismini\host
       to %Windows%\inf.
   b) Confirm that usb8023.sys and rndismp.sys exist in your
       %Windows%\system32\drivers directory. If they do not, you are
       missing the generic RNDIS driver and can get it at
       http://www.microsoft.com/whdc/device/network/NDIS/rndis.mspx.
   c) Connect your USB RNDIS device to Windows XP.  An "Add new hardware"
       dialog will pop up.  Follow the dialog.  Don't download any
       drivers from Windows Update since you already have them.  If the
       installer has trouble finding your driver, point it at the .inf
       and .sys files you copied in steps 1a. and 1b.

2) Choose how the device will connect to the internet. After installing
    the driver, your device will appear as a network connection.  However,
    it will be unable to obtain an IP address, and you will receive a
    "Limited Connectivity" warning.  To address this, you must use Internet
    Connection Sharing (ICS) or create a network bridge.
   a) Internet connection sharing employs network address translation (NAT).
       Your device gets a local IP address, and the desktop filters all
       network packets and lets only what the device cares about through.
       This is the recommended approach.  To enable ICS, attach the USB
       RNDIS device, so that the "<device name> USB Remote NDIS" connection
       appears.  Once two (non-bridged) connections exist, an "Advanced"
       tab becomes visible when you right-click your PC NIC connection
       and choose "Properties". Check the box that says "Allow other
       network users to connect through this computer's internet
       connection", and click OK.
   b) The alternative approach is to use a network bridge.  This can
       cause a high load on slower devices and is not preferred.  If
       you use a network bridge, understand that ALL packets that
       reach your PC's NIC will be repeated to your device.  Also, you
       will get an IP address on the same network that your host machine.
       is connected to.  To create a bridge, open your network
       connections.  Highlight both the device's connection and your PC
       NIC connection, right-click, and choose "Bridge".