LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
USBController.h
Go to the documentation of this file.
1 /*
2  * @brief Common USB Controller definitions for all architectures
3  *
4  * @note
5  * Copyright(C) NXP Semiconductors, 2012
6  * Copyright(C) Dean Camera, 2011, 2012
7  * All rights reserved.
8  *
9  * @par
10  * Software that is described herein is for illustrative purposes only
11  * which provides customers with programming information regarding the
12  * LPC products. This software is supplied "AS IS" without any warranties of
13  * any kind, and NXP Semiconductors and its licensor disclaim any and
14  * all warranties, express or implied, including all implied warranties of
15  * merchantability, fitness for a particular purpose and non-infringement of
16  * intellectual property rights. NXP Semiconductors assumes no responsibility
17  * or liability for the use of the software, conveys no license or rights under any
18  * patent, copyright, mask work right, or any other intellectual property rights in
19  * or to any products. NXP Semiconductors reserves the right to make changes
20  * in the software without notification. NXP Semiconductors also makes no
21  * representation or warranty that such application will be suitable for the
22  * specified use without further testing or modification.
23  *
24  * @par
25  * Permission to use, copy, modify, and distribute this software and its
26  * documentation is hereby granted, under NXP Semiconductors' and its
27  * licensor's relevant copyrights in the software, without fee, provided that it
28  * is used in conjunction with NXP Semiconductors microcontrollers. This
29  * copyright, permission, and disclaimer notice must appear in all copies of
30  * this code.
31  */
32 
42 #ifndef __USBCONTROLLER_H__
43 #define __USBCONTROLLER_H__
44 
45  /* Includes: */
46  #include "../../../Common/Common.h"
47  #include "USBMode.h"
48 
49  /* Enable C linkage for C++ Compilers: */
50  #if defined(__cplusplus)
51  extern "C" {
52  #endif
53 
54  /* Preprocessor Checks and Defines: */
55  #if !defined(__INCLUDE_FROM_USB_DRIVER)
56  #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
57  #endif
58 
59  /* Defines: */
65  #define ENDPOINT_DIR_MASK 0x80
66 
70  #define ENDPOINT_DIR_OUT 0x00
71 
75  #define ENDPOINT_DIR_IN 0x80
76 
77 
83  #define EP_TYPE_MASK 0x03
84 
89  #define EP_TYPE_CONTROL 0x00
90 
95  #define EP_TYPE_ISOCHRONOUS 0x01
96 
101  #define EP_TYPE_BULK 0x02
102 
107  #define EP_TYPE_INTERRUPT 0x03
108 
109 
110  /* Architecture Includes: */
111  #if (ARCH == ARCH_AVR8)
112  #include "AVR8/USBController_AVR8.h"
113  #elif (ARCH == ARCH_UC3)
114  #include "UC3/USBController_UC3.h"
115  #elif (ARCH == ARCH_XMEGA)
116  #include "XMEGA/USBController_XMEGA.h"
117  #elif (ARCH == ARCH_LPC)
118  #include "LPC/USBController_LPC.h"
119  #endif
120 
121  /* Disable C linkage for C++ Compilers: */
122  #if defined(__cplusplus)
123  }
124  #endif
125 
126 #endif
127