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