initial usb
[rapper.git] / new_cmsis / usb / Abstract.txt
diff --git a/new_cmsis/usb/Abstract.txt b/new_cmsis/usb/Abstract.txt
new file mode 100755 (executable)
index 0000000..8f49cbf
--- /dev/null
@@ -0,0 +1,141 @@
+ ******************** (C) COPYRIGHT 2010 NXPSemiconductors *******************\r
+ * @file    USBDEV\USBCDC\abstract.txt \r
+ * @author  NXP MCU SW Application Team\r
+ * @version 2.0\r
+ * @date    \r
+ * @brief   Description of the USBDEV CDC example.\r
+ ******************************************************************************\r
+ * Software that is described herein is for illustrative purposes only\r
+ * which provides customers with programming information regarding the\r
+ * products. This software is supplied "AS IS" without any warranties.\r
+ * NXP Semiconductors assumes no responsibility or liability for the\r
+ * use of the software, conveys no license or title under any patent,\r
+ * copyright, or mask work right to the product. NXP Semiconductors\r
+ * reserves the right to make changes in the software without\r
+ * notification. NXP Semiconductors also make no representation or\r
+ * warranty that such application will be suitable for the specified\r
+ * use without further testing or modification.\r
+ ******************************************************************************\r
+  \r
+@Example description:\r
+       Purpose:\r
+               This example describes how to use USBDEV on LPC1768 to demo the virtual COM port.\r
+       Process:                                                         \r
+               Clock Settings:\r
+                  - XTAL                   =  12 MHz\r
+                  - PLL                    =  400 MHz\r
+                  - processor clock = CCLK =  100 MHz\r
+                  - USB clock              =  48 MHz\r
+                  - CCLK / 4 clock         =  25 MHz\r
+               \r
+               The PC will install a virtual COM port on the PC (see Driver Installation).\r
+               After installation an additional port "LPC17xx USB VCom Port(COMx)"\r
+               can be found under System/Hardware/Device Manager/Ports(COM&LPT).\r
+               Number "x" is not fixed as different PC configuration may have different \r
+               "x" displayed on the device manager. The USB host driver assigns "x" \r
+               dynamically based on the existing COM port configuration of the system.\r
+               \r
+               Testing the USB Virtual COM port with serial cable:\r
+\r
+               Open two Hyperterminal windows. \r
+               One with "LPC17xx USB VCom Port(COMx)" \r
+               One with "Communications Port (COM1)".\r
+               Connect PC port COM1 to the comport on the board and open "COM1" \r
+               and "COMx". Data from COM1 will be echoed on "COMx" and visa versa. \r
+               So, this is bi-directional communication between the physical COM\r
+               port 0 or 1 on the board and the virtual COM port COMx on host PC.\r
+               By default, COM PORT1 on the board is used for VirtualCOM port test.\r
+               In order to use COM PORT0 on the board, modify the definition PORT_NUM\r
+               from 1 to 0 in serial.h, recompile and reprogram the flash. RST jumper\r
+               needs to removed to start the Virtual COM port test.     \r
+               \r
+@Driver Installation:\r
+     "Welcome to the Found New Hardware Wizard" appears\r
+     - select 'No, not this time'\r
+     - press  'Next'\r
+\r
+     - select 'Install from a list or specific location (Advanced)'\r
+     - press  'Next'\r
+\r
+     - select 'Search for the best driver in these locations'\r
+     - check  'include this location in the serach'\r
+     - set to <project folder>\r
+     - press 'Next'\r
+\r
+     "Hardware Installation" appears\r
+     "has not passed Windows Logo testing..."\r
+     - press 'Continue Anyway'\r
+\r
+     "Completing the Found New Hardware Wizard" appears\r
+     - press 'Finish'\r
+               \r
+@Directory contents:\r
+       \EWARM: includes EWARM (IAR) project and configuration files\r
+       \Keil:  includes RVMDK (Keil)project and configuration files \r
+       \r
+       cdc.h: USB CDC (Communication Device) Definitions\r
+       cdcuser.h/.c: USB Communication Device Class User module\r
+       lpc17xx_libcfg.h: Library configuration file - include needed driver library for this example \r
+       serial.h/.c: serial port handling for LPC17xx\r
+       usb.h:  USB Definitions\r
+       usbcfg.h: USB Custom Configuration\r
+       usbcore.h/.c: USB Core Module\r
+       usbdesc.h/.c: USB Descriptors\r
+       usbhw.h/.c: SB Hardware Layer Module\r
+       usbreg.h: USB Hardware Layer Definitions for NXP Semiconductors LPC \r
+       usbuser.h/.c: USB Custom User Module\r
+       vcomdemo.h/.c: main program     \r
+       makefile: Example's makefile (to build with GNU toolchain)\r
+       lpc17xx-vom.inf: driver info for VCOM LPC17xx (used when Windows requires install driver)\r
+\r
+@How to run:\r
+       Hardware configuration:         \r
+               This example was tested only on:\r
+                       Keil MCB1700 with LPC1768 vers.1\r
+                               These jumpers must be configured as following:\r
+                               - VDDIO: ON\r
+                               - VDDREGS: ON \r
+                               - VBUS: ON\r
+                               - D+: DEVICE\r
+                               - D-: DEVICE\r
+                               - UMODE: 1-2 (USB)\r
+                               - E/U: 1-2 (USB)\r
+                               - Remain jumpers: OFF\r
+       \r
+       Running mode:\r
+               This example can run on RAM/ROM mode.\r
+                                       \r
+               Note: If want to burn hex file to board by using Flash Magic, these jumpers need\r
+               to be connected:\r
+                       - MCB1700 with LPC1768 ver.1:\r
+                               + RST: ON\r
+                               + ISP: ON\r
+                       - IAR LPC1768 KickStart vers.A:\r
+                               + RST_E: ON\r
+                               + ISP_E: ON\r
+               \r
+               (Please reference "LPC1000 Software Development Toolchain" - chapter 4 "Creating and working with\r
+               LPC1000CMSIS project" for more information)\r
+       \r
+       Step to run:\r
+               - Step 1: Build example.\r
+               - Step 2: Burn hex file into board (if run on ROM mode)\r
+               - Step 3: Configure hardware as above instruction \r
+               - Step 4: Hit reset button to run example. (install driver if required)\r
+               - Step 5: After see UGL(USB Good Link) led on board turn on, open Device Manager > Ports (COM & LPT)\r
+                                 see if "LPC17xx USB Vcom Port (COMx)" appears or not. \r
+               - Step 6: Open one HyperTerminal for COM1 and other for COMx with below configuration:\r
+                                       - 9600 bps\r
+                                       - 8 data bits\r
+                                       - none parity\r
+                                       - 1 stop bit\r
+                                       - None flow control\r
+               - Step 7: Sure that you already connected COM1 port on board with PC. Type any character on \r
+                               one HyperTerminal screen and see this character will be echoed in other screen and vice versa \r
+               \r
+               (Pls see "LPC17xx Example Description" document - chapter "Examples > USBDEV > USBCDC"\r
+               for more details)\r
+               \r
+@Tip:\r
+       - Open \EWARM\*.eww project file to run example on IAR\r
+       - Open \RVMDK\*.uvproj project file to run example on Keil
\ No newline at end of file