LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Events.h
Go to the documentation of this file.
1 /*
2  * @brief USB Event management definitions
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 
52 #ifndef __USBEVENTS_H__
53 #define __USBEVENTS_H__
54 
55  /* Includes: */
56  #include "../../../Common/Common.h"
57  #include "USBMode.h"
58 
59  /* Enable C linkage for C++ Compilers: */
60  #if defined(__cplusplus)
61  extern "C" {
62  #endif
63 
64  /* Preprocessor Checks: */
65  #if !defined(__INCLUDE_FROM_USB_DRIVER)
66  #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
67  #endif
68 
69  /* Public Interface - May be used in end-application: */
70  /* Pseudo-Functions for Doxygen: */
71  #if !defined(__INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)
72 
83  void EVENT_USB_UIDChange(void);
84 
97  void EVENT_USB_Host_HostError(const uint8_t corenum, const uint8_t ErrorCode);
98 
112  void EVENT_USB_Host_DeviceAttached(const uint8_t corenum);
113 
126  void EVENT_USB_Host_DeviceUnattached(const uint8_t corenum);
127 
146  void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t corenum,
147  const uint8_t ErrorCode,
148  const uint8_t SubErrorCode);
149 
158  void EVENT_USB_Host_DeviceEnumerationComplete(const uint8_t corenum);
159 
175  void EVENT_USB_Host_StartOfFrame(const uint8_t corenum);
176 
197  void EVENT_USB_Device_Connect(void);
198 
215  void EVENT_USB_Device_Disconnect(void);
216 
242 
256 
273  void EVENT_USB_Device_Suspend(void);
274 
291  void EVENT_USB_Device_WakeUp(void);
292 
303  void EVENT_USB_Device_Reset(void);
304 
320  #endif
321 
322  /* Private Interface - For use in library only: */
323  #if !defined(__DOXYGEN__)
324  /* Function Prototypes: */
325  #if defined(__INCLUDE_FROM_EVENTS_C)
326  void USB_Event_Stub(void) ATTR_CONST;
327  #if defined(__ICCARM__)
328  void USB_Host_HostError_Event_Stub(const uint8_t ErrorCode);
329  void USB_Host_DeviceEnumerationFailed_Event_Stub(const uint8_t ErrorCode,
330  const uint8_t SubErrorCode);
331  #endif
332  #if defined(USB_CAN_BE_BOTH)
335  #endif
336 
337  #if defined(USB_CAN_BE_HOST)
338 PRAGMA_WEAK(EVENT_USB_Host_HostError,USB_Event_Stub)
339  #if !defined(__ICCARM__)
340  void EVENT_USB_Host_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
341  #endif
343  void EVENT_USB_Host_DeviceAttached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
345  void EVENT_USB_Host_DeviceUnattached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
347  void EVENT_USB_Host_DeviceEnumerationComplete(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
349  #if !defined(__ICCARM__)
350  void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
351  const uint8_t SubErrorCode)
352  ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
353  #endif
355  void EVENT_USB_Host_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
356  #endif
357 
358  #if defined(USB_CAN_BE_DEVICE)
359 PRAGMA_WEAK(EVENT_USB_Device_Connect,USB_Event_Stub)
360  void EVENT_USB_Device_Connect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
362  void EVENT_USB_Device_Disconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
364  void EVENT_USB_Device_ControlRequest(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
366  void EVENT_USB_Device_ConfigurationChanged(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
367 PRAGMA_WEAK(EVENT_USB_Device_Suspend,USB_Event_Stub)
368  void EVENT_USB_Device_Suspend(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
369 PRAGMA_WEAK(EVENT_USB_Device_WakeUp,USB_Event_Stub)
370  void EVENT_USB_Device_WakeUp(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
371 PRAGMA_WEAK(EVENT_USB_Device_Reset,USB_Event_Stub)
372  void EVENT_USB_Device_Reset(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
374  void EVENT_USB_Device_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
375  #endif
376  #endif
377  #endif
378 
379  /* Disable C linkage for C++ Compilers: */
380  #if defined(__cplusplus)
381  }
382  #endif
383 
384 #endif
385