______________________________________________________________________________

ReadMe.txt
______________________________________________________________________________

Copyright (C) 2009 PLX Technology

____________________________
Installation
____________________________

1. Install Windows CE 6.00 Platform Builder (PB) to development PC. Note the 
   WINCEROOT, i.e. the path where the CE 6.0 is installed (generally C:\WINCE600).
   
   Note: Windows CE 6.0 deveopment is done using Visual Studio 2005 with Platform
		 Builder for CE 6.0 as a plug in. All OSDesign's, drivers and applications
		 are developed using Visual Studio 2005.

2. Double click the batch file "CopyDriverToWinCERoot.bat" to execute it. 
   This batch file will prompt the user to enter the WINCEROOT. The batch file 
   will then copy all files and sub-folders of the driver to the WINCEROOT.
   The following directory structure shall be seen:
   
	C:\WINCE600\OXSEMI
	               |------UARTS
	               |        |
	               |        |-----....
	               |        |-----BUSPCIE950
	               |        |-----PDDPCIE950
	               |        |-----SERPCIE950
	               |        |-----MDDPCIE950
	               |        |-----ISRPCIE950
	               |        |-----INC
	               |        \-----....
	               |
	               \------....
				   
3. The batch file will also copy the Catalog item file "pcie950.pbcxml" to the folder 
   C:\WINCEROOT\3RDPARTY\OXSEMI\CATALOG.

4. Start Visual Studio 2005 and create a new or open an existing OSDesign.

5. Open the "Catalog Items View" window. The driver catalog will be located under
   "device drivers\serial\uarts\". Click on the catalog item to include it in 
   the OSDesign.

6. Change the subproject build order to:

        ISRPCIE950
        PDDPCIE950
        SERPCIE950
        MDDPCIE950
        COMPCIE950
        BUSPCIE950
        ...

7. Execute "Build -> Rebuild All Subprojects" with "Make Run Time Imag after building" checked.
   This will copy the driver files into the released folder of the OSDesign.

______________________________________________________________________________

Modifications required
______________________________________________________________________________

Crystal Frequency
_________________

As PCIE950 family devices have fixed input clock frequency (62.5MHz), the default
Crystal Frequency has been defined in the "buspcie950.Reg" file and should not be
changed in any circumstances.


Interrupt triggering and flow control levels
____________________________________________

Four level control values can be defined in "buspcie950.reg" file (brackets indicate
the correcponding 16950 registers, to where the values will be stored when device
driver being loaded):

    "RxIntTrigLevel" ------ Receive Interrupt Triggering Level (RTL)
    "TxIntTrigLevel" ------ Transmit Interrupt Triggering Level (TTL)
    "FlowCtrlLowLevel" ---- Automatic Flow Control Lower Trigger Level (FCL)
    "FlowCtrlHighLevel" --- Automatic Flow Control Higher Trigger Level (FCH)

The level control values defined in "buspcie950.reg" file shall be used as default
values by all UART channels.

The level value are expressed in hexadecimal, NOT DECIMAL. For example, to set
the Receive Interrupt Triggering Level to 95, the following line should exist
under the corresponging key:

    "RxIntTrigLevel"=dword:5F
	
________________________________________________________________________________	
 
 Branding / Configuration File using Oxide:
___________________________________________
The driver supports branding and customization. The user can generate a branding
(or configuration) file using Oxford Semiconductor's Oxide. Using this file, the 
user can specify values for crystal frequency, fifo levels, line driver values 
etc. 

To support branding files, a few changes need to be done to the reg file:
        
        Add the following two entries to the reg file:
            
                "BrandingFile"="pcie_branding_file.oxbx"
                "ReadBrandFile"=dword:1
                
        Where "pcie_branding_file.oxbx" is the name of the branding file. This
        branding file must be kept in the following folder:
                %WINCEROOT%\OXSEMI\UARTS\BrandingFiles
        The subkey "ReadBrandFile" specifies the driver whether to read the 
        mentioned branding file or not. The value of '1' means the driver will
        read the file.
		
		Also, in order to download the branding file on to the target platform, the
		.bib file should be modified. Add the following line to the buspcie950.bib file under
		the 'FILES' section. Please see the buspcie950.bib for an example.
		
		        pcie_branding_file.oxbx  $(_WINCEROOT)\OXSEMI\UARTS\BRANDINGFILES\pcie_branding_file.oxbx 		NK  SHU

        
The branding file is also used by the S(et) Uart (SUART) application to modify 
its user interface.

________________________________________________________________________________

                                 End of ReadMe
________________________________________________________________________________
