Abstract.h

00001  ******************** (C) COPYRIGHT 2010 NXPSemiconductors *******************
00002  * @file    USBDEV\USBCDC\abstract.txt 
00003  * @author  NXP MCU SW Application Team
00004  * @version 2.0
00005  * @date    
00006  * @brief   Description of the USBDEV CDC example.
00007  ******************************************************************************
00008  * Software that is described herein is for illustrative purposes only
00009  * which provides customers with programming information regarding the
00010  * products. This software is supplied "AS IS" without any warranties.
00011  * NXP Semiconductors assumes no responsibility or liability for the
00012  * use of the software, conveys no license or title under any patent,
00013  * copyright, or mask work right to the product. NXP Semiconductors
00014  * reserves the right to make changes in the software without
00015  * notification. NXP Semiconductors also make no representation or
00016  * warranty that such application will be suitable for the specified
00017  * use without further testing or modification.
00018  ******************************************************************************
00019   
00020 @Example description:
00021     Purpose:
00022         This example describes how to use USBDEV on LPC1768 to demo the virtual COM port.
00023     Process:                                                     
00024         Clock Settings:
00025            - XTAL                   =  12 MHz
00026            - PLL                    =  400 MHz
00027            - processor clock = CCLK =  100 MHz
00028            - USB clock              =  48 MHz
00029            - CCLK / 4 clock         =  25 MHz
00030         
00031         The PC will install a virtual COM port on the PC (see Driver Installation).
00032         After installation an additional port "LPC17xx USB VCom Port(COMx)"
00033         can be found under System/Hardware/Device Manager/Ports(COM&LPT).
00034         Number "x" is not fixed as different PC configuration may have different 
00035         "x" displayed on the device manager. The USB host driver assigns "x" 
00036         dynamically based on the existing COM port configuration of the system.
00037         
00038         Testing the USB Virtual COM port with serial cable:
00039 
00040         Open two Hyperterminal windows. 
00041             One with "LPC17xx USB VCom Port(COMx)" 
00042             One with "Communications Port (COM1)".
00043         Connect PC port COM1 to the comport on the board and open "COM1" 
00044         and "COMx". Data from COM1 will be echoed on "COMx" and visa versa. 
00045         So, this is bi-directional communication between the physical COM
00046         port 0 or 1 on the board and the virtual COM port COMx on host PC.
00047         By default, COM PORT1 on the board is used for VirtualCOM port test.
00048         In order to use COM PORT0 on the board, modify the definition PORT_NUM
00049         from 1 to 0 in serial.h, recompile and reprogram the flash. RST jumper
00050         needs to removed to start the Virtual COM port test.     
00051         
00052 @Driver Installation:
00053      "Welcome to the Found New Hardware Wizard" appears
00054      - select 'No, not this time'
00055      - press  'Next'
00056 
00057      - select 'Install from a list or specific location (Advanced)'
00058      - press  'Next'
00059 
00060      - select 'Search for the best driver in these locations'
00061      - check  'include this location in the serach'
00062      - set to <project folder>
00063      - press 'Next'
00064 
00065      "Hardware Installation" appears
00066      "has not passed Windows Logo testing..."
00067      - press 'Continue Anyway'
00068 
00069      "Completing the Found New Hardware Wizard" appears
00070      - press 'Finish'
00071             
00072 @Directory contents:
00073     \EWARM: includes EWARM (IAR) project and configuration files
00074     \Keil:  includes RVMDK (Keil)project and configuration files 
00075     
00076     cdc.h: USB CDC (Communication Device) Definitions
00077     cdcuser.h/.c: USB Communication Device Class User module
00078     lpc17xx_libcfg.h: Library configuration file - include needed driver library for this example 
00079     serial.h/.c: serial port handling for LPC17xx
00080     usb.h:  USB Definitions
00081     usbcfg.h: USB Custom Configuration
00082     usbcore.h/.c: USB Core Module
00083     usbdesc.h/.c: USB Descriptors
00084     usbhw.h/.c: SB Hardware Layer Module
00085     usbreg.h: USB Hardware Layer Definitions for NXP Semiconductors LPC 
00086     usbuser.h/.c: USB Custom User Module
00087     vcomdemo.h/.c: main program 
00088     makefile: Example's makefile (to build with GNU toolchain)
00089     lpc17xx-vom.inf: driver info for VCOM LPC17xx (used when Windows requires install driver)
00090 
00091 @How to run:
00092     Hardware configuration:     
00093         This example was tested only on:
00094             Keil MCB1700 with LPC1768 vers.1
00095                 These jumpers must be configured as following:
00096                 - VDDIO: ON
00097                 - VDDREGS: ON 
00098                 - VBUS: ON
00099                 - D+: DEVICE
00100                 - D-: DEVICE
00101                 - UMODE: 1-2 (USB)
00102                 - E/U: 1-2 (USB)
00103                 - Remain jumpers: OFF
00104     
00105     Running mode:
00106         This example can run on RAM/ROM mode.
00107                     
00108         Note: If want to burn hex file to board by using Flash Magic, these jumpers need
00109         to be connected:
00110             - MCB1700 with LPC1768 ver.1:
00111                 + RST: ON
00112                 + ISP: ON
00113             - IAR LPC1768 KickStart vers.A:
00114                 + RST_E: ON
00115                 + ISP_E: ON
00116         
00117         (Please reference "LPC1000 Software Development Toolchain" - chapter 4 "Creating and working with
00118         LPC1000CMSIS project" for more information)
00119     
00120     Step to run:
00121         - Step 1: Build example.
00122         - Step 2: Burn hex file into board (if run on ROM mode)
00123         - Step 3: Configure hardware as above instruction 
00124         - Step 4: Hit reset button to run example. (install driver if required)
00125         - Step 5: After see UGL(USB Good Link) led on board turn on, open Device Manager > Ports (COM & LPT)
00126                   see if "LPC17xx USB Vcom Port (COMx)" appears or not. 
00127         - Step 6: Open one HyperTerminal for COM1 and other for COMx with below configuration:
00128                     - 9600 bps
00129                     - 8 data bits
00130                     - none parity
00131                     - 1 stop bit
00132                     - None flow control
00133         - Step 7: Sure that you already connected COM1 port on board with PC. Type any character on 
00134                 one HyperTerminal screen and see this character will be echoed in other screen and vice versa 
00135         
00136         (Pls see "LPC17xx Example Description" document - chapter "Examples > USBDEV > USBCDC"
00137         for more details)
00138         
00139 @Tip:
00140     - Open \EWARM\*.eww project file to run example on IAR
00141     - Open \RVMDK\*.uvproj project file to run example on Keil