MdeModulePkg/Bus/Usb/UsbBusDxe/UsbEnumer.c

   1 /** @file
   2
   3     Usb bus enumeration support.
   4
   5 Copyright (c) 2007 - 2008, Intel Corporation
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #include "UsbBus.h"
  17
  18
  19 /**
  20   Return the endpoint descriptor in this interface.
  21
  22   @param  UsbIf                 The interface to search in.
  23   @param  EpAddr                The address of the endpoint to return.
  24
  25   @return The endpoint descriptor or NULL.
  26
  27 **/
  28 USB_ENDPOINT_DESC *
  29 UsbGetEndpointDesc (
  30   IN USB_INTERFACE        *UsbIf,
  31   IN UINT8                EpAddr
  32   )
  33 {
  34   USB_ENDPOINT_DESC       *EpDesc;
  35   UINT8                   Index;
  36   UINT8                   NumEndpoints;
  37
  38   NumEndpoints = UsbIf->IfSetting->Desc.NumEndpoints;
  39
  40   for (Index = 0; Index < NumEndpoints; Index++) {
  41     EpDesc = UsbIf->IfSetting->Endpoints[Index];
  42
  43     if (EpDesc->Desc.EndpointAddress == EpAddr) {
  44       return EpDesc;
  45     }
  46   }
  47
  48   return NULL;
  49 }
  50
  51
  52 /**
  53   Free the resource used by USB interface.
  54
  55   @param  UsbIf                 The USB interface to free.
  56
  57 **/
  58 VOID
  59 UsbFreeInterface (
  60   IN USB_INTERFACE        *UsbIf
  61   )
  62 {
  63   UsbCloseHostProtoByChild (UsbIf->Device->Bus, UsbIf->Handle);
  64
  65   gBS->UninstallMultipleProtocolInterfaces (
  66          UsbIf->Handle,
  67          &gEfiDevicePathProtocolGuid,
  68          UsbIf->DevicePath,
  69          &gEfiUsbIoProtocolGuid,
  70          &UsbIf->UsbIo,
  71          NULL
  72          );
  73
  74   if (UsbIf->DevicePath != NULL) {
  75     FreePool (UsbIf->DevicePath);
  76   }
  77
  78   FreePool (UsbIf);
  79 }
  80
  81
  82 /**
  83   Create an interface for the descriptor IfDesc. Each
  84   device's configuration can have several interfaces.
  85
  86   @param  Device                The device has the interface descriptor.
  87   @param  IfDesc                The interface descriptor.
  88
  89   @return The created USB interface for the descriptor, or NULL.
  90
  91 **/
  92 USB_INTERFACE *
  93 UsbCreateInterface (
  94   IN USB_DEVICE           *Device,
  95   IN USB_INTERFACE_DESC   *IfDesc
  96   )
  97 {
  98   USB_DEVICE_PATH         UsbNode;
  99   USB_INTERFACE           *UsbIf;
 100   USB_INTERFACE           *HubIf;
 101   EFI_STATUS              Status;
 102
 103   UsbIf = AllocateZeroPool (sizeof (USB_INTERFACE));
 104
 105   if (UsbIf == NULL) {
 106     return NULL;
 107   }
 108
 109   UsbIf->Signature  = USB_INTERFACE_SIGNATURE;
 110   UsbIf->Device     = Device;
 111   UsbIf->IfDesc     = IfDesc;
 112   ASSERT (IfDesc->ActiveIndex < USB_MAX_INTERFACE_SETTING);
 113   UsbIf->IfSetting  = IfDesc->Settings[IfDesc->ActiveIndex];
 114
 115   CopyMem (
 116     &(UsbIf->UsbIo),
 117     &mUsbIoProtocol,
 118     sizeof (EFI_USB_IO_PROTOCOL)
 119     );
 120
 121   //
 122   // Install protocols for USBIO and device path
 123   //
 124   UsbNode.Header.Type       = MESSAGING_DEVICE_PATH;
 125   UsbNode.Header.SubType    = MSG_USB_DP;
 126   UsbNode.ParentPortNumber  = Device->ParentPort;
 127   UsbNode.InterfaceNumber   = UsbIf->IfSetting->Desc.InterfaceNumber;
 128
 129   SetDevicePathNodeLength (&UsbNode.Header, sizeof (UsbNode));
 130
 131   HubIf = Device->ParentIf;
 132   ASSERT (HubIf != NULL);
 133
 134   UsbIf->DevicePath = AppendDevicePathNode (HubIf->DevicePath, &UsbNode.Header);
 135
 136   if (UsbIf->DevicePath == NULL) {
 137     DEBUG ((EFI_D_ERROR, "UsbCreateInterface: failed to create device path\n"));
 138
 139     Status = EFI_OUT_OF_RESOURCES;
 140     goto ON_ERROR;
 141   }
 142
 143   Status = gBS->InstallMultipleProtocolInterfaces (
 144                   &UsbIf->Handle,
 145                   &gEfiDevicePathProtocolGuid,
 146                   UsbIf->DevicePath,
 147                   &gEfiUsbIoProtocolGuid,
 148                   &UsbIf->UsbIo,
 149                   NULL
 150                   );
 151
 152   if (EFI_ERROR (Status)) {
 153     DEBUG ((EFI_D_ERROR, "UsbCreateInterface: failed to install UsbIo - %r\n", Status));
 154     goto ON_ERROR;
 155   }
 156
 157   //
 158   // Open USB Host Controller Protocol by Child
 159   //
 160   Status = UsbOpenHostProtoByChild (Device->Bus, UsbIf->Handle);
 161
 162   if (EFI_ERROR (Status)) {
 163     gBS->UninstallMultipleProtocolInterfaces (
 164            &UsbIf->Handle,
 165            &gEfiDevicePathProtocolGuid,
 166            UsbIf->DevicePath,
 167            &gEfiUsbIoProtocolGuid,
 168            &UsbIf->UsbIo,
 169            NULL
 170            );
 171
 172     DEBUG ((EFI_D_ERROR, "UsbCreateInterface: failed to open host for child - %r\n", Status));
 173     goto ON_ERROR;
 174   }
 175
 176   return UsbIf;
 177
 178 ON_ERROR:
 179   if (UsbIf->DevicePath != NULL) {
 180     FreePool (UsbIf->DevicePath);
 181   }
 182
 183   FreePool (UsbIf);
 184   return NULL;
 185 }
 186
 187
 188 /**
 189   Free the resource used by this USB device.
 190
 191   @param  Device                The USB device to free.
 192
 193 **/
 194 VOID
 195 UsbFreeDevice (
 196   IN USB_DEVICE           *Device
 197   )
 198 {
 199   if (Device->DevDesc != NULL) {
 200     UsbFreeDevDesc (Device->DevDesc);
 201   }
 202
 203   gBS->FreePool (Device);
 204 }
 205
 206
 207 /**
 208   Create a device which is on the parent's ParentPort port.
 209
 210   @param  ParentIf              The parent HUB interface.
 211   @param  ParentPort            The port on the HUB this device is connected to.
 212
 213   @return Created USB device, Or NULL.
 214
 215 **/
 216 USB_DEVICE *
 217 UsbCreateDevice (
 218   IN USB_INTERFACE        *ParentIf,
 219   IN UINT8                ParentPort
 220   )
 221 {
 222   USB_DEVICE              *Device;
 223
 224   ASSERT (ParentIf != NULL);
 225
 226   Device = AllocateZeroPool (sizeof (USB_DEVICE));
 227
 228   if (Device == NULL) {
 229     return NULL;
 230   }
 231
 232   Device->Bus         = ParentIf->Device->Bus;
 233   Device->MaxPacket0  = 8;
 234   Device->ParentAddr  = ParentIf->Device->Address;
 235   Device->ParentIf    = ParentIf;
 236   Device->ParentPort  = ParentPort;
 237   return Device;
 238 }
 239
 240
 241 /**
 242   Connect the USB interface with its driver. EFI USB bus will
 243   create a USB interface for each separate interface descriptor.
 244
 245   @param  UsbIf             The interface to connect driver to.
 246
 247   @return EFI_SUCCESS       Interface is managed by some driver.
 248   @return Others            Failed to locate a driver for this interface.
 249
 250 **/
 251 EFI_STATUS
 252 UsbConnectDriver (
 253   IN USB_INTERFACE        *UsbIf
 254   )
 255 {
 256   EFI_STATUS              Status;
 257   EFI_TPL                 OldTpl;
 258
 259   Status = EFI_SUCCESS;
 260
 261   //
 262   // Hub is maintained by the USB bus driver. Otherwise try to
 263   // connect drivers with this interface
 264   //
 265   if (UsbIsHubInterface (UsbIf)) {
 266     DEBUG ((EFI_D_INFO, "UsbConnectDriver: found a hub device\n"));
 267     Status = mUsbHubApi.Init (UsbIf);
 268
 269   } else {
 270     //
 271     // This function is called in both UsbIoControlTransfer and
 272     // the timer callback in hub enumeration. So, at least it is
 273     // called at TPL_CALLBACK. Some driver sitting on USB has
 274     // twisted TPL used. It should be no problem for us to connect
 275     // or disconnect at CALLBACK.
 276     //
 277
 278     //
 279     // Only recursively wanted usb child device
 280     //
 281     if (UsbBusIsWantedUsbIO (UsbIf->Device->Bus, UsbIf)) {
 282       OldTpl            = UsbGetCurrentTpl ();
 283       DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL before connect is %d, %p\n", (UINT32)OldTpl, UsbIf->Handle));
 284
 285       gBS->RestoreTPL (TPL_CALLBACK);
 286
 287       Status            = gBS->ConnectController (UsbIf->Handle, NULL, NULL, TRUE);
 288       UsbIf->IsManaged  = (BOOLEAN)!EFI_ERROR (Status);
 289
 290       DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL after connect is %d\n", (UINT32)UsbGetCurrentTpl()));
 291       ASSERT (UsbGetCurrentTpl () == TPL_CALLBACK);
 292
 293       gBS->RaiseTPL (OldTpl);
 294     }
 295   }
 296
 297   return Status;
 298 }
 299
 300
 301 /**
 302   Select an alternate setting for the interface.
 303   Each interface can have several mutually exclusive
 304   settings. Only one setting is active. It will
 305   also reset its endpoints' toggle to zero.
 306
 307   @param  IfDesc                The interface descriptor to set.
 308   @param  Alternate             The alternate setting number to locate.
 309
 310   @retval EFI_NOT_FOUND         There is no setting with this alternate index.
 311   @retval EFI_SUCCESS           The interface is set to Alternate setting.
 312
 313 **/
 314 EFI_STATUS
 315 UsbSelectSetting (
 316   IN USB_INTERFACE_DESC   *IfDesc,
 317   IN UINT8                Alternate
 318   )
 319 {
 320   USB_INTERFACE_SETTING   *Setting;
 321   UINT8                   Index;
 322
 323   //
 324   // Locate the active alternate setting
 325   //
 326   Setting = NULL;
 327
 328   for (Index = 0; Index < IfDesc->NumOfSetting; Index++) {
 329     ASSERT (Index < USB_MAX_INTERFACE_SETTING);
 330     Setting = IfDesc->Settings[Index];
 331
 332     if (Setting->Desc.AlternateSetting == Alternate) {
 333       break;
 334     }
 335   }
 336
 337   if (Index == IfDesc->NumOfSetting) {
 338     return EFI_NOT_FOUND;
 339   }
 340
 341   IfDesc->ActiveIndex = Index;
 342
 343   ASSERT (Setting != NULL);
 344   DEBUG ((EFI_D_INFO, "UsbSelectSetting: setting %d selected for interface %d\n",
 345               Alternate, Setting->Desc.InterfaceNumber));
 346
 347   //
 348   // Reset the endpoint toggle to zero
 349   //
 350   for (Index = 0; Index < Setting->Desc.NumEndpoints; Index++) {
 351     Setting->Endpoints[Index]->Toggle = 0;
 352   }
 353
 354   return EFI_SUCCESS;
 355 }
 356
 357
 358 /**
 359   Select a new configuration for the device. Each
 360   device may support several configurations.
 361
 362   @param  Device                The device to select configuration.
 363   @param  ConfigValue           The index of the configuration ( != 0).
 364
 365   @retval EFI_NOT_FOUND         There is no configuration with the index.
 366   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource.
 367   @retval EFI_SUCCESS           The configuration is selected.
 368
 369 **/
 370 EFI_STATUS
 371 UsbSelectConfig (
 372   IN USB_DEVICE           *Device,
 373   IN UINT8                ConfigValue
 374   )
 375 {
 376   USB_DEVICE_DESC         *DevDesc;
 377   USB_CONFIG_DESC         *ConfigDesc;
 378   USB_INTERFACE_DESC      *IfDesc;
 379   USB_INTERFACE           *UsbIf;
 380   EFI_STATUS              Status;
 381   UINT8                   Index;
 382
 383   //
 384   // Locate the active config, then set the device's pointer
 385   //
 386   DevDesc     = Device->DevDesc;
 387   ConfigDesc  = NULL;
 388
 389   for (Index = 0; Index < DevDesc->Desc.NumConfigurations; Index++) {
 390     ConfigDesc = DevDesc->Configs[Index];
 391
 392     if (ConfigDesc->Desc.ConfigurationValue == ConfigValue) {
 393       break;
 394     }
 395   }
 396
 397   if (Index == DevDesc->Desc.NumConfigurations) {
 398     return EFI_NOT_FOUND;
 399   }
 400
 401   Device->ActiveConfig = ConfigDesc;
 402
 403   DEBUG ((EFI_D_INFO, "UsbSelectConfig: config %d selected for device %d\n",
 404               ConfigValue, Device->Address));
 405
 406   //
 407   // Create interfaces for each USB interface descriptor.
 408   //
 409   for (Index = 0; Index < ConfigDesc->Desc.NumInterfaces; Index++) {
 410     //
 411     // First select the default interface setting, and reset
 412     // the endpoint toggles to zero for its endpoints.
 413     //
 414     IfDesc = ConfigDesc->Interfaces[Index];
 415     UsbSelectSetting (IfDesc, IfDesc->Settings[0]->Desc.AlternateSetting);
 416
 417     //
 418     // Create a USB_INTERFACE and install USB_IO and other protocols
 419     //
 420     UsbIf = UsbCreateInterface (Device, ConfigDesc->Interfaces[Index]);
 421
 422     if (UsbIf == NULL) {
 423       return EFI_OUT_OF_RESOURCES;
 424     }
 425
 426     ASSERT (Index < USB_MAX_INTERFACE);
 427     Device->Interfaces[Index] = UsbIf;
 428
 429     //
 430     // Connect the device to drivers, if it failed, ignore
 431     // the error. Don't let the unsupported interfaces to block
 432     // the supported interfaces.
 433     //
 434     Status = UsbConnectDriver (UsbIf);
 435
 436     if (EFI_ERROR (Status)) {
 437       DEBUG ((EFI_D_ERROR, "UsbSelectConfig: failed to connect driver %r, ignored\n", Status));
 438     }
 439   }
 440
 441   Device->NumOfInterface = Index;
 442
 443   return EFI_SUCCESS;
 444 }
 445
 446
 447 /**
 448   Disconnect the USB interface with its driver.
 449
 450   @param  UsbIf                 The interface to disconnect driver from.
 451
 452 **/
 453 VOID
 454 UsbDisconnectDriver (
 455   IN USB_INTERFACE        *UsbIf
 456   )
 457 {
 458   EFI_TPL                 OldTpl;
 459   EFI_STATUS              Status;
 460
 461   //
 462   // Release the hub if it's a hub controller, otherwise
 463   // disconnect the driver if it is managed by other drivers.
 464   //
 465   if (UsbIf->IsHub) {
 466     UsbIf->HubApi->Release (UsbIf);
 467
 468   } else if (UsbIf->IsManaged) {
 469     //
 470     // This function is called in both UsbIoControlTransfer and
 471     // the timer callback in hub enumeration. So, at least it is
 472     // called at TPL_CALLBACK. Some driver sitting on USB has
 473     // twisted TPL used. It should be no problem for us to connect
 474     // or disconnect at CALLBACK.
 475     //
 476     OldTpl           = UsbGetCurrentTpl ();
 477     DEBUG ((EFI_D_INFO, "UsbDisconnectDriver: old TPL is %d, %p\n", (UINT32)OldTpl, UsbIf->Handle));
 478
 479     gBS->RestoreTPL (TPL_CALLBACK);
 480
 481     Status = gBS->DisconnectController (UsbIf->Handle, NULL, NULL);
 482     UsbIf->IsManaged = FALSE;
 483
 484     DEBUG (( EFI_D_INFO, "UsbDisconnectDriver: TPL after disconnect is %d, %d\n", (UINT32)UsbGetCurrentTpl(), Status));
 485     ASSERT (UsbGetCurrentTpl () == TPL_CALLBACK);
 486
 487     gBS->RaiseTPL (OldTpl);
 488   }
 489 }
 490
 491
 492 /**
 493   Remove the current device configuration.
 494
 495   @param  Device                The USB device to remove configuration from.
 496
 497 **/
 498 VOID
 499 UsbRemoveConfig (
 500   IN USB_DEVICE           *Device
 501   )
 502 {
 503   USB_INTERFACE           *UsbIf;
 504   UINTN                   Index;
 505
 506   //
 507   // Remove each interface of the device
 508   //
 509   for (Index = 0; Index < Device->NumOfInterface; Index++) {
 510     ASSERT (Index < USB_MAX_INTERFACE);
 511     UsbIf = Device->Interfaces[Index];
 512
 513     if (UsbIf == NULL) {
 514       continue;
 515     }
 516
 517     UsbDisconnectDriver (UsbIf);
 518     UsbFreeInterface (UsbIf);
 519     Device->Interfaces[Index] = NULL;
 520   }
 521
 522   Device->ActiveConfig    = NULL;
 523   Device->NumOfInterface  = 0;
 524 }
 525
 526
 527 /**
 528   Remove the device and all its children from the bus.
 529
 530   @param  Device                The device to remove.
 531
 532   @retval EFI_SUCCESS           The device is removed.
 533
 534 **/
 535 EFI_STATUS
 536 UsbRemoveDevice (
 537   IN USB_DEVICE           *Device
 538   )
 539 {
 540   USB_BUS                 *Bus;
 541   USB_DEVICE              *Child;
 542   EFI_STATUS              Status;
 543   UINT8                   Index;
 544
 545   Bus = Device->Bus;
 546
 547   //
 548   // Remove all the devices on its downstream ports. Search from devices[1].
 549   // Devices[0] is the root hub.
 550   //
 551   for (Index = 1; Index < USB_MAX_DEVICES; Index++) {
 552     Child = Bus->Devices[Index];
 553
 554     if ((Child == NULL) || (Child->ParentAddr != Device->Address)) {
 555       continue;
 556     }
 557
 558     Status = UsbRemoveDevice (Child);
 559
 560     if (EFI_ERROR (Status)) {
 561       DEBUG ((EFI_D_ERROR, "UsbRemoveDevice: failed to remove child, ignore error\n"));
 562       Bus->Devices[Index] = NULL;
 563     }
 564   }
 565
 566   UsbRemoveConfig (Device);
 567
 568   DEBUG (( EFI_D_INFO, "UsbRemoveDevice: device %d removed\n", Device->Address));
 569
 570   ASSERT (Device->Address < USB_MAX_DEVICES);
 571   Bus->Devices[Device->Address] = NULL;
 572   UsbFreeDevice (Device);
 573
 574   return EFI_SUCCESS;
 575 }
 576
 577
 578 /**
 579   Find the child device on the hub's port.
 580
 581   @param  HubIf                 The hub interface.
 582   @param  Port                  The port of the hub this child is connected to.
 583
 584   @return The device on the hub's port, or NULL if there is none.
 585
 586 **/
 587 USB_DEVICE *
 588 UsbFindChild (
 589   IN USB_INTERFACE        *HubIf,
 590   IN UINT8                Port
 591   )
 592 {
 593   USB_DEVICE              *Device;
 594   USB_BUS                 *Bus;
 595   UINTN                   Index;
 596
 597   Bus = HubIf->Device->Bus;
 598
 599   //
 600   // Start checking from device 1, device 0 is the root hub
 601   //
 602   for (Index = 1; Index < USB_MAX_DEVICES; Index++) {
 603     Device = Bus->Devices[Index];
 604
 605     if ((Device != NULL) && (Device->ParentAddr == HubIf->Device->Address) &&
 606         (Device->ParentPort == Port)) {
 607
 608       return Device;
 609     }
 610   }
 611
 612   return NULL;
 613 }
 614
 615
 616 /**
 617   Enumerate and configure the new device on the port of this HUB interface.
 618
 619   @param  HubIf                 The HUB that has the device connected.
 620   @param  Port                  The port index of the hub (started with zero).
 621
 622   @retval EFI_SUCCESS           The device is enumerated (added or removed).
 623   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource for the device.
 624   @retval Others                Failed to enumerate the device.
 625
 626 **/
 627 EFI_STATUS
 628 UsbEnumerateNewDev (
 629   IN USB_INTERFACE        *HubIf,
 630   IN UINT8                Port
 631   )
 632 {
 633   USB_BUS                 *Bus;
 634   USB_HUB_API             *HubApi;
 635   USB_DEVICE              *Child;
 636   USB_DEVICE              *Parent;
 637   EFI_USB_PORT_STATUS     PortState;
 638   UINT8                   Address;
 639   UINT8                   Config;
 640   EFI_STATUS              Status;
 641
 642   Address = USB_MAX_DEVICES;
 643   Parent  = HubIf->Device;
 644   Bus     = Parent->Bus;
 645   HubApi  = HubIf->HubApi;
 646
 647   gBS->Stall (USB_WAIT_PORT_STABLE_STALL);
 648
 649   //
 650   // Hub resets the device for at least 10 milliseconds.
 651   // Host learns device speed. If device is of low/full speed
 652   // and the hub is a EHCI root hub, ResetPort will release
 653   // the device to its companion UHCI and return an error.
 654   //
 655   Status = HubApi->ResetPort (HubIf, Port);
 656
 657   if (EFI_ERROR (Status)) {
 658     DEBUG ((EFI_D_ERROR, "UsbEnumerateNewDev: failed to reset port %d - %r\n", Port, Status));
 659
 660     return Status;
 661   }
 662
 663   DEBUG (( EFI_D_INFO, "UsbEnumerateNewDev: hub port %d is reset\n", Port));
 664
 665   Child = UsbCreateDevice (HubIf, Port);
 666
 667   if (Child == NULL) {
 668     return EFI_OUT_OF_RESOURCES;
 669   }
 670
 671   //
 672   // OK, now identify the device speed. After reset, hub
 673   // fully knows the actual device speed.
 674   //
 675   Status = HubApi->GetPortStatus (HubIf, Port, &PortState);
 676
 677   if (EFI_ERROR (Status)) {
 678     DEBUG ((EFI_D_ERROR, "UsbEnumerateNewDev: failed to get speed of port %d\n", Port));
 679     goto ON_ERROR;
 680   }
 681
 682   if (USB_BIT_IS_SET (PortState.PortStatus, USB_PORT_STAT_LOW_SPEED)) {
 683     Child->Speed = EFI_USB_SPEED_LOW;
 684
 685   } else if (USB_BIT_IS_SET (PortState.PortStatus, USB_PORT_STAT_HIGH_SPEED)) {
 686     Child->Speed = EFI_USB_SPEED_HIGH;
 687
 688   } else {
 689     Child->Speed = EFI_USB_SPEED_FULL;
 690   }
 691
 692   DEBUG (( EFI_D_INFO, "UsbEnumerateNewDev: device is of %d speed\n", Child->Speed));
 693
 694   if (Child->Speed != EFI_USB_SPEED_HIGH) {
 695     //
 696     // If the child isn't a high speed device, it is necessary to
 697     // set the transaction translator. Port TT is 1-based.
 698     // This is quite simple:
 699     //  1. if parent is of high speed, then parent is our translator
 700     //  2. otherwise use parent's translator.
 701     //
 702     if (Parent->Speed == EFI_USB_SPEED_HIGH) {
 703       Child->Translator.TranslatorHubAddress  = Parent->Address;
 704       Child->Translator.TranslatorPortNumber  = (UINT8) (Port + 1);
 705
 706     } else {
 707       Child->Translator = Parent->Translator;
 708     }
 709
 710     DEBUG (( EFI_D_INFO, "UsbEnumerateNewDev: device uses translator (%d, %d)\n",
 711                 Child->Translator.TranslatorHubAddress,
 712                 Child->Translator.TranslatorPortNumber));
 713   }
 714
 715   //
 716   // After port is reset, hub establishes a signal path between
 717   // the device and host (DEFALUT state). Device's registers are
 718   // reset, use default address 0 (host enumerates one device at
 719   // a time) , and ready to respond to control transfer at EP 0.
 720   //
 721
 722   //
 723   // Host sends a Get_Descriptor request to learn the max packet
 724   // size of default pipe (only part of the device's descriptor).
 725   //
 726   Status = UsbGetMaxPacketSize0 (Child);
 727
 728   if (EFI_ERROR (Status)) {
 729     DEBUG ((EFI_D_ERROR, "UsbEnumerateNewDev: failed to get max packet for EP 0 - %r\n", Status));
 730     goto ON_ERROR;
 731   }
 732
 733   DEBUG (( EFI_D_INFO, "UsbEnumerateNewDev: max packet size for EP 0 is %d\n", Child->MaxPacket0));
 734
 735   //
 736   // Host assigns an address to the device. Device completes the
 737   // status stage with default address, then switches to new address.
 738   // ADDRESS state. Address zero is reserved for root hub.
 739   //
 740   for (Address = 1; Address < USB_MAX_DEVICES; Address++) {
 741     if (Bus->Devices[Address] == NULL) {
 742       break;
 743     }
 744   }
 745
 746   if (Address == USB_MAX_DEVICES) {
 747     DEBUG ((EFI_D_ERROR, "UsbEnumerateNewDev: address pool is full for port %d\n", Port));
 748
 749     Status = EFI_ACCESS_DENIED;
 750     goto ON_ERROR;
 751   }
 752
 753   Bus->Devices[Address] = Child;
 754   Status                = UsbSetAddress (Child, Address);
 755   Child->Address        = Address;
 756
 757   if (EFI_ERROR (Status)) {
 758     DEBUG ((EFI_D_ERROR, "UsbEnumerateNewDev: failed to set device address - %r\n", Status));
 759     goto ON_ERROR;
 760   }
 761
 762   gBS->Stall (USB_SET_DEVICE_ADDRESS_STALL);
 763
 764   DEBUG ((EFI_D_INFO, "UsbEnumerateNewDev: device is now ADDRESSED at %d\n", Address));
 765
 766   //
 767   // Host learns about the device's abilities by requesting device's
 768   // entire descriptions.
 769   //
 770   Status = UsbBuildDescTable (Child);
 771
 772   if (EFI_ERROR (Status)) {
 773     DEBUG ((EFI_D_ERROR, "UsbEnumerateNewDev: failed to build descriptor table - %r\n", Status));
 774     goto ON_ERROR;
 775   }
 776
 777   //
 778   // Select a default configuration: UEFI must set the configuration
 779   // before the driver can connect to the device.
 780   //
 781   Config = Child->DevDesc->Configs[0]->Desc.ConfigurationValue;
 782   Status = UsbSetConfig (Child, Config);
 783
 784   if (EFI_ERROR (Status)) {
 785     DEBUG ((EFI_D_ERROR, "UsbEnumerateNewDev: failed to set configure %d - %r\n", Config, Status));
 786     goto ON_ERROR;
 787   }
 788
 789   DEBUG (( EFI_D_INFO, "UsbEnumerateNewDev: device %d is now in CONFIGED state\n", Address));
 790
 791   //
 792   // Host assigns and loads a device driver.
 793   //
 794   Status = UsbSelectConfig (Child, Config);
 795
 796   if (EFI_ERROR (Status)) {
 797     DEBUG ((EFI_D_ERROR, "UsbEnumerateNewDev: failed to create interfaces - %r\n", Status));
 798     goto ON_ERROR;
 799   }
 800
 801   return EFI_SUCCESS;
 802
 803 ON_ERROR:
 804   if (Address != USB_MAX_DEVICES) {
 805     Bus->Devices[Address] = NULL;
 806   }
 807
 808   if (Child != NULL) {
 809     UsbFreeDevice (Child);
 810   }
 811
 812   return Status;
 813 }
 814
 815
 816 /**
 817   Process the events on the port.
 818
 819   @param  HubIf                 The HUB that has the device connected.
 820   @param  Port                  The port index of the hub (started with zero).
 821
 822   @retval EFI_SUCCESS           The device is enumerated (added or removed).
 823   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource for the device.
 824   @retval Others                Failed to enumerate the device.
 825
 826 **/
 827 EFI_STATUS
 828 UsbEnumeratePort (
 829   IN USB_INTERFACE        *HubIf,
 830   IN UINT8                Port
 831   )
 832 {
 833   USB_HUB_API             *HubApi;
 834   USB_DEVICE              *Child;
 835   EFI_USB_PORT_STATUS     PortState;
 836   EFI_STATUS              Status;
 837
 838   Child   = NULL;
 839   HubApi  = HubIf->HubApi;
 840
 841   //
 842   // Host learns of the new device by polling the hub for port changes.
 843   //
 844   Status = HubApi->GetPortStatus (HubIf, Port, &PortState);
 845
 846   if (EFI_ERROR (Status)) {
 847     DEBUG ((EFI_D_ERROR, "UsbEnumeratePort: failed to get state of port %d\n", Port));
 848     return Status;
 849   }
 850
 851   if (PortState.PortChangeStatus == 0) {
 852     return EFI_SUCCESS;
 853   }
 854
 855   DEBUG (( EFI_D_INFO, "UsbEnumeratePort: port %d state - %x, change - %x on %p\n",
 856               Port, PortState.PortStatus, PortState.PortChangeStatus, HubIf));
 857
 858   //
 859   // This driver only process two kinds of events now: over current and
 860   // connect/disconnect. Other three events are: ENABLE, SUSPEND, RESET.
 861   // ENABLE/RESET is used to reset port. SUSPEND isn't supported.
 862   //
 863
 864   if (USB_BIT_IS_SET (PortState.PortChangeStatus, USB_PORT_STAT_C_OVERCURRENT)) {
 865
 866     if (USB_BIT_IS_SET (PortState.PortStatus, USB_PORT_STAT_OVERCURRENT)) {
 867       //
 868       // Case1:
 869       //   Both OverCurrent and OverCurrentChange set, means over current occurs,
 870       //   which probably is caused by short circuit. It has to wait system hardware
 871       //   to perform recovery.
 872       //
 873       DEBUG (( EFI_D_ERROR, "UsbEnumeratePort: Critical Over Current\n", Port));
 874       return EFI_DEVICE_ERROR;
 875
 876     }
 877     //
 878     // Case2:
 879     //   Only OverCurrentChange set, means system has been recoveried from
 880     //   over current. As a result, all ports are nearly power-off, so
 881     //   it's necessary to detach and enumerate all ports again.
 882     //
 883     DEBUG (( EFI_D_ERROR, "UsbEnumeratePort: 2.0 device Recovery Over Current\n", Port));
 884   }
 885
 886   if (USB_BIT_IS_SET (PortState.PortChangeStatus, USB_PORT_STAT_C_ENABLE)) {
 887     //
 888     // Case3:
 889     //   1.1 roothub port reg doesn't reflect over-current state, while its counterpart
 890     //   on 2.0 roothub does. When over-current has influence on 1.1 device, the port
 891     //   would be disabled, so it's also necessary to detach and enumerate again.
 892     //
 893     DEBUG (( EFI_D_ERROR, "UsbEnumeratePort: 1.1 device Recovery Over Current\n", Port));
 894   }
 895
 896   if (USB_BIT_IS_SET (PortState.PortChangeStatus, USB_PORT_STAT_C_CONNECTION)) {
 897     //
 898     // Case4:
 899     //   Device connected or disconnected normally.
 900     //
 901     DEBUG ((EFI_D_ERROR, "UsbEnumeratePort: Device Connect/Discount Normally\n", Port));
 902   }
 903
 904   //
 905   // Following as the above cases, it's safety to remove and create again.
 906   //
 907   Child = UsbFindChild (HubIf, Port);
 908
 909   if (Child != NULL) {
 910     DEBUG (( EFI_D_INFO, "UsbEnumeratePort: device at port %d removed from root hub %p\n", Port, HubIf));
 911     UsbRemoveDevice (Child);
 912   }
 913
 914   if (USB_BIT_IS_SET (PortState.PortStatus, USB_PORT_STAT_CONNECTION)) {
 915     //
 916     // Now, new device connected, enumerate and configure the device
 917     //
 918     DEBUG (( EFI_D_INFO, "UsbEnumeratePort: new device connected at port %d\n", Port));
 919     Status = UsbEnumerateNewDev (HubIf, Port);
 920
 921   } else {
 922     DEBUG (( EFI_D_INFO, "UsbEnumeratePort: device disconnected event on port %d\n", Port));
 923   }
 924
 925   HubApi->ClearPortChange (HubIf, Port);
 926   return Status;
 927 }
 928
 929
 930 /**
 931   Enumerate all the changed hub ports.
 932
 933   @param  Event                 The event that is triggered.
 934   @param  Context               The context to the event.
 935
 936 **/
 937 VOID
 938 EFIAPI
 939 UsbHubEnumeration (
 940   IN EFI_EVENT            Event,
 941   IN VOID                 *Context
 942   )
 943 {
 944   USB_INTERFACE           *HubIf;
 945   UINT8                   Byte;
 946   UINT8                   Bit;
 947   UINT8                   Index;
 948
 949   ASSERT (Context != NULL);
 950
 951   HubIf = (USB_INTERFACE *) Context;
 952
 953   if (HubIf->ChangeMap == NULL) {
 954     return ;
 955   }
 956
 957   //
 958   // HUB starts its port index with 1.
 959   //
 960   Byte  = 0;
 961   Bit   = 1;
 962
 963   for (Index = 0; Index < HubIf->NumOfPort; Index++) {
 964     if (USB_BIT_IS_SET (HubIf->ChangeMap[Byte], USB_BIT (Bit))) {
 965       UsbEnumeratePort (HubIf, Index);
 966     }
 967
 968     USB_NEXT_BIT (Byte, Bit);
 969   }
 970
 971   UsbHubAckHubStatus (HubIf->Device);
 972
 973   gBS->FreePool (HubIf->ChangeMap);
 974   HubIf->ChangeMap = NULL;
 975   return ;
 976 }
 977
 978
 979 /**
 980   Enumerate all the changed hub ports.
 981
 982   @param  Event                 The event that is triggered.
 983   @param  Context               The context to the event.
 984
 985 **/
 986 VOID
 987 EFIAPI
 988 UsbRootHubEnumeration (
 989   IN EFI_EVENT            Event,
 990   IN VOID                 *Context
 991   )
 992 {
 993   USB_INTERFACE           *RootHub;
 994   UINT8                   Index;
 995
 996   RootHub = (USB_INTERFACE *) Context;
 997
 998   for (Index = 0; Index < RootHub->NumOfPort; Index++) {
 999     UsbEnumeratePort (RootHub, Index);
1000   }
1001 }