LUFA/Drivers/USB/LowLevel/Host.c

   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 #define  __INCLUDE_FROM_USB_DRIVER
  32 #include "../HighLevel/USBMode.h"
  33
  34 #if defined(USB_CAN_BE_HOST)
  35
  36 #define  __INCLUDE_FROM_HOST_C
  37 #include "Host.h"
  38
  39 void USB_Host_ProcessNextHostState(void)
  40 {
  41         uint8_t ErrorCode    = HOST_ENUMERROR_NoError;
  42         uint8_t SubErrorCode = HOST_ENUMERROR_NoError;
  43
  44         static uint16_t WaitMSRemaining;
  45         static uint8_t  PostWaitState;
  46
  47         switch (USB_HostState)
  48         {
  49                 case HOST_STATE_WaitForDevice:
  50                         if (WaitMSRemaining)
  51                         {
  52                                 if ((SubErrorCode = USB_Host_WaitMS(1)) != HOST_WAITERROR_Successful)
  53                                 {
  54                                         USB_HostState = PostWaitState;
  55                                         ErrorCode     = HOST_ENUMERROR_WaitStage;
  56                                         break;
  57                                 }
  58
  59                                 if (!(--WaitMSRemaining))
  60                                   USB_HostState = PostWaitState;
  61                         }
  62
  63                         break;
  64                 case HOST_STATE_Powered:
  65                         WaitMSRemaining = HOST_DEVICE_SETTLE_DELAY_MS;
  66
  67                         USB_HostState = HOST_STATE_Powered_WaitForDeviceSettle;
  68                         break;
  69                 case HOST_STATE_Powered_WaitForDeviceSettle:
  70                         if (WaitMSRemaining--)
  71                         {
  72                                 _delay_ms(1);
  73                                 break;
  74                         }
  75                         else
  76                         {
  77                                 USB_Host_VBUS_Manual_Off();
  78
  79                                 USB_OTGPAD_On();
  80                                 USB_Host_VBUS_Auto_Enable();
  81                                 USB_Host_VBUS_Auto_On();
  82
  83                                 USB_HostState = HOST_STATE_Powered_WaitForConnect;
  84                         }
  85
  86                         break;
  87                 case HOST_STATE_Powered_WaitForConnect:
  88                         if (USB_INT_HasOccurred(USB_INT_DCONNI))
  89                         {
  90                                 USB_INT_Clear(USB_INT_DCONNI);
  91                                 USB_INT_Clear(USB_INT_DDISCI);
  92
  93                                 USB_INT_Clear(USB_INT_VBERRI);
  94                                 USB_INT_Enable(USB_INT_VBERRI);
  95
  96                                 USB_Host_ResumeBus();
  97                                 Pipe_ClearPipes();
  98
  99                                 HOST_TASK_NONBLOCK_WAIT(100, HOST_STATE_Powered_DoReset);
 100                         }
 101
 102                         break;
 103                 case HOST_STATE_Powered_DoReset:
 104                         USB_Host_ResetDevice();
 105
 106                         HOST_TASK_NONBLOCK_WAIT(200, HOST_STATE_Powered_ConfigPipe);
 107                         break;
 108                 case HOST_STATE_Powered_ConfigPipe:
 109                         Pipe_ConfigurePipe(PIPE_CONTROLPIPE, EP_TYPE_CONTROL,
 110                                                            PIPE_TOKEN_SETUP, ENDPOINT_CONTROLEP,
 111                                                            PIPE_CONTROLPIPE_DEFAULT_SIZE, PIPE_BANK_SINGLE);
 112
 113                         if (!(Pipe_IsConfigured()))
 114                         {
 115                                 ErrorCode    = HOST_ENUMERROR_PipeConfigError;
 116                                 SubErrorCode = 0;
 117                                 break;
 118                         }
 119
 120                         USB_HostState = HOST_STATE_Default;
 121                         break;
 122                 case HOST_STATE_Default:
 123                         USB_ControlRequest = (USB_Request_Header_t)
 124                                 {
 125                                         .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_DEVICE),
 126                                         .bRequest      = REQ_GetDescriptor,
 127                                         .wValue        = (DTYPE_Device << 8),
 128                                         .wIndex        = 0,
 129                                         .wLength       = 8,
 130                                 };
 131
 132                         uint8_t DataBuffer[8];
 133
 134                         if ((SubErrorCode = USB_Host_SendControlRequest(DataBuffer)) != HOST_SENDCONTROL_Successful)
 135                         {
 136                                 ErrorCode = HOST_ENUMERROR_ControlError;
 137                                 break;
 138                         }
 139
 140                         USB_ControlPipeSize = DataBuffer[offsetof(USB_Descriptor_Device_t, Endpoint0Size)];
 141
 142                         USB_Host_ResetDevice();
 143
 144                         HOST_TASK_NONBLOCK_WAIT(200, HOST_STATE_Default_PostReset);
 145                         break;
 146                 case HOST_STATE_Default_PostReset:
 147                         Pipe_ConfigurePipe(PIPE_CONTROLPIPE, EP_TYPE_CONTROL,
 148                                            PIPE_TOKEN_SETUP, ENDPOINT_CONTROLEP,
 149                                            USB_ControlPipeSize, PIPE_BANK_SINGLE);
 150
 151                         if (!(Pipe_IsConfigured()))
 152                         {
 153                                 ErrorCode    = HOST_ENUMERROR_PipeConfigError;
 154                                 SubErrorCode = 0;
 155                                 break;
 156                         }
 157
 158                         USB_ControlRequest = (USB_Request_Header_t)
 159                                 {
 160                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 161                                         .bRequest      = REQ_SetAddress,
 162                                         .wValue        = USB_HOST_DEVICEADDRESS,
 163                                         .wIndex        = 0,
 164                                         .wLength       = 0,
 165                                 };
 166
 167                         if ((SubErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 168                         {
 169                                 ErrorCode = HOST_ENUMERROR_ControlError;
 170                                 break;
 171                         }
 172
 173                         HOST_TASK_NONBLOCK_WAIT(100, HOST_STATE_Default_PostAddressSet);
 174                         break;
 175                 case HOST_STATE_Default_PostAddressSet:
 176                         USB_Host_SetDeviceAddress(USB_HOST_DEVICEADDRESS);
 177
 178                         EVENT_USB_Host_DeviceEnumerationComplete();
 179                         USB_HostState = HOST_STATE_Addressed;
 180                         break;
 181         }
 182
 183         if ((ErrorCode != HOST_ENUMERROR_NoError) && (USB_HostState != HOST_STATE_Unattached))
 184         {
 185                 EVENT_USB_Host_DeviceEnumerationFailed(ErrorCode, SubErrorCode);
 186
 187                 USB_Host_VBUS_Auto_Off();
 188
 189                 EVENT_USB_Host_DeviceUnattached();
 190
 191                 USB_ResetInterface();
 192         }
 193 }
 194
 195 uint8_t USB_Host_WaitMS(uint8_t MS)
 196 {
 197         bool    BusSuspended = USB_Host_IsBusSuspended();
 198         uint8_t ErrorCode    = HOST_WAITERROR_Successful;
 199
 200         USB_Host_ResumeBus();
 201
 202         while (MS)
 203         {
 204                 if (USB_INT_HasOccurred(USB_INT_HSOFI))
 205                 {
 206                         USB_INT_Clear(USB_INT_HSOFI);
 207                         MS--;
 208                 }
 209
 210                 if ((USB_HostState == HOST_STATE_Unattached) || (USB_CurrentMode == USB_MODE_DEVICE))
 211                 {
 212                         ErrorCode = HOST_WAITERROR_DeviceDisconnect;
 213
 214                         break;
 215                 }
 216
 217                 if (Pipe_IsError() == true)
 218                 {
 219                         Pipe_ClearError();
 220                         ErrorCode = HOST_WAITERROR_PipeError;
 221
 222                         break;
 223                 }
 224
 225                 if (Pipe_IsStalled() == true)
 226                 {
 227                         Pipe_ClearStall();
 228                         ErrorCode = HOST_WAITERROR_SetupStalled;
 229
 230                         break;
 231                 }
 232         }
 233
 234         if (BusSuspended)
 235           USB_Host_SuspendBus();
 236
 237         return ErrorCode;
 238 }
 239
 240 static void USB_Host_ResetDevice(void)
 241 {
 242         bool BusSuspended = USB_Host_IsBusSuspended();
 243
 244         USB_INT_Disable(USB_INT_DDISCI);
 245
 246         USB_Host_ResetBus();
 247         while (!(USB_Host_IsBusResetComplete()));
 248
 249         USB_Host_ResumeBus();
 250
 251         USB_INT_Clear(USB_INT_HSOFI);
 252
 253         for (uint8_t MSRem = 10; MSRem != 0; MSRem--)
 254         {
 255                 /* Workaround for powerless-pull-up devices. After a USB bus reset,
 256                    all disconnection interrupts are suppressed while a USB frame is
 257                    looked for - if it is found within 10ms, the device is still
 258                    present.                                                        */
 259
 260                 if (USB_INT_HasOccurred(USB_INT_HSOFI))
 261                 {
 262                         USB_INT_Clear(USB_INT_HSOFI);
 263                         USB_INT_Clear(USB_INT_DDISCI);
 264                         break;
 265                 }
 266
 267                 _delay_ms(1);
 268         }
 269
 270         if (BusSuspended)
 271           USB_Host_SuspendBus();
 272
 273         USB_INT_Enable(USB_INT_DDISCI);
 274 }
 275
 276 uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber)
 277 {
 278         USB_ControlRequest = (USB_Request_Header_t)
 279                 {
 280                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 281                         .bRequest      = REQ_SetConfiguration,
 282                         .wValue        = ConfigNumber,
 283                         .wIndex        = 0,
 284                         .wLength       = 0,
 285                 };
 286
 287         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 288
 289         return USB_Host_SendControlRequest(NULL);
 290 }
 291
 292 uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr)
 293 {
 294         USB_ControlRequest = (USB_Request_Header_t)
 295                 {
 296                         .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_DEVICE),
 297                         .bRequest      = REQ_GetDescriptor,
 298                         .wValue        = (DTYPE_Device << 8),
 299                         .wIndex        = 0,
 300                         .wLength       = sizeof(USB_Descriptor_Device_t),
 301                 };
 302
 303         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 304
 305         return USB_Host_SendControlRequest(DeviceDescriptorPtr);
 306 }
 307
 308 uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
 309                                            void* const Buffer,
 310                                            const uint8_t BufferLength)
 311 {
 312         USB_ControlRequest = (USB_Request_Header_t)
 313                 {
 314                         .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_DEVICE),
 315                         .bRequest      = REQ_GetDescriptor,
 316                         .wValue        = (DTYPE_String << 8) | Index,
 317                         .wIndex        = 0,
 318                         .wLength       = BufferLength,
 319                 };
 320
 321         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 322
 323         return USB_Host_SendControlRequest(Buffer);
 324 }
 325
 326 uint8_t USB_Host_ClearPipeStall(uint8_t EndpointNum)
 327 {
 328         if (Pipe_GetPipeToken() == PIPE_TOKEN_IN)
 329           EndpointNum |= ENDPOINT_DESCRIPTOR_DIR_IN;
 330
 331         USB_ControlRequest = (USB_Request_Header_t)
 332                 {
 333                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_ENDPOINT),
 334                         .bRequest      = REQ_ClearFeature,
 335                         .wValue        = FEATURE_ENDPOINT_HALT,
 336                         .wIndex        = EndpointNum,
 337                         .wLength       = 0,
 338                 };
 339
 340         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 341
 342         return USB_Host_SendControlRequest(NULL);
 343 }
 344
 345 #endif