Correct parameter UINTN to UINT32

[mirror_edk2.git] / MdePkg / Include / Library / UsbLib.h

/** @file\r
  Common Dxe Libarary  for USB\r
\r
  Copyright (c) 2006, Intel Corporation<BR>\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
**/\r
\r
\r
#ifndef __USB_DXE_LIB_H__\r
#define __USB_DXE_LIB_H__\r
\r
#include <Protocol/UsbIo.h>\r
\r
//\r
// define the timeout time as 3ms\r
//\r
#define TIMEOUT_VALUE 3 * 1000\r
\r
EFI_STATUS\r
EFIAPI\r
UsbGetHidDescriptor (\r
  IN  EFI_USB_IO_PROTOCOL        *UsbIo,\r
  IN  UINT8                      InterfaceNum,\r
  OUT EFI_USB_HID_DESCRIPTOR     *HidDescriptor\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbGetReportDescriptor (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT8                   InterfaceNum,\r
  IN  UINT16                  DescriptorSize,\r
  OUT UINT8                   *DescriptorBuffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbGetProtocolRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   *Protocol\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbSetProtocolRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   Protocol\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbSetIdleRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   ReportId,\r
  IN UINT8                   Duration\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbGetIdleRequest (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT8                   Interface,\r
  IN  UINT8                   ReportId,\r
  OUT UINT8                   *Duration\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbSetReportRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   ReportId,\r
  IN UINT8                   ReportType,\r
  IN UINT16                  ReportLen,\r
  IN UINT8                   *Report\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbGetReportRequest (\r
  IN EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN UINT8                   Interface,\r
  IN UINT8                   ReportId,\r
  IN UINT8                   ReportType,\r
  IN UINT16                  ReportLen,\r
  IN UINT8                   *Report\r
  );\r
\r
typedef enum {\r
  EfiUsbEndpointHalt,\r
  EfiUsbDeviceRemoteWakeup\r
} EFI_USB_STANDARD_FEATURE_SELECTOR;\r
\r
EFI_STATUS\r
UsbGetDescriptor (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  Value,\r
  IN  UINT16                  Index,\r
  IN  UINT16                  DescriptorLength,\r
  OUT VOID                    *Descriptor,\r
  OUT UINT32                  *Status\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbSetDescriptor (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  Value,\r
  IN  UINT16                  Index,\r
  IN  UINT16                  DescriptorLength,\r
  IN  VOID                    *Descriptor,\r
  OUT UINT32                  *Status\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbGetInterface (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  Index,\r
  OUT UINT8                   *AltSetting,\r
  OUT UINT32                  *Status\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbSetInterface (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  InterfaceNo,\r
  IN  UINT16                  AltSetting,\r
  OUT UINT32                  *Status\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbGetConfiguration (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  OUT UINT8                   *ConfigValue,\r
  OUT UINT32                  *Status\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbSetConfiguration (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  Value,\r
  OUT UINT32                  *Status\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbSetFeature (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINTN                   Recipient,\r
  IN  UINT16                  Value,\r
  IN  UINT16                  Target,\r
  OUT UINT32                  *Status\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbClearFeature (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINTN                   Recipient,\r
  IN  UINT16                  Value,\r
  IN  UINT16                  Target,\r
  OUT UINT32                  *Status\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbGetStatus (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINTN                   Recipient,\r
  IN  UINT16                  Target,\r
  OUT UINT16                  *DevStatus,\r
  OUT UINT32                  *Status\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
UsbGetHubDescriptor (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT16                  Value,\r
  IN  UINT16                  Index,\r
  IN  UINT16                  DescriptorLength,\r
  OUT VOID                    *Descriptor,\r
  OUT UINT32                  *Status\r
  );\r
\r
//\r
// Clear endpoint stall\r
//\r
EFI_STATUS\r
EFIAPI\r
UsbClearEndpointHalt (\r
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
  IN  UINT8                   EndpointNo,\r
  OUT UINT32                  *Status\r
  );\r
\r
#endif\r