/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
+ Permission to use, copy, modify, distribute, and sell this \r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in \r
+ all copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting \r
+ documentation, and that the name of the author not be used in \r
+ advertising or publicity pertaining to distribution of the \r
software without specific, written prior permission.\r
\r
The author disclaim all warranties with regard to this\r
arising out of or in connection with the use or performance of\r
this software.\r
*/\r
- \r
+\r
+/** \file\r
+ * \brief Main USB service task management.\r
+ *\r
+ * This file contains the function definitions required for the main USB service task, which must be called\r
+ * from the user application to ensure that the USB connection to or from a connected USB device is maintained.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
#ifndef __USBTASK_H__\r
#define __USBTASK_H__\r
\r
#include <avr/io.h>\r
#include <avr/interrupt.h>\r
#include <stdbool.h>\r
- #include <stddef.h>\r
\r
#include "../LowLevel/LowLevel.h"\r
- #include "StdRequestType.h"\r
- #include "USBMode.h"\r
#include "Events.h"\r
+ #include "StdRequestType.h"\r
#include "StdDescriptors.h"\r
+ #include "USBMode.h"\r
+\r
+ #if defined(USB_CAN_BE_DEVICE)\r
+ #include "../LowLevel/DevChapter9.h"\r
+ #endif\r
\r
#if defined(USB_CAN_BE_HOST)\r
#include "../LowLevel/HostChapter9.h"\r
- #endif \r
+ #endif\r
\r
/* Enable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
extern "C" {\r
#endif\r
+\r
+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
+ #endif\r
\r
/* Public Interface - May be used in end-application: */\r
/* Global Variables: */\r
extern volatile bool USB_IsInitialized;\r
\r
/** Structure containing the last received Control request when in Device mode (for use in user-applications\r
- * inside of the \ref EVENT_USB_UnhandledControlPacket() event, or for filling up with a control request to issue when\r
+ * inside of the \ref EVENT_USB_Device_UnhandledControlRequest() event, or for filling up with a control request to issue when\r
* in Host mode before calling \ref USB_Host_SendControlRequest().\r
*\r
* \ingroup Group_USBManagement\r
extern USB_Request_Header_t USB_ControlRequest;\r
\r
#if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)\r
- #if !defined(HOST_STATE_AS_GPIOR1) || defined(__DOXYGEN__)\r
+ #if !defined(HOST_STATE_AS_GPIOR) || defined(__DOXYGEN__)\r
/** Indicates the current host state machine state. When in host mode, this indicates the state\r
* via one of the values of the \ref USB_Host_States_t enum values.\r
*\r
#else\r
#define _GET_HOST_GPIOR_NAME2(y) GPIOR ## y\r
#define _GET_HOST_GPIOR_NAME(x) _GET_HOST_GPIOR_NAME2(x)\r
- #define USB_HostState _GET_HOST_GPIOR_NAME(HOST_STATE_AS_GPIOR)\r
+ #define USB_HostState _GET_HOST_GPIOR_NAME(HOST_STATE_AS_GPIOR)\r
#endif\r
#endif\r
\r
*\r
* This value should not be altered by the user application as it is handled automatically by the\r
* library. The only exception to this rule is if the NO_LIMITED_CONTROLLER_CONNECT token is used\r
- * (see \ref EVENT_USB_Connect() and \ref EVENT_USB_Disconnect() events).\r
+ * (see \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events).\r
*\r
* To reduce program size and speed up checks of this global, it can be placed into one of the AVR's\r
* GPIOR hardware registers instead of RAM by defining the DEVICE_STATE_AS_GPIOR token to a value \r
#else\r
#define _GET_DEVICE_GPIOR_NAME2(y) GPIOR ## y\r
#define _GET_DEVICE_GPIOR_NAME(x) _GET_DEVICE_GPIOR_NAME2(x)\r
- #define USB_DeviceState _GET_DEVICE_GPIOR_NAME(DEVICE_STATE_AS_GPIOR)\r
+ #define USB_DeviceState _GET_DEVICE_GPIOR_NAME(DEVICE_STATE_AS_GPIOR)\r
#endif\r
#endif\r
\r
* The USB task must be serviced within 30ms while in device mode, or within 1ms while in host mode.\r
* The task may be serviced at all times, or (for minimum CPU consumption):\r
*\r
- * - In device mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Connect() event\r
- * and disabled again on the firing of the \ref EVENT_USB_Disconnect() event.\r
+ * - In device mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Device_Connect() \r
+ * event and disabled again on the firing of the \ref EVENT_USB_Device_Disconnect() event.\r
*\r
- * - In host mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_DeviceAttached()\r
- * event and disabled again on the firing of the \ref EVENT_USB_DeviceEnumerationComplete() or\r
- * \ref EVENT_USB_DeviceEnumerationFailed() events.\r
+ * - In host mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Host_DeviceAttached()\r
+ * event and disabled again on the firing of the \ref EVENT_USB_Host_DeviceEnumerationComplete() or\r
+ * \ref EVENT_USB_Host_DeviceEnumerationFailed() events.\r
*\r
* If in device mode (only), the control endpoint can instead be managed via interrupts entirely by the library\r
* by defining the INTERRUPT_CONTROL_ENDPOINT token and passing it to the compiler via the -D switch.\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
/* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_USBTASK_C)\r
+ #if defined(__INCLUDE_FROM_USBTASK_C)\r
#if defined(USB_CAN_BE_HOST)\r
static void USB_HostTask(void);\r
#endif\r
#endif\r
\r
/* Macros: */\r
- #define HOST_TASK_NONBLOCK_WAIT(duration, nextstate) {USB_HostState = HOST_STATE_WaitForDevice; WaitMSRemaining = duration; PostWaitState = nextstate; }\r
+ #define HOST_TASK_NONBLOCK_WAIT(duration, nextstate) MACROS{ USB_HostState = HOST_STATE_WaitForDevice; \\r
+ WaitMSRemaining = (duration); \\r
+ PostWaitState = (nextstate); }MACROE\r
#endif\r
\r
/* Disable C linkage for C++ Compilers: */\r
projects / pub / USBasp.git / blobdiff