LUFA/Drivers/USB/HighLevel/USBTask.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 #ifndef __USBTASK_H__
  32 #define __USBTASK_H__
  33
  34         /* Includes: */
  35                 #include <avr/io.h>
  36                 #include <avr/interrupt.h>
  37                 #include <stdbool.h>
  38
  39                 #include "../LowLevel/LowLevel.h"
  40                 #include "Events.h"
  41                 #include "StdRequestType.h"
  42                 #include "StdDescriptors.h"
  43                 #include "USBMode.h"
  44
  45                 #if defined(USB_CAN_BE_DEVICE)
  46                         #include "../LowLevel/DevChapter9.h"
  47                 #endif
  48
  49                 #if defined(USB_CAN_BE_HOST)
  50                         #include "../LowLevel/HostChapter9.h"
  51                 #endif
  52
  53         /* Enable C linkage for C++ Compilers: */
  54                 #if defined(__cplusplus)
  55                         extern "C" {
  56                 #endif
  57
  58         /* Preprocessor Checks: */
  59                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  60                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  61                 #endif
  62
  63         /* Public Interface - May be used in end-application: */
  64                 /* Global Variables: */
  65                         /** Indicates if the USB interface is currently initialized but not necessarily connected to a host
  66                          *  or device (i.e. if \ref USB_Init() has been run). If this is false, all other library globals are invalid.
  67                          *
  68                          *  \note This variable should be treated as read-only in the user application, and never manually
  69                          *        changed in value.
  70                          *
  71                          *  \ingroup Group_USBManagement
  72                          */
  73                         extern volatile bool USB_IsInitialized;
  74
  75                         /** Structure containing the last received Control request when in Device mode (for use in user-applications
  76                          *  inside of the \ref EVENT_USB_Device_UnhandledControlRequest() event, or for filling up with a control request to issue when
  77                          *  in Host mode before calling \ref USB_Host_SendControlRequest().
  78                          *
  79                          *  \ingroup Group_USBManagement
  80                          */
  81                          extern USB_Request_Header_t USB_ControlRequest;
  82
  83                         #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
  84                                 #if !defined(HOST_STATE_AS_GPIOR) || defined(__DOXYGEN__)
  85                                         /** Indicates the current host state machine state. When in host mode, this indicates the state
  86                                          *  via one of the values of the \ref USB_Host_States_t enum values.
  87                                          *
  88                                          *  This value may be altered by the user application to implement the \ref HOST_STATE_Addressed,
  89                                          *  \ref HOST_STATE_Configured and \ref HOST_STATE_Suspended states which are not implemented by
  90                                          *  the library.
  91                                          *
  92                                          *  To reduce program size and speed up checks of this global, it can be placed into one of the AVR's
  93                                          *  GPIOR hardware registers instead of RAM by defining the HOST_STATE_AS_GPIOR token to a value
  94                                          *  between 0 and 2 in the project makefile and passing it to the compiler via the -D switch. When
  95                                          *  defined, the corresponding GPIOR register should not be used in the user application except
  96                                          *  implicitly via the library APIs.
  97                                          *
  98                                          *  \note This global is only present if the user application can be a USB host.
  99                                          *
 100                                          *  \see \ref USB_Host_States_t for a list of possible device states
 101                                          *
 102                                          *  \ingroup Group_Host
 103                                          */
 104                                         extern volatile uint8_t USB_HostState;
 105                                 #else
 106                                         #define _GET_HOST_GPIOR_NAME2(y) GPIOR ## y
 107                                         #define _GET_HOST_GPIOR_NAME(x)  _GET_HOST_GPIOR_NAME2(x)
 108                                         #define USB_HostState            _GET_HOST_GPIOR_NAME(HOST_STATE_AS_GPIOR)
 109                                 #endif
 110                         #endif
 111
 112                         #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
 113                                 #if !defined(DEVICE_STATE_AS_GPIOR) || defined(__DOXYGEN__)
 114                                         /** Indicates the current device state machine state. When in device mode, this indicates the state
 115                                          *  via one of the values of the \ref USB_Device_States_t enum values.
 116                                          *
 117                                          *  This value should not be altered by the user application as it is handled automatically by the
 118                                          *  library. The only exception to this rule is if the NO_LIMITED_CONTROLLER_CONNECT token is used
 119                                          *  (see \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events).
 120                                          *
 121                                          *  To reduce program size and speed up checks of this global, it can be placed into one of the AVR's
 122                                          *  GPIOR hardware registers instead of RAM by defining the DEVICE_STATE_AS_GPIOR token to a value
 123                                          *  between 0 and 2 in the project makefile and passing it to the compiler via the -D switch. When
 124                                          *  defined, the corresponding GPIOR register should not be used in the user application except
 125                                          *  implicitly via the library APIs.
 126                                          *
 127                                          *  \note This global is only present if the user application can be a USB device.
 128                                          *
 129                                          *  \note This variable should be treated as read-only in the user application, and never manually
 130                                          *        changed in value except in the circumstances outlined above.
 131                                          *
 132                                          *  \see \ref USB_Device_States_t for a list of possible device states
 133                                          *
 134                                          *  \ingroup Group_Device
 135                                          */
 136                                         extern volatile uint8_t USB_DeviceState;
 137                                 #else
 138                                         #define _GET_DEVICE_GPIOR_NAME2(y) GPIOR ## y
 139                                         #define _GET_DEVICE_GPIOR_NAME(x)  _GET_DEVICE_GPIOR_NAME2(x)
 140                                         #define USB_DeviceState            _GET_DEVICE_GPIOR_NAME(DEVICE_STATE_AS_GPIOR)
 141                                 #endif
 142                         #endif
 143
 144                 /* Function Prototypes: */
 145                         /** This is the main USB management task. The USB driver requires that this task be executed
 146                          *  continuously when the USB system is active (device attached in host mode, or attached to a host
 147                          *  in device mode) in order to manage USB communications. This task may be executed inside an RTOS,
 148                          *  fast timer ISR or the main user application loop.
 149                          *
 150                          *  The USB task must be serviced within 30ms while in device mode, or within 1ms while in host mode.
 151                          *  The task may be serviced at all times, or (for minimum CPU consumption):
 152                          *
 153                          *    - In device mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Device_Connect()
 154                          *      event and disabled again on the firing of the \ref EVENT_USB_Device_Disconnect() event.
 155                          *
 156                          *    - In host mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Host_DeviceAttached()
 157                          *      event and disabled again on the firing of the \ref EVENT_USB_Host_DeviceEnumerationComplete() or
 158                          *      \ref EVENT_USB_Host_DeviceEnumerationFailed() events.
 159                          *
 160                          *  If in device mode (only), the control endpoint can instead be managed via interrupts entirely by the library
 161                          *  by defining the INTERRUPT_CONTROL_ENDPOINT token and passing it to the compiler via the -D switch.
 162                          *
 163                          *  \see \ref Group_Events for more information on the USB events.
 164                          *
 165                          *  \ingroup Group_USBManagement
 166                          */
 167                         void USB_USBTask(void);
 168
 169         /* Private Interface - For use in library only: */
 170         #if !defined(__DOXYGEN__)
 171                 /* Function Prototypes: */
 172                         #if defined(__INCLUDE_FROM_USBTASK_C)
 173                                 #if defined(USB_CAN_BE_HOST)
 174                                         static void USB_HostTask(void);
 175                                 #endif
 176
 177                                 #if defined(USB_CAN_BE_DEVICE)
 178                                         static void USB_DeviceTask(void);
 179                                 #endif
 180                         #endif
 181
 182                 /* Macros: */
 183                         #define HOST_TASK_NONBLOCK_WAIT(duration, nextstate) MACROS{ USB_HostState = HOST_STATE_WaitForDevice; \
 184                                                                                      WaitMSRemaining = (duration);             \
 185                                                                                      PostWaitState = (nextstate);        }MACROE
 186         #endif
 187
 188         /* Disable C linkage for C++ Compilers: */
 189                 #if defined(__cplusplus)
 190                         }
 191                 #endif
 192
 193 #endif