**
**
**  VNT Velocity Family Gigabit Ethernet Adapter
**
**  Ethernet Downloader/Debugger package for Windows CE 4.2
**
**  v1.01   Jun, 2004
**
**


Introduction:
=============

  This document shows you how to enables VNT Velocity Family Gigabit Ethernet Adapter
  to be adopted as a download/debug card for WINCE .NET platform builder 4.2.


Contents of the Subdirectory:
=============================

    \DEBUG\GETDBG.LIB             getdbg library debug version
    \DEBUG\GETDBG.PDB             getdbg library debug pdb file
    \RETAIL\GETDBG.LIB            getdbg library retail version
    \RETAIL\GETDBG.PDB            getdbg library retail pdb file
    MAKEFILE                      sample MAKEFILE file
    SOURCES                       sample SOURCES file
    HALETHER.H                    HAL Header File
    HALETHER.C                    HALETHER Source Code 
    EBOOT.BIN                     ethernet boot loader file
    LOADCEPC.EXE                  Windows CE .NET boot loader 
    GETDBG.TXT                    this file



Installation:
=============

  Assume your target platform is equipped with 
  VNT Velocity Family Gigabit Ethernet Adapter, the platform is "CEPC:X86".
  Installation and test instructions are described below.


  1. Copy binary library files

    (1) Retail build:
       Copy the following files to directory
       \WINCE420\public\common\oak\LIB\X86\RETAIL

            \Retail\getdbg.lib
            \Retail\getdbg.pdb

    (2) Debug build:
       Copy the following files to directory
       \WINCE420\public\common\oak\LIB\X86\DEBUG

            \Debug\getdbg.lib
            \Debug\getdbg.pdb


  2. Modify HALETHER.C

    Locate the HALETHER.C file in directory \WINCE420\PLATFORM\CEPC\KERNEL\HAL
    and add the following codes in the "switch (pBootArgs->ucEdbgAdapterType)" statement
    in the OEMEthInit() function:
  
    case EDBG_ADAPTER_GET:
        pfnEDbgInit           = GETInit;
        pfnEDbgInitDMA        = GETInitDMABuffer;
        pfnEDbgEnableInts     = GETEnableInts;
        pfnEDbgDisableInts    = GETDisableInts;
        pfnEDbgGetPendingInts = GETGetPendingInts;
        pfnEDbgGetFrame       = GETGetFrame;
        pfnEDbgSendFrame      = GETSendFrame;
        pfnEDbgReadEEPROM     = GETReadEEPROM;
        pfnEDbgWriteEEPROM    = GETWriteEEPROM;
        pfnEDbgSetOptions     = GETSetOptions;
        pfnCurrentPacketFilter= GETCurrentPacketFilter;
        pfnMulticastList      = GETMulticastList;
        break;

    Sample HALETHER.C file is included for your reference.


  3. Modify halether.h

    Locate the halether.h file in directory \WINCE420\public\common\oak\INC
    and add the following lines:
  
       #define EDBG_ADAPTER_GET   66

       // Prototypes for GETDBG.LIB functions
       BOOL   GETInitDMABuffer(DWORD dwStartAddress, DWORD dwSize);
       BOOL   GETInit( BYTE *pbBaseAddress, DWORD dwMultiplier, USHORT MacAddr[3]);
       void   GETEnableInts(void);
       void   GETDisableInts(void);
       DWORD  GETGetPendingInts(void);
       UINT16 GETGetFrame( BYTE *pbData, UINT16 *pwLength );
       UINT16 GETSendFrame( BYTE *pbData, DWORD dwLength );
       BOOL   GETReadEEPROM( UINT16 EEPROMAddress, UINT16 *pwVal);
       BOOL   GETWriteEEPROM( UINT16 EEPROMAddress, UINT16 Data );
       DWORD  GETSetOptions(DWORD dwOptions);
       void   GETCurrentPacketFilter(DWORD	dwFilter);
       BOOL   GETMulticastList(PUCHAR pucMulticastAddresses, DWORD dwNoOfAddresses);

    Also add the following lines into the SUPPORTED_COMMON_NIC #define section:

       {0x1106, 0x3119, 0xABCDEF, EDBG_ADAPTER_GET,     "VN" }, /* VNT */\

    Sample halether.h file is included for your reference.


  4. Modify the "Sources" files

    Locate respectively the "Sources" files in the two directories
        \WINCE420\PLATFORM\CEPC\KERNEL\BUILDEXE\KERNKITL
        \WINCE420\PLATFORM\CEPC\KERNEL\BUILDEXE\KERNKITLPROF

    and add one extra lines below for the TARGETLIBS environment variable:

    $(_COMMONOAKROOT)\lib\$(_CPUDEPPATH)\getdbg.lib  \

    Sample "Sources" file is included for your reference.


  5. Modify MAKEFILE file

    Locate the MAKEFILE file in directory \WINCE420\public\common\CESYSGEN
    and add "getdbg" for the tools and httpftp segments.

    Sample "MAKEFILE" file is included for your reference.


  6. Build CEPC platform

    Choose "Build Platform" from the "Build" menu to make a new OS image.


  7. Basic testing

    A file named EBOOT.BIN is included in this package. Copy this file to your boot disk.

    If you need to specify IRQ or IOPORT for ethernet debug card, a setup utility is
    included in this package. Run this setup utility on your target platform to check
    the IRQ and IOPORT assignments of the card.

    Then run loadcepc.exe to download the OS image.

    Usage,
       loadcepc /e:<IOPORT in HEX>:<IRQ in hex>:[<dotted IP address, optional>] eboot.bin

    Where <IOPORT> and <IRQ> could be found by the setup utility.

    Typical examples,
        In case of static IP assignment,
           loadcepc /e:E000:B:192.168.1.123 eboot.bin

        In case of IP assignment through DHCP,
            loadcepc /e:E000:B eboot.bin


  8. IDE platform builder ethernet download/debug settings

    In order to configure a connection for downloading and debugging, choose
    "Configure Remote Connection" from the Target menu to select the device name to be 
    used for image downloading and debugging.


  9. GET NDIS LAN driver/EDBG conflict problem

    If a GET is used as a download/debug card, then GET Gigabit Ethernet LAN Driver driver
    must not be installed on this download/debug card. Improper installation could cause
    Windows CE system hanging.
    By default, a VMini Ethernet sharing library is supported by CE.Net. It's a miniport driver
    that interfaces with VBridge to handle traffic not related to Ethernet debugging. Besides
    EDBG, a GET download/debug card also functions as a product Ethernet card.
    Note:If the environment variable BSP_NOSHAREETH is set, VMini will be disabled.