Update to support to produce Component Name and & Component Name 2 protocol based...

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbBusDxe / usbbus.h

/** @file\r
Copyright (c) 2004 - 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
  Module Name:\r
\r
    UsbBus.h\r
\r
  Abstract:\r
\r
    Usb Bus Driver Binding and Bus IO Protocol\r
\r
  Revision History\r
\r
\r
**/\r
\r
#ifndef _EFI_USB_BUS_H_\r
#define _EFI_USB_BUS_H_\r
\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/Usb2HostController.h>\r
#include <Protocol/UsbHostController.h>\r
#include <Protocol/UsbIo.h>\r
#include <Protocol/DevicePath.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
\r
#include <IndustryStandard/Usb.h>\r
\r
typedef struct _USB_DEVICE     USB_DEVICE;\r
typedef struct _USB_INTERFACE  USB_INTERFACE;\r
typedef struct _USB_BUS        USB_BUS;\r
typedef struct _USB_HUB_API    USB_HUB_API;\r
\r
\r
#include "UsbUtility.h"\r
#include "UsbDesc.h"\r
#include "UsbHub.h"\r
#include "UsbEnumer.h"\r
\r
enum {\r
  //\r
  // Time definition\r
  //\r
  USB_STALL_1_MS            = 1000,\r
  TICKS_PER_MS              = 10000U,\r
  USB_ROOTHUB_POLL_INTERVAL = 1000 * TICKS_PER_MS,\r
  USB_HUB_POLL_INTERVAL     = 64,\r
\r
  //\r
  // Maximum definition\r
  //\r
  USB_MAX_LANG_ID           = 16,\r
  USB_MAX_INTERFACE         = 16,\r
  USB_MAX_DEVICES           = 128,\r
\r
  //\r
  // Bus raises TPL to TPL_NOTIFY to serialize all its operations\r
  // to protect shared data structures.\r
  //\r
  USB_BUS_TPL               = TPL_NOTIFY,\r
\r
  USB_INTERFACE_SIGNATURE   = EFI_SIGNATURE_32 ('U', 'S', 'B', 'I'),\r
  USB_BUS_SIGNATURE         = EFI_SIGNATURE_32 ('U', 'S', 'B', 'B')\r
};\r
\r
#define USB_BIT(a)                  ((UINTN)(1 << (a)))\r
#define USB_BIT_IS_SET(Data, Bit)   ((BOOLEAN)(((Data) & (Bit)) == (Bit)))\r
\r
#define EFI_USB_BUS_PROTOCOL_GUID \\r
          {0x2B2F68CC, 0x0CD2, 0x44cf, {0x8E, 0x8B, 0xBB, 0xA2, 0x0B, 0x1B, 0x5B, 0x75}}\r
\r
#define USB_INTERFACE_FROM_USBIO(a) \\r
          CR(a, USB_INTERFACE, UsbIo, USB_INTERFACE_SIGNATURE)\r
\r
#define USB_BUS_FROM_THIS(a) \\r
          CR(a, USB_BUS, BusId, USB_BUS_SIGNATURE)\r
\r
//\r
// Used to locate USB_BUS\r
//\r
typedef struct _EFI_USB_BUS_PROTOCOL {\r
  UINT64                    Reserved;\r
} EFI_USB_BUS_PROTOCOL;\r
\r
\r
//\r
// Stands for the real USB device. Each device may\r
// has several seperately working interfaces.\r
//\r
struct _USB_DEVICE {\r
  USB_BUS                   *Bus;\r
\r
  //\r
  // Configuration information\r
  //\r
  UINT8                     Speed;\r
  UINT8                     Address;\r
  UINT8                     MaxPacket0;\r
\r
  //\r
  // The device's descriptors and its configuration\r
  //\r
  USB_DEVICE_DESC           *DevDesc;\r
  USB_CONFIG_DESC           *ActiveConfig;\r
\r
  UINT16                    LangId [USB_MAX_LANG_ID];\r
  UINT16                    TotalLangId;\r
\r
  UINT8                     NumOfInterface;\r
  USB_INTERFACE             *Interfaces [USB_MAX_INTERFACE];\r
\r
  //\r
  // Parent child relationship\r
  //\r
  EFI_USB2_HC_TRANSACTION_TRANSLATOR Translator;\r
\r
  UINT8                     ParentAddr;\r
  USB_INTERFACE             *ParentIf;\r
  UINT8                     ParentPort;       // Start at 0\r
};\r
\r
//\r
// Stands for different functions of USB device\r
//\r
struct _USB_INTERFACE {\r
  UINTN                     Signature;\r
  USB_DEVICE                *Device;\r
  USB_INTERFACE_DESC        *IfDesc;\r
  USB_INTERFACE_SETTING     *IfSetting;\r
\r
  //\r
  // Handles and protocols\r
  //\r
  EFI_HANDLE                Handle;\r
  EFI_USB_IO_PROTOCOL       UsbIo;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  BOOLEAN                   IsManaged;\r
\r
  //\r
  // Hub device special data\r
  //\r
  BOOLEAN                   IsHub;\r
  USB_HUB_API               *HubApi;\r
  UINT8                     NumOfPort;\r
  EFI_EVENT                 HubNotify;\r
\r
  //\r
  // Data used only by normal hub devices\r
  //\r
  USB_ENDPOINT_DESC         *HubEp;\r
  UINT8                     *ChangeMap;\r
\r
  //\r
  // Data used only by root hub to hand over device to\r
  // companion UHCI driver if low/full speed devices are\r
  // connected to EHCI.\r
  //\r
  UINT8                     MaxSpeed;\r
};\r
\r
//\r
// Stands for the current USB Bus\r
//\r
struct _USB_BUS {\r
  UINTN                     Signature;\r
  EFI_USB_BUS_PROTOCOL      BusId;\r
\r
  //\r
  // Managed USB host controller\r
  //\r
  EFI_HANDLE                HostHandle;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  EFI_USB2_HC_PROTOCOL      *Usb2Hc;\r
  EFI_USB_HC_PROTOCOL       *UsbHc;\r
\r
  //\r
  // An array of device that is on the bus. Devices[0] is\r
  // for root hub. Device with address i is at Devices[i].\r
  //\r
  USB_DEVICE                *Devices[USB_MAX_DEVICES];\r
};\r
\r
extern EFI_USB_IO_PROTOCOL           mUsbIoProtocol;\r
extern EFI_DRIVER_BINDING_PROTOCOL   mUsbBusDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL   mUsbBusComponentName;\r
\r
#endif\r