Vlv2TbltDevicePkg/Include/Protocol/UsbPolicy.h

   1 /*++
   2
   3   Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>
   4
   5   This program and the accompanying materials are licensed and made available under
   6   the terms and conditions of the BSD License that accompanies this distribution.
   7   The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php.
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13
  14 Module Name:
  15   UsbPolicy.h
  16
  17 Abstract:
  18
  19 --*/
  20
  21 #ifndef _USB_POLICY_H_
  22 #define _USB_POLICY_H_
  23
  24 EFI_FORWARD_DECLARATION (EFI_USB_POLICY_PROTOCOL);
  25
  26 #define USB_POLICY_GUID \
  27   {\
  28     0xf617b358, 0x12cf, 0x414a, 0xa0, 0x69, 0x60, 0x67, 0x7b, 0xda, 0x13, 0xb4\
  29   }
  30
  31 #define TIANO_CODE_BASE           0x00
  32 #define ICBD_CODE_BASE            0x01
  33
  34 #define ATUO_TYPE                 0x00
  35 #define USB_FDD_TYPE              0x01
  36 #define HDD_TYPE                  0x02
  37 #define ZIP_TYPE                  0x03
  38 #define CDROM_TYPE                0x04
  39 #define SIZE_TYPE                 0x05
  40
  41 #define ZIP_FDD                 0x80
  42
  43 #define FDD_EMULATION             0x00
  44 #define HDD_EMULATION             0x01
  45
  46 #define HIGH_SPEED                0x00
  47 #define FULL_SPEED                0x01
  48 #define SUPER_SPEED               0x02
  49
  50 #define LEGACY_KB_EN              0x01
  51 #define LEGACY_KB_DIS             0x00
  52 #define LEGACY_MS_EN              0x01
  53 #define LEGACY_MS_DIS             0x00
  54 #define LEGACY_USB_EN             0x00
  55 #define LEGACY_USB_DIS            0x01
  56 #define LEGACY_FREE_SUPP          0x01
  57 #define LEGACY_FREE_UN_SUPP       0x00
  58 #define LEGACY_PERIOD_SUPP        0x01
  59 #define LEGACY_PERIOD_UN_SUPP     0x00
  60
  61 #define LEGACY_USB_TIME_TUE_ENABLE       0x01
  62 #define LEGACY_USB_TIME_TUE_DISABLE      0x00
  63 #define USB_HAVE_HUB_INTERNEL            0x01
  64 #define USB_NOT_HAVE_HUB_INTERNEL        0x00
  65
  66 #define USB_POLICY_PROTOCOL_REVISION_1 1
  67 #define USB_POLICY_PROTOCOL_REVISION_2 2
  68
  69 #ifndef __GNUC__
  70 #pragma warning ( disable : 4306 )
  71 #pragma warning ( disable : 4054 )
  72 #endif
  73
  74 #define GET_USB_CFG (UsbCfg);\
  75  do{\
  76   UINT16                *pSegOfEbda;\
  77   UINT32                mToEbda;\
  78   pSegOfEbda = (UINT16 *)(UINTN)0x40E;\
  79   mToEbda    = (UINT32)(((UINTN)(*pSegOfEbda) << 4) + 0x80);\
  80   UsbCfg     = (USB_CFG *)(UINTN)mToEbda;\
  81  }while(0);
  82
  83 #pragma    pack(1)
  84 typedef struct {
  85     UINT8   HasUSBKeyboard:1;
  86     UINT8   HasUSBMouse:1;
  87     UINT8   LegacyFreeSupport:1;
  88     UINT8   UsbOperationMode:1;
  89     UINT8   LegacyKBEnable:1;
  90     UINT8   LegacyMSEnable:1;
  91     UINT8   USBPeriodSupport:1;
  92     UINT8   Reserved:1;
  93 } USB_DEVICE_INFOR;
  94
  95 typedef struct {
  96     UINT8               Codebase;
  97     UINT8               USBHDDForceType;
  98     UINT8               Configurated;
  99     UINT8               LpcAcpiBase;
 100     UINT8               AcpiTimerReg;
 101     UINT8               Reserved1[0x01];
 102     UINT8               LegacyUsbEnable;
 103     USB_DEVICE_INFOR    UsbDeviceInfor;
 104     UINT16              UsbEmulationSize;
 105     UINT8               Reserved2[0x06];
 106 } USB_CFG;
 107 #pragma pack()
 108
 109 typedef struct _EFI_USB_POLICY_PROTOCOL{
 110   UINT8   Version;
 111   UINT8   UsbMassStorageEmulationType;  // 1: FDD_Type; 2: HDD_Type; other:Auto_Type*
 112   UINT8   UsbOperationMode;             // 0: High_Speed; 1: Full_Speed;
 113   UINT8   LegacyKBEnable;               // 0: Disabled;   1: Enabled*
 114   UINT8   LegacyMSEnable;               // 0: Disabled;   1: Enabled*
 115   UINT8   USBPeriodSupport;             // 0; Unsupport;  1: Support
 116   UINT8   LegacyUsbEnable;              // 1: Disabled;   0: Enabled*
 117   UINT8   LegacyFreeSupport;            // 0: Unsupport;  1: Support
 118   UINT8   CodeBase;
 119   UINT8   LpcAcpiBase;                  // 40h(default)
 120   UINT8   AcpiTimerReg;
 121   UINT8   UsbTimeTue;
 122   UINT8   InternelHubExist;             // 1: Host have internel hub on board; 0: No internel hub on board
 123   UINT8   EnumWaitPortStableStall;      // Value for wait port stable when enum a new dev.
 124   UINT16  UsbEmulationSize;             // Mbytes.
 125   UINT8   UsbZipEmulationType;
 126   UINT8   Reserved[3];                  // Reserved fields for future expansion w/o protocol change
 127 } EFI_USB_POLICY_PROTOCOL;
 128
 129 extern EFI_GUID gUsbPolicyGuid;
 130
 131 #endif