new_cmsis/usb/Abstract.txt

   1  ******************** (C) COPYRIGHT 2010 NXPSemiconductors *******************\r
   2  * @file    USBDEV\USBCDC\abstract.txt \r
   3  * @author  NXP MCU SW Application Team\r
   4  * @version 2.0\r
   5  * @date    \r
   6  * @brief   Description of the USBDEV CDC example.\r
   7  ******************************************************************************\r
   8  * Software that is described herein is for illustrative purposes only\r
   9  * which provides customers with programming information regarding the\r
  10  * products. This software is supplied "AS IS" without any warranties.\r
  11  * NXP Semiconductors assumes no responsibility or liability for the\r
  12  * use of the software, conveys no license or title under any patent,\r
  13  * copyright, or mask work right to the product. NXP Semiconductors\r
  14  * reserves the right to make changes in the software without\r
  15  * notification. NXP Semiconductors also make no representation or\r
  16  * warranty that such application will be suitable for the specified\r
  17  * use without further testing or modification.\r
  18  ******************************************************************************\r
  19   \r
  20 @Example description:\r
  21         Purpose:\r
  22                 This example describes how to use USBDEV on LPC1768 to demo the virtual COM port.\r
  23         Process:                                                         \r
  24                 Clock Settings:\r
  25                    - XTAL                   =  12 MHz\r
  26                    - PLL                    =  400 MHz\r
  27                    - processor clock = CCLK =  100 MHz\r
  28                    - USB clock              =  48 MHz\r
  29                    - CCLK / 4 clock         =  25 MHz\r
  30                 \r
  31                 The PC will install a virtual COM port on the PC (see Driver Installation).\r
  32                 After installation an additional port "LPC17xx USB VCom Port(COMx)"\r
  33                 can be found under System/Hardware/Device Manager/Ports(COM&LPT).\r
  34                 Number "x" is not fixed as different PC configuration may have different \r
  35                 "x" displayed on the device manager. The USB host driver assigns "x" \r
  36                 dynamically based on the existing COM port configuration of the system.\r
  37                 \r
  38                 Testing the USB Virtual COM port with serial cable:\r
  39 \r
  40                 Open two Hyperterminal windows. \r
  41                 One with "LPC17xx USB VCom Port(COMx)" \r
  42                 One with "Communications Port (COM1)".\r
  43                 Connect PC port COM1 to the comport on the board and open "COM1" \r
  44                 and "COMx". Data from COM1 will be echoed on "COMx" and visa versa. \r
  45                 So, this is bi-directional communication between the physical COM\r
  46                 port 0 or 1 on the board and the virtual COM port COMx on host PC.\r
  47                 By default, COM PORT1 on the board is used for VirtualCOM port test.\r
  48                 In order to use COM PORT0 on the board, modify the definition PORT_NUM\r
  49                 from 1 to 0 in serial.h, recompile and reprogram the flash. RST jumper\r
  50                 needs to removed to start the Virtual COM port test.     \r
  51                 \r
  52 @Driver Installation:\r
  53      "Welcome to the Found New Hardware Wizard" appears\r
  54      - select 'No, not this time'\r
  55      - press  'Next'\r
  56 \r
  57      - select 'Install from a list or specific location (Advanced)'\r
  58      - press  'Next'\r
  59 \r
  60      - select 'Search for the best driver in these locations'\r
  61      - check  'include this location in the serach'\r
  62      - set to <project folder>\r
  63      - press 'Next'\r
  64 \r
  65      "Hardware Installation" appears\r
  66      "has not passed Windows Logo testing..."\r
  67      - press 'Continue Anyway'\r
  68 \r
  69      "Completing the Found New Hardware Wizard" appears\r
  70      - press 'Finish'\r
  71                 \r
  72 @Directory contents:\r
  73         \EWARM: includes EWARM (IAR) project and configuration files\r
  74         \Keil:  includes RVMDK (Keil)project and configuration files \r
  75         \r
  76         cdc.h: USB CDC (Communication Device) Definitions\r
  77         cdcuser.h/.c: USB Communication Device Class User module\r
  78         lpc17xx_libcfg.h: Library configuration file - include needed driver library for this example \r
  79         serial.h/.c: serial port handling for LPC17xx\r
  80         usb.h:  USB Definitions\r
  81         usbcfg.h: USB Custom Configuration\r
  82         usbcore.h/.c: USB Core Module\r
  83         usbdesc.h/.c: USB Descriptors\r
  84         usbhw.h/.c: SB Hardware Layer Module\r
  85         usbreg.h: USB Hardware Layer Definitions for NXP Semiconductors LPC \r
  86         usbuser.h/.c: USB Custom User Module\r
  87         vcomdemo.h/.c: main program     \r
  88         makefile: Example's makefile (to build with GNU toolchain)\r
  89         lpc17xx-vom.inf: driver info for VCOM LPC17xx (used when Windows requires install driver)\r
  90 \r
  91 @How to run:\r
  92         Hardware configuration:         \r
  93                 This example was tested only on:\r
  94                         Keil MCB1700 with LPC1768 vers.1\r
  95                                 These jumpers must be configured as following:\r
  96                                 - VDDIO: ON\r
  97                                 - VDDREGS: ON \r
  98                                 - VBUS: ON\r
  99                                 - D+: DEVICE\r
 100                                 - D-: DEVICE\r
 101                                 - UMODE: 1-2 (USB)\r
 102                                 - E/U: 1-2 (USB)\r
 103                                 - Remain jumpers: OFF\r
 104         \r
 105         Running mode:\r
 106                 This example can run on RAM/ROM mode.\r
 107                                         \r
 108                 Note: If want to burn hex file to board by using Flash Magic, these jumpers need\r
 109                 to be connected:\r
 110                         - MCB1700 with LPC1768 ver.1:\r
 111                                 + RST: ON\r
 112                                 + ISP: ON\r
 113                         - IAR LPC1768 KickStart vers.A:\r
 114                                 + RST_E: ON\r
 115                                 + ISP_E: ON\r
 116                 \r
 117                 (Please reference "LPC1000 Software Development Toolchain" - chapter 4 "Creating and working with\r
 118                 LPC1000CMSIS project" for more information)\r
 119         \r
 120         Step to run:\r
 121                 - Step 1: Build example.\r
 122                 - Step 2: Burn hex file into board (if run on ROM mode)\r
 123                 - Step 3: Configure hardware as above instruction \r
 124                 - Step 4: Hit reset button to run example. (install driver if required)\r
 125                 - Step 5: After see UGL(USB Good Link) led on board turn on, open Device Manager > Ports (COM & LPT)\r
 126                                   see if "LPC17xx USB Vcom Port (COMx)" appears or not. \r
 127                 - Step 6: Open one HyperTerminal for COM1 and other for COMx with below configuration:\r
 128                                         - 9600 bps\r
 129                                         - 8 data bits\r
 130                                         - none parity\r
 131                                         - 1 stop bit\r
 132                                         - None flow control\r
 133                 - Step 7: Sure that you already connected COM1 port on board with PC. Type any character on \r
 134                                 one HyperTerminal screen and see this character will be echoed in other screen and vice versa \r
 135                 \r
 136                 (Pls see "LPC17xx Example Description" document - chapter "Examples > USBDEV > USBCDC"\r
 137                 for more details)\r
 138                 \r
 139 @Tip:\r
 140         - Open \EWARM\*.eww project file to run example on IAR\r
 141         - Open \RVMDK\*.uvproj project file to run example on Keil