Frank 26080115
These are the examples provided for [[/users/frank26080115/libraries/LPC1700CMSIS_Lib/]] Note, the entire "program" is not compilable!
USBDEV/USBHID/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\USBHID\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 HID 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 run a simple HID application. |
| 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 | It demonstrates an USB HID (Human Interface Device): |
| frank26080115 | 0:bf7b9fba3924 | 32 | - LEDs (LEDs controlled by P1.28, P1.29, P1.31, P2.2-6) |
| frank26080115 | 0:bf7b9fba3924 | 33 | - Push Button (INT0) |
| frank26080115 | 0:bf7b9fba3924 | 34 | |
| frank26080115 | 0:bf7b9fba3924 | 35 | The USB HID is recognized by the host PC running Windows |
| frank26080115 | 0:bf7b9fba3924 | 36 | which will load a generic HID driver. The board LEDs |
| frank26080115 | 0:bf7b9fba3924 | 37 | and Push Buttons can then be accessed from the PC |
| frank26080115 | 0:bf7b9fba3924 | 38 | through a custom HID Client Program. |
| frank26080115 | 0:bf7b9fba3924 | 39 | |
| frank26080115 | 0:bf7b9fba3924 | 40 | @Directory contents: |
| frank26080115 | 0:bf7b9fba3924 | 41 | \app: HID Client application, use to test HID class in this example. |
| frank26080115 | 0:bf7b9fba3924 | 42 | \EWARM: includes EWARM (IAR) project and configuration files |
| frank26080115 | 0:bf7b9fba3924 | 43 | \Keil: includes RVMDK (Keil)project and configuration files |
| frank26080115 | 0:bf7b9fba3924 | 44 | |
| frank26080115 | 0:bf7b9fba3924 | 45 | hid.h: USB HID (Human Interface Device) Definitions |
| frank26080115 | 0:bf7b9fba3924 | 46 | hiduser.h/.c: HID Custom User module |
| frank26080115 | 0:bf7b9fba3924 | 47 | lpc17xx_libcfg.h: Library configuration file - include needed driver library for this example |
| frank26080115 | 0:bf7b9fba3924 | 48 | usb.h: USB Definitions |
| frank26080115 | 0:bf7b9fba3924 | 49 | usbcfg.h: USB Custom Configuration |
| frank26080115 | 0:bf7b9fba3924 | 50 | usbcore.h/.c: USB Core Module |
| frank26080115 | 0:bf7b9fba3924 | 51 | usbdesc.h/.c: USB Descriptors |
| frank26080115 | 0:bf7b9fba3924 | 52 | usbhw.h/.c: SB Hardware Layer Module |
| frank26080115 | 0:bf7b9fba3924 | 53 | usbreg.h: USB Hardware Layer Definitions for NXP Semiconductors LPC |
| frank26080115 | 0:bf7b9fba3924 | 54 | usbuser.h/.c: USB Custom User Module |
| frank26080115 | 0:bf7b9fba3924 | 55 | makefile: Example's makefile (to build with GNU toolchain) |
| frank26080115 | 0:bf7b9fba3924 | 56 | demo.h/.c: Main program |
| frank26080115 | 0:bf7b9fba3924 | 57 | |
| frank26080115 | 0:bf7b9fba3924 | 58 | @How to run: |
| frank26080115 | 0:bf7b9fba3924 | 59 | Hardware configuration: |
| frank26080115 | 0:bf7b9fba3924 | 60 | This example was tested only on: |
| frank26080115 | 0:bf7b9fba3924 | 61 | Keil MCB1700 with LPC1768 vers.1 |
| frank26080115 | 0:bf7b9fba3924 | 62 | These jumpers must be configured as following: |
| frank26080115 | 0:bf7b9fba3924 | 63 | - VDDIO: ON |
| frank26080115 | 0:bf7b9fba3924 | 64 | - VDDREGS: ON |
| frank26080115 | 0:bf7b9fba3924 | 65 | - VBUS: ON |
| frank26080115 | 0:bf7b9fba3924 | 66 | - LED: ON |
| frank26080115 | 0:bf7b9fba3924 | 67 | - INT1: ON |
| frank26080115 | 0:bf7b9fba3924 | 68 | - D+: DEVICE |
| frank26080115 | 0:bf7b9fba3924 | 69 | - D-: DEVICE |
| frank26080115 | 0:bf7b9fba3924 | 70 | - UMODE: 1-2 (USB) |
| frank26080115 | 0:bf7b9fba3924 | 71 | - E/U: 1-2 (USB) |
| frank26080115 | 0:bf7b9fba3924 | 72 | - Remain jumpers: OFF |
| frank26080115 | 0:bf7b9fba3924 | 73 | |
| frank26080115 | 0:bf7b9fba3924 | 74 | Running mode: |
| frank26080115 | 0:bf7b9fba3924 | 75 | RAM mode: This example can be run on RAM mode with debugger. |
| frank26080115 | 0:bf7b9fba3924 | 76 | All files must be build to .elf file, this file will be loaded into RAM through a |
| frank26080115 | 0:bf7b9fba3924 | 77 | debugger tool before running |
| frank26080115 | 0:bf7b9fba3924 | 78 | ROM(FLASH)mode: This example can be run on ROM mode with debugger or standalone after burning. |
| frank26080115 | 0:bf7b9fba3924 | 79 | All files in each example must be built to .hex file. This file will be burned into |
| frank26080115 | 0:bf7b9fba3924 | 80 | ROM(Flash) memory through an external tool (i.e: Flash Magic...) befor running. |
| frank26080115 | 0:bf7b9fba3924 | 81 | |
| frank26080115 | 0:bf7b9fba3924 | 82 | Note: If want to burn hex file to board by using Flash Magic, these jumpers need |
| frank26080115 | 0:bf7b9fba3924 | 83 | to be connected: |
| frank26080115 | 0:bf7b9fba3924 | 84 | - MCB1700 with LPC1768 ver.1: |
| frank26080115 | 0:bf7b9fba3924 | 85 | + RST: ON |
| frank26080115 | 0:bf7b9fba3924 | 86 | + ISP: ON |
| frank26080115 | 0:bf7b9fba3924 | 87 | - IAR LPC1768 KickStart vers.A: |
| frank26080115 | 0:bf7b9fba3924 | 88 | + RST_E: ON |
| frank26080115 | 0:bf7b9fba3924 | 89 | + ISP_E: ON |
| frank26080115 | 0:bf7b9fba3924 | 90 | |
| frank26080115 | 0:bf7b9fba3924 | 91 | (Please reference "LPC1000 Software Development Toolchain" - chapter 4 "Creating and working with |
| frank26080115 | 0:bf7b9fba3924 | 92 | LPC1000CMSIS project" for more information) |
| frank26080115 | 0:bf7b9fba3924 | 93 | |
| frank26080115 | 0:bf7b9fba3924 | 94 | Step to run: |
| frank26080115 | 0:bf7b9fba3924 | 95 | - Step 1: Build example. |
| frank26080115 | 0:bf7b9fba3924 | 96 | - Step 2: Burn hex file into board (if run on ROM mode) |
| frank26080115 | 0:bf7b9fba3924 | 97 | - Step 3: Configure hardware as above instruction |
| frank26080115 | 0:bf7b9fba3924 | 98 | - Step 4: Hit reset button to run example. |
| frank26080115 | 0:bf7b9fba3924 | 99 | - Step 5: After see UGL(USB Good Link) led on board turn on, run HIDClient application |
| frank26080115 | 0:bf7b9fba3924 | 100 | by clicking HIDClient.ext at USBHID\app folder |
| frank26080115 | 0:bf7b9fba3924 | 101 | - Step 6: Chose "LPC17xx HID" device. |
| frank26080115 | 0:bf7b9fba3924 | 102 | - Step 7: Click in any boxes on Outputs (LEDs) to turn on/off 8 LEDs on board |
| frank26080115 | 0:bf7b9fba3924 | 103 | - Step 8: Hit INT1 button and see if Inputs(BUTTON) box-0 turn on or not |
| frank26080115 | 0:bf7b9fba3924 | 104 | |
| frank26080115 | 0:bf7b9fba3924 | 105 | (Pls see "LPC17xx Example Description" document - chapter "Examples > USBDEV > USBHID" |
| frank26080115 | 0:bf7b9fba3924 | 106 | for more details) |
| frank26080115 | 0:bf7b9fba3924 | 107 | |
| frank26080115 | 0:bf7b9fba3924 | 108 | @Tip: |
| frank26080115 | 0:bf7b9fba3924 | 109 | - Open \EWARM\*.eww project file to run example on IAR |
| frank26080115 | 0:bf7b9fba3924 | 110 | - Open \RVMDK\*.uvproj project file to run example on Keil |