Initial import.

[mirror_edk2.git] / MdePkg / Include / Protocol / UsbHostController.h

/** @file\r
  EFI_USB_HC_PROTOCOL as defined in EFI 1.10.\r
\r
  Copyright (c) 2006, 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:  UsbHostController.h\r
\r
**/\r
\r
#ifndef _USB_HOSTCONTROLLER_H_\r
#define _USB_HOSTCONTROLLER_H_\r
\r
#define EFI_USB_HC_PROTOCOL_GUID \\r
  { \\r
    0xf5089266, 0x1aa0, 0x4953, {0x97, 0xd8, 0x56, 0x2f, 0x8a, 0x73, 0xb5, 0x19 } \\r
  }\r
\r
//\r
// Forward reference for pure ANSI compatability\r
//\r
typedef struct _EFI_USB_HC_PROTOCOL EFI_USB_HC_PROTOCOL;\r
\r
//\r
// Protocol definitions\r
//\r
\r
/**                                                                 \r
  Provides software reset for the USB host controller.\r
    \r
  @param  This                  A pointer to the EFI_USB_HC_PROTOCOL instance.\r
  @param  Attributes            A bit mask of the reset operation to perform.\r
                                \r
  @retval EFI_SUCCESS           The reset operation succeeded.\r
  @retval EFI_UNSUPPORTED       The type of reset specified by Attributes is not currently supported\r
                                by the host controller hardware.                                    \r
  @retval EFI_INVALID_PARAMETER Attributes is not valid.\r
  @retval EFI_DEVICE_ERROR      An error was encountered while attempting to perform the reset operation.\r
                                   \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_USB_HC_PROTOCOL_RESET) (\r
  IN EFI_USB_HC_PROTOCOL     *This,\r
  IN UINT16                  Attributes\r
  );\r
\r
/**                                                                 \r
  Retrieves current state of the USB host controller.\r
    \r
  @param  This                  A pointer to the EFI_USB_HC_PROTOCOL instance.\r
  @param  State                 A pointer to the EFI_USB_HC_STATE data structure that\r
                                indicates current state of the USB host controller.  \r
                                \r
  @retval EFI_SUCCESS           The state information of the host controller was returned in State.\r
  @retval EFI_INVALID_PARAMETER State is NULL.\r