/***************************************************************************
 * Readme file:
 *
 * Blackfin USB-LAN EZ-EXTENDER: ADI_ETHER_BF537 driver, lwIP TCP/IP stack 
 *
 **************************************************************************/

Contents:
I.   Overview
II. Software details
     a. Device Driver software 
     b. Kernel Abstraction Interface
     c. lwIP TCP/IP stack
     d. Example Software
III. Documentation 


//////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////
I. Overview:

Network software for the BF537 includes set of device drivers Ethernet controller, 
lwIP TCP/IP stack,and set of examples.All the source code for the drivers, stack, 
examples are also included. The LAN driver conforms to ADI driver model which is new in 
VisualDSP++, and has a strightforward driver inteface API and powerful 
support libraries that simplfy the process of creating custom driver and 
applications.

The VisualDSP++ installer installs the BF537 driver and lwIP stack 
libraries in <install_path>\Blackfin\lib directory. Various libraries and
the interfaces associated with the stack software are depicted as below. 


                        Network Application

             ----------------------------------------------- 
                                  ^ Socket API
                                  |
                      -----------------   ---------------
                      | lwip library  |  | tcpip wrapper |
                      -----------------   ---------------
                              ^               ^
                              |               |
             -----------------------------------------------
                      ^                         ^
                      | Driver API              |  Kernel API
                      |                         |
              -------------------       -------------------
              | device driver   |       | kernel interface|
              -------------------       -------------------
      
 
Network application developers can use lwIP wizard, present in the IDDE 
under "New-project->TCP/IP stack application using lwIP Stack" to create an
network application project.

Source code for the drivers,stack and examples were present under
"<install_path>\Blackfin\lib\src\drivers\ethernet" directory.

Documentaion for the device driver and lwIP user guide is present under
"<install_path>\Blackfin\lib\src\lwip\contrib\ports\ADSP-Blackfin\docs directory.


//////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////
II. Software Sources:

lwIP Root directory for the software: <install_path>\Blackfin\lib\src\lwip

please note that "lwip_root" directory in the subsequent text means the above
directory.

  a. Device Drivers for SMSC-LAN91c111: 
     Using programmed I/O: 
     <install-dir>\blackfin\lib\src\drivers\ethernet\ADI_ETHER_BF537

  b. Kernel Software
     A wrapper source for the ADI's VDK kernel.

     <lwip_root>\contrib\ports\ADSP-Blackfin\proj\kernels\vdk

  c. lwIP stack software
     <lwip_root>\lwip\ 
     please refer to <lwip_root>\readme.txt file fore more information.  
 
  d. Examples	
     Set of Networking Examples were included in 
     <install-dir>\Blackfin\examples\ADSP-BF537 EZ-Kit Lite\LAN directory.
     Each example project contain a "Readme.txt" under "Documentation" folder
     which contain detailed information about the example.
    
     A tracing example and a freely available webserver is also included.

//////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////
III. Documentation:
    
    Documentation files were present under <lwip_root>\docs\ directory.Brief
    description about the documentation files. 
    
    a. LWIP_UserGuide.doc                  - User guide for the stack 
                                             application developers.
    b. SMSCLAN91c111_DeviceDriver.doc      - SMSC Device driver definition.
    c. BF537EthernetDeviceDriverDesign.doc - BF537 Device driver design.
    d. Kernel_api.html                     - Kernel Abstraction interface 
                                             specification.
    e. socket_api\                         - please open index.html which 
                                             contain documentation for the 
                                             supported socket API.

/////////////////////////////////////////////////////////////////////////