-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\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
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\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
- /* Includes: */\r
- #include <avr/io.h>\r
- #include <avr/interrupt.h>\r
- #include <stdbool.h>\r
- \r
- #include "../LowLevel/LowLevel.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
- \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
- /** Indicates if the USB interface is currently initialized but not necessarily connected to a host\r
- * or device (i.e. if \ref USB_Init() has been run). If this is false, all other library globals are invalid.\r
- *\r
- * \note This variable should be treated as read-only in the user application, and never manually\r
- * changed in value.\r
- *\r
- * \ingroup Group_USBManagement\r
- */\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_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
- */\r
- extern USB_Request_Header_t USB_ControlRequest;\r
- \r
- #if defined(USB_CAN_BE_HOST) || 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
- * This value may be altered by the user application to implement the \ref HOST_STATE_Addressed,\r
- * \ref HOST_STATE_Configured and \ref HOST_STATE_Suspended states which are not implemented by\r
- * the library.\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 HOST_STATE_AS_GPIOR token to a value \r
- * between 0 and 2 in the project makefile and passing it to the compiler via the -D switch. When\r
- * defined, the corresponding GPIOR register should not be used in the user application except\r
- * implicitly via the library APIs.\r
- *\r
- * \note This global is only present if the user application can be a USB host.\r
- *\r
- * \see \ref USB_Host_States_t for a list of possible device states\r
- *\r
- * \ingroup Group_Host\r
- */\r
- extern volatile uint8_t USB_HostState;\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
- #endif\r
- #endif\r
-\r
- #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)\r
- #if !defined(DEVICE_STATE_AS_GPIOR) || defined(__DOXYGEN__)\r
- /** Indicates the current device state machine state. When in device mode, this indicates the state\r
- * via one of the values of the \ref USB_Device_States_t enum values.\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_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
- * between 0 and 2 in the project makefile and passing it to the compiler via the -D switch. When\r
- * defined, the corresponding GPIOR register should not be used in the user application except\r
- * implicitly via the library APIs.\r
- *\r
- * \note This global is only present if the user application can be a USB device.\r
- * \n\n\r
- *\r
- * \note This variable should be treated as read-only in the user application, and never manually\r
- * changed in value except in the circumstances outlined above.\r
- *\r
- * \see \ref USB_Device_States_t for a list of possible device states\r
- *\r
- * \ingroup Group_Device\r
- */\r
- extern volatile uint8_t USB_DeviceState;\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
- #endif\r
- #endif\r
-\r
- /* Function Prototypes: */\r
- /** This is the main USB management task. The USB driver requires that this task be executed\r
- * continuously when the USB system is active (device attached in host mode, or attached to a host\r
- * in device mode) in order to manage USB communications. This task may be executed inside an RTOS,\r
- * fast timer ISR or the main user application loop.\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_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_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
- *\r
- * \see \ref Group_Events for more information on the USB events.\r
- *\r
- * \ingroup Group_USBManagement\r
- */\r
- void USB_USBTask(void);\r
-\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(USB_CAN_BE_HOST)\r
- static void USB_HostTask(void);\r
- #endif\r
- \r
- #if defined(USB_CAN_BE_DEVICE)\r
- static void USB_DeviceTask(void);\r
- #endif\r
- #endif\r
- \r
- /* Macros: */\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
- #if defined(__cplusplus)\r
- }\r
- #endif\r
- \r
-#endif\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.fourwalledcubicle.com
+*/
+
+/*
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief Main USB service task management.
+ *
+ * This file contains the function definitions required for the main USB service task, which must be called
+ * from the user application to ensure that the USB connection to or from a connected USB device is maintained.
+ *
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver
+ * dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
+#ifndef __USBTASK_H__
+#define __USBTASK_H__
+
+ /* Includes: */
+ #include <avr/io.h>
+ #include <avr/interrupt.h>
+ #include <stdbool.h>
+
+ #include "../LowLevel/LowLevel.h"
+ #include "Events.h"
+ #include "StdRequestType.h"
+ #include "StdDescriptors.h"
+ #include "USBMode.h"
+
+ #if defined(USB_CAN_BE_DEVICE)
+ #include "../LowLevel/DevChapter9.h"
+ #endif
+
+ #if defined(USB_CAN_BE_HOST)
+ #include "../LowLevel/HostChapter9.h"
+ #endif
+
+ /* Enable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ extern "C" {
+ #endif
+
+ /* Preprocessor Checks: */
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Global Variables: */
+ /** Indicates if the USB interface is currently initialized but not necessarily connected to a host
+ * or device (i.e. if \ref USB_Init() has been run). If this is false, all other library globals are invalid.
+ *
+ * \note This variable should be treated as read-only in the user application, and never manually
+ * changed in value.
+ *
+ * \ingroup Group_USBManagement
+ */
+ extern volatile bool USB_IsInitialized;
+
+ /** Structure containing the last received Control request when in Device mode (for use in user-applications
+ * inside of the \ref EVENT_USB_Device_UnhandledControlRequest() event, or for filling up with a control request to issue when
+ * in Host mode before calling \ref USB_Host_SendControlRequest().
+ *
+ * \ingroup Group_USBManagement
+ */
+ extern USB_Request_Header_t USB_ControlRequest;
+
+ #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
+ #if !defined(HOST_STATE_AS_GPIOR) || defined(__DOXYGEN__)
+ /** Indicates the current host state machine state. When in host mode, this indicates the state
+ * via one of the values of the \ref USB_Host_States_t enum values.
+ *
+ * This value may be altered by the user application to implement the \ref HOST_STATE_Addressed,
+ * \ref HOST_STATE_Configured and \ref HOST_STATE_Suspended states which are not implemented by
+ * the library.
+ *
+ * To reduce program size and speed up checks of this global, it can be placed into one of the AVR's
+ * GPIOR hardware registers instead of RAM by defining the HOST_STATE_AS_GPIOR token to a value
+ * between 0 and 2 in the project makefile and passing it to the compiler via the -D switch. When
+ * defined, the corresponding GPIOR register should not be used in the user application except
+ * implicitly via the library APIs.
+ *
+ * \note This global is only present if the user application can be a USB host.
+ *
+ * \see \ref USB_Host_States_t for a list of possible device states
+ *
+ * \ingroup Group_Host
+ */
+ extern volatile uint8_t USB_HostState;
+ #else
+ #define _GET_HOST_GPIOR_NAME2(y) GPIOR ## y
+ #define _GET_HOST_GPIOR_NAME(x) _GET_HOST_GPIOR_NAME2(x)
+ #define USB_HostState _GET_HOST_GPIOR_NAME(HOST_STATE_AS_GPIOR)
+ #endif
+ #endif
+
+ #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
+ #if !defined(DEVICE_STATE_AS_GPIOR) || defined(__DOXYGEN__)
+ /** Indicates the current device state machine state. When in device mode, this indicates the state
+ * via one of the values of the \ref USB_Device_States_t enum values.
+ *
+ * This value should not be altered by the user application as it is handled automatically by the
+ * library. The only exception to this rule is if the NO_LIMITED_CONTROLLER_CONNECT token is used
+ * (see \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events).
+ *
+ * To reduce program size and speed up checks of this global, it can be placed into one of the AVR's
+ * GPIOR hardware registers instead of RAM by defining the DEVICE_STATE_AS_GPIOR token to a value
+ * between 0 and 2 in the project makefile and passing it to the compiler via the -D switch. When
+ * defined, the corresponding GPIOR register should not be used in the user application except
+ * implicitly via the library APIs.
+ *
+ * \note This global is only present if the user application can be a USB device.
+ * \n\n
+ *
+ * \note This variable should be treated as read-only in the user application, and never manually
+ * changed in value except in the circumstances outlined above.
+ *
+ * \see \ref USB_Device_States_t for a list of possible device states
+ *
+ * \ingroup Group_Device
+ */
+ extern volatile uint8_t USB_DeviceState;
+ #else
+ #define _GET_DEVICE_GPIOR_NAME2(y) GPIOR ## y
+ #define _GET_DEVICE_GPIOR_NAME(x) _GET_DEVICE_GPIOR_NAME2(x)
+ #define USB_DeviceState _GET_DEVICE_GPIOR_NAME(DEVICE_STATE_AS_GPIOR)
+ #endif
+ #endif
+
+ /* Function Prototypes: */
+ /** This is the main USB management task. The USB driver requires that this task be executed
+ * continuously when the USB system is active (device attached in host mode, or attached to a host
+ * in device mode) in order to manage USB communications. This task may be executed inside an RTOS,
+ * fast timer ISR or the main user application loop.
+ *
+ * The USB task must be serviced within 30ms while in device mode, or within 1ms while in host mode.
+ * The task may be serviced at all times, or (for minimum CPU consumption):
+ *
+ * - In device mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Device_Connect()
+ * event and disabled again on the firing of the \ref EVENT_USB_Device_Disconnect() event.
+ *
+ * - In host mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Host_DeviceAttached()
+ * event and disabled again on the firing of the \ref EVENT_USB_Host_DeviceEnumerationComplete() or
+ * \ref EVENT_USB_Host_DeviceEnumerationFailed() events.
+ *
+ * If in device mode (only), the control endpoint can instead be managed via interrupts entirely by the library
+ * by defining the INTERRUPT_CONTROL_ENDPOINT token and passing it to the compiler via the -D switch.
+ *
+ * \see \ref Group_Events for more information on the USB events.
+ *
+ * \ingroup Group_USBManagement
+ */
+ void USB_USBTask(void);
+
+ /* Private Interface - For use in library only: */
+ #if !defined(__DOXYGEN__)
+ /* Function Prototypes: */
+ #if defined(__INCLUDE_FROM_USBTASK_C)
+ #if defined(USB_CAN_BE_HOST)
+ static void USB_HostTask(void);
+ #endif
+
+ #if defined(USB_CAN_BE_DEVICE)
+ static void USB_DeviceTask(void);
+ #endif
+ #endif
+
+ /* Macros: */
+ #define HOST_TASK_NONBLOCK_WAIT(duration, nextstate) MACROS{ USB_HostState = HOST_STATE_WaitForDevice; \
+ WaitMSRemaining = (duration); \
+ PostWaitState = (nextstate); }MACROE
+ #endif
+
+ /* Disable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ }
+ #endif
+
+#endif
projects / pub / USBasp.git / blobdiff