Upload BSD-licensed Vlv2TbltDevicePkg and Vlv2DeviceRefCodePkg to

[mirror_edk2.git] / Vlv2TbltDevicePkg / Include / Ppi / UsbController.h

diff --git a/Vlv2TbltDevicePkg/Include/Ppi/UsbController.h b/Vlv2TbltDevicePkg/Include/Ppi/UsbController.h
new file mode 100644 (file)
index 0000000..dc6468a
--- /dev/null
+++ b/Vlv2TbltDevicePkg/Include/Ppi/UsbController.h
@@ -0,0 +1,90 @@
+/*++\r
+\r
+  Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>\r
+                                                                                   \r\r
+  This program and the accompanying materials are licensed and made available under\r\r
+  the terms and conditions of the BSD License that accompanies this distribution.  \r\r
+  The full text of the license may be found at                                     \r\r
+  http://opensource.org/licenses/bsd-license.php.                                  \r\r
+                                                                                   \r\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,            \r\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.    \r\r
+                                                                                   \r\r
+\r
+  Define APIs to retrieve USB Host Controller Info such as controller type and\r
+  I/O Port Base Address.\r
+\r
+\r
+**/\r
+\r
+#ifndef _PEI_USB_CONTROLLER_PPI_H_\r
+#define _PEI_USB_CONTROLLER_PPI_H_\r
+\r
+//\r
+// Global ID for the PEI_USB_CONTROLLER_PPI.\r
+//\r
+#define PEI_USB_CONTROLLER_PPI_GUID \\r
+  { \\r
+    0x3bc1f6de, 0x693e, 0x4547,{ 0xa3, 0x0, 0x21, 0x82, 0x3c, 0xa4, 0x20, 0xb2} \\r
+  }\r
+\r
+//\r
+// Forward declaration for the PEI_USB_CONTROLLER_PPI.\r
+//\r
+typedef struct _PEI_USB_CONTROLLER_PPI PEI_USB_CONTROLLER_PPI;\r
+\r
+//\r
+// This bit is used in the ControllerType return parameter of GetUsbController()\r
+// to identify the USB Host Controller type as UHCI\r
+//\r
+#define PEI_UHCI_CONTROLLER 0x01\r
+\r
+//\r
+// This bit is used in the ControllerType return parameter of GetUsbController()\r
+// to identify the USB Host Controller type as OHCI\r
+//\r
+#define PEI_OHCI_CONTROLLER 0x02\r
+\r
+//\r
+// This bit is used in the ControllerType return parameter of GetUsbController()\r
+// to identify the USB Host Controller type as EHCI\r
+//\r
+#define PEI_EHCI_CONTROLLER 0x03\r
+\r
+/**\r
+  Retrieve USB Host Controller Info such as controller type and I/O Base Address.\r
+\r
+  @param[in]  PeiServices      The pointer to the PEI Services Table.\r
+  @param[in]  This             The pointer to this instance of the PEI_USB_CONTROLLER_PPI.\r
+  @param[in]  ControllerId     The ID of the USB controller.\r
+  @param[out] ControllerType   On output, returns the type of the USB controller.\r
+  @param[out] BaseAddress      On output, returns the base address of UHCI's I/O ports\r
+                               if UHCI is enabled or the base address of EHCI's MMIO\r
+                               if EHCI is enabled.\r
+\r
+  @retval EFI_SUCCESS             USB controller attributes were returned successfully.\r
+  @retval EFI_INVALID_PARAMETER   ControllerId is greater than the maximum number\r
+                                  of USB controller supported by this platform.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *PEI_GET_USB_CONTROLLER)(\r
+  IN  EFI_PEI_SERVICES        **PeiServices,\r
+  IN  PEI_USB_CONTROLLER_PPI  *This,\r
+  IN  UINT8                   UsbControllerId,\r
+  OUT UINTN                   *ControllerType,\r
+  OUT UINTN                   *BaseAddress\r
+  );\r
+\r
+//\r
+// This PPI contains a single service to retrieve the USB Host Controller type\r
+// and the base address of the I/O ports used to access the USB Host Controller.\r
+//\r
+struct _PEI_USB_CONTROLLER_PPI {\r
+  PEI_GET_USB_CONTROLLER  GetUsbController;\r
+};\r
+\r
+extern EFI_GUID gPeiUsbControllerPpiGuid;\r
+\r
+#endif\r